js-bao-wss-client 3.4.0 → 3.4.1

package/dist/agents/uiMessageTypes.d.ts

@@ -0,0 +1,360 @@
+/** A JSON value, as AI SDK providers exchange it. */
+export type JSONValue = null | string | number | boolean | Readonly<JSONObject> | readonly JSONValue[];
+/** A JSON object, as AI SDK providers exchange it. */
+export type JSONObject = {
+    [key: string]: JSONValue | undefined;
+};
+/** Provider-specific metadata, keyed by provider name. */
+export type ProviderMetadata = Record<string, JSONObject>;
+/** Provider file identifiers for a file uploaded to a provider, keyed by provider name. */
+export type ProviderReference = Record<string, string> & {
+    type?: never;
+};
+/** A type with every key, nested keys included, made optional. */
+export type DeepPartial<T> = T extends null | undefined | string | number | boolean | symbol | bigint | void | Date | RegExp | ((...arguments_: any[]) => unknown) | (new (...arguments_: any[]) => unknown) ? T : T extends Map<infer KeyType, infer ValueType> ? PartialMap<KeyType, ValueType> : T extends Set<infer ItemType> ? PartialSet<ItemType> : T extends ReadonlyMap<infer KeyType, infer ValueType> ? PartialReadonlyMap<KeyType, ValueType> : T extends ReadonlySet<infer ItemType> ? PartialReadonlySet<ItemType> : T extends object ? T extends ReadonlyArray<infer ItemType> ? ItemType[] extends T ? readonly ItemType[] extends T ? ReadonlyArray<DeepPartial<ItemType | undefined>> : Array<DeepPartial<ItemType | undefined>> : PartialObject<T> : PartialObject<T> : unknown;
+/** A `Map` whose keys and values are `DeepPartial`. */
+export type PartialMap<KeyType, ValueType> = {} & Map<DeepPartial<KeyType>, DeepPartial<ValueType>>;
+/** A `Set` whose members are `DeepPartial`. */
+export type PartialSet<T> = {} & Set<DeepPartial<T>>;
+/** A `ReadonlyMap` whose keys and values are `DeepPartial`. */
+export type PartialReadonlyMap<KeyType, ValueType> = {} & ReadonlyMap<DeepPartial<KeyType>, DeepPartial<ValueType>>;
+/** A `ReadonlySet` whose members are `DeepPartial`. */
+export type PartialReadonlySet<T> = {} & ReadonlySet<DeepPartial<T>>;
+/** An object whose keys are optional and whose values are `DeepPartial`. */
+export type PartialObject<ObjectType extends object> = {
+    [KeyType in keyof ObjectType]?: DeepPartial<ObjectType[KeyType]>;
+};
+/** The union of an object type's property types. */
+export type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
+/** The data types a message's data parts can carry, keyed by data part name. */
+export type UIDataTypes = Record<string, unknown>;
+/** The input and output types of one tool, as a UI message sees them. */
+export type UITool = {
+    input: unknown;
+    output: unknown | undefined;
+};
+/** The tools a message's tool parts can name, keyed by tool name. */
+export type UITools = Record<string, UITool>;
+/** An AI SDK UI message: the unit AI SDK UI components render. */
+export interface UIMessage<METADATA = unknown, DATA_PARTS extends UIDataTypes = UIDataTypes, TOOLS extends UITools = UITools> {
+    /** A unique identifier for the message. */
+    id: string;
+    /** The role of the message. */
+    role: "system" | "user" | "assistant";
+    /** The metadata of the message. */
+    metadata?: METADATA;
+    /** The parts of the message, in the order they are rendered. */
+    parts: Array<UIMessagePart<DATA_PARTS, TOOLS>>;
+}
+/** One part of a UI message. */
+export type UIMessagePart<DATA_TYPES extends UIDataTypes, TOOLS extends UITools> = TextUIPart | CustomContentUIPart | ReasoningUIPart | ToolUIPart<TOOLS> | DynamicToolUIPart | SourceUrlUIPart | SourceDocumentUIPart | FileUIPart | ReasoningFileUIPart | DataUIPart<DATA_TYPES> | StepStartUIPart;
+/** A text part of a message. */
+export type TextUIPart = {
+    type: "text";
+    /** The text content. */
+    text: string;
+    /** The state of the text part. */
+    state?: "streaming" | "done";
+    /** The provider metadata. */
+    providerMetadata?: ProviderMetadata;
+};
+/** A provider-specific part of a message. */
+export type CustomContentUIPart = {
+    type: "custom";
+    /** The kind of custom content, in the format `{provider}.{provider-type}`. */
+    kind: `${string}.${string}`;
+    /** The provider metadata. */
+    providerMetadata?: ProviderMetadata;
+};
+/** A reasoning part of a message. */
+export type ReasoningUIPart = {
+    type: "reasoning";
+    /** The reasoning part ID. */
+    id?: string;
+    /** The reasoning text. */
+    text: string;
+    /** The state of the reasoning part. */
+    state?: "streaming" | "done";
+    /** The provider metadata. */
+    providerMetadata?: ProviderMetadata;
+};
+/** A source part of a message. */
+export type SourceUrlUIPart = {
+    type: "source-url";
+    sourceId: string;
+    url: string;
+    title?: string;
+    providerMetadata?: ProviderMetadata;
+};
+/** A document source part of a message. */
+export type SourceDocumentUIPart = {
+    type: "source-document";
+    sourceId: string;
+    mediaType: string;
+    title: string;
+    filename?: string;
+    providerMetadata?: ProviderMetadata;
+};
+/** A file part of a message. */
+export type FileUIPart = {
+    type: "file";
+    /** An IANA media type (`image/png`) or its top-level segment (`image`). */
+    mediaType: string;
+    /** Optional filename of the file. */
+    filename?: string;
+    /** The URL of the file: a hosted file or a data URL. */
+    url: string;
+    /** Provider file identifiers, keyed by provider name. */
+    providerReference?: ProviderReference;
+    /** The provider metadata. */
+    providerMetadata?: ProviderMetadata;
+};
+/** A reasoning file part of a message. */
+export type ReasoningFileUIPart = {
+    type: "reasoning-file";
+    /** IANA media type of the file. */
+    mediaType: string;
+    /** The URL of the file: a hosted file or a data URL. */
+    url: string;
+    /** The provider metadata. */
+    providerMetadata?: ProviderMetadata;
+};
+/** A step boundary part of a message. */
+export type StepStartUIPart = {
+    type: "step-start";
+};
+/** A data part of a message: `data-<name>` carrying that name's data type. */
+export type DataUIPart<DATA_TYPES extends UIDataTypes> = ValueOf<{
+    [NAME in keyof DATA_TYPES & string]: {
+        type: `data-${NAME}`;
+        id?: string;
+        data: DATA_TYPES[NAME];
+    };
+}>;
+/**
+ * Everything needed to render one tool call, by state. Each state admits its
+ * own fields: `output` only under `output-available`, `errorText` only under
+ * `output-error`, `approval` from `approval-requested` on.
+ */
+export type UIToolInvocation<TOOL extends UITool> = {
+    /** ID of the tool call. */
+    toolCallId: string;
+    title?: string;
+    toolMetadata?: JSONObject;
+    /** Whether the tool call was executed by the provider. */
+    providerExecuted?: boolean;
+} & ({
+    state: "input-streaming";
+    input?: DeepPartial<TOOL["input"]> | undefined;
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval?: never;
+} | {
+    state: "input-available";
+    input: TOOL["input"];
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval?: never;
+} | {
+    state: "approval-requested";
+    input: TOOL["input"];
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval: {
+        id: string;
+        approved?: never;
+        descriptor?: unknown;
+        requestReason?: string;
+        reason?: never;
+        isAutomatic?: boolean;
+        signature?: string;
+        inputSchemaInput?: unknown;
+    };
+} | {
+    state: "approval-responded";
+    input: TOOL["input"];
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval: {
+        id: string;
+        approved: boolean;
+        descriptor?: unknown;
+        requestReason?: string;
+        reason?: string;
+        isAutomatic?: boolean;
+        signature?: string;
+        inputSchemaInput?: unknown;
+    };
+} | {
+    state: "output-available";
+    input: TOOL["input"];
+    output: TOOL["output"];
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    resultProviderMetadata?: ProviderMetadata;
+    preliminary?: boolean;
+    approval?: {
+        id: string;
+        approved: true;
+        descriptor?: unknown;
+        requestReason?: string;
+        reason?: string;
+        isAutomatic?: boolean;
+        signature?: string;
+        inputSchemaInput?: unknown;
+    };
+} | {
+    state: "output-error";
+    input: TOOL["input"] | undefined;
+    /** @deprecated Use `input` instead. */
+    rawInput?: unknown;
+    output?: never;
+    errorText: string;
+    callProviderMetadata?: ProviderMetadata;
+    resultProviderMetadata?: ProviderMetadata;
+    approval?: {
+        id: string;
+        approved: true;
+        descriptor?: unknown;
+        requestReason?: string;
+        reason?: string;
+        isAutomatic?: boolean;
+        signature?: string;
+        inputSchemaInput?: unknown;
+    };
+} | {
+    state: "output-denied";
+    input: TOOL["input"];
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval: {
+        id: string;
+        approved: false;
+        descriptor?: unknown;
+        requestReason?: string;
+        reason?: string;
+        isAutomatic?: boolean;
+        signature?: string;
+        inputSchemaInput?: unknown;
+    };
+});
+/** A tool call part of a message: `tool-<name>` for a tool of `TOOLS`. */
+export type ToolUIPart<TOOLS extends UITools = UITools> = ValueOf<{
+    [NAME in keyof TOOLS & string]: {
+        type: `tool-${NAME}`;
+    } & UIToolInvocation<TOOLS[NAME]>;
+}>;
+/** A tool call part for a tool the message's `TOOLS` do not declare. */
+export type DynamicToolUIPart = {
+    type: "dynamic-tool";
+    /** Name of the tool that is being called. */
+    toolName: string;
+    /** ID of the tool call. */
+    toolCallId: string;
+    title?: string;
+    toolMetadata?: JSONObject;
+    /** Whether the tool call was executed by the provider. */
+    providerExecuted?: boolean;
+} & ({
+    state: "input-streaming";
+    input?: unknown;
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval?: never;
+} | {
+    state: "input-available";
+    input: unknown;
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval?: never;
+} | {
+    state: "approval-requested";
+    input: unknown;
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval: {
+        id: string;
+        approved?: never;
+        descriptor?: unknown;
+        requestReason?: string;
+        reason?: never;
+        isAutomatic?: boolean;
+        signature?: string;
+        inputSchemaInput?: unknown;
+    };
+} | {
+    state: "approval-responded";
+    input: unknown;
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval: {
+        id: string;
+        approved: boolean;
+        descriptor?: unknown;
+        requestReason?: string;
+        reason?: string;
+        isAutomatic?: boolean;
+        signature?: string;
+        inputSchemaInput?: unknown;
+    };
+} | {
+    state: "output-available";
+    input: unknown;
+    output: unknown;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    resultProviderMetadata?: ProviderMetadata;
+    preliminary?: boolean;
+    approval?: {
+        id: string;
+        approved: true;
+        descriptor?: unknown;
+        requestReason?: string;
+        reason?: string;
+        isAutomatic?: boolean;
+        signature?: string;
+        inputSchemaInput?: unknown;
+    };
+} | {
+    state: "output-error";
+    input: unknown;
+    output?: never;
+    errorText: string;
+    callProviderMetadata?: ProviderMetadata;
+    resultProviderMetadata?: ProviderMetadata;
+    approval?: {
+        id: string;
+        approved: true;
+        descriptor?: unknown;
+        requestReason?: string;
+        reason?: string;
+        isAutomatic?: boolean;
+        signature?: string;
+        inputSchemaInput?: unknown;
+    };
+} | {
+    state: "output-denied";
+    input: unknown;
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval: {
+        id: string;
+        approved: false;
+        descriptor?: unknown;
+        requestReason?: string;
+        reason?: string;
+        isAutomatic?: boolean;
+        signature?: string;
+        inputSchemaInput?: unknown;
+    };
+});

