@coveo/quantic 3.33.3 → 3.33.5

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

@@ -28,7 +28,7 @@ export interface BaseProduct {
      */
     ec_brand: string | null;
     /**
-     * The category of the product (e.g., `"Electronics;Electronics|Televisions;Electronics|Televisions|4K Televisions"`).
+     * The category of the product (for example, `"Electronics;Electronics|Televisions;Electronics|Televisions|4K Televisions"`).
      *
      * From the `ec_category` field.
      */
@@ -139,7 +139,7 @@ export interface Product extends BaseProduct {
     /**
      * The 1-based product's position across the non-paginated result set.
      *
-     * E.g., if the product is the third one on the second page, and there are 10 products per page, its position is 13 (not 3).
+     * For example, if the product is the third one on the second page, and there are 10 products per page, its position is 13 (not 3).
      */
     position: number;
 }

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

@@ -1,4 +1,4 @@
-import dayjs, { type ConfigType } from 'dayjs';
+import dayjs, { type ConfigType } from 'dayjs/esm/index.js';
 /**
  * The date format supported by the Search API.
  */

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

@@ -11,7 +11,7 @@ export interface PlanResponseSuccess {
     preprocessingOutput: {
         /**
          * The query response output generated by _trigger_ rules in the query
-         * pipeline (i.e., by `execute`, `notify`, `query`, and `redirect` rules).
+         * pipeline (that is, by `execute`, `notify`, `query`, and `redirect` rules).
          */
         triggers: Trigger[];
     };

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

@@ -1,7 +1,7 @@
 /**
  * Terms to highlight (with [stemming](https://docs.coveo.com/en/1576)) in the results.
  *
- * E.g., for the query "indexing consultant", where a result contains "Techzample is a consulting firm specializing in search indexes. It employs consultants that can analyze and improve your search index.", the `TermsToHighlight` might be `{ "indexing": ["indexes", "index"], "consultant": ["consulting", "consultants"] }`.
+ * For example, for the query "indexing consultant", where a result contains "Techzample is a consulting firm specializing in search indexes. It employs consultants that can analyze and improve your search index.", the `TermsToHighlight` might be `{ "indexing": ["indexes", "index"], "consultant": ["consulting", "consultants"] }`.
  */
 export type TermsToHighlight = {
     [originalTerm: string]: string[];
@@ -9,7 +9,7 @@ export type TermsToHighlight = {
 /**
  * Phrases to highlight (with [stemming](https://docs.coveo.com/en/1576)) in the results.
  *
- * E.g., for the exact phrase "indexing consultant", where a result contains "Techzample is a consulting firm specializing in search indexes. It employs consultants that can analyze and improve your search index.", the `PhrasesToHighlight` might be `{ "indexing consultant": {"indexing": ["indexes", "index"], "consultant": ["consulting", "consultants"]}}`.
+ * For example, for the exact phrase "indexing consultant", where a result contains "Techzample is a consulting firm specializing in search indexes. It employs consultants that can analyze and improve your search index.", the `PhrasesToHighlight` might be `{ "indexing consultant": {"indexing": ["indexes", "index"], "consultant": ["consulting", "consultants"]}}`.
  */
 export declare type PhrasesToHighlight = {
     [originalPhrase: string]: TermsToHighlight;

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

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

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

@@ -19,7 +19,7 @@ export interface CommerceEngineConfiguration extends EngineConfiguration {
      */
     cart?: CartInitialState;
     /**
-     * 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/app/engine-configuration.d.ts

@@ -8,11 +8,11 @@ import type { CoveoFramework } from '../utils/version.js';
  */
 export interface EngineConfiguration {
     /**
-     * The unique identifier of the target Coveo Cloud organization (e.g., `mycoveocloudorganizationg8tp8wu3`)
+     * The unique identifier of the target Coveo organization (for example, `mycoveocloudorganizationg8tp8wu3`)
      */
     organizationId: string;
     /**
-     * The access token to use to authenticate requests against the Coveo Cloud endpoints. Typically, this will be an API key or search token that grants the privileges to execute queries and push usage analytics data in the target Coveo Cloud organization.
+     * The access token to use to authenticate requests against the Coveo endpoints. Typically, this will be an API key or search token that grants the privileges to execute queries and push usage analytics data in the target Coveo organization.
      */
     accessToken: string;
     /**
@@ -28,7 +28,7 @@ export interface EngineConfiguration {
      */
     preprocessRequest?: PreprocessRequest;
     /**
-     * The Engine name (e.g., myEngine). Specifying your Engine name will help in debugging when using an application with multiple Redux stores.
+     * The Engine name (for example, myEngine). Specifying your Engine name will help in debugging when using an application with multiple Redux stores.
      * @defaultValue 'coveo-headless'
      */
     name?: string;
@@ -39,7 +39,7 @@ export interface EngineConfiguration {
     /**
      * The environment in which the organization is hosted.
      *
-     * The `dev` and `stg` environments are only available internally for Coveo employees (e.g., Professional Services).
+     * The `dev` and `stg` environments are only available internally for Coveo employees (for example, Professional Services).
      *
      * Defaults to `prod`.
      */
@@ -116,8 +116,8 @@ export interface AnalyticsConfiguration {
     trackingId?: string;
     /**
      * The analytics client to use.
-     * - `legacy`: The legacy analytics client, i.e., the Coveo Analytics.js library.
-     * - `next`: The next analytics client, i.e., the Coveo Event Protocol with the Relay library.
+     * - `legacy`: The legacy analytics client, that is, the Coveo Analytics.js library.
+     * - `next`: The next analytics client, that is, the Coveo Event Protocol with the Relay library.
      *
      * The default value is `next`.
      *
@@ -130,7 +130,7 @@ export interface AnalyticsConfiguration {
      */
     source?: Partial<Record<CoveoFramework, string>>;
     /**
-     * The base URL to use to proxy Coveo analytics requests (e.g., `https://example.com/analytics`).
+     * The base URL to use to proxy Coveo analytics requests (for example, `https://example.com/analytics`).
      *
      * This is an advanced option that you only set if you proxy Coveo analytics requests through your own
      * server. In most cases, you should not set this option.

package/force-app/main/default/staticresources/coveoheadless/definitions/app/insight-engine/insight-engine-configuration.d.ts

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

package/force-app/main/default/staticresources/coveoheadless/definitions/app/recommendation-engine/recommendation-engine-configuration.d.ts

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

package/force-app/main/default/staticresources/coveoheadless/definitions/app/search-engine/search-engine-configuration.d.ts

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

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

@@ -1,5 +1,6 @@
 /**
- * The Coveo Headless Commerce sub-package exposes exposes the engine, controllers, actions, and utility functions to build a commerce search experience.
+ * The Coveo Headless Commerce sub-package exposes the engine, controllers, actions, and utility functions to
+ * build a [commerce search experience](https://docs.coveo.com/en/o6r70022/).
  *
  * @example
  * ```typescript

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

@@ -5,7 +5,7 @@ export type { NumericFacetBreadcrumb, FacetBreadcrumb, DateFacetBreadcrumb, Cate
 /**
  * The `BreadcrumbManager` headless controller manages a summary of the currently active facet filters.
  *
- * Example: [breadcrumb-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/breadcrumb-manager/breadcrumb-manager.fn.tsx)
+ * Example: [breadcrumb-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/breadcrumb-manager/breadcrumb-manager.fn.tsx)
  *
  * @group Controllers
  * @category BreadcrumbManager

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

@@ -44,7 +44,7 @@ export interface BreadcrumbManagerState {
      */
     facetBreadcrumbs: Breadcrumb<AnyFacetValueResponse>[];
     /**
-     * Whether any breadcrumbs are available (i.e., if any facet values are currently active).
+     * Whether any breadcrumbs are available (that is, if any facet values are currently active).
      */
     hasBreadcrumbs: boolean;
 }

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

@@ -29,7 +29,6 @@ export interface FacetGenerator extends Controller {
     state: string[];
     /**
      * The facet sub-controllers created by the facet generator.
-     * Array of [RegularFacet](./regular-facet), [DateRangeFacet](./date-range-facet), [NumericFacet](./numeric-facet), [CategoryFacet](./category-facet), and [LocationFacet](./location-facet).
      */
     facets: GeneratedFacetControllers;
     /**

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

@@ -1,5 +1,5 @@
 import { type SchemaDefinition } from '@coveo/bueno';
-import { type UnknownAction } from '@reduxjs/toolkit';
+import type { UnknownAction } from '@reduxjs/toolkit';
 import type { CommerceEngine } from '../../../../app/commerce-engine/commerce-engine.js';
 import { stateKey } from '../../../../app/state-key.js';
 import type { Parameters } from '../../../../features/commerce/parameters/parameters-actions.js';
@@ -43,7 +43,7 @@ export interface ParameterManagerInitialState<T> {
     parameters: T;
 }
 /**
- * The `ParameterManager` sub-controller allows restoring parameters that affect the results (e.g., from the URL).
+ * The `ParameterManager` sub-controller allows restoring parameters that affect the results (for example, from the URL).
  *
  * @group Sub-controllers
  * @category ParameterManager

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

@@ -60,7 +60,7 @@ export interface CategoryFilterSuggestions extends Controller, FacetControllerTy
      * updated query.
      *
      * For example, if this method is called with `jeans` as an argument, it will request values from the controller's
-     * field (e.g., `ec_category`) that would return results if selected when the search query is `jeans` (such as
+     * field (for example, `ec_category`) that would return results if selected when the search query is `jeans` (such as
      * `Clothing`, `Clothing;Pants`, and `Clothing;Shorts`).
      *
      * @param query - The search query to use as context to request the category filter suggestions. In a typical

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

@@ -61,7 +61,7 @@ export interface FilterSuggestions extends Controller, FacetControllerType<'regu
      * query.
      *
      * For example, if this method is called with `jeans` as an argument, it will request values from the controller's
-     * field (e.g., `ec_brand`) that would return results if selected when the search query is `jeans` (such as
+     * field (for example, `ec_brand`) that would return results if selected when the search query is `jeans` (such as
      * `Calvin Klein`, `Columbia`, and `Nautica`).
      *
      * @param query - The search query to use as context to request the category filter suggestions. In a typical

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/instant-products/headless-instant-products.d.ts

@@ -41,7 +41,7 @@ export interface InstantProducts extends Controller {
      *
      * This method is useful when leveraging the product grouping feature to allow users to select nested products.
      *
-     * E.g., if a product has children (such as color variations), you can call this method when the user selects a child
+     * For example, if a product has children (such as color variations), you can call this method when the user selects a child
      * to make that child the new parent product, and re-render the product as such in the storefront.
      *
      * **Note:** In the controller state, a product that has children will always include itself as its own child so that

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-listing/headless-product-listing.d.ts

@@ -8,7 +8,7 @@ import type { ProductListingSummaryState } from './summary/headless-product-list
 /**
  * The `ProductListing` controller exposes a method for retrieving product listing content in a commerce interface.
  *
- * Example: [product-listing.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/commerce/product-listing.fn.tsx)
+ * Example: [product-listing.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/commerce/product-listing.fn.tsx)
  *
  * @group Buildable controllers
  * @category ProductListing
@@ -29,7 +29,7 @@ export interface ProductListing extends Controller, SearchAndListingSubControlle
      *
      * This method is useful when leveraging the product grouping feature to allow users to select nested products.
      *
-     * E.g., if a product has children (such as color variations), you can call this method when the user selects a child
+     * For example, if a product has children (such as color variations), you can call this method when the user selects a child
      * to make that child the new parent product, and re-render the product as such in the storefront.
      *
      * **Note:** In the controller state, a product that has children will always include itself as its own child so that

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

@@ -44,7 +44,7 @@ export interface RecentQueriesState {
      */
     maxLength: number;
     /**
-     * Whether analytics & tracking are enabled.
+     * Whether analytics and tracking are enabled.
      * In the case where it is disabled, it is recommended not to save recent queries.
      */
     analyticsEnabled: boolean;

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

@@ -7,7 +7,7 @@ import type { SummaryState } from '../core/summary/headless-core-summary.js';
 /**
  * The `Recommendations` controller exposes a method for retrieving recommendations content in a commerce interface.
  *
- * Example: [recommendations.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/commerce/recommendations.fn.tsx)
+ * Example: [recommendations.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/commerce/recommendations.fn.tsx)
  *
  * @group Buildable controllers
  * @category Recommendations
@@ -24,7 +24,7 @@ export interface Recommendations extends Controller, BaseSolutionTypeSubControll
      *
      * This method is useful when leveraging the product grouping feature to allow users to select nested products.
      *
-     * E.g., if a product has children (such as color variations), you can call this method when the user selects a child
+     * For example, if a product has children (such as color variations), you can call this method when the user selects a child
      * to make that child the new parent product, and re-render the product as such in the storefront.
      *
      * **Note:** In the controller state, a product that has children will always include itself as its own child so that
@@ -51,7 +51,7 @@ export interface RecommendationsState {
 }
 export interface RecommendationsOptions {
     /**
-     * The unique identifier of the recommendations slot (e.g., `b953ab2e-022b-4de4-903f-68b2c0682942`).
+     * The unique identifier of the recommendations slot (for example, `b953ab2e-022b-4de4-903f-68b2c0682942`).
      */
     slotId: string;
     /**

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

@@ -6,7 +6,7 @@ import { type SearchSubControllers } from '../core/sub-controller/headless-sub-c
 /**
  * The `Search` controller lets you create a commerce search page.
  *
- * Example: [search.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/commerce/search.fn.tsx)
+ * Example: [search.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/commerce/search.fn.tsx)
  *
  * @group Buildable controllers
  * @category Search
@@ -23,7 +23,7 @@ export interface Search extends Controller, SearchSubControllers {
      *
      * This method is useful when leveraging the product grouping feature to allow users to select nested products.
      *
-     * E.g., if a product has children (such as color variations), you can call this method when the user selects a child
+     * For example, if a product has children (such as color variations), you can call this method when the user selects a child
      * to make that child the new parent product, and re-render the product as such in the storefront.
      *
      * **Note:** In the controller state, a product that has children will always include itself as its own child so that

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

@@ -54,7 +54,7 @@ export interface BreadcrumbManagerState {
      */
     staticFilterBreadcrumbs: StaticFilterBreadcrumb[];
     /**
-     * Returns `true` if there are any available breadcrumbs (i.e., if there are any active facet values), and `false` if not.
+     * Returns `true` if there are any available breadcrumbs (that is, if there are any active facet values), and `false` if not.
      */
     hasBreadcrumbs: boolean;
 }

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

@@ -18,7 +18,7 @@ export interface ContextInitialState {
  * The `Context` controller injects [custom contextual information](https://docs.coveo.com/en/3389/)
  * into the search requests and usage analytics search events sent from a search interface.
  *
- * Example: [context.ts](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/context/context.ts)
+ * Example: [context.ts](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/context/context.ts)
  *
  * @group Controllers
  * @category Context

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/did-you-mean/headless-core-did-you-mean.d.ts

@@ -27,7 +27,7 @@ export interface DidYouMeanOptions {
 /**
  * The `DidYouMean` controller is responsible for handling query corrections.
  *
- * Example: [did-you-mean.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/did-you-mean/did-you-mean.fn.tsx)
+ * Example: [did-you-mean.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/did-you-mean/did-you-mean.fn.tsx)
  *
  * @group Controllers
  * @category DidYouMean

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

@@ -9,14 +9,14 @@ export interface FacetManagerPayload<T> {
      */
     facetId: string;
     /**
-     * The payload to associate with the facetId. This can be anything e.g., a DOM element, JSX, a string.
+     * The payload to associate with the facetId. This can be anything such as a DOM element, JSX, a string.
      */
     payload: T;
 }
 /**
  * The `FacetManager` controller helps reorder facets to match the most recent search response.
  *
- * Example: [facet-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/facet-manager/facet-manager.fn.tsx)
+ * Example: [facet-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/facet-manager/facet-manager.fn.tsx)
  *
  * @group Controllers
  * @category FacetManager

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

@@ -13,8 +13,8 @@ export interface CategoryFacetProps {
  * The `CategoryFacet` headless controller offers a high-level interface for designing a facet UI controller that renders values hierarchically.
  *
  * Example:
- * - [category-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/category-facet/category-facet.fn.tsx)
- * - [category-facet-search.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/category-facet/category-facet-search.tsx)
+ * - [category-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/category-facet/category-facet.fn.tsx)
+ * - [category-facet-search.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/category-facet/category-facet-search.tsx)
  *
  * @group Controllers
  * @category CategoryFacet

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

@@ -12,14 +12,14 @@ interface CoreFacetProps {
 }
 /**
  * The `Facet` controller allows you to create a search interface component that the end user
- * can use to refine a query by selecting filters based on item metadata (i.e., field values).
+ * can use to refine a query by selecting filters based on item metadata (that is, field values).
  * If you have enabled a [Dynamic Navigation Experience (DNE)](https://docs.coveo.com/en/m2na0333/)
  * model, the `Facet` controller automatically reorders facet values according to the user query.
  *
  * Examples:
- * - [facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/facet/facet.fn.tsx)
- * - [facet-search.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/facet/facet-search.tsx)
- * - [facet.class.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/facet/facet.class.tsx)
+ * - [facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/facet/facet.fn.tsx)
+ * - [facet-search.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/facet/facet-search.tsx)
+ * - [facet.class.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/facet/facet.class.tsx)
  *
  * @group Controllers
  * @category Facet

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

@@ -17,8 +17,8 @@ export interface DateFacetProps {
  * The `DateFacet` controller makes it possible to create a facet with date ranges.
  *
  * Examples:
- * - [date-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/date-facet/date-facet.fn.tsx)
- * - [relative-date-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/relative-date-facet/relative-date-facet.fn.tsx)
+ * - [date-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/date-facet/date-facet.fn.tsx)
+ * - [relative-date-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/relative-date-facet/relative-date-facet.fn.tsx)
  *
  * @document relative-date-format.md
  *

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

@@ -93,7 +93,7 @@ export interface DateFilterState {
 /**
  * The `DateFilter` controller makes it possible to create a date filter.
  *
- * Example: [date-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/date-filter/date-filter.fn.tsx)
+ * Example: [date-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/date-filter/date-filter.fn.tsx)
  *
  * @group Controllers
  * @category DateFilter

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

@@ -16,7 +16,7 @@ export interface NumericFacetProps {
 /**
  * The `NumericFacet` controller makes it possible to create a facet with numeric ranges.
  *
- * Example: [numeric-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/numeric-facet/numeric-facet.fn.tsx)
+ * Example: [numeric-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/numeric-facet/numeric-facet.fn.tsx)
  *
  * @group Controllers
  * @category NumericFacet

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

@@ -93,7 +93,7 @@ export interface NumericFilterState {
 /**
  * The `NumericFilter` controller makes it possible to create a numeric filter.
  *
- * Example: [numeric-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/numeric-filter/numeric-filter.fn.tsx)
+ * Example: [numeric-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/numeric-filter/numeric-filter.fn.tsx)
  *
  * @group Controllers
  * @category NumericFilter

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

@@ -53,7 +53,7 @@ export interface CoreFoldedResultListProps {
 /**
  * The `FoldedResultList` headless controller re-organizes results into hierarchical collections (a.k.a. threads).
  *
- * Example: [folded-result-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/folded-result-list/folded-result-list.fn.tsx)
+ * Example: [folded-result-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/folded-result-list/folded-result-list.fn.tsx)
  *
  * @group Controllers
  * @category FoldedResultList

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

@@ -27,7 +27,7 @@ export interface PagerProps {
 /**
  * The `Pager` controller allows to navigate through the different result pages.
  *
- * [pager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/pager/pager.fn.tsx)
+ * [pager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/pager/pager.fn.tsx)
  *
  * @group Controllers
  * @category Pager

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

@@ -4,7 +4,7 @@ import { type Controller } from '../../controller/headless-controller.js';
 /**
  * The `QueryError` controller allows to retrieve information about the current error returned by the search API, if any.
  *
- * Example: [query-error.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/query-error/query-error.fn.tsx)
+ * Example: [query-error.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/query-error/query-error.fn.tsx)
  *
  * @group Controllers
  * @category QueryError

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

@@ -25,14 +25,14 @@ export interface RecentQueriesListOptions {
     maxLength: number;
     /**
      * Whether to clear all active query filters when the end user submits a new query from the recent queries list.
-     * Setting this option to "false" is not recommended & can lead to an increasing number of queries returning no results.
+     * Setting this option to "false" is not recommended and can lead to an increasing number of queries returning no results.
      */
     clearFilters?: boolean;
 }
 /**
  * The `RecentQueriesList` controller manages the user's recent queries.
  *
- * Example: [recent-queries.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/recent-queries/recent-queries.fn.tsx)
+ * Example: [recent-queries.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/recent-queries/recent-queries.fn.tsx)
  *
  * @group Controllers
  * @category RecentQueriesList
@@ -73,7 +73,7 @@ export interface RecentQueriesState {
      */
     maxLength: number;
     /**
-     * Whether analytics & tracking are enabled.
+     * Whether analytics and tracking are enabled.
      * When analyticsEnabled is `false`, it is recommended not to save recent queries.
      */
     analyticsEnabled: boolean;

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

@@ -24,7 +24,7 @@ export interface ResultListProps {
 /**
  * The `ResultList` headless controller offers a high-level interface for designing a common result list UI controller.
  *
- * Example: [result-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/result-list/result-list.fn.tsx)
+ * Example: [result-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/result-list/result-list.fn.tsx)
  *
  * @group Controllers
  * @category ResultList

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/results-per-page/headless-core-results-per-page.d.ts

@@ -15,7 +15,7 @@ export interface ResultsPerPageInitialState {
 /**
  * The `ResultsPerPage` controller allows the end user to choose how many results to display per page.
  *
- * Example: [results-per-page.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/results-per-page/results-per-page.fn.tsx)
+ * Example: [results-per-page.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/results-per-page/results-per-page.fn.tsx)
  *
  * @group Controllers
  * @category ResultsPerPage

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

@@ -7,7 +7,7 @@ export interface SearchBoxOptions {
      */
     id?: string;
     /**
-     * Whether to interpret advanced [Coveo Cloud query syntax](https://docs.coveo.com/en/1814/) in the query.
+     * Whether to interpret advanced [Coveo query syntax](https://docs.coveo.com/en/1552/) in the query.
      *
      * @defaultValue `false`
      */
@@ -17,7 +17,7 @@ export interface SearchBoxOptions {
      */
     highlightOptions?: SuggestionHighlightingOptions;
     /**
-     * The number of query suggestions to request from Coveo ML (e.g., `3`).
+     * The number of query suggestions to request from Coveo ML (for example, `3`).
      *
      * Using the value `0` disables the query suggest feature.
      *
@@ -26,7 +26,7 @@ export interface SearchBoxOptions {
     numberOfSuggestions?: number;
     /**
      * Whether to clear all active query filters when the end user submits a new query from the search box.
-     * Setting this option to "false" is not recommended & can lead to an increasing number of queries returning no results.
+     * Setting this option to "false" is not recommended and can lead to an increasing number of queries returning no results.
      */
     clearFilters?: boolean;
 }

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

@@ -66,7 +66,7 @@ export interface SmartSnippetRelatedQuestion {
      */
     documentId: QuestionAnswerDocumentIdentifier;
     /**
-     * The unique identifier for this question & answer.
+     * The unique identifier for this question and answer.
      */
     questionAnswerId: string;
     /**

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

@@ -16,7 +16,7 @@ export interface SortInitialState {
 /**
  * The `Sort` controller manages how the results are sorted.
  *
- * Example: [sort.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/sort/sort.fn.tsx)
+ * Example: [sort.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/sort/sort.fn.tsx)
  *
  * @group Controllers
  * @category Sort

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

@@ -3,7 +3,7 @@ import { type Controller } from '../../controller/headless-controller.js';
 /**
  * The `SearchStatus` controller lets you access search status information.
  *
- * Example: [search-status.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/search-status/search-status.fn.tsx)
+ * Example: [search-status.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/search-status/search-status.fn.tsx)
  *
  * @group Controllers
  * @category SearchStatus

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

@@ -38,7 +38,7 @@ export interface TabProps {
 /**
  * The `Tab` headless controller offers a high-level interface for designing a common tab UI controller.
  *
- * Example: [tab.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/tab/tab.fn.tsx)
+ * Example: [tab.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/tab/tab.fn.tsx)
  *
  * @group Controllers
  * @category Tab