@coveo/quantic 3.36.7 → 3.36.9

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

@@ -1,6 +1,6 @@
 import { type InstantProducts, type InstantProductsOptions, type InstantProductsProps, type InstantProductsState } from '../../../../controllers/commerce/instant-products/headless-instant-products.js';
 import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { InstantProductsOptions, InstantProductsState, InstantProducts, InstantProductsProps, };
+export type { InstantProducts, InstantProductsOptions, InstantProductsProps, InstantProductsState, };
 export type InstantProductsDefinition = NonRecommendationControllerDefinitionWithoutProps<InstantProducts>;
 /**
  * Defines the `InstantProducts` controller for the purpose of server-side rendering.

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

@@ -1,6 +1,6 @@
 import type { CorePaginationOptions, Pagination, PaginationOptions, PaginationProps, PaginationState } from '../../../../controllers/commerce/core/pagination/headless-core-commerce-pagination.js';
 import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { Pagination, PaginationProps, PaginationState, PaginationOptions, CorePaginationOptions, };
+export type { CorePaginationOptions, Pagination, PaginationOptions, PaginationProps, PaginationState, };
 export type PaginationDefinition = SearchAndListingControllerDefinitionWithoutProps<Pagination>;
 /**
  * Defines a `Pagination` controller instance.

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.d.ts

@@ -3,7 +3,7 @@ import type { Parameters } from '../../../../features/commerce/parameters/parame
 import type { ProductListingParameters } from '../../../../features/commerce/product-listing-parameters/product-listing-parameters-actions.js';
 import type { CommerceSearchParameters } from '../../../../features/commerce/search-parameters/search-parameters-actions.js';
 import type { SearchAndListingControllerDefinitionWithProps } from '../../types/controller-definitions.js';
-export type { ParameterManager, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, CommerceSearchParameters, };
+export type { CommerceSearchParameters, ParameterManager, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, };
 export type ParameterManagerDefinition = SearchAndListingControllerDefinitionWithProps<ParameterManager<ProductListingParameters | CommerceSearchParameters>, SSRParameterManagerProps<ProductListingParameters | CommerceSearchParameters>>;
 /**
  * Defines a `ParameterManager` controller instance.

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

@@ -1,6 +1,6 @@
 import { type ProductEnrichment, type ProductEnrichmentProps, type ProductEnrichmentState } from '../../../../controllers/commerce/product-enrichment/headless-product-enrichment.js';
 import type { StandaloneControllerWithProps } from '../../types/controller-definitions.js';
-export type { ProductEnrichmentState, ProductEnrichment, ProductEnrichmentProps };
+export type { ProductEnrichment, ProductEnrichmentProps, ProductEnrichmentState };
 export interface ProductEnrichmentDefinition extends StandaloneControllerWithProps<ProductEnrichment, ProductEnrichmentProps> {
 }
 /**

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

@@ -1,13 +1,25 @@
 import { type ProductListing, type ProductListingState } from '../../../../controllers/commerce/product-listing/headless-product-listing.js';
 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 { ProductListing, ProductListingState as ProductListState, Search };
+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/recent-queries-list/headless-recent-queries-list.ssr.d.ts

@@ -1,6 +1,6 @@
 import { type RecentQueriesList, type RecentQueriesListInitialState, type RecentQueriesListOptions, type RecentQueriesListProps, type RecentQueriesState } from '../../../../controllers/commerce/recent-queries-list/headless-recent-queries-list.js';
 import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesState, RecentQueriesList, RecentQueriesListProps, };
+export type { RecentQueriesList, RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesListProps, RecentQueriesState, };
 export type RecentQueriesListDefinition = NonRecommendationControllerDefinitionWithoutProps<RecentQueriesList>;
 /**
  * Defines the `RecentQueriesList` controller for the purpose of server-side rendering.

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

@@ -1,6 +1,6 @@
 import { type CoreSearchBox, type SearchBox, type SearchBoxOptions, type SearchBoxProps, type SearchBoxState, type Suggestion } from '../../../../controllers/commerce/search-box/headless-search-box.js';
 import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { CoreSearchBox, SearchBox, SearchBoxProps, SearchBoxState, SearchBoxOptions, Suggestion, };
+export type { CoreSearchBox, SearchBox, SearchBoxOptions, SearchBoxProps, SearchBoxState, Suggestion, };
 export type SearchBoxDefinition = SearchOnlyControllerDefinitionWithoutProps<SearchBox>;
 /**
  * Defines a `SearchBox` controller instance.

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.d.ts

@@ -1,7 +1,7 @@
 import { type StandaloneSearchBox, type StandaloneSearchBoxState } from '../../../../controllers/commerce/standalone-search-box/headless-standalone-search-box.js';
 import type { StandaloneSearchBoxProps } from '../../../../controllers/standalone-search-box/headless-standalone-search-box.js';
 import type { ListingAndStandaloneControllerWithoutProps } from '../../types/controller-definitions.js';
-export type { StandaloneSearchBoxState, StandaloneSearchBox, StandaloneSearchBoxProps, };
+export type { StandaloneSearchBox, StandaloneSearchBoxProps, StandaloneSearchBoxState, };
 export type StandaloneSearchBoxDefinition = ListingAndStandaloneControllerWithoutProps<StandaloneSearchBox>;
 /**
  * Defines the `StandaloneSearchBox` controller for the purpose of server-side rendering.

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

@@ -3,7 +3,7 @@ import type { ProductListingSummaryState } from '../../../../controllers/commerc
 import type { RecommendationsSummaryState } from '../../../../controllers/commerce/recommendations/summary/headless-recommendations-summary.js';
 import type { SearchSummaryState } from '../../../../controllers/commerce/search/summary/headless-search-summary.js';
 import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { Summary, ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, SummaryState, };
+export type { ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, Summary, SummaryState, };
 export type SummaryDefinition = SearchAndListingControllerDefinitionWithoutProps<Summary<ProductListingSummaryState | SearchSummaryState | RecommendationsSummaryState>>;
 /**
  * Defines a `Summary` controller instance.

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/ssr-next/commerce/types/controller-inference.d.ts

@@ -3,7 +3,7 @@ import type { InferHydratedState, InferStaticState } from '../../common/types/en
 import type { HasKey, HasKeys } from '../../common/types/utilities.js';
 import type { SolutionType } from './controller-constants.js';
 import type { ControllerDefinition, ControllerDefinitionsMap, ControllerDefinitionWithoutProps, ControllerDefinitionWithProps, InferControllerStaticStateFromController } from './controller-definitions.js';
-export type { InferStaticState, InferHydratedState };
+export type { InferHydratedState, InferStaticState };
 type InferControllerPropsFromDefinition<TController extends ControllerDefinition<Controller>> = TController extends ControllerDefinitionWithProps<Controller, infer Props> ? Props : TController extends ControllerDefinitionWithoutProps<Controller> ? {} : unknown;
 export type InferControllerPropsMapFromDefinitions<TControllers extends ControllerDefinitionsMap<Controller>> = {
     [K in keyof TControllers as HasKeys<InferControllerPropsFromDefinition<TControllers[K]>> extends false ? never : K]: InferControllerPropsFromDefinition<TControllers[K]>;

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

@@ -9,7 +9,7 @@ import type { BakedInControllers, ControllerDefinitionsMap } from './controller-
 import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition } from './controller-inference.js';
 import type { FetchStaticState } from './fetch-static-state.js';
 import type { HydrateStaticState, HydrateStaticStateOptions } from './hydrate-static-state.js';
-export type { HydrateStaticState, HydrateStaticStateOptions, FetchStaticState, EngineStaticState, };
+export type { EngineStaticState, FetchStaticState, HydrateStaticState, HydrateStaticStateOptions, };
 type ReservedControllerNames = 'context' | 'parameterManager' | 'cart';
 type ValidateControllerNames<T extends ControllerDefinitionsMap<Controller>> = {
     [K in keyof T]: K extends ReservedControllerNames ? `ERROR: Controller name "${K & string}" is reserved and cannot be used. Reserved names are: context, parameterManager, cart. Please choose a different controller name.` : T[K];

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/types/controller-definition.d.ts

@@ -3,7 +3,7 @@ import type { Controller } from '../../../controllers/controller/headless-contro
 import type { InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers } from '../../common/types/controller-inference.js';
 import type { InferHydratedState, InferStaticState } from '../../common/types/engine.js';
 import type { SearchParameterManagerDefinition } from '../controllers/search-parameter-manager/headless-search-parameter-manager.ssr.js';
-export type { InferStaticState, InferHydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
+export type { InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, InferHydratedState, InferStaticState, };
 export interface ControllerDefinitionWithoutProps<TEngine extends CoreEngine | CoreEngineNext, TController extends Controller> {
     /**
      * Creates an instance of the given controller.

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 {};

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

@@ -10,7 +10,7 @@ import { type NumericRangeFieldExpression } from './numeric-range-field/numeric-
 import { type QueryExtensionExpression } from './query-extension/query-extension.js';
 import { type StringFacetFieldExpression } from './string-facet-field/string-facet-field.js';
 import { type StringFieldExpression } from './string-field/string-field.js';
-export type { KeywordExpression, NearExpression, OtherTerm, ExactMatchExpression, FieldExistsExpression, StringFieldExpression, StringFacetFieldExpression, NumericFieldExpression, NumericRangeFieldExpression, DateFieldExpression, DateRangeFieldExpression, QueryExtensionExpression, Negatable, };
+export type { DateFieldExpression, DateRangeFieldExpression, ExactMatchExpression, FieldExistsExpression, KeywordExpression, NearExpression, Negatable, NumericFieldExpression, NumericRangeFieldExpression, OtherTerm, QueryExtensionExpression, StringFacetFieldExpression, StringFieldExpression, };
 /**
  * A utility to help build query expressions.
  */