@coveo/atomic 3.33.8-pre.9cacc0cb9c → 3.33.8-pre.9f7e197648

package/dist/atomic/components/components/commerce/atomic-commerce-interface/atomic-commerce-interface.js

@@ -4,7 +4,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-import { buildCommerceEngine, buildContext, buildProductListing, buildSearch, VERSION as HEADLESS_VERSION, loadConfigurationActions, loadQueryActions, } from '@coveo/headless/commerce';
+import { buildCommerceEngine, buildContext, buildProductListing, buildSearch, VERSION as HEADLESS_VERSION, loadConfigurationActions, loadContextActions, loadQueryActions, } from '@coveo/headless/commerce';
 import { provide } from '@lit/context';
 import i18next from 'i18next';
 import { css, html, LitElement } from 'lit';
@@ -144,6 +144,41 @@ let AtomicCommerceInterface = class AtomicCommerceInterface extends ChildrenUpda
             this.searchOrListing.executeFirstRequest();
         }
     }
+    /**
+     * Updates the locale settings for the commerce 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
+     * interface.updateLocale('fr', 'CA', 'CAD');
+     * ```
+     */
+    updateLocale(language, country, currency) {
+        if (!this.interfaceController.engineIsCreated(this.engine) ||
+            !this.context) {
+            return;
+        }
+        language && this.interfaceController.onLanguageChange(language);
+        if (this.isNewLocale(language, country, currency)) {
+            const { setContext } = loadContextActions(this.engine);
+            this.engine.dispatch(setContext({
+                ...this.context.state,
+                ...(language && { language }),
+                ...(country && { country }),
+                ...(currency && { currency }),
+            }));
+        }
+    }
     toggleAnalytics() {
         this.interfaceController.onAnalyticsChange();
     }
@@ -157,11 +192,10 @@ let AtomicCommerceInterface = class AtomicCommerceInterface extends ChildrenUpda
             !this.context) {
             return;
         }
-        // TODO - KIT-4993: Add temporary deprecation warning.
+        this.engine.logger.warn('The `language` 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 `initialize` or `initializeWithEngine`, and update the language as needed using the `updateLocale` method.');
         this.context.setLanguage(this.language);
         return this.interfaceController.onLanguageChange();
     }
-    // TODO - KIT-4993: Add updateLocale public method.
     disconnectedCallback() {
         super.disconnectedCallback();
         if (typeof this.unsubscribeUrlManager === 'function') {
@@ -211,11 +245,11 @@ let AtomicCommerceInterface = class AtomicCommerceInterface extends ChildrenUpda
             throw error;
         }
     }
-    // TODO - KIT-4993: Adjust.
     initLanguage() {
-        if (!this.language) {
-            this.language = this.context.state.language;
+        if (!this.context || this.language) {
+            return;
         }
+        this.interfaceController.onLanguageChange(this.context.state.language);
     }
     initRequestStatus() {
         this.searchOrListing =
@@ -257,7 +291,7 @@ let AtomicCommerceInterface = class AtomicCommerceInterface extends ChildrenUpda
             this.i18Initialized,
         ]);
         this.initContext();
-        this.updateLanguage();
+        this.updateLanguage(); // TODO - (v4) KIT-4365: Remove.
         this.bindings = this.getBindings();
         markParentAsReady(this);
         this.initRequestStatus();
@@ -267,6 +301,14 @@ let AtomicCommerceInterface = class AtomicCommerceInterface extends ChildrenUpda
         this.initUrlManager();
         this.initialized = true;
     }
