@coveo/quantic 3.36.6 → 3.36.8

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce-next.index.d.ts

@@ -158,6 +158,8 @@ export * from './features/commerce/triggers/triggers-actions-loader.js';
 export { buildResultTemplatesManager } from './features/result-templates/result-templates-manager.js';
 export { getCommerceApiBaseUrl } from './api/commerce/commerce-api-client.js';
 export type { BaseProduct, ChildProduct, Product, } from './api/commerce/common/product.js';
+export type { Result, SpotlightContent, } from './api/commerce/common/result.js';
+export { ResultType } from './api/commerce/common/result.js';
 export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint, } from './api/platform-client.js';
 export type { RelativeDate, RelativeDatePeriod, RelativeDateUnit, } from './api/search/date/relative-date.js';
 export { deserializeRelativeDate, validateRelativeDate, } from './api/search/date/relative-date.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce.index.d.ts

@@ -154,6 +154,7 @@ export * from './features/commerce/triggers/triggers-actions-loader.js';
 export { buildResultTemplatesManager } from './features/result-templates/result-templates-manager.js';
 export { getCommerceApiBaseUrl } from './api/commerce/commerce-api-client.js';
 export type { BaseProduct, ChildProduct, Product, } from './api/commerce/common/product.js';
+export type { Result, SpotlightContent, } from './api/commerce/common/result.js';
 export { ResultType } from './api/commerce/common/result.js';
 export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint, } from './api/platform-client.js';
 export type { RelativeDate, RelativeDatePeriod, RelativeDateUnit, } from './api/search/date/relative-date.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/product-list/headless-product-list.ssr.d.ts

@@ -2,12 +2,24 @@ import { type ProductListing, type ProductListingState } from '../../../../contr
 import { type Search } from '../../../../controllers/commerce/search/headless-search.js';
 import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { Search, ProductListing, ProductListingState as ProductListState };
-export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'promoteChildToParent'>;
+export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'interactiveSpotlightContent' | 'promoteChildToParent'>;
 export type ProductListDefinition = SearchAndListingControllerDefinitionWithoutProps<ProductList>;
+/**
+ * Options for configuring the `ProductList` controller.
+ */
+interface ProductListOptions {
+    /**
+     * When set to true, fills the `results` field rather than the `products` field
+     * in the response. It may also include Spotlight Content in the results.
+     * @default false
+     */
+    enableResults?: boolean;
+}
 /**
  * Defines a `ProductList` controller instance.
  * @group Definers
  *
+ * @param options - The configurable `ProductList` controller options.
  * @returns The `ProductList` controller definition.
  */
-export declare function defineProductList(): ProductListDefinition;
+export declare function defineProductList(options?: ProductListOptions): ProductListDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/triggers/headless-query-trigger.ssr.d.ts

@@ -1,3 +1,4 @@
+import { type QueryTriggerOptions } from '../../../../controllers/commerce/triggers/headless-query-trigger.js';
 import type { QueryTrigger } from '../../../../controllers/core/triggers/headless-core-query-trigger.js';
 import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { QueryTriggerState } from '../../../../controllers/core/triggers/headless-core-query-trigger.js';
@@ -6,7 +7,7 @@ export type QueryTriggerDefinition = SearchOnlyControllerDefinitionWithoutProps<
 /**
  * Defines the `QueryTrigger` controller for the purpose of server-side rendering.
  * @group Definers
- *
+ * @param options - The configurable `QueryTrigger` controller options.
  * @returns The `QueryTrigger` controller definition.
  */
-export declare function defineQueryTrigger(): QueryTriggerDefinition;
+export declare function defineQueryTrigger(options?: QueryTriggerOptions): QueryTriggerDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/recommendation-static-state-factory.d.ts

@@ -5,7 +5,7 @@ import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions,
 export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (params: FetchStaticStateParameters<TControllerDefinitions, SolutionType.recommendation>) => Promise<import("../types/build.js").CommonBuildConfig & {
     productId?: string;
     recommendations: Extract<keyof TControllerDefinitions, { [K in keyof TControllerDefinitions]: import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], SolutionType.recommendation> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? never : K; }[keyof TControllerDefinitions]>[];
