@quadnix/octo 0.0.20 → 0.0.22

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

@@ -1 +1 @@
-{"version":3,"file":"module.decorator.js","sourceRoot":"","sources":["../../src/decorators/module.decorator.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAGjE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,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,GAwB5B;IACC,OAAO,UAAU,WAA4C;QAC3D,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,EAAE;YAEtD,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,CAAC;IACL,CAAC,CAAC;AACJ,CAAC"}
+{"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"}

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

@@ -1,3 +1,20 @@
 import type { Constructable } from '../app.type.js';
 import type { Event } from '../events/event.model.js';
+/**
+ * An `@OnEvent` is a method decorator to listen to an event.
+ *
+ * @example
+ * ```ts
+ * // Async handler.
+ * @OnEvent(MyEvent)
+ * async onEvent(event: MyEvent): Promise<void> { ... }
+ *
+ * // Sync handler.
+ * @OnEvent(MyEvent)
+ * onEvent(event: MyEvent): void { ... }
+ * ```
+ * @group Decorators
+ * @param ofType The type of event being listened to.
+ * @returns The decorated method.
+ */
 export declare function OnEvent(ofType: Constructable<Event<unknown>>): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

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

@@ -1,4 +1,21 @@
 import { EventService } from '../services/event/event.service.js';
+/**
+ * An `@OnEvent` is a method decorator to listen to an event.
+ *
+ * @example
+ * ```ts
+ * // Async handler.
+ * @OnEvent(MyEvent)
+ * async onEvent(event: MyEvent): Promise<void> { ... }
+ *
+ * // Sync handler.
+ * @OnEvent(MyEvent)
+ * onEvent(event: MyEvent): void { ... }
+ * ```
+ * @group Decorators
+ * @param ofType The type of event being listened to.
+ * @returns The decorated method.
+ */
 export function OnEvent(ofType) {
     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,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,WAAmB,EAAE,UAA8B;QAC/E,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 +1,14 @@
+/**
+ * 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.
+ *
+ * @example
+ * ```ts
+ * @Overlay()
+ * export class MyOverlay extends AOverlay<MyOverlay> { ... }
+ * ```
+ * @group Decorators
+ * @returns The decorated class.
+ * @see Definition of [Overlays](/docs/fundamentals/overlay-and-anchor).
+ */
 export declare function Overlay(): (constructor: any) => void;

package/dist/decorators/overlay.decorator.js

@@ -1,7 +1,20 @@
 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';
+import { Container } from '../functions/container/container.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.
+ *
+ * @example
+ * ```ts
+ * @Overlay()
+ * export class MyOverlay extends AOverlay<MyOverlay> { ... }
+ * ```
+ * @group Decorators
+ * @returns The decorated class.
+ * @see Definition of [Overlays](/docs/fundamentals/overlay-and-anchor).
+ */
 export function Overlay() {
     return function (constructor) {
         Container.get(ModelSerializationService)

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,gBAAgB,CAAC;AAE3C,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,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"}

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

@@ -1 +1,14 @@
+/**
+ * A `@Resource` is a class decorator to be placed on top of a class that represents a resource.
+ * - A resource must extend the {@link AResource} class.
+ *
+ * @example
+ * ```ts
+ * @Resource()
+ * export class MyResource extends AResource<MyResource> { ... }
+ * ```
+ * @group Decorators
+ * @returns The decorated class.
+ * @see Definition of [Resources](http://localhost:3000/docs/fundamentals/resources).
+ */
 export declare function Resource(): (constructor: any) => void;

package/dist/decorators/resource.decorator.js

@@ -1,7 +1,20 @@
 import { RegistrationErrorEvent } from '../events/error.event.js';
 import { EventService } from '../services/event/event.service.js';
 import { ResourceSerializationService } from '../services/serialization/resource/resource-serialization.service.js';
-import { Container } from './container.js';
+import { Container } from '../functions/container/container.js';
+/**
+ * A `@Resource` is a class decorator to be placed on top of a class that represents a resource.
+ * - A resource must extend the {@link AResource} class.
+ *
+ * @example
+ * ```ts
+ * @Resource()
+ * export class MyResource extends AResource<MyResource> { ... }
+ * ```
+ * @group Decorators
+ * @returns The decorated class.
+ * @see Definition of [Resources](http://localhost:3000/docs/fundamentals/resources).
+ */
 export function Resource() {
     return function (constructor) {
         Container.get(ResourceSerializationService)

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

@@ -1 +1 @@
-{"version":3,"file":"resource.decorator.js","sourceRoot":"","sources":["../../src/decorators/resource.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,4BAA4B,EAAE,MAAM,sEAAsE,CAAC;AACpH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,UAAU,QAAQ;IACtB,OAAO,UAAU,WAAgB;QAC/B,SAAS,CAAC,GAAG,CAAC,4BAA4B,CAAC;aACxC,IAAI,CAAC,CAAC,4BAA4B,EAAE,EAAE;YACrC,4BAA4B,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC5E,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":"resource.decorator.js","sourceRoot":"","sources":["../../src/decorators/resource.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,4BAA4B,EAAE,MAAM,sEAAsE,CAAC;AACpH,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAEhE;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,QAAQ;IACtB,OAAO,UAAU,WAAgB;QAC/B,SAAS,CAAC,GAAG,CAAC,4BAA4B,CAAC;aACxC,IAAI,CAAC,CAAC,4BAA4B,EAAE,EAAE;YACrC,4BAA4B,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC5E,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/validate.decorator.d.ts

@@ -0,0 +1,9 @@
+import type { ValidationType } from '../app.type.js';
+type ValidationOptions<T> = {
+    options: {
+        [key in ValidationType]?: any;
+    };
+    destruct?: (value: any) => T[];
+};
+export declare function Validate<T>(validators: ValidationOptions<T> | ValidationOptions<T>[]): (target: any, propertyKey: string) => void;
+export {};

package/dist/decorators/validate.decorator.js

@@ -0,0 +1,23 @@
+import { ValidationService } from '../services/validation/validation.service.js';
+export function Validate(validators) {
+    return function (target, propertyKey) {
+        const symbol = Symbol();
+        Object.defineProperty(target, propertyKey, {
+            get: function () {
+                return this[symbol];
+            },
+            set: function (newValue) {
+                if (!Array.isArray(validators)) {
+                    validators = [validators];
+                }
+                for (const validator of validators) {
+                    for (const [type, constraint] of Object.entries(validator.options)) {
+                        ValidationService.getInstance().addSubject(type, constraint, target, propertyKey, newValue, validator.destruct);
+                    }
+                }
+                this[symbol] = newValue;
+            },
+        });
+    };
+}
+//# sourceMappingURL=validate.decorator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validate.decorator.js","sourceRoot":"","sources":["../../src/decorators/validate.decorator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8CAA8C,CAAC;AAOjF,MAAM,UAAU,QAAQ,CACtB,UAAyD;IAEzD,OAAO,UAAU,MAAW,EAAE,WAAmB;QAC/C,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC;QAExB,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE;YACzC,GAAG,EAAE;gBACH,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;YACtB,CAAC;YACD,GAAG,EAAE,UAAU,QAAa;gBAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC/B,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC;gBAC5B,CAAC;gBAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;oBACnC,KAAK,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;wBACnE,iBAAiB,CAAC,WAAW,EAAE,CAAC,UAAU,CACxC,IAAsB,EACtB,UAAU,EACV,MAAM,EACN,WAAW,EACX,QAAQ,EACR,SAAS,CAAC,QAAQ,CACnB,CAAC;oBACJ,CAAC;gBACH,CAAC;gBAED,IAAI,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;YAC1B,CAAC;SACF,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC"}

package/dist/events/error.event.d.ts

@@ -1,5 +1,35 @@
 import { Event } from './event.model.js';
+/**
+ * The ErrorEvent class is the superclass for all events emitting an error.
+ * An error event is generated when Octo encounters an error.
+ *
+ * :::warning Warning
+ * It is not a good practice to create an event from this class directly,
+ * but should rather create one from one of the subclasses.
+ * This promotes a more accurate classification of events.
+ * :::
+ *
+ * @example
+ * ```ts
+ * const myEvent = new ErrorEvent(new Error('e'));
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class ErrorEvent extends Event<Error> {
 }
+/**
+ * This event is emitted at startup when a class fails to register.
+ * It emits the [Error](https://nodejs.org/api/errors.html) object.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new RegistrationErrorEvent(new Error('e'));
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class RegistrationErrorEvent extends ErrorEvent {
 }

package/dist/events/error.event.js

@@ -1,6 +1,36 @@
 import { Event } from './event.model.js';
+/**
+ * The ErrorEvent class is the superclass for all events emitting an error.
+ * An error event is generated when Octo encounters an error.
+ *
+ * :::warning Warning
+ * It is not a good practice to create an event from this class directly,
+ * but should rather create one from one of the subclasses.
+ * This promotes a more accurate classification of events.
+ * :::
+ *
+ * @example
+ * ```ts
+ * const myEvent = new ErrorEvent(new Error('e'));
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export class ErrorEvent extends Event {
 }
+/**
+ * This event is emitted at startup when a class fails to register.
+ * It emits the [Error](https://nodejs.org/api/errors.html) object.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new RegistrationErrorEvent(new Error('e'));
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export class RegistrationErrorEvent extends ErrorEvent {
 }
 //# sourceMappingURL=error.event.js.map

package/dist/events/error.event.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.event.js","sourceRoot":"","sources":["../../src/events/error.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,MAAM,OAAO,UAAW,SAAQ,KAAY;CAAG;AAE/C,MAAM,OAAO,sBAAuB,SAAQ,UAAU;CAAG"}
+{"version":3,"file":"error.event.js","sourceRoot":"","sources":["../../src/events/error.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,UAAW,SAAQ,KAAY;CAAG;AAE/C;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,sBAAuB,SAAQ,UAAU;CAAG"}

package/dist/events/event.model.d.ts

@@ -1,4 +1,23 @@
 import type { EventService } from '../services/event/event.service.js';
+/**
+ * The Event class is the superclass for all events.
+ * An event is generated when something important happens in Octo.
+ * The body of the event contains a header, a payload, and an optional user data.
+ *
+ * :::warning Warning
+ * It is not a good practice to create an event from this class directly,
+ * but should rather create one from one of the subclasses.
+ * This promotes a more accurate classification of events.
+ * :::
+ *
+ * @example
+ * ```ts
+ * const myEvent = new Event<string>('my payload', { key: 'value' });
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class Event<T> {
     readonly header: {
         timestamp: number;
@@ -6,5 +25,13 @@ export declare class Event<T> {
     readonly payload: T;
     readonly userData: object;
     constructor(payload: T, userData?: object);
+    /**
+     * The `registrar()` method is explicitly called by the {@link EventSource} decorator for a method
+     * to enhance the method to auto-emit events.
+     *
+     * @param args Arguments are spread out using the array spread operator.
+     * - args[0] - Instance of {@link EventService}.
+     * - args[1] - [PropertyDescriptor](https://www.typescriptlang.org/docs/handbook/decorators.html).
+     */
     static registrar(...args: [EventService, PropertyDescriptor]): void;
 }

package/dist/events/event.model.js

@@ -1,7 +1,23 @@
+/**
+ * The Event class is the superclass for all events.
+ * An event is generated when something important happens in Octo.
+ * The body of the event contains a header, a payload, and an optional user data.
+ *
+ * :::warning Warning
+ * It is not a good practice to create an event from this class directly,
+ * but should rather create one from one of the subclasses.
+ * This promotes a more accurate classification of events.
+ * :::
+ *
+ * @example
+ * ```ts
+ * const myEvent = new Event<string>('my payload', { key: 'value' });
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export class Event {
-    header;
-    payload;
-    userData;
     constructor(payload, userData = {}) {
         this.header = {
             timestamp: Date.now(),
@@ -9,6 +25,14 @@ export class Event {
         this.payload = payload;
         this.userData = userData;
     }
+    /**
+     * The `registrar()` method is explicitly called by the {@link EventSource} decorator for a method
+     * to enhance the method to auto-emit events.
+     *
+     * @param args Arguments are spread out using the array spread operator.
+     * - args[0] - Instance of {@link EventService}.
+     * - args[1] - [PropertyDescriptor](https://www.typescriptlang.org/docs/handbook/decorators.html).
+     */
     static registrar(...args) {
         if (args.length !== 2) {
             throw new Error('Invalid number of args in event registrar!');

package/dist/events/event.model.js.map

@@ -1 +1 @@
-{"version":3,"file":"event.model.js","sourceRoot":"","sources":["../../src/events/event.model.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,KAAK;IACP,MAAM,CAEb;IAEO,OAAO,CAAI;IAEX,QAAQ,CAAS;IAE1B,YAAY,OAAU,EAAE,WAAmB,EAAE;QAC3C,IAAI,CAAC,MAAM,GAAG;YACZ,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACtB,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,GAAG,IAAwC;QAC1D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;IAC9E,CAAC;CACF"}
+{"version":3,"file":"event.model.js","sourceRoot":"","sources":["../../src/events/event.model.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,KAAK;IAShB,YAAY,OAAU,EAAE,WAAmB,EAAE;QAC3C,IAAI,CAAC,MAAM,GAAG;YACZ,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACtB,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CAAC,GAAG,IAAwC;QAC1D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;IAC9E,CAAC;CACF"}

package/dist/events/hook.event.d.ts

@@ -1,27 +1,194 @@
 import { Event } from './event.model.js';
+/**
+ * The HookEvent class is the superclass for all events emitting in relation to hooks.
+ *
+ * :::warning Warning
+ * It is not a good practice to create an event from this class directly,
+ * but should rather create one from one of the subclasses.
+ * This promotes a more accurate classification of events.
+ * :::
+ *
+ * @example
+ * ```ts
+ * const myEvent = new HookEvent();
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class HookEvent extends Event<void> {
 }
+/**
+ * The CommitHookEvent class is the superclass for all events emitting in relation to commit hooks.
+ *
+ * :::warning Warning
+ * It is not a good practice to create an event from this class directly,
+ * but should rather create one from one of the subclasses.
+ * This promotes a more accurate classification of events.
+ * :::
+ *
+ * @example
+ * ```ts
+ * const myEvent = new CommitHookEvent();
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class CommitHookEvent extends HookEvent {
 }
+/**
+ * The ModelActionHookEvent class is the superclass for all events emitting in relation to model action hooks.
+ *
+ * :::warning Warning
+ * It is not a good practice to create an event from this class directly,
+ * but should rather create one from one of the subclasses.
+ * This promotes a more accurate classification of events.
+ * :::
+ *
+ * @example
+ * ```ts
+ * const myEvent = new ModelActionHookEvent();
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class ModelActionHookEvent extends HookEvent {
 }
+/**
+ * The ResourceActionHookEvent class is the superclass for all events emitting in relation to resource action hooks.
+ *
+ * :::warning Warning
+ * It is not a good practice to create an event from this class directly,
+ * but should rather create one from one of the subclasses.
+ * This promotes a more accurate classification of events.
+ * :::
+ *
+ * @example
+ * ```ts
+ * const myEvent = new ResourceActionHookEvent();
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class ResourceActionHookEvent extends HookEvent {
 }
+/**
+ * This hook event is emitted when the base decorated method is done executing.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new CommitHookCallbackDoneEvent();
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class CommitHookCallbackDoneEvent extends CommitHookEvent {
 }
+/**
+ * This hook event is emitted when the base decorated method is done executing.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new ModelActionHookCallbackDoneEvent();
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class ModelActionHookCallbackDoneEvent extends ModelActionHookEvent {
 }
+/**
+ * This hook event is emitted when the base decorated method is done executing.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new ResourceActionHookCallbackDoneEvent();
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class ResourceActionHookCallbackDoneEvent extends ResourceActionHookEvent {
 }
+/**
+ * This hook event is emitted when a post-commit hook callback is done executing.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new PostCommitHookCallbackDoneEvent();
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class PostCommitHookCallbackDoneEvent extends CommitHookEvent {
 }
+/**
+ * This hook event is emitted when a post-model action hook callback is done executing.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new PostModelActionHookCallbackDoneEvent();
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class PostModelActionHookCallbackDoneEvent extends ModelActionHookEvent {
 }
+/**
+ * This hook event is emitted when a post-resource action hook callback is done executing.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new PostResourceActionHookCallbackDoneEvent();
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class PostResourceActionHookCallbackDoneEvent extends ResourceActionHookEvent {
 }
+/**
+ * This hook event is emitted when a pre-commit hook callback is done executing.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new PreCommitHookCallbackDoneEvent();
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class PreCommitHookCallbackDoneEvent extends CommitHookEvent {
 }
+/**
+ * This hook event is emitted when a pre-model action hook callback is done executing.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new PreModelActionHookCallbackDoneEvent();
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class PreModelActionHookCallbackDoneEvent extends ModelActionHookEvent {
 }
+/**
+ * This hook event is emitted when a pre-resource action hook callback is done executing.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new PreResourceActionHookCallbackDoneEvent();
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
 export declare class PreResourceActionHookCallbackDoneEvent extends ResourceActionHookEvent {
 }