+    isNewLocale(language, country, currency) {
+        if (!this.context) {
+            return false;
+        }
+        return ((language && language !== this.context.state.language) ||
+            (country && country !== this.context.state.country) ||
+            (currency && currency !== this.context.state.currency));
+    }
     // TODO - (v4) KIT-4991: Make private.
     scrollToTop() {
         const scrollContainerElement = document.querySelector(this.scrollContainer);

package/dist/atomic/components/components/commerce/atomic-commerce-query-summary/atomic-commerce-query-summary.js

@@ -37,7 +37,7 @@ let AtomicCommerceQuerySummary = class AtomicCommerceQuerySummary extends LitEle
         this.listingOrSearchSummary = controller.summary();
     }
     render() {
-        const { firstProduct, firstRequestExecuted, lastProduct, totalNumberOfProducts, hasProducts, hasError, } = this.listingOrSearchSummaryState;
+        const { firstProduct, firstRequestExecuted, lastProduct, totalNumberOfProducts, hasProducts, hasError, isLoading, } = this.listingOrSearchSummaryState;
         const { i18nKey, highlights, ariaLiveMessage } = getProductQuerySummaryI18nParameters({
             first: firstProduct,
             last: lastProduct,
@@ -46,7 +46,7 @@ let AtomicCommerceQuerySummary = class AtomicCommerceQuerySummary extends LitEle
                 : '',
             total: totalNumberOfProducts,
             i18n: this.bindings.i18n,
-            isLoading: false,
+            isLoading,
         });
         this.ariaMessage.message = ariaLiveMessage;
         return html `${renderQuerySummaryGuard({

package/dist/atomic/components/components/commerce/atomic-commerce-recommendation-interface/atomic-commerce-recommendation-interface.js

@@ -50,6 +50,9 @@ let AtomicCommerceRecommendationInterface = class AtomicCommerceRecommendationIn
          *
          */
         this.iconAssetsPath = './assets';
+        // TODO - KIT-4994: Add disableAnalytics property that defaults to false.
+        // TODO - KIT-4994: Deprecate in favor of disableAnalytics property.
+        // TODO - (v4) KIT-4990: Remove.
         /**
          * Whether to enable analytics.
          */
@@ -104,13 +107,15 @@ let AtomicCommerceRecommendationInterface = class AtomicCommerceRecommendationIn
             return;
         }
         language && this.interfaceController.onLanguageChange(language);
-        const { setContext } = loadContextActions(this.engine);
-        this.engine.dispatch(setContext({
-            ...this.context.state,
-            ...(language && { language }),
-            ...(country && { country }),
-            ...(currency && { currency }),
-        }));
+        if (this.isNewLocale(language, country, currency)) {
+            const { setContext } = loadContextActions(this.engine);
+            this.engine.dispatch(setContext({
+                ...this.context.state,
+                ...(language && { language }),
+                ...(country && { country }),
+                ...(currency && { currency }),
+            }));
+        }
     }
     toggleAnalytics() {
         this.interfaceController.onAnalyticsChange();
@@ -118,6 +123,7 @@ let AtomicCommerceRecommendationInterface = class AtomicCommerceRecommendationIn
     updateIconAssetsPath() {
         this.store.state.iconAssetsPath = this.iconAssetsPath;
     }
+    // TODO - (v4) KIT-4365: Remove.
     async updateLanguage() {
         if (!this.interfaceController.engineIsCreated(this.engine) ||
             !this.language ||
@@ -150,7 +156,7 @@ let AtomicCommerceRecommendationInterface = class AtomicCommerceRecommendationIn
             this.i18Initialized,
         ]);
         this.initContext();
-        this.language && this.updateLanguage();
+        this.updateLanguage();
         this.bindings = this.getBindings();
         markParentAsReady(this);
         this.initLanguage();
@@ -167,9 +173,18 @@ let AtomicCommerceRecommendationInterface = class AtomicCommerceRecommendationIn
         };
     }
     initLanguage() {
-        if (!this.language) {
-            this.interfaceController.onLanguageChange(this.context.state.language);
+        if (!this.context || this.language) {
+            return;
+        }
+        this.interfaceController.onLanguageChange(this.context.state.language);
+    }
+    isNewLocale(language, country, currency) {
+        if (!this.context) {
+            return false;
         }
+        return ((language && language !== this.context.state.language) ||
+            (country && country !== this.context.state.country) ||
+            (currency && currency !== this.context.state.currency));
     }
 };
 AtomicCommerceRecommendationInterface.styles = [

package/dist/atomic/components/components/commerce/atomic-commerce-search-box/atomic-commerce-search-box.js

@@ -20,6 +20,7 @@ import { AriaLiveRegionController } from "../../../utils/accessibility-utils";
 import { hasKeyboard, isMacOS } from "../../../utils/device-utils";
 import { SafeStorage, StorageItems, } from "../../../utils/local-storage-utils";
 import { updateBreakpoints } from "../../../utils/replace-breakpoint-utils";
+import { getDefaultSlotFromHost } from "../../../utils/slot-utils";
 import { isFocusingOut, once, randomID, spreadProperties, } from '../../../utils/utils';
 import { renderSearchBoxWrapper } from '../../common/search-box/search-box-wrapper';
 import { renderSearchBoxTextArea } from '../../common/search-box/search-text-area';
@@ -123,9 +124,6 @@ let AtomicCommerceSearchBox = class AtomicCommerceSearchBox extends LitElement {
     }
     connectedCallback() {
         super.connectedCallback();
-        if (this.children.length === 0) {
-            this.replaceChildren(document.createElement('atomic-commerce-search-box-recent-queries'), document.createElement('atomic-commerce-search-box-query-suggestions'));
-        }
         this.addEventListener('atomic/searchBoxSuggestion/register', (event) => {
             const customEvent = event;
             this.searchBoxSuggestionEventsQueue.push(customEvent);
@@ -492,6 +490,14 @@ let AtomicCommerceSearchBox = class AtomicCommerceSearchBox extends LitElement {
       ></atomic-suggestion-renderer>
     `;
     }
