@askdialog/dialog-sdk 2.10.0 → 2.11.0

package/README.md

@@ -261,7 +261,7 @@ A non-2xx answer rejects with `DialogSearchError` — stable `name`, HTTP `statu
 
 - Search controller
 
-`createSearchController()` wraps the stateless transport with the stateful behavior every search UI needs — debounce (immediate on explicit submission), cancellation of the in-flight request, stale-response protection (a late response never replaces newer results, even if the transport ignores the abort), pagination that resets on a new query, `idle` / `loading` / `success` / `empty` / `error` states, retry, and the DEC-2448 attribution events (`view_search_results` viewport impressions, `select_search_result` clicks). It searches the products index (`products_<locale>`) and exposes the products result entry as `state.response`. It has no framework or rendering dependency: raw JavaScript, React, Vue and Shopify integrations are rendering-and-routing adapters around it.
+`createSearchController()` wraps the stateless transport with the stateful behavior every search UI needs — debounce (immediate on explicit submission), cancellation of the in-flight request, stale-response protection (a late response never replaces newer results, even if the transport ignores the abort), pagination that resets on a new query, `idle` / `loading` / `success` / `empty` / `error` states, retry, and the attribution events (`view_search_results` viewport impressions, `select_search_result` clicks). It searches the products index (`products_<locale>`) and exposes the products result entry as `state.response`; optional `sections` add other indices (`collections`, …) to the same request, exposed under `state.sections`. It has no framework or rendering dependency: raw JavaScript, React, Vue and Shopify integrations are rendering-and-routing adapters around it.
 
 ```typescript
 import { createSearchController, Dialog, SearchStatus } from '@askdialog/dialog-sdk';
@@ -279,6 +279,7 @@ const controller = createSearchController({
   navigate: (url) => router.push(url), // optional platform routing adapter
   debounceMs: 250, // optional (default 250)
   hitsPerPage: 12, // optional (default 12)
+  sections: [{ index: 'collections', hitsPerPage: 5 }], // optional, first page only; a function is resolved per request
 });
 
 const unsubscribe = controller.subscribe((state) => {

package/dist/__tests__/searchController.spec.js

@@ -1,4 +1,4 @@
-/* eslint max-lines: ["error", 400] */
+/* eslint max-lines: ["error", 460] */
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
 import { createSearchController } from "../searchController";
 import { SearchStatus } from "../types/searchController";
@@ -288,4 +288,83 @@ describe("createSearchController", () => {
         expect(search).toHaveBeenCalledTimes(1);
         expect(controller.getState().status).toBe(SearchStatus.LOADING);
     });
+    it("requests the sections on their first page with the products and exposes their entries", async () => {
+        const controller = createSearchController({
+            search,
+            analytics: {
+                surface: "search_page",
+                trackViewSearchResults,
+                trackSelectSearchResult,
+            },
+            locale: "fr",
+            sections: [{ index: "collections", hitsPerPage: 5 }],
+        });
+        const collections = {
+            ...response().results[0],
+            index: "collections_fr",
+            hits: [{ objectID: "c1" }],
+            nbHits: 1,
+        };
+        search.mockResolvedValueOnce({
+            results: [...response().results, collections],
+        });
+        controller.submit("shoes");
+        await settle();
+        expect(search.mock.calls[0][0].requests).toEqual([
+            { indexName: "products_fr", query: "shoes", page: 0, hitsPerPage: 12 },
+            { indexName: "collections_fr", query: "shoes", page: 0, hitsPerPage: 5 },
+        ]);
+        expect(controller.getState().response?.index).toBe("products_fr");
+        expect(controller.getState().sections).toEqual({ collections });
+    });
+    it("resolves a sections function per request and leaves a missing entry out", async () => {
+        let enabled = false;
+        const controller = createSearchController({
+            search,
+            analytics: {
+                surface: "search_page",
+                trackViewSearchResults,
+                trackSelectSearchResult,
+            },
+            locale: "fr",
+            sections: () => (enabled ? [{ index: "collections" }] : []),
+        });
+        search.mockResolvedValue(response());
+        controller.submit("shoes");
+        await settle();
+        enabled = true;
+        controller.submit("boots");
+        await settle();
+        expect(search.mock.calls[0][0].requests).toHaveLength(1);
+        expect(search.mock.calls[1][0].requests).toHaveLength(2);
+        expect(search.mock.calls[1][0].requests[1]).toMatchObject({
+            indexName: "collections_fr",
+            hitsPerPage: 12,
+        });
+        expect(controller.getState().sections).toEqual({});
+    });
+    it("enters the error state when the sections resolver throws", async () => {
+        const failure = new Error("entitlement lookup failed");
+        const controller = createSearchController({
+            search,
+            analytics: {
+                surface: "search_page",
+                trackViewSearchResults,
+                trackSelectSearchResult,
+            },
+            locale: "fr",
+            sections: () => {
+                throw failure;
+            },
+        });
+        controller.submit("shoes");
+        await settle();
+        expect(search).not.toHaveBeenCalled();
+        expect(controller.getState()).toMatchObject({
+            status: SearchStatus.ERROR,
+            error: failure,
+            response: undefined,
+            sections: undefined,
+        });
+    });
 });

