@nocobase/app-plugin-projects 0.0.0-stage → 0.1.0-beta.2

package/dist/server/lifecycle/definition.js

@@ -0,0 +1,18 @@
+/**
+ * A lifecycle definition: the states a record can be in and who may move it from one to another. It is plain JSON, so
+ * it can be stored, compared and edited; `compile` turns it into a machine the application asks, and `move` is the one
+ * way a record changes state.
+ *
+ * The vocabulary follows statecharts (states, transitions, guards, entry actions), but a record's state lives in its
+ * own row and every check is asynchronous, so nothing here keeps a running instance in memory.
+ */
+/** `*` stands for any state. */
+export const ANY_STATE = '*';
+export const DEFAULT_LIMITS = {
+    states: 40,
+    transitions: 400,
+    nameLength: 64,
+    rulesPerState: 10,
+};
+export const STATE_KEY_PATTERN = /^[a-z][a-z0-9_]{1,31}$/u;
+//# sourceMappingURL=definition.js.map

package/dist/server/lifecycle/definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definition.js","sourceRoot":"","sources":["../../../server/lifecycle/definition.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAwBH,gCAAgC;AAChC,MAAM,CAAC,MAAM,SAAS,GAAG,GAAG,CAAC;AA6C7B,MAAM,CAAC,MAAM,cAAc,GAAoB;IAC7C,MAAM,EAAE,EAAE;IACV,WAAW,EAAE,GAAG;IAChB,UAAU,EAAE,EAAE;IACd,aAAa,EAAE,EAAE;CAClB,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAW,yBAAyB,CAAC"}

