Compare commits

...

50 Commits

Author SHA1 Message Date
Julien Valverdé
8d2cb90f52 Moved Trait helper types to a namespace
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-04 22:20:50 +01:00
Julien Valverdé
891db74032 Moved Trait helper types to a namespace 2024-02-04 22:20:19 +01:00
Julien Valverdé
1dd118d856 Working TraitExpressionBuilder
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-04 22:01:16 +01:00
Julien Valverdé
26daee364d Trait refactoring
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-04 18:10:00 +01:00
Julien Valverdé
74029493e8 trait -> Trait
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-04 17:33:05 +01:00
Julien Valverdé
bb5e85573c TraitExpressionBuilder work
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-04 04:26:20 +01:00
Julien Valverdé
2d32e4807d Tests
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-04 03:32:12 +01:00
Julien Valverdé
f6d2d68eee Subtrait work
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-04 03:19:33 +01:00
Julien Valverdé
781567a3bd TraitExpressionTraitsFn
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-04 02:53:47 +01:00
Julien Valverdé
ec914e0ffd TraitExpressionTraitsFn
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-04 02:22:35 +01:00
Julien Valverdé
1219cd7a89 Fix
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-04 00:30:32 +01:00
Julien Valverdé
0ff6b7896e Trait refactoring
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-04 00:26:09 +01:00
Julien Valverdé
8d29d9ba94 Fix
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-03 23:32:56 +01:00
Julien Valverdé
0d469fabeb Trait refactoring
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-03 23:15:30 +01:00
Julien Valverdé
8af604831b Cleanup
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-03 04:18:31 +01:00
Julien Valverdé
bdfc57481d Refactoring
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-03 04:09:35 +01:00
Julien Valverdé
956457ee18 Fix
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-03 03:22:14 +01:00
Julien Valverdé
be59a6e0ea Subtrait work
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-03 03:12:32 +01:00
Julien Valverdé
c6b9bbe9cb Fix
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-03 02:24:44 +01:00
Julien Valverdé
c044051813 Fix
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-03 02:21:04 +01:00
Julien Valverdé
c1097ff2f2 Trait refactoring
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-03 02:18:36 +01:00
Julien Valverdé
3c40a0a96b Fix
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-03 01:30:20 +01:00
Julien Valverdé
a061bac1de Trait refactoring
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-03 01:09:40 +01:00
Julien Valverdé
acc26c7e0c Subtrait work
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-02 22:42:45 +01:00
Julien Valverdé
58de52ffc0 Fix
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-02 20:14:44 +01:00
Julien Valverdé
7a449c73cc Fixed error detection
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-02 05:44:09 +01:00
Julien Valverdé
29148cd42b Refactoring
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-02 05:10:28 +01:00
Julien Valverdé
01d59f2cef ExtendsAndExpressesReturnType refactoring
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-02 03:27:47 +01:00
Julien Valverdé
939772c89c Cleanup
All checks were successful
continuous-integration/drone/push Build is passing
2024-02-01 05:18:35 +01:00
Julien Valverdé
48f5f44d8f Tests 2024-02-01 04:11:53 +01:00
Julien Valverdé
7eb2b950a8 Detect empty trait arrays 2024-02-01 04:09:52 +01:00
Julien Valverdé
2945cdb7ae Expresses fix 2024-02-01 03:51:07 +01:00
Julien Valverdé
288969a789 Working expresses 2024-02-01 03:41:18 +01:00
Julien Valverdé
a82c978c9e Extendable 2024-02-01 02:21:10 +01:00
Julien Valverdé
a5b8a1c184 Tests 2024-01-31 06:50:27 +01:00
Julien Valverdé
a0aa9446d6 Working exp.extends() 2024-01-31 06:44:18 +01:00
Julien Valverdé
11335f10cd Expresses work 2024-01-31 05:21:56 +01:00
Julien Valverdé
ff3991ae45 Working trait expression implements 2024-01-31 03:22:23 +01:00
Julien Valverdé
e493331ff3 Work 2024-01-29 18:39:20 +01:00
Julien Valverdé
5f0d21d93b HOTScript tests 2024-01-29 17:27:15 +01:00
Julien Valverdé
bb6172381f Tests 2024-01-29 16:59:37 +01:00
Julien Valverdé
f59706d994 Tests 2024-01-29 03:33:43 +01:00
Julien Valverdé
3aade48a7d Trait refactoring 2024-01-29 03:23:09 +01:00
Julien Valverdé
754a5dc420 TraitImplInstance 2024-01-29 02:54:47 +01:00
Julien Valverdé
ecbf936f85 Tests 2024-01-29 01:42:14 +01:00
Julien Valverdé
9834856e8b Tests 2024-01-28 23:43:39 +01:00
Julien Valverdé
8b01a13d7c Expresses work 2024-01-28 22:52:32 +01:00
Julien Valverdé
096d4a92e7 Trait examples 2024-01-28 20:23:44 +01:00
Julien Valverdé
e46f78d93e Trait work 2024-01-28 20:16:10 +01:00
Julien Valverdé
f5ab00c34a Trait reimplementation work 2024-01-28 19:56:12 +01:00
15 changed files with 468 additions and 384 deletions

