@coveo/quantic 3.16.0 → 3.16.1-pre.1a6fc4649f

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/recent-queries-list/headless-recent-queries-list.d.ts

@@ -22,6 +22,11 @@ export interface RecentQueriesList extends Controller {
      * @param index - The index of the recent query to execute.
      */
     executeRecentQuery(index: number): void;
+    /**
+     * Sets the recent queries list to the specified array of queries.
+     * @param queries - The array of queries to set.
+     */
+    updateRecentQueries(queries: string[]): void;
 }
 /**
  * A scoped and simplified part of the headless state that is relevant to the `RecentQueriesList` controller.

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/search-parameter-manager/headless-core-search-parameter-manager.d.ts

@@ -55,7 +55,6 @@ export interface SearchParameterManagerState {
  */
 export declare function buildCoreSearchParameterManager(engine: CoreEngine, props: SearchParameterManagerProps): SearchParameterManager;
 export declare function enrichParameters(engine: CoreEngine, parameters: SearchParameters): Required<SearchParameters>;
-export declare function validateParams(engine: CoreEngine, parameters: Required<SearchParameters>): boolean;
 export declare function getCoreActiveSearchParameters(engine: CoreEngine): SearchParameters;
 export declare function getSelectedValues(request: FacetRequest): string[];
 export declare function getSelectedRangeValues(request: CurrentValues<BaseFacetValueRequest>): BaseFacetValueRequest[];

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recent-queries-list/headless-recent-queries-list.d.ts

@@ -51,6 +51,11 @@ export interface RecentQueriesList extends Controller {
      * @param index - The index of the recent query to execute.
      */
     executeRecentQuery(index: number): void;
+    /**
+     * Sets the recent queries list to the specified array of queries.
+     * @param queries - The array of queries to set.
+     */
+    updateRecentQueries(queries: string[]): void;
 }
 /**
  * A scoped and simplified part of the headless state that is relevant to the `RecentQueriesList` controller.

package/force-app/main/default/staticresources/coveoheadless/definitions/features/parameter-manager/parameter-manager-selectors.d.ts

@@ -15,3 +15,8 @@ export declare function getFacets<Value, Request, Parameters>(section: Record<st
         [x: string]: Value[];
     };
 };
+export declare function getTab<Section>(section: Section | undefined, tabSelector: (tabSet: Section) => string, initialState: string): {
+    tab?: undefined;
+} | {
+    tab: string;
+};

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

@@ -0,0 +1,36 @@
+import { PayloadAction } from '@reduxjs/toolkit';
+import { CoreEngine } from '../../app/engine.js';
+import { SearchParameters } from './search-parameter-actions.js';
+export type { SearchParameters } from './search-parameter-actions.js';
+/**
+ * The search parameters action creators.
+ *
+ * @group Actions
+ * @category SearchParameters
+ */
+export interface SearchParameterActionCreators {
+    /**
+     * Restores the search parameters.
+     *
+     * @param payload - The action creator payload.
+     * @returns A dispatchable action.
+     */
+    restoreSearchParameters(payload: SearchParameters): PayloadAction<SearchParameters>;
+    /**
+     * Restores the tab.
+     *
+     * @param payload - The action creator payload.
+     * @returns A dispatchable action.
+     */
+    restoreTab(payload: string): PayloadAction<string>;
+}
+/**
+ * Loads the facet order, facet set, pagination, query, query set, and sort reducers and returns the available search parameters action creators.
+ *
+ * @param engine - The headless engine.
+ * @returns An object holding the search parameters action creators.
+ *
+ * @group Actions
+ * @category SearchParameters
+ */
+export declare function loadSearchParameterActions(engine: CoreEngine): SearchParameterActionCreators;

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

@@ -66,6 +66,7 @@ export interface SearchParameters {
     sf?: Record<string, string[]>;
     /**
      * The active tab id.
+     * @deprecated Restoring the tab with the restoreSearchParameters action can cause components to be visible/hidden on the wrong tab. Instead, first restore the tab using the `restoreTab` action, then the rest of the parameters with the restoreSearchParameters action.
      */
     tab?: string;
     /**
@@ -73,4 +74,9 @@ export interface SearchParameters {
      */
     af?: Record<string, string[]>;
 }
+/**
+ * The unique identifier of a tab.
+ */
+export type TabId = string;
 export declare const restoreSearchParameters: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SearchParameters], SearchParameters, "searchParameters/restore", never, never>;
+export declare const restoreTab: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string], string, "searchParameters/restoreTab", never, never>;