@bluewombat/work-ledger 0.1.0

package/dist/ledger/open-work-ledger.d.ts

@@ -0,0 +1,122 @@
+import type { PersistencePort } from "../persist/port.js";
+import type { EscalationKind, FeatureAggregate, FeatureIntention, FeatureSummary, RefusalCode, TraceRecord } from "../records.js";
+import { type PlanDraft } from "./check-plan.js";
+export type FeatureAdmission = FeatureIntention;
+export type CommandOk = {
+    ok: true;
+};
+export type CommandRefused = {
+    ok: false;
+    code: RefusalCode;
+};
+export type CommandResult = CommandOk | CommandRefused;
+export type ClaimResult = {
+    ok: true;
+    key: string;
+} | {
+    ok: true;
+    empty: true;
+} | CommandRefused;
+export type GetResult = {
+    ok: true;
+    aggregate: FeatureAggregate;
+} | {
+    ok: false;
+    code: "not-found";
+};
+export type OpenWorkLedgerOptions = {
+    persist: PersistencePort;
+    now?: () => number;
+    bailDurationMs?: number;
+};
+export type EscalateInput = {
+    key: string;
+    kind: EscalationKind;
+    subtaskId?: string;
+    /** Why it stopped. Kept so the person who reads the escalation is told. */
+    report?: string;
+};
+export type RecordAttemptInput = {
+    key: string;
+    subtaskId: string;
+    number: number;
+    trace?: TraceRecord;
+};
+export type DeclareWorkspaceInput = {
+    key: string;
+    feature?: string;
+    subtask?: string;
+};
+export type ClearWorkspaceInput = {
+    key: string;
+    feature?: boolean;
+    subtask?: boolean;
+};
+export type DeclaredWorkspace = {
+    key: string;
+    feature?: string;
+    subtask?: string;
+};
+export type WorkLedger = {
+    admit(feature: FeatureAdmission): Promise<CommandResult>;
+    recordInvalid(input: {
+        key: string;
+        project: string;
+        code: string;
+        reason: string;
+        /** Of what was received, so the same invalid intention is known as such. */
+        fingerprint?: string;
+        priority?: number;
+    }): Promise<CommandResult>;
+    claim(project: string): Promise<ClaimResult>;
+    recordPlan(input: {
+        key: string;
+        plannedAt: string;
+        subtasks: PlanDraft[];
+    }): Promise<CommandResult>;
+    refusePlan(input: {
+        key: string;
+        code: string;
+        reason: string;
+    }): Promise<CommandResult>;
+    startSubtask(input: {
+        key: string;
+        subtaskId: string;
+    }): Promise<CommandResult>;
+    recordAttempt(input: RecordAttemptInput): Promise<CommandResult>;
+    markSubtaskIntegrated(input: {
+        key: string;
+        subtaskId: string;
+    }): Promise<CommandResult>;
+    markSubmitted(input: {
+        key: string;
+        reference: string;
+    }): Promise<CommandResult>;
+    recordRefusal(input: {
+        key: string;
+        report: string;
+        refusedBy?: string;
+    }): Promise<CommandResult>;
+    markMerging(key: string): Promise<CommandResult>;
+    markDone(key: string, input?: {
+        reference?: string | undefined;
+    }): Promise<CommandResult>;
+    escalate(input: EscalateInput): Promise<CommandResult>;
+    resumeReady(key: string): Promise<CommandResult>;
+    cancel(key: string): Promise<CommandResult>;
+    declareWorkspace(input: DeclareWorkspaceInput): Promise<CommandResult>;
+    clearWorkspace(input: ClearWorkspaceInput): Promise<CommandResult>;
+    expireBail(key: string): Promise<CommandResult>;
+    renewBail(key: string): Promise<CommandResult>;
+    get(key: string): Promise<GetResult>;
+    /** Every known Feature, whatever its state. */
+    list(): Promise<FeatureSummary[]>;
+    /** Every Feature mid-flight, whatever its Project. */
+    listInFlight(): Promise<FeatureSummary[]>;
+    activeOn(project: string): Promise<FeatureSummary | undefined>;
+    nextReceived(project: string): Promise<FeatureSummary | undefined>;
+    nextRunnable(key: string): Promise<string | undefined>;
+    listDeclaredWorkspaces(): Promise<DeclaredWorkspace[]>;
+};
+export declare function openWorkLedger(options: OpenWorkLedgerOptions): WorkLedger;
+//# sourceMappingURL=open-work-ledger.d.ts.map

package/dist/ledger/open-work-ledger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"open-work-ledger.d.ts","sourceRoot":"","sources":["../../src/ledger/open-work-ledger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAEV,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAEhB,cAAc,EACd,WAAW,EACX,WAAW,EACZ,MAAM,eAAe,CAAC;AACvB,OAAO,EAAkC,KAAK,SAAS,EAAmB,MAAM,iBAAiB,CAAC;AAoBlG,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;AAEhD,MAAM,MAAM,SAAS,GAAG;IAAE,EAAE,EAAE,IAAI,CAAA;CAAE,CAAC;AACrC,MAAM,MAAM,cAAc,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,WAAW,CAAA;CAAE,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,cAAc,CAAC;AAEvD,MAAM,MAAM,WAAW,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,IAAI,CAAA;CAAE,GAAG,cAAc,CAAC;AAEjG,MAAM,MAAM,SAAS,GACjB;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,SAAS,EAAE,gBAAgB,CAAA;CAAE,GACzC;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,WAAW,CAAA;CAAE,CAAC;AAErC,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,eAAe,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,cAAc,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2EAA2E;IAC3E,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACzD,aAAa,CAAC,KAAK,EAAE;QACnB,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,4EAA4E;QAC5E,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC3B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7C,UAAU,CAAC,KAAK,EAAE;QAChB,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,SAAS,EAAE,CAAC;KACvB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC3B,UAAU,CAAC,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACzF,YAAY,CAAC,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAChF,aAAa,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACjE,qBAAqB,CAAC,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACzF,aAAa,CAAC,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACjF,aAAa,CAAC,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAClG,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACjD,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC1F,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACvD,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACjD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC5C,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACvE,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACnE,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAChD,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC/C,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACrC,+CAA+C;IAC/C,IAAI,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAClC,sDAAsD;IACtD,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAC1C,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IAC/D,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IACnE,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACvD,sBAAsB,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;CACxD,CAAC;AAmDF,wBAAgB,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,UAAU,CAknBzE"}