+    renderSlotContent() {
+        const hasDefaultSlot = !!getDefaultSlotFromHost(this);
+        if (hasDefaultSlot) {
+            return html `<slot></slot>`;
+        }
+        return html `<atomic-commerce-search-box-recent-queries></atomic-commerce-search-box-recent-queries>
+      <atomic-commerce-search-box-query-suggestions></atomic-commerce-search-box-query-suggestions>`;
+    }
     render() {
         this.updateBreakpoints();
         if (!this.suggestionManager.suggestions.length) {
@@ -511,7 +517,7 @@ let AtomicCommerceSearchBox = class AtomicCommerceSearchBox extends LitElement {
                 },
             },
         })(html `${this.renderTextBox()}
-        ${renderSubmitButton({
+      ${renderSubmitButton({
             props: {
                 i18n: this.bindings.i18n,
                 disabled: this.isSearchDisabledForEndUser,
@@ -521,7 +527,8 @@ let AtomicCommerceSearchBox = class AtomicCommerceSearchBox extends LitElement {
                 },
             },
         })}
-        ${this.renderSuggestions()}`)}
+      ${this.renderSuggestions()}`)}
+      ${this.renderSlotContent()}
     `;
     }
 };

package/dist/atomic/components/components/common/atomic-modal/atomic-modal.js

@@ -9,6 +9,7 @@ import { customElement, property, state } from 'lit/decorators.js';
 import { createRef, ref } from 'lit/directives/ref.js';
 import { when } from 'lit/directives/when.js';
 import { booleanConverter } from "../../../converters/boolean-converter.js";
+import { bindings } from "../../../decorators/bindings.js";
 import { errorGuard } from "../../../decorators/error-guard";
 import { watch } from "../../../decorators/watch.js";
 import { withTailwindStyles } from "../../../decorators/with-tailwind-styles.js";
@@ -296,6 +297,7 @@ __decorate([
 ], AtomicModal.prototype, "watchToggleOpen", null);
 AtomicModal = __decorate([
     customElement('atomic-modal'),
+    bindings(),
     withTailwindStyles
 ], AtomicModal);
 export { AtomicModal };

package/dist/atomic/components/components/search/atomic-search-box-query-suggestions/atomic-search-box-query-suggestions.js

