@coveo/headless-react 2.5.7-pre.fd645afb40 → 2.5.7

package/dist/__tests__/component-test-utils.d.ts

@@ -0,0 +1,11 @@
+import type { Result } from '@coveo/headless/ssr';
+import type { Product } from '@coveo/headless/ssr-commerce';
+export declare const createProductListComponent: (productCount?: number) => {
+    ProductListComponent: () => import("react/jsx-runtime").JSX.Element;
+    mockProducts: Product[];
+};
+export declare const createResultListComponent: (resultCount?: number) => {
+    ResultListComponent: () => import("react/jsx-runtime").JSX.Element;
+    mockResults: Result[];
+};
+export declare const createTestComponent: (testId: string, content?: string) => () => import("react/jsx-runtime").JSX.Element;

package/dist/__tests__/component-test-utils.js

@@ -0,0 +1,50 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { randomUUID } from 'node:crypto';
+import { generateMockProducts } from './mock-products.js';
+export const createProductListComponent = (productCount = 5) => {
+    const mockProducts = generateMockProducts(productCount);
+    function ProductListComponent() {
+        return (_jsx("ul", { "data-testid": "product-list", children: mockProducts.map((product) => (_jsx("li", { "data-testid": "product-item", children: product.ec_name }, product.ec_product_id))) }));
+    }
+    return { ProductListComponent, mockProducts };
+};
+export const createResultListComponent = (resultCount = 5) => {
+    const generateMockResult = () => ({
+        absentTerms: [],
+        clickUri: '',
+        excerpt: '',
+        excerptHighlights: [],
+        firstSentences: '',
+        firstSentencesHighlights: [],
+        flags: '',
+        hasHtmlVersion: false,
+        isRecommendation: false,
+        isTopResult: false,
+        isUserActionView: false,
+        percentScore: 0,
+        printableUri: '',
+        printableUriHighlights: [],
+        rankingInfo: null,
+        raw: { urihash: '' },
+        score: 0,
+        searchUid: '',
+        summary: null,
+        summaryHighlights: [],
+        title: `Test Result ${Math.random()}`,
+        titleHighlights: [],
+        uniqueId: randomUUID(),
+        uri: '',
+    });
+    const mockResults = Array.from({ length: resultCount }, generateMockResult);
+    function ResultListComponent() {
+        return (_jsx("ul", { "data-testid": "result-list", children: mockResults.map((result) => (_jsx("li", { "data-testid": "result-item", children: result.title }, result.uniqueId))) }));
+    }
+    return { ResultListComponent, mockResults };
+};
+export const createTestComponent = (testId, content = 'Test Content') => {
+    function TestComponent() {
+        return _jsx("div", { "data-testid": testId, children: content });
+    }
+    return TestComponent;
+};
+//# sourceMappingURL=component-test-utils.js.map

package/dist/__tests__/component-test-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-test-utils.js","sourceRoot":"","sources":["../../src/__tests__/component-test-utils.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC;AAGvC,OAAO,EAAC,oBAAoB,EAAC,MAAM,oBAAoB,CAAC;AAExD,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,YAAY,GAAG,CAAC,EAAE,EAAE;IAC7D,MAAM,YAAY,GAAG,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAExD,SAAS,oBAAoB;QAC3B,OAAO,CACL,4BAAgB,cAAc,YAC3B,YAAY,CAAC,GAAG,CAAC,CAAC,OAAgB,EAAE,EAAE,CAAC,CACtC,4BAA4C,cAAc,YACvD,OAAO,CAAC,OAAO,IADT,OAAO,CAAC,aAAa,CAEzB,CACN,CAAC,GACC,CACN,CAAC;IACJ,CAAC;IAED,OAAO,EAAC,oBAAoB,EAAE,YAAY,EAAC,CAAC;AAC9C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,WAAW,GAAG,CAAC,EAAE,EAAE;IAC3D,MAAM,kBAAkB,GAAG,GAAW,EAAE,CAAC,CAAC;QACxC,WAAW,EAAE,EAAE;QACf,QAAQ,EAAE,EAAE;QACZ,OAAO,EAAE,EAAE;QACX,iBAAiB,EAAE,EAAE;QACrB,cAAc,EAAE,EAAE;QAClB,wBAAwB,EAAE,EAAE;QAC5B,KAAK,EAAE,EAAE;QACT,cAAc,EAAE,KAAK;QACrB,gBAAgB,EAAE,KAAK;QACvB,WAAW,EAAE,KAAK;QAClB,gBAAgB,EAAE,KAAK;QACvB,YAAY,EAAE,CAAC;QACf,YAAY,EAAE,EAAE;QAChB,sBAAsB,EAAE,EAAE;QAC1B,WAAW,EAAE,IAAI;QACjB,GAAG,EAAE,EAAC,OAAO,EAAE,EAAE,EAAC;QAClB,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,EAAE;QACb,OAAO,EAAE,IAAI;QACb,iBAAiB,EAAE,EAAE;QACrB,KAAK,EAAE,eAAe,IAAI,CAAC,MAAM,EAAE,EAAE;QACrC,eAAe,EAAE,EAAE;QACnB,QAAQ,EAAE,UAAU,EAAE;QACtB,GAAG,EAAE,EAAE;KACR,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,EAAC,MAAM,EAAE,WAAW,EAAC,EAAE,kBAAkB,CAAC,CAAC;IAE1E,SAAS,mBAAmB;QAC1B,OAAO,CACL,4BAAgB,aAAa,YAC1B,WAAW,CAAC,GAAG,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,CACnC,4BAAsC,aAAa,YAChD,MAAM,CAAC,KAAK,IADN,MAAM,CAAC,QAAQ,CAEnB,CACN,CAAC,GACC,CACN,CAAC;IACJ,CAAC;IAED,OAAO,EAAC,mBAAmB,EAAE,WAAW,EAAC,CAAC;AAC5C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,MAAc,EACd,OAAO,GAAG,cAAc,EACxB,EAAE;IACF,SAAS,aAAa;QACpB,OAAO,6BAAkB,MAAM,YAAG,OAAO,GAAO,CAAC;IACnD,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC"}

