@blazingagents/sdk 0.1.0

package/dist/contracts/entities/tasks.d.ts

@@ -0,0 +1,457 @@
+import { z } from "zod";
+/**
+ * Schedule kinds — discriminated union, Cohand's kinds with croner-forked
+ * next-run math. `staggerMs` is an optional cron load-spreading offset.
+ */
+export declare const taskScheduleKindSchema: z.ZodEnum<{
+    cron: "cron";
+    interval: "interval";
+    once: "once";
+}>;
+export declare const taskOnceConfigSchema: z.ZodObject<{
+    at: z.ZodISODateTime;
+}, z.core.$strict>;
+export declare const taskIntervalConfigSchema: z.ZodObject<{
+    everyMs: z.ZodNumber;
+}, z.core.$strict>;
+/**
+ * Croner validates the expression in the schedule's own timezone. The DBOS
+ * schedule plan uses that validated expression and timezone unchanged.
+ */
+export declare const taskCronConfigSchema: z.ZodObject<{
+    expression: z.ZodString;
+    staggerMs: z.ZodOptional<z.ZodNumber>;
+    timezone: z.ZodDefault<z.ZodString>;
+}, z.core.$strict>;
+export declare const taskScheduleInputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"once">;
+    config: z.ZodObject<{
+        at: z.ZodISODateTime;
+    }, z.core.$strict>;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"interval">;
+    config: z.ZodObject<{
+        everyMs: z.ZodNumber;
+    }, z.core.$strict>;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"cron">;
+    config: z.ZodObject<{
+        expression: z.ZodString;
+        staggerMs: z.ZodOptional<z.ZodNumber>;
+        timezone: z.ZodDefault<z.ZodString>;
+    }, z.core.$strict>;
+}, z.core.$strict>], "kind">;
+export type TaskScheduleInput = z.infer<typeof taskScheduleInputSchema>;
+/**
+ * `POST /v1/tasks` — schedule present = scheduled task; absent = on-demand.
+ * `submit: true` enqueues a run immediately (on-demand's only trigger
+ * alongside creation) with a server-minted random run id. This path is
+ * NOT idempotent — each call creates a new task + new run. For run-level
+ * idempotency, use `POST /v1/tasks/{taskId}/runs` with an idempotency key
+ * (the task must already exist so the deterministic run id is stable
+ * across replays).
+ */
+export declare const createTaskBodySchema: z.ZodObject<{
+    agentId: z.ZodString;
+    agentVersion: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    name: z.ZodString;
+    prompt: z.ZodString;
+    schedule: z.ZodDefault<z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"once">;
+        config: z.ZodObject<{
+            at: z.ZodISODateTime;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"interval">;
+        config: z.ZodObject<{
+            everyMs: z.ZodNumber;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"cron">;
+        config: z.ZodObject<{
+            expression: z.ZodString;
+            staggerMs: z.ZodOptional<z.ZodNumber>;
+            timezone: z.ZodDefault<z.ZodString>;
+        }, z.core.$strict>;
+    }, z.core.$strict>], "kind">>>;
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    submit: z.ZodDefault<z.ZodBoolean>;
+    userId: z.ZodDefault<z.ZodString>;
+    metadata: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strict>;
+export declare const updateTaskBodySchema: z.ZodObject<{
+    agentVersion: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    name: z.ZodOptional<z.ZodString>;
+    prompt: z.ZodOptional<z.ZodString>;
+    schedule: z.ZodOptional<z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"once">;
+        config: z.ZodObject<{
+            at: z.ZodISODateTime;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"interval">;
+        config: z.ZodObject<{
+            everyMs: z.ZodNumber;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"cron">;
+        config: z.ZodObject<{
+            expression: z.ZodString;
+            staggerMs: z.ZodOptional<z.ZodNumber>;
+            timezone: z.ZodDefault<z.ZodString>;
+        }, z.core.$strict>;
+    }, z.core.$strict>], "kind">>>;
+    enabled: z.ZodOptional<z.ZodBoolean>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strict>;
+export declare const createTaskRunBodySchema: z.ZodObject<{
+    idempotencyKey: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * Task run status. `blocked` is the soft-block terminal state for an expected
+ * admission denial, such as quota exhaustion, missing subscription, or
+ * insufficient Usage credit. Like the other terminal statuses, it sets
+ * `finishedAt` and frees the task's active-run slot for the next scheduled fire.
+ */
+export declare const taskRunStatusSchema: z.ZodEnum<{
+    blocked: "blocked";
+    canceled: "canceled";
+    failed: "failed";
+    queued: "queued";
+    running: "running";
+    succeeded: "succeeded";
+}>;
+export declare const taskSchema: z.ZodObject<{
+    id: z.ZodString;
+    tenantId: z.ZodString;
+    agentId: z.ZodString;
+    agentVersion: z.ZodNullable<z.ZodNumber>;
+    name: z.ZodString;
+    prompt: z.ZodString;
+    schedule: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"once">;
+        config: z.ZodObject<{
+            at: z.ZodISODateTime;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"interval">;
+        config: z.ZodObject<{
+            everyMs: z.ZodNumber;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"cron">;
+        config: z.ZodObject<{
+            expression: z.ZodString;
+            staggerMs: z.ZodOptional<z.ZodNumber>;
+            timezone: z.ZodDefault<z.ZodString>;
+        }, z.core.$strict>;
+    }, z.core.$strict>], "kind">>;
+    enabled: z.ZodBoolean;
+    activeRunId: z.ZodNullable<z.ZodString>;
+    latestRunId: z.ZodNullable<z.ZodString>;
+    userId: z.ZodString;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    deletedAt: z.ZodNullable<z.ZodISODateTime>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+}, z.core.$strict>;
+export declare const taskLatestRunSchema: z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        blocked: "blocked";
+        canceled: "canceled";
+        failed: "failed";
+        queued: "queued";
+        running: "running";
+        succeeded: "succeeded";
+    }>;
+    finishedAt: z.ZodNullable<z.ZodISODateTime>;
+}, z.core.$strict>;
+export declare const taskListItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    tenantId: z.ZodString;
+    agentId: z.ZodString;
+    agentVersion: z.ZodNullable<z.ZodNumber>;
+    name: z.ZodString;
+    prompt: z.ZodString;
+    schedule: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"once">;
+        config: z.ZodObject<{
+            at: z.ZodISODateTime;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"interval">;
+        config: z.ZodObject<{
+            everyMs: z.ZodNumber;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"cron">;
+        config: z.ZodObject<{
+            expression: z.ZodString;
+            staggerMs: z.ZodOptional<z.ZodNumber>;
+            timezone: z.ZodDefault<z.ZodString>;
+        }, z.core.$strict>;
+    }, z.core.$strict>], "kind">>;
+    enabled: z.ZodBoolean;
+    activeRunId: z.ZodNullable<z.ZodString>;
+    latestRunId: z.ZodNullable<z.ZodString>;
+    userId: z.ZodString;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    deletedAt: z.ZodNullable<z.ZodISODateTime>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+    latestRun: z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        status: z.ZodEnum<{
+            blocked: "blocked";
+            canceled: "canceled";
+            failed: "failed";
+            queued: "queued";
+            running: "running";
+            succeeded: "succeeded";
+        }>;
+        finishedAt: z.ZodNullable<z.ZodISODateTime>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const tasksListResponseSchema: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        tenantId: z.ZodString;
+        agentId: z.ZodString;
+        agentVersion: z.ZodNullable<z.ZodNumber>;
+        name: z.ZodString;
+        prompt: z.ZodString;
+        schedule: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"once">;
+            config: z.ZodObject<{
+                at: z.ZodISODateTime;
+            }, z.core.$strict>;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"interval">;
+            config: z.ZodObject<{
+                everyMs: z.ZodNumber;
+            }, z.core.$strict>;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"cron">;
+            config: z.ZodObject<{
+                expression: z.ZodString;
+                staggerMs: z.ZodOptional<z.ZodNumber>;
+                timezone: z.ZodDefault<z.ZodString>;
+            }, z.core.$strict>;
+        }, z.core.$strict>], "kind">>;
+        enabled: z.ZodBoolean;
+        activeRunId: z.ZodNullable<z.ZodString>;
+        latestRunId: z.ZodNullable<z.ZodString>;
+        userId: z.ZodString;
+        metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        deletedAt: z.ZodNullable<z.ZodISODateTime>;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+        latestRun: z.ZodNullable<z.ZodObject<{
+            id: z.ZodString;
+            status: z.ZodEnum<{
+                blocked: "blocked";
+                canceled: "canceled";
+                failed: "failed";
+                queued: "queued";
+                running: "running";
+                succeeded: "succeeded";
+            }>;
+            finishedAt: z.ZodNullable<z.ZodISODateTime>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export declare const tasksListQuerySchema: z.ZodObject<{
+    agentId: z.ZodOptional<z.ZodString>;
+    userId: z.ZodOptional<z.ZodString>;
+    cursor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strict>;
+export declare const taskResponseSchema: z.ZodObject<{
+    id: z.ZodString;
+    tenantId: z.ZodString;
+    agentId: z.ZodString;
+    agentVersion: z.ZodNullable<z.ZodNumber>;
+    name: z.ZodString;
+    prompt: z.ZodString;
+    schedule: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"once">;
+        config: z.ZodObject<{
+            at: z.ZodISODateTime;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"interval">;
+        config: z.ZodObject<{
+            everyMs: z.ZodNumber;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"cron">;
+        config: z.ZodObject<{
+            expression: z.ZodString;
+            staggerMs: z.ZodOptional<z.ZodNumber>;
+            timezone: z.ZodDefault<z.ZodString>;
+        }, z.core.$strict>;
+    }, z.core.$strict>], "kind">>;
+    enabled: z.ZodBoolean;
+    activeRunId: z.ZodNullable<z.ZodString>;
+    latestRunId: z.ZodNullable<z.ZodString>;
+    userId: z.ZodString;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    deletedAt: z.ZodNullable<z.ZodISODateTime>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+}, z.core.$strict>;
+export declare const taskRunSchema: z.ZodObject<{
+    id: z.ZodString;
+    taskId: z.ZodString;
+    tenantId: z.ZodString;
+    agentId: z.ZodString;
+    agentVersion: z.ZodNumber;
+    sessionId: z.ZodNullable<z.ZodString>;
+    turnId: z.ZodNullable<z.ZodString>;
+    status: z.ZodEnum<{
+        blocked: "blocked";
+        canceled: "canceled";
+        failed: "failed";
+        queued: "queued";
+        running: "running";
+        succeeded: "succeeded";
+    }>;
+    error: z.ZodNullable<z.ZodString>;
+    userId: z.ZodString;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    startedAt: z.ZodNullable<z.ZodISODateTime>;
+    finishedAt: z.ZodNullable<z.ZodISODateTime>;
+    cancelRequestedAt: z.ZodNullable<z.ZodISODateTime>;
+    canceledAt: z.ZodNullable<z.ZodISODateTime>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+}, z.core.$strict>;
+export declare const taskRunResponseSchema: z.ZodObject<{
+    id: z.ZodString;
+    taskId: z.ZodString;
+    tenantId: z.ZodString;
+    agentId: z.ZodString;
+    agentVersion: z.ZodNumber;
+    sessionId: z.ZodNullable<z.ZodString>;
+    turnId: z.ZodNullable<z.ZodString>;
+    status: z.ZodEnum<{
+        blocked: "blocked";
+        canceled: "canceled";
+        failed: "failed";
+        queued: "queued";
+        running: "running";
+        succeeded: "succeeded";
+    }>;
+    error: z.ZodNullable<z.ZodString>;
+    userId: z.ZodString;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    startedAt: z.ZodNullable<z.ZodISODateTime>;
+    finishedAt: z.ZodNullable<z.ZodISODateTime>;
+    cancelRequestedAt: z.ZodNullable<z.ZodISODateTime>;
+    canceledAt: z.ZodNullable<z.ZodISODateTime>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+}, z.core.$strict>;
+export declare const taskRunsListResponseSchema: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        taskId: z.ZodString;
+        tenantId: z.ZodString;
+        agentId: z.ZodString;
+        agentVersion: z.ZodNumber;
+        sessionId: z.ZodNullable<z.ZodString>;
+        turnId: z.ZodNullable<z.ZodString>;
+        status: z.ZodEnum<{
+            blocked: "blocked";
+            canceled: "canceled";
+            failed: "failed";
+            queued: "queued";
+            running: "running";
+            succeeded: "succeeded";
+        }>;
+        error: z.ZodNullable<z.ZodString>;
+        userId: z.ZodString;
+        metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        startedAt: z.ZodNullable<z.ZodISODateTime>;
+        finishedAt: z.ZodNullable<z.ZodISODateTime>;
+        cancelRequestedAt: z.ZodNullable<z.ZodISODateTime>;
+        canceledAt: z.ZodNullable<z.ZodISODateTime>;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+    }, z.core.$strict>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export declare const createTaskResponseSchema: z.ZodObject<{
+    task: z.ZodObject<{
+        id: z.ZodString;
+        tenantId: z.ZodString;
+        agentId: z.ZodString;
+        agentVersion: z.ZodNullable<z.ZodNumber>;
+        name: z.ZodString;
+        prompt: z.ZodString;
+        schedule: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"once">;
+            config: z.ZodObject<{
+                at: z.ZodISODateTime;
+            }, z.core.$strict>;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"interval">;
+            config: z.ZodObject<{
+                everyMs: z.ZodNumber;
+            }, z.core.$strict>;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"cron">;
+            config: z.ZodObject<{
+                expression: z.ZodString;
+                staggerMs: z.ZodOptional<z.ZodNumber>;
+                timezone: z.ZodDefault<z.ZodString>;
+            }, z.core.$strict>;
+        }, z.core.$strict>], "kind">>;
+        enabled: z.ZodBoolean;
+        activeRunId: z.ZodNullable<z.ZodString>;
+        latestRunId: z.ZodNullable<z.ZodString>;
+        userId: z.ZodString;
+        metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        deletedAt: z.ZodNullable<z.ZodISODateTime>;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+    }, z.core.$strict>;
+    runId: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export declare const createTaskRunResponseSchema: z.ZodObject<{
+    runId: z.ZodString;
+}, z.core.$strict>;
+export declare const taskRunMessagesResponseSchema: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        role: z.ZodEnum<{
+            assistant: "assistant";
+            system: "system";
+            user: "user";
+        }>;
+        parts: z.ZodArray<z.ZodObject<{
+            type: z.ZodString;
+        }, z.core.$loose>>;
+        metadata: z.ZodOptional<z.ZodUnknown>;
+    }, z.core.$loose>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+    latestCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export type Task = z.infer<typeof taskSchema>;
+export type TaskListItem = z.infer<typeof taskListItemSchema>;
+export type TaskLatestRun = z.infer<typeof taskLatestRunSchema>;
+export type TasksListResponse = z.infer<typeof tasksListResponseSchema>;
+export type TasksListQuery = z.infer<typeof tasksListQuerySchema>;
+export type TaskResponse = z.infer<typeof taskResponseSchema>;
+export type TaskRun = z.infer<typeof taskRunSchema>;
+export type TaskRunResponse = z.infer<typeof taskRunResponseSchema>;
+export type TaskRunStatus = z.infer<typeof taskRunStatusSchema>;
+export type TaskRunsListResponse = z.infer<typeof taskRunsListResponseSchema>;
+export type CreateTaskBody = z.input<typeof createTaskBodySchema>;
+export type UpdateTaskBody = z.infer<typeof updateTaskBodySchema>;
+export type CreateTaskRunBody = z.infer<typeof createTaskRunBodySchema>;
+export type CreateTaskResponse = z.infer<typeof createTaskResponseSchema>;
+export type CreateTaskRunResponse = z.infer<typeof createTaskRunResponseSchema>;
+export type TaskRunMessagesResponse = z.infer<typeof taskRunMessagesResponseSchema>;
+export type TaskScheduleKind = z.infer<typeof taskScheduleKindSchema>;