@work-shape/catalyst-api-contract 0.8.0-rc.3 → 0.8.0-rc.4

package/dist/index.js

@@ -769,7 +769,7 @@ import { z as z39 } from "zod";
 // package.json
 var package_default = {
   name: "@work-shape/catalyst-api-contract",
-  version: "0.8.0-rc.3",
+  version: "0.8.0-rc.4",
   license: "MIT",
   repository: {
     type: "git",
@@ -2564,6 +2564,10 @@ var agentDraftSchema = z13.object({
   config: configAssetConfigSchema,
   author: z13.object({
     userId: z13.string().optional(),
+    /** The name of the person who wrote the draft last, while their account exists. */
+    displayLabel: z13.string().optional(),
+    /** The name people read for the person who wrote the draft last, while they exist. */
+    name: z13.string().optional(),
     conversationId: z13.string().optional(),
     release: z13.boolean()
   }),
@@ -2618,6 +2622,8 @@ var agentDraftSummarySchema = z14.object({
   baseRevision: revisionNumberSchema2,
   author: z14.object({
     userId: z14.string().optional(),
+    /** The name of the person who wrote the draft last, while their account exists. */
+    displayLabel: z14.string().optional(),
     conversationId: z14.string().optional(),
     release: z14.boolean()
   }),
@@ -2662,6 +2668,7 @@ var assetFileSchema = z14.object({
   text: z14.string().optional(),
   base64: z14.string().optional()
 });
+var assetVerbSchema = z14.enum(["write", "delete", "publish"]);
 var assetSchema = z14.object({
   id: z14.string(),
   kind: z14.string(),
@@ -2673,6 +2680,8 @@ var assetSchema = z14.object({
   config: configAssetConfigSchema,
   /** The active account's display label for the Workflow revision returned by this read. */
   runsAs: z14.string().optional(),
+  /** Unrecorded draft review lines naming its audience and shared source accounts. */
+  publishQuestion: z14.array(z14.string()).optional(),
   /**
    * The revision `config` and `files` are of, for a kind with a draft and a published revision:
    * the draft where the call names none.
@@ -2700,6 +2709,12 @@ var assetSchema = z14.object({
   unavailableModels: z14.array(unavailableModelSchema).optional(),
   /** False when the primary model is unavailable; no model is substituted. */
   chatAvailable: z14.boolean().optional(),
+  /**
+   * What the caller may do to this asset, as the instance decides it on this asset: grants and
+   * denies on the instance, a Namespace, a workspace and the asset itself. A kind without a
+   * published revision names no `publish`. Left out by an instance from before AD-4.
+   */
+  allowed: z14.array(assetVerbSchema).optional(),
   updatedAt: timestampSchema
 });
 var assetWarningSchema = z14.object({ code: z14.string(), message: z14.string() });
@@ -6231,8 +6246,20 @@ var jobOperations = {
 };
 
 // src/operations/knowledge.ts
+import {
+  knowledgeSyncInputSchema,
+  knowledgeSyncResultSchema,
+  knowledgeSourcesOutputSchema,
+  knowledgeSourceItemsInputSchema,
+  knowledgeSourceItemsOutputSchema,
+  knowledgeLocateInputSchema,
+  knowledgeLocateOutputSchema,
+  knowledgeRetryInputSchema,
+  knowledgeRetryOutputSchema
+} from "@work-shape/catalyst-asset-schemas";
 import {
   DATA_STORE_SCALAR_TYPES as DATA_STORE_SCALAR_TYPES2,
+  MANAGED_FILE_STATUSES,
   KNOWLEDGE_BASE_STATUSES,
   KNOWLEDGE_DOCUMENT_FAILURE_CODES,
   KNOWLEDGE_DOCUMENT_STATES,
@@ -6314,6 +6341,8 @@ var knowledgeListDocumentsResponseSchema = z32.object({
       format: z32.string(),
       /** The size of the file in bytes. */
       bytes: z32.number().int(),
+      /** Released originals remain at the source; file metadata and extracted text stay here. */
+      originalStatus: z32.enum(MANAGED_FILE_STATUSES).exclude(["deleted"]).optional(),
       /** `pending` until it is searchable, then `indexed`; `failed` with `failureCode`. */
       state: z32.enum(KNOWLEDGE_DOCUMENT_STATES),
       failureCode: z32.enum(KNOWLEDGE_DOCUMENT_FAILURE_CODES).optional(),
@@ -6335,16 +6364,6 @@ var knowledgeListDocumentsResponseSchema = z32.object({
   /** Present while more documents follow. */
   nextCursor: z32.string().optional()
 });
-var knowledgeRetryDocumentsRequestSchema = z32.strictObject({
-  /** The documents to index again: failed ones, or pending ones whose indexing seems stuck. */
-  documentIds: z32.array(z32.string().min(1)).min(1).max(100)
-});
-var knowledgeRetryDocumentsResponseSchema = z32.object({
-  /** Each named document in the Knowledge Base, with its state after the retry. */
-  documents: z32.array(z32.object({ id: z32.string(), state: z32.enum(KNOWLEDGE_DOCUMENT_STATES) })),
-  /** How many contents were queued to be indexed again. */
-  queued: z32.number().int()
-});
 var knowledgeSearchRequestSchema = z32.strictObject({
   /** Words or a question. Quoted words are a phrase, and a word after `-` is left out. */
   query: z32.string().trim().min(1).max(1e3),
@@ -6382,6 +6401,53 @@ var BASE = {
   errors: ["NOT_FOUND", "CONFLICT", "TIMEOUT"]
 };
 var knowledgeOperations = {
+  "knowledge_bases.sync": defineRegisteredOperation({
+    ...BASE,
+    id: "knowledge_bases.sync",
+    method: "POST",
+    path: "/api/v1/knowledge-bases/:knowledgeBase/sync",
+    summary: "Start a full source sync and return its Operation Run immediately; concurrent starts join the running sync",
+    scope: "config_assets:write",
+    effect: "changing",
+    body: knowledgeSyncInputSchema,
+    response: json(knowledgeSyncResultSchema),
+    rateClass: "write"
+  }),
+  "knowledge_bases.sources": defineRegisteredOperation({
+    ...BASE,
+    id: "knowledge_bases.sources",
+    method: "GET",
+    path: "/api/v1/knowledge-bases/:knowledgeBase/sources",
+    summary: "Read source states, counts, failure codes and sync progress",
+    scope: "config_assets:read",
+    effect: "reading",
+    response: json(knowledgeSourcesOutputSchema),
+    rateClass: "read"
+  }),
+  "knowledge_bases.source_items": defineRegisteredOperation({
+    ...BASE,
+    id: "knowledge_bases.source_items",
+    method: "GET",
+    path: "/api/v1/knowledge-bases/:knowledgeBase/sources/:source/items",
+    summary: "Page through the items of a source, newest change first; filter by state or failure code",
+    scope: "config_assets:read",
+    effect: "reading",
+    query: knowledgeSourceItemsInputSchema.omit({ source: true }),
+    response: json(knowledgeSourceItemsOutputSchema),
+    rateClass: "read"
+  }),
+  "knowledge_bases.locate": defineRegisteredOperation({
+    ...BASE,
+    id: "knowledge_bases.locate",
+    method: "GET",
+    path: "/api/v1/knowledge-bases/:knowledgeBase/locate",
+    summary: "Locate a source item for erasure: state and lifecycle times without content, file name or path",
+    scope: "config_assets:read",
+    effect: "reading",
+    query: knowledgeLocateInputSchema,
+    response: json(knowledgeLocateOutputSchema),
+    rateClass: "read"
+  }),
   "knowledge_bases.get": defineRegisteredOperation({
     ...BASE,
     id: "knowledge_bases.get",
@@ -6462,10 +6528,10 @@ var knowledgeOperations = {
     method: "POST",
     path: "/api/v1/knowledge-bases/:knowledgeBase/documents/retry",
     summary: "Index documents of a Knowledge Base again: a failed one goes back to pending, and its content is queued",
-    scope: "data_store_rows:write",
+    scope: "config_assets:write",
     effect: "changing",
-    body: knowledgeRetryDocumentsRequestSchema,
-    response: json(knowledgeRetryDocumentsResponseSchema),
+    body: knowledgeRetryInputSchema,
+    response: json(knowledgeRetryOutputSchema),
     errors: ["NOT_FOUND", "CONFLICT", "VALIDATION_FAILED", "TIMEOUT"],
     rateClass: "write"
   }),
@@ -7316,6 +7382,8 @@ import {
 } from "@work-shape/catalyst-asset-schemas";
 import { z as z38 } from "zod";
 var WORKFLOW_RUN_OUTPUT_PREVIEW_MAX_CHARS = 2e3;
+var WORKFLOW_RUN_KEY_MAX_CHARS = 200;
+var runKeySchema = z38.string().min(1).max(WORKFLOW_RUN_KEY_MAX_CHARS);
 var runStatusSchema = z38.enum(WORKFLOW_RUN_STATUSES2);
 var stepRunStatusSchema = z38.enum(WORKFLOW_STEP_RUN_STATUSES);
 var stepTypeSchema = z38.enum([...WORKFLOW_STEP_TYPES, ...WORKFLOW_RESERVED_STEP_TYPES]);
@@ -7360,6 +7428,11 @@ var workflowRunSchema = z38.object({
   }),
   /** The due time of the schedule that started the run. Missing on every other run. */
   scheduledFor: timestampSchema.optional(),
+  /**
+   * The run key its start gave the run, such as `2026-09/1402`. Among the Workflow's runs that
+   * are open or `done` a key exists once. Missing on a run started without one.
+   */
+  runKey: z38.string().optional(),
   /** The Operation Run of the call that started the run. */
   operationRunId: z38.string().optional(),
   parentRunId: z38.string().optional(),
@@ -7431,6 +7504,11 @@ var workflowStepRunSchema = z38.object({
   attempt: z38.number().int().min(0),
   /** The Operation Run of the call an operation step made. */
   operationRunId: z38.string().optional(),
+  /**
+   * On the step run of a `workflow` step whose start a run key answered: the run it waits for
+   * and does not own. Cancelling this run leaves that one going.
+   */
+  linkedRunId: z38.string().optional(),
   error: workflowRunErrorSchema.optional(),
   outputPreview: workflowOutputPreviewSchema.optional(),
   createdAt: timestampSchema,
@@ -7439,7 +7517,17 @@ var workflowStepRunSchema = z38.object({
 });
 var startWorkflowRunRequestSchema = z38.object({
   /** The input of the run, checked against the `inputs` of the Workflow's definition. */
-  input: z38.record(z38.string(), z38.unknown()).optional()
+  input: z38.record(z38.string(), z38.unknown()).optional(),
+  /**
+   * The run key, such as `2026-09/1402`. Where a run of the Workflow that is open or `done`
+   * holds it, the start starts nothing and answers that run; a run that ended `failed`,
+   * `cancelled` or `limit_reached` holds no key.
+   */
+  key: runKeySchema.optional()
+});
+var listWorkflowRunsQuerySchema = listQuerySchema.extend({
+  key: runKeySchema.optional(),
+  keyPrefix: runKeySchema.optional()
 });
 var listWorkflowStepRunsQuerySchema = listQuerySchema.extend({
   topLevel: z38.enum(["true", "false"]).optional(),
@@ -7516,7 +7604,7 @@ var workflowOperations = {
     effect: "changing",
     body: startWorkflowRunRequestSchema,
     response: json(workflowRunSchema),
-    errors: ["NOT_FOUND", "CONFLICT"],
+    errors: ["NOT_FOUND", "CONFLICT", "VALIDATION_FAILED"],
     rateClass: "write"
   }),
   "workflows.test": defineRegisteredOperation({
@@ -7538,15 +7626,15 @@ var workflowOperations = {
     id: "workflows.list_runs",
     method: "GET",
     path: "/api/v1/workflows/:workflow/runs",
-    summary: "List the runs of one Workflow with their status, newest first",
+    summary: "List the runs of one Workflow with their status, newest first: all of them, or those of one run key or key prefix",
     tag: "Workflows",
     auth: "principal",
     scope: "config_assets:read",
     requires: [],
     effect: "reading",
-    query: listQuerySchema,
+    query: listWorkflowRunsQuerySchema,
     response: page(workflowRunSchema, ["createdAt", "id"], true),
-    errors: [],
+    errors: ["VALIDATION_FAILED"],
     rateClass: "read"
   }),
   "workflows.get_run": defineRegisteredOperation({
@@ -7717,6 +7805,7 @@ __export(schemas_exports, {
   assetSyncItemSchema: () => assetSyncItemSchema,
   assetSyncRefusedItemSchema: () => assetSyncRefusedItemSchema,
   assetValidationIssueSchema: () => assetValidationIssueSchema,
+  assetVerbSchema: () => assetVerbSchema,
   assetWarningSchema: () => assetWarningSchema,
   assetWriteResponseSchema: () => assetWriteResponseSchema,
   assistantFinalMessageMetadataSchema: () => assistantFinalMessageMetadataSchema,
@@ -8664,6 +8753,7 @@ export {
   VIEW_RUNTIME,
   VIEW_SHELL,
   VIEW_SHELL_MESSAGES,
+  WORKFLOW_RUN_KEY_MAX_CHARS,
   WORKFLOW_RUN_OUTPUT_PREVIEW_MAX_CHARS,
   activeRunSummarySchema,
   addWorkspaceMemberRequestSchema,
@@ -8742,6 +8832,7 @@ export {
   assetSyncItemSchema,
   assetSyncRefusedItemSchema,
   assetValidationIssueSchema,
+  assetVerbSchema,
   assetWarningSchema,
   assetWriteResponseSchema,
   assistantFinalMessageMetadataSchema,
@@ -8868,6 +8959,7 @@ export {
   listLiveOnceQuerySchema,
   listPermissionGrantsQuerySchema,
   listQuerySchema,
+  listWorkflowRunsQuerySchema,
   listWorkflowStepRunsQuerySchema,
   listWorkspaceFilesQuerySchema,
   liveOnceListSchema,