@melite/estate-drafts 0.0.0-stage → 0.1.4-alpha

package/lib/bench.d.ts

@@ -0,0 +1,329 @@
+import type { Domain } from "@deepseek-ai/dsh-storage-domain";
+import type { DraftsDomainSpec } from "./spec.js";
+import type { JsonValue } from "./remote.js";
+/** The bench's Remote failure codes, merged into the protocol's one
+ *  vocabulary (cookbook §2: declaration merging, next to the throw). */
+declare module "@deepseek-ai/dsh-typert-protocol" {
+    interface RemoteErrorDetailsMap {
+        /** The session key fails the [A-Za-z0-9_-]{1,64} bench law. */
+        "bench/bad-session": Record<string, never>;
+        /** The body failed the bench contract (non-object / unknown keys). */
+        "bench/bad-body": Record<string, never>;
+        /** THE MODEL ADMISSION (no-silent-drop law, hour 26 stroke 17):
+         *  the stage's model is not offered by the card, or boarded but
+         *  not downloaded on this machine — the write refuses with the
+         *  card + the offered (present) models. */
+        "bench/bad-model": {
+            readonly card: string;
+            readonly offered: readonly string[];
+        };
+        
+
+
+
+
+
+        "bench/lane-refusal": {
+            readonly card: string;
+        };
+        /** The CAS law: expect_rev missing, or the bench moved under the
+         *  caller — current_rev is the rev to re-read from. */
+        "bench/cas-conflict": {
+            readonly current_rev: number;
+            readonly expect_rev?: number;
+        };
+        
+
+
+        "bench/overwrite-required": {
+            readonly current_rev: number;
+            readonly stages: number;
+        };
+        /** No bench doc carries that session. */
+        "bench/not-found": {
+            readonly session: string;
+        };
+        /** No stage of that id sits on the bench. */
+        "bench/stage-not-found": {
+            readonly session: string;
+            readonly stage: string;
+        };
+        
+
+
+        "bench/bad-wire": {
+            readonly session: string;
+            readonly stage: string;
+            readonly input: string;
+        };
+        /** A stage wired to itself — a cycle composes nothing. */
+        "bench/self-wire": {
+            readonly session: string;
+            readonly stage: string;
+            readonly input: string;
+        };
+        /** A wiring input pointing at a stage id not on the bench (the
+         *  phantom-upstream cure: 'stage-1' never existed; the mint
+         *  mints s_N). */
+        "bench/wire-stage-not-found": {
+            readonly session: string;
+            readonly stage: string;
+            readonly input: string;
+            readonly live: readonly string[];
+        };
+        
+
+
+        "bench/grouped-row-wired": {
+            readonly session: string;
+            readonly stage: string;
+        };
+        /** A wiring channel no param spells ($channel) — the wiring
+         *  feeds nothing and the run would silently ignore it. */
+        "bench/dead-wire": {
+            readonly session: string;
+            readonly stage: string;
+            readonly input: string;
+        };
+        /** A stage of that id is already on the bench. */
+        "bench/duplicate-stage": {
+            readonly session: string;
+            readonly stage: string;
+        };
+        /** The undo walk found no live, filter-matching action. */
+        "bench/nothing-to-undo": Record<string, never>;
+        /** The storage open refused an otherwise valid call. */
+        "bench/store-failed": Record<string, never>;
+    }
+}
+
+
+
+
+
+
+
+
+
+
+import { SESSION_RE } from "@melite/contracts/benchStage";
+export { SESSION_RE };
+declare const AUTHORS: readonly ["agent", "user"];
+type Author = (typeof AUTHORS)[number];
+interface BenchEntry {
+    /** Filled by the persister (rev/at are the domain's, not the caller's). */
+    rev: number;
+    at: number;
+    author: Author;
+    kind: "patch" | "add_stage" | "remove_stage" | "rewire" | "reorder" | "group" | "ungroup" | "load" | "clear" | "undo";
+    stage?: string;
+    summary?: string;
+    /** Kind-specific inverse payload (undo applies it). */
+    inverse?: Record<string, unknown>;
+    /** Filled on undo entries: the revs this entry reverted. */
+    reverted?: number[];
+}
+export interface BenchBlock {
+    rev: number;
+    log: BenchEntry[];
+}
+export declare function benchBlockOf(doc: Record<string, unknown>): BenchBlock;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+export declare function mintStageId(rows: readonly Record<string, unknown>[], body: Record<string, unknown>): string;
+/** Birth defaults per the composer's law (id, inputs, provenance)
+ *  with the runner's object inputs. */
+export declare function normalizeStages(stagesIn: unknown, author: Author): Record<string, unknown>[];
+/** The ensure row: create marker, rev, intent, stages. */
+export interface BenchEnsureRow {
+    readonly draft_id: string;
+    readonly session: string;
+    readonly rev: number;
+    readonly intent: JsonValue;
+    readonly stages: JsonValue;
+    readonly created: boolean;
+}
+/** The get row: the bench as it stands, log HEADS only (rev/at /
+ *  author / kind / stage / summary / reverted — inverses never
+ *  leave the domain). */
+export interface BenchGetRow {
+    readonly draft_id: string;
+    readonly session: string;
+    readonly rev: number;
+    readonly intent: JsonValue;
+    readonly stages: JsonValue;
+    readonly log: readonly {
+        readonly [key: string]: JsonValue;
+    }[];
+}
+export declare function ensureBench(drafts: Domain<DraftsDomainSpec>, body: Record<string, unknown>, admit?: StageAdmission): Promise<BenchEnsureRow>;
+/** get — one session's bench block as the served row. */
+export declare function getBench(drafts: Domain<DraftsDomainSpec>, session: string): BenchGetRow;
+/** The patch row: the touched stage + the params keys merged. */
+export interface BenchPatchRow {
+    readonly draft_id: string;
+    readonly session: string;
+    readonly rev: number;
+    readonly stage: string;
+    readonly patched: readonly string[];
+}
+
+
+
+
+
+
+
+
+
+export declare function patchBench(drafts: Domain<DraftsDomainSpec>, session: string, body: Record<string, unknown>, admit?: StageAdmission): Promise<BenchPatchRow>;
+/** The stage row: the arm's answer (stage id + rev). */
+export interface BenchStageRow {
+    readonly draft_id: string;
+    readonly session: string;
+    readonly rev: number;
+    readonly stage: string;
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+export type StageAdmission = (card: string, params: Record<string, unknown>, provenance: unknown) => void;
+
+
+
+
+
+export declare function strippedForAdmission(card: string, params: Record<string, unknown>): Record<string, unknown>;
+/** The wiring admission over ONE row (params = the MERGED view the
+ *  next run composes; inputs = the MERGED wiring; liveIds = the
+ *  bench's stage ids after the write; selfId = the row's own id —
+ *  self-wiring is a cycle, refused). Throws bench/* named. */
+export declare function admitWiring(row: Record<string, unknown>, params: Record<string, unknown>, inputs: Record<string, unknown>, liveIds: readonly string[], selfId: string, session: string, tolerate?: ReadonlySet<string>): void;
+/** add_stage — append a card stage with optional wiring (the
+ *  runner's input convention rides the row). */
+export declare function addStageBench(drafts: Domain<DraftsDomainSpec>, session: string, body: Record<string, unknown>, admit?: StageAdmission): Promise<BenchStageRow>;
+
+
+
+
+
+
+
+export declare function reorderBench(drafts: Domain<DraftsDomainSpec>, session: string, body: Record<string, unknown>): Promise<BenchReorderRow>;
+/** The reorder row: the move's coordinates for the caller's optimistic
+ *  update (from → to, both POST-splice-clamp). */
+export interface BenchReorderRow {
+    readonly draft_id: string;
+    readonly session: string;
+    readonly rev: number;
+    readonly stage: string;
+    readonly from: number;
+    readonly to: number;
+}
+
+
+
+
+
+
+export declare function groupBench(drafts: Domain<DraftsDomainSpec>, session: string, body: Record<string, unknown>, admit?: StageAdmission | undefined): Promise<BenchStageRow>;
+/** ungroup — the compound's door: spill the children back at the
+ *  compound's index, in their stored order. */
+export declare function ungroupBench(drafts: Domain<DraftsDomainSpec>, session: string, body: Record<string, unknown>, admit?: StageAdmission | undefined): Promise<BenchStageRow>;
+/** remove_stage — splice one stage out (the inverse carries row +
+ *  index for undo). */
+export declare function removeStageBench(drafts: Domain<DraftsDomainSpec>, session: string, body: Record<string, unknown>): Promise<BenchStageRow>;
+/** The clear row. */
+export interface BenchClearRow {
+    readonly draft_id: string;
+    readonly session: string;
+    readonly rev: number;
+    readonly cleared: number;
+}
+
+
+
+
+
+
+
+export declare function clearBench(drafts: Domain<DraftsDomainSpec>, session: string, body: Record<string, unknown>): Promise<BenchClearRow>;
+/** The rewire row. */
+export interface BenchRewireRow {
+    readonly draft_id: string;
+    readonly session: string;
+    readonly rev: number;
+    readonly stage: string;
+    readonly input: string;
+}
+/** rewire — set or clear one input binding. from:
+ *  {stage, output} | {initial: "image"} | absent → clear. */
+export declare function rewireBench(drafts: Domain<DraftsDomainSpec>, session: string, body: Record<string, unknown>): Promise<BenchRewireRow>;
+/** The undo row: the undone revs + the stages as they stand. */
+export interface BenchUndoRow {
+    readonly draft_id: string;
+    readonly session: string;
+    readonly rev: number;
+    readonly undone: readonly number[];
+    readonly stages: JsonValue;
+}
+/** undo — walk the log tail, skip already-reverted entries and
+ *  entries the author filter excludes, apply inverses
+ *  newest-first, append ONE undo entry carrying the pre-undo
+ *  snapshot. Undo entries are NEVER candidates — a plain undo
+ *  walks ACTIONS (targeting them would ping-pong). */
+export declare function undoBench(drafts: Domain<DraftsDomainSpec>, session: string, body: Record<string, unknown>, admit?: StageAdmission): Promise<BenchUndoRow>;
+type BenchChangeListener = (session: string) => void;
+/** The event seam this pure domain module reaches the bus through.
+ *  `bench.ts` owns no Context (it is the domain layer, not a plugin),
+ *  so the plugin installs the pair once and every writer here keeps
+ *  calling {@link notifyBenchChange}. */
+export interface BenchChangeSeam {
+    emit: (session: string) => void;
+    on: (fn: BenchChangeListener) => () => void;
+}
+/** Install the seam (the plugin does this with its Context; tests do
+ *  it with their own). Pass null to detach. */
+export declare function setBenchChangeSeam(seam: BenchChangeSeam | null): void;
+
+
+
+
+
+
+
+
+export declare function onBenchChange(fn: BenchChangeListener): () => void;
+/** Fire the write event — the remote layer calls this after every
+ *  successful bench write (the door seam: every in-process and
+ *  host-routed write crosses the remote arms). */
+export declare function notifyBenchChange(session: string): void;
+/** The public notify (the drafts-patch door writes bench docs from
+ *  remote.ts — outside this module; it fires this with the session
+ *  parsed from the bench-shaped draft id). */
+export declare function notifyBenchDocWrite(draftId: string): void;
+//# sourceMappingURL=bench.d.ts.map