package/dist/agents/uiMessageTypes.js

@@ -0,0 +1,15 @@
+// The AI SDK `UIMessage` family as structural types.
+//
+// Transcribed from the published `ai` package, version 7.0.119
+// (`ai/dist/index.d.ts`; `ProviderMetadata`, `ProviderReference` and the JSON
+// value types from `@ai-sdk/provider` 4.0.19, which that version depends on),
+// so the client ships AI SDK shapes with no dependency on `ai`. The names are
+// the ones `ai` uses. `ToolUIPart` is the per-state union it is in `ai`: each
+// state admits its own fields. Only `FlexibleSchema` is left out of
+// `DeepPartial`, because the `TOOLS` here are UI tools, never schemas.
+//
+// `tests/unit/workflows/agent-ui-message-types-3804.test.ts` compiles these
+// against the published declarations in both directions.
+//
+// Types only: no imports, no emitted code.
+export {};

package/dist/agents/uiMessages.d.ts

@@ -0,0 +1,105 @@
+import { type PrimitiveFilePartRecord, type PrimitiveMessageRecord, type PrimitiveMessageRow, type PrimitivePartRecord, type PrimitivePartRow, type PrimitiveStepRecord } from "./sessionModels.generated";
+import type { UIMessage, UITools } from "./uiMessageTypes";
+/** The decoded rows of one session document (from the `decodePrimitive*` functions). */
+export interface PrimitiveSessionContent {
+    messages: readonly PrimitiveMessageRecord[];
+    parts: readonly PrimitivePartRecord[];
+    steps?: readonly PrimitiveStepRecord[];
+}
+/** Options for `toUIMessages`. */
+export interface ToUIMessagesOptions {
+    /**
+     * The `url` of a file part. Default: `primitive-blob:<blobId>`, which an app
+     * resolves itself (for example with the document's `blobs.proxyUrl`), or
+     * `""` for a file part with no blob.
+     */
+    fileUrl?: (part: PrimitiveFilePartRecord) => string;
+}
+/** The platform-only fields of one part, in `metadata.parts` at the part's index. */
+export interface PrimitiveUIPartMetadata {
+    id: string;
+    seq: number;
+    createdAt: string;
+    modifiedAt?: string;
+    /** Tool call parts. */
+    statusText?: string;
+    errorCode?: string;
+    approvalUserId?: string;
+    approvalRespondedAt?: string;
+    resolvedByUserId?: string;
+    artifact?: unknown;
+    artifactBlobId?: string;
+    /** File parts. */
+    blobId?: string;
+    sizeBytes?: number;
+    /** The part row as read, present only when the mapping alone would not reproduce it. */
+    source?: PrimitivePartRow;
+}
+/** The platform-only fields of one message, in its `metadata`. */
+export interface PrimitiveUIMessageMetadata {
+    seq: number;
+    turnId?: string;
+    authorUserId?: string;
+    clientMessageId?: string;
+    createdAt: string;
+    /** One entry per element of `parts`, in the same order. */
+    parts: PrimitiveUIPartMetadata[];
+    /** The step rows of this message's turn, by step `seq`; present only when there are any. */
+    steps?: PrimitiveStepRecord[];
+    /** The message row as read, present only when the mapping alone would not reproduce it. */
+    source?: PrimitiveMessageRow;
+}
+/** The data of a `data-primitive-event` part: an event part's columns. */
+export interface PrimitiveUIEventData {
+    eventKind?: string;
+    eventId?: string;
+    refersTo?: string;
+    data?: unknown;
+}
+/** The data part types a session's `UIMessage`s carry. */
+export type PrimitiveUIDataTypes = {
+    "primitive-event": PrimitiveUIEventData;
+};
+/** A session message as an AI SDK `UIMessage`, typed by the app's tools. */
+export type PrimitiveUIMessage<TOOLS extends UITools = UITools> = UIMessage<PrimitiveUIMessageMetadata, PrimitiveUIDataTypes, TOOLS>;
+/**
+ * The error `toUIMessages` and `fromUIMessages` throw for input they cannot
+ * map. `AGENT_UI_MESSAGE_ORPHAN` is a part or step with no message to ride
+ * on; `AGENT_UI_MESSAGE_UNMAPPABLE` is everything else.
+ */
+export interface AgentUIMessageError extends Error {
+    code: "AGENT_UI_MESSAGE_UNMAPPABLE" | "AGENT_UI_MESSAGE_ORPHAN";
+    messageId?: string;
+    partId?: string;
+    stepId?: string;
+    /** What could not be mapped, e.g. `part kind "sticker"` or `tool state "queued"`. */
+    reason: string;
+}
+/**
+ * The session's messages as AI SDK `UIMessage`s, one per `PrimitiveMessage`
+ * by `seq` (then id), each with its parts by `seq` (then id). Platform-only
+ * fields ride in `metadata`; a turn's steps ride on the turn's last message,
+ * or on the session's last message when the turn has none. A row the mapping
+ * alone would not reproduce carries itself as `source`, so `fromUIMessages`
+ * returns it exactly. Throws an `AgentUIMessageError` for a row it cannot map:
+ * an unknown author, part kind, tool state or text state, a tool part missing
+ * a column its state requires, a part with no message, or a step when there is
+ * no message at all.
+ */
+export declare function toUIMessages<TOOLS extends UITools = UITools>(content: PrimitiveSessionContent, options?: ToUIMessagesOptions): PrimitiveUIMessage<TOOLS>[];
+/**
+ * The records `UIMessage`s from `toUIMessages` map back to, in the order they
+ * appear; `encodePrimitiveMessage`, `encodePrimitivePart` and
+ * `encodePrimitiveStep` turn them into the rows that went in. A message or
+ * part carrying `source` is rebuilt from it, with only the fields the app
+ * changed overwritten, and its record carries `row`; the rest carry none. A
+ * file part's `url` is never read (its blob is `metadata.parts[i].blobId`).
+ * Throws an `AgentUIMessageError` for a message without the adapter's
+ * metadata, a `parts`/`metadata.parts` length mismatch, a part type the
+ * adapter never produces, or a tool part whose fields do not fit its state.
+ */
+export declare function fromUIMessages(messages: readonly PrimitiveUIMessage<any>[]): {
+    messages: PrimitiveMessageRecord[];
+    parts: PrimitivePartRecord[];
+    steps: PrimitiveStepRecord[];
+};