@coveo/atomic 3.37.3 → 3.38.0

package/dist/types/components/search/atomic-generated-answer/atomic-generated-answer.d.ts

@@ -87,7 +87,7 @@ export declare class AtomicGeneratedAnswer implements InitializableComponent {
     /**
      * The tabs on which the generated answer can be displayed. This property should not be used at the same time as `tabs-excluded`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-generated-answer tabs-included='["tabIDA", "tabIDB"]'></atomic-generated-answer>
      * ```
@@ -97,7 +97,7 @@ export declare class AtomicGeneratedAnswer implements InitializableComponent {
     /**
      * The tabs on which this generated answer must not be displayed. This property should not be used at the same time as `tabs-included`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-generated-answer tabs-excluded='["tabIDA", "tabIDB"]'></atomic-generated-answer>
      * ```

package/dist/types/components/search/atomic-query-error/atomic-query-error.d.ts

@@ -1,6 +1,8 @@
-import { QueryError } from '@coveo/headless';
-import { InitializableComponent } from '../../../utils/initialization-utils';
-import { Bindings } from '../atomic-search-interface/atomic-search-interface';
+import { type QueryError } from '@coveo/headless';
+import { LitElement } from 'lit';
+import type { InitializableComponent } from "../../../decorators/types";
+import { AriaLiveRegionController } from "../../../utils/accessibility-utils";
+import type { Bindings } from '../atomic-search-interface/atomic-search-interface';
 /**
  * The `atomic-query-error` component handles fatal errors when performing a query on the index or Search API. When the error is known, it displays a link to relevant documentation link for debugging purposes. When the error is unknown, it displays a small text area with the JSON content of the error.
  *
@@ -11,13 +13,18 @@ import { Bindings } from '../atomic-search-interface/atomic-search-interface';
  * @part more-info-btn - A button to request additional error information.
  * @part error-info - Additional error information.
  */
-export declare class AtomicQueryError implements InitializableComponent {
+export declare class AtomicQueryError extends LitElement implements InitializableComponent<Bindings> {
+    private queryErrorState;
+    protected ariaMessage: AriaLiveRegionController;
     bindings: Bindings;
     queryError: QueryError;
-    private queryErrorState;
     error: Error;
     showMoreInfo: boolean;
-    protected ariaMessage: string;
     initialize(): void;
-    render(): any;
+    render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-query-error': AtomicQueryError;
+    }
 }

package/dist/types/components/search/atomic-query-summary/atomic-query-summary.d.ts

@@ -5,7 +5,7 @@ import { AriaLiveRegionController } from "../../../utils/accessibility-utils";
 import type { Bindings } from '../atomic-search-interface/interfaces';
 declare const AtomicQuerySummary_base: typeof LitElement;
 /**
- * The `atomic-query-summary` component displays information about the current range of results and the request duration (e.g., "Results 1-10 of 123 in 0.47 seconds").
+ * The `atomic-query-summary` component displays information about the current range of results and the request duration (for example, "Results 1-10 of 123 in 0.47 seconds").
  *
  * @part container - The container for the whole summary.
  * @part duration - The container for the duration.

package/dist/types/components/search/atomic-result-list/atomic-result-list.d.ts

@@ -5,6 +5,7 @@ import type { Bindings } from "../atomic-search-interface/atomic-search-interfac
 import type { InitializableComponent } from "../../../decorators/types";
 import '../atomic-result/atomic-result';
 import { type ItemDisplayDensity, type ItemDisplayImageSize, type ItemDisplayLayout } from "../../common/layout/item-layout-utils";
+import "../atomic-result-template/atomic-result-template";
 declare const AtomicResultList_base: typeof LitElement;
 /**
  * The `atomic-result-list` component is responsible for displaying query results by applying one or more result templates.
@@ -12,7 +13,7 @@ declare const AtomicResultList_base: typeof LitElement;
  * @slot default - The default slot where the result templates are inserted.
  * @part result-list - The element containing every result of a result list
  * @part outline - The element displaying an outline or a divider around a result
- * @part result-list-grid-clickable-container - The parent of the result & the clickable link encompassing it, when results are displayed as a grid
+ * @part result-list-grid-clickable-container - The parent of the result and the clickable link encompassing it, when results are displayed as a grid
  * @part result-list-grid-clickable - The clickable link encompassing the result when results are displayed as a grid
  * @part result-table - The element of the result table containing a heading and a body
  * @part result-table-heading - The element containing the row of cells in the result table's heading
@@ -58,7 +59,7 @@ export declare class AtomicResultList extends AtomicResultList_base implements I
     /**
      * The tabs on which the result list can be displayed. This property should not be used at the same time as `tabs-excluded`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-result-list tabs-included='["tabIDA", "tabIDB"]'></atomic-result-list snippet>
      * ```
@@ -68,7 +69,7 @@ export declare class AtomicResultList extends AtomicResultList_base implements I
     /**
      * The tabs on which this result list must not be displayed. This property should not be used at the same time as `tabs-included`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-result-list tabs-excluded='["tabIDA", "tabIDB"]'></atomic-result-list>
      * ```
@@ -78,7 +79,7 @@ export declare class AtomicResultList extends AtomicResultList_base implements I
     constructor();
     /**
      * Sets a rendering function to bypass the standard HTML template mechanism for rendering results.
-     * You can use this function while working with web frameworks that don't use plain HTML syntax, e.g., React, Angular or Vue.
+     * You can use this function while working with web frameworks that don't use plain HTML syntax such as React, Angular, or Vue.
      *
      * Do not use this method if you integrate Atomic in a plain HTML deployment.
      *

package/dist/types/components/search/atomic-result-number/atomic-result-number.d.ts

@@ -0,0 +1,38 @@
+import { LitElement } from 'lit';
+import type { Bindings } from "../atomic-search-interface/interfaces";
+import type { InitializableComponent } from "../../../decorators/types";
+declare const AtomicResultNumber_base: import("../../../mixins/mixin-common").Constructor<{
+    injectStyles(dynamicStyles?: import("lit").CSSResultGroup): Promise<void>;
+}> & typeof LitElement;
+/**
+ * The `atomic-result-number` component renders the value of a numeric result field.
+ * You can embed an `atomic-format-number`, `atomic-format-currency`, or `atomic-format-unit` component inside this component to format its value.
+ */
+export declare class AtomicResultNumber extends AtomicResultNumber_base implements InitializableComponent<Bindings> {
+    /**
+     * The name of the numeric result field whose value to display.
+     * The component looks for this field in the `Result` object, then in `Result.raw` if not found.
+     * This field must be present in the `fieldsToInclude` property of the `atomic-search-interface` component.
+     */
+    field: string;
+    bindings: Bindings;
+    error: Error;
+    private formatter;
+    private resultContext;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    initialize(): void;
+    render(): import("lit").TemplateResult<1>;
+    private handleNumberFormat;
+    private parseValue;
+    private formatValue;
+    private getValueToDisplay;
+    private get result();
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-result-number': AtomicResultNumber;
+    }
+}
+export {};

