@xylabs/creatable 4.12.24 → 4.12.26

package/dist/types/TestCreatable.d.ts

@@ -1,2 +1,13 @@
-export {};
+import type { EventData } from '@xylabs/events';
+import { Promisable } from '@xylabs/promise';
+import { AbstractCreatable } from './AbstractCreatable.ts';
+import { Creatable } from './Creatable.ts';
+import type { CreatableInstance, CreatableParams } from './model/index.ts';
+export interface TestCreatableParams extends CreatableParams {
+    testParam: string;
+}
+export declare class TestCreatable<TParams extends TestCreatableParams = TestCreatableParams, TEventData extends EventData = EventData> extends AbstractCreatable<TParams, TEventData> {
+    static createHandler<T extends CreatableInstance>(this: Creatable<T>, instance: T): Promisable<T>;
+    paramsValidator(params?: Partial<TParams>): TParams;
+}
 //# sourceMappingURL=TestCreatable.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"TestCreatable.d.ts","sourceRoot":"","sources":["../../src/TestCreatable.ts"],"names":[],"mappings":""}
+{"version":3,"file":"TestCreatable.d.ts","sourceRoot":"","sources":["../../src/TestCreatable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,SAAS,EAAa,MAAM,gBAAgB,CAAA;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAE1E,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,qBACa,aAAa,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB,EAAE,UAAU,SAAS,SAAS,GAAG,SAAS,CAC5H,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;WAC9B,aAAa,CAAC,CAAC,SAAS,iBAAiB,EACvD,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAClB,QAAQ,EAAE,CAAC,GACV,UAAU,CAAC,CAAC,CAAC;IAIP,eAAe,CAAC,MAAM,GAAE,OAAO,CAAC,OAAO,CAAM,GAAG,OAAO;CAMjE"}

package/dist/types/TestCreatable2.d.ts

@@ -0,0 +1,14 @@
+import type { EventData } from '@xylabs/events';
+import { Promisable } from '@xylabs/promise';
+import { Creatable } from './Creatable.ts';
+import type { CreatableInstance } from './model/index.ts';
+import { TestCreatable, TestCreatableParams } from './TestCreatable.ts';
+interface TestCreatableParams2 extends TestCreatableParams {
+    testParam2: number;
+}
+export declare class TestCreatable2<TParams extends TestCreatableParams2 = TestCreatableParams2, TEventData extends EventData = EventData> extends TestCreatable<TParams, TEventData> {
+    static createHandler<T extends CreatableInstance>(this: Creatable<T>, instance: T): Promisable<T>;
+    paramsValidator(params?: Partial<TParams>): TParams;
+}
+export {};
+//# sourceMappingURL=TestCreatable2.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TestCreatable2.d.ts","sourceRoot":"","sources":["../../src/TestCreatable2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C,OAAO,EAAE,SAAS,EAAa,MAAM,gBAAgB,CAAA;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACzD,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAEvE,UAAU,oBAAqB,SAAQ,mBAAmB;IACxD,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,qBACa,cAAc,CAAC,OAAO,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,UAAU,SAAS,SAAS,GAAG,SAAS,CAC/H,SAAQ,aAAa,CAAC,OAAO,EAAE,UAAU,CAAC;WAC1B,aAAa,CAAC,CAAC,SAAS,iBAAiB,EACvD,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAClB,QAAQ,EAAE,CAAC,GACV,UAAU,CAAC,CAAC,CAAC;IAIP,eAAe,CAAC,MAAM,GAAE,OAAO,CAAC,OAAO,CAAM,GAAG,OAAO;CAMjE"}

package/dist/types/model/CreatableInstance.d.ts

@@ -1,8 +1,8 @@
 import type { EventData } from '@xylabs/events';
 import type { CreatableName, CreatableParams } from './CreatableParams.ts';
-export interface CreatableInstance {
-    eventData: EventData;
+export interface CreatableInstance<TParams extends CreatableParams = CreatableParams, TEventData extends EventData = EventData> {
+    eventData: TEventData;
     name: CreatableName;
-    params: CreatableParams;
+    params: TParams;
 }
 //# sourceMappingURL=CreatableInstance.d.ts.map

package/dist/types/model/CreatableInstance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CreatableInstance.d.ts","sourceRoot":"","sources":["../../../src/model/CreatableInstance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE1E,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,SAAS,CAAA;IACpB,IAAI,EAAE,aAAa,CAAA;IACnB,MAAM,EAAE,eAAe,CAAA;CACxB"}
+{"version":3,"file":"CreatableInstance.d.ts","sourceRoot":"","sources":["../../../src/model/CreatableInstance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE1E,MAAM,WAAW,iBAAiB,CAAC,OAAO,SAAS,eAAe,GAAG,eAAe,EAAE,UAAU,SAAS,SAAS,GAAG,SAAS;IAC5H,SAAS,EAAE,UAAU,CAAA;IACrB,IAAI,EAAE,aAAa,CAAA;IACnB,MAAM,EAAE,OAAO,CAAA;CAChB"}

package/dist/types/model/CreatableParams.d.ts

@@ -1,7 +1,8 @@
 import type { BaseClassName } from '@xylabs/base';
+import type { BaseEmitterParams } from '@xylabs/events';
 import type { CreatableStatusReporter } from './CreatableStatusReporter.ts';
 export type CreatableName = Exclude<string, 'creatable-name-reserved-32546239486'> & BaseClassName;
-export interface CreatableParams {
+export interface CreatableParams extends BaseEmitterParams {
     name: CreatableName;
     statusReporter?: CreatableStatusReporter;
 }

package/dist/types/model/CreatableParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CreatableParams.d.ts","sourceRoot":"","sources":["../../../src/model/CreatableParams.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAEjD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AAE3E,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,EAAE,qCAAqC,CAAC,GAAG,aAAa,CAAA;AAElG,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,aAAa,CAAA;IACnB,cAAc,CAAC,EAAE,uBAAuB,CAAA;CACzC"}
+{"version":3,"file":"CreatableParams.d.ts","sourceRoot":"","sources":["../../../src/model/CreatableParams.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAEvD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AAE3E,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,EAAE,qCAAqC,CAAC,GAAG,aAAa,CAAA;AAElG,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;IACxD,IAAI,EAAE,aAAa,CAAA;IACnB,cAAc,CAAC,EAAE,uBAAuB,CAAA;CACzC"}

package/package.json

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

package/src/TestCreatable.ts

@@ -5,14 +5,12 @@ import { AbstractCreatable } from './AbstractCreatable.ts'
 import { Creatable, creatable } from './Creatable.ts'
 import type { CreatableInstance, CreatableParams } from './model/index.ts'
 
-interface TestCreatableParams extends CreatableParams {
+export 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 TestCreatableParams = TestCreatableParams, TEventData extends EventData = EventData>
+export class TestCreatable<TParams extends TestCreatableParams = TestCreatableParams, TEventData extends EventData = EventData>
   extends AbstractCreatable<TParams, TEventData> {
   static override createHandler<T extends CreatableInstance>(
     this: Creatable<T>,

package/src/TestCreatable2.ts

@@ -0,0 +1,28 @@
+import type { EventData } from '@xylabs/events'
+import { Promisable } from '@xylabs/promise'
+
+import { Creatable, creatable } from './Creatable.ts'
+import type { CreatableInstance } from './model/index.ts'
+import { TestCreatable, TestCreatableParams } from './TestCreatable.ts'
+
+interface TestCreatableParams2 extends TestCreatableParams {
+  testParam2: number
+}
+
+@creatable()
+export class TestCreatable2<TParams extends TestCreatableParams2 = TestCreatableParams2, TEventData extends EventData = EventData>
+  extends TestCreatable<TParams, TEventData> {
+  static override createHandler<T extends CreatableInstance>(
+    this: Creatable<T>,
+    instance: T,
+  ): Promisable<T> {
+    return instance
+  }
+
+  override paramsValidator(params: Partial<TParams> = {}): TParams {
+    const result: TestCreatableParams = {
+      ...params, name: params.name ?? this.constructor.name, testParam: 'yo',
+    }
+    return result as TParams
+  }
+}

package/src/model/CreatableInstance.ts

@@ -2,8 +2,8 @@ import type { EventData } from '@xylabs/events'
 
 import type { CreatableName, CreatableParams } from './CreatableParams.ts'
 
-export interface CreatableInstance {
-  eventData: EventData
+export interface CreatableInstance<TParams extends CreatableParams = CreatableParams, TEventData extends EventData = EventData> {
+  eventData: TEventData
   name: CreatableName
-  params: CreatableParams
+  params: TParams
 }

package/src/model/CreatableParams.ts

@@ -1,10 +1,11 @@
 import type { BaseClassName } from '@xylabs/base'
+import type { BaseEmitterParams } from '@xylabs/events'
 
 import type { CreatableStatusReporter } from './CreatableStatusReporter.ts'
 
 export type CreatableName = Exclude<string, 'creatable-name-reserved-32546239486'> & BaseClassName
 
-export interface CreatableParams {
+export interface CreatableParams extends BaseEmitterParams {
   name: CreatableName
   statusReporter?: CreatableStatusReporter
 }