Compare commits
5 Commits
30ca69c33d
...
next
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
82e75e4166 | ||
|
|
d457fb8aad | ||
|
|
1630d4d736 | ||
|
|
9a84c59731 | ||
|
|
d0e574422a |
@@ -2,12 +2,6 @@ local bun_image = "oven/bun:1";
|
|||||||
local node_image = "node:20";
|
local node_image = "node:20";
|
||||||
|
|
||||||
|
|
||||||
local fetch_step = {
|
|
||||||
name: "fetch",
|
|
||||||
image: "alpine/git",
|
|
||||||
commands: ["git fetch --tags"],
|
|
||||||
};
|
|
||||||
|
|
||||||
local install_step = {
|
local install_step = {
|
||||||
name: "install",
|
name: "install",
|
||||||
image: bun_image,
|
image: bun_image,
|
||||||
@@ -29,7 +23,7 @@ local build_step = {
|
|||||||
local pack_step = {
|
local pack_step = {
|
||||||
name: "pack",
|
name: "pack",
|
||||||
image: node_image,
|
image: node_image,
|
||||||
commands: ["npm pack"],
|
commands: ["npm pack --dry-run"],
|
||||||
};
|
};
|
||||||
|
|
||||||
local publish_step = {
|
local publish_step = {
|
||||||
@@ -41,7 +35,7 @@ local publish_step = {
|
|||||||
},
|
},
|
||||||
|
|
||||||
commands: [
|
commands: [
|
||||||
"npm set registry https://git.jvalver.de/api/packages/thilawyn/npm/",
|
"npm set @thilawyn:registry https://git.jvalver.de/api/packages/thilawyn/npm/",
|
||||||
"npm config set -- //git.jvalver.de/api/packages/thilawyn/npm/:_authToken $NPM_TOKEN",
|
"npm config set -- //git.jvalver.de/api/packages/thilawyn/npm/:_authToken $NPM_TOKEN",
|
||||||
"npm publish",
|
"npm publish",
|
||||||
],
|
],
|
||||||
|
|||||||
10
.npmignore
10
.npmignore
@@ -1,10 +0,0 @@
|
|||||||
/node_modules/
|
|
||||||
/src/
|
|
||||||
/.drone.jsonnet
|
|
||||||
/.gitignore
|
|
||||||
/.npmignore
|
|
||||||
/bun.lockb
|
|
||||||
/README.md
|
|
||||||
/rollup.config.js
|
|
||||||
/tsconfig.json
|
|
||||||
/tsconfig.tsbuildinfo
|
|
||||||
12
package.json
12
package.json
@@ -1,10 +1,13 @@
|
|||||||
{
|
{
|
||||||
"name": "thilatrait",
|
"name": "@thilawyn/thilatrait",
|
||||||
"version": "20231229.0.0",
|
"version": "0.1.2",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"registry": "https://git.jvalver.de/api/packages/thilawyn/npm/"
|
"registry": "https://git.jvalver.de/api/packages/thilawyn/npm/"
|
||||||
},
|
},
|
||||||
|
"files": [
|
||||||
|
"./dist"
|
||||||
|
],
|
||||||
"exports": {
|
"exports": {
|
||||||
".": {
|
".": {
|
||||||
"import": {
|
"import": {
|
||||||
@@ -18,7 +21,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "rollup -c",
|
"build": "rollup -c rollup.config.ts",
|
||||||
"lint:tsc": "tsc --noEmit",
|
"lint:tsc": "tsc --noEmit",
|
||||||
"clean:cache": "rm -f tsconfig.tsbuildinfo",
|
"clean:cache": "rm -f tsconfig.tsbuildinfo",
|
||||||
"clean:dist": "rm -rf dist",
|
"clean:dist": "rm -rf dist",
|
||||||
@@ -28,10 +31,11 @@
|
|||||||
"type-fest": "^4.9.0"
|
"type-fest": "^4.9.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
"@rollup/plugin-node-resolve": "^15.2.3",
|
||||||
"bun-types": "latest",
|
"bun-types": "latest",
|
||||||
"npm-check-updates": "^16.14.12",
|
"npm-check-updates": "^16.14.12",
|
||||||
"npm-sort": "^0.0.4",
|
"npm-sort": "^0.0.4",
|
||||||
"rollup": "^4.9.1",
|
"rollup": "^4.9.4",
|
||||||
"rollup-plugin-cleanup": "^3.2.1",
|
"rollup-plugin-cleanup": "^3.2.1",
|
||||||
"rollup-plugin-ts": "^3.4.5",
|
"rollup-plugin-ts": "^3.4.5",
|
||||||
"tsx": "^4.7.0",
|
"tsx": "^4.7.0",
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import { nodeResolve } from "@rollup/plugin-node-resolve"
|
||||||
import { defineConfig } from "rollup"
|
import { defineConfig } from "rollup"
|
||||||
import cleanup from "rollup-plugin-cleanup"
|
import cleanup from "rollup-plugin-cleanup"
|
||||||
import ts from "rollup-plugin-ts"
|
import ts from "rollup-plugin-ts"
|
||||||
@@ -19,7 +20,10 @@ export default defineConfig({
|
|||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
|
||||||
|
external: id => !/^[./]/.test(id),
|
||||||
|
|
||||||
plugins: [
|
plugins: [
|
||||||
|
nodeResolve(),
|
||||||
ts(),
|
ts(),
|
||||||
|
|
||||||
cleanup({
|
cleanup({
|
||||||
84
src/expresses.ts
Normal file
84
src/expresses.ts
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
import { AbstractClass, Opaque } from "type-fest"
|
||||||
|
import { Trait, TraitApplierSuperTag } from "."
|
||||||
|
import { ClassesInstances, ClassesStaticMembers, MergeInheritanceTree, MergeInheritanceTreeWithoutOverriding, StaticMembers, TraitsClasses } from "./util"
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extends a class with the given traits and expresses their combined functionality.
|
||||||
|
* @template C - The abstract class type.
|
||||||
|
* @template Traits - An array of traits.
|
||||||
|
* @param extend - The class to extend.
|
||||||
|
* @param traits - An array of traits to apply.
|
||||||
|
* @returns A new class type expressing the combined functionality of the base class and traits.
|
||||||
|
* @example
|
||||||
|
* Extends a superclass and applies traits:
|
||||||
|
* ```ts
|
||||||
|
* class User extends extendsAndExpresses(Entity,
|
||||||
|
* Identifiable<bigint>(),
|
||||||
|
* Permissible,
|
||||||
|
* ) {
|
||||||
|
* readonly id: bigint
|
||||||
|
*
|
||||||
|
* constructor(id: bigint) {
|
||||||
|
* super()
|
||||||
|
* this.id = id
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
export function extendsAndExpresses<
|
||||||
|
C extends AbstractClass<any>,
|
||||||
|
Traits extends readonly Trait<any>[],
|
||||||
|
>(
|
||||||
|
extend: C,
|
||||||
|
...traits: Traits
|
||||||
|
) {
|
||||||
|
return traits.reduce(
|
||||||
|
(previous, trait) => trait(previous),
|
||||||
|
extend as Opaque<C, TraitApplierSuperTag>,
|
||||||
|
) as unknown as (
|
||||||
|
AbstractClass<
|
||||||
|
MergeInheritanceTreeWithoutOverriding<[
|
||||||
|
InstanceType<C>,
|
||||||
|
...ClassesInstances<
|
||||||
|
TraitsClasses<Traits>
|
||||||
|
>,
|
||||||
|
]>,
|
||||||
|
|
||||||
|
ConstructorParameters<C>
|
||||||
|
> &
|
||||||
|
|
||||||
|
MergeInheritanceTree<[
|
||||||
|
StaticMembers<C>,
|
||||||
|
...ClassesStaticMembers<
|
||||||
|
TraitsClasses<Traits>
|
||||||
|
>,
|
||||||
|
]>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Expresses the combined functionality of multiple traits.
|
||||||
|
* @template Traits - An array of trait.
|
||||||
|
* @param traits - An array of trait to apply.
|
||||||
|
* @returns A new class type expressing the combined functionality of the traits.
|
||||||
|
* @example
|
||||||
|
* Applies traits to a class:
|
||||||
|
* ```ts
|
||||||
|
* class User extends expresses(Identifiable<bigint>(), Permissible) {
|
||||||
|
* readonly id: bigint
|
||||||
|
*
|
||||||
|
* constructor(id: bigint) {
|
||||||
|
* super()
|
||||||
|
* this.id = id
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
export function expresses<
|
||||||
|
Traits extends readonly Trait<any>[],
|
||||||
|
>(
|
||||||
|
...traits: Traits
|
||||||
|
) {
|
||||||
|
return extendsAndExpresses(Object, ...traits)
|
||||||
|
}
|
||||||
172
src/index.ts
172
src/index.ts
@@ -1,170 +1,2 @@
|
|||||||
import { AbstractClass, AbstractConstructor, Opaque, UnionToIntersection } from "type-fest"
|
export * from "./expresses"
|
||||||
|
export * from "./trait"
|
||||||
|
|
||||||
/**
|
|
||||||
* Represents the static members of a class.
|
|
||||||
* @template C - The class type.
|
|
||||||
*/
|
|
||||||
export type StaticMembers<C> = Pick<C, keyof C>
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Represents a trait that can be applied to a class.
|
|
||||||
* @template C - The abstract class type.
|
|
||||||
*/
|
|
||||||
export type Trait<
|
|
||||||
C extends AbstractClass<any>
|
|
||||||
> = Opaque<
|
|
||||||
TraitApplier<C>,
|
|
||||||
"thilatrait/Trait"
|
|
||||||
>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Represents the function signature for applying a trait to a parent class.
|
|
||||||
* @template C - The abstract class type.
|
|
||||||
*/
|
|
||||||
export type TraitApplier<
|
|
||||||
C extends AbstractClass<any>
|
|
||||||
> =
|
|
||||||
(Parent: AbstractConstructor<any>) => C
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Unwraps the type of the class from a given trait.
|
|
||||||
* @template T - The trait type.
|
|
||||||
*/
|
|
||||||
export type UnwrapTraitC<T> =
|
|
||||||
T extends Trait<infer C>
|
|
||||||
? C
|
|
||||||
: never
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Creates a trait using the provided trait applier function.
|
|
||||||
* @template C - The abstract class type.
|
|
||||||
* @param applier - The trait applier function.
|
|
||||||
* @returns A trait.
|
|
||||||
* @example
|
|
||||||
* Creates a trait:
|
|
||||||
* ```ts
|
|
||||||
* const Permissible = trait(Parent => {
|
|
||||||
* abstract class Permissible extends Parent {
|
|
||||||
* static readonly defaultPermissions: string[] = []
|
|
||||||
* permissions: string[] = []
|
|
||||||
*
|
|
||||||
* constructor(...args: any[]) {
|
|
||||||
* super(...args)
|
|
||||||
* }
|
|
||||||
* }
|
|
||||||
*
|
|
||||||
* return Permissible
|
|
||||||
* })
|
|
||||||
* ```
|
|
||||||
* Creates a generic trait:
|
|
||||||
* ```ts
|
|
||||||
* const Identifiable = <ID>() =>
|
|
||||||
* trait(Parent => {
|
|
||||||
* abstract class Identifiable extends Parent {
|
|
||||||
* abstract readonly id: ID
|
|
||||||
*
|
|
||||||
* equals(el: Identifiable) {
|
|
||||||
* return this.id === el.id
|
|
||||||
* }
|
|
||||||
*
|
|
||||||
* constructor(...args: any[]) {
|
|
||||||
* super(...args)
|
|
||||||
* }
|
|
||||||
* }
|
|
||||||
*
|
|
||||||
* return Identifiable
|
|
||||||
* })
|
|
||||||
* ```
|
|
||||||
*/
|
|
||||||
export function trait<
|
|
||||||
C extends AbstractClass<any>
|
|
||||||
>(
|
|
||||||
applier: TraitApplier<C>
|
|
||||||
) {
|
|
||||||
return applier as Trait<C>
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Extends a class with the given traits and expresses their combined functionality.
|
|
||||||
* @template C - The abstract class type.
|
|
||||||
* @template Traits - An array of traits.
|
|
||||||
* @param extend - The class to extend.
|
|
||||||
* @param traits - An array of traits to apply.
|
|
||||||
* @returns A new class type expressing the combined functionality of the base class and traits.
|
|
||||||
* @example
|
|
||||||
* Extends a superclass and applies traits:
|
|
||||||
* ```ts
|
|
||||||
* class User extends extendsAndExpresses(Entity, [Identifiable<bigint>(), Permissible]) {
|
|
||||||
* readonly id: bigint
|
|
||||||
*
|
|
||||||
* constructor(id: bigint) {
|
|
||||||
* super()
|
|
||||||
* this.id = id
|
|
||||||
* }
|
|
||||||
* }
|
|
||||||
* ```
|
|
||||||
*/
|
|
||||||
export function extendsAndExpresses<
|
|
||||||
C extends AbstractClass<any>,
|
|
||||||
Traits extends readonly Trait<any>[],
|
|
||||||
>(
|
|
||||||
extend: C,
|
|
||||||
traits: Traits,
|
|
||||||
) {
|
|
||||||
return traits.reduce(
|
|
||||||
(previous, trait) => trait(previous),
|
|
||||||
extend,
|
|
||||||
) as (
|
|
||||||
AbstractClass<
|
|
||||||
InstanceType<C> &
|
|
||||||
UnionToIntersection<
|
|
||||||
InstanceType<
|
|
||||||
UnwrapTraitC<
|
|
||||||
Traits[number]
|
|
||||||
>
|
|
||||||
>
|
|
||||||
>,
|
|
||||||
|
|
||||||
ConstructorParameters<C>
|
|
||||||
> &
|
|
||||||
|
|
||||||
StaticMembers<C> &
|
|
||||||
StaticMembers<
|
|
||||||
UnionToIntersection<
|
|
||||||
UnwrapTraitC<
|
|
||||||
Traits[number]
|
|
||||||
>
|
|
||||||
>
|
|
||||||
>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Expresses the combined functionality of multiple traits.
|
|
||||||
* @template Traits - An array of trait.
|
|
||||||
* @param traits - An array of trait to apply.
|
|
||||||
* @returns A new class type expressing the combined functionality of the traits.
|
|
||||||
* @example
|
|
||||||
* Applies traits to a class:
|
|
||||||
* ```ts
|
|
||||||
* class User extends expresses(Identifiable<bigint>(), Permissible) {
|
|
||||||
* readonly id: bigint
|
|
||||||
*
|
|
||||||
* constructor(id: bigint) {
|
|
||||||
* super()
|
|
||||||
* this.id = id
|
|
||||||
* }
|
|
||||||
* }
|
|
||||||
* ```
|
|
||||||
*/
|
|
||||||
export function expresses<
|
|
||||||
Traits extends readonly Trait<any>[],
|
|
||||||
>(
|
|
||||||
...traits: Traits
|
|
||||||
) {
|
|
||||||
return extendsAndExpresses(Object, traits)
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,74 +0,0 @@
|
|||||||
import { AbstractClass } from "type-fest"
|
|
||||||
import { expresses } from "./trait"
|
|
||||||
|
|
||||||
|
|
||||||
function inspectClass(class_: AbstractClass<any, any>) {
|
|
||||||
Object.getOwnPropertyNames(class_).forEach(name => {
|
|
||||||
console.log(
|
|
||||||
"[static]",
|
|
||||||
name,
|
|
||||||
Object.getOwnPropertyDescriptor(class_, name)
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
Object.getOwnPropertyNames(class_.prototype).forEach(name => {
|
|
||||||
console.log(
|
|
||||||
"[prototype]",
|
|
||||||
name,
|
|
||||||
Object.getOwnPropertyDescriptor(class_.prototype, name)
|
|
||||||
)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
abstract class Identified<ID> {
|
|
||||||
abstract id: ID
|
|
||||||
|
|
||||||
equals(el: Identified<ID>) {
|
|
||||||
return this.id === el.id
|
|
||||||
}
|
|
||||||
|
|
||||||
// initializer() {
|
|
||||||
// console.log("Identified initializer")
|
|
||||||
// }
|
|
||||||
}
|
|
||||||
|
|
||||||
class ImplementsIdentifiable<ID> extends Identified<ID> {
|
|
||||||
id!: ID
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
abstract class Permissible {
|
|
||||||
static readonly defaultPermissions: string[] = []
|
|
||||||
permissions: string[] = []
|
|
||||||
// permissions!: string[]
|
|
||||||
|
|
||||||
constructor() {
|
|
||||||
console.log("Permissible constructor")
|
|
||||||
}
|
|
||||||
|
|
||||||
initializer() {
|
|
||||||
console.log("Permissible initializer")
|
|
||||||
this.permissions = []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
class User extends expresses(
|
|
||||||
Identified as typeof Identified<bigint>,
|
|
||||||
// Identified<string>,
|
|
||||||
Permissible,
|
|
||||||
) {
|
|
||||||
readonly id: bigint
|
|
||||||
|
|
||||||
constructor(id: bigint) {
|
|
||||||
super()
|
|
||||||
this.id = id
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const user1 = new User(BigInt(1))
|
|
||||||
const user2 = new User(BigInt(2))
|
|
||||||
|
|
||||||
console.log(user1)
|
|
||||||
console.log(user1.equals(user2))
|
|
||||||
@@ -1,126 +0,0 @@
|
|||||||
import { AbstractClass, Class, UnionToIntersection } from "type-fest"
|
|
||||||
import { StaticMembers, copyProperties, getInheritanceHierarchy } from "./util/class"
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Represents a trait that can be used to define common behavior
|
|
||||||
* for classes and abstract classes.
|
|
||||||
* @typeParam T - The type of the trait.
|
|
||||||
*/
|
|
||||||
export type Trait<T> =
|
|
||||||
AbstractClass<T, []>
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Creates a link class that expresses the given traits.
|
|
||||||
* @param traits - An array of traits to be expressed by the link class.
|
|
||||||
* @returns A dynamically created class that expresses the given traits.
|
|
||||||
* @typeParam Traits - An array of traits that the link class expresses.
|
|
||||||
*/
|
|
||||||
export function expresses<
|
|
||||||
Traits extends readonly Trait<any>[]
|
|
||||||
>(
|
|
||||||
...traits: Traits
|
|
||||||
) {
|
|
||||||
return makeLinkClass(traits)
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Creates a link class that extends a base class and expresses the given traits.
|
|
||||||
* @param extend - The base class or abstract class to extend.
|
|
||||||
* @param traits - An array of traits to be expressed by the link class.
|
|
||||||
* @returns A dynamically created class that extends the given base class and expresses the given traits.
|
|
||||||
* @typeParam C - The type of the base class to extend.
|
|
||||||
* @typeParam Traits - An array of traits that the link class expresses.
|
|
||||||
*/
|
|
||||||
export function extendsAndExpresses<
|
|
||||||
C extends Class<any, any>
|
|
||||||
| AbstractClass<any, any>,
|
|
||||||
Traits extends readonly Trait<any>[],
|
|
||||||
>(
|
|
||||||
extend: C,
|
|
||||||
...traits: Traits
|
|
||||||
) {
|
|
||||||
return makeLinkClass(traits, extend)
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Creates a link class that expresses the given traits and optionally extends a base class.
|
|
||||||
* @param traits - An array of traits to be expressed by the link class.
|
|
||||||
* @param extend - The base class or abstract class to extend (optional).
|
|
||||||
* @returns A dynamically created class that expresses the given traits and extends the base class.
|
|
||||||
* @typeParam Traits - An array of traits that the link class expresses.
|
|
||||||
* @typeParam C - The type of the base class to extend (optional).
|
|
||||||
*/
|
|
||||||
export function makeLinkClass<
|
|
||||||
Traits extends readonly Trait<any>[],
|
|
||||||
C extends Class<any, any>
|
|
||||||
| AbstractClass<any, any>
|
|
||||||
| undefined = undefined,
|
|
||||||
>(
|
|
||||||
traits: Traits,
|
|
||||||
extend?: C,
|
|
||||||
) {
|
|
||||||
const class_ = extend
|
|
||||||
? class extends extend {
|
|
||||||
constructor(...args: any[]) {
|
|
||||||
super(...args)
|
|
||||||
|
|
||||||
traits.forEach(trait => {
|
|
||||||
trait.prototype.initializer?.call(this)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
: class {
|
|
||||||
constructor() {
|
|
||||||
traits.forEach(trait => {
|
|
||||||
trait.prototype.initializer?.call(this)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
traits.forEach(trait => {
|
|
||||||
getInheritanceHierarchy(trait).forEach(current => {
|
|
||||||
copyProperties(
|
|
||||||
current,
|
|
||||||
class_,
|
|
||||||
["name", "length"],
|
|
||||||
["constructor"],
|
|
||||||
)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
return class_ as unknown as (
|
|
||||||
(C extends Class<any, any> | AbstractClass<any, any>
|
|
||||||
? (
|
|
||||||
AbstractClass<
|
|
||||||
InstanceType<C> &
|
|
||||||
UnionToIntersection<
|
|
||||||
InstanceType<
|
|
||||||
Traits[number]
|
|
||||||
>
|
|
||||||
>,
|
|
||||||
|
|
||||||
ConstructorParameters<C>
|
|
||||||
> &
|
|
||||||
|
|
||||||
StaticMembers<C>
|
|
||||||
)
|
|
||||||
: Trait<
|
|
||||||
UnionToIntersection<
|
|
||||||
InstanceType<
|
|
||||||
Traits[number]
|
|
||||||
>
|
|
||||||
>
|
|
||||||
>
|
|
||||||
) &
|
|
||||||
|
|
||||||
StaticMembers<
|
|
||||||
UnionToIntersection<
|
|
||||||
Traits[number]
|
|
||||||
>
|
|
||||||
>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@@ -1,109 +0,0 @@
|
|||||||
import { AbstractClass } from "type-fest"
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Represents the static members of a class.
|
|
||||||
*
|
|
||||||
* @template C - The type of the class for which static members are extracted.
|
|
||||||
* @typeparam The static members of the class.
|
|
||||||
*/
|
|
||||||
export type StaticMembers<C> = Pick<C, keyof C>
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Flattens the inheritance hierarchy of a given class by copying all properties
|
|
||||||
* from its superclass chain into a single object.
|
|
||||||
*
|
|
||||||
* @template C - The type of the class to be flattened, extending AbstractClass<any, any>.
|
|
||||||
* @param C - The class to be flattened.
|
|
||||||
* @returns A new class with properties flattened from the entire inheritance hierarchy.
|
|
||||||
*/
|
|
||||||
export function flattenClass<
|
|
||||||
C extends AbstractClass<any, any>
|
|
||||||
>(class_: C) {
|
|
||||||
const flattenedClass = class {} as unknown as C
|
|
||||||
|
|
||||||
getInheritanceHierarchy(class_).forEach(current => {
|
|
||||||
copyProperties(current, flattenedClass)
|
|
||||||
})
|
|
||||||
|
|
||||||
copyProperty(class_, flattenedClass, "name")
|
|
||||||
copyProperty(class_.prototype, flattenedClass.prototype, "constructor")
|
|
||||||
|
|
||||||
return flattenedClass
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Retrieves the inheritance hierarchy of a given class, including itself.
|
|
||||||
*
|
|
||||||
* @param class_ - The class for which the inheritance hierarchy is retrieved.
|
|
||||||
* @returns An array representing the inheritance hierarchy, ordered from the furthest in the hierarchy to `class_` itself.
|
|
||||||
*/
|
|
||||||
export function getInheritanceHierarchy(
|
|
||||||
class_: AbstractClass<any, any>
|
|
||||||
): AbstractClass<any, any>[] {
|
|
||||||
const parent = Object.getPrototypeOf(class_)
|
|
||||||
|
|
||||||
return isClass(parent)
|
|
||||||
? [...getInheritanceHierarchy(parent), class_]
|
|
||||||
: [class_]
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Checks if a given element appears to be a class based on its string representation.
|
|
||||||
*
|
|
||||||
* @param el - The element to check for being a class.
|
|
||||||
* @returns `true` if the element is likely a class; otherwise, `false`.
|
|
||||||
*/
|
|
||||||
export function isClass(el: { toString: () => string }) {
|
|
||||||
return Boolean(el.toString().match(/^class(?: [.\S]+)?(?: extends [.\S]+)? {[\s\S]*}$/))
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Copies properties from one class to another, including static and prototype properties.
|
|
||||||
*
|
|
||||||
* @param from - The source class to copy properties from.
|
|
||||||
* @param to - The destination class to copy properties to.
|
|
||||||
*/
|
|
||||||
export function copyProperties(
|
|
||||||
from: AbstractClass<any, any>,
|
|
||||||
to: AbstractClass<any, any>,
|
|
||||||
ignoreKeys: string[] = [],
|
|
||||||
ignorePrototypeKeys: string[] = [],
|
|
||||||
) {
|
|
||||||
Object.getOwnPropertyNames(from).forEach(name => {
|
|
||||||
if (name === "prototype"
|
|
||||||
|| ignoreKeys.find(v => v === name)
|
|
||||||
)
|
|
||||||
return
|
|
||||||
|
|
||||||
// console.log(from, to, name, Object.getOwnPropertyDescriptor(from, name))
|
|
||||||
|
|
||||||
copyProperty(from, to, name)
|
|
||||||
})
|
|
||||||
|
|
||||||
Object.getOwnPropertyNames(from.prototype).forEach(name => {
|
|
||||||
if (ignorePrototypeKeys.find(v => v === name))
|
|
||||||
return
|
|
||||||
|
|
||||||
// console.log(from, to, name, Object.getOwnPropertyDescriptor(from, name))
|
|
||||||
|
|
||||||
copyProperty(from.prototype, to.prototype, name)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
export function copyProperty(
|
|
||||||
from: unknown,
|
|
||||||
to: unknown,
|
|
||||||
name: string,
|
|
||||||
) {
|
|
||||||
Object.defineProperty(
|
|
||||||
to,
|
|
||||||
name,
|
|
||||||
Object.getOwnPropertyDescriptor(from, name) || Object.create(null),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
72
src/tests.ts
72
src/tests.ts
@@ -1,9 +1,11 @@
|
|||||||
import { expresses, trait } from "."
|
import { AbstractClass } from "type-fest"
|
||||||
|
import { expresses, extendsAndExpresses, trait } from "."
|
||||||
|
import { ClassesInstances, MergeInheritanceTree } from "./util"
|
||||||
|
|
||||||
|
|
||||||
const Identifiable = <ID>() =>
|
const Identifiable = <ID>() =>
|
||||||
trait(Parent => {
|
trait(Super => {
|
||||||
abstract class Identifiable extends Parent {
|
abstract class Identifiable extends Super {
|
||||||
abstract readonly id: ID
|
abstract readonly id: ID
|
||||||
|
|
||||||
equals(el: Identifiable) {
|
equals(el: Identifiable) {
|
||||||
@@ -20,17 +22,25 @@ const Identifiable = <ID>() =>
|
|||||||
})
|
})
|
||||||
|
|
||||||
const ImplementsIdentifiable = <ID>(defaultID: ID) =>
|
const ImplementsIdentifiable = <ID>(defaultID: ID) =>
|
||||||
trait(Parent => {
|
trait(Super => {
|
||||||
abstract class ImplementsIdentifiable extends Identifiable<ID>()(Parent) {
|
abstract class ImplementsIdentifiable extends extendsAndExpresses(
|
||||||
|
Super,
|
||||||
|
Identifiable<ID>(),
|
||||||
|
) {
|
||||||
id: ID = defaultID
|
id: ID = defaultID
|
||||||
|
|
||||||
|
constructor(...args: any[]) {
|
||||||
|
super(...args)
|
||||||
|
console.log("ImplementsIdentifiable constructor")
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return ImplementsIdentifiable
|
return ImplementsIdentifiable
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|
||||||
const Permissible = trait(Parent => {
|
const Permissible = trait(Super => {
|
||||||
abstract class Permissible extends Parent {
|
abstract class Permissible extends Super {
|
||||||
static readonly defaultPermissions: string[] = []
|
static readonly defaultPermissions: string[] = []
|
||||||
permissions: string[] = []
|
permissions: string[] = []
|
||||||
|
|
||||||
@@ -60,3 +70,51 @@ class User extends UserProto {
|
|||||||
const user1 = new User(1n)
|
const user1 = new User(1n)
|
||||||
console.log(user1)
|
console.log(user1)
|
||||||
console.log(user1.equals(user1))
|
console.log(user1.equals(user1))
|
||||||
|
|
||||||
|
|
||||||
|
const Test1 = trait(Super => {
|
||||||
|
abstract class Test1 extends Super {
|
||||||
|
declare static name: string
|
||||||
|
declare static testValue: (
|
||||||
|
{ _tag: "type1", value: string } |
|
||||||
|
{ _tag: "type2", value: number }
|
||||||
|
)
|
||||||
|
|
||||||
|
abstract name: string
|
||||||
|
|
||||||
|
declare createdAt: Date
|
||||||
|
declare readonly status: (
|
||||||
|
{ _tag: "awaitingPayment" } |
|
||||||
|
{ _tag: "active", activeSince: Date, expiresAt?: Date } |
|
||||||
|
{ _tag: "expired", expiredSince: Date }
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return Test1
|
||||||
|
})
|
||||||
|
|
||||||
|
const Test2 = trait(Super => {
|
||||||
|
abstract class Test2 extends Super {
|
||||||
|
declare readonly status: { _tag: "active", activeSince: Date, expiresAt?: Date }
|
||||||
|
}
|
||||||
|
|
||||||
|
return Test2
|
||||||
|
})
|
||||||
|
|
||||||
|
const Test3 = trait(Super => {
|
||||||
|
abstract class Test3 extends Super {
|
||||||
|
declare static testValue: { _tag: "type2", value: number }
|
||||||
|
declare lol: 10n
|
||||||
|
}
|
||||||
|
|
||||||
|
return Test3
|
||||||
|
})
|
||||||
|
|
||||||
|
const TestObjectProto = expresses(Test1, Test2, Test3)
|
||||||
|
TestObjectProto.testValue
|
||||||
|
|
||||||
|
type CleanupInheritanceTreeProperties<Classes extends readonly AbstractClass<any>[]> = (
|
||||||
|
MergeInheritanceTree<
|
||||||
|
ClassesInstances<Classes>
|
||||||
|
>
|
||||||
|
)
|
||||||
|
|||||||
117
src/trait.ts
Normal file
117
src/trait.ts
Normal file
@@ -0,0 +1,117 @@
|
|||||||
|
import { AbstractClass, AbstractConstructor, Opaque } from "type-fest"
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents a trait that can be applied to a class.
|
||||||
|
* @template C - The abstract class type.
|
||||||
|
*/
|
||||||
|
export type Trait<
|
||||||
|
C extends AbstractClass<any>
|
||||||
|
> = Opaque<
|
||||||
|
TraitApplier<C>,
|
||||||
|
"@thilawyn/thilatrait/Trait"
|
||||||
|
>
|
||||||
|
|
||||||
|
export type TraitApplierSuperTag = "@thilawyn/thilatrait/Super"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents the function signature for applying a trait to a parent class.
|
||||||
|
* @template C - The abstract class type.
|
||||||
|
*/
|
||||||
|
export type TraitApplier<
|
||||||
|
C extends AbstractClass<any>
|
||||||
|
> = (
|
||||||
|
(Super: Opaque<AbstractConstructor<object>, TraitApplierSuperTag>) => Opaque<C, TraitApplierSuperTag>
|
||||||
|
)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a trait using the provided trait applier function.
|
||||||
|
* @template C - The abstract class type.
|
||||||
|
* @param applier - The trait applier function.
|
||||||
|
* @returns A trait.
|
||||||
|
* @example
|
||||||
|
* Creates a trait:
|
||||||
|
* ```ts
|
||||||
|
* const Permissible = trait(Super => {
|
||||||
|
* abstract class Permissible extends Super {
|
||||||
|
* static readonly defaultPermissions: string[] = []
|
||||||
|
* permissions: string[] = []
|
||||||
|
*
|
||||||
|
* // Constructor is optional
|
||||||
|
* // If you wish to use it, make sure it takes any[] as an args array and passes it to the super call. This is necessary for inheritance to work properly.
|
||||||
|
* // Trait constructors cannot have typed arguments of their own, they only serve to run logic during object instantiation.
|
||||||
|
* constructor(...args: any[]) {
|
||||||
|
* super(...args)
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* return Permissible
|
||||||
|
* })
|
||||||
|
* ```
|
||||||
|
* Creates a generic trait:
|
||||||
|
* ```ts
|
||||||
|
* const Identifiable = <ID>() =>
|
||||||
|
* trait(Super => {
|
||||||
|
* abstract class Identifiable extends Super {
|
||||||
|
* abstract readonly id: ID
|
||||||
|
*
|
||||||
|
* equals(el: Identifiable) {
|
||||||
|
* return this.id === el.id
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* // Optional
|
||||||
|
* constructor(...args: any[]) {
|
||||||
|
* super(...args)
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* return Identifiable
|
||||||
|
* })
|
||||||
|
* ```
|
||||||
|
* Creates a subtrait:
|
||||||
|
* ```ts
|
||||||
|
* const ImplementsIdentifiable = <ID>(defaultID: ID) =>
|
||||||
|
* trait(Super => {
|
||||||
|
* abstract class ImplementsIdentifiable extends extendsAndExpresses(
|
||||||
|
* Super,
|
||||||
|
* Identifiable<ID>(),
|
||||||
|
* ) {
|
||||||
|
* id: ID = defaultID
|
||||||
|
*
|
||||||
|
* // Optional
|
||||||
|
* constructor(...args: any[]) {
|
||||||
|
* super(...args)
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* return ImplementsIdentifiable
|
||||||
|
* })
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
export function trait<
|
||||||
|
C extends AbstractClass<any>
|
||||||
|
>(
|
||||||
|
applier: TraitApplier<C>
|
||||||
|
) {
|
||||||
|
return applier as Trait<C>
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the class type of a trait.
|
||||||
|
* @template T - The trait type.
|
||||||
|
*/
|
||||||
|
export type TraitClass<T> = (
|
||||||
|
T extends Trait<infer C>
|
||||||
|
? C
|
||||||
|
: never
|
||||||
|
)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the instance type of a trait.
|
||||||
|
* @template T - The trait type.
|
||||||
|
*/
|
||||||
|
export type TraitInstance<T> = (
|
||||||
|
T extends Trait<infer C>
|
||||||
|
? InstanceType<C>
|
||||||
|
: never
|
||||||
|
)
|
||||||
66
src/util/class.ts
Normal file
66
src/util/class.ts
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
import { AbstractClass } from "type-fest"
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents an array of instances corresponding to the provided classes.
|
||||||
|
* @template Classes - An array of classes extending AbstractClass.
|
||||||
|
*/
|
||||||
|
export type ClassesInstances<Classes extends readonly AbstractClass<any>[]> = (
|
||||||
|
Classes extends [infer Class, ...infer Rest]
|
||||||
|
? Class extends AbstractClass<any>
|
||||||
|
? Rest extends AbstractClass<any>[]
|
||||||
|
? [InstanceType<Class>, ...ClassesInstances<Rest>]
|
||||||
|
: never
|
||||||
|
: never
|
||||||
|
: []
|
||||||
|
)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents an intersection of instances of the provided classes.
|
||||||
|
* @template Classes - An array of classes extending AbstractClass.
|
||||||
|
*/
|
||||||
|
export type ClassesInstancesIntersection<Classes extends readonly AbstractClass<any>[]> = (
|
||||||
|
Classes extends [infer Class, ...infer Rest]
|
||||||
|
? Class extends AbstractClass<any>
|
||||||
|
? Rest extends AbstractClass<any>[]
|
||||||
|
? InstanceType<Class> & ClassesInstancesIntersection<Rest>
|
||||||
|
: never
|
||||||
|
: never
|
||||||
|
: {}
|
||||||
|
)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents the static members of a class.
|
||||||
|
* @template Class - A class extending AbstractClass.
|
||||||
|
*/
|
||||||
|
export type StaticMembers<Class extends AbstractClass<any>> = (
|
||||||
|
Omit<Class, "prototype">
|
||||||
|
)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents an array of static members corresponding to the provided classes.
|
||||||
|
* @template Classes - An array of classes extending AbstractClass.
|
||||||
|
*/
|
||||||
|
export type ClassesStaticMembers<Classes extends readonly AbstractClass<any>[]> = (
|
||||||
|
Classes extends [infer Class, ...infer Rest]
|
||||||
|
? Class extends AbstractClass<any>
|
||||||
|
? Rest extends AbstractClass<any>[]
|
||||||
|
? [StaticMembers<Class>, ...ClassesStaticMembers<Rest>]
|
||||||
|
: never
|
||||||
|
: never
|
||||||
|
: []
|
||||||
|
)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents an intersection of static members of the provided classes.
|
||||||
|
* @template Classes - An array of classes extending AbstractClass.
|
||||||
|
*/
|
||||||
|
export type ClassesStaticMembersIntersection<Classes extends readonly AbstractClass<any>[]> = (
|
||||||
|
Classes extends [infer Class, ...infer Rest]
|
||||||
|
? Class extends AbstractClass<any>
|
||||||
|
? Rest extends AbstractClass<any>[]
|
||||||
|
? StaticMembers<Class> & ClassesStaticMembersIntersection<Rest>
|
||||||
|
: never
|
||||||
|
: never
|
||||||
|
: {}
|
||||||
|
)
|
||||||
3
src/util/index.ts
Normal file
3
src/util/index.ts
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
export * from "./class"
|
||||||
|
export * from "./inheritance"
|
||||||
|
export * from "./trait"
|
||||||
40
src/util/inheritance.ts
Normal file
40
src/util/inheritance.ts
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
/**
|
||||||
|
* Represents the common keys between two types.
|
||||||
|
* @template A - The first type.
|
||||||
|
* @template B - The second type.
|
||||||
|
*/
|
||||||
|
export type CommonKeys<A, B> = Extract<keyof A, keyof B>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Merges an inheritance tree defined by an array of types, considering overrides.
|
||||||
|
* @template T - An array of types representing the inheritance tree.
|
||||||
|
*/
|
||||||
|
export type MergeInheritanceTree<T extends readonly any[]> = (
|
||||||
|
T extends [infer Super, infer Self, ...infer Rest]
|
||||||
|
? Pick<Self, CommonKeys<Self, Super>> extends Pick<Super, CommonKeys<Self, Super>>
|
||||||
|
? MergeInheritanceTree<[
|
||||||
|
Omit<Super, CommonKeys<Self, Super>> & Self,
|
||||||
|
...Rest,
|
||||||
|
]>
|
||||||
|
: never
|
||||||
|
: T extends [infer Self]
|
||||||
|
? Self
|
||||||
|
: void
|
||||||
|
)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Merges an inheritance tree defined by an array of types without allowing overrides.
|
||||||
|
* @template T - An array of types representing the inheritance tree.
|
||||||
|
*/
|
||||||
|
export type MergeInheritanceTreeWithoutOverriding<T extends readonly any[]> = (
|
||||||
|
T extends [infer Super, infer Self, ...infer Rest]
|
||||||
|
? Pick<Self, CommonKeys<Self, Super>> extends Pick<Super, CommonKeys<Self, Super>>
|
||||||
|
? MergeInheritanceTreeWithoutOverriding<[
|
||||||
|
Super & Self,
|
||||||
|
...Rest,
|
||||||
|
]>
|
||||||
|
: never
|
||||||
|
: T extends [infer Self]
|
||||||
|
? Self
|
||||||
|
: void
|
||||||
|
)
|
||||||
16
src/util/trait.ts
Normal file
16
src/util/trait.ts
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
import { Trait, TraitClass } from ".."
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents an array of classes corresponding to the provided traits.
|
||||||
|
* @template Traits - An array of traits extending Trait<any>.
|
||||||
|
*/
|
||||||
|
export type TraitsClasses<Traits extends readonly Trait<any>[]> = (
|
||||||
|
Traits extends [infer T, ...infer Rest]
|
||||||
|
? T extends Trait<any>
|
||||||
|
? Rest extends Trait<any>[]
|
||||||
|
? [TraitClass<T>, ...TraitsClasses<Rest>]
|
||||||
|
: never
|
||||||
|
: never
|
||||||
|
: []
|
||||||
|
)
|
||||||
Reference in New Issue
Block a user