@quadnix/octo 0.0.29 → 0.1.0

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

@@ -3,8 +3,6 @@ import { HookEvent } from './hook.event.js';
  * The CommitHookEvent class is the superclass for all events emitting in relation to commit hooks.
  *
  * @group Events/Hooks/Commit
- *
- * @returns The Event instance.
  */
 export declare class CommitHookEvent extends HookEvent {
 }
@@ -12,8 +10,6 @@ export declare class CommitHookEvent extends HookEvent {
  * This hook event is emitted when a post-commit hook callback is done executing.
  *
  * @group Events/Hooks/Commit
- *
- * @returns The Event instance.
  */
 export declare class PostCommitHookCallbackDoneEvent extends CommitHookEvent {
 }
@@ -21,8 +17,6 @@ export declare class PostCommitHookCallbackDoneEvent extends CommitHookEvent {
  * This hook event is emitted when a pre-commit hook callback is done executing.
  *
  * @group Events/Hooks/Commit
- *
- * @returns The Event instance.
  */
 export declare class PreCommitHookCallbackDoneEvent extends CommitHookEvent {
 }

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

@@ -3,8 +3,6 @@ import { HookEvent } from './hook.event.js';
  * The CommitHookEvent class is the superclass for all events emitting in relation to commit hooks.
  *
  * @group Events/Hooks/Commit
- *
- * @returns The Event instance.
  */
 export class CommitHookEvent extends HookEvent {
 }
@@ -12,8 +10,6 @@ export class CommitHookEvent extends HookEvent {
  * This hook event is emitted when a post-commit hook callback is done executing.
  *
  * @group Events/Hooks/Commit
- *
- * @returns The Event instance.
  */
 export class PostCommitHookCallbackDoneEvent extends CommitHookEvent {
 }
@@ -21,8 +17,6 @@ export class PostCommitHookCallbackDoneEvent extends CommitHookEvent {
  * This hook event is emitted when a pre-commit hook callback is done executing.
  *
  * @group Events/Hooks/Commit
- *
- * @returns The Event instance.
  */
 export class PreCommitHookCallbackDoneEvent extends CommitHookEvent {
 }

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

@@ -1 +1 @@
-{"version":3,"file":"commit.hook.event.js","sourceRoot":"","sources":["../../../src/events/hook/commit.hook.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;CAAG;AAEjD;;;;;;GAMG;AACH,MAAM,OAAO,+BAAgC,SAAQ,eAAe;CAAG;AAEvE;;;;;;GAMG;AACH,MAAM,OAAO,8BAA+B,SAAQ,eAAe;CAAG"}
+{"version":3,"file":"commit.hook.event.js","sourceRoot":"","sources":["../../../src/events/hook/commit.hook.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C;;;;GAIG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;CAAG;AAEjD;;;;GAIG;AACH,MAAM,OAAO,+BAAgC,SAAQ,eAAe;CAAG;AAEvE;;;;GAIG;AACH,MAAM,OAAO,8BAA+B,SAAQ,eAAe;CAAG"}

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

@@ -3,8 +3,6 @@ import { Event } from '../event.model.js';
  * The HookEvent class is the superclass for all events emitting in relation to hooks.
  *
  * @group Events/Hooks
- *
- * @returns The Event instance.
  */
 export declare class HookEvent extends Event<void> {
 }

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

@@ -3,8 +3,6 @@ import { Event } from '../event.model.js';
  * The HookEvent class is the superclass for all events emitting in relation to hooks.
  *
  * @group Events/Hooks
- *
- * @returns The Event instance.
  */
 export class HookEvent extends Event {
 }

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

@@ -1 +1 @@
-{"version":3,"file":"hook.event.js","sourceRoot":"","sources":["../../../src/events/hook/hook.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE1C;;;;;;GAMG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAW;CAAG"}
+{"version":3,"file":"hook.event.js","sourceRoot":"","sources":["../../../src/events/hook/hook.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE1C;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAW;CAAG"}

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

@@ -3,8 +3,6 @@ import { HookEvent } from './hook.event.js';
  * The ModelActionHookEvent class is the superclass for all events emitting in relation to model action hooks.
  *
  * @group Events/Hooks/Model
- *
- * @returns The Event instance.
  */
 export declare class ModelActionHookEvent extends HookEvent {
 }
@@ -12,8 +10,6 @@ export declare class ModelActionHookEvent extends HookEvent {
  * This hook event is emitted when a post-model action hook callback is done executing.
  *
  * @group Events/Hooks/Model
- *
- * @returns The Event instance.
  */
 export declare class PostModelActionHookCallbackDoneEvent extends ModelActionHookEvent {
 }
@@ -21,8 +17,6 @@ export declare class PostModelActionHookCallbackDoneEvent extends ModelActionHoo
  * This hook event is emitted when a pre-model action hook callback is done executing.
  *
  * @group Events/Hooks/Model
- *
- * @returns The Event instance.
  */
 export declare class PreModelActionHookCallbackDoneEvent extends ModelActionHookEvent {
 }

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

@@ -3,8 +3,6 @@ import { HookEvent } from './hook.event.js';
  * The ModelActionHookEvent class is the superclass for all events emitting in relation to model action hooks.
  *
  * @group Events/Hooks/Model
- *
- * @returns The Event instance.
  */
 export class ModelActionHookEvent extends HookEvent {
 }
@@ -12,8 +10,6 @@ export class ModelActionHookEvent extends HookEvent {
  * This hook event is emitted when a post-model action hook callback is done executing.
  *
  * @group Events/Hooks/Model
- *
- * @returns The Event instance.
  */
 export class PostModelActionHookCallbackDoneEvent extends ModelActionHookEvent {
 }
@@ -21,8 +17,6 @@ export class PostModelActionHookCallbackDoneEvent extends ModelActionHookEvent {
  * This hook event is emitted when a pre-model action hook callback is done executing.
  *
  * @group Events/Hooks/Model
- *
- * @returns The Event instance.
  */
 export class PreModelActionHookCallbackDoneEvent extends ModelActionHookEvent {
 }

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

@@ -1 +1 @@
-{"version":3,"file":"model.hook.event.js","sourceRoot":"","sources":["../../../src/events/hook/model.hook.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,OAAO,oBAAqB,SAAQ,SAAS;CAAG;AAEtD;;;;;;GAMG;AACH,MAAM,OAAO,oCAAqC,SAAQ,oBAAoB;CAAG;AAEjF;;;;;;GAMG;AACH,MAAM,OAAO,mCAAoC,SAAQ,oBAAoB;CAAG"}
+{"version":3,"file":"model.hook.event.js","sourceRoot":"","sources":["../../../src/events/hook/model.hook.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C;;;;GAIG;AACH,MAAM,OAAO,oBAAqB,SAAQ,SAAS;CAAG;AAEtD;;;;GAIG;AACH,MAAM,OAAO,oCAAqC,SAAQ,oBAAoB;CAAG;AAEjF;;;;GAIG;AACH,MAAM,OAAO,mCAAoC,SAAQ,oBAAoB;CAAG"}

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

@@ -3,8 +3,6 @@ import { HookEvent } from './hook.event.js';
  * The ResourceActionHookEvent class is the superclass for all events emitting in relation to resource action hooks.
  *
  * @group Events/Hooks/Resource
- *
- * @returns The Event instance.
  */
 export declare class ResourceActionHookEvent extends HookEvent {
 }
@@ -12,8 +10,6 @@ export declare class ResourceActionHookEvent extends HookEvent {
  * This hook event is emitted when a post-resource action hook callback is done executing.
  *
  * @group Events/Hooks/Resource
- *
- * @returns The Event instance.
  */
 export declare class PostResourceActionHookCallbackDoneEvent extends ResourceActionHookEvent {
 }
@@ -21,8 +17,6 @@ export declare class PostResourceActionHookCallbackDoneEvent extends ResourceAct
  * This hook event is emitted when a pre-resource action hook callback is done executing.
  *
  * @group Events/Hooks/Resource
- *
- * @returns The Event instance.
  */
 export declare class PreResourceActionHookCallbackDoneEvent extends ResourceActionHookEvent {
 }

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

@@ -3,8 +3,6 @@ import { HookEvent } from './hook.event.js';
  * The ResourceActionHookEvent class is the superclass for all events emitting in relation to resource action hooks.
  *
  * @group Events/Hooks/Resource
- *
- * @returns The Event instance.
  */
 export class ResourceActionHookEvent extends HookEvent {
 }
@@ -12,8 +10,6 @@ export class ResourceActionHookEvent extends HookEvent {
  * This hook event is emitted when a post-resource action hook callback is done executing.
  *
  * @group Events/Hooks/Resource
- *
- * @returns The Event instance.
  */
 export class PostResourceActionHookCallbackDoneEvent extends ResourceActionHookEvent {
 }
@@ -21,8 +17,6 @@ export class PostResourceActionHookCallbackDoneEvent extends ResourceActionHookE
  * This hook event is emitted when a pre-resource action hook callback is done executing.
  *
  * @group Events/Hooks/Resource
- *
- * @returns The Event instance.
  */
 export class PreResourceActionHookCallbackDoneEvent extends ResourceActionHookEvent {
 }

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

@@ -1 +1 @@
-{"version":3,"file":"resource.hook.event.js","sourceRoot":"","sources":["../../../src/events/hook/resource.hook.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,OAAO,uBAAwB,SAAQ,SAAS;CAAG;AAEzD;;;;;;GAMG;AACH,MAAM,OAAO,uCAAwC,SAAQ,uBAAuB;CAAG;AAEvF;;;;;;GAMG;AACH,MAAM,OAAO,sCAAuC,SAAQ,uBAAuB;CAAG"}
+{"version":3,"file":"resource.hook.event.js","sourceRoot":"","sources":["../../../src/events/hook/resource.hook.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C;;;;GAIG;AACH,MAAM,OAAO,uBAAwB,SAAQ,SAAS;CAAG;AAEzD;;;;GAIG;AACH,MAAM,OAAO,uCAAwC,SAAQ,uBAAuB;CAAG;AAEvF;;;;GAIG;AACH,MAAM,OAAO,sCAAuC,SAAQ,uBAAuB;CAAG"}

package/dist/events/index.d.ts

@@ -1,7 +1,10 @@
 export * from './action.event.js';
 export * from './event.model.js';
 export * from './hook/index.js';
+export * from './mode.event.js';
+export * from './mode-result.event.js';
 export * from './module.event.js';
 export * from './registration.event.js';
 export * from './serialization.event.js';
+export * from './terraform.event.js';
 export * from './transaction.event.js';

package/dist/events/index.js

@@ -1,8 +1,11 @@
 export * from './action.event.js';
 export * from './event.model.js';
 export * from './hook/index.js';
+export * from './mode.event.js';
+export * from './mode-result.event.js';
 export * from './module.event.js';
 export * from './registration.event.js';
 export * from './serialization.event.js';
+export * from './terraform.event.js';
 export * from './transaction.event.js';
 //# sourceMappingURL=index.js.map

package/dist/events/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC"}

package/dist/events/mode-result.event.d.ts

@@ -0,0 +1,57 @@
+import type { AggregatedResourceAction } from '../functions/diff/aggregate-resource-actions.js';
+import type { ValidateReport } from '../modes/validate.mode.js';
+import { Event } from './event.model.js';
+/**
+ * The ModeResultEvent class is the superclass for all events carrying what a mode concluded.
+ *
+ * @group Events/ModeResult
+ */
+export declare class ModeResultEvent<T> extends Event<T> {
+}
+/**
+ * This event is emitted when `validate` has correlated terraform's plans with octo's intent.
+ * The payload is the {@link ValidateReport} that `validate` returns to its caller.
+ *
+ * @group Events/ModeResult
+ */
+export declare class ValidateModeCompletedEvent extends ModeResultEvent<{
+    report: ValidateReport;
+}> {
+}
+/**
+ * This event is emitted when `commit` has recorded a terraform apply back into octo state.
+ *
+ * @group Events/ModeResult
+ */
+export declare class CommitModeCompletedEvent extends ModeResultEvent<{
+    /**
+     * Modules whose folders were written without resources, because they left intent.
+     */
+    emptiedModuleIds: string[];
+    /**
+     * Each octo resource this commit applied, with the terraform addresses it renders.
+     * Carries no terraform actions - `commit` runs after the apply, so it has no plan to read.
+     */
+    resources: {
+        action: AggregatedResourceAction['action'];
+        moduleId?: string;
+        reason?: string;
+        resourceContext: string;
+        resourceId: string;
+        terraformAddresses: string[];
+    }[];
+    /**
+     * Every response key written onto a resource from a terraform output, with the value it replaced.
+     */
+    responses: {
+        key: string;
+        previousValue?: string;
+        resourceContext: string;
+        value: string;
+    }[];
+    warnings: {
+        message: string;
+        moduleId?: string;
+    }[];
+}> {
+}

package/dist/events/mode-result.event.js

@@ -0,0 +1,24 @@
+import { Event } from './event.model.js';
+/**
+ * The ModeResultEvent class is the superclass for all events carrying what a mode concluded.
+ *
+ * @group Events/ModeResult
+ */
+export class ModeResultEvent extends Event {
+}
+/**
+ * This event is emitted when `validate` has correlated terraform's plans with octo's intent.
+ * The payload is the {@link ValidateReport} that `validate` returns to its caller.
+ *
+ * @group Events/ModeResult
+ */
+export class ValidateModeCompletedEvent extends ModeResultEvent {
+}
+/**
+ * This event is emitted when `commit` has recorded a terraform apply back into octo state.
+ *
+ * @group Events/ModeResult
+ */
+export class CommitModeCompletedEvent extends ModeResultEvent {
+}
+//# sourceMappingURL=mode-result.event.js.map

package/dist/events/mode-result.event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mode-result.event.js","sourceRoot":"","sources":["../../src/events/mode-result.event.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;GAIG;AACH,MAAM,OAAO,eAAmB,SAAQ,KAAQ;CAAG;AAEnD;;;;;GAKG;AACH,MAAM,OAAO,0BAA2B,SAAQ,eAA2C;CAAG;AAE9F;;;;GAIG;AACH,MAAM,OAAO,wBAAyB,SAAQ,eAyB5C;CAAG"}

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

@@ -0,0 +1,57 @@
+import { Event } from './event.model.js';
+/**
+ * The steps of the octo lifecycle.
+ *
+ * @group Events/Mode
+ */
+export type OctoMode = 'commit' | 'generate' | 'run-action' | 'validate';
+/**
+ * What every {@link ModeEvent} carries.
+ *
+ * @group Events/Mode
+ */
+export interface ModeEventPayload {
+    /**
+     * Absent in `run-action`, which does not load an app.
+     */
+    appName?: string;
+    /**
+     * The mode this event is about.
+     */
+    mode: OctoMode;
+}
+/**
+ * The ModeEvent class is the superclass for all events marking the boundaries of an octo lifecycle mode.
+ *
+ * @group Events/Mode
+ */
+export declare class ModeEvent<T extends ModeEventPayload = ModeEventPayload> extends Event<T> {
+}
+/**
+ * This event is emitted when a mode begins, before any work is done.
+ *
+ * @group Events/Mode
+ */
+export declare class ModeStartedEvent extends ModeEvent {
+}
+/**
+ * This event is emitted when a mode completes successfully.
+ * A listener that returns a promise is awaited, so it can finish writing before the process exits.
+ *
+ * @group Events/Mode
+ */
+export declare class ModeFinishedEvent extends ModeEvent<ModeEventPayload & {
+    durationInMs: number;
+}> {
+}
+/**
+ * This event is emitted when a mode throws. The error is also re-thrown to the caller.
+ * A listener that returns a promise is awaited, so it can finish writing before the process exits.
+ *
+ * @group Events/Mode
+ */
+export declare class ModeFailedEvent extends ModeEvent<ModeEventPayload & {
+    durationInMs: number;
+    error: string;
+}> {
+}

package/dist/events/mode.event.js

@@ -0,0 +1,32 @@
+import { Event } from './event.model.js';
+/**
+ * The ModeEvent class is the superclass for all events marking the boundaries of an octo lifecycle mode.
+ *
+ * @group Events/Mode
+ */
+export class ModeEvent extends Event {
+}
+/**
+ * This event is emitted when a mode begins, before any work is done.
+ *
+ * @group Events/Mode
+ */
+export class ModeStartedEvent extends ModeEvent {
+}
+/**
+ * This event is emitted when a mode completes successfully.
+ * A listener that returns a promise is awaited, so it can finish writing before the process exits.
+ *
+ * @group Events/Mode
+ */
+export class ModeFinishedEvent extends ModeEvent {
+}
+/**
+ * This event is emitted when a mode throws. The error is also re-thrown to the caller.
+ * A listener that returns a promise is awaited, so it can finish writing before the process exits.
+ *
+ * @group Events/Mode
+ */
+export class ModeFailedEvent extends ModeEvent {
+}
+//# sourceMappingURL=mode.event.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mode.event.js","sourceRoot":"","sources":["../../src/events/mode.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AA0BzC;;;;GAIG;AACH,MAAM,OAAO,SAAyD,SAAQ,KAAQ;CAAG;AAEzF;;;;GAIG;AACH,MAAM,OAAO,gBAAiB,SAAQ,SAAS;CAAG;AAElD;;;;;GAKG;AACH,MAAM,OAAO,iBAAkB,SAAQ,SAAsD;CAAG;AAEhG;;;;;GAKG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAqE;CAAG"}

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

@@ -4,8 +4,6 @@ import { Event } from './event.model.js';
  * It emits the name of the module.
  *
  * @group Events/Module
- *
- * @returns The Event instance.
  */
 export declare class ModuleEvent extends Event<void> {
 }

package/dist/events/module.event.js

@@ -4,8 +4,6 @@ import { Event } from './event.model.js';
  * It emits the name of the module.
  *
  * @group Events/Module
- *
- * @returns The Event instance.
  */
 export class ModuleEvent extends Event {
 }

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;;;;;;;GAOG;AACH,MAAM,OAAO,WAAY,SAAQ,KAAW;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;;;;;GAKG;AACH,MAAM,OAAO,WAAY,SAAQ,KAAW;CAAG"}

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

@@ -4,8 +4,6 @@ import { Event } from './event.model.js';
  * The RegistrationEvent class is the superclass for all events in relation to class registration.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export declare class RegistrationEvent extends Event<void> {
 }
@@ -14,10 +12,11 @@ export declare class RegistrationEvent extends Event<void> {
  * It emits the name of the class.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export declare class AnchorRegistrationEvent extends RegistrationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
 }
 /**
@@ -25,10 +24,11 @@ export declare class AnchorRegistrationEvent extends RegistrationEvent {
  * It emits the name of the model class and the name of the action.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export declare class ModelActionRegistrationEvent extends RegistrationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
 }
 /**
@@ -36,10 +36,11 @@ export declare class ModelActionRegistrationEvent extends RegistrationEvent {
  * It emits the name of the class.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export declare class ModelRegistrationEvent extends RegistrationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
 }
 /**
@@ -47,10 +48,11 @@ export declare class ModelRegistrationEvent extends RegistrationEvent {
  * It emits the name of the class.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export declare class OverlayRegistrationEvent extends RegistrationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
 }
 /**
@@ -58,10 +60,11 @@ export declare class OverlayRegistrationEvent extends RegistrationEvent {
  * It emits the name of the resource class and the name of the action.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export declare class ResourceActionRegistrationEvent extends RegistrationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
 }
 /**
@@ -69,9 +72,10 @@ export declare class ResourceActionRegistrationEvent extends RegistrationEvent {
  * It emits the name of the class.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export declare class ResourceRegistrationEvent extends RegistrationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
 }

package/dist/events/registration.event.js

@@ -7,8 +7,6 @@ import { Event } from './event.model.js';
  * The RegistrationEvent class is the superclass for all events in relation to class registration.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export class RegistrationEvent extends Event {
 }
@@ -17,10 +15,11 @@ export class RegistrationEvent extends Event {
  * It emits the name of the class.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export class AnchorRegistrationEvent extends RegistrationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
         descriptor.value = function (...args) {
@@ -36,10 +35,11 @@ export class AnchorRegistrationEvent extends RegistrationEvent {
  * It emits the name of the model class and the name of the action.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export class ModelActionRegistrationEvent extends RegistrationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
         descriptor.value = function (...args) {
@@ -55,10 +55,11 @@ export class ModelActionRegistrationEvent extends RegistrationEvent {
  * It emits the name of the class.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export class ModelRegistrationEvent extends RegistrationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
         descriptor.value = function (...args) {
@@ -74,10 +75,11 @@ export class ModelRegistrationEvent extends RegistrationEvent {
  * It emits the name of the class.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export class OverlayRegistrationEvent extends RegistrationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
         descriptor.value = function (...args) {
@@ -93,10 +95,11 @@ export class OverlayRegistrationEvent extends RegistrationEvent {
  * It emits the name of the resource class and the name of the action.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export class ResourceActionRegistrationEvent extends RegistrationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
         descriptor.value = function (...args) {
@@ -112,10 +115,11 @@ export class ResourceActionRegistrationEvent extends RegistrationEvent {
  * It emits the name of the class.
  *
  * @group Events/Registration
- *
- * @returns The Event instance.
  */
 export class ResourceRegistrationEvent extends RegistrationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
         descriptor.value = function (...args) {

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

@@ -1 +1 @@
-{"version":3,"file":"registration.event.js","sourceRoot":"","sources":["../../src/events/registration.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAK9D,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;;;GAMG;AACH,MAAM,OAAO,iBAAkB,SAAQ,KAAW;CAAG;AAErD;;;;;;;GAOG;AACH,MAAM,OAAO,uBAAwB,SAAQ,iBAAiB;IAC5D,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE0C,UAAU,CAAC,KAAK,CAAC;QAE/E,UAAU,CAAC,KAAK,GAAG,UACjB,GAAG,IAA4D;YAE/D,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,OAAO,EAAE,CAAC;gBACzC,YAAY,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,4BAA6B,SAAQ,iBAAiB;IACjE,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAQlF,MAAM,cAAc,GAAoD,UAAU,CAAC,KAAK,CAAC;QAEzF,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,YAAY,CAAC,IAAI,CAAC,IAAI,4BAA4B,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YACpG,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,sBAAuB,SAAQ,iBAAiB;IAC3D,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE0C,UAAU,CAAC,KAAK,CAAC;QAE/E,UAAU,CAAC,KAAK,GAAG,UACjB,GAAG,IAA4D;YAE/D,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,MAAM,EAAE,CAAC;gBACxC,YAAY,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACzD,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,wBAAyB,SAAQ,iBAAiB;IAC7D,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE0C,UAAU,CAAC,KAAK,CAAC;QAE/E,UAAU,CAAC,KAAK,GAAG,UACjB,GAAG,IAA4D;YAE/D,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,QAAQ,EAAE,CAAC;gBAC1C,YAAY,CAAC,IAAI,CAAC,IAAI,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,+BAAgC,SAAQ,iBAAiB;IACpE,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE6C,UAAU,CAAC,KAAK,CAAC;QAElF,UAAU,CAAC,KAAK,GAAG,UACjB,GAAG,IAA+D;YAElE,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7B,YAAY,CAAC,IAAI,CAAC,IAAI,+BAA+B,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YACvG,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,yBAA0B,SAAQ,iBAAiB;IAC9D,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE6C,UAAU,CAAC,KAAK,CAAC;QAElF,UAAU,CAAC,KAAK,GAAG,UACjB,GAAG,IAA+D;YAElE,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,SAAS,EAAE,CAAC;gBAC3C,YAAY,CAAC,IAAI,CAAC,IAAI,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"registration.event.js","sourceRoot":"","sources":["../../src/events/registration.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAK9D,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;GAIG;AACH,MAAM,OAAO,iBAAkB,SAAQ,KAAW;CAAG;AAErD;;;;;GAKG;AACH,MAAM,OAAO,uBAAwB,SAAQ,iBAAiB;IAC5D;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE0C,UAAU,CAAC,KAAK,CAAC;QAE/E,UAAU,CAAC,KAAK,GAAG,UACjB,GAAG,IAA4D;YAE/D,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,OAAO,EAAE,CAAC;gBACzC,YAAY,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,4BAA6B,SAAQ,iBAAiB;IACjE;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAQlF,MAAM,cAAc,GAAoD,UAAU,CAAC,KAAK,CAAC;QAEzF,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,YAAY,CAAC,IAAI,CAAC,IAAI,4BAA4B,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YACpG,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,sBAAuB,SAAQ,iBAAiB;IAC3D;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE0C,UAAU,CAAC,KAAK,CAAC;QAE/E,UAAU,CAAC,KAAK,GAAG,UACjB,GAAG,IAA4D;YAE/D,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,MAAM,EAAE,CAAC;gBACxC,YAAY,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACzD,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,wBAAyB,SAAQ,iBAAiB;IAC7D;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE0C,UAAU,CAAC,KAAK,CAAC;QAE/E,UAAU,CAAC,KAAK,GAAG,UACjB,GAAG,IAA4D;YAE/D,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,QAAQ,EAAE,CAAC;gBAC1C,YAAY,CAAC,IAAI,CAAC,IAAI,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,+BAAgC,SAAQ,iBAAiB;IACpE;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE6C,UAAU,CAAC,KAAK,CAAC;QAElF,UAAU,CAAC,KAAK,GAAG,UACjB,GAAG,IAA+D;YAElE,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7B,YAAY,CAAC,IAAI,CAAC,IAAI,+BAA+B,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YACvG,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,yBAA0B,SAAQ,iBAAiB;IAC9D;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE6C,UAAU,CAAC,KAAK,CAAC;QAElF,UAAU,CAAC,KAAK,GAAG,UACjB,GAAG,IAA+D;YAElE,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,SAAS,EAAE,CAAC;gBAC3C,YAAY,CAAC,IAAI,CAAC,IAAI,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF"}