@xinghunm/ai-chat 1.0.1 → 1.1.0

package/dist/index.d.mts

@@ -72,6 +72,7 @@ interface PlanSingleSelectQuestion extends PlanQuestionBase {
  */
 interface PlanMultiSelectQuestion extends PlanQuestionBase {
     kind: 'multi_select';
+    allowOther?: boolean;
     options: PlanQuestionOption[];
 }
 /**
@@ -102,25 +103,57 @@ interface PlanBooleanQuestion extends PlanQuestionBase {
  */
 type PlanQuestion = PlanSingleSelectQuestion | PlanMultiSelectQuestion | PlanTextQuestion | PlanNumberQuestion | PlanBooleanQuestion;
 type PlanQuestionnaireStatus = 'expired' | 'failed';
+/**
+ * Merge behavior applied when a keyed structured block is patched repeatedly.
+ */
+type ChatBlockMergePolicy = 'append' | 'replace' | 'ignore-duplicate';
 /**
  * Structured question form emitted for plan-mode clarification flows.
  */
 interface PlanQuestionnaire {
     questionnaireId: string;
+    /**
+     * Stable key used to identify the same logical questionnaire across streaming patches.
+     * When present, questionnaires are merged by `blockKey` instead of `questionnaireId`.
+     */
+    blockKey?: string;
+    /**
+     * Merge strategy used when another questionnaire with the same key arrives.
+     *
+     * - `append`: keep appending questionnaires even if the key matches.
+     * - `replace`: replace the existing keyed questionnaire with the latest one.
+     * - `ignore-duplicate`: keep the first keyed questionnaire and ignore later duplicates.
+     */
+    mergePolicy?: ChatBlockMergePolicy;
     title?: string;
     description?: string;
     submitLabel?: string;
-    questions: PlanQuestion[];
+    /**
+     * Single question rendered by the questionnaire card.
+     */
+    question: PlanQuestion;
     answers?: Partial<Record<string, PlanQuestionnaireAnswerValue>>;
     status?: PlanQuestionnaireStatus;
     statusMessage?: string;
 }
+interface PlanQuestionSubmissionDetail {
+    questionId: string;
+    kind: PlanQuestion['kind'];
+    value?: PlanQuestionnaireAnswerValue;
+    selectedOptionValues?: string[];
+    otherValue?: string;
+}
 /**
  * Submission payload emitted by a questionnaire card.
  */
 interface PlanQuestionnaireSubmission {
     questionnaireId: string;
+    /**
+     * Stable questionnaire block key forwarded from the rendered card when available.
+     */
+    blockKey?: string;
     answers: Record<string, PlanQuestionnaireAnswerValue>;
+    details?: Record<string, PlanQuestionSubmissionDetail>;
     content: string;
     sourceMessageId?: string;
 }
@@ -168,10 +201,6 @@ interface ResultSummary {
     headline: string;
     details: string[];
 }
-/**
- * Merge behavior applied when a keyed custom block is patched repeatedly.
- */
-type ChatCustomBlockMergePolicy = 'append' | 'replace' | 'ignore-duplicate';
 /**
  * Extensible custom block rendered by a consumer-provided block renderer.
  */
@@ -191,7 +220,7 @@ interface ChatCustomBlock {
      * - `replace`: replace the existing keyed block with the latest one.
      * - `ignore-duplicate`: keep the first keyed block and ignore later duplicates.
      */
-    mergePolicy?: ChatCustomBlockMergePolicy;
+    mergePolicy?: ChatBlockMergePolicy;
 }
 /**
  * Structured assistant block variants rendered by the chat thread.
@@ -387,6 +416,9 @@ interface AiChatLabels {
     questionnaireSubmitted?: string;
     questionnaireValidationPrefix?: string;
     questionnaireSubmitFailed?: string;
+    questionnaireMultiSelectHint?: string;
+    questionnaireOtherOptionLabel?: string;
+    questionnaireOtherPlaceholder?: string;
 }
 /**
  * Default English label values used when no labels are provided.
@@ -621,4 +653,4 @@ declare const useChatContext: () => ChatContextValue;
  */
 declare const useChatStore: <T>(selector: (state: ChatStore) => T) => T;
 
-export { AiChat, type AiChatLabels, type AiChatProps, AiChatProvider, type AiChatProviderProps, CHAT_AGENT_MODES, CHAT_MESSAGE_RENDER_ORDERS, type ChatAgentMode, ChatComposer, type ChatComposerViewProps, type ChatConfirmationSubmitHandler, ChatConversationList, type ChatImageAttachment, type ChatMessage, type ChatMessageBlock, type ChatMessageBlockRenderer, type ChatMessageBlockRendererProps, type ChatMessageRenderOrder, type ChatMessageStatus, type ChatModel, type ChatParameterSummaryItem, type ChatQuestionnaireSubmitHandler, type ChatRole, type ChatSession, type ChatStreamMessagePatch, type ChatStreamPacketTransformArgs, type ChatStreamPacketUpdate, type ChatSubmissionContext, ChatThread, type ChatToolExecutionPolicy, type ChatTransport, type ChatTransportStartStreamArgs, type CreateDefaultChatTransportOptions, DEFAULT_AI_CHAT_LABELS, DEFAULT_CHAT_AGENT_MODE, type DefaultChatTransportEndpoints, type ExecutionConfirmationSubmission, type ExecutionProposal, type PlanQuestionOption, type PlanQuestionnaire, type PlanQuestionnaireSubmission, type ResultSummary, type TransformChatStreamPacket, createDefaultChatTransport, useChatContext, useChatStore };
+export { AiChat, type AiChatLabels, type AiChatProps, AiChatProvider, type AiChatProviderProps, CHAT_AGENT_MODES, CHAT_MESSAGE_RENDER_ORDERS, type ChatAgentMode, ChatComposer, type ChatComposerViewProps, type ChatConfirmationSubmitHandler, ChatConversationList, type ChatImageAttachment, type ChatMessage, type ChatMessageBlock, type ChatMessageBlockRenderer, type ChatMessageBlockRendererProps, type ChatMessageRenderOrder, type ChatMessageStatus, type ChatModel, type ChatParameterSummaryItem, type ChatQuestionnaireSubmitHandler, type ChatRole, type ChatSession, type ChatStreamMessagePatch, type ChatStreamPacketTransformArgs, type ChatStreamPacketUpdate, type ChatSubmissionContext, ChatThread, type ChatToolExecutionPolicy, type ChatTransport, type ChatTransportStartStreamArgs, type CreateDefaultChatTransportOptions, DEFAULT_AI_CHAT_LABELS, DEFAULT_CHAT_AGENT_MODE, type DefaultChatTransportEndpoints, type ExecutionConfirmationSubmission, type ExecutionProposal, type PlanQuestionOption, type PlanQuestionSubmissionDetail, type PlanQuestionnaire, type PlanQuestionnaireSubmission, type ResultSummary, type TransformChatStreamPacket, createDefaultChatTransport, useChatContext, useChatStore };

package/dist/index.d.ts

@@ -72,6 +72,7 @@ interface PlanSingleSelectQuestion extends PlanQuestionBase {
  */
 interface PlanMultiSelectQuestion extends PlanQuestionBase {
     kind: 'multi_select';
+    allowOther?: boolean;
     options: PlanQuestionOption[];
 }
 /**
@@ -102,25 +103,57 @@ interface PlanBooleanQuestion extends PlanQuestionBase {
  */
 type PlanQuestion = PlanSingleSelectQuestion | PlanMultiSelectQuestion | PlanTextQuestion | PlanNumberQuestion | PlanBooleanQuestion;
 type PlanQuestionnaireStatus = 'expired' | 'failed';
+/**
+ * Merge behavior applied when a keyed structured block is patched repeatedly.
+ */
+type ChatBlockMergePolicy = 'append' | 'replace' | 'ignore-duplicate';
 /**
  * Structured question form emitted for plan-mode clarification flows.
  */
 interface PlanQuestionnaire {
     questionnaireId: string;
+    /**
+     * Stable key used to identify the same logical questionnaire across streaming patches.
+     * When present, questionnaires are merged by `blockKey` instead of `questionnaireId`.
+     */
+    blockKey?: string;
+    /**
+     * Merge strategy used when another questionnaire with the same key arrives.
+     *
+     * - `append`: keep appending questionnaires even if the key matches.
+     * - `replace`: replace the existing keyed questionnaire with the latest one.
+     * - `ignore-duplicate`: keep the first keyed questionnaire and ignore later duplicates.
+     */
+    mergePolicy?: ChatBlockMergePolicy;
     title?: string;
     description?: string;
     submitLabel?: string;
-    questions: PlanQuestion[];
+    /**
+     * Single question rendered by the questionnaire card.
+     */
+    question: PlanQuestion;
     answers?: Partial<Record<string, PlanQuestionnaireAnswerValue>>;
     status?: PlanQuestionnaireStatus;
     statusMessage?: string;
 }
+interface PlanQuestionSubmissionDetail {
+    questionId: string;
+    kind: PlanQuestion['kind'];
+    value?: PlanQuestionnaireAnswerValue;
+    selectedOptionValues?: string[];
+    otherValue?: string;
+}
 /**
  * Submission payload emitted by a questionnaire card.
  */
 interface PlanQuestionnaireSubmission {
     questionnaireId: string;
+    /**
+     * Stable questionnaire block key forwarded from the rendered card when available.
+     */
+    blockKey?: string;
     answers: Record<string, PlanQuestionnaireAnswerValue>;
+    details?: Record<string, PlanQuestionSubmissionDetail>;
     content: string;
     sourceMessageId?: string;
 }
@@ -168,10 +201,6 @@ interface ResultSummary {
     headline: string;
     details: string[];
 }
-/**
- * Merge behavior applied when a keyed custom block is patched repeatedly.
- */
-type ChatCustomBlockMergePolicy = 'append' | 'replace' | 'ignore-duplicate';
 /**
  * Extensible custom block rendered by a consumer-provided block renderer.
  */
@@ -191,7 +220,7 @@ interface ChatCustomBlock {
      * - `replace`: replace the existing keyed block with the latest one.
      * - `ignore-duplicate`: keep the first keyed block and ignore later duplicates.
      */
-    mergePolicy?: ChatCustomBlockMergePolicy;
+    mergePolicy?: ChatBlockMergePolicy;
 }
 /**
  * Structured assistant block variants rendered by the chat thread.
@@ -387,6 +416,9 @@ interface AiChatLabels {
     questionnaireSubmitted?: string;
     questionnaireValidationPrefix?: string;
     questionnaireSubmitFailed?: string;
+    questionnaireMultiSelectHint?: string;
+    questionnaireOtherOptionLabel?: string;
+    questionnaireOtherPlaceholder?: string;
 }
 /**
  * Default English label values used when no labels are provided.
@@ -621,4 +653,4 @@ declare const useChatContext: () => ChatContextValue;
  */
 declare const useChatStore: <T>(selector: (state: ChatStore) => T) => T;
 
-export { AiChat, type AiChatLabels, type AiChatProps, AiChatProvider, type AiChatProviderProps, CHAT_AGENT_MODES, CHAT_MESSAGE_RENDER_ORDERS, type ChatAgentMode, ChatComposer, type ChatComposerViewProps, type ChatConfirmationSubmitHandler, ChatConversationList, type ChatImageAttachment, type ChatMessage, type ChatMessageBlock, type ChatMessageBlockRenderer, type ChatMessageBlockRendererProps, type ChatMessageRenderOrder, type ChatMessageStatus, type ChatModel, type ChatParameterSummaryItem, type ChatQuestionnaireSubmitHandler, type ChatRole, type ChatSession, type ChatStreamMessagePatch, type ChatStreamPacketTransformArgs, type ChatStreamPacketUpdate, type ChatSubmissionContext, ChatThread, type ChatToolExecutionPolicy, type ChatTransport, type ChatTransportStartStreamArgs, type CreateDefaultChatTransportOptions, DEFAULT_AI_CHAT_LABELS, DEFAULT_CHAT_AGENT_MODE, type DefaultChatTransportEndpoints, type ExecutionConfirmationSubmission, type ExecutionProposal, type PlanQuestionOption, type PlanQuestionnaire, type PlanQuestionnaireSubmission, type ResultSummary, type TransformChatStreamPacket, createDefaultChatTransport, useChatContext, useChatStore };
+export { AiChat, type AiChatLabels, type AiChatProps, AiChatProvider, type AiChatProviderProps, CHAT_AGENT_MODES, CHAT_MESSAGE_RENDER_ORDERS, type ChatAgentMode, ChatComposer, type ChatComposerViewProps, type ChatConfirmationSubmitHandler, ChatConversationList, type ChatImageAttachment, type ChatMessage, type ChatMessageBlock, type ChatMessageBlockRenderer, type ChatMessageBlockRendererProps, type ChatMessageRenderOrder, type ChatMessageStatus, type ChatModel, type ChatParameterSummaryItem, type ChatQuestionnaireSubmitHandler, type ChatRole, type ChatSession, type ChatStreamMessagePatch, type ChatStreamPacketTransformArgs, type ChatStreamPacketUpdate, type ChatSubmissionContext, ChatThread, type ChatToolExecutionPolicy, type ChatTransport, type ChatTransportStartStreamArgs, type CreateDefaultChatTransportOptions, DEFAULT_AI_CHAT_LABELS, DEFAULT_CHAT_AGENT_MODE, type DefaultChatTransportEndpoints, type ExecutionConfirmationSubmission, type ExecutionProposal, type PlanQuestionOption, type PlanQuestionSubmissionDetail, type PlanQuestionnaire, type PlanQuestionnaireSubmission, type ResultSummary, type TransformChatStreamPacket, createDefaultChatTransport, useChatContext, useChatStore };