@breadstone-infrastructure/utilities 0.0.12-beta.0

package/DI/Container.js

@@ -0,0 +1,143 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Container = void 0;
+require("reflect-metadata");
+/**
+ * Represents a dependency injection container.
+ *
+ * @public
+ */
+class Container {
+    // #region Fields
+    static _instance;
+    _registry;
+    // #endregion
+    // #region Ctor
+    /**
+     * Constructs a new instance of the `Container` class.
+     *
+     * @protected
+     */
+    constructor() {
+        this._registry = new Map();
+    }
+    // #endregion
+    // #region Properties
+    /**
+     * Gets the singleton instance of the `Container` class.
+     *
+     * @public
+     * @static
+     * @readonly
+     */
+    static get instance() {
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+        if (!Container._instance) {
+            Container._instance = new Container();
+        }
+        return Container._instance;
+    }
+    // #endregion
+    // #region Methods
+    /**
+     * Registers a class for the specified token.
+     *
+     * @public
+     * @param token - The token to register. Can be a `Function` or `string`.
+     * @param clazz - The class to associate with the token. If not provided, the token itself will be used as the class.
+     */
+    provide(token, clazz) {
+        const actualClass = clazz ?? token;
+        if (typeof actualClass === 'function') {
+            if (!actualClass.prototype.constructor.length) {
+                throw new Error(`${actualClass.name} is not instantiable.`);
+            }
+        }
+        this._registry.set(token, {
+            token: actualClass
+        });
+        return this;
+    }
+    /**
+     * Registers a factory function for the specified token.
+     *
+     * @public
+     * @param token - The token to register. Can be a `Function` or `string`.
+     * @param factory - The factory function to produce the instance.
+     */
+    provideFactory(token, factory) {
+        this._registry.set(token, {
+            token,
+            factory
+        });
+        return this;
+    }
+    /**
+     * Registers a static value or object for the specified token.
+     *
+     * @public
+     * @param token - The token to register. Can be a `Function` or `string`.
+     * @param value - The static value or object to register.
+     */
+    provideValue(token, value) {
+        this._registry.set(token, {
+            token,
+            value
+        });
+        return this;
+    }
+    /**
+     * Resolves an instance for the specified token.
+     *
+     * @public
+     * @param token - The token to resolve. Can be a `Function` or `string`.
+     * @returns The resolved instance.
+     * @throws Error if no instance is found for the token.
+     */
+    get(token) {
+        const item = this._registry.get(token);
+        if (!item) {
+            throw new Error(`Nothing found for token '${typeof token === 'string' ? token : token.name}'`);
+        }
+        if (!item.instance) {
+            if (item.value !== undefined) {
+                // Use the registered static value
+                return item.value;
+            }
+            else if (item.factory) {
+                // Use the factory function to create the instance
+                item.instance = item.factory(this);
+            }
+            else if (typeof item.token === 'function') {
+                // Automatically create an instance using the constructor
+                const params = this.getInjectedParams(item.token);
+                const newInstance = Reflect.construct(item.token, params);
+                item.instance = newInstance;
+            }
+            else {
+                throw new Error(`Token '${String(token)}' is a string and does not support automatic instantiation.`);
+            }
+        }
+        if (item.instance) {
+            return item.instance;
+        }
+        throw new Error(`Instance for token '${typeof token === 'string' ? token : token.name}' is not of type ${String(token)}`);
+    }
+    /**
+     * Reads type information from metadata and resolves dependencies.
+     *
+     * @private
+     * @param clazz - The class to resolve constructor parameters for.
+     */
+    getInjectedParams(clazz) {
+        const argTypes = Reflect.getMetadata('design:paramtypes', clazz) || [];
+        return argTypes.map((token) => {
+            if (typeof token === 'function' || typeof token === 'string') {
+                return this.get(token);
+            }
+            throw new Error(`Invalid token type: ${typeof token}`);
+        });
+    }
+}
+exports.Container = Container;
+//# sourceMappingURL=Container.js.map

