@xylabs/creatable 4.13.15 → 4.13.17

package/README.md

@@ -1,69 +1,60 @@
-[![logo][]](https://xylabs.com)
+# @xylabs/creatable
 
-# @xylabs/base
+[![logo][]](https://xylabs.com)
 
+[![main-build][]][main-build-link]
 [![npm-badge][]][npm-link]
 [![npm-downloads-badge][]][npm-link]
 [![jsdelivr-badge][]][jsdelivr-link]
 [![npm-license-badge][]](LICENSE)
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
 [![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:
+Version: 4.13.15
 
-```sh
-npm i --save @xylabs/base
-```
+Primary SDK for using XYO Protocol 2.0
 
-Using yarn:
+## Documentation
 
-```sh
-yarn add @xylabs/base
-```
+Coming Soon!
 
-## Documentation
-[Developer Reference](https://xylabs.github.io/sdk-js)
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/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)
+-   [Joel Carter](https://github.com/JoelBCarter)
 -   [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
-See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
-[Made with 🔥and ❄️ by XY Labs](https://xylabs.com)
+[Made with 🔥 and ❄️ by XYLabs](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
+[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
+[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
+[npm-badge]: https://img.shields.io/npm/v/@xylabs/creatable.svg
+[npm-link]: https://www.npmjs.com/package/@xylabs/creatable
+[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
+[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
+[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
+[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
+[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
+
+[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/creatable
+[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/creatable
+
+[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/creatable/badge
+[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/creatable
+
+[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/creatable
+[socket-link]: https://socket.dev/npm/package/@xylabs/creatable

package/dist/neutral/index.d.ts

@@ -1,110 +1,5 @@
-import { BaseClassName } from '@xylabs/base';
-import { BaseEmitterParams, EventData, EventEmitter, BaseEmitter } from '@xylabs/events';
-import { Logger } from '@xylabs/logger';
-import { Promisable } from '@xylabs/promise';
-
-type CreatableStatus = 'creating' | 'created' | 'starting' | 'started' | 'stopping' | 'stopped' | 'error';
-interface CreatableStatusReporter<T extends void | string = void> {
-    report(name: BaseClassName, status: Exclude<T extends void ? CreatableStatus : CreatableStatus | T, 'error'>, progress?: number): void;
-    report(name: BaseClassName, status: Extract<T extends void ? CreatableStatus : CreatableStatus | T, 'error'>, error?: Error): void;
-}
-
-type CreatableName = Exclude<string, 'creatable-name-reserved-32546239486'> & BaseClassName;
-interface CreatableParams extends BaseEmitterParams {
-    name?: CreatableName;
-    statusReporter?: CreatableStatusReporter;
-}
-
-interface CreatableInstance<TParams extends CreatableParams = CreatableParams, TEventData extends EventData = EventData> extends EventEmitter<TEventData> {
-    eventData: TEventData;
-    name: CreatableName;
-    params: TParams;
-}
-
-/**
- * Object used to represent labels identifying a resource.
- */
-interface Labels {
-    [key: string]: string | undefined;
-}
-/**
- * Interface for objects that have labels.
- */
-interface WithLabels<T extends Labels = Labels> {
-    labels: T;
-}
-/**
- * Interface for objects that have labels.
- */
-interface WithOptionalLabels<T extends Labels = Labels> {
-    labels?: T;
-}
-/**
- * Returns true if the source object has all the labels from the required set
- * @param source Source object to check against
- * @param required Set of labels to check for in source
- * @returns True of the source object has all the labels from the required set
- */
-declare const hasAllLabels: (source?: Labels, required?: Labels) => boolean;
-
-interface CreatableFactory<T extends CreatableInstance = CreatableInstance> extends Omit<Creatable<T>, 'create' | 'createHandler' | 'paramsHandler' | 'defaultLogger' | 'factory'> {
-    create(this: CreatableFactory<T>, params?: Partial<T['params']>): Promise<T>;
-}
-interface Creatable<T extends CreatableInstance = CreatableInstance> {
-    defaultLogger?: Logger;
-    new (key: unknown, params: Partial<CreatableParams>): 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>;
-    paramsHandler<T extends CreatableInstance>(this: Creatable<T>, params?: Partial<T['params']>): Promisable<T['params']>;
-}
-interface CreatableWithFactory<T extends CreatableInstance = CreatableInstance> extends Creatable<T> {
-    factory<T extends CreatableInstance>(this: Creatable<T>, params?: Partial<T['params']>, labels?: Labels): CreatableFactory<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
- */
-declare function creatable<T extends CreatableInstance>(): <U extends Creatable<T>>(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
- */
-declare function creatableFactory(): <U extends CreatableFactory>(constructor: U) => void;
-
-declare class AbstractCreatable<TParams extends CreatableParams = CreatableParams, TEventData extends EventData = EventData> extends BaseEmitter<Partial<TParams>, TEventData> {
-    defaultLogger?: Logger;
-    private _validatedParams?;
-    constructor(key: unknown, params: Partial<TParams>);
-    get name(): CreatableName;
-    get params(): TParams;
-    get statusReporter(): CreatableStatusReporter<void> | undefined;
-    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 paramsHandler<T extends CreatableInstance>(this: Creatable<T>, params?: Partial<T['params']>): Promisable<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>;
-}
-declare class AbstractCreatableWithFactory<TParams extends CreatableParams = CreatableParams, TEventData extends EventData = EventData> extends AbstractCreatable<TParams, TEventData> {
-    static factory<T extends CreatableInstance>(this: Creatable<T>, params?: Partial<T['params']>, labels?: Labels): CreatableFactory<T>;
-}
-
-declare class Factory<T extends CreatableInstance = CreatableInstance> implements CreatableFactory<T> {
-    creatable: Creatable<T>;
-    defaultParams?: Partial<T['params']>;
-    labels?: Labels;
-    constructor(creatable: Creatable<T>, params?: Partial<T['params']>, labels?: Labels);
-    static withParams<T extends CreatableInstance>(creatableModule: Creatable<T>, params?: Partial<T['params']>, labels?: Labels): Factory<T>;
-    create(params?: Partial<T['params']>): Promise<T>;
-}
-
-export { AbstractCreatable, AbstractCreatableWithFactory, Factory, creatable, creatableFactory, hasAllLabels };
-export type { Creatable, CreatableFactory, CreatableInstance, CreatableName, CreatableParams, CreatableStatus, CreatableStatusReporter, CreatableWithFactory, Labels, WithLabels, WithOptionalLabels };
+export * from './AbstractCreatable.ts';
+export * from './Creatable.ts';
+export * from './Factory.ts';
+export * from './model/index.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/spec/TestCreatable.spec.d.ts

@@ -0,0 +1,13 @@
+import type { EventData } from '@xylabs/events';
+import { Promisable } from '@xylabs/promise';
+import { AbstractCreatable } from '../AbstractCreatable.ts';
+import { Creatable } from '../Creatable.ts';
+import { 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.spec.d.ts.map

package/dist/neutral/spec/TestCreatable.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestCreatable.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/TestCreatable.spec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAK5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,SAAS,EAAa,MAAM,iBAAiB,CAAA;AACtD,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEtE,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/neutral/spec/TestCreatable2.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=TestCreatable2.spec.d.ts.map

package/dist/neutral/spec/TestCreatable2.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestCreatable2.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/TestCreatable2.spec.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/creatable",
-  "version": "4.13.15",
+  "version": "4.13.17",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,16 +29,16 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/assert": "^4.13.15",
-    "@xylabs/base": "^4.13.15",
-    "@xylabs/events": "^4.13.15",
-    "@xylabs/logger": "^4.13.15",
-    "@xylabs/promise": "^4.13.15",
-    "@xylabs/typeof": "^4.13.15"
+    "@xylabs/assert": "^4.13.17",
+    "@xylabs/base": "^4.13.17",
+    "@xylabs/events": "^4.13.17",
+    "@xylabs/logger": "^4.13.17",
+    "@xylabs/promise": "^4.13.17",
+    "@xylabs/typeof": "^4.13.17"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
-    "@xylabs/tsconfig": "^7.0.0-rc.20",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
     "tslib": "^2.8.1",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"

package/build/neutral/index.d.ts

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