package/dist/searchController.d.ts

@@ -1,3 +1,3 @@
 import { SearchController, SearchControllerOptions } from "./types/searchController";
-export declare function createSearchController({ search, analytics, navigate, debounceMs, hitsPerPage, locale, }: SearchControllerOptions): SearchController;
+export declare function createSearchController({ search, analytics, navigate, debounceMs, hitsPerPage, locale, sections, }: SearchControllerOptions): SearchController;
 //# sourceMappingURL=searchController.d.ts.map

package/dist/searchController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchController.d.ts","sourceRoot":"","sources":["../src/searchController.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EAGxB,MAAM,0BAA0B,CAAC;AAgBlC,wBAAgB,sBAAsB,CAAC,EACrC,MAAM,EACN,SAAS,EACT,QAAQ,EACR,UAAgC,EAChC,WAAmC,EACnC,MAAM,GACP,EAAE,uBAAuB,GAAG,gBAAgB,CA8K5C"}
+{"version":3,"file":"searchController.d.ts","sourceRoot":"","sources":["../src/searchController.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EAIxB,MAAM,0BAA0B,CAAC;AAqBlC,wBAAgB,sBAAsB,CAAC,EACrC,MAAM,EACN,SAAS,EACT,QAAQ,EACR,UAAgC,EAChC,WAAmC,EACnC,MAAM,EACN,QAAa,GACd,EAAE,uBAAuB,GAAG,gBAAgB,CA6L5C"}

package/dist/searchController.js

@@ -1,10 +1,12 @@
-// This controller is one cohesive unit. `selectResult` now returns whether the
-// navigate adapter handled the transition, nudging the file just past the
-// default 200-line cap — raised modestly rather than split artificially.
-/* eslint max-lines: ["error", 220] */
+// This controller is one cohesive unit: `selectResult` reports whether the
+// navigate adapter handled the transition and the response is split into the
+// products entry plus its sections, pushing the file past the default 200-line
+// cap — raised modestly rather than split artificially.
+/* eslint max-lines: ["error", 240] */
 import { searchIndexName } from "./services/search";
 import { SearchStatus, } from "./types/searchController";
 import { createControllerAnalytics } from "./utils/searchControllerAnalytics";
+import { buildSectionQueries, pickSectionResults, } from "./utils/searchSections";
 const DEFAULT_DEBOUNCE_MS = 250;
 const DEFAULT_HITS_PER_PAGE = 12;
 // `SearchRequest` rejects queries under two visible characters (code points).
@@ -14,10 +16,12 @@ const INITIAL_STATE = {
     query: "",
     page: 0,
     response: undefined,
+    sections: undefined,
     error: undefined,
 };
-export function createSearchController({ search, analytics, navigate, debounceMs = DEFAULT_DEBOUNCE_MS, hitsPerPage = DEFAULT_HITS_PER_PAGE, locale, }) {
+export function createSearchController({ search, analytics, navigate, debounceMs = DEFAULT_DEBOUNCE_MS, hitsPerPage = DEFAULT_HITS_PER_PAGE, locale, sections = [], }) {
     const indexName = searchIndexName("products", locale);
+    const resolveSections = () => typeof sections === "function" ? sections() : sections;
     let state = INITIAL_STATE;
     const listeners = new Set();
     const controllerAnalytics = createControllerAnalytics(analytics);
@@ -40,17 +44,20 @@ export function createSearchController({ search, analytics, navigate, debounceMs
         abortController?.abort();
         abortController = undefined;
     };
-    const buildRequest = (query, page) => ({
-        requests: [{ indexName, query, page, hitsPerPage }],
+    const buildRequest = (query, page, requested) => ({
+        requests: [
+            { indexName, query, page, hitsPerPage },
+            ...buildSectionQueries(requested, query, locale, hitsPerPage),
+        ],
     });
     const run = async (query, page) => {
         cancelInFlight();
         abortController = new AbortController();
         const id = ++requestId;
-        const request = buildRequest(query, page);
         setState({ status: SearchStatus.LOADING, query, page });
         try {
-            const response = await search(request, {
+            const requested = resolveSections();
+            const response = await search(buildRequest(query, page, requested), {
                 signal: abortController.signal,
             });
             if (id !== requestId) {
@@ -64,6 +71,7 @@ export function createSearchController({ search, analytics, navigate, debounceMs
             setState({
                 status: result.nbHits === 0 ? SearchStatus.EMPTY : SearchStatus.SUCCESS,
                 response: result,
+                sections: pickSectionResults(response, requested, locale),
                 error: undefined,
             });
         }
@@ -74,7 +82,12 @@ export function createSearchController({ search, analytics, navigate, debounceMs
             if (id !== requestId) {
                 return;
             }
-            setState({ status: SearchStatus.ERROR, error, response: undefined });
+            setState({
+                status: SearchStatus.ERROR,
+                error,
+                response: undefined,
+                sections: undefined,
+            });
         }
     };
     // Shared by `setQuery`/`submit`: undefined = reset to idle (query too short).

package/dist/types/searchController.d.ts

@@ -1,4 +1,4 @@
-import { SearchHit, SearchOptions, SearchRequest, SearchResponse, SearchResult } from "./search";
+import { SearchHit, SearchIndex, SearchOptions, SearchRequest, SearchResponse, SearchResult } from "./search";
 import { SearchSurface, SelectSearchResultParams, ViewSearchResultsParams } from "./searchAnalytics";
 export declare const SearchStatus: {
     readonly IDLE: "idle";
@@ -9,6 +9,10 @@ export declare const SearchStatus: {
     readonly ERROR: "error";
 };
 export type SearchStatus = (typeof SearchStatus)[keyof typeof SearchStatus];
+export interface SearchSection {
+    index: Exclude<SearchIndex, "products">;
+    hitsPerPage?: number;
+}
 export interface SearchControllerState {
     status: SearchStatus;
     /** Last committed (run) query — not the text currently being typed. */
@@ -20,6 +24,7 @@ export interface SearchControllerState {
      * loads, cleared on error. Hits are flat records (`objectID`, `title`, …).
      */
     response?: SearchResult;
+    sections?: Partial<Record<SearchIndex, SearchResult>>;
     error?: unknown;
 }
 export type SearchFunction = (request: SearchRequest, options?: SearchOptions) => Promise<SearchResponse>;
@@ -48,6 +53,7 @@ export interface SearchControllerOptions {
     debounceMs?: number;
     hitsPerPage?: number;
     locale: string;
+    sections?: readonly SearchSection[] | (() => readonly SearchSection[]);
 }
 /**
  * Framework-agnostic stateful search behavior around the stateless

package/dist/types/searchController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchController.d.ts","sourceRoot":"","sources":["../../src/types/searchController.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,EACd,YAAY,EACb,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,aAAa,EACb,wBAAwB,EACxB,uBAAuB,EACxB,MAAM,mBAAmB,CAAC;AAE3B,eAAO,MAAM,YAAY;;;;IAIvB,yGAAyG;;;CAGjG,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE5E,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,YAAY,CAAC;IACrB,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,MAAM,cAAc,GAAG,CAC3B,OAAO,EAAE,aAAa,EACtB,OAAO,CAAC,EAAE,aAAa,KACpB,OAAO,CAAC,cAAc,CAAC,CAAC;AAE7B;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,aAAa,CAAC;IACvB,sBAAsB,EAAE,CAAC,MAAM,EAAE,uBAAuB,KAAK,IAAI,CAAC;IAClE,uBAAuB,EAAE,CAAC,MAAM,EAAE,wBAAwB,KAAK,IAAI,CAAC;CACrE;AAED,MAAM,WAAW,uBAAuB;IACtC,0CAA0C;IAC1C,MAAM,EAAE,cAAc,CAAC;IACvB,SAAS,EAAE,yBAAyB,CAAC;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,KAAK,IAAI,CAAC;IACjD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,2EAA2E;IAC3E,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,kEAAkE;IAClE,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,oEAAoE;IACpE,KAAK,IAAI,IAAI,CAAC;IACd;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrD;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC;IACvE,mEAAmE;IACnE,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IACxE,QAAQ,IAAI,qBAAqB,CAAC;IAClC,kEAAkE;IAClE,OAAO,IAAI,IAAI,CAAC;CACjB"}
+{"version":3,"file":"searchController.d.ts","sourceRoot":"","sources":["../../src/types/searchController.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,WAAW,EACX,aAAa,EACb,aAAa,EACb,cAAc,EACd,YAAY,EACb,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,aAAa,EACb,wBAAwB,EACxB,uBAAuB,EACxB,MAAM,mBAAmB,CAAC;AAE3B,eAAO,MAAM,YAAY;;;;IAIvB,yGAAyG;;;CAGjG,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE5E,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,YAAY,CAAC;IACrB,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC;IACtD,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,MAAM,cAAc,GAAG,CAC3B,OAAO,EAAE,aAAa,EACtB,OAAO,CAAC,EAAE,aAAa,KACpB,OAAO,CAAC,cAAc,CAAC,CAAC;AAE7B;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,aAAa,CAAC;IACvB,sBAAsB,EAAE,CAAC,MAAM,EAAE,uBAAuB,KAAK,IAAI,CAAC;IAClE,uBAAuB,EAAE,CAAC,MAAM,EAAE,wBAAwB,KAAK,IAAI,CAAC;CACrE;AAED,MAAM,WAAW,uBAAuB;IACtC,0CAA0C;IAC1C,MAAM,EAAE,cAAc,CAAC;IACvB,SAAS,EAAE,yBAAyB,CAAC;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,KAAK,IAAI,CAAC;IACjD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,SAAS,aAAa,EAAE,GAAG,CAAC,MAAM,SAAS,aAAa,EAAE,CAAC,CAAC;CACxE;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,2EAA2E;IAC3E,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,kEAAkE;IAClE,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,oEAAoE;IACpE,KAAK,IAAI,IAAI,CAAC;IACd;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrD;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC;IACvE,mEAAmE;IACnE,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IACxE,QAAQ,IAAI,qBAAqB,CAAC;IAClC,kEAAkE;IAClE,OAAO,IAAI,IAAI,CAAC;CACjB"}

package/dist/utils/searchSections.d.ts

@@ -0,0 +1,5 @@
+import { SearchIndex, SearchQuery, SearchResponse, SearchResult } from "../types/search";
+import { SearchSection } from "../types/searchController";
+export declare const buildSectionQueries: (sections: readonly SearchSection[], query: string, locale: string, hitsPerPage: number) => SearchQuery[];
+export declare const pickSectionResults: (response: SearchResponse, sections: readonly SearchSection[], locale: string) => Partial<Record<SearchIndex, SearchResult>> | undefined;
+//# sourceMappingURL=searchSections.d.ts.map

package/dist/utils/searchSections.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchSections.d.ts","sourceRoot":"","sources":["../../src/utils/searchSections.ts"],"names":[],"mappings":"AACA,OAAO,EACL,WAAW,EACX,WAAW,EACX,cAAc,EACd,YAAY,EACb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D,eAAO,MAAM,mBAAmB,GAC9B,UAAU,SAAS,aAAa,EAAE,EAClC,OAAO,MAAM,EACb,QAAQ,MAAM,EACd,aAAa,MAAM,KAClB,WAAW,EAMT,CAAC;AAEN,eAAO,MAAM,kBAAkB,GAC7B,UAAU,cAAc,EACxB,UAAU,SAAS,aAAa,EAAE,EAClC,QAAQ,MAAM,KACb,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,GAAG,SAgB/C,CAAC"}

package/dist/utils/searchSections.js

@@ -0,0 +1,21 @@
+import { searchIndexName } from "../services/search";
+export const buildSectionQueries = (sections, query, locale, hitsPerPage) => sections.map((section) => ({
+    indexName: searchIndexName(section.index, locale),
+    query,
+    page: 0,
+    hitsPerPage: section.hitsPerPage ?? hitsPerPage,
+}));
+export const pickSectionResults = (response, sections, locale) => {
+    if (sections.length === 0) {
+        return undefined;
+    }
+    const picked = {};
+    for (const section of sections) {
+        const sectionIndexName = searchIndexName(section.index, locale);
+        const entry = response.results.find((candidate) => candidate.index === sectionIndexName);
+        if (entry !== undefined) {
+            picked[section.index] = entry;
+        }
+    }
+    return picked;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@askdialog/dialog-sdk",
-  "version": "2.10.0",
+  "version": "2.11.0",
   "private": false,
   "description": "Dialog SDK",
   "main": "dist/index.js",