@coveo/quantic 3.14.1 → 3.14.3

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

@@ -123,6 +123,12 @@ export interface BaseProduct {
     /**
      * The length and offset of each word to highlight in the product excerpt string.
      */
+    excerptHighlights?: HighlightKeyword[];
+    /**
+     * @deprecated Use `excerptHighlights` instead.
+     *
+     * The length and offset of each word to highlight in the product excerpt string.
+     */
     excerptsHighlights?: HighlightKeyword[];
 }
 export interface Product extends BaseProduct {

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

@@ -1,8 +1,8 @@
-import { EventSourceMessage } from '@microsoft/fetch-event-source';
 import { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
 import { GeneratedContentFormat } from '../../features/generated-answer/generated-response-format.js';
 import { SearchAppState } from '../../state/search-app-state.js';
 import { ConfigurationSection, GeneratedAnswerSection, InsightConfigurationSection } from '../../state/state-sections.js';
+import { EventSourceMessage } from '../../utils/fetch-event-source/parse.js';
 import { GeneratedAnswerCitation } from '../generated-answer/generated-answer-event-payload.js';
 import { SearchRequest } from '../search/search/search-request.js';
 export type StateNeededByAnswerAPI = {

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

@@ -39,6 +39,15 @@ export interface EngineDefinition<TControllers extends ControllerDefinitionsMap<
      * Note: The implementation specifics of the navigator context provider depend on the Node.js framework being utilized. It is the developer's responsibility to appropriately define and implement the navigator context provider to ensure accurate navigation context is available throughout the application. If the user fails to provide a navigator context provider, a warning will be logged either on the server or the browser console.
      */
     setNavigatorContextProvider: (navigatorContextProvider: NavigatorContextProvider) => void;
+    /**
+     * Returns the access token.
+     */
+    getAccessToken: () => string;
+    /**
+     * Updates the access token.
+     * @param accessToken - The access token to update.
+     */
+    setAccessToken: (accessToken: string) => void;
 }
 export type InferStaticState<T extends {
     fetchStaticState(...args: unknown[]): Promise<unknown>;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/category-facet/headless-core-category-facet-options.d.ts

@@ -41,13 +41,15 @@ export interface CategoryFacetOptions {
     /**
      * Whether to exclude the parents of folded results when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all of the potential facet values.
      *
-     * **Note:** A high `injectionDepth` may reduce facet request performance.
+     * Note: A high `injectionDepth` may reduce facet request performance.
      *
      * Minimum: `0`
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/facet/headless-core-facet-options.d.ts

@@ -24,13 +24,15 @@ export interface FacetOptions {
     /**
      * Whether to exclude the parents of folded results when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/date-facet/headless-core-date-filter.d.ts

@@ -24,13 +24,15 @@ export interface DateFilterOptions {
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/date-facet/headless-date-facet-options.d.ts

@@ -38,13 +38,15 @@ export interface DateFacetOptions {
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-filter.d.ts

@@ -24,13 +24,15 @@ export interface NumericFilterOptions {
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-numeric-facet-options.d.ts

@@ -42,13 +42,15 @@ export interface NumericFacetOptions {
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/facet/headless-facet-options.d.ts

@@ -24,13 +24,15 @@ export interface FacetOptions {
     /**
      * Whether to exclude the parents of folded results when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/category-facet-set/category-facet-set-actions.d.ts

@@ -41,13 +41,15 @@ export interface RegisterCategoryFacetActionCreatorPayload {
     /**
      * Whether to exclude the parents of folded results when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-api/request.d.ts

@@ -9,12 +9,15 @@ export interface BaseFacetRequest {
     /** The field whose values you want to display in the facet.*/
     field: string;
     /** Whether to exclude folded result parents when estimating the result count for each facet value.
+     *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount: boolean;
     /** The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-set/facet-set-actions.d.ts

@@ -24,13 +24,15 @@ export interface RegisterFacetActionCreatorPayload {
     /**
      * Whether to exclude the parents of folded results when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/date-facet-set/date-facet-actions.d.ts

@@ -39,13 +39,15 @@ export interface RegisterDateFacetActionCreatorPayload {
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/numeric-facet-set/numeric-facet-actions.d.ts

@@ -39,13 +39,15 @@ export interface RegisterNumericFacetActionCreatorPayload {
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
      *
+     * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+     *
      * @defaultValue `true`
      */
     filterFacetCount?: boolean;
     /**
      * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
      *
-     * Note: A high injectionDepth may negatively impact the facet request performance.
+     * Note: A high `injectionDepth` may negatively impact the facet request performance.
      *
      * Minimum: `0`
      *

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

@@ -31,6 +31,7 @@ export declare const updateResponseFormat: import("@reduxjs/toolkit").ActionCrea
 export declare const updateAnswerConfigurationId: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string], string, "knowledge/updateAnswerConfigurationId", never, never>;
 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>;
 interface StreamAnswerArgs {
     setAbortControllerRef: (ref: AbortController) => void;
 }

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

@@ -78,6 +78,10 @@ export interface GeneratedAnswerState {
      * Whether the answer is expanded.
      */
     expanded: boolean;
+    /**
+     * Whether an answer cannot be generated after a query is executed.
+     */
+    cannotAnswer: boolean;
     /**
      * The answer configuration unique identifier.
      */

package/force-app/main/default/staticresources/coveoheadless/definitions/utils/fetch-event-source/fetch.d.ts

@@ -0,0 +1,44 @@
+import { EventSourceMessage } from './parse.js';
+export declare const EventStreamContentType = "text/event-stream";
+export interface FetchEventSourceInit extends RequestInit {
+    /**
+     * The request headers. FetchEventSource only supports the Record<string,string> format.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Called when a response is received. Use this to validate that the response
+     * actually matches what you expect (and throw if it doesn't.) If not provided,
+     * will default to a basic validation to ensure the content-type is text/event-stream.
+     */
+    onopen?: (response: Response) => Promise<void>;
+    /**
+     * Called when a message is received. NOTE: Unlike the default browser
+     * EventSource.onmessage, this callback is called for _all_ events,
+     * even ones with a custom `event` field.
+     */
+    onmessage?: (ev: EventSourceMessage) => void;
+    /**
+     * Called when a response finishes. If you don't expect the server to kill
+     * the connection, you can throw an exception here and retry using onerror.
+     */
+    onclose?: () => void;
+    /**
+     * Called when there is any error making the request / processing messages /
+     * handling callbacks etc. Use this to control the retry strategy: if the
+     * error is fatal, rethrow the error inside the callback to stop the entire
+     * operation. Otherwise, you can return an interval (in milliseconds) after
+     * which the request will automatically retry (with the last-event-id).
+     * If this callback is not specified, or it returns undefined, fetchEventSource
+     * will treat every error as retryable and will try again after 1 second.
+     */
+    onerror?: (err: unknown) => number | null | undefined | void;
+    /**
+     * If true, will keep the request open even if the document is hidden.
+     * By default, fetchEventSource will close the request and reopen it
+     * automatically when the document becomes visible again.
+     */
+    openWhenHidden?: boolean;
+    /** The Fetch function to use. Defaults to window.fetch */
+    fetch?: typeof fetch;
+}
+export declare function fetchEventSource(input: RequestInfo, { signal: inputSignal, headers: inputHeaders, onopen: inputOnOpen, onmessage, onclose, onerror, openWhenHidden, fetch: inputFetch, ...rest }: FetchEventSourceInit): Promise<void>;

package/force-app/main/default/staticresources/coveoheadless/definitions/utils/fetch-event-source/index.d.ts

@@ -0,0 +1,2 @@
+export { fetchEventSource, type FetchEventSourceInit, EventStreamContentType, } from './fetch.js';
+export { type EventSourceMessage } from './parse.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/utils/fetch-event-source/parse.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Represents a message sent in an event stream
+ * https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format
+ */
+export interface EventSourceMessage {
+    /** The event ID to set the EventSource object's last event ID value. */
+    id: string;
+    /** A string identifying the type of event described. */
+    event: string;
+    /** The event data */
+    data: string;
+    /** The reconnection interval (in milliseconds) to wait before retrying the connection */
+    retry?: number;
+}
+/**
+ * Converts a ReadableStream into a callback pattern.
+ * @param stream The input ReadableStream.
+ * @param onChunk A function that will be called on each new byte chunk in the stream.
+ * @returns {Promise<void>} A promise that will be resolved when the stream closes.
+ */
+export declare function getBytes(stream: ReadableStream<Uint8Array>, onChunk: (arr: Uint8Array) => void): Promise<void>;
+/**
+ * Parses arbitrary byte chunks into EventSource line buffers.
+ * Each line should be of the format "field: value" and ends with \r, \n, or \r\n.
+ * @param onLine A function that will be called on each new EventSource line.
+ * @returns A function that should be called for each incoming byte chunk.
+ */
+export declare function getLines(onLine: (line: Uint8Array, fieldLength: number) => void): (arr: Uint8Array) => void;
+/**
+ * Parses line buffers into EventSourceMessages.
+ * @param onId A function that will be called on each `id` field.
+ * @param onRetry A function that will be called on each `retry` field.
+ * @param onMessage A function that will be called on each message.
+ * @returns A function that should be called for each incoming line buffer.
+ */
+export declare function getMessages(onId: (id: string) => void, onRetry: (retry: number) => void, onMessage?: (msg: EventSourceMessage) => void): (line: Uint8Array, fieldLength: number) => void;