@quadnix/octo 0.0.30 → 0.2.0

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

@@ -0,0 +1,43 @@
+import { Event } from './event.model.js';
+/**
+ * The superclass of the events marking one command a driver runs, such as one `octo` CLI command.
+ * A command may run several modes, or none.
+ *
+ * @group Events/Command
+ */
+export declare abstract class CommandEvent<T extends {
+    command: string;
+} = {
+    command: string;
+}> extends Event<T> {
+}
+/**
+ * This event is emitted when a command begins.
+ *
+ * @group Events/Command
+ */
+export declare class CommandStartedEvent extends CommandEvent {
+}
+/**
+ * This event is emitted when a command completes successfully. A listener that returns a promise is
+ * awaited, so it can finish writing before the process exits.
+ *
+ * @group Events/Command
+ */
+export declare class CommandFinishedEvent extends CommandEvent<{
+    command: string;
+    durationInMs: number;
+}> {
+}
+/**
+ * This event is emitted when a command fails. A listener that returns a promise is awaited, so it
+ * can finish writing before the process exits.
+ *
+ * @group Events/Command
+ */
+export declare class CommandFailedEvent extends CommandEvent<{
+    command: string;
+    durationInMs: number;
+    error: Error;
+}> {
+}

package/dist/events/command.event.js

@@ -0,0 +1,33 @@
+import { Event } from './event.model.js';
+/**
+ * The superclass of the events marking one command a driver runs, such as one `octo` CLI command.
+ * A command may run several modes, or none.
+ *
+ * @group Events/Command
+ */
+export class CommandEvent extends Event {
+}
+/**
+ * This event is emitted when a command begins.
+ *
+ * @group Events/Command
+ */
+export class CommandStartedEvent extends CommandEvent {
+}
+/**
+ * This event is emitted when a command completes successfully. A listener that returns a promise is
+ * awaited, so it can finish writing before the process exits.
+ *
+ * @group Events/Command
+ */
+export class CommandFinishedEvent extends CommandEvent {
+}
+/**
+ * This event is emitted when a command fails. A listener that returns a promise is awaited, so it
+ * can finish writing before the process exits.
+ *
+ * @group Events/Command
+ */
+export class CommandFailedEvent extends CommandEvent {
+}
+//# sourceMappingURL=command.event.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"command.event.js","sourceRoot":"","sources":["../../src/events/command.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,OAAgB,YAAkE,SAAQ,KAAQ;CAAG;AAE3G;;;;GAIG;AACH,MAAM,OAAO,mBAAoB,SAAQ,YAAY;CAAG;AAExD;;;;;GAKG;AACH,MAAM,OAAO,oBAAqB,SAAQ,YAAuD;CAAG;AAEpG;;;;;GAKG;AACH,MAAM,OAAO,kBAAmB,SAAQ,YAAqE;CAAG"}

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

@@ -1,33 +1,51 @@
 import type { EventService } from '../services/event/event.service.js';
 /**
- * The Event class is the superclass for all events.
- * An event is generated when something important happens in Octo.
- * The body of the event contains a header, name (optional), and payload (optional).
+ * The superclass of every event Octo emits.
+ *
+ * Octo narrates its whole run as events - what registered, what changed, what terraform did, what
+ * each mode concluded. Subscribe with {@link OnEvent} to build logging, reporting, or notifications
+ * on top of a run without touching the framework. Emit your own by extending it.
  *
  * @example
  * ```ts
- * const myEvent = new Event<{ value: string }>('event name', { value: 'my payload' });
- * EventService.getInstance().emit(myEvent);
+ * class DeployApprovedEvent extends Event<{ reviewer: string }> {}
+ * EventService.getInstance().emit(new DeployApprovedEvent('deploy approved', { reviewer: 'ops-lead' }));
  * ```
  *
  * @group Events
- *
- * @returns The Event instance.
  */
