@coveo/quantic 3.30.0 → 3.30.1-pre.cc2819b982

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" | "organizationId" | "url" | "authentication">;
+export declare function pickNonBaseParams<Params extends BaseParam & AuthenticationParam>(req: Params): Omit<Params, "url" | "accessToken" | "organizationId" | "authentication">;
 export declare const unwrapError: (payload: PlatformResponse<AllSearchAPIResponse>) => SearchAPIErrorWithStatusCode;

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

@@ -28,10 +28,10 @@ export declare const getRequestOptions: (req: FilterableCommerceAPIRequest, path
         facets: import("../../../features/commerce/facets/facet-set/interfaces/request.js").AnyFacetRequest[] | undefined;
         sort: import("./sort.js").SortOption | undefined;
     };
-    accessToken: string;
     url: string;
-    method: import("../../platform-client.js").HttpMethods;
     origin: import("../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../platform-client.js").HttpMethods;
     contentType: import("../../platform-client.js").HTTPContentType;
     requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
 };

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

@@ -24,10 +24,10 @@ export declare const buildRecommendationsRequest: (req: CommerceRecommendationsR
         page: number | undefined;
         perPage: number | undefined;
     };
-    accessToken: string;
     url: string;
-    method: import("../../platform-client.js").HttpMethods;
     origin: import("../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../platform-client.js").HttpMethods;
     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

@@ -21,10 +21,10 @@ export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) =
         country: string;
         currency: string;
     };
-    accessToken: string;
     url: string;
-    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../../platform-client.js").HttpMethods;
     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-actions.d.ts

@@ -0,0 +1,15 @@
+import type { NavigatorContext } from '../../app/navigator-context-provider.js';
+import type { StreamAnswerAPIState } from './stream-answer-api-state.js';
+export declare const triggerSearchRequest: import("@reduxjs/toolkit").AsyncThunk<void, {
+    state: StreamAnswerAPIState;
+    navigatorContext: NavigatorContext;
+}, {
+    state?: unknown;
+    dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction>;
+    extra?: unknown;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;

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

@@ -1,5 +1,4 @@
-import { type ThunkDispatch, type UnknownAction } from '@reduxjs/toolkit';
-import { type NavigatorContext } from '../../app/navigator-context-provider.js';
+import type { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
 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';
@@ -8,97 +7,10 @@ export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: Ge
 export declare const answerApi: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, {
     getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<Partial<SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer">;
 }, "answer", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
-export declare const selectAnswerTriggerParams: ((state: any, ...params: any[]) => {
-    q: any;
-    requestId: any;
-    cannotAnswer: any;
-    analyticsMode: any;
-    actionCause: any;
-}) & {
-    clearCache: () => void;
-    resultsCount: () => number;
-    resetResultsCount: () => void;
-} & {
-    resultFunc: (...resultFuncArgs: readonly any[]) => {
-        q: any;
-        requestId: any;
-        cannotAnswer: any;
-        analyticsMode: any;
-        actionCause: any;
-    };
-    memoizedResultFunc: ((...resultFuncArgs: readonly any[]) => {
-        q: any;
-        requestId: any;
-        cannotAnswer: any;
-        analyticsMode: any;
-        actionCause: any;
-    }) & {
-        clearCache: () => void;
-        resultsCount: () => number;
-        resetResultsCount: () => void;
-    };
-    lastResult: () => {
-        q: any;
-        requestId: any;
-        cannotAnswer: any;
-        analyticsMode: any;
-        actionCause: any;
-    };
-    dependencies: import("reselect").SelectorArray<any>;
-    recomputations: () => number;
-    resetRecomputations: () => void;
-    dependencyRecomputations: () => number;
-    resetDependencyRecomputations: () => void;
-} & {
-    argsMemoize: typeof import("reselect").weakMapMemoize;
-    memoize: typeof import("reselect").weakMapMemoize;
-};
-export declare const constructAnswerQueryParams: (state: StreamAnswerAPIState, usage: "fetch" | "select", 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[];
-    };
-    tab: string;
-    numberOfResults?: number | undefined;
-    firstResult?: number | undefined;
-    queryCorrection?: {
-        enabled: boolean;
-        options: {
-            automaticallyCorrect: "whenNoResults" | "never";
-        };
-    } | undefined;
-    enableDidYouMean?: boolean | undefined;
-    fieldsToInclude?: string[] | undefined;
-    facets?: (import("../../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
-    pipeline?: string | undefined;
-    searchHub?: string | undefined;
-    pipelineRuleParameters: {
-        mlGenerativeQuestionAnswering: {
-            responseFormat: import("../../index.js").GeneratedResponseFormat;
-            citationsFieldToInclude: string[];
-        };
-    };
-    context?: import("../../ssr.index.js").ContextPayload | undefined;
-    enableQuerySyntax?: boolean | undefined;
-    lq?: string | undefined;
-    dq?: string | undefined;
-    cq?: string | undefined;
-    aq?: string | undefined;
-    q: string | undefined;
-};
-export declare const fetchAnswer: (state: StreamAnswerAPIState, navigatorContext: NavigatorContext) => 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 selectAnswer: (state: StreamAnswerAPIState, navigatorContext?: NavigatorContext) => ({
+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 selectAnswer: (params: Partial<SearchRequest>) => (state: import("@reduxjs/toolkit/query").RootState<{
+    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">;
+}, never, "answer">) => ({
     status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
     originalArgs?: undefined | undefined;
     data?: undefined | undefined;
@@ -116,9 +28,9 @@ export declare const selectAnswer: (state: StreamAnswerAPIState, navigatorContex
 }) | ({
     status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
     error: undefined;
-    endpointName: string;
-    originalArgs: Partial<SearchRequest>;
     requestId: string;
+    originalArgs: Partial<SearchRequest>;
+    endpointName: string;
     startedTimeStamp: number;
     data: GeneratedAnswerStream;
     fulfilledTimeStamp: number;
@@ -145,11 +57,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>;
-    requestId: string;
+    endpointName: 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

@@ -11,9 +11,9 @@ export declare const buildGetCaseClassificationsRequest: (req: GetCaseClassifica
             };
         };
     };
-    accessToken: string;
     url: string;
-    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../../platform-client.js").HttpMethods;
     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

@@ -28,9 +28,9 @@ export declare const buildGetDocumentSuggestionsRequest: (req: GetDocumentSugges
             source?: string[];
         } | undefined;
     };
-    accessToken: string;
     url: string;
-    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../../platform-client.js").HttpMethods;
     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

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

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

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

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