package/DI/Container.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Container.js","sourceRoot":"","sources":["../../src/DI/Container.ts"],"names":[],"mappings":";;;AAAA,4BAA0B;AAwB1B;;;;GAIG;AACH,MAAa,SAAS;IAElB,iBAAiB;IAET,MAAM,CAAC,SAAS,CAAY;IACnB,SAAS,CAAwC;IAElE,aAAa;IAEb,eAAe;IAEf;;;;OAIG;IACH;QACI,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;IAC/B,CAAC;IAED,aAAa;IAEb,qBAAqB;IAErB;;;;;;OAMG;IACI,MAAM,KAAK,QAAQ;QACtB,uEAAuE;QACvE,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;YACvB,SAAS,CAAC,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;QAC1C,CAAC;QACD,OAAO,SAAS,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,aAAa;IAEb,kBAAkB;IAElB;;;;;;OAMG;IACI,OAAO,CAAI,KAAe,EAAE,KAAgB;QAC/C,MAAM,WAAW,GAAG,KAAK,IAAI,KAAK,CAAC;QAEnC,IAAI,OAAO,WAAW,KAAK,UAAU,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;gBAC5C,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,CAAC,IAAI,uBAAuB,CAAC,CAAC;YAChE,CAAC;QACL,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE;YACtB,KAAK,EAAE,WAAW;SACrB,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAI,KAAe,EAAE,OAA4B;QAClE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE;YACtB,KAAK;YACL,OAAO;SACV,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACI,YAAY,CAAI,KAAe,EAAE,KAAQ;QAC5C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE;YACtB,KAAK;YACL,KAAK;SACR,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACI,GAAG,CAAU,KAAe;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAEvC,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,4BAA4B,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;QACnG,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC3B,kCAAkC;gBAClC,OAAO,IAAI,CAAC,KAAK,CAAC;YACtB,CAAC;iBAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACtB,kDAAkD;gBAClD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACvC,CAAC;iBAAM,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;gBAC1C,yDAAyD;gBACzD,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAClD,MAAM,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;gBAC1D,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACJ,MAAM,IAAI,KAAK,CAAC,UAAU,MAAM,CAAC,KAAK,CAAC,6DAA6D,CAAC,CAAC;YAC1G,CAAC;QACL,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;QACzB,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,uBAAuB,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,oBAAoB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC9H,CAAC;IAED;;;;;OAKG;IACK,iBAAiB,CAAC,KAAe;QACrC,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;QACvE,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAc,EAAE,EAAE;YACnC,IAAI,OAAO,KAAK,KAAK,UAAU,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,KAAuB,CAAC,CAAC;YAC7C,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,uBAAuB,OAAO,KAAK,EAAE,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACP,CAAC;CAIJ;AA3JD,8BA2JC"}

package/DI/Inject.d.ts

@@ -0,0 +1,11 @@
+import { type Token } from './Container';
+/**
+ * Injects a dependency from the container.
+ *
+ * @param token - The token of the dependency to inject.
+ * @returns The instance of the dependency.
+ *
+ * @public
+ */
+export declare function inject<T = any>(token: Token<T>): T;
+//# sourceMappingURL=Inject.d.ts.map

package/DI/Inject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Inject.d.ts","sourceRoot":"","sources":["../../src/DI/Inject.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAa,MAAM,aAAa,CAAC;AAIpD;;;;;;;GAOG;AACH,wBAAgB,MAAM,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAElD"}

package/DI/Inject.js

@@ -0,0 +1,18 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.inject = inject;
+const Container_1 = require("./Container");
+// #endregion
+/**
+ * Injects a dependency from the container.
+ *
+ * @param token - The token of the dependency to inject.
+ * @returns The instance of the dependency.
+ *
+ * @public
+ */
+function inject(token) {
+    return Container_1.Container.instance.get(token);
+}
+//# sourceMappingURL=Inject.js.map

package/DI/Inject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Inject.js","sourceRoot":"","sources":["../../src/DI/Inject.ts"],"names":[],"mappings":";AAAA,kBAAkB;;AAclB,wBAEC;AAdD,2CAAoD;AAEpD,aAAa;AAEb;;;;;;;GAOG;AACH,SAAgB,MAAM,CAAU,KAAe;IAC3C,OAAO,qBAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC"}

package/Decorators/EnumerableDecorator.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @enumerable decorator that sets the enumerable property of a class field to false.
+ * @param value true|false
+ */
+export declare function Enumerable(value: boolean): any;
+//# sourceMappingURL=EnumerableDecorator.d.ts.map