package/dist/types/components/search/atomic-search-box/atomic-search-box.d.ts

@@ -101,13 +101,13 @@ export declare class AtomicSearchBox implements InitializableComponent<Bindings>
     minimumQueryLength: 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;
     /**
-     * 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.
      * You should only enable query syntax in the search box if you have good reasons to do so, as it
-     * requires end users to be familiar with Coveo Cloud query syntax, otherwise they will likely be surprised
+     * requires end users to be familiar with Coveo query syntax, otherwise they will likely be surprised
      * by the search box behaviour.
      *
      * When the `redirection-url` property is set and redirects to a page with more `atomic-search-box` components, all `atomic-search-box` components need to have the same `enable-query-syntax` value.

package/dist/types/components/search/atomic-search-box-instant-results/atomic-search-box-instant-results.d.ts

@@ -29,7 +29,7 @@ export declare class AtomicSearchBoxInstantResults extends LitElement implements
     private templateHasError;
     /**
      * Sets a rendering function to bypass the standard HTML template mechanism for rendering results.
-     * You can use this function while working with web frameworks that don't use plain HTML syntax, e.g., React, Angular or Vue.
+     * You can use this function while working with web frameworks that don't use plain HTML syntax such as React, Angular, or Vue.
      *
      * Do not use this method if you integrate Atomic in a plain HTML deployment.
      *

package/dist/types/components/search/atomic-search-interface/atomic-search-interface.d.ts

@@ -109,7 +109,7 @@ export declare class AtomicSearchInterface extends AtomicSearchInterface_base im
     /**
      * Whether the relevance inspector shortcut should be enabled for this interface.
      *
-     * The relevance inspector can be opened by holding the Alt key (Option on Mac) while over the interface, and performing a double click.
+     * The relevance inspector can be opened by holding the Alt key (Option on Mac) while over the interface, and performing a double-click.
      *
      * The relevance inspector allows to troubleshoot and debug queries.
      * @deprecated - replaced by `disable-relevance-inspector` (this defaults to `true`, while the replacement defaults to `false`).
@@ -134,7 +134,7 @@ export declare class AtomicSearchInterface extends AtomicSearchInterface_base im
     initialize(options: InitializationOptions): Promise<void>;
     /**
      * Initializes the interface using the provided [headless search engine](https://docs.coveo.com/en/headless/latest/reference/modules/Search.html, as opposed to the `initialize` method which internally builds a search engine instance.
-     * This bypasses the properties set on the component, such as analytics, searchHub, pipeline, language, timezone & logLevel.
+     * This bypasses the properties set on the component, such as analytics, searchHub, pipeline, language, timezone, and logLevel.
      */
     initializeWithSearchEngine(engine: SearchEngine): Promise<void>;
     /**

package/dist/types/components/search/atomic-search-layout/atomic-search-layout.d.ts

@@ -14,7 +14,7 @@ export declare class AtomicSearchLayout extends AtomicSearchLayout_base {
     error: Error;
     /**
      * The viewport width at which the layout goes from desktop to mobile.
-     * E.g., 800px, 65rem.
+     * For example: 800px, 65rem.
      */
     mobileBreakpoint: string;
     private layoutStylesController;

