@opencxh/domain 1.274.0 → 1.275.0

package/dist/entities/rule/types.d.ts

@@ -1,4 +1,5 @@
 import { OwnerScope } from '../scope/types';
+import { OutcomePrior, RunOutcome } from './outcome';
 /**
  * When something starts. One vocabulary for every executor.
  *
@@ -101,3 +102,46 @@ export interface RuleEvent {
     /** How many rule hops produced this event. Absent = zero, a genuine first cause. */
     depth?: number;
 }
+/** One line of a rule run log. `ok: false` is a step that did not land, not a rule that did not fire. */
+export interface RuleTraceEntry {
+    ruleId: string;
+    action?: string;
+    ok: boolean;
+    note: string;
+}
+/**
+ * What one action changed, captured when it ran — the params it was called with, which of those
+ * were content (a field the subject owns) rather than addressing, and those fields as they were.
+ * A key missing from `before` held nothing.
+ */
+export interface ActionPrior extends OutcomePrior {
+    /** The rule that ran this action. Empty for an undo replay. */
+    ruleId?: string;
+    before: Record<string, unknown>;
+}
+/** What an owning app's write path posts after a rule acted: one rule, one event. */
+export interface RuleRunRecord {
+    ruleId: string;
+    ruleName?: string;
+    eventName: string;
+    eventId: string;
+    subjectKind?: string;
+    subjectId?: string;
+    applied: number;
+    trace: RuleTraceEntry[];
+    priors: ActionPrior[];
+}
+/**
+ * One thing a rule did, once, as the run log stores it. Written only when something happened.
+ *
+ * `outcome` is stamped an hour after the fact; empty means "not judged yet", and `unknown` is
+ * deliberately not `kept` — "nobody objected" and "we could not look" are different facts.
+ */
+export interface RuleRun extends RuleRunRecord {
+    id: string;
+    undoneAt?: number;
+    undoneBy?: string;
+    outcome?: RunOutcome | "";
+    outcomeAt?: number;
+    createdAt?: number;
+}