@moonbase.sh/storefront-api 3.11.0 → 3.13.0

package/README.md

@@ -24,7 +24,8 @@ Configuration notes:
 
 - `endpoint`: your Moonbase storefront URL.
 - `includeManifests`: include downloadable file manifests when available.
-- `persistUtm`: store detected UTM values and ad click IDs in localStorage instead of sessionStorage.
+- `persistUtm`: in `@moonbase.sh/vue`, keep the attribution a visitor arrived with in localStorage, across visits, instead of sessionStorage for the tab. Only with the visitor's consent (see `attributionConsent`); a refusal removes it.
+- `attributionConsent`: in `@moonbase.sh/vue`, whether the visitor has agreed to marketing cookies. `false` keeps the UTM tags, referrer and the ad platforms a click came from (`adClicks`) but not the ad click IDs themselves, and records a tagged arrival on the order only with the first thing put in the cart; `true` keeps the click IDs too. Left out, it follows the store's own setting in Moonbase, which the catalog reports for this visitor as `cookieConsentRequired`. Change it later with `setAttributionConsent()`.
 
 ## Common usage
 
@@ -65,6 +66,22 @@ const user = await client.identity.get()
 console.log(user.email)
 ```
 
+### Save a customer's address
+
+The signed-in customer's next checkout starts from the address saved here. A
+checkout they have already entered billing details in keeps those.
+
+```ts
+const user = await client.identity.updateAddress({
+  countryCode: 'AU',
+  streetAddress1: '1 George Street',
+  streetAddress2: null,
+  locality: 'Sydney',
+  region: 'NSW',
+  postCode: '2000',
+})
+```
+
 ### Redeem a voucher
 
 ```ts
@@ -211,6 +228,11 @@ from TikTok) go to the API under those names, and the rest as `utm_*`.
 in from the tags and click IDs it has already picked up, unless you pass your own
 `utm`.
 
+A click ID identifies the visitor's click, so only send one once the visitor has
+agreed to marketing cookies, where the law asks for that. `withoutClickIds(utm)`
+drops their values and keeps the platforms they came from in `adClicks` (sent as
+`utm_ad_click`), which still counts the visit as an ad click.
+
 ## Inventory flow
 
 Most inventory endpoints require an authenticated user:

package/dist/index.cjs

