@work-shape/catalyst-api-contract 0.8.0-rc.10 → 0.8.0-rc.11

package/dist/index.js

@@ -823,7 +823,7 @@ import { z as z49 } from "zod";
 // package.json
 var package_default = {
   name: "@work-shape/catalyst-api-contract",
-  version: "0.8.0-rc.10",
+  version: "0.8.0-rc.11",
   license: "MIT",
   repository: {
     type: "git",
@@ -887,7 +887,7 @@ var appErrorCodeSchema = z7.enum(APP_ERROR_CODES);
 var API_ERROR_MEANINGS = {
   BAD_REQUEST: "The request cannot be read.",
   UNAUTHENTICATED: "No credential was presented, or the credential is not valid.",
-  FORBIDDEN: "The caller lacks the scope or the right this operation requires.",
+  FORBIDDEN: "The caller lacks the scope or the right this operation requires. `details.reason` is `two_factor_setup_required` where the instance requires two-factor sign-in and the person signed in with a password, or the owner of the personal key, has not set it up: every operation but `me.get` is refused until they have.",
   NOT_FOUND: "The resource does not exist, is not visible to the caller, or the instance runs without this operation.",
   CONFLICT: "The request conflicts with the current state of the resource.",
   REVISION_CONFLICT: "An asset the call writes is at another revision than the one the call names, or the name it creates is taken or was deleted. Nothing was written. `details.conflicts` names each such asset, with its current revision and who changed it when for an asset the caller may read.",
@@ -923,6 +923,7 @@ var unknownOperationSchema = z7.object({
   })
 });
 var BODY_TOO_LARGE_REASON = "body_too_large";
+var TWO_FACTOR_SETUP_REQUIRED_REASON = "two_factor_setup_required";
 var INVALID_JSON_BODY_REASON = "invalid_json_body";
 function isUnknownOperationResponse(payload) {
   return unknownOperationSchema.safeParse(payload).success;
@@ -1566,7 +1567,12 @@ var apiUserSchema = z12.object({
   principal: authPrincipalSchema.optional(),
   subjectUserId: z12.string().optional(),
   delegatedActor: delegatedActorSchema.optional(),
-  scopes: z12.array(authScopeSchema).optional()
+  scopes: z12.array(authScopeSchema).optional(),
+  /**
+   * Two-factor sign-in of a person signed in with a password (TWO-FACTOR-1): whether the instance
+   * requires it and whether the person has set it up. Left out for every other way in.
+   */
+  twoFactor: z12.object({ required: z12.boolean(), enrolled: z12.boolean() }).optional()
 });
 var issueSessionTokenRequestSchema = z12.object({
   externalUserId: z12.string().min(1),
@@ -1614,7 +1620,9 @@ var administeredUserSchema = z12.object({
   createdAt: timestampSchema,
   updatedAt: timestampSchema,
   lastAuthenticatedAt: timestampSchema.optional(),
-  identities: z12.array(administeredUserIdentitySchema)
+  identities: z12.array(administeredUserIdentitySchema),
+  /** Whether the user's password sign-in has a second factor. Left out without a password sign-in. */
+  twoFactorEnabled: z12.boolean().optional()
 });
 var administeredUserPasswordSignInRequestSchema = z12.object({
   password: z12.string().min(8)
@@ -1668,6 +1676,10 @@ var resetAdministeredUserPasswordRequestSchema = z12.object({
 var resetAdministeredUserPasswordResponseSchema = z12.object({
   ok: z12.literal(true)
 });
+var resetAdministeredUserTwoFactorResponseSchema = z12.object({
+  ok: z12.literal(true),
+  hadFactor: z12.boolean()
+});
 var requestPasswordResetRequestSchema = z12.object({
   email: z12.string().email()
 });
@@ -2055,7 +2067,9 @@ var configAssetReferencesSchema = z13.object({
       id: z13.string(),
       model: z13.string(),
       /** The name people read, when release config gives one. */
-      label: z13.string().optional()
+      label: z13.string().optional(),
+      /** The binding that answers when this one is overloaded or down, where it names one. */
+      fallback: z13.string().optional()
     })
   ),
   fastModeModelBindingIds: z13.array(z13.string()),
@@ -3020,6 +3034,7 @@ import {
   DECIDED_APPROVAL_REQUEST_STATUSES,
   ENDED_APPROVAL_EXECUTIONS,
   MESSAGE_FINISH_STATUSES,
+  MODEL_FALLBACK_REASONS,
   MODEL_USAGE_LIMIT_PERIODS as MODEL_USAGE_LIMIT_PERIODS2,
   MODEL_USAGE_LIMIT_METRICS,
   MODEL_USAGE_LIMIT_SCOPES,
@@ -3066,6 +3081,16 @@ var storedModelContextSnapshotSchema = z18.object({
   compactThresholdTokens: z18.number(),
   compacted: z18.boolean()
 });
+var storedModelFallbackBindingSchema = z18.object({
+  bindingId: z18.string(),
+  model: z18.string(),
+  label: z18.string().optional()
+});
+var storedModelFallbackSchema = z18.object({
+  from: storedModelFallbackBindingSchema,
+  to: storedModelFallbackBindingSchema,
+  reason: z18.enum(MODEL_FALLBACK_REASONS)
+});
 var storedToolCallSchema = z18.object({
   toolCallId: z18.string(),
   toolName: z18.string(),
@@ -3136,7 +3161,9 @@ var assistantFinalMessageMetadataSchema = z18.object({
   sources: z18.array(webSourceSchema).optional(),
   knowledgeSources: z18.array(knowledgeCitationSourceSchema).optional(),
   citations: z18.array(messageCitationSchema).optional(),
-  modelContext: storedModelContextSnapshotSchema.optional()
+  modelContext: storedModelContextSnapshotSchema.optional(),
+  /** The run switched to its binding's fallback, which wrote this answer. */
+  modelFallback: storedModelFallbackSchema.optional()
 });
 var toolResultMessageMetadataSchema = z18.object({
   version: messageMetadataVersionSchema,
@@ -5977,6 +6004,20 @@ var connectionTestResultSchema = z28.object({
   status: z28.enum(CONNECTOR_TEST_STATUSES),
   testedAt: timestampSchema
 });
+var sourceFolderSchema = z28.object({
+  id: z28.string().min(1).max(500),
+  name: z28.string().min(1).max(1e3)
+});
+var connectionSourceFoldersQuerySchema = z28.object({
+  parent: z28.string().min(1).max(500).optional(),
+  pageToken: z28.string().min(1).max(4e3).optional()
+});
+var connectionSourceFoldersSchema = z28.object({
+  /** The folder listed, with its path from the top; `/` for the top. */
+  folder: sourceFolderSchema.extend({ path: z28.string().min(1).max(4e3) }),
+  folders: z28.array(sourceFolderSchema),
+  nextPageToken: z28.string().min(1).max(4e3).optional()
+});
 var connectionToolSchema = z28.object({
   toolName: z28.string(),
   operation: z28.string(),
@@ -6352,6 +6393,21 @@ var connectionOperations = {
     errors: ["NOT_FOUND", "CONFLICT"],
     rateClass: "write"
   }),
+  "connections.source_folders": defineRegisteredOperation({
+    id: "connections.source_folders",
+    method: "GET",
+    path: "/api/v1/connections/:name/source-folders",
+    summary: "List the folders inside one folder of a document source, to choose a Knowledge Base's folders",
+    tag: "Connections",
+    auth: "principal",
+    scope: "config_assets:read",
+    requires: [],
+    effect: "reading",
+    query: connectionSourceFoldersQuerySchema,
+    response: json(connectionSourceFoldersSchema),
+    errors: ["NOT_FOUND", "CONFLICT", "TIMEOUT"],
+    rateClass: "read"
+  }),
   // A path of its own: `agent-tools` would be a valid Connection name under `/connections/`.
   "connections.connector_types": defineRegisteredOperation({
     id: "connections.connector_types",
@@ -9560,6 +9616,20 @@ var userOperations = {
     errors: ["NOT_FOUND"],
     rateClass: "write"
   }),
+  "users.two_factor.reset": defineRegisteredOperation({
+    id: "users.two_factor.reset",
+    method: "POST",
+    path: "/api/v1/instance/users/:userId/two-factor/reset",
+    summary: "Reset a user's two-factor sign-in: delete their second factor and trusted browsers and end their sessions. Needs the right `users.manage`. Only a superadmin resets a superadmin; nobody resets their own.",
+    tag: "Users",
+    auth: "user",
+    scope: "user_admin:write",
+    requires: [],
+    effect: "changing",
+    response: json(resetAdministeredUserTwoFactorResponseSchema),
+    errors: ["NOT_FOUND"],
+    rateClass: "write"
+  }),
   "users.invitation.send": defineRegisteredOperation({
     id: "users.invitation.send",
     method: "POST",
@@ -10214,6 +10284,7 @@ __export(schemas_exports, {
   MAX_LIST_LIMIT: () => MAX_LIST_LIMIT,
   REFUSAL_REASONS: () => REFUSAL_REASONS,
   ROLE_GRANTS_MAX: () => ROLE_GRANTS_MAX,
+  TWO_FACTOR_SETUP_REQUIRED_REASON: () => TWO_FACTOR_SETUP_REQUIRED_REASON,
   UNKNOWN_OPERATION_REASON: () => UNKNOWN_OPERATION_REASON,
   USAGE_BREAKDOWN_MAX_DAYS: () => USAGE_BREAKDOWN_MAX_DAYS,
   VIEW_RUNTIME: () => VIEW_RUNTIME,
@@ -10482,6 +10553,7 @@ __export(schemas_exports, {
   requestPasswordResetResponseSchema: () => requestPasswordResetResponseSchema,
   resetAdministeredUserPasswordRequestSchema: () => resetAdministeredUserPasswordRequestSchema,
   resetAdministeredUserPasswordResponseSchema: () => resetAdministeredUserPasswordResponseSchema,
+  resetAdministeredUserTwoFactorResponseSchema: () => resetAdministeredUserTwoFactorResponseSchema,
   revertAssetRequestSchema: () => revertAssetRequestSchema,
   roleGrantSchema: () => roleGrantSchema,
   rolePendingActionSchema: () => rolePendingActionSchema,
@@ -10514,6 +10586,7 @@ __export(schemas_exports, {
   startConversationRunRequestSchema: () => startConversationRunRequestSchema,
   startConversationRunResponseSchema: () => startConversationRunResponseSchema,
   storedModelContextSnapshotSchema: () => storedModelContextSnapshotSchema,
+  storedModelFallbackSchema: () => storedModelFallbackSchema,
   storedReasoningSummarySchema: () => storedReasoningSummarySchema,
   storedToolCallSchema: () => storedToolCallSchema,
   structuredDataResourceResponseSchema: () => structuredDataResourceResponseSchema,
@@ -11309,6 +11382,7 @@ export {
   REFUSAL_REASONS,
   RELEASE_VERSION,
   ROLE_GRANTS_MAX,
+  TWO_FACTOR_SETUP_REQUIRED_REASON,
   UNKNOWN_OPERATION_REASON,
   USAGE_BREAKDOWN_MAX_DAYS,
   VIEW_RUNTIME,
@@ -11462,6 +11536,8 @@ export {
   connectionPeopleSchema,
   connectionPersonContextSchema,
   connectionSecretStateSchema,
+  connectionSourceFoldersQuerySchema,
+  connectionSourceFoldersSchema,
   connectionTestResultSchema,
   connectionToolSchema,
   connectionToolsSchema,
@@ -11637,6 +11713,7 @@ export {
   requestPasswordResetResponseSchema,
   resetAdministeredUserPasswordRequestSchema,
   resetAdministeredUserPasswordResponseSchema,
+  resetAdministeredUserTwoFactorResponseSchema,
   revertAssetRequestSchema,
   roleGrantSchema,
   rolePendingActionSchema,
@@ -11677,6 +11754,7 @@ export {
   startConversationRunResponseSchema,
   startWorkflowRunRequestSchema,
   storedModelContextSnapshotSchema,
+  storedModelFallbackSchema,
   storedReasoningSummarySchema,
   storedToolCallSchema,
   structuredDataResourceResponseSchema,