@coveo/quantic 3.29.3 → 3.29.4-pre.054be7e998

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

@@ -1,19 +1,18 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
 import type { Controller } from '../../controllers/controller/headless-controller.js';
-import type { ControllersMap } from '../common/types/controllers.js';
 import type { SSRCommerceEngine } from './factories/build-factory.js';
 import type { SolutionType } from './types/controller-constants.js';
-import type { ControllerDefinitionOption, ControllerDefinitionsMap, InferControllerStaticStateMapFromControllers } from './types/controller-definitions.js';
-import type { InferControllerPropsMapFromDefinitions, InferControllersMapFromDefinition } from './types/controller-inference.js';
+import type { ControllerDefinitionOption, ControllerDefinitionsMap } from './types/controller-definitions.js';
+import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition } from './types/controller-inference.js';
 import type { EngineStaticState } from './types/engine.js';
-export declare function createStaticState<TSearchAction extends UnknownAction>({ searchActions, controllers, }: {
+export declare function createStaticState<TSearchAction extends UnknownAction, TControllerDefinitions extends ControllerDefinitionsMap<Controller>>({ searchActions, controllers, }: {
     searchActions: TSearchAction[];
-    controllers: ControllersMap;
-}): EngineStaticState<TSearchAction, InferControllerStaticStateMapFromControllers<ControllersMap>>;
+    controllers: InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>;
+}): EngineStaticState<TSearchAction, InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, SolutionType>>;
 export declare function buildControllerDefinitions<TControllerDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>({ definitionsMap, engine, solutionType, propsMap, }: {
     definitionsMap: TControllerDefinitionsMap;
     engine: SSRCommerceEngine;
     solutionType: TSolutionType;
-    propsMap: InferControllerPropsMapFromDefinitions<TControllerDefinitionsMap>;
+    propsMap?: InferControllerPropsMapFromDefinitions<TControllerDefinitionsMap>;
 }): InferControllersMapFromDefinition<TControllerDefinitionsMap, TSolutionType>;
 export declare function ensureAtLeastOneSolutionType(options?: ControllerDefinitionOption): void;

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

@@ -1,7 +1,9 @@
 import { type Context, type ContextOptions, type ContextProps, type ContextState, type UserLocation, type View } from '../../../../controllers/commerce/context/headless-context.js';
 import type { UniversalControllerDefinitionWithProps } from '../../types/controller-definitions.js';
 export type { Context, ContextProps, ContextState, View, UserLocation, ContextOptions, };
-export interface ContextDefinition extends UniversalControllerDefinitionWithProps<Context, ContextOptions> {
+export interface ContextDefinition extends UniversalControllerDefinitionWithProps<Context, {
+    initialState: ContextOptions;
+}> {
 }
 /**
  * Defines a `Context` controller instance.

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

@@ -4,13 +4,14 @@ import type { ProductListingParameters } from '../../../../features/commerce/pro
 import type { CommerceSearchParameters } from '../../../../features/commerce/search-parameters/search-parameters-actions.js';
 import type { ControllerDefinitionOption, SubControllerDefinitionWithProps } from '../../types/controller-definitions.js';
 export type { ParameterManager, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, CommerceSearchParameters, };
+export type ParameterManagerDefinition<TOptions extends ControllerDefinitionOption | undefined> = SubControllerDefinitionWithProps<ParameterManager<MappedParameterTypes<TOptions>>, TOptions, SSRParameterManagerProps<MappedParameterTypes<TOptions>>>;
 /**
  * Defines a `ParameterManager` controller instance.
  * @group Definers
  *
  * @returns The `ParameterManager` controller definition.
  */
-export declare function defineParameterManager<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithProps<ParameterManager<MappedParameterTypes<TOptions>>, TOptions, SSRParameterManagerProps<MappedParameterTypes<TOptions>>>;
+export declare function defineParameterManager<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): ParameterManagerDefinition<TOptions>;
 export interface SSRParameterManagerProps<T extends Parameters> extends Omit<ParameterManagerProps<T>, 'excludeDefaultParameters'> {
 }
 type MappedParameterTypes<TOptions extends ControllerDefinitionOption | undefined> = TOptions extends {

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

@@ -8,7 +8,7 @@ export type InferStaticState<T extends {
 export type InferHydratedState<T extends {
     hydrateStaticState(...args: unknown[]): Promise<unknown>;
 }> = Awaited<ReturnType<T['hydrateStaticState']>>;
-export type InferControllerPropsFromDefinition<TController extends ControllerDefinition<Controller>> = TController extends ControllerDefinitionWithProps<Controller, infer Props> ? HasKey<TController, typeof recommendationInternalOptionKey> extends never ? Props : Props & RecommendationControllerSettings : TController extends ControllerDefinitionWithoutProps<Controller> ? HasKey<TController, typeof recommendationInternalOptionKey> extends never ? {} : RecommendationControllerSettings : unknown;
+type InferControllerPropsFromDefinition<TController extends ControllerDefinition<Controller>> = TController extends ControllerDefinitionWithProps<Controller, infer Props> ? HasKey<TController, typeof recommendationInternalOptionKey> extends never ? Props : Props & RecommendationControllerSettings : TController extends ControllerDefinitionWithoutProps<Controller> ? HasKey<TController, typeof recommendationInternalOptionKey> extends never ? {} : RecommendationControllerSettings : unknown;
 export type InferControllerPropsMapFromDefinitions<TControllers extends ControllerDefinitionsMap<Controller>> = {
     [K in keyof TControllers as HasKeys<InferControllerPropsFromDefinition<TControllers[K]>> extends false ? never : K]: InferControllerPropsFromDefinition<TControllers[K]>;
 };
@@ -17,5 +17,6 @@ export type InferControllersMapFromDefinition<TControllers extends ControllerDef
     [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : K]: InferControllerFromDefinition<TControllers[K]>;
 };
 export type InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
-    [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : K]: InferControllerStaticStateFromController<InferControllerFromDefinition<TControllers[K]>>;
+    [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : K]: InferControllerStaticStateFromController<InferControllerFromDefinition<TControllers[K]>> & InferControllerPropsFromDefinition<TControllers[K]>;
 };
