paperclip/packages/shared/src/validators/pipeline.ts

160 lines
7.0 KiB
TypeScript

import { z } from "zod";
import {
ISSUE_EXECUTION_WORKSPACE_PREFERENCES,
issueExecutionWorkspaceSettingsSchema,
} from "./issue.js";
const routineVariableLikeNameSchema = z.string().trim().regex(/^[A-Za-z][A-Za-z0-9_]*$/);
export const pipelineStageKindSchema = z.enum(["working", "review", "done", "cancelled"]);
export const legacyPipelineStageKindSchema = z.enum(["open", "working", "review", "done", "cancelled"]);
export const pipelineStageApproverSchema = z.object({
kind: z.enum(["any_human", "user", "agent"]).optional().default("any_human"),
id: z.string().trim().min(1).max(200).optional(),
}).superRefine((value, ctx) => {
if (value.kind !== "any_human" && (typeof value.id !== "string" || value.id.length === 0)) {
ctx.addIssue({
code: z.ZodIssueCode.custom,
path: ["id"],
message: "Specific stage approvers require an id",
});
}
});
export const pipelineStageOnEnterSchema = z.object({
type: z.literal("run_routine"),
routineId: z.string().guid(),
id: z.string().trim().min(1).max(200).optional(),
projectId: z.string().guid().optional().nullable(),
projectWorkspaceId: z.string().guid().optional().nullable(),
executionWorkspaceId: z.string().guid().optional().nullable(),
executionWorkspacePreference: z.enum(ISSUE_EXECUTION_WORKSPACE_PREFERENCES).optional().nullable(),
executionWorkspaceSettings: issueExecutionWorkspaceSettingsSchema.optional().nullable(),
}).passthrough();
export const pipelineStageAutomationSchema = z.object({
routineId: z.string().guid().optional().nullable(),
assigneeAgentId: z.string().guid().optional().nullable(),
instructionsBody: z.string().optional().nullable(),
projectId: z.string().guid().optional().nullable(),
projectWorkspaceId: z.string().guid().optional().nullable(),
executionWorkspaceId: z.string().guid().optional().nullable(),
executionWorkspacePreference: z.enum(ISSUE_EXECUTION_WORKSPACE_PREFERENCES).optional().nullable(),
executionWorkspaceSettings: issueExecutionWorkspaceSettingsSchema.optional().nullable(),
}).passthrough();
export const pipelineStageCarryOverPolicySchema = z.object({
version: z.literal(1).default(1),
mode: z.enum(["all_except", "only"]).default("all_except"),
includeFields: z.array(routineVariableLikeNameSchema).max(100).default([]),
excludeFields: z.array(routineVariableLikeNameSchema).max(100).default([]),
});
export const pipelineStageBreakdownSchema = z.object({
targetPipelineId: z.string().guid(),
targetStageKey: z.string().trim().min(1).max(120),
pieceNoun: z.string().trim().min(1).max(80).default("piece"),
carryOverPolicy: pipelineStageCarryOverPolicySchema.optional(),
inheritFields: z.array(routineVariableLikeNameSchema).max(100).default([]),
advanceTo: z.string().trim().min(1).max(120).optional(),
waitForPieces: z.boolean().optional().default(false),
whenFinishedMoveTo: z.string().trim().min(1).max(120).optional(),
}).superRefine((value, ctx) => {
if (value.waitForPieces && !value.whenFinishedMoveTo) {
ctx.addIssue({
code: z.ZodIssueCode.custom,
path: ["whenFinishedMoveTo"],
message: "Breakdown stages that wait for pieces need a destination stage",
});
}
});
export const pipelineStageVariableSchema = z.object({
key: routineVariableLikeNameSchema,
label: z.string().trim().max(120),
type: z.enum(["select", "text", "multiline"]).default("text"),
options: z.array(z.string().trim().min(1).max(120)).max(50).optional().default([]),
required: z.boolean().optional().default(false),
showInAddForm: z.boolean().optional().default(false),
}).superRefine((value, ctx) => {
if (value.type === "select" && value.options.length === 0) {
ctx.addIssue({
code: z.ZodIssueCode.custom,
path: ["options"],
message: "Select variables require at least one option",
});
}
if (value.type !== "select" && value.options.length > 0) {
ctx.addIssue({
code: z.ZodIssueCode.custom,
path: ["options"],
message: "Only select variables can define options",
});
}
});
export const pipelineStageConfigSchema = z.object({
variables: z.array(pipelineStageVariableSchema).default([]),
disabled: z.boolean().optional(),
disabledReason: z.string().trim().max(1_000).nullable().optional(),
requireApproval: z.boolean().optional(),
approver: pipelineStageApproverSchema.optional(),
/** Legacy input only; the server migrates it to requireApproval/approver. */
reviewerKind: z.enum(["human", "any"]).optional(),
whatHappensHere: z.string().trim().max(10_000).optional(),
onEnter: pipelineStageOnEnterSchema.optional(),
automation: pipelineStageAutomationSchema.optional(),
breakdown: pipelineStageBreakdownSchema.optional(),
approveToStageKey: z.string().trim().min(1).max(120).optional(),
rejectToStageKey: z.string().trim().min(1).max(120).optional(),
requestChangesToStageKey: z.string().trim().min(1).max(120).optional(),
requireRejectReason: z.boolean().optional(),
requireRequestChangesReason: z.boolean().optional(),
requireChildrenTerminal: z.boolean().optional(),
requireNoUnresolvedDrift: z.boolean().optional(),
}).passthrough().superRefine((value, ctx) => {
const keys = new Set<string>();
value.variables.forEach((variable, index) => {
if (keys.has(variable.key)) {
ctx.addIssue({
code: z.ZodIssueCode.custom,
path: ["variables", index, "key"],
message: "Pipeline stage variable keys must be unique",
});
}
keys.add(variable.key);
});
});
export const pipelineAutomationRetryScopeSchema = z.enum(["current_stage", "previous_stage"]);
export const pipelineAutomationRetryCleanupOptionsSchema = z.object({
retireDirectChildren: z.boolean().default(true),
retireDescendants: z.boolean().default(true),
cancelLinkedAutomationIssues: z.boolean().default(true),
});
export const pipelineAutomationRetryRequestSchema = z.object({
scope: pipelineAutomationRetryScopeSchema,
targetStageId: z.string().guid().nullable().optional(),
expectedVersion: z.number().int().positive(),
cleanup: pipelineAutomationRetryCleanupOptionsSchema.default({
retireDirectChildren: true,
retireDescendants: true,
cancelLinkedAutomationIssues: true,
}),
});
export type PipelineStageKind = z.infer<typeof pipelineStageKindSchema>;
export type PipelineStageApprover = z.infer<typeof pipelineStageApproverSchema>;
export type PipelineStageOnEnter = z.infer<typeof pipelineStageOnEnterSchema>;
export type PipelineStageAutomationConfig = z.infer<typeof pipelineStageAutomationSchema>;
export type PipelineStageCarryOverPolicy = z.infer<typeof pipelineStageCarryOverPolicySchema>;
export type PipelineStageBreakdown = z.infer<typeof pipelineStageBreakdownSchema>;
export type PipelineStageVariable = z.infer<typeof pipelineStageVariableSchema>;
export type PipelineStageConfig = z.infer<typeof pipelineStageConfigSchema>;
export type PipelineAutomationRetryScope = z.infer<typeof pipelineAutomationRetryScopeSchema>;
export type PipelineAutomationRetryCleanupOptions = z.infer<typeof pipelineAutomationRetryCleanupOptionsSchema>;
export type PipelineAutomationRetryRequest = z.infer<typeof pipelineAutomationRetryRequestSchema>;