@shipfox/api-definitions-dto 5.0.0 → 9.0.1

package/dist/workflow-model.d.ts

@@ -0,0 +1,153 @@
+import type { ExpressionType, OutputDeclarations, ResolvedFieldSegment, WorkflowExpression } from '@shipfox/expression';
+import type { AgentThinking, Harness } from '@shipfox/workflow-document';
+import { z } from 'zod';
+export declare const DEFAULT_RUN_TIMEOUT_MS: number;
+export declare const DEFAULT_JOB_SUCCESS = "!executions.exists(e, e.status == 'failed')";
+export interface WorkflowModelJobCheckout {
+    readonly permissions: {
+        readonly contents: 'read' | 'write';
+    };
+    readonly persistCredentials: boolean;
+}
+export declare const DEFAULT_JOB_CHECKOUT: WorkflowModelJobCheckout;
+export type WorkflowFieldTemplate = readonly ResolvedFieldSegment[];
+export type WorkflowEnvTemplates = Readonly<Record<string, WorkflowFieldTemplate>>;
+export type WorkflowOutputTemplates = Readonly<Record<string, WorkflowFieldTemplate>>;
+export interface WorkflowModel {
+    readonly kind: 'workflow';
+    readonly name: string;
+    readonly env?: Readonly<Record<string, string>>;
+    readonly templates?: {
+        readonly env?: WorkflowEnvTemplates;
+    };
+    readonly triggers: readonly WorkflowModelTrigger[];
+    readonly jobs: readonly WorkflowModelJob[];
+    readonly dependencies: readonly WorkflowModelDependency[];
+}
+export interface WorkflowModelTrigger {
+    readonly id: string;
+    readonly key: string;
+    readonly source: string;
+    readonly event: string;
+    readonly inputs?: Readonly<Record<string, unknown>>;
+    readonly filter?: string;
+    readonly config?: Readonly<Record<string, unknown>>;
+}
+export interface WorkflowModelJob {
+    readonly id: string;
+    readonly key: string;
+    readonly mode: 'one_shot' | 'listening';
+    readonly runner: readonly string[];
+    readonly runnerTemplates?: readonly WorkflowFieldTemplate[];
+    readonly checkout: WorkflowModelJobCheckout;
+    readonly if?: WorkflowExpression;
+    readonly success?: string;
+    readonly outputs?: WorkflowOutputTemplates;
+    readonly outputTypes?: Readonly<Record<string, ExpressionType>>;
+    readonly executionTimeoutMs?: number;
+    readonly listening?: WorkflowModelJobListening;
+    readonly name?: WorkflowFieldTemplate;
+    readonly env?: Readonly<Record<string, string>>;
+    readonly templates?: {
+        readonly env?: WorkflowEnvTemplates;
+    };
+    readonly dependencies: readonly string[];
+    readonly steps: readonly WorkflowModelStep[];
+}
+export interface WorkflowModelJobListening {
+    readonly on: readonly WorkflowModelListeningTrigger[];
+    readonly until?: readonly WorkflowModelListeningTrigger[];
+    readonly timeoutMs?: number;
+    readonly maxExecutions?: number;
+    readonly batch?: WorkflowModelListeningBatch;
+    readonly onResolve: 'finish' | 'cancel';
+}
+export interface WorkflowModelListeningTrigger {
+    readonly source: string;
+    readonly event: string;
+    readonly inputs?: Readonly<Record<string, unknown>>;
+    readonly filter?: string;
+}
+export interface WorkflowModelListeningBatch {
+    readonly debounceMs?: number;
+    readonly maxSize?: number;
+    readonly maxWaitMs?: number;
+}
+export type WorkflowModelStep = WorkflowModelRunStep | WorkflowModelAgentStep;
+interface WorkflowModelStepBase {
+    readonly id: string;
+    readonly key?: string;
+    readonly if?: WorkflowExpression;
+    readonly name?: string;
+    readonly outputs?: OutputDeclarations;
+    readonly gate?: WorkflowModelStepGate;
+    readonly sourceLocation?: WorkflowSourceLocation;
+}
+export interface WorkflowModelRunStep extends WorkflowModelStepBase {
+    readonly kind: 'run';
+    readonly command: {
+        readonly kind: 'shell';
+        readonly value: string;
+    };
+    readonly env?: Readonly<Record<string, string>>;
+    readonly templates?: {
+        readonly command?: WorkflowFieldTemplate;
+        readonly name?: WorkflowFieldTemplate;
+        readonly env?: WorkflowEnvTemplates;
+    };
+}
+export interface WorkflowModelAgentStep extends WorkflowModelStepBase {
+    readonly kind: 'agent';
+    readonly harness?: Harness;
+    readonly model?: string;
+    readonly provider?: string;
+    readonly thinking?: AgentThinking;
+    readonly tools?: readonly string[];
+    readonly integrations?: readonly WorkflowModelStepIntegration[];
+    readonly prompt: string;
+    readonly templates?: {
+        readonly prompt?: WorkflowFieldTemplate;
+        readonly model?: WorkflowFieldTemplate;
+        readonly provider?: WorkflowFieldTemplate;
+        readonly name?: WorkflowFieldTemplate;
+    };
+}
+export interface WorkflowModelStepIntegration {
+    readonly connection?: string;
+    readonly include: readonly string[];
+    readonly exclude?: readonly string[];
+    readonly allowWrite: boolean;
+}
+export interface WorkflowSourceLocation {
+    readonly startLine: number;
+    readonly endLine: number;
+}
+export type WorkflowStepSourceLocationMap = ReadonlyMap<string, ReadonlyMap<number, WorkflowSourceLocation>>;
+export interface WorkflowModelStepGate {
+    readonly success?: WorkflowExpression;
+    readonly onFailure?: WorkflowModelStepFailureAction;
+}
+export interface WorkflowModelStepFailureAction {
+    readonly restartFrom: string;
+    readonly feedback?: string;
+    readonly feedbackTemplate?: WorkflowFieldTemplate;
+}
+export interface WorkflowModelDependency {
+    readonly from: string;
+    readonly to: string;
+}
+export interface WorkflowSourceSnapshot {
+    readonly content: string;
+    readonly format: 'yaml';
+}
+export declare const workflowModelSnapshotSchema: z.ZodObject<{
+    version: z.ZodLiteral<1>;
+    model: z.ZodCustom<WorkflowModel, WorkflowModel>;
+}, z.core.$strip>;
+export type WorkflowModelSnapshot = z.infer<typeof workflowModelSnapshotSchema>;
+export declare function createWorkflowModelSnapshot(model: WorkflowModel): WorkflowModelSnapshot;
+export declare function workflowModelFromSnapshot(snapshot: WorkflowModelSnapshot): WorkflowModel;
+/** Reads both current snapshots and the unversioned attempt rows written before snapshots existed. */
+export declare function readPersistedWorkflowModel(value: WorkflowModel | WorkflowModelSnapshot): WorkflowModel;
+export {};
+//# sourceMappingURL=workflow-model.d.ts.map

