@decaf-ts/injectable-decorators 1.6.0 → 1.6.2

package/lib/esm/Injectables.js

@@ -1,58 +1,116 @@
-import { InjectableRegistryImp, } from "./registry";
+import { InjectableRegistryImp, } from "./registry.js";
 /**
- * @summary Static class Holding the access to the injectables functions
+ * @description Central registry for managing injectable dependencies.
+ * @summary Static class holding the access to the injectables functions. Provides methods for registering,
+ * retrieving, and building injectable objects.
+ * @template T Type of the injectable object
  *
  * @class Injectables
- * @static
+ *
+ * @example
+ * // Define an injectable class
+ * @injectable()
+ * class MyService {
+ *   doSomething() {
+ *     return 'Hello World';
+ *   }
+ * }
+ *
+ * // Inject the service into another class
+ * class MyComponent {
+ *   @inject()
+ *   private service!: MyService;
+ *
+ *   useService() {
+ *     return this.service.doSomething();
+ *   }
+ * }
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant Client
+ *   participant Injectables
+ *   participant Registry
+ *
+ *   Client->>Injectables: register(MyService)
+ *   Injectables->>Registry: register(MyService)
+ *   Registry-->>Injectables: void
+ *
+ *   Client->>Injectables: get("MyService")
+ *   Injectables->>Registry: get("MyService")
+ *   Registry-->>Injectables: MyService instance
+ *   Injectables-->>Client: MyService instance
  */
 export class Injectables {
     static { this.actingInjectablesRegistry = undefined; }
     constructor() { }
     /**
-     * @summary Retrieves the named {@link Injectable} from the registry
-     * @param {string} name
-     * @param {any[]} args
+     * @description Fetches an injectable instance by its registered name.
+     * @summary Retrieves the named {@link Injectable} from the registry. If the injectable is a singleton,
+     * returns the existing instance. Otherwise, creates a new instance.
+     * @template T Type of the injectable object to retrieve
+     * @param {string} name The registered name of the injectable to retrieve
+     * @param {any[]} args Constructor arguments to pass when instantiating the injectable
+     * @return {Injectable<T> | undefined} The injectable instance or undefined if not found
      */
     static get(name, ...args) {
         return Injectables.getRegistry().get(name, ...args);
     }
     /**
-     * @summary registers an injectable constructor
-     * @param {Injectable} constructor
-     * @param {any[]} args
-     *
+     * @description Adds a class or object to the injectable registry.
+     * @summary Registers an injectable constructor or instance with the registry, making it available for injection.
+     * @template T Type of the injectable object to register
+     * @param {Injectable<T>} constructor The class constructor or object instance to register
+     * @param {any[]} args Additional arguments for registration (category, singleton flag, etc.)
+     * @return {void}
      */
     static register(constructor, ...args) {
         return Injectables.getRegistry().register(constructor, ...args);
     }
     /**
-     * @summary Instantiates an Injectable
-     * @param {Record<string, any>} obj
-     * @param {any[]} args
-     * @return T
-     *
+     * @description Creates a new instance of an injectable class.
+     * @summary Instantiates an injectable class using its constructor and the provided arguments.
+     * @template T Type of the object to build
+     * @param {Record<string, any>} obj Object containing the name of the injectable to build
+     * @param {any[]} args Constructor arguments to pass when instantiating the injectable
+     * @return {T} The newly created instance
      */
     static build(obj, ...args) {
         return Injectables.getRegistry().build(obj, ...args);
     }
     /**
-     * @summary Sets a new {@link InjectablesRegistry}
-     * @param {InjectablesRegistry} operationsRegistry the new implementation of Registry
+     * @description Replaces the current registry implementation.
+     * @summary Sets a new {@link InjectablesRegistry} implementation, allowing for custom registry behavior.
+     * @param {InjectablesRegistry} operationsRegistry The new implementation of Registry to use
+     * @return {void}
      */
     static setRegistry(operationsRegistry) {
         Injectables.actingInjectablesRegistry = operationsRegistry;
     }
     /**
-     * @summary Returns the current {@link InjectablesRegistry}
+     * @description Provides access to the current registry instance.
+     * @summary Returns the current {@link InjectablesRegistry} or creates a default one if none exists.
+     * @return {InjectablesRegistry} The current registry instance
      */
     static getRegistry() {
         if (!Injectables.actingInjectablesRegistry)
             Injectables.actingInjectablesRegistry = new InjectableRegistryImp();
         return Injectables.actingInjectablesRegistry;
     }
+    /**
+     * @description Clears all registered injectables.
+     * @summary Resets the registry to a clean state by creating a new empty registry instance.
+     * @return {void}
+     */
     static reset() {
         Injectables.setRegistry(new InjectableRegistryImp());
     }
+    /**
+     * @description Removes specific injectables from the registry based on a pattern.
+     * @summary Selectively resets the registry by removing only the injectables whose names match the provided pattern.
+     * @param {string | RegExp} match A string or regular expression pattern to match against injectable names
+     * @return {void}
+     */
     static selectiveReset(match) {
         const regexp = typeof match === "string" ? new RegExp(match) : match;
         Injectables.actingInjectablesRegistry["cache"] = Object.entries(Injectables.actingInjectablesRegistry["cache"]).reduce((accum, [key, val]) => {
@@ -62,4 +120,4 @@ export class Injectables {
         }, {});
     }
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiSW5qZWN0YWJsZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvSW5qZWN0YWJsZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUVMLHFCQUFxQixHQUV0QixNQUFNLFlBQVksQ0FBQztBQUVwQjs7Ozs7R0FLRztBQUNILE1BQU0sT0FBTyxXQUFXO2FBQ1AsOEJBQXlCLEdBQXlCLFNBQVMsQ0FBQztJQUUzRSxnQkFBdUIsQ0FBQztJQUV4Qjs7OztPQUlHO0lBQ0gsTUFBTSxDQUFDLEdBQUcsQ0FBSSxJQUFZLEVBQUUsR0FBRyxJQUFXO1FBQ3hDLE9BQU8sV0FBVyxDQUFDLFdBQVcsRUFBRSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQztJQUN0RCxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxNQUFNLENBQUMsUUFBUSxDQUFJLFdBQTBCLEVBQUUsR0FBRyxJQUFXO1FBQzNELE9BQU8sV0FBVyxDQUFDLFdBQVcsRUFBRSxDQUFDLFFBQVEsQ0FBQyxXQUFXLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQztJQUNsRSxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsTUFBTSxDQUFDLEtBQUssQ0FBSSxHQUF3QixFQUFFLEdBQUcsSUFBVztRQUN0RCxPQUFPLFdBQVcsQ0FBQyxXQUFXLEVBQUUsQ0FBQyxLQUFLLENBQUMsR0FBRyxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUM7SUFDdkQsQ0FBQztJQUVEOzs7T0FHRztJQUNILE1BQU0sQ0FBQyxXQUFXLENBQUMsa0JBQXVDO1FBQ3hELFdBQVcsQ0FBQyx5QkFBeUIsR0FBRyxrQkFBa0IsQ0FBQztJQUM3RCxDQUFDO0lBQ0Q7O09BRUc7SUFDSyxNQUFNLENBQUMsV0FBVztRQUN4QixJQUFJLENBQUMsV0FBVyxDQUFDLHlCQUF5QjtZQUN4QyxXQUFXLENBQUMseUJBQXlCLEdBQUcsSUFBSSxxQkFBcUIsRUFBRSxDQUFDO1FBQ3RFLE9BQU8sV0FBVyxDQUFDLHlCQUF5QixDQUFDO0lBQy9DLENBQUM7SUFFRCxNQUFNLENBQUMsS0FBSztRQUNWLFdBQVcsQ0FBQyxXQUFXLENBQUMsSUFBSSxxQkFBcUIsRUFBRSxDQUFDLENBQUM7SUFDdkQsQ0FBQztJQUVELE1BQU0sQ0FBQyxjQUFjLENBQUMsS0FBc0I7UUFDMUMsTUFBTSxNQUFNLEdBQUcsT0FBTyxLQUFLLEtBQUssUUFBUSxDQUFDLENBQUMsQ0FBQyxJQUFJLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDO1FBQ3BFLFdBQVcsQ0FBQyx5QkFBaUMsQ0FBQyxPQUFPLENBQUMsR0FBRyxNQUFNLENBQUMsT0FBTyxDQUNyRSxXQUFXLENBQUMseUJBQWlDLENBQUMsT0FBTyxDQUFDLENBQ3hELENBQUMsTUFBTSxDQUFDLENBQUMsS0FBMEIsRUFBRSxDQUFDLEdBQUcsRUFBRSxHQUFHLENBQUMsRUFBRSxFQUFFO1lBQ2xELElBQUksQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQztnQkFBRSxLQUFLLENBQUMsR0FBRyxDQUFDLEdBQUcsR0FBRyxDQUFDO1lBQ3pDLE9BQU8sS0FBSyxDQUFDO1FBQ2YsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDO0lBQ1QsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7XG4gIEluamVjdGFibGUsXG4gIEluamVjdGFibGVSZWdpc3RyeUltcCxcbiAgSW5qZWN0YWJsZXNSZWdpc3RyeSxcbn0gZnJvbSBcIi4vcmVnaXN0cnlcIjtcblxuLyoqXG4gKiBAc3VtbWFyeSBTdGF0aWMgY2xhc3MgSG9sZGluZyB0aGUgYWNjZXNzIHRvIHRoZSBpbmplY3RhYmxlcyBmdW5jdGlvbnNcbiAqXG4gKiBAY2xhc3MgSW5qZWN0YWJsZXNcbiAqIEBzdGF0aWNcbiAqL1xuZXhwb3J0IGNsYXNzIEluamVjdGFibGVzIHtcbiAgcHJpdmF0ZSBzdGF0aWMgYWN0aW5nSW5qZWN0YWJsZXNSZWdpc3RyeT86IEluamVjdGFibGVzUmVnaXN0cnkgPSB1bmRlZmluZWQ7XG5cbiAgcHJpdmF0ZSBjb25zdHJ1Y3RvcigpIHt9XG5cbiAgLyoqXG4gICAqIEBzdW1tYXJ5IFJldHJpZXZlcyB0aGUgbmFtZWQge0BsaW5rIEluamVjdGFibGV9IGZyb20gdGhlIHJlZ2lzdHJ5XG4gICAqIEBwYXJhbSB7c3RyaW5nfSBuYW1lXG4gICAqIEBwYXJhbSB7YW55W119IGFyZ3NcbiAgICovXG4gIHN0YXRpYyBnZXQ8VD4obmFtZTogc3RyaW5nLCAuLi5hcmdzOiBhbnlbXSk6IEluamVjdGFibGU8VD4gfCB1bmRlZmluZWQge1xuICAgIHJldHVybiBJbmplY3RhYmxlcy5nZXRSZWdpc3RyeSgpLmdldChuYW1lLCAuLi5hcmdzKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBAc3VtbWFyeSByZWdpc3RlcnMgYW4gaW5qZWN0YWJsZSBjb25zdHJ1Y3RvclxuICAgKiBAcGFyYW0ge0luamVjdGFibGV9IGNvbnN0cnVjdG9yXG4gICAqIEBwYXJhbSB7YW55W119IGFyZ3NcbiAgICpcbiAgICovXG4gIHN0YXRpYyByZWdpc3RlcjxUPihjb25zdHJ1Y3RvcjogSW5qZWN0YWJsZTxUPiwgLi4uYXJnczogYW55W10pOiB2b2lkIHtcbiAgICByZXR1cm4gSW5qZWN0YWJsZXMuZ2V0UmVnaXN0cnkoKS5yZWdpc3Rlcihjb25zdHJ1Y3RvciwgLi4uYXJncyk7XG4gIH1cblxuICAvKipcbiAgICogQHN1bW1hcnkgSW5zdGFudGlhdGVzIGFuIEluamVjdGFibGVcbiAgICogQHBhcmFtIHtSZWNvcmQ8c3RyaW5nLCBhbnk+fSBvYmpcbiAgICogQHBhcmFtIHthbnlbXX0gYXJnc1xuICAgKiBAcmV0dXJuIFRcbiAgICpcbiAgICovXG4gIHN0YXRpYyBidWlsZDxUPihvYmo6IFJlY29yZDxzdHJpbmcsIGFueT4sIC4uLmFyZ3M6IGFueVtdKTogVCB7XG4gICAgcmV0dXJuIEluamVjdGFibGVzLmdldFJlZ2lzdHJ5KCkuYnVpbGQob2JqLCAuLi5hcmdzKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBAc3VtbWFyeSBTZXRzIGEgbmV3IHtAbGluayBJbmplY3RhYmxlc1JlZ2lzdHJ5fVxuICAgKiBAcGFyYW0ge0luamVjdGFibGVzUmVnaXN0cnl9IG9wZXJhdGlvbnNSZWdpc3RyeSB0aGUgbmV3IGltcGxlbWVudGF0aW9uIG9mIFJlZ2lzdHJ5XG4gICAqL1xuICBzdGF0aWMgc2V0UmVnaXN0cnkob3BlcmF0aW9uc1JlZ2lzdHJ5OiBJbmplY3RhYmxlc1JlZ2lzdHJ5KSB7XG4gICAgSW5qZWN0YWJsZXMuYWN0aW5nSW5qZWN0YWJsZXNSZWdpc3RyeSA9IG9wZXJhdGlvbnNSZWdpc3RyeTtcbiAgfVxuICAvKipcbiAgICogQHN1bW1hcnkgUmV0dXJucyB0aGUgY3VycmVudCB7QGxpbmsgSW5qZWN0YWJsZXNSZWdpc3RyeX1cbiAgICovXG4gIHByaXZhdGUgc3RhdGljIGdldFJlZ2lzdHJ5KCkge1xuICAgIGlmICghSW5qZWN0YWJsZXMuYWN0aW5nSW5qZWN0YWJsZXNSZWdpc3RyeSlcbiAgICAgIEluamVjdGFibGVzLmFjdGluZ0luamVjdGFibGVzUmVnaXN0cnkgPSBuZXcgSW5qZWN0YWJsZVJlZ2lzdHJ5SW1wKCk7XG4gICAgcmV0dXJuIEluamVjdGFibGVzLmFjdGluZ0luamVjdGFibGVzUmVnaXN0cnk7XG4gIH1cblxuICBzdGF0aWMgcmVzZXQoKSB7XG4gICAgSW5qZWN0YWJsZXMuc2V0UmVnaXN0cnkobmV3IEluamVjdGFibGVSZWdpc3RyeUltcCgpKTtcbiAgfVxuXG4gIHN0YXRpYyBzZWxlY3RpdmVSZXNldChtYXRjaDogc3RyaW5nIHwgUmVnRXhwKSB7XG4gICAgY29uc3QgcmVnZXhwID0gdHlwZW9mIG1hdGNoID09PSBcInN0cmluZ1wiID8gbmV3IFJlZ0V4cChtYXRjaCkgOiBtYXRjaDtcbiAgICAoSW5qZWN0YWJsZXMuYWN0aW5nSW5qZWN0YWJsZXNSZWdpc3RyeSBhcyBhbnkpW1wiY2FjaGVcIl0gPSBPYmplY3QuZW50cmllcyhcbiAgICAgIChJbmplY3RhYmxlcy5hY3RpbmdJbmplY3RhYmxlc1JlZ2lzdHJ5IGFzIGFueSlbXCJjYWNoZVwiXVxuICAgICkucmVkdWNlKChhY2N1bTogUmVjb3JkPHN0cmluZywgYW55PiwgW2tleSwgdmFsXSkgPT4ge1xuICAgICAgaWYgKCFrZXkubWF0Y2gocmVnZXhwKSkgYWNjdW1ba2V5XSA9IHZhbDtcbiAgICAgIHJldHVybiBhY2N1bTtcbiAgICB9LCB7fSk7XG4gIH1cbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"Injectables.js","sourceRoot":"","sources":["../../src/Injectables.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,qBAAqB,GAEtB,sBAAmB;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,OAAO,WAAW;aACP,8BAAyB,GAAyB,SAAS,CAAC;IAE3E,gBAAuB,CAAC;IAExB;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,CAAI,IAAY,EAAE,GAAG,IAAW;QACxC,OAAO,WAAW,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CAAI,WAA0B,EAAE,GAAG,IAAW;QAC3D,OAAO,WAAW,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAI,GAAwB,EAAE,GAAG,IAAW;QACtD,OAAO,WAAW,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,kBAAuC;QACxD,WAAW,CAAC,yBAAyB,GAAG,kBAAkB,CAAC;IAC7D,CAAC;IACD;;;;OAIG;IACK,MAAM,CAAC,WAAW;QACxB,IAAI,CAAC,WAAW,CAAC,yBAAyB;YACxC,WAAW,CAAC,yBAAyB,GAAG,IAAI,qBAAqB,EAAE,CAAC;QACtE,OAAO,WAAW,CAAC,yBAAyB,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK;QACV,WAAW,CAAC,WAAW,CAAC,IAAI,qBAAqB,EAAE,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,KAAsB;QAC1C,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACpE,WAAW,CAAC,yBAAiC,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,OAAO,CACrE,WAAW,CAAC,yBAAiC,CAAC,OAAO,CAAC,CACxD,CAAC,MAAM,CAAC,CAAC,KAA0B,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;YAClD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;gBAAE,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;YACzC,OAAO,KAAK,CAAC;QACf,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC","sourcesContent":["import {\n  Injectable,\n  InjectableRegistryImp,\n  InjectablesRegistry,\n} from \"./registry\";\n\n/**\n * @description Central registry for managing injectable dependencies.\n * @summary Static class holding the access to the injectables functions. Provides methods for registering,\n * retrieving, and building injectable objects.\n * @template T Type of the injectable object\n * \n * @class Injectables\n * \n * @example\n * // Define an injectable class\n * @injectable()\n * class MyService {\n *   doSomething() {\n *     return 'Hello World';\n *   }\n * }\n * \n * // Inject the service into another class\n * class MyComponent {\n *   @inject()\n *   private service!: MyService;\n *   \n *   useService() {\n *     return this.service.doSomething();\n *   }\n * }\n * \n * @mermaid\n * sequenceDiagram\n *   participant Client\n *   participant Injectables\n *   participant Registry\n *   \n *   Client->>Injectables: register(MyService)\n *   Injectables->>Registry: register(MyService)\n *   Registry-->>Injectables: void\n *   \n *   Client->>Injectables: get(\"MyService\")\n *   Injectables->>Registry: get(\"MyService\")\n *   Registry-->>Injectables: MyService instance\n *   Injectables-->>Client: MyService instance\n */\nexport class Injectables {\n  private static actingInjectablesRegistry?: InjectablesRegistry = undefined;\n\n  private constructor() {}\n\n  /**\n   * @description Fetches an injectable instance by its registered name.\n   * @summary Retrieves the named {@link Injectable} from the registry. If the injectable is a singleton,\n   * returns the existing instance. Otherwise, creates a new instance.\n   * @template T Type of the injectable object to retrieve\n   * @param {string} name The registered name of the injectable to retrieve\n   * @param {any[]} args Constructor arguments to pass when instantiating the injectable\n   * @return {Injectable<T> | undefined} The injectable instance or undefined if not found\n   */\n  static get<T>(name: string, ...args: any[]): Injectable<T> | undefined {\n    return Injectables.getRegistry().get(name, ...args);\n  }\n\n  /**\n   * @description Adds a class or object to the injectable registry.\n   * @summary Registers an injectable constructor or instance with the registry, making it available for injection.\n   * @template T Type of the injectable object to register\n   * @param {Injectable<T>} constructor The class constructor or object instance to register\n   * @param {any[]} args Additional arguments for registration (category, singleton flag, etc.)\n   * @return {void}\n   */\n  static register<T>(constructor: Injectable<T>, ...args: any[]): void {\n    return Injectables.getRegistry().register(constructor, ...args);\n  }\n\n  /**\n   * @description Creates a new instance of an injectable class.\n   * @summary Instantiates an injectable class using its constructor and the provided arguments.\n   * @template T Type of the object to build\n   * @param {Record<string, any>} obj Object containing the name of the injectable to build\n   * @param {any[]} args Constructor arguments to pass when instantiating the injectable\n   * @return {T} The newly created instance\n   */\n  static build<T>(obj: Record<string, any>, ...args: any[]): T {\n    return Injectables.getRegistry().build(obj, ...args);\n  }\n\n  /**\n   * @description Replaces the current registry implementation.\n   * @summary Sets a new {@link InjectablesRegistry} implementation, allowing for custom registry behavior.\n   * @param {InjectablesRegistry} operationsRegistry The new implementation of Registry to use\n   * @return {void}\n   */\n  static setRegistry(operationsRegistry: InjectablesRegistry) {\n    Injectables.actingInjectablesRegistry = operationsRegistry;\n  }\n  /**\n   * @description Provides access to the current registry instance.\n   * @summary Returns the current {@link InjectablesRegistry} or creates a default one if none exists.\n   * @return {InjectablesRegistry} The current registry instance\n   */\n  private static getRegistry() {\n    if (!Injectables.actingInjectablesRegistry)\n      Injectables.actingInjectablesRegistry = new InjectableRegistryImp();\n    return Injectables.actingInjectablesRegistry;\n  }\n\n  /**\n   * @description Clears all registered injectables.\n   * @summary Resets the registry to a clean state by creating a new empty registry instance.\n   * @return {void}\n   */\n  static reset() {\n    Injectables.setRegistry(new InjectableRegistryImp());\n  }\n\n  /**\n   * @description Removes specific injectables from the registry based on a pattern.\n   * @summary Selectively resets the registry by removing only the injectables whose names match the provided pattern.\n   * @param {string | RegExp} match A string or regular expression pattern to match against injectable names\n   * @return {void}\n   */\n  static selectiveReset(match: string | RegExp) {\n    const regexp = typeof match === \"string\" ? new RegExp(match) : match;\n    (Injectables.actingInjectablesRegistry as any)[\"cache\"] = Object.entries(\n      (Injectables.actingInjectablesRegistry as any)[\"cache\"]\n    ).reduce((accum: Record<string, any>, [key, val]) => {\n      if (!key.match(regexp)) accum[key] = val;\n      return accum;\n    }, {});\n  }\n}\n"]}

package/lib/esm/constants.d.ts

@@ -1,12 +1,13 @@
 /**
- * @summary Injectables Reflection keys
- * @const InjectablesKeys
+ * @description Constants used for reflection metadata keys in the dependency injection system.
+ * @summary Injectables Reflection keys used to store and retrieve metadata about injectable classes and properties.
  *
- * @property {string} REFLECT Reflection injectables base key
- * @property {string} INJECTABLE Reflection injectable key
- * @property {string} INJECT Reflection inject key
+ * @property {string} REFLECT Reflection injectables base key prefix for all metadata keys
+ * @property {string} INJECTABLE Reflection key suffix for marking a class as injectable
+ * @property {string} INJECT Reflection key suffix for marking a property for injection
  *
- * @memberOf injectable-decorators
+ * @const InjectablesKeys
+ * @memberOf module:injectable-decorators
  */
 export declare const InjectablesKeys: {
     REFLECT: string;

package/lib/esm/constants.js

@@ -1,16 +1,17 @@
 /**
- * @summary Injectables Reflection keys
- * @const InjectablesKeys
+ * @description Constants used for reflection metadata keys in the dependency injection system.
+ * @summary Injectables Reflection keys used to store and retrieve metadata about injectable classes and properties.
  *
- * @property {string} REFLECT Reflection injectables base key
- * @property {string} INJECTABLE Reflection injectable key
- * @property {string} INJECT Reflection inject key
+ * @property {string} REFLECT Reflection injectables base key prefix for all metadata keys
+ * @property {string} INJECTABLE Reflection key suffix for marking a class as injectable
+ * @property {string} INJECT Reflection key suffix for marking a property for injection
  *
- * @memberOf injectable-decorators
+ * @const InjectablesKeys
+ * @memberOf module:injectable-decorators
  */
 export const InjectablesKeys = {
     REFLECT: "inject.db.",
     INJECTABLE: "injectable",
     INJECT: "inject",
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7Ozs7O0dBU0c7QUFDSCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUc7SUFDN0IsT0FBTyxFQUFFLFlBQVk7SUFDckIsVUFBVSxFQUFFLFlBQVk7SUFDeEIsTUFBTSxFQUFFLFFBQVE7Q0FDakIsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQHN1bW1hcnkgSW5qZWN0YWJsZXMgUmVmbGVjdGlvbiBrZXlzXG4gKiBAY29uc3QgSW5qZWN0YWJsZXNLZXlzXG4gKlxuICogQHByb3BlcnR5IHtzdHJpbmd9IFJFRkxFQ1QgUmVmbGVjdGlvbiBpbmplY3RhYmxlcyBiYXNlIGtleVxuICogQHByb3BlcnR5IHtzdHJpbmd9IElOSkVDVEFCTEUgUmVmbGVjdGlvbiBpbmplY3RhYmxlIGtleVxuICogQHByb3BlcnR5IHtzdHJpbmd9IElOSkVDVCBSZWZsZWN0aW9uIGluamVjdCBrZXlcbiAqXG4gKiBAbWVtYmVyT2YgaW5qZWN0YWJsZS1kZWNvcmF0b3JzXG4gKi9cbmV4cG9ydCBjb25zdCBJbmplY3RhYmxlc0tleXMgPSB7XG4gIFJFRkxFQ1Q6IFwiaW5qZWN0LmRiLlwiLFxuICBJTkpFQ1RBQkxFOiBcImluamVjdGFibGVcIixcbiAgSU5KRUNUOiBcImluamVjdFwiLFxufTtcbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7Ozs7OztHQVVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sZUFBZSxHQUFHO0lBQzdCLE9BQU8sRUFBRSxZQUFZO0lBQ3JCLFVBQVUsRUFBRSxZQUFZO0lBQ3hCLE1BQU0sRUFBRSxRQUFRO0NBQ2pCLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEBkZXNjcmlwdGlvbiBDb25zdGFudHMgdXNlZCBmb3IgcmVmbGVjdGlvbiBtZXRhZGF0YSBrZXlzIGluIHRoZSBkZXBlbmRlbmN5IGluamVjdGlvbiBzeXN0ZW0uXG4gKiBAc3VtbWFyeSBJbmplY3RhYmxlcyBSZWZsZWN0aW9uIGtleXMgdXNlZCB0byBzdG9yZSBhbmQgcmV0cmlldmUgbWV0YWRhdGEgYWJvdXQgaW5qZWN0YWJsZSBjbGFzc2VzIGFuZCBwcm9wZXJ0aWVzLlxuICogXG4gKiBAcHJvcGVydHkge3N0cmluZ30gUkVGTEVDVCBSZWZsZWN0aW9uIGluamVjdGFibGVzIGJhc2Uga2V5IHByZWZpeCBmb3IgYWxsIG1ldGFkYXRhIGtleXNcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBJTkpFQ1RBQkxFIFJlZmxlY3Rpb24ga2V5IHN1ZmZpeCBmb3IgbWFya2luZyBhIGNsYXNzIGFzIGluamVjdGFibGVcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBJTkpFQ1QgUmVmbGVjdGlvbiBrZXkgc3VmZml4IGZvciBtYXJraW5nIGEgcHJvcGVydHkgZm9yIGluamVjdGlvblxuICogXG4gKiBAY29uc3QgSW5qZWN0YWJsZXNLZXlzXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmluamVjdGFibGUtZGVjb3JhdG9yc1xuICovXG5leHBvcnQgY29uc3QgSW5qZWN0YWJsZXNLZXlzID0ge1xuICBSRUZMRUNUOiBcImluamVjdC5kYi5cIixcbiAgSU5KRUNUQUJMRTogXCJpbmplY3RhYmxlXCIsXG4gIElOSkVDVDogXCJpbmplY3RcIixcbn07XG4iXX0=

package/lib/esm/decorators.d.ts

@@ -1,29 +1,59 @@
 /**
- * @summary Defines a class as an injectable
+ * @description Decorator that marks a class as available for dependency injection.
+ * @summary Defines a class as an injectable singleton that can be retrieved from the registry.
+ * When applied to a class, replaces its constructor with one that returns a singleton instance.
  *
- * @param {string} [category] defaults to the class Name. (Useful when minification occours and names are changed so we can no longer rely on the class name, or when we want to upcast the Object)
- * @param {boolean} [force] defines if the injectable should override the already existing instance (if any). (only meant for extending decorators
- * @param instanceCallback
+ * @param {string} [category] Defaults to the class name. Useful when minification occurs and names are changed,
+ * or when you want to upcast the object to a different type.
+ * @param {boolean} [force] Defines if the injectable should override an already existing instance (if any).
+ * Only meant for extending decorators.
+ * @param {Function} [instanceCallback] Optional callback function that will be called with the instance after creation.
+ * @return {Function} A decorator function that transforms the class into an injectable.
  *
  * @function injectable
+ * @category Class Decorators
  *
- * @memberOf module:injectable-decorators.Decorators
+ * @mermaid
+ * sequenceDiagram
+ *   participant Client
+ *   participant Decorator
+ *   participant Injectables
+ *
+ *   Client->>Decorator: @injectable()
+ *   Decorator->>Decorator: Create new constructor
+ *
+ *   Note over Decorator: When new instance requested
+ *   Decorator->>Injectables: get(name)
+ *   alt Instance exists
+ *     Injectables-->>Decorator: Return existing instance
+ *   else No instance
+ *     Decorator->>Injectables: register(original, name)
+ *     Decorator->>Injectables: get(name)
+ *     Injectables-->>Decorator: Return new instance
+ *     opt Has callback
+ *       Decorator->>Decorator: Call instanceCallback
+ *     end
+ *   end
+ *   Decorator->>Decorator: Define metadata
+ *   Decorator-->>Client: Return instance
  */
-export declare const injectable: (category?: string | undefined, force?: boolean, instanceCallback?: (instance: any, ...args: any[]) => void) => (original: any, propertyKey?: any) => any;
+export declare function injectable(category?: string | undefined, force?: boolean, instanceCallback?: (instance: any, ...args: any[]) => void): (original: any, propertyKey?: any) => any;
 /**
- * @summary function witch transforms a cached {@link injectable}
+ * @description Function type for transforming injectable instances before they're injected.
+ * @summary Function which transforms a cached {@link injectable} instance before it's injected into a target object.
  *
- * @param {any} injectable
- * @param {any} obj the obj the injectable will be injected on
+ * @param {any} injectable The injectable instance to transform
+ * @param {any} obj The object the injectable will be injected on
+ * @return {any} The transformed injectable instance
  *
+ * @typedef {Function} InstanceTransformer
  * @memberOf module:injectable-decorators
  */
 export type InstanceTransformer = (injectable: any, obj: any) => any;
 /**
- * @summary Allows for the injection of an {@link injectable} decorated dependency
- * @description the property must be typed for the requested dependency.
- *
- * Only concrete classes. No generics are supported
+ * @description Property decorator that injects a dependency into a class property.
+ * @summary Allows for the injection of an {@link injectable} decorated dependency into a class property.
+ * The property must be typed for the requested dependency. Only concrete classes are supported; generics are not.
  *
  * Injected properties should be described like so:
  * <pre>
@@ -38,14 +68,45 @@ export type InstanceTransformer = (injectable: any, obj: any) => any;
  * </pre>
  *
  * where InjectableClass is the class you want to inject.
- * Notice the use of '!:' to ensure the transpiler the property will be set outside the constructor but will always be defined
- * For project where minification occours, you should use the category param to ensure the name is the same throughout
+ * Notice the use of '!:' to ensure the transpiler the property will be set outside the constructor but will always be defined.
+ * For projects where minification occurs, you should use the category param to ensure the name is the same throughout.
  *
- * @param {string} [category] defaults to the class Name. (Useful when minification occours and names are changed so we can no longer rely on the class name, or when we want to upcast the Object)
- * @param {InstanceTransformer} [transformer]
+ * @param {string} [category] Defaults to the class name derived from the property type. Useful when minification occurs
+ * and names are changed, or when you want to upcast the object to a different type.
+ * @param {InstanceTransformer} [transformer] Optional function to transform the injectable instance before it's injected.
+ * @return {Function} A property decorator function that sets up the dependency injection.
  *
  * @function inject
+ * @category Property Decorators
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant Client
+ *   participant Decorator
+ *   participant Injectables
+ *
+ *   Client->>Decorator: @inject()
+ *   Decorator->>Decorator: Get type from property
+ *   Decorator->>Decorator: Define metadata
+ *   Decorator->>Decorator: Define property getter
  *
- * @memberOf module:injectable-decorators.Decorators
+ *   Note over Decorator: When property accessed
+ *   Client->>Decorator: access property
+ *   Decorator->>Decorator: Check if instance exists
+ *   alt Instance exists in WeakMap
+ *     Decorator-->>Client: Return cached instance
+ *   else No instance
+ *     Decorator->>Injectables: get(name)
+ *     alt Injectable found
+ *       Injectables-->>Decorator: Return injectable instance
+ *       opt Has transformer
+ *         Decorator->>Decorator: Call transformer
+ *       end
+ *       Decorator->>Decorator: Store in WeakMap
+ *       Decorator-->>Client: Return instance
+ *     else No injectable
+ *       Decorator-->>Client: Throw error
+ *     end
+ *   end
  */
-export declare const inject: (category?: string, transformer?: InstanceTransformer) => (target: any, propertyKey?: any) => void;
+export declare function inject(category?: string, transformer?: InstanceTransformer): (target: any, propertyKey?: any) => void;