skedyul 1.7.26 → 1.7.28

package/dist/cli/api/workflows.d.ts

@@ -0,0 +1,134 @@
+import { type CliContext } from './context';
+export interface WorkflowVersion {
+    id: string;
+    version: number | null;
+    versionLabel: string | null;
+    contentHash: string | null;
+    createdAt: string;
+    isTriggerVersion?: boolean;
+}
+export interface WorkflowRecord {
+    id: string;
+    handle: string;
+    name: string;
+    description: string;
+    createdAt: string;
+    updatedAt: string;
+    triggerVersionId: string | null;
+    triggerVersion: number | null;
+    triggerVersionLabel: string | null;
+    versions?: WorkflowVersion[];
+}
+export interface WorkflowFieldError {
+    code: string;
+    message: string;
+}
+export interface DeployWorkflowResult {
+    success: boolean;
+    workflow: WorkflowRecord | null;
+    version: WorkflowVersion | null;
+    isNew: boolean;
+    reusedVersion: boolean;
+    pendingBuild: boolean;
+    message?: string;
+    errors?: Record<string, WorkflowFieldError>;
+    error?: string;
+}
+export interface ValidateWorkflowResult {
+    success: boolean;
+    valid: boolean;
+    handle?: string;
+    name?: string;
+    errors?: Record<string, WorkflowFieldError>;
+    error?: string;
+}
+export interface WorkflowInputField {
+    name: string;
+    type: string;
+    required: boolean;
+    description?: string;
+    label?: string;
+}
+export interface WorkflowSchema {
+    handle: string;
+    name: string;
+    description?: string;
+    version: number;
+    versionId: string;
+    inputs: WorkflowInputField[];
+    error?: string;
+}
+export interface RunWorkflowResult {
+    success: boolean;
+    workflowRunId: string;
+    status: string;
+    workflowId: string;
+    workflowVersionId: string;
+    version: number;
+    error?: string;
+}
+export interface WorkflowRunStep {
+    id: string;
+    handle: string;
+    name: string;
+    status: string;
+    startedAt: string | null;
+    completedAt: string | null;
+}
+export interface WorkflowRunStatus {
+    success: boolean;
+    workflowRunId: string;
+    status: string;
+    startedAt: string | null;
+    completedAt: string | null;
+    failedAt: string | null;
+    cancelledAt: string | null;
+    steps: WorkflowRunStep[];
+    error?: string;
+}
+export interface PublishWorkflowResult {
+    success: boolean;
+    workflowId: string;
+    workflowVersionId: string;
+    version: number;
+}
+export interface PullWorkflowResult {
+    success: boolean;
+    yaml: string;
+    version: number;
+    handle: string;
+}
+/** Local Zod/YAML check used by CLI before any server call. */
+export declare function validateWorkflowContent(yamlContent: string): {
+    content: string;
+};
+export declare function listWorkflows(ctx: CliContext, workplace: string): Promise<WorkflowRecord[]>;
+export declare function getWorkflow(ctx: CliContext, workplace: string, handle: string): Promise<WorkflowRecord>;
+export declare function listWorkflowVersions(ctx: CliContext, workplace: string, handle: string): Promise<WorkflowVersion[]>;
+export declare function validateWorkflow(ctx: CliContext, workplace: string, yamlContent: string): Promise<ValidateWorkflowResult>;
+export interface DeployWorkflowOptions {
+    publish?: boolean;
+    versionLabel?: string;
+}
+export declare function deployWorkflow(ctx: CliContext, workplace: string, yamlContent: string, options?: DeployWorkflowOptions): Promise<DeployWorkflowResult>;
+export declare function publishWorkflow(ctx: CliContext, workplace: string, handle: string, version: number): Promise<PublishWorkflowResult>;
+export declare function pullWorkflow(ctx: CliContext, workplace: string, handle: string, version?: number): Promise<PullWorkflowResult>;
+export declare function getWorkflowSchema(ctx: CliContext, workplace: string, handle: string, version?: number): Promise<WorkflowSchema>;
+export declare function runWorkflow(ctx: CliContext, workplace: string, handle: string, options?: {
+    version?: number;
+    inputs?: Record<string, string>;
+}): Promise<RunWorkflowResult>;
+export declare function getWorkflowRun(ctx: CliContext, workplace: string, workflowRunId: string): Promise<WorkflowRunStatus>;
+export declare const workflows: {
+    list: typeof listWorkflows;
+    get: typeof getWorkflow;
+    versions: typeof listWorkflowVersions;
+    validate: typeof validateWorkflow;
+    validateLocal: typeof validateWorkflowContent;
+    deploy: typeof deployWorkflow;
+    publish: typeof publishWorkflow;
+    pull: typeof pullWorkflow;
+    schema: typeof getWorkflowSchema;
+    run: typeof runWorkflow;
+    getRun: typeof getWorkflowRun;
+};