@coveo/quantic 3.33.2 → 3.33.4

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-redirection-trigger.d.ts

@@ -2,7 +2,7 @@ import type { Controller } from '../../controller/headless-controller.js';
 /**
  * The `RedirectionTrigger` controller handles redirection triggers. A [Redirection trigger](https://docs.coveo.com/en/3413#redirect) query pipeline rule lets you define a URL to redirect the user's browser to when a certain condition is met.
  *
- * Example: [redirection-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/triggers/redirection-trigger.fn.tsx)
+ * Example: [redirection-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/triggers/redirection-trigger.fn.tsx)
  *
  * @group Controllers
  * @category RedirectionTrigger

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/dictionary-field-context/headless-dictionary-field-context.d.ts

@@ -5,7 +5,7 @@ export type { DictionaryFieldContextPayload };
 /**
  * The `DictionaryFieldContext` controller allows specifying which [dictionary field](https://docs.coveo.com/en/2036/) keys to retrieve.
  *
- * Example: [dictionary-field-context.fn.ts](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/dictionary-field-context/dictionary-field-context.fn.ts)
+ * Example: [dictionary-field-context.fn.ts](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/dictionary-field-context/dictionary-field-context.fn.ts)
  *
  * @group Controllers
  * @category DictionaryFieldContext

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

@@ -12,8 +12,8 @@ export type { AutomaticFacetGeneratorOptions };
  * To learn more about the automatic facet generator feature, see: [About the Facet Generator](https://docs.coveo.com/en/n9sd0159/).
  *
  * Examples:
- * - [automatic-facet-generator.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/automatic-facet-generator/automatic-facet-generator.fn.tsx)
- * - [automatic-facet-generator.class.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/automatic-facet-generator/automatic-facet-generator.class.tsx)
+ * - [automatic-facet-generator.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/automatic-facet-generator/automatic-facet-generator.fn.tsx)
+ * - [automatic-facet-generator.class.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/automatic-facet-generator/automatic-facet-generator.class.tsx)
  *
  * @group Controllers
  * @category AutomaticFacetGenerator
@@ -64,7 +64,7 @@ export interface AutomaticFacetState {
 }
 /**
  * The `AutomaticFacet` controller allows you to create a search interface component that the end user
- * can interact with to refine a query by selecting filters based on item metadata (i.e., field values). Unlike regular facets that
+ * can interact with to refine a query by selecting filters based on item metadata (that is, field values). Unlike regular facets that
  * need to be explicitly defined and requested in the query, automatic facets are dynamically generated by the index
  * in response to the query.
  *

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/field-suggestions/category-facet/headless-category-field-suggestions.d.ts

@@ -54,7 +54,7 @@ export interface CategoryFieldSuggestionsState {
  *
  * This controller is a wrapper around the basic category facet controller search functionality, and thus exposes similar options and properties.
  *
- * Example: [category-suggestions.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/field-suggestions/category-field/category-suggestions.fn.tsx)
+ * Example: [category-suggestions.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/field-suggestions/category-field/category-suggestions.fn.tsx)
  *
  * @group Controllers
  * @category CategoryFieldSuggestions

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

@@ -47,7 +47,7 @@ export interface FieldSuggestionsState {
  *
  * This controller is a wrapper around the basic facet controller search functionality, and thus exposes similar options and properties.
  *
- * Example: [field-suggestions.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/field-suggestions/specific-field/field-suggestions.fn.tsx)
+ * Example: [field-suggestions.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/field-suggestions/specific-field/field-suggestions.fn.tsx)
  *
  * @group Controllers
  * @category FieldSuggestions

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

@@ -5,7 +5,7 @@ import { type Controller } from '../controller/headless-controller.js';
 /**
  * The `HistoryManager` controller is in charge of allowing navigating back and forward in the search interface history.
  *
- * Example: [history-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/history-manager/history-manager.fn.tsx)
+ * Example: [history-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/history-manager/history-manager.fn.tsx)
  *
  * @group Controllers
  * @category HistoryManager

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/instant-results/instant-results.d.ts

@@ -11,7 +11,7 @@ export interface InstantResultProps {
 /**
  * The `InstantResults` controller allows the end user to manage instant results queries.
  *
- * Example: [instant-results.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/instant-results/instant-results.fn.tsx)
+ * Example: [instant-results.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/instant-results/instant-results.fn.tsx)
  *
  * @group Controllers
  * @category InstantResults

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/query-summary/headless-query-summary.d.ts

@@ -7,7 +7,7 @@ export type { QuerySummary, QuerySummaryState };
  * @param engine - The headless engine instance.
  * @returns A `QuerySummary` controller instance.
  *
- * Example: [query-summary.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/query-summary/query-summary.fn.tsx)
+ * Example: [query-summary.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/query-summary/query-summary.fn.tsx)
  *
  * @group Controllers
  * @category QuerySummary

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/quickview/headless-quickview.d.ts

@@ -24,7 +24,7 @@ export interface QuickviewState extends CoreQuickviewState {
 /**
  * The `Quickview` controller provides an interface for triggering desirable side effects, such as logging UA events to the Coveo Platform, when a user interacts with a quickview.
  *
- * Example: [quickview.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/quickview/quickview.fn.tsx)
+ * Example: [quickview.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/quickview/quickview.fn.tsx)
  *
  * @group Controllers
  * @category Quickview

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

@@ -28,7 +28,7 @@ export interface RecentResultsListOptions {
 /**
  * The `RecentResultsList` controller manages a user's recently clicked results.
  *
- * Example: [recent-results.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/recent-results/recent-results.fn.tsx)
+ * Example: [recent-results.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/recent-results/recent-results.fn.tsx)
  *
  * @group Controllers
  * @category RecentResultsList

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recommendation/headless-recommendation.d.ts

@@ -20,7 +20,7 @@ export interface RecommendationListProps {
 /**
  * The `RecommendationList` controller retrieves information about the current recommendations by the search API, if there are any.
  *
- * Example: [recommendation-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/recommendation-list/recommendation-list.fn.tsx)
+ * Example: [recommendation-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/recommendation-list/recommendation-list.fn.tsx)
  *
  * @group Controllers
  * @category RecommendationList

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/relevance-inspector/headless-relevance-inspector.d.ts

@@ -22,7 +22,7 @@ export interface RelevanceInspectorInitialState {
 /**
  * The `RelevanceInspector` controller is in charge of allowing displaying various debug information.
  *
- * Example: [relevance-inspector.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/relevance-inspector/relevance-inspector.fn.tsx)
+ * Example: [relevance-inspector.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/relevance-inspector/relevance-inspector.fn.tsx)
  *
  * @group Controllers
  * @category RelevanceInspector

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

@@ -16,7 +16,7 @@ export interface InteractiveResultProps extends InteractiveResultCoreProps {
 /**
  * The `InteractiveResult` controller provides an interface for triggering desirable side effects, such as logging UA events to the Coveo Platform, when a user selects a query result.
  *
- * Example: [result-link.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/result-list/result-link.tsx)
+ * Example: [result-link.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/result-list/result-link.tsx)
  *
  * @group Controllers
  * @category InteractiveResult

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.d.ts

@@ -13,7 +13,7 @@ export interface SmartSnippetQuestionsListState extends CoreSmartSnippetQuestion
 /**
  * The `SmartSnippetQuestionsList` controller allows to manage additional queries for which a SmartSnippet model can provide relevant excerpts.
  *
- * Example: [smart-snippet-questions-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/smart-snippet-questions-list/smart-snippet-questions-list.fn.tsx)
+ * Example: [smart-snippet-questions-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/smart-snippet-questions-list/smart-snippet-questions-list.fn.tsx)
  *
  * @group Controllers
  * @category SmartSnippetQuestionsList

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/standalone-search-box/headless-standalone-search-box.d.ts

@@ -10,7 +10,7 @@ export interface StandaloneSearchBoxProps {
  * The `StandaloneSearchBox` headless controller offers a high-level interface for designing a common search box UI controller.
  * Meant to be used for a search box that will redirect instead of executing a query.
  *
- * Example: [standalone-search-box.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/standalone-search-box/standalone-search-box.fn.tsx)
+ * Example: [standalone-search-box.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/standalone-search-box/standalone-search-box.fn.tsx)
  *
  * @group Controllers
  * @category StandaloneSearchBox

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/static-filter/headless-static-filter.d.ts

@@ -23,7 +23,7 @@ export interface StaticFilterOptions {
 /**
  * The `StaticFilter` controller manages a collection of filter values.
  *
- * Example: [static-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/static-filter/static-filter.fn.tsx)
+ * Example: [static-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/static-filter/static-filter.fn.tsx)
  *
  * @group Controllers
  * @category StaticFilter

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/static-filter/static-filter-value.d.ts

@@ -1,11 +1,11 @@
 import type { StaticFilterValue, StaticFilterValueState } from '../../features/static-filter-set/static-filter-set-state.js';
 export interface StaticFilterValueOptions {
     /**
-     * A human-readable caption for the expression (e.g., `Youtube`).
+     * A human-readable caption for the expression (for example, `Youtube`).
      */
     caption: string;
     /**
-     * The query filter expression to apply when the value is selected (e.g., `@filetype=="youtubevideo"`).
+     * The query filter expression to apply when the value is selected (for example, `@filetype=="youtubevideo"`).
      */
     expression: string;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-execute-trigger.d.ts

