saasco-sdk 0.1.25 → 0.1.27

package/index.cjs.js

@@ -4,9 +4,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var tslib = require('tslib');
 var uuid = require('@lukeed/uuid');
+var psl = require('psl');
 var zod = require('zod');
 
-var version = "0.1.25";
+var version = "0.1.27";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -439,7 +440,7 @@ const timezones = {
 function getBrowserContext() {
   var _a;
   const isBrowser = typeof window !== 'undefined';
-  if (!isBrowser) return;
+  if (!isBrowser) throw new Error('getBrowserContext can only be called in browser');
   const customNavigator = navigator;
   const $locale = (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.languages) && (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.languages.length) ? customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.languages[0] : (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.userLanguage) || (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.language) || (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.browserLanguage) || 'en';
   // https://caniuse.com/?search=Intl.DateTimeFormat().resolvedOptions().timeZone
@@ -468,16 +469,108 @@ function getBrowserContext() {
   };
 }
 
+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() {
+  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;
+  }
+  return undefined;
+}
+function setCookie(name, value, ttl) {
+  if (isServer) return;
+  const expires = new Date(Date.now() + ttl).toUTCString();
+  const domain = getRootDomain();
+  const cookieString = `${name}=${encodeURIComponent(value)}; expires=${expires}; path=/${domain ? `; domain=.${domain}` : ''}`;
+  document.cookie = cookieString;
+}
+function getCookie(name) {
+  if (isServer) return null;
+  const nameEQ = name + '=';
+  const ca = document.cookie.split(';');
+  for (let i = 0; i < ca.length; i++) {
+    let c = ca[i];
+    while (c.charAt(0) === ' ') c = c.substring(1, c.length);
+    if (c.indexOf(nameEQ) === 0) {
+      return decodeURIComponent(c.substring(nameEQ.length, c.length));
+    }
+  }
+  return null;
+}
+function deleteCookie(name) {
+  if (isServer) return;
+  const domain = getRootDomain();
+  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`];
+  keysToMigrate.forEach(key => {
+    try {
+      const value = localStorage.getItem(key);
+      if (value) {
+        // Parse the stored data to get the original TTL
+        const item = JSON.parse(value);
+        const now = new Date().getTime();
+        // Check if the data is still valid
+        if (item.expiry > now) {
+          // Calculate remaining TTL
+          const remainingTtl = item.expiry - now;
+          // Store in cookie with remaining TTL
+          setCookie(key, value, remainingTtl);
+          // Remove from localStorage after successful migration
+          localStorage.removeItem(key);
+        } else {
+          // Data has expired, just remove it
+          localStorage.removeItem(key);
+        }
+      }
+    } catch (error) {
+      // If there's an error parsing the data, remove the corrupted item
+      localStorage.removeItem(key);
+    }
+  });
+}
 function storeData(key, value, ttl) {
-  const item = {
-    value,
-    expiry: new Date().getTime() + ttl
-  };
   if (isServer) {
+    const item = {
+      value,
+      expiry: new Date().getTime() + ttl
+    };
     if (value === undefined) {
       delete data[key];
       return;
@@ -486,8 +579,11 @@ function storeData(key, value, ttl) {
     return;
   }
   const fullKey = `${PREF}-${key}`;
-  if (value === undefined) return window.localStorage.removeItem(fullKey);
-  localStorage.setItem(fullKey, JSON.stringify(item));
+  if (value === undefined) {
+    deleteCookie(fullKey);
+    return;
+  }
+  setCookie(fullKey, JSON.stringify(value), ttl);
 }
 function retrieveData(key) {
   if (isServer) {
@@ -500,17 +596,17 @@ function retrieveData(key) {
     return item.value;
   }
   const fullKey = `${PREF}-${key}`;
-  const itemStr = localStorage.getItem(fullKey);
+  const itemStr = getCookie(fullKey);
   if (!itemStr) {
     return null;
   }
-  const item = JSON.parse(itemStr);
-  const now = new Date();
-  if (now.getTime() > item.expiry) {
-    localStorage.removeItem(fullKey);
+  try {
+    return JSON.parse(itemStr);
+  } catch (error) {
+    // If JSON parsing fails, remove the corrupted cookie
+    deleteCookie(fullKey);
     return null;
   }
-  return item.value;
 }
 function getSessionId() {
   return retrieveData(`session-id`);
@@ -521,7 +617,7 @@ function setSessionId({
   reset: false
 }) {
   const sessionId = reset ? uuid.v4() : getSessionId() || uuid.v4();
-  storeData(`session-id`, sessionId, 1000 * 60 * 30);
+  storeData(`session-id`, sessionId, SESSION_DURATION);
 }
 function getAnonymousId() {
   return retrieveData(`anonymous-id`);
@@ -532,14 +628,31 @@ function setAnonymousId({
   reset: false
 }) {
   const anonymousId = reset ? uuid.v4() : getAnonymousId() || uuid.v4();
-  storeData(`anonymous-id`, anonymousId, 1000 * 60 * 60 * 24 * 365);
+  storeData(`anonymous-id`, anonymousId, USER_DURATION);
   return anonymousId;
 }
 function getUserId() {
   return retrieveData(`user-id`);
 }
 function setUserId(userId) {
-  storeData(`user-id`, userId, 1000 * 60 * 60 * 24 * 365);
+  storeData(`user-id`, userId, USER_DURATION);
+}
+function getSessionUTMContext() {
+  return retrieveData(`session-utm-context`);
+}
+function setSessionUTMContext(utmContext) {
+  storeData(`session-utm-context`, utmContext, 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);
+  }
+  // This will return the current data, or stored data if we have any
+  return utmContext || getSessionUTMContext() || null;
 }
 class Saasco {
   /**
@@ -579,6 +692,8 @@ class Saasco {
     if (isBrowser) {
       window.saasco = this;
     }
+    // Migrate existing localStorage data to cookies for cross-subdomain support
+    migrateFromLocalStorage();
     this.log('Saasco initialized', this.config);
     if (this.config.debug) this.log('Debug mode active. This will log all events to the console.');
     if (!this.config.enabled) this.log('Analytics is disabled. No requests will be sent to the server.');
@@ -618,8 +733,15 @@ 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 context if in the browser
-    const browserContext = isBrowser ? getBrowserContext() || {} : {};
+    // Only gets browser and utm context if in the browser
+    let browserContext;
+    let utmContext;
+    if (isBrowser) {
+      browserContext = getBrowserContext();
+      // handle session utm context and set it if it exists
+      const sessionUTMContext = handleSessionUTMContext();
+      if (sessionUTMContext) utmContext = sessionUTMContext;
+    }
     const data = {
       id: uuid.v4(),
       timestamp: new Date().toISOString(),
@@ -629,7 +751,7 @@ class Saasco {
       anonymousId,
       distinctId,
       projectId: this.config.projectId,
-      payload: JSON.stringify(Object.assign(Object.assign({}, browserContext), {
+      payload: JSON.stringify(Object.assign(Object.assign(Object.assign({}, browserContext), utmContext), {
         properties: properties || {}
       })),
       source: isBrowser ? 'client' : 'server',
@@ -712,6 +834,8 @@ class Saasco {
    *
    */
   logout() {
+    // Clear UTM data on logout
+    setSessionUTMContext(null);
     this.identify(null);
   }
   /**
@@ -837,8 +961,17 @@ const browserContextSchema = zod.z.object({
   $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()
+});
 
 exports.Saasco = Saasco;
 exports.browserContextSchema = browserContextSchema;
 exports.getBrowserContext = getBrowserContext;
+exports.getUTMContext = getUTMContext;
 exports.timezones = timezones;
+exports.utmContextSchema = utmContextSchema;

package/index.esm.js

@@ -1,8 +1,9 @@
 import { __awaiter } from 'tslib';
 import { v4 } from '@lukeed/uuid';
+import { isValid, parse } from 'psl';
 import { z } from 'zod';
 
-var version = "0.1.25";
+var version = "0.1.27";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -435,7 +436,7 @@ const timezones = {
 function getBrowserContext() {
   var _a;
   const isBrowser = typeof window !== 'undefined';
-  if (!isBrowser) return;
+  if (!isBrowser) throw new Error('getBrowserContext can only be called in browser');
   const customNavigator = navigator;
   const $locale = (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.languages) && (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.languages.length) ? customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.languages[0] : (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.userLanguage) || (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.language) || (customNavigator === null || customNavigator === void 0 ? void 0 : customNavigator.browserLanguage) || 'en';
   // https://caniuse.com/?search=Intl.DateTimeFormat().resolvedOptions().timeZone
@@ -464,16 +465,108 @@ function getBrowserContext() {
   };
 }
 
+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() {
+  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;
+  }
+  return undefined;
+}
+function setCookie(name, value, ttl) {
+  if (isServer) return;
+  const expires = new Date(Date.now() + ttl).toUTCString();
+  const domain = getRootDomain();
+  const cookieString = `${name}=${encodeURIComponent(value)}; expires=${expires}; path=/${domain ? `; domain=.${domain}` : ''}`;
+  document.cookie = cookieString;
+}
+function getCookie(name) {
+  if (isServer) return null;
+  const nameEQ = name + '=';
+  const ca = document.cookie.split(';');
+  for (let i = 0; i < ca.length; i++) {
+    let c = ca[i];
+    while (c.charAt(0) === ' ') c = c.substring(1, c.length);
+    if (c.indexOf(nameEQ) === 0) {
+      return decodeURIComponent(c.substring(nameEQ.length, c.length));
+    }
+  }
+  return null;
+}
+function deleteCookie(name) {
+  if (isServer) return;
+  const domain = getRootDomain();
+  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`];
+  keysToMigrate.forEach(key => {
+    try {
+      const value = localStorage.getItem(key);
+      if (value) {
+        // Parse the stored data to get the original TTL
+        const item = JSON.parse(value);
+        const now = new Date().getTime();
+        // Check if the data is still valid
+        if (item.expiry > now) {
+          // Calculate remaining TTL
+          const remainingTtl = item.expiry - now;
+          // Store in cookie with remaining TTL
+          setCookie(key, value, remainingTtl);
+          // Remove from localStorage after successful migration
+          localStorage.removeItem(key);
+        } else {
+          // Data has expired, just remove it
+          localStorage.removeItem(key);
+        }
+      }
+    } catch (error) {
+      // If there's an error parsing the data, remove the corrupted item
+      localStorage.removeItem(key);
+    }
+  });
+}
 function storeData(key, value, ttl) {
-  const item = {
-    value,
-    expiry: new Date().getTime() + ttl
-  };
   if (isServer) {
+    const item = {
+      value,
+      expiry: new Date().getTime() + ttl
+    };
     if (value === undefined) {
       delete data[key];
       return;
@@ -482,8 +575,11 @@ function storeData(key, value, ttl) {
     return;
   }
   const fullKey = `${PREF}-${key}`;
-  if (value === undefined) return window.localStorage.removeItem(fullKey);
-  localStorage.setItem(fullKey, JSON.stringify(item));
+  if (value === undefined) {
+    deleteCookie(fullKey);
+    return;
+  }
+  setCookie(fullKey, JSON.stringify(value), ttl);
 }
 function retrieveData(key) {
   if (isServer) {
@@ -496,17 +592,17 @@ function retrieveData(key) {
     return item.value;
   }
   const fullKey = `${PREF}-${key}`;
-  const itemStr = localStorage.getItem(fullKey);
+  const itemStr = getCookie(fullKey);
   if (!itemStr) {
     return null;
   }
-  const item = JSON.parse(itemStr);
-  const now = new Date();
-  if (now.getTime() > item.expiry) {
-    localStorage.removeItem(fullKey);
+  try {
+    return JSON.parse(itemStr);
+  } catch (error) {
+    // If JSON parsing fails, remove the corrupted cookie
+    deleteCookie(fullKey);
     return null;
   }
-  return item.value;
 }
 function getSessionId() {
   return retrieveData(`session-id`);
@@ -517,7 +613,7 @@ function setSessionId({
   reset: false
 }) {
   const sessionId = reset ? v4() : getSessionId() || v4();
-  storeData(`session-id`, sessionId, 1000 * 60 * 30);
+  storeData(`session-id`, sessionId, SESSION_DURATION);
 }
 function getAnonymousId() {
   return retrieveData(`anonymous-id`);
@@ -528,14 +624,31 @@ function setAnonymousId({
   reset: false
 }) {
   const anonymousId = reset ? v4() : getAnonymousId() || v4();
-  storeData(`anonymous-id`, anonymousId, 1000 * 60 * 60 * 24 * 365);
+  storeData(`anonymous-id`, anonymousId, USER_DURATION);
   return anonymousId;
 }
 function getUserId() {
   return retrieveData(`user-id`);
 }
 function setUserId(userId) {
-  storeData(`user-id`, userId, 1000 * 60 * 60 * 24 * 365);
+  storeData(`user-id`, userId, USER_DURATION);
+}
+function getSessionUTMContext() {
+  return retrieveData(`session-utm-context`);
+}
+function setSessionUTMContext(utmContext) {
+  storeData(`session-utm-context`, utmContext, 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);
+  }
+  // This will return the current data, or stored data if we have any
+  return utmContext || getSessionUTMContext() || null;
 }
 class Saasco {
   /**
@@ -575,6 +688,8 @@ class Saasco {
     if (isBrowser) {
       window.saasco = this;
     }
+    // Migrate existing localStorage data to cookies for cross-subdomain support
+    migrateFromLocalStorage();
     this.log('Saasco initialized', this.config);
     if (this.config.debug) this.log('Debug mode active. This will log all events to the console.');
     if (!this.config.enabled) this.log('Analytics is disabled. No requests will be sent to the server.');
@@ -614,8 +729,15 @@ 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 context if in the browser
-    const browserContext = isBrowser ? getBrowserContext() || {} : {};
+    // Only gets browser and utm context if in the browser
+    let browserContext;
+    let utmContext;
+    if (isBrowser) {
+      browserContext = getBrowserContext();
+      // handle session utm context and set it if it exists
+      const sessionUTMContext = handleSessionUTMContext();
+      if (sessionUTMContext) utmContext = sessionUTMContext;
+    }
     const data = {
       id: v4(),
       timestamp: new Date().toISOString(),
@@ -625,7 +747,7 @@ class Saasco {
       anonymousId,
       distinctId,
       projectId: this.config.projectId,
-      payload: JSON.stringify(Object.assign(Object.assign({}, browserContext), {
+      payload: JSON.stringify(Object.assign(Object.assign(Object.assign({}, browserContext), utmContext), {
         properties: properties || {}
       })),
       source: isBrowser ? 'client' : 'server',
@@ -708,6 +830,8 @@ class Saasco {
    *
    */
   logout() {
+    // Clear UTM data on logout
+    setSessionUTMContext(null);
     this.identify(null);
   }
   /**
@@ -833,5 +957,12 @@ const browserContextSchema = z.object({
   $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()
+});
 
-export { Saasco, browserContextSchema, getBrowserContext, timezones };
+export { Saasco, browserContextSchema, getBrowserContext, getUTMContext, timezones, utmContextSchema };

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "saasco-sdk",
-  "version": "0.1.25",
+  "version": "0.1.27",
   "dependencies": {
     "tslib": "^2.3.0",
     "@lukeed/uuid": "^2.0.1",
-    "zod": "^3.22.4"
+    "zod": "^3.22.4",
+    "psl": "^1.9.0"
   },
   "main": "./index.cjs.js",
   "typings": "./src/index.d.ts",

package/src/index.d.ts

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

package/src/lib/getBrowserContext.d.ts

@@ -1,2 +1,2 @@
 import { BrowserContext } from './tracking';
-export declare function getBrowserContext(): BrowserContext | undefined;
+export declare function getBrowserContext(): BrowserContext;

package/src/lib/getUTMContext.d.ts

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

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

@@ -34,3 +34,23 @@ export declare const browserContextSchema: z.ZodObject<{
     $userAgent: string;
 }>;
 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>;