@quadnix/octo 0.0.20 → 0.0.21

package/dist/app.type.d.ts

@@ -13,6 +13,11 @@ export declare enum ModelType {
     RESOURCE = "resource",
     SHARED_RESOURCE = "shared-resource"
 }
+export declare enum ValidationType {
+    MAX_LENGTH = "maxLength",
+    MIN_LENGTH = "minLength",
+    REGEX = "regex"
+}
 export type ActionInputs = {
     [key: string]: string | UnknownResource;
 };

package/dist/app.type.js

@@ -5,4 +5,10 @@ export var ModelType;
     ModelType["RESOURCE"] = "resource";
     ModelType["SHARED_RESOURCE"] = "shared-resource";
 })(ModelType || (ModelType = {}));
+export var ValidationType;
+(function (ValidationType) {
+    ValidationType["MAX_LENGTH"] = "maxLength";
+    ValidationType["MIN_LENGTH"] = "minLength";
+    ValidationType["REGEX"] = "regex";
+})(ValidationType || (ValidationType = {}));
 //# sourceMappingURL=app.type.js.map

package/dist/app.type.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.type.js","sourceRoot":"","sources":["../src/app.type.ts"],"names":[],"mappings":"AAUA,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAAe,CAAA;IACf,gCAAmB,CAAA;IACnB,kCAAqB,CAAA;IACrB,gDAAmC,CAAA;AACrC,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB"}
+{"version":3,"file":"app.type.js","sourceRoot":"","sources":["../src/app.type.ts"],"names":[],"mappings":"AAUA,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAAe,CAAA;IACf,gCAAmB,CAAA;IACnB,kCAAqB,CAAA;IACrB,gDAAmC,CAAA;AACrC,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAED,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,0CAAwB,CAAA;IACxB,0CAAwB,CAAA;IACxB,iCAAe,CAAA;AACjB,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB"}

package/dist/decorators/action.decorator.d.ts

@@ -1,2 +1,19 @@
 import { ModelType } from '../app.type.js';
+/**
+ * An `@Action` is a class decorator to be placed on top of a class that represents an action of one of ModelType.
+ * - A ModelType.MODEL action must implement the {@link IModelAction} interface.
+ * - A ModelType.OVERLAY action must implement the {@link IModelAction} interface.
+ * - A ModelType.RESOURCE action must implement the {@link IResourceAction} interface.
+ * - A ModelType.SHARED_RESOURCE action must implement the {@link IResourceAction} interface.
+ *
+ * @example
+ * ```ts
+ * @Action(ModelType.MODEL)
+ * export class MyModelAction implements IModelAction { ... }
+ * ```
+ * @group Decorators
+ * @param type The type of Model being decorated.
+ * @returns The decorated class.
+ * @see Definition of [Actions](/docs/fundamentals/actions).
+ */
 export declare function Action(type: ModelType): (constructor: any) => void;

package/dist/decorators/action.decorator.js

@@ -5,26 +5,49 @@ import { ResourceActionHook } from '../functions/hook/resource-action.hook.js';
 import { EventService } from '../services/event/event.service.js';
 import { TransactionService } from '../services/transaction/transaction.service.js';
 import { Container } from './container.js';
