@coveo/quantic 3.30.0-pre.e3bf4d7bb2 → 3.30.0-pre.ea0fa3a1da

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

@@ -6,14 +6,29 @@ export declare const getRelayInstanceFromState: ((state: StateNeededByRelay, nav
     resultsCount: () => number;
     resetResultsCount: () => void;
 } & {
-    resultFunc: (resultFuncArgs_0: string, resultFuncArgs_1: "dev" | "stg" | "hipaa" | "prod", resultFuncArgs_2: string, resultFuncArgs_3: import("../../features/configuration/configuration-state.js").CoreAnalyticsState | import("../../features/configuration/configuration-state.js").AnalyticsState, resultFuncArgs_4: string[], resultFuncArgs_5: NavigatorContextProvider | undefined) => import("@coveo/relay").Relay;
-    memoizedResultFunc: ((resultFuncArgs_0: string, resultFuncArgs_1: "dev" | "stg" | "hipaa" | "prod", resultFuncArgs_2: string, resultFuncArgs_3: import("../../features/configuration/configuration-state.js").CoreAnalyticsState | import("../../features/configuration/configuration-state.js").AnalyticsState, resultFuncArgs_4: string[], resultFuncArgs_5: NavigatorContextProvider | undefined) => import("@coveo/relay").Relay) & {
+    resultFunc: (resultFuncArgs_0: string, resultFuncArgs_1: "dev" | "stg" | "hipaa" | "prod", resultFuncArgs_2: string, resultFuncArgs_3: import("../../features/configuration/configuration-state.js").CoreAnalyticsState | import("../../features/configuration/configuration-state.js").AnalyticsState, resultFuncArgs_4: string[], resultFuncArgs_5: {
+        getLocation: () => string | null;
+        getReferrer: () => string | null;
+        getUserAgent: () => string | null;
+        generateUUID: () => string;
+    } | undefined) => import("@coveo/relay").Relay;
+    memoizedResultFunc: ((resultFuncArgs_0: string, resultFuncArgs_1: "dev" | "stg" | "hipaa" | "prod", resultFuncArgs_2: string, resultFuncArgs_3: import("../../features/configuration/configuration-state.js").CoreAnalyticsState | import("../../features/configuration/configuration-state.js").AnalyticsState, resultFuncArgs_4: string[], resultFuncArgs_5: {
+        getLocation: () => string | null;
+        getReferrer: () => string | null;
+        getUserAgent: () => string | null;
+        generateUUID: () => string;
+    } | undefined) => import("@coveo/relay").Relay) & {
         clearCache: () => void;
         resultsCount: () => number;
         resetResultsCount: () => void;
     };
     lastResult: () => import("@coveo/relay").Relay;
-    dependencies: [(state: StateNeededByRelay) => string, (state: StateNeededByRelay) => "dev" | "stg" | "hipaa" | "prod", (state: StateNeededByRelay) => string, (state: StateNeededByRelay) => import("../../features/configuration/configuration-state.js").CoreAnalyticsState | import("../../features/configuration/configuration-state.js").AnalyticsState, (state: StateNeededByRelay) => string[], (_state: StateNeededByRelay, navigatorContextProvider?: NavigatorContextProvider) => NavigatorContextProvider | undefined];
+    dependencies: [(state: StateNeededByRelay) => string, (state: StateNeededByRelay) => "dev" | "stg" | "hipaa" | "prod", (state: StateNeededByRelay) => string, (state: StateNeededByRelay) => import("../../features/configuration/configuration-state.js").CoreAnalyticsState | import("../../features/configuration/configuration-state.js").AnalyticsState, (state: StateNeededByRelay) => string[], (_state: StateNeededByRelay, navigatorContextProvider?: NavigatorContextProvider) => {
+        getLocation: () => string | null;
+        getReferrer: () => string | null;
+        getUserAgent: () => string | null;
+        generateUUID: () => string;
+    } | undefined];
     recomputations: () => number;
     resetRecomputations: () => void;
     dependencyRecomputations: () => number;

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

@@ -3,5 +3,5 @@ import type { BaseParam } from './platform-service-params.js';
 import type { AllSearchAPIResponse } from './search/search-api-client.js';
 import type { SearchAPIErrorWithStatusCode } from './search/search-api-error-response.js';
 import type { AuthenticationParam } from './search/search-api-params.js';
-export declare function pickNonBaseParams<Params extends BaseParam & AuthenticationParam>(req: Params): Omit<Params, "accessToken" | "url" | "organizationId" | "authentication">;
+export declare function pickNonBaseParams<Params extends BaseParam & AuthenticationParam>(req: Params): Omit<Params, "accessToken" | "organizationId" | "url" | "authentication">;
 export declare const unwrapError: (payload: PlatformResponse<AllSearchAPIResponse>) => SearchAPIErrorWithStatusCode;

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

@@ -29,10 +29,10 @@ export declare const getRequestOptions: (req: FilterableCommerceAPIRequest, path
         sort: import("./sort.js").SortOption | undefined;
     };
     accessToken: string;
-    method: import("../../platform-client.js").HttpMethods;
-    contentType: import("../../platform-client.js").HTTPContentType;
     url: string;
+    method: import("../../platform-client.js").HttpMethods;
     origin: import("../../preprocess-request.js").PlatformClientOrigin;
+    contentType: import("../../platform-client.js").HTTPContentType;
     requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
 };
 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/commerce/recommendations/recommendations-request.d.ts

@@ -25,9 +25,9 @@ export declare const buildRecommendationsRequest: (req: CommerceRecommendationsR
         perPage: number | undefined;
     };
     accessToken: string;
-    method: import("../../platform-client.js").HttpMethods;
-    contentType: import("../../platform-client.js").HTTPContentType;
     url: string;
+    method: import("../../platform-client.js").HttpMethods;
     origin: import("../../preprocess-request.js").PlatformClientOrigin;
+    contentType: import("../../platform-client.js").HTTPContentType;
     requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
 };

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

@@ -22,9 +22,9 @@ export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) =
         currency: string;
     };
     accessToken: string;
