@coveo/atomic 3.34.0-pre.616c4e348b → 3.34.0-pre.64accaaf5d

package/dist/types/components/common/validate-props-controller/validate-props-controller.d.ts

@@ -0,0 +1,32 @@
+import type { Schema } from '@coveo/bueno';
+import type { ReactiveController, ReactiveControllerHost } from 'lit';
+/**
+ * A reactive controller that validates the props of a Lit component against a
+ * provided Bueno schema.
+ *
+ * It validates the props when the host is connected to the DOM and whenever
+ * the host updates, revalidating only if the props have changed since the last
+ * validation.
+ *
+ * If validation fails, the controller sets the `error` property on the host.
+ */
+export declare class ValidatePropsController<TProps extends Record<string, unknown>> implements ReactiveController {
+    private host;
+    private getProps;
+    private schema;
+    private currentProps?;
+    private previousProps?;
+    /**
+     * Creates a `ValidatePropsController`.
+     *
+     * @param host The host element.
+     * @param getProps A function that returns the current props to validate.
+     * @param schema The Bueno schema to validate the props against.
+     */
+    constructor(host: ReactiveControllerHost & HTMLElement & {
+        error: Error;
+    }, getProps: () => TProps, schema: Schema<TProps>);
+    hostConnected(): void;
+    hostUpdate(): void;
+    private _validateProps;
+}

package/dist/types/components/search/atomic-relevance-inspector/atomic-relevance-inspector.d.ts

@@ -1,15 +1,25 @@
-import { EventEmitter } from '../../../stencil-public-runtime';
-import { Bindings } from '../atomic-search-interface/atomic-search-interface';
+import { LitElement } from 'lit';
+import "../../common/atomic-modal/atomic-modal";
+import type { Bindings } from "../atomic-search-interface/interfaces";
+import type { InitializableComponent } from "../../../decorators/types.js";
 /**
  * The `atomic-relevance-inspector` component is used internally to offer insight on search page relevance, as well as information to help troubleshoot issues during development.
+ *
+ * @internal
  */
-export declare class AtomicRelevanceInspector {
-    /**
-     * The Atomic interface bindings, namely the headless search engine and i18n instances.
-     */
+export declare class AtomicRelevanceInspector extends LitElement implements InitializableComponent<Bindings> {
     bindings: Bindings;
+    error: Error;
     open: boolean;
-    closeRelevanceInspector: EventEmitter<null> | undefined;
-    render(): any;
+    initialize: () => void;
+    disconnectedCallback(): void;
+    render(): import("lit-html").TemplateResult<1>;
+    private handleRelevanceInspectorDoubleClick;
+    private handleCloseRelevanceInspector;
     private get adminHref();
 }
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-relevance-inspector': AtomicRelevanceInspector;
+    }
+}

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

@@ -0,0 +1,45 @@
+import { type SearchBox } from '@coveo/headless';
+import { LitElement } from 'lit';
+import type { SearchBoxSuggestionsComponent } from "../../../decorators/types";
+import type { SearchBoxSuggestions, SearchBoxSuggestionsBindings } from '../../common/suggestions/suggestions-types';
+import type { Bindings } from '../atomic-search-interface/interfaces';
+/**
+ * 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.
+ */
+export declare class AtomicSearchBoxRecentQueries extends LitElement implements SearchBoxSuggestionsComponent<Bindings> {
+    bindings: SearchBoxSuggestionsBindings<SearchBox, Bindings>;
+    private recentQueriesList;
+    private storage;
+    error: Error;
+    /**
+     * 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.
+     */
+    icon?: string;
+    /**
+     * The maximum number of suggestions to display when the user types in the input field.
+     */
+    maxWithQuery: number;
+    /**
+     * The maximum number of suggestions to display initially, when the input field is empty.
+     */
+    maxWithoutQuery?: number;
+    connectedCallback(): void;
+    initialize(): SearchBoxSuggestions;
+    private retrieveLocalStorage;
+    private updateLocalStorage;
+    private warnUser;
+    private disableFeature;
+    private renderItems;
+    private renderClear;
+    private renderItem;
+    render(): import("lit-html").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-search-box-recent-queries': AtomicSearchBoxRecentQueries;
+    }
+}

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

@@ -3,6 +3,7 @@ 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 "../atomic-relevance-inspector/atomic-relevance-inspector";
 import { type SearchStore } from './store';
 import "../../common/atomic-modal/atomic-modal";
 export type InitializationOptions = SearchEngineConfiguration;
