@moonbase.sh/storefront-api 3.10.0 → 3.12.0

package/dist/index.js

@@ -51,6 +51,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,
@@ -63,7 +64,8 @@ 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
@@ -434,7 +436,11 @@ var storefrontSchema = z3.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: z3.boolean().optional()
 });
 
 // src/activationRequests/models.ts
@@ -1229,7 +1235,7 @@ var ProductEndpoints = class {
 import { z as z15 } from "zod";
 
 // package.json
-var version = "3.10.0";
+var version = "3.12.0";
 
 // src/utils/client.ts
 function buildClientHeader(sdk) {
@@ -1385,6 +1391,10 @@ var MoonbaseApi = class {
 var schemas_exports8 = {};
 __export(schemas_exports8, {
   milestoneProgressSchema: () => milestoneProgressSchema,
+  pendingPlanChangeSchema: () => pendingPlanChangeSchema,
+  pricingOptionSchema: () => pricingOptionSchema,
+  subscriptionPlanOptionSchema: () => subscriptionPlanOptionSchema,
+  subscriptionPlanOptionsSchema: () => subscriptionPlanOptionsSchema,
   subscriptionSchema: () => subscriptionSchema
 });
 import { z as z14 } from "zod";
@@ -1594,6 +1604,33 @@ var milestoneProgressSchema = z14.object({
   toNormalizedCycleNumber: z14.number(),
   events: z14.record(z14.coerce.number(), milestoneProgressEventSchema.array())
 });
+var pricingOptionSchema = z14.object({
+  id: z14.string(),
+  name: z14.string(),
+  cycleLength: z14.nativeEnum(CycleLength)
+});
+var pendingPlanChangeSchema = z14.object({
+  option: pricingOptionSchema,
+  // The renewal that starts the new plan and charges `nextTotal`.
+  takesEffectAt: z14.coerce.date(),
+  nextTotal: orderTotalSchema,
+  // Whether everything the subscription gets off now (discount, offer, coupons) still applies on the new plan.
+  keepsDiscount: z14.boolean(),
+  scheduledAt: z14.coerce.date()
+});
+var subscriptionPlanOptionSchema = z14.object({
+  option: pricingOptionSchema,
+  // What the next renewal charges on this plan. For the plan it is on, its normal renewal.
+  nextTotal: orderTotalSchema,
+  takesEffectAt: z14.coerce.date(),
+  keepsDiscount: z14.boolean(),
+  current: z14.boolean(),
+  scheduled: z14.boolean()
+});
+var subscriptionPlanOptionsSchema = z14.object({
+  unavailable: z14.string().nullish(),
+  plans: subscriptionPlanOptionSchema.array()
+});
 var subscriptionSchema = z14.object({
   id: z14.string(),
   status: z14.nativeEnum(SubscriptionStatus),
@@ -1608,6 +1645,10 @@ var subscriptionSchema = z14.object({
   paymentMethod: z14.string().optional(),
   milestoneProgress: milestoneProgressSchema.nullish(),
   embeddedUpdatePaymentUrl: z14.string().optional(),
+  // Older backends send neither, and one this version can't read is dropped rather than failing
+  // the whole subscription.
+  pricingOption: pricingOptionSchema.nullish().catch(void 0),
+  pendingChange: pendingPlanChangeSchema.nullish().catch(void 0),
   content: z14.discriminatedUnion("type", [
     z14.object({
       type: z14.literal("Product"),
@@ -1651,6 +1692,38 @@ var SubscriptionEndpoints = class {
     });
     return response.data;
   }
+  /**
+   * The plans the subscription can switch to when its current period ends, each with what the
+   * next renewal would charge on it. The plan it is on comes first. When it can't switch,
+   * `unavailable` says why, ready to show to the customer.
+   */
+  async getPlanOptions(subscriptionId) {
+    const response = await this.api.authenticatedFetch(`/api/customer/inventory/subscriptions/${subscriptionId}/plan-options`, subscriptionPlanOptionsSchema);
+    return response.data;
+  }
+  /**
+   * Switches the subscription to another plan when its current period ends. Nothing is charged
+   * now: the next renewal charges the new plan and starts its cycle. Until then the customer can
+   * switch again, and passing the plan it is on keeps that plan. Returns the updated subscription,
+   * with the switch in `pendingChange`.
+   */
+  async changePlan(subscriptionId, variationId) {
+    const response = await this.api.authenticatedFetch(`/api/customer/inventory/subscriptions/${subscriptionId}/plan-change`, subscriptionSchema, {
+      method: "POST",
+      body: { variationId }
+    });
+    return response.data;
+  }
+  /**
+   * Keeps the subscription on its current plan, dropping a switch scheduled with `changePlan`.
+   * Returns the updated subscription.
+   */
+  async cancelPlanChange(subscriptionId) {
+    const response = await this.api.authenticatedFetch(`/api/customer/inventory/subscriptions/${subscriptionId}/plan-change`, subscriptionSchema, {
+      method: "DELETE"
+    });
+    return response.data;
+  }
   async renew(subscriptionId, returnUrl, embedded) {
     const response = await this.api.authenticatedFetch(`/api/customer/inventory/subscriptions/${subscriptionId}/renew?redirect=false&return=${returnUrl}&embedded=${embedded ? "true" : "false"}`, z15.object({
       location: z15.string()
@@ -2923,6 +2996,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;
@@ -2937,7 +3035,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;
@@ -2999,6 +3097,7 @@ export {
   SubscriptionStatus,
   TokenStore,
   accessTokenLifetime,
+  adClicksOf,
   imageWidths,
   isLocalStorageAvailable,
   isPromotionDisplay,
@@ -3011,5 +3110,6 @@ export {
   promotionDisplays,
   resolveUtm,
   schemas_exports12 as schemas,
-  utmToObject
+  utmToObject,
+  withoutClickIds
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@moonbase.sh/storefront-api",
   "type": "module",
-  "version": "3.10.0",
+  "version": "3.12.0",
   "description": "Package to let you build storefronts with Moonbase.sh as payment and delivery provider",
   "author": "Tobias Lønnerød Madsen <m@dsen.tv>",
   "license": "MIT",