@quadnix/octo 0.0.30 → 0.2.0

package/dist/functions/diff/aggregate-resource-actions.js

@@ -0,0 +1,41 @@
+import { DiffAction } from './diff.js';
+/**
+ * Collapses a resource's field-level diffs into one action per resource, keyed by resource context.
+ *
+ * Precedence: an add/delete of `resourceId` wins; a REPLACE beats an UPDATE; otherwise UPDATE.
+ * `reason` is taken from the winning diff.
+ *
+ * @internal
+ */
+export function aggregateResourceActions(diffs) {
+    const aggregated = new Map();
+    for (const diff of diffs) {
+        const node = diff.node;
+        const context = node.getContext();
+        const reason = diff.diff.reason;
+        if (diff.action === DiffAction.DELETE && diff.field === 'resourceId') {
+            aggregated.set(context, { action: DiffAction.DELETE, reason, resourceId: node.resourceId });
+        }
+        else if (diff.action === DiffAction.ADD && diff.field === 'resourceId') {
+            aggregated.set(context, { action: DiffAction.ADD, reason, resourceId: node.resourceId });
+        }
+        else if (diff.action === DiffAction.REPLACE) {
+            const existing = aggregated.get(context);
+            if (!existing || existing.action === DiffAction.UPDATE) {
+                aggregated.set(context, { action: DiffAction.REPLACE, reason, resourceId: node.resourceId });
+            }
+        }
+        else if (!aggregated.has(context)) {
+            aggregated.set(context, { action: DiffAction.UPDATE, reason, resourceId: node.resourceId });
+        }
+        else {
+            // A later update may be the only one carrying a reason.
+            const existing = aggregated.get(context);
+            if (existing.action === DiffAction.UPDATE && existing.reason === undefined && reason !== undefined) {
+                existing.reason = reason;
+            }
+        }
+    }
+    return aggregated;
+}
+//# sourceMappingURL=aggregate-resource-actions.js.map

package/dist/functions/diff/aggregate-resource-actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregate-resource-actions.js","sourceRoot":"","sources":["../../../src/functions/diff/aggregate-resource-actions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAWvC;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAqB;IAC5D,MAAM,UAAU,GAAG,IAAI,GAAG,EAAoC,CAAC;IAE/D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAuB,CAAC;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QAEhC,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,KAAK,YAAY,EAAE,CAAC;YACrE,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QAC9F,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,GAAG,IAAI,IAAI,CAAC,KAAK,KAAK,YAAY,EAAE,CAAC;YACzE,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QAC3F,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC;YAC9C,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACzC,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;gBACvD,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;YAC/F,CAAC;QACH,CAAC;aAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACpC,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QAC9F,CAAC;aAAM,CAAC;YACN,wDAAwD;YACxD,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC;YAC1C,IAAI,QAAQ,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACnG,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/functions/diff/diff-metadata.d.ts

@@ -1,24 +1,42 @@
 import type { ActionInputs, ActionOutputs, IUnknownModelAction, IUnknownResourceAction, UnknownNode } from '../../app.type.js';
 import type { Diff, DiffAction } from './diff.js';
 /**
+ * A {@link Diff} paired with the actions that will apply it, and the order they run in.
+ *
+ * A transaction is a list of these, so this is the shape you read when inspecting what a run did -
+ * in an event payload, or in a test.
+ *
  * @group Functions/Diff
  */
 export declare class DiffMetadata {
+    readonly action: DiffAction;
     readonly actions: IUnknownModelAction[] | IUnknownResourceAction[];
     applied: boolean;
     applyOrder: number;
     readonly diff: Diff;
-    readonly action: DiffAction;
     readonly field: string;
-    readonly node: UnknownNode;
-    readonly value: unknown;
     readonly inputs: ActionInputs;
+    readonly node: UnknownNode;
     readonly outputs: ActionOutputs;
+    readonly value: unknown;
+    /**
+     * @param diff The change this metadata is about.
+     * @param actions The actions that will apply it.
+     * @throws {@link NoMatchingActionFoundTransactionError} If no action was given.
+     */
     constructor(diff: Diff, actions: IUnknownModelAction[] | IUnknownResourceAction[]);
     /**
      * Overrides JSON.serialize() to output a more succinct model of diff-metadata.
+     *
+     * @internal
      */
     toJSON(): ReturnType<Diff['toJSON']>;
+    /**
+     * @internal
+     */
     updateInputs(inputs: ActionInputs): void;
+    /**
+     * @internal
+     */
     updateOutputs(outputs: ActionOutputs): void;
 }

