swell-js 5.9.3 → 5.9.4

package/README.md

@@ -13,7 +13,7 @@ Universal JavaScript client for Swell's Frontend API, providing client-safe acce
 
 **About Swell**
 
-[Swell](https://www.swell.is) is a customizable, API-first platform for powering modern B2C/B2B shopping experiences and marketplaces. Build and connect anything using your favorite technologies, and provide admins with an easy to use dashboard.
+[Swell](https://www.swell.is) is an ecommerce platform with subscriptions and B2B pricing built in. Run your store on a Swell theme, or [go headless](https://www.swell.is/headless-commerce) with its APIs.
 
 ## Documentation
 

package/dist/api.mjs

@@ -1,21 +1,21 @@
-import methods$5 from './card.mjs';
+import methods$6 from './card.mjs';
 import { getCookie, setCookie } from './cookie.mjs';
-import methods$4 from './cache.mjs';
-import methods$3 from './cart.mjs';
-import methods$6 from './account.mjs';
-import { j as isFunction, l as loadScript, e as isObject, v as vaultRequest, k as isEmpty, d as defaultMethods, x as trimEnd, y as utils, z as trimStart, A as trimBoth, b as toSnake, o as base64Encode, i as isServer, t as toCamel } from './index.76eb52e5.mjs';
+import methods$5 from './cache.mjs';
+import methods$4 from './cart.mjs';
+import methods$7 from './account.mjs';
+import { j as isFunction, l as loadScript, e as isObject, v as vaultRequest, k as isEmpty, d as defaultMethods, i as isServer, x as trimEnd, y as utils, z as trimStart, A as trimBoth, b as toSnake, o as base64Encode, t as toCamel } from './index.76eb52e5.mjs';
 import { Q as stringifyQuery } from './find.ba551a2e.mjs';
 import 'deepmerge';
 import 'fast-case';
-import methods$7 from './products.mjs';
-import methods$8 from './categories.mjs';
-import methods$9 from './attributes.mjs';
-import methods$a from './subscriptions.mjs';
-import methods$b from './content.mjs';
-import methods$c from './settings.mjs';
+import methods$8 from './products.mjs';
+import methods$9 from './categories.mjs';
+import methods$a from './attributes.mjs';
+import methods$b from './subscriptions.mjs';
+import methods$c from './content.mjs';
+import methods$d from './settings.mjs';
 import PaymentController from './payment.mjs';
-import methods$d from './locale.mjs';
-import methods$e, { isCurrencyCode } from './currency.mjs';
+import methods$e from './locale.mjs';
+import methods$f, { isCurrencyCode } from './currency.mjs';
 import './round.c68b8be5.mjs';
 
 class AppComponent {
@@ -81,7 +81,7 @@ class AppComponent {
   }
 
   async updateCart(data) {
-    const cart = await methods$3(this.api, this.options).update(data);
+    const cart = await methods$4(this.api, this.options).update(data);
 
     this.setProps({ cart });
   }
@@ -317,7 +317,7 @@ class AppController {
   }
 }
 
-function methods$2(api) {
+function methods$3(api) {
   const { get, list } = defaultMethods(api, '/invoices', ['list', 'get']);
   return {
     get: (id, ...args) => {
@@ -328,7 +328,7 @@ function methods$2(api) {
   };
 }
 
-function methods$1(api, opt) {
+function methods$2(api, opt) {
   return {
     /**
      * Get the decoded session as an object of session values
@@ -355,7 +355,7 @@ function methods$1(api, opt) {
   };
 }
 
-function methods(api, _opt) {
+function methods$1(api, _opt) {
   return {
     /**
      * Make a request to an app function and greceiveet a response
@@ -424,6 +424,85 @@ function methods(api, _opt) {
   };
 }
 
+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>
@@ -455,7 +534,7 @@ function swell(initStore = undefined, initKey, initOptions = {}) {
   const api = {};
 
   Object.assign(api, {
-    version: '5.9.3',
+    version: '5.9.4',
     options,
     request,
 
@@ -509,39 +588,41 @@ function swell(initStore = undefined, initKey, initOptions = {}) {
       return api.request('delete', url, data);
     },
 
-    cache: methods$4(options),
+    cache: methods$5(options),
 
-    card: methods$5(options),
+    card: methods$6(options),
 
-    cart: methods$3(api, options),
+    cart: methods$4(api, options),
 
-    account: methods$6(api),
+    account: methods$7(api),
 
     app: new AppController(api, options),
 
-    products: methods$7(api, options),
+    products: methods$8(api, options),
 
-    categories: methods$8(api),
+    categories: methods$9(api),
 
-    attributes: methods$9(api),
+    attributes: methods$a(api),
 
-    subscriptions: methods$a(api),
+    subscriptions: methods$b(api),
 
-    invoices: methods$2(api),
+    invoices: methods$3(api),
 
-    content: methods$b(api, options),
+    content: methods$c(api, options),
 
-    settings: methods$c(api, options),
+    settings: methods$d(api, options),
 
     payment: new PaymentController(api, options),
 
-    locale: methods$d(api, options),
+    locale: methods$e(api, options),
+
+    currency: methods$f(api, options),
 
-    currency: methods$e(api, options),
+    session: methods$2(api, options),
 
-    session: methods$1(api, options),
+    functions: methods$1(api),
 
-    functions: methods(api),
+    consent: methods(api),
 
     utils,
 
@@ -615,6 +696,13 @@ function swell(initStore = undefined, initKey, initOptions = {}) {
       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;
     }

package/dist/swell.cjs

@@ -4966,7 +4966,7 @@ const utils = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   vaultRequest
 }, Symbol.toStringTag, { value: 'Module' }));
 
-function methods$e(options) {
+function methods$f(options) {
   return {
     async createToken(data) {
       let error = null;
@@ -5183,7 +5183,7 @@ function setCookie(name, value, options = {}) {
 
 const RECORD_TIMEOUT = 5000;
 
-function methods$d(opt) {
+function methods$e(opt) {
   let VALUES = {
     /*
     [model]: {
@@ -5345,7 +5345,7 @@ function methods$d(opt) {
   };
 }
 
-function methods$c(api) {
+function methods$d(api) {
   const { get, list } = defaultMethods(api, '/attributes', ['list', 'get']);
 
   return {
@@ -5357,7 +5357,7 @@ function methods$c(api) {
   };
 }
 
-function methods$b(api, opt) {
+function methods$c(api, opt) {
   const { get, list } = defaultMethods(api, '/products', ['list', 'get']);
   return {
     get: (id, ...args) => {
@@ -5566,7 +5566,7 @@ function findPurchaseOption(product, purchaseOption) {
 }
 
 async function getFilterableAttributeFilters(api, products, options) {
-  const { results: filterableAttributes } = await methods$c(api).list({
+  const { results: filterableAttributes } = await methods$d(api).list({
     filterable: true,
   });
 
@@ -5750,7 +5750,7 @@ function getPriceRange(products) {
   };
 }
 
-function methods$a(api, options) {
+function methods$b(api, options) {
   return {
     state: null,
     order: null,
@@ -5935,7 +5935,7 @@ function methods$a(api, options) {
   };
 }
 
-function methods$9(api) {
+function methods$a(api) {
   return {
     state: null,
 
@@ -6109,7 +6109,7 @@ class AppComponent {
   }
 
   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 });
   }
@@ -6345,7 +6345,7 @@ class AppController {
   }
 }
 
-function methods$8(api) {
+function methods$9(api) {
   const { get, list } = defaultMethods(api, '/categories', ['list', 'get']);
 
   return {
@@ -6357,7 +6357,7 @@ function methods$8(api) {
   };
 }
 
-function methods$7(api) {
+function methods$8(api) {
   const { get, list } = defaultMethods(api, '/subscriptions', ['list', 'get']);
   return {
     get: (id, ...args) => {
@@ -6422,7 +6422,7 @@ function methods$7(api) {
   };
 }
 
-function methods$6(api) {
+function methods$7(api) {
   const { get, list } = defaultMethods(api, '/invoices', ['list', 'get']);
   return {
     get: (id, ...args) => {
@@ -6433,7 +6433,7 @@ function methods$6(api) {
   };
 }
 
-function methods$5(api, opt) {
+function methods$6(api, opt) {
   return {
     get: (type, id, query) => {
       return api.cache.getFetch(`content_${type}`, id, () =>
@@ -6449,7 +6449,7 @@ function methods$5(api, opt) {
   };
 }
 
-function methods$4(api, opt) {
+function methods$5(api, opt) {
   return {
     state: null,
     menuState: null,
@@ -6744,7 +6744,7 @@ function decodeLocaleValue(locale, values, key, configs, opt) {
   }
 }
 
-function methods$3(api, opt) {
+function methods$4(api, opt) {
   return {
     /**
      * Get the decoded session as an object of session values
@@ -7132,7 +7132,7 @@ class Payment {
    * @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');
@@ -7160,7 +7160,7 @@ class Payment {
       }
     }
 
-    const updatedCart = await methods$a(this.api, this.options).update(
+    const updatedCart = await methods$b(this.api, this.options).update(
       updateData,
     );
 
@@ -7173,7 +7173,7 @@ class Payment {
    * @returns {Promise<object>}
    */
   async getSettings() {
-    return methods$4(this.api, this.options).get();
+    return methods$5(this.api, this.options).get();
   }
 
   /**
@@ -12789,7 +12789,7 @@ class PaymentController {
   }
 
   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);
@@ -13019,7 +13019,7 @@ class PaymentController {
   }
 }
 
-function methods$2(api, opt) {
+function methods$3(api, opt) {
   return {
     code: null,
     state: null,
@@ -13075,7 +13075,7 @@ function defaultLocale() {
   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) {
@@ -13296,7 +13296,7 @@ function methods$1(api, opt) {
   };
 }
 
-function methods(api, _opt) {
+function methods$1(api, _opt) {
   return {
     /**
      * Make a request to an app function and greceiveet a response
@@ -13365,6 +13365,85 @@ function methods(api, _opt) {
   };
 }
 
+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>
@@ -13396,7 +13475,7 @@ function swell(initStore = undefined, initKey, initOptions = {}) {
   const api = {};
 
   Object.assign(api, {
-    version: '5.9.3',
+    version: '5.9.4',
     options,
     request,
 
@@ -13450,39 +13529,41 @@ function swell(initStore = undefined, initKey, initOptions = {}) {
       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,
 
@@ -13556,6 +13637,13 @@ function swell(initStore = undefined, initKey, initOptions = {}) {
       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;
     }