@quadnix/octo 0.0.20 → 0.0.21

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 {
 }

package/dist/events/hook.event.js

@@ -1,28 +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

@@ -1 +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,MAAM,OAAO,SAAU,SAAQ,KAAW;CAAG;AAE7C,MAAM,OAAO,eAAgB,SAAQ,SAAS;CAAG;AAEjD,MAAM,OAAO,oBAAqB,SAAQ,SAAS;CAAG;AAEtD,MAAM,OAAO,uBAAwB,SAAQ,SAAS;CAAG;AAEzD,MAAM,OAAO,2BAA4B,SAAQ,eAAe;CAAG;AAEnE,MAAM,OAAO,gCAAiC,SAAQ,oBAAoB;CAAG;AAE7E,MAAM,OAAO,mCAAoC,SAAQ,uBAAuB;CAAG;AAEnF,MAAM,OAAO,+BAAgC,SAAQ,eAAe;CAAG;AAEvE,MAAM,OAAO,oCAAqC,SAAQ,oBAAoB;CAAG;AAEjF,MAAM,OAAO,uCAAwC,SAAQ,uBAAuB;CAAG;AAEvF,MAAM,OAAO,8BAA+B,SAAQ,eAAe;CAAG;AAEtE,MAAM,OAAO,mCAAoC,SAAQ,oBAAoB;CAAG;AAEhF,MAAM,OAAO,sCAAuC,SAAQ,uBAAuB;CAAG"}
+{"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

@@ -1,3 +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

@@ -1,4 +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

@@ -1 +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,MAAM,OAAO,WAAY,SAAQ,KAAa;CAAG"}
+{"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

@@ -1,22 +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;
 }

package/dist/events/registration.event.js

@@ -3,8 +3,37 @@ import { AAnchor } from '../overlays/anchor.abstract.js';
 import { AOverlay } from '../overlays/overlay.abstract.js';
 import { AResource } from '../resources/resource.abstract.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 class RegistrationEvent extends Event {
 }
+/**
+ * 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 class AnchorRegistrationEvent extends RegistrationEvent {
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
@@ -17,6 +46,18 @@ export class AnchorRegistrationEvent extends RegistrationEvent {
         };
     }
 }
+/**
+ * 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 class ModelActionRegistrationEvent extends RegistrationEvent {
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
@@ -29,6 +70,18 @@ export class ModelActionRegistrationEvent extends RegistrationEvent {
         };
     }
 }
+/**
+ * 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 class ModelRegistrationEvent extends RegistrationEvent {
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
@@ -41,6 +94,18 @@ export class ModelRegistrationEvent extends RegistrationEvent {
         };
     }
 }
+/**
+ * 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 class OverlayRegistrationEvent extends RegistrationEvent {
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
@@ -53,6 +118,19 @@ export class OverlayRegistrationEvent extends RegistrationEvent {
         };
     }
 }
+/**
+ * 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 class ResourceActionRegistrationEvent extends RegistrationEvent {
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
@@ -65,6 +143,18 @@ export class ResourceActionRegistrationEvent extends RegistrationEvent {
         };
     }
 }
+/**
+ * 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 class ResourceRegistrationEvent extends RegistrationEvent {
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;

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

@@ -1 +1 @@
-{"version":3,"file":"registration.event.js","sourceRoot":"","sources":["../../src/events/registration.event.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAE9D,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,MAAM,OAAO,iBAAkB,SAAQ,KAAa;CAAG;AAEvD,MAAM,OAAO,uBAAwB,SAAQ,iBAAiB;IAC5D,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAsC;YACpE,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,OAAO,EAAE,CAAC;gBACzC,MAAM,KAAK,GAAG,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBACxD,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,4BAA6B,SAAQ,iBAAiB;IACjE,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAsB;YACpD,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7B,MAAM,KAAK,GAAG,IAAI,4BAA4B,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;gBACnE,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,iBAAiB;IAC3D,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAsC;YACpE,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,MAAM,EAAE,CAAC;gBACxC,MAAM,KAAK,GAAG,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBACvD,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,wBAAyB,SAAQ,iBAAiB;IAC7D,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAsC;YACpE,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,QAAQ,EAAE,CAAC;gBAC1C,MAAM,KAAK,GAAG,IAAI,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBACzD,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,+BAAgC,SAAQ,iBAAiB;IACpE,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAyB;YACvD,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7B,MAAM,KAAK,GAAG,IAAI,+BAA+B,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;gBACtE,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,iBAAiB;IAC9D,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAsC;YACpE,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,SAAS,EAAE,CAAC;gBAC3C,MAAM,KAAK,GAAG,IAAI,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBAC1D,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"registration.event.js","sourceRoot":"","sources":["../../src/events/registration.event.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAE9D,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,iBAAkB,SAAQ,KAAa;CAAG;AAEvD;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,uBAAwB,SAAQ,iBAAiB;IAC5D,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAsC;YACpE,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,OAAO,EAAE,CAAC;gBACzC,MAAM,KAAK,GAAG,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBACxD,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,4BAA6B,SAAQ,iBAAiB;IACjE,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAsB;YACpD,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7B,MAAM,KAAK,GAAG,IAAI,4BAA4B,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;gBACnE,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,sBAAuB,SAAQ,iBAAiB;IAC3D,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAsC;YACpE,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,MAAM,EAAE,CAAC;gBACxC,MAAM,KAAK,GAAG,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBACvD,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,wBAAyB,SAAQ,iBAAiB;IAC7D,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAsC;YACpE,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,QAAQ,EAAE,CAAC;gBAC1C,MAAM,KAAK,GAAG,IAAI,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBACzD,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,+BAAgC,SAAQ,iBAAiB;IACpE,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAyB;YACvD,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7B,MAAM,KAAK,GAAG,IAAI,+BAA+B,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;gBACtE,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,yBAA0B,SAAQ,iBAAiB;IAC9D,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAsC;YACpE,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,SAAS,EAAE,CAAC;gBAC3C,MAAM,KAAK,GAAG,IAAI,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBAC1D,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF"}