package/dist/workflow-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-model.d.ts","sourceRoot":"","sources":["../src/workflow-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAC,aAAa,EAAE,OAAO,EAAC,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAEtB,eAAO,MAAM,sBAAsB,QAA2B,CAAC;AAC/D,eAAO,MAAM,mBAAmB,gDAAgD,CAAC;AAEjF,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,WAAW,EAAE;QAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;IAC5D,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC;CACtC;AAED,eAAO,MAAM,oBAAoB,EAAE,wBAGlC,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,SAAS,oBAAoB,EAAE,CAAC;AACpE,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAC;AACnF,MAAM,MAAM,uBAAuB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAC;AAEtF,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAChD,QAAQ,CAAC,SAAS,CAAC,EAAE;QAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,oBAAoB,CAAA;KAAC,CAAC;IAC3D,QAAQ,CAAC,QAAQ,EAAE,SAAS,oBAAoB,EAAE,CAAC;IACnD,QAAQ,CAAC,IAAI,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAC3C,QAAQ,CAAC,YAAY,EAAE,SAAS,uBAAuB,EAAE,CAAC;CAC3D;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACpD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,WAAW,CAAC;IACxC,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,qBAAqB,EAAE,CAAC;IAC5D,QAAQ,CAAC,QAAQ,EAAE,wBAAwB,CAAC;IAC5C,QAAQ,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,uBAAuB,CAAC;IAC3C,QAAQ,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;IAChE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,SAAS,CAAC,EAAE,yBAAyB,CAAC;IAC/C,QAAQ,CAAC,IAAI,CAAC,EAAE,qBAAqB,CAAC;IACtC,QAAQ,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAChD,QAAQ,CAAC,SAAS,CAAC,EAAE;QAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,oBAAoB,CAAA;KAAC,CAAC;IAC3D,QAAQ,CAAC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;IACzC,QAAQ,CAAC,KAAK,EAAE,SAAS,iBAAiB,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,EAAE,EAAE,SAAS,6BAA6B,EAAE,CAAC;IACtD,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,6BAA6B,EAAE,CAAC;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,KAAK,CAAC,EAAE,2BAA2B,CAAC;IAC7C,QAAQ,CAAC,SAAS,EAAE,QAAQ,GAAG,QAAQ,CAAC;CACzC;AACD,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACpD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AACD,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AACD,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,GAAG,sBAAsB,CAAC;AAC9E,UAAU,qBAAqB;IAC7B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC;IACjC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC;IACtC,QAAQ,CAAC,IAAI,CAAC,EAAE,qBAAqB,CAAC;IACtC,QAAQ,CAAC,cAAc,CAAC,EAAE,sBAAsB,CAAC;CAClD;AACD,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IACjE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,OAAO,EAAE;QAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAC,CAAC;IACnE,QAAQ,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAChD,QAAQ,CAAC,SAAS,CAAC,EAAE;QACnB,QAAQ,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC;QACzC,QAAQ,CAAC,IAAI,CAAC,EAAE,qBAAqB,CAAC;QACtC,QAAQ,CAAC,GAAG,CAAC,EAAE,oBAAoB,CAAC;KACrC,CAAC;CACH;AACD,MAAM,WAAW,sBAAuB,SAAQ,qBAAqB;IACnE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,4BAA4B,EAAE,CAAC;IAChE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE;QACnB,QAAQ,CAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC;QACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,qBAAqB,CAAC;QACvC,QAAQ,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;QAC1C,QAAQ,CAAC,IAAI,CAAC,EAAE,qBAAqB,CAAC;KACvC,CAAC;CACH;AACD,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;CAC9B;AACD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AACD,MAAM,MAAM,6BAA6B,GAAG,WAAW,CACrD,MAAM,EACN,WAAW,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAC5C,CAAC;AACF,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC;IACtC,QAAQ,CAAC,SAAS,CAAC,EAAE,8BAA8B,CAAC;CACrD;AACD,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,qBAAqB,CAAC;CACnD;AACD,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAWD,eAAO,MAAM,2BAA2B;;;iBAGtC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,aAAa,GAAG,qBAAqB,CAEvF;AAED,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,qBAAqB,GAAG,aAAa,CAKxF;AAED,sGAAsG;AACtG,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,aAAa,GAAG,qBAAqB,GAC3C,aAAa,CAIf"}