package/dist/server/lifecycle/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * A record lifecycle: a state machine whose definition is data and whose state lives in the record. Self-contained on
+ * purpose (nothing from this plugin's domains), so it can move into a platform package once another plugin needs it.
+ */
+export { ANY_STATE, DEFAULT_LIMITS, STATE_KEY_PATTERN, type LifecycleApproval, type LifecycleDefinition, type LifecycleLimits, type LifecycleRuleRef, type LifecycleSchema, type LifecycleState, type LifecycleTransition, } from './definition.js';
+export { compile, type LifecycleMachine } from './machine.js';
+export { canMove, fire, LifecycleError, move, type ApprovalNote, type EntryReport, type LifecycleErrorCode, type MoveRequest, type MoveResult, UNAVAILABLE_RULE, } from './move.js';
+export { createLifecycleRegistry, type ApproverResolver, type EntryOutcome, type GuardFailure, type LifecycleActor, type LifecycleRegistry, type RuleConfig, type RuleContext, type StateRule, type WhoRule, } from './registry.js';
+export { validateDefinition, type LifecycleIssue, type LifecycleRule, type ValidateOptions, type ValidationResult, } from './validate.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/server/lifecycle/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../server/lifecycle/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EACL,SAAS,EACT,cAAc,EACd,iBAAiB,EACjB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,mBAAmB,GACzB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,EACL,OAAO,EACP,IAAI,EACJ,cAAc,EACd,IAAI,EACJ,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,gBAAgB,GACjB,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,uBAAuB,EACvB,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,OAAO,GACb,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,kBAAkB,EAClB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB,MAAM,eAAe,CAAC"}

package/dist/server/lifecycle/index.js

@@ -0,0 +1,10 @@
+/**
+ * A record lifecycle: a state machine whose definition is data and whose state lives in the record. Self-contained on
+ * purpose (nothing from this plugin's domains), so it can move into a platform package once another plugin needs it.
+ */
+export { ANY_STATE, DEFAULT_LIMITS, STATE_KEY_PATTERN, } from './definition.js';
+export { compile } from './machine.js';
+export { canMove, fire, LifecycleError, move, UNAVAILABLE_RULE, } from './move.js';
+export { createLifecycleRegistry, } from './registry.js';
+export { validateDefinition, } from './validate.js';
+//# sourceMappingURL=index.js.map

package/dist/server/lifecycle/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../server/lifecycle/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EACL,SAAS,EACT,cAAc,EACd,iBAAiB,GAQlB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,OAAO,EAAyB,MAAM,cAAc,CAAC;AAC9D,OAAO,EACL,OAAO,EACP,IAAI,EACJ,cAAc,EACd,IAAI,EAMJ,gBAAgB,GACjB,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,uBAAuB,GAUxB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,kBAAkB,GAKnB,MAAM,eAAe,CAAC"}

package/dist/server/lifecycle/machine.d.ts

@@ -0,0 +1,23 @@
+/**
+ * A compiled definition: what the application asks about states and moves. Event transitions (`on`) are never an
+ * ordinary move: `canTransition` and `allowedMoves` leave them out, and `eventTarget` answers for them.
+ */
+import { type LifecycleDefinition, type LifecycleState } from './definition.js';
+export interface LifecycleMachine {
+    readonly definition: LifecycleDefinition;
+    /** In definition order. */
+    readonly states: readonly LifecycleState[];
+    isKnown(key: string): boolean;
+    category(key: string): string | null;
+    /**
+     * Whether `actor` may move a record from `from` to `to`. `to` must be a state of this definition; `from` need not
+     * be (a record that came from another definition), in which case only transitions from `*` apply.
+     */
+    canTransition(from: string, to: string, actor: string): boolean;
+    /** The states `actor` may move a record in `from` to, in definition order. */
+    allowedMoves(from: string, actor: string): readonly string[];
+    /** Where `event` takes a record in `from`, or null when no event transition leaves `from` on it. */
+    eventTarget(from: string, event: string): string | null;
+}
+export declare function compile(definition: LifecycleDefinition): LifecycleMachine;
+//# sourceMappingURL=machine.d.ts.map

package/dist/server/lifecycle/machine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"machine.d.ts","sourceRoot":"","sources":["../../../server/lifecycle/machine.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAEL,KAAK,mBAAmB,EACxB,KAAK,cAAc,EACpB,MAAM,iBAAiB,CAAC;AAEzB,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,UAAU,EAAE,mBAAmB,CAAC;IACzC,2BAA2B;IAC3B,QAAQ,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,CAAC;IAC3C,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACrC;;;OAGG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IAChE,8EAA8E;IAC9E,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;IAC7D,oGAAoG;IACpG,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CACzD;AAKD,wBAAgB,OAAO,CAAC,UAAU,EAAE,mBAAmB,GAAG,gBAAgB,CA6BzE"}

package/dist/server/lifecycle/machine.js

@@ -0,0 +1,27 @@
+/**
+ * A compiled definition: what the application asks about states and moves. Event transitions (`on`) are never an
+ * ordinary move: `canTransition` and `allowedMoves` leave them out, and `eventTarget` answers for them.
+ */
+import { ANY_STATE, } from './definition.js';
+const matches = (pattern, key) => pattern === ANY_STATE || pattern === key;
+export function compile(definition) {
+    const byKey = new Map(definition.states.map((state) => [state.key, state]));
+    const keys = definition.states.map((state) => state.key);
+    /** `from → to` pairs per actor, with `from` possibly outside the definition only through `*`. */
+    const allowed = (from, to, actor) => from !== to &&
+        byKey.has(to) &&
+        definition.transitions.some((transition) => transition.on === undefined &&
+            transition.actors.includes(actor) &&
+            matches(transition.from, from) &&
+            matches(transition.to, to));
+    return {
+        definition,
+        states: definition.states,
+        isKnown: (key) => byKey.has(key),
+        category: (key) => byKey.get(key)?.category ?? null,
+        canTransition: allowed,
+        allowedMoves: (from, actor) => keys.filter((to) => allowed(from, to, actor)),
+        eventTarget: (from, event) => definition.transitions.find((transition) => transition.on === event && transition.from === from)?.to ?? null,
+    };
+}
+//# sourceMappingURL=machine.js.map

package/dist/server/lifecycle/machine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"machine.js","sourceRoot":"","sources":["../../../server/lifecycle/machine.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EACL,SAAS,GAGV,MAAM,iBAAiB,CAAC;AAmBzB,MAAM,OAAO,GAAG,CAAC,OAAe,EAAE,GAAW,EAAE,EAAE,CAC/C,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,GAAG,CAAC;AAE3C,MAAM,UAAU,OAAO,CAAC,UAA+B;IACrD,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAC5E,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEzD,iGAAiG;IACjG,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAU,EAAE,KAAa,EAAE,EAAE,CAC1D,IAAI,KAAK,EAAE;QACX,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACb,UAAU,CAAC,WAAW,CAAC,IAAI,CACzB,CAAC,UAAU,EAAE,EAAE,CACb,UAAU,CAAC,EAAE,KAAK,SAAS;YAC3B,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YACjC,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;YAC9B,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAC7B,CAAC;IAEJ,OAAO;QACL,UAAU;QACV,MAAM,EAAE,UAAU,CAAC,MAAM;QACzB,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;QAChC,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,QAAQ,IAAI,IAAI;QACnD,aAAa,EAAE,OAAO;QACtB,YAAY,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAC5B,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QAC/C,WAAW,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAC3B,UAAU,CAAC,WAAW,CAAC,IAAI,CACzB,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,KAAK,KAAK,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI,CACpE,EAAE,EAAE,IAAI,IAAI;KAChB,CAAC;AACJ,CAAC"}

package/dist/server/lifecycle/move.d.ts

@@ -0,0 +1,93 @@
+/**
+ * The one way a record changes state. `move` runs inside the caller's unit of work (its transaction travels in
+ * `context`) and knows nothing about storage: `apply` writes the new state. The steps, in order:
+ *
+ * 1. Who may: a transition from `from` to `to` names the actor's type, and its "who may" rule, if any, allows the actor.
+ * 2. Guards: the state rules of `from` allow leaving it and those of `to` allow entering it.
+ * 3. Approval: when a transition taken needs one, the move stops as `pending` with the people who may approve it,
+ *    unless nobody resolves (no approver) or the actor is one of them (self). An approved move passes `approved`.
+ * 4. `apply`.
+ * 5. Entry actions: the state rules of `to`, each in `isolate` (a savepoint), so one failing leaves the move and the
+ *    other actions in place. Each reports what it did; a rule the registry no longer has is skipped (`unavailable`),
+ *    so a definition naming the rule of a removed plugin still moves.
+ *
+ * A move with an `event` may take only that event's transitions, and a move without one never takes them; `fire`
+ * finds where an event leads and moves there.
+ */
+import type { LifecycleMachine } from './machine.js';
+import type { GuardFailure, LifecycleActor, LifecycleRegistry } from './registry.js';
+export type LifecycleErrorCode = 'UNKNOWN_STATE' | 'TRANSITION_NOT_ALLOWED' | 'GUARD_FAILED';
+export declare class LifecycleError extends Error {
+    readonly code: LifecycleErrorCode;
+    /** Set for `GUARD_FAILED`: what the guard said, and which rule it was. */
+    readonly failure?: GuardFailure & {
+        readonly rule: string;
+    };
+    constructor(code: LifecycleErrorCode, message: string, failure?: GuardFailure & {
+        readonly rule: string;
+    });
+}
+export interface MoveRequest<Subject, Context> {
+    readonly from: string;
+    readonly to: string;
+    readonly actor: LifecycleActor;
+    readonly subject: Subject;
+    readonly context: Context;
+    /** The approval was given already: step 3 is skipped. */
+    readonly approved?: boolean;
+    /** Guards are not asked (a system write that must go through). */
+    readonly skipGuards?: boolean;
+    /** The event this move answers: only transitions with the same `on` are taken (none when unset). */
+    readonly event?: string;
+    /**
+     * Runs one entry action so that its failure leaves the rest of the work intact (a savepoint), handing it the context
+     * to use inside; defaults to running it directly with `context`.
+     */
+    readonly isolate?: <T>(run: (context: Context) => Promise<T>) => Promise<T>;
+}
+/** Why the move needed no approval step: none required, the actor approves it, nobody resolved, or it was given. */
+export type ApprovalNote = 'none' | 'self' | 'noApprover' | 'approved';
+export interface EntryReport {
+    readonly rule: string;
+    readonly status: 'applied' | 'skipped' | 'failed';
+    readonly reason?: string;
+    readonly details?: Readonly<Record<string, unknown>>;
+    readonly error?: unknown;
+}
+/** The reason a rule the registry does not have is skipped. */
+export declare const UNAVAILABLE_RULE = "unavailable";
+export type MoveResult = {
+    readonly outcome: 'unchanged';
+} | {
+    readonly outcome: 'pending';
+    /** The approver names of the transitions taken. */
+    readonly approvers: readonly string[];
+    /** The people they resolve to. */
+    readonly approverIds: readonly string[];
+} | {
+    readonly outcome: 'moved';
+    readonly approval: ApprovalNote;
+    readonly entry: readonly EntryReport[];
+};
+/**
+ * Steps 1 and 2 alone: whether the actor may take the record from `from` to `to` now (who may, and the guards unless
+ * skipped). Nothing is written; the error is what `move` would throw.
+ */
+export declare function canMove<Subject, Context>(machine: LifecycleMachine, registry: LifecycleRegistry<Subject, Context>, request: Omit<MoveRequest<Subject, Context>, 'approved' | 'isolate'>): Promise<{
+    readonly ok: true;
+} | {
+    readonly ok: false;
+    readonly error: LifecycleError;
+}>;
+export declare function move<Subject, Context>(machine: LifecycleMachine, registry: LifecycleRegistry<Subject, Context>, request: MoveRequest<Subject, Context>, apply: () => Promise<void>): Promise<MoveResult>;
+/**
+ * Moves the record where `event` takes it from `from`, through `move` with every step but approval (an event has
+ * nobody to ask): guards still apply and refuse with `GUARD_FAILED`. `ignored` when no event transition leaves `from`
+ * on it.
+ */
+export declare function fire<Subject, Context>(machine: LifecycleMachine, registry: LifecycleRegistry<Subject, Context>, request: Omit<MoveRequest<Subject, Context>, 'to' | 'approved' | 'event'> & {
+    readonly event: string;
+}, apply: (to: string) => Promise<void>): Promise<MoveResult | {
+    readonly outcome: 'ignored';
+}>;
+//# sourceMappingURL=move.d.ts.map

package/dist/server/lifecycle/move.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"move.d.ts","sourceRoot":"","sources":["../../../server/lifecycle/move.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAMrD,OAAO,KAAK,EACV,YAAY,EACZ,cAAc,EACd,iBAAiB,EAElB,MAAM,eAAe,CAAC;AAEvB,MAAM,MAAM,kBAAkB,GAC5B,eAAe,GAAG,wBAAwB,GAAG,cAAc,CAAC;AAE9D,qBAAa,cAAe,SAAQ,KAAK;IACvC,SAAgB,IAAI,EAAE,kBAAkB,CAAC;IACzC,0EAA0E;IAC1E,SAAgB,OAAO,CAAC,EAAE,YAAY,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;gBAGjE,IAAI,EAAE,kBAAkB,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,YAAY,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE;CAOrD;AAED,MAAM,WAAW,WAAW,CAAC,OAAO,EAAE,OAAO;IAC3C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAC/B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,yDAAyD;IACzD,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,kEAAkE;IAClE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,oGAAoG;IACpG,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;CAC7E;AAED,oHAAoH;AACpH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,CAAC;AAEvE,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;IAClD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACrD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,+DAA+D;AAC/D,eAAO,MAAM,gBAAgB,gBAAgB,CAAC;AAE9C,MAAM,MAAM,UAAU,GAClB;IAAE,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAA;CAAE,GACjC;IACE,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC;IAC5B,mDAAmD;IACnD,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;IACtC,kCAAkC;IAClC,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;CACzC,GACD;IACE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAC;CACxC,CAAC;AAgIN;;;GAGG;AACH,wBAAsB,OAAO,CAAC,OAAO,EAAE,OAAO,EAC5C,OAAO,EAAE,gBAAgB,EACzB,QAAQ,EAAE,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,EAC7C,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC,GACnE,OAAO,CACR;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAA;CAAE,CAC/E,CAyBA;AAED,wBAAsB,IAAI,CAAC,OAAO,EAAE,OAAO,EACzC,OAAO,EAAE,gBAAgB,EACzB,QAAQ,EAAE,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,EAC7C,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,EACtC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GACzB,OAAO,CAAC,UAAU,CAAC,CAmCrB;AAED;;;;GAIG;AACH,wBAAsB,IAAI,CAAC,OAAO,EAAE,OAAO,EACzC,OAAO,EAAE,gBAAgB,EACzB,QAAQ,EAAE,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,EAC7C,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,IAAI,GAAG,UAAU,GAAG,OAAO,CAAC,GAAG;IAC1E,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,EACD,KAAK,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GACnC,OAAO,CAAC,UAAU,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAA;CAAE,CAAC,CAMvD"}

package/dist/server/lifecycle/move.js

@@ -0,0 +1,181 @@
+import { ANY_STATE, } from './definition.js';
+export class LifecycleError extends Error {
+    code;
+    /** Set for `GUARD_FAILED`: what the guard said, and which rule it was. */
+    failure;
+    constructor(code, message, failure) {
+        super(message);
+        this.name = 'LifecycleError';
+        this.code = code;
+        if (failure)
+            this.failure = failure;
+    }
+}
+/** The reason a rule the registry does not have is skipped. */
+export const UNAVAILABLE_RULE = 'unavailable';
+const matches = (pattern, key) => pattern === ANY_STATE || pattern === key;
+const stateOf = (machine, key) => machine.states.find((state) => state.key === key);
+const rulesOf = (state) => state?.rules ?? [];
+/** The transitions the actor may take from `from` to `to`, "who may" rules included. */
+async function takeable(machine, registry, ctx, event) {
+    const taken = [];
+    for (const transition of machine.definition.transitions) {
+        if (transition.on !== event ||
+            !transition.actors.includes(ctx.actor.type) ||
+            !matches(transition.from, ctx.from) ||
+            !matches(transition.to, ctx.to))
+            continue;
+        if (transition.who) {
+            const rule = registry.findWhoRule(transition.who.type);
+            if (!rule || !(await rule.allows(ctx, transition.who.config ?? {})))
+                continue;
+        }
+        taken.push(transition);
+    }
+    return taken;
+}
+async function checkGuards(machine, registry, ctx) {
+    const checks = [
+        ...rulesOf(stateOf(machine, ctx.from)).map((ref) => ({
+            ref,
+            leaving: true,
+        })),
+        ...rulesOf(stateOf(machine, ctx.to)).map((ref) => ({
+            ref,
+            leaving: false,
+        })),
+    ];
+    for (const { ref, leaving } of checks) {
+        const rule = registry.findStateRule(ref.type);
+        const config = ref.config ?? {};
+        const failure = await (leaving
+            ? rule?.canLeave?.(ctx, config)
+            : rule?.canEnter?.(ctx, config));
+        if (failure)
+            throw new LifecycleError('GUARD_FAILED', failure.message, {
+                ...failure,
+                rule: ref.type,
+            });
+    }
+}
+async function approvalStep(registry, ctx, taken) {
+    // When several transitions apply (`* → *` and `in_review → done`), one needing an approval is enough.
+    const approvers = [
+        ...new Set(taken.flatMap((item) => item.approval?.approvers ?? [])),
+    ];
+    if (approvers.length === 0)
+        return { note: 'none' };
+    const ids = new Set();
+    for (const name of approvers)
+        for (const id of (await registry.findApprover(name)?.resolve(ctx)) ?? [])
+            ids.add(id);
+    if (ids.size === 0)
+        return { note: 'noApprover' };
+    if (ctx.actor.id !== null && ids.has(ctx.actor.id))
+        return { note: 'self' };
+    return { approvers, approverIds: [...ids] };
+}
+async function runEntry(machine, registry, ctx, isolate) {
+    const reports = [];
+    for (const ref of rulesOf(stateOf(machine, ctx.to))) {
+        const rule = registry.findStateRule(ref.type);
+        if (!rule) {
+            reports.push({
+                rule: ref.type,
+                status: 'skipped',
+                reason: UNAVAILABLE_RULE,
+            });
+            continue;
+        }
+        const entered = rule.entered?.bind(rule);
+        if (!entered)
+            continue;
+        try {
+            const outcome = await isolate((context) => entered({ ...ctx, context }, ref.config ?? {}));
+            const details = outcome?.details ? { details: outcome.details } : {};
+            reports.push(outcome?.status === 'skipped'
+                ? {
+                    rule: ref.type,
+                    status: 'skipped',
+                    reason: outcome.reason,
+                    ...details,
+                }
+                : { rule: ref.type, status: 'applied', ...details });
+        }
+        catch (error) {
+            reports.push({ rule: ref.type, status: 'failed', error });
+        }
+    }
+    return reports;
+}
+/**
+ * Steps 1 and 2 alone: whether the actor may take the record from `from` to `to` now (who may, and the guards unless
+ * skipped). Nothing is written; the error is what `move` would throw.
+ */
+export async function canMove(machine, registry, request) {
+    try {
+        const { from, to, actor } = request;
+        if (!machine.isKnown(to))
+            throw new LifecycleError('UNKNOWN_STATE', `There is no state ${to}.`);
+        const ctx = {
+            subject: request.subject,
+            from,
+            to,
+            actor,
+            machine,
+            context: request.context,
+            ...(request.event === undefined ? {} : { event: request.event }),
+        };
+        if ((await takeable(machine, registry, ctx, request.event)).length === 0)
+            throw new LifecycleError('TRANSITION_NOT_ALLOWED', `Moving from ${from} to ${to} is not allowed.`);
+        if (!request.skipGuards)
+            await checkGuards(machine, registry, ctx);
+        return { ok: true };
+    }
+    catch (error) {
+        if (error instanceof LifecycleError)
+            return { ok: false, error };
+        throw error;
+    }
+}
+export async function move(machine, registry, request, apply) {
+    const { from, to, actor } = request;
+    if (!machine.isKnown(to))
+        throw new LifecycleError('UNKNOWN_STATE', `There is no state ${to}.`);
+    if (from === to)
+        return { outcome: 'unchanged' };
+    const ctx = {
+        subject: request.subject,
+        from,
+        to,
+        actor,
+        machine,
+        context: request.context,
+        ...(request.event === undefined ? {} : { event: request.event }),
+    };
+    const taken = await takeable(machine, registry, ctx, request.event);
+    if (taken.length === 0)
+        throw new LifecycleError('TRANSITION_NOT_ALLOWED', `Moving from ${from} to ${to} is not allowed.`);
+    if (!request.skipGuards)
+        await checkGuards(machine, registry, ctx);
+    const approval = request.approved
+        ? { note: 'approved' }
+        : await approvalStep(registry, ctx, taken);
+    if (!('note' in approval))
+        return { outcome: 'pending', ...approval };
+    await apply();
+    const entry = await runEntry(machine, registry, ctx, request.isolate ?? ((run) => run(request.context)));
+    return { outcome: 'moved', approval: approval.note, entry };
+}
+/**
+ * Moves the record where `event` takes it from `from`, through `move` with every step but approval (an event has
+ * nobody to ask): guards still apply and refuse with `GUARD_FAILED`. `ignored` when no event transition leaves `from`
+ * on it.
+ */
+export async function fire(machine, registry, request, apply) {
+    const to = machine.eventTarget(request.from, request.event);
+    if (to === null)
+        return { outcome: 'ignored' };
+    return move(machine, registry, { ...request, to, approved: true }, () => apply(to));
+}
+//# sourceMappingURL=move.js.map

package/dist/server/lifecycle/move.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"move.js","sourceRoot":"","sources":["../../../server/lifecycle/move.ts"],"names":[],"mappings":"AAiBA,OAAO,EACL,SAAS,GAGV,MAAM,iBAAiB,CAAC;AAWzB,MAAM,OAAO,cAAe,SAAQ,KAAK;IACvB,IAAI,CAAqB;IACzC,0EAA0E;IAC1D,OAAO,CAA4C;IAEnE,YACE,IAAwB,EACxB,OAAe,EACf,OAAkD;QAElD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,OAAO;YAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACtC,CAAC;CACF;AAgCD,+DAA+D;AAC/D,MAAM,CAAC,MAAM,gBAAgB,GAAG,aAAa,CAAC;AAiB9C,MAAM,OAAO,GAAG,CAAC,OAAe,EAAE,GAAW,EAAE,EAAE,CAC/C,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,GAAG,CAAC;AAE3C,MAAM,OAAO,GAAG,CAAC,OAAyB,EAAE,GAAW,EAAE,EAAE,CACzD,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;AAEpD,MAAM,OAAO,GAAG,CAAC,KAAiC,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,IAAI,EAAE,CAAC;AAE1E,wFAAwF;AACxF,KAAK,UAAU,QAAQ,CACrB,OAAyB,EACzB,QAA6C,EAC7C,GAAkC,EAClC,KAAyB;IAEzB,MAAM,KAAK,GAA0B,EAAE,CAAC;IACxC,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;QACxD,IACE,UAAU,CAAC,EAAE,KAAK,KAAK;YACvB,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;YAC3C,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC;YACnC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC;YAE/B,SAAS;QACX,IAAI,UAAU,CAAC,GAAG,EAAE,CAAC;YACnB,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACvD,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;gBACjE,SAAS;QACb,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,KAAK,UAAU,WAAW,CACxB,OAAyB,EACzB,QAA6C,EAC7C,GAAkC;IAElC,MAAM,MAAM,GAAG;QACb,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACnD,GAAG;YACH,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;QACH,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACjD,GAAG;YACH,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;KACJ,CAAC;IACF,KAAK,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,MAAM,EAAE,CAAC;QACtC,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO;YAC5B,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC;YAC/B,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC;QACnC,IAAI,OAAO;YACT,MAAM,IAAI,cAAc,CAAC,cAAc,EAAE,OAAO,CAAC,OAAO,EAAE;gBACxD,GAAG,OAAO;gBACV,IAAI,EAAE,GAAG,CAAC,IAAI;aACf,CAAC,CAAC;IACP,CAAC;AACH,CAAC;AAED,KAAK,UAAU,YAAY,CACzB,QAA6C,EAC7C,GAAkC,EAClC,KAAqC;IAKrC,sGAAsG;IACtG,MAAM,SAAS,GAAG;QAChB,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC;KACpE,CAAC;IACF,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACpD,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,KAAK,MAAM,IAAI,IAAI,SAAS;QAC1B,KAAK,MAAM,EAAE,IAAI,CAAC,MAAM,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE;YACtE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IAClD,IAAI,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC5E,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC;AAC9C,CAAC;AAED,KAAK,UAAU,QAAQ,CACrB,OAAyB,EACzB,QAA6C,EAC7C,GAAkC,EAClC,OAAiE;IAEjE,MAAM,OAAO,GAAkB,EAAE,CAAC;IAClC,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,CAAC;gBACX,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,MAAM,EAAE,SAAS;gBACjB,MAAM,EAAE,gBAAgB;aACzB,CAAC,CAAC;YACH,SAAS;QACX,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,OAAO;YAAE,SAAS;QACvB,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CACxC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE,OAAO,EAAE,EAAE,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAC/C,CAAC;YACF,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrE,OAAO,CAAC,IAAI,CACV,OAAO,EAAE,MAAM,KAAK,SAAS;gBAC3B,CAAC,CAAC;oBACE,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,GAAG,OAAO;iBACX;gBACH,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,CACtD,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,OAAyB,EACzB,QAA6C,EAC7C,OAAoE;IAIpE,IAAI,CAAC;QACH,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QACpC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,cAAc,CAAC,eAAe,EAAE,qBAAqB,EAAE,GAAG,CAAC,CAAC;QACxE,MAAM,GAAG,GAAkC;YACzC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,IAAI;YACJ,EAAE;YACF,KAAK;YACL,OAAO;YACP,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;SACjE,CAAC;QACF,IAAI,CAAC,MAAM,QAAQ,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC;YACtE,MAAM,IAAI,cAAc,CACtB,wBAAwB,EACxB,eAAe,IAAI,OAAO,EAAE,kBAAkB,CAC/C,CAAC;QACJ,IAAI,CAAC,OAAO,CAAC,UAAU;YAAE,MAAM,WAAW,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;QACnE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,cAAc;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;QACjE,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,OAAyB,EACzB,QAA6C,EAC7C,OAAsC,EACtC,KAA0B;IAE1B,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IACpC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,cAAc,CAAC,eAAe,EAAE,qBAAqB,EAAE,GAAG,CAAC,CAAC;IACxE,IAAI,IAAI,KAAK,EAAE;QAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;IACjD,MAAM,GAAG,GAAkC;QACzC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,IAAI;QACJ,EAAE;QACF,KAAK;QACL,OAAO;QACP,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;KACjE,CAAC;IAEF,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACpE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QACpB,MAAM,IAAI,cAAc,CACtB,wBAAwB,EACxB,eAAe,IAAI,OAAO,EAAE,kBAAkB,CAC/C,CAAC;IACJ,IAAI,CAAC,OAAO,CAAC,UAAU;QAAE,MAAM,WAAW,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IACnE,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ;QAC/B,CAAC,CAAC,EAAE,IAAI,EAAE,UAAmB,EAAE;QAC/B,CAAC,CAAC,MAAM,YAAY,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAC7C,IAAI,CAAC,CAAC,MAAM,IAAI,QAAQ,CAAC;QAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,QAAQ,EAAE,CAAC;IAEtE,MAAM,KAAK,EAAE,CAAC;IACd,MAAM,KAAK,GAAG,MAAM,QAAQ,CAC1B,OAAO,EACP,QAAQ,EACR,GAAG,EACH,OAAO,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CACnD,CAAC;IACF,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;AAC9D,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,OAAyB,EACzB,QAA6C,EAC7C,OAEC,EACD,KAAoC;IAEpC,MAAM,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAC5D,IAAI,EAAE,KAAK,IAAI;QAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;IAC/C,OAAO,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CACtE,KAAK,CAAC,EAAE,CAAC,CACV,CAAC;AACJ,CAAC"}

