@constructor-io/constructorio-ui-asa 1.4.0 → 1.6.0

package/lib/types/components/icons/index.d.ts

@@ -1,5 +1,6 @@
 export { default as ChatBubbleDarkIcon } from './ChatBubbleDarkIcon';
 export { default as ChatBubbleLightIcon } from './ChatBubbleLightIcon';
 export { default as SendArrowIcon } from './SendArrowIcon';
+export { default as StopIcon } from './StopIcon';
 export { default as SendPlaneIcon } from './SendPlaneIcon';
 export { default as ArrowRightIcon } from './ArrowRightIcon';

package/lib/types/hooks/asaStreamHandlers.d.ts

@@ -3,6 +3,7 @@ import { ResultGroupMeta, ChatMessage } from '../types';
 export type MessageUpdater = Dispatch<SetStateAction<ChatMessage[]>>;
 export declare function handleSearchResult(data: any, pendingGroup: ResultGroupMeta | null, assistantId: string, setMessages: MessageUpdater): ResultGroupMeta | null;
 export declare function handleMessage(data: any, assistantId: string, setMessages: MessageUpdater): void;
+export declare function handleFollowUpRefinement(data: any, assistantId: string, setMessages: MessageUpdater): void;
 export declare function handleServerError(assistantId: string, setMessages: MessageUpdater): void;
 export declare function handleStreamEnd(assistantId: string, setMessages: MessageUpdater): void;
 export declare function handleStreamError(assistantId: string, setMessages: MessageUpdater): void;

package/lib/types/index.d.ts

@@ -12,4 +12,4 @@ export type { UseAsaTrackingProps, UseAsaTrackingReturn } from './hooks/useAsaTr
 export { normalizeItemToProduct } from './utils/productNormalizer';
 export type { Product, NormalizeOptions } from './utils/productNormalizer';
 export { ConstructorIOClient } from './types';
-export type { Nullable, CioAsaProviderProps, AsaContextValue, CioClientOptions, RequestConfigs, Formatters, UrlHelpers, QueryParamEncodingOptions, DefaultQueryStringMap, Translations, ChatMessage, ChatMessageStatus, ResultGroup, ResultGroupMeta, SearchResultEventRequest, UseAsaResultsOptions, UseChatReturn, AsaCallbacks, AssistantSubmitSource, AssistantTrackedItem, ChatComponentOverrides, WelcomeScreenOverrides, ChatInputOverrides, AiMessageOverrides, ResultsBlockOverrides, ComponentOverrideProps, IncludeComponentOverrides, ChatHeaderRenderProps, ChatInputRenderProps, WelcomeScreenTitleRenderProps, WelcomeScreenInputRenderProps, SuggestedQuestionsRenderProps, UserMessageRenderProps, AiMessageLoaderRenderProps, AiMessageTextRenderProps, ResultsGroupTitleRenderProps, ResultsViewMoreRenderProps, } from './types';
+export type { Nullable, CioAsaProviderProps, AsaContextValue, CioClientOptions, RequestConfigs, Formatters, UrlHelpers, QueryParamEncodingOptions, DefaultQueryStringMap, Translations, ChatMessage, ChatMessageStatus, FollowUpRefinement, ResultGroup, ResultGroupMeta, SearchResultEventRequest, UseAsaResultsOptions, UseChatReturn, AsaCallbacks, AssistantSubmitSource, AssistantTrackedItem, ChatComponentOverrides, WelcomeScreenOverrides, ChatInputOverrides, AiMessageOverrides, ResultsBlockOverrides, ComponentOverrideProps, IncludeComponentOverrides, ChatHeaderRenderProps, ChatInputRenderProps, WelcomeScreenTitleRenderProps, WelcomeScreenInputRenderProps, SuggestedQuestionsRenderProps, UserMessageRenderProps, AiMessageLoaderRenderProps, AiMessageTextRenderProps, FollowUpRefinementRenderProps, ResultsGroupTitleRenderProps, ResultsViewMoreRenderProps, } from './types';

package/lib/types/types.d.ts

@@ -70,6 +70,13 @@ export interface ChatMessage {
     intent?: string;
     intentResultId?: string;
     threadId?: string;
+    /** Narrowing question the agent asked at the end of this turn, from a `follow_up_refinement` event. */
+    refinement?: FollowUpRefinement;
+}
+/** A narrowing question with selectable options, emitted by the agent as a `follow_up_refinement` event. */
+export interface FollowUpRefinement {
+    question: string;
+    options: string[];
 }
 export type ChatMessageStatus = 'idle' | 'loading' | 'streaming' | 'done' | 'error';
 /**
@@ -127,14 +134,20 @@ export interface UseChatReturn {
     messages: ChatMessage[];
     sendMessage: (text: string, source?: AssistantSubmitSource) => void;
     isStreaming: boolean;
+    /**
+     * Cancel the in-flight request, keeping the conversation. The partial reply is settled
+     * as `done` and the thread id is kept, so the next message continues the same
+     * conversation. No-op when nothing is streaming. Use `clearHistory` to reset instead.
+     */
+    abort: () => void;
     clearHistory: () => void;
 }
 export interface UseAsaResultsOptions {
     /** Seed the thread id (e.g. loaded from browser storage) to resume a prior conversation. Read once on mount. */
     initialThreadId?: string;
 }
