@coveo/quantic 3.30.4-pre.fbe332fd49 → 3.30.5-pre.0c1931ccff

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

@@ -1,13 +1,14 @@
 import type { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
+import type { AnswerApiQueryParams } from '../../features/generated-answer/generated-answer-request.js';
 import type { EventSourceMessage } from '../../utils/fetch-event-source/parse.js';
-import type { SearchRequest } from '../search/search/search-request.js';
 import type { GeneratedAnswerStream } from './generated-answer-stream.js';
 import type { StreamAnswerAPIState } from './stream-answer-api-state.js';
 export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StreamAnswerAPIState, unknown, UnknownAction>) => void;
+export declare const buildAnswerEndpoint: (platformEndpoint: string, organizationId: string, answerConfigurationId: string, insightId?: string) => string;
 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">;
+    getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<AnswerApiQueryParams, 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>;
-export declare const fetchAnswer: (fetchAnswerParams: Partial<SearchRequest>) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<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">>, any, any, UnknownAction>;
+export declare const fetchAnswer: (fetchAnswerParams: AnswerApiQueryParams) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<AnswerApiQueryParams, 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">>, any, any, UnknownAction>;
 export declare const selectAnswer: (state: StreamAnswerAPIState) => ({
     status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
     originalArgs?: undefined | undefined;
@@ -27,7 +28,7 @@ export declare const selectAnswer: (state: StreamAnswerAPIState) => ({
     status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
     error: undefined;
     endpointName: string;
-    originalArgs: Partial<SearchRequest>;
+    originalArgs: AnswerApiQueryParams;
     requestId: string;
     startedTimeStamp: number;
     data: GeneratedAnswerStream;
@@ -40,7 +41,7 @@ export declare const selectAnswer: (state: StreamAnswerAPIState) => ({
     isError: false;
 }) | ({
     status: import("@reduxjs/toolkit/query").QueryStatus.pending;
-    originalArgs: Partial<SearchRequest>;
+    originalArgs: AnswerApiQueryParams;
     requestId: string;
     data?: GeneratedAnswerStream | undefined;
     error?: import("@reduxjs/toolkit").SerializedError | import("@reduxjs/toolkit/query").FetchBaseQueryError | undefined;
@@ -58,7 +59,7 @@ export declare const selectAnswer: (state: StreamAnswerAPIState) => ({
     data?: GeneratedAnswerStream | undefined;
     endpointName: string;
     fulfilledTimeStamp?: number | undefined;
-    originalArgs: Partial<SearchRequest>;
+    originalArgs: AnswerApiQueryParams;
     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.d.ts

@@ -1,7 +1,7 @@
 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 { SearchRequest } from '../../api/search/search/search-request.js';
 import type { SearchThunkExtraArguments } from '../../app/search-thunk-extra-arguments.js';
+import type { AnswerApiQueryParams } from '../../features/generated-answer/generated-answer-request.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;
@@ -35,7 +35,7 @@ export declare const updateAnswerConfigurationId: import("@reduxjs/toolkit").Act
 export declare const registerFieldsToIncludeInCitations: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string[]], string[], "generatedAnswer/registerFieldsToIncludeInCitations", never, never>;
 export declare const setIsAnswerGenerated: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: boolean], boolean, "generatedAnswer/setIsAnswerGenerated", never, never>;
 export declare const setCannotAnswer: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: boolean], boolean, "generatedAnswer/setCannotAnswer", never, never>;
-export declare const setAnswerApiQueryParams: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: Partial<SearchRequest>], unknown, "generatedAnswer/setAnswerApiQueryParams", never, never>;
+export declare const setAnswerApiQueryParams: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: AnswerApiQueryParams], unknown, "generatedAnswer/setAnswerApiQueryParams", never, never>;
 interface StreamAnswerArgs {
     setAbortControllerRef: (ref: AbortController) => void;
 }

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

@@ -0,0 +1,209 @@
+/** biome-ignore-all lint/suspicious/noExplicitAny: <mock> */
+import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api-state.js';
+export declare const streamAnswerAPIStateMock: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithATabWithAnExpression: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithoutAnyTab: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithStaticFiltersSelected: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithNonValidFilters: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithoutAnyFilters: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpression: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWithEmptyCQ: {
+    advancedSearchQueries: {
+        cq: string;
+        cqWasSet: boolean;
+        aq: string;
+        aqWasSet: boolean;
+        lq: string;
+        lqWasSet: boolean;
+        dq: string;
+        dqWasSet: boolean;
+        defaultFilters: {
+            cq: string;
+            aq: string;
+            lq: string;
+            dq: string;
+        };
+    };
+    searchHub: string;
+    pipeline: string;
+    answer: import("@reduxjs/toolkit/query").CombinedState<{
+        getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<import("./generated-answer-request.js").AnswerApiQueryParams, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, import("../../api/knowledge/generated-answer-stream.js").GeneratedAnswerStream, "answer">;
+    }, never, "answer">;
+    configuration: import("../configuration/configuration-state.js").ConfigurationState;
+    facetSet?: import("../facets/facet-set/facet-set-state.js").FacetSetState | undefined;
+    dateFacetSet?: import("../facets/range-facets/date-facet-set/date-facet-set-state.js").DateFacetSetState | undefined;
+    numericFacetSet?: import("../facets/range-facets/numeric-facet-set/numeric-facet-set-state.js").NumericFacetSetState | undefined;
+    categoryFacetSet?: import("../facets/category-facet-set/category-facet-set-state.js").CategoryFacetSetState | undefined;
+    automaticFacetSet?: import("../facets/automatic-facet-set/automatic-facet-set-state.js").AutomaticFacetSetState | undefined;
+    facetOptions?: import("../facet-options/facet-options-state.js").FacetOptionsState | undefined;
+    query?: import("../query/query-state.js").QueryState | undefined;
+    tabSet?: import("../tab-set/tab-set-state.js").TabSetState | undefined;
+    staticFilterSet?: import("../static-filter-set/static-filter-set-state.js").StaticFilterSetState | undefined;
+    pagination?: import("../pagination/pagination-state.js").PaginationState | undefined;
+    sortCriteria?: string | undefined;
+    context?: import("../context/context-state.js").ContextState | undefined;
+    dictionaryFieldContext?: import("../dictionary-field-context/dictionary-field-context-state.js").DictionaryFieldContextState | undefined;
+    querySet?: import("../query-set/query-set-state.js").QuerySetState | undefined;
+    debug?: boolean | undefined;
+    facetSearchSet?: import("../facets/facet-search-set/specific/specific-facet-search-set-state.js").SpecificFacetSearchSetState | undefined;
+    categoryFacetSearchSet?: import("../facets/facet-search-set/category/category-facet-search-set-state.js").CategoryFacetSearchSetState | undefined;
+    standaloneSearchBoxSet?: import("../standalone-search-box-set/standalone-search-box-set-state.js").StandaloneSearchBoxSetState | undefined;
+    querySuggest?: import("../query-suggest/query-suggest-state.js").QuerySuggestSet | undefined;
+    search?: import("../search/search-state.js").SearchState | undefined;
+    resultPreview?: import("../result-preview/result-preview-state.js").ResultPreviewState | undefined;
+    didYouMean?: import("../did-you-mean/did-you-mean-state.js").DidYouMeanState | undefined;
+    fields?: import("../fields/fields-state.js").FieldsState | undefined;
+    facetOrder?: import("../facets/facet-order/facet-order-state.js").FacetOrderState | undefined;
+    version?: string | undefined;
+    history?: import("../../app/undoable.js").StateWithHistory<import("../history/history-state.js").HistoryState> | undefined;
+    folding?: import("../folding/folding-state.js").FoldingState | undefined;
+    triggers?: import("../triggers/triggers-state.js").TriggerState | undefined;
+    questionAnswering?: import("../question-answering/question-answering-state.js").QuestionAnsweringState | undefined;
+    recentResults?: import("../recent-results/recent-results-state.js").RecentResultsState | undefined;
+    recentQueries?: import("../recent-queries/recent-queries-state.js").RecentQueriesState | undefined;
+    excerptLength?: import("../excerpt-length/excerpt-length-state.js").ExcerptLengthState | undefined;
+    generatedAnswer: import("./generated-answer-state.js").GeneratedAnswerState;
+    instantResults?: import("../instant-results/instant-results-state.js").InstantResultsState | undefined;
+    insightConfiguration?: import("../insight-configuration/insight-configuration-state.js").InsightConfigurationState | undefined;
+};
+export declare const streamAnswerAPIStateMockWithoutSearchAction: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithAnalyticsEnabled: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithFoldingDisabled: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithFoldingEnabled: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithDictionaryFieldContext: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithExcerptLength: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithQuerySyntaxEnabled: StreamAnswerAPIState;
+export declare const expectedStreamAnswerAPIParam: {
+    q: string;
+    aq: string;
+    cq: string;
+    dq: string;
+    lq: string;
+    enableQuerySyntax: boolean;
+    context: {
+        testKey: string;
+    };
+    pipelineRuleParameters: {
+        mlGenerativeQuestionAnswering: {
+            responseFormat: {
+                contentFormat: string[];
+            };
+            citationsFieldToInclude: never[];
+        };
+    };
+    searchHub: string;
+    facets: ({
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        resultsMustMatch: string;
+        type: string;
+        currentValues: never[];
+        freezeCurrentValues: boolean;
+        isFieldExpanded: boolean;
+        preventAutoSelect: boolean;
+        facetId: string;
+        field: string;
+        rangeAlgorithm?: undefined;
+        generateAutomaticRanges?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    } | {
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        rangeAlgorithm: string;
+        resultsMustMatch: string;
+        currentValues: {
+            start: string;
+            end: string;
+            endInclusive: boolean;
+            state: string;
+        }[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        generateAutomaticRanges: boolean;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    } | {
+        delimitingCharacter: string;
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        basePath: never[];
+        filterByBasePath: boolean;
+        resultsMustMatch: string;
+        currentValues: never[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        rangeAlgorithm?: undefined;
+        generateAutomaticRanges?: undefined;
+    } | {
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        rangeAlgorithm: string;
+        resultsMustMatch: string;
+        currentValues: {
+            endInclusive: boolean;
+            state: string;
+            start: number;
+            end: number;
+        }[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        generateAutomaticRanges: boolean;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    })[];
+    fieldsToInclude: string[];
+    queryCorrection: {
+        enabled: boolean;
+        options: {
+            automaticallyCorrect: string;
+        };
+    };
+    enableDidYouMean: boolean;
+    numberOfResults: number;
+    firstResult: number;
+    tab: string;
+    locale: string;
+    timezone: string;
+    referrer: string;
+    debug: boolean;
+    actionsHistory: never[];
+    sortCriteria: string;
+    facetOptions: {
+        freezeFacetOrder: boolean;
+    };
+    analytics: {
+        actionCause: string;
+        capture: boolean;
+        clientId: string;
+        clientTimestamp: string;
+        customData: undefined;
+        documentLocation: string;
+        documentReferrer: string;
+        originContext: string;
+        source: string[];
+    };
+};

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

@@ -1,85 +1,13 @@
 import type { GeneratedAnswerStreamRequest } from '../../api/generated-answer/generated-answer-request.js';
 import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api-state.js';
+import type { BaseParam } from '../../api/platform-service-params.js';
+import type { SearchRequest } from '../../api/search/search/search-request.js';
+import type { AuthenticationParam, AutomaticFacetsParams } from '../../api/search/search-api-params.js';
 import type { NavigatorContext } from '../../app/navigator-context-provider.js';
 import type { ConfigurationSection, GeneratedAnswerSection, SearchSection } from '../../state/state-sections.js';
 type StateNeededByGeneratedAnswerStream = ConfigurationSection & SearchSection & GeneratedAnswerSection;
+export interface AnswerApiQueryParams extends Omit<SearchRequest, keyof (BaseParam & AuthenticationParam & AutomaticFacetsParams)> {
+}
 export declare const buildStreamingRequest: (state: StateNeededByGeneratedAnswerStream) => Promise<GeneratedAnswerStreamRequest>;
-export declare const constructAnswerAPIQueryParams: (state: StreamAnswerAPIState, navigatorContext: NavigatorContext) => {
-    analytics?: {
-        actionCause?: string;
-        customData?: object;
-        clientId: string;
-        deviceId?: string;
-        pageId?: string;
-        clientTimestamp: string;
-        documentReferrer: string | null;
-        originContext: string;
-        userDisplayName?: string;
-        documentLocation?: string | null;
-        trackingId?: string;
-        capture?: boolean;
-        source?: string[];
-    };
-    facetOptions?: {
-        freezeFacetOrder: boolean;
-    } | undefined;
-    sortCriteria: string | undefined;
-    dictionaryFieldContext?: import("../dictionary-field-context/dictionary-field-context-state.js").DictionaryFieldContextPayload | undefined;
-    excerptLength?: number | undefined;
-    filterField?: string | undefined;
-    childField?: string | undefined;
-    parentField?: string | undefined;
-    filterFieldRange?: number | undefined;
-    actionsHistory: import("../../api/analytics/coveo.analytics/history-store.js").HistoryElement[];
-    referrer: string;
-    debug?: boolean | undefined;
-    tab: string;
-    locale: string;
-    timezone: string;
-    numberOfResults?: number | undefined;
-    firstResult?: number | undefined;
-    queryCorrection?: {
-        enabled: boolean;
-        options: {
-            automaticallyCorrect: "never" | "whenNoResults";
-        };
-    } | undefined;
-    enableDidYouMean?: boolean | undefined;
-    fieldsToInclude?: string[] | undefined;
-    facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | {
-        currentValues: {
-            start: string;
-            end: string;
-            endInclusive: boolean;
-            state: import("../../ssr.index.js").FacetValueState;
-            previousState?: import("../../ssr.index.js").FacetValueState;
-        }[];
-        sortCriteria: import("../../ssr.index.js").RangeFacetSortCriterion;
-        rangeAlgorithm: import("../../ssr.index.js").RangeFacetRangeAlgorithm;
-        facetId: string;
-        field: string;
-        filterFacetCount: boolean;
-        injectionDepth: number;
-        numberOfValues: number;
-        preventAutoSelect: boolean;
-        resultsMustMatch: import("../../ssr.index.js").FacetResultsMustMatch;
-        generateAutomaticRanges: boolean;
-        type: "dateRange";
-    })[] | undefined;
-    pipeline?: string | undefined;
-    searchHub?: string | undefined;
-    pipelineRuleParameters: {
-        mlGenerativeQuestionAnswering: {
-            responseFormat: import("./generated-response-format.js").GeneratedResponseFormat;
-            citationsFieldToInclude: string[];
-        };
-    };
-    context?: import("../context/context-state.js").ContextPayload | undefined;
-    enableQuerySyntax?: boolean | undefined;
-    lq?: string | undefined;
-    dq?: string | undefined;
-    cq?: string | undefined;
-    aq?: string | undefined;
-    q: string | undefined;
-};
+export declare const constructAnswerAPIQueryParams: (state: StreamAnswerAPIState, navigatorContext: NavigatorContext) => AnswerApiQueryParams;
 export {};

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

@@ -1,5 +1,5 @@
 import type { GeneratedAnswerCitation } from '../../api/generated-answer/generated-answer-event-payload.js';
-import type { SearchRequest } from '../../api/search/search/search-request.js';
+import type { AnswerApiQueryParams } from '../../features/generated-answer/generated-answer-request.js';
 import type { GeneratedContentFormat, GeneratedResponseFormat } from './generated-response-format.js';
 /**
  * A scoped and simplified part of the headless state that is relevant to the `GeneratedAnswer` component.
@@ -90,6 +90,6 @@ export interface GeneratedAnswerState {
     /**
      * The query parameters used for the answer API request cache key
      */
-    answerApiQueryParams?: Partial<SearchRequest>;
+    answerApiQueryParams?: AnswerApiQueryParams;
 }
 export declare function getGeneratedAnswerInitialState(): GeneratedAnswerState;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts

@@ -24,7 +24,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, eve
     facetOptions?: import("../../facet-options/facet-options.js").FacetOptions;
     numberOfResults?: number;
     firstResult?: number;
-    facets?: (import("../../facets/facet-set/interfaces/request.js").FacetRequest | import("../../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
+    facets?: (import("../../facets/facet-set/interfaces/request.js").FacetRequest | import("../../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
     cq?: string;
     queryCorrection?: {
         enabled?: boolean;

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

@@ -25,7 +25,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, nav
     facetOptions?: import("../facet-options/facet-options.js").FacetOptions;
     numberOfResults?: number;
     firstResult?: number;
-    facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
+    facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
     cq?: string;
     queryCorrection?: {
         enabled?: boolean;

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

@@ -7,6 +7,7 @@ export interface CartBuildProps {
 export interface CartDefinition extends UniversalControllerDefinitionWithProps<Cart, CartBuildProps> {
 }
 /**
+ * @deprecated In the future, the context controller will be included by default in the engine definition. You will no longer need to define it manually
  * Defines a `Cart` controller instance.
  * @group Definers
  *

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

@@ -4,6 +4,7 @@ export type { Context, ContextProps, ContextState, View, UserLocation, ContextOp
 export interface ContextDefinition extends UniversalControllerDefinitionWithProps<Context, ContextOptions> {
 }
 /**
+ * @deprecated In the future, the context controller will be included by default in the engine definition. You will no longer need to define it manually
  * Defines a `Context` controller instance.
  * @group Definers
  *

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

@@ -5,6 +5,7 @@ import type { CommerceSearchParameters } from '../../../../features/commerce/sea
 import type { ControllerDefinitionOption, SubControllerDefinitionWithProps } from '../../types/controller-definitions.js';
 export type { ParameterManager, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, CommerceSearchParameters, };
 /**
+ * @deprecated In the future, the parameterManager controller will be included by default in the engine definition. You will no longer need to define it manually
  * Defines a `ParameterManager` controller instance.
  * @group Definers
  *

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

@@ -1,12 +1,16 @@
 /**
  * Utility functions to be used for Commerce Server Side Rendering.
  */
-import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
+import type { CommerceEngineOptions as OriginalCommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import { type CommerceEngineDefinitionOptions } from '../factories/build-factory.js';
 import { SolutionType } from '../types/controller-constants.js';
 import type { ControllerDefinitionsMap } from '../types/controller-definitions.js';
 import type { EngineDefinition } from '../types/engine.js';
+/**
+ * @deprecated use `SSRCommerceEngineOptions` type instead.
+ */
+export type CommerceEngineOptions = OriginalCommerceEngineOptions;
 export interface CommerceEngineDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> extends EngineDefinition<TControllers, CommerceEngineOptions, TSolutionType> {
 }
 /**

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

@@ -15,7 +15,26 @@ export interface SSRCommerceEngine extends CommerceEngine {
      */
     waitForRequestCompletedAction(): Promise<Action>[];
 }
-export type CommerceEngineDefinitionOptions<TControllers extends ControllerDefinitionsMap<Controller> = ControllerDefinitionsMap<Controller>> = EngineDefinitionOptions<CommerceEngineOptions, TControllers>;
+/**
+ * SSR-specific commerce engine options with deprecated context property.
+ */
+export type SSRCommerceEngineOptions = Omit<CommerceEngineOptions, 'configuration'> & {
+    configuration: Omit<CommerceEngineOptions['configuration'], 'context'> & {
+        /**
+         * @deprecated In the future major release, context should be provided through `fetchStaticState` rather than in the engine definition.
+         *
+         * @example
+         * ```ts
+         * engineDefinition = defineCommerceEngine({...});
+         * engineDefinition.fetchStaticState({
+         *   context: {...},
+         * });
+         * ```
+         */
+        context: CommerceEngineOptions['configuration']['context'];
+    };
+};
+export type CommerceEngineDefinitionOptions<TControllers extends ControllerDefinitionsMap<Controller> = ControllerDefinitionsMap<Controller>> = EngineDefinitionOptions<SSRCommerceEngineOptions, TControllers>;
 export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <T extends SolutionType>(solutionType: T) => (...[buildOptions]: BuildParameters<TControllerDefinitions>) => Promise<{
     engine: SSRCommerceEngine;
     controllers: import("../types/controller-inference.js").InferControllersMapFromDefinition<TControllerDefinitions, T>;

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

@@ -12,9 +12,18 @@ import type { Kind } from './kind.js';
 export type { EngineDefinitionBuildResult, HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
 export type RecommendationControllerSettings = {
     /**
+     * @deprecated In the next major version, recommendation controllers will be enabled by simply including their names in the `recommendations` array when calling `fetchStaticState`, rather than using this `enabled` property.
+     *
      * Toggle to enable or disable the recommendation controller.
      * When set to `true`, the controller will perform a recommendation request server-side.
      *
+     * @example
+     * ```ts
+     * await recommendationEngineDefinition.fetchStaticState({
+     *   recommendations: ['popularBought', 'popularViewed']
+     * });
+     * ```
+     *
      * @default false
      */
     enabled?: boolean;

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

@@ -39,6 +39,8 @@ export interface EngineDefinition<TControllers extends ControllerDefinitionsMap<
      */
     hydrateStaticState: HydrateStaticState<InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerPropsMapFromDefinitions<TControllers>, TControllers, TSolutionType>;
     /**
+     * @deprecated This method is deprecated and will be removed in a future major version. Use the `fetchStaticState` method instead.
+     *
      * Builds an engine and its controllers from an engine definition.
      */
     build: Build<TEngineOptions, InferControllersMapFromDefinition<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>, TControllers, TSolutionType>;