package/dist/server/lifecycle/registry.d.ts

@@ -0,0 +1,73 @@
+/**
+ * The rules a definition may name, registered by the application. A definition stays plain data: it names a rule and
+ * gives its settings, and the registry holds the code.
+ *
+ * - State rules guard entering or leaving a state and act once a record entered it.
+ * - "Who may" rules decide, from the record, whether an actor may take a transition.
+ * - Approvers turn a name (`owner`) into the people who may approve a move of this record.
+ *
+ * `Subject` is the record being moved and `Context` whatever the application passes through `move` (its transaction,
+ * for example), so rules read and write where the move does.
+ */
+import type { LifecycleMachine } from './machine.js';
+import type { LifecycleIssue } from './validate.js';
+/** Who moves a record: an actor type the definition names on its transitions, and who exactly when known. */
+export interface LifecycleActor {
+    readonly type: string;
+    readonly id: string | null;
+}
+export type RuleConfig = Readonly<Record<string, unknown>>;
+export interface RuleContext<Subject, Context> {
+    readonly subject: Subject;
+    readonly from: string;
+    readonly to: string;
+    readonly actor: LifecycleActor;
+    readonly machine: LifecycleMachine;
+    readonly context: Context;
+    /** The event the move answers, for a move along an event transition. */
+    readonly event?: string;
+}
+/** Why a guard refused a move; `code` reaches the caller as it is. */
+export interface GuardFailure {
+    readonly code: string;
+    readonly message: string;
+    readonly details?: Readonly<Record<string, unknown>>;
+}
+/** What an entry action did; `undefined` counts as applied. `details` travel to the report as they are. */
+export type EntryOutcome = {
+    readonly status: 'applied';
+    readonly details?: Readonly<Record<string, unknown>>;
+} | {
+    readonly status: 'skipped';
+    readonly reason: string;
+    readonly details?: Readonly<Record<string, unknown>>;
+};
+export interface StateRule<Subject, Context> {
+    /** Problems with the settings, at paths relative to them (`items[0].key`). */
+    validate?(config: RuleConfig): readonly LifecycleIssue[];
+    /** Checked before a record enters a state carrying the rule. */
+    canEnter?(ctx: RuleContext<Subject, Context>, config: RuleConfig): Promise<GuardFailure | null>;
+    /** Checked before a record leaves a state carrying the rule. */
+    canLeave?(ctx: RuleContext<Subject, Context>, config: RuleConfig): Promise<GuardFailure | null>;
+    /** Run after the record entered the state; a failure never undoes the move. */
+    entered?(ctx: RuleContext<Subject, Context>, config: RuleConfig): Promise<EntryOutcome | undefined>;
+}
+export interface WhoRule<Subject, Context> {
+    validate?(config: RuleConfig): readonly LifecycleIssue[];
+    allows(ctx: RuleContext<Subject, Context>, config: RuleConfig): Promise<boolean>;
+}
+export interface ApproverResolver<Subject, Context> {
+    /** The ids of the people who may approve; none means nobody has to. */
+    resolve(ctx: RuleContext<Subject, Context>): Promise<readonly string[]>;
+}
+export interface LifecycleRegistry<Subject, Context> {
+    /** Each registers one name, once; they return the registry so registrations chain. */
+    stateRule(type: string, rule: StateRule<Subject, Context>): LifecycleRegistry<Subject, Context>;
+    whoRule(type: string, rule: WhoRule<Subject, Context>): LifecycleRegistry<Subject, Context>;
+    approver(name: string, resolver: ApproverResolver<Subject, Context>): LifecycleRegistry<Subject, Context>;
+    findStateRule(type: string): StateRule<Subject, Context> | undefined;
+    findWhoRule(type: string): WhoRule<Subject, Context> | undefined;
+    findApprover(name: string): ApproverResolver<Subject, Context> | undefined;
+}
+export declare function createLifecycleRegistry<Subject, Context>(): LifecycleRegistry<Subject, Context>;
+//# sourceMappingURL=registry.d.ts.map

