@owlmeans/planning 0.1.18-rc.2 → 0.1.18-rc.21

package/build/helpers/changes/types.d.ts

@@ -0,0 +1,58 @@
+import type { AnyTypeSchema, SpecificationSlot, TransitionExecution, Workcard, WorkcardChanges } from '../../types.js';
+import type { FlowLookup } from '../types.local.js';
+export interface ChangeSet {
+    changes: WorkcardChanges;
+    unset: string[];
+    /** Transit only: the flow that moved, and the move. */
+    flow?: string;
+    from?: string;
+    to?: string;
+}
+/** What a transition records — computed from an execution, and the guards it must pass first. */
+export interface ChangesHelper {
+    /** Structural equality over JSON values. */
+    sameValue: (left: unknown, right: unknown) => boolean;
+    /** A shallow merge that drops keys patched to `null`. */
+    mergeFields: (base?: Record<string, unknown> | null, patch?: Record<string, unknown> | null) => Record<string, unknown>;
+    /** A copy of the record with the paths (`key`, `fields.key`, `flows.id`) removed. */
+    applyUnset: <T extends object>(record: T, unset?: string[]) => T;
+    /**
+     * Refuse an execution that writes what only the transition, the flow or the executor may write.
+     *
+     * `status`/`intrinsic`/`flows`/`closedAt` move only through `transit` (a create's draft may name
+     * the initial status); `code` is fixed once minted unless the type's policy says `mutable`;
+     * `category` is fixed; `revision`/`bodyChars` are computed; `createdBy` is the create DRAFT's
+     * alone — named in `changes` or `unset` it is refused on every action, so an owner check
+     * (`card.createdBy === profileId`) can trust it.
+     *
+     * @throws {PlanningError} `planning:immutable:<field>`
+     */
+    assertMutable: (exec: TransitionExecution, type: AnyTypeSchema) => void;
+    /**
+     * The `changes`/`unset` a transition records (plan step 9).
+     *
+     * - `create`: the whole initial record from the draft (overlaid by `exec.changes`) — `parents`
+     *   normalized, every flow at its initial status (the draft's `status` for the primary one),
+     *   `status`/`intrinsic` mirrored, `closedAt` when it starts closed; a specification gets its
+     *   format, `bodyChars` and revision 1 when the slot is revisioned.
+     * - `update`: only what differs; `null` or `exec.unset` clears a field that has a value; a moved
+     *   `parent` replaces the old one in `parents`; a revisioned document whose content changed gets
+     *   `revision + 1`. An update that changes nothing is empty ({@link ChangesHelper.isEmptyChange}).
+     * - `transit`: `flows[flow] = rule.to`, `status` when the flow is primary, `intrinsic` when it
+     *   moves, `closedAt` set on entering closed and cleared on leaving it — plus the caller's own
+     *   changes, diffed as in an update.
+     * - `link`, `unlink`, `delete`: nothing.
+     *
+     * `createdBy` comes from a create's draft only: `changes` and `unset` never carry it, on any action
+     * ({@link ChangesHelper.assertMutable} refuses an execution that tries).
+     *
+     * @throws {IllegalTransition} a transit the flow does not offer from the current status
+     * @throws {PlanningError} `malformed:*` for an execution missing what its action needs
+     */
+    computeChanges: (card: Workcard | null | undefined, exec: TransitionExecution, type: AnyTypeSchema, registry: FlowLookup, at: string, opts?: {
+        slot?: SpecificationSlot | null;
+    }) => ChangeSet;
+    /** Nothing to write: no changed value and nothing to clear. */
+    isEmptyChange: (set: Pick<ChangeSet, 'changes' | 'unset'>) => boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/helpers/changes/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/helpers/changes/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,eAAe,EACjF,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAEnD,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,eAAe,CAAA;IACxB,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAED,iGAAiG;AACjG,MAAM,WAAW,aAAa;IAC5B,4CAA4C;IAC5C,SAAS,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAA;IACrD,yDAAyD;IACzD,WAAW,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACvH,qFAAqF;IACrF,UAAU,EAAE,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;IAChE;;;;;;;;;;OAUG;IACH,aAAa,EAAE,CAAC,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,aAAa,KAAK,IAAI,CAAA;IACvE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,cAAc,EAAE,CACd,IAAI,EAAE,QAAQ,GAAG,IAAI,GAAG,SAAS,EACjC,IAAI,EAAE,mBAAmB,EACzB,IAAI,EAAE,aAAa,EACnB,QAAQ,EAAE,UAAU,EACpB,EAAE,EAAE,MAAM,EACV,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;KAAE,KACvC,SAAS,CAAA;IACd,+DAA+D;IAC/D,aAAa,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,KAAK,OAAO,CAAA;CACtE"}

package/build/helpers/changes/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/helpers/changes/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/helpers/changes/types.ts"],"names":[],"mappings":""}

package/build/helpers/changes.d.ts

@@ -1,51 +1,20 @@
-import type { AnyTypeSchema, PlanningSchemaRegistry, SpecificationSlot, TransitionExecution, Workcard, WorkcardChanges } from '../types.js';
-type FlowLookup = Pick<PlanningSchemaRegistry, 'flow'>;
-export interface ChangeSet {
-    changes: WorkcardChanges;
-    unset: string[];
-    /** Transit only: the flow that moved, and the move. */
-    flow?: string;
-    from?: string;
-    to?: string;
-}
-/** Structural equality over JSON values. */
+import type { AnyTypeSchema, SpecificationSlot, TransitionExecution, Workcard } from '../types.js';
+import type { ChangeSet, ChangesHelper } from './changes/types.js';
+import type { FlowLookup } from './types.local.js';
+export declare const createChangesHelper: () => ChangesHelper;
+export declare const changesHelper: ChangesHelper;
+/** @deprecated compat:factory-refactor — use `changesHelper.sameValue(…)` */
 export declare const sameValue: (left: unknown, right: unknown) => boolean;
-/** A shallow merge that drops keys patched to `null`. */
+/** @deprecated compat:factory-refactor — use `changesHelper.mergeFields(…)` */
 export declare const mergeFields: (base?: Record<string, unknown> | null, patch?: Record<string, unknown> | null) => Record<string, unknown>;
-/** A copy of the record with the paths (`key`, `fields.key`, `flows.id`) removed. */
+/** @deprecated compat:factory-refactor — use `changesHelper.applyUnset(…)` */
 export declare const applyUnset: <T extends object>(record: T, unset?: string[]) => T;
-/**
- * Refuse an execution that writes what only the transition, the flow or the executor may write.
- *
- * `status`/`intrinsic`/`flows`/`closedAt` move only through `transit` (a create's draft may name
- * the initial status); `code` is fixed once minted unless the type's policy says `mutable`;
- * `category` is fixed; `revision`/`bodyChars` are computed.
- *
- * @throws {PlanningError} `planning:immutable:<field>`
- */
+/** @deprecated compat:factory-refactor — use `changesHelper.assertMutable(…)` */
 export declare const assertMutable: (exec: TransitionExecution, type: AnyTypeSchema) => void;
-/**
- * The `changes`/`unset` a transition records (plan step 9).
- *
- * - `create`: the whole initial record from the draft (overlaid by `exec.changes`) — `parents`
- *   normalized, every flow at its initial status (the draft's `status` for the primary one),
- *   `status`/`intrinsic` mirrored, `closedAt` when it starts closed; a specification gets its
- *   format, `bodyChars` and revision 1 when the slot is revisioned.
- * - `update`: only what differs; `null` or `exec.unset` clears a field that has a value; a moved
- *   `parent` replaces the old one in `parents`; a revisioned document whose content changed gets
- *   `revision + 1`. An update that changes nothing is empty ({@link isEmptyChange}).
- * - `transit`: `flows[flow] = rule.to`, `status` when the flow is primary, `intrinsic` when it
- *   moves, `closedAt` set on entering closed and cleared on leaving it — plus the caller's own
- *   changes, diffed as in an update.
- * - `link`, `unlink`, `delete`: nothing.
- *
- * @throws {IllegalTransition} a transit the flow does not offer from the current status
- * @throws {PlanningError} `malformed:*` for an execution missing what its action needs
- */
+/** @deprecated compat:factory-refactor — use `changesHelper.computeChanges(…)` */
 export declare const computeChanges: (card: Workcard | null | undefined, exec: TransitionExecution, type: AnyTypeSchema, registry: FlowLookup, at: string, opts?: {
     slot?: SpecificationSlot | null;
 }) => ChangeSet;
-/** Nothing to write: no changed value and nothing to clear. */
+/** @deprecated compat:factory-refactor — use `changesHelper.isEmptyChange(…)` */
 export declare const isEmptyChange: (set: Pick<ChangeSet, 'changes' | 'unset'>) => boolean;
-export {};
 //# sourceMappingURL=changes.d.ts.map

package/build/helpers/changes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"changes.d.ts","sourceRoot":"","sources":["../../src/helpers/changes.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,aAAa,EAAE,sBAAsB,EAAiB,iBAAiB,EAAE,mBAAmB,EAC5F,QAAQ,EAAE,eAAe,EAC1B,MAAM,aAAa,CAAA;AAKpB,KAAK,UAAU,GAAG,IAAI,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAA;AAEtD,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,eAAe,CAAA;IACxB,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAgBD,4CAA4C;AAC5C,eAAO,MAAM,SAAS,SAAU,OAAO,SAAS,OAAO,KAAG,OAczD,CAAA;AAKD,yDAAyD;AACzD,eAAO,MAAM,WAAW,UACf,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,UAAU,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,KAC5E,MAAM,CAAC,MAAM,EAAE,OAAO,CACuC,CAAA;AAEhE,qFAAqF;AACrF,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,MAAM,UAAU,CAAC,UAAU,MAAM,EAAE,KAAG,CAe1E,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,SAAU,mBAAmB,QAAQ,aAAa,KAAG,IA0B9E,CAAA;AAsID;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,cAAc,SACnB,QAAQ,GAAG,IAAI,GAAG,SAAS,QAC3B,mBAAmB,QACnB,aAAa,YACT,UAAU,MAChB,MAAM,SACH;IAAE,IAAI,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAAE,KACzC,SAsDF,CAAA;AAED,+DAA+D;AAC/D,eAAO,MAAM,aAAa,QAAS,IAAI,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,KAAG,OAEW,CAAA"}
+{"version":3,"file":"changes.d.ts","sourceRoot":"","sources":["../../src/helpers/changes.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAiB,iBAAiB,EAAE,mBAAmB,EAAE,QAAQ,EAAkC,MAAM,aAAa,CAAA;AAEjJ,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAIlE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAQlD,eAAO,MAAM,mBAAmB,QAAO,aAkRtC,CAAA;AAED,eAAO,MAAM,aAAa,eAAwB,CAAA;AAElD,6EAA6E;AAC7E,eAAO,MAAM,SAAS,SAAU,OAAO,SAAS,OAAO,KAAG,OAA+C,CAAA;AAEzG,+EAA+E;AAC/E,eAAO,MAAM,WAAW,UACf,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,UAAU,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,KAC5E,MAAM,CAAC,MAAM,EAAE,OAAO,CAA2C,CAAA;AAEpE,8EAA8E;AAC9E,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,MAAM,UAAU,CAAC,UAAU,MAAM,EAAE,KAAG,CAA+C,CAAA;AAE1H,iFAAiF;AACjF,eAAO,MAAM,aAAa,SAAU,mBAAmB,QAAQ,aAAa,KAAG,IAA+C,CAAA;AAE9H,kFAAkF;AAClF,eAAO,MAAM,cAAc,SACnB,QAAQ,GAAG,IAAI,GAAG,SAAS,QAC3B,mBAAmB,QACnB,aAAa,YACT,UAAU,MAChB,MAAM,SACH;IAAE,IAAI,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAAE,KACzC,SAA+E,CAAA;AAElF,iFAAiF;AACjF,eAAO,MAAM,aAAa,QAAS,IAAI,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,KAAG,OAA2C,CAAA"}