@coveo/atomic 3.28.0-pre.df6c8a3eb3 → 3.28.0-pre.f769419eb8

package/dist/types/components/commerce/atomic-commerce-no-products/atomic-commerce-no-products.d.ts

@@ -1,6 +1,8 @@
+import { InitializableComponent } from "../../../decorators/types";
+import { AriaLiveRegionController } from "../../../utils/accessibility-utils";
 import { SearchSummaryState, ProductListingSummaryState, Summary } from '@coveo/headless/commerce';
-import { InitializableComponent } from '../../../utils/initialization-utils';
-import { CommerceBindings } from '../atomic-commerce-interface/atomic-commerce-interface';
+import { LitElement } from 'lit';
+import { CommerceBindings } from '../atomic-commerce-interface/atomic-commerce-interface.js';
 /**
  * @alpha
  *
@@ -13,12 +15,19 @@ import { CommerceBindings } from '../atomic-commerce-interface/atomic-commerce-i
  *
  * @slot default - Any additional content slotted inside of its element will be displayed as well.
  */
-export declare class AtomicCommerceNoProducts implements InitializableComponent<CommerceBindings> {
+export declare class AtomicCommerceNoProducts extends LitElement implements InitializableComponent<CommerceBindings> {
     bindings: CommerceBindings;
     summary: Summary<ProductListingSummaryState | SearchSummaryState>;
-    private summaryState;
+    summaryState: SearchSummaryState | ProductListingSummaryState;
     error: Error;
-    protected ariaMessage: string;
+    protected ariaMessage: AriaLiveRegionController;
     initialize(): void;
-    render(): any;
+    render(): import("lit-html").TemplateResult<1>;
+    private renderNoItems;
+    private renderSearchTips;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-commerce-no-products': AtomicCommerceNoProducts;
+    }
 }

package/dist/types/components/commerce/atomic-commerce-recommendation-interface/atomic-commerce-recommendation-interface.d.ts

@@ -1,21 +1,26 @@
-import { CommerceEngine, CommerceEngineConfiguration } from '@coveo/headless/commerce';
+import { CommerceEngine, CommerceEngineConfiguration, Context } from '@coveo/headless/commerce';
+import type { CurrencyCodeISO4217 } from '@coveo/relay-event-types';
 import { i18n } from 'i18next';
-import { InitializeEvent } from '../../../utils/initialization-utils';
-import { AdoptedStylesBindings, CommonBindings } from '../../common/interface/bindings';
-import { StencilBaseAtomicInterface } from '../../common/interface/interface-common-stencil';
-import { AtomicCommerceInterface } from '../atomic-commerce-interface/atomic-commerce-interface';
-import { CommerceRecommendationStore } from './store';
+import { CSSResultGroup, LitElement } from 'lit';
+import { AdoptedStylesBindings, CommonBindings } from '../../common/interface/bindings.js';
+import { BaseAtomicInterface } from '../../common/interface/interface-common.js';
+import { CommerceRecommendationStore } from './store.js';
 export type CommerceInitializationOptions = CommerceEngineConfiguration;
-export type CommerceBindings = CommonBindings<CommerceEngine, CommerceRecommendationStore, AtomicCommerceInterface> & AdoptedStylesBindings;
+export type CommerceBindings = CommonBindings<CommerceEngine, CommerceRecommendationStore, AtomicCommerceRecommendationInterface> & AdoptedStylesBindings;
+declare const AtomicCommerceRecommendationInterface_base: typeof LitElement;
 /**
- * @alpha
- * The `atomic-commerce-recommendation-interface` component is meant to be used as the parent of one or more `atomic-commerce-recommendation-list` components. It handles the headless search engine and localization configurations.
+ * The `atomic-commerce-recommendation-interface` component is meant to be used
+ * as the parent of one or more `atomic-commerce-recommendation-list`
+ * components. It handles the headless search engine and localization
+ * configurations.
  */