package/dist/workflow-model.js

@@ -0,0 +1,34 @@
+import { z } from 'zod';
+export const DEFAULT_RUN_TIMEOUT_MS = 30 * 24 * 60 * 60 * 1000;
+export const DEFAULT_JOB_SUCCESS = "!executions.exists(e, e.status == 'failed')";
+export const DEFAULT_JOB_CHECKOUT = {
+    permissions: {
+        contents: 'read'
+    },
+    persistCredentials: true
+};
+const workflowModelSchema = z.custom((value)=>typeof value === 'object' && value !== null && !Array.isArray(value) && value.kind === 'workflow', {
+    message: 'Expected a normalized workflow model'
+});
+export const workflowModelSnapshotSchema = z.object({
+    version: z.literal(1),
+    model: workflowModelSchema
+});
+export function createWorkflowModelSnapshot(model) {
+    return {
+        version: 1,
+        model
+    };
+}
+export function workflowModelFromSnapshot(snapshot) {
+    switch(snapshot.version){
+        case 1:
+            return snapshot.model;
+    }
+}
+/** Reads both current snapshots and the unversioned attempt rows written before snapshots existed. */ export function readPersistedWorkflowModel(value) {
+    if ('version' in value) return workflowModelFromSnapshot(workflowModelSnapshotSchema.parse(value));
+    return workflowModelSchema.parse(value);
+}
+
+//# sourceMappingURL=workflow-model.js.map