-export declare class Event<T = undefined> {
+export declare abstract class Event<T = undefined> {
+    /**
+     * When the event was created. `sequence` counts every event this process created, so it orders
+     * two events created in the same millisecond, and events a late listener receives replayed.
+     */
     readonly header: {
+        sequence: number;
         timestamp: number;
     };
+    /**
+     * The subject of the event, when the event type alone does not identify it - e.g. the class name
+     * on a registration event. Empty otherwise.
+     */
     readonly name: string;
+    /**
+     * The event's data. Its shape is fixed by the event type.
+     */
     readonly payload: T;
+    /**
+     * @param name The subject of the event, when the event type alone does not identify it.
+     * @param payload The event's data.
+     */
     constructor(name?: string, payload?: T);
     /**
      * The `registrar()` method is explicitly called by the {@link EventSource} decorator for a method
      * to enhance that method to auto-emit events.
      *
+     * @internal
      * @param args Arguments are spread out using the array spread operator.
      * - args[0] - Instance of {@link EventService}.
      * - args[1] - [PropertyDescriptor](https://www.typescriptlang.org/docs/handbook/decorators.html).
+     *
      */
     static registrar(...args: [EventService, PropertyDescriptor]): void;
 }

package/dist/events/event.model.js

@@ -1,21 +1,27 @@
+let nextSequence = 0;
 /**
- * The Event class is the superclass for all events.
- * An event is generated when something important happens in Octo.
- * The body of the event contains a header, name (optional), and payload (optional).
+ * The superclass of every event Octo emits.
+ *
+ * Octo narrates its whole run as events - what registered, what changed, what terraform did, what
+ * each mode concluded. Subscribe with {@link OnEvent} to build logging, reporting, or notifications
+ * on top of a run without touching the framework. Emit your own by extending it.
  *
  * @example
  * ```ts
- * const myEvent = new Event<{ value: string }>('event name', { value: 'my payload' });
- * EventService.getInstance().emit(myEvent);
+ * class DeployApprovedEvent extends Event<{ reviewer: string }> {}
+ * EventService.getInstance().emit(new DeployApprovedEvent('deploy approved', { reviewer: 'ops-lead' }));
  * ```
  *
  * @group Events
- *
- * @returns The Event instance.
  */
 export class Event {
+    /**
+     * @param name The subject of the event, when the event type alone does not identify it.
+     * @param payload The event's data.
+     */
     constructor(name, payload) {
         this.header = {
+            sequence: nextSequence++,
             timestamp: Date.now(),
         };
         this.name = name || '';
@@ -25,9 +31,11 @@ export class Event {
      * The `registrar()` method is explicitly called by the {@link EventSource} decorator for a method
      * to enhance that method to auto-emit events.
      *
+     * @internal
      * @param args Arguments are spread out using the array spread operator.
      * - args[0] - Instance of {@link EventService}.
      * - args[1] - [PropertyDescriptor](https://www.typescriptlang.org/docs/handbook/decorators.html).
+     *
      */
     static registrar(...args) {
         if (args.length !== 2) {

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

@@ -1 +1 @@
-{"version":3,"file":"event.model.js","sourceRoot":"","sources":["../../src/events/event.model.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,KAAK;IAShB,YAAY,IAAa,EAAE,OAAW;QACpC,IAAI,CAAC,MAAM,GAAG;YACZ,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACtB,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAY,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CAAC,GAAG,IAAwC;QAC1D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;IAC9E,CAAC;CACF"}
+{"version":3,"file":"event.model.js","sourceRoot":"","sources":["../../src/events/event.model.ts"],"names":[],"mappings":"AAEA,IAAI,YAAY,GAAG,CAAC,CAAC;AAErB;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAgB,KAAK;IAqBzB;;;OAGG;IACH,YAAY,IAAa,EAAE,OAAW;QACpC,IAAI,CAAC,MAAM,GAAG;YACZ,QAAQ,EAAE,YAAY,EAAE;YACxB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACtB,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAY,CAAC;IAC9B,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,CAAC,GAAG,IAAwC;QAC1D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;IAC9E,CAAC;CACF"}

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

@@ -3,17 +3,13 @@ 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 {
+export declare abstract 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,OAAgB,eAAgB,SAAQ,SAAS;CAAG;AAE1D;;;;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> {
+export declare abstract class HookEvent extends Event<undefined> {
 }

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,OAAgB,SAAU,SAAQ,KAAgB;CAAG"}

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

@@ -3,17 +3,13 @@ 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 {
+export declare abstract 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,OAAgB,oBAAqB,SAAQ,SAAS;CAAG;AAE/D;;;;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,17 +3,13 @@ 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 {
+export declare abstract 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,OAAgB,uBAAwB,SAAQ,SAAS;CAAG;AAElE;;;;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,12 @@
 export * from './action.event.js';
+export * from './command.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 './state.event.js';
+export * from './terraform.event.js';
 export * from './transaction.event.js';

package/dist/events/index.js

@@ -1,8 +1,13 @@
 export * from './action.event.js';
+export * from './command.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 './state.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,oBAAoB,CAAC;AACnC,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,kBAAkB,CAAC;AACjC,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 abstract 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,OAAgB,eAAmB,SAAQ,KAAQ;CAAG;AAE5D;;;;;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,61 @@
+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 {
+    /**
+     * The name of the app the mode runs on.
+     */
+    appName: string;
+    /**
+     * The mode this event is about.
+     */
+    mode: OctoMode;
+    /**
+     * The resource a `run-action` runs the action of. Absent in every other mode.
+     */
+    resourceId?: string;
+}
+/**
+ * The ModeEvent class is the superclass for all events marking the boundaries of an octo lifecycle mode.
+ *
+ * @group Events/Mode
+ */
+export declare abstract 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: Error;
+}> {
+}

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;AA+BzC;;;;GAIG;AACH,MAAM,OAAgB,SAAyD,SAAQ,KAAQ;CAAG;AAElG;;;;GAIG;AACH,MAAM,OAAO,gBAAiB,SAAQ,SAAS;CAAG;AAElD;;;;;GAKG;AACH,MAAM,OAAO,iBAAkB,SAAQ,SAAsD;CAAG;AAEhG;;;;;GAKG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAoE;CAAG"}

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

@@ -1,11 +1,13 @@
 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 declare class ModuleEvent extends Event<void> {
+export declare class ModuleEvent extends Event<{
+    inputs: Record<string, unknown>;
+    moduleId: string;
+}> {
 }