@quadnix/octo 0.0.30 → 0.2.0

package/dist/events/module.event.js

@@ -1,11 +1,10 @@
 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.
+ * This event is emitted when a module's `onInit()` method is run, once for every module id, with the
+ * inputs it ran with: the definition's values, references resolved, and schema defaults filled in.
+ * Its name is the module's class name.
  *
  * @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;;;;;;GAMG;AACH,MAAM,OAAO,WAAY,SAAQ,KAA4D;CAAG"}

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

@@ -4,20 +4,19 @@ 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> {
+export declare abstract class RegistrationEvent extends Event<void> {
 }
 /**
  * This event is emitted when a class with `@Anchor('my-package')` decorator is registered.
  * 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,OAAgB,iBAAkB,SAAQ,KAAW;CAAG;AAE9D;;;;;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"}

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

@@ -5,61 +5,64 @@ import { Event } from './event.model.js';
  * The SerializationEvent class is the superclass for all events in relation to serialization and deserialization.
  *
  * @group Events/Serialization
- *
- * @returns The Event instance.
  */
-export declare class SerializationEvent<T> extends Event<T> {
+export declare abstract class SerializationEvent<T> extends Event<T> {
 }
 /**
  * This event is emitted when models are deserialized from serialized output.
  *
  * @group Events/Serialization
- *
- * @returns The Event instance.
  */
 export declare class ModelDeserializedEvent extends SerializationEvent<ModelSerializedOutput> {
+    /**
+     * @internal
+     */
     static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
 }
 /**
  * This event is emitted when models are serialized to an output.
  *
  * @group Events/Serialization
- *
- * @returns The Event instance.
  */
 export declare class ModelSerializedEvent extends SerializationEvent<ModelSerializedOutput> {
+    /**
+     * @internal
+     */
     static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
 }
 /**
  * This event is emitted when resources are deserialized from serialized output.
  *
  * @group Events/Serialization
- *
- * @returns The Event instance.
  */
 export declare class ResourceDeserializedEvent extends SerializationEvent<{
     actual: ResourceSerializedOutput;
     old: ResourceSerializedOutput;
 }> {
+    /**
+     * @internal
+     */
     static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
 }
 /**
  * This event is emitted when actual resources are serialized to an output.
  *
  * @group Events/Serialization
- *
- * @returns The Event instance.
  */
 export declare class ActualResourceSerializedEvent extends SerializationEvent<ResourceSerializedOutput> {
+    /**
+     * @internal
+     */
     static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
 }
 /**
  * This event is emitted when new resources are serialized to an output.
  *
  * @group Events/Serialization
- *
- * @returns The Event instance.
  */
 export declare class NewResourceSerializedEvent extends SerializationEvent<ResourceSerializedOutput> {
+    /**
+     * @internal
+     */
     static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
 }

package/dist/events/serialization.event.js

@@ -3,8 +3,6 @@ import { Event } from './event.model.js';
  * The SerializationEvent class is the superclass for all events in relation to serialization and deserialization.
  *
  * @group Events/Serialization
- *
- * @returns The Event instance.
  */
 export class SerializationEvent extends Event {
 }
@@ -12,10 +10,11 @@ export class SerializationEvent extends Event {
  * This event is emitted when models are deserialized from serialized output.
  *
  * @group Events/Serialization
- *
- * @returns The Event instance.
  */
 export class ModelDeserializedEvent extends SerializationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
         descriptor.value = async function (...args) {
@@ -29,10 +28,11 @@ export class ModelDeserializedEvent extends SerializationEvent {
  * This event is emitted when models are serialized to an output.
  *
  * @group Events/Serialization
- *
- * @returns The Event instance.
  */
 export class ModelSerializedEvent extends SerializationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
         descriptor.value = async function (...args) {
@@ -46,10 +46,11 @@ export class ModelSerializedEvent extends SerializationEvent {
  * This event is emitted when resources are deserialized from serialized output.
  *
  * @group Events/Serialization
- *
- * @returns The Event instance.
  */
 export class ResourceDeserializedEvent extends SerializationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
         descriptor.value = async function (...args) {
@@ -62,10 +63,11 @@ export class ResourceDeserializedEvent extends SerializationEvent {
  * This event is emitted when actual resources are serialized to an output.
  *
  * @group Events/Serialization
- *
- * @returns The Event instance.
  */
 export class ActualResourceSerializedEvent extends SerializationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
         descriptor.value = async function (...args) {
@@ -79,10 +81,11 @@ export class ActualResourceSerializedEvent extends SerializationEvent {
  * This event is emitted when new resources are serialized to an output.
  *
  * @group Events/Serialization
- *
- * @returns The Event instance.
  */
 export class NewResourceSerializedEvent extends SerializationEvent {
+    /**
+     * @internal
+     */
     static registrar(eventService, descriptor) {
         const originalMethod = descriptor.value;
         descriptor.value = async function (...args) {

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

@@ -1 +1 @@
-{"version":3,"file":"serialization.event.js","sourceRoot":"","sources":["../../src/events/serialization.event.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;;;GAMG;AACH,MAAM,OAAO,kBAAsB,SAAQ,KAAQ;CAAG;AAEtD;;;;;;GAMG;AACH,MAAM,OAAO,sBAAuB,SAAQ,kBAAyC;IACnF,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEwC,UAAU,CAAC,KAAK,CAAC;QAE7E,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAA0D;YAE7D,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAElE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,oBAAqB,SAAQ,kBAAyC;IACjF,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEsC,UAAU,CAAC,KAAK,CAAC;QAE3E,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAAwD;YAE3D,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;YAE/D,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,yBAA0B,SAAQ,kBAG7C;IACA,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE2C,UAAU,CAAC,KAAK,CAAC;QAEhF,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAA6D;YAEhE,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEvC,YAAY,CAAC,IAAI,CAAC,IAAI,yBAAyB,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACjG,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,6BAA8B,SAAQ,kBAA4C;IAC7F,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEwD,UAAU,CAAC,KAAK,CAAC;QAE7F,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAA0E;YAE7E,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,6BAA6B,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;YAExE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,0BAA2B,SAAQ,kBAA4C;IAC1F,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEqD,UAAU,CAAC,KAAK,CAAC;QAE1F,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAAuE;YAE1E,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,0BAA0B,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;YAErE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"serialization.event.js","sourceRoot":"","sources":["../../src/events/serialization.event.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;GAIG;AACH,MAAM,OAAgB,kBAAsB,SAAQ,KAAQ;CAAG;AAE/D;;;;GAIG;AACH,MAAM,OAAO,sBAAuB,SAAQ,kBAAyC;IACnF;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEwC,UAAU,CAAC,KAAK,CAAC;QAE7E,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAA0D;YAE7D,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAElE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,oBAAqB,SAAQ,kBAAyC;IACjF;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEsC,UAAU,CAAC,KAAK,CAAC;QAE3E,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAAwD;YAE3D,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;YAE/D,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,yBAA0B,SAAQ,kBAG7C;IACA;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE2C,UAAU,CAAC,KAAK,CAAC;QAEhF,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAA6D;YAEhE,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEvC,YAAY,CAAC,IAAI,CAAC,IAAI,yBAAyB,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACjG,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,6BAA8B,SAAQ,kBAA4C;IAC7F;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEwD,UAAU,CAAC,KAAK,CAAC;QAE7F,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAA0E;YAE7E,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,6BAA6B,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;YAExE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,0BAA2B,SAAQ,kBAA4C;IAC1F;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEqD,UAAU,CAAC,KAAK,CAAC;QAE1F,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAAuE;YAE1E,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,0BAA0B,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;YAErE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF"}

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

@@ -0,0 +1,102 @@
+import type { IStateProvider } from '../services/state-management/state-provider.interface.js';
+import { Event } from './event.model.js';
+/**
+ * The superclass of the events about Octo's state: what was written, refreshed, locked, or unlocked.
+ *
+ * @group Events/State
+ */
+export declare abstract class StateEvent<T> extends Event<T> {
+}
+/**
+ * This event is emitted when the app lock is refused, before the error is thrown. `holder` is the
+ * command holding the lock, as far as the state provider knows it.
+ *
+ * @group Events/State
+ */
+export declare class AppLockRefusedEvent extends StateEvent<{
+    holder?: {
+        commitId?: string;
+        context?: string;
+        lockId: string;
+        takenAt?: number;
+    };
+    newestCommitId?: string;
+    reason: 'held' | 'not-held' | 'state-moved' | 'unfinished';
+    refreshedCommitId?: string;
+    stateFileNames?: string[];
+}> {
+}
+/**
+ * This event is emitted when the app lock is taken, or resumed with its id. A provider sharing state
+ * names where a resume took the state directory from: the directory the lock was taken in
+ * (`directory`), what the run uploaded so far (`run`), or the newest sealed state, because the run
+ * uploaded nothing (`sealed`).
+ *
+ * @group Events/State
+ */
+export declare class AppLockTakenEvent extends StateEvent<{
+    commitId?: string;
+    lockId: string;
+    resumed: boolean;
+    resumedFrom?: 'directory' | 'run' | 'sealed';
+}> {
+}
+/**
+ * This event is emitted after the app lock is released. The run's journal files are archived, and
+ * with a remote state provider its record is sealed, by then. Nothing is written after it.
+ *
+ * @group Events/State
+ */
+export declare class AppUnlockedEvent extends StateEvent<{
+    lockId: string;
+}> {
+}
+/**
+ * This event is emitted before the app lock is released. A listener that returns a promise is
+ * awaited, so what it writes lands in the run's record before the record is sealed. A listener that
+ * fails keeps the lock held.
+ *
+ * @group Events/State
+ */
+export declare class AppUnlockingEvent extends StateEvent<{
+    lockId: string;
+}> {
+}
+/**
+ * This event is emitted after state files are written, with the bytes written and their MD5. A file
+ * copied from a path carries only its path, which its saver may delete once this event is emitted, and a
+ * deleted file has neither.
+ *
+ * @group Events/State
+ */
+export declare class StateFilesSavedEvent extends StateEvent<{
+    stateFiles: {
+        data: Buffer | undefined;
+        filePath?: string;
+        md5: string | undefined;
+        stateFileName: string;
+    }[];
+}> {
+}
+/**
+ * This event is emitted before state files are written. A listener that returns a promise is awaited,
+ * and may add files to `stateFiles`, which are then written in the same change.
+ *
+ * @group Events/State
+ */
+export declare class StateFilesSavingEvent extends StateEvent<{
+    stateFiles: Parameters<IStateProvider['saveStates']>[0];
+}> {
+}
+/**
+ * This event is emitted after the state is brought up to the newest a command may plan against.
+ * `replaced` is true when the state files were replaced with the ones of another commit.
+ *
+ * @group Events/State
+ */
+export declare class StateRefreshedEvent extends StateEvent<{
+    commitId?: string;
+    previousCommitId?: string;
+    replaced: boolean;
+}> {
+}

package/dist/events/state.event.js

@@ -0,0 +1,69 @@
+import { Event } from './event.model.js';
+/**
+ * The superclass of the events about Octo's state: what was written, refreshed, locked, or unlocked.
+ *
+ * @group Events/State
+ */
+export class StateEvent extends Event {
+}
+/**
+ * This event is emitted when the app lock is refused, before the error is thrown. `holder` is the
+ * command holding the lock, as far as the state provider knows it.
+ *
+ * @group Events/State
+ */
+export class AppLockRefusedEvent extends StateEvent {
+}
+/**
+ * This event is emitted when the app lock is taken, or resumed with its id. A provider sharing state
+ * names where a resume took the state directory from: the directory the lock was taken in
+ * (`directory`), what the run uploaded so far (`run`), or the newest sealed state, because the run
+ * uploaded nothing (`sealed`).
+ *
+ * @group Events/State
+ */
+export class AppLockTakenEvent extends StateEvent {
+}
+/**
+ * This event is emitted after the app lock is released. The run's journal files are archived, and
+ * with a remote state provider its record is sealed, by then. Nothing is written after it.
+ *
+ * @group Events/State
+ */
+export class AppUnlockedEvent extends StateEvent {
+}
+/**
+ * This event is emitted before the app lock is released. A listener that returns a promise is
+ * awaited, so what it writes lands in the run's record before the record is sealed. A listener that
+ * fails keeps the lock held.
+ *
+ * @group Events/State
+ */
+export class AppUnlockingEvent extends StateEvent {
+}
+/**
+ * This event is emitted after state files are written, with the bytes written and their MD5. A file
+ * copied from a path carries only its path, which its saver may delete once this event is emitted, and a
+ * deleted file has neither.
+ *
+ * @group Events/State
+ */
+export class StateFilesSavedEvent extends StateEvent {
+}
+/**
+ * This event is emitted before state files are written. A listener that returns a promise is awaited,
+ * and may add files to `stateFiles`, which are then written in the same change.
+ *
+ * @group Events/State
+ */
+export class StateFilesSavingEvent extends StateEvent {
+}
+/**
+ * This event is emitted after the state is brought up to the newest a command may plan against.
+ * `replaced` is true when the state files were replaced with the ones of another commit.
+ *
+ * @group Events/State
+ */
+export class StateRefreshedEvent extends StateEvent {
+}
+//# sourceMappingURL=state.event.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"state.event.js","sourceRoot":"","sources":["../../src/events/state.event.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;GAIG;AACH,MAAM,OAAgB,UAAc,SAAQ,KAAQ;CAAG;AAEvD;;;;;GAKG;AACH,MAAM,OAAO,mBAAoB,SAAQ,UAMvC;CAAG;AAEL;;;;;;;GAOG;AACH,MAAM,OAAO,iBAAkB,SAAQ,UAKrC;CAAG;AAEL;;;;;GAKG;AACH,MAAM,OAAO,gBAAiB,SAAQ,UAA8B;CAAG;AAEvE;;;;;;GAMG;AACH,MAAM,OAAO,iBAAkB,SAAQ,UAA8B;CAAG;AAExE;;;;;;GAMG;AACH,MAAM,OAAO,oBAAqB,SAAQ,UAExC;CAAG;AAEL;;;;;GAKG;AACH,MAAM,OAAO,qBAAsB,SAAQ,UAEzC;CAAG;AAEL;;;;;GAKG;AACH,MAAM,OAAO,mBAAoB,SAAQ,UAIvC;CAAG"}

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

@@ -0,0 +1,78 @@
+import { Event } from './event.model.js';
+/**
+ * The TerraformEvent class is the superclass for all events in relation to terraform and terragrunt.
+ *
+ * @group Events/Terraform
+ */
+export declare abstract class TerraformEvent<T = undefined> extends Event<T> {
+}
+/**
+ * This event is emitted when generate finishes writing terragrunt module folders.
+ * `emptied` lists folders written without resources, because their module left intent.
+ *
+ * @group Events/Terraform
+ */
+export declare class TerraformFoldersWrittenEvent extends TerraformEvent<{
+    emptied: string[];
+    outputDir: string;
+    written: string[];
+}> {
+}
+/**
+ * This event is emitted before a terraform/terragrunt command is invoked.
+ *
+ * @group Events/Terraform
+ */
+export declare class TerraformCommandStartedEvent extends TerraformEvent<{
+    command: string;
+    dir: string;
+}> {
+}
+/**
+ * This event is emitted after a terraform/terragrunt command returns, whatever its exit code.
+ *
+ * @group Events/Terraform
+ */
+export declare class TerraformCommandFinishedEvent extends TerraformEvent<{
+    command: string;
+    dir: string;
+    durationInMs: number;
+    exitCode: number;
+}> {
+}
+/**
+ * This event is emitted when octo starts a terraform or terragrunt process, before it writes anything.
+ * `processId` tells apart the processes of one octo process: a JSON plan runs a plan and a show in
+ * every folder.
+ *
+ * @group Events/Terraform
+ */
+export declare class TerraformProcessStartedEvent extends TerraformEvent<{
+    args: string[];
+    binary: string;
+    dir: string;
+    processId: number;
+}> {
+}
+/**
+ * This event is emitted for every chunk a terraform or terragrunt process writes, as it writes it.
+ *
+ * @group Events/Terraform
+ */
+export declare class TerraformProcessOutputEvent extends TerraformEvent<{
+    processId: number;
+    stream: 'stderr' | 'stdout';
+    text: string;
+}> {
+}
+/**
+ * This event is emitted after every terraform or terragrunt process exits, whatever its exit code.
+ * `exitCode` is -1 for a process that could not start or was killed.
+ *
+ * @group Events/Terraform
+ */
+export declare class TerraformProcessExitedEvent extends TerraformEvent<{
+    exitCode: number;
+    processId: number;
+}> {
+}