@futurity/chat-protocol 0.0.1

package/dist/index.js

@@ -0,0 +1,489 @@
+// src/chat-websocket.ts
+import { z as z2 } from "zod";
+
+// src/message-parts.ts
+import { z } from "zod";
+var Z_ProviderMetadataSchema = z.record(
+  z.string(),
+  z.record(z.string(), z.any())
+);
+var Z_TextUIPartSchema = z.object({
+  type: z.literal("text"),
+  text: z.string(),
+  state: z.enum(["streaming", "done"]).optional(),
+  providerMetadata: Z_ProviderMetadataSchema.optional()
+});
+var Z_ReasoningUIPartSchema = z.object({
+  type: z.literal("reasoning"),
+  text: z.string(),
+  state: z.enum(["streaming", "done"]).optional(),
+  providerMetadata: Z_ProviderMetadataSchema.optional()
+});
+var Z_SourceUrlUIPartSchema = z.object({
+  type: z.literal("source-url"),
+  sourceId: z.string(),
+  url: z.string(),
+  title: z.string().optional(),
+  providerMetadata: Z_ProviderMetadataSchema.optional()
+});
+var Z_SourceDocumentUIPartSchema = z.object({
+  type: z.literal("source-document"),
+  sourceId: z.string(),
+  mediaType: z.string(),
+  title: z.string(),
+  filename: z.string().optional(),
+  providerMetadata: Z_ProviderMetadataSchema.optional()
+});
+var Z_FileUIPartSchema = z.object({
+  type: z.literal("file"),
+  mediaType: z.string(),
+  filename: z.string().optional(),
+  url: z.string(),
+  providerMetadata: Z_ProviderMetadataSchema.optional()
+});
+var Z_StepStartUIPartSchema = z.object({
+  type: z.literal("step-start")
+});
+var Z_DataUIPartSchema = z.object({
+  type: z.custom((value) => {
+    return typeof value === "string" && value.startsWith("data-");
+  }),
+  id: z.string().optional(),
+  data: z.unknown()
+});
+var Z_DataSplitSchema = z.object({
+  type: z.literal("data-split"),
+  data: z.object({
+    title: z.string(),
+    subtitle: z.string().optional(),
+    desktopSessionId: z.string().optional(),
+    subAgentId: z.string().optional()
+  })
+});
+var Z_DataEndSplitSchema = z.object({
+  type: z.literal("data-endsplit"),
+  data: z.object({
+    desktopSessionId: z.string().optional(),
+    subAgentId: z.string().optional()
+  }).optional()
+});
+var Z_DataSubagentPartSchema = z.object({
+  type: z.literal("data-subagent-part"),
+  data: z.object({
+    subAgentId: z.string(),
+    part: z.unknown()
+  })
+});
+var Z_DataStatusSchema = z.object({
+  type: z.literal("data-status"),
+  id: z.string().optional(),
+  data: z.object({
+    status: z.enum(["loading", "ready", "error"]),
+    text: z.string()
+  })
+});
+var Z_DataClarifyResponseSchema = z.object({
+  type: z.literal("data-clarify-response"),
+  data: z.object({
+    answers: z.record(z.string(), z.string())
+  })
+});
+var Z_DataScreenshotSchema = z.object({
+  type: z.literal("data-screenshot"),
+  data: z.object({
+    src: z.string(),
+    toolName: z.string().optional()
+  })
+});
+var Z_DataViewSwitchSchema = z.object({
+  type: z.literal("data-view-switch"),
+  data: z.object({
+    view: z.enum(["browser", "terminal"])
+  })
+});
+var Z_DataFileHighlightSchema = z.object({
+  type: z.literal("data-file-highlight"),
+  data: z.object({
+    path: z.string(),
+    label: z.string().optional()
+  })
+});
+var Z_BaseToolInvocationSchema = z.object({
+  toolCallId: z.string(),
+  title: z.string().optional(),
+  providerExecuted: z.boolean().optional()
+});
+var Z_ToolInvocationInputStreamingSchema = Z_BaseToolInvocationSchema.extend({
+  state: z.literal("input-streaming"),
+  input: z.unknown(),
+  callProviderMetadata: Z_ProviderMetadataSchema.optional()
+});
+var Z_ToolInvocationInputAvailableSchema = Z_BaseToolInvocationSchema.extend({
+  state: z.literal("input-available"),
+  input: z.unknown(),
+  callProviderMetadata: Z_ProviderMetadataSchema.optional()
+});
+var Z_ToolInvocationApprovalRequestedSchema = Z_BaseToolInvocationSchema.extend({
+  state: z.literal("approval-requested"),
+  input: z.unknown(),
+  callProviderMetadata: Z_ProviderMetadataSchema.optional(),
+  approval: z.object({
+    id: z.string()
+  })
+});
+var Z_ToolInvocationApprovalRespondedSchema = Z_BaseToolInvocationSchema.extend({
+  state: z.literal("approval-responded"),
+  input: z.unknown(),
+  callProviderMetadata: Z_ProviderMetadataSchema.optional(),
+  approval: z.object({
+    id: z.string(),
+    approved: z.boolean(),
+    reason: z.string().optional()
+  })
+});
+var Z_ToolInvocationOutputAvailableSchema = Z_BaseToolInvocationSchema.extend({
+  state: z.literal("output-available"),
+  input: z.unknown(),
+  output: z.unknown(),
+  callProviderMetadata: Z_ProviderMetadataSchema.optional(),
+  preliminary: z.boolean().optional(),
+  approval: z.object({
+    id: z.string(),
+    approved: z.literal(true),
+    reason: z.string().optional()
+  }).optional()
+});
+var Z_ToolInvocationOutputErrorSchema = Z_BaseToolInvocationSchema.extend({
+  state: z.literal("output-error"),
+  input: z.unknown(),
+  rawInput: z.unknown().optional(),
+  errorText: z.string(),
+  callProviderMetadata: Z_ProviderMetadataSchema.optional(),
+  approval: z.object({
+    id: z.string(),
+    approved: z.literal(true),
+    reason: z.string().optional()
+  }).optional()
+});
+var Z_ToolInvocationOutputDeniedSchema = Z_BaseToolInvocationSchema.extend({
+  state: z.literal("output-denied"),
+  input: z.unknown(),
+  callProviderMetadata: Z_ProviderMetadataSchema.optional(),
+  approval: z.object({
+    id: z.string(),
+    approved: z.literal(false),
+    reason: z.string().optional()
+  })
+});
+var Z_ToolInvocationSchema = z.discriminatedUnion("state", [
+  Z_ToolInvocationInputStreamingSchema,
+  Z_ToolInvocationInputAvailableSchema,
+  Z_ToolInvocationApprovalRequestedSchema,
+  Z_ToolInvocationApprovalRespondedSchema,
+  Z_ToolInvocationOutputAvailableSchema,
+  Z_ToolInvocationOutputErrorSchema,
+  Z_ToolInvocationOutputDeniedSchema
+]);
+var Z_ToolUIPartSchema = z.object({
+  type: z.custom((value) => {
+    return typeof value === "string" && value.startsWith("tool-");
+  })
+}).and(Z_ToolInvocationSchema);
+var Z_DynamicToolUIPartSchema = z.object({
+  type: z.literal("dynamic-tool"),
+  toolName: z.string(),
+  toolCallId: z.string(),
+  title: z.string().optional(),
+  providerExecuted: z.boolean().optional()
+}).and(
+  z.discriminatedUnion("state", [
+    z.object({
+      state: z.literal("input-streaming"),
+      input: z.unknown(),
+      callProviderMetadata: Z_ProviderMetadataSchema.optional()
+    }),
+    z.object({
+      state: z.literal("input-available"),
+      input: z.unknown(),
+      callProviderMetadata: Z_ProviderMetadataSchema.optional()
+    }),
+    z.object({
+      state: z.literal("approval-requested"),
+      input: z.unknown(),
+      callProviderMetadata: Z_ProviderMetadataSchema.optional(),
+      approval: z.object({
+        id: z.string()
+      })
+    }),
+    z.object({
+      state: z.literal("approval-responded"),
+      input: z.unknown(),
+      callProviderMetadata: Z_ProviderMetadataSchema.optional(),
+      approval: z.object({
+        id: z.string(),
+        approved: z.boolean(),
+        reason: z.string().optional()
+      })
+    }),
+    z.object({
+      state: z.literal("output-available"),
+      input: z.unknown(),
+      output: z.unknown(),
+      callProviderMetadata: Z_ProviderMetadataSchema.optional(),
+      preliminary: z.boolean().optional(),
+      approval: z.object({
+        id: z.string(),
+        approved: z.literal(true),
+        reason: z.string().optional()
+      }).optional()
+    }),
+    z.object({
+      state: z.literal("output-error"),
+      input: z.unknown(),
+      errorText: z.string(),
+      callProviderMetadata: Z_ProviderMetadataSchema.optional(),
+      approval: z.object({
+        id: z.string(),
+        approved: z.literal(true),
+        reason: z.string().optional()
+      }).optional()
+    }),
+    z.object({
+      state: z.literal("output-denied"),
+      input: z.unknown(),
+      callProviderMetadata: Z_ProviderMetadataSchema.optional(),
+      approval: z.object({
+        id: z.string(),
+        approved: z.literal(false),
+        reason: z.string().optional()
+      })
+    })
+  ])
+);
+var Z_MessagePart = z.union([
+  Z_TextUIPartSchema,
+  Z_ReasoningUIPartSchema,
+  Z_SourceUrlUIPartSchema,
+  Z_SourceDocumentUIPartSchema,
+  Z_FileUIPartSchema,
+  Z_StepStartUIPartSchema,
+  Z_DataUIPartSchema,
+  Z_ToolUIPartSchema,
+  Z_DynamicToolUIPartSchema
+]);
+
+// src/chat-websocket.ts
+var wsMessageMetadataSchema = z2.object({
+  parent_id: z2.string().uuid().nullable()
+});
+var wsMessageSchema = z2.object({
+  id: z2.string(),
+  role: z2.enum(["user", "assistant", "system"]),
+  parts: z2.array(Z_MessagePart),
+  metadata: wsMessageMetadataSchema.optional()
+});
+var wsVaultItemSchema = z2.object({
+  id: z2.string(),
+  name: z2.string(),
+  url: z2.string()
+});
+var wsClarifyOptionSchema = z2.object({
+  label: z2.string(),
+  description: z2.string()
+});
+var wsClarifyQuestionSchema = z2.object({
+  question: z2.string(),
+  header: z2.string(),
+  options: z2.array(wsClarifyOptionSchema),
+  multiSelect: z2.boolean()
+});
+var wsRunCommandSchema = z2.object({
+  type: z2.literal("run"),
+  data: z2.object({
+    id: z2.string(),
+    message: wsMessageSchema,
+    vaultItems: z2.array(wsVaultItemSchema),
+    timezone: z2.string()
+  })
+});
+var wsGetChatCommandSchema = z2.object({
+  type: z2.literal("get_chat"),
+  data: z2.object({
+    chat_id: z2.string()
+  })
+});
+var wsCancelCommandSchema = z2.object({
+  type: z2.literal("cancel"),
+  data: z2.object({
+    job_id: z2.string()
+  })
+});
+var wsClarifyResponseCommandSchema = z2.object({
+  type: z2.literal("clarify_response"),
+  data: z2.object({
+    job_id: z2.string(),
+    requestId: z2.string(),
+    answers: z2.record(z2.string(), z2.string())
+  })
+});
+var wsInjectMessageCommandSchema = z2.object({
+  type: z2.literal("inject_message"),
+  data: z2.object({
+    job_id: z2.string(),
+    text: z2.string().max(5e4),
+    message_id: z2.string().uuid()
+  })
+});
+var wsClientCommandSchema = z2.discriminatedUnion("type", [
+  wsRunCommandSchema,
+  wsGetChatCommandSchema,
+  wsCancelCommandSchema,
+  wsClarifyResponseCommandSchema,
+  wsInjectMessageCommandSchema
+]);
+var wsReadyMessageSchema = z2.object({
+  type: z2.literal("ready"),
+  data: z2.object({
+    success: z2.boolean()
+  })
+});
+var wsRunMessageSchema = z2.object({
+  type: z2.literal("run"),
+  data: z2.object({
+    job_id: z2.string(),
+    message_id: z2.string()
+  })
+});
+var wsStreamMessageSchema = z2.object({
+  type: z2.literal("stream"),
+  jobId: z2.string(),
+  chatId: z2.string(),
+  messageId: z2.string(),
+  delta: Z_MessagePart,
+  index: z2.number(),
+  consolidated: z2.boolean().optional().default(false),
+  partsLength: z2.number()
+});
+var wsStreamResumeMessageSchema = z2.object({
+  type: z2.literal("stream_resume"),
+  jobId: z2.string(),
+  chatId: z2.string(),
+  messageId: z2.string(),
+  parts: z2.array(Z_MessagePart)
+});
+var wsErrorMessageSchema = z2.object({
+  type: z2.literal("error"),
+  error: z2.string().optional(),
+  message: z2.string().optional(),
+  data: z2.any().optional()
+});
+var wsChatHistoryMessageSchema = z2.object({
+  type: z2.literal("chat_history"),
+  data: z2.object({
+    messages: z2.array(z2.any()),
+    activeMessageId: z2.string().optional()
+  })
+});
+var wsCancelMessageSchema = z2.object({
+  type: z2.literal("cancel"),
+  data: z2.object({
+    job_id: z2.string(),
+    success: z2.boolean(),
+    reason: z2.string().optional()
+  })
+});
+var wsDoneMessageSchema = z2.object({
+  type: z2.literal("done"),
+  data: z2.object({
+    job_id: z2.string()
+  })
+});
+var wsClarifyRequestMessageSchema = z2.object({
+  type: z2.literal("clarify_request"),
+  data: z2.object({
+    job_id: z2.string(),
+    requestId: z2.string(),
+    questions: z2.array(wsClarifyQuestionSchema)
+  })
+});
+var wsInjectAckMessageSchema = z2.object({
+  type: z2.literal("inject_ack"),
+  data: z2.object({
+    job_id: z2.string(),
+    inject_message_id: z2.string(),
+    new_assistant_id: z2.string()
+  })
+});
+var wsInjectSplitMessageSchema = z2.object({
+  type: z2.literal("inject_split"),
+  data: z2.object({
+    job_id: z2.string(),
+    new_message_id: z2.string()
+  })
+});
+var wsServerMessageSchema = z2.discriminatedUnion("type", [
+  wsReadyMessageSchema,
+  wsRunMessageSchema,
+  wsStreamMessageSchema,
+  wsStreamResumeMessageSchema,
+  wsErrorMessageSchema,
+  wsChatHistoryMessageSchema,
+  wsCancelMessageSchema,
+  wsDoneMessageSchema,
+  wsClarifyRequestMessageSchema,
+  wsInjectAckMessageSchema,
+  wsInjectSplitMessageSchema
+]);
+export {
+  Z_BaseToolInvocationSchema,
+  Z_DataClarifyResponseSchema,
+  Z_DataEndSplitSchema,
+  Z_DataFileHighlightSchema,
+  Z_DataScreenshotSchema,
+  Z_DataSplitSchema,
+  Z_DataStatusSchema,
+  Z_DataSubagentPartSchema,
+  Z_DataUIPartSchema,
+  Z_DataViewSwitchSchema,
+  Z_DynamicToolUIPartSchema,
+  Z_FileUIPartSchema,
+  Z_MessagePart,
+  Z_ProviderMetadataSchema,
+  Z_ReasoningUIPartSchema,
+  Z_SourceDocumentUIPartSchema,
+  Z_SourceUrlUIPartSchema,
+  Z_StepStartUIPartSchema,
+  Z_TextUIPartSchema,
+  Z_ToolInvocationApprovalRequestedSchema,
+  Z_ToolInvocationApprovalRespondedSchema,
+  Z_ToolInvocationInputAvailableSchema,
+  Z_ToolInvocationInputStreamingSchema,
+  Z_ToolInvocationOutputAvailableSchema,
+  Z_ToolInvocationOutputDeniedSchema,
+  Z_ToolInvocationOutputErrorSchema,
+  Z_ToolInvocationSchema,
+  Z_ToolUIPartSchema,
+  wsCancelCommandSchema,
+  wsCancelMessageSchema,
+  wsChatHistoryMessageSchema,
+  wsClarifyOptionSchema,
+  wsClarifyQuestionSchema,
+  wsClarifyRequestMessageSchema,
+  wsClarifyResponseCommandSchema,
+  wsClientCommandSchema,
+  wsDoneMessageSchema,
+  wsErrorMessageSchema,
+  wsGetChatCommandSchema,
+  wsInjectAckMessageSchema,
+  wsInjectMessageCommandSchema,
+  wsInjectSplitMessageSchema,
+  wsMessageMetadataSchema,
+  wsMessageSchema,
+  wsReadyMessageSchema,
+  wsRunCommandSchema,
+  wsRunMessageSchema,
+  wsServerMessageSchema,
+  wsStreamMessageSchema,
+  wsStreamResumeMessageSchema,
+  wsVaultItemSchema
+};

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@futurity/chat-protocol",
+  "version": "0.0.1",
+  "type": "module",
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": ["dist", "src", "README.md"],
+  "scripts": {
+    "build": "tsup",
+    "check": "tsgo --noEmit",
+    "prepublishOnly": "tsup"
+  },
+  "peerDependencies": {
+    "zod": "^4.0.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.0",
+    "zod": "^4.1.13"
+  }
+}