@coveo/quantic 3.22.2 → 3.23.0-pre.1c8addde3a

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

@@ -1,9 +1,8 @@
-import { AnalyticsClientSendEventHook, IRuntimeEnvironment, history } from 'coveo.analytics';
+import { AnalyticsClientSendEventHook, IRuntimeEnvironment } from 'coveo.analytics';
 import { Logger } from 'pino';
 import { PreprocessRequest } from '../preprocess-request.js';
 export declare const getVisitorID: (options: {
     runtimeEnvironment?: IRuntimeEnvironment;
 }) => Promise<string>;
-export declare const historyStore: history.HistoryStore;
 export declare const wrapPreprocessRequest: (logger: Logger, preprocessRequest?: PreprocessRequest) => ((request: import("../preprocess-request.js").PlatformRequestOptions, clientOrigin: import("../preprocess-request.js").PlatformClientOrigin, metadata?: import("../preprocess-request.js").RequestMetadata | undefined) => import("../preprocess-request.js").PlatformRequestOptions | Promise<import("../preprocess-request.js").PlatformRequestOptions>) | undefined;
 export declare const wrapAnalyticsClientSendEventHook: (logger: Logger, hook: AnalyticsClientSendEventHook) => (...args: Parameters<AnalyticsClientSendEventHook>) => any;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/coveo.analytics/cookie.d.ts

@@ -0,0 +1,5 @@
+export declare class Cookie {
+    static set(name: string, value: string, expire?: number): void;
+    static get(name: string): string | null;
+    static erase(name: string): void;
+}

package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/coveo.analytics/detector.d.ts

@@ -0,0 +1,5 @@
+export declare function hasNavigator(): boolean;
+export declare function hasDocument(): boolean;
+export declare function hasLocalStorage(): boolean;
+export declare function hasSessionStorage(): boolean;
+export declare function hasCookieStorage(): boolean;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/coveo.analytics/history-store.d.ts

@@ -0,0 +1,41 @@
+import { WebStorage } from './storage.js';
+export declare const STORE_KEY: string;
+export declare const MAX_NUMBER_OF_HISTORY_ELEMENTS: number;
+export declare const MIN_THRESHOLD_FOR_DUPLICATE_VALUE: number;
+export declare const MAX_VALUE_SIZE = 75;
+export declare class HistoryStore {
+    private static instance;
+    static getInstance(store?: WebStorage): HistoryStore;
+    private store;
+    private constructor();
+    /**
+     * @deprecated Synchronous method is deprecated, use addElementAsync instead. This method will NOT work with react-native.
+     */
+    addElement(elem: HistoryElement): void;
+    addElementAsync(elem: HistoryElement): Promise<void>;
+    /**
+     * @deprecated Synchronous method is deprecated, use getHistoryAsync instead. This method will NOT work with react-native.
+     */
+    getHistory(): HistoryElement[];
+    getHistoryAsync(): Promise<HistoryElement[]>;
+    private getHistoryWithInternalTime;
+    private getHistoryWithInternalTimeAsync;
+    setHistory(history: HistoryElement[]): void;
+    clear(): void;
+    getMostRecentElement(): HistoryElement | null;
+    private cropQueryElement;
+    private isValidEntry;
+    private stripInternalTime;
+    private stripEmptyQuery;
+    private stripEmptyQueries;
+}
+export interface HistoryElement {
+    name: string;
+    value?: string;
+    time: string;
+    internalTime?: number;
+}
+export interface HistoryViewElement extends HistoryElement {
+    title?: string;
+}
+export default HistoryStore;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/coveo.analytics/storage.d.ts

@@ -0,0 +1,24 @@
+export declare const preferredStorage: WebStorage | null;
+export interface WebStorage {
+    getItem(key: string): string | null | Promise<string | null>;
+    removeItem(key: string): void;
+    setItem(key: string, data: string): void | Promise<void>;
+}
+export declare function getAvailableStorage(): WebStorage;
+export declare class CookieStorage implements WebStorage {
+    static prefix: string;
+    getItem(key: string): string | null;
+    removeItem(key: string): void;
+    setItem(key: string, data: string, expire?: number): void;
+}
+export declare class CookieAndLocalStorage implements WebStorage {
+    private cookieStorage;
+    getItem(key: string): string | null;
+    removeItem(key: string): void;
+    setItem(key: string, data: string): void;
+}
+export declare class NullStorage implements WebStorage {
+    getItem(_key: string): string | null;
+    removeItem(_key: string): void;
+    setItem(_key: string, _data: string): void;
+}

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

