@xylabs/creatable 4.12.17 → 4.12.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/neutral/index.mjs +1 -1
- package/dist/neutral/index.mjs.map +1 -1
- package/dist/types/AbstractCreatable.d.ts +3 -4
- package/dist/types/AbstractCreatable.d.ts.map +1 -1
- package/dist/types/Creatable.d.ts +2 -1
- package/dist/types/Creatable.d.ts.map +1 -1
- package/dist/types/TestCreatable.d.ts +2 -0
- package/dist/types/TestCreatable.d.ts.map +1 -0
- package/package.json +8 -8
- package/src/AbstractCreatable.ts +9 -10
- package/src/Creatable.ts +2 -1
- package/src/TestCreatable.ts +15 -0
package/dist/neutral/index.mjs
CHANGED
|
@@ -46,7 +46,7 @@ var AbstractCreatable = class extends BaseEmitter {
|
|
|
46
46
|
get statusReporter() {
|
|
47
47
|
return this.params.statusReporter;
|
|
48
48
|
}
|
|
49
|
-
static async create(params) {
|
|
49
|
+
static async create(params = {}) {
|
|
50
50
|
const name = params.name ?? this.name;
|
|
51
51
|
params.statusReporter?.report(name, "creating");
|
|
52
52
|
try {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/AbstractCreatable.ts","../../src/lib/getFunctionName.ts","../../src/lib/getRootFunction.ts","../../src/Creatable.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport type { EventData } from '@xylabs/events'\nimport { BaseEmitter } from '@xylabs/events'\nimport { type Logger } from '@xylabs/logger'\nimport type {
|
|
1
|
+
{"version":3,"sources":["../../src/AbstractCreatable.ts","../../src/lib/getFunctionName.ts","../../src/lib/getRootFunction.ts","../../src/Creatable.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport type { EventData } from '@xylabs/events'\nimport { BaseEmitter } from '@xylabs/events'\nimport { type Logger } from '@xylabs/logger'\nimport type { Promisable } from '@xylabs/promise'\nimport { isError } from '@xylabs/typeof'\n\nimport { type Creatable, creatable } from './Creatable.ts'\nimport { getFunctionName, getRootFunction } from './lib/index.ts'\nimport type {\n CreatableInstance, CreatableName, CreatableParams,\n} from './model/index.ts'\n\nexport abstract class AbstractCreatable<TParams extends CreatableParams = CreatableParams,\n TEventData extends EventData = EventData> extends BaseEmitter<Partial<TParams>, TEventData> {\n defaultLogger?: Logger\n name: CreatableName\n\n private _populatedParams: TParams | undefined\n\n constructor(params: Partial<TParams>) {\n super(params)\n this.name = params.name ?? this.constructor.name as CreatableName\n }\n\n override get params(): CreatableParams<TParams> {\n this._noOverride()\n this._populatedParams = this._populatedParams ?? this.paramsHandler(super.params)\n return this._populatedParams\n }\n\n get statusReporter() {\n return this.params.statusReporter\n }\n\n static async create<T extends CreatableInstance>(\n this: Creatable<T>,\n params: Partial<T['params']> = {},\n ): Promise<T> {\n const name: CreatableName = params.name ?? this.name\n params.statusReporter?.report(name, 'creating')\n try {\n const instance = new this(params)\n const initializedInstance = await this.createHandler(instance)\n await instance.createHandler()\n params.statusReporter?.report(name, 'created')\n return initializedInstance\n } catch (ex) {\n params.statusReporter?.report(name, 'error', isError(ex) ? ex : new Error(`Error creating: ${name}`))\n throw new Error(`Error creating: ${name}`)\n }\n }\n\n /* override this for initialization of instance */\n static createHandler<T extends CreatableInstance>(\n this: Creatable<T>,\n instance: T,\n ): Promisable<T> {\n return instance\n }\n\n createHandler(): Promisable<void> {}\n\n async start(): Promise<boolean> {\n this._noOverride('start')\n try {\n this.statusReporter?.report(this.name, 'starting')\n await this.startHandler()\n this.statusReporter?.report(this.name, 'started')\n return true\n } catch (ex) {\n this.statusReporter?.report(this.name, 'error', isError(ex) ? ex : new Error(`Error stopping: ${ex}`))\n return false\n }\n }\n\n async stop(): Promise<boolean> {\n this._noOverride('stop')\n try {\n this.statusReporter?.report(this.name, 'stopping')\n await this.stopHandler()\n this.statusReporter?.report(this.name, 'stopped')\n return true\n } catch (ex) {\n this.statusReporter?.report(this.name, 'error', isError(ex) ? ex : new Error(`Error stopping: ${ex}`))\n return false\n }\n }\n\n protected _noOverride(functionName = getFunctionName(3)) {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const thisFunc = (this as any)[functionName]\n\n const rootFunc = getRootFunction(this, functionName)\n assertEx(thisFunc === rootFunc, () => `Override not allowed for [${functionName}] - override ${functionName}Handler instead`)\n }\n\n protected startHandler(): Promisable<void> {\n // when overriding this, throw an error on failure\n }\n\n protected stopHandler(): Promisable<void> {\n // when overriding this, throw an error on failure\n }\n\n protected abstract paramsHandler(params?: Partial<CreatableParams<TParams>>): CreatableParams<TParams>\n}\n","import { isNumber } from '@xylabs/typeof'\n\nexport function getFunctionName(depth = 2) {\n const error = new Error('Stack')\n let newIndex: number | undefined\n const stackParts = error.stack?.split('\\n')[depth]?.split(' ')\n const funcName\n = stackParts?.find((item, index) => {\n if (item.length > 0 && item !== 'at') {\n // check if constructor\n if (item === 'new') {\n newIndex = index\n }\n return true\n }\n }) ?? '<unknown>'\n return isNumber(newIndex) ? `${funcName} ${stackParts?.[newIndex + 1]}` : funcName\n}\n","export function getRootFunction(obj: unknown, funcName: string) {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n let anyObj = obj as any\n while (anyObj.__proto__?.[funcName]) {\n anyObj = anyObj.__proto__\n }\n return anyObj[funcName]\n}\n","import type { Logger } from '@xylabs/logger'\nimport type { EmptyObject } from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\n\nimport type { AbstractCreatable } from './AbstractCreatable.ts'\nimport type { CreatableInstance, CreatableParams } from './model/index.ts'\n\n/*\nexport interface CreatableFactory<T extends EmptyObject | void = void,\n TParams extends EmptyObject | void = void> {\n create(params?: CreatableParams<TParams>): Promise<CreatableInstance<T>>\n}\n*/\n\nexport interface Creatable<T extends CreatableInstance = CreatableInstance> {\n\n defaultLogger?: Logger\n\n new (params: Partial<T['params']>): T & AbstractCreatable<T['params']>\n\n create<T extends CreatableInstance>(\n this: Creatable<T>,\n params: Partial<T['params']>): Promise<T>\n\n createHandler<T extends CreatableInstance>(\n this: Creatable<T>,\n instance: T\n ): Promisable<T>\n\n /*\n factory<T extends EmptyObject | void = void,\n TParams extends EmptyObject | void = void> (this: Creatable<T, TParams>, params: Partial<CreatableParams<TParams>>): CreatableFactory<T, TParams>\n */\n}\n\n/**\n * Class annotation to be used to decorate Modules which support\n * an asynchronous creation pattern\n * @returns The decorated Module requiring it implement the members\n * of the CreatableModule as statics properties/methods\n */\nexport function creatable<T extends EmptyObject | void = void, TParams extends CreatableParams = CreatableParams>() {\n return <U extends Creatable<CreatableInstance<T, TParams>>>(constructor: U) => {\n // eslint-disable-next-line @typescript-eslint/no-unused-expressions\n constructor\n }\n}\n\n/**\n * Class annotation to be used to decorate Modules which support\n * an asynchronous creation factory pattern\n * @returns The decorated Module requiring it implement the members\n * of the CreatableModule as statics properties/methods\n */\n\n/*\nexport function creatableFactory() {\n return <U extends CreatableFactory>(constructor: U) => {\n // eslint-disable-next-line @typescript-eslint/no-unused-expressions\n constructor\n }\n}\n*/\n"],"mappings":";AAAA,SAAS,gBAAgB;AAEzB,SAAS,mBAAmB;AAG5B,SAAS,eAAe;;;ACLxB,SAAS,gBAAgB;AAElB,SAAS,gBAAgB,QAAQ,GAAG;AACzC,QAAM,QAAQ,IAAI,MAAM,OAAO;AAC/B,MAAI;AACJ,QAAM,aAAa,MAAM,OAAO,MAAM,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG;AAC7D,QAAM,WACE,YAAY,KAAK,CAAC,MAAM,UAAU;AAClC,QAAI,KAAK,SAAS,KAAK,SAAS,MAAM;AAEpC,UAAI,SAAS,OAAO;AAClB,mBAAW;AAAA,MACb;AACA,aAAO;AAAA,IACT;AAAA,EACF,CAAC,KAAK;AACZ,SAAO,SAAS,QAAQ,IAAI,GAAG,QAAQ,IAAI,aAAa,WAAW,CAAC,CAAC,KAAK;AAC5E;;;ACjBO,SAAS,gBAAgB,KAAc,UAAkB;AAE9D,MAAI,SAAS;AACb,SAAO,OAAO,YAAY,QAAQ,GAAG;AACnC,aAAS,OAAO;AAAA,EAClB;AACA,SAAO,OAAO,QAAQ;AACxB;;;AFMO,IAAe,oBAAf,cAC6C,YAA0C;AAAA,EAC5F;AAAA,EACA;AAAA,EAEQ;AAAA,EAER,YAAY,QAA0B;AACpC,UAAM,MAAM;AACZ,SAAK,OAAO,OAAO,QAAQ,KAAK,YAAY;AAAA,EAC9C;AAAA,EAEA,IAAa,SAAmC;AAC9C,SAAK,YAAY;AACjB,SAAK,mBAAmB,KAAK,oBAAoB,KAAK,cAAc,MAAM,MAAM;AAChF,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,iBAAiB;AACnB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,aAAa,OAEX,SAA+B,CAAC,GACpB;AACZ,UAAM,OAAsB,OAAO,QAAQ,KAAK;AAChD,WAAO,gBAAgB,OAAO,MAAM,UAAU;AAC9C,QAAI;AACF,YAAM,WAAW,IAAI,KAAK,MAAM;AAChC,YAAM,sBAAsB,MAAM,KAAK,cAAc,QAAQ;AAC7D,YAAM,SAAS,cAAc;AAC7B,aAAO,gBAAgB,OAAO,MAAM,SAAS;AAC7C,aAAO;AAAA,IACT,SAAS,IAAI;AACX,aAAO,gBAAgB,OAAO,MAAM,SAAS,QAAQ,EAAE,IAAI,KAAK,IAAI,MAAM,mBAAmB,IAAI,EAAE,CAAC;AACpG,YAAM,IAAI,MAAM,mBAAmB,IAAI,EAAE;AAAA,IAC3C;AAAA,EACF;AAAA;AAAA,EAGA,OAAO,cAEL,UACe;AACf,WAAO;AAAA,EACT;AAAA,EAEA,gBAAkC;AAAA,EAAC;AAAA,EAEnC,MAAM,QAA0B;AAC9B,SAAK,YAAY,OAAO;AACxB,QAAI;AACF,WAAK,gBAAgB,OAAO,KAAK,MAAM,UAAU;AACjD,YAAM,KAAK,aAAa;AACxB,WAAK,gBAAgB,OAAO,KAAK,MAAM,SAAS;AAChD,aAAO;AAAA,IACT,SAAS,IAAI;AACX,WAAK,gBAAgB,OAAO,KAAK,MAAM,SAAS,QAAQ,EAAE,IAAI,KAAK,IAAI,MAAM,mBAAmB,EAAE,EAAE,CAAC;AACrG,aAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEA,MAAM,OAAyB;AAC7B,SAAK,YAAY,MAAM;AACvB,QAAI;AACF,WAAK,gBAAgB,OAAO,KAAK,MAAM,UAAU;AACjD,YAAM,KAAK,YAAY;AACvB,WAAK,gBAAgB,OAAO,KAAK,MAAM,SAAS;AAChD,aAAO;AAAA,IACT,SAAS,IAAI;AACX,WAAK,gBAAgB,OAAO,KAAK,MAAM,SAAS,QAAQ,EAAE,IAAI,KAAK,IAAI,MAAM,mBAAmB,EAAE,EAAE,CAAC;AACrG,aAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEU,YAAY,eAAe,gBAAgB,CAAC,GAAG;AAEvD,UAAM,WAAY,KAAa,YAAY;AAE3C,UAAM,WAAW,gBAAgB,MAAM,YAAY;AACnD,aAAS,aAAa,UAAU,MAAM,6BAA6B,YAAY,gBAAgB,YAAY,iBAAiB;AAAA,EAC9H;AAAA,EAEU,eAAiC;AAAA,EAE3C;AAAA,EAEU,cAAgC;AAAA,EAE1C;AAGF;;;AGjEO,SAAS,YAAoG;AAClH,SAAO,CAAqD,gBAAmB;AAE7E;AAAA,EACF;AACF;","names":[]}
|
|
@@ -1,9 +1,8 @@
|
|
|
1
1
|
import type { EventData } from '@xylabs/events';
|
|
2
2
|
import { BaseEmitter } from '@xylabs/events';
|
|
3
3
|
import { type Logger } from '@xylabs/logger';
|
|
4
|
-
import type { EmptyObject } from '@xylabs/object';
|
|
5
4
|
import type { Promisable } from '@xylabs/promise';
|
|
6
|
-
import type
|
|
5
|
+
import { type Creatable } from './Creatable.ts';
|
|
7
6
|
import type { CreatableInstance, CreatableName, CreatableParams } from './model/index.ts';
|
|
8
7
|
export declare abstract class AbstractCreatable<TParams extends CreatableParams = CreatableParams, TEventData extends EventData = EventData> extends BaseEmitter<Partial<TParams>, TEventData> {
|
|
9
8
|
defaultLogger?: Logger;
|
|
@@ -12,8 +11,8 @@ export declare abstract class AbstractCreatable<TParams extends CreatableParams
|
|
|
12
11
|
constructor(params: Partial<TParams>);
|
|
13
12
|
get params(): CreatableParams<TParams>;
|
|
14
13
|
get statusReporter(): import("./model/CreatableStatusReporter.ts").CreatableStatusReporter | undefined;
|
|
15
|
-
static create<T extends
|
|
16
|
-
static createHandler<T extends
|
|
14
|
+
static create<T extends CreatableInstance>(this: Creatable<T>, params?: Partial<T['params']>): Promise<T>;
|
|
15
|
+
static createHandler<T extends CreatableInstance>(this: Creatable<T>, instance: T): Promisable<T>;
|
|
17
16
|
createHandler(): Promisable<void>;
|
|
18
17
|
start(): Promise<boolean>;
|
|
19
18
|
stop(): Promise<boolean>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AbstractCreatable.d.ts","sourceRoot":"","sources":["../../src/AbstractCreatable.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"AbstractCreatable.d.ts","sourceRoot":"","sources":["../../src/AbstractCreatable.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAGjD,OAAO,EAAE,KAAK,SAAS,EAAa,MAAM,gBAAgB,CAAA;AAE1D,OAAO,KAAK,EACV,iBAAiB,EAAE,aAAa,EAAE,eAAe,EAClD,MAAM,kBAAkB,CAAA;AAEzB,8BAAsB,iBAAiB,CAAC,OAAO,SAAS,eAAe,GAAG,eAAe,EACvF,UAAU,SAAS,SAAS,GAAG,SAAS,CAAE,SAAQ,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC3F,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,IAAI,EAAE,aAAa,CAAA;IAEnB,OAAO,CAAC,gBAAgB,CAAqB;gBAEjC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC;IAKpC,IAAa,MAAM,IAAI,eAAe,CAAC,OAAO,CAAC,CAI9C;IAED,IAAI,cAAc,qFAEjB;WAEY,MAAM,CAAC,CAAC,SAAS,iBAAiB,EAC7C,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAClB,MAAM,GAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAM,GAChC,OAAO,CAAC,CAAC,CAAC;IAgBb,MAAM,CAAC,aAAa,CAAC,CAAC,SAAS,iBAAiB,EAC9C,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAClB,QAAQ,EAAE,CAAC,GACV,UAAU,CAAC,CAAC,CAAC;IAIhB,aAAa,IAAI,UAAU,CAAC,IAAI,CAAC;IAE3B,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;IAazB,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;IAa9B,SAAS,CAAC,WAAW,CAAC,YAAY,SAAqB;IAQvD,SAAS,CAAC,YAAY,IAAI,UAAU,CAAC,IAAI,CAAC;IAI1C,SAAS,CAAC,WAAW,IAAI,UAAU,CAAC,IAAI,CAAC;IAIzC,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC;CACvG"}
|
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
import type { Logger } from '@xylabs/logger';
|
|
2
2
|
import type { EmptyObject } from '@xylabs/object';
|
|
3
|
+
import type { Promisable } from '@xylabs/promise';
|
|
3
4
|
import type { AbstractCreatable } from './AbstractCreatable.ts';
|
|
4
5
|
import type { CreatableInstance, CreatableParams } from './model/index.ts';
|
|
5
6
|
export interface Creatable<T extends CreatableInstance = CreatableInstance> {
|
|
6
7
|
defaultLogger?: Logger;
|
|
7
8
|
new (params: Partial<T['params']>): T & AbstractCreatable<T['params']>;
|
|
8
9
|
create<T extends CreatableInstance>(this: Creatable<T>, params: Partial<T['params']>): Promise<T>;
|
|
9
|
-
createHandler<T extends CreatableInstance>(this: Creatable<T>, instance: T):
|
|
10
|
+
createHandler<T extends CreatableInstance>(this: Creatable<T>, instance: T): Promisable<T>;
|
|
10
11
|
}
|
|
11
12
|
/**
|
|
12
13
|
* Class annotation to be used to decorate Modules which support
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Creatable.d.ts","sourceRoot":"","sources":["../../src/Creatable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAS1E,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB;IAExE,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,KAAK,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;IAEtE,MAAM,CAAC,CAAC,SAAS,iBAAiB,EAChC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAClB,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IAE3C,aAAa,CAAC,CAAC,SAAS,iBAAiB,EACvC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAClB,QAAQ,EAAE,CAAC,GACV,
|
|
1
|
+
{"version":3,"file":"Creatable.d.ts","sourceRoot":"","sources":["../../src/Creatable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAS1E,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB;IAExE,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,KAAK,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;IAEtE,MAAM,CAAC,CAAC,SAAS,iBAAiB,EAChC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAClB,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IAE3C,aAAa,CAAC,CAAC,SAAS,iBAAiB,EACvC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAClB,QAAQ,EAAE,CAAC,GACV,UAAU,CAAC,CAAC,CAAC,CAAA;CAMjB;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,eAAe,GAAG,eAAe,MACtG,CAAC,SAAS,SAAS,CAAC,iBAAiB,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,aAAa,CAAC,UAI3E;AAED;;;;;GAKG"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"TestCreatable.d.ts","sourceRoot":"","sources":["../../src/TestCreatable.ts"],"names":[],"mappings":""}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xylabs/creatable",
|
|
3
|
-
"version": "4.12.
|
|
3
|
+
"version": "4.12.18",
|
|
4
4
|
"description": "Primary SDK for using XYO Protocol 2.0",
|
|
5
5
|
"homepage": "https://xyo.network",
|
|
6
6
|
"bugs": {
|
|
@@ -29,13 +29,13 @@
|
|
|
29
29
|
"module": "dist/neutral/index.mjs",
|
|
30
30
|
"types": "dist/types/index.d.ts",
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@xylabs/assert": "^4.12.
|
|
33
|
-
"@xylabs/base": "^4.12.
|
|
34
|
-
"@xylabs/events": "^4.12.
|
|
35
|
-
"@xylabs/logger": "^4.12.
|
|
36
|
-
"@xylabs/object": "^4.12.
|
|
37
|
-
"@xylabs/promise": "^4.12.
|
|
38
|
-
"@xylabs/typeof": "^4.12.
|
|
32
|
+
"@xylabs/assert": "^4.12.18",
|
|
33
|
+
"@xylabs/base": "^4.12.18",
|
|
34
|
+
"@xylabs/events": "^4.12.18",
|
|
35
|
+
"@xylabs/logger": "^4.12.18",
|
|
36
|
+
"@xylabs/object": "^4.12.18",
|
|
37
|
+
"@xylabs/promise": "^4.12.18",
|
|
38
|
+
"@xylabs/typeof": "^4.12.18"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@xylabs/ts-scripts-yarn3": "^6.5.9",
|
package/src/AbstractCreatable.ts
CHANGED
|
@@ -2,11 +2,10 @@ import { assertEx } from '@xylabs/assert'
|
|
|
2
2
|
import type { EventData } from '@xylabs/events'
|
|
3
3
|
import { BaseEmitter } from '@xylabs/events'
|
|
4
4
|
import { type Logger } from '@xylabs/logger'
|
|
5
|
-
import type { EmptyObject } from '@xylabs/object'
|
|
6
5
|
import type { Promisable } from '@xylabs/promise'
|
|
7
6
|
import { isError } from '@xylabs/typeof'
|
|
8
7
|
|
|
9
|
-
import type
|
|
8
|
+
import { type Creatable, creatable } from './Creatable.ts'
|
|
10
9
|
import { getFunctionName, getRootFunction } from './lib/index.ts'
|
|
11
10
|
import type {
|
|
12
11
|
CreatableInstance, CreatableName, CreatableParams,
|
|
@@ -34,10 +33,10 @@ export abstract class AbstractCreatable<TParams extends CreatableParams = Creata
|
|
|
34
33
|
return this.params.statusReporter
|
|
35
34
|
}
|
|
36
35
|
|
|
37
|
-
static async create<T extends
|
|
38
|
-
this: Creatable<
|
|
39
|
-
params: Partial<
|
|
40
|
-
): Promise<
|
|
36
|
+
static async create<T extends CreatableInstance>(
|
|
37
|
+
this: Creatable<T>,
|
|
38
|
+
params: Partial<T['params']> = {},
|
|
39
|
+
): Promise<T> {
|
|
41
40
|
const name: CreatableName = params.name ?? this.name
|
|
42
41
|
params.statusReporter?.report(name, 'creating')
|
|
43
42
|
try {
|
|
@@ -53,10 +52,10 @@ export abstract class AbstractCreatable<TParams extends CreatableParams = Creata
|
|
|
53
52
|
}
|
|
54
53
|
|
|
55
54
|
/* override this for initialization of instance */
|
|
56
|
-
static createHandler<T extends
|
|
57
|
-
this: Creatable<
|
|
58
|
-
instance:
|
|
59
|
-
): Promisable<
|
|
55
|
+
static createHandler<T extends CreatableInstance>(
|
|
56
|
+
this: Creatable<T>,
|
|
57
|
+
instance: T,
|
|
58
|
+
): Promisable<T> {
|
|
60
59
|
return instance
|
|
61
60
|
}
|
|
62
61
|
|
package/src/Creatable.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { Logger } from '@xylabs/logger'
|
|
2
2
|
import type { EmptyObject } from '@xylabs/object'
|
|
3
|
+
import type { Promisable } from '@xylabs/promise'
|
|
3
4
|
|
|
4
5
|
import type { AbstractCreatable } from './AbstractCreatable.ts'
|
|
5
6
|
import type { CreatableInstance, CreatableParams } from './model/index.ts'
|
|
@@ -24,7 +25,7 @@ export interface Creatable<T extends CreatableInstance = CreatableInstance> {
|
|
|
24
25
|
createHandler<T extends CreatableInstance>(
|
|
25
26
|
this: Creatable<T>,
|
|
26
27
|
instance: T
|
|
27
|
-
):
|
|
28
|
+
): Promisable<T>
|
|
28
29
|
|
|
29
30
|
/*
|
|
30
31
|
factory<T extends EmptyObject | void = void,
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { EventData } from '@xylabs/events'
|
|
2
|
+
|
|
3
|
+
import { AbstractCreatable } from './AbstractCreatable.ts'
|
|
4
|
+
import { creatable } from './Creatable.ts'
|
|
5
|
+
import type { CreatableParams } from './model/index.ts'
|
|
6
|
+
|
|
7
|
+
// This is here to check types
|
|
8
|
+
@creatable()
|
|
9
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
10
|
+
class TestCreatable<TParams extends CreatableParams = CreatableParams, TEventData extends EventData = EventData>
|
|
11
|
+
extends AbstractCreatable<TParams, TEventData> {
|
|
12
|
+
protected override paramsHandler(params?: Partial<CreatableParams<TParams>> | undefined): CreatableParams<TParams> {
|
|
13
|
+
return params as CreatableParams<TParams>
|
|
14
|
+
}
|
|
15
|
+
}
|