@coveo/quantic 3.30.0 → 3.30.1-pre.0b6ca95bda

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/utils/testingUtils.d.ts

@@ -0,0 +1,8 @@
+type DateRangeCurrentValues = {
+    start: string;
+    end: string;
+    endInclusive: boolean;
+    state: string;
+};
+export declare function addSecondsToFacetsTimestamps(facetsCurrentValues: DateRangeCurrentValues[], seconds: number): DateRangeCurrentValues[];
+export {};

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

@@ -2,7 +2,6 @@ import type { PayloadAction } from '@reduxjs/toolkit';
 import type { InsightEngine } from '../../app/insight-engine/insight-engine.js';
 import { type SetAttachedResultsActionCreatorPayload } from './attached-results-actions.js';
 import type { AttachedResult } from './attached-results-state.js';
-export type { SetAttachedResultsActionCreatorPayload, AttachedResult };
 /**
  * The attached results action creators.
  *
@@ -27,6 +26,20 @@ export interface AttachedResultsActionCreators {
      * @returns A dispatchable action.
      */
     setAttachedResults(payload: SetAttachedResultsActionCreatorPayload): PayloadAction<SetAttachedResultsActionCreatorPayload>;
+    /**
+     * Creates an action that attaches a result to a case.
+     *
+     * @param payload - The action creator payload containing the result to attach.
+     * @returns A dispatchable action.
+     */
+    attachResult(payload: AttachedResult): PayloadAction<AttachedResult>;
+    /**
+     * Creates an action that detaches a result from a case.
+     *
+     * @param payload - The action creator payload containing the result to detach.
+     * @returns A dispatchable action.
+     */
+    detachResult(payload: AttachedResult): PayloadAction<AttachedResult>;
 }
 /**
  * Loads the `attachedResults` reducer and returns possible action creators.

package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-actions.d.ts

@@ -9,13 +9,6 @@ export interface SetAttachedResultsActionCreatorPayload {
      */
     loading?: boolean;
 }
-interface SetAttachToCaseAttachActionCreatorPayload {
-    result: AttachedResult;
-}
-interface SetAttachToCaseDetachActionCreatorPayload {
-    result: AttachedResult;
-}
 export declare const setAttachedResults: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetAttachedResultsActionCreatorPayload], SetAttachedResultsActionCreatorPayload, "insight/attachToCase/setAttachedResults", never, never>;
-export declare const attachResult: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetAttachToCaseAttachActionCreatorPayload], SetAttachToCaseAttachActionCreatorPayload | SetAttachToCaseDetachActionCreatorPayload, "insight/attachToCase/attach", never, never>;
-export declare const detachResult: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetAttachToCaseDetachActionCreatorPayload], SetAttachToCaseAttachActionCreatorPayload | SetAttachToCaseDetachActionCreatorPayload, "insight/attachToCase/detach", never, never>;
-export {};
+export declare const attachResult: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: AttachedResult], AttachedResult, "insight/attachToCase/attach", never, never>;
+export declare const detachResult: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: AttachedResult], AttachedResult, "insight/attachToCase/detach", never, never>;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-analytics-actions-loader.d.ts

@@ -0,0 +1,35 @@
+import type { Result } from '../../api/search/search/result.js';
+import type { InsightEngine } from '../../app/insight-engine/insight-engine.js';
+import type { InsightAction } from '../analytics/analytics-utils.js';
+/**
+ * The attached results action creators.
+ *
+ * @group Actions
+ * @category AttachedResults
+ */
+export interface AttachedResultsAnalyticsActionCreators {
+    /**
+     * Creates an analytics action for when a case attach event occurs.
+     *
+     * @param result - The result to attach.
+     * @returns A dispatchable action.
+     */
+    logCaseAttach(result: Result): InsightAction;
+    /**
+     * Creates an analytics action for when a case detach event occurs.
+     *
+     * @param result - The result to detach.
+     * @returns A dispatchable action.
+     */
+    logCaseDetach(result: Result): InsightAction;
+}
+/**
+ * Loads the `attachedResults` reducer and returns possible analytics action creators.
+ *
+ * @param engine - The headless engine.
+ * @returns An object holding the analytics action creators.
+ *
+ * @group Actions
+ * @category AttachedResults
+ */
+export declare function loadAttachedResultsAnalyticsActions(engine: InsightEngine): AttachedResultsAnalyticsActionCreators;

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

@@ -0,0 +1,72 @@
+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;
+};
+/**
+ * If answer params are not available, returns `skipToken`, a special value from RTK Query
+ * that tells RTK Query to "skip" running a query or selector until the params are ready.
+ *
+ * @see https://redux-toolkit.js.org/rtk-query/usage-with-typescript#skipping-queries-with-typescript-using-skiptoken
+ */
+export declare const selectAnswerApiQueryParams: ((state: any, ...params: any[]) => any) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (...resultFuncArgs: readonly any[]) => any;
+    memoizedResultFunc: ((...resultFuncArgs: readonly any[]) => any) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => any;
+    dependencies: import("reselect").SelectorArray<any>;
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    argsMemoize: typeof import("reselect").weakMapMemoize;
+    memoize: typeof import("reselect").weakMapMemoize;
+};

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

@@ -1,5 +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 { SearchRequest } from '../../api/search/search/search-request.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';
@@ -34,6 +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>;
 interface StreamAnswerArgs {
     setAbortControllerRef: (ref: AbortController) => void;
 }