BIN
bun.lockb

Binary file not shown.

View File

@@ -28,6 +28,7 @@
"clean:node": "rm -rf node_modules" "clean:node": "rm -rf node_modules"
}, },
"dependencies": { "dependencies": {
"hotscript": "^1.0.13",
"type-fest": "^4.10.1" "type-fest": "^4.10.1"
}, },
"devDependencies": { "devDependencies": {

117
src/Trait.ts Normal file
View File

@@ -0,0 +1,117 @@
import { Fn } from "hotscript"
import { AbstractClass, Class, Opaque } from "type-fest"
import { AbstractTag, TraitExpression, TraitExpressionAllTraits, TraitExpressionNullSuperclass, emptyTraitExpression } from "."
import { StaticMembers } from "./util"
type AddAbstractToImplClass<
ImplClass extends Class<{}, []>,
Abstract extends {},
> = (
Class<
InstanceType<ImplClass> & Abstract,
ConstructorParameters<ImplClass>
> &
StaticMembers<ImplClass>
)
type RemoveAbstractFromImplClass<
ImplClassWithAbstract extends Class<Abstract, []>,
Abstract extends {},
> = (
Class<
Omit<InstanceType<ImplClassWithAbstract>, keyof Abstract>,
ConstructorParameters<ImplClassWithAbstract>
> &
StaticMembers<ImplClassWithAbstract>
)
export class Trait<
Super extends TraitExpression<typeof TraitExpressionNullSuperclass, Trait<any, any, any>[], Trait<any, any, any>[]>,
Abstract extends {},
ImplClass extends Class<{}, []>,
> {
constructor(
readonly supertraits: Super,
readonly abstract: Abstract,
readonly apply: (Super: AbstractClass<{}>) => ImplClass,
) {}
}
export namespace Trait {
export type OwnAbstract<T> = (
T extends Trait<any, infer Abstract, any>
? Abstract
: never
)
export interface OwnAbstractFn extends Fn {
return: Trait.OwnAbstract<this["arg0"]>
}
export type OwnImplClass<T> = (
T extends Trait<any, any, infer ImplClass>
? ImplClass
: never
)
export interface OwnImplClassFn extends Fn {
return: Trait.OwnImplClass<this["arg0"]>
}
export type OwnImplInstance<T> = (
T extends Trait<any, any, infer ImplClass>
? InstanceType<ImplClass>
: never
)
export interface OwnImplInstanceFn extends Fn {
return: Trait.OwnImplInstance<this["arg0"]>
}
export type OwnClass<T> = (
T extends Trait<any, infer Abstract, infer ImplClass>
? AddAbstractToImplClass<ImplClass, Abstract>
: never
)
export interface OwnClassFn extends Fn {
return: Trait.OwnClass<this["arg0"]>
}
export type OwnInstance<T> = (
T extends Trait<any, infer Abstract, infer ImplClass>
? InstanceType<
AddAbstractToImplClass<ImplClass, Abstract>
>
: never
)
export interface OwnInstanceFn extends Fn {
return: Trait.OwnInstance<this["arg0"]>
}
export type Supertraits<T> = (
T extends Trait<infer Super, any, any>
? TraitExpressionAllTraits<Super>
: never
)
export interface SupertraitsFn extends Fn {
return: Trait.Supertraits<this["arg0"]>
}
}
export type TraitApplierSuperTag = "@thilawyn/traitify-ts/TraitApplierSuper"
export function trait<
Abstract extends {},
ImplClassWithAbstract extends Class<Abstract, []>,
>(
abstract: Opaque<Abstract, AbstractTag>,
apply: (Super: Opaque<AbstractClass<Abstract>, TraitApplierSuperTag>) => (
Opaque<ImplClassWithAbstract, TraitApplierSuperTag>
),
) {
return new Trait(
emptyTraitExpression,
abstract as Abstract,
apply as any as (Super: AbstractClass<{}>) => RemoveAbstractFromImplClass<ImplClassWithAbstract, Abstract>,
)
}

107
src/TraitExpression.ts Normal file
View File

@@ -0,0 +1,107 @@
import { Call, Fn, Pipe, Tuples } from "hotscript"
import { AbstractClass, Class, Opaque } from "type-fest"
import { AbstractTag, Trait, TraitApplierSuperTag } from "."
import { ExtendFn, SimplifyFn, StaticMembersFn } from "./util"
export class TraitExpressionNullSuperclass {}
export class TraitExpression<
Super extends AbstractClass<{}>,
OwnTraits extends Trait<any, any, any>[],
AllTraits extends Trait<any, any, any>[],
> {
constructor(
readonly superclass: Super,
readonly ownTraits: OwnTraits,
readonly allTraits: AllTraits,
) {}
get extends(): (
AbstractClass<
Pipe<[
InstanceType<Super>,
...Call<Tuples.Map<Trait.OwnImplInstanceFn>, OwnTraits>,
], [
ExtendFn,
SimplifyFn,
]>,
ConstructorParameters<Super>
> &
Pipe<[
Super,
...Call<Tuples.Map<Trait.OwnImplClassFn>, OwnTraits>,
], [
Tuples.Map<StaticMembersFn>,
ExtendFn,
SimplifyFn,
]>
) {
return this.allTraits.reduce(
(previous, trait) => trait.apply(previous),
this.superclass as Opaque<Super, TraitApplierSuperTag>,
) as any
}
subtrait<
SubtraitAbstract extends {},
SubtraitImplWithAbstract extends Class<{}>,
>(
abstract: (
abstract: Pipe<typeof this, [
]>
) => Opaque<SubtraitAbstract, AbstractTag>,
// impl: ()
) {
}
}
export type TraitExpressionSuper<T> = (
T extends TraitExpression<infer Super, any, any>
? Super
: never
)
export interface TraitExpressionSuperFn extends Fn {
return: TraitExpressionSuper<this["arg0"]>
}
export type TraitExpressionOwnTraits<T> = (
T extends TraitExpression<any, infer OwnTraits, any>
? OwnTraits
: never
)
export interface TraitExpressionOwnTraitsFn extends Fn {
return: TraitExpressionOwnTraits<this["arg0"]>
}
export type TraitExpressionAllTraits<T> = (
T extends TraitExpression<any, any, infer AllTraits>
? AllTraits
: never
)
export interface TraitExpressionAllTraitsFn extends Fn {
return: TraitExpressionAllTraits<this["arg0"]>
}
export type Implements<Exp extends TraitExpression<any, any, any>> = (
Exp extends TraitExpression<any, infer AllTraits, any>
? Pipe<AllTraits, [
Tuples.Map<Trait.OwnAbstractFn>,
ExtendFn,
SimplifyFn,
]>
: never
)
export const emptyTraitExpression = new TraitExpression(
TraitExpressionNullSuperclass,
[] as const,
[] as const,
)

View File

@@ -0,0 +1,134 @@
import { Call, Fn, Pipe, Tuples } from "hotscript"
import { AbstractClass } from "type-fest"
import { Trait, TraitExpression, emptyTraitExpression } from "."
import { ExtendableFn, StaticMembersFn } from "./util"
class TraitExpressionBuilder<
Super extends AbstractClass<{}>,
OwnTraits extends Trait<any, any, any>[],
AllTraits extends Trait<any, any, any>[],
> {
constructor(public expression: TraitExpression<Super, OwnTraits, AllTraits>) {}
extends<
NewSuper extends AbstractClass<any>
>(superclass: NewSuper) {
return new TraitExpressionBuilder(
new TraitExpression(
superclass,
this.expression.ownTraits,
this.expression.allTraits,
)
)
}
expresses<
Traits extends Trait<any, any, any>[]
>(
...traits: Traits
): TraitExpressionBuilder<
Super,
[...OwnTraits, ...Traits],
[...AllTraits, SpreadSupertraits<Traits>]
> {
return new TraitExpressionBuilder(
new TraitExpression(
this.expression.superclass,
[...this.expression.ownTraits, ...traits] as const,
[...this.expression.allTraits, ...this.spreadSupertraits(traits)] as const,
)
) as any
}
private spreadSupertraits<
Traits extends Trait<
TraitExpression<any, any, Trait<any, any, any>[]>,
any,
any
>[]
>(
traits: Traits
) {
return traits.flatMap(trait => [
...trait.supertraits.allTraits,
trait,
]) as SpreadSupertraits<Traits>
}
get() {
return this.expression as GetTraitExpression<Super, OwnTraits, AllTraits>
}
then<V>(fn: (expression: ReturnType<typeof this.get>) => V): V {
return fn(this.get())
}
}
type SpreadSupertraits<Traits extends Trait<any, any, any>[]> = (
Call<
Tuples.FlatMap<PrependTraitSupertraitsFn>,
Traits
>
)
interface PrependTraitSupertraitsFn extends Fn {
return: this["arg0"] extends Trait<infer Super, any, any>
? Super extends TraitExpression<any, any, infer AllTraits>
? [...AllTraits, this["arg0"]]
: never
: never
}
type AbstractMembersExtendable<
Super extends AbstractClass<{}>,
Traits extends Trait<any, any, any>[],
> = (
Call<ExtendableFn, [
InstanceType<Super>,
...Call<Tuples.Map<Trait.OwnAbstractFn>, Traits>,
]>
)
type ImplInstanceExtendable<
Super extends AbstractClass<{}>,
Traits extends Trait<any, any, any>[],
> = (
Call<ExtendableFn, [
InstanceType<Super>,
...Call<Tuples.Map<Trait.OwnImplInstanceFn>, Traits>,
]>
)
type ImplStaticMembersExtendable<
Super extends AbstractClass<{}>,
Traits extends Trait<any, any, any>[],
> = (
Pipe<[
Super,
...Call<Tuples.Map<Trait.OwnImplClassFn>, Traits>,
], [
Tuples.Map<StaticMembersFn>,
ExtendableFn,
]>
)
type GetTraitExpression<
Super extends AbstractClass<{}>,
OwnTraits extends Trait<any, any, any>[],
AllTraits extends Trait<any, any, any>[],
> = (
Call<Tuples.IsEmpty, OwnTraits> extends true
? "Cannot express an empty list of traits."
: AbstractMembersExtendable<Super, OwnTraits> extends false
? "Type conflict between the traits abstract members and/or the superclass instance."
: ImplInstanceExtendable<Super, OwnTraits> extends false
? "Type conflict between the traits implementation instances and/or the superclass instance."
: ImplStaticMembersExtendable<Super, OwnTraits> extends false
? "Type conflict between the traits implementation static members and/or the superclass static members."
: TraitExpression<Super, OwnTraits, AllTraits>
)
export const expression = new TraitExpressionBuilder(emptyTraitExpression)

10
src/abstract.ts Normal file
View File

@@ -0,0 +1,10 @@
import { Opaque } from "type-fest"
export type AbstractTag = "@thilawyn/traitify-ts/Abstract"
export function abstract<
Abstract extends {} = {}
>() {
return {} as Opaque<Abstract, AbstractTag>
}

View File

@@ -1,84 +0,0 @@
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)
}

