@xylabs/creatable 4.12.17 → 4.12.19

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.
@@ -1,8 +1,26 @@
1
+ var __defProp = Object.defineProperty;
2
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
3
+ var __decorateClass = (decorators, target, key, kind) => {
4
+ var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
5
+ for (var i = decorators.length - 1, decorator; i >= 0; i--)
6
+ if (decorator = decorators[i])
7
+ result = (kind ? decorator(target, key, result) : decorator(result)) || result;
8
+ if (kind && result) __defProp(target, key, result);
9
+ return result;
10
+ };
11
+
1
12
  // src/AbstractCreatable.ts
2
13
  import { assertEx } from "@xylabs/assert";
3
14
  import { BaseEmitter } from "@xylabs/events";
4
15
  import { isError } from "@xylabs/typeof";
5
16
 
17
+ // src/Creatable.ts
18
+ function creatable() {
19
+ return (constructor) => {
20
+ constructor;
21
+ };
22
+ }
23
+
6
24
  // src/lib/getFunctionName.ts
7
25
  import { isNumber } from "@xylabs/typeof";
8
26
  function getFunctionName(depth = 2) {
@@ -32,21 +50,22 @@ function getRootFunction(obj, funcName) {
32
50
  // src/AbstractCreatable.ts
33
51
  var AbstractCreatable = class extends BaseEmitter {
34
52
  defaultLogger;
35
- name;
36
- _populatedParams;
53
+ _validatedParams;
37
54
  constructor(params) {
38
55
  super(params);
39
- this.name = params.name ?? this.constructor.name;
56
+ }
57
+ get name() {
58
+ return this.params.name;
40
59
  }
41
60
  get params() {
42
- this._noOverride();
43
- this._populatedParams = this._populatedParams ?? this.paramsHandler(super.params);
44
- return this._populatedParams;
61
+ this._validatedParams = this._validatedParams ?? this.paramsValidator(super.params);
62
+ return this._validatedParams;
45
63
  }
46
64
  get statusReporter() {
47
65
  return this.params.statusReporter;
48
66
  }
49
- static async create(params) {
67
+ static async create(inParams = {}) {
68
+ const params = { ...await this.defaultParams(), ...inParams };
50
69
  const name = params.name ?? this.name;
51
70
  params.statusReporter?.report(name, "creating");
52
71
  try {
@@ -60,12 +79,17 @@ var AbstractCreatable = class extends BaseEmitter {
60
79
  throw new Error(`Error creating: ${name}`);
61
80
  }
62
81
  }
63
- /* override this for initialization of instance */
64
82
  static createHandler(instance) {
65
83
  return instance;
66
84
  }
85
+ static defaultParams() {
86
+ return {};
87
+ }
67
88
  createHandler() {
68
89
  }
90
+ paramsValidator(params) {
91
+ return { ...params, name: params.name ?? this.constructor.name };
92
+ }
69
93
  async start() {
70
94
  this._noOverride("start");
71
95
  try {
@@ -100,13 +124,9 @@ var AbstractCreatable = class extends BaseEmitter {
100
124
  stopHandler() {
101
125
  }
102
126
  };
103
-
104
- // src/Creatable.ts
105
- function creatable() {
106
- return (constructor) => {
107
- constructor;
108
- };
109
- }
127
+ AbstractCreatable = __decorateClass([
128
+ creatable()
129
+ ], AbstractCreatable);
110
130
  export {
111
131
  AbstractCreatable,
112
132
  creatable
@@ -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 { EmptyObject } from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\nimport { isError } from '@xylabs/typeof'\n\nimport type { 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 EmptyObject | void = void, TParams extends CreatableParams = CreatableParams>(\n this: Creatable<CreatableInstance<T, TParams>>,\n params: Partial<CreatableParams<TParams>>,\n ): Promise<CreatableInstance<T, TParams>> {\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 EmptyObject | void = void, TParams extends CreatableParams = CreatableParams>(\n this: Creatable<CreatableInstance<T, TParams>>,\n instance: CreatableInstance<T, TParams>,\n ): Promisable<CreatableInstance<T, TParams>> {\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'\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 ): Promise<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;AAI5B,SAAS,eAAe;;;ACNxB,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;;;AFOO,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,QACwC;AACxC,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,UAC2C;AAC3C,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;;;AGnEO,SAAS,YAAoG;AAClH,SAAO,CAAqD,gBAAmB;AAE7E;AAAA,EACF;AACF;","names":[]}
1
+ {"version":3,"sources":["../../src/AbstractCreatable.ts","../../src/Creatable.ts","../../src/lib/getFunctionName.ts","../../src/lib/getRootFunction.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\n@creatable()\nexport class AbstractCreatable<TParams extends CreatableParams = CreatableParams,\n TEventData extends EventData = EventData> extends BaseEmitter<Partial<TParams>, TEventData> {\n defaultLogger?: Logger\n\n private _validatedParams?: TParams\n\n constructor(params: Partial<TParams>) {\n super(params)\n }\n\n get name(): CreatableName {\n return this.params.name\n }\n\n override get params(): TParams {\n this._validatedParams = this._validatedParams ?? this.paramsValidator(super.params)\n return this._validatedParams\n }\n\n get statusReporter() {\n return this.params.statusReporter\n }\n\n static async create<T extends CreatableInstance>(\n this: Creatable<T>,\n inParams: Partial<T['params']> = {},\n ): Promise<T> {\n const params: Partial<T['params']> = { ...(await this.defaultParams()), ...inParams }\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 static createHandler<T extends CreatableInstance>(\n this: Creatable<T>,\n instance: T,\n ): Promisable<T> {\n return instance\n }\n\n static defaultParams<T extends CreatableInstance>(\n this: Creatable<T>,\n ): Promisable<Partial<T['params']>> {\n return {}\n }\n\n createHandler(): Promisable<void> {}\n\n paramsValidator(params: Partial<TParams>): TParams {\n return { ...params, name: params.name ?? this.constructor.name } as TParams\n }\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","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 defaultParams<T extends CreatableInstance>(\n this: Creatable<T>): Promisable<Partial<T['params']>>\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","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"],"mappings":";;;;;;;;;;;;AAAA,SAAS,gBAAgB;AAEzB,SAAS,mBAAmB;AAG5B,SAAS,eAAe;;;ACuCjB,SAAS,YAAoG;AAClH,SAAO,CAAqD,gBAAmB;AAE7E;AAAA,EACF;AACF;;;ACjDA,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;;;AHOO,IAAM,oBAAN,cAC6C,YAA0C;AAAA,EAC5F;AAAA,EAEQ;AAAA,EAER,YAAY,QAA0B;AACpC,UAAM,MAAM;AAAA,EACd;AAAA,EAEA,IAAI,OAAsB;AACxB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAa,SAAkB;AAC7B,SAAK,mBAAmB,KAAK,oBAAoB,KAAK,gBAAgB,MAAM,MAAM;AAClF,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,iBAAiB;AACnB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,aAAa,OAEX,WAAiC,CAAC,GACtB;AACZ,UAAM,SAA+B,EAAE,GAAI,MAAM,KAAK,cAAc,GAAI,GAAG,SAAS;AACpF,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,EAEA,OAAO,cAEL,UACe;AACf,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,gBAE6B;AAClC,WAAO,CAAC;AAAA,EACV;AAAA,EAEA,gBAAkC;AAAA,EAAC;AAAA,EAEnC,gBAAgB,QAAmC;AACjD,WAAO,EAAE,GAAG,QAAQ,MAAM,OAAO,QAAQ,KAAK,YAAY,KAAK;AAAA,EACjE;AAAA,EAEA,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;AACF;AAtGa,oBAAN;AAAA,EADN,UAAU;AAAA,GACE;","names":[]}
@@ -1,25 +1,25 @@
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 { Creatable } from './Creatable.ts';
5
+ import { type Creatable } from './Creatable.ts';
7
6
  import type { CreatableInstance, CreatableName, CreatableParams } from './model/index.ts';
8
- export declare abstract class AbstractCreatable<TParams extends CreatableParams = CreatableParams, TEventData extends EventData = EventData> extends BaseEmitter<Partial<TParams>, TEventData> {
7
+ export declare class AbstractCreatable<TParams extends CreatableParams = CreatableParams, TEventData extends EventData = EventData> extends BaseEmitter<Partial<TParams>, TEventData> {
9
8
  defaultLogger?: Logger;
10
- name: CreatableName;
11
- private _populatedParams;
9
+ private _validatedParams?;
12
10
  constructor(params: Partial<TParams>);
13
- get params(): CreatableParams<TParams>;
11
+ get name(): CreatableName;
12
+ get params(): TParams;
14
13
  get statusReporter(): import("./model/CreatableStatusReporter.ts").CreatableStatusReporter | undefined;
15
- static create<T extends EmptyObject | void = void, TParams extends CreatableParams = CreatableParams>(this: Creatable<CreatableInstance<T, TParams>>, params: Partial<CreatableParams<TParams>>): Promise<CreatableInstance<T, TParams>>;
16
- static createHandler<T extends EmptyObject | void = void, TParams extends CreatableParams = CreatableParams>(this: Creatable<CreatableInstance<T, TParams>>, instance: CreatableInstance<T, TParams>): Promisable<CreatableInstance<T, TParams>>;
14
+ static create<T extends CreatableInstance>(this: Creatable<T>, inParams?: Partial<T['params']>): Promise<T>;
15
+ static createHandler<T extends CreatableInstance>(this: Creatable<T>, instance: T): Promisable<T>;
16
+ static defaultParams<T extends CreatableInstance>(this: Creatable<T>): Promisable<Partial<T['params']>>;
17
17
  createHandler(): Promisable<void>;
18
+ paramsValidator(params: Partial<TParams>): TParams;
18
19
  start(): Promise<boolean>;
19
20
  stop(): Promise<boolean>;
20
21
  protected _noOverride(functionName?: string): void;
21
22
  protected startHandler(): Promisable<void>;
22
23
  protected stopHandler(): Promisable<void>;
23
- protected abstract paramsHandler(params?: Partial<CreatableParams<TParams>>): CreatableParams<TParams>;
24
24
  }
25
25
  //# sourceMappingURL=AbstractCreatable.d.ts.map
@@ -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,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAGjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,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,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,eAAe,GAAG,eAAe,EACxG,IAAI,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,EAC9C,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GACxC,OAAO,CAAC,iBAAiB,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAgBzC,MAAM,CAAC,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,eAAe,GAAG,eAAe,EACzG,IAAI,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,EAC9C,QAAQ,EAAE,iBAAiB,CAAC,CAAC,EAAE,OAAO,CAAC,GACtC,UAAU,CAAC,iBAAiB,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAI5C,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
+ {"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,qBACa,iBAAiB,CAAC,OAAO,SAAS,eAAe,GAAG,eAAe,EAC9E,UAAU,SAAS,SAAS,GAAG,SAAS,CAAE,SAAQ,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC3F,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,OAAO,CAAC,gBAAgB,CAAC,CAAS;gBAEtB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC;IAIpC,IAAI,IAAI,IAAI,aAAa,CAExB;IAED,IAAa,MAAM,IAAI,OAAO,CAG7B;IAED,IAAI,cAAc,qFAEjB;WAEY,MAAM,CAAC,CAAC,SAAS,iBAAiB,EAC7C,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAClB,QAAQ,GAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAM,GAClC,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,MAAM,CAAC,aAAa,CAAC,CAAC,SAAS,iBAAiB,EAC9C,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,GACjB,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAInC,aAAa,IAAI,UAAU,CAAC,IAAI,CAAC;IAEjC,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO;IAI5C,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;CAG1C"}
@@ -1,12 +1,14 @@
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): Promise<T>;
10
+ createHandler<T extends CreatableInstance>(this: Creatable<T>, instance: T): Promisable<T>;
11
+ defaultParams<T extends CreatableInstance>(this: Creatable<T>): Promisable<Partial<T['params']>>;
10
12
  }
11
13
  /**
12
14
  * 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,OAAO,CAAC,CAAC,CAAC,CAAA;CAMd;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"}
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,KAAI,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;IAErE,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;IAEhB,aAAa,CAAC,CAAC,SAAS,iBAAiB,EACvC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;CAMxD;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,2 @@
1
+ export {};
2
+ //# sourceMappingURL=TestCreatable.d.ts.map
@@ -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.17",
3
+ "version": "4.12.19",
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.17",
33
- "@xylabs/base": "^4.12.17",
34
- "@xylabs/events": "^4.12.17",
35
- "@xylabs/logger": "^4.12.17",
36
- "@xylabs/object": "^4.12.17",
37
- "@xylabs/promise": "^4.12.17",
38
- "@xylabs/typeof": "^4.12.17"
32
+ "@xylabs/assert": "^4.12.19",
33
+ "@xylabs/base": "^4.12.19",
34
+ "@xylabs/events": "^4.12.19",
35
+ "@xylabs/logger": "^4.12.19",
36
+ "@xylabs/object": "^4.12.19",
37
+ "@xylabs/promise": "^4.12.19",
38
+ "@xylabs/typeof": "^4.12.19"
39
39
  },
40
40
  "devDependencies": {
41
41
  "@xylabs/ts-scripts-yarn3": "^6.5.9",
@@ -2,42 +2,44 @@ 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 { Creatable } from './Creatable.ts'
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,
13
12
  } from './model/index.ts'
14
13
 
15
- export abstract class AbstractCreatable<TParams extends CreatableParams = CreatableParams,
14
+ @creatable()
15
+ export class AbstractCreatable<TParams extends CreatableParams = CreatableParams,
16
16
  TEventData extends EventData = EventData> extends BaseEmitter<Partial<TParams>, TEventData> {
17
17
  defaultLogger?: Logger
18
- name: CreatableName
19
18
 
20
- private _populatedParams: TParams | undefined
19
+ private _validatedParams?: TParams
21
20
 
22
21
  constructor(params: Partial<TParams>) {
23
22
  super(params)
24
- this.name = params.name ?? this.constructor.name as CreatableName
25
23
  }
26
24
 
27
- override get params(): CreatableParams<TParams> {
28
- this._noOverride()
29
- this._populatedParams = this._populatedParams ?? this.paramsHandler(super.params)
30
- return this._populatedParams
25
+ get name(): CreatableName {
26
+ return this.params.name
27
+ }
28
+
29
+ override get params(): TParams {
30
+ this._validatedParams = this._validatedParams ?? this.paramsValidator(super.params)
31
+ return this._validatedParams
31
32
  }
32
33
 
33
34
  get statusReporter() {
34
35
  return this.params.statusReporter
35
36
  }
36
37
 
37
- static async create<T extends EmptyObject | void = void, TParams extends CreatableParams = CreatableParams>(
38
- this: Creatable<CreatableInstance<T, TParams>>,
39
- params: Partial<CreatableParams<TParams>>,
40
- ): Promise<CreatableInstance<T, TParams>> {
38
+ static async create<T extends CreatableInstance>(
39
+ this: Creatable<T>,
40
+ inParams: Partial<T['params']> = {},
41
+ ): Promise<T> {
42
+ const params: Partial<T['params']> = { ...(await this.defaultParams()), ...inParams }
41
43
  const name: CreatableName = params.name ?? this.name
42
44
  params.statusReporter?.report(name, 'creating')
43
45
  try {
@@ -52,16 +54,25 @@ export abstract class AbstractCreatable<TParams extends CreatableParams = Creata
52
54
  }
53
55
  }
54
56
 
55
- /* override this for initialization of instance */
56
- static createHandler<T extends EmptyObject | void = void, TParams extends CreatableParams = CreatableParams>(
57
- this: Creatable<CreatableInstance<T, TParams>>,
58
- instance: CreatableInstance<T, TParams>,
59
- ): Promisable<CreatableInstance<T, TParams>> {
57
+ static createHandler<T extends CreatableInstance>(
58
+ this: Creatable<T>,
59
+ instance: T,
60
+ ): Promisable<T> {
60
61
  return instance
61
62
  }
62
63
 
64
+ static defaultParams<T extends CreatableInstance>(
65
+ this: Creatable<T>,
66
+ ): Promisable<Partial<T['params']>> {
67
+ return {}
68
+ }
69
+
63
70
  createHandler(): Promisable<void> {}
64
71
 
72
+ paramsValidator(params: Partial<TParams>): TParams {
73
+ return { ...params, name: params.name ?? this.constructor.name } as TParams
74
+ }
75
+
65
76
  async start(): Promise<boolean> {
66
77
  this._noOverride('start')
67
78
  try {
@@ -103,6 +114,4 @@ export abstract class AbstractCreatable<TParams extends CreatableParams = Creata
103
114
  protected stopHandler(): Promisable<void> {
104
115
  // when overriding this, throw an error on failure
105
116
  }
106
-
107
- protected abstract paramsHandler(params?: Partial<CreatableParams<TParams>>): CreatableParams<TParams>
108
117
  }
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'
@@ -15,7 +16,7 @@ export interface Creatable<T extends CreatableInstance = CreatableInstance> {
15
16
 
16
17
  defaultLogger?: Logger
17
18
 
18
- new (params: Partial<T['params']>): T & AbstractCreatable<T['params']>
19
+ new(params: Partial<T['params']>): T & AbstractCreatable<T['params']>
19
20
 
20
21
  create<T extends CreatableInstance>(
21
22
  this: Creatable<T>,
@@ -24,7 +25,10 @@ export interface Creatable<T extends CreatableInstance = CreatableInstance> {
24
25
  createHandler<T extends CreatableInstance>(
25
26
  this: Creatable<T>,
26
27
  instance: T
27
- ): Promise<T>
28
+ ): Promisable<T>
29
+
30
+ defaultParams<T extends CreatableInstance>(
31
+ this: Creatable<T>): Promisable<Partial<T['params']>>
28
32
 
29
33
  /*
30
34
  factory<T extends EmptyObject | void = void,
@@ -0,0 +1,22 @@
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
+ interface TestCreatableParams extends CreatableParams {
8
+ testParam: string
9
+ }
10
+
11
+ // This is here to check types
12
+ @creatable()
13
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
14
+ class TestCreatable<TParams extends TestCreatableParams = TestCreatableParams, TEventData extends EventData = EventData>
15
+ extends AbstractCreatable<TParams, TEventData> {
16
+ override paramsValidator(params: Partial<TParams> = {}): TParams {
17
+ const result: TestCreatableParams = {
18
+ ...params, name: params.name ?? this.constructor.name, testParam: 'yo',
19
+ }
20
+ return result as TParams
21
+ }
22
+ }