-export declare class AtomicCommerceRecommendationInterface implements StencilBaseAtomicInterface<CommerceEngine> {
-    private store;
-    private commonInterfaceHelper;
-    host: AtomicCommerceInterface;
+export declare class AtomicCommerceRecommendationInterface extends AtomicCommerceRecommendationInterface_base implements BaseAtomicInterface<CommerceEngine> {
+    bindings: CommerceBindings;
     error?: Error;
+    context: Context;
+    store: CommerceRecommendationStore;
+    private commonInterfaceHelper;
+    static styles: CSSResultGroup;
     /**
      * The commerce interface i18next instance.
      */
@@ -23,7 +28,7 @@ export declare class AtomicCommerceRecommendationInterface implements StencilBas
     /**
      * The commerce interface headless engine.
      */
-    engine: CommerceEngine;
+    engine?: CommerceEngine;
     /**
      * The CSS selector for the container the interface will scroll back to.
      */
@@ -42,27 +47,16 @@ export declare class AtomicCommerceRecommendationInterface implements StencilBas
      *
      */
     iconAssetsPath: string;
-    /**
-     * 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;
     /**
      * The commerce interface language.
      *
-     * Will default to the value set in the Headless engine context if not provided.
+     * Will default to the value set in the Headless engine context if not
+     * provided.
+     *
+     * @deprecated - This property will be removed in the next major version of
+     * Atomic (v4). Rather than using this property, set the initial language
+     * through the engine configuration when calling `initializeWithEngine`, and
+     * update the language as needed using the `updateLocale` method.
      */
     language?: string;
     /**
@@ -70,24 +64,48 @@ export declare class AtomicCommerceRecommendationInterface implements StencilBas
      */
     analytics: boolean;
     private i18Initialized;
-    private componentWillLoadCalledPromise;
-    private componentWillLoadResolver;
-    private contextController;
     constructor();
-    componentWillLoad(): void;
-    toggleAnalytics(): void;
-    updateLanguage(): Promise<void> | undefined;
-    updateIconAssetsPath(): void;
-    handleInitialization(event: InitializeEvent): void;
-    scrollToTop(): void;
+    connectedCallback(): void;
     /**
      * Initializes the connection with an already preconfigured [headless commerce engine](https://docs.coveo.com/en/headless/latest/reference/commerce/).
      */
     initializeWithEngine(engine: CommerceEngine): Promise<void>;
-    get bindings(): CommerceBindings;
+    /**
+     * Updates the locale settings for the commerce recommendation interface and
+     * headless commerce engine. Only the provided parameters will be updated.
+     *
+     * Calling this method affects the localization of the interface as well as
+     * the catalog configuration being used by the Commerce API. If the resulting
+     * language-country-currency combination matches no existing catalog
+     * configuration in your Coveo organization, requests made through the
+     * commerce engine will start failing.
+     *
+     * @param language - (Optional) The IETF language code tag (e.g., `en`).
+     * @param country - (Optional) The ISO-3166-1 country tag (e.g., `US`).
+     * @param currency - (Optional) The ISO-4217 currency code (e.g., `USD`).
+     *
+     * @example
+     * ```typescript
+     * recommendationInterface.updateLocale('fr', 'CA', 'CAD');
+     * ```
+     */
+    updateLocale(language?: string, country?: string, currency?: CurrencyCodeISO4217): void;
+    toggleAnalytics(): void;
+    updateIconAssetsPath(): void;
+    updateLanguage(): Promise<void>;
+    disconnectedCallback(): void;
+    render(): import("lit-html").TemplateResult<1>;
+    private handleInitialization;
+    private scrollToTop;
+    private internalInitialization;
+    private initAriaLive;
     private initContext;
+    private getBindings;
     private initLanguage;
-    private initAriaLive;
-    private internalInitialization;
-    render(): any[];
 }
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-commerce-recommendation-interface': AtomicCommerceRecommendationInterface;
+    }
+}
+export {};

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

