saasco-sdk 0.1.29 → 0.1.30

package/index.cjs.js

@@ -7,7 +7,7 @@ var uuid = require('@lukeed/uuid');
 var psl = require('psl');
 var zod = require('zod');
 
-var version = "0.1.29";
+var version = "0.1.30";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -455,6 +455,17 @@ function getBrowserContext() {
   const $screenWidth = screen.width;
   const $title = document.title;
   const $userAgent = window.navigator.userAgent;
+  const params = new URLSearchParams(window.location.search);
+  const $utmSource = params.get('utm_source');
+  const $utmMedium = params.get('utm_medium');
+  const $utmCampaign = params.get('utm_campaign');
+  const $utmTerm = params.get('utm_term');
+  const $utmContent = params.get('utm_content');
+  const $utmId = params.get('utm_id');
+  const $utmSourcePlatform = params.get('utm_source_platform');
+  const $utmCampaignId = params.get('utm_campaign_id');
+  const $utmCreativeFormat = params.get('utm_creative_format');
+  const $utmMarketingTactic = params.get('utm_marketing_tactic');
   return {
     $locale,
     $location,
@@ -465,55 +476,43 @@ function getBrowserContext() {
     $screenHeight,
     $screenWidth,
     $title,
-    $userAgent
+    $userAgent,
+    $utmSource,
+    $utmMedium,
+    $utmCampaign,
+    $utmTerm,
+    $utmContent,
+    $utmId,
+    $utmSourcePlatform,
+    $utmCampaignId,
+    $utmCreativeFormat,
+    $utmMarketingTactic
   };
 }
 
-function getUTMContext() {
-  const isBrowser = typeof window !== 'undefined';
-  if (!isBrowser) throw new Error('getUTMContext can only be called in browser');
-  const params = new URLSearchParams(window.location.search);
-  const $utmSource = params.get('utm_source');
-  const $utmMedium = params.get('utm_medium');
-  const $utmCampaign = params.get('utm_campaign');
-  const $utmTerm = params.get('utm_term');
-  const $utmContent = params.get('utm_content');
-  return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, $utmSource ? {
-    $utmSource
-  } : {}), $utmMedium ? {
-    $utmMedium
-  } : {}), $utmCampaign ? {
-    $utmCampaign
-  } : {}), $utmTerm ? {
-    $utmTerm
-  } : {}), $utmContent ? {
-    $utmContent
-  } : {});
-}
-
 const isBrowser = typeof window !== 'undefined';
 const isServer = !isBrowser;
 const PREF = 'saasco-sdk';
 const SESSION_DURATION = 1000 * 60 * 30;
 const USER_DURATION = 1000 * 60 * 60 * 24 * 365;
 const data = {};