@@ -54,6 +54,7 @@ __export(index_exports, {
   SubscriptionStatus: () => SubscriptionStatus,
   TokenStore: () => TokenStore,
   accessTokenLifetime: () => accessTokenLifetime,
+  adClicksOf: () => adClicksOf,
   imageWidths: () => imageWidths,
   isLocalStorageAvailable: () => isLocalStorageAvailable,
   isPromotionDisplay: () => isPromotionDisplay,
@@ -66,41 +67,14 @@ __export(index_exports, {
   promotionDisplays: () => promotionDisplays,
   resolveUtm: () => resolveUtm,
   schemas: () => schemas_exports12,
-  utmToObject: () => utmToObject
+  utmToObject: () => utmToObject,
+  withoutClickIds: () => withoutClickIds
 });
 module.exports = __toCommonJS(index_exports);
 
 // src/activationRequests/endpoints.ts
 var import_zod5 = require("zod");
 
-// src/activationRequests/schemas.ts
-var schemas_exports3 = {};
-__export(schemas_exports3, {
-  activationRequestSchema: () => activationRequestSchema
-});
-var import_zod4 = require("zod");
-
-// src/storefront/schemas.ts
-var schemas_exports2 = {};
-__export(schemas_exports2, {
-  offerConditionSchema: () => offerConditionSchema,
-  offerScopeSchema: () => offerScopeSchema,
-  storefrontBundleSchema: () => storefrontBundleSchema,
-  storefrontLicenseUpgradeSchema: () => storefrontLicenseUpgradeSchema,
-  storefrontOfferSchema: () => storefrontOfferSchema,
-  storefrontOfferTargetSchema: () => storefrontOfferTargetSchema,
-  storefrontProductSchema: () => storefrontProductSchema,
-  storefrontPromotionCtaSchema: () => storefrontPromotionCtaSchema,
-  storefrontPromotionSchema: () => storefrontPromotionSchema,
-  storefrontPromotionTargetSchema: () => storefrontPromotionTargetSchema,
-  storefrontSchema: () => storefrontSchema,
-  taxEstimateSchema: () => taxEstimateSchema
-});
-var import_zod3 = require("zod");
-
-// src/globalSchemas.ts
-var import_zod = require("zod");
-
 // src/globalModels.ts
 var CycleLength = /* @__PURE__ */ ((CycleLength2) => {
   CycleLength2["Daily"] = "Daily";
@@ -117,6 +91,7 @@ var MarketingConsentType = /* @__PURE__ */ ((MarketingConsentType2) => {
   return MarketingConsentType2;
 })(MarketingConsentType || {});
 function utmToObject(utm) {
+  var _a;
   return Object.entries({
     utm_source: utm == null ? void 0 : utm.source,
     utm_medium: utm == null ? void 0 : utm.medium,
@@ -129,14 +104,41 @@ function utmToObject(utm) {
     wbraid: utm == null ? void 0 : utm.wbraid,
     fbclid: utm == null ? void 0 : utm.fbclid,
     msclkid: utm == null ? void 0 : utm.msclkid,
-    ttclid: utm == null ? void 0 : utm.ttclid
+    ttclid: utm == null ? void 0 : utm.ttclid,
+    utm_ad_click: ((_a = utm == null ? void 0 : utm.adClicks) == null ? void 0 : _a.length) ? utm.adClicks.join(",") : void 0
   }).filter(([_, value]) => value !== void 0).reduce((obj, [key, value]) => ({
     ...obj,
     [key]: value
   }), {});
 }
 
+// src/activationRequests/schemas.ts
+var schemas_exports3 = {};
+__export(schemas_exports3, {
+  activationRequestSchema: () => activationRequestSchema
+});
+var import_zod4 = require("zod");
+
+// src/storefront/schemas.ts
+var schemas_exports2 = {};
+__export(schemas_exports2, {
+  offerConditionSchema: () => offerConditionSchema,
+  offerScopeSchema: () => offerScopeSchema,
+  storefrontBundleSchema: () => storefrontBundleSchema,
+  storefrontLicenseUpgradeSchema: () => storefrontLicenseUpgradeSchema,
+  storefrontOfferSchema: () => storefrontOfferSchema,
+  storefrontOfferTargetSchema: () => storefrontOfferTargetSchema,
+  storefrontProductSchema: () => storefrontProductSchema,
+  storefrontPromotionCtaSchema: () => storefrontPromotionCtaSchema,
+  storefrontPromotionSchema: () => storefrontPromotionSchema,
+  storefrontPromotionTargetSchema: () => storefrontPromotionTargetSchema,
+  storefrontSchema: () => storefrontSchema,
+  taxEstimateSchema: () => taxEstimateSchema
+});
+var import_zod3 = require("zod");
+
 // src/globalSchemas.ts
+var import_zod = require("zod");
 var priceCollectionSchema = import_zod.z.record(import_zod.z.number());
 var discountPromotionFields = {
   promotionId: import_zod.z.string().optional(),
@@ -500,7 +502,11 @@ var storefrontSchema = import_zod3.z.object({
   // Promotions need to be optional since we may still have old, cached representations in browsers
   promotions: storefrontPromotionsSchema.optional(),
   // Depending on circumstances, we may have a tax estimate available
-  estimatedTax: taxEstimateSchema.optional()
+  estimatedTax: taxEstimateSchema.optional(),
+  // Whether the storefront has to wait for this visitor's cookie consent before it keeps ad click
+  // IDs or remembers their visit: the store's setting, for the country the visit comes from.
+  // Optional for older backends and cached catalogs, which count as asking.
+  cookieConsentRequired: import_zod3.z.boolean().optional()
 });
 
 // src/activationRequests/models.ts
@@ -566,8 +572,14 @@ var ActivationRequestEndpoints = class {
     const response = await this.api.authenticatedFetch(`/api/customer/activations/${requestId}/license`, activationRequestSchema, { method: "POST" });
     return response.data;
   }
-  async fulfillTrial(requestId) {
-    const response = await this.api.fetch(`/api/customer/activations/${requestId}/trial`, activationRequestSchema, { method: "POST" });
+  /**
+   * Starts the trial the request's app asked for. `utm` is the tracking the visitor arrived with, which the
+   * trial is put down to, as a sign-up or an order is, so trials can be told apart by the marketing that
+   * brought them.
+   */
+  async fulfillTrial(requestId, utm) {
+    const query = new URLSearchParams(utmToObject(utm)).toString();
+    const response = await this.api.fetch(`/api/customer/activations/${requestId}/trial${query ? `?${query}` : ""}`, activationRequestSchema, { method: "POST" });
     return response.data;
   }
   async cancel(requestId) {
@@ -1050,6 +1062,20 @@ var IdentityEndpoints = class {
       user: response.data
     };
   }
+  /**
+   * Saves the signed-in customer's address, which their next checkout starts from. A checkout
+   * they have already entered billing details in keeps those. Rejects with a `MoonbaseError` for
+   * an address the store can't use: it needs a known country, a street address, a city or a
+   * region, and in the US a postal code.
+   */
+  async updateAddress(address) {
+    const response = await this.api.authenticatedFetch("/api/customer/identity", userSchema, {
+      method: "PATCH",
+      body: { address }
+    });
+    this.tokenStore.setUser(response.data);
+    return response.data;
+  }
   async setPassword(currentPassword, newPassword) {
     await this.api.authenticatedFetch(`/api/customer/identity/set-password`, null, {
       method: "POST",
@@ -1295,7 +1321,7 @@ var ProductEndpoints = class {
 var import_zod15 = require("zod");
 
 // package.json
-var version = "3.11.0";
+var version = "3.13.0";
 
 // src/utils/client.ts
 function buildClientHeader(sdk) {
@@ -3056,6 +3082,31 @@ var ImageUtils = class _ImageUtils {
 };
 
 // src/utils/utm.ts
+var clickIdPlatforms = [
+  ["gclid", "google"],
+  ["gbraid", "google"],
+  ["wbraid", "google"],
+  ["msclkid", "microsoft"],
+  ["fbclid", "meta"],
+  ["ttclid", "tiktok"]
+];
+var adPlatformOrder = ["google", "microsoft", "meta", "tiktok"];
+function adClicksOf(utm) {
+  var _a;
+  if (!utm)
+    return void 0;
+  const platforms = new Set((_a = utm.adClicks) != null ? _a : []);
+  for (const [key, platform] of clickIdPlatforms) {
+    if (utm[key])
+      platforms.add(platform);
+  }
+  const ordered = adPlatformOrder.filter((platform) => platforms.has(platform));
+  return ordered.length > 0 ? ordered : void 0;
+}
+function withoutClickIds(utm) {
+  const { gclid: _gclid, gbraid: _gbraid, wbraid: _wbraid, msclkid: _msclkid, fbclid: _fbclid, ttclid: _ttclid, ...rest } = utm;
+  return { ...rest, adClicks: adClicksOf(utm) };
+}
 function parseOffSiteReferrer(rawReferrer, currentOrigin) {
   if (!rawReferrer)
     return void 0;
@@ -3070,7 +3121,7 @@ function parseOffSiteReferrer(rawReferrer, currentOrigin) {
 }
 function resolveUtm(cached, fresh) {
   const freshHasUtm = !!(fresh.source || fresh.medium || fresh.campaign || fresh.term || fresh.content);
-  const freshHasClickId = !!(fresh.gclid || fresh.gbraid || fresh.wbraid || fresh.fbclid || fresh.msclkid || fresh.ttclid);
+  const freshHasClickId = !!adClicksOf(fresh);
   const freshIsExternalArrival = freshHasUtm || freshHasClickId || !!fresh.referrer;
   if (freshIsExternalArrival)
     return fresh;
@@ -3133,6 +3184,7 @@ var MoonbaseClient = class {
   SubscriptionStatus,
   TokenStore,
   accessTokenLifetime,
+  adClicksOf,
   imageWidths,
   isLocalStorageAvailable,
   isPromotionDisplay,
@@ -3145,5 +3197,6 @@ var MoonbaseClient = class {
   promotionDisplays,
   resolveUtm,
   schemas,
-  utmToObject
+  utmToObject,
+  withoutClickIds
 });