@belonguniverseai/react-sdk 0.6.15 → 0.6.17

package/dist/i18n/messages/surfaces/stream.d.ts

@@ -29,9 +29,26 @@ export declare const streamEn: {
         readonly submitError: "That didn't go through — {{message}}. Try again.";
         readonly errorServerAnswered: "the server answered {{status}}";
         readonly errorRequestUnreachable: "the request didn't reach the server";
-        readonly answered: "answered";
         readonly alreadyAnswered: "already answered";
+        readonly questionPending: "Waiting for your answer";
+        readonly questionSkipped: "skipped";
+        readonly questionClosed: "closed without answering";
+        readonly questionDetached: "still open — answer it or reply in the chat";
+        readonly questionCancelled: "cancelled";
+        readonly youReplied: "You replied: {{reply}}";
         readonly submit: "Submit";
+        readonly questionOf: "{{n}} of {{total}}";
+        readonly previousQuestion: "Previous question";
+        readonly nextQuestion: "Next question";
+        readonly close: "Close";
+        readonly somethingElse: "Something else";
+        readonly typeYourAnswer: "Type your answer…";
+        readonly skip: "Skip";
+        readonly selectedCount_one: "{{count}} selected";
+        readonly selectedCount_other: "{{count}} selected";
+        readonly answer: "Answer";
+        readonly next: "Next";
+        readonly questionDetachedHint: "Belong moved on — your answer will be sent as a new message";
         readonly toolShellRunning: "Running a command";
         readonly toolShellDone: "Ran a command";
         readonly toolShellFailed: "A command didn't complete";
@@ -71,6 +88,8 @@ export declare const streamEn: {
         readonly actionMadePlan: "Put a plan together";
         readonly actionCheckedRules: "Checked the rules";
         readonly actionScheduledTask: "Set up a scheduled task";
+        /** Plan 013 — `ask_user_question` / `AskUserQuestion`. */
+        readonly actionAskedQuestion: "Asked a question";
         /** A tool this build has no copy for — a neutral line, never its name. */
         readonly actionGeneric: "Worked on it";
         readonly executingTasks: "Working on it…";
@@ -120,9 +139,26 @@ export declare const streamEs: {
         submitError: string;
         errorServerAnswered: string;
         errorRequestUnreachable: string;
-        answered: string;
         alreadyAnswered: string;
+        questionPending: string;
+        questionSkipped: string;
+        questionClosed: string;
+        questionDetached: string;
+        questionCancelled: string;
+        youReplied: string;
         submit: string;
+        questionOf: string;
+        previousQuestion: string;
+        nextQuestion: string;
+        close: string;
+        somethingElse: string;
+        typeYourAnswer: string;
+        skip: string;
+        selectedCount_one: string;
+        selectedCount_other: string;
+        answer: string;
+        next: string;
+        questionDetachedHint: string;
         toolShellRunning: string;
         toolShellDone: string;
         toolShellFailed: string;
@@ -162,6 +198,7 @@ export declare const streamEs: {
         actionMadePlan: string;
         actionCheckedRules: string;
         actionScheduledTask: string;
+        actionAskedQuestion: string;
         actionGeneric: string;
         executingTasks: string;
         workedSteps_one: string;
@@ -209,9 +246,26 @@ export declare const streamPt: {
         submitError: string;
         errorServerAnswered: string;
         errorRequestUnreachable: string;
-        answered: string;
         alreadyAnswered: string;
+        questionPending: string;
+        questionSkipped: string;
+        questionClosed: string;
+        questionDetached: string;
+        questionCancelled: string;
+        youReplied: string;
         submit: string;
+        questionOf: string;
+        previousQuestion: string;
+        nextQuestion: string;
+        close: string;
+        somethingElse: string;
+        typeYourAnswer: string;
+        skip: string;
+        selectedCount_one: string;
+        selectedCount_other: string;
+        answer: string;
+        next: string;
+        questionDetachedHint: string;
         toolShellRunning: string;
         toolShellDone: string;
         toolShellFailed: string;
@@ -251,6 +305,7 @@ export declare const streamPt: {
         actionMadePlan: string;
         actionCheckedRules: string;
         actionScheduledTask: string;
+        actionAskedQuestion: string;
         actionGeneric: string;
         executingTasks: string;
         workedSteps_one: string;

package/dist/stream/belong-chat-transport.d.ts

@@ -9,6 +9,23 @@ declare const cancelRunResponseSchema: z.ZodObject<{
     }, z.core.$strip>>>;
 }, z.core.$strip>;
 export type RecalledQueuedMessage = z.infer<typeof cancelRunResponseSchema>["recalledMessages"][number];
+export declare const choiceAnswerSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"options">;
+    optionIds: z.ZodArray<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"text">;
+    text: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"skipped">;
+}, z.core.$strip>], "kind">;
+export declare const choiceStateSchema: z.ZodEnum<{
+    pending: "pending";
+    detached: "detached";
+    answered: "answered";
+    dismissed: "dismissed";
+    cancelled: "cancelled";
+}>;
 /**
  * The wire/stored part union. Exported so the history loader (chat.tsx) can
  * validate persisted assistant parts against the SAME shapes the live stream
@@ -58,6 +75,22 @@ export declare const wireStreamPartSchema: z.ZodDiscriminatedUnion<[z.ZodObject<
             expired: "expired";
         }>;
         toolName: z.ZodOptional<z.ZodString>;
+        preview: z.ZodOptional<z.ZodObject<{
+            heading: z.ZodString;
+            fields: z.ZodArray<z.ZodObject<{
+                label: z.ZodString;
+                value: z.ZodString;
+                emphasis: z.ZodOptional<z.ZodEnum<{
+                    normal: "normal";
+                    warning: "warning";
+                }>>;
+            }, z.core.$strip>>;
+            body: z.ZodNullable<z.ZodObject<{
+                label: z.ZodString;
+                content: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        persistentConsentAllowed: z.ZodOptional<z.ZodBoolean>;
         subagentId: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
 }, z.core.$strip>, z.ZodObject<{
@@ -188,47 +221,38 @@ export declare const wireStreamPartSchema: z.ZodDiscriminatedUnion<[z.ZodObject<
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"data-choice-request">;
     id: z.ZodString;
-    data: z.ZodDiscriminatedUnion<[z.ZodObject<{
-        mode: z.ZodLiteral<"single">;
-        uiActionRequestId: z.ZodString;
-        question: z.ZodString;
-        options: z.ZodArray<z.ZodObject<{
-            id: z.ZodString;
-            label: z.ZodString;
-            description: z.ZodOptional<z.ZodString>;
-        }, z.core.$strip>>;
+    data: z.ZodObject<{
+        questionRequestId: z.ZodString;
         state: z.ZodEnum<{
             pending: "pending";
-            expired: "expired";
-            resolved: "resolved";
+            detached: "detached";
+            answered: "answered";
+            dismissed: "dismissed";
+            cancelled: "cancelled";
         }>;
-    }, z.core.$strip>, z.ZodObject<{
-        mode: z.ZodLiteral<"multi">;
-        uiActionRequestId: z.ZodString;
-        question: z.ZodString;
-        options: z.ZodArray<z.ZodObject<{
+        questions: z.ZodArray<z.ZodObject<{
             id: z.ZodString;
-            label: z.ZodString;
-            description: z.ZodOptional<z.ZodString>;
+            question: z.ZodString;
+            header: z.ZodString;
+            multiSelect: z.ZodBoolean;
+            options: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                label: z.ZodString;
+                description: z.ZodString;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
-        state: z.ZodEnum<{
-            pending: "pending";
-            expired: "expired";
-            resolved: "resolved";
-        }>;
-        minChoicesCount: z.ZodOptional<z.ZodNumber>;
-        maxChoicesCount: z.ZodOptional<z.ZodNumber>;
-    }, z.core.$strip>, z.ZodObject<{
-        mode: z.ZodLiteral<"open">;
-        uiActionRequestId: z.ZodString;
-        question: z.ZodString;
-        state: z.ZodEnum<{
-            pending: "pending";
-            expired: "expired";
-            resolved: "resolved";
-        }>;
-        placeholder: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>], "mode">;
+        answers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"options">;
+            optionIds: z.ZodArray<z.ZodString>;
+            text: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"text">;
+            text: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"skipped">;
+        }, z.core.$strip>], "kind">>>;
+        reply: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
 }, z.core.$strip>], "type">;
 /** A request was 401'd twice (once with a freshly re-read token): the host
  * session is expired — the dock must surface re-auth, not retry forever. */

package/dist/stream/belong-data-parts.d.ts

@@ -15,7 +15,7 @@ export type PlanStep = {
 };
 export type ApprovalState = "pending" | "approved" | "rejected" | "amend_requested" | "expired";
 export type ToolCallState = "started" | "completed" | "failed";
-export type ChoiceState = "pending" | "resolved" | "expired";
+export type ChoiceState = "pending" | "answered" | "dismissed" | "detached" | "cancelled";
 export type SandboxCommandState = "started" | "output" | "completed" | "failed";
 export type SandboxStream = "stdout" | "stderr";
 export type UiActionState = "requested" | "completed" | "failed";
@@ -28,6 +28,18 @@ export type PlanData = {
     readonly summary: string;
     readonly steps: readonly PlanStep[];
 };
+export type ApprovalPreview = {
+    readonly heading: string;
+    readonly fields: readonly {
+        readonly label: string;
+        readonly value: string;
+        readonly emphasis?: "normal" | "warning" | undefined;
+    }[];
+    readonly body: {
+        readonly label: string;
+        readonly content: string;
+    } | null;
+};
 export type ApprovalRequestData = {
     readonly approvalId: string;
     readonly reason: string;
@@ -40,6 +52,9 @@ export type ApprovalRequestData = {
      * messages; render the generic label when undefined.
      */
     readonly toolName?: string | undefined;
+    readonly preview?: ApprovalPreview | undefined;
+    /** False for exact-action approvals that must never become standing consent. */
+    readonly persistentConsentAllowed?: boolean | undefined;
     /**
      * BEL-199 attribution — the `data-subagent` part id whose gated call raised this
      * card. The resolution event (`approval_state_changed`) carries no subagentId, so
@@ -48,44 +63,51 @@ export type ApprovalRequestData = {
     readonly subagentId?: string | undefined;
 };
 /**
- * BEL-93 — a friendly question widget the agent emits instead of dumping a wall
- * of questions as prose. Discriminated on `mode`:
- *   - "single": choose exactly one option (radio group)
- *   - "multi":  choose several options (checkbox list), bounded by
- *               min/maxChoicesCount when present
- *   - "open":   free-text answer (textarea)
- * The user answers in-dock; the SDK posts the answer back through the same
- * `ui-actions/:uiActionRequestId/result` endpoint the UI-action renderer uses,
- * so no new backend route is needed. `state` mirrors the approval lifecycle
- * (see ChoiceState) so a resolved/expired question survives a reload.
+ * Plan 013 (supersedes BEL-93's single-question shape) — the agent's
+ * `AskUserQuestion` call as ONE part: 1–4 questions, each single- or
+ * multi-select with 2–4 options (label + description). The dock adds its own
+ * "Something else" free-text row and a per-question Skip. Answers post to
+ * `POST /v1/questions/:questionRequestId/answer` by option id; `answers` /
+ * `reply` are filled in by the backend on resolution (live) or by the history
+ * patch (reload) so the transcript record renders identically either way.
  */
 export type ChoiceOption = {
     readonly id: string;
     readonly label: string;
-    readonly description?: string | undefined;
+    readonly description: string;
 };
-export type ChoiceRequestData = {
-    readonly mode: "single";
-    readonly uiActionRequestId: string;
+export type ChoiceQuestion = {
+    readonly id: string;
     readonly question: string;
+    /** Chip label, ≤ 12 chars. */
+    readonly header: string;
+    readonly multiSelect: boolean;
     readonly options: readonly ChoiceOption[];
-    readonly state: ChoiceState;
+};
+/**
+ * One question's answer. On a MULTI-select question `text` alongside
+ * `optionIds` is the "Something else" free text combined with the ticks — the
+ * agent gets both. A single-select answer is exactly one option OR `text`
+ * (the server rejects options + text there).
+ */
+export type ChoiceAnswer = {
+    readonly kind: "options";
+    readonly optionIds: readonly string[];
+    readonly text?: string | undefined;
 } | {
-    readonly mode: "multi";
-    readonly uiActionRequestId: string;
-    readonly question: string;
-    readonly options: readonly ChoiceOption[];
-    readonly state: ChoiceState;
-    /** Inclusive lower bound on selected options. Absent ⇒ at least one (1). */
-    readonly minChoicesCount?: number | undefined;
-    /** Inclusive upper bound on selected options. Absent ⇒ no maximum. */
-    readonly maxChoicesCount?: number | undefined;
+    readonly kind: "text";
+    readonly text: string;
 } | {
-    readonly mode: "open";
-    readonly uiActionRequestId: string;
-    readonly question: string;
+    readonly kind: "skipped";
+};
+export type ChoiceRequestData = {
+    readonly questionRequestId: string;
     readonly state: ChoiceState;
-    readonly placeholder?: string | undefined;
+    readonly questions: readonly ChoiceQuestion[];
+    /** Keyed by question id. Present once answered. */
+    readonly answers?: Readonly<Record<string, ChoiceAnswer>> | undefined;
+    /** The composer text when the user replied in chat instead of choosing. */
+    readonly reply?: string | undefined;
 };
 /**
  * Optional fields declared with explicit `| undefined` so Zod's

package/dist/stream/pending-question-store.d.ts

@@ -0,0 +1,22 @@
+import { BelongUIMessage, ChoiceRequestData } from './belong-data-parts.ts';
+/** Snapshot — identity is stable until the set changes (useSyncExternalStore). */
+export declare const peekHiddenQuestions: () => ReadonlySet<string>;
+export declare const subscribeHiddenQuestions: (listener: () => void) => (() => void);
+export declare const isQuestionHidden: (questionRequestId: string) => boolean;
+export declare const hideQuestion: (questionRequestId: string) => void;
+export declare const unhideQuestion: (questionRequestId: string) => void;
+export declare const __resetPendingQuestionStoreForTest: () => void;
+/**
+ * The question the bottom card should show: the NEWEST answerable
+ * `data-choice-request` part across the conversation that is not hidden, or
+ * null. Same-id parts replace each other in `useChat` (a resolution arrives
+ * as the same part id with a terminal state), so a question that was answered
+ * — from this tab, another tab, or a reload's history patch — un-arms the card
+ * from the wire without any local bookkeeping.
+ *
+ * The LAST occurrence of each question id wins before "newest" is decided: a
+ * restored history part and a resumed stream's re-emit of the same question
+ * (§40 re-attach) can sit in different messages, and only the later one
+ * carries the current state.
+ */
+export declare const selectActiveQuestion: (messages: readonly BelongUIMessage[], hiddenIds: ReadonlySet<string>) => ChoiceRequestData | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@belonguniverseai/react-sdk",
-  "version": "0.6.15",
+  "version": "0.6.17",
   "description": "Belong — embeddable React AI assistant dock. Mount <BelongWidget> in your app tree with getToken dependency-injection auth.",
   "license": "UNLICENSED",
   "type": "module",