-    method: import("../../../platform-client.js").HttpMethods;
-    contentType: import("../../../platform-client.js").HTTPContentType;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    contentType: import("../../../platform-client.js").HTTPContentType;
     requestMetadata?: import("../../../preprocess-request.js").RequestMetadata | undefined;
 };

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

@@ -75,7 +75,7 @@ export declare const constructAnswerQueryParams: (state: StreamAnswerAPIState, u
     queryCorrection?: {
         enabled: boolean;
         options: {
-            automaticallyCorrect: "never" | "whenNoResults";
+            automaticallyCorrect: "whenNoResults" | "never";
         };
     } | undefined;
     enableDidYouMean?: boolean | undefined;
@@ -116,9 +116,9 @@ export declare const selectAnswer: (state: StreamAnswerAPIState, navigatorContex
 }) | ({
     status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
     error: undefined;
-    requestId: string;
-    originalArgs: Partial<SearchRequest>;
     endpointName: string;
+    originalArgs: Partial<SearchRequest>;
+    requestId: string;
     startedTimeStamp: number;
     data: GeneratedAnswerStream;
     fulfilledTimeStamp: number;
@@ -145,11 +145,11 @@ export declare const selectAnswer: (state: StreamAnswerAPIState, navigatorContex
     isError: false;
 }) | ({
     status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
-    requestId: string;
     data?: GeneratedAnswerStream | undefined;
+    endpointName: string;
     fulfilledTimeStamp?: number | undefined;
     originalArgs: Partial<SearchRequest>;
-    endpointName: string;
+    requestId: string;
     startedTimeStamp: number;
     error: import("@reduxjs/toolkit").SerializedError | import("@reduxjs/toolkit/query").FetchBaseQueryError;
 } & {

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

@@ -12,8 +12,8 @@ export declare const buildGetCaseClassificationsRequest: (req: GetCaseClassifica
         };
     };
     accessToken: string;
-    method: import("../../../platform-client.js").HttpMethods;
-    contentType: import("../../../platform-client.js").HTTPContentType;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    contentType: import("../../../platform-client.js").HTTPContentType;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts

@@ -29,8 +29,8 @@ export declare const buildGetDocumentSuggestionsRequest: (req: GetDocumentSugges
         } | undefined;
     };
     accessToken: string;
-    method: import("../../../platform-client.js").HttpMethods;
-    contentType: import("../../../platform-client.js").HTTPContentType;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    contentType: import("../../../platform-client.js").HTTPContentType;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/get-interface/get-interface-config-request.d.ts

@@ -4,8 +4,8 @@ export type GetInsightInterfaceConfigRequest = BaseParam & InsightIdParam;
 export declare const buildGetInsightInterfaceConfigRequest: (req: GetInsightInterfaceConfigRequest) => {
     requestParams: {};
     accessToken: string;
-    method: import("../../../platform-client.js").HttpMethods;
-    contentType: import("../../../platform-client.js").HTTPContentType;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    contentType: import("../../../platform-client.js").HTTPContentType;
 };

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

@@ -9,17 +9,17 @@ interface CaseContextParam {
 export declare const buildInsightQueryRequest: (req: InsightQueryRequest) => {
     requestParams: {};
     accessToken: string;
-    method: import("../../../platform-client.js").HttpMethods;
-    contentType: import("../../../platform-client.js").HTTPContentType;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    contentType: import("../../../platform-client.js").HTTPContentType;
 };
 export declare const buildInsightQuerySuggestRequest: (req: InsightQuerySuggestRequest) => {
     requestParams: {};
     accessToken: string;
-    method: import("../../../platform-client.js").HttpMethods;
-    contentType: import("../../../platform-client.js").HTTPContentType;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    contentType: import("../../../platform-client.js").HTTPContentType;
 };
 export {};

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

@@ -11,9 +11,9 @@ export declare const buildInsightUserActionsRequest: (req: InsightUserActionsReq
         objectId: string;
     };
     accessToken: string;
-    method: import("../../../platform-client.js").HttpMethods;
-    contentType: import("../../../platform-client.js").HTTPContentType;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    contentType: import("../../../platform-client.js").HTTPContentType;
 };
 export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-actions-loader.d.ts

@@ -7,6 +7,15 @@ import type { CoreEngine } from '../../app/engine.js';
  * @category GeneratedAnswer
  */
 export interface GeneratedAnswerActionCreators {
+    /**
+     * Generates a new answer using the Answer API.
+     *
+     * This action requires an answer configuration ID to be set in the engine configuration.
+     * When present, it will use the Answer API service for enhanced answer generation.
+     *
+     * @returns A dispatchable action.
+     */
+    generateAnswer(): void;
     /**
      * Resets the generated answer state to a clean slate.
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-actions.d.ts

@@ -1,4 +1,6 @@
 import type { GeneratedAnswerCitationsPayload, GeneratedAnswerMessagePayload } from '../../api/generated-answer/generated-answer-event-payload.js';
+import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api-state.js';
+import type { SearchThunkExtraArguments } from '../../app/search-thunk-extra-arguments.js';
 import type { ConfigurationSection, DebugSection, GeneratedAnswerSection, SearchSection } from '../../state/state-sections.js';
 import { type GeneratedResponseFormat } from './generated-response-format.js';
 type StateNeededByGeneratedAnswerStream = ConfigurationSection & SearchSection & GeneratedAnswerSection & DebugSection;
@@ -45,4 +47,27 @@ export declare const streamAnswer: import("@reduxjs/toolkit").AsyncThunk<void, S
     fulfilledMeta?: unknown;
     rejectedMeta?: unknown;
 }>;
+/**
+ * Thunk to handle the sequence of actions required to generate a new answer
+ * after a search request.
+ *
+ * ⚠️ This action only works when an **answer configuration ID** is present
+ * in the engine configuration. In that case, the **Answer API** will be used
+ * instead of the regular search pipeline.
+ *
+ * Flow:
+ * 1. Reset any existing answer state.
+ * 2. Fetch a new answer from the Answer API using the provided configuration.
+ * 3. Update the search action metadata.
+ */
+export declare const generateAnswer: import("@reduxjs/toolkit").AsyncThunk<void, void, {
+    state: StreamAnswerAPIState;
+    extra: SearchThunkExtraArguments;
+    dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction> | undefined;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
 export {};

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

@@ -104,6 +104,7 @@ export type { NumericFacetValue } from './features/facets/range-facets/numeric-f
 export * from './features/facets/range-facets/numeric-facet-set/numeric-facet-actions-loader.js';
 export * from './features/fields/fields-actions-loader.js';
 export * from './features/folding/insight-folding-actions-loader.js';
+export * from './features/generated-answer/generated-answer-actions-loader.js';
 export * from './features/insight-interface/insight-interface-actions-loader.js';
 export type { InsightInterfaceState } from './features/insight-interface/insight-interface-state.js';
 export * from './features/insight-search/insight-query-set-actions-loader.js';

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

@@ -5,10 +5,6 @@ import type { EngineDefinitionBuildResult, EngineDefinitionControllersPropsOptio
 import type { FromBuildResult } from './from-build-result.js';
 import type { OptionsTuple } from './utilities.js';
 interface HydrateStaticStateOptions<TSearchAction> {
-    /**
-     * @deprecated The `searchAction` property will be replaced with `searchActions` in the next major release.
-     * The new property will accept an array of actions instead of a single action to support multiple search operations (e.g. search and recommendation).
-     */
     searchAction: TSearchAction;
 }
 export interface HydratedState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> extends EngineDefinitionBuildResult<TEngine, TControllers> {

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

@@ -1,8 +1,7 @@
 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 { ControllersMap } from '../../common/types/controllers.js';
-import type { EngineStaticState } from '../../common/types/engine.js';
+import type { ControllerStaticStateMap, ControllersMap } from '../../common/types/controllers.js';
 import type { SSRCommerceEngine } from '../factories/build-factory.js';
 import type { SSRCommerceEngineOptions } from './build.js';
 import type { SolutionType } from './controller-constants.js';
@@ -10,7 +9,11 @@ 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 { HydrateStaticState, HydrateStaticStateOptions, FetchStaticState };
+export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
+    searchActions: TSearchAction[];
+    controllers: TControllers;
+}
 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/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/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> {
-    searchActions: TSearchAction[];
+    searchAction: TSearchAction;
     controllers: TControllers;
 }
 export type InferStaticState<T extends {

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>>({ searchActions, controllers, }: {
-    searchActions: TSearchAction[];
+export declare function createStaticState<TSearchAction extends UnknownAction, TControllerDefinitions extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>>({ searchAction, controllers, }: {
+    searchAction: TSearchAction;
     controllers: InferControllersMapFromDefinition<TControllerDefinitions>;
 }): EngineStaticState<TSearchAction, InferControllerStaticStateMapFromDefinitions<TControllerDefinitions>>;

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> {
-    searchActions: TSearchAction[];
+    searchAction: TSearchAction;
 }
 /**
  * Creates a new engine from the snapshot of the engine created in SSR with fetchStaticState.