@quadnix/octo 0.0.22 → 0.0.24

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

@@ -7,20 +7,25 @@ import { CommitHook } from '../functions/hook/commit.hook.js';
  * @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) {
+    return function (_target, _propertyKey, descriptor) {
         switch (hook) {
             case 'CommitHook':
                 CommitHook.getInstance().registrar(descriptor);
                 break;
             default:
-                throw new Error('Invalid hook!');
+                throw new Error(`Invalid hook "${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;;;;;;;;;;;;;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"}
+{"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;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,OAAO,UAAU,OAAY,EAAE,YAAoB,EAAE,UAA8B;QACjF,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,iBAAiB,IAAI,IAAI,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

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

@@ -1,5 +1,5 @@
 import type { Constructable } from '../app.type.js';
-import type { Event } from '../events/event.model.js';
+import type { Event } from '../events/index.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.
@@ -10,9 +10,13 @@ import type { Event } from '../events/event.model.js';
  * @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

@@ -9,13 +9,17 @@ import { EventService } from '../services/event/event.service.js';
  * @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) {
+    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;;;;;;;;;;;;;;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"}
+{"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;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,WAAW,CACzB,MAAqC;IAErC,OAAO,UAAU,OAAY,EAAE,YAAoB,EAAE,UAA8B;QAChF,MAAc,CAAC,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,EAAE,UAAU,CAAC,CAAC;IACpE,CAAC,CAAC;AACJ,CAAC"}

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

@@ -3,10 +3,14 @@ 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)
+ * @Factory<MyService>(MyService, { metadata: { key: 'value' } })
  * export class MyServiceFactory {
  *   static async create(arg1, arg2, ...): Promise<MyService> { ... }
  * }
@@ -14,11 +18,15 @@ import type { Constructable } from '../app.type.js';
  * // 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.
  * @remarks
  * If the factory is dependent on other factories, it should not block creation of its instance.
  * ```ts
@@ -52,6 +60,10 @@ import type { Constructable } from '../app.type.js';
  * ```
  * @returns The decorated class.
  */
-export declare function Factory<T>(type: Constructable<T> | string): (constructor: {
+export declare function Factory<T>(type: Constructable<T> | string, options?: {
+    metadata?: {
+        [key: string]: string;
+    };
+}): (constructor: {
     create: (...args: unknown[]) => Promise<T>;
 }) => void;

package/dist/decorators/factory.decorator.js

@@ -3,10 +3,14 @@ import { Container } from '../functions/container/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)
+ * @Factory<MyService>(MyService, { metadata: { key: 'value' } })
  * export class MyServiceFactory {
  *   static async create(arg1, arg2, ...): Promise<MyService> { ... }
  * }
@@ -14,11 +18,15 @@ import { Container } from '../functions/container/container.js';
  * // 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.
  * @remarks
  * If the factory is dependent on other factories, it should not block creation of its instance.
  * ```ts
@@ -52,9 +60,10 @@ import { Container } from '../functions/container/container.js';
  * ```
  * @returns The decorated class.
  */
-export function Factory(type) {
+export function Factory(type, options) {
+    const container = Container.getInstance();
     return function (constructor) {
-        Container.registerFactory(type, constructor);
+        container.registerFactory(type, constructor, options);
     };
 }
 //# sourceMappingURL=factory.decorator.js.map

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,qCAAqC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,MAAM,UAAU,OAAO,CACrB,IAA+B;IAE/B,OAAO,UAAU,WAA2D;QAC1E,SAAS,CAAC,eAAe,CAAI,IAAI,EAAE,WAAW,CAAC,CAAC;IAClD,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,qCAAqC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,MAAM,UAAU,OAAO,CACrB,IAA+B,EAC/B,OAEC;IAED,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,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,14 +1,28 @@
+import { type Constructable, type ModelSchema, type UnknownModel } from '../app.type.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.
+ * A `@Model` is a class decorator and must be placed on top of a class representing a model.
+ * - A model must also extend a base model class.
+ * - For type safety, the type of model being decorated is passed to the decorator.
  *
  * @example
  * ```ts
- * @Model()
- * export class MyModel extends AModel<IMyModel, MyModel> { ... }
+ * @Model<MyModel>('@example', 'region', MyModelSchema)
+ * export class MyModel extends Region { ... }
  * ```
+ *
  * @group Decorators
+ *
+ * @param packageName - The name of the package under which the model is registered.
+ * Selecting a unique package name helps avoid collisions between same model class names across different libraries.
+ * You will reuse the same package name throughout your library for different Octo components you create.
+ * @param modelName - a string that uniquely represents the base model you are extending.
+ * Octo provides names for each of the base models, and you must use the same name.
+ * E.g. for region base model, the model name is `region`.
+ * @param schema - The schema of the model.
+ *
  * @returns The decorated class.
+ *
  * @see Definition of [Models](/docs/fundamentals/models).
+ * @see {@link App} and {@link Region} are a few base models. More can be found in the same folder.
  */
-export declare function Model(): (constructor: any) => void;
+export declare function Model<T extends UnknownModel>(packageName: string, modelName: string, schema: Constructable<ModelSchema<T>>): (constructor: any) => void;

package/dist/decorators/model.decorator.js

@@ -1,29 +1,55 @@
-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 { NodeType } from '../app.type.js';
 import { Container } from '../functions/container/container.js';
+import { AModel } from '../models/model.abstract.js';
+import { AOverlay } from '../overlays/overlay.abstract.js';
+import { ModelSerializationService } from '../services/serialization/model/model-serialization.service.js';
+import { ValidationUtility } from '../utilities/validation/validation.utility.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.
+ * A `@Model` is a class decorator and must be placed on top of a class representing a model.
+ * - A model must also extend a base model class.
+ * - For type safety, the type of model being decorated is passed to the decorator.
  *
  * @example
  * ```ts
- * @Model()
- * export class MyModel extends AModel<IMyModel, MyModel> { ... }
+ * @Model<MyModel>('@example', 'region', MyModelSchema)
+ * export class MyModel extends Region { ... }
  * ```
+ *
  * @group Decorators
+ *
+ * @param packageName - The name of the package under which the model is registered.
+ * Selecting a unique package name helps avoid collisions between same model class names across different libraries.
+ * You will reuse the same package name throughout your library for different Octo components you create.
+ * @param modelName - a string that uniquely represents the base model you are extending.
+ * Octo provides names for each of the base models, and you must use the same name.
+ * E.g. for region base model, the model name is `region`.
+ * @param schema - The schema of the model.
+ *
  * @returns The decorated class.
+ *
  * @see Definition of [Models](/docs/fundamentals/models).
+ * @see {@link App} and {@link Region} are a few base models. More can be found in the same folder.
  */
-export function Model() {
+export function Model(packageName, modelName, schema) {
+    const container = Container.getInstance();
     return function (constructor) {
-        Container.get(ModelSerializationService)
-            .then((modelSerializationService) => {
-            modelSerializationService.registerClass(constructor.name, constructor);
-        })
-            .catch((error) => {
-            EventService.getInstance().emit(new RegistrationErrorEvent(error));
+        if (!ValidationUtility.validateRegex(packageName, /^[@A-Za-z][\w-]+[A-Za-z]$/)) {
+            throw new Error(`Invalid package name: ${packageName}`);
+        }
+        if (!ValidationUtility.validateRegex(modelName, /^[A-Za-z][\w-]+[A-Za-z]$/)) {
+            throw new Error(`Invalid model name: ${modelName}`);
+        }
+        if (!(constructor.prototype instanceof AModel) || constructor.prototype instanceof AOverlay) {
+            throw new Error(`Class "${constructor.name}" must extend the AModel class!`);
+        }
+        constructor.NODE_NAME = modelName;
+        constructor.NODE_PACKAGE = packageName;
+        constructor.NODE_SCHEMA = schema;
+        constructor.NODE_TYPE = NodeType.MODEL;
+        const promise = container.get(ModelSerializationService).then((modelSerializationService) => {
+            modelSerializationService.registerClass(`${packageName}/${constructor.name}`, constructor);
         });
+        container.registerStartupUnhandledPromise(promise);
     };
 }
 //# sourceMappingURL=model.decorator.js.map

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,qCAAqC,CAAC;AAEhE;;;;;;;;;;;;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"}
+{"version":3,"file":"model.decorator.js","sourceRoot":"","sources":["../../src/decorators/model.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwC,QAAQ,EAAqB,MAAM,gBAAgB,CAAC;AACnG,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gEAAgE,CAAC;AAC3G,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,KAAK,CACnB,WAAmB,EACnB,SAAiB,EACjB,MAAqC;IAErC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAAgB;QAC/B,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,WAAW,EAAE,2BAA2B,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,SAAS,EAAE,0BAA0B,CAAC,EAAE,CAAC;YAC5E,MAAM,IAAI,KAAK,CAAC,uBAAuB,SAAS,EAAE,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,YAAY,MAAM,CAAC,IAAI,WAAW,CAAC,SAAS,YAAY,QAAQ,EAAE,CAAC;YAC5F,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,iCAAiC,CAAC,CAAC;QAC/E,CAAC;QAED,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;QAClC,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC;QACvC,WAAW,CAAC,WAAW,GAAG,MAAM,CAAC;QACjC,WAAW,CAAC,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;QAEvC,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,IAAI,CAAC,CAAC,yBAAyB,EAAE,EAAE;YAC1F,yBAAyB,CAAC,aAAa,CAAC,GAAG,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}

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

@@ -1,92 +1,21 @@
-import type { Constructable } from '../app.type.js';
-import type { DiffMetadata } from '../functions/diff/diff-metadata.js';
-import type { App } from '../models/app/app.model.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';
-type CommitHooksCallback = (app: App, modelTransaction: DiffMetadata[][], resourceTransaction: DiffMetadata[][]) => Promise<void>;
-export interface IModuleOptions {
-    args?: {
-        isArg: (arg: unknown) => boolean;
-        name: string;
-    }[];
-    imports?: (Constructable<IModule<unknown>> | string)[];
-    postCommitHooks?: {
-        callback: CommitHooksCallback;
-    }[];
-    postModelActionHooks?: {
-        ACTION_NAME: string;
-        collectInput?: IModelAction['collectInput'];
-        handle: IModelAction['handle'];
-    }[];
-    postResourceActionHooks?: {
-        ACTION_NAME: string;
-        handle: IResourceAction['handle'];
-    }[];
-    preCommitHooks?: {
-        callback: CommitHooksCallback;
-    }[];
-    preModelActionHooks?: {
-        ACTION_NAME: string;
-        collectInput?: IModelAction['collectInput'];
-        handle: IModelAction['handle'];
-    }[];
-    preResourceActionHooks?: {
-        ACTION_NAME: string;
-        handle: IResourceAction['handle'];
-    }[];
-}
+import type { Constructable, ModuleSchema } from '../app.type.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: () => { ... } }],
- * })
+ * @Module<MyInputInterface, OutputModel>('my-package', {})
  * export class MyModule implements IModule<Region> {
- *   constructor(app: App) { ... }
+ *   constructor(inputs: IMyInputs) { ... }
  *
  *   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, }?: IModuleOptions): (constructor: any) => void;
-export {};
+export declare function Module<T>(packageName: string, schema: Constructable<ModuleSchema<T>>): (constructor: any) => void;

package/dist/decorators/module.decorator.js

@@ -1,81 +1,41 @@
-import { RegistrationErrorEvent } from '../events/error.event.js';
-import { ModuleContainer } from '../modules/module.container.js';
-import { EventService } from '../services/event/event.service.js';
 import { Container } from '../functions/container/container.js';
+import { AModule } from '../modules/module.abstract.js';
+import { ModuleContainer } from '../modules/module.container.js';
+import { ValidationUtility } from '../utilities/validation/validation.utility.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: () => { ... } }],
- * })
+ * @Module<MyInputInterface, OutputModel>('my-package', {})
  * export class MyModule implements IModule<Region> {
- *   constructor(app: App) { ... }
+ *   constructor(inputs: IMyInputs) { ... }
  *
  *   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 function Module({ args = [], imports = [], postCommitHooks = [], postModelActionHooks = [], postResourceActionHooks = [], preCommitHooks = [], preModelActionHooks = [], preResourceActionHooks = [], } = {}) {
+export function Module(packageName, schema) {
+    const container = Container.getInstance();
     return function (constructor) {
-        Container.get(ModuleContainer)
-            .then((moduleContainer) => {
-            // Verify classes with @Module implements IModule.
-            if (!('onInit' in constructor.prototype)) {
-                throw new Error(`Class "${constructor.name}" does not implement IModule!`);
-            }
-            moduleContainer.register(constructor, {
-                args,
-                imports,
-                postCommitHooks,
-                postModelActionHooks,
-                postResourceActionHooks,
-                preCommitHooks,
-                preModelActionHooks,
-                preResourceActionHooks,
-            });
-        })
-            .catch((error) => {
-            EventService.getInstance().emit(new RegistrationErrorEvent(error));
+        if (!ValidationUtility.validateRegex(packageName, /^[@A-Za-z][\w-]+[A-Za-z]$/)) {
+            throw new Error(`Invalid package name: ${packageName}`);
+        }
+        if (!(constructor.prototype instanceof AModule)) {
+            throw new Error(`Class "${constructor.name}" must extend the AModule class!`);
+        }
+        constructor.MODULE_PACKAGE = packageName;
+        constructor.MODULE_SCHEMA = schema;
+        const promise = container.get(ModuleContainer).then((moduleContainer) => {
+            moduleContainer.register(constructor, { packageName });
         });
+        container.registerStartupUnhandledPromise(promise);
     };
 }
 //# sourceMappingURL=module.decorator.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"module.decorator.js","sourceRoot":"","sources":["../../src/decorators/module.decorator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAIlE,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAGjE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAiChE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,UAAU,MAAM,CAAC,EACrB,IAAI,GAAG,EAAE,EACT,OAAO,GAAG,EAAE,EACZ,eAAe,GAAG,EAAE,EACpB,oBAAoB,GAAG,EAAE,EACzB,uBAAuB,GAAG,EAAE,EAC5B,cAAc,GAAG,EAAE,EACnB,mBAAmB,GAAG,EAAE,EACxB,sBAAsB,GAAG,EAAE,MACT,EAAE;IACpB,OAAO,UAAU,WAA4C;QAC3D,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC;aAC3B,IAAI,CAAC,CAAC,eAAe,EAAE,EAAE;YACxB,kDAAkD;YAClD,IAAI,CAAC,CAAC,QAAQ,IAAI,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,+BAA+B,CAAC,CAAC;YAC7E,CAAC;YAED,eAAe,CAAC,QAAQ,CAAC,WAAW,EAAE;gBACpC,IAAI;gBACJ,OAAO;gBACP,eAAe;gBACf,oBAAoB;gBACpB,uBAAuB;gBACvB,cAAc;gBACd,mBAAmB;gBACnB,sBAAsB;aACvB,CAAC,CAAC;QACL,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":"module.decorator.js","sourceRoot":"","sources":["../../src/decorators/module.decorator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,MAAM,CAAI,WAAmB,EAAE,MAAsC;IACnF,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAAgB;QAC/B,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,WAAW,EAAE,2BAA2B,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,YAAY,OAAO,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,kCAAkC,CAAC,CAAC;QAChF,CAAC;QAED,WAAW,CAAC,cAAc,GAAG,WAAW,CAAC;QACzC,WAAW,CAAC,aAAa,GAAG,MAAM,CAAC;QAEnC,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,EAAE;YACtE,eAAe,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}

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

@@ -1,5 +1,5 @@
 import type { Constructable } from '../app.type.js';
-import type { Event } from '../events/event.model.js';
+import type { Event } from '../events/index.js';
 /**
  * An `@OnEvent` is a method decorator to listen to an event.
  *

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

@@ -17,7 +17,7 @@ import { EventService } from '../services/event/event.service.js';
  * @returns The decorated method.
  */
 export function OnEvent(ofType) {
-    return function (target, propertyKey, descriptor) {
+    return function (target, _propertyKey, descriptor) {
         EventService.getInstance().registerListeners(ofType, target, descriptor);
     };
 }

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

@@ -1 +1 @@
-{"version":3,"file":"on-event.decorator.js","sourceRoot":"","sources":["../../src/decorators/on-event.decorator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,OAAO,CACrB,MAAqC;IAErC,OAAO,UAAU,MAAW,EAAE,WAAmB,EAAE,UAA8B;QAC/E,YAAY,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAC3E,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"on-event.decorator.js","sourceRoot":"","sources":["../../src/decorators/on-event.decorator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,OAAO,CACrB,MAAqC;IAErC,OAAO,UAAU,MAAW,EAAE,YAAoB,EAAE,UAA8B;QAChF,YAAY,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAC3E,CAAC,CAAC;AACJ,CAAC"}

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

@@ -1,14 +1,24 @@
+import { type Constructable, type OverlaySchema, type UnknownOverlay } from '../app.type.js';
 /**
- * An `@Overlay` is a class decorator to be placed on top of a class that represents an overlay.
- * - An overlay must extend the {@link AOverlay} class.
+ * An `@Overlay` is a class decorator and must be placed on top of a class representing an overlay.
+ * - An overlay must also extend the {@link AOverlay} class.
+ * - For type safety, the type of overlay being decorated is passed to the decorator.
  *
  * @example
  * ```ts
- * @Overlay()
- * export class MyOverlay extends AOverlay<MyOverlay> { ... }
+ * @Overlay<MyOverlay>('@example', 'my-name', MyOverlaySchema)
+ * export class MyOverlay extends AOverlay<MyOverlaySchema, MyOverlay> { ... }
  * ```
  * @group Decorators
+ *
+ * @param packageName - The name of the package under which the overlay is registered.
+ * Selecting a unique package name helps avoid collisions between same overlay class names across different libraries.
+ * You will reuse the same package name throughout your library for different Octo components you create.
+ * @param overlayName - a string that uniquely represents the name of the overlay.
+ * @param schema - The schema of the overlay.
+ *
  * @returns The decorated class.
- * @see Definition of [Overlays](/docs/fundamentals/overlay-and-anchor).
+ *
+ * @see Definition of [Overlays](/docs/fundamentals/overlays).
  */
-export declare function Overlay(): (constructor: any) => void;
+export declare function Overlay<T extends UnknownOverlay>(packageName: string, overlayName: string, schema: Constructable<OverlaySchema<T>>): (constructor: any) => void;

package/dist/decorators/overlay.decorator.js

@@ -1,29 +1,50 @@
-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 { NodeType } from '../app.type.js';
 import { Container } from '../functions/container/container.js';
+import { AOverlay } from '../overlays/overlay.abstract.js';
+import { ModelSerializationService } from '../services/serialization/model/model-serialization.service.js';
+import { ValidationUtility } from '../utilities/validation/validation.utility.js';
 /**
- * An `@Overlay` is a class decorator to be placed on top of a class that represents an overlay.
- * - An overlay must extend the {@link AOverlay} class.
+ * An `@Overlay` is a class decorator and must be placed on top of a class representing an overlay.
+ * - An overlay must also extend the {@link AOverlay} class.
+ * - For type safety, the type of overlay being decorated is passed to the decorator.
  *
  * @example
  * ```ts
- * @Overlay()
- * export class MyOverlay extends AOverlay<MyOverlay> { ... }
+ * @Overlay<MyOverlay>('@example', 'my-name', MyOverlaySchema)
+ * export class MyOverlay extends AOverlay<MyOverlaySchema, MyOverlay> { ... }
  * ```
  * @group Decorators
+ *
+ * @param packageName - The name of the package under which the overlay is registered.
+ * Selecting a unique package name helps avoid collisions between same overlay class names across different libraries.
+ * You will reuse the same package name throughout your library for different Octo components you create.
+ * @param overlayName - a string that uniquely represents the name of the overlay.
+ * @param schema - The schema of the overlay.
+ *
  * @returns The decorated class.
- * @see Definition of [Overlays](/docs/fundamentals/overlay-and-anchor).
+ *
+ * @see Definition of [Overlays](/docs/fundamentals/overlays).
  */
-export function Overlay() {
+export function Overlay(packageName, overlayName, schema) {
+    const container = Container.getInstance();
     return function (constructor) {
-        Container.get(ModelSerializationService)
-            .then((modelSerializationService) => {
-            modelSerializationService.registerClass(constructor.name, constructor);
-        })
-            .catch((error) => {
-            EventService.getInstance().emit(new RegistrationErrorEvent(error));
+        if (!ValidationUtility.validateRegex(packageName, /^[@A-Za-z][\w-]+[A-Za-z]$/)) {
+            throw new Error(`Invalid package name: ${packageName}`);
+        }
+        if (!ValidationUtility.validateRegex(overlayName, /^[A-Za-z][\w-]+[A-Za-z]$/)) {
+            throw new Error(`Invalid overlay name: ${overlayName}`);
+        }
+        if (!(constructor.prototype instanceof AOverlay)) {
+            throw new Error(`Class "${constructor.name}" must extend the AOverlay class!`);
+        }
+        constructor.NODE_NAME = overlayName;
+        constructor.NODE_PACKAGE = packageName;
+        constructor.NODE_SCHEMA = schema;
+        constructor.NODE_TYPE = NodeType.OVERLAY;
+        const promise = container.get(ModelSerializationService).then((modelSerializationService) => {
+            modelSerializationService.registerClass(`${packageName}/${constructor.name}`, constructor);
         });
+        container.registerStartupUnhandledPromise(promise);
     };
 }
 //# sourceMappingURL=overlay.decorator.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"overlay.decorator.js","sourceRoot":"","sources":["../../src/decorators/overlay.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,qCAAqC,CAAC;AAEhE;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,OAAO;IACrB,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":"overlay.decorator.js","sourceRoot":"","sources":["../../src/decorators/overlay.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,QAAQ,EAA2C,MAAM,gBAAgB,CAAC;AACvG,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gEAAgE,CAAC;AAC3G,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,OAAO,CACrB,WAAmB,EACnB,WAAmB,EACnB,MAAuC;IAEvC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAAgB;QAC/B,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,WAAW,EAAE,2BAA2B,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,WAAW,EAAE,0BAA0B,CAAC,EAAE,CAAC;YAC9E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,YAAY,QAAQ,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,mCAAmC,CAAC,CAAC;QACjF,CAAC;QAED,WAAW,CAAC,SAAS,GAAG,WAAW,CAAC;QACpC,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC;QACvC,WAAW,CAAC,WAAW,GAAG,MAAM,CAAC;QACjC,WAAW,CAAC,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC;QAEzC,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,IAAI,CAAC,CAAC,yBAAyB,EAAE,EAAE;YAC1F,yBAAyB,CAAC,aAAa,CAAC,GAAG,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}