@xylabs/creatable 4.12.8 → 4.12.10

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.
Files changed (40) hide show
  1. package/dist/neutral/index.mjs +45 -5
  2. package/dist/neutral/index.mjs.map +1 -1
  3. package/dist/types/AbstractCreatable.d.ts +6 -2
  4. package/dist/types/AbstractCreatable.d.ts.map +1 -1
  5. package/dist/types/Creatable.d.ts +2 -3
  6. package/dist/types/Creatable.d.ts.map +1 -1
  7. package/dist/types/index.d.ts +1 -3
  8. package/dist/types/index.d.ts.map +1 -1
  9. package/dist/types/lib/getFunctionName.d.ts.map +1 -0
  10. package/dist/types/lib/getRootFunction.d.ts.map +1 -0
  11. package/dist/types/lib/index.d.ts +3 -0
  12. package/dist/types/lib/index.d.ts.map +1 -0
  13. package/dist/types/model/CreatableInstance.d.ts.map +1 -0
  14. package/dist/types/{CreatableParams.d.ts → model/CreatableParams.d.ts} +1 -1
  15. package/dist/types/model/CreatableParams.d.ts.map +1 -0
  16. package/dist/types/model/CreatableStatusReporter.d.ts +7 -0
  17. package/dist/types/model/CreatableStatusReporter.d.ts.map +1 -0
  18. package/dist/types/model/index.d.ts +4 -0
  19. package/dist/types/model/index.d.ts.map +1 -0
  20. package/package.json +7 -7
  21. package/src/AbstractCreatable.ts +54 -7
  22. package/src/Creatable.ts +2 -3
  23. package/src/index.ts +1 -3
  24. package/src/lib/index.ts +2 -0
  25. package/src/{CreatableParams.ts → model/CreatableParams.ts} +1 -1
  26. package/src/model/CreatableStatusReporter.ts +8 -0
  27. package/src/model/index.ts +3 -0
  28. package/dist/types/CreatableInstance.d.ts.map +0 -1
  29. package/dist/types/CreatableParams.d.ts.map +0 -1
  30. package/dist/types/CreatableStatusReporter.d.ts +0 -6
  31. package/dist/types/CreatableStatusReporter.d.ts.map +0 -1
  32. package/dist/types/getFunctionName.d.ts.map +0 -1
  33. package/dist/types/getRootFunction.d.ts.map +0 -1
  34. package/src/CreatableStatusReporter.ts +0 -7
  35. /package/dist/types/{getFunctionName.d.ts → lib/getFunctionName.d.ts} +0 -0
  36. /package/dist/types/{getRootFunction.d.ts → lib/getRootFunction.d.ts} +0 -0
  37. /package/dist/types/{CreatableInstance.d.ts → model/CreatableInstance.d.ts} +0 -0
  38. /package/src/{getFunctionName.ts → lib/getFunctionName.ts} +0 -0
  39. /package/src/{getRootFunction.ts → lib/getRootFunction.ts} +0 -0
  40. /package/src/{CreatableInstance.ts → model/CreatableInstance.ts} +0 -0
@@ -1,8 +1,9 @@
1
1
  // src/AbstractCreatable.ts
2
2
  import { assertEx } from "@xylabs/assert";
3
3
  import { BaseEmitter } from "@xylabs/events";
4
+ import { isError } from "@xylabs/typeof";
4
5
 
5
- // src/getFunctionName.ts
6
+ // src/lib/getFunctionName.ts
6
7
  import { isNumber } from "@xylabs/typeof";