package/dist/server/lifecycle/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../server/lifecycle/registry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAEpD,6GAA6G;AAC7G,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAE3D,MAAM,WAAW,WAAW,CAAC,OAAO,EAAE,OAAO;IAC3C,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAC/B,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACnC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,wEAAwE;IACxE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,sEAAsE;AACtE,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACtD;AAED,2GAA2G;AAC3G,MAAM,MAAM,YAAY,GACpB;IACE,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACtD,GACD;IACE,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACtD,CAAC;AAEN,MAAM,WAAW,SAAS,CAAC,OAAO,EAAE,OAAO;IACzC,8EAA8E;IAC9E,QAAQ,CAAC,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,cAAc,EAAE,CAAC;IACzD,gEAAgE;IAChE,QAAQ,CAAC,CACP,GAAG,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,EAClC,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IAChC,gEAAgE;IAChE,QAAQ,CAAC,CACP,GAAG,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,EAClC,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IAChC,+EAA+E;IAC/E,OAAO,CAAC,CACN,GAAG,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,EAClC,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,OAAO,CAAC,OAAO,EAAE,OAAO;IACvC,QAAQ,CAAC,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,cAAc,EAAE,CAAC;IACzD,MAAM,CACJ,GAAG,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,EAClC,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,OAAO,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB,CAAC,OAAO,EAAE,OAAO;IAChD,uEAAuE;IACvE,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,SAAS,MAAM,EAAE,CAAC,CAAC;CACzE;AAED,MAAM,WAAW,iBAAiB,CAAC,OAAO,EAAE,OAAO;IACjD,sFAAsF;IACtF,SAAS,CACP,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,GAChC,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvC,OAAO,CACL,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,GAC9B,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvC,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,GAC3C,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IACrE,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IACjE,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAC5E;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,OAAO,KAAK,iBAAiB,CAC5E,OAAO,EACP,OAAO,CACR,CA6BA"}