package/dist/workflow-model.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/workflow-model.ts"],"sourcesContent":["import type {\n  ExpressionType,\n  OutputDeclarations,\n  ResolvedFieldSegment,\n  WorkflowExpression,\n} from '@shipfox/expression';\nimport type {AgentThinking, Harness} from '@shipfox/workflow-document';\nimport {z} from 'zod';\n\nexport const DEFAULT_RUN_TIMEOUT_MS = 30 * 24 * 60 * 60 * 1000;\nexport const DEFAULT_JOB_SUCCESS = \"!executions.exists(e, e.status == 'failed')\";\n\nexport interface WorkflowModelJobCheckout {\n  readonly permissions: {readonly contents: 'read' | 'write'};\n  readonly persistCredentials: boolean;\n}\n\nexport const DEFAULT_JOB_CHECKOUT: WorkflowModelJobCheckout = {\n  permissions: {contents: 'read'},\n  persistCredentials: true,\n};\n\nexport type WorkflowFieldTemplate = readonly ResolvedFieldSegment[];\nexport type WorkflowEnvTemplates = Readonly<Record<string, WorkflowFieldTemplate>>;\nexport type WorkflowOutputTemplates = Readonly<Record<string, WorkflowFieldTemplate>>;\n\nexport interface WorkflowModel {\n  readonly kind: 'workflow';\n  readonly name: string;\n  readonly env?: Readonly<Record<string, string>>;\n  readonly templates?: {readonly env?: WorkflowEnvTemplates};\n  readonly triggers: readonly WorkflowModelTrigger[];\n  readonly jobs: readonly WorkflowModelJob[];\n  readonly dependencies: readonly WorkflowModelDependency[];\n}\n\nexport interface WorkflowModelTrigger {\n  readonly id: string;\n  readonly key: string;\n  readonly source: string;\n  readonly event: string;\n  readonly inputs?: Readonly<Record<string, unknown>>;\n  readonly filter?: string;\n  readonly config?: Readonly<Record<string, unknown>>;\n}\n\nexport interface WorkflowModelJob {\n  readonly id: string;\n  readonly key: string;\n  readonly mode: 'one_shot' | 'listening';\n  readonly runner: readonly string[];\n  readonly runnerTemplates?: readonly WorkflowFieldTemplate[];\n  readonly checkout: WorkflowModelJobCheckout;\n  readonly if?: WorkflowExpression;\n  readonly success?: string;\n  readonly outputs?: WorkflowOutputTemplates;\n  readonly outputTypes?: Readonly<Record<string, ExpressionType>>;\n  readonly executionTimeoutMs?: number;\n  readonly listening?: WorkflowModelJobListening;\n  readonly name?: WorkflowFieldTemplate;\n  readonly env?: Readonly<Record<string, string>>;\n  readonly templates?: {readonly env?: WorkflowEnvTemplates};\n  readonly dependencies: readonly string[];\n  readonly steps: readonly WorkflowModelStep[];\n}\n\nexport interface WorkflowModelJobListening {\n  readonly on: readonly WorkflowModelListeningTrigger[];\n  readonly until?: readonly WorkflowModelListeningTrigger[];\n  readonly timeoutMs?: number;\n  readonly maxExecutions?: number;\n  readonly batch?: WorkflowModelListeningBatch;\n  readonly onResolve: 'finish' | 'cancel';\n}\nexport interface WorkflowModelListeningTrigger {\n  readonly source: string;\n  readonly event: string;\n  readonly inputs?: Readonly<Record<string, unknown>>;\n  readonly filter?: string;\n}\nexport interface WorkflowModelListeningBatch {\n  readonly debounceMs?: number;\n  readonly maxSize?: number;\n  readonly maxWaitMs?: number;\n}\nexport type WorkflowModelStep = WorkflowModelRunStep | WorkflowModelAgentStep;\ninterface WorkflowModelStepBase {\n  readonly id: string;\n  readonly key?: string;\n  readonly if?: WorkflowExpression;\n  readonly name?: string;\n  readonly outputs?: OutputDeclarations;\n  readonly gate?: WorkflowModelStepGate;\n  readonly sourceLocation?: WorkflowSourceLocation;\n}\nexport interface WorkflowModelRunStep extends WorkflowModelStepBase {\n  readonly kind: 'run';\n  readonly command: {readonly kind: 'shell'; readonly value: string};\n  readonly env?: Readonly<Record<string, string>>;\n  readonly templates?: {\n    readonly command?: WorkflowFieldTemplate;\n    readonly name?: WorkflowFieldTemplate;\n    readonly env?: WorkflowEnvTemplates;\n  };\n}\nexport interface WorkflowModelAgentStep extends WorkflowModelStepBase {\n  readonly kind: 'agent';\n  readonly harness?: Harness;\n  readonly model?: string;\n  readonly provider?: string;\n  readonly thinking?: AgentThinking;\n  readonly tools?: readonly string[];\n  readonly integrations?: readonly WorkflowModelStepIntegration[];\n  readonly prompt: string;\n  readonly templates?: {\n    readonly prompt?: WorkflowFieldTemplate;\n    readonly model?: WorkflowFieldTemplate;\n    readonly provider?: WorkflowFieldTemplate;\n    readonly name?: WorkflowFieldTemplate;\n  };\n}\nexport interface WorkflowModelStepIntegration {\n  readonly connection?: string;\n  readonly include: readonly string[];\n  readonly exclude?: readonly string[];\n  readonly allowWrite: boolean;\n}\nexport interface WorkflowSourceLocation {\n  readonly startLine: number;\n  readonly endLine: number;\n}\nexport type WorkflowStepSourceLocationMap = ReadonlyMap<\n  string,\n  ReadonlyMap<number, WorkflowSourceLocation>\n>;\nexport interface WorkflowModelStepGate {\n  readonly success?: WorkflowExpression;\n  readonly onFailure?: WorkflowModelStepFailureAction;\n}\nexport interface WorkflowModelStepFailureAction {\n  readonly restartFrom: string;\n  readonly feedback?: string;\n  readonly feedbackTemplate?: WorkflowFieldTemplate;\n}\nexport interface WorkflowModelDependency {\n  readonly from: string;\n  readonly to: string;\n}\nexport interface WorkflowSourceSnapshot {\n  readonly content: string;\n  readonly format: 'yaml';\n}\n\nconst workflowModelSchema = z.custom<WorkflowModel>(\n  (value) =>\n    typeof value === 'object' &&\n    value !== null &&\n    !Array.isArray(value) &&\n    (value as {kind?: unknown}).kind === 'workflow',\n  {message: 'Expected a normalized workflow model'},\n);\n\nexport const workflowModelSnapshotSchema = z.object({\n  version: z.literal(1),\n  model: workflowModelSchema,\n});\nexport type WorkflowModelSnapshot = z.infer<typeof workflowModelSnapshotSchema>;\n\nexport function createWorkflowModelSnapshot(model: WorkflowModel): WorkflowModelSnapshot {\n  return {version: 1, model};\n}\n\nexport function workflowModelFromSnapshot(snapshot: WorkflowModelSnapshot): WorkflowModel {\n  switch (snapshot.version) {\n    case 1:\n      return snapshot.model;\n  }\n}\n\n/** Reads both current snapshots and the unversioned attempt rows written before snapshots existed. */\nexport function readPersistedWorkflowModel(\n  value: WorkflowModel | WorkflowModelSnapshot,\n): WorkflowModel {\n  if ('version' in value)\n    return workflowModelFromSnapshot(workflowModelSnapshotSchema.parse(value));\n  return workflowModelSchema.parse(value);\n}\n"],"names":["z","DEFAULT_RUN_TIMEOUT_MS","DEFAULT_JOB_SUCCESS","DEFAULT_JOB_CHECKOUT","permissions","contents","persistCredentials","workflowModelSchema","custom","value","Array","isArray","kind","message","workflowModelSnapshotSchema","object","version","literal","model","createWorkflowModelSnapshot","workflowModelFromSnapshot","snapshot","readPersistedWorkflowModel","parse"],"mappings":"AAOA,SAAQA,CAAC,QAAO,MAAM;AAEtB,OAAO,MAAMC,yBAAyB,KAAK,KAAK,KAAK,KAAK,KAAK;AAC/D,OAAO,MAAMC,sBAAsB,8CAA8C;AAOjF,OAAO,MAAMC,uBAAiD;IAC5DC,aAAa;QAACC,UAAU;IAAM;IAC9BC,oBAAoB;AACtB,EAAE;AAqIF,MAAMC,sBAAsBP,EAAEQ,MAAM,CAClC,CAACC,QACC,OAAOA,UAAU,YACjBA,UAAU,QACV,CAACC,MAAMC,OAAO,CAACF,UACf,AAACA,MAA2BG,IAAI,KAAK,YACvC;IAACC,SAAS;AAAsC;AAGlD,OAAO,MAAMC,8BAA8Bd,EAAEe,MAAM,CAAC;IAClDC,SAAShB,EAAEiB,OAAO,CAAC;IACnBC,OAAOX;AACT,GAAG;AAGH,OAAO,SAASY,4BAA4BD,KAAoB;IAC9D,OAAO;QAACF,SAAS;QAAGE;IAAK;AAC3B;AAEA,OAAO,SAASE,0BAA0BC,QAA+B;IACvE,OAAQA,SAASL,OAAO;QACtB,KAAK;YACH,OAAOK,SAASH,KAAK;IACzB;AACF;AAEA,oGAAoG,GACpG,OAAO,SAASI,2BACdb,KAA4C;IAE5C,IAAI,aAAaA,OACf,OAAOW,0BAA0BN,4BAA4BS,KAAK,CAACd;IACrE,OAAOF,oBAAoBgB,KAAK,CAACd;AACnC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shipfox/api-definitions-dto",
   "license": "MIT",
