@coveo/quantic 3.11.0 → 3.12.0

package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/instant-result-analytics.d.ts

@@ -6,7 +6,7 @@ export declare class InstantResultsAnalyticsProvider extends SearchAnalyticsProv
     constructor(getState: () => StateNeededByInstantResultsAnalyticsProvider);
     private get activeInstantResultQuery();
     private get activeInstantResultCache();
-    protected get results(): import("../../case-assist.index.js").Result[] | undefined;
+    protected get results(): import("../../ssr.index.js").Result[] | undefined;
     protected get queryText(): string;
     protected get responseTime(): number;
     protected get numberOfResults(): number;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/search-analytics.d.ts

@@ -85,7 +85,7 @@ export declare class SearchAnalyticsProvider extends BaseAnalyticsProvider<State
     };
     getGeneratedAnswerMetadata(): Record<string, string | boolean>;
     private get resultURIs();
-    protected get results(): import("../../case-assist.index.js").Result[] | undefined;
+    protected get results(): import("../../ssr.index.js").Result[] | undefined;
     protected get queryText(): string;
     protected get responseTime(): number;
     protected get numberOfResults(): number;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts

@@ -24,4 +24,4 @@ export declare const buildRequest: (req: CommerceAPIRequest, path: CommerceApiMe
     origin: import("../../preprocess-request.js").PlatformClientOrigin;
     requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
 };
-export declare const baseRequest: (req: BaseParam, path: CommerceApiMethod) => Pick<PlatformClientCallOptions, 'accessToken' | 'method' | 'contentType' | 'url' | 'origin' | 'requestMetadata'>;
+export declare const baseRequest: (req: BaseParam, path: CommerceApiMethod) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin" | "requestMetadata">;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts

@@ -1,4 +1,5 @@
-import { UnknownAction } from '@reduxjs/toolkit';
+import { EventSourceMessage } from '@microsoft/fetch-event-source';
+import { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
 import { GeneratedContentFormat } from '../../features/generated-answer/generated-response-format.js';
 import { SearchAppState } from '../../state/search-app-state.js';
 import { ConfigurationSection, GeneratedAnswerSection, InsightConfigurationSection } from '../../state/state-sections.js';
@@ -22,6 +23,7 @@ export interface GeneratedAnswerStream {
         code: number;
     };
 }
+export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StateNeededByAnswerAPI, unknown, UnknownAction>) => void;
 export declare const answerApi: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, {
     getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<Partial<SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer">;
 }, "answer", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
@@ -58,7 +60,7 @@ export declare const selectAnswerTriggerParams: ((state: any, ...params: any[])
     argsMemoize: typeof import("reselect").weakMapMemoize;
     memoize: typeof import("reselect").weakMapMemoize;
 };