7
8
  function getFunctionName(depth = 2) {
8
9
  const error = new Error("Stack");
@@ -19,7 +20,7 @@ function getFunctionName(depth = 2) {
19
20
  return isNumber(newIndex) ? `${funcName} ${stackParts?.[newIndex + 1]}` : funcName;
20
21
  }
21
22
 
22
- // src/getRootFunction.ts
23
+ // src/lib/getRootFunction.ts
23
24
  function getRootFunction(obj, funcName) {
24
25
  let anyObj = obj;
25
26
  while (anyObj.__proto__?.[funcName]) {
@@ -42,19 +43,58 @@ var AbstractCreatable = class extends BaseEmitter {
42
43
  this._populatedParams = this._populatedParams ?? this.paramsHandler(super.params);
43
44
  return this._populatedParams;
44
45
  }
46
+ get statusReporter() {
47
+ return this.params.statusReporter;
48
+ }
45
49
  static async create(params) {
46
- const instance = new this(params);
47
- await instance.createHandler();
48
- return await Promise.resolve(instance);
50
+ const name = params.name ?? this.name;
51
+ params.statusReporter?.report(name, "creating");
52
+ try {
53
+ const instance = new this(params);
54
+ await instance.createHandler();
55
+ params.statusReporter?.report(name, "created");
56
+ return instance;
57
+ } catch (ex) {
58
+ params.statusReporter?.report(name, "error", isError(ex) ? ex : new Error(`Error creating: ${name}`));
59
+ throw new Error(`Error creating: ${name}`);
60
+ }
49
61
  }
50
62
  createHandler() {
51
63
  return true;
52
64
  }
65
+ async start() {
66
+ this._noOverride("start");
67
+ try {
68
+ this.statusReporter?.report(this.name, "starting");
69
+ await this.startHandler();
70
+ this.statusReporter?.report(this.name, "started");
71
+ return true;
72
+ } catch (ex) {
73
+ this.statusReporter?.report(this.name, "error", isError(ex) ? ex : new Error(`Error stopping: ${ex}`));
74
+ return false;
75
+ }
76
+ }
77
+ async stop() {
78
+ this._noOverride("stop");
79
+ try {
80
+ this.statusReporter?.report(this.name, "stopping");
81
+ await this.stopHandler();
82
+ this.statusReporter?.report(this.name, "stopped");
83
+ return true;
84
+ } catch (ex) {
85
+ this.statusReporter?.report(this.name, "error", isError(ex) ? ex : new Error(`Error stopping: ${ex}`));
86
+ return false;
87
+ }
88
+ }
53
89
  _noOverride(functionName = getFunctionName(3)) {
54
90
  const thisFunc = this[functionName];
55
91
  const rootFunc = getRootFunction(this, functionName);
56
92
  assertEx(thisFunc === rootFunc, () => `Override not allowed for [${functionName}] - override ${functionName}Handler instead`);
57
93
  }
94
+ startHandler() {
95
+ }
96
+ stopHandler() {
97
+ }
58
98
  };
59
99
 
60
100
  // src/Creatable.ts
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/AbstractCreatable.ts","../../src/getFunctionName.ts","../../src/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'\n\nimport type { Creatable } from './Creatable.ts'\nimport type { CreatableInstance } from './CreatableInstance.ts'\nimport type { CreatableName, CreatableParams } from './CreatableParams.ts'\nimport { getFunctionName } from './getFunctionName.ts'\nimport { getRootFunction } from './getRootFunction.ts'\n\nexport abstract class AbstractCreatable<TParams extends EmptyObject | void = void,\n TEventData extends EventData = EventData> extends BaseEmitter<Partial<CreatableParams<TParams>>, TEventData> {\n defaultLogger?: Logger\n name: CreatableName\n\n private _populatedParams: CreatableParams<TParams> | undefined\n\n constructor(params: Partial<CreatableParams<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 static async create<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void>(\n this: Creatable<T, TParams>,\n params: Partial<CreatableParams<TParams>>,\n ): Promise<CreatableInstance<T>> {\n const instance = new this(params)\n await instance.createHandler()\n return await Promise.resolve(instance as CreatableInstance<T>)\n }\n\n createHandler(): Promisable<boolean> {\n return true\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 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 } from './CreatableInstance.ts'\nimport type { CreatableParams } from './CreatableParams.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 EmptyObject | void = void, TParams extends EmptyObject | void = void> {\n\n defaultLogger?: Logger\n\n new (params: Partial<CreatableParams<TParams>>): CreatableInstance<T> & AbstractCreatable<TParams>\n\n create<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void>(\n this: Creatable<T, TParams>,\n params: Partial<CreatableParams<TParams>>): Promise<CreatableInstance<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<TInstance extends EmptyObject | void = void, TParams extends EmptyObject | void = void>() {\n return <U extends Creatable<TInstance, 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;;;ACF5B,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,YAA2D;AAAA,EAC7G;AAAA,EACA;AAAA,EAEQ;AAAA,EAER,YAAY,QAA2C;AACrD,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,aAAa,OAEX,QAC+B;AAC/B,UAAM,WAAW,IAAI,KAAK,MAAM;AAChC,UAAM,SAAS,cAAc;AAC7B,WAAO,MAAM,QAAQ,QAAQ,QAAgC;AAAA,EAC/D;AAAA,EAEA,gBAAqC;AACnC,WAAO;AAAA,EACT;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;AAGF;;;AGjBO,SAAS,YAAoG;AAClH,SAAO,CAA0C,gBAAmB;AAElE;AAAA,EACF;AACF;","names":[]}
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 EmptyObject | void = void,\n TEventData extends EventData = EventData> extends BaseEmitter<Partial<CreatableParams<TParams>>, TEventData> {\n defaultLogger?: Logger\n name: CreatableName\n\n private _populatedParams: CreatableParams<TParams> | undefined\n\n constructor(params: Partial<CreatableParams<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 EmptyObject | void = void>(\n this: Creatable<T, TParams>,\n params: Partial<CreatableParams<TParams>>,\n ): Promise<CreatableInstance<T>> {\n const name: CreatableName = params.name ?? this.name\n params.statusReporter?.report(name, 'creating')\n try {\n const instance = new this(params)\n await instance.createHandler()\n params.statusReporter?.report(name, 'created')\n return instance\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 createHandler(): Promisable<boolean> {\n return true\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 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 EmptyObject | void = void, TParams extends EmptyObject | void = void> {\n\n defaultLogger?: Logger\n\n new (params: Partial<CreatableParams<TParams>>): CreatableInstance<T, TParams> & AbstractCreatable<TParams>\n\n create<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void>(\n this: Creatable<T, TParams>,\n params: Partial<CreatableParams<TParams>>): Promise<CreatableInstance<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<TInstance extends EmptyObject | void = void, TParams extends EmptyObject | void = void>() {\n return <U extends Creatable<TInstance, 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,YAA2D;AAAA,EAC7G;AAAA,EACA;AAAA,EAEQ;AAAA,EAER,YAAY,QAA2C;AACrD,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,QAC+B;AAC/B,UAAM,OAAsB,OAAO,QAAQ,KAAK;AAChD,WAAO,gBAAgB,OAAO,MAAM,UAAU;AAC9C,QAAI;AACF,YAAM,WAAW,IAAI,KAAK,MAAM;AAChC,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,gBAAqC;AACnC,WAAO;AAAA,EACT;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;AAGF;;;AGjEO,SAAS,YAAoG;AAClH,SAAO,CAA0C,gBAAmB;AAElE;AAAA,EACF;AACF;","names":[]}
@@ -4,17 +4,21 @@ import { type Logger } from '@xylabs/logger';
4
4
  import type { EmptyObject } from '@xylabs/object';
5
5
  import type { Promisable } from '@xylabs/promise';
6
6
  import type { Creatable } from './Creatable.ts';
7
- import type { CreatableInstance } from './CreatableInstance.ts';
8
- import type { CreatableName, CreatableParams } from './CreatableParams.ts';
7
+ import type { CreatableInstance, CreatableName, CreatableParams } from './model/index.ts';
9
8
  export declare abstract class AbstractCreatable<TParams extends EmptyObject | void = void, TEventData extends EventData = EventData> extends BaseEmitter<Partial<CreatableParams<TParams>>, TEventData> {
10
9
  defaultLogger?: Logger;
11
10
  name: CreatableName;
12
11
  private _populatedParams;
13
12
  constructor(params: Partial<CreatableParams<TParams>>);
14
13
  get params(): CreatableParams<TParams>;
14
+ get statusReporter(): import("./model/CreatableStatusReporter.ts").CreatableStatusReporter | undefined;
15
15
  static create<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void>(this: Creatable<T, TParams>, params: Partial<CreatableParams<TParams>>): Promise<CreatableInstance<T>>;
16
16
  createHandler(): Promisable<boolean>;
17
+ start(): Promise<boolean>;
18
+ stop(): Promise<boolean>;
17
19
  protected _noOverride(functionName?: string): void;
20
+ protected startHandler(): Promisable<void>;
21
+ protected stopHandler(): Promisable<void>;
18
22
  protected abstract paramsHandler(params?: Partial<CreatableParams<TParams>>): CreatableParams<TParams>;
19
23
  }
20
24
  //# 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;AAEjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAI1E,8BAAsB,iBAAiB,CAAC,OAAO,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EAC/E,UAAU,SAAS,SAAS,GAAG,SAAS,CAAE,SAAQ,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE,UAAU,CAAC;IAC5G,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,IAAI,EAAE,aAAa,CAAA;IAEnB,OAAO,CAAC,gBAAgB,CAAsC;gBAElD,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAKrD,IAAa,MAAM,IAAI,eAAe,CAAC,OAAO,CAAC,CAI9C;WAEY,MAAM,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EAChG,IAAI,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,EAC3B,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GACxC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAMhC,aAAa,IAAI,UAAU,CAAC,OAAO,CAAC;IAIpC,SAAS,CAAC,WAAW,CAAC,YAAY,SAAqB;IAQvD,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,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,WAAW,GAAG,IAAI,GAAG,IAAI,EAC/E,UAAU,SAAS,SAAS,GAAG,SAAS,CAAE,SAAQ,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE,UAAU,CAAC;IAC5G,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,IAAI,EAAE,aAAa,CAAA;IAEnB,OAAO,CAAC,gBAAgB,CAAsC;gBAElD,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAKrD,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,WAAW,GAAG,IAAI,GAAG,IAAI,EAChG,IAAI,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,EAC3B,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GACxC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAchC,aAAa,IAAI,UAAU,CAAC,OAAO,CAAC;IAI9B,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,11 +1,10 @@
1
1
  import type { Logger } from '@xylabs/logger';
2
2
  import type { EmptyObject } from '@xylabs/object';
3
3
  import type { AbstractCreatable } from './AbstractCreatable.ts';
4
- import type { CreatableInstance } from './CreatableInstance.ts';
5
- import type { CreatableParams } from './CreatableParams.ts';
4
+ import type { CreatableInstance, CreatableParams } from './model/index.ts';
6
5
  export interface Creatable<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void> {
7
6
  defaultLogger?: Logger;
8
- new (params: Partial<CreatableParams<TParams>>): CreatableInstance<T> & AbstractCreatable<TParams>;
7
+ new (params: Partial<CreatableParams<TParams>>): CreatableInstance<T, TParams> & AbstractCreatable<TParams>;
9
8
  create<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void>(this: Creatable<T, TParams>, params: Partial<CreatableParams<TParams>>): Promise<CreatableInstance<T>>;
10
9
  }
11
10
  /**
@@ -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,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAS3D,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI;IAEvG,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,KAAK,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAA;IAElG,MAAM,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EACnF,IAAI,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,EAC3B,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAA;CAM5E;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,SAAS,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,MACtG,CAAC,SAAS,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,UAIhE;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;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,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI;IAEvG,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,KAAK,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAA;IAE3G,MAAM,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EACnF,IAAI,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,EAC3B,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAA;CAM5E;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,SAAS,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,MACtG,CAAC,SAAS,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,UAIhE;AAED;;;;;GAKG"}
@@ -1,6 +1,4 @@
1
1
  export * from './AbstractCreatable.ts';
2
2
  export * from './Creatable.ts';
3
- export * from './CreatableInstance.ts';
4
- export * from './CreatableParams.ts';
5
- export * from './CreatableStatusReporter.ts';
3
+ export * from './model/index.ts';
6
4
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA;AACpC,cAAc,8BAA8B,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,kBAAkB,CAAA"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getFunctionName.d.ts","sourceRoot":"","sources":["../../../src/lib/getFunctionName.ts"],"names":[],"mappings":"AAEA,wBAAgB,eAAe,CAAC,KAAK,SAAI,UAexC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getRootFunction.d.ts","sourceRoot":"","sources":["../../../src/lib/getRootFunction.ts"],"names":[],"mappings":"AAAA,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAO7D"}
@@ -0,0 +1,3 @@
1
+ export * from './getFunctionName.ts';
2
+ export * from './getRootFunction.ts';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CreatableInstance.d.ts","sourceRoot":"","sources":["../../../src/model/CreatableInstance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE1E,MAAM,WAAW,uBAAuB,CAAC,OAAO,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI;IAChF,IAAI,EAAE,aAAa,CAAA;IACnB,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,CAAA;CACjC;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IACxG,CAAC,SAAS,WAAW,GAAG,CAAC,GAAG,uBAAuB,CAAC,OAAO,CAAC,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAA"}
@@ -4,7 +4,7 @@ import type { EmptyObject } from '@xylabs/object';
4
4
  import type { CreatableStatusReporter } from './CreatableStatusReporter.ts';
5
5
  export type CreatableName = Exclude<string, 'creatable-name-reserved-32546239486'> & BaseClassName;
6
6
  export type CreatableParamsFields = {
7
- name?: CreatableName;
7
+ name: CreatableName;
8
8
  statusReporter?: CreatableStatusReporter;
9
9
  };
10
10
  export type CreatableParams<TAdditionalParams extends EmptyObject | void = void> = BaseEmitterParams<TAdditionalParams extends EmptyObject ? CreatableParamsFields & TAdditionalParams : CreatableParamsFields>;
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CreatableParams.d.ts","sourceRoot":"","sources":["../../../src/model/CreatableParams.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AAE3E,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,EAAE,qCAAqC,CAAC,GAAG,aAAa,CAAA;AAElG,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,aAAa,CAAA;IACnB,cAAc,CAAC,EAAE,uBAAuB,CAAA;CACzC,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,iBAAiB,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAC7E,iBAAiB,CAAC,iBAAiB,SAAS,WAAW,GAAG,qBAAqB,GAAG,iBAAiB,GAAG,qBAAqB,CAAC,CAAA"}
@@ -0,0 +1,7 @@
1
+ import type { BaseClassName } from '@xylabs/base';
2
+ export type CreatableStatus = 'creating' | 'created' | 'starting' | 'started' | 'stopping' | 'stopped' | 'error';
3
+ export interface CreatableStatusReporter {
4
+ report(name: BaseClassName, status: Exclude<CreatableStatus, 'error'>, progress?: number): void;
5
+ report(name: BaseClassName, status: Extract<CreatableStatus, 'error'>, error?: Error): void;
6
+ }
7
+ //# sourceMappingURL=CreatableStatusReporter.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CreatableStatusReporter.d.ts","sourceRoot":"","sources":["../../../src/model/CreatableStatusReporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAEjD,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAA;AAEhH,MAAM,WAAW,uBAAuB;IACtC,MAAM,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,eAAe,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/F,MAAM,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,eAAe,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,CAAA;CAC5F"}
@@ -0,0 +1,4 @@
1
+ export * from './CreatableInstance.ts';
2
+ export * from './CreatableParams.ts';
3
+ export * from './CreatableStatusReporter.ts';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/model/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA;AACpC,cAAc,8BAA8B,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/creatable",
3
- "version": "4.12.8",
3
+ "version": "4.12.10",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -30,12 +30,12 @@
30
30
  "types": "dist/types/index.d.ts",
31
31
  "dependencies": {
32
32
  "@opentelemetry/api": "^1.9.0",
33
- "@xylabs/assert": "^4.12.8",
34
- "@xylabs/base": "^4.12.8",
35
- "@xylabs/events": "^4.12.8",
36
- "@xylabs/logger": "^4.12.8",
37
- "@xylabs/object": "^4.12.8",
38
- "@xylabs/typeof": "^4.12.8"
33
+ "@xylabs/assert": "^4.12.10",
34
+ "@xylabs/base": "^4.12.10",
35
+ "@xylabs/events": "^4.12.10",
36
+ "@xylabs/logger": "^4.12.10",
37
+ "@xylabs/object": "^4.12.10",
38
+ "@xylabs/typeof": "^4.12.10"
39
39
  },
40
40
  "devDependencies": {
41
41
  "@xylabs/ts-scripts-yarn3": "^6.5.8",
@@ -4,12 +4,13 @@ import { BaseEmitter } from '@xylabs/events'
4
4
  import { type Logger } from '@xylabs/logger'
5
5
  import type { EmptyObject } from '@xylabs/object'
6
6
  import type { Promisable } from '@xylabs/promise'
7
+ import { isError } from '@xylabs/typeof'
7
8
 
8
9
  import type { Creatable } from './Creatable.ts'
9
- import type { CreatableInstance } from './CreatableInstance.ts'
10
- import type { CreatableName, CreatableParams } from './CreatableParams.ts'
11
- import { getFunctionName } from './getFunctionName.ts'
12
- import { getRootFunction } from './getRootFunction.ts'
10
+ import { getFunctionName, getRootFunction } from './lib/index.ts'
11
+ import type {
12
+ CreatableInstance, CreatableName, CreatableParams,
13
+ } from './model/index.ts'
13
14
 
14
15
  export abstract class AbstractCreatable<TParams extends EmptyObject | void = void,
15
16
  TEventData extends EventData = EventData> extends BaseEmitter<Partial<CreatableParams<TParams>>, TEventData> {
@@ -29,19 +30,57 @@ export abstract class AbstractCreatable<TParams extends EmptyObject | void = voi
29
30
  return this._populatedParams
30
31
  }
31
32
 
33
+ get statusReporter() {
34
+ return this.params.statusReporter
35
+ }
36
+
32
37
  static async create<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void>(
33
38
  this: Creatable<T, TParams>,
34
39
  params: Partial<CreatableParams<TParams>>,
35
40
  ): Promise<CreatableInstance<T>> {
36
- const instance = new this(params)
37
- await instance.createHandler()
38
- return await Promise.resolve(instance as CreatableInstance<T>)
41
+ const name: CreatableName = params.name ?? this.name
42
+ params.statusReporter?.report(name, 'creating')
43
+ try {
44
+ const instance = new this(params)
45
+ await instance.createHandler()
46
+ params.statusReporter?.report(name, 'created')
47
+ return instance
48
+ } catch (ex) {
49
+ params.statusReporter?.report(name, 'error', isError(ex) ? ex : new Error(`Error creating: ${name}`))
50
+ throw new Error(`Error creating: ${name}`)
51
+ }
39
52
  }
40
53
 
41
54
  createHandler(): Promisable<boolean> {
42
55
  return true
43
56
  }
44
57
 
58
+ async start(): Promise<boolean> {
59
+ this._noOverride('start')
60
+ try {
61
+ this.statusReporter?.report(this.name, 'starting')
62
+ await this.startHandler()
63
+ this.statusReporter?.report(this.name, 'started')
64
+ return true
65
+ } catch (ex) {
66
+ this.statusReporter?.report(this.name, 'error', isError(ex) ? ex : new Error(`Error stopping: ${ex}`))
67
+ return false
68
+ }
69
+ }
70
+
71
+ async stop(): Promise<boolean> {
72
+ this._noOverride('stop')
73
+ try {
74
+ this.statusReporter?.report(this.name, 'stopping')
75
+ await this.stopHandler()
76
+ this.statusReporter?.report(this.name, 'stopped')
77
+ return true
78
+ } catch (ex) {
79
+ this.statusReporter?.report(this.name, 'error', isError(ex) ? ex : new Error(`Error stopping: ${ex}`))
80
+ return false
81
+ }
82
+ }
83
+
45
84
  protected _noOverride(functionName = getFunctionName(3)) {
46
85
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
47
86
  const thisFunc = (this as any)[functionName]
@@ -50,5 +89,13 @@ export abstract class AbstractCreatable<TParams extends EmptyObject | void = voi
50
89
  assertEx(thisFunc === rootFunc, () => `Override not allowed for [${functionName}] - override ${functionName}Handler instead`)
51
90
  }
52
91
 
92
+ protected startHandler(): Promisable<void> {
93
+ // when overriding this, throw an error on failure
94
+ }
95
+
96
+ protected stopHandler(): Promisable<void> {
97
+ // when overriding this, throw an error on failure
98
+ }
99
+
53
100
  protected abstract paramsHandler(params?: Partial<CreatableParams<TParams>>): CreatableParams<TParams>
54
101
  }
package/src/Creatable.ts CHANGED
@@ -2,8 +2,7 @@ import type { Logger } from '@xylabs/logger'
2
2
  import type { EmptyObject } from '@xylabs/object'
3
3
 
4
4
  import type { AbstractCreatable } from './AbstractCreatable.ts'
5
- import type { CreatableInstance } from './CreatableInstance.ts'
6
- import type { CreatableParams } from './CreatableParams.ts'
5
+ import type { CreatableInstance, CreatableParams } from './model/index.ts'
7
6
 
8
7
  /*
9
8
  export interface CreatableFactory<T extends EmptyObject | void = void,
@@ -16,7 +15,7 @@ export interface Creatable<T extends EmptyObject | void = void, TParams extends
16
15
 
17
16
  defaultLogger?: Logger
18
17
 
19
- new (params: Partial<CreatableParams<TParams>>): CreatableInstance<T> & AbstractCreatable<TParams>
18
+ new (params: Partial<CreatableParams<TParams>>): CreatableInstance<T, TParams> & AbstractCreatable<TParams>
20
19
 
21
20
  create<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void>(
22
21
  this: Creatable<T, TParams>,
package/src/index.ts CHANGED
@@ -1,5 +1,3 @@
1
1
  export * from './AbstractCreatable.ts'
2
2
  export * from './Creatable.ts'
3
- export * from './CreatableInstance.ts'
4
- export * from './CreatableParams.ts'
5
- export * from './CreatableStatusReporter.ts'
3
+ export * from './model/index.ts'
@@ -0,0 +1,2 @@
1
+ export * from './getFunctionName.ts'
2
+ export * from './getRootFunction.ts'
@@ -7,7 +7,7 @@ import type { CreatableStatusReporter } from './CreatableStatusReporter.ts'
7
7
  export type CreatableName = Exclude<string, 'creatable-name-reserved-32546239486'> & BaseClassName
8
8
 
9
9
  export type CreatableParamsFields = {
10
- name?: CreatableName
10
+ name: CreatableName
11
11
  statusReporter?: CreatableStatusReporter
12
12
  }
13
13
 
@@ -0,0 +1,8 @@
1
+ import type { BaseClassName } from '@xylabs/base'
2
+
3
+ export type CreatableStatus = 'creating' | 'created' | 'starting' | 'started' | 'stopping' | 'stopped' | 'error'
4
+
5
+ export interface CreatableStatusReporter {
6
+ report(name: BaseClassName, status: Exclude<CreatableStatus, 'error'>, progress?: number): void
7
+ report(name: BaseClassName, status: Extract<CreatableStatus, 'error'>, error?: Error): void
8
+ }
@@ -0,0 +1,3 @@
1
+ export * from './CreatableInstance.ts'
2
+ export * from './CreatableParams.ts'
3
+ export * from './CreatableStatusReporter.ts'
@@ -1 +0,0 @@
1
- {"version":3,"file":"CreatableInstance.d.ts","sourceRoot":"","sources":["../../src/CreatableInstance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE1E,MAAM,WAAW,uBAAuB,CAAC,OAAO,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI;IAChF,IAAI,EAAE,aAAa,CAAA;IACnB,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,CAAA;CACjC;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IACxG,CAAC,SAAS,WAAW,GAAG,CAAC,GAAG,uBAAuB,CAAC,OAAO,CAAC,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAA"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"CreatableParams.d.ts","sourceRoot":"","sources":["../../src/CreatableParams.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AAE3E,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,EAAE,qCAAqC,CAAC,GAAG,aAAa,CAAA;AAElG,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,cAAc,CAAC,EAAE,uBAAuB,CAAA;CACzC,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,iBAAiB,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAC7E,iBAAiB,CAAC,iBAAiB,SAAS,WAAW,GAAG,qBAAqB,GAAG,iBAAiB,GAAG,qBAAqB,CAAC,CAAA"}
@@ -1,6 +0,0 @@
1
- import type { BaseClassName } from '@xylabs/base';
2
- export type CreatableStatus = 'creating' | 'created' | 'starting' | 'started' | 'stopping' | 'stopped';
3
- export interface CreatableStatusReporter {
4
- report: (name: BaseClassName, status: CreatableStatus, progress?: number) => void;
5
- }
6
- //# sourceMappingURL=CreatableStatusReporter.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"CreatableStatusReporter.d.ts","sourceRoot":"","sources":["../../src/CreatableStatusReporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAEjD,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAA;AAEtG,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,eAAe,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CAClF"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"getFunctionName.d.ts","sourceRoot":"","sources":["../../src/getFunctionName.ts"],"names":[],"mappings":"AAEA,wBAAgB,eAAe,CAAC,KAAK,SAAI,UAexC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"getRootFunction.d.ts","sourceRoot":"","sources":["../../src/getRootFunction.ts"],"names":[],"mappings":"AAAA,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAO7D"}
@@ -1,7 +0,0 @@
1
- import type { BaseClassName } from '@xylabs/base'
2
-
3
- export type CreatableStatus = 'creating' | 'created' | 'starting' | 'started' | 'stopping' | 'stopped'
4
-
5
- export interface CreatableStatusReporter {
6
- report: (name: BaseClassName, status: CreatableStatus, progress?: number) => void
7
- }