@coveo/quantic 3.30.0-pre.7fbcdbbb29 → 3.30.0-pre.87f88f35ec

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

@@ -1,5 +1,4 @@
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import type { InvalidControllerDefinition } from '../../common/errors.js';
 import type { InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers } from '../../common/types/controller-inference.js';
 import type { ControllersPropsMap } from '../../common/types/controllers.js';
 import type { HasKey, HasRequiredKeys, OptionsTuple } from '../../common/types/utilities.js';
@@ -8,9 +7,8 @@ import type { ContextDefinition } from '../controllers/context/headless-context.
 import type { ParameterManagerDefinition } from '../controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
 import type { SSRCommerceEngine } from '../factories/build-factory.js';
 import { type recommendationInternalOptionKey, SolutionType } from './controller-constants.js';
-import type { ListingAndStandaloneController, ListingOnlyController, NonRecommendationController, RecommendationOnlyController, SearchAndListingController, SearchOnlyController, UniversalController } from './controller-scopes.js';
+import type { ListingAndStandaloneController, NonRecommendationController, RecommendationOnlyController, SearchAndListingController, SearchOnlyController, UniversalController } from './controller-scopes.js';
 import type { HydratedState } from './hydrate-static-state.js';
-import type { Kind } from './kind.js';
 import type { HasSolutionType } from './utilities.js';
 export type { HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
 export interface ControllerDefinitionWithoutProps<TController extends Controller> {
@@ -23,9 +21,6 @@ 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.
@@ -35,7 +30,7 @@ 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 & ControllerWithKind;
+    buildWithProps(engine: SSRCommerceEngine, props?: TProps, solutionType?: SolutionType): TController;
 }
 interface SolutionTypeAvailability {
     [SolutionType.search]?: boolean;
@@ -48,10 +43,7 @@ export interface ControllerDefinitionsMap<TController extends Controller> {
     [customName: string]: ControllerDefinition<TController>;
 }
 type BakedInControllerDefinitions = {
-    parameterManager: ParameterManagerDefinition<{
-        listing: true;
-        search: true;
-    }>;
+    parameterManager: ParameterManagerDefinition;
     context: ContextDefinition;
     cart: CartDefinition;
 };
@@ -93,51 +85,10 @@ export type IsRecommendationController<TController extends ControllerDefinition<
 type DefaultControllerProps<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, K extends keyof TControllers> = {
     [I in keyof TControllersPropsMap as I extends K ? I : never]: TControllersPropsMap[I];
 };
-export interface ControllerDefinitionOption {
-    /**
-     * Whether the controller will be used in a product listing context.
-     * @defaultValue true
-     */
-    listing?: boolean;
-    /**
-     * Whether the controller will be used in a search page context.
-     * @defaultValue true
-     */
-    search?: boolean;
-}
 export type SearchOnlyControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & SearchOnlyController;
-type SearchOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchOnlyController;
 export type ListingAndStandaloneControllerWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & ListingAndStandaloneController;
-type ListingOnlyControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & ListingOnlyController;
-type ListingOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & ListingOnlyController;
 export type RecommendationOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & RecommendationOnlyController;
 export type NonRecommendationControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & NonRecommendationController;
 export type UniversalControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & UniversalController;
 export type SearchAndListingControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & SearchAndListingController;
-type SearchAndListingControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchAndListingController;
-export type SubControllerDefinitionWithoutProps<TController extends Controller, TDefinition extends ControllerDefinitionOption | undefined> = TDefinition extends {
-    listing?: true;
-    search?: true;
-} | undefined ? SearchAndListingControllerDefinitionWithoutProps<TController> : TDefinition extends {
-    listing?: true;
-    search?: false;
-} ? ListingOnlyControllerDefinitionWithoutProps<TController> : TDefinition extends {
-    listing?: false;
-    search?: true;
-} ? SearchOnlyControllerDefinitionWithoutProps<TController> : TDefinition extends {
-    listing: false;
-    search: false;
-} ? InvalidControllerDefinition : never;
-export type SubControllerDefinitionWithProps<TController extends Controller, TDefinition extends ControllerDefinitionOption | undefined, TProps> = TDefinition extends {
-    listing?: true;
-    search?: true;
-} | undefined ? SearchAndListingControllerDefinitionWithProps<TController, TProps> : TDefinition extends {
-    listing?: true;
-    search?: false;
-} ? ListingOnlyControllerDefinitionWithProps<TController, TProps> : TDefinition extends {
-    listing?: false;
-    search?: true;
-} ? SearchOnlyControllerDefinitionWithProps<TController, TProps> : TDefinition extends {
-    listing: false;
-    search: false;
-} ? InvalidControllerDefinition : never;
+export type SearchAndListingControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchAndListingController;

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

@@ -37,12 +37,6 @@ export interface SearchOnlyController {
      */
     [SolutionType.search]: true;
 }
-export interface ListingOnlyController {
-    /**
-     * @internal
-     */
-    [SolutionType.listing]: true;
-}
 export interface RecommendationOnlyController {
     /**
      * @internal

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

@@ -1,19 +1,16 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
 import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import type { ControllerStaticStateMap, ControllersMap } from '../../common/types/controllers.js';
+import type { ControllersMap } from '../../common/types/controllers.js';
+import type { EngineStaticState } from '../../common/types/engine.js';
 import type { SSRCommerceEngine } from '../factories/build-factory.js';
-import type { Build, SSRCommerceEngineOptions } from './build.js';
+import type { SSRCommerceEngineOptions } from './build.js';
 import type { SolutionType } from './controller-constants.js';
 import type { BakedInControllers, ControllerDefinitionsMap } from './controller-definitions.js';
 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 };
-export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
-    searchActions: TSearchAction[];
-    controllers: TControllers;
-}
+export type { HydrateStaticState, HydrateStaticStateOptions, FetchStaticState, EngineStaticState, };
 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];
@@ -60,14 +57,8 @@ export interface CommerceEngineDefinitionBuildResult<TControllers extends Contro
     controllers: TControllers & BakedInControllers;
 }
 export type CommerceControllerDefinitionsMap = ControllerDefinitionsMap<Controller>;
-type Definition<TControllerDefinitions extends CommerceControllerDefinitionsMap> = CommerceEngineDefinition<TControllerDefinitions, SolutionType>;
-export type FetchStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Definition<TControllerDefinitions>['fetchStaticState'];
-export type HydrateStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Definition<TControllerDefinitions>['hydrateStaticState'];
-export type BuildParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<Build<InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>, InferControllerPropsMapFromDefinitions<TControllerDefinitions>, TControllerDefinitions, SolutionType>>;
-export type FetchStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<FetchStaticStateFunction<TControllerDefinitions>>;
-export type HydrateStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<HydrateStaticStateFunction<TControllerDefinitions>>;
-type Controllers<TControllerDefinitions extends CommerceControllerDefinitionsMap> = InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>;
-export type BuildResult<TControllerDefinitions extends CommerceControllerDefinitionsMap> = {
-    engine: SSRCommerceEngine;
-    controllers: Controllers<TControllerDefinitions> & BakedInControllers;
-};
+type Definition<TControllerDefinitions extends CommerceControllerDefinitionsMap, TSolutionType extends SolutionType> = CommerceEngineDefinition<TControllerDefinitions, TSolutionType>;
+type FetchStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap, TSolutionType extends SolutionType> = Definition<TControllerDefinitions, TSolutionType>['fetchStaticState'];
+export type HydrateStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap, TSolutionType extends SolutionType> = Definition<TControllerDefinitions, TSolutionType>['hydrateStaticState'];
+export type FetchStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap, TSolutionType extends SolutionType> = Parameters<FetchStaticStateFunction<TControllerDefinitions, TSolutionType>>;
+export type HydrateStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap, TSolutionType extends SolutionType> = Parameters<HydrateStaticStateFunction<TControllerDefinitions, TSolutionType>>;

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

@@ -1,10 +1,10 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { ControllerStaticStateMap, ControllersPropsMap } from '../../common/types/controllers.js';
+import type { EngineStaticState } from '../../common/types/engine.js';
 import type { BuildConfig } from './build.js';
 import type { SolutionType } from './controller-constants.js';
 import type { CommerceEngineDefinitionControllersPropsOption, ControllerDefinitionsMap, FilteredBakedInControllers, OptionsTuple } from './controller-definitions.js';
-import type { EngineStaticState } from './engine.js';
 /**
  * Executes only the initial search for a given configuration, then returns a resumable snapshot of engine state along with the state of the controllers.
  *

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

@@ -20,5 +20,5 @@ export declare function filterRecommendationControllers<TControllerDefinitions e
      * @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;
+    refresh(whitelist?: Array<keyof TControllerDefinitions>): void;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/common/builders/static-controller-builder.d.ts

@@ -1,19 +1,14 @@
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import type { ControllerWithKind } from '../../commerce/types/controller-definitions.js';
-import type { Kind } from '../../commerce/types/kind.js';
 export type StaticControllerState = {
     initialState?: Controller['state'];
-    _kind?: Kind;
-} & Pick<ControllerWithKind, 'state'>;
+} & Pick<Controller, 'state'>;
 /**
  * Builder class for creating static controller
  */
 declare class StaticControllerBuilder {
     private _state?;
-    private _kind?;
     private _initialState?;
     withState(state: StaticControllerState['state']): this;
-    withKind(kind: Kind): this;
     withInitialState(initialState: StaticControllerState['initialState']): this;
     /**
      * Builds and returns the static controller state object

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/common/errors.d.ts

@@ -1,6 +1,3 @@
-export declare class InvalidControllerDefinition extends Error {
-    constructor();
-}
 export declare class MissingControllerProps extends Error {
     constructor(controller: string);
 }

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

@@ -1,7 +1,7 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
 import type { ControllerStaticStateMap } from './controllers.js';
 export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
-    searchAction: TSearchAction;
+    searchActions: TSearchAction[];
     controllers: TControllers;
 }
 export type InferStaticState<T extends {

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

@@ -7,5 +7,4 @@ type ExtractRequiredOptions<TOptions> = {
     [TKey in keyof TOptions as Pick<TOptions, TKey> extends Required<Pick<TOptions, TKey>> ? TKey : never]: TOptions[TKey];
 };
 export type OptionsTuple<TOptions> = HasKeys<TOptions> extends false ? [] : HasKeys<ExtractRequiredOptions<TOptions>> extends false ? [options?: TOptions] : [options: TOptions];
-export type OptionsExtender<TOptions> = (options: TOptions) => TOptions | Promise<TOptions>;
 export {};

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

@@ -9,7 +9,7 @@ export declare function buildControllerDefinitions<TControllerDefinitionsMap ext
     engine: TEngine;
     propsMap?: InferControllerPropsMapFromDefinitions<TControllerDefinitionsMap>;
 }): InferControllersMapFromDefinition<TControllerDefinitionsMap>;
-export declare function createStaticState<TSearchAction extends UnknownAction, TControllerDefinitions extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>>({ searchAction, controllers, }: {
-    searchAction: TSearchAction;
+export declare function createStaticState<TSearchAction extends UnknownAction, TControllerDefinitions extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>>({ searchActions, controllers, }: {
+    searchActions: TSearchAction[];
     controllers: InferControllersMapFromDefinition<TControllerDefinitions>;
 }): EngineStaticState<TSearchAction, InferControllerStaticStateMapFromDefinitions<TControllerDefinitions>>;

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

@@ -1,12 +1,8 @@
 import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
 import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
-import type { OptionsExtender, OptionsTuple } from '../../common/types/utilities.js';
+import type { OptionsTuple } from '../../common/types/utilities.js';
 import type { SearchEngineDefinitionBuildResult, SearchEngineDefinitionControllersPropsOption } from './engine.js';
-interface BuildOptions<TEngineOptions> {
-    extend?: OptionsExtender<TEngineOptions>;
-}
 /**
  * @internal
  */
-export type Build<TEngine extends CoreEngine | CoreEngineNext, TEngineOptions, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<BuildOptions<TEngineOptions> & SearchEngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<SearchEngineDefinitionBuildResult<TEngine, TControllersMap>>;
-export {};
+export type Build<TEngine extends CoreEngine | CoreEngineNext, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<SearchEngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<SearchEngineDefinitionBuildResult<TEngine, TControllersMap>>;

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

@@ -11,7 +11,7 @@ import type { ControllerDefinitionsMap } from './controller-definition.js';
 import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitions, InferControllersMapFromDefinition } from './controller-inference.js';
 import type { FetchStaticState } from './fetch-static-state.js';
 import type { HydrateStaticState } from './hydrate-static-state.js';
-export type EngineBuildResult<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllerDefinitionsMap<TEngine, Controller>, TEngineOptions> = Build<TEngine, TEngineOptions, InferControllersMapFromDefinition<TControllers>, InferControllerPropsMapFromDefinitions<TControllers>>;
+export type EngineBuildResult<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllerDefinitionsMap<TEngine, Controller>> = Build<TEngine, InferControllersMapFromDefinition<TControllers>, InferControllerPropsMapFromDefinitions<TControllers>>;
 /**
  * The options to create a search engine definition in SSR.
  *

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/types/hydrate-static-state.d.ts

@@ -5,7 +5,7 @@ import type { OptionsTuple } from '../../common/types/utilities.js';
 import type { SearchEngineDefinitionBuildResult, SearchEngineDefinitionControllersPropsOption } from './engine.js';
 export type HydratedState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> = SearchEngineDefinitionBuildResult<TEngine, TControllers>;
 interface HydrateStaticStateOptions<TSearchAction> {
-    searchAction: TSearchAction;
+    searchActions: TSearchAction[];
 }
 /**
  * Creates a new engine from the snapshot of the engine created in SSR with fetchStaticState.

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

@@ -1,6 +1,5 @@
 import type { SearchEngine } from '../app/search-engine/search-engine.js';
 import type { Controller } from '../controllers/controller/headless-controller.js';
-import type { Kind } from '../ssr/commerce/types/kind.js';
 import type { ControllerDefinitionWithoutProps, ControllerDefinitionWithProps } from '../ssr/common/types/controllers.js';
 import { recommendationInternalOptionKey } from '../ssr-next/commerce/types/controller-constants.js';
 interface MockController {
@@ -29,7 +28,6 @@ export declare function defineMockCommerceControllerWithProps(options?: Solution
     buildWithProps: import("vitest").Mock<(engine: any, props: any) => {
         state: {};
         subscribe(listener: () => void): import("redux").Unsubscribe;
-        _kind: Kind;
     }>;
     listing: boolean;
     search: boolean;
@@ -44,7 +42,6 @@ export declare function defineMockRecommendationDefinition(slotId: string): {
     buildWithProps: import("vitest").Mock<(engine: any, props: any) => {
         state: {};
         subscribe(listener: () => void): import("redux").Unsubscribe;
-        _kind: Kind;
     }>;
 };
 export {};