swell-js 5.9.3 → 5.9.4

package/dist/swell.umd.min.js

@@ -5111,7 +5111,7 @@
     vaultRequest: vaultRequest
   });
 
-  function methods$e(options) {
+  function methods$f(options) {
     return {
       async createToken(data) {
         let error = null;
@@ -5328,7 +5328,7 @@
 
   const RECORD_TIMEOUT = 5000;
 
-  function methods$d(opt) {
+  function methods$e(opt) {
     let VALUES = {
       /*
       [model]: {
@@ -5490,7 +5490,7 @@
     };
   }
 
-  function methods$c(api) {
+  function methods$d(api) {
     const { get, list } = defaultMethods(api, '/attributes', ['list', 'get']);
 
     return {
@@ -5502,7 +5502,7 @@
     };
   }
 
-  function methods$b(api, opt) {
+  function methods$c(api, opt) {
     const { get, list } = defaultMethods(api, '/products', ['list', 'get']);
     return {
       get: (id, ...args) => {
@@ -5711,7 +5711,7 @@
   }
 
   async function getFilterableAttributeFilters(api, products, options) {
-    const { results: filterableAttributes } = await methods$c(api).list({
+    const { results: filterableAttributes } = await methods$d(api).list({
       filterable: true,
     });
 
@@ -5895,7 +5895,7 @@
     };
   }
 
-  function methods$a(api, options) {
+  function methods$b(api, options) {
     return {
       state: null,
       order: null,
@@ -6080,7 +6080,7 @@
     };
   }
 
-  function methods$9(api) {
+  function methods$a(api) {
     return {
       state: null,
 
@@ -6254,7 +6254,7 @@
     }
 
     async updateCart(data) {
-      const cart = await methods$a(this.api, this.options).update(data);
+      const cart = await methods$b(this.api, this.options).update(data);
 
       this.setProps({ cart });
     }
@@ -6490,7 +6490,7 @@
     }
   }
 
-  function methods$8(api) {
+  function methods$9(api) {
     const { get, list } = defaultMethods(api, '/categories', ['list', 'get']);
 
     return {
@@ -6502,7 +6502,7 @@
     };
   }
 
-  function methods$7(api) {
+  function methods$8(api) {
     const { get, list } = defaultMethods(api, '/subscriptions', ['list', 'get']);
     return {
       get: (id, ...args) => {
@@ -6567,7 +6567,7 @@
     };
   }
 
-  function methods$6(api) {
+  function methods$7(api) {
     const { get, list } = defaultMethods(api, '/invoices', ['list', 'get']);
     return {
       get: (id, ...args) => {
@@ -6578,7 +6578,7 @@
     };
   }
 
-  function methods$5(api, opt) {
+  function methods$6(api, opt) {
     return {
       get: (type, id, query) => {
         return api.cache.getFetch(`content_${type}`, id, () =>
@@ -6594,7 +6594,7 @@
     };
   }
 
-  function methods$4(api, opt) {
+  function methods$5(api, opt) {
     return {
       state: null,
       menuState: null,
@@ -6889,7 +6889,7 @@
     }
   }
 
-  function methods$3(api, opt) {
+  function methods$4(api, opt) {
     return {
       /**
        * Get the decoded session as an object of session values
@@ -7277,7 +7277,7 @@
      * @returns {Promise<Cart>}
      */
     async getCart() {
-      const cart = await methods$a(this.api, this.options).get();
+      const cart = await methods$b(this.api, this.options).get();
 
       if (!cart) {
         throw new Error('Cart not found');
@@ -7305,7 +7305,7 @@
         }
       }
 
-      const updatedCart = await methods$a(this.api, this.options).update(
+      const updatedCart = await methods$b(this.api, this.options).update(
         updateData,
       );
 
@@ -7318,7 +7318,7 @@
      * @returns {Promise<object>}
      */
     async getSettings() {
-      return methods$4(this.api, this.options).get();
+      return methods$5(this.api, this.options).get();
     }
 
     /**
@@ -12934,7 +12934,7 @@
     }
 
     async _getPaymentMethods() {
-      const paymentMethods = await methods$4(this.api, this.options).payments();
+      const paymentMethods = await methods$5(this.api, this.options).payments();
 
       if (paymentMethods.error) {
         throw new Error(paymentMethods.error);
@@ -13164,7 +13164,7 @@
     }
   }
 
-  function methods$2(api, opt) {
+  function methods$3(api, opt) {
     return {
       code: null,
       state: null,
@@ -13220,7 +13220,7 @@
     return typeof navigator === 'object' ? navigator.language : 'en-US';
   }
 
-  function methods$1(api, opt) {
+  function methods$2(api, opt) {
     // Reads a store setting without ever returning a Promise. Until settings
     // load, this starts the request and reports `loaded: false`.
     function readSetting(path, def) {
@@ -13441,7 +13441,7 @@
     };
   }
 
-  function methods(api, _opt) {
+  function methods$1(api, _opt) {
     return {
       /**
        * Make a request to an app function and greceiveet a response
@@ -13510,6 +13510,85 @@
     };
   }
 
+  const PURPOSES = ['analytics', 'marketing', 'sale_of_data'];
+
+  /**
+   * The page the shopper landed on, which the consent call sends along: the
+   * first URL of this document and its referrer. Read when needed, so nothing
+   * is kept before the shopper answers.
+   *
+   * @returns {{url: string, referrer: string} | undefined}
+   */
+  function getLanding() {
+    if (isServer()) {
+      return undefined;
+    }
+
+    let url = window.location.href;
+
+    try {
+      const [navigation] = window.performance.getEntriesByType('navigation');
+      if (navigation?.name) {
+        url = navigation.name;
+      }
+    } catch {
+      // Navigation timing is not available
+    }
+
+    return { url, referrer: window.document.referrer || '' };
+  }
+
+  function methods(api) {
+    // Calls run one after another. Consent tools fire several events for one
+    // answer, and the first call may set the visitor cookie that the next one
+    // has to send: in parallel, each would start a visitor of its own.
+    let queue = Promise.resolve();
+
+    return {
+      /**
+       * Records the shopper's consent for attribution, from the storefront's
+       * consent banner. Purposes left out stay as they are.
+       *
+       * Calls the storefront's own origin, so that Swell sees the page's
+       * cookies and sets the visitor cookie on the storefront's domain.
+       *
+       * @param {{analytics?: boolean, marketing?: boolean, sale_of_data?: boolean}} consent
+       */
+      set(consent = {}) {
+        if (isServer()) {
+          return Promise.reject(new Error('consent.set() runs in the browser'));
+        }
+
+        const data = {};
+
+        for (const purpose of PURPOSES) {
+          // camelCase clients pass saleOfData
+          const camel = purpose.replace(/_(\w)/g, (_m, c) => c.toUpperCase());
+          const value = consent[purpose] ?? consent[camel];
+
+          if (typeof value === 'boolean') {
+            data[purpose] = value;
+          }
+        }
+
+        const result = queue.then(() =>
+          api.request(
+            'put',
+            '/session/consent',
+            { ...data, landing: getLanding() },
+            undefined,
+            { fullUrl: `${window.location.origin}/api/session/consent` },
+          ),
+        );
+
+        // A failed call doesn't hold back the next one
+        queue = result.catch(() => undefined);
+
+        return result;
+      },
+    };
+  }
+
   /**
    * @template {'snake' | 'camel'} C
    * @typedef {import('../types').InitOptions<C>} InitOptions<C>
@@ -13541,7 +13620,7 @@
     const api = {};
 
     Object.assign(api, {
-      version: '5.9.3',
+      version: '5.9.4',
       options,
       request,
 
@@ -13595,39 +13674,41 @@
         return api.request('delete', url, data);
       },
 
-      cache: methods$d(options),
+      cache: methods$e(options),
 
-      card: methods$e(options),
+      card: methods$f(options),
 
-      cart: methods$a(api, options),
+      cart: methods$b(api, options),
 
-      account: methods$9(api),
+      account: methods$a(api),
 
       app: new AppController(api, options),
 
-      products: methods$b(api, options),
+      products: methods$c(api, options),
 
-      categories: methods$8(api),
+      categories: methods$9(api),
 
-      attributes: methods$c(api),
+      attributes: methods$d(api),
 
-      subscriptions: methods$7(api),
+      subscriptions: methods$8(api),
 
-      invoices: methods$6(api),
+      invoices: methods$7(api),
 
-      content: methods$5(api, options),
+      content: methods$6(api, options),
 
-      settings: methods$4(api, options),
+      settings: methods$5(api, options),
 
       payment: new PaymentController(api, options),
 
-      locale: methods$2(api, options),
+      locale: methods$3(api, options),
 
-      currency: methods$1(api, options),
+      currency: methods$2(api, options),
 
-      session: methods$3(api, options),
+      session: methods$4(api, options),
 
-      functions: methods(api),
+      functions: methods$1(api),
+
+      consent: methods(api),
 
       utils,
 
@@ -13701,6 +13782,13 @@
         reqHeaders['X-Session'] = session;
       }
 
+      // The storefront's visitor, for attribution: the cookie is on the
+      // storefront's domain and doesn't reach the store's API host
+      const visitor = allOptions.getCookie('swell-visitor');
+      if (visitor) {
+        reqHeaders['X-Visitor'] = visitor;
+      }
+
       if (locale) {
         reqHeaders['X-Locale'] = locale;
       }