-export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI, usage: 'fetch' | 'select') => {
+export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI, usage: "fetch" | "select") => {
     tab: string;
     numberOfResults?: number | undefined;
     firstResult?: number | undefined;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/search-api-params.d.ts

@@ -127,6 +127,6 @@ export interface GenQAParameters {
 export interface ResponseFormatParameters {
     contentFormat?: GeneratedContentFormat[];
 }
-export declare const baseSearchRequest: (req: BaseParam & AuthenticationParam, method: HttpMethods, contentType: HTTPContentType, path: string) => Pick<PlatformClientCallOptions, 'accessToken' | 'method' | 'contentType' | 'url' | 'origin'>;
+export declare const baseSearchRequest: (req: BaseParam & AuthenticationParam, method: HttpMethods, contentType: HTTPContentType, path: string) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin">;
 export declare const getOrganizationIdQueryParam: (req: BaseParam) => string;
 export declare const getAuthenticationQueryParam: (req: AuthenticationParam) => string;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/case-assist-params.d.ts

@@ -22,6 +22,6 @@ export type CaseAssistParam = BaseParam & CaseAssistIdParam;
  * @param queryStringArguments - The arguments to pass in the query string.
  * @returns The built request information.
  */
-export declare const baseCaseAssistRequest: (req: CaseAssistParam, method: HttpMethods, contentType: HTTPContentType, path: string, queryStringArguments?: Record<string, string>) => Pick<PlatformClientCallOptions, 'accessToken' | 'method' | 'contentType' | 'url' | 'origin'>;
+export declare const baseCaseAssistRequest: (req: CaseAssistParam, method: HttpMethods, contentType: HTTPContentType, path: string, queryStringArguments?: Record<string, string>) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin">;
 export declare const prepareSuggestionRequestFields: (fields: CaseFields) => CaseFields;
 export declare const prepareContextFromFields: (fields: CaseFields) => Record<string, string | string[]>;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/insight-params.d.ts

@@ -7,6 +7,6 @@ export interface InsightIdParam {
 export type InsightParam = BaseParam & InsightIdParam;
 export declare const baseInsightUrl: (req: InsightParam, path?: string) => string;
 export declare const baseInsightUserActionsUrl: (req: InsightUserActionsRequest) => string;
-export declare const baseInsightRequest: (req: InsightParam, method: HttpMethods, contentType: HTTPContentType, path: string) => Pick<PlatformClientCallOptions, 'accessToken' | 'method' | 'contentType' | 'url' | 'origin'>;
-export declare const baseInsightUserActionRequest: (req: InsightUserActionsRequest, method: HttpMethods, contentType: HTTPContentType) => Pick<PlatformClientCallOptions, 'accessToken' | 'method' | 'contentType' | 'url' | 'origin'>;
+export declare const baseInsightRequest: (req: InsightParam, method: HttpMethods, contentType: HTTPContentType, path: string) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin">;
+export declare const baseInsightUserActionRequest: (req: InsightUserActionsRequest, method: HttpMethods, contentType: HTTPContentType) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin">;
 export declare const pickNonInsightParams: (req: InsightParam) => {};

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

@@ -13,6 +13,8 @@ export interface CommerceEngineDefinition<TControllers extends ControllerDefinit
  * @param options - The commerce engine definition
  * @returns Three utility functions to fetch the initial state of the engine in SSR, hydrate the state in CSR,
  *  and a build function that can be used for edge cases requiring more control.
+ *
+ * @group Engine
  */
 export declare function defineCommerceEngine<TControllerDefinitions extends ControllerDefinitionsMap<Controller>>(options: CommerceEngineDefinitionOptions<TControllerDefinitions>): {
     listingEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, SolutionType.listing>;

package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/factories/build-factory.d.ts

@@ -5,6 +5,8 @@ import { ControllerDefinitionsMap, SolutionType } from '../types/common.js';
 import { BuildParameters, CommerceControllerDefinitionsMap, EngineDefinitionOptions } from '../types/core-engine.js';
 /**
  * The SSR commerce engine.
+ *
+ * @group Engine
  */
 export interface SSRCommerceEngine extends CommerceEngine {
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/factories/utils/recommendation-filter.d.ts

@@ -0,0 +1,11 @@
+import { Controller } from '../../../../controllers/controller/headless-controller.js';
+import { ControllerDefinitionsMap } from '../../types/common.js';
+export declare function filterRecommendationControllers<TControllerDefinitions extends ControllerDefinitionsMap<Controller>>(controllers: Record<string, Controller>, controllerDefinitions: TControllerDefinitions): {
+    /**
+     * Go through all the controllers passed in argument and only refresh recommendation controllers.
+     *
+     * @param controllers - A record of all controllers where the key is the controller name and the value is the controller instance.
+     * @param controllerNames - A list of all recommendation controllers to refresh
+     */
+    refresh(whitelist?: string[]): void;
+};

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

@@ -3,6 +3,7 @@ import type { Controller } from '../../../controllers/controller/headless-contro
 import type { InvalidControllerDefinition } from '../../../utils/errors.js';
 import type { HasKey, InferControllerStaticStateMapFromControllers, InferControllerStaticStateFromController, ControllerStaticStateMap, EngineDefinitionBuildResult, HydratedState, OptionsTuple, ControllersPropsMap, HasKeys, HasRequiredKeys, HasOptionalKeys } from '../../ssr-engine/types/common.js';
 import { SSRCommerceEngine } from '../factories/build-factory.js';
+import { Kind } from './kind.js';
 export type { EngineDefinitionBuildResult, HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
 export declare enum SolutionType {
     search = "search",
@@ -30,6 +31,9 @@ export interface ControllerDefinitionWithoutProps<TController extends Controller
      */
     build(engine: SSRCommerceEngine, solutionType?: SolutionType): TController;
 }
+export interface ControllerWithKind extends Controller {
+    _kind: Kind;
+}
 export interface ControllerDefinitionWithProps<TController extends Controller, TProps> {
     /**
      * Creates an instance of the given controller.
@@ -39,13 +43,19 @@ export interface ControllerDefinitionWithProps<TController extends Controller, T
      * @param solutionType - The type of solution for which the controller should be built (e.g. search or listing). This option only applies to sub-controllers.
      * @returns The created controller instance.
      */
-    buildWithProps(engine: SSRCommerceEngine, props: TProps, solutionType?: SolutionType): TController;
+    buildWithProps(engine: SSRCommerceEngine, props: TProps, solutionType?: SolutionType): TController & ControllerWithKind;
 }
 export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
     searchActions: TSearchAction[];
     controllers: TControllers;
 }
-export type ControllerDefinition<TController extends Controller> = ControllerDefinitionWithoutProps<TController> | ControllerDefinitionWithProps<TController, unknown>;
+export interface SolutionTypeAvailability {
+    [SolutionType.search]?: boolean;
+    [SolutionType.listing]?: boolean;
+    [SolutionType.standalone]?: boolean;
+    [SolutionType.recommendation]?: boolean;
+}
+export type ControllerDefinition<TController extends Controller> = SolutionTypeAvailability & (ControllerDefinitionWithoutProps<TController> | ControllerDefinitionWithProps<TController, unknown>);
 export interface ControllerDefinitionsMap<TController extends Controller> {
     [customName: string]: ControllerDefinition<TController>;
 }

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

@@ -0,0 +1,9 @@
+export declare enum Kind {
+    Cart = "CART",
+    Context = "CONTEXT",
+    ParameterManager = "PARAMETER_MANAGER",
+    Recommendations = "RECOMMENDATIONS"
+}
+export declare function createControllerWithKind<TController, TKind extends Kind>(controller: TController, kind: TKind): TController & {
+    _kind: TKind;
+};

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

@@ -5,8 +5,6 @@ export interface StateWithHistory<State> {
     present?: State;
     future: State[];
 }
-declare const undo: <State>(state: StateWithHistory<State>) => StateWithHistory<State>;
-declare const redo: <State>(state: StateWithHistory<State>) => StateWithHistory<State>;
 export declare const undoable: <State>(options: {
     reducer: Reducer<State>;
     actionTypes: {
@@ -15,4 +13,3 @@ export declare const undoable: <State>(options: {
         snapshot: string;
     };
 }) => (state: StateWithHistory<State> | undefined, action: AnyAction) => StateWithHistory<State>;
-export {};

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

@@ -102,7 +102,7 @@ export type { InstantProducts, InstantProductsState, InstantProductsOptions, Ins
 export { buildStandaloneSearchBox } from './controllers/commerce/standalone-search-box/headless-standalone-search-box.js';
 export type { StandaloneSearchBox, StandaloneSearchBoxState, } from './controllers/commerce/standalone-search-box/headless-standalone-search-box.js';
 export type { StandaloneSearchBoxProps, StandaloneSearchBoxOptions, } from './controllers/standalone-search-box/headless-standalone-search-box.ts';
-export type { UrlManagerProps, UrlManagerInitialState, UrlManagerState, UrlManager, } from './controllers/commerce/core/url-manager/headless-core-url-manager.js';
+export type { BaseUrlManagerProps, UrlManagerProps, UrlManagerInitialState, UrlManagerState, UrlManager, } from './controllers/commerce/core/url-manager/headless-core-url-manager.js';
 export type { Template } from './features/templates/templates-manager.ts';
 export type { ProductTemplate, ProductTemplateCondition, ProductTemplatesManager, } from './features/commerce/product-templates/product-templates-manager.js';
 export { buildProductTemplatesManager } from './features/commerce/product-templates/product-templates-manager.js';

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

@@ -3,6 +3,7 @@ import { BreadcrumbManager, BreadcrumbManagerState } from './headless-core-bread
 export type { BreadcrumbManager, BreadcrumbManagerState };
 /**
  * Defines a `BreadcrumbManager` controller instance.
+ * @group Definers
  *
  * @returns The `BreadcrumbManager` controller definition.
  *

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/facets/generator/headless-commerce-facet-generator.ssr.d.ts

@@ -17,6 +17,9 @@ export type { FacetType };
 export type MappedFacetState = {
     [T in FacetType]: T extends 'numericalRange' ? NumericFacetState : T extends 'regular' ? RegularFacetState : T extends 'dateRange' ? DateFacetState : T extends 'hierarchical' ? CategoryFacetState : T extends 'location' ? LocationFacetState : never;
 };
+/**
+ * @group Definers
+ */
 export declare function defineFacetGenerator<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<FacetGenerator, TOptions>;
 /**
  * The `FacetGenerator` headless sub-controller creates commerce facet sub-controllers from the Commerce API search or

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

@@ -10,6 +10,13 @@ export interface ParameterManagerProps<T extends Parameters> {
      * The initial state that should be applied to the `ParameterManager` sub-controller.
      */
     initialState?: ParameterManagerInitialState<T>;
+    /**
+     * Whether the controller's state should exclude the default parameters returned by the Commerce API, and only include
+     * the parameters that were set explicitly set through dispatched actions.
+     *
+     * Defaults to `false`.
+     */
+    excludeDefaultParameters?: boolean;
 }
 export interface CoreParameterManagerProps<T extends Parameters> extends ParameterManagerProps<T> {
     /**
@@ -28,12 +35,6 @@ export interface CoreParameterManagerProps<T extends Parameters> extends Paramet
      * The action to dispatch to fetch more results.
      */
     fetchProductsActionCreator: FetchProductsActionCreator;
-    /**
-     * Enriches the parameters with the active parameters.
-     * @param state
-     * @param activeParams
-     */
-    enrichParameters(state: CommerceEngine[typeof stateKey], activeParams: T): Required<T>;
 }
 export interface ParameterManagerInitialState<T> {
     /**

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

@@ -12,7 +12,9 @@ export type { ParameterManager, ParameterManagerProps, ParameterManagerState, Pa
  *
  * @internal
  */
-export declare function defineParameterManager<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithProps<ParameterManager<Parameters | CommerceSearchParameters | MappedParameterTypes<TOptions>>, TOptions, ParameterManagerProps<Parameters | CommerceSearchParameters | MappedParameterTypes<TOptions>>>;
+export declare function defineParameterManager<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithProps<ParameterManager<MappedParameterTypes<TOptions>>, TOptions, SSRParameterManagerProps<MappedParameterTypes<TOptions>>>;
+export interface SSRParameterManagerProps<T extends Parameters> extends Omit<ParameterManagerProps<T>, 'excludeDefaultParameters'> {
+}
 type MappedParameterTypes<TOptions extends ControllerDefinitionOption | undefined> = TOptions extends {
     listing: true;
     search: true;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/sub-controller/headless-sub-controller.d.ts

@@ -68,7 +68,7 @@ export interface SearchAndListingSubControllers<P extends Parameters, S extends
      * @param props - Properties for the `ParameterManager` sub-controller.
      * @returns A `ParameterManager` sub-controller.
      */
-    parameterManager(props: ParameterManagerProps<P>): ParameterManager<P>;
+    parameterManager(props?: ParameterManagerProps<P>): ParameterManager<P>;
 }
 export interface SearchSubControllers extends SearchAndListingSubControllers<CommerceSearchParameters, SearchSummaryState> {
     /**
@@ -98,7 +98,6 @@ export interface SearchAndListingSubControllerProps<P extends Parameters, S exte
     parametersDefinition: SchemaDefinition<Required<P>>;
     activeParametersSelector: (state: CommerceEngine[typeof stateKey]) => P;
     restoreActionCreator: (parameters: P) => UnknownAction;
-    enrichParameters: (state: CommerceEngine[typeof stateKey], activeParams: P) => Required<P>;
     facetSearchType: FacetSearchType;
 }
 /**

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

@@ -3,4 +3,5 @@ import type { Summary } from '../../core/summary/headless-core-summary.js';
 import type { ProductListingSummaryState } from '../../product-listing/summary/headless-product-listing-summary.js';
 import { SearchSummaryState } from '../../search/summary/headless-search-summary.js';
 export type { ProductListingSummaryState, Summary };
-export declare function defineQuerySummary<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<Summary<ProductListingSummaryState & SearchSummaryState>, TOptions>;
+export declare function defineQuerySummary<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<Summary<ProductListingSummaryState & SearchSummaryState>, // TODO: fix conditional typing to return the appropriate type based on current solution type
+TOptions>;

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

@@ -2,9 +2,18 @@ import { CommerceEngine } from '../../../../app/commerce-engine/commerce-engine.
 import { stateKey } from '../../../../app/state-key.js';
 import { Parameters } from '../../../../features/commerce/parameters/parameters-actions.js';
 import { Serializer } from '../../../../features/commerce/parameters/parameters-serializer.js';
-import { UrlManager, UrlManagerInitialState, type UrlManagerProps, UrlManagerState } from '../../../url-manager/headless-url-manager.js';
+import { UrlManager, UrlManagerInitialState, type UrlManagerProps as BaseUrlManagerProps, UrlManagerState } from '../../../url-manager/headless-url-manager.js';
 import { ParameterManager, ParameterManagerProps } from '../parameter-manager/headless-core-parameter-manager.js';
-export type { UrlManagerProps, UrlManager, UrlManagerInitialState, UrlManagerState, };
+export type { UrlManager, UrlManagerInitialState, UrlManagerState, BaseUrlManagerProps, };
+export interface UrlManagerProps extends BaseUrlManagerProps {
+    /**
+     * Whether the controller's state should exclude the default parameters returned by the Commerce API, and only include
+     * the parameters that were set explicitly set through dispatched actions.
+     *
+     * Defaults to `false`.
+     */
+    excludeDefaultParameters?: boolean;
+}
 interface CoreUrlManagerProps<T extends Parameters> extends UrlManagerProps {
     requestIdSelector: (state: CommerceEngine[typeof stateKey]) => string;
     parameterManagerBuilder: (engine: CommerceEngine, props: ParameterManagerProps<T>) => ParameterManager<T>;

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

@@ -2,7 +2,7 @@ import { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from
 import { ProductListing } from '../product-listing/headless-product-listing.js';
 import { Search } from '../search/headless-search.js';
 export type { ProductListingState as ProductListState } from '../product-listing/headless-product-listing.js';
-export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct'>;
+export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'promoteChildToParent'>;
 /**
  * Defines a `ProductList` controller instance.
  * @group Definers

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

@@ -13,6 +13,7 @@ export interface ProductViewDefinition extends NonRecommendationControllerDefini
  * @returns The `ProductView` controller definition.
  *
  * @internal
+ * @group Definers
  */
 export declare function defineProductView(): ProductViewDefinition;
 export interface ProductView extends BaseProductView, Controller {

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/recommendations/headless-recommendations.d.ts

@@ -47,6 +47,7 @@ export interface RecommendationsState {
     error: CommerceAPIErrorStatusResponse | null;
     isLoading: boolean;
     responseId: string;
+    productId?: string;
 }
 export interface RecommendationsOptions {
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/example-deleteme-headless-case-context.d.ts

@@ -29,4 +29,4 @@ export interface CaseContextState extends CoreContextState {
     caseNumber: string;
 }
 export type CaseContextControllerState = CaseContext['state'];
-export declare const createCaseContext: (engine: CoreEngine<{}, import("../../../app/thunk-extra-arguments.js").ThunkExtraArguments, import("../../../features/configuration/configuration-state.js").CoreConfigurationState<import("../../../features/configuration/configuration-state.js").CoreAnalyticsState>>, props: ContextProps) => CaseContext, mixinCaseContext: <InputContext extends CoreContext>(engine: CoreEngine<{}, import("../../../app/thunk-extra-arguments.js").ThunkExtraArguments, import("../../../features/configuration/configuration-state.js").CoreConfigurationState<import("../../../features/configuration/configuration-state.js").CoreAnalyticsState>>, props: ContextProps, context: InputContext) => InputContext & CaseContext;
+export declare const createCaseContext: (engine: CoreEngine, props: ContextProps) => CaseContext, mixinCaseContext: <InputContext extends CoreContext>(engine: CoreEngine, props: ContextProps, context: InputContext) => InputContext & CaseContext;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/actions-history/ipx-actions-history-actions.d.ts

@@ -1,6 +1,6 @@
 export declare const addPageViewEntryInActionsHistory: import("@reduxjs/toolkit").AsyncThunk<void, string, {
     state?: unknown;
-    dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction> | undefined;
+    dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction>;
     extra?: unknown;
     rejectValue?: unknown;
     serializedErrorType?: unknown;

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

@@ -66,15 +66,15 @@ type InternalLegacyStateNeeded = StateNeededBySearchAnalyticsProvider | StateNee
 type LogFunction<Client, StateNeeded> = (client: Client, state: StateNeeded) => Promise<void | SearchEventResponse> | void | null;
 export declare const makeAnalyticsAction: {
     <LegacyStateNeeded extends StateNeededBySearchAnalyticsProvider = StateNeededBySearchAnalyticsProvider, ComputedLegacyAnalyticsOptions extends LegacyAnalyticsOptions<LegacyStateNeeded, CoveoSearchPageClient, SearchPageClientProvider> = LegacyAnalyticsOptions<LegacyStateNeeded, CoveoSearchPageClient, SearchPageClientProvider>>(prefix: string, __legacy__getBuilder: (client: CoveoSearchPageClient, state: StateNeededBySearchAnalyticsProvider) => Promise<EventBuilder | null> | null, __legacy__provider?: ComputedLegacyAnalyticsOptions["__legacy__provider"] | undefined): PreparableAnalyticsAction<LegacyStateNeeded>;
-    <LegacyStateNeeded_1 extends StateNeededBySearchAnalyticsProvider = StateNeededBySearchAnalyticsProvider, StateNeeded extends StateNeededBySearchAnalyticsProvider = StateNeededBySearchAnalyticsProvider, PayloadType = {}>({ prefix, __legacy__getBuilder, __legacy__provider, analyticsPayloadBuilder, analyticsType, }: AnalyticsActionOptions<LegacyStateNeeded_1, StateNeeded, (client: CoveoSearchPageClient, state: StateNeededBySearchAnalyticsProvider) => Promise<EventBuilder | null> | null, SearchPageClientProvider, CoveoSearchPageClient, PayloadType>): PreparableAnalyticsAction<StateNeeded>;
+    <LegacyStateNeeded extends StateNeededBySearchAnalyticsProvider = StateNeededBySearchAnalyticsProvider, StateNeeded extends StateNeededBySearchAnalyticsProvider = StateNeededBySearchAnalyticsProvider, PayloadType = {}>({ prefix, __legacy__getBuilder, __legacy__provider, analyticsPayloadBuilder, analyticsType, }: AnalyticsActionOptions<LegacyStateNeeded, StateNeeded, (client: CoveoSearchPageClient, state: StateNeededBySearchAnalyticsProvider) => Promise<EventBuilder | null> | null, SearchPageClientProvider, CoveoSearchPageClient, PayloadType>): PreparableAnalyticsAction<StateNeeded>;
 };
 export declare const makeCaseAssistAnalyticsAction: {
     <LegacyStateNeeded extends StateNeededByCaseAssistAnalytics = StateNeededByCaseAssistAnalytics, ComputedLegacyAnalyticsOptions extends LegacyAnalyticsOptions<LegacyStateNeeded, CaseAssistClient, CaseAssistAnalyticsProvider> = LegacyAnalyticsOptions<LegacyStateNeeded, CaseAssistClient, CaseAssistAnalyticsProvider>>(prefix: string, __legacy__getBuilder: LogFunction<CaseAssistClient, StateNeededByCaseAssistAnalytics>, __legacy__provider?: ComputedLegacyAnalyticsOptions["__legacy__provider"] | undefined): PreparableAnalyticsAction<LegacyStateNeeded>;
-    <LegacyStateNeeded_1 extends StateNeededByCaseAssistAnalytics = StateNeededByCaseAssistAnalytics, StateNeeded extends StateNeededByCaseAssistAnalytics = StateNeededByCaseAssistAnalytics, PayloadType = {}>({ prefix, __legacy__getBuilder, __legacy__provider, analyticsPayloadBuilder, analyticsType, }: AnalyticsActionOptions<LegacyStateNeeded_1, StateNeeded, LogFunction<CaseAssistClient, StateNeededByCaseAssistAnalytics>, CaseAssistAnalyticsProvider, CaseAssistClient, PayloadType>): PreparableAnalyticsAction<StateNeeded>;
+    <LegacyStateNeeded extends StateNeededByCaseAssistAnalytics = StateNeededByCaseAssistAnalytics, StateNeeded extends StateNeededByCaseAssistAnalytics = StateNeededByCaseAssistAnalytics, PayloadType = {}>({ prefix, __legacy__getBuilder, __legacy__provider, analyticsPayloadBuilder, analyticsType, }: AnalyticsActionOptions<LegacyStateNeeded, StateNeeded, LogFunction<CaseAssistClient, StateNeededByCaseAssistAnalytics>, CaseAssistAnalyticsProvider, CaseAssistClient, PayloadType>): PreparableAnalyticsAction<StateNeeded>;
 };
 export declare const makeInsightAnalyticsActionFactory: (actionCause: string) => {
     <LegacyStateNeeded extends StateNeededByInsightAnalyticsProvider = StateNeededByInsightAnalyticsProvider, ComputedLegacyAnalyticsOptions extends LegacyAnalyticsOptions<LegacyStateNeeded, CoveoInsightClient, InsightAnalyticsProvider> = LegacyAnalyticsOptions<LegacyStateNeeded, CoveoInsightClient, InsightAnalyticsProvider>>(prefix: string, __legacy__getBuilder: LogFunction<CoveoInsightClient, StateNeededByInsightAnalyticsProvider>, __legacy__provider?: ComputedLegacyAnalyticsOptions["__legacy__provider"] | undefined): PreparableAnalyticsAction<LegacyStateNeeded>;
-    <LegacyStateNeeded_1 extends StateNeededByInsightAnalyticsProvider = StateNeededByInsightAnalyticsProvider, StateNeeded extends StateNeededByInsightAnalyticsProvider = StateNeededByInsightAnalyticsProvider, PayloadType = {}>({ prefix, __legacy__getBuilder, __legacy__provider, analyticsPayloadBuilder, analyticsType, }: AnalyticsActionOptions<LegacyStateNeeded_1, StateNeeded, LogFunction<CoveoInsightClient, StateNeededByInsightAnalyticsProvider>, InsightAnalyticsProvider, CoveoInsightClient, PayloadType>): PreparableAnalyticsAction<StateNeeded>;
+    <LegacyStateNeeded extends StateNeededByInsightAnalyticsProvider = StateNeededByInsightAnalyticsProvider, StateNeeded extends StateNeededByInsightAnalyticsProvider = StateNeededByInsightAnalyticsProvider, PayloadType = {}>({ prefix, __legacy__getBuilder, __legacy__provider, analyticsPayloadBuilder, analyticsType, }: AnalyticsActionOptions<LegacyStateNeeded, StateNeeded, LogFunction<CoveoInsightClient, StateNeededByInsightAnalyticsProvider>, InsightAnalyticsProvider, CoveoInsightClient, PayloadType>): PreparableAnalyticsAction<StateNeeded>;
 };
 export declare const makeNoopAnalyticsAction: () => PreparableAnalyticsAction<StateNeededBySearchAnalyticsProvider>;
 export declare const noopSearchAnalyticsAction: () => LegacySearchAction;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-actions.d.ts

@@ -3,29 +3,45 @@ import { NumericRangeRequest } from '../../facets/range-facets/numeric-facet-set
 import { SortCriterion } from '../sort/sort.js';
 export interface Parameters {
     /**
-     * A record of the facets, where the key is the facet id, and value is an array containing the selected values.
+     * A record of the facets, where the key is the facet id, and the value is an array containing the selected values.
      */
     f?: Record<string, string[]>;
     /**
-     * A record of the location facets, where the key is the facet id, and value is an array containing the selected values.
+     * A record of the facets, where the key is the facet id, and the value is an array containing the excluded values.
+     */
+    fExcluded?: Record<string, string[]>;
+    /**
+     * A record of the location facets, where the key is the facet id, and the value is an array containing the selected values.
      */
     lf?: Record<string, string[]>;
     /**
-     * A record of the category facets, where the key is the facet id, and value is an array containing the parts of the selected path.
+     * A record of the category facets, where the key is the facet id, and the value is an array containing the parts of the selected path.
      */
     cf?: Record<string, string[]>;
     /**
-     * A record of the date facets, where the key is the facet id, and value is an array containing the date ranges to request.
+     * A record of the date facets, where the key is the facet id, and the value is an array containing the selected date ranges.
      */
     df?: Record<string, DateRangeRequest[]>;
     /**
-     * A record of the numeric facets, where the key is the facet id, and value is an array containing the numeric ranges to request.
+     * A record of the date facets, where the key is the facet id, and the value is an array containing the excluded date ranges.
+     */
+    dfExcluded?: Record<string, DateRangeRequest[]>;
+    /**
+     * A record of the numeric facets, where the key is the facet id, and the value is an array containing the selected numeric ranges.
      */
     nf?: Record<string, NumericRangeRequest[]>;
     /**
-     * A record of manual numeric facets, where the key is the facet id, and the value is an array containing the numeric ranges to request.
+     * A record of the numeric facets, where the key is the facet id, and the value is an array containing the excluded numeric ranges.
+     */
+    nfExcluded?: Record<string, NumericRangeRequest[]>;
+    /**
+     * A record of manual numeric facets, where the key is the facet id, and the the value is an array containing the selected manual numeric ranges.
      */
     mnf?: Record<string, NumericRangeRequest[]>;
+    /**
+     * A record of manual numeric facets, where the key is the facet id, and the value is an array containing the excluded manual numeric ranges.
+     */
+    mnfExcluded?: Record<string, NumericRangeRequest[]>;
     /**
      * The sort expression to order returned results by.
      */

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-schema.d.ts

@@ -1,11 +1,15 @@
 import { NumberValue, RecordValue } from '@coveo/bueno';
 export declare const parametersDefinition: {
     f: RecordValue;
+    fExcluded: RecordValue;
     lf: RecordValue;
     cf: RecordValue;
     nf: RecordValue;
+    nfExcluded: RecordValue;
     mnf: RecordValue;
+    mnfExcluded: RecordValue;
     df: RecordValue;
+    dfExcluded: RecordValue;
     sortCriteria: RecordValue;
     page: NumberValue;
     perPage: NumberValue;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-selectors.d.ts

@@ -3,14 +3,3 @@ import { stateKey } from '../../../app/state-key.js';
 import { Parameters as ManagedParameters } from './parameters-actions.js';
 export declare function initialParametersSelector(state: CommerceEngine[typeof stateKey]): Required<ManagedParameters>;
 export declare function activeParametersSelector(state: CommerceEngine[typeof stateKey]): ManagedParameters;
-export declare function enrichedParametersSelector(state: CommerceEngine[typeof stateKey], activeParams: ManagedParameters): {
-    f: Record<string, string[]>;
-    lf: Record<string, string[]>;
-    cf: Record<string, string[]>;
-    df: Record<string, import("../../../ssr.index.js").DateRangeRequest[]>;
-    nf: Record<string, import("../../../ssr.index.js").NumericRangeRequest[]>;
-    mnf: Record<string, import("../../../ssr.index.js").NumericRangeRequest[]>;
-    sortCriteria: import("../sort/sort.js").SortCriterion;
-    page: number;
-    perPage: number;
-};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-serializer.d.ts

@@ -1,15 +1,21 @@
 import { SearchParameterKey } from '../../search-parameters/search-parameter-serializer.js';
+import { ProductListingParameters } from '../product-listing-parameters/product-listing-parameters-actions.js';
 import { CommerceSearchParameters } from '../search-parameters/search-parameters-actions.js';
+import { SortCriterion } from '../sort/sort.js';
 import { Parameters } from './parameters-actions.js';
+export declare const commerceFacetsRegex: RegExp;
 export interface Serializer<T extends Parameters> {
     serialize: (parameters: T) => string;
     deserialize: (fragment: string) => T;
 }
 export declare const searchSerializer: Serializer<CommerceSearchParameters>;
-export declare const productListingSerializer: Serializer<Parameters>;
-type FacetParameters = keyof Pick<Parameters, 'f' | 'lf' | 'cf' | 'nf' | 'df' | 'mnf'>;
+export declare const productListingSerializer: Serializer<ProductListingParameters>;
+export type ParametersKey = keyof CommerceSearchParameters;
+export type FacetParameters = keyof Pick<Parameters, 'f' | 'fExcluded' | 'lf' | 'cf' | 'nf' | 'nfExcluded' | 'df' | 'dfExcluded' | 'mnf' | 'mnfExcluded'>;
 type FacetKey = keyof typeof supportedFacetParameters;
 declare const supportedFacetParameters: Record<FacetParameters, boolean>;
+export declare function buildCriterionExpression(criterion: SortCriterion | undefined): string;
 export declare function isValidBasicKey(key: string): key is Exclude<SearchParameterKey, FacetKey>;
 export declare function keyHasObjectValue(key: string): key is FacetKey;
+export declare function deserializeSortCriteria(value: string): SortCriterion | undefined;
 export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-serializer.ssr.d.ts

@@ -0,0 +1,44 @@
+import { DateRangeRequest, NumericRangeRequest } from '../../../controllers/commerce/core/facets/headless-core-commerce-facet.js';
+import { FacetValueSearchParam, SearchParamValue as CommerceSearchParamValue } from '../../search-parameters/search-parameter-utils.js';
+import { CommerceSearchParameters } from '../search-parameters/search-parameters-actions.js';
+import { SortCriterion } from '../sort/sort.js';
+import { FacetParameters } from './parameters-serializer.js';
+type CommerceSearchParametersKey = keyof CommerceSearchParameters;
+type CommerceSearchParamPair<T> = [CommerceSearchParametersKey, T];
+type RangeFacetValueSearchParam = Record<string, DateRangeRequest[] | NumericRangeRequest[]>;
+export declare function buildParameterSerializer(): {
+    deserialize: typeof deserialize;
+    serialize: typeof serialize;
+};
+/**
+ * Converts URLSearchParams or a record of commerce search parameters into a {@link CommerceSearchParameters} object.
+ *
+ * @param urlCommerceSearchParams - The URLSearchParams or record of commerce search parameters.
+ * @returns The converted CommerceSearchParameters object.
+ */
+declare function deserialize(urlCommerceSearchParams: URLSearchParams | Record<string, CommerceSearchParamValue>): CommerceSearchParameters;
+/**
+ * Serializes the commerce search parameters to the provided URL.
+ *
+ * @param commerceSearchParameters - The commerce search parameters to be serialized.
+ * @param initialUrl - The initial URL to which the commerce search parameters will be added.
+ * @returns The serialized URL.
+ */
+declare function serialize(commerceSearchParameters: CommerceSearchParameters, initialUrl: URL): string;
+export declare function isValidKey(key: string): key is CommerceSearchParametersKey;
+export declare function isValidBasicKey(key: string): key is Exclude<CommerceSearchParametersKey, keyof FacetParameters>;
+/**
+ * Extends the search parameters with the given key-value pair. If the key-value pair is not valid or if the value is undefined, the search parameters are not modified.
+ * @param commerceSearchParams - The search parameters object to extend.
+ * @param key - The key of the search parameter.
+ * @param value - The value of the search parameter.
+ */
+export declare function extendSearchParams(commerceSearchParams: Record<string, unknown>, key: string, value: CommerceSearchParamValue): void;
+export declare function cast<K extends CommerceSearchParametersKey>(pair: [K, string], decode?: boolean): [K, unknown];
+export declare function isValidSearchParam(key: string): boolean;
+export declare function isSortPair(pair: [CommerceSearchParametersKey, unknown]): pair is CommerceSearchParamPair<SortCriterion>;
+export declare function isFacetPair(pair: [CommerceSearchParametersKey, unknown]): pair is CommerceSearchParamPair<FacetValueSearchParam>;
+export declare function isRangeFacetPair(pair: [CommerceSearchParametersKey, unknown]): pair is CommerceSearchParamPair<RangeFacetValueSearchParam>;
+export declare function isRangeFacetObject(obj: unknown): obj is Record<string, (DateRangeRequest | NumericRangeRequest)[]>;
+export declare function addFacetValuesToSearchParams(facetId: string, paramKey: CommerceSearchParametersKey): (searchParams: Record<string, unknown>, valueArray: unknown[]) => void;
+export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-slice.d.ts

@@ -0,0 +1,4 @@
+import { CommerceParametersState } from './parameters-state.js';
+export declare const parametersReducer: import("redux").Reducer<CommerceParametersState> & {
+    getInitialState: () => CommerceParametersState;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-state.d.ts

@@ -0,0 +1,4 @@
+import { CommerceSearchParameters } from '../search-parameters/search-parameters-actions.js';
+export interface CommerceParametersState extends CommerceSearchParameters {
+}
+export declare function getCommerceParametersInitialState(): CommerceParametersState;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-actions.d.ts

@@ -38,6 +38,7 @@ export declare const fetchMoreRecommendations: import("@reduxjs/toolkit").AsyncT
 }>;
 export interface SlotIdPayload {
     slotId: string;
+    productId?: string;
 }
 export type RegisterRecommendationsSlotPayload = SlotIdPayload;
 export declare const registerRecommendationsSlot: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SlotIdPayload], SlotIdPayload, "commerce/recommendations/registerSlot", never, never>;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-state.d.ts

@@ -6,6 +6,7 @@ export interface RecommendationsSlice {
     isLoading: boolean;
     responseId: string;
     products: Product[];
+    productId?: string;
 }
 /**
  * An object in which each key is a slot identifier, and each value is the corresponding recommendations slice.

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-selectors.d.ts

@@ -241,18 +241,6 @@ export declare const queryExecutedSelector: ((state: CommerceSearchSection) => s
 };
 export declare const queryExecutedFromResponseSelector: (state: CommerceQuerySection, response: SearchCommerceSuccessResponse) => string;
 export declare const activeParametersSelector: (state: CommerceEngine[typeof stateKey]) => CommerceSearchParameters;
-export declare function enrichedParametersSelector(state: CommerceEngine[typeof stateKey], activeParams: CommerceSearchParameters): {
-    f: Record<string, string[]>;
-    lf: Record<string, string[]>;
-    cf: Record<string, string[]>;
-    df: Record<string, import("../../../ssr.index.js").DateRangeRequest[]>;
-    nf: Record<string, import("../../../ssr.index.js").NumericRangeRequest[]>;
-    mnf: Record<string, import("../../../ssr.index.js").NumericRangeRequest[]>;
-    sortCriteria: import("../sort/sort.js").SortCriterion;
-    page: number;
-    perPage: number;
-    q: string;
-};
 export declare function enrichedSummarySelector(state: CommerceEngineState): {
     query: string;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/features/debug/debug-selectors.d.ts

@@ -1,6 +1,6 @@
 import { SearchSection } from '../../state/state-sections.js';
 export declare function rankingInformationSelector(state: SearchSection): {
-    result: import("../../case-assist.index.js").Result;
+    result: import("../../ssr.index.js").Result;
     ranking: {
         documentWeights: import("./ranking-info-parser.js").DocumentWeights | null;
         termsWeight: import("./ranking-info-parser.js").TermWeightReport | null;