@coveo/atomic 3.33.8-pre.1c7ce2c966 → 3.33.8-pre.1de0612019

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

@@ -1,24 +1,30 @@
-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';
+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";
 export type InitializationOptions = SearchEngineConfiguration;
-export type Bindings = _Bindings;
+export type Bindings = CommonBindings<SearchEngine, SearchStore, AtomicSearchInterface> & NonceBindings;
+declare const AtomicSearchInterface_base: typeof LitElement;
 /**
  * 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 implements StencilBaseAtomicInterface<SearchEngine> {
-    private urlManager;
-    private searchStatus;
+export declare class AtomicSearchInterface extends AtomicSearchInterface_base implements BaseAtomicInterface<SearchEngine> {
+    bindings: Bindings;
+    error: Error;
+    relevanceInspectorIsOpen: boolean;
+    urlManager: UrlManager;
+    searchStatus: SearchStatus;
     private unsubscribeUrlManager;
     private unsubscribeSearchStatus;
     private initialized;
     private store;
-    private commonInterfaceHelper;
-    host: HTMLAtomicSearchInterfaceElement;
-    error?: Error;
-    relevanceInspectorIsOpen: boolean;
+    private interfaceController;
+    static styles: CSSResultGroup;
     /**
      * A list of non-default fields to include in the query results.
      *
@@ -27,7 +33,7 @@ export declare class AtomicSearchInterface implements StencilBaseAtomicInterface
      * <atomic-search-interface fields-to-include='["fieldA", "fieldB"]'></atomic-search-interface>
      * ```
      */
-    fieldsToInclude: string[] | string;
+    fieldsToInclude: string[];
     /**
      * The search interface [query pipeline](https://docs.coveo.com/en/180/).
      *
@@ -69,8 +75,13 @@ export declare class AtomicSearchInterface implements StencilBaseAtomicInterface
     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.
      */
@@ -95,39 +106,19 @@ export declare class AtomicSearchInterface implements StencilBaseAtomicInterface
      * 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;
     /**
-     * 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>
-     * ```
+     * Whether to disable the relevance inspector shortcut for this interface.
      */
-    CspNonce?: string;
+    disableRelevanceInspector: boolean;
     private i18Initialized;
-    private componentWillLoadCalledPromise;
-    private componentWillLoadResolver;
     constructor();
     connectedCallback(): void;
-    componentWillLoad(): void;
-    updateSearchConfiguration(updatedProp: 'searchHub' | 'pipeline', newValue: string | undefined): void;
-    updateSearchHub(): void;
-    updatePipeline(): void;
-    toggleAnalytics(): void;
-    updateLanguage(): Promise<void> | undefined;
-    updateIconAssetsPath(): void;
+    willUpdate(changedProperties: Map<string, unknown>): void;
     disconnectedCallback(): void;
-    handleInitialization(event: InitializeEvent): void;
+    private handleInitialization;
     scrollToTop(): void;
     closeRelevanceInspector(): void;
     /**
@@ -135,7 +126,7 @@ export declare class AtomicSearchInterface implements StencilBaseAtomicInterface
      */
     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.
+     * 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.
      */
     initializeWithSearchEngine(engine: SearchEngine): Promise<void>;
@@ -144,19 +135,30 @@ export declare class AtomicSearchInterface implements StencilBaseAtomicInterface
      * Executes the first search and logs the interface load event to analytics, after initializing connection to the headless search engine.
      */
     executeFirstSearch(): Promise<void>;
-    get bindings(): Bindings;
+    updateSearchConfiguration(updatedProp: 'searchHub' | 'pipeline', newValue: string | undefined): void;
+    updateSearchHub(): void;
+    updatePipeline(): void;
+    toggleAnalytics(): void;
+    updateLanguage(): void;
+    updateIconAssetsPath(): void;
+    private getBindings;
     private initFieldsToInclude;
     registerFieldsToInclude(): void;
-    private updateMobileBreakpoint;
     private initEngine;
     private getSearchConfiguration;
     private get fragment();
     private initUrlManager;
-    private initAriaLive;
+    private handleRelevanceInspectorDoubleClick;
     private initRelevanceInspector;
     private initSearchStatus;
     private updateHash;
     private onHashChange;
     private internalInitialization;
-    render(): any[];
+    render(): import("lit-html").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-search-interface': AtomicSearchInterface;
+    }
 }
+export {};

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

@@ -1,4 +1,5 @@
 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, HTMLAtomicSearchInterfaceElement> & NonceBindings;
+export type Bindings = CommonBindings<SearchEngine, SearchStore, AtomicSearchInterface> & NonceBindings;

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

@@ -11,14 +11,16 @@ 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,5 @@
-export { AtomicPager } from './atomic-pager/atomic-pager.js';
+export { AtomicFacet } from './atomic-facet/atomic-facet.js';
 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 { AtomicSearchLayout } from './atomic-search-layout/atomic-search-layout.js';