-} & { [K_1 in keyof TControllerDefinitions as import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K_1], SolutionType.recommendation> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K_1], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? import("../../common/types/utilities.js").HasRequiredKeys<import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T as I extends K_1 ? I : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions>[I]; } : never> extends false ? never : "controllers" : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T_1 extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T_1 as I extends K_1 ? I : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions>[I]; } : never; } & {
+} & { [K_1 in keyof TControllerDefinitions as import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K_1], SolutionType.recommendation> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K_1], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? import("../../common/types/utilities.js").HasRequiredKeys<import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T as I extends K_1 ? I : never]: T[I]; } : never> extends false ? never : "controllers" : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T_1 extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T_1 as I extends K_1 ? I : never]: T_1[I]; } : never; } & {
     controllers: import("../types/controller-inference.js").InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, SolutionType.recommendation> & import("../types/controller-definitions.js").FilteredBakedInControllers<SolutionType.recommendation>;
     searchActions: UnknownAction[];
 }>;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/static-state-factory.d.ts

@@ -4,7 +4,7 @@ import type { AugmentedControllerDefinition } from '../types/controller-definiti
 import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, FetchStaticStateParameters } from '../types/engine.js';
 export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (params: FetchStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<Omit<{
     controllers?: Record<string, unknown>;
-} & import("../types/build.js").BuildConfig<TControllerDefinitions, TSolutionType> & { [K in keyof TControllerDefinitions as import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], TSolutionType> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? import("../../common/types/utilities.js").HasRequiredKeys<import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T as I extends K ? I : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions>[I]; } : never> extends false ? never : "controllers" : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T_1 extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T_1 as I extends K ? I : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions>[I]; } : never; }, "controllers"> & {
+} & import("../types/build.js").BuildConfig<TControllerDefinitions, TSolutionType> & { [K in keyof TControllerDefinitions as import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], TSolutionType> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? import("../../common/types/utilities.js").HasRequiredKeys<import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T as I extends K ? I : never]: T[I]; } : never> extends false ? never : "controllers" : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T_1 extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T_1 as I extends K ? I : never]: T_1[I]; } : never; }, "controllers"> & {
     controllerProps?: Record<string, unknown> | undefined;
     controllers: import("../types/controller-inference.js").InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, TSolutionType> & import("../types/controller-definitions.js").FilteredBakedInControllers<TSolutionType>;
     searchActions: UnknownAction[];

package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-controller.d.ts

@@ -1,9 +1,10 @@
 import type { CoreEngine, CoreEngineNext } from '../app/engine.js';
 import type { Controller } from '../controllers/controller/headless-controller.js';
 import type { SSRCommerceEngine } from '../ssr/commerce/factories/build-factory.js';
+export { buildMockProductListingController } from './mock-product-listing-controller.js';
+export { buildMockSearchController } from './mock-search-controller.js';
 interface MockController {
     initialState?: Record<string, unknown>;
 }
 export declare function buildMockController(): Controller;
 export declare function buildMockControllerWithInitialState(_engine: CoreEngine | CoreEngineNext | SSRCommerceEngine, props: MockController): Controller;
-export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-product-listing-controller.d.ts

@@ -0,0 +1,2 @@
+import type { ProductListing } from '../controllers/commerce/product-listing/headless-product-listing.js';
+export declare function buildMockProductListingController(): ProductListing;

package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-search-controller.d.ts

@@ -0,0 +1,2 @@
+import type { Search } from '../controllers/commerce/search/headless-search.js';
+export declare function buildMockSearchController(): Search;

package/force-app/main/default/staticresources/coveoheadless/definitions/utils/facet-utils.d.ts

@@ -8,5 +8,5 @@ export declare function sortFacets<T extends {
     facetId: string;
 }>(facets: T[], sortOrder: string[]): T[];
 export declare const sortCriteriaMap: Record<string, SortCriteria>;
-export declare function getFacets(state: StateNeededBySearchRequest): (import("../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[];
+export declare function getFacets(state: StateNeededBySearchRequest): (import("../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[];
 export {};