saasco-sdk 0.1.24 → 0.1.26

package/index.cjs.js

@@ -6,7 +6,7 @@ var tslib = require('tslib');
 var uuid = require('@lukeed/uuid');
 var zod = require('zod');
 
-var version = "0.1.24";
+var version = "0.1.26";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -439,7 +439,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,9 +468,33 @@ 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 storeData(key, value, ttl) {
   const item = {
@@ -521,7 +545,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 +556,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 {
   /**
@@ -618,8 +659,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 +677,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 +760,8 @@ class Saasco {
    *
    */
   logout() {
+    // Clear UTM data on logout
+    setSessionUTMContext(null);
     this.identify(null);
   }
   /**
@@ -837,8 +887,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

@@ -2,7 +2,7 @@ import { __awaiter } from 'tslib';
 import { v4 } from '@lukeed/uuid';
 import { z } from 'zod';
 
-var version = "0.1.24";
+var version = "0.1.26";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -435,7 +435,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,9 +464,33 @@ 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 storeData(key, value, ttl) {
   const item = {
@@ -517,7 +541,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 +552,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 {
   /**
@@ -614,8 +655,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 +673,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 +756,8 @@ class Saasco {
    *
    */
   logout() {
+    // Clear UTM data on logout
+    setSessionUTMContext(null);
     this.identify(null);
   }
   /**
@@ -833,5 +883,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,6 +1,6 @@
 {
   "name": "saasco-sdk",
-  "version": "0.1.24",
+  "version": "0.1.26",
   "dependencies": {
     "tslib": "^2.3.0",
     "@lukeed/uuid": "^2.0.1",

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/analytics.d.ts

@@ -11,11 +11,14 @@ type Identity = {
     anonymousId: string | number;
     userId?: string | number;
 };
+type Context = {
+    active?: boolean;
+};
 type TrackPayload = Identity & {
     event: string;
     sessionId?: string;
     properties?: Record<string, any>;
-    context?: Record<string, any>;
+    context?: Context;
 };
 type DoRequestResponse = {
     success: boolean;
@@ -55,9 +58,7 @@ export declare class Saasco {
      * Client: track('User Signed Up', { plan: 'Pro' }, { source: 'client' })
      * Server: track({ event: 'User Signed Up', userId: 'user_123', properties: { plan: 'Pro' } })
      */
-    track(action: string, properties?: Record<string, any>, context?: {
-        active?: boolean;
-    }): Promise<DoRequestResponse>;
+    track(action: string, properties?: Record<string, any>, context?: Context): Promise<DoRequestResponse>;
     track(payload: TrackPayload): Promise<DoRequestResponse>;
     /**
      * The page method lets you record page views on your website
@@ -75,12 +76,8 @@ export declare class Saasco {
      * @param properties A dictionary of traits you know about the user like their email, name, plan etc.
      * @param context Context for the identify call such as whether the user is active.
      */
-    identify(properties: Record<string, any>, context?: {
-        active?: boolean;
-    }): Promise<DoRequestResponse>;
-    identify(distinctId: string | number | null, properties?: Record<string, any>, context?: {
-        active?: boolean;
-    }): Promise<DoRequestResponse>;
+    identify(properties: Record<string, any>, context?: Context): Promise<DoRequestResponse>;
+    identify(distinctId: string | number | null, properties?: Record<string, any>, context?: Context): Promise<DoRequestResponse>;
     /**
      * This should only be called when the user logs out
      * It will reset the session, anonymous id, and user id

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>;