package/dist/__tests__/mock-navigator-context-provider.d.ts

@@ -0,0 +1,2 @@
+import type { NavigatorContextProvider } from '@coveo/headless/ssr';
+export declare const createMockNavigatorContextProvider: () => NavigatorContextProvider;

package/dist/__tests__/mock-navigator-context-provider.js

@@ -0,0 +1,7 @@
+export const createMockNavigatorContextProvider = () => () => ({
+    clientId: 'test-commerce-client',
+    location: 'https://commerce.test.com',
+    referrer: 'https://search.test.com',
+    userAgent: 'Test Commerce Agent',
+});
+//# sourceMappingURL=mock-navigator-context-provider.js.map

package/dist/__tests__/mock-navigator-context-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-navigator-context-provider.js","sourceRoot":"","sources":["../../src/__tests__/mock-navigator-context-provider.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,kCAAkC,GAC7C,GAA6B,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;IACrC,QAAQ,EAAE,sBAAsB;IAChC,QAAQ,EAAE,2BAA2B;IACrC,QAAQ,EAAE,yBAAyB;IACnC,SAAS,EAAE,qBAAqB;CACjC,CAAC,CAAC"}

package/dist/__tests__/mock-products.d.ts

@@ -0,0 +1,2 @@
+import type { Product } from '@coveo/headless/ssr-commerce';
+export declare const generateMockProducts: (count: number) => Product[];

package/dist/__tests__/mock-products.js

@@ -0,0 +1,31 @@
+import { randomUUID } from 'node:crypto';
+const createMockProduct = (overrides = {}) => ({
+    additionalFields: {},
+    children: [],
+    clickUri: '',
+    ec_brand: 'Test Brand',
+    ec_category: ['Test Category'],
+    ec_color: 'Test Color',
+    ec_description: 'Test Description',
+    ec_gender: 'Test Gender',
+    ec_images: [],
+    ec_in_stock: true,
+    ec_item_group_id: 'test-group',
+    ec_listing: 'test-listing',
+    ec_name: 'Test Product',
+    ec_price: 99.99,
+    ec_product_id: randomUUID(),
+    ec_promo_price: 79.99,
+    ec_rating: 4.5,
+    ec_shortdesc: 'Test short description',
+    ec_thumbnails: [],
+    permanentid: randomUUID(),
+    position: 1,
+    totalNumberOfChildren: 0,
+    ...overrides,
+});
+export const generateMockProducts = (count) => Array.from({ length: count }, (_, index) => createMockProduct({
+    ec_name: `Product ${index + 1}`,
+    position: index + 1,
+}));
+//# sourceMappingURL=mock-products.js.map