+export {};

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

@@ -0,0 +1,17 @@
+import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
+import type { Controller } from '../../../controllers/controller/headless-controller.js';
+import type { BaseControllerDefinitionWithoutProps, BaseControllerDefinitionWithProps } from '../types/controllers.js';
+/**
+ * Builder class for creating controllers from definitions
+ */
+export declare class ControllerBuilder<TDefinition extends Partial<BaseControllerDefinitionWithoutProps<TEngine, TController>> & Partial<BaseControllerDefinitionWithProps<TEngine, TController, TProps>>, TEngine extends CoreEngine | CoreEngineNext, TProps, TController extends Controller = Controller> {
+    private _definition;
+    private _engine;
+    private _props?;
+    private _additionalArgs;
+    constructor(definition: TDefinition, engine: TEngine, props?: TProps);
+    withAdditionalArgs(additionalArgs?: unknown[]): this;
+    build(): TController;
+    private buildWithoutProps;
+    private buildWithProps;
+}

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

@@ -0,0 +1,24 @@
+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'>;
+/**
+ * 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
+     */
+    build(): StaticControllerState;
+}
+export declare function createStaticControllerBuilder<TController extends Controller>(controller: TController): StaticControllerBuilder;
+export {};

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

@@ -1,15 +1,15 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
 import type { CoreEngine, CoreEngineNext } from '../../app/engine.js';
 import type { Controller } from '../../controllers/controller/headless-controller.js';
-import type { ControllerDefinitionsMap, ControllersMap } from './types/controllers.js';
+import type { ControllerDefinitionsMap } from './types/controllers.js';
 import type { EngineStaticState } from './types/engine.js';
-import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromControllers, InferControllersMapFromDefinition } from './types/inference.js';
+import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitions, InferControllersMapFromDefinition } from './types/inference.js';
 export declare function buildControllerDefinitions<TControllerDefinitionsMap extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>, TEngine extends CoreEngine | CoreEngineNext>({ definitionsMap, engine, propsMap, }: {
     definitionsMap: TControllerDefinitionsMap;
     engine: TEngine;
-    propsMap: InferControllerPropsMapFromDefinitions<TControllerDefinitionsMap>;
+    propsMap?: InferControllerPropsMapFromDefinitions<TControllerDefinitionsMap>;
 }): InferControllersMapFromDefinition<TControllerDefinitionsMap>;
-export declare function createStaticState<TSearchAction extends UnknownAction>({ searchAction, controllers, }: {
+export declare function createStaticState<TSearchAction extends UnknownAction, TControllerDefinitions extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>>({ searchAction, controllers, }: {
     searchAction: TSearchAction;
-    controllers: ControllersMap;
-}): EngineStaticState<TSearchAction, InferControllerStaticStateMapFromControllers<ControllersMap>>;
+    controllers: InferControllersMapFromDefinition<TControllerDefinitions>;
+}): EngineStaticState<TSearchAction, InferControllerStaticStateMapFromDefinitions<TControllerDefinitions>>;

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

