@quadnix/octo 0.0.19 → 0.0.21

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

@@ -0,0 +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 {
+}

package/dist/events/hook.event.js

@@ -0,0 +1,195 @@
+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 class HookEvent extends Event {
+}
+/**
+ * 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 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 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 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 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 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 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 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 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 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 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 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 class PreResourceActionHookCallbackDoneEvent extends ResourceActionHookEvent {
+}
+//# sourceMappingURL=hook.event.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hook.event.js","sourceRoot":"","sources":["../../src/events/hook.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAW;CAAG;AAE7C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;CAAG;AAEjD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,oBAAqB,SAAQ,SAAS;CAAG;AAEtD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,uBAAwB,SAAQ,SAAS;CAAG;AAEzD;;;;;;;;;;GAUG;AACH,MAAM,OAAO,2BAA4B,SAAQ,eAAe;CAAG;AAEnE;;;;;;;;;;GAUG;AACH,MAAM,OAAO,gCAAiC,SAAQ,oBAAoB;CAAG;AAE7E;;;;;;;;;;GAUG;AACH,MAAM,OAAO,mCAAoC,SAAQ,uBAAuB;CAAG;AAEnF;;;;;;;;;;GAUG;AACH,MAAM,OAAO,+BAAgC,SAAQ,eAAe;CAAG;AAEvE;;;;;;;;;;GAUG;AACH,MAAM,OAAO,oCAAqC,SAAQ,oBAAoB;CAAG;AAEjF;;;;;;;;;;GAUG;AACH,MAAM,OAAO,uCAAwC,SAAQ,uBAAuB;CAAG;AAEvF;;;;;;;;;;GAUG;AACH,MAAM,OAAO,8BAA+B,SAAQ,eAAe;CAAG;AAEtE;;;;;;;;;;GAUG;AACH,MAAM,OAAO,mCAAoC,SAAQ,oBAAoB;CAAG;AAEhF;;;;;;;;;;GAUG;AACH,MAAM,OAAO,sCAAuC,SAAQ,uBAAuB;CAAG"}

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

@@ -0,0 +1,15 @@
+import { Event } from './event.model.js';
+/**
+ * This event is emitted when a module's `onInit()` method is run.
+ * It emits the name of the module.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new ModuleEvent('MyModule');
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
+export declare class ModuleEvent extends Event<string> {
+}

package/dist/events/module.event.js

@@ -0,0 +1,16 @@
+import { Event } from './event.model.js';
+/**
+ * This event is emitted when a module's `onInit()` method is run.
+ * It emits the name of the module.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new ModuleEvent('MyModule');
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
+export class ModuleEvent extends Event {
+}
+//# sourceMappingURL=module.event.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"module.event.js","sourceRoot":"","sources":["../../src/events/module.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,WAAY,SAAQ,KAAa;CAAG"}

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

@@ -0,0 +1,112 @@
+import type { EventService } from '../services/event/event.service.js';
+import { Event } from './event.model.js';
+/**
+ * The RegistrationEvent class is the superclass for all events in relation to class registration.
+ *
+ * :::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 RegistrationEvent('MyClass');
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
+export declare class RegistrationEvent extends Event<string> {
+}
+/**
+ * This event is emitted when a class with `@Anchor()` decorator is registered.
+ * It emits the name of the class.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new AnchorRegistrationEvent('MyClass');
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
+export declare class AnchorRegistrationEvent extends RegistrationEvent {
+    static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
+}
+/**
+ * This event is emitted when a class with `@Action(ModelType.MODEL)` decorator is registered.
+ * It emits the name of the class.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new ModelActionRegistrationEvent('MyClass');
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
+export declare class ModelActionRegistrationEvent extends RegistrationEvent {
+    static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
+}
+/**
+ * This event is emitted when a class with `@Model()` decorator is registered.
+ * It emits the name of the class.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new ModelRegistrationEvent('MyClass');
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
+export declare class ModelRegistrationEvent extends RegistrationEvent {
+    static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
+}
+/**
+ * This event is emitted when a class with `@Overlay()` decorator is registered.
+ * It emits the name of the class.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new OverlayRegistrationEvent('MyClass');
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
+export declare class OverlayRegistrationEvent extends RegistrationEvent {
+    static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
+}
+/**
+ * This event is emitted when a class with `@Action(ModelType.RESOURCE)` or `@Action(ModelType.SHARED_RESOURCE)`
+ * decorator is registered.
+ * It emits the name of the class.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new ResourceActionRegistrationEvent('MyClass');
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
+export declare class ResourceActionRegistrationEvent extends RegistrationEvent {
+    static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
+}
+/**
+ * This event is emitted when a class with `@Resource()` decorator is registered.
+ * It emits the name of the class.
+ *
+ * @example
+ * ```ts
+ * const myEvent = new ResourceRegistrationEvent('MyClass');
+ * EventService.getInstance().emit(myEvent);
+ * ```
+ * @group Events
+ * @returns The Event instance.
+ */
+export declare class ResourceRegistrationEvent extends RegistrationEvent {
+    static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
+}