@xylabs/creatable 4.12.9 → 4.12.11

package/dist/neutral/index.mjs

@@ -96,7 +96,15 @@ var AbstractCreatable = class extends BaseEmitter {
   stopHandler() {
   }
 };
+
+// src/Creatable.ts
+function creatable() {
+  return (constructor) => {
+    constructor;
+  };
+}
 export {
-  AbstractCreatable
+  AbstractCreatable,
+  creatable
 };
 //# sourceMappingURL=index.mjs.map

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/AbstractCreatable.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 { 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"],"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;","names":[]}
+{"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":[]}

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from './AbstractCreatable.ts';
+export * from './Creatable.ts';
 export * from './model/index.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,kBAAkB,CAAA"}
+{"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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/creatable",
-  "version": "4.12.9",
+  "version": "4.12.11",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,13 +29,13 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/types/index.d.ts",
   "dependencies": {
-    "@opentelemetry/api": "^1.9.0",
-    "@xylabs/assert": "^4.12.9",
-    "@xylabs/base": "^4.12.9",
-    "@xylabs/events": "^4.12.9",
-    "@xylabs/logger": "^4.12.9",
-    "@xylabs/object": "^4.12.9",
-    "@xylabs/typeof": "^4.12.9"
+    "@xylabs/assert": "^4.12.11",
+    "@xylabs/base": "^4.12.11",
+    "@xylabs/events": "^4.12.11",
+    "@xylabs/logger": "^4.12.11",
+    "@xylabs/object": "^4.12.11",
+    "@xylabs/promise": "^4.12.11",
+    "@xylabs/typeof": "^4.12.11"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^6.5.8",

package/src/index.ts

@@ -1,2 +1,3 @@
 export * from './AbstractCreatable.ts'
+export * from './Creatable.ts'
 export * from './model/index.ts'