package/dist/functions/diff/diff-metadata.js

@@ -1,8 +1,18 @@
 import { NoMatchingActionFoundTransactionError } from '../../errors/index.js';
 /**
+ * A {@link Diff} paired with the actions that will apply it, and the order they run in.
+ *
+ * A transaction is a list of these, so this is the shape you read when inspecting what a run did -
+ * in an event payload, or in a test.
+ *
  * @group Functions/Diff
  */
 export class DiffMetadata {
+    /**
+     * @param diff The change this metadata is about.
+     * @param actions The actions that will apply it.
+     * @throws {@link NoMatchingActionFoundTransactionError} If no action was given.
+     */
     constructor(diff, actions) {
         this.inputs = { inputs: {}, metadata: {}, models: {}, overlays: {}, resources: {} };
         this.outputs = {};
@@ -20,13 +30,21 @@ export class DiffMetadata {
     }
     /**
      * Overrides JSON.serialize() to output a more succinct model of diff-metadata.
+     *
+     * @internal
      */
     toJSON() {
         return this.diff.toJSON();
     }
+    /**
+     * @internal
+     */
     updateInputs(inputs) {
         Object.assign(this.inputs, inputs);
     }
+    /**
+     * @internal
+     */
     updateOutputs(outputs) {
         Object.assign(this.outputs, outputs);
     }

package/dist/functions/diff/diff-metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"diff-metadata.js","sourceRoot":"","sources":["../../../src/functions/diff/diff-metadata.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,qCAAqC,EAAE,MAAM,uBAAuB,CAAC;AAG9E;;GAEG;AACH,MAAM,OAAO,YAAY;IAcvB,YAAY,IAAU,EAAE,OAAyD;QAHxE,WAAM,GAAiB,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;QAC7F,YAAO,GAAkB,EAAE,CAAC;QAGnC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;YACrB,MAAM,IAAI,qCAAqC,CAAC,oCAAoC,EAAE,IAAI,CAAC,CAAC;QAC9F,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAErB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;IAC5B,CAAC;IAED,YAAY,CAAC,MAAoB;QAC/B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,aAAa,CAAC,OAAsB;QAClC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;CACF"}
+{"version":3,"file":"diff-metadata.js","sourceRoot":"","sources":["../../../src/functions/diff/diff-metadata.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,qCAAqC,EAAE,MAAM,uBAAuB,CAAC;AAG9E;;;;;;;GAOG;AACH,MAAM,OAAO,YAAY;IAcvB;;;;OAIG;IACH,YAAY,IAAU,EAAE,OAAyD;QAXxE,WAAM,GAAiB,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;QAG7F,YAAO,GAAkB,EAAE,CAAC;QASnC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;YACrB,MAAM,IAAI,qCAAqC,CAAC,oCAAoC,EAAE,IAAI,CAAC,CAAC;QAC9F,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAErB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,MAAoB;QAC/B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,OAAsB;QAClC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;CACF"}

package/dist/functions/diff/diff.d.ts

@@ -1,30 +1,91 @@
 import type { UnknownNode } from '../../app.type.js';
 /**
+ * What a {@link Diff} says happened to a node.
+ *
+ * `REPLACE` is distinct from `UPDATE`: it means the change cannot be applied in place, and the
+ * infrastructure must be destroyed and re-created.
+ *
  * @group Functions/Diff
  */
 export declare enum DiffAction {
+    /**
+     * The node is in the new graph and not in the last committed one, so it has to be created.
+     */
     ADD = "add",
+    /**
+     * The node is in the last committed graph and not in the new one, so it has to be destroyed.
+     */
     DELETE = "delete",
+    /**
+     * A field changed that cannot be changed in place, so the infrastructure is destroyed and created
+     * again. A resource declares this itself, with a reason, which is what a report shows a reviewer
+     * in place of leaving them to work a recreate out of a terraform plan.
+     */
     REPLACE = "replace",
+    /**
+     * A field changed and can be changed in place.
+     */
     UPDATE = "update",
+    /**
+     * Nothing changed, and the node still wants an action to run over it.
+     */
     VALIDATE = "validate"
 }
 /**
+ * A diff as it leaves the process: `node` is the context of the model, overlay or resource changed,
+ * and a `value` naming a node is its context, or `anchorId=<id>` for an anchor.
+ *
+ * @group Functions/Diff
+ */
+export type DiffSerializedOutput = {
+    action: `${DiffAction}`;
+    field: string;
+    node: string;
+    reason?: string;
+    value: unknown;
+};
+/**
+ * One change to one field of one node.
+ *
+ * Diffs are the currency of Octo: comparing the graph you just described against the last committed
+ * one produces a list of them, and every action is selected and driven by the diffs it accepts.
+ *
  * @group Functions/Diff
  */
 export declare class Diff<N extends UnknownNode = UnknownNode, V = unknown> {
+    /**
+     * What happened.
+     */
     readonly action: DiffAction;
+    /**
+     * The field of the node that changed, e.g. `resourceId`, `properties`, or `parent`.
+     */
     readonly field: string;
+    /**
+     * The node that changed.
+     */
     readonly node: N;
+    /**
+     * Why the change is being made, when the field alone does not explain it.
+     * It is carried into reports, so write it for whoever reads the plan.
+     */
+    readonly reason?: string;
+    /**
+     * The new value of the field. Its shape depends on the field.
+     */
     readonly value: V;
-    constructor(node: Diff<N, V>['node'], action: Diff['action'], field: Diff['field'], value: Diff<N, V>['value']);
+    /**
+     * @param node The node that changed.
+     * @param action What happened to it.
+     * @param field The field of the node that changed.
+     * @param value The new value of the field.
+     * @param reason Why the change is being made, carried into reports.
+     */
+    constructor(node: Diff<N, V>['node'], action: Diff['action'], field: Diff['field'], value: Diff<N, V>['value'], reason?: Diff['reason']);
     /**
      * Overrides JSON.serialize() to output a more succinct representation of diff.
+     *
+     * @internal
      */
-    toJSON(): {
-        action: string;
-        field: string;
-        node: string;
-        value: V | string;
-    };
+    toJSON(): DiffSerializedOutput;
 }

package/dist/functions/diff/diff.js

@@ -1,26 +1,63 @@
 /**
+ * What a {@link Diff} says happened to a node.
+ *
+ * `REPLACE` is distinct from `UPDATE`: it means the change cannot be applied in place, and the
+ * infrastructure must be destroyed and re-created.
+ *
  * @group Functions/Diff
  */
 export var DiffAction;
 (function (DiffAction) {
+    /**
+     * The node is in the new graph and not in the last committed one, so it has to be created.
+     */
     DiffAction["ADD"] = "add";
+    /**
+     * The node is in the last committed graph and not in the new one, so it has to be destroyed.
+     */
     DiffAction["DELETE"] = "delete";
+    /**
+     * A field changed that cannot be changed in place, so the infrastructure is destroyed and created
+     * again. A resource declares this itself, with a reason, which is what a report shows a reviewer
+     * in place of leaving them to work a recreate out of a terraform plan.
+     */
     DiffAction["REPLACE"] = "replace";
+    /**
+     * A field changed and can be changed in place.
+     */
     DiffAction["UPDATE"] = "update";
+    /**
+     * Nothing changed, and the node still wants an action to run over it.
+     */
     DiffAction["VALIDATE"] = "validate";
 })(DiffAction || (DiffAction = {}));
 /**
+ * One change to one field of one node.
+ *
+ * Diffs are the currency of Octo: comparing the graph you just described against the last committed
+ * one produces a list of them, and every action is selected and driven by the diffs it accepts.
+ *
  * @group Functions/Diff
  */
 export class Diff {
-    constructor(node, action, field, value) {
+    /**
+     * @param node The node that changed.
+     * @param action What happened to it.
+     * @param field The field of the node that changed.
+     * @param value The new value of the field.
+     * @param reason Why the change is being made, carried into reports.
+     */
+    constructor(node, action, field, value, reason) {
         this.node = node;
         this.action = action;
         this.field = field;
         this.value = value;
+        this.reason = reason;
     }
     /**
      * Overrides JSON.serialize() to output a more succinct representation of diff.
+     *
+     * @internal
      */
     toJSON() {
         let value = this.value;
@@ -31,14 +68,18 @@ export class Diff {
             value = `anchorId=${value.anchorId}`;
         }
         else {
-            value = JSON.parse(JSON.stringify(value));
+            value = value === undefined ? undefined : JSON.parse(JSON.stringify(value));
         }
-        return {
+        const json = {
             action: this.action,
             field: this.field,
             node: this.node.getContext(),
             value,
         };
+        if (this.reason !== undefined) {
+            json.reason = this.reason;
+        }
+        return json;
     }
 }
 //# sourceMappingURL=diff.js.map

package/dist/functions/diff/diff.js.map

@@ -1 +1 @@
-{"version":3,"file":"diff.js","sourceRoot":"","sources":["../../../src/functions/diff/diff.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,yBAAW,CAAA;IACX,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;AACvB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAED;;GAEG;AACH,MAAM,OAAO,IAAI;IASf,YAAY,IAAwB,EAAE,MAAsB,EAAE,KAAoB,EAAE,KAA0B;QAC5G,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,KAAK,GAAe,IAAI,CAAC,KAAK,CAAC;QACnC,IAAK,KAAqB,CAAC,UAAU,EAAE,CAAC;YACtC,KAAK,GAAI,KAAqB,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;aAAM,IAAK,KAAuB,CAAC,QAAQ,EAAE,CAAC;YAC7C,KAAK,GAAG,YAAa,KAAuB,CAAC,QAAQ,EAAE,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5C,CAAC;QAED,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAC5B,KAAK;SACN,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"diff.js","sourceRoot":"","sources":["../../../src/functions/diff/diff.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,UA2BX;AA3BD,WAAY,UAAU;IACpB;;OAEG;IACH,yBAAW,CAAA;IAEX;;OAEG;IACH,+BAAiB,CAAA;IAEjB;;;;OAIG;IACH,iCAAmB,CAAA;IAEnB;;OAEG;IACH,+BAAiB,CAAA;IAEjB;;OAEG;IACH,mCAAqB,CAAA;AACvB,CAAC,EA3BW,UAAU,KAAV,UAAU,QA2BrB;AAgBD;;;;;;;GAOG;AACH,MAAM,OAAO,IAAI;IA2Bf;;;;;;OAMG;IACH,YACE,IAAwB,EACxB,MAAsB,EACtB,KAAoB,EACpB,KAA0B,EAC1B,MAAuB;QAEvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,IAAI,KAAK,GAAY,IAAI,CAAC,KAAK,CAAC;QAChC,IAAK,KAAqB,CAAC,UAAU,EAAE,CAAC;YACtC,KAAK,GAAI,KAAqB,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;aAAM,IAAK,KAAuB,CAAC,QAAQ,EAAE,CAAC;YAC7C,KAAK,GAAG,YAAa,KAAuB,CAAC,QAAQ,EAAE,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9E,CAAC;QAED,MAAM,IAAI,GAAyB;YACjC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAC5B,KAAK;SACN,CAAC;QAEF,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC5B,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/dist/functions/hook/commit.hook.d.ts

@@ -13,13 +13,28 @@ export declare class CommitHook implements IHook<PreHookSignature, PostHookSigna
     private static instance;
     private readonly postCommitHooks;
     private readonly preCommitHooks;
+    /**
+     * @internal
+     */
     private constructor();
+    /**
+     * @internal
+     */
+    static getInstance(): CommitHook;
+    /**
+     * @internal
+     */
     collectHooks(hooks: {
         postHooks?: PostHookSignature[];
         preHooks?: PreHookSignature[];
     }): void;
-    static getInstance(): CommitHook;
+    /**
+     * @internal
+     */
     registrar(descriptor: PropertyDescriptor): void;
+    /**
+     * @internal
+     */
     reset(): void;
 }
 export {};

package/dist/functions/hook/commit.hook.js

@@ -5,10 +5,25 @@ import { Container } from '../container/container.js';
  * @internal
  */
 export class CommitHook {
+    /**
+     * @internal
+     */
     constructor() {
         this.postCommitHooks = [];
         this.preCommitHooks = [];
     }
+    /**
+     * @internal
+     */
+    static getInstance() {
+        if (!this.instance) {
+            this.instance = new CommitHook();
+        }
+        return this.instance;
+    }
+    /**
+     * @internal
+     */
     collectHooks(hooks) {
         for (const { handle } of hooks.postHooks || []) {
             this.postCommitHooks.push({ handle });
@@ -17,12 +32,9 @@ export class CommitHook {
             this.preCommitHooks.push({ handle });
         }
     }
-    static getInstance() {
-        if (!this.instance) {
-            this.instance = new CommitHook();
-        }
-        return this.instance;
-    }
+    /**
+     * @internal
+     */
     registrar(descriptor) {
         // `self` here references this class, vs `this` references the original method.
         // eslint-disable-next-line @typescript-eslint/no-this-alias
@@ -42,6 +54,9 @@ export class CommitHook {
             }
         };
     }
+    /**
+     * @internal
+     */
     reset() {
         this.postCommitHooks.splice(0, this.postCommitHooks.length);
         this.preCommitHooks.splice(0, this.preCommitHooks.length);

package/dist/functions/hook/commit.hook.js.map

@@ -1 +1 @@
-{"version":3,"file":"commit.hook.js","sourceRoot":"","sources":["../../../src/functions/hook/commit.hook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AAExG,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAMtD;;GAEG;AACH,MAAM,OAAO,UAAU;IAMrB;QAHiB,oBAAe,GAAwB,EAAE,CAAC;QAC1C,mBAAc,GAAuB,EAAE,CAAC;IAElC,CAAC;IAExB,YAAY,CAAC,KAAyE;QACpF,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,KAAK,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;YAC/C,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACxC,CAAC;QAED,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,KAAK,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;YAC9C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED,MAAM,CAAC,WAAW;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,UAAU,EAAE,CAAC;QACnC,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,SAAS,CAAC,UAA8B;QACtC,+EAA+E;QAC/E,4DAA4D;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC;QAElB,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAG,IAA2C;YAC/E,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,YAAY,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAEvD,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC7C,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC/B,YAAY,CAAC,IAAI,CAAC,IAAI,8BAA8B,EAAE,CAAC,CAAC;YAC1D,CAAC;YAED,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEvC,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;gBAC9C,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC/B,YAAY,CAAC,IAAI,CAAC,IAAI,+BAA+B,EAAE,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IAED,KAAK;QACH,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC5D,CAAC;CACF"}
+{"version":3,"file":"commit.hook.js","sourceRoot":"","sources":["../../../src/functions/hook/commit.hook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AAExG,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAMtD;;GAEG;AACH,MAAM,OAAO,UAAU;IAMrB;;OAEG;IACH;QANiB,oBAAe,GAAwB,EAAE,CAAC;QAC1C,mBAAc,GAAuB,EAAE,CAAC;IAKlC,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,WAAW;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,UAAU,EAAE,CAAC;QACnC,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,KAAyE;QACpF,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,KAAK,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;YAC/C,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACxC,CAAC;QAED,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,KAAK,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;YAC9C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,UAA8B;QACtC,+EAA+E;QAC/E,4DAA4D;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC;QAElB,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAG,IAA2C;YAC/E,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,YAAY,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAEvD,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC7C,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC/B,YAAY,CAAC,IAAI,CAAC,IAAI,8BAA8B,EAAE,CAAC,CAAC;YAC1D,CAAC;YAED,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEvC,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;gBAC9C,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC/B,YAAY,CAAC,IAAI,CAAC,IAAI,+BAA+B,EAAE,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC5D,CAAC;CACF"}

package/dist/functions/hook/model-action.hook.d.ts

@@ -15,13 +15,28 @@ export declare class ModelActionHook implements IHook<PreHookSignature, PostHook
     private static instance;
     private readonly postModelActionHooks;
     private readonly preModelActionHooks;
+    /**
+     * @internal
+     */
     private constructor();
+    /**
+     * @internal
+     */
+    static getInstance(): ModelActionHook;
+    /**
+     * @internal
+     */
     collectHooks(hooks: {
         postHooks?: PostHookSignature[];
         preHooks?: PreHookSignature[];
     }): void;
-    static getInstance(): ModelActionHook;
+    /**
+     * @internal
+     */
     registrar(modelAction: IUnknownModelAction): void;
+    /**
+     * @internal
+     */
     reset(): void;
 }
 export {};

package/dist/functions/hook/model-action.hook.js

@@ -5,10 +5,25 @@ import { Container } from '../container/container.js';
  * @internal
  */
 export class ModelActionHook {
+    /**
+     * @internal
+     */
     constructor() {
         this.postModelActionHooks = {};
         this.preModelActionHooks = {};
     }
+    /**
+     * @internal
+     */
+    static getInstance() {
+        if (!this.instance) {
+            this.instance = new ModelActionHook();
+        }
+        return this.instance;
+    }
+    /**
+     * @internal
+     */
     collectHooks(hooks) {
         for (const { action, handle } of hooks.postHooks || []) {
             if (!this.postModelActionHooks[action.constructor.name]) {
@@ -23,12 +38,9 @@ export class ModelActionHook {
             this.preModelActionHooks[action.constructor.name].push({ handle });
         }
     }
-    static getInstance() {
-        if (!this.instance) {
-            this.instance = new ModelActionHook();
-        }
-        return this.instance;
-    }
+    /**
+     * @internal
+     */
     registrar(modelAction) {
         // `self` here references this class, vs `this` references the original method.
         // eslint-disable-next-line @typescript-eslint/no-this-alias
@@ -50,6 +62,9 @@ export class ModelActionHook {
             return output;
         };
     }
+    /**
+     * @internal
+     */
     reset() {
         for (const name in this.postModelActionHooks) {
             delete this.postModelActionHooks[name];

package/dist/functions/hook/model-action.hook.js.map

@@ -1 +1 @@
-{"version":3,"file":"model-action.hook.js","sourceRoot":"","sources":["../../../src/functions/hook/model-action.hook.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oCAAoC,EAAE,mCAAmC,EAAE,MAAM,uBAAuB,CAAC;AAClH,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAYtD;;GAEG;AACH,MAAM,OAAO,eAAe;IAU1B;QAPiB,yBAAoB,GAEjC,EAAE,CAAC;QACU,wBAAmB,GAEhC,EAAE,CAAC;IAEgB,CAAC;IAExB,YAAY,CAAC,KAAyE;QACpF,KAAK,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,KAAK,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxD,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YAC1D,CAAC;YACD,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACtE,CAAC;QAED,KAAK,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,KAAK,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvD,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACzD,CAAC;YACD,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED,MAAM,CAAC,WAAW;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;QACxC,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,SAAS,CAAC,WAAgC;QACxC,+EAA+E;QAC/E,4DAA4D;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC;QAElB,MAAM,oBAAoB,GAAG,WAAW,CAAC,MAAM,CAAC;QAEhD,WAAW,CAAC,MAAM,GAAG,KAAK,WAAW,GAAG,IAA+C;YACrF,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,YAAY,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAEvD,IAAI,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAE3B,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBACtF,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;gBAC9D,YAAY,CAAC,IAAI,CAAC,IAAI,mCAAmC,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;YAC3F,CAAC;YAED,MAAM,GAAG,MAAM,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YAE5E,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBACvF,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;gBAC9D,YAAY,CAAC,IAAI,CAAC,IAAI,oCAAoC,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5F,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;IAED,KAAK;QACH,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC7C,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC5C,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"model-action.hook.js","sourceRoot":"","sources":["../../../src/functions/hook/model-action.hook.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oCAAoC,EAAE,mCAAmC,EAAE,MAAM,uBAAuB,CAAC;AAClH,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAYtD;;GAEG;AACH,MAAM,OAAO,eAAe;IAU1B;;OAEG;IACH;QAViB,yBAAoB,GAEjC,EAAE,CAAC;QACU,wBAAmB,GAEhC,EAAE,CAAC;IAKgB,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,WAAW;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;QACxC,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,KAAyE;QACpF,KAAK,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,KAAK,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxD,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YAC1D,CAAC;YACD,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACtE,CAAC;QAED,KAAK,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,KAAK,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvD,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACzD,CAAC;YACD,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,WAAgC;QACxC,+EAA+E;QAC/E,4DAA4D;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC;QAElB,MAAM,oBAAoB,GAAG,WAAW,CAAC,MAAM,CAAC;QAEhD,WAAW,CAAC,MAAM,GAAG,KAAK,WAAW,GAAG,IAA+C;YACrF,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,YAAY,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAEvD,IAAI,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAE3B,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBACtF,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;gBAC9D,YAAY,CAAC,IAAI,CAAC,IAAI,mCAAmC,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;YAC3F,CAAC;YAED,MAAM,GAAG,MAAM,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YAE5E,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBACvF,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;gBAC9D,YAAY,CAAC,IAAI,CAAC,IAAI,oCAAoC,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5F,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK;QACH,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC7C,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC5C,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;CACF"}

package/dist/functions/hook/resource-action.hook.d.ts

@@ -15,13 +15,28 @@ export declare class ResourceActionHook implements IHook<PreHookSignature, PostH
     private static instance;
     private readonly postResourceActionHooks;
     private readonly preResourceActionHooks;
+    /**
+     * @internal
+     */
     private constructor();
+    /**
+     * @internal
+     */
+    static getInstance(): ResourceActionHook;
+    /**
+     * @internal
+     */
     collectHooks(hooks: {
         postHooks?: PostHookSignature[];
         preHooks?: PreHookSignature[];
     }): void;
-    static getInstance(): ResourceActionHook;
+    /**
+     * @internal
+     */
     registrar(resourceAction: IUnknownResourceAction): void;
+    /**
+     * @internal
+     */
     reset(): void;
 }
 export {};

package/dist/functions/hook/resource-action.hook.js

@@ -5,10 +5,25 @@ import { Container } from '../container/container.js';
  * @internal
  */
 export class ResourceActionHook {
+    /**
+     * @internal
+     */
     constructor() {
         this.postResourceActionHooks = {};
         this.preResourceActionHooks = {};
     }
+    /**
+     * @internal
+     */
+    static getInstance() {
+        if (!this.instance) {
+            this.instance = new ResourceActionHook();
+        }
+        return this.instance;
+    }
+    /**
+     * @internal
+     */
     collectHooks(hooks) {
         for (const { action, handle } of hooks.postHooks || []) {
             if (!this.postResourceActionHooks[action.constructor.name]) {
@@ -23,12 +38,9 @@ export class ResourceActionHook {
             this.preResourceActionHooks[action.constructor.name].push({ handle });
         }
     }
-    static getInstance() {
-        if (!this.instance) {
-            this.instance = new ResourceActionHook();
-        }
-        return this.instance;
-    }
+    /**
+     * @internal
+     */
     registrar(resourceAction) {
         // `self` here references this class, vs `this` references the original method.
         // eslint-disable-next-line @typescript-eslint/no-this-alias
@@ -49,6 +61,9 @@ export class ResourceActionHook {
             return response;
         };
     }
+    /**
+     * @internal
+     */
     reset() {
         for (const name in this.postResourceActionHooks) {
             delete this.postResourceActionHooks[name];

package/dist/functions/hook/resource-action.hook.js.map

@@ -1 +1 @@
-{"version":3,"file":"resource-action.hook.js","sourceRoot":"","sources":["../../../src/functions/hook/resource-action.hook.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uCAAuC,EAAE,sCAAsC,EAAE,MAAM,uBAAuB,CAAC;AACxH,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAYtD;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAU7B;QAPiB,4BAAuB,GAEpC,EAAE,CAAC;QACU,2BAAsB,GAEnC,EAAE,CAAC;IAEgB,CAAC;IAExB,YAAY,CAAC,KAAyE;QACpF,KAAK,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,KAAK,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC3D,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7D,CAAC;YACD,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACzE,CAAC;QAED,KAAK,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,KAAK,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1D,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YAC5D,CAAC;YACD,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;IAED,MAAM,CAAC,WAAW;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAC3C,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,SAAS,CAAC,cAAsC;QAC9C,+EAA+E;QAC/E,4DAA4D;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC;QAElB,MAAM,oBAAoB,GAAG,cAAc,CAAC,MAAM,CAAC;QAEnD,cAAc,CAAC,MAAM,GAAG,KAAK,WAC3B,GAAG,IAAkD;YAErD,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,YAAY,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAEvD,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,sBAAsB,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC5F,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC/B,YAAY,CAAC,IAAI,CAAC,IAAI,sCAAsC,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;YACjG,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAE9D,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC7F,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC/B,YAAY,CAAC,IAAI,CAAC,IAAI,uCAAuC,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;YAClG,CAAC;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC;IACJ,CAAC;IAED,KAAK;QACH,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAChD,OAAO,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC/C,OAAO,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"resource-action.hook.js","sourceRoot":"","sources":["../../../src/functions/hook/resource-action.hook.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uCAAuC,EAAE,sCAAsC,EAAE,MAAM,uBAAuB,CAAC;AACxH,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAYtD;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAU7B;;OAEG;IACH;QAViB,4BAAuB,GAEpC,EAAE,CAAC;QACU,2BAAsB,GAEnC,EAAE,CAAC;IAKgB,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,WAAW;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAC3C,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,KAAyE;QACpF,KAAK,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,KAAK,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC3D,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7D,CAAC;YACD,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACzE,CAAC;QAED,KAAK,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,KAAK,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1D,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YAC5D,CAAC;YACD,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,cAAsC;QAC9C,+EAA+E;QAC/E,4DAA4D;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC;QAElB,MAAM,oBAAoB,GAAG,cAAc,CAAC,MAAM,CAAC;QAEnD,cAAc,CAAC,MAAM,GAAG,KAAK,WAC3B,GAAG,IAAkD;YAErD,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,YAAY,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAEvD,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,sBAAsB,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC5F,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC/B,YAAY,CAAC,IAAI,CAAC,IAAI,sCAAsC,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;YACjG,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAE9D,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC7F,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC/B,YAAY,CAAC,IAAI,CAAC,IAAI,uCAAuC,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;YAClG,CAAC;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK;QACH,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAChD,OAAO,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC/C,OAAO,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;CACF"}

package/dist/functions/node/node-action.abstract.d.ts

@@ -1,10 +1,31 @@
 import { Container } from '../container/container.js';
+import type { Diff } from '../diff/diff.js';
 /**
+ * The base class of every resource action: an action implementing {@link IResourceAction} must extend
+ * it. It gives the action the {@link Container}, and a `log()` that goes through Octo's event stream so
+ * its output lands in the command's report alongside everything else.
+ *
+ * @example
+ * ```ts
+ * @Action(MyResource)
+ * export class AddMyResourceAction extends ANodeAction implements IResourceAction<MyResource> { ... }
+ * ```
+ *
  * @group Functions/Node
  */
 export declare abstract class ANodeAction {
+    /**
+     * The container, for resolving whatever services or SDK clients the action needs.
+     */
     readonly container: Container;
-    private readonly eventService;
+    /**
+     * @internal
+     */
     protected constructor();
-    log(message: string, metadata?: Record<string, unknown>): void;
+    /**
+     * To report what the action is doing for `diff`, the diff its `handle()` was given. The message is
+     * emitted as an {@link ActionEvent}, so it is picked up by whatever listeners the command has,
+     * rather than written straight to the console.
+     */
+    log(diff: Diff, message: string, metadata?: Record<string, unknown>): void;
 }