package/dist/types/components/search/atomic-sort-expression/atomic-sort-expression.d.ts

@@ -34,7 +34,7 @@ export declare class AtomicSortExpression {
     /**
      * The tabs on which the sort expression can be displayed. This property should not be used at the same time as `tabs-excluded`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-sort-expression tabs-included='["tabIDA", "tabIDB"]'></atomic-sort-expression snippet>
      * ```
@@ -44,7 +44,7 @@ export declare class AtomicSortExpression {
     /**
      * The tabs on which the sort expression must not be displayed. This property should not be used at the same time as `tabs-included`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-sort-expression tabs-excluded='["tabIDA", "tabIDB"]'></atomic-sort-expression>
      * ```

package/dist/types/components/search/facets/atomic-category-facet/atomic-category-facet.d.ts

@@ -2,7 +2,7 @@ import { CategoryFacet, CategoryFacetState, CategoryFacetSortCriterion, SearchSt
 import { InitializableComponent } from '../../../../utils/initialization-utils';
 import { Bindings } from '../../atomic-search-interface/atomic-search-interface';
 /**
- * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (e.g., number of occurrences).
+ * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (for example, number of occurrences).
  * An `atomic-category-facet` displays a facet of values in a browsable, hierarchical fashion.
  *
  * @part facet - The wrapper for the entire facet.
@@ -38,7 +38,7 @@ import { Bindings } from '../../atomic-search-interface/atomic-search-interface'
  *
  * @part show-more - The show more results button.
  * @part show-less - The show less results button.
- * @part show-more-less-icon - The icons of the show more & show less buttons.
+ * @part show-more-less-icon - The icons of the show more and show less buttons.
  */
 export declare class AtomicCategoryFacet implements InitializableComponent {
     bindings: Bindings;
@@ -68,7 +68,7 @@ export declare class AtomicCategoryFacet implements InitializableComponent {
     /**
      * The tabs on which the facet can be displayed. This property should not be used at the same time as `tabs-excluded`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-included='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```
@@ -78,7 +78,7 @@ export declare class AtomicCategoryFacet implements InitializableComponent {
     /**
      * The tabs on which this facet must not be displayed. This property should not be used at the same time as `tabs-included`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-excluded='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```

package/dist/types/components/search/facets/atomic-color-facet/atomic-color-facet.d.ts

@@ -2,7 +2,7 @@ import { Facet, FacetState, FacetSortCriterion, SearchStatus, SearchStatusState,
 import { InitializableComponent } from '../../../../utils/initialization-utils';
 import { Bindings } from '../../atomic-search-interface/atomic-search-interface';
 /**
- * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (e.g., number of occurrences).
+ * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (for example, number of occurrences).
  * An `atomic-color-facet` displays a facet of the results for the current query as colors.
  *
  * @part facet - The wrapper for the entire facet.
@@ -36,7 +36,7 @@ import { Bindings } from '../../atomic-search-interface/atomic-search-interface'
  *
  * @part show-more - The show more results button.
  * @part show-less - The show less results button.
- * @part show-more-less-icon - The icons of the show more & show less buttons.
+ * @part show-more-less-icon - The icons of the show more and show less buttons.
  */
 export declare class AtomicColorFacet implements InitializableComponent {
     bindings: Bindings;
@@ -66,7 +66,7 @@ export declare class AtomicColorFacet implements InitializableComponent {
     /**
      * The tabs on which the facet can be displayed. This property should not be used at the same time as `tabs-excluded`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-included='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```
@@ -76,7 +76,7 @@ export declare class AtomicColorFacet implements InitializableComponent {
     /**
      * The tabs on which this facet must not be displayed. This property should not be used at the same time as `tabs-included`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-excluded='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```

package/dist/types/components/search/facets/atomic-numeric-facet/atomic-numeric-facet.d.ts

@@ -4,7 +4,7 @@ import { NumberInputType } from '../../../common/facets/facet-number-input/numbe
 import { NumberFormatter } from '../../../common/formats/format-common';
 import { Bindings } from '../../atomic-search-interface/atomic-search-interface';
 /**
- * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (e.g., ascending, descending).
+ * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (for example, ascending, descending).
  * An `atomic-numeric-facet` displays a facet of the results for the current query as numeric ranges.
  *
  * @part facet - The wrapper for the entire facet.
@@ -68,7 +68,7 @@ export declare class AtomicNumericFacet implements InitializableComponent {
     /**
      * The tabs on which the facet can be displayed. This property should not be used at the same time as `tabs-excluded`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-included='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```
@@ -78,7 +78,7 @@ export declare class AtomicNumericFacet implements InitializableComponent {
     /**
      * The tabs on which this facet must not be displayed. This property should not be used at the same time as `tabs-included`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-excluded='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```

package/dist/types/components/search/facets/atomic-rating-facet/atomic-rating-facet.d.ts

@@ -2,7 +2,7 @@ import { NumericFacet, NumericFacetState, SearchStatus, SearchStatusState, TabMa
 import { InitializableComponent } from '../../../../utils/initialization-utils';
 import { Bindings } from '../../atomic-search-interface/atomic-search-interface';
 /**
- * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (e.g., number of occurrences).
+ * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (for example, number of occurrences).
  * An `atomic-rating-facet` displays a facet of the results for the current query as ratings.
  * It only supports numeric fields.
  *
@@ -53,7 +53,7 @@ export declare class AtomicRatingFacet implements InitializableComponent {
     /**
      * The tabs on which the facet can be displayed. This property should not be used at the same time as `tabs-excluded`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-included='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```
@@ -63,7 +63,7 @@ export declare class AtomicRatingFacet implements InitializableComponent {
     /**
      * The tabs on which this facet must not be displayed. This property should not be used at the same time as `tabs-included`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-excluded='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```

package/dist/types/components/search/facets/atomic-rating-range-facet/atomic-rating-range-facet.d.ts

@@ -2,7 +2,7 @@ import { NumericFacet, NumericFacetState, SearchStatus, SearchStatusState, TabMa
 import { InitializableComponent } from '../../../../utils/initialization-utils';
 import { Bindings } from '../../atomic-search-interface/atomic-search-interface';
 /**
- * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (e.g., number of occurrences).
+ * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (for example, number of occurrences).
  * An `atomic-rating-range-facet` displays a facet of the results for the current query as ratings.
  * It only supports numeric fields.
  *
@@ -52,7 +52,7 @@ export declare class AtomicRatingRangeFacet implements InitializableComponent {
     /**
      * The tabs on which the facet can be displayed. This property should not be used at the same time as `tabs-excluded`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-included='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```
@@ -62,7 +62,7 @@ export declare class AtomicRatingRangeFacet implements InitializableComponent {
     /**
      * The tabs on which this facet must not be displayed. This property should not be used at the same time as `tabs-included`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-excluded='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```

package/dist/types/components/search/facets/atomic-segmented-facet/atomic-segmented-facet.d.ts

@@ -35,7 +35,7 @@ export declare class AtomicSegmentedFacet implements InitializableComponent {
     /**
      * The tabs on which the facet can be displayed. This property should not be used at the same time as `tabs-excluded`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-included='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```
@@ -45,7 +45,7 @@ export declare class AtomicSegmentedFacet implements InitializableComponent {
     /**
      * The tabs on which this facet must not be displayed. This property should not be used at the same time as `tabs-included`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-excluded='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```

package/dist/types/components/search/facets/atomic-segmented-facet-scrollable/atomic-segmented-facet-scrollable.d.ts

@@ -8,8 +8,8 @@ import { InitializableComponent } from '../../../../utils/initialization-utils';
  *
  * @part scrollable-container - The wrapper for the entire component including the horizontal-scroll container and the arrow buttons.
  * @part horizontal-scroll - The scrollable container for the segmented facets.
- * @part left-arrow-wrapper - The wrapper for the arrow button & fade on the left.
- * @part right-arrow-wrapper - The wrapper for the arrow button & fade on the right.
+ * @part left-arrow-wrapper - The wrapper for the arrow button and fade on the left.
+ * @part right-arrow-wrapper - The wrapper for the arrow button and fade on the right.
  * @part left-arrow-button - The arrow button used to scroll on the left.
  * @part right-arrow-button - The arrow button used to scroll on the right.
  * @part left-arrow-icon - The arrow icon on the left.

package/dist/types/components/search/facets/atomic-timeframe-facet/atomic-timeframe-facet.d.ts

@@ -57,7 +57,7 @@ export declare class AtomicTimeframeFacet implements InitializableComponent {
     /**
      * The tabs on which the facet can be displayed. This property should not be used at the same time as `tabs-excluded`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-included='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```
@@ -67,7 +67,7 @@ export declare class AtomicTimeframeFacet implements InitializableComponent {
     /**
      * The tabs on which this facet must not be displayed. This property should not be used at the same time as `tabs-included`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-timeframe-facet tabs-excluded='["tabIDA", "tabIDB"]'></atomic-timeframe-facet>
      * ```

package/dist/types/components/search/facets/color-facet-checkbox/color-facet-checkbox.d.ts

@@ -1,6 +1,3 @@
-import { FunctionalComponent } from '../../../../stencil-public-runtime';
-import { FacetValueProps } from '../../../common/facets/stencil-facet-common';
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const ColorFacetCheckbox: FunctionalComponent<FacetValueProps>;
+import type { FacetValuePropsBase } from "../../../common/facets/facet-common";
+import type { FunctionalComponentWithChildren } from "../../../../utils/functional-component-utils";
+export declare const renderColorFacetCheckbox: FunctionalComponentWithChildren<FacetValuePropsBase>;

package/dist/types/components/search/facets/color-facet-checkbox/stencil-color-facet-checkbox.d.ts

@@ -0,0 +1,6 @@
+import { FunctionalComponent } from '../../../../stencil-public-runtime';
+import { FacetValueProps } from '../../../common/facets/stencil-facet-common';
+/**
+ * @deprecated should only be used for Stencil components.
+ */
+export declare const ColorFacetCheckbox: FunctionalComponent<FacetValueProps>;

package/dist/types/components/search/formats/atomic-format-unit.d.ts

@@ -14,9 +14,9 @@ export declare class AtomicFormatUnit {
     /**
      * The unit formatting style to use in unit formatting.
      *
-     * * "long" (e.g., 16 litres)
-     * * "short" (e.g., 16 l)
-     * * "narrow" (e.g., 16l)
+     * * "long" (for example, 16 litres)
+     * * "short" (for example, 16 l)
+     * * "narrow" (for example, 16l)
      */
     unitDisplay?: 'long' | 'short' | 'narrow';
     componentWillLoad(): void;

package/dist/types/components/search/index.d.ts

@@ -3,11 +3,13 @@ export { AtomicFacet } from './atomic-facet/atomic-facet.js';
 export { AtomicHtml } from './atomic-html/atomic-html.js';
 export { AtomicLoadMoreResults } from './atomic-load-more-results/atomic-load-more-results.js';
 export { AtomicPager } from './atomic-pager/atomic-pager.js';
+export { AtomicQueryError } from './atomic-query-error/atomic-query-error.js';
 export { AtomicQuerySummary } from './atomic-query-summary/atomic-query-summary.js';
 export { AtomicRelevanceInspector } from './atomic-relevance-inspector/atomic-relevance-inspector.js';
 export { AtomicResult } from './atomic-result/atomic-result.js';
 export { AtomicResultChildrenTemplate } from './atomic-result-children-template/atomic-result-children-template.js';
 export { AtomicResultList } from './atomic-result-list/atomic-result-list.js';
+export { AtomicResultNumber } from './atomic-result-number/atomic-result-number.js';
 export { AtomicResultSectionActions } from './atomic-result-section-actions/atomic-result-section-actions.js';
 export { AtomicResultSectionBadges } from './atomic-result-section-badges/atomic-result-section-badges.js';
 export { AtomicResultSectionBottomMetadata } from './atomic-result-section-bottom-metadata/atomic-result-section-bottom-metadata.js';

package/dist/types/components/search/result-lists/atomic-folded-result-list/atomic-folded-result-list.d.ts

@@ -6,7 +6,7 @@ import { ItemRenderingFunction } from '../../../common/item-list/stencil-item-li
 import { ItemDisplayDensity, ItemDisplayImageSize } from '../../../common/layout/display-options';
 import { Bindings } from '../../atomic-search-interface/atomic-search-interface';
 /**
- * The `atomic-folded-result-list` component is responsible for displaying folded query results, by applying one or more result templates for up to three layers (i.e., to the result, child and grandchild).
+ * The `atomic-folded-result-list` component is responsible for displaying folded query results, by applying one or more result templates for up to three layers (that is, to the result, child, and grandchild).
  * @slot default - The default slot where the result templates are inserted.
  * @part result-list - The element containing every result of a result list
  * @part outline - The element displaying an outline or a divider around a result
@@ -41,7 +41,7 @@ export declare class AtomicFoldedResultList implements InitializableComponent {
     /**
      * The tabs on which the folded result list can be displayed. This property should not be used at the same time as `tabs-excluded`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-folded-result-list tabs-included='["tabIDA", "tabIDB"]'></atomic-folded-result-list snippet>
      * ```
@@ -51,7 +51,7 @@ export declare class AtomicFoldedResultList implements InitializableComponent {
     /**
      * The tabs on which this folded result list must not be displayed. This property should not be used at the same time as `tabs-included`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-folded-result-list tabs-excluded='["tabIDA", "tabIDB"]'></atomic-folded-result-list>
      * ```
@@ -82,13 +82,13 @@ export declare class AtomicFoldedResultList implements InitializableComponent {
      * @defaultValue `2`
      *
      * @example For an email thread with a total of 20 messages, using the default value of `2` will request the top two child messages, based on the current sort criteria and query, to be returned as children of the parent message.
-     * The user can then click to expand the collection and see the remaining messages that match the current query (i.e., not necessarily all remaining 18 messages). Those messages will be sorted based on the current sort criteria (i.e., not necessarily by date).
+     * The user can then click to expand the collection and see the remaining messages that match the current query (that is, not necessarily all remaining 18 messages). Those messages will be sorted based on the current sort criteria (that is, not necessarily by date).
      * For more info on Result Folding, see [Result Folding](https://docs.coveo.com/en/1884).
      **/
     numberOfFoldedResults: number;
     /**
      * Sets a rendering function to bypass the standard HTML template mechanism for rendering results.
-     * You can use this function while working with web frameworks that don't use plain HTML syntax, e.g., React, Angular or Vue.
+     * You can use this function while working with web frameworks that don't use plain HTML syntax such as React, Angular, or Vue.
      *
      * Do not use this method if you integrate Atomic in a plain HTML deployment.
      */

package/dist/types/components/search/result-template-components/atomic-field-condition/atomic-field-condition.d.ts

@@ -1,6 +1,6 @@
 /**
  * The `atomic-field-condition` component takes a list of conditions that, if fulfilled, apply the template in which it's defined.
- * The condition properties can be based on any top-level result property of the `result` object, not restricted to fields (e.g., `isRecommendation`).
+ * The condition properties can be based on any top-level result property of the `result` object, not restricted to fields (for example, `isRecommendation`).
  *
  * @slot default - The content to display if the conditions are met.
  *

package/dist/types/components/search/result-template-components/atomic-quickview/atomic-quickview.d.ts

@@ -6,7 +6,7 @@ import { Bindings } from '../../atomic-search-interface/atomic-search-interface'
  * The `atomic-quickview` component renders a button which the end user can click to open a modal box containing a preview
  * about a result.
  *
- * The `atomic-quickview` is not meant to replace the `atomic-result-link` to access an item in a result template; it has certain limitations (e.g., custom styles and embedded
+ * The `atomic-quickview` is not meant to replace the `atomic-result-link` to access an item in a result template; it has certain limitations (for example, custom styles and embedded
  * images/links may not work as expected in an `atomic-quickview`).
  *
  * @part button - The button that opens the quickview modal on click.

package/dist/types/components/search/result-template-components/atomic-quickview-modal/atomic-quickview-modal.d.ts

@@ -12,7 +12,7 @@ export interface HighlightKeywords {
     };
 }
 /**
- * The modal opened when clicking on a quickview button.
+ * The modal opened when clicking a quickview button.
  * Do not use this component directly; use `atomic-quickview` instead.
  *
  * @part backdrop - The transparent backdrop hiding the content behind the modal.

package/dist/types/components/search/result-template-components/atomic-result-badge/atomic-result-badge.d.ts

@@ -31,7 +31,7 @@
  * @part result-badge-element - The decorative outer-most element with the background color and text color.
  * @part result-badge-icon - The icon displayed at the left-end of the badge, if present.
  * @part result-badge-label - The wrapper around the contents at the right-end of the badge. This may be text, a field or slotted elements depending on which was configured.
- * @slot default - The element(s) to display inside the badge, instead of a field or label.
+ * @slot default - The elements to display inside the badge, instead of a field or label.
  */
 export declare class AtomicResultBadge {
     private result;

package/dist/types/components/search/smart-snippets/atomic-smart-snippet/atomic-smart-snippet.d.ts

@@ -79,7 +79,7 @@ export declare class AtomicSmartSnippet implements InitializableComponent {
     /**
      * The tabs on which the smart snippet can be displayed. This property should not be used at the same time as `tabs-excluded`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-smart-snippet tabs-included='["tabIDA", "tabIDB"]'></atomic-smart-snippet snippet>
      * ```
@@ -89,7 +89,7 @@ export declare class AtomicSmartSnippet implements InitializableComponent {
     /**
      * The tabs on which this smart snippet must not be displayed. This property should not be used at the same time as `tabs-included`.
      *
-     * Set this property as a stringified JSON array, e.g.,
+     * Set this property as a stringified JSON array, for example:
      * ```html
      *  <atomic-smart-snippet tabs-excluded='["tabIDA", "tabIDB"]'></atomic-smart-snippet>
      * ```