@@ -1,12 +1,13 @@
-import { InitializableComponent } from '../../../utils/initialization-utils';
+import { InitializableComponent } from "../../../decorators/types";
+import { LitElement } from 'lit';
 import { CommerceBindings } from '../atomic-commerce-interface/atomic-commerce-interface';
+declare const AtomicCommerceText_base: typeof LitElement;
 /**
  * @alpha
  * The `atomic-commerce-text` component leverages the I18n translation module through the atomic-commerce-interface.
  */
-export declare class AtomicCommerceText implements InitializableComponent<CommerceBindings> {
+export declare class AtomicCommerceText extends AtomicCommerceText_base implements InitializableComponent<CommerceBindings> {
     bindings: CommerceBindings;
-    private strings;
     error: Error;
     /**
      * The string key value.
@@ -17,6 +18,13 @@ export declare class AtomicCommerceText implements InitializableComponent<Commer
      * @type {number}
      */
     count?: number;
-    connectedCallback(): void;
-    render(): string;
+    private get strings();
+    initialize(): void;
+    render(): import("lit-html").TemplateResult<1>;
 }
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-commerce-text': AtomicCommerceText;
+    }
+}
+export {};

package/dist/types/components/commerce/atomic-product-template/atomic-product-template.d.ts

@@ -1,9 +1,10 @@
 import { LitElementWithError } from "../../../decorators/types";
 import { ProductTemplate, ProductTemplateCondition } from '@coveo/headless/commerce';
 import { LitElement } from 'lit';