-function getRootDomain() {
+function getRootDomain(url) {
   if (isServer) return;
-  const hostname = window.location.hostname;
-  if (!psl.isValid(hostname)) {
-    // If not a valid domain, don't set domain (for localhost, IP addresses, etc.)
-    return undefined;
-  }
-  const parsed = psl.parse(hostname);
-  if ('domain' in parsed && parsed.domain) {
-    return parsed.domain;
+  if (!url) return;
+  try {
+    const hostname = new URL(url).hostname;
+    if (!psl.isValid(hostname)) return;
+    const parsed = psl.parse(hostname);
+    if ('domain' in parsed && parsed.domain) return parsed.domain;
+  } catch (error) {
+    // invalid url
   }
-  return undefined;
+  return;
 }
 function setCookie(name, value, ttl) {
   if (isServer) return;
   const expires = new Date(Date.now() + ttl).toUTCString();
-  const domain = getRootDomain();
+  const domain = getRootDomain(window.location.href);
   const cookieString = `${name}=${encodeURIComponent(value)}; expires=${expires}; path=/${domain ? `; domain=.${domain}` : ''}`;
   document.cookie = cookieString;
 }
@@ -532,13 +531,13 @@ function getCookie(name) {
 }
 function deleteCookie(name) {
   if (isServer) return;
-  const domain = getRootDomain();
+  const domain = getRootDomain(window.location.href);
   const cookieString = `${name}=; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/${domain ? `; domain=.${domain}` : ''}`;
   document.cookie = cookieString;
 }
 function migrateFromLocalStorage() {
   if (isServer) return;
-  const keysToMigrate = [`${PREF}-session-id`, `${PREF}-anonymous-id`, `${PREF}-user-id`, `${PREF}-session-utm-context`];
+  const keysToMigrate = [`${PREF}-session-id`, `${PREF}-anonymous-id`, `${PREF}-user-id`, `${PREF}-session-utm-context`, `${PREF}-super-context`];
   keysToMigrate.forEach(key => {
     try {
       const value = localStorage.getItem(key);
@@ -646,22 +645,31 @@ function getUserId() {
 function setUserId(userId) {
   storeData(`user-id`, userId, USER_DURATION);
 }
-function getSessionUTMContext() {
-  return retrieveData(`session-utm-context`);
+function getSuperContext() {
+  return retrieveData('super-context') || {};
 }
-function setSessionUTMContext(utmContext) {
-  storeData(`session-utm-context`, utmContext, SESSION_DURATION);
+function setSuperContext(superContext) {
+  storeData('super-context', superContext, SESSION_DURATION);
 }
-function handleSessionUTMContext() {
-  if (isServer) return null;
-  const utmContext = getUTMContext();
-  // If we have any utm data its current so we store it
-  const utmContextKeys = Object.keys(utmContext);
-  if (utmContextKeys.length > 0) {
-    setSessionUTMContext(utmContext);
+function updateSuperContext(browserContext) {
+  const existingSuperContext = getSuperContext();
+  const defaultSuperContextKeys = ['$utmSource', '$utmMedium', '$utmCampaign', '$utmTerm', '$utmContent', '$utmId', '$utmSourcePlatform', '$utmCampaignId', '$utmCreativeFormat', '$utmMarketingTactic'];
+  const superContext = defaultSuperContextKeys.reduce((acc, key) => {
+    const value = Object.assign({}, browserContext)[key];
+    if (value) acc[key] = value;
+    return acc;
+  }, existingSuperContext);
+  // Only set referrer if it's from a different root domain
+  // Prevents setting referrer when going between subdomains of the same root domain
+  if (browserContext.$referrer) {
+    const referrerRootDomain = getRootDomain(browserContext.$referrer);
+    const currentRootDomain = getRootDomain(browserContext.$href);
+    if (referrerRootDomain && currentRootDomain && referrerRootDomain !== currentRootDomain) {
+      superContext['$referrer'] = browserContext.$referrer;
+    }
   }
-  // This will return the current data, or stored data if we have any
-  return utmContext || getSessionUTMContext() || null;
+  setSuperContext(superContext);
+  return superContext;
 }
 class Saasco {
   /**
@@ -742,15 +750,16 @@ class Saasco {
     const sessionId = (hasAction ? undefined : actionOrPayload.sessionId) || getSessionId();
     const anonymousId = (hasAction ? undefined : actionOrPayload.anonymousId) || getAnonymousId();
     const distinctId = (hasAction ? undefined : actionOrPayload.userId) || getUserId();
-    // Only gets browser and utm context if in the browser
+    // Only gets browser and super context if in the browser
     let browserContext;
-    let utmContext;
+    let superContext;
     if (isBrowser) {
       browserContext = getBrowserContext();
-      // handle session utm context and set it if it exists
-      const sessionUTMContext = handleSessionUTMContext();
-      if (sessionUTMContext) utmContext = sessionUTMContext;
+      superContext = updateSuperContext(browserContext);
     }
+    const payloadJSON = Object.assign(Object.assign(Object.assign({}, browserContext), superContext), {
+      properties: properties || {}
+    });
     const data = {
       id: uuid.v4(),
       timestamp: new Date().toISOString(),
@@ -760,9 +769,7 @@ class Saasco {
       anonymousId,
       distinctId,
       projectId: this.config.projectId,
-      payload: JSON.stringify(Object.assign(Object.assign(Object.assign({}, browserContext), utmContext), {
-        properties: properties || {}
-      })),
+      payload: JSON.stringify(payloadJSON),
       source: isBrowser ? 'client' : 'server',
       context: JSON.stringify(context || {})
     };
@@ -843,8 +850,8 @@ class Saasco {
    *
    */
   logout() {
-    // Clear UTM data on logout
-    setSessionUTMContext(null);
+    // Clear super context data on logout
+    setSuperContext(null);
     this.identify(null);
   }
   /**
@@ -968,19 +975,20 @@ const browserContextSchema = zod.z.object({
   $screenHeight: zod.z.number(),
   $screenWidth: zod.z.number(),
   $title: zod.z.string(),
-  $userAgent: zod.z.string()
-});
-const utmContextSchema = zod.z.object({
-  $utmSource: zod.z.string().optional(),
-  $utmMedium: zod.z.string().optional(),
-  $utmCampaign: zod.z.string().optional(),
-  $utmTerm: zod.z.string().optional(),
-  $utmContent: zod.z.string().optional()
+  $userAgent: zod.z.string(),
+  $utmSource: zod.z.string().nullable(),
+  $utmMedium: zod.z.string().nullable(),
+  $utmCampaign: zod.z.string().nullable(),
+  $utmTerm: zod.z.string().nullable(),
+  $utmContent: zod.z.string().nullable(),
+  $utmId: zod.z.string().nullable(),
+  $utmSourcePlatform: zod.z.string().nullable(),
+  $utmCampaignId: zod.z.string().nullable(),
+  $utmCreativeFormat: zod.z.string().nullable(),
+  $utmMarketingTactic: zod.z.string().nullable()
 });
 
 exports.Saasco = Saasco;
 exports.browserContextSchema = browserContextSchema;
 exports.getBrowserContext = getBrowserContext;
-exports.getUTMContext = getUTMContext;
 exports.timezones = timezones;
-exports.utmContextSchema = utmContextSchema;

package/index.esm.js

@@ -3,7 +3,7 @@ import { v4 } from '@lukeed/uuid';
 import { isValid, parse } from 'psl';
 import { z } from 'zod';
 
-var version = "0.1.29";
+var version = "0.1.30";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -451,6 +451,17 @@ function getBrowserContext() {
   const $screenWidth = screen.width;
   const $title = document.title;
   const $userAgent = window.navigator.userAgent;
+  const params = new URLSearchParams(window.location.search);
+  const $utmSource = params.get('utm_source');
+  const $utmMedium = params.get('utm_medium');
+  const $utmCampaign = params.get('utm_campaign');
+  const $utmTerm = params.get('utm_term');
+  const $utmContent = params.get('utm_content');
+  const $utmId = params.get('utm_id');
+  const $utmSourcePlatform = params.get('utm_source_platform');
+  const $utmCampaignId = params.get('utm_campaign_id');
+  const $utmCreativeFormat = params.get('utm_creative_format');
+  const $utmMarketingTactic = params.get('utm_marketing_tactic');
   return {
     $locale,
     $location,
@@ -461,55 +472,43 @@ function getBrowserContext() {
     $screenHeight,
     $screenWidth,
     $title,
-    $userAgent
+    $userAgent,
+    $utmSource,
+    $utmMedium,
+    $utmCampaign,
+    $utmTerm,
+    $utmContent,
+    $utmId,
+    $utmSourcePlatform,
+    $utmCampaignId,
+    $utmCreativeFormat,
+    $utmMarketingTactic
   };
 }
 
-function getUTMContext() {
-  const isBrowser = typeof window !== 'undefined';
-  if (!isBrowser) throw new Error('getUTMContext can only be called in browser');
-  const params = new URLSearchParams(window.location.search);
-  const $utmSource = params.get('utm_source');
-  const $utmMedium = params.get('utm_medium');
-  const $utmCampaign = params.get('utm_campaign');
-  const $utmTerm = params.get('utm_term');
-  const $utmContent = params.get('utm_content');
-  return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, $utmSource ? {
-    $utmSource
-  } : {}), $utmMedium ? {
-    $utmMedium
-  } : {}), $utmCampaign ? {
-    $utmCampaign
-  } : {}), $utmTerm ? {
-    $utmTerm
-  } : {}), $utmContent ? {
-    $utmContent
-  } : {});
-}
-
 const isBrowser = typeof window !== 'undefined';
 const isServer = !isBrowser;
 const PREF = 'saasco-sdk';
 const SESSION_DURATION = 1000 * 60 * 30;
 const USER_DURATION = 1000 * 60 * 60 * 24 * 365;
 const data = {};
-function getRootDomain() {
+function getRootDomain(url) {
   if (isServer) return;
-  const hostname = window.location.hostname;
-  if (!isValid(hostname)) {
-    // If not a valid domain, don't set domain (for localhost, IP addresses, etc.)
-    return undefined;
-  }
-  const parsed = parse(hostname);
-  if ('domain' in parsed && parsed.domain) {
-    return parsed.domain;
+  if (!url) return;
+  try {
+    const hostname = new URL(url).hostname;
+    if (!isValid(hostname)) return;
+    const parsed = parse(hostname);
+    if ('domain' in parsed && parsed.domain) return parsed.domain;
+  } catch (error) {
+    // invalid url
   }
-  return undefined;
+  return;
 }
 function setCookie(name, value, ttl) {
   if (isServer) return;
   const expires = new Date(Date.now() + ttl).toUTCString();
-  const domain = getRootDomain();
+  const domain = getRootDomain(window.location.href);
   const cookieString = `${name}=${encodeURIComponent(value)}; expires=${expires}; path=/${domain ? `; domain=.${domain}` : ''}`;
   document.cookie = cookieString;
 }
@@ -528,13 +527,13 @@ function getCookie(name) {
 }
 function deleteCookie(name) {
   if (isServer) return;
-  const domain = getRootDomain();
+  const domain = getRootDomain(window.location.href);
   const cookieString = `${name}=; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/${domain ? `; domain=.${domain}` : ''}`;
   document.cookie = cookieString;
 }
 function migrateFromLocalStorage() {
   if (isServer) return;
-  const keysToMigrate = [`${PREF}-session-id`, `${PREF}-anonymous-id`, `${PREF}-user-id`, `${PREF}-session-utm-context`];
+  const keysToMigrate = [`${PREF}-session-id`, `${PREF}-anonymous-id`, `${PREF}-user-id`, `${PREF}-session-utm-context`, `${PREF}-super-context`];
   keysToMigrate.forEach(key => {
     try {
       const value = localStorage.getItem(key);
@@ -642,22 +641,31 @@ function getUserId() {
 function setUserId(userId) {
   storeData(`user-id`, userId, USER_DURATION);
 }
-function getSessionUTMContext() {
-  return retrieveData(`session-utm-context`);
+function getSuperContext() {
+  return retrieveData('super-context') || {};
 }
-function setSessionUTMContext(utmContext) {
-  storeData(`session-utm-context`, utmContext, SESSION_DURATION);
+function setSuperContext(superContext) {
+  storeData('super-context', superContext, SESSION_DURATION);
 }
-function handleSessionUTMContext() {
-  if (isServer) return null;
-  const utmContext = getUTMContext();
-  // If we have any utm data its current so we store it
-  const utmContextKeys = Object.keys(utmContext);
-  if (utmContextKeys.length > 0) {
-    setSessionUTMContext(utmContext);
+function updateSuperContext(browserContext) {
+  const existingSuperContext = getSuperContext();
+  const defaultSuperContextKeys = ['$utmSource', '$utmMedium', '$utmCampaign', '$utmTerm', '$utmContent', '$utmId', '$utmSourcePlatform', '$utmCampaignId', '$utmCreativeFormat', '$utmMarketingTactic'];
+  const superContext = defaultSuperContextKeys.reduce((acc, key) => {
+    const value = Object.assign({}, browserContext)[key];
+    if (value) acc[key] = value;
+    return acc;
+  }, existingSuperContext);
+  // Only set referrer if it's from a different root domain
+  // Prevents setting referrer when going between subdomains of the same root domain
+  if (browserContext.$referrer) {
+    const referrerRootDomain = getRootDomain(browserContext.$referrer);
+    const currentRootDomain = getRootDomain(browserContext.$href);
+    if (referrerRootDomain && currentRootDomain && referrerRootDomain !== currentRootDomain) {
+      superContext['$referrer'] = browserContext.$referrer;
+    }
   }
-  // This will return the current data, or stored data if we have any
-  return utmContext || getSessionUTMContext() || null;
+  setSuperContext(superContext);
+  return superContext;
 }
 class Saasco {
   /**
@@ -738,15 +746,16 @@ class Saasco {
     const sessionId = (hasAction ? undefined : actionOrPayload.sessionId) || getSessionId();
     const anonymousId = (hasAction ? undefined : actionOrPayload.anonymousId) || getAnonymousId();
     const distinctId = (hasAction ? undefined : actionOrPayload.userId) || getUserId();
-    // Only gets browser and utm context if in the browser
+    // Only gets browser and super context if in the browser
     let browserContext;
-    let utmContext;
+    let superContext;
     if (isBrowser) {
       browserContext = getBrowserContext();
-      // handle session utm context and set it if it exists
-      const sessionUTMContext = handleSessionUTMContext();
-      if (sessionUTMContext) utmContext = sessionUTMContext;
+      superContext = updateSuperContext(browserContext);
     }
+    const payloadJSON = Object.assign(Object.assign(Object.assign({}, browserContext), superContext), {
+      properties: properties || {}
+    });
     const data = {
       id: v4(),
       timestamp: new Date().toISOString(),
@@ -756,9 +765,7 @@ class Saasco {
       anonymousId,
       distinctId,
       projectId: this.config.projectId,
-      payload: JSON.stringify(Object.assign(Object.assign(Object.assign({}, browserContext), utmContext), {
-        properties: properties || {}
-      })),
+      payload: JSON.stringify(payloadJSON),
       source: isBrowser ? 'client' : 'server',
       context: JSON.stringify(context || {})
     };
@@ -839,8 +846,8 @@ class Saasco {
    *
    */
   logout() {
-    // Clear UTM data on logout
-    setSessionUTMContext(null);
+    // Clear super context data on logout
+    setSuperContext(null);
     this.identify(null);
   }
   /**
@@ -964,14 +971,17 @@ const browserContextSchema = z.object({
   $screenHeight: z.number(),
   $screenWidth: z.number(),
   $title: z.string(),
-  $userAgent: z.string()
-});
-const utmContextSchema = z.object({
-  $utmSource: z.string().optional(),
-  $utmMedium: z.string().optional(),
-  $utmCampaign: z.string().optional(),
-  $utmTerm: z.string().optional(),
-  $utmContent: z.string().optional()
+  $userAgent: z.string(),
+  $utmSource: z.string().nullable(),
+  $utmMedium: z.string().nullable(),
+  $utmCampaign: z.string().nullable(),
+  $utmTerm: z.string().nullable(),
+  $utmContent: z.string().nullable(),
+  $utmId: z.string().nullable(),
+  $utmSourcePlatform: z.string().nullable(),
+  $utmCampaignId: z.string().nullable(),
+  $utmCreativeFormat: z.string().nullable(),
+  $utmMarketingTactic: z.string().nullable()
 });
 
-export { Saasco, browserContextSchema, getBrowserContext, getUTMContext, timezones, utmContextSchema };
+export { Saasco, browserContextSchema, getBrowserContext, timezones };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "saasco-sdk",
-  "version": "0.1.29",
+  "version": "0.1.30",
   "dependencies": {
     "tslib": "^2.3.0",
     "@lukeed/uuid": "^2.0.1",

package/src/index.d.ts

@@ -1,5 +1,4 @@
 export * from './lib/analytics';
 export * from './lib/getBrowserContext';
-export * from './lib/getUTMContext';
 export * from './lib/tracking';
 export * from './lib/timezones';

package/src/lib/tracking/types.d.ts

@@ -10,6 +10,16 @@ export declare const browserContextSchema: z.ZodObject<{
     $screenWidth: z.ZodNumber;
     $title: z.ZodString;
     $userAgent: z.ZodString;
+    $utmSource: z.ZodNullable<z.ZodString>;
+    $utmMedium: z.ZodNullable<z.ZodString>;
+    $utmCampaign: z.ZodNullable<z.ZodString>;
+    $utmTerm: z.ZodNullable<z.ZodString>;
+    $utmContent: z.ZodNullable<z.ZodString>;
+    $utmId: z.ZodNullable<z.ZodString>;
+    $utmSourcePlatform: z.ZodNullable<z.ZodString>;
+    $utmCampaignId: z.ZodNullable<z.ZodString>;
+    $utmCreativeFormat: z.ZodNullable<z.ZodString>;
+    $utmMarketingTactic: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     $locale: string;
     $location: string;
@@ -21,6 +31,16 @@ export declare const browserContextSchema: z.ZodObject<{
     $screenWidth: number;
     $title: string;
     $userAgent: string;
+    $utmSource: string | null;
+    $utmMedium: string | null;
+    $utmCampaign: string | null;
+    $utmTerm: string | null;
+    $utmContent: string | null;
+    $utmId: string | null;
+    $utmSourcePlatform: string | null;
+    $utmCampaignId: string | null;
+    $utmCreativeFormat: string | null;
+    $utmMarketingTactic: string | null;
 }, {
     $locale: string;
     $location: string;
@@ -32,25 +52,16 @@ export declare const browserContextSchema: z.ZodObject<{
     $screenWidth: number;
     $title: string;
     $userAgent: string;
+    $utmSource: string | null;
+    $utmMedium: string | null;
+    $utmCampaign: string | null;
+    $utmTerm: string | null;
+    $utmContent: string | null;
+    $utmId: string | null;
+    $utmSourcePlatform: string | null;
+    $utmCampaignId: string | null;
+    $utmCreativeFormat: string | null;
+    $utmMarketingTactic: string | null;
 }>;
 export type BrowserContext = z.infer<typeof browserContextSchema>;
-export declare const utmContextSchema: z.ZodObject<{
-    $utmSource: z.ZodOptional<z.ZodString>;
-    $utmMedium: z.ZodOptional<z.ZodString>;
-    $utmCampaign: z.ZodOptional<z.ZodString>;
-    $utmTerm: z.ZodOptional<z.ZodString>;
-    $utmContent: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    $utmSource?: string | undefined;
-    $utmMedium?: string | undefined;
-    $utmCampaign?: string | undefined;
-    $utmTerm?: string | undefined;
-    $utmContent?: string | undefined;
-}, {
-    $utmSource?: string | undefined;
-    $utmMedium?: string | undefined;
-    $utmCampaign?: string | undefined;
-    $utmTerm?: string | undefined;
-    $utmContent?: string | undefined;
-}>;
-export type UTMContext = z.infer<typeof utmContextSchema>;
+export type SuperContext = Record<string, any>;

package/src/lib/getUTMContext.d.ts

@@ -1,2 +0,0 @@
-import { UTMContext } from './tracking';
-export declare function getUTMContext(): UTMContext;