@coveo/atomic 3.35.0-pre.ebf3345026 → 3.35.0-pre.ed6c0f14c8

package/dist/esm/version.js

@@ -1,2 +1,2 @@
-export const headlessVersion = '3.31.3-pre.ebf3345026';
-export const atomicVersion = '3.35.0-pre.ebf3345026';
+export const headlessVersion = '3.31.3-pre.ed6c0f14c8';
+export const atomicVersion = '3.35.0-pre.ed6c0f14c8';

package/dist/types/components/commerce/atomic-commerce-breadbox/atomic-commerce-breadbox.d.ts

@@ -36,6 +36,7 @@ export declare class AtomicCommerceBreadbox extends LitElement implements Initia
     error: Error;
     private isCollapsed;
     private showMoreText;
+    private breadboxAriaMessage;
     /**
      * This prop allows you to control the display depth
      * of the path by specifying the number of parent or ancestor

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

@@ -139,6 +139,7 @@ export declare class AtomicCommerceSearchBox extends LitElement implements Initi
     private renderSuggestion;
     private renderSlotContent;
     render(): import("lit-html").TemplateResult<1>;
+    private announceClearSearchBoxToScreenReader;
 }
 declare global {
     interface HTMLElementTagNameMap {

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

@@ -27,6 +27,7 @@ export declare class AtomicCommerceSearchBoxRecentQueries extends LitElement imp
      * The maximum number of suggestions to display initially, when the input field is empty.
      */
     maxWithoutQuery?: number;
+    private searchBoxAriaMessage;
     connectedCallback(): void;
     initialize(): SearchBoxSuggestions;
     private retrieveLocalStorage;

package/dist/types/components/common/breadbox/breadcrumb-button.d.ts

@@ -1,4 +1,5 @@
 import type { i18n } from 'i18next';
+import type { AriaLiveRegionController } from "../../../utils/accessibility-utils";
 import type { FunctionalComponentWithChildren } from "../../../utils/functional-component-utils";
 import type { Breadcrumb } from './breadcrumb-types';
 export interface BreadcrumbButtonProps {
@@ -7,5 +8,6 @@ export interface BreadcrumbButtonProps {
     pathLimit: number;
     breadcrumb: Breadcrumb;
     i18n: i18n;
+    ariaController: AriaLiveRegionController;
 }
 export declare const renderBreadcrumbButton: FunctionalComponentWithChildren<BreadcrumbButtonProps>;

package/dist/types/components/common/facets/category-facet/all-categories-button.d.ts

@@ -3,6 +3,8 @@ import type { i18n } from 'i18next';
 import type { FunctionalComponent } from "../../../../utils/functional-component-utils";
 export interface CategoryFacetAllCategoryButtonProps {
     i18n: i18n;
+    facetId?: string;
+    field: string;
     onClick(): void;
 }
 export declare const renderCategoryFacetAllCategoryButton: FunctionalComponent<CategoryFacetAllCategoryButtonProps>;

package/dist/types/components/common/facets/category-facet/all-categories-localized-label.d.ts

@@ -0,0 +1,6 @@
+import type { i18n } from 'i18next';
+export declare const getAllCategoriesLocalizedLabel: ({ facetId, field, i18n, }: {
+    facetId?: string;
+    field: string;
+    i18n: i18n;
+}) => string;

package/dist/types/components/common/facets/category-facet/search-value.d.ts

@@ -9,6 +9,7 @@ interface CategoryFacetSearchValueProps {
     };
     i18n: i18n;
     field: string;
+    facetId?: string;
     onClick(): void;
     searchQuery: string;
 }

package/dist/types/components/common/facets/category-facet/stencil-all-categories-button.d.ts