+import '../atomic-commerce-text/atomic-commerce-text';
+import '../atomic-product-text/atomic-product-text';
 import '../atomic-product/atomic-product';
 /**
- * @alpha
  * * A product template determines the format of the query results, depending on the conditions that are defined for each template.
  *
  * A `template` element must be the child of an `atomic-product-template`. Furthermore, an `atomic-commerce-product-list`, `atomic-commerce-recommendation-list`, or `atomic-commerce-search-box-instant-products` must be the parent of each `atomic-product-template`.
@@ -13,6 +14,8 @@ import '../atomic-product/atomic-product';
  * @MapProp name: mustNotMatch;attr: must-not-match;docs: The field and values that must not be matched by a product item for the template to apply. For example, a template with the following attribute only applies to product items whose `filetype` is not `lithiummessage`: `must-not-match-filetype="lithiummessage";type: Record<string, string[]> ;default: {}
  * @slot default - The default slot where to insert the template element.
  * @slot link - A `template` element that contains a single `atomic-product-link` component.
+ *
+ * @alpha
  */
 export declare class AtomicProductTemplate extends LitElement implements LitElementWithError {
     private productTemplateController;

package/dist/types/components/commerce/atomic-product-text/atomic-product-text.d.ts

@@ -1,29 +1,43 @@
-import { InitializableComponent } from '../../../utils/initialization-utils';
+import { InitializableComponent } from "../../../decorators/types";
+import { LitElement } from 'lit';
 import { CommerceBindings } from '../atomic-commerce-interface/atomic-commerce-interface';
+import '../atomic-commerce-text/atomic-commerce-text';
+declare const AtomicProductText_base: typeof LitElement;
 /**
- * @alpha
- * The `atomic-product-text` component renders the value of a string product field.
+ * The `atomic-product-text` component renders the value of a string field for a given product.
  */
-export declare class AtomicProductText implements InitializableComponent<CommerceBindings> {
-    bindings: CommerceBindings;
-    error: Error;
-    private product;
-    private host;
+export declare class AtomicProductText extends AtomicProductText_base implements InitializableComponent<CommerceBindings> {
     /**
-     * The product field which the component should use.
-     * This will look in the Product object first, and then in the product.additionalFields object for the fields.
+     * The string field whose value the component should render.
+     * The component will look for the specified field in the product's properties first, and then in the product's `additionalFields` property.
      */
     field: string;
     /**
-     * When this is set to `true`, the component attempts to highlight text based on the highlighting properties provided by the search API response.
-     * This property only works for the product excerpt and the ec_name field.
+     * Whether to highlight the string field value.
+     *
+     * Only works if the `field` property is set to `excerpt` or `ec_name`.
      */
     shouldHighlight: boolean;
     /**
-     * The locale key for the text to display when the configured field has no value.
+     * The locale key to use for displaying default text when the specified field has no value for the product.
      */
     default?: string;
+    private product;
+    private productController;
+    bindings: CommerceBindings;
+    error: Error;
+    initialize(): void;
     private get shouldRenderHighlights();
-    isFieldSupportedForHighlighting(): boolean;
-    render(): any;
+    private isFieldSupportedForHighlighting;
+    private get highlightKeywords();
+    private renderFallback;
+    private renderProductText;
+    private renderProductTextValue;
+    render(): import("lit-html").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-product-text': AtomicProductText;
+    }
 }
+export {};

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

@@ -2,15 +2,19 @@ export { AtomicCommerceBreadbox } from './atomic-commerce-breadbox/atomic-commer
 export { AtomicCommerceDidYouMean } from './atomic-commerce-did-you-mean/atomic-commerce-did-you-mean.js';
 export { AtomicCommerceInterface } from './atomic-commerce-interface/atomic-commerce-interface.js';
 export { AtomicCommerceLayout } from './atomic-commerce-layout/atomic-commerce-layout.js';
+export { AtomicCommerceNoProducts } from './atomic-commerce-no-products/atomic-commerce-no-products.js';
 export { AtomicCommercePager } from './atomic-commerce-pager/atomic-commerce-pager.js';
 export { AtomicCommerceProductList } from './atomic-commerce-product-list/atomic-commerce-product-list.js';
 export { AtomicCommerceProductsPerPage } from './atomic-commerce-products-per-page/atomic-commerce-products-per-page.js';
 export { AtomicCommerceQuerySummary } from './atomic-commerce-query-summary/atomic-commerce-query-summary.js';
+export { AtomicCommerceRecommendationInterface } from './atomic-commerce-recommendation-interface/atomic-commerce-recommendation-interface.js';
 export { AtomicCommerceRecommendationList } from './atomic-commerce-recommendation-list/atomic-commerce-recommendation-list.js';
 export { AtomicCommerceSearchBox } from './atomic-commerce-search-box/atomic-commerce-search-box.js';
 export { AtomicCommerceSearchBoxInstantProducts } from './atomic-commerce-search-box-instant-products/atomic-commerce-search-box-instant-products.js';
 export { AtomicCommerceSearchBoxQuerySuggestions } from './atomic-commerce-search-box-query-suggestions/atomic-commerce-search-box-query-suggestions.js';
 export { AtomicCommerceSearchBoxRecentQueries } from './atomic-commerce-search-box-recent-queries/atomic-commerce-search-box-recent-queries.js';
 export { AtomicCommerceSortDropdown } from './atomic-commerce-sort-dropdown/atomic-commerce-sort-dropdown.js';
+export { AtomicCommerceText } from './atomic-commerce-text/atomic-commerce-text.js';
 export { AtomicProduct } from './atomic-product/atomic-product.js';
 export { AtomicProductTemplate } from './atomic-product-template/atomic-product-template.js';
+export { AtomicProductText } from './atomic-product-text/atomic-product-text.js';

package/dist/types/components/common/atomic-layout-section/atomic-layout-section.d.ts

@@ -1,8 +1,11 @@
+import { LitElement } from 'lit';
 import { Section } from './sections';
 /**
- * The `atomic-layout-section` lets you identify various sections for the related `atomic-layout` component.
+ * The `atomic-layout-section` lets you identify various sections for the related `atomic-search-layout` or `atomic-commerce-layout` component.
+ *
+ * @slot default - The default slot where you can add child components to the section.
  */
-export declare class AtomicLayoutSection {
+export declare class AtomicLayoutSection extends LitElement {
     /**
      * The name of the layout section.
      */
@@ -17,4 +20,10 @@ export declare class AtomicLayoutSection {
      * E.g. '300px'
      */
     maxWidth?: string;
+    createRenderRoot(): this;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-layout-section': AtomicLayoutSection;
+    }
 }

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

@@ -1,3 +1,4 @@
+import { AtomicLayoutSection } from './atomic-layout-section';
 export type Section = 'search' | 'facets' | 'main' | 'status' | 'results' | 'horizontal-facets' | 'products' | 'pagination';
-export declare function findSection(element: HTMLElement, section: Section): HTMLAtomicLayoutSectionElement | null;
+export declare function findSection(element: HTMLElement, section: Section): AtomicLayoutSection | null;
 export declare function sectionSelector(section: Section): string;

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

@@ -1,2 +1,3 @@
 export { AtomicComponentError } from './atomic-component-error/atomic-component-error.js';
 export { AtomicIcon } from './atomic-icon/atomic-icon.js';
+export { AtomicLayoutSection } from './atomic-layout-section/atomic-layout-section.js';

package/dist/types/components/common/interface/interface-common.d.ts

@@ -26,9 +26,8 @@ export declare class CommonAtomicInterfaceHelper<Engine extends AnyEngineType> {
     onComponentInitializing(event: InitializeEvent): void;
     onInitialization(initEngine: () => void): Promise<void>;
     onAnalyticsChange(): void;
-    onLanguageChange(): void;
+    onLanguageChange(newLanguage?: string): void;
     engineIsCreated(engine?: Engine): engine is Engine;
     private get interfaceTagname();
     private initComponents;
-    private get language();
 }

package/dist/types/components/common/items-per-page/label.d.ts

@@ -1,2 +1,2 @@
-import { FunctionalComponentWithChildren } from "../../../utils/functional-component-utils";
-export declare const renderLabel: FunctionalComponentWithChildren<{}>;
+import { FunctionalComponentWithChildrenNoProps } from "../../../utils/functional-component-utils";
+export declare const renderLabel: FunctionalComponentWithChildrenNoProps;

package/dist/types/components/common/no-items/container.d.ts

@@ -1,2 +1,2 @@
-import { FunctionalComponentWithChildren } from "../../../utils/functional-component-utils";
-export declare const renderNoItemsContainer: FunctionalComponentWithChildren<{}>;
+import { FunctionalComponentWithChildrenNoProps } from "../../../utils/functional-component-utils";
+export declare const renderNoItemsContainer: FunctionalComponentWithChildrenNoProps;

package/dist/types/components/common/no-items/magnifying-glass.d.ts

@@ -1,2 +1,2 @@
-import { FunctionalComponent } from "../../../utils/functional-component-utils";
-export declare const renderMagnifyingGlass: FunctionalComponent;
+import { FunctionalComponentNoProps } from "../../../utils/functional-component-utils";
+export declare const renderMagnifyingGlass: FunctionalComponentNoProps;

package/dist/types/components/insight/atomic-insight-interface/store.d.ts

@@ -1,6 +1,9 @@
 import { DateFacetValue, InsightEngine, NumericFacetValue } from '@coveo/headless/insight';
 import { FacetInfo, FacetStore, FacetType, FacetValueFormat } from '../../common/facets/facet-common-store';
 import { BaseStore, ResultListInfo } from '../../common/interface/store';
+interface FacetInfoMap {
+    [facetId: string]: FacetInfo | (FacetInfo & FacetValueFormat<NumericFacetValue>) | (FacetInfo & FacetValueFormat<DateFacetValue>);
+}
 interface Data {
     loadingFlags: string[];
     iconAssetsPath: string;
@@ -24,6 +27,7 @@ export type InsightStore = BaseStore<Data> & {
     getFacetElements(): HTMLElement[];
     waitUntilAppLoaded(callback: () => void): void;
     getUniqueIDFromEngine(engine: InsightEngine): string;
+    getAllFacets(): FacetInfoMap;
 };
 export declare function createInsightStore(): InsightStore;
 export {};