View File

@@ -1,2 +1,4 @@
export * from "./expresses" export * from "./Trait"
export * from "./trait" export * from "./TraitExpression"
export * from "./TraitExpressionBuilder"
export * from "./abstract"

View File

@@ -1,131 +1,78 @@
import { AbstractClass } from "type-fest" import { Implements, Trait, abstract, expression, trait } from "."
import { expresses, extendsAndExpresses, trait } from "."
import { ClassesInstances, MergeInheritanceTree } from "./util"
const Identifiable = <ID>() => const PrintsHelloOnNew = trait(
trait(Super => { abstract(),
abstract class Identifiable extends Super { Super => class PrintsHelloOnNew extends Super {
abstract readonly id: ID
equals(el: Identifiable) {
return this.id === el.id
}
constructor(...args: any[]) {
super(...args)
console.log("Identified constructor")
}
}
return Identifiable
})
const ImplementsIdentifiable = <ID>(defaultID: ID) =>
trait(Super => {
abstract class ImplementsIdentifiable extends extendsAndExpresses(
Super,
Identifiable<ID>(),
) {
id: ID = defaultID
constructor(...args: any[]) {
super(...args)
console.log("ImplementsIdentifiable constructor")
}
}
return ImplementsIdentifiable
})
const Permissible = trait(Super => {
abstract class Permissible extends Super {
static readonly defaultPermissions: string[] = []
permissions: string[] = []
constructor(...args: any[]) { constructor(...args: any[]) {
super(...args) super(...args)
console.log("Permissible constructor") console.log("Hello!")
} }
} },
return Permissible
})
const UserProto = expresses(
// Identifiable<bigint>(),
ImplementsIdentifiable(0n),
Permissible,
) )
class User extends UserProto { const Identifiable = <ID>() => trait(
constructor(id: bigint) { abstract<{ readonly id: ID }>(),
super() Super => class Identifiable extends Super {
this.id = id equals(el: Identifiable) {
} return this.id === el.id
} }
},
)
const user1 = new User(1n) const StatefulSubscription = trait(
console.log(user1) abstract<{
console.log(user1.equals(user1)) readonly status: (
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: "awaitingPayment" } |
{ _tag: "active", activeSince: Date, expiresAt?: Date } | { _tag: "active", activeSince: Date, expiresAt?: Date } |
{ _tag: "expired", expiredSince: Date } { _tag: "expired", expiredSince: Date }
) )
} }>(),
return Test1 Super => class StatefulSubscription extends Super {},
}) )
const Test2 = trait(Super => { // interface ActiveStatefulSubscriptionAbstractMembers extends TraitAbstractMembers<typeof StatefulSubscription> {
abstract class Test2 extends Super { // readonly status: { _tag: "active", activeSince: Date, expiresAt?: Date }
declare readonly status: { _tag: "active", activeSince: Date, expiresAt?: Date } // }
}
return Test2 // const ActiveStatefulSubscription = trait(
}) // abstract<ActiveStatefulSubscriptionAbstractMembers>(),
// Super => class ActiveStatefulSubscription extends Super {},
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
interface Gneugneu { class TestSuperclass {
ahi: string // id: number = 69
get adolf(): string // static test = 69
} }
class GneugneuImpl implements Gneugneu {
ahi: string = ""
get adolf(): string {
throw new Error("Method not implemented.")
}
const builder = expression
.extends(TestSuperclass)
.expresses(
PrintsHelloOnNew,
Identifiable<bigint>(),
// Identifiable<number>(),
StatefulSubscription,
)
const exp = builder.get()
type Abs = Implements<typeof exp>
// exp.subtrait(
// s => {
// interface Subtrait extends (typeof s) {
// }
// return abstract<Subtrait>()
// },
// )
class User extends exp.extends implements Implements<typeof exp> {
declare status: { _tag: "awaitingPayment" } | { _tag: "active"; activeSince: Date; expiresAt?: Date | undefined } | { _tag: "expired"; expiredSince: Date }
id: bigint = -1n
} }
abstract class Issou extends GneugneuImpl implements Gneugneu { console.log(new User())
}

