@coveo/atomic 3.33.8-pre.32aa53b021 → 3.33.8-pre.32dc00f676

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/{atomic-facet → facets/atomic-facet}/atomic-facet.d.ts

@@ -1,8 +1,6 @@
-import { type Facet, type FacetResultsMustMatch, type FacetSortCriterion, type FacetState, type SearchStatus, type SearchStatusState, type TabManager, type TabManagerState } from '@coveo/headless';
-import { LitElement } from 'lit';
-import type { InitializableComponent } from "../../../decorators/types";
-import type { Bindings } from '../atomic-search-interface/atomic-search-interface';
-import '../../common/atomic-facet-placeholder/atomic-facet-placeholder';
+import { Facet, FacetState, FacetSortCriterion, SearchStatus, SearchStatusState, FacetResultsMustMatch, TabManagerState, TabManager } from '@coveo/headless';
+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).
  * An `atomic-facet` displays a facet of the results for the current query.
@@ -42,12 +40,12 @@ import '../../common/atomic-facet-placeholder/atomic-facet-placeholder';
  * @part show-less - The show less results button.
  * @part show-more-less-icon - The icons of the show more & show less buttons.
  */
-export declare class AtomicFacet extends LitElement implements InitializableComponent<Bindings> {
-    static styles: import("lit").CSSResult[];
+export declare class AtomicFacet implements InitializableComponent {
     bindings: Bindings;
     facet: Facet;
     searchStatus: SearchStatus;
     tabManager: TabManager;
+    private host;
     facetState: FacetState;
     searchStatusState: SearchStatusState;
     tabManagerState: TabManagerState;
@@ -203,13 +201,11 @@ export declare class AtomicFacet extends LitElement implements InitializableComp
     private showMoreFocus?;
     private headerFocus?;
     private facetConditionsManager?;
-    private facetSearchAriaLive?;
+    protected facetSearchAriaMessage: string;
     initialize(): void;
     disconnectedCallback(): void;
-    shouldUpdate(changedProperties: Map<string, unknown>): boolean;
-    private shouldRenderFacet;
-    render(): import("lit-html").TemplateResult<1>;
-    private renderFacetHeader;
+    componentShouldUpdate(next: FacetState, prev: FacetState, propName: keyof AtomicFacet): boolean;
+    render(): any;
     private renderBody;
     private renderValuesContainer;
     private renderSearchResults;
@@ -220,7 +216,6 @@ export declare class AtomicFacet extends LitElement implements InitializableComp
     private get facetOptions();
     private get facetValueProps();
     private get isHidden();
-    private get host();
     private initConditionManager;
     private registerFacet;
     private initPopover;
@@ -228,4 +223,5 @@ export declare class AtomicFacet extends LitElement implements InitializableComp
     private get facetInfo();
     private get definedLabel();
     private get focusTargets();
+    private isFacetState;
 }

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

@@ -1,5 +1,3 @@
-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';

package/dist/types/components/search/result-template-component-utils/context/fetch-result-context.d.ts

@@ -0,0 +1,8 @@
+import type { FoldedResult, Result } from '@coveo/headless';
+/**
+ * Retrieves `Result` on a rendered `atomic-result`.
+ *
+ * @param element - The element that the event is dispatched to
+ * @returns A promise that resolves on initialization of the parent `atomic-result` element, or rejects if missing
+ */
+export declare function fetchResultContext<T extends Result | FoldedResult = Result>(element: Element): Promise<T>;

package/dist/types/components/search/result-template-component-utils/context/interactive-result-context-controller.d.ts

@@ -0,0 +1,12 @@
+import type { InteractiveResult } from '@coveo/headless';
+import type { LitElement } from 'lit';
+import { InteractiveItemContextController } from "../../../common/item-list/context/interactive-item-context-controller";
+/**
+ * Creates a [Lit reactive controller](https://lit.dev/docs/composition/controllers/) for managing interactive result context in result template components.
+ *
+ * @param host - The Lit component instance
+ * @returns InteractiveItemContextController instance
+ */
+export declare function createInteractiveResultContextController(host: LitElement & {
+    error: Error;
+}): InteractiveItemContextController<InteractiveResult>;

package/dist/types/components/search/result-template-component-utils/context/result-context-controller.d.ts

@@ -0,0 +1,18 @@
+import type { FoldedResult, InteractiveResult, Result } from '@coveo/headless';
+import type { LitElement } from 'lit';
+import type { InteractiveItemContextEvent } from "../../../common/item-list/context/interactive-item-context-controller";
+import { ItemContextController, type ItemContextEvent } from "../../../common/item-list/context/item-context-controller";
+/**
+ * Creates a [Lit reactive controller](https://lit.dev/docs/composition/controllers/) for managing result context in result template components.
+ *
+ * @param host - The Lit component instance
+ * @param options - Configuration options
+ * @returns ItemContextController instance configured for atomic-result
+ */
+export declare function createResultContextController(host: LitElement & {
+    error: Error | null;
+}, options?: {
+    folded?: boolean;
+}): ItemContextController<Result | FoldedResult>;
+export type ResultContextEvent<T = Result> = ItemContextEvent<T>;
+export type InteractiveResultContextEvent<T extends InteractiveResult = InteractiveResult> = InteractiveItemContextEvent<T>;

package/dist/types/components/search/{result-template-components/result-template-decorators.d.ts → result-template-component-utils/context/stencil-result-template-decorators.d.ts}

@@ -1,5 +1,5 @@
 import { FoldedResult, Result } from '@coveo/headless';
-import { InteractiveItemContextEvent, ItemContextEvent } from '../../common/item-list/stencil-item-decorators';
+import { InteractiveItemContextEvent, ItemContextEvent } from "../../../common/item-list/stencil-item-decorators";
 /**
  * A [StencilJS property decorator](https://stenciljs.com/) to be used for result template components.
  * This allows the Stencil component to fetch the current result from its rendered parent, the `atomic-result` component.
@@ -8,6 +8,8 @@ import { InteractiveItemContextEvent, ItemContextEvent } from '../../common/item
  * @ResultContext() private result!: Result;
  *
  * For more information and examples, view the "Utilities" section of the readme.
+ *
+ * @deprecated should only be used for Stencil components. For Lit components, use `createResultContextController` from \@/src/components/search/result-template-component-utils/context/result-context-controller.ts
  */
 export declare function ResultContext(opts?: {
     folded: boolean;
@@ -22,7 +24,9 @@ export type InteractiveResultContextEvent = InteractiveItemContextEvent;
  *
  * You should use the method in the [connectedCallback lifecycle method](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements#using_the_lifecycle_callbacks).
  *
- * @param element The element that the event is dispatched to, which must be the child of a rendered "atomic-result".
+ * @param element The element that the event is dispatched to, which must be the child of a rendered "atomic-result" element.
  * @returns A promise that resolves on initialization of the parent "atomic-result" element, or rejects when there is no parent "atomic-result" element.
+ *
+ * @deprecated should only be used for Stencil components. For Lit components, use `fetchResultContext` from \@/src/components/search/result-template-component-utils/context/fetch-result-context.ts
  */
 export declare function resultContext<T extends Result | FoldedResult = Result>(element: Element): Promise<T>;