@xylabs/creatable 4.12.18 → 4.12.20

package/dist/neutral/index.mjs

@@ -1,8 +1,26 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result) __defProp(target, key, result);
+  return result;
+};
+
 // src/AbstractCreatable.ts
 import { assertEx } from "@xylabs/assert";
 import { BaseEmitter } from "@xylabs/events";
 import { isError } from "@xylabs/typeof";
 
+// src/Creatable.ts
+function creatable() {
+  return (constructor) => {
+    constructor;
+  };
+}
+
 // src/lib/getFunctionName.ts
 import { isNumber } from "@xylabs/typeof";
 function getFunctionName(depth = 2) {
@@ -32,21 +50,22 @@ function getRootFunction(obj, funcName) {
 // src/AbstractCreatable.ts
 var AbstractCreatable = class extends BaseEmitter {
   defaultLogger;
-  name;
-  _populatedParams;
+  _validatedParams;
   constructor(params) {
     super(params);
-    this.name = params.name ?? this.constructor.name;
+  }
+  get name() {
+    return this.params.name;
   }
   get params() {
-    this._noOverride();
-    this._populatedParams = this._populatedParams ?? this.paramsHandler(super.params);
-    return this._populatedParams;
+    this._validatedParams = this._validatedParams ?? this.paramsValidator(super.params);
+    return this._validatedParams;
   }
   get statusReporter() {
     return this.params.statusReporter;
   }
-  static async create(params = {}) {
+  static async create(inParams = {}) {
+    const params = { ...await this.defaultParams(), ...inParams };
     const name = params.name ?? this.name;
     params.statusReporter?.report(name, "creating");
     try {
@@ -60,12 +79,17 @@ var AbstractCreatable = class extends BaseEmitter {
       throw new Error(`Error creating: ${name}`);
     }
   }
-  /* override this for initialization of instance */
   static createHandler(instance) {
     return instance;
   }
+  static defaultParams() {
+    return {};
+  }
   createHandler() {
   }
+  paramsValidator(params) {
+    return { ...params, name: params.name ?? this.constructor.name };
+  }
   async start() {
     this._noOverride("start");
     try {
@@ -100,13 +124,9 @@ var AbstractCreatable = class extends BaseEmitter {
   stopHandler() {
   }
 };
-
-// src/Creatable.ts
-function creatable() {
-  return (constructor) => {
-    constructor;
-  };
-}
+AbstractCreatable = __decorateClass([
+  creatable()
+], AbstractCreatable);
 export {
   AbstractCreatable,
   creatable

package/dist/neutral/index.mjs.map

@@ -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 { Promisable } from '@xylabs/promise'\nimport { isError } from '@xylabs/typeof'\n\nimport { type Creatable, creatable } from './Creatable.ts'\nimport { getFunctionName, getRootFunction } from './lib/index.ts'\nimport type {\n  CreatableInstance, CreatableName, CreatableParams,\n} from './model/index.ts'\n\nexport abstract class AbstractCreatable<TParams extends CreatableParams = CreatableParams,\n  TEventData extends EventData = EventData> extends BaseEmitter<Partial<TParams>, TEventData> {\n  defaultLogger?: Logger\n  name: CreatableName\n\n  private _populatedParams: TParams | undefined\n\n  constructor(params: Partial<TParams>) {\n    super(params)\n    this.name = params.name ?? this.constructor.name as CreatableName\n  }\n\n  override get params(): CreatableParams<TParams> {\n    this._noOverride()\n    this._populatedParams = this._populatedParams ?? this.paramsHandler(super.params)\n    return this._populatedParams\n  }\n\n  get statusReporter() {\n    return this.params.statusReporter\n  }\n\n  static async create<T extends CreatableInstance>(\n    this: Creatable<T>,\n    params: Partial<T['params']> = {},\n  ): Promise<T> {\n    const name: CreatableName = params.name ?? this.name\n    params.statusReporter?.report(name, 'creating')\n    try {\n      const instance = new this(params)\n      const initializedInstance = await this.createHandler(instance)\n      await instance.createHandler()\n      params.statusReporter?.report(name, 'created')\n      return initializedInstance\n    } catch (ex) {\n      params.statusReporter?.report(name, 'error', isError(ex) ? ex : new Error(`Error creating: ${name}`))\n      throw new Error(`Error creating: ${name}`)\n    }\n  }\n\n  /* override this for initialization of instance */\n  static createHandler<T extends CreatableInstance>(\n    this: Creatable<T>,\n    instance: T,\n  ): Promisable<T> {\n    return instance\n  }\n\n  createHandler(): Promisable<void> {}\n\n  async start(): Promise<boolean> {\n    this._noOverride('start')\n    try {\n      this.statusReporter?.report(this.name, 'starting')\n      await this.startHandler()\n      this.statusReporter?.report(this.name, 'started')\n      return true\n    } catch (ex) {\n      this.statusReporter?.report(this.name, 'error', isError(ex) ? ex : new Error(`Error stopping: ${ex}`))\n      return false\n    }\n  }\n\n  async stop(): Promise<boolean> {\n    this._noOverride('stop')\n    try {\n      this.statusReporter?.report(this.name, 'stopping')\n      await this.stopHandler()\n      this.statusReporter?.report(this.name, 'stopped')\n      return true\n    } catch (ex) {\n      this.statusReporter?.report(this.name, 'error', isError(ex) ? ex : new Error(`Error stopping: ${ex}`))\n      return false\n    }\n  }\n\n  protected _noOverride(functionName = getFunctionName(3)) {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    const thisFunc = (this as any)[functionName]\n\n    const rootFunc = getRootFunction(this, functionName)\n    assertEx(thisFunc === rootFunc, () => `Override not allowed for [${functionName}] - override ${functionName}Handler instead`)\n  }\n\n  protected startHandler(): Promisable<void> {\n    // when overriding this, throw an error on failure\n  }\n\n  protected stopHandler(): Promisable<void> {\n    // when overriding this, throw an error on failure\n  }\n\n  protected abstract paramsHandler(params?: Partial<CreatableParams<TParams>>): CreatableParams<TParams>\n}\n","import { isNumber } from '@xylabs/typeof'\n\nexport function getFunctionName(depth = 2) {\n  const error = new Error('Stack')\n  let newIndex: number | undefined\n  const stackParts = error.stack?.split('\\n')[depth]?.split(' ')\n  const funcName\n        = stackParts?.find((item, index) => {\n          if (item.length > 0 && item !== 'at') {\n            // check if constructor\n            if (item === 'new') {\n              newIndex = index\n            }\n            return true\n          }\n        }) ?? '<unknown>'\n  return isNumber(newIndex) ? `${funcName} ${stackParts?.[newIndex + 1]}` : funcName\n}\n","export function getRootFunction(obj: unknown, funcName: string) {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  let anyObj = obj as any\n  while (anyObj.__proto__?.[funcName]) {\n    anyObj = anyObj.__proto__\n  }\n  return anyObj[funcName]\n}\n","import type { Logger } from '@xylabs/logger'\nimport type { EmptyObject } from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\n\nimport type { AbstractCreatable } from './AbstractCreatable.ts'\nimport type { CreatableInstance, CreatableParams } from './model/index.ts'\n\n/*\nexport interface CreatableFactory<T extends EmptyObject | void = void,\n  TParams extends EmptyObject | void = void> {\n  create(params?: CreatableParams<TParams>): Promise<CreatableInstance<T>>\n}\n*/\n\nexport interface Creatable<T extends CreatableInstance = CreatableInstance> {\n\n  defaultLogger?: Logger\n\n  new (params: Partial<T['params']>): T & AbstractCreatable<T['params']>\n\n  create<T extends CreatableInstance>(\n    this: Creatable<T>,\n    params: Partial<T['params']>): Promise<T>\n\n  createHandler<T extends CreatableInstance>(\n    this: Creatable<T>,\n    instance: T\n  ): Promisable<T>\n\n  /*\n  factory<T extends EmptyObject | void = void,\n    TParams extends EmptyObject | void = void> (this: Creatable<T, TParams>, params: Partial<CreatableParams<TParams>>): CreatableFactory<T, TParams>\n  */\n}\n\n/**\n * Class annotation to be used to decorate Modules which support\n * an asynchronous creation pattern\n * @returns The decorated Module requiring it implement the members\n * of the CreatableModule as statics properties/methods\n */\nexport function creatable<T extends EmptyObject | void = void, TParams extends CreatableParams = CreatableParams>() {\n  return <U extends Creatable<CreatableInstance<T, TParams>>>(constructor: U) => {\n    // eslint-disable-next-line @typescript-eslint/no-unused-expressions\n    constructor\n  }\n}\n\n/**\n * Class annotation to be used to decorate Modules which support\n * an asynchronous creation factory pattern\n * @returns The decorated Module requiring it implement the members\n * of the CreatableModule as statics properties/methods\n */\n\n/*\nexport function creatableFactory() {\n  return <U extends CreatableFactory>(constructor: U) => {\n    // eslint-disable-next-line @typescript-eslint/no-unused-expressions\n    constructor\n  }\n}\n*/\n"],"mappings":";AAAA,SAAS,gBAAgB;AAEzB,SAAS,mBAAmB;AAG5B,SAAS,eAAe;;;ACLxB,SAAS,gBAAgB;AAElB,SAAS,gBAAgB,QAAQ,GAAG;AACzC,QAAM,QAAQ,IAAI,MAAM,OAAO;AAC/B,MAAI;AACJ,QAAM,aAAa,MAAM,OAAO,MAAM,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG;AAC7D,QAAM,WACE,YAAY,KAAK,CAAC,MAAM,UAAU;AAClC,QAAI,KAAK,SAAS,KAAK,SAAS,MAAM;AAEpC,UAAI,SAAS,OAAO;AAClB,mBAAW;AAAA,MACb;AACA,aAAO;AAAA,IACT;AAAA,EACF,CAAC,KAAK;AACZ,SAAO,SAAS,QAAQ,IAAI,GAAG,QAAQ,IAAI,aAAa,WAAW,CAAC,CAAC,KAAK;AAC5E;;;ACjBO,SAAS,gBAAgB,KAAc,UAAkB;AAE9D,MAAI,SAAS;AACb,SAAO,OAAO,YAAY,QAAQ,GAAG;AACnC,aAAS,OAAO;AAAA,EAClB;AACA,SAAO,OAAO,QAAQ;AACxB;;;AFMO,IAAe,oBAAf,cAC6C,YAA0C;AAAA,EAC5F;AAAA,EACA;AAAA,EAEQ;AAAA,EAER,YAAY,QAA0B;AACpC,UAAM,MAAM;AACZ,SAAK,OAAO,OAAO,QAAQ,KAAK,YAAY;AAAA,EAC9C;AAAA,EAEA,IAAa,SAAmC;AAC9C,SAAK,YAAY;AACjB,SAAK,mBAAmB,KAAK,oBAAoB,KAAK,cAAc,MAAM,MAAM;AAChF,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,iBAAiB;AACnB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,aAAa,OAEX,SAA+B,CAAC,GACpB;AACZ,UAAM,OAAsB,OAAO,QAAQ,KAAK;AAChD,WAAO,gBAAgB,OAAO,MAAM,UAAU;AAC9C,QAAI;AACF,YAAM,WAAW,IAAI,KAAK,MAAM;AAChC,YAAM,sBAAsB,MAAM,KAAK,cAAc,QAAQ;AAC7D,YAAM,SAAS,cAAc;AAC7B,aAAO,gBAAgB,OAAO,MAAM,SAAS;AAC7C,aAAO;AAAA,IACT,SAAS,IAAI;AACX,aAAO,gBAAgB,OAAO,MAAM,SAAS,QAAQ,EAAE,IAAI,KAAK,IAAI,MAAM,mBAAmB,IAAI,EAAE,CAAC;AACpG,YAAM,IAAI,MAAM,mBAAmB,IAAI,EAAE;AAAA,IAC3C;AAAA,EACF;AAAA;AAAA,EAGA,OAAO,cAEL,UACe;AACf,WAAO;AAAA,EACT;AAAA,EAEA,gBAAkC;AAAA,EAAC;AAAA,EAEnC,MAAM,QAA0B;AAC9B,SAAK,YAAY,OAAO;AACxB,QAAI;AACF,WAAK,gBAAgB,OAAO,KAAK,MAAM,UAAU;AACjD,YAAM,KAAK,aAAa;AACxB,WAAK,gBAAgB,OAAO,KAAK,MAAM,SAAS;AAChD,aAAO;AAAA,IACT,SAAS,IAAI;AACX,WAAK,gBAAgB,OAAO,KAAK,MAAM,SAAS,QAAQ,EAAE,IAAI,KAAK,IAAI,MAAM,mBAAmB,EAAE,EAAE,CAAC;AACrG,aAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEA,MAAM,OAAyB;AAC7B,SAAK,YAAY,MAAM;AACvB,QAAI;AACF,WAAK,gBAAgB,OAAO,KAAK,MAAM,UAAU;AACjD,YAAM,KAAK,YAAY;AACvB,WAAK,gBAAgB,OAAO,KAAK,MAAM,SAAS;AAChD,aAAO;AAAA,IACT,SAAS,IAAI;AACX,WAAK,gBAAgB,OAAO,KAAK,MAAM,SAAS,QAAQ,EAAE,IAAI,KAAK,IAAI,MAAM,mBAAmB,EAAE,EAAE,CAAC;AACrG,aAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEU,YAAY,eAAe,gBAAgB,CAAC,GAAG;AAEvD,UAAM,WAAY,KAAa,YAAY;AAE3C,UAAM,WAAW,gBAAgB,MAAM,YAAY;AACnD,aAAS,aAAa,UAAU,MAAM,6BAA6B,YAAY,gBAAgB,YAAY,iBAAiB;AAAA,EAC9H;AAAA,EAEU,eAAiC;AAAA,EAE3C;AAAA,EAEU,cAAgC;AAAA,EAE1C;AAGF;;;AGjEO,SAAS,YAAoG;AAClH,SAAO,CAAqD,gBAAmB;AAE7E;AAAA,EACF;AACF;","names":[]}
+{"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":[]}

package/dist/types/AbstractCreatable.d.ts

@@ -4,21 +4,22 @@ import { type Logger } from '@xylabs/logger';
 import type { Promisable } from '@xylabs/promise';
 import { type Creatable } from './Creatable.ts';
 import type { CreatableInstance, CreatableName, CreatableParams } from './model/index.ts';
-export declare abstract class AbstractCreatable<TParams extends CreatableParams = CreatableParams, TEventData extends EventData = EventData> extends BaseEmitter<Partial<TParams>, TEventData> {
+export declare class AbstractCreatable<TParams extends CreatableParams = CreatableParams, TEventData extends EventData = EventData> extends BaseEmitter<Partial<TParams>, TEventData> {
     defaultLogger?: Logger;
-    name: CreatableName;
-    private _populatedParams;
+    private _validatedParams?;
     constructor(params: Partial<TParams>);
-    get params(): CreatableParams<TParams>;
+    get name(): CreatableName;
+    get params(): TParams;
     get statusReporter(): import("./model/CreatableStatusReporter.ts").CreatableStatusReporter | undefined;
-    static create<T extends CreatableInstance>(this: Creatable<T>, params?: Partial<T['params']>): Promise<T>;
+    static create<T extends CreatableInstance>(this: Creatable<T>, inParams?: Partial<T['params']>): Promise<T>;
     static createHandler<T extends CreatableInstance>(this: Creatable<T>, instance: T): Promisable<T>;
+    static defaultParams<T extends CreatableInstance>(this: Creatable<T>): Promisable<Partial<T['params']>>;
     createHandler(): Promisable<void>;
+    paramsValidator(params: Partial<TParams>): TParams;
     start(): Promise<boolean>;
     stop(): Promise<boolean>;
     protected _noOverride(functionName?: string): void;
     protected startHandler(): Promisable<void>;
     protected stopHandler(): Promisable<void>;
-    protected abstract paramsHandler(params?: Partial<CreatableParams<TParams>>): CreatableParams<TParams>;
 }
 //# sourceMappingURL=AbstractCreatable.d.ts.map

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

@@ -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,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAGjD,OAAO,EAAE,KAAK,SAAS,EAAa,MAAM,gBAAgB,CAAA;AAE1D,OAAO,KAAK,EACV,iBAAiB,EAAE,aAAa,EAAE,eAAe,EAClD,MAAM,kBAAkB,CAAA;AAEzB,8BAAsB,iBAAiB,CAAC,OAAO,SAAS,eAAe,GAAG,eAAe,EACvF,UAAU,SAAS,SAAS,GAAG,SAAS,CAAE,SAAQ,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC3F,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,IAAI,EAAE,aAAa,CAAA;IAEnB,OAAO,CAAC,gBAAgB,CAAqB;gBAEjC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC;IAKpC,IAAa,MAAM,IAAI,eAAe,CAAC,OAAO,CAAC,CAI9C;IAED,IAAI,cAAc,qFAEjB;WAEY,MAAM,CAAC,CAAC,SAAS,iBAAiB,EAC7C,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAClB,MAAM,GAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAM,GAChC,OAAO,CAAC,CAAC,CAAC;IAgBb,MAAM,CAAC,aAAa,CAAC,CAAC,SAAS,iBAAiB,EAC9C,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAClB,QAAQ,EAAE,CAAC,GACV,UAAU,CAAC,CAAC,CAAC;IAIhB,aAAa,IAAI,UAAU,CAAC,IAAI,CAAC;IAE3B,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;IAazB,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;IAa9B,SAAS,CAAC,WAAW,CAAC,YAAY,SAAqB;IAQvD,SAAS,CAAC,YAAY,IAAI,UAAU,CAAC,IAAI,CAAC;IAI1C,SAAS,CAAC,WAAW,IAAI,UAAU,CAAC,IAAI,CAAC;IAIzC,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC;CACvG"}
+{"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"}

package/dist/types/Creatable.d.ts

@@ -8,6 +8,7 @@ export interface Creatable<T extends CreatableInstance = CreatableInstance> {
     new (params: Partial<T['params']>): T & AbstractCreatable<T['params']>;
     create<T extends CreatableInstance>(this: Creatable<T>, params: Partial<T['params']>): Promise<T>;
     createHandler<T extends CreatableInstance>(this: Creatable<T>, instance: T): Promisable<T>;
+    defaultParams<T extends CreatableInstance>(this: Creatable<T>): Promisable<Partial<T['params']>>;
 }
 /**
  * Class annotation to be used to decorate Modules which support

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

@@ -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;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAS1E,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB;IAExE,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,KAAK,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;IAEtE,MAAM,CAAC,CAAC,SAAS,iBAAiB,EAChC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAClB,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IAE3C,aAAa,CAAC,CAAC,SAAS,iBAAiB,EACvC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAClB,QAAQ,EAAE,CAAC,GACV,UAAU,CAAC,CAAC,CAAC,CAAA;CAMjB;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,eAAe,GAAG,eAAe,MACtG,CAAC,SAAS,SAAS,CAAC,iBAAiB,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,aAAa,CAAC,UAI3E;AAED;;;;;GAKG"}
+{"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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/creatable",
-  "version": "4.12.18",
+  "version": "4.12.20",
   "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": {
-    "@xylabs/assert": "^4.12.18",
-    "@xylabs/base": "^4.12.18",
-    "@xylabs/events": "^4.12.18",
-    "@xylabs/logger": "^4.12.18",
-    "@xylabs/object": "^4.12.18",
-    "@xylabs/promise": "^4.12.18",
-    "@xylabs/typeof": "^4.12.18"
+    "@xylabs/assert": "^4.12.20",
+    "@xylabs/base": "^4.12.20",
+    "@xylabs/events": "^4.12.20",
+    "@xylabs/logger": "^4.12.20",
+    "@xylabs/object": "^4.12.20",
+    "@xylabs/promise": "^4.12.20",
+    "@xylabs/typeof": "^4.12.20"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^6.5.9",

package/src/AbstractCreatable.ts

@@ -11,22 +11,24 @@ import type {
   CreatableInstance, CreatableName, CreatableParams,
 } from './model/index.ts'
 
-export abstract class AbstractCreatable<TParams extends CreatableParams = CreatableParams,
+@creatable()
+export class AbstractCreatable<TParams extends CreatableParams = CreatableParams,
   TEventData extends EventData = EventData> extends BaseEmitter<Partial<TParams>, TEventData> {
   defaultLogger?: Logger
-  name: CreatableName
 
-  private _populatedParams: TParams | undefined
+  private _validatedParams?: TParams
 
   constructor(params: Partial<TParams>) {
     super(params)
-    this.name = params.name ?? this.constructor.name as CreatableName
   }
 
-  override get params(): CreatableParams<TParams> {
-    this._noOverride()
-    this._populatedParams = this._populatedParams ?? this.paramsHandler(super.params)
-    return this._populatedParams
+  get name(): CreatableName {
+    return this.params.name
+  }
+
+  override get params(): TParams {
+    this._validatedParams = this._validatedParams ?? this.paramsValidator(super.params)
+    return this._validatedParams
   }
 
   get statusReporter() {
@@ -35,8 +37,9 @@ export abstract class AbstractCreatable<TParams extends CreatableParams = Creata
 
   static async create<T extends CreatableInstance>(
     this: Creatable<T>,
-    params: Partial<T['params']> = {},
+    inParams: Partial<T['params']> = {},
   ): Promise<T> {
+    const params: Partial<T['params']> = { ...(await this.defaultParams()), ...inParams }
     const name: CreatableName = params.name ?? this.name
     params.statusReporter?.report(name, 'creating')
     try {
@@ -51,7 +54,6 @@ export abstract class AbstractCreatable<TParams extends CreatableParams = Creata
     }
   }
 
-  /* override this for initialization of instance */
   static createHandler<T extends CreatableInstance>(
     this: Creatable<T>,
     instance: T,
@@ -59,8 +61,18 @@ export abstract class AbstractCreatable<TParams extends CreatableParams = Creata
     return instance
   }
 
+  static defaultParams<T extends CreatableInstance>(
+    this: Creatable<T>,
+  ): Promisable<Partial<T['params']>> {
+    return {}
+  }
+
   createHandler(): Promisable<void> {}
 
+  paramsValidator(params: Partial<TParams>): TParams {
+    return { ...params, name: params.name ?? this.constructor.name } as TParams
+  }
+
   async start(): Promise<boolean> {
     this._noOverride('start')
     try {
@@ -102,6 +114,4 @@ export abstract class AbstractCreatable<TParams extends CreatableParams = Creata
   protected stopHandler(): Promisable<void> {
     // when overriding this, throw an error on failure
   }
-
-  protected abstract paramsHandler(params?: Partial<CreatableParams<TParams>>): CreatableParams<TParams>
 }

package/src/Creatable.ts

@@ -16,7 +16,7 @@ export interface Creatable<T extends CreatableInstance = CreatableInstance> {
 
   defaultLogger?: Logger
 
-  new (params: Partial<T['params']>): T & AbstractCreatable<T['params']>
+  new(params: Partial<T['params']>): T & AbstractCreatable<T['params']>
 
   create<T extends CreatableInstance>(
     this: Creatable<T>,
@@ -27,6 +27,9 @@ export interface Creatable<T extends CreatableInstance = CreatableInstance> {
     instance: T
   ): Promisable<T>
 
+  defaultParams<T extends CreatableInstance>(
+    this: Creatable<T>): Promisable<Partial<T['params']>>
+
   /*
   factory<T extends EmptyObject | void = void,
     TParams extends EmptyObject | void = void> (this: Creatable<T, TParams>, params: Partial<CreatableParams<TParams>>): CreatableFactory<T, TParams>

package/src/TestCreatable.ts

@@ -4,12 +4,19 @@ import { AbstractCreatable } from './AbstractCreatable.ts'
 import { creatable } from './Creatable.ts'
 import type { CreatableParams } from './model/index.ts'
 
+interface TestCreatableParams extends CreatableParams {
+  testParam: string
+}
+
 // This is here to check types
 @creatable()
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-class TestCreatable<TParams extends CreatableParams = CreatableParams, TEventData extends EventData = EventData>
+class TestCreatable<TParams extends TestCreatableParams = TestCreatableParams, TEventData extends EventData = EventData>
   extends AbstractCreatable<TParams, TEventData> {
-  protected override paramsHandler(params?: Partial<CreatableParams<TParams>> | undefined): CreatableParams<TParams> {
-    return params as CreatableParams<TParams>
+  override paramsValidator(params: Partial<TParams> = {}): TParams {
+    const result: TestCreatableParams = {
+      ...params, name: params.name ?? this.constructor.name, testParam: 'yo',
+    }
+    return result as TParams
   }
 }