View File

@@ -1,117 +0,0 @@
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
)

View File

@@ -1,34 +1,7 @@
import { Fn } from "hotscript"
import { AbstractClass } from "type-fest" 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. * Represents the static members of a class.
* @template Class - A class extending AbstractClass. * @template Class - A class extending AbstractClass.
@@ -37,30 +10,6 @@ export type StaticMembers<Class extends AbstractClass<any>> = (
Omit<Class, "prototype"> Omit<Class, "prototype">
) )
/** export interface StaticMembersFn extends Fn {
* Represents an array of static members corresponding to the provided classes. return: StaticMembers<this["arg0"]>
* @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
: {}
)

26
src/util/extend.ts Normal file
View File

@@ -0,0 +1,26 @@
import { Call, ComposeLeft, Fn, Match, Tuples } from "hotscript"
type CommonKeys<A, B> = Extract<keyof A, keyof B>
type ExtendReducer<Super, Self> = (
Pick<Self, CommonKeys<Self, Super>> extends Pick<Super, CommonKeys<Self, Super>>
? Omit<Super, CommonKeys<Self, Super>> & Self
: never
)
interface ExtendReducerFn extends Fn {
return: ExtendReducer<this["arg0"], this["arg1"]>
}
export type ExtendFn = Tuples.Reduce<ExtendReducerFn, {}>
export type Extend<T extends object[]> = Call<ExtendFn, T>
export type ExtendableFn = ComposeLeft<[
ExtendFn,
Match<[
Match.With<never, false>,
Match.With<any, true>,
]>
]>
export type Extendable<T extends object[]> = Call<ExtendableFn, T>

View File

@@ -1,3 +1,4 @@
export * from "./class" export * from "./class"
export * from "./extend"
export * from "./inheritance" export * from "./inheritance"
export * from "./trait" export * from "./misc"

7
src/util/misc.ts Normal file
View File

@@ -0,0 +1,7 @@
import { Fn } from "hotscript"
import { Simplify } from "type-fest"
export interface SimplifyFn extends Fn {
return: Simplify<this["arg0"]>
}

View File

@@ -1,16 +0,0 @@
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
: []
)