@@ -16,7 +17,6 @@ declare const AtomicSearchInterface_base: typeof LitElement;
 export declare class AtomicSearchInterface extends AtomicSearchInterface_base implements BaseAtomicInterface<SearchEngine> {
     bindings: Bindings;
     error: Error;
-    relevanceInspectorIsOpen: boolean;
     urlManager: UrlManager;
     searchStatus: SearchStatus;
     private unsubscribeUrlManager;
@@ -24,6 +24,7 @@ export declare class AtomicSearchInterface extends AtomicSearchInterface_base im
     private initialized;
     private store;
     private interfaceController;
+    private relevanceInspector?;
     static styles: CSSResultGroup;
     /**
      * A list of non-default fields to include in the query results.
@@ -120,6 +121,9 @@ export declare class AtomicSearchInterface extends AtomicSearchInterface_base im
     disconnectedCallback(): void;
     private handleInitialization;
     scrollToTop(): void;
+    /**
+     * @deprecated provided for backward compatibility. set the 'open' property directly on the relevance inspector instead.
+     */
     closeRelevanceInspector(): void;
     /**
      * Initializes the connection with the headless search engine using options for `accessToken` (required), `organizationId` (required), `environment` (defaults to `prod`), and `renewAccessToken`.
@@ -149,8 +153,6 @@ export declare class AtomicSearchInterface extends AtomicSearchInterface_base im
     private getSearchConfiguration;
     private get fragment();
     private initUrlManager;
-    private handleRelevanceInspectorDoubleClick;
-    private initRelevanceInspector;
     private initSearchStatus;
     private updateHash;
     private onHashChange;

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

@@ -1,14 +1,7 @@
 export { AtomicPager } from './atomic-pager/atomic-pager.js';
 export { AtomicQuerySummary } from './atomic-query-summary/atomic-query-summary.js';
-export { AtomicResultSectionActions } from './atomic-result-section-actions/atomic-result-section-actions.js';
-export { AtomicResultSectionBadges } from './atomic-result-section-badges/atomic-result-section-badges.js';
-export { AtomicResultSectionBottomMetadata } from './atomic-result-section-bottom-metadata/atomic-result-section-bottom-metadata.js';
-export { AtomicResultSectionChildren } from './atomic-result-section-children/atomic-result-section-children.js';
-export { AtomicResultSectionEmphasized } from './atomic-result-section-emphasized/atomic-result-section-emphasized.js';
-export { AtomicResultSectionExcerpt } from './atomic-result-section-excerpt/atomic-result-section-excerpt.js';
-export { AtomicResultSectionTitle } from './atomic-result-section-title/atomic-result-section-title.js';
-export { AtomicResultSectionTitleMetadata } from './atomic-result-section-title-metadata/atomic-result-section-title-metadata.js';
-export { AtomicResultSectionVisual } from './atomic-result-section-visual/atomic-result-section-visual.js';
+export { AtomicRelevanceInspector } from './atomic-relevance-inspector/atomic-relevance-inspector.js';
 export { AtomicResultsPerPage } from './atomic-results-per-page/atomic-results-per-page.js';
+export { AtomicSearchBoxRecentQueries } from './atomic-search-box-recent-queries/atomic-search-box-recent-queries.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/{atomic-result-section-actions → result-template-components/atomic-result-sections}/atomic-result-section-actions.d.ts

@@ -1,5 +1,3 @@
-import { LitElement } from 'lit';
-declare const AtomicResultSectionActions_base: typeof LitElement;
 /**
  * This section allows the information seeker to perform an action on an item without having to view its details.
  * For example, in Commerce you can add an item to the cart directly or add it to a wish list to view at a later time.
@@ -10,11 +8,7 @@ declare const AtomicResultSectionActions_base: typeof LitElement;
  * * Is a wrapping flexbox with a gap.
  * * May appear over, next to, or beneath the visual section.
  */
-export declare class AtomicResultSectionActions extends AtomicResultSectionActions_base {
+export declare class AtomicResultSectionActions {
+    private host;
+    componentDidRender(): void;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'atomic-result-section-actions': AtomicResultSectionActions;
-    }
-}
-export {};

package/dist/types/components/search/{atomic-result-section-badges → result-template-components/atomic-result-sections}/atomic-result-section-badges.d.ts

@@ -1,5 +1,3 @@
-import { LitElement } from 'lit';
-declare const AtomicResultSectionBadges_base: typeof LitElement;
 /**
  * This section provides badges that highlight special features of the item.
  *
@@ -9,11 +7,7 @@ declare const AtomicResultSectionBadges_base: typeof LitElement;
  * * Is a wrapping flexbox with a gap.
  * * May appear over, next to, or beneath the visual section.
  */
-export declare class AtomicResultSectionBadges extends AtomicResultSectionBadges_base {
+export declare class AtomicResultSectionBadges {
+    private host;
+    componentDidRender(): void;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'atomic-result-section-badges': AtomicResultSectionBadges;
-    }
-}
-export {};

package/dist/types/components/search/{atomic-result-section-bottom-metadata → result-template-components/atomic-result-sections}/atomic-result-section-bottom-metadata.d.ts

@@ -1,5 +1,3 @@
-import { LitElement } from 'lit';
-declare const AtomicResultSectionBottomMetadata_base: typeof LitElement;
 /**
  * This section displays additional descriptive information about the item.
  *
@@ -10,11 +8,7 @@ declare const AtomicResultSectionBottomMetadata_base: typeof LitElement;
  * * Has a defined CSS `color` property for text.
  * * Has a font weight.
  */
-export declare class AtomicResultSectionBottomMetadata extends AtomicResultSectionBottomMetadata_base {
+export declare class AtomicResultSectionBottomMetadata {
+    private host;
+    componentDidRender(): void;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'atomic-result-section-bottom-metadata': AtomicResultSectionBottomMetadata;
-    }
-}
-export {};

package/dist/types/components/search/result-template-components/atomic-result-sections/atomic-result-section-children.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This section displays the folded results, available when using the <atomic-result-children> component.
+ *
+ * Behavior:
+ * * Shows children at the bottom of the result, indented and wrapped in a border.
+ */
+export declare class AtomicResultSectionChildren {
+    private host;
+    componentDidRender(): void;
+}

package/dist/types/components/search/result-template-components/atomic-result-sections/atomic-result-section-emphasized.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This section displays the field that's important for its search criteria.
+ * For example, in Commerce, a product's cost is often more important than the title itself.
+ *
+ * Behavior:
+ * * Has a very large font size.
+ * * Is the second closest element beneath the title section.
+ */
+export declare class AtomicResultSectionEmphasized {
+    private host;
+    componentDidRender(): void;
+}

package/dist/types/components/search/{atomic-result-section-excerpt → result-template-components/atomic-result-sections}/atomic-result-section-excerpt.d.ts

@@ -1,5 +1,3 @@
-import { LitElement } from 'lit';
-declare const AtomicResultSectionExcerpt_base: typeof LitElement;
 /**
  * This section contains an informative summary of the item's content.
  *
@@ -9,11 +7,7 @@ declare const AtomicResultSectionExcerpt_base: typeof LitElement;
  * * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
  * * Has a defined CSS `color` property for text.
  */
-export declare class AtomicResultSectionExcerpt extends AtomicResultSectionExcerpt_base {
+export declare class AtomicResultSectionExcerpt {
+    private host;
+    componentDidRender(): void;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'atomic-result-section-excerpt': AtomicResultSectionExcerpt;
-    }
-}
-export {};

package/dist/types/components/search/result-template-components/atomic-result-sections/atomic-result-section-title-metadata.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This section surfaces some fields that are directly related to the title of the item.
+ * For example, in Commerce, this could be the item's rating, which is tied to the nature of the product itself,
+ * rather than to the product's description.
+ *
+ * Behavior:
+ * * Has a very small font size.
+ * * Is the closest element beneath the title section.
+ */
+export declare class AtomicResultSectionTitleMetadata {
+    private host;
+    componentDidRender(): void;
+}

package/dist/types/components/search/{atomic-result-section-title → result-template-components/atomic-result-sections}/atomic-result-section-title.d.ts

@@ -1,5 +1,3 @@
-import { LitElement } from 'lit';
-declare const AtomicResultSectionTitle_base: typeof LitElement;
 /**
  * This section identifies the item by its name, and its main use is to make the result list scannable.
  * This is usually the page title.
@@ -9,11 +7,7 @@ declare const AtomicResultSectionTitle_base: typeof LitElement;
  * * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
  * * Has a defined CSS `color` property for text.
  */
-export declare class AtomicResultSectionTitle extends AtomicResultSectionTitle_base {
+export declare class AtomicResultSectionTitle {
+    private host;
+    componentDidRender(): void;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'atomic-result-section-title': AtomicResultSectionTitle;
-    }
-}
-export {};

package/dist/types/components/search/result-template-components/atomic-result-sections/atomic-result-section-visual.d.ts

@@ -0,0 +1,20 @@
+import { ItemDisplayImageSize } from '../../../common/layout/display-options';
+/**
+ * This section provides visual information about the item.
+ * For example, in Commerce, an image is a great shorthand for a product category.
+ * An icon can quickly show the item type, or an avatar can help identify to whom it is related.
+ *
+ * Behavior:
+ * * Has a fixed size that depends on the specified image size, the layout, the density, and the screen size.
+ * ** When the image size is set to `icon`, this section stays very small.
+ * ** You should ensure that elements inside of it take the available space.
+ * * Always has a 1:1 aspect ratio.
+ */
+export declare class AtomicResultSectionVisual {
+    private host;
+    /**
+     * How large or small the visual section of results using this template should be.
+     */
+    imageSize?: ItemDisplayImageSize;
+    componentDidRender(): void;
+}