@@ -3,6 +3,8 @@ import { i18n } from 'i18next';
 interface CategoryFacetAllCategoryButtonProps {
     i18n: i18n;
     onClick(): void;
+    facetId?: string;
+    field: string;
 }
 /**
  * @deprecated should only be used for Stencil components.

package/dist/types/components/common/facets/category-facet/stencil-search-value.d.ts

@@ -8,6 +8,7 @@ interface CategoryFacetSearchValueProps {
     };
     i18n: i18n;
     field: string;
+    facetId?: string;
     onClick(): void;
     searchQuery: string;
 }

package/dist/types/components/common/layout/item-layout-sections.d.ts

@@ -1,4 +1,4 @@
-declare const allTags: Set<"atomic-product-section-actions" | "atomic-product-section-badges" | "atomic-product-section-bottom-metadata" | "atomic-product-section-children" | "atomic-product-section-description" | "atomic-product-section-emphasized" | "atomic-product-section-metadata" | "atomic-product-section-name" | "atomic-product-section-visual" | "atomic-result-section-actions" | "atomic-result-section-badges" | "atomic-result-section-bottom-metadata" | "atomic-result-section-children" | "atomic-result-section-emphasized" | "atomic-result-section-excerpt" | "atomic-result-section-title" | "atomic-result-section-title-metadata" | "atomic-result-section-visual">;
+declare const allTags: Set<"atomic-result-section-actions" | "atomic-result-section-badges" | "atomic-result-section-bottom-metadata" | "atomic-result-section-children" | "atomic-result-section-emphasized" | "atomic-result-section-excerpt" | "atomic-result-section-title" | "atomic-result-section-title-metadata" | "atomic-result-section-visual" | "atomic-product-section-actions" | "atomic-product-section-badges" | "atomic-product-section-bottom-metadata" | "atomic-product-section-children" | "atomic-product-section-description" | "atomic-product-section-emphasized" | "atomic-product-section-metadata" | "atomic-product-section-name" | "atomic-product-section-visual">;
 type SetValueType<T> = T extends Set<infer U> ? U : never;
 export type ItemSectionTagName = SetValueType<typeof allTags>;
 export declare function isResultSectionNode(element: Node): boolean;

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

@@ -1,21 +1,17 @@
-import type { FoldedResult, InteractiveResult, Result } from '@coveo/headless';
-import { type CSSResultGroup, LitElement } from 'lit';
-import type { DisplayConfig } from "../../common/item-list/context/item-display-config-context-controller";
-import { type ItemRenderingFunction } from "../../common/item-list/item-list-common";
-import type { ItemDisplayDensity, ItemDisplayImageSize, ItemDisplayLayout } from "../../common/layout/display-options";
-import type { SearchStore } from "../atomic-search-interface/store";
-import type { InteractiveResultContextEvent, ResultContextEvent } from "../result-template-component-utils/context/result-context-controller";
-declare const AtomicResult_base: typeof LitElement;
+import { FoldedResult, InteractiveResult, Result } from '@coveo/headless';
+import { DisplayConfig } from '../../common/item-list/stencil-item-decorators';
+import { ItemRenderingFunction } from '../../common/item-list/stencil-item-list-common';
+import { ItemDisplayDensity, ItemDisplayImageSize, ItemDisplayLayout } from '../../common/layout/display-options';
+import { SearchStore } from '../atomic-search-interface/store';
+import { InteractiveResultContextEvent, ResultContextEvent } from "../result-template-component-utils/context/stencil-result-template-decorators";
 /**
- * The `atomic-result` component is used internally by the `atomic-result-list` and `atomic-folded-result-list` components.
+ * The `atomic-result` component is used internally by the `atomic-result-list` component.
  */