package/Decorators/EnumerableDecorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnumerableDecorator.d.ts","sourceRoot":"","sources":["../../src/Decorators/EnumerableDecorator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,GAAG,CAS9C"}

package/Decorators/EnumerableDecorator.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Enumerable = Enumerable;
+/**
+ * @enumerable decorator that sets the enumerable property of a class field to false.
+ * @param value true|false
+ */
+function Enumerable(value) {
+    return function (target, propertyKey) {
+        const descriptor = Object.getOwnPropertyDescriptor(target, propertyKey) ?? {};
+        if (descriptor.enumerable !== value) {
+            descriptor.enumerable = value;
+            descriptor.writable = true;
+            Object.defineProperty(target, propertyKey, descriptor);
+        }
+    };
+}
+//# sourceMappingURL=EnumerableDecorator.js.map

package/Decorators/EnumerableDecorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnumerableDecorator.js","sourceRoot":"","sources":["../../src/Decorators/EnumerableDecorator.ts"],"names":[],"mappings":";;AAIA,gCASC;AAbD;;;GAGG;AACH,SAAgB,UAAU,CAAC,KAAc;IACrC,OAAO,UAAS,MAAW,EAAE,WAAmB;QAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;QAC9E,IAAI,UAAU,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAClC,UAAU,CAAC,UAAU,GAAG,KAAK,CAAC;YAC9B,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC;YAC3B,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;QAC3D,CAAC;IACL,CAAC,CAAC;AACN,CAAC"}

package/Events/AsyncEventEmitter.d.ts

@@ -0,0 +1,8 @@
+import { EventEmitter } from 'events';
+/**
+ * @public
+ */
+export declare class AsyncEventEmitter extends EventEmitter {
+    emitAsync(event: string | symbol, ...args: Array<any>): Promise<boolean>;
+}
+//# sourceMappingURL=AsyncEventEmitter.d.ts.map

package/Events/AsyncEventEmitter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AsyncEventEmitter.d.ts","sourceRoot":"","sources":["../../src/Events/AsyncEventEmitter.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAMtC;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IAIlC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CA2BxF"}

package/Events/AsyncEventEmitter.js

@@ -0,0 +1,37 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AsyncEventEmitter = void 0;
+// #region Imports
+const events_1 = require("events");
+const es_toolkit_1 = require("es-toolkit");
+const compat_1 = require("es-toolkit/compat");
+// #endregion
+/**
+ * @public
+ */
+class AsyncEventEmitter extends events_1.EventEmitter {
+    // #region Methods
+    async emitAsync(event, ...args) {
+        const evts = this._events;
+        const handler = (0, compat_1.get)(evts, event);
+        if ((0, compat_1.isEmpty)(handler) && !(0, es_toolkit_1.isFunction)(handler)) {
+            return false;
+        }
+        const promises = [];
+        if (typeof handler === 'function') {
+            promises.push(Reflect.apply(handler, this, args));
+        }
+        else {
+            const len = handler.length;
+            const listeners = (0, es_toolkit_1.clone)(handler);
+            for (let i = 0; i < len; i += 1) {
+                promises.push(Reflect.apply(listeners[i], this, args));
+            }
+        }
+        await Promise.all(promises);
+        return true;
+    }
+}
+exports.AsyncEventEmitter = AsyncEventEmitter;
+//# sourceMappingURL=AsyncEventEmitter.js.map

package/Events/AsyncEventEmitter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AsyncEventEmitter.js","sourceRoot":"","sources":["../../src/Events/AsyncEventEmitter.ts"],"names":[],"mappings":";AAAA,uDAAuD;;;AAEvD,kBAAkB;AAElB,mCAAsC;AACtC,2CAA+C;AAC/C,8CAAiD;AAEjD,aAAa;AAEb;;GAEG;AACH,MAAa,iBAAkB,SAAQ,qBAAY;IAE/C,kBAAkB;IAEX,KAAK,CAAC,SAAS,CAAC,KAAsB,EAAE,GAAG,IAAgB;QAC9D,MAAM,IAAI,GAAI,IAAY,CAAC,OAAO,CAAC;QACnC,MAAM,OAAO,GAAG,IAAA,YAAG,EAAC,IAAI,EAAE,KAAK,CAAe,CAAC;QAE/C,IAAI,IAAA,gBAAO,EAAC,OAAO,CAAC,IAAI,CAAC,IAAA,uBAAU,EAAC,OAAO,CAAC,EAAE,CAAC;YAC3C,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,MAAM,QAAQ,GAAG,EAAE,CAAC;QAEpB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YAChC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACJ,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;YAC3B,MAAM,SAAS,GAAG,IAAA,kBAAK,EAAC,OAAO,CAAC,CAAC;YACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YAC3D,CAAC;QACL,CAAC;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAE5B,OAAO,IAAI,CAAC;IAChB,CAAC;CAIJ;AA/BD,8CA+BC"}