package/dist/__tests__/mock-products.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-products.js","sourceRoot":"","sources":["../../src/__tests__/mock-products.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC;AAGvC,MAAM,iBAAiB,GAAG,CAAC,YAA8B,EAAE,EAAW,EAAE,CAAC,CAAC;IACxE,gBAAgB,EAAE,EAAE;IACpB,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,YAAY;IACtB,WAAW,EAAE,CAAC,eAAe,CAAC;IAC9B,QAAQ,EAAE,YAAY;IACtB,cAAc,EAAE,kBAAkB;IAClC,SAAS,EAAE,aAAa;IACxB,SAAS,EAAE,EAAE;IACb,WAAW,EAAE,IAAI;IACjB,gBAAgB,EAAE,YAAY;IAC9B,UAAU,EAAE,cAAc;IAC1B,OAAO,EAAE,cAAc;IACvB,QAAQ,EAAE,KAAK;IACf,aAAa,EAAE,UAAU,EAAE;IAC3B,cAAc,EAAE,KAAK;IACrB,SAAS,EAAE,GAAG;IACd,YAAY,EAAE,wBAAwB;IACtC,aAAa,EAAE,EAAE;IACjB,WAAW,EAAE,UAAU,EAAE;IACzB,QAAQ,EAAE,CAAC;IACX,qBAAqB,EAAE,CAAC;IACxB,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAa,EAAa,EAAE,CAC/D,KAAK,CAAC,IAAI,CAAC,EAAC,MAAM,EAAE,KAAK,EAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CACvC,iBAAiB,CAAC;IAChB,OAAO,EAAE,WAAW,KAAK,GAAG,CAAC,EAAE;IAC/B,QAAQ,EAAE,KAAK,GAAG,CAAC;CACpB,CAAC,CACH,CAAC"}

package/dist/__tests__/mock-ssr-controller-definitions.d.ts

@@ -0,0 +1,19 @@
+import type { Controller } from '@coveo/headless';
+type SolutionTypeAvailabilities = {
+    listing?: boolean;
+    search?: boolean;
+    standalone?: boolean;
+    recommendation?: boolean;
+};
+export declare function buildMockController(): Controller;
+export declare function defineMockCommerceController(options?: SolutionTypeAvailabilities): {
+    build: import("vitest").Mock<(_engine: any) => Controller>;
+    listing: boolean;
+    search: boolean;
+    standalone: boolean;
+    recommendation: boolean;
+};
+export declare function defineMockSearchController(): {
+    build: import("vitest").Mock<(_engine: any) => Controller>;
+};
+export {};

package/dist/__tests__/mock-ssr-controller-definitions.js

@@ -0,0 +1,26 @@
+import { vi } from 'vitest';
+export function buildMockController() {
+    return {
+        subscribe: vi.fn(() => vi.fn()),
+        state: {},
+    };
+}
+export function defineMockCommerceController(options) {
+    return {
+        build: vi.fn((_engine) => {
+            return buildMockController();
+        }),
+        listing: options?.listing ?? true,
+        search: options?.search ?? true,
+        standalone: options?.standalone ?? true,
+        recommendation: options?.recommendation ?? true,
+    };
+}
+export function defineMockSearchController() {
+    return {
+        build: vi.fn((_engine) => {
+            return buildMockController();
+        }),
+    };
+}
+//# sourceMappingURL=mock-ssr-controller-definitions.js.map

package/dist/__tests__/mock-ssr-controller-definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-ssr-controller-definitions.js","sourceRoot":"","sources":["../../src/__tests__/mock-ssr-controller-definitions.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,EAAE,EAAC,MAAM,QAAQ,CAAC;AAS1B,MAAM,UAAU,mBAAmB;IACjC,OAAO;QACL,SAAS,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/B,KAAK,EAAE,EAAE;KACI,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,4BAA4B,CAC1C,OAAoC;IAEpC,OAAO;QACL,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE;YACvB,OAAO,mBAAmB,EAAE,CAAC;QAC/B,CAAC,CAAC;QACF,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,IAAI;QACjC,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,IAAI;QAC/B,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,IAAI;QACvC,cAAc,EAAE,OAAO,EAAE,cAAc,IAAI,IAAI;KAChD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B;IACxC,OAAO;QACL,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE;YACvB,OAAO,mBAAmB,EAAE,CAAC;QAC/B,CAAC,CAAC;KACH,CAAC;AACJ,CAAC"}

package/dist/__tests__/mock-ssr-engine.d.ts

@@ -0,0 +1,4 @@
+import type { SearchEngine } from '@coveo/headless/ssr';
+import type { CommerceEngine } from '@coveo/headless/ssr-commerce';
+export declare const createMockCommerceEngine: () => CommerceEngine;
+export declare const createMockSearchEngine: () => SearchEngine;

package/dist/__tests__/mock-ssr-engine.js

@@ -0,0 +1,12 @@
+import { vi } from 'vitest';
+export const createMockCommerceEngine = () => ({
+    state: {},
+    subscribe: vi.fn(() => vi.fn()), // Returns unsubscribe function
+    dispatch: vi.fn(),
+});
+export const createMockSearchEngine = () => ({
+    state: {},
+    subscribe: vi.fn(() => vi.fn()), // Returns unsubscribe function
+    dispatch: vi.fn(),
+});
+//# sourceMappingURL=mock-ssr-engine.js.map