@@ -9,6 +9,12 @@ export interface ControllerStaticState<TState> {
 export interface ControllerStaticStateMap {
     [customName: string]: ControllerStaticState<unknown>;
 }
+export interface BaseControllerDefinitionWithoutProps<TEngine, TController extends Controller> {
+    build(engine: TEngine, ...args: unknown[]): TController;
+}
+export interface BaseControllerDefinitionWithProps<TEngine, TController extends Controller, TProps> {
+    buildWithProps(engine: TEngine, props?: TProps, ...args: unknown[]): TController;
+}
 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/ssr-next/common/types/inference.d.ts

@@ -2,7 +2,7 @@ import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { ControllerDefinition, ControllerDefinitionsMap, ControllerDefinitionWithoutProps, ControllerDefinitionWithProps, ControllerStaticState, ControllersMap } from './controllers.js';
 import type { HasKeys } from './utilities.js';
-export type InferControllerPropsFromDefinition<TController extends ControllerDefinition<CoreEngine | CoreEngineNext, Controller>> = TController extends ControllerDefinitionWithProps<CoreEngine | CoreEngineNext, Controller, infer Props> ? Props : TController extends ControllerDefinitionWithoutProps<CoreEngine | CoreEngineNext, Controller> ? {} : unknown;
+type InferControllerPropsFromDefinition<TController extends ControllerDefinition<CoreEngine | CoreEngineNext, Controller>> = TController extends ControllerDefinitionWithProps<CoreEngine | CoreEngineNext, Controller, infer Props> ? Props : TController extends ControllerDefinitionWithoutProps<CoreEngine | CoreEngineNext, Controller> ? {} : unknown;
 export type InferControllerPropsMapFromDefinitions<TControllers extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>> = {
     [K in keyof TControllers as HasKeys<InferControllerPropsFromDefinition<TControllers[K]>> extends false ? never : K]: InferControllerPropsFromDefinition<TControllers[K]>;
 };
@@ -12,8 +12,9 @@ export type InferControllersMapFromDefinition<TControllers extends ControllerDef
 };
 export type InferControllerStaticStateFromController<TController extends Controller> = ControllerStaticState<TController['state']>;
 export type InferControllerStaticStateMapFromDefinitions<TControllers extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>> = {
-    [K in keyof TControllers]: InferControllerStaticStateFromController<InferControllerFromDefinition<TControllers[K]>>;
+    [K in keyof TControllers]: InferControllerStaticStateFromController<InferControllerFromDefinition<TControllers[K]>> & InferControllerPropsFromDefinition<TControllers[K]>;
 };
 export type InferControllerStaticStateMapFromControllers<TControllers extends ControllersMap> = {
     [K in keyof TControllers]: InferControllerStaticStateFromController<TControllers[K]>;
 };
+export {};

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

@@ -0,0 +1,9 @@
+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';
+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-ssr-controller-definitions.d.ts

@@ -0,0 +1,38 @@
+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-next/common/types/controllers.js';
+interface MockController {
+    initialState?: Record<string, unknown>;
+}
+interface MockControllerDefinitionWithoutProps extends ControllerDefinitionWithoutProps<SearchEngine, Controller> {
+}
+interface MockControllerDefinitionWithProps extends ControllerDefinitionWithProps<SearchEngine, Controller, MockController> {
+}
+type SolutionTypeAvailabilities = {
+    listing?: boolean;
+    search?: boolean;
+    standalone?: boolean;
+    recommendation?: boolean;
+};
+export declare function defineMockController(): MockControllerDefinitionWithoutProps;
+export declare function defineMockControllerWithProps(): MockControllerDefinitionWithProps;
+export declare function defineMockCommerceController(options?: SolutionTypeAvailabilities): {
+    build: import("vitest").Mock<(_engine: any) => Controller>;
+    listing: boolean;
+    search: boolean;
+    standalone: boolean;
+    recommendation: boolean;
+};
+export declare function defineMockCommerceControllerWithProps(options?: SolutionTypeAvailabilities): {
+    buildWithProps: import("vitest").Mock<(engine: any, props: any) => {
+        state: {};
+        subscribe(listener: () => void): import("redux").Unsubscribe;
+        _kind: Kind;
+    }>;
+    listing: boolean;
+    search: boolean;
+    standalone: boolean;
+    recommendation: boolean;
+};
+export {};