@@ -1,5 +1,5 @@
 import { AnalyticsClientSendEventHook, InsightClientProvider, CoveoInsightClient } from 'coveo.analytics';
-import { SearchEventRequest } from 'coveo.analytics/dist/definitions/events.js';
+import type { SearchEventRequest } from 'coveo.analytics/dist/definitions/events.js';
 import { Logger } from 'pino';
 import { SectionNeededForFacetMetadata } from '../../features/facets/facet-set/facet-set-analytics-actions-utils.js';
 import { InsightAppState } from '../../state/insight-app-state.js';

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

@@ -1,5 +1,5 @@
 import { SearchPageClientProvider } from 'coveo.analytics';
-import { SearchEventRequest } from 'coveo.analytics/dist/definitions/events.js';
+import type { SearchEventRequest } from 'coveo.analytics/dist/definitions/events.js';
 import { ConfigurationSection, ContextSection, PipelineSection, RecommendationSection, SearchHubSection } from '../../state/state-sections.js';
 import { BaseAnalyticsProvider } from './base-analytics.js';
 export type StateNeededByRecommendationAnalyticsProvider = ConfigurationSection & Partial<SearchHubSection & PipelineSection & ContextSection & RecommendationSection>;

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

@@ -1,5 +1,5 @@
 import { CoveoSearchPageClient, SearchPageClientProvider, AnalyticsClientSendEventHook } from 'coveo.analytics';
-import { SearchEventRequest } from 'coveo.analytics/dist/definitions/events.js';
+import type { SearchEventRequest } from 'coveo.analytics/dist/definitions/events.js';
 import { Logger } from 'pino';
 import { FacetSortCriterion } from '../../features/facets/facet-set/interfaces/request.js';
 import { DateFacetValue } from '../../features/facets/range-facets/date-facet-set/interfaces/response.js';

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

@@ -97,6 +97,7 @@ export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI,
             citationsFieldToInclude: string[];
         };
     };
+    context?: import("../../ssr.index.js").ContextPayload | undefined;
     lq?: string | undefined;
     dq?: string | undefined;
     cq?: string | undefined;

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

