@coveo/atomic 3.33.4-pre.d6df6afdb0 → 3.33.4-pre.da0d82cd6a

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

@@ -1,28 +1,24 @@
-import { type LogLevel, type SearchEngine, type SearchEngineConfiguration } 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 { 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> {
+export declare class AtomicSearchInterface implements StencilBaseAtomicInterface<SearchEngine> {
     private urlManager;
     private searchStatus;
     private unsubscribeUrlManager;
     private unsubscribeSearchStatus;
     private initialized;
     private store;
-    private interfaceController;
-    error: Error;
+    private commonInterfaceHelper;
+    host: HTMLAtomicSearchInterfaceElement;
+    error?: Error;
     relevanceInspectorIsOpen: boolean;
-    static styles: CSSResultGroup;
     /**
      * A list of non-default fields to include in the query results.
      *
@@ -31,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/).
      *
@@ -101,17 +97,37 @@ export declare class AtomicSearchInterface extends AtomicSearchInterface_base im
      * The relevance inspector allows to troubleshoot and debug queries.
      */
     enableRelevanceInspector: boolean;
+    /**
+     * 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>
+     * ```
+     */
+    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(): void;
+    updateLanguage(): Promise<void> | undefined;
     updateIconAssetsPath(): void;
     disconnectedCallback(): void;
-    private handleInitialization;
+    handleInitialization(event: InitializeEvent): void;
     scrollToTop(): void;
     closeRelevanceInspector(): void;
     /**
@@ -119,7 +135,7 @@ export declare class AtomicSearchInterface extends AtomicSearchInterface_base im
      */
     initialize(options: InitializationOptions): Promise<void>;
     /**
-     * Initializes the connection with an already preconfigured [headless search engine](https://docs.coveo.com/en/headless/latest/reference/modules/Search.html, as opposed to the `initialize` method, which will internally create a new 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>;
@@ -128,9 +144,7 @@ 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>;
-    bindings: Bindings;
-    updateSearchConfiguration(updatedProp: 'searchHub' | 'pipeline', newValue: string | undefined): void;
-    private getBindings;
+    get bindings(): Bindings;
     private initFieldsToInclude;
     registerFieldsToInclude(): void;
     private updateMobileBreakpoint;
@@ -138,16 +152,11 @@ export declare class AtomicSearchInterface extends AtomicSearchInterface_base im
     private getSearchConfiguration;
     private get fragment();
     private initUrlManager;
+    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/index.d.ts

@@ -1,3 +1,2 @@
 export { AtomicResultsPerPage } from './atomic-results-per-page/atomic-results-per-page.js';
-export { AtomicSearchInterface } from './atomic-search-interface/atomic-search-interface.js';
 export { AtomicSearchLayout } from './atomic-search-layout/atomic-search-layout.js';

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 { InitializationOptions } from "./components/search/atomic-search-interface/atomic-search-interface";
+import { StandaloneSearchBoxData } from "./utils/local-storage-utils";
 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";
+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,6 +46,8 @@ 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 { InitializationOptions } from "./components/search/atomic-search-interface/atomic-search-interface";
+export { StandaloneSearchBoxData } from "./utils/local-storage-utils";
 export { SearchBoxSuggestionElement } from "./components/common/suggestions/suggestions-common";
 export namespace Components {
     /**
@@ -2468,6 +2472,84 @@ export namespace Components {
          */
         "maxWithoutQuery"?: number;
     }
+    /**
+     * 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 AtomicSearchInterface {
+        /**
+          * 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> ```
+         */
+        "CspNonce"?: string;
+        /**
+          * Whether analytics should be enabled.
+         */
+        "analytics": boolean;
+        /**
+          * 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.
+         */
+        "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.
      */
@@ -4186,6 +4268,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.
      */
@@ -4584,6 +4675,7 @@ declare global {
         "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;
@@ -6906,6 +6998,72 @@ declare namespace LocalJSX {
          */
         "maxWithoutQuery"?: number;
     }
+    /**
+     * 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 AtomicSearchInterface {
+        /**
+          * 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> ```
+         */
+        "CspNonce"?: string;
+        /**
+          * Whether analytics should be enabled.
+         */
+        "analytics"?: boolean;
+        /**
+          * 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.
+         */
+        "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.
      */
@@ -7415,6 +7573,7 @@ declare namespace LocalJSX {
         "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;
@@ -7942,6 +8101,10 @@ declare module "@stencil/core" {
              * 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.
              */