-  "version": "5.0.0",
+  "version": "9.0.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
@@ -11,26 +11,24 @@
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "imports": {
-    "#test/*": "./test/*",
-    "#*": "./dist/*"
-  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./inter-module": {
+      "types": "./dist/inter-module.d.ts",
+      "default": "./dist/inter-module.js"
     }
   },
   "dependencies": {
-    "zod": "^4.4.3"
+    "zod": "^4.4.3",
+    "@shipfox/expression": "1.1.4",
+    "@shipfox/inter-module": "0.2.1",
+    "@shipfox/workflow-document": "2.1.2"
   },
-  "devDependencies": {
-    "@shipfox/biome": "1.8.2",
-    "@shipfox/depcruise": "1.0.2",
-    "@shipfox/swc": "1.2.6",
-    "@shipfox/ts-config": "1.3.8",
-    "@shipfox/typescript": "1.1.7",
-    "@shipfox/vitest": "1.2.3"
+  "imports": {
+    "#*": "./dist/*"
   },
   "scripts": {
     "build": "shipfox-swc",

package/src/index.ts

@@ -28,3 +28,13 @@ export {
   definitionResolvedEventSchema,
   definitionsEventSchemas,
 } from './events.js';
+export type * from './workflow-model.js';
+export {
+  createWorkflowModelSnapshot,
+  DEFAULT_JOB_CHECKOUT,
+  DEFAULT_JOB_SUCCESS,
+  DEFAULT_RUN_TIMEOUT_MS,
+  readPersistedWorkflowModel,
+  workflowModelFromSnapshot,
+  workflowModelSnapshotSchema,
+} from './workflow-model.js';

package/src/inter-module.test.ts

@@ -0,0 +1,24 @@
+import {definitionsInterModuleContract} from './inter-module.js';
+import {readPersistedWorkflowModel} from './workflow-model.js';
+
+describe('definitionsInterModuleContract', () => {
+  test('exposes a versioned workflow snapshot', () => {
+    const result = definitionsInterModuleContract.methods.getDefinitionForWorkflowRun.output.parse({
+      definition: {
+        id: '00000000-0000-4000-8000-000000000001',
+        projectId: '00000000-0000-4000-8000-000000000002',
+        name: 'Deploy',
+        model: {version: 1, model: {kind: 'workflow'}},
+        sourceSnapshot: null,
+      },
+    });
+
+    expect(result.definition?.model.version).toBe(1);
+  });
+
+  test('rejects an unknown persisted snapshot version', () => {
+    expect(() =>
+      readPersistedWorkflowModel({version: 2, model: {kind: 'workflow'}} as never),
+    ).toThrow();
+  });
+});

package/src/inter-module.ts

@@ -0,0 +1,25 @@
+import {defineInterModuleContract, type InterModuleClient} from '@shipfox/inter-module';
+import {z} from 'zod';
+import {workflowModelSnapshotSchema} from './workflow-model.js';
+
+const idSchema = z.string().uuid();
+const definitionSnapshotSchema = z.object({
+  id: idSchema,
+  projectId: idSchema,
+  name: z.string(),
+  model: workflowModelSnapshotSchema,
+  sourceSnapshot: z.object({content: z.string(), format: z.literal('yaml')}).nullable(),
+});
+
+export const definitionsInterModuleContract = defineInterModuleContract({
+  module: 'definitions',
+  methods: {
+    getDefinitionForWorkflowRun: {
+      input: z.object({definitionId: idSchema}),
+      output: z.object({definition: definitionSnapshotSchema.nullable()}),
+    },
+  },
+});
+
+export type DefinitionsInterModuleClient = InterModuleClient<typeof definitionsInterModuleContract>;
+export type DefinitionWorkflowSnapshot = z.infer<typeof definitionSnapshotSchema>;

package/src/workflow-model.ts

@@ -0,0 +1,187 @@
+import type {
+  ExpressionType,
+  OutputDeclarations,
+  ResolvedFieldSegment,
+  WorkflowExpression,
+} from '@shipfox/expression';
+import type {AgentThinking, Harness} from '@shipfox/workflow-document';
+import {z} from 'zod';
+
+export const DEFAULT_RUN_TIMEOUT_MS = 30 * 24 * 60 * 60 * 1000;
+export const DEFAULT_JOB_SUCCESS = "!executions.exists(e, e.status == 'failed')";
+
+export interface WorkflowModelJobCheckout {
+  readonly permissions: {readonly contents: 'read' | 'write'};
+  readonly persistCredentials: boolean;
+}
+
+export const DEFAULT_JOB_CHECKOUT: WorkflowModelJobCheckout = {
+  permissions: {contents: 'read'},
+  persistCredentials: true,
+};
+
+export type WorkflowFieldTemplate = readonly ResolvedFieldSegment[];
+export type WorkflowEnvTemplates = Readonly<Record<string, WorkflowFieldTemplate>>;
+export type WorkflowOutputTemplates = Readonly<Record<string, WorkflowFieldTemplate>>;
+
+export interface WorkflowModel {
+  readonly kind: 'workflow';
+  readonly name: string;
+  readonly env?: Readonly<Record<string, string>>;
+  readonly templates?: {readonly env?: WorkflowEnvTemplates};
+  readonly triggers: readonly WorkflowModelTrigger[];
+  readonly jobs: readonly WorkflowModelJob[];
+  readonly dependencies: readonly WorkflowModelDependency[];
+}
+
+export interface WorkflowModelTrigger {
+  readonly id: string;
+  readonly key: string;
+  readonly source: string;
+  readonly event: string;
+  readonly inputs?: Readonly<Record<string, unknown>>;
+  readonly filter?: string;
+  readonly config?: Readonly<Record<string, unknown>>;
+}
+
+export interface WorkflowModelJob {
+  readonly id: string;
+  readonly key: string;
+  readonly mode: 'one_shot' | 'listening';
+  readonly runner: readonly string[];
+  readonly runnerTemplates?: readonly WorkflowFieldTemplate[];
+  readonly checkout: WorkflowModelJobCheckout;
+  readonly if?: WorkflowExpression;
+  readonly success?: string;
+  readonly outputs?: WorkflowOutputTemplates;
+  readonly outputTypes?: Readonly<Record<string, ExpressionType>>;
+  readonly executionTimeoutMs?: number;
+  readonly listening?: WorkflowModelJobListening;
+  readonly name?: WorkflowFieldTemplate;
+  readonly env?: Readonly<Record<string, string>>;
+  readonly templates?: {readonly env?: WorkflowEnvTemplates};
+  readonly dependencies: readonly string[];
+  readonly steps: readonly WorkflowModelStep[];
+}
+
+export interface WorkflowModelJobListening {
+  readonly on: readonly WorkflowModelListeningTrigger[];
+  readonly until?: readonly WorkflowModelListeningTrigger[];
+  readonly timeoutMs?: number;
+  readonly maxExecutions?: number;
+  readonly batch?: WorkflowModelListeningBatch;
+  readonly onResolve: 'finish' | 'cancel';
+}
+export interface WorkflowModelListeningTrigger {
+  readonly source: string;
+  readonly event: string;
+  readonly inputs?: Readonly<Record<string, unknown>>;
+  readonly filter?: string;
+}
+export interface WorkflowModelListeningBatch {
+  readonly debounceMs?: number;
+  readonly maxSize?: number;
+  readonly maxWaitMs?: number;
+}
+export type WorkflowModelStep = WorkflowModelRunStep | WorkflowModelAgentStep;
+interface WorkflowModelStepBase {
+  readonly id: string;
+  readonly key?: string;
+  readonly if?: WorkflowExpression;
+  readonly name?: string;
+  readonly outputs?: OutputDeclarations;
+  readonly gate?: WorkflowModelStepGate;
+  readonly sourceLocation?: WorkflowSourceLocation;
+}
+export interface WorkflowModelRunStep extends WorkflowModelStepBase {
+  readonly kind: 'run';
+  readonly command: {readonly kind: 'shell'; readonly value: string};
+  readonly env?: Readonly<Record<string, string>>;
+  readonly templates?: {
+    readonly command?: WorkflowFieldTemplate;
+    readonly name?: WorkflowFieldTemplate;
+    readonly env?: WorkflowEnvTemplates;
+  };
+}
+export interface WorkflowModelAgentStep extends WorkflowModelStepBase {
+  readonly kind: 'agent';
+  readonly harness?: Harness;
+  readonly model?: string;
+  readonly provider?: string;
+  readonly thinking?: AgentThinking;
+  readonly tools?: readonly string[];
+  readonly integrations?: readonly WorkflowModelStepIntegration[];
+  readonly prompt: string;
+  readonly templates?: {
+    readonly prompt?: WorkflowFieldTemplate;
+    readonly model?: WorkflowFieldTemplate;
+    readonly provider?: WorkflowFieldTemplate;
+    readonly name?: WorkflowFieldTemplate;
+  };
+}
+export interface WorkflowModelStepIntegration {
+  readonly connection?: string;
+  readonly include: readonly string[];
+  readonly exclude?: readonly string[];
+  readonly allowWrite: boolean;
+}
+export interface WorkflowSourceLocation {
+  readonly startLine: number;
+  readonly endLine: number;
+}
+export type WorkflowStepSourceLocationMap = ReadonlyMap<
+  string,
+  ReadonlyMap<number, WorkflowSourceLocation>
+>;
+export interface WorkflowModelStepGate {
+  readonly success?: WorkflowExpression;
+  readonly onFailure?: WorkflowModelStepFailureAction;
+}
+export interface WorkflowModelStepFailureAction {
+  readonly restartFrom: string;
+  readonly feedback?: string;
+  readonly feedbackTemplate?: WorkflowFieldTemplate;
+}
+export interface WorkflowModelDependency {
+  readonly from: string;
+  readonly to: string;
+}
+export interface WorkflowSourceSnapshot {
+  readonly content: string;
+  readonly format: 'yaml';
+}
+
+const workflowModelSchema = z.custom<WorkflowModel>(
+  (value) =>
+    typeof value === 'object' &&
+    value !== null &&
+    !Array.isArray(value) &&
+    (value as {kind?: unknown}).kind === 'workflow',
+  {message: 'Expected a normalized workflow model'},
+);
+
+export const workflowModelSnapshotSchema = z.object({
+  version: z.literal(1),
+  model: workflowModelSchema,
+});
+export type WorkflowModelSnapshot = z.infer<typeof workflowModelSnapshotSchema>;
+
+export function createWorkflowModelSnapshot(model: WorkflowModel): WorkflowModelSnapshot {
+  return {version: 1, model};
+}
+
+export function workflowModelFromSnapshot(snapshot: WorkflowModelSnapshot): WorkflowModel {
+  switch (snapshot.version) {
+    case 1:
+      return snapshot.model;
+  }
+}
+
+/** Reads both current snapshots and the unversioned attempt rows written before snapshots existed. */
+export function readPersistedWorkflowModel(
+  value: WorkflowModel | WorkflowModelSnapshot,
+): WorkflowModel {
+  if ('version' in value)
+    return workflowModelFromSnapshot(workflowModelSnapshotSchema.parse(value));
+  return workflowModelSchema.parse(value);
+}