@xylabs/creatable 4.12.3

package/README.md

@@ -0,0 +1,69 @@
+[![logo][]](https://xylabs.com)
+
+# @xylabs/base
+
+[![npm-badge][]][npm-link]
+[![npm-downloads-badge][]][npm-link]
+[![jsdelivr-badge][]][jsdelivr-link]
+[![npm-license-badge][]](LICENSE)
+[![socket-badge][]][socket-link]
+
+> XY Labs generalized Javascript library 
+
+## Table of Contents
+
+-   [Description](#description)
+-   [Install](#install)
+-   [Maintainers](#maintainers)
+-   [License](#license)
+-   [Credits](#credits)
+
+## Description
+
+Common Javascript code that is used throughout XYO projects that use React.
+
+## Install
+
+Using npm:
+
+```sh
+npm i --save @xylabs/base
+```
+
+Using yarn:
+
+```sh
+yarn add @xylabs/base
+```
+
+## Documentation
+[Developer Reference](https://xylabs.github.io/sdk-js)
+
+## Maintainers
+
+-   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
+-   [Joel Carter](https://github.com/JoelBCarter)
+-   [Matt Jones](https://github.com/jonesmac)
+-   [Jordan Trouw](https://github.com/jordantrouw)
+
+## License
+
+See the [LICENSE](LICENSE) file for license details
+
+## Credits
+
+[Made with 🔥and ❄️ by XY Labs](https://xylabs.com)
+
+[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
+
+[npm-badge]: https://img.shields.io/npm/v/@xylabs/base.svg
+[npm-link]: https://www.npmjs.com/package/@xylabs/base
+
+[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/base
+[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/base
+
+[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/base/badge
+[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/base
+
+[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/base
+[socket-link]: https://socket.dev/npm/package/@xylabs/base

package/dist/neutral/index.mjs

@@ -0,0 +1,70 @@
+// src/AbstractCreatable.ts
+import { assertEx } from "@xylabs/assert";
+import { BaseEmitter } from "@xylabs/events";
+
+// src/getFunctionName.ts
+import { isNumber } from "@xylabs/typeof";
+function getFunctionName(depth = 2) {
+  const error = new Error("Stack");
+  let newIndex;
+  const stackParts = error.stack?.split("\n")[depth]?.split(" ");
+  const funcName = stackParts?.find((item, index) => {
+    if (item.length > 0 && item !== "at") {
+      if (item === "new") {
+        newIndex = index;
+      }
+      return true;
+    }
+  }) ?? "<unknown>";
+  return isNumber(newIndex) ? `${funcName} ${stackParts?.[newIndex + 1]}` : funcName;
+}
+
+// src/getRootFunction.ts
+function getRootFunction(obj, funcName) {
+  let anyObj = obj;
+  while (anyObj.__proto__?.[funcName]) {
+    anyObj = anyObj.__proto__;
+  }
+  return anyObj[funcName];
+}
+
+// src/AbstractCreatable.ts
+var AbstractCreatable = class extends BaseEmitter {
+  defaultLogger;
+  name;
+  _populatedParams;
+  constructor(params) {
+    super(params);
+    this.name = params.name ?? this.constructor.name;
+  }
+  get params() {
+    this._noOverride();
+    this._populatedParams = this._populatedParams ?? this.paramsHandler(super.params);
+    return this._populatedParams;
+  }
+  static async create(params) {
+    const instance = new this(params);
+    await instance.createHandler();
+    return await Promise.resolve(instance);
+  }
+  createHandler() {
+    return true;
+  }
+  _noOverride(functionName = getFunctionName(3)) {
+    const thisFunc = this[functionName];
+    const rootFunc = getRootFunction(this, functionName);
+    assertEx(thisFunc === rootFunc, () => `Override not allowed for [${functionName}] - override ${functionName}Handler instead`);
+  }
+};
+
+// src/Creatable.ts
+function creatable() {
+  return (constructor) => {
+    constructor;
+  };
+}
+export {
+  AbstractCreatable,
+  creatable
+};
+//# sourceMappingURL=index.mjs.map

package/dist/neutral/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/AbstractCreatable.ts","../../src/getFunctionName.ts","../../src/getRootFunction.ts","../../src/Creatable.ts"],"sourcesContent":["import type { MeterProvider, TracerProvider } from '@opentelemetry/api'\nimport { assertEx } from '@xylabs/assert'\nimport type { BaseClassName, BaseParams } from '@xylabs/base'\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 {\n  Creatable, CreatableInstance,\n  CreatableName,\n} from './Creatable.ts'\nimport { getFunctionName } from './getFunctionName.ts'\nimport { getRootFunction } from './getRootFunction.ts'\n\nexport type CreatableStatus = 'creating' | 'created' | 'starting' | 'started' | 'stopping' | 'stopped'\n\nexport interface StatusReporter {\n  report: (name: BaseClassName, status: CreatableStatus, progress?: number) => void\n}\n\nexport type CreatableParamsFields = {\n  logger?: Logger\n  meterProvider?: MeterProvider\n  name?: BaseClassName\n  traceProvider?: TracerProvider\n}\n\nexport type CreatableParams<TAdditionalParams extends EmptyObject | void = void> =\n  BaseParams<TAdditionalParams extends EmptyObject ? CreatableParamsFields & TAdditionalParams : CreatableParamsFields>\n\nexport abstract class AbstractCreatable<TParams extends EmptyObject | void = void> extends BaseEmitter<Partial<CreatableParams<TParams>>> {\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 { BaseClassName } from '@xylabs/base'\nimport type { Logger } from '@xylabs/logger'\nimport type { EmptyObject } from '@xylabs/object'\n\nimport type { AbstractCreatable, CreatableParams } from './AbstractCreatable.ts'\n\nexport type CreatableName = Exclude<string, 'creatable-name-reserved-32546239486'> & BaseClassName\n\nexport interface CreatableInstanceFields<TParams extends EmptyObject | void = void> {\n  name: CreatableName\n  params: CreatableParams<TParams>\n}\n\nexport type CreatableInstance<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void>\n  = T extends EmptyObject ? T & CreatableInstanceFields<TParams> : CreatableInstanceFields<TParams>\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":";AACA,SAAS,gBAAgB;AAEzB,SAAS,mBAAmB;;;ACH5B,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;;;AFwBO,IAAe,oBAAf,cAAoF,YAA+C;AAAA,EACxI;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;;;AGzBO,SAAS,YAAoG;AAClH,SAAO,CAA0C,gBAAmB;AAElE;AAAA,EACF;AACF;","names":[]}

package/dist/types/AbstractCreatable.d.ts

@@ -0,0 +1,30 @@
+import type { MeterProvider, TracerProvider } from '@opentelemetry/api';
+import type { BaseClassName, BaseParams } from '@xylabs/base';
+import { BaseEmitter } from '@xylabs/events';
+import { type Logger } from '@xylabs/logger';
+import type { EmptyObject } from '@xylabs/object';
+import type { Promisable } from '@xylabs/promise';
+import type { Creatable, CreatableInstance, CreatableName } from './Creatable.ts';
+export type CreatableStatus = 'creating' | 'created' | 'starting' | 'started' | 'stopping' | 'stopped';
+export interface StatusReporter {
+    report: (name: BaseClassName, status: CreatableStatus, progress?: number) => void;
+}
+export type CreatableParamsFields = {
+    logger?: Logger;
+    meterProvider?: MeterProvider;
+    name?: BaseClassName;
+    traceProvider?: TracerProvider;
+};
+export type CreatableParams<TAdditionalParams extends EmptyObject | void = void> = BaseParams<TAdditionalParams extends EmptyObject ? CreatableParamsFields & TAdditionalParams : CreatableParamsFields>;
+export declare abstract class AbstractCreatable<TParams extends EmptyObject | void = void> extends BaseEmitter<Partial<CreatableParams<TParams>>> {
+    defaultLogger?: Logger;
+    name: CreatableName;
+    private _populatedParams;
+    constructor(params: Partial<CreatableParams<TParams>>);
+    get params(): CreatableParams<TParams>;
+    static create<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void>(this: Creatable<T, TParams>, params: Partial<CreatableParams<TParams>>): Promise<CreatableInstance<T>>;
+    createHandler(): Promisable<boolean>;
+    protected _noOverride(functionName?: string): void;
+    protected abstract paramsHandler(params?: Partial<CreatableParams<TParams>>): CreatableParams<TParams>;
+}
+//# sourceMappingURL=AbstractCreatable.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractCreatable.d.ts","sourceRoot":"","sources":["../../src/AbstractCreatable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAEvE,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAC7D,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,EACV,SAAS,EAAE,iBAAiB,EAC5B,aAAa,EACd,MAAM,gBAAgB,CAAA;AAIvB,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAA;AAEtG,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,eAAe,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CAClF;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,aAAa,CAAC,EAAE,cAAc,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,iBAAiB,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAC7E,UAAU,CAAC,iBAAiB,SAAS,WAAW,GAAG,qBAAqB,GAAG,iBAAiB,GAAG,qBAAqB,CAAC,CAAA;AAEvH,8BAAsB,iBAAiB,CAAC,OAAO,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,CAAE,SAAQ,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;IACvI,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"}

package/dist/types/Creatable.d.ts

@@ -0,0 +1,29 @@
+import type { BaseClassName } from '@xylabs/base';
+import type { Logger } from '@xylabs/logger';
+import type { EmptyObject } from '@xylabs/object';
+import type { AbstractCreatable, CreatableParams } from './AbstractCreatable.ts';
+export type CreatableName = Exclude<string, 'creatable-name-reserved-32546239486'> & BaseClassName;
+export interface CreatableInstanceFields<TParams extends EmptyObject | void = void> {
+    name: CreatableName;
+    params: CreatableParams<TParams>;
+}
+export type CreatableInstance<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void> = T extends EmptyObject ? T & CreatableInstanceFields<TParams> : CreatableInstanceFields<TParams>;
+export interface Creatable<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void> {
+    defaultLogger?: Logger;
+    new (params: Partial<CreatableParams<TParams>>): CreatableInstance<T> & AbstractCreatable<TParams>;
+    create<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void>(this: Creatable<T, TParams>, params: Partial<CreatableParams<TParams>>): Promise<CreatableInstance<T>>;
+}
+/**
+ * Class annotation to be used to decorate Modules which support
+ * an asynchronous creation pattern
+ * @returns The decorated Module requiring it implement the members
+ * of the CreatableModule as statics properties/methods
+ */
+export declare function creatable<TInstance extends EmptyObject | void = void, TParams extends EmptyObject | void = void>(): <U extends Creatable<TInstance, TParams>>(constructor: U) => void;
+/**
+ * Class annotation to be used to decorate Modules which support
+ * an asynchronous creation factory pattern
+ * @returns The decorated Module requiring it implement the members
+ * of the CreatableModule as statics properties/methods
+ */
+//# sourceMappingURL=Creatable.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Creatable.d.ts","sourceRoot":"","sources":["../../src/Creatable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAEhF,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,EAAE,qCAAqC,CAAC,GAAG,aAAa,CAAA;AAElG,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;AASnG,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"}

package/dist/types/getFunctionName.d.ts

@@ -0,0 +1,2 @@
+export declare function getFunctionName(depth?: number): string;
+//# sourceMappingURL=getFunctionName.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getFunctionName.d.ts","sourceRoot":"","sources":["../../src/getFunctionName.ts"],"names":[],"mappings":"AAEA,wBAAgB,eAAe,CAAC,KAAK,SAAI,UAexC"}

package/dist/types/getRootFunction.d.ts

@@ -0,0 +1,2 @@
+export declare function getRootFunction(obj: unknown, funcName: string): any;
+//# sourceMappingURL=getRootFunction.d.ts.map

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

@@ -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"}

package/dist/types/index.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,gBAAgB,CAAA"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@xylabs/creatable",
+  "version": "4.12.3",
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "homepage": "https://xyo.network",
+  "bugs": {
+    "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues",
+    "email": "support@xyo.network"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "license": "LGPL-3.0-only",
+  "author": {
+    "name": "XYO Development Team",
+    "email": "support@xyo.network",
+    "url": "https://xyo.network"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "default": "./dist/neutral/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "module": "dist/neutral/index.mjs",
+  "types": "dist/types/index.d.ts",
+  "dependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "@xylabs/assert": "^4.12.3",
+    "@xylabs/base": "^4.12.3",
+    "@xylabs/events": "^4.12.3",
+    "@xylabs/logger": "^4.12.3",
+    "@xylabs/object": "^4.12.3",
+    "@xylabs/typeof": "^4.12.3"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^6.5.8",
+    "@xylabs/tsconfig": "^6.5.8",
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/AbstractCreatable.ts

@@ -0,0 +1,71 @@
+import type { MeterProvider, TracerProvider } from '@opentelemetry/api'
+import { assertEx } from '@xylabs/assert'
+import type { BaseClassName, BaseParams } from '@xylabs/base'
+import { BaseEmitter } from '@xylabs/events'
+import { type Logger } from '@xylabs/logger'
+import type { EmptyObject } from '@xylabs/object'
+import type { Promisable } from '@xylabs/promise'
+
+import type {
+  Creatable, CreatableInstance,
+  CreatableName,
+} from './Creatable.ts'
+import { getFunctionName } from './getFunctionName.ts'
+import { getRootFunction } from './getRootFunction.ts'
+
+export type CreatableStatus = 'creating' | 'created' | 'starting' | 'started' | 'stopping' | 'stopped'
+
+export interface StatusReporter {
+  report: (name: BaseClassName, status: CreatableStatus, progress?: number) => void
+}
+
+export type CreatableParamsFields = {
+  logger?: Logger
+  meterProvider?: MeterProvider
+  name?: BaseClassName
+  traceProvider?: TracerProvider
+}
+
+export type CreatableParams<TAdditionalParams extends EmptyObject | void = void> =
+  BaseParams<TAdditionalParams extends EmptyObject ? CreatableParamsFields & TAdditionalParams : CreatableParamsFields>
+
+export abstract class AbstractCreatable<TParams extends EmptyObject | void = void> extends BaseEmitter<Partial<CreatableParams<TParams>>> {
+  defaultLogger?: Logger
+  name: CreatableName
+
+  private _populatedParams: CreatableParams<TParams> | undefined
+
+  constructor(params: Partial<CreatableParams<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
+  }
+
+  static async create<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void>(
+    this: Creatable<T, TParams>,
+    params: Partial<CreatableParams<TParams>>,
+  ): Promise<CreatableInstance<T>> {
+    const instance = new this(params)
+    await instance.createHandler()
+    return await Promise.resolve(instance as CreatableInstance<T>)
+  }
+
+  createHandler(): Promisable<boolean> {
+    return true
+  }
+
+  protected _noOverride(functionName = getFunctionName(3)) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const thisFunc = (this as any)[functionName]
+
+    const rootFunc = getRootFunction(this, functionName)
+    assertEx(thisFunc === rootFunc, () => `Override not allowed for [${functionName}] - override ${functionName}Handler instead`)
+  }
+
+  protected abstract paramsHandler(params?: Partial<CreatableParams<TParams>>): CreatableParams<TParams>
+}

package/src/Creatable.ts

@@ -0,0 +1,67 @@
+import type { BaseClassName } from '@xylabs/base'
+import type { Logger } from '@xylabs/logger'
+import type { EmptyObject } from '@xylabs/object'
+
+import type { AbstractCreatable, CreatableParams } from './AbstractCreatable.ts'
+
+export type CreatableName = Exclude<string, 'creatable-name-reserved-32546239486'> & BaseClassName
+
+export interface CreatableInstanceFields<TParams extends EmptyObject | void = void> {
+  name: CreatableName
+  params: CreatableParams<TParams>
+}
+
+export type CreatableInstance<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void>
+  = T extends EmptyObject ? T & CreatableInstanceFields<TParams> : CreatableInstanceFields<TParams>
+
+/*
+export interface CreatableFactory<T extends EmptyObject | void = void,
+  TParams extends EmptyObject | void = void> {
+  create(params?: CreatableParams<TParams>): Promise<CreatableInstance<T>>
+}
+*/
+
+export interface Creatable<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void> {
+
+  defaultLogger?: Logger
+
+  new (params: Partial<CreatableParams<TParams>>): CreatableInstance<T> & AbstractCreatable<TParams>
+
+  create<T extends EmptyObject | void = void, TParams extends EmptyObject | void = void>(
+    this: Creatable<T, TParams>,
+    params: Partial<CreatableParams<TParams>>): Promise<CreatableInstance<T>>
+
+  /*
+  factory<T extends EmptyObject | void = void,
+    TParams extends EmptyObject | void = void> (this: Creatable<T, TParams>, params: Partial<CreatableParams<TParams>>): CreatableFactory<T, TParams>
+  */
+}
+
+/**
+ * Class annotation to be used to decorate Modules which support
+ * an asynchronous creation pattern
+ * @returns The decorated Module requiring it implement the members
+ * of the CreatableModule as statics properties/methods
+ */
+export function creatable<TInstance extends EmptyObject | void = void, TParams extends EmptyObject | void = void>() {
+  return <U extends Creatable<TInstance, TParams>>(constructor: U) => {
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+    constructor
+  }
+}
+
+/**
+ * Class annotation to be used to decorate Modules which support
+ * an asynchronous creation factory pattern
+ * @returns The decorated Module requiring it implement the members
+ * of the CreatableModule as statics properties/methods
+ */
+
+/*
+export function creatableFactory() {
+  return <U extends CreatableFactory>(constructor: U) => {
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+    constructor
+  }
+}
+*/

package/src/getFunctionName.ts

@@ -0,0 +1,18 @@
+import { isNumber } from '@xylabs/typeof'
+
+export function getFunctionName(depth = 2) {
+  const error = new Error('Stack')
+  let newIndex: number | undefined
+  const stackParts = error.stack?.split('\n')[depth]?.split(' ')
+  const funcName
+        = stackParts?.find((item, index) => {
+          if (item.length > 0 && item !== 'at') {
+            // check if constructor
+            if (item === 'new') {
+              newIndex = index
+            }
+            return true
+          }
+        }) ?? '<unknown>'
+  return isNumber(newIndex) ? `${funcName} ${stackParts?.[newIndex + 1]}` : funcName
+}

package/src/getRootFunction.ts

@@ -0,0 +1,8 @@
+export function getRootFunction(obj: unknown, funcName: string) {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  let anyObj = obj as any
+  while (anyObj.__proto__?.[funcName]) {
+    anyObj = anyObj.__proto__
+  }
+  return anyObj[funcName]
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './AbstractCreatable.ts'
+export * from './Creatable.ts'

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.typedoc.json"
+}

package/xy.config.ts

@@ -0,0 +1,10 @@
+import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
+const config: XyTsupConfig = {
+  compile: {
+    browser: {},
+    neutral: { src: true },
+    node: {},
+  },
+}
+
+export default config