package/IO/CustomElementManifest.d.ts

@@ -0,0 +1,254 @@
+export declare namespace CustomElementManifest {
+    interface PackageDoc {
+        version: string;
+        /**
+         * An array of the modules this package contains.
+         */
+        modules: Array<ModuleDoc>;
+    }
+    interface ModuleDoc {
+        path: string;
+        /**
+         * A markdown summary suitable for display in a listing.
+         */
+        summary?: string;
+        /**
+         * A markdown description of the module.
+         */
+        description?: string;
+        exports?: Array<ExportDoc>;
+    }
+    type ExportDoc = ClassDoc | FunctionDoc | VariableDoc | CustomElementDefinitionDoc;
+    /**
+     * A reference to an export of a module.
+     *
+     * All references are required to be publically accessible, so the canonical
+     * representation of a refernce it the export it's available from.
+     */
+    interface Reference {
+        name: string;
+        package?: string;
+        module?: string;
+    }
+    interface CustomElementDoc extends ClassDoc {
+        tagName: string;
+        /**
+         * The attributes that this element is known to understand.
+         */
+        attributes?: Array<AttributeDoc>;
+        /** The events that this element fires. */
+        events?: Array<EventDoc>;
+        /**
+         * The shadow dom content slots that this element accepts.
+         */
+        slots?: Array<SlotDoc>;
+        cssProperties?: Array<CSSPropertyDoc>;
+        cssParts?: Array<CSSPartDoc>;
+        demos?: Array<Demo>;
+    }
+    interface CustomElementDefinitionDoc {
+        kind: 'definition';
+        name: string;
+        declaration: Reference;
+    }
+    interface AttributeDoc {
+        name: string;
+        /**
+         * A markdown description for the attribute.
+         */
+        description?: string;
+        /**
+         * The type that the attribute will be serialized/deserialized as.
+         */
+        type?: string;
+        /**
+         * The default value of the attribute, if any.
+         *
+         * As attributes are always strings, this is the actual value, not a human
+         * readable description.
+         */
+        defaultValue?: string;
+        /**
+         * The name of the field this attribute is associated with, if any.
+         */
+        fieldName?: string;
+        /**
+         * A reference to the class or mixin that declared this property.
+         */
+        inheritedFrom?: Reference;
+    }
+    interface EventDoc {
+        name: string;
+        /**
+         * A markdown description of the event.
+         */
+        description?: string;
+        /**
+         * The type of the event object that's fired.
+         *
+         * If the event type is built-in, this is a string, e.g. `Event`,
+         * `CustomEvent`, `KeyboardEvent`. If the event type is an event class defined
+         * in a module, the reference to it.
+         */
+        type?: Reference | string;
+        /**
+         * If the event is a CustomEvent, the type of `detail` field.
+         */
+        detailType?: string;
+        /**
+         * A reference to the class or mixin that declared this property.
+         */
+        inheritedFrom?: Reference;
+    }
+    interface SlotDoc {
+        /**
+         * The slot name, or the empty string for an unnamed slot.
+         */
+        name: string;
+        /**
+         * A markdown description of the slot.
+         */
+        description?: string;
+        /**
+         * A reference to the class or mixin that declared this property.
+         */
+        inheritedFrom?: Reference;
+    }
+    interface CSSPropertyDoc {
+        name: string;
+        description?: string;
+        type?: string;
+        default?: string;
+        /**
+         * A reference to the class or mixin that declared this property.
+         */
+        inheritedFrom?: Reference;
+    }
+    interface CSSPartDoc {
+        name: string;
+        description?: string;
+        /**
+         * A reference to the class or mixin that declared this property.
+         */
+        inheritedFrom?: Reference;
+    }
+    interface ClassDoc {
+        kind: 'class';
+        /**
+         * The class name, or `undefined` if the class is anonymous.
+         */
+        name?: string;
+        /**
+         * A markdown summary suitable for display in a listing.
+         * TODO: restrictions on markdown/markup. ie, no headings, only inline
+         *       formatting?
+         */
+        summary?: string;
+        /**
+         * A markdown description of the class.
+         */
+        description?: string;
+        superclass?: Reference;
+        mixins?: Array<Reference>;
+        members?: Array<ClassMember>;
+    }
+    type ClassMember = FieldDoc | MethodDoc;
+    interface FieldDoc {
+        kind: 'field';
+        name: string;
+        static?: boolean;
+        /**
+         * A markdown summary suitable for display in a listing.
+         * TODO: restrictions on markdown/markup. ie, no headings, only inline
+         *       formatting?
+         */
+        summary?: string;
+        /**
+         * A markdown description of the field.
+         */
+        description?: string;
+        default?: string;
+        privacy?: Privacy;
+        type?: string;
+        /**
+         * A reference to the class or mixin that declared this property.
+         */
+        inheritedFrom?: Reference;
+    }
+    interface MethodDoc extends FunctionLike {
+        kind: 'method';
+        static?: boolean;
+        /**
+         * A reference to the class or mixin that declared this property.
+         */
+        inheritedFrom?: Reference;
+    }
+    /**
+     * TODO: tighter definition of mixin:
+     *  - Should it only accept a single argument?
+     *  - Should it not extend ClassDoc so it doesn't has a superclass?
+     *  - What's TypeScript's exact definition?
+     */
+    interface MixinDoc extends ClassDoc {
+    }
+    interface VariableDoc {
+        kind: 'variable';
+        name: string;
+        /**
+         * A markdown summary suitable for display in a listing.
+         */
+        summary?: string;
+        /**
+         * A markdown description of the class.
+         */
+        description?: string;
+        type?: string;
+    }
+    interface FunctionDoc extends FunctionLike {
+        kind: 'function';
+    }
+    interface Parameter {
+        name: string;
+        type?: string;
+        description?: string;
+    }
+    interface FunctionLike {
+        name: string;
+        /**
+         * A markdown summary suitable for display in a listing.
+         */
+        summary?: string;
+        /**
+         * A markdown description of the class.
+         */
+        description?: string;
+        parameters?: Array<Parameter>;
+        return?: {
+            type?: string;
+            description?: string;
+        };
+        privacy?: Privacy;
+        type?: string;
+    }
+    type Privacy = 'public' | 'private' | 'protected';
+    interface Demo {
+        /**
+         * A markdown description of the demo.
+         */
+        description?: string;
+        /**
+         * Relative URL of the demo if it's published with the package. Absolute URL
+         * if it's hosted.
+         */
+        url: string;
+    }
+    function readProperties(pkg: PackageDoc): Array<FieldDoc>;
+    function readMethods(pkg: PackageDoc): Array<MethodDoc>;
+    function readEvents(pkg: PackageDoc): Array<EventDoc>;
+    function readSlots(pkg: PackageDoc): Array<SlotDoc>;
+    function readAttributes(pkg: PackageDoc): Array<AttributeDoc>;
+    function readCSSProperties(pkg: PackageDoc): Array<CSSPropertyDoc>;
+    function readCSSParts(pkg: PackageDoc): Array<CSSPartDoc>;
+    function readDefinition(pkg: PackageDoc): CustomElementDefinitionDoc;
+}
+//# sourceMappingURL=CustomElementManifest.d.ts.map