-/** How an intent was submitted: typed into the input, or a suggestion chip clicked. */
-export type AssistantSubmitSource = 'input' | 'suggestion';
+/** How an intent was submitted: typed input, a welcome-screen suggestion chip, or a refinement chip. */
+export type AssistantSubmitSource = 'input' | 'suggestion' | 'refinement';
 /** An item within a viewed/clicked search_result pod. */
 export interface AssistantTrackedItem {
     itemId?: string;
@@ -147,7 +160,7 @@ export interface AssistantTrackedItem {
  * so consumers can mirror ASA analytics into their own systems. All are optional.
  */
 export interface AsaCallbacks {
-    /** User submitted an intent (typed) or clicked a suggestion. */
+    /** User submitted an intent (typed) or clicked a suggestion / refinement chip. */
     onAssistantSubmit?: (payload: {
         intent: string;
         source: AssistantSubmitSource;
@@ -198,6 +211,7 @@ export type Translations = {
     'CioAsa.input.placeholder'?: string;
     'CioAsa.input.ariaLabel'?: string;
     'CioAsa.input.sendAriaLabel'?: string;
+    'CioAsa.input.stopAriaLabel'?: string;
     'CioAsa.welcome.title'?: string;
     'CioAsa.welcome.placeholder'?: string;
     'CioAsa.welcome.sendButton'?: string;
@@ -212,6 +226,7 @@ export type Translations = {
     'CioAsa.results.viewMore'?: string;
     'CioAsa.results.addToCart'?: string;
     'CioAsa.results.saleBadge'?: string;
+    'CioAsa.refinement.ariaLabel'?: string;
     'CioAsa.error.message'?: string;
 };
 export interface ChatHeaderRenderProps {
@@ -224,6 +239,14 @@ export interface ChatInputRenderProps {
     onSubmit: () => void;
     placeholder: string;
     isDisabled: boolean;
+    /**
+     * Whether a reply is currently streaming. Pair it with `onAbort` to offer a cancel
+     * control while it is true — the built-in stop button is off by default, so an override
+     * is often the only way a user can cancel.
+     */
+    isStreaming: boolean;
+    /** Cancel the in-flight reply. Keeps the conversation and the thread. */
+    onAbort: () => void;
 }
 export interface WelcomeScreenTitleRenderProps {
     text: string;
@@ -248,6 +271,14 @@ export interface AiMessageLoaderRenderProps {
 export interface AiMessageTextRenderProps {
     text: string;
 }
+export interface FollowUpRefinementRenderProps {
+    question: string;
+    options: string[];
+    /** Sends the option as a follow-up message. No-op while `isDisabled`. */
+    onOptionClick: (option: string) => void;
+    /** True for earlier refinements and while a response is streaming. */
+    isDisabled: boolean;
+}
 export interface ResultsGroupTitleRenderProps {
     label: string;
 }
@@ -266,6 +297,7 @@ export interface ChatInputOverrides {
 export interface AiMessageOverrides {
     loader?: ComponentOverrideProps<AiMessageLoaderRenderProps>;
     text?: ComponentOverrideProps<AiMessageTextRenderProps>;
+    followUpRefinement?: ComponentOverrideProps<FollowUpRefinementRenderProps>;
 }
 export interface ResultsBlockOverrides {
     groupTitle?: ComponentOverrideProps<ResultsGroupTitleRenderProps>;

package/lib/types/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.4.0";
+declare const _default: "1.6.0";
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-ui-asa",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "Constructor.io AI Shopping Agent UI library for web applications",
   "author": "constructor.io",
   "license": "MIT",
@@ -69,7 +69,7 @@
     "prepare": "husky install"
   },
   "peerDependencies": {
-    "@constructor-io/constructorio-client-javascript": "^2.91.0",
+    "@constructor-io/constructorio-client-javascript": "^2.93.1",
     "@constructor-io/constructorio-ui-components": "^1.6.0",
     "react": ">=16.12.0",
     "react-dom": ">=16.12.0",
@@ -79,7 +79,7 @@
     "@babel/preset-env": "^7.28.3",
     "@babel/preset-react": "^7.27.1",
     "@babel/preset-typescript": "^7.27.1",
-    "@constructor-io/constructorio-client-javascript": "^2.91.0",
+    "@constructor-io/constructorio-client-javascript": "2.93.1",
     "@constructor-io/constructorio-ui-components": "^1.6.0",
     "@cspell/eslint-plugin": "^6.18.1",
     "@storybook/addon-a11y": "^8.6.14",