@zhin.js/workroom 0.0.0 → 0.0.2

package/lib/workroom/effect-ledger.d.ts

@@ -0,0 +1,211 @@
+export type WorkroomEffectOutcome = 'committed' | 'failed' | 'outcome_unknown';
+export type WorkroomEffectStatus = 'pending_authorization' | 'executing' | 'committed' | 'failed' | 'outcome_unknown' | 'cancelled';
+export interface WorkroomEffectIntentInput {
+    readonly projectId: string;
+    readonly runId: string;
+    readonly taskKey: string;
+    readonly taskRevision: number;
+    readonly candidateHash: string;
+    readonly capability: Readonly<{
+        ref: string;
+        digest: string;
+    }>;
+    readonly operation: Readonly<{
+        kind: 'git_push';
+        parameters: {
+            repositoryId: string;
+            ref: string;
+            headSha: string;
+            changedPaths: readonly string[];
+        };
+    }> | Readonly<{
+        kind: 'git_open_pr';
+        parameters: {
+            repositoryId: string;
+            headRef: string;
+            baseRef: string;
+            headSha: string;
+        };
+    }> | Readonly<{
+        kind: 'git_merge_pr';
+        parameters: {
+            repositoryId: string;
+            pullNumber: number;
+            headSha: string;
+            baseRef: string;
+            baseSha: string;
+            protectionDigest: string;
+            checksDigest: string;
+        };
+    }> | Readonly<{
+        kind: 'git_cancel_remote';
+        parameters: {
+            repositoryId: string;
+            remoteOperationId: string;
+        };
+    }> | Readonly<{
+        kind: 'delivery_release';
+        parameters: {
+            repositoryId: string;
+            headSha: string;
+            artifactDigest: string;
+            environment: string;
+            pipelineRef: string;
+        };
+    }> | Readonly<{
+        kind: 'processor_recall';
+        parameters: {
+            purgeId: string;
+            objectId: string;
+            locationId: string;
+            locationAuthorityDigest: string;
+            locationManifestDigest: string;
+            attempt: number;
+            fence: number;
+            requestDigest: string;
+        };
+    }> | Readonly<{
+        kind: 'compensation';
+        parameters: {
+            originalEffectId: string;
+            operation: string;
+            receiptRef: string;
+        };
+    }>;
+    readonly target: Readonly<{
+        ref: string;
+        digest: string;
+    }>;
+    readonly preconditions: readonly Readonly<{
+        ref: string;
+        digest: string;
+    }>[];
+    readonly risk: Readonly<{
+        assessmentRef: string;
+        assessmentDigest: string;
+        tier: 'low' | 'medium' | 'high' | 'critical';
+    }>;
+    readonly reversibility: Readonly<{
+        kind: 'discard_only' | 'irreversible';
+    }> | Readonly<{
+        kind: 'compensatable';
+        compensation: Readonly<{
+            operation: string;
+            requiresReceipt: true;
+        }>;
+    }>;
+    readonly idempotencyKey: string;
+    readonly createdAt: number;
+}
+export interface WorkroomEffectIntent extends WorkroomEffectIntentInput {
+    readonly version: 1;
+    readonly id: string;
+    readonly digest: string;
+}
+export interface WorkroomEffectAuthorization {
+    readonly version: 1;
+    readonly authorized: true;
+    readonly intentId: string;
+    readonly intentDigest: string;
+    readonly candidateHash: string;
+    readonly authorizationId: string;
+    readonly authorizationDigest: string;
+    readonly policy: Readonly<{
+        id: string;
+        revision: number;
+        digest: string;
+    }>;
+    readonly authorizedBy: string;
+    readonly expiresAt: number;
+}
+export interface WorkroomEffectAuthorizationPort {
+    authorize(input: Readonly<{
+        projectId: string;
+        expectedSequence: number;
+        now: number;
+        intent: WorkroomEffectIntent;
+    }>): Promise<WorkroomEffectAuthorization>;
+}
+export interface WorkroomEffectAttempt {
+    readonly id: string;
+    readonly operationId: string;
+    readonly workerId: string;
+    readonly fence: number;
+    readonly startedAt: number;
+    readonly idempotencyKey: string;
+    readonly intentDigest: string;
+    readonly authorizationDigest: string;
+}
+export interface WorkroomEffectGatewayReceipt {
+    readonly version: 1;
+    readonly receiptId: string;
+    readonly intentId: string;
+    readonly intentDigest: string;
+    readonly authorizationDigest: string;
+    readonly attemptId: string;
+    readonly fence: number;
+    readonly provider: Readonly<{
+        id: string;
+        digest: string;
+    }>;
+    readonly outcome: WorkroomEffectOutcome;
+    readonly remoteRef: string;
+    readonly remoteDigest: string;
+    readonly observedAt: number;
+    readonly authenticatedBy: string;
+}
+export interface WorkroomEffectState {
+    readonly projectId: string;
+    readonly sequence: number;
+    readonly status: WorkroomEffectStatus;
+    readonly intent: WorkroomEffectIntent;
+    readonly authorization?: WorkroomEffectAuthorization;
+    readonly attempt?: WorkroomEffectAttempt;
+    readonly receipt?: WorkroomEffectGatewayReceipt;
+    readonly cancelledAt?: number;
+}
+export type WorkroomEffectEventType = 'effect.intent_recorded' | 'effect.attempt_started' | 'effect.receipt_recorded' | 'effect.cancelled';
+export interface WorkroomEffectEventDraft {
+    readonly type: WorkroomEffectEventType;
+    readonly payload: Readonly<Record<string, unknown>>;
+}
+export interface WorkroomEffectEvent extends WorkroomEffectEventDraft {
+    readonly version: 1;
+    readonly projectId: string;
+    readonly sequence: number;
+    readonly digest: string;
+}
+export interface WorkroomEffectJournal {
+    read(projectId: string): Promise<readonly WorkroomEffectEvent[]>;
+    append(projectId: string, expectedSequence: number, drafts: readonly WorkroomEffectEventDraft[]): Promise<readonly WorkroomEffectEvent[]>;
+}
+export declare class WorkroomEffectSequenceConflictError extends Error {
+    readonly expected: number;
+    readonly actual: number;
+    constructor(expected: number, actual: number);
+}
+export declare class MemoryWorkroomEffectJournal implements WorkroomEffectJournal {
+    #private;
+    read(projectId: string): Promise<readonly WorkroomEffectEvent[]>;
+    append(projectId: string, expectedSequence: number, drafts: readonly WorkroomEffectEventDraft[]): Promise<readonly WorkroomEffectEvent[]>;
+}
+export declare function createWorkroomEffectIntent(input: WorkroomEffectIntentInput): WorkroomEffectIntent;
+export declare class WorkroomEffectLedger {
+    readonly journal: WorkroomEffectJournal;
+    readonly authorization?: WorkroomEffectAuthorizationPort | undefined;
+    constructor(journal: WorkroomEffectJournal, authorization?: WorkroomEffectAuthorizationPort | undefined);
+    recordIntent(projectId: string, intent: WorkroomEffectIntent): Promise<WorkroomEffectState>;
+    startAuthorizedAttempt(projectId: string, effectId: string, input: Readonly<{
+        operationId: string;
+        workerId: string;
+        fence: number;
+        startedAt: number;
+    }>, signal?: AbortSignal): Promise<WorkroomEffectState>;
+    recordReceipt(projectId: string, effectId: string, receipt: WorkroomEffectGatewayReceipt): Promise<WorkroomEffectState>;
+    cancelPending(projectId: string, effectId: string, operationId: string, cancelledAt: number): Promise<WorkroomEffectState>;
+    read(projectId: string, effectId: string): Promise<WorkroomEffectState>;
+}
+export declare function replayWorkroomEffectLedger(projectId: string, events: readonly WorkroomEffectEvent[]): Readonly<Record<string, WorkroomEffectState>>;
+export declare function createWorkroomEffectEvent(projectId: string, sequence: number, draft: WorkroomEffectEventDraft): WorkroomEffectEvent;
+export declare function assertWorkroomEffectEvent(event: WorkroomEffectEvent, projectId: string, sequence: number): void;
+//# sourceMappingURL=effect-ledger.d.ts.map