package/IO/CustomElementManifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomElementManifest.d.ts","sourceRoot":"","sources":["../../src/IO/CustomElementManifest.ts"],"names":[],"mappings":"AAAA,yBAAiB,qBAAqB,CAAC;IAEnC,UAAiB,UAAU;QACvB,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;KAC7B;IAED,UAAiB,SAAS;QACtB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;KAC9B;IAED,KAAY,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,WAAW,GAAG,0BAA0B,CAAC;IAE1F;;;;;OAKG;IACH,UAAiB,SAAS;QACtB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,gBAAiB,SAAQ,QAAQ;QAC9C,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;QAEjC,0CAA0C;QAC1C,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEzB;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAEvB,aAAa,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;QAEtC,QAAQ,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAE7B,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;KACvB;IAED,UAAiB,0BAA0B;QACvC,IAAI,EAAE,YAAY,CAAC;QAEnB,IAAI,EAAE,MAAM,CAAC;QAEb,WAAW,EAAE,SAAS,CAAC;KAC1B;IAED,UAAiB,YAAY;QACzB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;;WAKG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,CAAC;KAC7B;IAED,UAAiB,QAAQ;QACrB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;;;WAMG;QACH,IAAI,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;QAE1B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,CAAC;KAC7B;IAED,UAAiB,OAAO;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,CAAC;KAC7B;IAED,UAAiB,cAAc;QAC3B,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,CAAC;KAC7B;IAED,UAAiB,UAAU;QACvB,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,CAAC;KAC7B;IAED,UAAiB,QAAQ;QACrB,IAAI,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,SAAS,CAAC;QACvB,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;QAC1B,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;KAChC;IAED,KAAY,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;IAE/C,UAAiB,QAAQ;QACrB,IAAI,EAAE,OAAO,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,CAAC;KAC7B;IAED,UAAiB,SAAU,SAAQ,YAAY;QAC3C,IAAI,EAAE,QAAQ,CAAC;QAEf,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,CAAC;KAC7B;IAED;;;;;OAKG;IACH,UAAiB,QAAS,SAAQ,QAAQ;KAAI;IAE9C,UAAiB,WAAW;QACxB,IAAI,EAAE,UAAU,CAAC;QAEjB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB;IAED,UAAiB,WAAY,SAAQ,YAAY;QAC7C,IAAI,EAAE,UAAU,CAAC;KACpB;IAED,UAAiB,SAAS;QACtB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,YAAY;QACzB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;QAE9B,MAAM,CAAC,EAAE;YACL,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,WAAW,CAAC,EAAE,MAAM,CAAC;SACxB,CAAC;QAEF,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB;IAED,KAAY,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;IAEzD,UAAiB,IAAI;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;KACf;IAED,SAAgB,cAAc,CAAC,GAAG,EAAE,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,CAQ/D;IAED,SAAgB,WAAW,CAAC,GAAG,EAAE,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC,CAK7D;IAED,SAAgB,UAAU,CAAC,GAAG,EAAE,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,CAK3D;IAED,SAAgB,SAAS,CAAC,GAAG,EAAE,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,CAKzD;IAED,SAAgB,cAAc,CAAC,GAAG,EAAE,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC,CAKnE;IAED,SAAgB,iBAAiB,CAAC,GAAG,EAAE,UAAU,GAAG,KAAK,CAAC,cAAc,CAAC,CAKxE;IAED,SAAgB,YAAY,CAAC,GAAG,EAAE,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,CAK/D;IAED,SAAgB,cAAc,CAAC,GAAG,EAAE,UAAU,GAAG,0BAA0B,CAI1E;CAEJ"}