-export declare class AtomicResult extends AtomicResult_base {
-    private resultRootRef?;
-    private linkContainerRef?;
-    private itemLayoutController;
-    static styles: CSSResultGroup;
+export declare class AtomicResult {
+    private layout;
+    host: HTMLElement;
     /**
-     * Whether `atomic-result-link` components nested in the `atomic-result` should stop click event propagation.
+     * Whether an atomic-result-link inside atomic-result should stop click event propagation.
      */
     stopPropagation?: boolean;
     /**
@@ -24,10 +20,12 @@ export declare class AtomicResult extends AtomicResult_base {
     result: Result | FoldedResult;
     /**
      * The InteractiveResult item.
+     * @internal
      */
     interactiveResult: InteractiveResult;
     /**
      * Global Atomic state.
+     * @internal
      */
     store?: SearchStore;
     /**
@@ -59,37 +57,30 @@ export declare class AtomicResult extends AtomicResult_base {
      */
     classes: string;
     /**
-     * A unique identifier for tracking the loading state of this result component.
-     * When set, this flag is added to the global loading flags array and automatically
-     * removed when the component finishes its initial render. This allows the framework
-     * to determine when all components have finished loading.
-     *
      * @internal
      */
     loadingFlag?: string;
     /**
-     * Internal function used in advanced setups, which lets you bypass the standard HTML template system.
-     * Particularly useful for Atomic React.
+     * Internal function used by atomic-recs-list in advanced setups, which lets you bypass the standard HTML template system.
+     * Particularly useful for Atomic React
      *
      * @internal
      */
     renderingFunction: ItemRenderingFunction;
-    resolveResult: (event: ResultContextEvent) => void;
-    resolveInteractiveResult: (event: InteractiveResultContextEvent) => void;
-    resolveStopPropagation: (event: CustomEvent) => void;
-    resolveResultDisplayConfig: (event: ResultContextEvent<DisplayConfig>) => void;
-    handleClick: (event: MouseEvent) => void;
-    clickLinkContainer: () => void;
-    connectedCallback(): Promise<void>;
-    disconnectedCallback(): void;
+    private resultRootRef?;
+    private linkContainerRef?;
+    private executedRenderingFunctionOnce;
+    resolveResult(event: ResultContextEvent<FoldedResult | Result>): void;
+    resolveInteractiveResult(event: InteractiveResultContextEvent): void;
+    resolveStopPropagation(event: CustomEvent): void;
+    resolveResultDisplayConfig(event: ResultContextEvent<DisplayConfig>): void;
+    handleClick(event: MouseEvent): void;
+    connectedCallback(): void;
+    private get isCustomRenderFunctionMode();
     private getContentHTML;
     private getLinkHTML;
-    render(): import("lit-html").TemplateResult<1>;
-    firstUpdated(_changedProperties: Map<string, unknown>): void;
-}
-declare global {
-    interface HTMLElementTagNameMap {
-        'atomic-result': AtomicResult;
-    }
+    private shouldExecuteRenderFunction;
+    render(): any;
+    componentDidLoad(): void;
+    componentDidRender(): void;
 }
-export {};

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

@@ -160,6 +160,7 @@ export declare class AtomicSearchBox implements InitializableComponent<Bindings>
     private isSearchDisabledForEndUser;
     private getSearchInputLabel;
     private announceNewActiveSuggestionToScreenReader;
+    private announceClearSearchBoxToScreenReader;
     private announceNewSuggestionsToScreenReader;
     private renderSlotContent;
     render(): any;

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

@@ -6,7 +6,6 @@ import { type BaseAtomicInterface } from "../../common/interface/interface-contr
 import "../atomic-relevance-inspector/atomic-relevance-inspector";
 import { type SearchStore } from './store';
 import "../../common/atomic-modal/atomic-modal";
-import '../atomic-result/atomic-result';
 export type InitializationOptions = SearchEngineConfiguration;
 export type Bindings = CommonBindings<SearchEngine, SearchStore, AtomicSearchInterface> & NonceBindings;
 declare const AtomicSearchInterface_base: typeof LitElement;

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

@@ -1,16 +1,6 @@
 export { AtomicPager } from './atomic-pager/atomic-pager.js';
 export { AtomicQuerySummary } from './atomic-query-summary/atomic-query-summary.js';
 export { AtomicRelevanceInspector } from './atomic-relevance-inspector/atomic-relevance-inspector.js';
-export { AtomicResult } from './atomic-result/atomic-result.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 { AtomicResultsPerPage } from './atomic-results-per-page/atomic-results-per-page.js';
 export { AtomicSearchBoxInstantResults } from './atomic-search-box-instant-results/atomic-search-box-instant-results.js';
 export { AtomicSearchBoxQuerySuggestions } from './atomic-search-box-query-suggestions/atomic-search-box-query-suggestions.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;
+}