@coveo/quantic 3.10.0-pre.faaf12d7a7 → 3.10.0

package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/search-action-cause.d.ts

@@ -23,10 +23,6 @@ export declare enum SearchPageEvents {
      * Identifies the search event that gets logged when a submit button is selected on a search box.
      */
     searchboxSubmit = "searchboxSubmit",
-    /**
-     * Identifies the search event that gets logged when a clear button is selected on a search box.
-     */
-    searchboxClear = "searchboxClear",
     /**
      * The search-as-you-type event that gets logged when a query is automatically generated, and results are displayed while a user is entering text in the search box before they voluntarily submit the query.
      */
@@ -39,10 +35,6 @@ export declare enum SearchPageEvents {
      * Identifies the search event that gets logged when the event to clear the current breadcrumbs is triggered.
      */
     breadcrumbResetAll = "breadcrumbResetAll",
-    /**
-     * Identifies the click event that gets logged when the Quick View element is selected and a Quick View modal of the document is displayed.
-     */
-    documentQuickview = "documentQuickview",
     /**
      * Identifies the click event that gets logged when a user clicks on a search result to open an item.
      */
@@ -59,34 +51,14 @@ export declare enum SearchPageEvents {
      * Identifies the search event that gets logged when the search page loads with a query, such as when a user clicks a link pointing to a search results page with a query or enters a query in a standalone search box that points to a search page.
      */
     searchFromLink = "searchFromLink",
-    /**
-     * Identifies the custom event that gets logged when a user action triggers a notification set in the effective query pipeline on the search page.
-     */
-    triggerNotify = "notify",
-    /**
-     * Identifies the custom event that gets logged when a user action executes a JavaScript function set in the effective query pipeline on the search page.
-     */
-    triggerExecute = "execute",
     /**
      * Identifies the custom event that gets logged when a user action triggers a new query set in the effective query pipeline on the search page.
      */
     triggerQuery = "query",
-    /**
-     * Identifies the custom event that gets logged when a user action redirects them to a URL set in the effective query pipeline on the search page.
-     */
-    triggerRedirect = "redirect",
     /**
      * Identifies the search cause that gets logged for pagination and other user navigation that do not express a new search intent.
      */
     browseResults = "browseResults",
-    /**
-     * Identifies the search event that gets logged when the clearing all selected values of a static filter.
-     */
-    staticFilterClearAll = "staticFilterClearAll",
-    /**
-     * Identifies the search event that gets logged when a static filter check box is selected and the query is updated.
-     */
-    staticFilterSelect = "staticFilterSelect",
     /**
      * Identifies the search event that gets logged when a static filter check box is deselected and the query is updated.
      */
@@ -95,18 +67,10 @@ export declare enum SearchPageEvents {
      * Identifies the search event that gets logged when the Clear Facet button is selected.
      */
     facetClearAll = "facetClearAll",
-    /**
-     * Identifies the custom event that gets logged when a query is being typed into the facet search box.
-     */
-    facetSearch = "facetSearch",
     /**
      * Identifies the search event that gets logged when a facet check box is selected and the query is updated.
      */
     facetSelect = "facetSelect",
-    /**
-     * Identifies the search event that gets logged when all filters on a facet are selected.
-     */
-    facetSelectAll = "facetSelectAll",
     /**
      * Identifies the search event that gets logged when a facet check box is deselected and the query is updated.
      */
@@ -135,30 +99,10 @@ export declare enum SearchPageEvents {
      * Identifies the custom event that gets logged when a user query encounters an error during execution.
      */
     queryError = "query",
-    /**
-     * Identifies the search and custom event that gets logged when a user clicks the Go Back link after an error page.
-     */
-    queryErrorBack = "errorBack",
-    /**
-     * Identifies the search and custom event that gets logged when a user clears the query box after an error page.
-     */
-    queryErrorClear = "errorClearQuery",
-    /**
-     * Identifies the search and custom event that gets logged when a user clicks the Retry link after an error page.
-     */
-    queryErrorRetry = "errorRetry",
-    /**
-     * Identifies the custom event that gets logged when a user performs a query that returns recommendations in the Recommendations panel.
-     */
-    recommendation = "recommendation",
     /**
      * Identifies the search event that gets logged when a user action (that is not a query) reloads the Recommendations panel with new recommendations.
      */
     recommendationInterfaceLoad = "recommendationInterfaceLoad",
-    /**
-     * Identifies the click event that gets logged when a user clicks a recommendation in the Recommendations panel.
-     */
-    recommendationOpen = "recommendationOpen",
     /**
      * Identifies the custom event that gets logged when a user identifies a smart snippet answer as relevant.
      */
@@ -203,30 +147,6 @@ export declare enum SearchPageEvents {
      * Identifies the custom event that gets logged when a user clicks on the source of a snippet suggestion for a related question.
      */
     openSmartSnippetSuggestionSource = "openSmartSnippetSuggestionSource",
-    /**
-     * Identifies the custom event that gets logged when a user clicks on a link in the answer of a smart snippet.
-     */
-    openSmartSnippetInlineLink = "openSmartSnippetInlineLink",
-    /**
-     * Identifies the custom event that gets logged when a user clicks on a link in the snippet suggestion for a related question.
-     */
-    openSmartSnippetSuggestionInlineLink = "openSmartSnippetSuggestionInlineLink",
-    /**
-     * Identifies the search event that gets logged when a recent queries list item gets clicked.
-     */
-    recentQueryClick = "recentQueriesClick",
-    /**
-     * Identifies the custom event that gets logged when a recent queries list gets cleared.
-     */
-    clearRecentQueries = "clearRecentQueries",
-    /**
-     * Identifies the custom event that gets logged when a recently clicked results list item gets clicked.
-     */
-    recentResultClick = "recentResultClick",
-    /**
-     * Identifies the custom event that gets logged when a recently clicked results list gets cleared.
-     */
-    clearRecentResults = "clearRecentResults",
     /**
      * Identifies the click event that gets logged when a user clicks the Show More link under a search result that support the folding component.
      */
@@ -275,8 +195,6 @@ export declare enum SearchPageEvents {
      * Identified the custom event that gets logged when a generated answer stream is completed.
      */
     generatedAnswerStreamEnd = "generatedAnswerStreamEnd",
-    historyForward = "historyForward",
-    historyBackward = "historyBackward",
     /**
      * Identifies the search event that gets logged when the query context is updated as a result of updating one of the case context fields.
      */

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

@@ -71,7 +71,6 @@ export interface LogFacetBreadcrumbActionCreatorPayload {
     facetValue: string;
 }
 export declare const logFacetBreadcrumb: (payload: LogFacetBreadcrumbActionCreatorPayload) => LegacySearchAction;
-export declare const facetUpdateSort: () => SearchAction;
 export declare const facetClearAll: () => SearchAction;
 export declare const facetSelect: () => SearchAction;
 export declare const facetExclude: () => SearchAction;

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

@@ -1,7 +1,4 @@
 import { LegacySearchAction } from '../analytics/analytics-utils.js';
-import { SearchAction } from '../search/search-actions.js';
 export declare const logNavigateForward: () => LegacySearchAction;
 export declare const logNavigateBackward: () => LegacySearchAction;
 export declare const logNoResultsBack: () => LegacySearchAction;
-export declare const historyForward: () => SearchAction;
-export declare const historyBackward: () => SearchAction;

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

@@ -17,7 +17,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, eve
     facetOptions?: import("../../facet-options/facet-options.js").FacetOptions | undefined;
     numberOfResults?: number | undefined;
     firstResult?: number | 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;
+    facets?: import("../../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[] | undefined;
     cq?: string | undefined;
     queryCorrection?: {
         enabled?: boolean | undefined;

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

@@ -10,7 +10,6 @@ import { MappedSearchRequest } from './search-mappings.js';
 export interface SearchAction {
     actionCause: string;
 }
-export declare const nullActionCause: () => SearchAction;
 export type { StateNeededByExecuteSearch } from './search-actions-thunk-processor.js';
 export interface ExecuteSearchThunkReturn {
     /** The successful search response. */
@@ -130,6 +129,7 @@ export declare const buildInstantResultSearchRequest: (state: StateNeededByExecu
     filterFieldRange?: number | undefined;
     tab: string;
     referrer: string | null;
+    /** The query that was executed. */
     timezone: string;
     analytics?: {
         actionCause?: string | undefined;
@@ -138,7 +138,7 @@ export declare const buildInstantResultSearchRequest: (state: StateNeededByExecu
         deviceId?: string | undefined;
         pageId?: string | undefined;
         clientTimestamp: string;
-        documentReferrer: string | null; /** The original query that was performed when an automatic correction is executed.*/
+        documentReferrer: string | null;
         originContext: string;
         userDisplayName?: string | undefined;
         documentLocation?: string | null | undefined;

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

@@ -18,7 +18,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, nav
     facetOptions?: import("../facet-options/facet-options.js").FacetOptions | undefined;
     numberOfResults?: number | undefined;
     firstResult?: number | 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;
+    facets?: import("../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[] | undefined;
     cq?: string | undefined;
     queryCorrection?: {
         enabled?: boolean | undefined;

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

@@ -1,5 +1,4 @@
 import { LegacySearchAction } from '../analytics/analytics-utils.js';
-import { SearchAction } from '../search/search-actions.js';
 import { StaticFilterValue } from './static-filter-set-state.js';
 export interface RegisterStaticFilterActionCreatorPayload {
     /**
@@ -54,6 +53,3 @@ export interface LogStaticFilterClearAllActionCreatorPayload {
     staticFilterId: string;
 }
 export declare const logStaticFilterClearAll: (metadata: LogStaticFilterClearAllActionCreatorPayload) => LegacySearchAction;
-export declare const staticFilterSelect: () => SearchAction;
-export declare const staticFilterDeselect: () => SearchAction;
-export declare const staticFilterClearAll: () => SearchAction;

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

@@ -66,19 +66,19 @@
  * ```
  * @module SSR Commerce
  */
+export type { CommerceEngineDefinitionOptions, SSRCommerceEngine as CommerceEngine, } from './app/commerce-ssr-engine/factories/build-factory.js';
 export type { Unsubscribe, Middleware } from '@reduxjs/toolkit';
 export type { Relay } from '@coveo/relay';
 export type { CommerceEngineOptions } from './app/commerce-engine/commerce-engine.js';
 export type { CommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
-export type { SSRCommerceEngine as CommerceEngine, CommerceEngineDefinition, CommerceEngineDefinitionOptions, } from './app/commerce-engine/commerce-engine.ssr.js';
+export type { CommerceEngineDefinition } from './app/commerce-engine/commerce-engine.ssr.js';
 export { defineCommerceEngine } from './app/commerce-engine/commerce-engine.ssr.js';
 export { getSampleCommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
 export type { CoreEngineNext, ExternalEngineOptions } from './app/engine.js';
 export type { EngineConfiguration, AnalyticsConfiguration, AnalyticsRuntimeEnvironment, } from './app/engine-configuration.js';
 export { SolutionType } from './app/commerce-ssr-engine/types/common.js';
-export type { ControllerDefinitionsMap, InferControllerFromDefinition, InferControllersMapFromDefinition, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllerPropsMapFromDefinitions, } from './app/commerce-ssr-engine/types/common.js';
-export type { Build } from './app/ssr-engine/types/build.js';
-export type { EngineDefinition, InferStaticState, InferHydratedState, InferBuildResult, HydrateStaticState, FetchStaticState, } from './app/commerce-ssr-engine/types/core-engine.js';
+export type { ControllerDefinitionsMap, InferControllerFromDefinition, InferControllersMapFromDefinition, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllerPropsMapFromDefinitions, EngineStaticState, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, HydratedState, OptionsTuple, } from './app/commerce-ssr-engine/types/common.js';
+export type { EngineDefinition, InferStaticState, InferHydratedState, InferBuildResult, HydrateStaticState, FetchStaticState, FetchStaticStateOptions, HydrateStaticStateOptions, Build, BuildOptions, FromBuildResult, FromBuildResultOptions, } from './app/commerce-ssr-engine/types/core-engine.js';
 export type { LoggerOptions } from './app/logger.js';
 export type { NavigatorContext, BrowserNavigatorContextProvider, NavigatorContextProvider, } from './app/navigatorContextProvider.js';
 export type { LogLevel } from './app/logger.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-engine-v2.d.ts

@@ -3,7 +3,7 @@ import { Logger } from 'pino';
 import { Mock } from 'vitest';
 import { CaseAssistEngine } from '../app/case-assist-engine/case-assist-engine.js';
 import { CommerceEngine } from '../app/commerce-engine/commerce-engine.js';
-import { SSRCommerceEngine } from '../app/commerce-engine/commerce-engine.ssr.js';
+import { SSRCommerceEngine } from '../app/commerce-ssr-engine/factories/build-factory.js';
 import type { CoreEngine, CoreEngineNext } from '../app/engine.js';
 import { InsightEngine } from '../app/insight-engine/insight-engine.js';
 import { RecommendationEngine } from '../app/recommendation-engine/recommendation-engine.js';

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

@@ -9,5 +9,5 @@ export declare function sortFacets<T extends {
     facetId: string;
 }>(facets: T[], sortOrder: string[]): T[];
 export declare const sortCriteriaMap: Record<string, SortCriteria>;
-export declare function getFacets(state: StateNeededBySearchRequest): (import("../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[];
+export declare function getFacets(state: StateNeededBySearchRequest): (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)[];
 export {};

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

@@ -25,3 +25,7 @@ export declare function createWaitForActionMiddleware<TAction extends Action>(is
     promise: Promise<TAction>;
     middleware: Middleware;
 };
+export declare function createWaitForActionMiddlewareForRecommendation<TAction extends Action>(isDesiredAction: (action: unknown) => action is TAction, memo: Set<string>): {
+    promise: Promise<TAction>;
+    middleware: Middleware;
+};