package/IO/CustomElementManifest.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomElementManifest = void 0;
+var CustomElementManifest;
+(function (CustomElementManifest) {
+    function readProperties(pkg) {
+        const doc = pkg.modules.flatMap((m) => m.exports?.filter((d) => d.kind === 'class') ?? [])[0];
+        let properties = doc.members?.filter((m) => m.kind === 'field' && m.privacy === 'public') ?? [];
+        // Diry hack to remove properties that are also events
+        properties = properties.filter((p) => !doc.events?.some((e) => e.name === p.name));
+        return properties;
+    }
+    CustomElementManifest.readProperties = readProperties;
+    function readMethods(pkg) {
+        const doc = pkg.modules.flatMap((m) => m.exports?.filter((d) => d.kind === 'class') ?? [])[0];
+        const methods = doc.members?.filter((m) => m.kind === 'method' && m.privacy === 'public') ?? [];
+        return methods;
+    }
+    CustomElementManifest.readMethods = readMethods;
+    function readEvents(pkg) {
+        const doc = pkg.modules.flatMap((m) => m.exports?.filter((d) => d.kind === 'class') ?? [])[0];
+        const events = doc.events ?? [];
+        return events;
+    }
+    CustomElementManifest.readEvents = readEvents;
+    function readSlots(pkg) {
+        const doc = pkg.modules.flatMap((m) => m.exports?.filter((d) => d.kind === 'class') ?? [])[0];
+        const slots = doc.slots ?? [];
+        return slots;
+    }
+    CustomElementManifest.readSlots = readSlots;
+    function readAttributes(pkg) {
+        const doc = pkg.modules.flatMap((m) => m.exports?.filter((d) => d.kind === 'class') ?? [])[0];
+        const attributes = doc.attributes ?? [];
+        return attributes;
+    }
+    CustomElementManifest.readAttributes = readAttributes;
+    function readCSSProperties(pkg) {
+        const doc = pkg.modules.flatMap((m) => m.exports?.filter((d) => d.kind === 'class') ?? [])[0];
+        const cssProperties = doc.cssProperties ?? [];
+        return cssProperties;
+    }
+    CustomElementManifest.readCSSProperties = readCSSProperties;
+    function readCSSParts(pkg) {
+        const doc = pkg.modules.flatMap((m) => m.exports?.filter((d) => d.kind === 'class') ?? [])[0];
+        const cssParts = doc.cssParts ?? [];
+        return cssParts;
+    }
+    CustomElementManifest.readCSSParts = readCSSParts;
+    function readDefinition(pkg) {
+        const doc = pkg.modules.flatMap((m) => m.exports?.filter((d) => d.kind === 'definition') ?? [])[0];
+        return doc;
+    }
+    CustomElementManifest.readDefinition = readDefinition;
+})(CustomElementManifest || (exports.CustomElementManifest = CustomElementManifest = {}));
+//# sourceMappingURL=CustomElementManifest.js.map