@@ -5,8 +5,8 @@ import { type Controller } from '../controller/headless-controller.js';
  * The `ExecuteTrigger` controller handles Execute triggers from the query response. An [Execute trigger](https://docs.coveo.com/en/3413#execute) query pipeline rule lets you define a custom JavaScript function to be executed in the frontend when a certain condition is met.
  *
  * Examples:
- * - [execute-trigger.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/triggers/execute-trigger.tsx)
- * - [execute-trigger.class.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/triggers/execute-trigger.class.tsx)
+ * - [execute-trigger.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/triggers/execute-trigger.tsx)
+ * - [execute-trigger.class.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/triggers/execute-trigger.class.tsx)
  *
  * @group Controllers
  * @category ExecuteTrigger

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

@@ -10,7 +10,7 @@ export interface UrlManagerProps {
 export interface UrlManagerInitialState {
     /**
      * The part of the url that contains search parameters.
-     * E.g., `q=windmill&f[author]=Cervantes`
+     * For example: `q=windmill&f[author]=Cervantes`.
      */
     fragment: string;
 }
@@ -18,7 +18,7 @@ export declare const initialStateSchema: Schema<Required<UrlManagerInitialState>
 /**
  * The `UrlManager` controller can parse an url fragment to extract search parameters which affect the search response.
  *
- * Example: [url-manager.ts](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/url-manager/url-manager.ts)
+ * Example: [url-manager.ts](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/url-manager/url-manager.ts)
  *
  * @group Controllers
  * @category UrlManager
@@ -29,8 +29,8 @@ export interface UrlManager extends Controller {
      * */
     state: UrlManagerState;
     /**
-     * Updates the search parameters in state with those from the url & launches a search.
-     * @param fragment The part of the url that contains search parameters.  E.g., `q=windmill&f[author]=Cervantes`
+     * Updates the search parameters in state with those from the url and launches a search.
+     * @param fragment The part of the url that contains search parameters.  For example: `q=windmill&f[author]=Cervantes`.
      */
     synchronize(fragment: string): void;
 }
@@ -43,7 +43,7 @@ export interface UrlManager extends Controller {
 export interface UrlManagerState {
     /**
      * The part of the url that contains search parameters.
-     * E.g., `q=windmill&f[author]=Cervantes`
+     * For example: `q=windmill&f[author]=Cervantes`.
      */
     fragment: string;
 }

package/force-app/main/default/staticresources/coveoheadless/definitions/features/advanced-search-queries/advanced-search-queries-state.d.ts

@@ -1,10 +1,10 @@
 type AdvancedSearchQueriesDefaultFiltersState = {
     /**
-     * The initial cq filter (e.g., `((q AND aq) OR dq) AND cq).
+     * The initial cq filter (for example, `((q AND aq) OR dq) AND cq).
      */
     cq: string;
     /**
-     * The initial aq filter (e.g., `((q AND aq) OR dq) AND cq).
+     * The initial aq filter (for example, `((q AND aq) OR dq) AND cq).
      */
     aq: string;
     /**
@@ -12,13 +12,13 @@ type AdvancedSearchQueriesDefaultFiltersState = {
      */
     lq: string;
     /**
-     * The initial dq filter, or disjunction query expression filter (e.g., `((q AND aq) OR dq) AND cq).
+     * The initial dq filter, or disjunction query expression filter (for example, `((q AND aq) OR dq) AND cq).
      */
     dq: string;
 };
 export interface AdvancedSearchQueriesState {
     /**
-     * The cq filter (e.g., `((q AND aq) OR dq) AND cq).
+     * The cq filter (for example, `((q AND aq) OR dq) AND cq).
      */
     cq: string;
     /**
@@ -28,7 +28,7 @@ export interface AdvancedSearchQueriesState {
      */
     cqWasSet: boolean;
     /**
-     * The aq filter (e.g., `((q AND aq) OR dq) AND cq).
+     * The aq filter (for example, `((q AND aq) OR dq) AND cq).
      */
     aq: string;
     /**
@@ -53,7 +53,7 @@ export interface AdvancedSearchQueriesState {
     /**
      * The dq filter, or disjunction query expression.
      *
-     * This is the disjunctive part of the query expression that is merged with the other expression parts using an OR boolean operator (e.g., `((q AND aq) OR dq) AND cq).
+     * This is the disjunctive part of the query expression that is merged with the other expression parts using an OR boolean operator (for example, `((q AND aq) OR dq) AND cq).
      */
     dq: string;
     /**

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

@@ -4,7 +4,7 @@ import type { SearchAction } from '../search/search-actions.js';
 import { type ClickAction, type CustomAction, type LegacySearchAction } from './analytics-utils.js';
 export interface LogSearchEventActionCreatorPayload {
     /**
-     * The identifier of the search action (e.g., `interfaceLoad`).
+     * The identifier of the search action (for example, `interfaceLoad`).
      * */
     evt: string;
     /**
@@ -15,7 +15,7 @@ export interface LogSearchEventActionCreatorPayload {
 export declare const logSearchEvent: (p: LogSearchEventActionCreatorPayload) => LegacySearchAction;
 export interface LogClickEventActionCreatorPayload {
     /**
-     * The identifier of the click action (e.g., `documentOpen`).
+     * The identifier of the click action (for example, `documentOpen`).
      * */
     evt: string;
     /**

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

@@ -36,7 +36,7 @@ export declare enum SearchPageEvents {
      */
     breadcrumbResetAll = "breadcrumbResetAll",
     /**
-     * Identifies the click event that gets logged when a user clicks on a search result to open an item.
+     * Identifies the click event that gets logged when a user clicks a search result to open an item.
      */
     documentOpen = "documentOpen",
     /**
@@ -144,11 +144,11 @@ export declare enum SearchPageEvents {
      */
     collapseSmartSnippetSuggestion = "collapseSmartSnippetSuggestion",
     /**
-     * Identifies the custom event that gets logged when a user clicks on the source of an answer in a smart snippet.
+     * Identifies the custom event that gets logged when a user clicks the source of an answer in a smart snippet.
      */
     openSmartSnippetSource = "openSmartSnippetSource",
     /**
-     * Identifies the custom event that gets logged when a user clicks on the source of a snippet suggestion for a related question.
+     * Identifies the custom event that gets logged when a user clicks the source of a snippet suggestion for a related question.
      */
     openSmartSnippetSuggestionSource = "openSmartSnippetSuggestionSource",
     /**

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

@@ -49,7 +49,7 @@ export interface SearchAnalyticsActionCreators {
      */
     logInterfaceChange(): LegacySearchAction;
     /**
-     * The event to log when a user triggers a search by clicking on a did-you-mean suggestion.
+     * The event to log when a user triggers a search by clicking a did-you-mean suggestion.
      *
      * @returns A dispatchable action.
      */

package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-assist-configuration/case-assist-configuration-actions.d.ts

@@ -8,7 +8,7 @@ interface SetCaseAssistConfigurationActionCreatorPayload {
      */
     locale?: string;
     /**
-     * The base URL to use to proxy Coveo case assist requests (e.g., `https://example.com/search`).
+     * The base URL to use to proxy Coveo case assist requests (for example, `https://example.com/search`).
      *
      * This is an advanced option that you only set if you proxy Coveo case assist through your own
      * server. In most cases, you should not set this option.

package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-assist-configuration/case-assist-configuration-state.d.ts

@@ -9,7 +9,7 @@ export interface CaseAssistConfigurationState {
      */
     locale?: string;
     /**
-     * The base URL to use to proxy Coveo case assist requests (e.g., `https://example.com/search`).
+     * The base URL to use to proxy Coveo case assist requests (for example, `https://example.com/search`).
      *
      * This is an advanced option that you only set if you proxy Coveo case assist through your own
      * server. In most cases, you should not set this option.

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

@@ -2,7 +2,7 @@ import type { GetCaseClassificationsResponse } from '../../api/service/case-assi
 import type { CaseAssistConfigurationSection, CaseFieldSection, CaseInputSection, ConfigurationSection, DebugSection } from '../../state/state-sections.js';
 export interface SetCaseFieldActionCreatorPayload {
     /**
-     * The name of the field whose value is being updated (e.g., product, category, model)
+     * The name of the field whose value is being updated (for example, product, category, model)
      */
     fieldName: string;
     /**

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

@@ -1,6 +1,6 @@
 export interface SetCaseInputActionCreatorPayload {
     /**
-     * The name of the field whose value is being updated (e.g., subject, description, product, category).
+     * The name of the field whose value is being updated (for example, subject, description, product, category).
      */
     fieldName: string;
     /**

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

@@ -3,7 +3,7 @@ export type UpdateBasicConfigurationPayload = UpdateBasicConfigurationActionCrea
 export declare const updateBasicConfiguration: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateBasicConfigurationActionCreatorPayload], UpdateBasicConfigurationActionCreatorPayload, "commerce/configuration/updateBasicConfiguration", never, never>;
 export type UpdateProxyBaseUrlPayload = {
     /**
-     * The base URL to use to proxy Coveo commerce requests (e.g., `https://example.com/commerce`).
+     * The base URL to use to proxy Coveo commerce requests (for example, `https://example.com/commerce`).
      *
      * This is an advanced option that you only set if you proxy Coveo commerce requests through your own
      * server. In most cases, you should not set this option.

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/configuration/configuration-state.d.ts

@@ -11,7 +11,7 @@ interface CommerceState {
      *
      * By default, will append `/rest/organizations/{organizationId}/commerce/v2` to the automatically resolved
      * platform [organization endpoint](https://docs.coveo.com/en/mcc80216)
-     * (i.e., `https;://<ORG_ID>.org<hipaa|dev|stg|>.coveo.com`)
+     * (that is, `https;://<ORG_ID>.org<hipaa|dev|stg|>.coveo.com`)
      *
      * If necessary, you can override this value by specifying a `commerce.proxyBaseUrl` in the configuration of your
      * commerce engine, or by manually dispatching the `updateProxyBaseUrl` action.

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

@@ -13,7 +13,7 @@ export declare const clearAllCoreFacets: import("@reduxjs/toolkit").ActionCreato
 export declare const deleteAllCoreFacets: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"commerce/facets/core/deleteAll">;
 export type DeselectAllValuesInCoreFacetPayload = {
     /**
-     * The unique identifier of the facet (e.g., `"1"`).
+     * The unique identifier of the facet (for example, `"1"`).
      */
     facetId: string;
 };

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

@@ -1,7 +1,7 @@
 import type { LocationFacetValue } from '../facet-set/interfaces/response.js';
 export interface ToggleSelectLocationFacetValuePayload {
     /**
-     * The unique identifier of the facet (e.g., `"1"`).
+     * The unique identifier of the facet (for example, `"1"`).
      */
     facetId: string;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/numeric-facet/manual-numeric-facet-selectors.d.ts

@@ -1,22 +1,2 @@
 import type { ManualRangeSection } from '../../../../state/state-sections.js';
-export declare const manualNumericFacetSelector: ((state: ManualRangeSection, facetId: string) => import("../../../../ssr.index.js").NumericRangeRequest | undefined) & {
-    clearCache: () => void;
-    resultsCount: () => number;
-    resetResultsCount: () => void;
-} & {
-    resultFunc: (resultFuncArgs_0: import("../../../../ssr.index.js").NumericRangeRequest | undefined) => import("../../../../ssr.index.js").NumericRangeRequest | undefined;
-    memoizedResultFunc: ((resultFuncArgs_0: import("../../../../ssr.index.js").NumericRangeRequest | undefined) => import("../../../../ssr.index.js").NumericRangeRequest | undefined) & {
-        clearCache: () => void;
-        resultsCount: () => number;
-        resetResultsCount: () => void;
-    };
-    lastResult: () => import("../../../../ssr.index.js").NumericRangeRequest | undefined;
-    dependencies: [(state: ManualRangeSection, facetId: string) => import("../../../../ssr.index.js").NumericRangeRequest | undefined];
-    recomputations: () => number;
-    resetRecomputations: () => void;
-    dependencyRecomputations: () => number;
-    resetDependencyRecomputations: () => void;
-} & {
-    argsMemoize: typeof import("reselect").weakMapMemoize;
-    memoize: typeof import("reselect").weakMapMemoize;
-};
+export declare const manualNumericFacetSelector: (state: ManualRangeSection, facetId: string) => import("../../../../ssr.index.js").NumericRangeRequest | undefined;

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

@@ -1,7 +1,7 @@
 import type { NumericRangeRequest } from '../../../facets/range-facets/numeric-facet-set/interfaces/request.js';
 export interface ToggleSelectNumericFacetValuePayload {
     /**
-     * The unique identifier of the facet (e.g., `"1"`).
+     * The unique identifier of the facet (for example, `"1"`).
      */
     facetId: string;
     /**
@@ -21,7 +21,7 @@ export type ToggleExcludeNumericFacetValuePayload = ToggleSelectNumericFacetValu
 export declare const toggleExcludeNumericFacetValue: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: ToggleSelectNumericFacetValuePayload], ToggleSelectNumericFacetValuePayload, "commerce/facets/numericFacet/toggleExcludeValue", never, never>;
 export interface UpdateNumericFacetValuesPayload {
     /**
-     * The unique identifier of the facet (e.g., `"1"`).
+     * The unique identifier of the facet (for example, `"1"`).
      */
     facetId: string;
     /**
@@ -32,7 +32,7 @@ export interface UpdateNumericFacetValuesPayload {
 export declare const updateNumericFacetValues: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateNumericFacetValuesPayload], UpdateNumericFacetValuesPayload, "commerce/facets/numericFacet/updateValues", import("@reduxjs/toolkit").SerializedError | null, never>;
 export type UpdateManualNumericFacetRangePayload = {
     /**
-     * The unique identifier of the facet (e.g., `"1"`).
+     * The unique identifier of the facet (for example, `"1"`).
      */
     facetId: string;
 } & Omit<NumericRangeRequest, 'previousState'>;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/pagination/pagination-selectors.d.ts

@@ -1,127 +1,7 @@
 import type { CommercePaginationSection } from '../../../state/state-sections.js';
-export declare const perPagePrincipalSelector: ((state: Partial<CommercePaginationSection>) => number) & {
-    clearCache: () => void;
-    resultsCount: () => number;
-    resetResultsCount: () => void;
-} & {
-    resultFunc: (resultFuncArgs_0: number) => number;
-    memoizedResultFunc: ((resultFuncArgs_0: number) => number) & {
-        clearCache: () => void;
-        resultsCount: () => number;
-        resetResultsCount: () => void;
-    };
-    lastResult: () => number;
-    dependencies: [(state: Partial<CommercePaginationSection>) => number];
-    recomputations: () => number;
-    resetRecomputations: () => void;
-    dependencyRecomputations: () => number;
-    resetDependencyRecomputations: () => void;
-} & {
-    argsMemoize: typeof import("reselect").weakMapMemoize;
-    memoize: typeof import("reselect").weakMapMemoize;
-};
-export declare const perPageRecommendationSelector: ((state: Partial<CommercePaginationSection>, slotId: string) => number) & {
-    clearCache: () => void;
-    resultsCount: () => number;
-    resetResultsCount: () => void;
-} & {
-    resultFunc: (resultFuncArgs_0: number) => number;
-    memoizedResultFunc: ((resultFuncArgs_0: number) => number) & {
-        clearCache: () => void;
-        resultsCount: () => number;
-        resetResultsCount: () => void;
-    };
-    lastResult: () => number;
-    dependencies: [(state: Partial<CommercePaginationSection>, slotId: string) => number];
-    recomputations: () => number;
-    resetRecomputations: () => void;
-    dependencyRecomputations: () => number;
-    resetDependencyRecomputations: () => void;
-} & {
-    argsMemoize: typeof import("reselect").weakMapMemoize;
-    memoize: typeof import("reselect").weakMapMemoize;
-};
-export declare const totalEntriesPrincipalSelector: ((state: Partial<CommercePaginationSection>) => number) & {
-    clearCache: () => void;
-    resultsCount: () => number;
-    resetResultsCount: () => void;
-} & {
-    resultFunc: (resultFuncArgs_0: number) => number;
-    memoizedResultFunc: ((resultFuncArgs_0: number) => number) & {
-        clearCache: () => void;
-        resultsCount: () => number;
-        resetResultsCount: () => void;
-    };
-    lastResult: () => number;
-    dependencies: [(state: Partial<CommercePaginationSection>) => number];
-    recomputations: () => number;
-    resetRecomputations: () => void;
-    dependencyRecomputations: () => number;
-    resetDependencyRecomputations: () => void;
-} & {
-    argsMemoize: typeof import("reselect").weakMapMemoize;
-    memoize: typeof import("reselect").weakMapMemoize;
-};
-export declare const totalEntriesRecommendationSelector: ((state: Partial<CommercePaginationSection>, slotId: string) => number) & {
-    clearCache: () => void;
-    resultsCount: () => number;
-    resetResultsCount: () => void;
-} & {
-    resultFunc: (resultFuncArgs_0: number) => number;
-    memoizedResultFunc: ((resultFuncArgs_0: number) => number) & {
-        clearCache: () => void;
-        resultsCount: () => number;
-        resetResultsCount: () => void;
-    };
-    lastResult: () => number;
-    dependencies: [(state: Partial<CommercePaginationSection>, slotId: string) => number];
-    recomputations: () => number;
-    resetRecomputations: () => void;
-    dependencyRecomputations: () => number;
-    resetDependencyRecomputations: () => void;
-} & {
-    argsMemoize: typeof import("reselect").weakMapMemoize;
-    memoize: typeof import("reselect").weakMapMemoize;
-};
-export declare const pagePrincipalSelector: ((state: Partial<CommercePaginationSection>) => number) & {
-    clearCache: () => void;
-    resultsCount: () => number;
-    resetResultsCount: () => void;
-} & {
-    resultFunc: (resultFuncArgs_0: number) => number;
-    memoizedResultFunc: ((resultFuncArgs_0: number) => number) & {
-        clearCache: () => void;
-        resultsCount: () => number;
-        resetResultsCount: () => void;
-    };
-    lastResult: () => number;
-    dependencies: [(state: Partial<CommercePaginationSection>) => number];
-    recomputations: () => number;
-    resetRecomputations: () => void;
-    dependencyRecomputations: () => number;
-    resetDependencyRecomputations: () => void;
-} & {
-    argsMemoize: typeof import("reselect").weakMapMemoize;
-    memoize: typeof import("reselect").weakMapMemoize;
-};
-export declare const pageRecommendationSelector: ((state: Partial<CommercePaginationSection>, slotId: string) => number) & {
-    clearCache: () => void;
-    resultsCount: () => number;
-    resetResultsCount: () => void;
-} & {
-    resultFunc: (resultFuncArgs_0: number) => number;
-    memoizedResultFunc: ((resultFuncArgs_0: number) => number) & {
-        clearCache: () => void;
-        resultsCount: () => number;
-        resetResultsCount: () => void;
-    };
-    lastResult: () => number;
-    dependencies: [(state: Partial<CommercePaginationSection>, slotId: string) => number];
-    recomputations: () => number;
-    resetRecomputations: () => void;
-    dependencyRecomputations: () => number;
-    resetDependencyRecomputations: () => void;
-} & {
-    argsMemoize: typeof import("reselect").weakMapMemoize;
-    memoize: typeof import("reselect").weakMapMemoize;
-};
+export declare const perPagePrincipalSelector: (state: Partial<CommercePaginationSection>) => number;
+export declare const perPageRecommendationSelector: (state: Partial<CommercePaginationSection>, slotId: string) => number;
+export declare const totalEntriesPrincipalSelector: (state: Partial<CommercePaginationSection>) => number;
+export declare const totalEntriesRecommendationSelector: (state: Partial<CommercePaginationSection>, slotId: string) => number;
+export declare const pagePrincipalSelector: (state: Partial<CommercePaginationSection>) => number;
+export declare const pageRecommendationSelector: (state: Partial<CommercePaginationSection>, slotId: string) => number;