+/**
+ * An `@Action` is a class decorator to be placed on top of a class that represents an action of one of ModelType.
+ * - A ModelType.MODEL action must implement the {@link IModelAction} interface.
+ * - A ModelType.OVERLAY action must implement the {@link IModelAction} interface.
+ * - A ModelType.RESOURCE action must implement the {@link IResourceAction} interface.
+ * - A ModelType.SHARED_RESOURCE action must implement the {@link IResourceAction} interface.
+ *
+ * @example
+ * ```ts
+ * @Action(ModelType.MODEL)
+ * export class MyModelAction implements IModelAction { ... }
+ * ```
+ * @group Decorators
+ * @param type The type of Model being decorated.
+ * @returns The decorated class.
+ * @see Definition of [Actions](/docs/fundamentals/actions).
+ */
 export function Action(type) {
     return function (constructor) {
         Container.get(TransactionService)
             .then(async (transactionService) => {
             switch (type) {
                 case ModelType.MODEL: {
+                    // Register model action.
                     const modelAction = await Container.get(constructor.name);
                     transactionService.registerModelActions([modelAction]);
+                    // Wrap model action with hooks.
                     ModelActionHook.getInstance().registrar(modelAction);
                     break;
                 }
                 case ModelType.OVERLAY: {
+                    // Register overlay action.
                     const modelAction = await Container.get(constructor.name);
                     transactionService.registerOverlayActions([modelAction]);
+                    // Wrap overlay action with hooks.
                     ModelActionHook.getInstance().registrar(modelAction);
                     break;
                 }
                 case ModelType.RESOURCE: {
+                    // Register resource action.
                     const resourceAction = await Container.get(constructor.name);
                     transactionService.registerResourceActions([resourceAction]);
+                    // Wrap resource action with hooks.
                     ResourceActionHook.getInstance().registrar(resourceAction);
                     break;
                 }

package/dist/decorators/action.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"action.decorator.js","sourceRoot":"","sources":["../../src/decorators/action.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAG/E,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,UAAU,MAAM,CAAC,IAAe;IACpC,OAAO,UAAU,WAAgB;QAC/B,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC;aAC9B,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,EAAE;YACjC,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;oBAErB,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,GAAG,CAAe,WAAW,CAAC,IAAI,CAAC,CAAC;oBACxE,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;oBAGvD,eAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;oBACrD,MAAM;gBACR,CAAC;gBACD,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;oBAEvB,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,GAAG,CAAe,WAAW,CAAC,IAAI,CAAC,CAAC;oBACxE,kBAAkB,CAAC,sBAAsB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;oBAGzD,eAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;oBACrD,MAAM;gBACR,CAAC;gBACD,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;oBAExB,MAAM,cAAc,GAAG,MAAM,SAAS,CAAC,GAAG,CAAkB,WAAW,CAAC,IAAI,CAAC,CAAC;oBAC9E,kBAAkB,CAAC,uBAAuB,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;oBAG7D,kBAAkB,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;oBAC3D,MAAM;gBACR,CAAC;gBACD,OAAO,CAAC,CAAC,CAAC;oBACR,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;gBACpE,CAAC;YACH,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,YAAY,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"action.decorator.js","sourceRoot":"","sources":["../../src/decorators/action.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAG/E,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,MAAM,CAAC,IAAe;IACpC,OAAO,UAAU,WAAgB;QAC/B,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC;aAC9B,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,EAAE;YACjC,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;oBACrB,yBAAyB;oBACzB,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,GAAG,CAAe,WAAW,CAAC,IAAI,CAAC,CAAC;oBACxE,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;oBAEvD,gCAAgC;oBAChC,eAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;oBACrD,MAAM;gBACR,CAAC;gBACD,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;oBACvB,2BAA2B;oBAC3B,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,GAAG,CAAe,WAAW,CAAC,IAAI,CAAC,CAAC;oBACxE,kBAAkB,CAAC,sBAAsB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;oBAEzD,kCAAkC;oBAClC,eAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;oBACrD,MAAM;gBACR,CAAC;gBACD,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;oBACxB,4BAA4B;oBAC5B,MAAM,cAAc,GAAG,MAAM,SAAS,CAAC,GAAG,CAAkB,WAAW,CAAC,IAAI,CAAC,CAAC;oBAC9E,kBAAkB,CAAC,uBAAuB,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;oBAE7D,mCAAmC;oBACnC,kBAAkB,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;oBAC3D,MAAM;gBACR,CAAC;gBACD,OAAO,CAAC,CAAC,CAAC;oBACR,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;gBACpE,CAAC;YACH,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,YAAY,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;AACJ,CAAC"}

package/dist/decorators/anchor.decorator.d.ts

@@ -1 +1,14 @@
+/**
+ * An `@Anchor` is a class decorator to be placed on top of a class that represents an anchor.
+ * - An anchor must extend the {@link AAnchor} class.
+ *
+ * @example
+ * ```ts
+ * @Anchor()
+ * export class MyAnchor extends AAnchor { ... }
+ * ```
+ * @group Decorators
+ * @returns The decorated class.
+ * @see Definition of [Anchors](/docs/fundamentals/overlay-and-anchor).
+ */
 export declare function Anchor(): (constructor: any) => void;

package/dist/decorators/anchor.decorator.js

@@ -2,6 +2,19 @@ import { RegistrationErrorEvent } from '../events/error.event.js';
 import { EventService } from '../services/event/event.service.js';
 import { ModelSerializationService } from '../services/serialization/model/model-serialization.service.js';
 import { Container } from './container.js';
+/**
+ * An `@Anchor` is a class decorator to be placed on top of a class that represents an anchor.
+ * - An anchor must extend the {@link AAnchor} class.
+ *
+ * @example
+ * ```ts
+ * @Anchor()
+ * export class MyAnchor extends AAnchor { ... }
+ * ```
+ * @group Decorators
+ * @returns The decorated class.
+ * @see Definition of [Anchors](/docs/fundamentals/overlay-and-anchor).
+ */
 export function Anchor() {
     return function (constructor) {
         Container.get(ModelSerializationService)

package/dist/decorators/anchor.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"anchor.decorator.js","sourceRoot":"","sources":["../../src/decorators/anchor.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gEAAgE,CAAC;AAC3G,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,UAAU,MAAM;IACpB,OAAO,UAAU,WAAgB;QAC/B,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC;aACrC,IAAI,CAAC,CAAC,yBAAyB,EAAE,EAAE;YAClC,yBAAyB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACzE,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,YAAY,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"anchor.decorator.js","sourceRoot":"","sources":["../../src/decorators/anchor.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gEAAgE,CAAC;AAC3G,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,MAAM;IACpB,OAAO,UAAU,WAAgB;QAC/B,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC;aACrC,IAAI,CAAC,CAAC,yBAAyB,EAAE,EAAE;YAClC,yBAAyB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACzE,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,YAAY,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;AACJ,CAAC"}

package/dist/decorators/container.d.ts

@@ -2,23 +2,83 @@ import type { Constructable } from '../app.type.js';
 type Factory<T> = {
     create: (...args: unknown[]) => Promise<T>;
 };
+/**
+ * The Container class is a box to hold all registered factories.
+ *
+ * In Octo, we minimize the use of the `new` keyword and get instance of a class using its factory.
+ * The factory has full control over how the instance is created.
+ *
+ * By using the Container and Factory concepts, it is possible to override internal class definitions at runtime.
+ * It is an incredibly powerful tool to customize implementation.
+ */
 export declare class Container {
     private static FACTORY_TIMEOUT_IN_MS;
     private static readonly factories;
+    /**
+     * `Container.get()` allows to get an instance of a class using its factory.
+     *
+     * @param type The type or name of the class to get.
+     * @param options Allows selection of a specific factory to use to get the instance.
+     * - The `args` option supplies arguments to the factory.
+     * - The `metadata` option identifies the factory.
+     * @returns The instance of the class.
+     */
     static get<T>(type: Constructable<T> | string, options?: {
         args?: unknown[];
         metadata?: {
             [key: string]: string;
         };
     }): Promise<T>;
+    /**
+     * `Container.registerFactory()` allows to register a factory for a class.
+     *
+     * @param type The type or name of the class for which the factory is registered.
+     * @param factory The factory class being registered.
+     * @param options Distinguishes between different factories of the same class.
+     * - The `metadata` attaches custom metadata to the factory.
+     */
     static registerFactory<T>(type: Constructable<T> | string, factory: Factory<T>, options?: {
         metadata?: {
             [key: string]: string;
         };
     }): void;
+    /**
+     * `Container.reset()` clears all registered factories and empties the container. This is mostly used in testing.
+     */
     static reset(): void;
+    /**
+     * `Container.setDefault()` sets a default factory for the class.
+     *
+     * @example
+     * ```ts
+     * // Register a factory.
+     * Container.registerFactory(MyClass, MyClassFactory, { metadata: { key: 'value' } });
+     *
+     * // Without default.
+     * Container.get(MyClass, { metadata: { key: 'value' } });
+     *
+     * // Set default.
+     * Container.setDefault(MyClass, MyClassFactory);
+     *
+     * // With default.
+     * Container.get(MyClass);
+     * ```
+     * @param type The type or name of the class for which the default factory is set.
+     * @param factory The factory class being set as default.
+     */
     static setDefault<T>(type: Constructable<T> | string, factory: Factory<T>): void;
+    /**
+     * The Container, by default, will wait a maximum of 5 seconds for a factory to resolve and provide an instance.
+     * This method allows to change that timeout.
+     *
+     * @param timeoutInMs The timeout in milliseconds.
+     */
     static setFactoryTimeout(timeoutInMs: number): void;
+    /**
+     * `Container.unRegisterFactory()` will unregister all factories of a class.
+     *
+     * @param type The type or name of the class for which all factory is unregistered.
+     */
     static unRegisterFactory<T>(type: Constructable<T> | string): void;
 }
 export {};

package/dist/decorators/container.js

@@ -1,6 +1,24 @@
+/**
+ * The Container class is a box to hold all registered factories.
+ *
+ * In Octo, we minimize the use of the `new` keyword and get instance of a class using its factory.
+ * The factory has full control over how the instance is created.
+ *
+ * By using the Container and Factory concepts, it is possible to override internal class definitions at runtime.
+ * It is an incredibly powerful tool to customize implementation.
+ */
 export class Container {
-    static FACTORY_TIMEOUT_IN_MS = 5000;
-    static factories = {};
+    static { this.FACTORY_TIMEOUT_IN_MS = 5000; }
+    static { this.factories = {}; }
+    /**
+     * `Container.get()` allows to get an instance of a class using its factory.
+     *
+     * @param type The type or name of the class to get.
+     * @param options Allows selection of a specific factory to use to get the instance.
+     * - The `args` option supplies arguments to the factory.
+     * - The `metadata` option identifies the factory.
+     * @returns The instance of the class.
+     */
     static async get(type, options) {
         const args = options?.args || [];
         const metadata = options?.metadata;
@@ -48,6 +66,14 @@ export class Container {
         }
         return factory.create(...args);
     }
+    /**
+     * `Container.registerFactory()` allows to register a factory for a class.
+     *
+     * @param type The type or name of the class for which the factory is registered.
+     * @param factory The factory class being registered.
+     * @param options Distinguishes between different factories of the same class.
+     * - The `metadata` attaches custom metadata to the factory.
+     */
     static registerFactory(type, factory, options) {
         const metadata = options?.metadata || {};
         const name = typeof type === 'string' ? type : type.name;
@@ -60,6 +86,7 @@ export class Container {
         }
         const factoryContainer = this.factories[name].find((f) => filters.every((c) => f.metadata[c.key] === c.value));
         if (factoryContainer?.factory) {
+            // If factory is not a promise set by get() above, it has already been registered.
             if (!Array.isArray(factoryContainer.factory)) {
                 return;
             }
@@ -73,21 +100,55 @@ export class Container {
         this.factories[name].push({ default: false, factory, metadata });
         this.setDefault(type, factory);
     }
+    /**
+     * `Container.reset()` clears all registered factories and empties the container. This is mostly used in testing.
+     */
     static reset() {
         this.FACTORY_TIMEOUT_IN_MS = 5000;
         for (const name in this.factories) {
             delete this.factories[name];
         }
     }
+    /**
+     * `Container.setDefault()` sets a default factory for the class.
+     *
+     * @example
+     * ```ts
+     * // Register a factory.
+     * Container.registerFactory(MyClass, MyClassFactory, { metadata: { key: 'value' } });
+     *
+     * // Without default.
+     * Container.get(MyClass, { metadata: { key: 'value' } });
+     *
+     * // Set default.
+     * Container.setDefault(MyClass, MyClassFactory);
+     *
+     * // With default.
+     * Container.get(MyClass);
+     * ```
+     * @param type The type or name of the class for which the default factory is set.
+     * @param factory The factory class being set as default.
+     */
     static setDefault(type, factory) {
         const name = typeof type === 'string' ? type : type.name;
         this.factories[name]?.forEach((f) => {
             f.default = f.factory.name === factory.name;
         });
     }
+    /**
+     * The Container, by default, will wait a maximum of 5 seconds for a factory to resolve and provide an instance.
+     * This method allows to change that timeout.
+     *
+     * @param timeoutInMs The timeout in milliseconds.
+     */
     static setFactoryTimeout(timeoutInMs) {
         this.FACTORY_TIMEOUT_IN_MS = timeoutInMs;
     }
+    /**
+     * `Container.unRegisterFactory()` will unregister all factories of a class.
+     *
+     * @param type The type or name of the class for which all factory is unregistered.
+     */
     static unRegisterFactory(type) {
         const name = typeof type === 'string' ? type : type.name;
         delete this.factories[name];

package/dist/decorators/container.js.map

@@ -1 +1 @@
-{"version":3,"file":"container.js","sourceRoot":"","sources":["../../src/decorators/container.ts"],"names":[],"mappings":"AAKA,MAAM,OAAO,SAAS;IACZ,MAAM,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAEpC,MAAM,CAAU,SAAS,GAM7B,EAAE,CAAC;IAEP,MAAM,CAAC,KAAK,CAAC,GAAG,CACd,IAA+B,EAC/B,OAGC;QAED,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,CAAC;QACnC,MAAM,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAEzD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAC5B,CAAC;QAED,IAAI,gBAA+F,CAAC;QACpG,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACjE,CAAC;aAAM,CAAC;YACN,MAAM,OAAO,GAAqC,EAAE,CAAC;YACrD,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;gBAC3B,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC9C,CAAC;YACD,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3G,CAAC;QAED,IAAI,gBAAgB,EAAE,OAAO,EAAE,CAAC;YAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC7C,OAAQ,gBAAgB,CAAC,OAAsB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;YAClE,CAAC;iBAAM,CAAC;gBACN,MAAM,OAAO,GAAG,MAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAyB,CAAC;gBAC3E,OAAO,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;QAED,MAAM,mBAAmB,GAAG;YAC1B,OAAO,EAAE,IAAI;YACb,QAAQ;SAC4D,CAAC;QACvE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE/C,IAAI,eAAe,CAAC;QACpB,IAAI,cAAc,CAAC;QACnB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAa,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1D,cAAc,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC/B,MAAM,CAAC,IAAI,KAAK,CAAC,iCAAiC,IAAI,cAAc,CAAC,CAAC,CAAC;YACzE,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAC/B,eAAe,GAAG,OAAO,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,mBAAmB,CAAC,OAAO,GAAG,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAEzD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC;QAC9B,IAAI,cAAc,EAAE,CAAC;YACnB,YAAY,CAAC,cAAc,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,eAAe,CACpB,IAA+B,EAC/B,OAAmB,EACnB,OAEC;QAED,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,EAAE,CAAC;QACzC,MAAM,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAEzD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAC5B,CAAC;QAED,MAAM,OAAO,GAAqC,EAAE,CAAC;QACrD,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAE/G,IAAI,gBAAgB,EAAE,OAAO,EAAE,CAAC;YAE9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC7C,OAAO;YACT,CAAC;YAED,gBAAgB,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACrC,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAkC,CAAC;YAC7E,OAAO,CAAC,OAAO,CAAC,CAAC;YACjB,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAC;YACnC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAE/B,OAAO;QACT,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QACjE,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,KAAK;QACV,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QAElC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,MAAM,CAAC,UAAU,CAAI,IAA+B,EAAE,OAAmB;QACvE,MAAM,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAEzD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAClC,CAAC,CAAC,OAAO,GAAI,CAAC,CAAC,OAAuC,CAAC,IAAI,KAAM,OAAuC,CAAC,IAAI,CAAC;QAChH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,iBAAiB,CAAC,WAAmB;QAC1C,IAAI,CAAC,qBAAqB,GAAG,WAAW,CAAC;IAC3C,CAAC;IAED,MAAM,CAAC,iBAAiB,CAAI,IAA+B;QACzD,MAAM,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACzD,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC"}
+{"version":3,"file":"container.js","sourceRoot":"","sources":["../../src/decorators/container.ts"],"names":[],"mappings":"AAKA;;;;;;;;GAQG;AACH,MAAM,OAAO,SAAS;aACL,0BAAqB,GAAG,IAAI,CAAC;aAEpB,cAAS,GAM7B,EAAE,CAAC;IAEP;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG,CACd,IAA+B,EAC/B,OAGC;QAED,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,CAAC;QACnC,MAAM,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAEzD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAC5B,CAAC;QAED,IAAI,gBAA+F,CAAC;QACpG,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACjE,CAAC;aAAM,CAAC;YACN,MAAM,OAAO,GAAqC,EAAE,CAAC;YACrD,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;gBAC3B,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC9C,CAAC;YACD,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3G,CAAC;QAED,IAAI,gBAAgB,EAAE,OAAO,EAAE,CAAC;YAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC7C,OAAQ,gBAAgB,CAAC,OAAsB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;YAClE,CAAC;iBAAM,CAAC;gBACN,MAAM,OAAO,GAAG,MAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAyB,CAAC;gBAC3E,OAAO,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;QAED,MAAM,mBAAmB,GAAG;YAC1B,OAAO,EAAE,IAAI;YACb,QAAQ;SAC4D,CAAC;QACvE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE/C,IAAI,eAAe,CAAC;QACpB,IAAI,cAAc,CAAC;QACnB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAa,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1D,cAAc,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC/B,MAAM,CAAC,IAAI,KAAK,CAAC,iCAAiC,IAAI,cAAc,CAAC,CAAC,CAAC;YACzE,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAC/B,eAAe,GAAG,OAAO,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,mBAAmB,CAAC,OAAO,GAAG,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAEzD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC;QAC9B,IAAI,cAAc,EAAE,CAAC;YACnB,YAAY,CAAC,cAAc,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,eAAe,CACpB,IAA+B,EAC/B,OAAmB,EACnB,OAEC;QAED,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,EAAE,CAAC;QACzC,MAAM,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAEzD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAC5B,CAAC;QAED,MAAM,OAAO,GAAqC,EAAE,CAAC;QACrD,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAE/G,IAAI,gBAAgB,EAAE,OAAO,EAAE,CAAC;YAC9B,kFAAkF;YAClF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC7C,OAAO;YACT,CAAC;YAED,gBAAgB,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACrC,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAkC,CAAC;YAC7E,OAAO,CAAC,OAAO,CAAC,CAAC;YACjB,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAC;YACnC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAE/B,OAAO;QACT,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QACjE,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK;QACV,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QAElC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,UAAU,CAAI,IAA+B,EAAE,OAAmB;QACvE,MAAM,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAEzD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAClC,CAAC,CAAC,OAAO,GAAI,CAAC,CAAC,OAAuC,CAAC,IAAI,KAAM,OAAuC,CAAC,IAAI,CAAC;QAChH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,WAAmB;QAC1C,IAAI,CAAC,qBAAqB,GAAG,WAAW,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAI,IAA+B;QACzD,MAAM,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACzD,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC"}

package/dist/decorators/enable-hook.decorator.d.ts

@@ -1,3 +1,17 @@
 type Hook = 'CommitHook';
+/**
+ * A `@EnableHook` is a method decorator to enable registration of hooks.
+ *
+ * @example
+ * ```ts
+ * @EnableHook('CommitHook')
+ * async commitTransaction(): Promise<void> { ... }
+ * ```
+ * @group Decorators
+ * @internal
+ * @param hook The only values supported are `CommitHook`.
+ * @returns The decorated method.
+ * @see Definition of [Hooks](/docs/fundamentals/modules#hooks).
+ */
 export declare function EnableHook(hook: Hook): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
 export {};

package/dist/decorators/enable-hook.decorator.js

@@ -1,4 +1,18 @@
 import { CommitHook } from '../functions/hook/commit.hook.js';
+/**
+ * A `@EnableHook` is a method decorator to enable registration of hooks.
+ *
+ * @example
+ * ```ts
+ * @EnableHook('CommitHook')
+ * async commitTransaction(): Promise<void> { ... }
+ * ```
+ * @group Decorators
+ * @internal
+ * @param hook The only values supported are `CommitHook`.
+ * @returns The decorated method.
+ * @see Definition of [Hooks](/docs/fundamentals/modules#hooks).
+ */
 export function EnableHook(hook) {
     return function (target, propertyKey, descriptor) {
         switch (hook) {

package/dist/decorators/enable-hook.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"enable-hook.decorator.js","sourceRoot":"","sources":["../../src/decorators/enable-hook.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAI9D,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,OAAO,UAAU,MAAW,EAAE,WAAmB,EAAE,UAA8B;QAC/E,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,YAAY;gBACf,UAAU,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;gBAC/C,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;QACrC,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"enable-hook.decorator.js","sourceRoot":"","sources":["../../src/decorators/enable-hook.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAI9D;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,OAAO,UAAU,MAAW,EAAE,WAAmB,EAAE,UAA8B;QAC/E,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,YAAY;gBACf,UAAU,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;gBAC/C,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;QACrC,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/dist/decorators/event-source.decorator.d.ts

@@ -1,3 +1,18 @@
 import type { Constructable } from '../app.type.js';
 import type { Event } from '../events/event.model.js';
+/**
+ * An `@EventSource` is a method decorator to enable automatic event emission.
+ * The `registrar()` method of the Event class is used to decorate the method to auto-emit events.
+ * - All event types must extend the {@link Event} class.
+ *
+ * @example
+ * ```ts
+ * @EventSource(MyEvent)
+ * myMethod(): void { ... }
+ * ```
+ * @group Decorators
+ * @internal
+ * @param ofType The type of event being emitted.
+ * @returns The decorated method.
+ */
 export declare function EventSource(ofType: Constructable<Event<unknown>>): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/dist/decorators/event-source.decorator.js

@@ -1,4 +1,19 @@
 import { EventService } from '../services/event/event.service.js';
+/**
+ * An `@EventSource` is a method decorator to enable automatic event emission.
+ * The `registrar()` method of the Event class is used to decorate the method to auto-emit events.
+ * - All event types must extend the {@link Event} class.
+ *
+ * @example
+ * ```ts
+ * @EventSource(MyEvent)
+ * myMethod(): void { ... }
+ * ```
+ * @group Decorators
+ * @internal
+ * @param ofType The type of event being emitted.
+ * @returns The decorated method.
+ */
 export function EventSource(ofType) {
     return function (target, propertyKey, descriptor) {
         ofType.registrar(EventService.getInstance(), descriptor);

package/dist/decorators/event-source.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"event-source.decorator.js","sourceRoot":"","sources":["../../src/decorators/event-source.decorator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE,MAAM,UAAU,WAAW,CACzB,MAAqC;IAErC,OAAO,UAAU,MAAW,EAAE,WAAmB,EAAE,UAA8B;QAC9E,MAAc,CAAC,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,EAAE,UAAU,CAAC,CAAC;IACpE,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"event-source.decorator.js","sourceRoot":"","sources":["../../src/decorators/event-source.decorator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,WAAW,CACzB,MAAqC;IAErC,OAAO,UAAU,MAAW,EAAE,WAAmB,EAAE,UAA8B;QAC9E,MAAc,CAAC,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,EAAE,UAAU,CAAC,CAAC;IACpE,CAAC,CAAC;AACJ,CAAC"}

package/dist/decorators/factory.decorator.d.ts

@@ -1,4 +1,34 @@
 import type { Constructable } from '../app.type.js';
+/**
+ * A `@Factory` is a class decorator to be placed on top of a class that represents a factory.
+ * A factory is responsible for creating instances of a class.
+ *
+ * It is possible to generate multiple factories for the same class
+ * by assigning a unique set of metadata to the factory.
+ * Of all registered factories, only one can be the default factory.
+ *
+ * @example
+ * ```ts
+ * // Factory definition.
+ * @Factory<MyService>(MyService, { metadata: { key: 'value' } })
+ * export class MyServiceFactory {
+ *   static async create(arg1, arg2, ...): Promise<MyService> { ... }>
+ * }
+ *
+ * // Get instance using default factory.
+ * const myService = await Container.get(MyService);
+ *
+ * // Get instance using specific factory.
+ * const myService = await Container.get(MyService, { metadata: { key: 'value' } });
+ *
+ * // Pass args to factory.
+ * const myService = await Container.get(MyService, { args: [arg1, arg2, ...] });
+ * ```
+ * @group Decorators
+ * @param type The type of class that the factory creates.
+ * @param options Allows registering multiple factories for the same class that differ by metadata.
+ * @returns The decorated class.
+ */
 export declare function Factory<T>(type: Constructable<T> | string, options?: {
     metadata?: {
         [key: string]: string;

package/dist/decorators/factory.decorator.js

@@ -1,4 +1,34 @@
 import { Container } from './container.js';
+/**
+ * A `@Factory` is a class decorator to be placed on top of a class that represents a factory.
+ * A factory is responsible for creating instances of a class.
+ *
+ * It is possible to generate multiple factories for the same class
+ * by assigning a unique set of metadata to the factory.
+ * Of all registered factories, only one can be the default factory.
+ *
+ * @example
+ * ```ts
+ * // Factory definition.
+ * @Factory<MyService>(MyService, { metadata: { key: 'value' } })
+ * export class MyServiceFactory {
+ *   static async create(arg1, arg2, ...): Promise<MyService> { ... }>
+ * }
+ *
+ * // Get instance using default factory.
+ * const myService = await Container.get(MyService);
+ *
+ * // Get instance using specific factory.
+ * const myService = await Container.get(MyService, { metadata: { key: 'value' } });
+ *
+ * // Pass args to factory.
+ * const myService = await Container.get(MyService, { args: [arg1, arg2, ...] });
+ * ```
+ * @group Decorators
+ * @param type The type of class that the factory creates.
+ * @param options Allows registering multiple factories for the same class that differ by metadata.
+ * @returns The decorated class.
+ */
 export function Factory(type, options) {
     return function (constructor) {
         Container.registerFactory(type, constructor, options);

package/dist/decorators/factory.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"factory.decorator.js","sourceRoot":"","sources":["../../src/decorators/factory.decorator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,UAAU,OAAO,CACrB,IAA+B,EAC/B,OAEC;IAED,OAAO,UAAU,WAA2D;QAC1E,SAAS,CAAC,eAAe,CAAI,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"factory.decorator.js","sourceRoot":"","sources":["../../src/decorators/factory.decorator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,OAAO,CACrB,IAA+B,EAC/B,OAEC;IAED,OAAO,UAAU,WAA2D;QAC1E,SAAS,CAAC,eAAe,CAAI,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC,CAAC;AACJ,CAAC"}

package/dist/decorators/model.decorator.d.ts

@@ -1 +1,14 @@
+/**
+ * A `@Model` is a class decorator to be placed on top of a class that represents a model.
+ * - A model must extend the {@link AModel} class.
+ *
+ * @example
+ * ```ts
+ * @Model()
+ * export class MyModel extends AModel<IMyModel, MyModel> { ... }
+ * ```
+ * @group Decorators
+ * @returns The decorated class.
+ * @see Definition of [Models](/docs/fundamentals/models).
+ */
 export declare function Model(): (constructor: any) => void;

package/dist/decorators/model.decorator.js

@@ -2,6 +2,19 @@ import { RegistrationErrorEvent } from '../events/error.event.js';
 import { EventService } from '../services/event/event.service.js';
 import { ModelSerializationService } from '../services/serialization/model/model-serialization.service.js';
 import { Container } from './container.js';
+/**
+ * A `@Model` is a class decorator to be placed on top of a class that represents a model.
+ * - A model must extend the {@link AModel} class.
+ *
+ * @example
+ * ```ts
+ * @Model()
+ * export class MyModel extends AModel<IMyModel, MyModel> { ... }
+ * ```
+ * @group Decorators
+ * @returns The decorated class.
+ * @see Definition of [Models](/docs/fundamentals/models).
+ */
 export function Model() {
     return function (constructor) {
         Container.get(ModelSerializationService)

package/dist/decorators/model.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"model.decorator.js","sourceRoot":"","sources":["../../src/decorators/model.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gEAAgE,CAAC;AAC3G,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,UAAU,KAAK;IACnB,OAAO,UAAU,WAAgB;QAC/B,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC;aACrC,IAAI,CAAC,CAAC,yBAAyB,EAAE,EAAE;YAClC,yBAAyB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACzE,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,YAAY,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"model.decorator.js","sourceRoot":"","sources":["../../src/decorators/model.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gEAAgE,CAAC;AAC3G,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,KAAK;IACnB,OAAO,UAAU,WAAgB;QAC/B,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC;aACrC,IAAI,CAAC,CAAC,yBAAyB,EAAE,EAAE;YAClC,yBAAyB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACzE,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,YAAY,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;AACJ,CAAC"}

package/dist/decorators/module.decorator.d.ts

@@ -3,6 +3,58 @@ import type { Octo } from '../main.js';
 import type { IModelAction } from '../models/model-action.interface.js';
 import { type IModule } from '../modules/module.interface.js';
 import type { IResourceAction } from '../resources/resource-action.interface.js';
+/**
+ * A `@Module` is a class decorator to be placed on top of a class that represents a module.
+ * - A Module class must implement the {@link IModule} interface.
+ * - A Module class constructor is injected with the outputs of the modules it imports.
+ * - The {@link IModule.onInit} method is called to initialize the module,
+ * and is where you will *define* your infrastructure.
+ *
+ * @example
+ * ```ts
+ * @Module({
+ *   args: [{ isArg: (app: App) => app instanceof App, name: 'app' }],
+ *   imports: [OtherModule],
+ *   postModelActionHooks: [{ ACTION_NAME: 'SomeAction', collectInput: () => { ... }, handle: () => { ... } }],
+ * })
+ * export class MyModule implements IModule<Region> {
+ *   constructor(app: App) { ... }
+ *
+ *   async onInit(): Promise<Region> { ... }
+ * }
+ * ```
+ * @group Decorators
+ * @param options - Options to the module.
+ * @param options.args - (optional) An array of arg validators to verify the args passed to the module's constructor.
+ * - The `isArg` method receives an argument, and you must do your own type checking and return a boolean.
+ * - The `name` property is the name of the argument.
+ * @param options.imports - (optional) An array of modules to import.
+ * @param options.postCommitHooks - (optional) An array of post-commit hooks.
+ * - The `callback` method will be called after the transaction is committed.
+ * This method receives the same arguments as {@link Octo.commitTransaction}.
+ * @param options.postModelActionHooks - (optional) An array of post-model action hooks.
+ * - The `ACTION_NAME` identifies the action on which this hook is registered.
+ * - The `collectInput` method can be used to enrich the action inputs. It works the same as in {@link IModelAction}.
+ * - The `handle` method will be called after the action is executed.
+ * This method receives the same arguments as {@link IModelAction.handle}.
+ * @param options.postResourceActionHooks - (optional) An array of post-resource action hooks.
+ * - The `ACTION_NAME` identifies the action on which this hook is registered.
+ * - The `handle` method will be called after the action is executed.
+ * This method receives the same arguments as {@link IResourceAction.handle}.
+ * @param options.preCommitHooks - (optional) An array of pre-commit hooks.
+ * - The `callback` method will be called before the transaction is committed.
+ * This method receives the same arguments as {@link Octo.commitTransaction}.
+ * @param options.preModelActionHooks - (optional) An array of pre-model action hooks.
+ * - The `ACTION_NAME` identifies the action on which this hook is registered.
+ * - The `collectInput` method can be used to enrich the action inputs. It works the same as in {@link IModelAction}.
+ * - The `handle` method will be called before the action is executed.
+ * This method receives the same arguments as {@link IModelAction.handle}.
+ * @param options.preResourceActionHooks - (optional) An array of pre-resource action hooks.
+ * - The `ACTION_NAME` identifies the action on which this hook is registered.
+ * - The `handle` method will be called before the action is executed.
+ * @returns The decorated class.
+ * @see Definition of [Modules](/docs/fundamentals/modules).
+ */
 export declare function Module({ args, imports, postCommitHooks, postModelActionHooks, postResourceActionHooks, preCommitHooks, preModelActionHooks, preResourceActionHooks, }: {
     args?: {
         isArg: (arg: unknown) => boolean;