package/IO/CustomElementManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomElementManifest.js","sourceRoot":"","sources":["../../src/IO/CustomElementManifest.ts"],"names":[],"mappings":";;;AAAA,IAAiB,qBAAqB,CAgXrC;AAhXD,WAAiB,qBAAqB;IAsTlC,SAAgB,cAAc,CAAC,GAAe;QAC1C,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAyB,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACrH,IAAI,UAAU,GAAG,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAiB,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,CAAC,OAAO,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;QAE/G,sDAAsD;QACtD,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAEnF,OAAO,UAAU,CAAC;IACtB,CAAC;IARe,oCAAc,iBAQ7B,CAAA;IAED,SAAgB,WAAW,CAAC,GAAe;QACvC,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAyB,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACrH,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAkB,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,OAAO,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEhH,OAAO,OAAO,CAAC;IACnB,CAAC;IALe,iCAAW,cAK1B,CAAA;IAED,SAAgB,UAAU,CAAC,GAAe;QACtC,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAyB,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACrH,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;QAEhC,OAAO,MAAM,CAAC;IAClB,CAAC;IALe,gCAAU,aAKzB,CAAA;IAED,SAAgB,SAAS,CAAC,GAAe;QACrC,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAyB,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACrH,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;QAE9B,OAAO,KAAK,CAAC;IACjB,CAAC;IALe,+BAAS,YAKxB,CAAA;IAED,SAAgB,cAAc,CAAC,GAAe;QAC1C,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAyB,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACrH,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC;QAExC,OAAO,UAAU,CAAC;IACtB,CAAC;IALe,oCAAc,iBAK7B,CAAA;IAED,SAAgB,iBAAiB,CAAC,GAAe;QAC7C,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAyB,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACrH,MAAM,aAAa,GAAG,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC;QAE9C,OAAO,aAAa,CAAC;IACzB,CAAC;IALe,uCAAiB,oBAKhC,CAAA;IAED,SAAgB,YAAY,CAAC,GAAe;QACxC,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAyB,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACrH,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC;QAEpC,OAAO,QAAQ,CAAC;IACpB,CAAC;IALe,kCAAY,eAK3B,CAAA;IAED,SAAgB,cAAc,CAAC,GAAe;QAC1C,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAmC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAEpI,OAAO,GAAG,CAAC;IACf,CAAC;IAJe,oCAAc,iBAI7B,CAAA;AAEL,CAAC,EAhXgB,qBAAqB,qCAArB,qBAAqB,QAgXrC"}