package/dist/server/lifecycle/registry.js

@@ -0,0 +1,29 @@
+export function createLifecycleRegistry() {
+    const states = new Map();
+    const who = new Map();
+    const approvers = new Map();
+    function add(map, kind, name, value) {
+        if (map.has(name))
+            throw new Error(`The ${kind} ${name} is registered already.`);
+        map.set(name, value);
+    }
+    const registry = {
+        stateRule(type, rule) {
+            add(states, 'state rule', type, rule);
+            return registry;
+        },
+        whoRule(type, rule) {
+            add(who, 'who rule', type, rule);
+            return registry;
+        },
+        approver(name, resolver) {
+            add(approvers, 'approver', name, resolver);
+            return registry;
+        },
+        findStateRule: (type) => states.get(type),
+        findWhoRule: (type) => who.get(type),
+        findApprover: (name) => approvers.get(name),
+    };
+    return registry;
+}
+//# sourceMappingURL=registry.js.map

package/dist/server/lifecycle/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../../server/lifecycle/registry.ts"],"names":[],"mappings":"AAwGA,MAAM,UAAU,uBAAuB;IAIrC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAuC,CAAC;IAC9D,MAAM,GAAG,GAAG,IAAI,GAAG,EAAqC,CAAC;IACzD,MAAM,SAAS,GAAG,IAAI,GAAG,EAA8C,CAAC;IAExE,SAAS,GAAG,CAAI,GAAmB,EAAE,IAAY,EAAE,IAAY,EAAE,KAAQ;QACvE,IAAI,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI,IAAI,yBAAyB,CAAC,CAAC;QAChE,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,MAAM,QAAQ,GAAwC;QACpD,SAAS,CAAC,IAAI,EAAE,IAAI;YAClB,GAAG,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACtC,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,OAAO,CAAC,IAAI,EAAE,IAAI;YAChB,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACjC,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,QAAQ,CAAC,IAAI,EAAE,QAAQ;YACrB,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC3C,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;QACzC,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC;QACpC,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC;KAC5C,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/server/lifecycle/validate.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Validation of a lifecycle definition. Returns every problem with its path (`states[3].key`), so an editor can show
+ * each one where it belongs. The shape and the rules that hold for any lifecycle are checked here; an application adds
+ * its own (`rules`) and runs with `base`, the definition being replaced, so an existing state keeps its category.
+ *
+ * The rules a definition names (state rules, "who may" rules, approvers) must be in `registry`, and their settings
+ * pass the rule's own `validate`; without a registry a definition names none. A state rule the registry lacks is kept
+ * when `base` has the same rule, settings and all, on the same state: its plugin may be gone, and the definition can
+ * still be edited around it. Likewise an event transition on an event the schema lacks is kept when `base` has the same
+ * transition (same ends, same event).
+ */
+import { type LifecycleDefinition, type LifecycleSchema } from './definition.js';
+import type { LifecycleRegistry } from './registry.js';
+export interface LifecycleIssue {
+    readonly path: string;
+    readonly message: string;
+}
+/** An application rule over a definition whose shape is already valid. */
+export type LifecycleRule = (definition: LifecycleDefinition) => readonly LifecycleIssue[];
+export interface ValidateOptions {
+    readonly base?: LifecycleDefinition | null;
+    readonly rules?: readonly LifecycleRule[];
+    /** Where the rules a definition names are registered; any registry, whatever its subject. */
+    readonly registry?: LifecycleRegistry<never, never>;
+}
+export type ValidationResult = {
+    readonly ok: true;
+    readonly definition: LifecycleDefinition;
+} | {
+    readonly ok: false;
+    readonly issues: readonly LifecycleIssue[];
+};
+export declare function validateDefinition(input: unknown, schema: LifecycleSchema, options?: ValidateOptions): ValidationResult;
+//# sourceMappingURL=validate.d.ts.map

package/dist/server/lifecycle/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../server/lifecycle/validate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAIL,KAAK,mBAAmB,EACxB,KAAK,eAAe,EAKrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,iBAAiB,EAAc,MAAM,eAAe,CAAC;AAEnE,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,0EAA0E;AAC1E,MAAM,MAAM,aAAa,GAAG,CAC1B,UAAU,EAAE,mBAAmB,KAC5B,SAAS,cAAc,EAAE,CAAC;AAE/B,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAC3C,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,aAAa,EAAE,CAAC;IAC1C,6FAA6F;IAC7F,QAAQ,CAAC,QAAQ,CAAC,EAAE,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;CACrD;AAED,MAAM,MAAM,gBAAgB,GACxB;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,UAAU,EAAE,mBAAmB,CAAA;CAAE,GAC/D;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,CAAA;CAAE,CAAC;AA4YvE,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,eAAe,EACvB,OAAO,GAAE,eAAoB,GAC5B,gBAAgB,CAkDlB"}