@moonbase.sh/storefront-api 2.0.1 → 2.1.0

package/dist/index.cjs

@@ -46,7 +46,9 @@ __export(index_exports, {
   SubscriptionStatus: () => SubscriptionStatus,
   TokenStore: () => TokenStore,
   objectToQuery: () => objectToQuery,
+  parseOffSiteReferrer: () => parseOffSiteReferrer,
   problemDetailsSchema: () => problemDetailsSchema,
+  resolveUtm: () => resolveUtm,
   schemas: () => schemas_exports12,
   utmToObject: () => utmToObject
 });
@@ -1685,6 +1687,27 @@ var OfferUtils = class _OfferUtils {
   }
 };
 
+// src/utils/utm.ts
+function parseOffSiteReferrer(rawReferrer, currentOrigin) {
+  if (!rawReferrer)
+    return void 0;
+  try {
+    const referrerUrl = new URL(rawReferrer);
+    if (referrerUrl.origin === currentOrigin)
+      return void 0;
+    return referrerUrl.host || void 0;
+  } catch (e) {
+    return void 0;
+  }
+}
+function resolveUtm(cached, fresh) {
+  const freshHasUtm = !!(fresh.source || fresh.medium || fresh.campaign || fresh.term || fresh.content);
+  const freshIsExternalArrival = freshHasUtm || !!fresh.referrer;
+  if (freshIsExternalArrival)
+    return fresh;
+  return cached != null ? cached : fresh;
+}
+
 // src/index.ts
 var MoonbaseClient = class {
   constructor(configuration) {
@@ -1732,7 +1755,9 @@ var MoonbaseClient = class {
   SubscriptionStatus,
   TokenStore,
   objectToQuery,
+  parseOffSiteReferrer,
   problemDetailsSchema,
+  resolveUtm,
   schemas,
   utmToObject
 });

package/dist/index.d.cts

@@ -38421,6 +38421,32 @@ declare class DiscountUtils {
     static apply(discount: Discount, price: MoneyCollection): MoneyCollection;
 }
 
+/**
+ * Returns the host of `rawReferrer` if it parses as a URL with a different
+ * origin from `currentOrigin`. Returns `undefined` for same-origin (internal
+ * navigation), empty, or unparseable referrers — these should not count as
+ * attribution signals.
+ */
+declare function parseOffSiteReferrer(rawReferrer: string | undefined, currentOrigin: string): string | undefined;
+/**
+ * Resolves the effective attribution state given the cached attribution from
+ * a previous pageview and the freshly captured attribution on the current
+ * page.
+ *
+ * Model: session-last-touch with atomic attribution events. UTM fields and
+ * the referrer describe one and the same arrival, so they move together.
+ *
+ * - If the current page has any external signal — a UTM field or an off-site
+ *   referrer — that's a new attribution event and `fresh` is adopted
+ *   wholesale. No mixing with prior attribution.
+ * - Otherwise (typically internal navigation, where same-origin referrers
+ *   are filtered to undefined upstream), the cached attribution is restored
+ *   verbatim so it carries through the session.
+ * - With nothing fresh and nothing cached, the result is an empty
+ *   attribution (direct visit, no signal).
+ */
+declare function resolveUtm(cached: UrchinTrackingModule | undefined, fresh: UrchinTrackingModule): UrchinTrackingModule;
+
 interface MoonbaseConfiguration {
     endpoint: string;
     persistUtm?: boolean;
@@ -38444,4 +38470,4 @@ declare class MoonbaseClient {
     orders: OrderEndpoints;
 }
 
-export { type Activation, ActivationMethod, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type Address, type BundleLineItem, 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, InMemoryStore, type License, LicenseStatus, type LineItem, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, OfferUtils, type OpenOrder, type Order, OrderStatus, type OwnedProduct, type Page, Platform, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type Quantifiable, type RawPropertyObject, type RawPropertyValue, type SignUpResult, type SingleOrMultiple, type Storefront, type StorefrontBundle, type StorefrontOffer, type StorefrontProduct, type SubscribeInput, type SubscribeResponse, type Subscription, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type UserAccountConfirmedStatus, type Vendor, type Voucher, objectToQuery, problemDetailsSchema, schemas, utmToObject };
+export { type Activation, ActivationMethod, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type Address, type BundleLineItem, 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, InMemoryStore, type License, LicenseStatus, type LineItem, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, OfferUtils, type OpenOrder, type Order, OrderStatus, type OwnedProduct, type Page, Platform, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type Quantifiable, type RawPropertyObject, type RawPropertyValue, type SignUpResult, type SingleOrMultiple, type Storefront, type StorefrontBundle, type StorefrontOffer, type StorefrontProduct, type SubscribeInput, type SubscribeResponse, type Subscription, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type UserAccountConfirmedStatus, type Vendor, type Voucher, objectToQuery, parseOffSiteReferrer, problemDetailsSchema, resolveUtm, schemas, utmToObject };

package/dist/index.d.ts

@@ -38421,6 +38421,32 @@ declare class DiscountUtils {
     static apply(discount: Discount, price: MoneyCollection): MoneyCollection;
 }
 
+/**
+ * Returns the host of `rawReferrer` if it parses as a URL with a different
+ * origin from `currentOrigin`. Returns `undefined` for same-origin (internal
+ * navigation), empty, or unparseable referrers — these should not count as
+ * attribution signals.
+ */
+declare function parseOffSiteReferrer(rawReferrer: string | undefined, currentOrigin: string): string | undefined;
+/**
+ * Resolves the effective attribution state given the cached attribution from
+ * a previous pageview and the freshly captured attribution on the current
+ * page.
+ *
+ * Model: session-last-touch with atomic attribution events. UTM fields and
+ * the referrer describe one and the same arrival, so they move together.
+ *
+ * - If the current page has any external signal — a UTM field or an off-site
+ *   referrer — that's a new attribution event and `fresh` is adopted
+ *   wholesale. No mixing with prior attribution.
+ * - Otherwise (typically internal navigation, where same-origin referrers
+ *   are filtered to undefined upstream), the cached attribution is restored
+ *   verbatim so it carries through the session.
+ * - With nothing fresh and nothing cached, the result is an empty
+ *   attribution (direct visit, no signal).
+ */
+declare function resolveUtm(cached: UrchinTrackingModule | undefined, fresh: UrchinTrackingModule): UrchinTrackingModule;
+
 interface MoonbaseConfiguration {
     endpoint: string;
     persistUtm?: boolean;
@@ -38444,4 +38470,4 @@ declare class MoonbaseClient {
     orders: OrderEndpoints;
 }
 
-export { type Activation, ActivationMethod, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type Address, type BundleLineItem, 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, InMemoryStore, type License, LicenseStatus, type LineItem, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, OfferUtils, type OpenOrder, type Order, OrderStatus, type OwnedProduct, type Page, Platform, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type Quantifiable, type RawPropertyObject, type RawPropertyValue, type SignUpResult, type SingleOrMultiple, type Storefront, type StorefrontBundle, type StorefrontOffer, type StorefrontProduct, type SubscribeInput, type SubscribeResponse, type Subscription, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type UserAccountConfirmedStatus, type Vendor, type Voucher, objectToQuery, problemDetailsSchema, schemas, utmToObject };
+export { type Activation, ActivationMethod, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type Address, type BundleLineItem, 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, InMemoryStore, type License, LicenseStatus, type LineItem, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, OfferUtils, type OpenOrder, type Order, OrderStatus, type OwnedProduct, type Page, Platform, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type Quantifiable, type RawPropertyObject, type RawPropertyValue, type SignUpResult, type SingleOrMultiple, type Storefront, type StorefrontBundle, type StorefrontOffer, type StorefrontProduct, type SubscribeInput, type SubscribeResponse, type Subscription, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type UserAccountConfirmedStatus, type Vendor, type Voucher, objectToQuery, parseOffSiteReferrer, problemDetailsSchema, resolveUtm, schemas, utmToObject };

package/dist/index.js

@@ -1637,6 +1637,27 @@ var OfferUtils = class _OfferUtils {
   }
 };
 
+// src/utils/utm.ts
+function parseOffSiteReferrer(rawReferrer, currentOrigin) {
+  if (!rawReferrer)
+    return void 0;
+  try {
+    const referrerUrl = new URL(rawReferrer);
+    if (referrerUrl.origin === currentOrigin)
+      return void 0;
+    return referrerUrl.host || void 0;
+  } catch (e) {
+    return void 0;
+  }
+}
+function resolveUtm(cached, fresh) {
+  const freshHasUtm = !!(fresh.source || fresh.medium || fresh.campaign || fresh.term || fresh.content);
+  const freshIsExternalArrival = freshHasUtm || !!fresh.referrer;
+  if (freshIsExternalArrival)
+    return fresh;
+  return cached != null ? cached : fresh;
+}
+
 // src/index.ts
 var MoonbaseClient = class {
   constructor(configuration) {
@@ -1683,7 +1704,9 @@ export {
   SubscriptionStatus,
   TokenStore,
   objectToQuery,
+  parseOffSiteReferrer,
   problemDetailsSchema,
+  resolveUtm,
   schemas_exports12 as schemas,
   utmToObject
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@moonbase.sh/storefront-api",
   "type": "module",
-  "version": "2.0.1",
+  "version": "2.1.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",