@coveo/atomic 3.31.0 → 3.31.1-pre.4862ba88ca

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

@@ -9,12 +9,14 @@ import { provide } from '@lit/context';
 import i18next from 'i18next';
 import { html, LitElement, unsafeCSS } from 'lit';
 import { customElement, property, state } from 'lit/decorators.js';
+import { booleanConverter } from "../../../converters/boolean-converter";
+import { errorGuard } from "../../../decorators/error-guard";
 import { watch } from "../../../decorators/watch";
 import { withTailwindStyles } from "../../../decorators/with-tailwind-styles.js";
 import { markParentAsReady } from "../../../utils/init-queue";
 import { SafeStorage, StorageItems, } from "../../../utils/local-storage-utils";
 import { ChildrenUpdateCompleteMixin } from '../../../mixins/children-update-complete-mixin';
-import { CommonAtomicInterfaceHelper, } from '../../common/interface/interface-common';
+import { InterfaceController, } from '../../common/interface/interface-controller';
 import { bindingsContext } from '../../context/bindings-context';
 import { createCommerceStore, } from '../atomic-commerce-interface/store';
 import { errorSelector, firstSearchExecutedSelector, noProductsSelector, } from '../atomic-commerce-layout/commerce-layout';
@@ -34,6 +36,7 @@ let AtomicCommerceInterface = class AtomicCommerceInterface extends ChildrenUpda
     constructor() {
         super();
         this.initialized = false;
+        this.interfaceController = new InterfaceController(this, 'CoveoAtomic');
         /**
          * The type of the interface.
          * - 'search': Indicates that the interface is used for Search.
@@ -67,13 +70,12 @@ let AtomicCommerceInterface = class AtomicCommerceInterface extends ChildrenUpda
          */
         this.iconAssetsPath = './assets';
         this.handleInitialization = (event) => {
-            this.commonInterfaceHelper.onComponentInitializing(event);
+            this.interfaceController.onComponentInitializing(event);
         };
         this.bindings = {};
         this.onHashChange = () => {
             this.urlManager.synchronize(this.fragment);
         };
-        this.commonInterfaceHelper = new CommonAtomicInterfaceHelper(this, 'CoveoAtomic');
         this.store = createCommerceStore(this.type);
         const { promise, resolve } = Promise.withResolvers();
         this.i18Initialized = promise;
@@ -87,16 +89,16 @@ let AtomicCommerceInterface = class AtomicCommerceInterface extends ChildrenUpda
         this.addEventListener('atomic/scrollToTop', this.scrollToTop);
     }
     toggleAnalytics() {
-        this.commonInterfaceHelper.onAnalyticsChange();
+        this.interfaceController.onAnalyticsChange();
     }
     updateLanguage() {
-        if (!this.commonInterfaceHelper.engineIsCreated(this.engine) ||
+        if (!this.interfaceController.engineIsCreated(this.engine) ||
             !this.language ||
             !this.context) {
             return;
         }
         this.context.setLanguage(this.language);
-        return this.commonInterfaceHelper.onLanguageChange();
+        return this.interfaceController.onLanguageChange();
     }
     updateIconAssetsPath() {
         this.store.state.iconAssetsPath = this.iconAssetsPath;
@@ -114,10 +116,6 @@ let AtomicCommerceInterface = class AtomicCommerceInterface extends ChildrenUpda
         window.removeEventListener('hashchange', this.onHashChange);
         this.removeEventListener('atomic/initializeComponent', this.handleInitialization);
         this.removeEventListener('atomic/scrollToTop', this.scrollToTop);
-        const ariaLive = this.querySelector('atomic-aria-live');
-        if (ariaLive) {
-            ariaLive.remove();
-        }
     }
     updateMobileBreakpoint() {
         const breakpoint = this.querySelector('atomic-commerce-layout')?.mobileBreakpoint;
@@ -153,7 +151,7 @@ let AtomicCommerceInterface = class AtomicCommerceInterface extends ChildrenUpda
      * Executes the first request after initializing connection to the headless commerce engine.
      */
     async executeFirstRequest() {
-        if (!this.commonInterfaceHelper.engineIsCreated(this.engine)) {
+        if (!this.interfaceController.engineIsCreated(this.engine)) {
             return;
         }
         if (!this.initialized) {
@@ -178,10 +176,9 @@ let AtomicCommerceInterface = class AtomicCommerceInterface extends ChildrenUpda
     }
     async internalInitialization(initEngine) {
         await Promise.all([
-            this.commonInterfaceHelper.onInitialization(initEngine),
+            this.interfaceController.onInitialization(initEngine),
             this.i18Initialized,
         ]);
-        this.initAriaLive();
         this.initContext();
         this.updateLanguage();
         this.bindings = this.getBindings();
@@ -222,13 +219,6 @@ let AtomicCommerceInterface = class AtomicCommerceInterface extends ChildrenUpda
     get fragment() {
         return window.location.hash.slice(1);
     }
-    initAriaLive() {
-        if (Array.from(this.children).some((element) => element.tagName === 'ATOMIC-ARIA-LIVE')) {
-            return;
-        }
-        const ariaLive = document.createElement('atomic-aria-live');
-        this.prepend(ariaLive);
-    }
     initUrlManager() {
         if (!this.reflectStateInUrl) {
             return;
@@ -292,9 +282,7 @@ __decorate([
 __decorate([
     property({
         type: Boolean,
-        converter: {
-            fromAttribute: (value) => value !== 'false',
-        },
+        converter: booleanConverter,
         reflect: true,
     })
 ], AtomicCommerceInterface.prototype, "analytics", void 0);
@@ -315,9 +303,7 @@ __decorate([
         type: Boolean,
         attribute: 'reflect-state-in-url',
         reflect: true,
-        converter: {
-            fromAttribute: (value) => value !== 'false',
-        },
+        converter: booleanConverter,
     })
 ], AtomicCommerceInterface.prototype, "reflectStateInUrl", void 0);
 __decorate([
@@ -342,6 +328,9 @@ __decorate([
     state(),
     provide({ context: bindingsContext })
 ], AtomicCommerceInterface.prototype, "bindings", void 0);
+__decorate([
+    errorGuard()
+], AtomicCommerceInterface.prototype, "render", null);
 AtomicCommerceInterface = __decorate([
     customElement('atomic-commerce-interface'),
     withTailwindStyles

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

@@ -9,11 +9,13 @@ import { provide } from '@lit/context';
 import i18next from 'i18next';
 import { html, LitElement, unsafeCSS } from 'lit';
 import { customElement, property, state } from 'lit/decorators.js';
+import { booleanConverter } from "../../../converters/boolean-converter.js";
+import { errorGuard } from "../../../decorators/error-guard.js";
 import { watch } from "../../../decorators/watch";
 import { withTailwindStyles } from "../../../decorators/with-tailwind-styles.js";
 import { ChildrenUpdateCompleteMixin } from "../../../mixins/children-update-complete-mixin.js";
 import { markParentAsReady } from "../../../utils/init-queue";
-import { CommonAtomicInterfaceHelper, } from '../../common/interface/interface-common.js';
+import { InterfaceController, } from '../../common/interface/interface-controller.js';
 import { bindingsContext } from '../../context/bindings-context.js';
 import styles from './atomic-commerce-recommendation-interface.tw.css';
 import { createCommerceRecommendationStore, } from './store.js';
@@ -27,6 +29,7 @@ let AtomicCommerceRecommendationInterface = class AtomicCommerceRecommendationIn
     constructor() {
         super();
         this.bindings = {};
+        this.interfaceController = new InterfaceController(this, 'CoveoAtomic');
         /**
          * The CSS selector for the container the interface will scroll back to.
          */
@@ -50,9 +53,8 @@ let AtomicCommerceRecommendationInterface = class AtomicCommerceRecommendationIn
          */
         this.analytics = true;
         this.handleInitialization = (event) => {
-            this.commonInterfaceHelper.onComponentInitializing(event);
+            this.interfaceController.onComponentInitializing(event);
         };
-        this.commonInterfaceHelper = new CommonAtomicInterfaceHelper(this, 'CoveoAtomic');
         this.store = createCommerceRecommendationStore();
         const { promise, resolve } = Promise.withResolvers();
         this.i18Initialized = promise;
@@ -91,11 +93,11 @@ let AtomicCommerceRecommendationInterface = class AtomicCommerceRecommendationIn
      * ```
      */
     updateLocale(language, country, currency) {
-        if (!this.commonInterfaceHelper.engineIsCreated(this.engine) ||
+        if (!this.interfaceController.engineIsCreated(this.engine) ||
             !this.context) {
             return;
         }
-        language && this.commonInterfaceHelper.onLanguageChange(language);
+        language && this.interfaceController.onLanguageChange(language);
         const { setContext } = loadContextActions(this.engine);
         this.engine.dispatch(setContext({
             ...this.context.state,
@@ -105,29 +107,25 @@ let AtomicCommerceRecommendationInterface = class AtomicCommerceRecommendationIn
         }));
     }
     toggleAnalytics() {
-        this.commonInterfaceHelper.onAnalyticsChange();
+        this.interfaceController.onAnalyticsChange();
     }
     updateIconAssetsPath() {
         this.store.state.iconAssetsPath = this.iconAssetsPath;
     }
     async updateLanguage() {
-        if (!this.commonInterfaceHelper.engineIsCreated(this.engine) ||
+        if (!this.interfaceController.engineIsCreated(this.engine) ||
             !this.language ||
             !this.context) {
             return;
         }
         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 `initializeWithEngine`, and update the language as needed using the `updateLocale` method.');
         this.context.setLanguage(this.language);
-        return this.commonInterfaceHelper.onLanguageChange();
+        return this.interfaceController.onLanguageChange();
     }
     disconnectedCallback() {
         super.disconnectedCallback();
         this.removeEventListener('atomic/initializeComponent', this.handleInitialization);
         this.removeEventListener('atomic/scrollToTop', this.scrollToTop);
-        const ariaLive = this.querySelector('atomic-aria-live');
-        if (ariaLive) {
-            ariaLive.remove();
-        }
     }
     render() {
         return html `<slot></slot>`;
@@ -142,23 +140,15 @@ let AtomicCommerceRecommendationInterface = class AtomicCommerceRecommendationIn
     }
     async internalInitialization(initEngine) {
         await Promise.all([
-            this.commonInterfaceHelper.onInitialization(initEngine),
+            this.interfaceController.onInitialization(initEngine),
             this.i18Initialized,
         ]);
-        this.initAriaLive();
         this.initContext();
         this.language && this.updateLanguage();
         this.bindings = this.getBindings();
         markParentAsReady(this);
         this.initLanguage();
     }
-    initAriaLive() {
-        if (Array.from(this.children).some((element) => element.tagName === 'ATOMIC-ARIA-LIVE')) {
-            return;
-        }
-        const ariaLive = document.createElement('atomic-aria-live');
-        this.prepend(ariaLive);
-    }
     initContext() {
         this.context = buildContext(this.engine);
     }
@@ -168,21 +158,11 @@ let AtomicCommerceRecommendationInterface = class AtomicCommerceRecommendationIn
             i18n: this.i18n,
             store: this.store,
             interfaceElement: this,
-            addAdoptedStyleSheets: (stylesheet) => {
-                const parent = this.getRootNode();
-                const styleSheet = stylesheet;
-                const isDocumentOrShadowRoot = parent instanceof Document || parent instanceof ShadowRoot;
-                if (styleSheet &&
-                    isDocumentOrShadowRoot &&
-                    !parent.adoptedStyleSheets.includes(styleSheet)) {
-                    parent.adoptedStyleSheets.push(styleSheet);
-                }
-            },
         };
     }
     initLanguage() {
         if (!this.language) {
-            this.commonInterfaceHelper.onLanguageChange(this.context.state.language);
+            this.interfaceController.onLanguageChange(this.context.state.language);
         }
     }
 };
@@ -215,9 +195,7 @@ __decorate([
 __decorate([
     property({
         type: Boolean,
-        converter: {
-            fromAttribute: (value) => value !== 'false',
-        },
+        converter: booleanConverter,
         reflect: true,
     })
 ], AtomicCommerceRecommendationInterface.prototype, "analytics", void 0);
@@ -230,6 +208,9 @@ __decorate([
 __decorate([
     watch('language')
 ], AtomicCommerceRecommendationInterface.prototype, "updateLanguage", null);
+__decorate([
+    errorGuard()
+], AtomicCommerceRecommendationInterface.prototype, "render", null);
 AtomicCommerceRecommendationInterface = __decorate([
     customElement('atomic-commerce-recommendation-interface'),
     withTailwindStyles

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

@@ -27,6 +27,9 @@ import { renderSubmitButton } from '../../common/search-box/submit-button';
 import { SuggestionManager } from '../../common/suggestions/suggestion-manager';
 import { elementHasQuery, } from '../../common/suggestions/suggestions-common';
 import styles from './atomic-commerce-search-box.tw.css';
+import '../atomic-commerce-search-box-instant-products/atomic-commerce-search-box-instant-products';
+import '../atomic-commerce-search-box-query-suggestions/atomic-commerce-search-box-query-suggestions';
+import '../atomic-commerce-search-box-recent-queries/atomic-commerce-search-box-recent-queries';
 /**
  * The `atomic-commerce-search-box` component enables users to perform product searches with built-in query suggestions and optional redirection to a search results page.
  *

package/dist/atomic/components/components/common/interface/interface-controller.js

@@ -0,0 +1,89 @@
+import Backend from 'i18next-http-backend';
+import { setCoveoGlobal } from "../../../global/environment";
+import { loadDayjsLocale } from "../../../utils/dayjs-locales";
+import { i18nBackendOptions, i18nTranslationNamespace, init18n } from './i18n';
+export class InterfaceController {
+    constructor(host, globalVariableName) {
+        this.hangingComponentsInitialization = [];
+        this.host = host;
+        this.host.addController(this);
+        setCoveoGlobal(globalVariableName);
+    }
+    hostConnected() {
+        this.i18nPromise = init18n(this.host);
+        this.initAriaLive();
+    }
+    hostDisconnected() {
+        this.removeAriaLive();
+    }
+    onComponentInitializing(event) {
+        event.preventDefault();
+        event.stopPropagation();
+        if (this.host.engine) {
+            event.detail(this.host.bindings);
+            return;
+        }
+        this.hangingComponentsInitialization.push(event);
+    }
+    async onInitialization(initEngine) {
+        if (this.host.engine) {
+            this.host.engine.logger.warn(`The ${this.interfaceTagname} component "initialize" has already been called.`, this.host);
+            return;
+        }
+        this.host.updateIconAssetsPath();
+        initEngine();
+        if (this.host.registerFieldsToInclude) {
+            this.host.registerFieldsToInclude();
+        }
+        loadDayjsLocale(this.host.language || 'en');
+        await this.i18nPromise;
+        this.initComponents();
+    }
+    onAnalyticsChange() {
+        const { engine, analytics } = this.host;
+        if (!this.engineIsCreated(engine)) {
+            return;
+        }
+        if (!analytics) {
+            engine.disableAnalytics();
+            return;
+        }
+        engine.enableAnalytics();
+    }
+    onLanguageChange(newLanguage) {
+        const language = newLanguage ?? this.host.language;
+        const languageWithFallback = language ?? 'en';
+        const { i18n } = this.host;
+        loadDayjsLocale(languageWithFallback);
+        new Backend(i18n.services, i18nBackendOptions(this.host)).read(languageWithFallback.split('-')[0], i18nTranslationNamespace, (_, data) => {
+            i18n.addResourceBundle(languageWithFallback.split('-')[0], i18nTranslationNamespace, data, true, false);
+            i18n.changeLanguage(language);
+        });
+    }
+    engineIsCreated(engine) {
+        if (!engine) {
+            console.error(`You have to call "initialize" on the ${this.interfaceTagname} component before modifying the props or calling other public methods.`, this.host);
+            return false;
+        }
+        return true;
+    }
+    get interfaceTagname() {
+        return this.host.tagName.toLowerCase();
+    }
+    initComponents() {
+        this.hangingComponentsInitialization.forEach((event) => event.detail(this.host.bindings));
+    }
+    initAriaLive() {
+        if (Array.from(this.host.children).some((element) => element.tagName === 'ATOMIC-ARIA-LIVE')) {
+            return;
+        }
+        const ariaLive = document.createElement('atomic-aria-live');
+        this.host.prepend(ariaLive);
+    }
+    removeAriaLive() {
+        const ariaLive = this.host.querySelector('atomic-aria-live');
+        if (ariaLive) {
+            ariaLive.remove();
+        }
+    }
+}

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

@@ -4,7 +4,7 @@ function getWindow() {
 }
 export function getAtomicEnvironment() {
     return {
-        version: "3.31.0".VERSION,
+        version: "3.31.1-pre.4862ba88ca".VERSION,
         headlessVersion: VERSION,
     };
 }