@coveo/atomic 3.33.8-pre.4e1f9f5e88 → 3.33.8-pre.502797e5d3

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

@@ -3,6 +3,7 @@ import { type CSSResultGroup, LitElement } from 'lit';
 import type { InitializableComponent } from "../../../decorators/types";
 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").
  *
@@ -12,7 +13,7 @@ import type { Bindings } from '../atomic-search-interface/interfaces';
  * @part query - The summary highlighted query.
  * @part placeholder - The query summary placeholder used while the search interface is initializing.
  */
-export declare class AtomicQuerySummary extends LitElement implements InitializableComponent<Bindings> {
+export declare class AtomicQuerySummary extends AtomicQuerySummary_base implements InitializableComponent<Bindings> {
     bindings: Bindings;
     error: Error;
     static styles: CSSResultGroup;
@@ -27,3 +28,4 @@ declare global {
         'atomic-query-summary': AtomicQuerySummary;
     }
 }
+export {};

package/dist/types/components/search/atomic-results-per-page/atomic-results-per-page.d.ts

@@ -2,6 +2,7 @@ import { type ResultsPerPage, type ResultsPerPageState, type SearchStatus } from
 import { LitElement } from 'lit';
 import type { Bindings } from "../atomic-search-interface/interfaces.js";
 import type { InitializableComponent } from "../../../decorators/types.js";
+declare const AtomicResultsPerPage_base: typeof LitElement;
 /**
  * The `atomic-results-per-page` component determines how many results to display per page.
  *
@@ -10,7 +11,7 @@ import type { InitializableComponent } from "../../../decorators/types.js";
  * @part button - The result per page button.
  * @part active-button - The active result per page button.
  */
-export declare class AtomicResultsPerPage extends LitElement implements InitializableComponent<Bindings> {
+export declare class AtomicResultsPerPage extends AtomicResultsPerPage_base implements InitializableComponent<Bindings> {
     bindings: Bindings;
     error: Error;
     resultPerPage: ResultsPerPage;
@@ -34,3 +35,4 @@ export declare class AtomicResultsPerPage extends LitElement implements Initiali
     private get label();
     render(): import("lit-html").TemplateResult<1>;
 }
+export {};

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

@@ -2,7 +2,7 @@ import { SearchBox, StandaloneSearchBox } from '@coveo/headless';
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { InitializableComponent } from '../../../utils/initialization-utils';
 import { RedirectionPayload } from '../../common/search-box/redirection-payload';
-import { SearchBoxSuggestionsEvent } from '../../common/suggestions/suggestions-common';
+import type { SearchBoxSuggestionsEvent } from '../../common/suggestions/suggestions-types';
 import { Bindings } from '../atomic-search-interface/atomic-search-interface';
 /**
  * The `atomic-search-box` component creates a search box with built-in support for suggestions.

package/dist/types/components/search/{search-box-suggestions/atomic-search-box-query-suggestions → atomic-search-box-query-suggestions}/atomic-search-box-query-suggestions.d.ts

@@ -1,9 +1,13 @@
+import { type SearchBox } from '@coveo/headless';
+import { LitElement } from 'lit';
+import type { SearchBoxSuggestions, SearchBoxSuggestionsBindings } from "../../common/suggestions/suggestions-types";
+import type { Bindings } from "../atomic-search-interface/interfaces";
+import type { SearchBoxSuggestionsComponent } from "../../../decorators/types";
 /**
  * The `atomic-search-box-query-suggestions` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of query suggestion behavior.
  */
-export declare class AtomicSearchBoxQuerySuggestions {
-    private bindings;
-    private host;
+export declare class AtomicSearchBoxQuerySuggestions extends LitElement implements SearchBoxSuggestionsComponent<Bindings> {
+    bindings: SearchBoxSuggestionsBindings<SearchBox, Bindings>;
     error: Error;
     /**
      * The SVG icon to display.
@@ -16,14 +20,19 @@ export declare class AtomicSearchBoxQuerySuggestions {
     /**
      * The maximum number of suggestions that will be displayed if the user has typed something into the input field.
      */
-    maxWithQuery?: number;
+    maxWithQuery: number;
     /**
      * The maximum number of suggestions that will be displayed initially when the input field is empty.
      */
     maxWithoutQuery?: number;
-    componentWillLoad(): void;
-    private initialize;
+    connectedCallback(): void;
+    initialize(): SearchBoxSuggestions;
     private renderItems;
     private renderItem;
-    render(): any;
+    render(): import("lit-html").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-search-box-query-suggestions': AtomicSearchBoxQuerySuggestions;
+    }
 }

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

@@ -1,30 +1,24 @@
-import { type LogLevel, type SearchEngine, type SearchEngineConfiguration, type SearchStatus, type UrlManager } from '@coveo/headless';
-import { type i18n } from 'i18next';
-import { type CSSResultGroup, LitElement } from 'lit';
-import type { CommonBindings, NonceBindings } from '../../common/interface/bindings';
-import { type BaseAtomicInterface } from '../../common/interface/interface-controller';
-import { type SearchStore } from './store';
-import '../../common/atomic-modal/atomic-modal';
+import { LogLevel, SearchEngine, SearchEngineConfiguration } from '@coveo/headless';
+import { i18n } from 'i18next';
+import { InitializeEvent } from '../../../utils/initialization-utils';
+import { StencilBaseAtomicInterface } from '../../common/interface/interface-common-stencil';
+import type { Bindings as _Bindings } from './interfaces';
 export type InitializationOptions = SearchEngineConfiguration;
-export type Bindings = CommonBindings<SearchEngine, SearchStore, AtomicSearchInterface> & NonceBindings;
-declare const AtomicSearchInterface_base: typeof LitElement;
+export type Bindings = _Bindings;
 /**
  * The `atomic-search-interface` component is the parent to all other atomic components in a search page. It handles the headless search engine and localization configurations.
- *
- * @slot default - The default slot where you can add child components to the interface.
  */
-export declare class AtomicSearchInterface extends AtomicSearchInterface_base implements BaseAtomicInterface<SearchEngine> {
-    bindings: Bindings;
-    error: Error;
-    relevanceInspectorIsOpen: boolean;
-    urlManager: UrlManager;
-    searchStatus: SearchStatus;
+export declare class AtomicSearchInterface implements StencilBaseAtomicInterface<SearchEngine> {
+    private urlManager;
+    private searchStatus;
     private unsubscribeUrlManager;
     private unsubscribeSearchStatus;
     private initialized;
     private store;
-    private interfaceController;
-    static styles: CSSResultGroup;
+    private commonInterfaceHelper;
+    host: HTMLAtomicSearchInterfaceElement;
+    error?: Error;
+    relevanceInspectorIsOpen: boolean;
     /**
      * A list of non-default fields to include in the query results.
      *
@@ -33,7 +27,7 @@ export declare class AtomicSearchInterface extends AtomicSearchInterface_base im
      * <atomic-search-interface fields-to-include='["fieldA", "fieldB"]'></atomic-search-interface>
      * ```
      */
-    fieldsToInclude: string[];
+    fieldsToInclude: string[] | string;
     /**
      * The search interface [query pipeline](https://docs.coveo.com/en/180/).
      *
@@ -75,13 +69,8 @@ export declare class AtomicSearchInterface extends AtomicSearchInterface_base im
     engine?: SearchEngine;
     /**
      * Whether the state should be reflected in the URL parameters.
-     * @deprecated - replaced by `disable-state-reflection-in-url` (this defaults to `true`, while the replacement defaults to `false`).
      */
     reflectStateInUrl: boolean;
-    /**
-     * Whether to disable state reflection in the URL parameters.
-     */
-    disableStateReflectionInUrl: boolean;
     /**
      * The CSS selector for the container where the interface will scroll back to.
      */
@@ -106,19 +95,39 @@ export declare class AtomicSearchInterface extends AtomicSearchInterface_base im
      * 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`).
      */
     enableRelevanceInspector: boolean;
     /**
-     * Whether to disable the relevance inspector shortcut for this interface.
+     * The value to set the [nonce](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/nonce) attribute to on inline script and style elements generated by this interface and its child components.
+     * If your application is served with a Content Security Policy (CSP) that doesn't include the `script-src: 'unsafe-inline'` or `style-src: 'unsafe-inline'` directives,
+     * you should ensure that your application server generates a new nonce on every page load and uses the generated value to set this prop and serve the corresponding CSP response headers
+     * (i.e., script-src 'nonce-<YOUR_GENERATED_NONCE>' and style-src 'nonce-<YOUR_GENERATED_NONCE>').
+     * Otherwise you may see console errors such as
+     *  - Refused to execute inline script because it violates the following Content Security Policy directive: [...]
+     *  - Refused to apply inline style because it violates the following Content Security Policy directive: [...].
+     * @example:
+     * ```html
+     * <script nonce="<YOUR_GENERATED_NONCE>">
+     *  import {setNonce} from '@coveo/atomic';
+     *  setNonce('<YOUR_GENERATED_NONCE>');
+     * </script>
+     * ```
      */
-    disableRelevanceInspector: boolean;
+    CspNonce?: string;
     private i18Initialized;
+    private componentWillLoadCalledPromise;
+    private componentWillLoadResolver;
     constructor();
     connectedCallback(): void;
-    willUpdate(changedProperties: Map<string, unknown>): void;
+    componentWillLoad(): void;
+    updateSearchConfiguration(updatedProp: 'searchHub' | 'pipeline', newValue: string | undefined): void;
+    updateSearchHub(): void;
+    updatePipeline(): void;
+    toggleAnalytics(): void;
+    updateLanguage(): Promise<void> | undefined;
+    updateIconAssetsPath(): void;
     disconnectedCallback(): void;
-    private handleInitialization;
+    handleInitialization(event: InitializeEvent): void;
     scrollToTop(): void;
     closeRelevanceInspector(): void;
     /**
@@ -126,7 +135,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.
+     * Initializes the connection with an already preconfigured [headless search engine](https://docs.coveo.com/en/headless/latest/reference/interfaces/Search.SearchEngine.html), as opposed to the `initialize` method, which will internally create a new search engine instance.
      * This bypasses the properties set on the component, such as analytics, searchHub, pipeline, language, timezone & logLevel.
      */
     initializeWithSearchEngine(engine: SearchEngine): Promise<void>;
@@ -135,30 +144,19 @@ export declare class AtomicSearchInterface extends AtomicSearchInterface_base im
      * Executes the first search and logs the interface load event to analytics, after initializing connection to the headless search engine.
      */
     executeFirstSearch(): Promise<void>;
-    updateSearchConfiguration(updatedProp: 'searchHub' | 'pipeline', newValue: string | undefined): void;
-    updateSearchHub(): void;
-    updatePipeline(): void;
-    toggleAnalytics(): void;
-    updateLanguage(): void;
-    updateIconAssetsPath(): void;
-    private getBindings;
+    get bindings(): Bindings;
     private initFieldsToInclude;
     registerFieldsToInclude(): void;
+    private updateMobileBreakpoint;
     private initEngine;
     private getSearchConfiguration;
     private get fragment();
     private initUrlManager;
-    private handleRelevanceInspectorDoubleClick;
+    private initAriaLive;
     private initRelevanceInspector;
     private initSearchStatus;
     private updateHash;
     private onHashChange;
     private internalInitialization;
-    render(): import("lit-html").TemplateResult<1>;
-}
-declare global {
-    interface HTMLElementTagNameMap {
-        'atomic-search-interface': AtomicSearchInterface;
-    }
+    render(): any[];
 }
-export {};

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

@@ -1,5 +1,4 @@
 import type { SearchEngine } from '@coveo/headless';
 import type { CommonBindings, NonceBindings } from '../../common/interface/bindings';
-import type { AtomicSearchInterface } from './atomic-search-interface';
 import type { SearchStore } from './store';
-export type Bindings = CommonBindings<SearchEngine, SearchStore, AtomicSearchInterface> & NonceBindings;
+export type Bindings = CommonBindings<SearchEngine, SearchStore, HTMLAtomicSearchInterfaceElement> & NonceBindings;

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

@@ -11,16 +11,14 @@ declare const AtomicSearchLayout_base: import("../../../mixins/mixin-common").Co
  */
 export declare class AtomicSearchLayout extends AtomicSearchLayout_base {
     static styles: import("lit").CSSResult[];
+    private addStyles;
     error: Error;
     /**
      * The viewport width at which the layout goes from desktop to mobile.
      * E.g., 800px, 65rem.
      */
     mobileBreakpoint: string;
-    private layoutStylesController;
     connectedCallback(): void;
-    private emitBreakpointChangeEvent;
-    onMobileBreakpointChange(): void;
 }
 declare global {
     interface HTMLElementTagNameMap {

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

@@ -1,4 +1,4 @@
 export { AtomicQuerySummary } from './atomic-query-summary/atomic-query-summary.js';
 export { AtomicResultsPerPage } from './atomic-results-per-page/atomic-results-per-page.js';
-export { AtomicSearchInterface } from './atomic-search-interface/atomic-search-interface.js';
+export { AtomicSearchBoxQuerySuggestions } from './atomic-search-box-query-suggestions/atomic-search-box-query-suggestions.js';
 export { AtomicSearchLayout } from './atomic-search-layout/atomic-search-layout.js';

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

@@ -2,7 +2,7 @@ import { Result, SearchBox } from '@coveo/headless';
 import { InitializableComponent } from '../../../../utils/initialization-utils';
 import { ItemRenderingFunction } from '../../../common/item-list/stencil-item-list-common';
 import { ItemDisplayDensity, ItemDisplayImageSize } from '../../../common/layout/display-options';
-import { SearchBoxSuggestions, SearchBoxSuggestionsBindings } from '../../../common/suggestions/suggestions-common';
+import type { SearchBoxSuggestions, SearchBoxSuggestionsBindings } from '../../../common/suggestions/suggestions-types';
 import { Bindings } from '../../atomic-search-interface/atomic-search-interface';
 export type AriaLabelGenerator = (bindings: Bindings, result: Result) => string | undefined;
 /**

package/dist/types/components.d.ts

@@ -5,7 +5,7 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
-import { AutomaticFacet, CategoryFacetSortCriterion, DateFilterRange, DateRangeRequest, FacetResultsMustMatch, FacetSortCriterion, FoldedResult, GeneratedAnswer, GeneratedAnswerCitation, InlineLink, InteractiveCitation, InteractiveResult, NumericFilter, NumericFilterState, RangeFacetRangeAlgorithm, RangeFacetSortCriterion, RelativeDateUnit, Result, ResultTemplate, ResultTemplateCondition, SearchStatus } from "@coveo/headless";
+import { AutomaticFacet, CategoryFacetSortCriterion, DateFilterRange, DateRangeRequest, FacetResultsMustMatch, FacetSortCriterion, FoldedResult, GeneratedAnswer, GeneratedAnswerCitation, InlineLink, InteractiveCitation, InteractiveResult, LogLevel, NumericFilter, NumericFilterState, RangeFacetRangeAlgorithm, RangeFacetSortCriterion, RelativeDateUnit, Result, ResultTemplate, ResultTemplateCondition, SearchEngine, SearchStatus } from "@coveo/headless";
 import { AtomicInterface } from "./utils/initialization-utils";
 import { AnyBindings } from "./components/common/interface/bindings";
 import { NumberInputType } from "./components/common/facets/facet-number-input/number-input-type";
@@ -24,8 +24,10 @@ import { Bindings } from "./components/search/atomic-search-interface/atomic-sea
 import { SearchStore } from "./components/search/atomic-search-interface/store";
 import { RedirectionPayload } from "./components/common/search-box/redirection-payload";
 import { AriaLabelGenerator } from "./components/search/search-box-suggestions/atomic-search-box-instant-results/atomic-search-box-instant-results";
-import { SearchBoxSuggestionElement } from "./components/common/suggestions/suggestions-common";
-export { AutomaticFacet, CategoryFacetSortCriterion, DateFilterRange, DateRangeRequest, FacetResultsMustMatch, FacetSortCriterion, FoldedResult, GeneratedAnswer, GeneratedAnswerCitation, InlineLink, InteractiveCitation, InteractiveResult, NumericFilter, NumericFilterState, RangeFacetRangeAlgorithm, RangeFacetSortCriterion, RelativeDateUnit, Result, ResultTemplate, ResultTemplateCondition, SearchStatus } from "@coveo/headless";
+import { InitializationOptions } from "./components/search/atomic-search-interface/atomic-search-interface";
+import { StandaloneSearchBoxData } from "./utils/local-storage-utils";
+import { SearchBoxSuggestionElement } from "./components/common/suggestions/suggestions-types";
+export { AutomaticFacet, CategoryFacetSortCriterion, DateFilterRange, DateRangeRequest, FacetResultsMustMatch, FacetSortCriterion, FoldedResult, GeneratedAnswer, GeneratedAnswerCitation, InlineLink, InteractiveCitation, InteractiveResult, LogLevel, NumericFilter, NumericFilterState, RangeFacetRangeAlgorithm, RangeFacetSortCriterion, RelativeDateUnit, Result, ResultTemplate, ResultTemplateCondition, SearchEngine, SearchStatus } from "@coveo/headless";
 export { AtomicInterface } from "./utils/initialization-utils";
 export { AnyBindings } from "./components/common/interface/bindings";
 export { NumberInputType } from "./components/common/facets/facet-number-input/number-input-type";
@@ -44,7 +46,9 @@ export { Bindings } from "./components/search/atomic-search-interface/atomic-sea
 export { SearchStore } from "./components/search/atomic-search-interface/store";
 export { RedirectionPayload } from "./components/common/search-box/redirection-payload";
 export { AriaLabelGenerator } from "./components/search/search-box-suggestions/atomic-search-box-instant-results/atomic-search-box-instant-results";
-export { SearchBoxSuggestionElement } from "./components/common/suggestions/suggestions-common";
+export { InitializationOptions } from "./components/search/atomic-search-interface/atomic-search-interface";
+export { StandaloneSearchBoxData } from "./utils/local-storage-utils";
+export { SearchBoxSuggestionElement } from "./components/common/suggestions/suggestions-types";
 export namespace Components {
     /**
      * An automatic facet is a special type of facet generated by the automatic facets feature.
@@ -2412,9 +2416,9 @@ export namespace Components {
         "setRenderFunction": (resultRenderingFunction: ItemRenderingFunction) => Promise<void>;
     }
     /**
-     * The `atomic-search-box-query-suggestions` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of query suggestion behavior.
+     * The `atomic-search-box-recent-queries` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of recent query suggestions.
      */
-    interface AtomicSearchBoxQuerySuggestions {
+    interface AtomicSearchBoxRecentQueries {
         /**
           * The SVG icon to display.  - Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location. - Use a value that starts with `assets://`, to display an icon from the Atomic package. - Use a stringified SVG to display it directly.
          */
@@ -2422,28 +2426,89 @@ export namespace Components {
         /**
           * The maximum number of suggestions that will be displayed if the user has typed something into the input field.
          */
-        "maxWithQuery"?: number;
+        "maxWithQuery": number;
         /**
           * The maximum number of suggestions that will be displayed initially when the input field is empty.
          */
         "maxWithoutQuery"?: number;
     }
     /**
-     * The `atomic-search-box-recent-queries` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of recent query suggestions.
+     * The `atomic-search-interface` component is the parent to all other atomic components in a search page. It handles the headless search engine and localization configurations.
      */
-    interface AtomicSearchBoxRecentQueries {
+    interface AtomicSearchInterface {
         /**
-          * The SVG icon to display.  - Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location. - Use a value that starts with `assets://`, to display an icon from the Atomic package. - Use a stringified SVG to display it directly.
+          * The value to set the [nonce](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/nonce) attribute to on inline script and style elements generated by this interface and its child components. If your application is served with a Content Security Policy (CSP) that doesn't include the `script-src: 'unsafe-inline'` or `style-src: 'unsafe-inline'` directives, you should ensure that your application server generates a new nonce on every page load and uses the generated value to set this prop and serve the corresponding CSP response headers (i.e., script-src 'nonce-<YOUR_GENERATED_NONCE>' and style-src 'nonce-<YOUR_GENERATED_NONCE>'). Otherwise you may see console errors such as  - Refused to execute inline script because it violates the following Content Security Policy directive: [...]  - Refused to apply inline style because it violates the following Content Security Policy directive: [...].
+          * @example : ```html <script nonce="<YOUR_GENERATED_NONCE>"> import {setNonce} from '@coveo/atomic'; setNonce('<YOUR_GENERATED_NONCE>'); </script> ```
          */
-        "icon"?: string;
+        "CspNonce"?: string;
         /**
-          * The maximum number of suggestions that will be displayed if the user has typed something into the input field.
+          * Whether analytics should be enabled.
          */
-        "maxWithQuery": number;
+        "analytics": boolean;
         /**
-          * The maximum number of suggestions that will be displayed initially when the input field is empty.
+          * 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 allows to troubleshoot and debug queries.
          */
-        "maxWithoutQuery"?: number;
+        "enableRelevanceInspector": boolean;
+        /**
+          * The search interface headless engine.
+         */
+        "engine"?: SearchEngine;
+        /**
+          * Executes the first search and logs the interface load event to analytics, after initializing connection to the headless search engine.
+         */
+        "executeFirstSearch": () => Promise<void>;
+        /**
+          * A list of non-default fields to include in the query results.  Specify the property as an array using a JSON string representation: ```html <atomic-search-interface fields-to-include='["fieldA", "fieldB"]'></atomic-search-interface> ```
+         */
+        "fieldsToInclude": string[] | string;
+        /**
+          * The search interface i18next instance.
+         */
+        "i18n": i18n;
+        /**
+          * The icon assets path. By default, this will be a relative URL pointing to `./assets`.  Example: "/mypublicpath/icons"
+         */
+        "iconAssetsPath": string;
+        /**
+          * Initializes the connection with the headless search engine using options for `accessToken` (required), `organizationId` (required), `environment` (defaults to `prod`), and `renewAccessToken`.
+         */
+        "initialize": (options: InitializationOptions) => Promise<void>;
+        /**
+          * Initializes the connection with an already preconfigured [headless search engine](https://docs.coveo.com/en/headless/latest/reference/interfaces/Search.SearchEngine.html), as opposed to the `initialize` method, which will internally create a new search engine instance. This bypasses the properties set on the component, such as analytics, searchHub, pipeline, language, timezone & logLevel.
+         */
+        "initializeWithSearchEngine": (engine: SearchEngine) => Promise<void>;
+        /**
+          * The search interface language.
+         */
+        "language": string;
+        /**
+          * The language assets path. By default, this will be a relative URL pointing to `./lang`.  Example: "/mypublicpath/languages"
+         */
+        "languageAssetsPath": string;
+        /**
+          * The severity level of the messages to log in the console.
+         */
+        "logLevel"?: LogLevel;
+        /**
+          * The search interface [query pipeline](https://docs.coveo.com/en/180/).  If the search interface is initialized using [`initializeWithSearchEngine`](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-search-interface/#initializewithsearchengine), the query pipeline should instead be configured in the target engine.
+         */
+        "pipeline"?: string;
+        /**
+          * Whether the state should be reflected in the URL parameters.
+         */
+        "reflectStateInUrl": boolean;
+        /**
+          * The CSS selector for the container where the interface will scroll back to.
+         */
+        "scrollContainer": string;
+        /**
+          * The search interface [search hub](https://docs.coveo.com/en/1342/).  If the search interface is initialized using [`initializeWithSearchEngine`](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-search-interface/#initializewithsearchengine, the search hub should instead be configured in the target engine.
+         */
+        "searchHub"?: string;
+        /**
+          * The [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) identifier of the time zone to use to correctly interpret dates in the query expression, facets, and result items. By default, the timezone will be [guessed](https://day.js.org/docs/en/timezone/guessing-user-timezone).  Example: "America/Montreal"
+         */
+        "timezone"?: string;
     }
     /**
      * The `atomic-segmented-facet` displays a horizontal facet of the results for the current query.
@@ -4112,15 +4177,6 @@ declare global {
         prototype: HTMLAtomicSearchBoxInstantResultsElement;
         new (): HTMLAtomicSearchBoxInstantResultsElement;
     };
-    /**
-     * The `atomic-search-box-query-suggestions` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of query suggestion behavior.
-     */
-    interface HTMLAtomicSearchBoxQuerySuggestionsElement extends Components.AtomicSearchBoxQuerySuggestions, HTMLStencilElement {
-    }
-    var HTMLAtomicSearchBoxQuerySuggestionsElement: {
-        prototype: HTMLAtomicSearchBoxQuerySuggestionsElement;
-        new (): HTMLAtomicSearchBoxQuerySuggestionsElement;
-    };
     /**
      * The `atomic-search-box-recent-queries` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of recent query suggestions.
      */
@@ -4130,6 +4186,15 @@ declare global {
         prototype: HTMLAtomicSearchBoxRecentQueriesElement;
         new (): HTMLAtomicSearchBoxRecentQueriesElement;
     };
+    /**
+     * The `atomic-search-interface` component is the parent to all other atomic components in a search page. It handles the headless search engine and localization configurations.
+     */
+    interface HTMLAtomicSearchInterfaceElement extends Components.AtomicSearchInterface, HTMLStencilElement {
+    }
+    var HTMLAtomicSearchInterfaceElement: {
+        prototype: HTMLAtomicSearchInterfaceElement;
+        new (): HTMLAtomicSearchInterfaceElement;
+    };
     /**
      * The `atomic-segmented-facet` displays a horizontal facet of the results for the current query.
      */
@@ -4524,8 +4589,8 @@ declare global {
         "atomic-result-timespan": HTMLAtomicResultTimespanElement;
         "atomic-search-box": HTMLAtomicSearchBoxElement;
         "atomic-search-box-instant-results": HTMLAtomicSearchBoxInstantResultsElement;
-        "atomic-search-box-query-suggestions": HTMLAtomicSearchBoxQuerySuggestionsElement;
         "atomic-search-box-recent-queries": HTMLAtomicSearchBoxRecentQueriesElement;
+        "atomic-search-interface": HTMLAtomicSearchInterfaceElement;
         "atomic-segmented-facet": HTMLAtomicSegmentedFacetElement;
         "atomic-segmented-facet-scrollable": HTMLAtomicSegmentedFacetScrollableElement;
         "atomic-smart-snippet": HTMLAtomicSmartSnippetElement;
@@ -6791,9 +6856,9 @@ declare namespace LocalJSX {
         "maxResultsPerQuery"?: number;
     }
     /**
-     * The `atomic-search-box-query-suggestions` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of query suggestion behavior.
+     * The `atomic-search-box-recent-queries` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of recent query suggestions.
      */
-    interface AtomicSearchBoxQuerySuggestions {
+    interface AtomicSearchBoxRecentQueries {
         /**
           * The SVG icon to display.  - Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location. - Use a value that starts with `assets://`, to display an icon from the Atomic package. - Use a stringified SVG to display it directly.
          */
@@ -6808,21 +6873,70 @@ declare namespace LocalJSX {
         "maxWithoutQuery"?: number;
     }
     /**
-     * The `atomic-search-box-recent-queries` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of recent query suggestions.
+     * The `atomic-search-interface` component is the parent to all other atomic components in a search page. It handles the headless search engine and localization configurations.
      */
-    interface AtomicSearchBoxRecentQueries {
+    interface AtomicSearchInterface {
         /**
-          * The SVG icon to display.  - Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location. - Use a value that starts with `assets://`, to display an icon from the Atomic package. - Use a stringified SVG to display it directly.
+          * The value to set the [nonce](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/nonce) attribute to on inline script and style elements generated by this interface and its child components. If your application is served with a Content Security Policy (CSP) that doesn't include the `script-src: 'unsafe-inline'` or `style-src: 'unsafe-inline'` directives, you should ensure that your application server generates a new nonce on every page load and uses the generated value to set this prop and serve the corresponding CSP response headers (i.e., script-src 'nonce-<YOUR_GENERATED_NONCE>' and style-src 'nonce-<YOUR_GENERATED_NONCE>'). Otherwise you may see console errors such as  - Refused to execute inline script because it violates the following Content Security Policy directive: [...]  - Refused to apply inline style because it violates the following Content Security Policy directive: [...].
+          * @example : ```html <script nonce="<YOUR_GENERATED_NONCE>"> import {setNonce} from '@coveo/atomic'; setNonce('<YOUR_GENERATED_NONCE>'); </script> ```
          */
-        "icon"?: string;
+        "CspNonce"?: string;
         /**
-          * The maximum number of suggestions that will be displayed if the user has typed something into the input field.
+          * Whether analytics should be enabled.
          */
-        "maxWithQuery"?: number;
+        "analytics"?: boolean;
         /**
-          * The maximum number of suggestions that will be displayed initially when the input field is empty.
+          * 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 allows to troubleshoot and debug queries.
          */
-        "maxWithoutQuery"?: number;
+        "enableRelevanceInspector"?: boolean;
+        /**
+          * The search interface headless engine.
+         */
+        "engine"?: SearchEngine;
+        /**
+          * A list of non-default fields to include in the query results.  Specify the property as an array using a JSON string representation: ```html <atomic-search-interface fields-to-include='["fieldA", "fieldB"]'></atomic-search-interface> ```
+         */
+        "fieldsToInclude"?: string[] | string;
+        /**
+          * The search interface i18next instance.
+         */
+        "i18n"?: i18n;
+        /**
+          * The icon assets path. By default, this will be a relative URL pointing to `./assets`.  Example: "/mypublicpath/icons"
+         */
+        "iconAssetsPath"?: string;
+        /**
+          * The search interface language.
+         */
+        "language"?: string;
+        /**
+          * The language assets path. By default, this will be a relative URL pointing to `./lang`.  Example: "/mypublicpath/languages"
+         */
+        "languageAssetsPath"?: string;
+        /**
+          * The severity level of the messages to log in the console.
+         */
+        "logLevel"?: LogLevel;
+        /**
+          * The search interface [query pipeline](https://docs.coveo.com/en/180/).  If the search interface is initialized using [`initializeWithSearchEngine`](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-search-interface/#initializewithsearchengine), the query pipeline should instead be configured in the target engine.
+         */
+        "pipeline"?: string;
+        /**
+          * Whether the state should be reflected in the URL parameters.
+         */
+        "reflectStateInUrl"?: boolean;
+        /**
+          * The CSS selector for the container where the interface will scroll back to.
+         */
+        "scrollContainer"?: string;
+        /**
+          * The search interface [search hub](https://docs.coveo.com/en/1342/).  If the search interface is initialized using [`initializeWithSearchEngine`](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-search-interface/#initializewithsearchengine, the search hub should instead be configured in the target engine.
+         */
+        "searchHub"?: string;
+        /**
+          * The [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) identifier of the time zone to use to correctly interpret dates in the query expression, facets, and result items. By default, the timezone will be [guessed](https://day.js.org/docs/en/timezone/guessing-user-timezone).  Example: "America/Montreal"
+         */
+        "timezone"?: string;
     }
     /**
      * The `atomic-segmented-facet` displays a horizontal facet of the results for the current query.
@@ -7329,8 +7443,8 @@ declare namespace LocalJSX {
         "atomic-result-timespan": AtomicResultTimespan;
         "atomic-search-box": AtomicSearchBox;
         "atomic-search-box-instant-results": AtomicSearchBoxInstantResults;
-        "atomic-search-box-query-suggestions": AtomicSearchBoxQuerySuggestions;
         "atomic-search-box-recent-queries": AtomicSearchBoxRecentQueries;
+        "atomic-search-interface": AtomicSearchInterface;
         "atomic-segmented-facet": AtomicSegmentedFacet;
         "atomic-segmented-facet-scrollable": AtomicSegmentedFacetScrollable;
         "atomic-smart-snippet": AtomicSmartSnippet;
@@ -7842,14 +7956,14 @@ declare module "@stencil/core" {
              * This component is not supported on mobile.
              */
             "atomic-search-box-instant-results": LocalJSX.AtomicSearchBoxInstantResults & JSXBase.HTMLAttributes<HTMLAtomicSearchBoxInstantResultsElement>;
-            /**
-             * The `atomic-search-box-query-suggestions` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of query suggestion behavior.
-             */
-            "atomic-search-box-query-suggestions": LocalJSX.AtomicSearchBoxQuerySuggestions & JSXBase.HTMLAttributes<HTMLAtomicSearchBoxQuerySuggestionsElement>;
             /**
              * The `atomic-search-box-recent-queries` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of recent query suggestions.
              */
             "atomic-search-box-recent-queries": LocalJSX.AtomicSearchBoxRecentQueries & JSXBase.HTMLAttributes<HTMLAtomicSearchBoxRecentQueriesElement>;
+            /**
+             * The `atomic-search-interface` component is the parent to all other atomic components in a search page. It handles the headless search engine and localization configurations.
+             */
+            "atomic-search-interface": LocalJSX.AtomicSearchInterface & JSXBase.HTMLAttributes<HTMLAtomicSearchInterfaceElement>;
             /**
              * The `atomic-segmented-facet` displays a horizontal facet of the results for the current query.
              */

package/dist/types/decorators/types.d.ts

@@ -1,7 +1,7 @@
 import type { LitElement, TemplateResult } from 'lit';
 import type { TemplateResultType } from 'lit/directive-helpers.js';
 import type { AnyBindings } from '../components/common/interface/bindings';
-import type { SearchBoxSuggestions } from '../components/common/suggestions/suggestions-common';
+import type { SearchBoxSuggestions } from '../components/common/suggestions/suggestions-types';
 export type GenericRender<T extends TemplateResultType> = TemplateResult<T>;
 export type RenderGuardDecorator<Component, T extends TemplateResultType, Descriptor = TypedPropertyDescriptor<() => GenericRender<T>>> = (target: Component, propertyKey: 'render', descriptor: Descriptor) => Descriptor;
 /**