package/lib/workroom/effect-ledger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"effect-ledger.d.ts","sourceRoot":"","sources":["../../src/workroom/effect-ledger.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,qBAAqB,GAAG,WAAW,GAAG,QAAQ,GAAG,iBAAiB,CAAC;AAC/E,MAAM,MAAM,oBAAoB,GAC5B,uBAAuB,GACvB,WAAW,GACX,WAAW,GACX,QAAQ,GACR,iBAAiB,GACjB,WAAW,CAAC;AAEhB,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC/D,QAAQ,CAAC,SAAS,EACd,QAAQ,CAAC;QACP,IAAI,EAAE,UAAU,CAAC;QACjB,UAAU,EAAE;YAAE,YAAY,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAA;SAAE,CAAC;KACrG,CAAC,GACF,QAAQ,CAAC;QAAE,IAAI,EAAE,aAAa,CAAC;QAAC,UAAU,EAAE;YAAE,YAAY,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC,GAC1H,QAAQ,CAAC;QAAE,IAAI,EAAE,cAAc,CAAC;QAAC,UAAU,EAAE;YAAE,YAAY,EAAE,MAAM,CAAC;YAAC,UAAU,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,gBAAgB,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC,GAC/L,QAAQ,CAAC;QAAE,IAAI,EAAE,mBAAmB,CAAC;QAAC,UAAU,EAAE;YAAE,YAAY,EAAE,MAAM,CAAC;YAAC,iBAAiB,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC,GACxG,QAAQ,CAAC;QAAE,IAAI,EAAE,kBAAkB,CAAC;QAAC,UAAU,EAAE;YAC/C,YAAY,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,cAAc,EAAE,MAAM,CAAC;YAAC,WAAW,EAAE,MAAM,CAAC;YAAC,WAAW,EAAE,MAAM,CAAC;SACzG,CAAA;KAAE,CAAC,GACJ,QAAQ,CAAC;QAAE,IAAI,EAAE,kBAAkB,CAAC;QAAC,UAAU,EAAE;YAC/C,OAAO,EAAE,MAAM,CAAC;YAChB,QAAQ,EAAE,MAAM,CAAC;YACjB,UAAU,EAAE,MAAM,CAAC;YACnB,uBAAuB,EAAE,MAAM,CAAC;YAChC,sBAAsB,EAAE,MAAM,CAAC;YAC/B,OAAO,EAAE,MAAM,CAAC;YAChB,KAAK,EAAE,MAAM,CAAC;YACd,aAAa,EAAE,MAAM,CAAC;SACvB,CAAA;KAAE,CAAC,GACJ,QAAQ,CAAC;QAAE,IAAI,EAAE,cAAc,CAAC;QAAC,UAAU,EAAE;YAAE,gBAAgB,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAC;YAAC,UAAU,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC,CAAC;IACxH,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC3D,QAAQ,CAAC,aAAa,EAAE,SAAS,QAAQ,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAC;IAC7E,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;QACtB,aAAa,EAAE,MAAM,CAAC;QACtB,gBAAgB,EAAE,MAAM,CAAC;QACzB,IAAI,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,CAAC;KAC9C,CAAC,CAAC;IACH,QAAQ,CAAC,aAAa,EAClB,QAAQ,CAAC;QAAE,IAAI,EAAE,cAAc,GAAG,cAAc,CAAA;KAAE,CAAC,GACnD,QAAQ,CAAC;QACP,IAAI,EAAE,eAAe,CAAC;QACtB,YAAY,EAAE,QAAQ,CAAC;YAAE,SAAS,EAAE,MAAM,CAAC;YAAC,eAAe,EAAE,IAAI,CAAA;SAAE,CAAC,CAAC;KACtE,CAAC,CAAC;IACP,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAqB,SAAQ,yBAAyB;IACrE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACpB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACpB,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC5E,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,+BAA+B;IAC9C,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,gBAAgB,EAAE,MAAM,CAAC;QACzB,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,oBAAoB,CAAC;KAC9B,CAAC,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;CACtC;AAED,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC5D,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAC;IACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IACtC,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IACtC,QAAQ,CAAC,aAAa,CAAC,EAAE,2BAA2B,CAAC;IACrD,QAAQ,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC;IACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,4BAA4B,CAAC;IAChD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,MAAM,uBAAuB,GAC/B,wBAAwB,GACxB,wBAAwB,GACxB,yBAAyB,GACzB,kBAAkB,CAAC;AAEvB,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,mBAAoB,SAAQ,wBAAwB;IACnE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,mBAAmB,EAAE,CAAC,CAAC;IACjE,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,MAAM,EACxB,MAAM,EAAE,SAAS,wBAAwB,EAAE,GAC1C,OAAO,CAAC,SAAS,mBAAmB,EAAE,CAAC,CAAC;CAC5C;AAED,qBAAa,mCAAoC,SAAQ,KAAK;IAChD,QAAQ,CAAC,QAAQ,EAAE,MAAM;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM;gBAAzC,QAAQ,EAAE,MAAM,EAAW,MAAM,EAAE,MAAM;CAI/D;AAED,qBAAa,2BAA4B,YAAW,qBAAqB;;IAGjE,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,mBAAmB,EAAE,CAAC;IAIhE,MAAM,CACV,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,MAAM,EACxB,MAAM,EAAE,SAAS,wBAAwB,EAAE,GAC1C,OAAO,CAAC,SAAS,mBAAmB,EAAE,CAAC;CAgB3C;AAED,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,yBAAyB,GAAG,oBAAoB,CAQjG;AAED,qBAAa,oBAAoB;IAE7B,QAAQ,CAAC,OAAO,EAAE,qBAAqB;IACvC,QAAQ,CAAC,aAAa,CAAC,EAAE,+BAA+B;gBAD/C,OAAO,EAAE,qBAAqB,EAC9B,aAAa,CAAC,EAAE,+BAA+B,YAAA;IAGpD,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAkB3F,sBAAsB,CAC1B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,QAAQ,CAAC;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,EAC5F,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,mBAAmB,CAAC;IA8BzB,aAAa,CACjB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,mBAAmB,CAAC;IAmBzB,aAAa,CACjB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,mBAAmB,CAAC;IAezB,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAM9E;AAED,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,SAAS,mBAAmB,EAAE,GACrC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAoD/C;AAwOD,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,wBAAwB,GAC9B,mBAAmB,CASrB;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAe/G"}