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

package/lib/cjs/hooks/asaStreamHandlers.js

@@ -1,15 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handleStreamError = exports.handleStreamEnd = exports.handleServerError = exports.handleMessage = exports.handleSearchResult = void 0;
+/**
+ * Internal A/B configuration echoed back on the request. Stripped before the request reaches
+ * consumers: it is unstable (the backend omits it on some pods within a single response) and
+ * nothing a consumer should branch on. Everything else passes through untouched, so new
+ * backend fields reach consumers without a library change.
+ */
+const INTERNAL_REQUEST_FIELDS = ['features', 'feature_variants'];
+function omitInternalRequestFields(request) {
+    return Object.fromEntries(Object.entries(request).filter(([key]) => !INTERNAL_REQUEST_FIELDS.includes(key)));
+}
 function updateMessageById(setMessages, id, patch) {
     setMessages((prev) => prev.map((msg) => (msg.id === id ? patch(msg) : msg)));
 }
 function handleSearchResult(data, pendingGroup, assistantId, setMessages) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-    const resolvedGroup = pendingGroup !== null && pendingGroup !== void 0 ? pendingGroup : {
+    const baseGroup = pendingGroup !== null && pendingGroup !== void 0 ? pendingGroup : {
         display_name: (_d = (_c = (_b = (_a = data === null || data === void 0 ? void 0 : data.response) === null || _a === void 0 ? void 0 : _a.search_request) === null || _b === void 0 ? void 0 : _b.display_name) !== null && _c !== void 0 ? _c : data === null || data === void 0 ? void 0 : data.title) !== null && _d !== void 0 ? _d : '',
         value: (_h = (_g = (_f = (_e = data === null || data === void 0 ? void 0 : data.response) === null || _e === void 0 ? void 0 : _e.search_request) === null || _f === void 0 ? void 0 : _f.search_term) !== null && _g !== void 0 ? _g : data === null || data === void 0 ? void 0 : data.title) !== null && _h !== void 0 ? _h : '',
     };
+    // The echoed CIO request arrives on the `search_result` event, not on the preceding `group`
+    // event, so it is merged in regardless of how the group resolved. Consumers branch on
+    // `data.request.term` in `onViewMore` to build the destination URL.
+    const resolvedGroup = Object.assign(Object.assign({}, baseGroup), ((data === null || data === void 0 ? void 0 : data.request) && {
+        data: Object.assign(Object.assign({}, baseGroup.data), { request: omitInternalRequestFields(data.request) }),
+    }));
     const results = (_k = (_j = data === null || data === void 0 ? void 0 : data.response) === null || _j === void 0 ? void 0 : _j.results) !== null && _k !== void 0 ? _k : ((data === null || data === void 0 ? void 0 : data.results) ? data.results : [data]);
     // `result_id` is unique per search_result event; `intent_result_id` is shared across
     // the stream. Both sit at the top level of the SSE event payload.

package/lib/cjs/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '1.3.0';
+exports.default = '1.4.0';

package/lib/mjs/hooks/asaStreamHandlers.js

@@ -1,11 +1,30 @@
+/**
+ * Internal A/B configuration echoed back on the request. Stripped before the request reaches
+ * consumers: it is unstable (the backend omits it on some pods within a single response) and
+ * nothing a consumer should branch on. Everything else passes through untouched, so new
+ * backend fields reach consumers without a library change.
+ */
+const INTERNAL_REQUEST_FIELDS = ['features', 'feature_variants'];
+function omitInternalRequestFields(request) {
+    return Object.fromEntries(Object.entries(request).filter(([key]) => !INTERNAL_REQUEST_FIELDS.includes(key)));
+}
 function updateMessageById(setMessages, id, patch) {
     setMessages((prev) => prev.map((msg) => (msg.id === id ? patch(msg) : msg)));
 }
 export function handleSearchResult(data, pendingGroup, assistantId, setMessages) {
-    const resolvedGroup = pendingGroup ?? {
+    const baseGroup = pendingGroup ?? {
         display_name: data?.response?.search_request?.display_name ?? data?.title ?? '',
         value: data?.response?.search_request?.search_term ?? data?.title ?? '',
     };
+    // The echoed CIO request arrives on the `search_result` event, not on the preceding `group`
+    // event, so it is merged in regardless of how the group resolved. Consumers branch on
+    // `data.request.term` in `onViewMore` to build the destination URL.
+    const resolvedGroup = {
+        ...baseGroup,
+        ...(data?.request && {
+            data: { ...baseGroup.data, request: omitInternalRequestFields(data.request) },
+        }),
+    };
     const results = data?.response?.results ?? (data?.results ? data.results : [data]);
     // `result_id` is unique per search_result event; `intent_result_id` is shared across
     // the stream. Both sit at the top level of the SSE event payload.

package/lib/mjs/version.js

@@ -1 +1 @@
-export default '1.3.0';
+export default '1.4.0';

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, 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, 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';

package/lib/types/types.d.ts

@@ -72,11 +72,48 @@ export interface ChatMessage {
     threadId?: string;
 }
 export type ChatMessageStatus = 'idle' | 'loading' | 'streaming' | 'done' | 'error';
+/**
+ * Echoed CIO search API request from a `search_result` SSE event — the parameters the
+ * backend used to fetch this pod's results.
+ *
+ * Several pod types (keyword search, category browse, recommendations, bestsellers) all
+ * arrive as `search_result` events, and nothing at the event level distinguishes them.
+ * This request is the only place a consumer can tell them apart:
+ * - `term` non-empty -> keyword pod; route to a search page.
+ * - `term` empty with `browse_filter_name`/`browse_filter_value` -> category pod; route to
+ *   a category page. Do **not** use the pod's `value` as a query here: for category pods the
+ *   backend sets it to the heading rather than a search term.
+ *
+ * Carry `filters`, `filter_match_types` and the sort over to the destination too, otherwise
+ * the page shows a different result set than the pod that was clicked.
+ */
+export interface SearchResultEventRequest {
+    num_results_per_page?: number;
+    ids?: string[];
+    term?: string;
+    page?: number;
+    fmt_options?: Record<string, unknown>;
+    sort_by?: string;
+    sort_order?: string;
+    section?: string;
+    /** Facet name a category pod browses on (e.g. `'group_id'`). Absent on keyword pods. */
+    browse_filter_name?: string;
+    /** Facet value a category pod browses on (e.g. `'cat100260235'`). Absent on keyword pods. */
+    browse_filter_value?: string;
+    /** Filters the agent applied to build this pod, e.g. `{ event: ['wedding'] }`. */
+    filters?: Record<string, unknown>;
+    /** Match type per filter, e.g. `{ event: 'any' }`. */
+    filter_match_types?: Record<string, unknown>;
+    pre_filter_expression?: Record<string, unknown>;
+    [key: string]: unknown;
+}
 export interface ResultGroupMeta {
     display_name: string;
     value?: string;
+    /** Backend metadata for this pod. */
     data?: {
         display_name?: string;
+        request?: SearchResultEventRequest;
         [key: string]: unknown;
     };
 }

package/lib/types/version.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-ui-asa",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Constructor.io AI Shopping Agent UI library for web applications",
   "author": "constructor.io",
   "license": "MIT",