@xylabs/creatable 4.12.3 → 4.12.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1 +1 @@
|
|
|
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
|
|
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 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 {\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,\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 { 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;AAGzB,SAAS,mBAAmB;;;ACJ5B,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;;;AFyBO,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;;;AG3BO,SAAS,YAAoG;AAClH,SAAO,CAA0C,gBAAmB;AAElE;AAAA,EACF;AACF;","names":[]}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { MeterProvider, TracerProvider } from '@opentelemetry/api';
|
|
2
2
|
import type { BaseClassName, BaseParams } from '@xylabs/base';
|
|
3
|
+
import type { EventData } from '@xylabs/events';
|
|
3
4
|
import { BaseEmitter } from '@xylabs/events';
|
|
4
5
|
import { type Logger } from '@xylabs/logger';
|
|
5
6
|
import type { EmptyObject } from '@xylabs/object';
|
|
@@ -16,7 +17,7 @@ export type CreatableParamsFields = {
|
|
|
16
17
|
traceProvider?: TracerProvider;
|
|
17
18
|
};
|
|
18
19
|
export type CreatableParams<TAdditionalParams extends EmptyObject | void = void> = BaseParams<TAdditionalParams extends EmptyObject ? CreatableParamsFields & TAdditionalParams : CreatableParamsFields>;
|
|
19
|
-
export declare abstract class AbstractCreatable<TParams extends EmptyObject | void = void> extends BaseEmitter<Partial<CreatableParams<TParams
|
|
20
|
+
export declare abstract class AbstractCreatable<TParams extends EmptyObject | void = void, TEventData extends EventData = EventData> extends BaseEmitter<Partial<CreatableParams<TParams>>, TEventData> {
|
|
20
21
|
defaultLogger?: Logger;
|
|
21
22
|
name: CreatableName;
|
|
22
23
|
private _populatedParams;
|
|
@@ -1 +1 @@
|
|
|
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;
|
|
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,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,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,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"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xylabs/creatable",
|
|
3
|
-
"version": "4.12.
|
|
3
|
+
"version": "4.12.4",
|
|
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.
|
|
34
|
-
"@xylabs/base": "^4.12.
|
|
35
|
-
"@xylabs/events": "^4.12.
|
|
36
|
-
"@xylabs/logger": "^4.12.
|
|
37
|
-
"@xylabs/object": "^4.12.
|
|
38
|
-
"@xylabs/typeof": "^4.12.
|
|
33
|
+
"@xylabs/assert": "^4.12.4",
|
|
34
|
+
"@xylabs/base": "^4.12.4",
|
|
35
|
+
"@xylabs/events": "^4.12.4",
|
|
36
|
+
"@xylabs/logger": "^4.12.4",
|
|
37
|
+
"@xylabs/object": "^4.12.4",
|
|
38
|
+
"@xylabs/typeof": "^4.12.4"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@xylabs/ts-scripts-yarn3": "^6.5.8",
|
package/src/AbstractCreatable.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { MeterProvider, TracerProvider } from '@opentelemetry/api'
|
|
2
2
|
import { assertEx } from '@xylabs/assert'
|
|
3
3
|
import type { BaseClassName, BaseParams } from '@xylabs/base'
|
|
4
|
+
import type { EventData } from '@xylabs/events'
|
|
4
5
|
import { BaseEmitter } from '@xylabs/events'
|
|
5
6
|
import { type Logger } from '@xylabs/logger'
|
|
6
7
|
import type { EmptyObject } from '@xylabs/object'
|
|
@@ -29,7 +30,8 @@ export type CreatableParamsFields = {
|
|
|
29
30
|
export type CreatableParams<TAdditionalParams extends EmptyObject | void = void> =
|
|
30
31
|
BaseParams<TAdditionalParams extends EmptyObject ? CreatableParamsFields & TAdditionalParams : CreatableParamsFields>
|
|
31
32
|
|
|
32
|
-
export abstract class AbstractCreatable<TParams extends EmptyObject | void = void
|
|
33
|
+
export abstract class AbstractCreatable<TParams extends EmptyObject | void = void,
|
|
34
|
+
TEventData extends EventData = EventData> extends BaseEmitter<Partial<CreatableParams<TParams>>, TEventData> {
|
|
33
35
|
defaultLogger?: Logger
|
|
34
36
|
name: CreatableName
|
|
35
37
|
|