saasco-sdk 0.1.13 → 0.1.15

package/index.esm.js

@@ -2,6 +2,8 @@ import { __awaiter } from 'tslib';
 import { v4 } from '@lukeed/uuid';
 import { z } from 'zod';
 
+var version = "0.1.15";
+
 const timezones = {
   'Asia/Barnaul': 'RU',
   'Africa/Nouakchott': 'MR',
@@ -430,10 +432,39 @@ const timezones = {
   'Asia/Calcutta': 'IN'
 };
 
-var version = "0.1.13";
+function getBrowserContext() {
+  var _a;
+  const isBrowser = typeof window !== 'undefined';
+  if (!isBrowser) return;
+  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
+  // Only has 96.63% global support, so we need to check for undefined
+  const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+  const $location = timezones[timezone] || ((_a = $locale === null || $locale === void 0 ? void 0 : $locale.split('-')) === null || _a === void 0 ? void 0 : _a[1]) || 'undefined';
+  const $href = window.location.href;
+  const $pathname = window.location.pathname;
+  const $referrer = document.referrer;
+  const $screenDPI = window.devicePixelRatio;
+  const $screenHeight = screen.height;
+  const $screenWidth = screen.width;
+  const $title = document.title;
+  const $userAgent = window.navigator.userAgent;
+  return {
+    $locale,
+    $location,
+    $href,
+    $pathname,
+    $referrer,
+    $screenDPI,
+    $screenHeight,
+    $screenWidth,
+    $title,
+    $userAgent
+  };
+}
 
 const isBrowser = typeof window !== 'undefined';
-let userId = null;
 const PREF = 'saasco-sdk';
 const data = {};
 function storeData(key, value, ttl) {
@@ -499,35 +530,11 @@ function setAnonmousId({
   storeData(`anonymous-id`, anonymousId, 1000 * 60 * 60 * 24 * 365);
   return anonymousId;
 }
-function getBrowserContext() {
-  var _a;
-  if (!isBrowser) return {};
-  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
-  // Only has 96.63% global support, so we need to check for undefined
-  const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
-  const $location = timezones[timezone] || ((_a = $locale === null || $locale === void 0 ? void 0 : $locale.split('-')) === null || _a === void 0 ? void 0 : _a[1]) || 'undefined';
-  const $href = window.location.href;
-  const $pathname = window.location.pathname;
-  const $referrer = document.referrer;
-  const $screenDPI = window.devicePixelRatio;
-  const $screenHeight = screen.height;
-  const $screenWidth = screen.width;
-  const $title = document.title;
-  const $userAgent = window.navigator.userAgent;
-  return {
-    $locale,
-    $location,
-    $href,
-    $pathname,
-    $referrer,
-    $screenDPI,
-    $screenHeight,
-    $screenWidth,
-    $title,
-    $userAgent
-  };
+function getUserId() {
+  return retrieveData(`user-id`);
+}
+function setUserId(userId) {
+  storeData(`user-id`, userId, 1000 * 60 * 60 * 24 * 365);
 }
 class Saasco {
   /**
@@ -538,10 +545,12 @@ class Saasco {
    * @param config.autoPageTracking Whether to automatically track page views. Default is false.
    * @param config.enabled Whether analytics is enabled. Default is true. Set to false for development and staging envioronments. Will still allow debug mode to be true, just no events will be sent
    * @param config.debug Whether to log debug information. Default is false.
+   * @param config.trackUrlParams Whether to track URL parameters. Default is true.
+   * @param config.trackHashChanges Whether to track hash changes. Default is true.
    */
   constructor(config) {
     this.config = config;
-    this.lastPageViewHref = '';
+    this.lastPageViewPath = '';
     this.isInitialized = false;
     if (!config.projectId) {
       this.error("Project ID is required but has not been provided. If you are using an env variable make sure it's set correctly.");
@@ -549,6 +558,9 @@ class Saasco {
     }
     // default enabled to true
     this.config.enabled = this.config.enabled === undefined ? true : this.config.enabled;
+    // default URL tracking options
+    this.config.trackUrlParams = this.config.trackUrlParams === undefined ? true : this.config.trackUrlParams;
+    this.config.trackHashChanges = this.config.trackHashChanges === undefined ? true : this.config.trackHashChanges;
   }
   init() {
     if (this.isInitialized) {
@@ -586,16 +598,6 @@ class Saasco {
     if (!this.config.projectId) {
       return this.error("Unable to track event. Project ID is required but has not been provided. If you are using an env variable make sure it's set correctly.");
     }
-    // Prevent duplicate Page View tracking
-    if (name === 'Page View') {
-      if (!isBrowser) {
-        console.warn('Saasco page tracking is only available in the browser');
-        return;
-      }
-      const pageViewHref = window.location.href;
-      if (pageViewHref === this.lastPageViewHref) return;
-      this.lastPageViewHref = pageViewHref;
-    }
     setSessionId();
     setAnonmousId();
     const browserContext = getBrowserContext();
@@ -606,9 +608,9 @@ class Saasco {
       version,
       sessionId: getSessionId(),
       anonymousId: getAnonymousId(),
-      distinctId: userId,
+      distinctId: getUserId(),
       projectId: this.config.projectId,
-      payload: JSON.stringify(Object.assign(Object.assign({}, browserContext), {
+      payload: JSON.stringify(Object.assign(Object.assign({}, browserContext || {}), {
         properties: properties || {}
       })),
       context: JSON.stringify(context || {})
@@ -622,6 +624,23 @@ class Saasco {
    * Before implementing this make sure you have disabled the autoPageTracking in the config or you will get duplicate page views
    */
   page() {
+    if (!isBrowser) {
+      console.warn('Saasco page tracking is only available in the browser');
+      return;
+    }
+    const url = new URL(window.location.href);
+    let pathToCompare = url.pathname;
+    // Include search params if configured
+    if (this.config.trackUrlParams) {
+      pathToCompare += url.search;
+    }
+    // Include hash if configured
+    if (this.config.trackHashChanges) {
+      pathToCompare += url.hash;
+    }
+    // Only track if the path has changed
+    if (pathToCompare === this.lastPageViewPath) return;
+    this.lastPageViewPath = pathToCompare;
     return this.track('Page View');
   }
   identify(distinctIdOrProperties, propertiesOrContext, contextOrNothing) {
@@ -635,7 +654,7 @@ class Saasco {
     // When the user gets identified as null this will reset the users session and anonymous id
     // This should only be called when distinctId is null and there is an existing userId.
     // This means the user has logged out and we should reset the session and anonymous IDs
-    const userIdChangedToNull = distinctId === null && !!userId;
+    const userIdChangedToNull = distinctId === null && !!getUserId();
     if (userIdChangedToNull) this.log('User ID change to null. Session reset');
     const reset = userIdChangedToNull;
     setSessionId({
@@ -645,7 +664,7 @@ class Saasco {
       reset
     });
     // set the distinct Id to the userId
-    userId = distinctId;
+    setUserId(distinctId);
     // No distinctId provided so we don't track the user
     if (!distinctId) return;
     const data = {
@@ -805,6 +824,9 @@ function coerceReservedProperties(properties) {
   }, {
     key: 'displayName',
     coerceFrom: ['display_name', 'displayName', 'user_display_name', 'userDisplayName', 'full_name', 'fullName', 'user_full_name', 'userFullName', 'complete_name', 'completeName', 'user_complete_name', 'userCompleteName', 'name', 'username']
+  }, {
+    key: '$stripeCustomerId',
+    coerceFrom: ['stripe_customer_id', 'stripeCustomerId', 'stripe_customer_id', 'stripeCustomerId', 'stripe_customer_id', 'stripeCustomerId', 'stripe_customer_id', 'stripeCustomerId', 'stripe_customer_id', 'stripeCustomerId']
   }];
   return coerce.reduce((acc, {
     key,
@@ -852,6 +874,61 @@ function coerceValue(properties, keys, schema) {
   return coercedValue;
 }
 
+const browserContextSchema = z.object({
+  $locale: z.string(),
+  $location: z.string(),
+  $href: z.string(),
+  $pathname: z.string(),
+  $referrer: z.string(),
+  $screenDPI: z.number(),
+  $screenHeight: z.number(),
+  $screenWidth: z.number(),
+  $title: z.string(),
+  $userAgent: z.string()
+});
+const serverContextSchema = z.object({
+  $city: z.string().optional(),
+  $country: z.string().optional(),
+  $continent: z.string().optional(),
+  $latitude: z.number().optional(),
+  $longitude: z.number().optional(),
+  $timezone: z.string().optional(),
+  $userAgent: z.string().optional(),
+  $referrer: z.string().optional(),
+  $ip: z.string().optional(),
+  $processedAt: z.string().datetime().optional(),
+  $identityHash: z.string().optional()
+});
+const trackedEventTypesSchema = z.enum(['SHORTLINK_REDIRECT']);
+const trackedEventSchema = z.object({
+  id: z.string().uuid(),
+  timestamp: z.string().datetime(),
+  projectId: z.string(),
+  version: z.string(),
+  type: trackedEventTypesSchema,
+  payload: z.object({
+    browserContext: browserContextSchema.optional(),
+    serverContext: serverContextSchema.optional(),
+    properties: z.record(z.string(), z.any()).optional()
+  })
+});
+/**
+ * Creates a zod for tracking any type of event.
+ * Includes the base tracking schema and extends with any new schema
+ * @param type
+ * @param payloadSchema
+ * @returns
+ */
+function createTrackedEventTypeSchema(type, payloadSchema) {
+  const typeSchema = z.literal(type);
+  return trackedEventSchema.extend({
+    type: typeSchema,
+    payload: z.object(Object.assign(Object.assign({}, trackedEventSchema.shape.payload.shape), {
+      properties: payloadSchema
+    }))
+  });
+}
+
 const tbAny = z.union([z.string(), z.number(), z.array(z.union([z.string(), z.number()]))]);
 const tinyBirdBaseSchema = z.object({
   meta: z.array(z.object({
@@ -891,7 +968,9 @@ const TinybirdJobResponseSchema = z.object({
 const latestEventsRequestSchema = z.object({
   projectId: z.string(),
   limit: z.number().optional(),
-  payload: z.boolean().optional()
+  payload: z.boolean().optional(),
+  distinctId: z.string().optional(),
+  action: z.string().optional()
 });
 const latestEventItemSchema = z.object({
   id: z.string(),
@@ -902,7 +981,9 @@ const latestEventItemSchema = z.object({
   href: z.string(),
   device: z.string(),
   browser: z.string(),
-  payload: z.string().optional()
+  payload: z.string().optional(),
+  distinctId: z.string().optional(),
+  unique: z.boolean().optional()
 });
 const latestEventsResponseSchema = tinyBirdBaseSchema.extend({
   data: z.array(latestEventItemSchema)
@@ -1014,7 +1095,7 @@ const currentUsersResponseSchema = tinyBirdBaseSchema.extend({
   }))
 });
 const reservedPropertiesSchema = z.object({
-  age: z.number().or(z.string()).nullish(),
+  age: z.number().nullish(),
   avatar: z.string().url().nullish(),
   birthday: z.string().nullish(),
   createdAt: z.string().nullish(),
@@ -1029,8 +1110,17 @@ const reservedPropertiesSchema = z.object({
   title: z.string().nullish(),
   username: z.string().nullish(),
   website: z.string().nullish(),
+  // Default Properties
   $id: z.string().nullish(),
-  $lastSeen: z.string().nullish()
+  $lastSeen: z.string().nullish(),
+  $unsubscribed: z.boolean().nullish(),
+  $unsubscribeReason: z.enum(['manual', 'complained', 'bounced']).nullish(),
+  // Stripe Properties
+  $stripeCustomerId: z.string().nullish(),
+  $stripeTotalPayments: z.number().or(z.string()).nullish(),
+  $stripeTotalSpent: z.number().or(z.string()).nullish(),
+  // Internal properties
+  $_toDelete: z.boolean().nullish()
 });
 const contactPropertiesSchema = reservedPropertiesSchema.optional().and(z.record(z.union([z.string(), z.number(), z.boolean(), z.date(), z.null(), z.array(z.union([z.string(), z.number(), z.boolean(), z.date(), z.null()]))])));
 const analyticsUserRawSchema = z.object({
@@ -1075,4 +1165,4 @@ const latestIdentifiesResponseSchema = tinyBirdBaseSchema.extend({
   }))
 });
 
-export { Saasco, TinybirdJobResponseSchema, analyticsEventSchema, analyticsUserRawSchema, analyticsUserSchema, baseTopRequestSchema, coerceReservedProperties, contactPropertiesSchema, currentUsersRequestSchema, currentUsersResponseSchema, getAnalyticsUserParamsSchema, idenfitySchema, kpiSchema, kpisRequestSchema, kpisResponseSchema, latestEventItemSchema, latestEventsRequestSchema, latestEventsResponseSchema, latestIdentifiesRequestSchema, latestIdentifiesResponseSchema, listUsersParamsSchema, reservedPropertiesSchema, tbAny, timezones, tinyBirdBaseSchema, topActionsResponseSchema, topBrowsersResponseSchema, topDevicesResponseSchema, topLocationsResponseSchema, topPagesResponseSchema, topSourcesResponseSchema, topSourcesSchema, userEventsResponseSchema };
+export { Saasco, TinybirdJobResponseSchema, analyticsEventSchema, analyticsUserRawSchema, analyticsUserSchema, baseTopRequestSchema, browserContextSchema, coerceReservedProperties, contactPropertiesSchema, createTrackedEventTypeSchema, currentUsersRequestSchema, currentUsersResponseSchema, getAnalyticsUserParamsSchema, getBrowserContext, idenfitySchema, kpiSchema, kpisRequestSchema, kpisResponseSchema, latestEventItemSchema, latestEventsRequestSchema, latestEventsResponseSchema, latestIdentifiesRequestSchema, latestIdentifiesResponseSchema, listUsersParamsSchema, reservedPropertiesSchema, serverContextSchema, tbAny, timezones, tinyBirdBaseSchema, topActionsResponseSchema, topBrowsersResponseSchema, topDevicesResponseSchema, topLocationsResponseSchema, topPagesResponseSchema, topSourcesResponseSchema, topSourcesSchema, trackedEventSchema, trackedEventTypesSchema, userEventsResponseSchema };

package/package.json

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

package/src/index.d.ts

@@ -1,4 +1,6 @@
 export * from './lib/analytics';
 export * from './lib/coerceReservedProperties';
+export * from './lib/getBrowserContext';
 export * from './lib/timezones';
+export * from './lib/tracking';
 export * from './lib/types';

package/src/lib/analytics.d.ts

@@ -1,11 +1,12 @@
 declare global {
     interface Window {
         saascoAutoPageTrackingActive?: boolean;
+        saasco: Saasco;
     }
 }
 export declare class Saasco {
     private config;
-    private lastPageViewHref;
+    private lastPageViewPath;
     private isInitialized;
     /**
      * Creates an instance of Saasco SDK.
@@ -15,6 +16,8 @@ export declare class Saasco {
      * @param config.autoPageTracking Whether to automatically track page views. Default is false.
      * @param config.enabled Whether analytics is enabled. Default is true. Set to false for development and staging envioronments. Will still allow debug mode to be true, just no events will be sent
      * @param config.debug Whether to log debug information. Default is false.
+     * @param config.trackUrlParams Whether to track URL parameters. Default is true.
+     * @param config.trackHashChanges Whether to track hash changes. Default is true.
      */
     constructor(config: {
         projectId: string;
@@ -22,6 +25,8 @@ export declare class Saasco {
         autoPageTracking?: boolean;
         enabled?: boolean;
         debug?: boolean;
+        trackUrlParams?: boolean;
+        trackHashChanges?: boolean;
     });
     init(): void;
     disableDebug(): void;

package/src/lib/getBrowserContext.d.ts

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

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

@@ -0,0 +1 @@
+export * from './types';