@@ -0,0 +1,107 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { loadQuerySuggestActions, } from '@coveo/headless';
+import { html, LitElement, nothing } from 'lit';
+import { customElement, property, state } from 'lit/decorators.js';
+import { getPartialSearchBoxSuggestionElement, renderQuerySuggestion, } from "../../common/suggestions/query-suggestions";
+import { dispatchSearchBoxSuggestionsEvent } from "../../common/suggestions/suggestions-events";
+import { errorGuard } from "../../../decorators/error-guard";
+const SearchIcon = "<svg viewBox=\"0 0 16 16\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"m6.4 0c3.5 0 6.4 2.9 6.4 6.4 0 1.4-.4 2.7-1.2 3.7l4 4c.4.4.4 1 .1 1.5l-.1.1c-.2.2-.5.3-.8.3s-.6-.1-.8-.3l-4-4c-1 .7-2.3 1.2-3.7 1.2-3.4-.1-6.3-3-6.3-6.5s2.9-6.4 6.4-6.4zm0 2.1c-2.3 0-4.3 1.9-4.3 4.3s1.9 4.3 4.3 4.3 4.3-1.9 4.3-4.3-1.9-4.3-4.3-4.3z\"/></svg>";
+/**
+ * The `atomic-search-box-query-suggestions` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of query suggestion behavior.
+ */
+let AtomicSearchBoxQuerySuggestions = class AtomicSearchBoxQuerySuggestions extends LitElement {
+    constructor() {
+        super(...arguments);
+        /**
+         * The maximum number of suggestions that will be displayed if the user has typed something into the input field.
+         */
+        this.maxWithQuery = 3;
+    }
+    connectedCallback() {
+        super.connectedCallback();
+        try {
+            dispatchSearchBoxSuggestionsEvent((bindings) => {
+                this.bindings = bindings;
+                return this.initialize();
+            }, this, ['atomic-search-box']);
+        }
+        catch (error) {
+            this.error = error;
+        }
+    }
+    initialize() {
+        const engine = this.bindings.engine;
+        const { registerQuerySuggest, fetchQuerySuggestions } = loadQuerySuggestActions(engine);
+        const numberOfQueries = this.bindings.numberOfQueries;
+        const maxWithQuery = this.maxWithQuery;
+        if (numberOfQueries < maxWithQuery) {
+            const logger = this.bindings.engine.logger;
+            logger.warn(`Query suggestions configuration mismatch: atomic-search-box has number-of-queries="${numberOfQueries}" but atomic-search-box-query-suggestions has max-with-query="${maxWithQuery}". ` +
+                `This may cause inconsistent behavior where the search box requests ${numberOfQueries} suggestions but the component tries to display up to ${maxWithQuery}. ` +
+                `Consider updating max-with-query to ${numberOfQueries} or increasing number-of-queries to ${maxWithQuery}.`);
+        }
+        engine.dispatch(registerQuerySuggest({
+            id: this.bindings.id,
+            count: this.bindings.numberOfQueries,
+        }));
+        return {
+            position: Array.from(this.parentNode.children).indexOf(this),
+            onInput: () => engine.dispatch(fetchQuerySuggestions({
+                id: this.bindings.id,
+            })),
+            renderItems: () => this.renderItems(),
+        };
+    }
+    renderItems() {
+        const hasQuery = this.bindings.searchBoxController.state.value !== '';
+        const max = hasQuery ? this.maxWithQuery : this.maxWithoutQuery;
+        return this.bindings.searchBoxController.state.suggestions
+            .slice(0, max)
+            .map((suggestion) => this.renderItem(suggestion));
+    }
+    renderItem(suggestion) {
+        const partialItem = getPartialSearchBoxSuggestionElement(suggestion, this.bindings.i18n);
+        const icon = this.icon ? this.icon : SearchIcon;
+        const hasQuery = this.bindings.searchBoxController.state.value !== '';
+        const hasMultipleKindOfSuggestions = this.bindings.getSuggestions().length > 1;
+        return {
+            ...partialItem,
+            content: renderQuerySuggestion({
+                icon,
+                hasQuery,
+                suggestion,
+                hasMultipleKindOfSuggestions,
+            }),
+            onSelect: () => {
+                this.bindings.searchBoxController.selectSuggestion(suggestion.rawValue);
+            },
+        };
+    }
+    render() {
+        return html `${nothing}`;
+    }
+};
+__decorate([
+    state()
+], AtomicSearchBoxQuerySuggestions.prototype, "error", void 0);
+__decorate([
+    property()
+], AtomicSearchBoxQuerySuggestions.prototype, "icon", void 0);
+__decorate([
+    property({ type: Number, attribute: 'max-with-query', reflect: true })
+], AtomicSearchBoxQuerySuggestions.prototype, "maxWithQuery", void 0);
+__decorate([
+    property({ type: Number, attribute: 'max-without-query', reflect: true })
+], AtomicSearchBoxQuerySuggestions.prototype, "maxWithoutQuery", void 0);
+__decorate([
+    errorGuard()
+], AtomicSearchBoxQuerySuggestions.prototype, "render", null);
+AtomicSearchBoxQuerySuggestions = __decorate([
+    customElement('atomic-search-box-query-suggestions')
+], AtomicSearchBoxQuerySuggestions);
+export { AtomicSearchBoxQuerySuggestions };

package/dist/atomic/components/components/search/index.js

@@ -1,5 +1,5 @@
 // Auto-generated file
 export { AtomicQuerySummary } from './atomic-query-summary/atomic-query-summary.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 { AtomicSearchBoxQuerySuggestions } from './atomic-search-box-query-suggestions/atomic-search-box-query-suggestions.js';
 export { AtomicSearchLayout } from './atomic-search-layout/atomic-search-layout.js';

package/dist/atomic/components/components/search/lazy-index.js

@@ -2,6 +2,6 @@
 export default {
     'atomic-query-summary': async () => await import('./atomic-query-summary/atomic-query-summary.js'),
     'atomic-results-per-page': async () => await import('./atomic-results-per-page/atomic-results-per-page.js'),
-    'atomic-search-box-recent-queries': async () => await import('./atomic-search-box-recent-queries/atomic-search-box-recent-queries.js'),
+    'atomic-search-box-query-suggestions': async () => await import('./atomic-search-box-query-suggestions/atomic-search-box-query-suggestions.js'),
     'atomic-search-layout': async () => await import('./atomic-search-layout/atomic-search-layout.js'),
 };

package/dist/atomic/components/global/environment.js

@@ -3,7 +3,7 @@ function getWindow() {
 }
 export function getAtomicEnvironment(headlessVersion) {
     return {
-        version: "3.33.8-pre.9cacc0cb9c",
+        version: "3.33.8-pre.9f7e197648",
         headlessVersion,
     };
 }