package/dist/__tests__/mock-ssr-engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-ssr-engine.js","sourceRoot":"","sources":["../../src/__tests__/mock-ssr-engine.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,EAAE,EAAC,MAAM,QAAQ,CAAC;AAE1B,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,EAAE,CAC3C,CAAC;IACC,KAAK,EAAE,EAAE;IACT,SAAS,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,+BAA+B;IAChE,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;CAClB,CAA8B,CAAC;AAElC,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,EAAE,CACzC,CAAC;IACC,KAAK,EAAE,EAAE;IACT,SAAS,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,+BAA+B;IAChE,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;CAClB,CAA4B,CAAC"}

package/dist/__tests__/setup.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/setup.js

@@ -0,0 +1,9 @@
+import { cleanup } from '@testing-library/react';
+import { afterEach, beforeEach, vi } from 'vitest';
+beforeEach(() => {
+    vi.clearAllMocks();
+});
+afterEach(() => {
+    cleanup();
+});
+//# sourceMappingURL=setup.js.map

package/dist/__tests__/setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.js","sourceRoot":"","sources":["../../src/__tests__/setup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,wBAAwB,CAAC;AAC/C,OAAO,EAAC,SAAS,EAAE,UAAU,EAAE,EAAE,EAAC,MAAM,QAAQ,CAAC;AAEjD,UAAU,CAAC,GAAG,EAAE;IACd,EAAE,CAAC,aAAa,EAAE,CAAC;AACrB,CAAC,CAAC,CAAC;AAEH,SAAS,CAAC,GAAG,EAAE;IACb,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC,CAAC"}

package/dist/__tests__/test-utils.d.ts

@@ -0,0 +1,10 @@
+import { type RenderResult } from '@testing-library/react';
+import type { ReactElement } from 'react';
+interface ProviderWrapperOptions {
+    controllers?: unknown;
+    engine?: unknown;
+    provider?: React.ComponentType<any>;
+}
+export declare function renderWithProvider(ui: ReactElement, options?: ProviderWrapperOptions): RenderResult;
+export declare const waitForAsyncUpdates: () => Promise<void>;
+export {};

package/dist/__tests__/test-utils.js

@@ -0,0 +1,19 @@
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+import { render } from '@testing-library/react';
+export function renderWithProvider(ui, options) {
+    return render(ui, {
+        wrapper: createProviderWrapper(options),
+    });
+}
+export const waitForAsyncUpdates = async () => {
+    // Wait for React to flush all pending updates
+    await new Promise((resolve) => setTimeout(resolve, 0));
+    // Wait for microtasks
+    await new Promise((resolve) => queueMicrotask(resolve));
+};
+function createProviderWrapper(options) {
+    return function ProviderWrapper({ children }) {
+        return options?.provider ? (_jsx(options.provider, { controllers: options?.controllers, engine: options?.engine, children: children })) : (_jsxs(_Fragment, { children: [" ", children, " "] }));
+    };
+}
+//# sourceMappingURL=test-utils.js.map

package/dist/__tests__/test-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils.js","sourceRoot":"","sources":["../../src/__tests__/test-utils.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAoB,MAAM,EAAC,MAAM,wBAAwB,CAAC;AAUjE,MAAM,UAAU,kBAAkB,CAChC,EAAgB,EAChB,OAAgC;IAEhC,OAAO,MAAM,CAAC,EAAE,EAAE;QAChB,OAAO,EAAE,qBAAqB,CAAC,OAAO,CAAC;KACxC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,IAAI,EAAE;IAC5C,8CAA8C;IAC9C,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IACvD,sBAAsB;IACtB,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;AAChE,CAAC,CAAC;AAEF,SAAS,qBAAqB,CAAC,OAAgC;IAC7D,OAAO,SAAS,eAAe,CAAC,EAAC,QAAQ,EAAoB;QAC3D,OAAO,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CACzB,KAAC,OAAO,CAAC,QAAQ,IACf,WAAW,EAAE,OAAO,EAAE,WAAW,EACjC,MAAM,EAAE,OAAO,EAAE,MAAM,YAEtB,QAAQ,GACQ,CACpB,CAAC,CAAC,CAAC,CACF,mCAAI,QAAQ,SAAK,CAClB,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/headless-react",
-  "version": "2.5.7-pre.fd645afb40",
+  "version": "2.5.7",
   "description": "React utilities for SSR (Server Side Rendering) with headless",
   "homepage": "https://docs.coveo.com/en/headless/latest/",
   "repository": {
@@ -41,7 +41,7 @@
     "serve:typedoc": "live-server ./docs"
   },
   "dependencies": {
-    "@coveo/headless": "3.29.2-pre.fd645afb40"
+    "@coveo/headless": "3.29.2"
   },
   "devDependencies": {
     "@testing-library/react": "16.3.0",