@moonbase.sh/storefront-api 3.11.0 → 3.12.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
 
@@ -211,6 +212,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,7 +67,8 @@ __export(index_exports, {
   promotionDisplays: () => promotionDisplays,
   resolveUtm: () => resolveUtm,
   schemas: () => schemas_exports12,
-  utmToObject: () => utmToObject
+  utmToObject: () => utmToObject,
+  withoutClickIds: () => withoutClickIds
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -117,6 +119,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,7 +132,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
@@ -500,7 +504,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
@@ -1295,7 +1303,7 @@ var ProductEndpoints = class {
 var import_zod15 = require("zod");
 
 // package.json
-var version = "3.11.0";
+var version = "3.12.0";
 
 // src/utils/client.ts
 function buildClientHeader(sdk) {
@@ -3056,6 +3064,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 +3103,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 +3166,7 @@ var MoonbaseClient = class {
   SubscriptionStatus,
   TokenStore,
   accessTokenLifetime,
+  adClicksOf,
   imageWidths,
   isLocalStorageAvailable,
   isPromotionDisplay,
@@ -3145,5 +3179,6 @@ var MoonbaseClient = class {
   promotionDisplays,
   resolveUtm,
   schemas,
-  utmToObject
+  utmToObject,
+  withoutClickIds
 });

package/dist/index.d.cts

@@ -1773,12 +1773,21 @@ interface UrchinTrackingModule {
     msclkid?: string;
     /** TikTok Ads click ID, added to the landing page URL of a TikTok ad. */
     ttclid?: string;
+    /**
+     * The platforms whose click IDs were on the link. A click ID identifies the
+     * visitor's click, so the storefront only passes one on once the visitor has
+     * agreed to marketing cookies (`attributionConsent`). Until then it sends
+     * these instead, which still tell Moonbase the visit came from an ad.
+     */
+    adClicks?: AdPlatform[];
 }
+/** An ad platform whose click IDs Moonbase recognises on a link. */
+type AdPlatform = 'google' | 'microsoft' | 'meta' | 'tiktok';
 /**
- * The query parameters for `utm`: the tags and referrer as `utm_*`, and the ad
+ * The query parameters for `utm`: the tags and referrer as `utm_*`, the ad
  * click IDs under their own names (`gclid`, `gbraid`, `wbraid`, `fbclid`,
- * `msclkid`, `ttclid`), as they appear on the landing page URL. Fields left out
- * are not sent.
+ * `msclkid`, `ttclid`), as they appear on the landing page URL, and the
+ * platforms they came from as `utm_ad_click`. Fields left out are not sent.
  */
 declare function utmToObject(utm?: UrchinTrackingModule): Record<string, string>;
 
@@ -27252,6 +27261,7 @@ declare class StorefrontEndpoints {
             rate: number;
             region?: string | undefined;
         } | undefined;
+        cookieConsentRequired?: boolean | undefined;
     }>;
 }
 
@@ -51381,6 +51391,7 @@ declare const storefrontSchema: z.ZodObject<{
         rate: number;
         region?: string | undefined;
     }>>;
+    cookieConsentRequired: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     products: {
         id: string;
@@ -51875,6 +51886,7 @@ declare const storefrontSchema: z.ZodObject<{
         rate: number;
         region?: string | undefined;
     } | undefined;
+    cookieConsentRequired?: boolean | undefined;
 }, {
     products: {
         id: string;
@@ -52195,6 +52207,7 @@ declare const storefrontSchema: z.ZodObject<{
         rate: number;
         region?: string | undefined;
     } | undefined;
+    cookieConsentRequired?: boolean | undefined;
 }>;
 
 declare const schemas$1_offerConditionSchema: typeof offerConditionSchema;
@@ -52579,6 +52592,20 @@ declare const problemDetailsSchema: z.ZodObject<{
 }>;
 type ProblemDetails = z.infer<typeof problemDetailsSchema>;
 
+/**
+ * The platforms the click IDs in `utm` came from, together with any it already
+ * names in `adClicks`, each once; undefined when there are none, so a visit
+ * without an ad click carries no empty list.
+ */
+declare function adClicksOf(utm: UrchinTrackingModule | undefined): AdPlatform[] | undefined;
+/**
+ * `utm` without the values of its ad click IDs, which identify the visitor's
+ * click, but still naming in `adClicks` the platforms they came from, which
+ * identify no one. This is what the storefront keeps and sends until the
+ * visitor has agreed to marketing cookies: the visit still counts as an ad
+ * click, and a sale from it is still put down to the ad's tags.
+ */
+declare function withoutClickIds(utm: UrchinTrackingModule): UrchinTrackingModule;
 /**
  * Returns the host of `rawReferrer` if it parses as a URL with a different
  * origin from `currentOrigin`. Returns `undefined` for same-origin (internal
@@ -52611,7 +52638,25 @@ declare function resolveUtm(cached: UrchinTrackingModule | undefined, fresh: Urc
 
 interface MoonbaseConfiguration {
     endpoint: string;
+    /**
+     * Keep the attribution a visitor arrived with in localStorage, across visits,
+     * rather than in sessionStorage for the tab. Only with the visitor's consent
+     * (see `attributionConsent`), as it remembers them beyond the visit; a refusal
+     * removes it.
+     */
     persistUtm?: boolean;
+    /**
+     * Whether the visitor has agreed to marketing cookies, as your cookie banner
+     * reports it, so `@moonbase.sh/vue` may keep and send the ad click IDs on the
+     * landing page URL (`gclid`, `fbclid` and the rest) and record a tagged arrival
+     * before they put anything in the cart. Without them it keeps only the UTM
+     * tags, the referring site and which ad platforms the click IDs came from, for
+     * the tab. Left out, the storefront follows the store's own setting in Moonbase
+     * (always, per country, or only with cookie consent), which the catalog
+     * reports for this visitor as `cookieConsentRequired`. Change it later with
+     * `setAttributionConsent()`.
+     */
+    attributionConsent?: boolean;
     includeManifests?: boolean;
     store?: IStore;
     logger?: ILogger;
@@ -52641,4 +52686,4 @@ declare class MoonbaseClient {
     orders: OrderEndpoints;
 }
 
-export { type Activation, ActivationMethod, type ActivationReleaseNotCovered, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type Address, Architecture, type BundleLineItem, CaptchaRequiredError, type CartCatalog, type CartOrder, type CartTotal, type CartTotalCondition, CartUtils, type CommunicationPreferences, type CommunicationPreferencesInput, type CommunicationPreferencesView, type CompletedOrder, ConnectableAccountProvider, type ConnectedAccount, ConsoleLogger, CycleLength, type Discount, DiscountUtils, type Download, type DownloadManifest, type ILogger, type IRecurrence, type IStore, type ITokenStore, type Identity, type ImageFit, type ImageFormat, type ImageTransform, ImageUtils, InMemoryStore, type License, type LicenseReleaseAccess, LicenseStatus, type LineItem, type LineItemTotal, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, type OfferConditionContext, type OfferProgress, type OfferScope, OfferUtils, type OpenOrder, type Order, OrderStatus, type OrderTotal, type OwnedProduct, type Page, PasswordSetupRequiredError, type PendingPlanChange, Platform, type PricingOption, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type ProductRelease, type ProductReleaseAccess, type PromotionDisplay, type Quantifiable, type RawPropertyArray, type RawPropertyObject, type RawPropertyValue, ReleaseNotCoveredError, type SignUpOptions, type SignUpResult, type SingleOrMultiple, StoreClosedError, type Storefront, type StorefrontBundle, type StorefrontLicenseUpgrade, type StorefrontLicenseUpgradeReleaseAccess, type StorefrontOffer, type StorefrontOfferTarget, type StorefrontProduct, type StorefrontPromotion, type StorefrontPromotionCta, type StorefrontPromotionTarget, type SubscribeInput, type SubscribeResponse, type Subscription, type SubscriptionCancellationFeedback, SubscriptionCancellationReason, type SubscriptionPlanOption, type SubscriptionPlanOptions, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type UserAccountConfirmedStatus, type Vendor, type VendorCaptcha, type VendorFeatures, type Voucher, accessTokenLifetime, imageWidths, isLocalStorageAvailable, isPromotionDisplay, isTransformableImageUrl, maxImageDimension, normalizeGroupIds, objectToQuery, parseOffSiteReferrer, problemDetailsSchema, promotionDisplays, resolveUtm, schemas, utmToObject };
+export { type Activation, ActivationMethod, type ActivationReleaseNotCovered, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type AdPlatform, type Address, Architecture, type BundleLineItem, CaptchaRequiredError, type CartCatalog, type CartOrder, type CartTotal, type CartTotalCondition, CartUtils, type CommunicationPreferences, type CommunicationPreferencesInput, type CommunicationPreferencesView, type CompletedOrder, ConnectableAccountProvider, type ConnectedAccount, ConsoleLogger, CycleLength, type Discount, DiscountUtils, type Download, type DownloadManifest, type ILogger, type IRecurrence, type IStore, type ITokenStore, type Identity, type ImageFit, type ImageFormat, type ImageTransform, ImageUtils, InMemoryStore, type License, type LicenseReleaseAccess, LicenseStatus, type LineItem, type LineItemTotal, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, type OfferConditionContext, type OfferProgress, type OfferScope, OfferUtils, type OpenOrder, type Order, OrderStatus, type OrderTotal, type OwnedProduct, type Page, PasswordSetupRequiredError, type PendingPlanChange, Platform, type PricingOption, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type ProductRelease, type ProductReleaseAccess, type PromotionDisplay, type Quantifiable, type RawPropertyArray, type RawPropertyObject, type RawPropertyValue, ReleaseNotCoveredError, type SignUpOptions, type SignUpResult, type SingleOrMultiple, StoreClosedError, type Storefront, type StorefrontBundle, type StorefrontLicenseUpgrade, type StorefrontLicenseUpgradeReleaseAccess, type StorefrontOffer, type StorefrontOfferTarget, type StorefrontProduct, type StorefrontPromotion, type StorefrontPromotionCta, type StorefrontPromotionTarget, type SubscribeInput, type SubscribeResponse, type Subscription, type SubscriptionCancellationFeedback, SubscriptionCancellationReason, type SubscriptionPlanOption, type SubscriptionPlanOptions, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type UserAccountConfirmedStatus, type Vendor, type VendorCaptcha, type VendorFeatures, type Voucher, accessTokenLifetime, adClicksOf, imageWidths, isLocalStorageAvailable, isPromotionDisplay, isTransformableImageUrl, maxImageDimension, normalizeGroupIds, objectToQuery, parseOffSiteReferrer, problemDetailsSchema, promotionDisplays, resolveUtm, schemas, utmToObject, withoutClickIds };

package/dist/index.d.ts

@@ -1773,12 +1773,21 @@ interface UrchinTrackingModule {
     msclkid?: string;
     /** TikTok Ads click ID, added to the landing page URL of a TikTok ad. */
     ttclid?: string;
+    /**
+     * The platforms whose click IDs were on the link. A click ID identifies the
+     * visitor's click, so the storefront only passes one on once the visitor has
+     * agreed to marketing cookies (`attributionConsent`). Until then it sends
+     * these instead, which still tell Moonbase the visit came from an ad.
+     */
+    adClicks?: AdPlatform[];
 }
+/** An ad platform whose click IDs Moonbase recognises on a link. */
+type AdPlatform = 'google' | 'microsoft' | 'meta' | 'tiktok';
 /**
- * The query parameters for `utm`: the tags and referrer as `utm_*`, and the ad
+ * The query parameters for `utm`: the tags and referrer as `utm_*`, the ad
  * click IDs under their own names (`gclid`, `gbraid`, `wbraid`, `fbclid`,
- * `msclkid`, `ttclid`), as they appear on the landing page URL. Fields left out
- * are not sent.
+ * `msclkid`, `ttclid`), as they appear on the landing page URL, and the
+ * platforms they came from as `utm_ad_click`. Fields left out are not sent.
  */
 declare function utmToObject(utm?: UrchinTrackingModule): Record<string, string>;
 
@@ -27252,6 +27261,7 @@ declare class StorefrontEndpoints {
             rate: number;
             region?: string | undefined;
         } | undefined;
+        cookieConsentRequired?: boolean | undefined;
     }>;
 }
 
@@ -51381,6 +51391,7 @@ declare const storefrontSchema: z.ZodObject<{
         rate: number;
         region?: string | undefined;
     }>>;
+    cookieConsentRequired: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     products: {
         id: string;
@@ -51875,6 +51886,7 @@ declare const storefrontSchema: z.ZodObject<{
         rate: number;
         region?: string | undefined;
     } | undefined;
+    cookieConsentRequired?: boolean | undefined;
 }, {
     products: {
         id: string;
@@ -52195,6 +52207,7 @@ declare const storefrontSchema: z.ZodObject<{
         rate: number;
         region?: string | undefined;
     } | undefined;
+    cookieConsentRequired?: boolean | undefined;
 }>;
 
 declare const schemas$1_offerConditionSchema: typeof offerConditionSchema;
@@ -52579,6 +52592,20 @@ declare const problemDetailsSchema: z.ZodObject<{
 }>;
 type ProblemDetails = z.infer<typeof problemDetailsSchema>;
 
+/**
+ * The platforms the click IDs in `utm` came from, together with any it already
+ * names in `adClicks`, each once; undefined when there are none, so a visit
+ * without an ad click carries no empty list.
+ */
+declare function adClicksOf(utm: UrchinTrackingModule | undefined): AdPlatform[] | undefined;
+/**
+ * `utm` without the values of its ad click IDs, which identify the visitor's
+ * click, but still naming in `adClicks` the platforms they came from, which
+ * identify no one. This is what the storefront keeps and sends until the
+ * visitor has agreed to marketing cookies: the visit still counts as an ad
+ * click, and a sale from it is still put down to the ad's tags.
+ */
+declare function withoutClickIds(utm: UrchinTrackingModule): UrchinTrackingModule;
 /**
  * Returns the host of `rawReferrer` if it parses as a URL with a different
  * origin from `currentOrigin`. Returns `undefined` for same-origin (internal
@@ -52611,7 +52638,25 @@ declare function resolveUtm(cached: UrchinTrackingModule | undefined, fresh: Urc
 
 interface MoonbaseConfiguration {
     endpoint: string;
+    /**
+     * Keep the attribution a visitor arrived with in localStorage, across visits,
+     * rather than in sessionStorage for the tab. Only with the visitor's consent
+     * (see `attributionConsent`), as it remembers them beyond the visit; a refusal
+     * removes it.
+     */
     persistUtm?: boolean;
+    /**
+     * Whether the visitor has agreed to marketing cookies, as your cookie banner
+     * reports it, so `@moonbase.sh/vue` may keep and send the ad click IDs on the
+     * landing page URL (`gclid`, `fbclid` and the rest) and record a tagged arrival
+     * before they put anything in the cart. Without them it keeps only the UTM
+     * tags, the referring site and which ad platforms the click IDs came from, for
+     * the tab. Left out, the storefront follows the store's own setting in Moonbase
+     * (always, per country, or only with cookie consent), which the catalog
+     * reports for this visitor as `cookieConsentRequired`. Change it later with
+     * `setAttributionConsent()`.
+     */
+    attributionConsent?: boolean;
     includeManifests?: boolean;
     store?: IStore;
     logger?: ILogger;
@@ -52641,4 +52686,4 @@ declare class MoonbaseClient {
     orders: OrderEndpoints;
 }
 
-export { type Activation, ActivationMethod, type ActivationReleaseNotCovered, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type Address, Architecture, type BundleLineItem, CaptchaRequiredError, type CartCatalog, type CartOrder, type CartTotal, type CartTotalCondition, CartUtils, type CommunicationPreferences, type CommunicationPreferencesInput, type CommunicationPreferencesView, type CompletedOrder, ConnectableAccountProvider, type ConnectedAccount, ConsoleLogger, CycleLength, type Discount, DiscountUtils, type Download, type DownloadManifest, type ILogger, type IRecurrence, type IStore, type ITokenStore, type Identity, type ImageFit, type ImageFormat, type ImageTransform, ImageUtils, InMemoryStore, type License, type LicenseReleaseAccess, LicenseStatus, type LineItem, type LineItemTotal, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, type OfferConditionContext, type OfferProgress, type OfferScope, OfferUtils, type OpenOrder, type Order, OrderStatus, type OrderTotal, type OwnedProduct, type Page, PasswordSetupRequiredError, type PendingPlanChange, Platform, type PricingOption, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type ProductRelease, type ProductReleaseAccess, type PromotionDisplay, type Quantifiable, type RawPropertyArray, type RawPropertyObject, type RawPropertyValue, ReleaseNotCoveredError, type SignUpOptions, type SignUpResult, type SingleOrMultiple, StoreClosedError, type Storefront, type StorefrontBundle, type StorefrontLicenseUpgrade, type StorefrontLicenseUpgradeReleaseAccess, type StorefrontOffer, type StorefrontOfferTarget, type StorefrontProduct, type StorefrontPromotion, type StorefrontPromotionCta, type StorefrontPromotionTarget, type SubscribeInput, type SubscribeResponse, type Subscription, type SubscriptionCancellationFeedback, SubscriptionCancellationReason, type SubscriptionPlanOption, type SubscriptionPlanOptions, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type UserAccountConfirmedStatus, type Vendor, type VendorCaptcha, type VendorFeatures, type Voucher, accessTokenLifetime, imageWidths, isLocalStorageAvailable, isPromotionDisplay, isTransformableImageUrl, maxImageDimension, normalizeGroupIds, objectToQuery, parseOffSiteReferrer, problemDetailsSchema, promotionDisplays, resolveUtm, schemas, utmToObject };
+export { type Activation, ActivationMethod, type ActivationReleaseNotCovered, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type AdPlatform, type Address, Architecture, type BundleLineItem, CaptchaRequiredError, type CartCatalog, type CartOrder, type CartTotal, type CartTotalCondition, CartUtils, type CommunicationPreferences, type CommunicationPreferencesInput, type CommunicationPreferencesView, type CompletedOrder, ConnectableAccountProvider, type ConnectedAccount, ConsoleLogger, CycleLength, type Discount, DiscountUtils, type Download, type DownloadManifest, type ILogger, type IRecurrence, type IStore, type ITokenStore, type Identity, type ImageFit, type ImageFormat, type ImageTransform, ImageUtils, InMemoryStore, type License, type LicenseReleaseAccess, LicenseStatus, type LineItem, type LineItemTotal, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, type OfferConditionContext, type OfferProgress, type OfferScope, OfferUtils, type OpenOrder, type Order, OrderStatus, type OrderTotal, type OwnedProduct, type Page, PasswordSetupRequiredError, type PendingPlanChange, Platform, type PricingOption, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type ProductRelease, type ProductReleaseAccess, type PromotionDisplay, type Quantifiable, type RawPropertyArray, type RawPropertyObject, type RawPropertyValue, ReleaseNotCoveredError, type SignUpOptions, type SignUpResult, type SingleOrMultiple, StoreClosedError, type Storefront, type StorefrontBundle, type StorefrontLicenseUpgrade, type StorefrontLicenseUpgradeReleaseAccess, type StorefrontOffer, type StorefrontOfferTarget, type StorefrontProduct, type StorefrontPromotion, type StorefrontPromotionCta, type StorefrontPromotionTarget, type SubscribeInput, type SubscribeResponse, type Subscription, type SubscriptionCancellationFeedback, SubscriptionCancellationReason, type SubscriptionPlanOption, type SubscriptionPlanOptions, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type UserAccountConfirmedStatus, type Vendor, type VendorCaptcha, type VendorFeatures, type Voucher, accessTokenLifetime, adClicksOf, imageWidths, isLocalStorageAvailable, isPromotionDisplay, isTransformableImageUrl, maxImageDimension, normalizeGroupIds, objectToQuery, parseOffSiteReferrer, problemDetailsSchema, promotionDisplays, resolveUtm, schemas, utmToObject, withoutClickIds };

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.11.0";
+var version = "3.12.0";
 
 // src/utils/client.ts
 function buildClientHeader(sdk) {
@@ -2990,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;
@@ -3004,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;
@@ -3066,6 +3097,7 @@ export {
   SubscriptionStatus,
   TokenStore,
   accessTokenLifetime,
+  adClicksOf,
   imageWidths,
   isLocalStorageAvailable,
   isPromotionDisplay,
@@ -3078,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.11.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",