@@ -66,6 +66,9 @@ export declare const expectedStreamAnswerAPIParam: {
     cq: string;
     dq: string;
     lq: string;
+    context: {
+        testKey: string;
+    };
     pipelineRuleParameters: {
         mlGenerativeQuestionAnswering: {
             responseFormat: {
@@ -186,6 +189,9 @@ export declare const expectedStreamAnswerAPIParamWithATabWithAnExpression: {
     aq: string;
     dq: string;
     lq: string;
+    context: {
+        testKey: string;
+    };
     pipelineRuleParameters: {
         mlGenerativeQuestionAnswering: {
             responseFormat: {
@@ -305,6 +311,9 @@ export declare const expectedStreamAnswerAPIParamWithoutAnyTab: {
     cq: string;
     dq: string;
     lq: string;
+    context: {
+        testKey: string;
+    };
     pipelineRuleParameters: {
         mlGenerativeQuestionAnswering: {
             responseFormat: {
@@ -423,6 +432,9 @@ export declare const expectedStreamAnswerAPIParamWithStaticFiltersSelected: {
     aq: string;
     dq: string;
     lq: string;
+    context: {
+        testKey: string;
+    };
     pipelineRuleParameters: {
         mlGenerativeQuestionAnswering: {
             responseFormat: {
@@ -542,6 +554,9 @@ export declare const expectedStreamAnswerAPIParamWithStaticFiltersAndTabExpressi
     aq: string;
     dq: string;
     lq: string;
+    context: {
+        testKey: string;
+    };
     pipelineRuleParameters: {
         mlGenerativeQuestionAnswering: {
             responseFormat: {
@@ -661,6 +676,9 @@ export declare const expectedStreamAnswerAPIParamWithStaticFiltersAndTabExpressi
     aq: string;
     dq: string;
     lq: string;
+    context: {
+        testKey: string;
+    };
     pipelineRuleParameters: {
         mlGenerativeQuestionAnswering: {
             responseFormat: {

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

@@ -1,4 +1,4 @@
-import { AnalyticsClientOrigin } from 'coveo.analytics/dist/definitions/client/analyticsRequestClient.js';
+import type { AnalyticsClientOrigin } from 'coveo.analytics/dist/definitions/client/analyticsRequestClient.js';
 import { CommerceApiMethod } from './commerce/commerce-metadata.js';
 import { SearchApiMethod, SearchOrigin } from './search/search-metadata.js';
 export interface PlatformRequestOptions extends RequestInit {

package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/search-api-params.d.ts

@@ -1,8 +1,8 @@
-import { history } from 'coveo.analytics';
 import { FacetOptions } from '../../features/facet-options/facet-options.js';
 import { AutomaticFacetRequest } from '../../features/facets/automatic-facet-set/interfaces/request.js';
 import { AnyFacetRequest } from '../../features/facets/generic/interfaces/generic-facet-request.js';
 import { GeneratedContentFormat } from '../../features/generated-answer/generated-response-format.js';
+import { HistoryElement } from '../analytics/coveo.analytics/history-store.js';
 import { HTTPContentType, HttpMethods, PlatformClientCallOptions } from '../platform-client.js';
 import { BaseParam } from '../platform-service-params.js';
 export interface QueryParam {
@@ -79,7 +79,7 @@ export interface MaximumAgeParam {
     maximumAge: number;
 }
 export interface ActionsHistoryParam {
-    actionsHistory?: history.HistoryElement[];
+    actionsHistory?: HistoryElement[];
 }
 export interface TimezoneParam {
     timezone: string;

package/force-app/main/default/staticresources/coveoheadless/definitions/app/navigator-context-provider.d.ts

@@ -2,6 +2,14 @@
  * The `NavigatorContext` interface represents the context of the browser client.
  */
 export interface NavigatorContext {
+    /**
+     * The`X-Forwarded-For` header.
+     * This header is used to identify the originating IP address of a client.
+     * See [X-Forwarded-For](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For)
+     *
+     * **Note:** This property is only relevant for Server-Side Rendering (SSR) use cases.
+     */
+    forwardedFor?: string;
     /**
      * The URL of the page that referred the user to the current page.
      * See [Referer](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer)

package/force-app/main/default/staticresources/coveoheadless/definitions/app/ssr-engine/augment-preprocess-request.d.ts

@@ -0,0 +1,9 @@
+import { PlatformClientOrigin, PlatformRequestOptions, PreprocessRequest, RequestMetadata } from '../../api/preprocess-request.js';
+import { LoggerOptions } from '../logger.js';
+import { NavigatorContextProvider } from '../navigator-context-provider.js';
+export interface AugmentPreprocessRequestOptions {
+    preprocessRequest?: PreprocessRequest;
+    navigatorContextProvider?: NavigatorContextProvider;
+    loggerOptions?: LoggerOptions;
+}
+export declare function augmentPreprocessRequestWithForwardedFor(options: AugmentPreprocessRequestOptions): (request: PlatformRequestOptions, clientOrigin: PlatformClientOrigin, metadata?: RequestMetadata) => Promise<PlatformRequestOptions>;

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

@@ -1,4 +1,4 @@
-import { SearchPageEvents as LegacySearchPageEvents } from 'coveo.analytics/dist/definitions/searchPage/searchPageEvents.js';
+import type { SearchPageEvents as LegacySearchPageEvents } from 'coveo.analytics/dist/definitions/searchPage/searchPageEvents.js';
 import { Result } from '../../api/search/search/result.js';
 import { OmniboxSuggestionMetadata } from '../query-suggest/query-suggest-analytics-actions.js';
 import { SearchAction } from '../search/search-actions.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/analytics-utils.d.ts

@@ -2,8 +2,8 @@ import { RecordValue, StringValue } from '@coveo/bueno';
 import { ItemMetaData } from '@coveo/relay-event-types';
 import { AsyncThunk } from '@reduxjs/toolkit';
 import type { CoveoSearchPageClient, SearchPageClientProvider, CaseAssistClient, CoveoInsightClient, EventBuilder, EventDescription, AnalyticsClientSendEventHook } from 'coveo.analytics';
-import { SearchEventResponse } from 'coveo.analytics/dist/definitions/events.js';
-import { PartialDocumentInformation, DocumentIdentifier } from 'coveo.analytics/dist/definitions/searchPage/searchPageEvents.js';
+import type { SearchEventResponse } from 'coveo.analytics/dist/definitions/events.js';
+import type { PartialDocumentInformation, DocumentIdentifier } from 'coveo.analytics/dist/definitions/searchPage/searchPageEvents.js';
 import { Logger } from 'pino';
 import { CaseAssistAnalyticsProvider, StateNeededByCaseAssistAnalytics } from '../../api/analytics/case-assist-analytics.js';
 import { InsightAnalyticsProvider, StateNeededByInsightAnalyticsProvider } from '../../api/analytics/insight-analytics.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/features/configuration/magic-cookie.d.ts

@@ -0,0 +1 @@
+export default function getMagicCookie(): string | false | null;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/context/context-selector.d.ts

@@ -0,0 +1,26 @@
+import { ContextState } from './context-state.js';
+export declare const selectContext: ((state: {
+    context?: ContextState;
+}) => ContextState | undefined) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: ContextState | undefined) => ContextState | undefined;
+    memoizedResultFunc: ((resultFuncArgs_0: ContextState | undefined) => ContextState | undefined) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => ContextState | undefined;
+    dependencies: [(state: {
+        context?: ContextState;
+    }) => ContextState | undefined];
+    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/facets/category-facet-set/category-facet-set-actions.d.ts

@@ -17,7 +17,10 @@ export interface RegisterCategoryFacetActionCreatorPayload {
         excluded?: string[];
     };
     /**
-     * The currently active tab.
+     * @deprecated - This field is unused and should not be relied on.
+     * If you need the currently active tab, use the TabManager instead.
+     *
+     * This property will be removed in version 4.0.
      */
     activeTab?: string;
     /**

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

@@ -18,7 +18,10 @@ export interface RegisterFacetActionCreatorPayload {
         excluded?: string[];
     };
     /**
-     * The currently active tab.
+     * @deprecated - This field is unused and should not be relied on.
+     * If you need the currently active tab, use the TabManager instead.
+     *
+     * This property will be removed in version 4.0.
      */
     activeTab?: string;
     /**

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

@@ -18,7 +18,10 @@ export interface RegisterDateFacetActionCreatorPayload {
         excluded?: string[];
     };
     /**
-     * The currently active tab.
+     * @deprecated - This field is unused and should not be relied on.
+     * If you need the currently active tab, use the TabManager instead.
+     *
+     * This property will be removed in version 4.0.
      */
     activeTab?: string;
     /**

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

@@ -18,7 +18,10 @@ export interface RegisterNumericFacetActionCreatorPayload {
         excluded?: string[];
     };
     /**
-     * The currently active tab.
+     * @deprecated - This field is unused and should not be relied on.
+     * If you need the currently active tab, use the TabManager instead.
+     *
+     * This property will be removed in version 4.0.
      */
     activeTab?: string;
     /**

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

@@ -139,7 +139,7 @@ export declare const buildInstantResultSearchRequest: (state: StateNeededByExecu
         source?: string[];
     };
     excerptLength?: number;
-    actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[];
+    actionsHistory?: import("../../../api/analytics/coveo.analytics/history-store.js").HistoryElement[];
     authentication?: string;
     generateAutomaticFacets?: {
         desiredCount: number;

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

@@ -61,7 +61,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, eve
         source?: string[];
     };
     excerptLength?: number;
-    actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[];
+    actionsHistory?: import("../../../api/analytics/coveo.analytics/history-store.js").HistoryElement[];
     authentication?: string;
 }>>;
 export {};

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

@@ -1,4 +1,4 @@
-import { EventDescription } from 'coveo.analytics';
+import type { EventDescription } from 'coveo.analytics';
 import { SearchResponseSuccess } from '../../api/search/search/search-response.js';
 import { NavigatorContext } from '../../app/navigator-context-provider.js';
 import { InstantResultSection } from '../../state/state-sections.js';
@@ -146,7 +146,7 @@ export declare const buildInstantResultSearchRequest: (state: StateNeededByExecu
         source?: string[];
     };
     excerptLength?: number;
-    actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[];
+    actionsHistory?: import("../../api/analytics/coveo.analytics/history-store.js").HistoryElement[];
     authentication?: string;
     generateAutomaticFacets?: {
         desiredCount: number;

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

@@ -62,7 +62,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, nav
         source?: string[];
     };
     excerptLength?: number;
-    actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[];
+    actionsHistory?: import("../../api/analytics/coveo.analytics/history-store.js").HistoryElement[];
     authentication?: string;
 }>>;
 export {};

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

@@ -51,7 +51,7 @@ export declare function buildMockSearchRequest(config?: Partial<SearchRequest>):
         source?: string[];
     };
     excerptLength?: number;
-    actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[];
+    actionsHistory?: import("../api/analytics/coveo.analytics/history-store.js").HistoryElement[];
     authentication?: string;
     generateAutomaticFacets?: {
         desiredCount: number;