saasco-sdk 0.1.6 → 0.1.8

package/index.esm.js

@@ -1,3 +1,4 @@
+import { __awaiter } from 'tslib';
 import { v4 } from '@lukeed/uuid';
 import { z } from 'zod';
 
@@ -429,7 +430,6 @@ const timezones = {
   'Asia/Calcutta': 'IN'
 };
 
-/* eslint-disable @typescript-eslint/no-explicit-any */
 const isBrowser = typeof window !== 'undefined';
 let userId = null;
 const PREF = 'saasco-sdk';
@@ -497,6 +497,36 @@ 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
+  };
+}
 class Saasco {
   /**
    * Creates an instance of Saasco SDK.
@@ -538,8 +568,7 @@ class Saasco {
    */
   track(name,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  properties) {
-    var _a;
+  properties, context) {
     // Prevent duplicate Page View tracking
     if (name === 'Page View') {
       if (!isBrowser) {
@@ -552,20 +581,7 @@ class Saasco {
     }
     setSessionId();
     setAnonmousId();
-    const customNavigator = isBrowser ? navigator : undefined;
-    const $locale = isBrowser ? (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' : undefined;
-    // 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 = isBrowser ? timezones[timezone] || ((_a = $locale === null || $locale === void 0 ? void 0 : $locale.split('-')) === null || _a === void 0 ? void 0 : _a[1]) || 'undefined' : undefined;
-    const $href = isBrowser ? window.location.href : undefined;
-    const $pathname = isBrowser ? window.location.pathname : undefined;
-    const $referrer = isBrowser ? document.referrer : undefined;
-    const $screenDPI = isBrowser ? window.devicePixelRatio : undefined;
-    const $screenHeight = isBrowser ? screen.height : undefined;
-    const $screenWidth = isBrowser ? screen.width : undefined;
-    const $title = isBrowser ? document.title : undefined;
-    const $userAgent = isBrowser ? window.navigator.userAgent : undefined;
+    const browserContext = getBrowserContext();
     const data = {
       id: v4(),
       timestamp: new Date().toISOString(),
@@ -574,21 +590,12 @@ class Saasco {
       sessionId: getSessionId(),
       anonymousId: getAnonymousId(),
       projectId: this.config.projectId,
-      payload: JSON.stringify({
-        $href,
-        $locale,
-        $location,
-        $pathname,
-        $referrer,
-        $screenDPI,
-        $screenHeight,
-        $screenWidth,
-        $title,
-        $userAgent,
+      payload: JSON.stringify(Object.assign(Object.assign({}, browserContext), {
         properties: properties || {}
-      })
+      })),
+      context: JSON.stringify(context || {})
     };
-    this.doRequest('events', data);
+    return this.doRequest('events', data);
   }
   /**
    * The page method lets you record page views on your website
@@ -597,18 +604,22 @@ class Saasco {
    * Before implementing this make sure you have disabled the autoPageTracking in the config or you will get duplicate page views
    */
   page() {
-    this.track('Page View');
+    return this.track('Page View');
   }
-  identify(distinctIdOrProperties, propertiesOrOptions, optionsOrNothing) {
+  identify(distinctIdOrProperties, propertiesOrContext, contextOrNothing) {
     const hasId = typeof distinctIdOrProperties === 'string' || typeof distinctIdOrProperties === 'number' || distinctIdOrProperties === null;
     const distinctId = hasId ? distinctIdOrProperties === null || distinctIdOrProperties === void 0 ? void 0 : distinctIdOrProperties.toString() : `soft_${v4()}`;
-    const properties = hasId ? propertiesOrOptions : distinctIdOrProperties;
-    const options = hasId ? optionsOrNothing : propertiesOrOptions;
+    const properties = hasId ? propertiesOrContext : distinctIdOrProperties;
+    const context = hasId ? contextOrNothing : propertiesOrContext;
     // 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 reset = !distinctId && !!userId;
-    if (reset) this.log('User logged out and session reset');
+    const userIdChangedToNull = !distinctId && !!userId;
+    if (userIdChangedToNull) this.log('User ID change to null. Session reset');
+    // If we have a userId, but a new user ID is provided, we should reset the session and anonymous IDs
+    const userIdChanged = !!userId && distinctId !== userId;
+    if (userIdChanged) this.log('User ID changed. Session reset');
+    const reset = userIdChangedToNull || userIdChanged;
     setSessionId({
       reset
     });
@@ -627,9 +638,9 @@ class Saasco {
       anonymousId,
       version: '2',
       payload: properties || {},
-      options: options || {}
+      context: context || {}
     };
-    this.doRequest('identify', data);
+    return this.doRequest('identify', data);
   }
   /**
    * Handles sending data to the Saasco API
@@ -638,25 +649,31 @@ class Saasco {
    * @param data
    */
   doRequest(path, data) {
-    const base = this.config.proxy || 'https://www.saasco.com/api/';
-    const url = `${base}${path}`;
-    const logMessage = data.action === 'Page View' ? `Page View ${window.location.pathname}` // if its a page view, include pathname in console log
-    : data.action || path;
-    this.log(logMessage, data);
-    // If analytics is disabled, don't send the request
-    if (this.config.enabled === false) return;
-    fetch(url, {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json'
-      },
-      body: JSON.stringify(data)
-    }).then(response => {
-      if (!response.ok) {
-        throw new Error(response.status.toString());
+    return __awaiter(this, void 0, void 0, function* () {
+      const base = this.config.proxy || 'https://www.saasco.com/api/';
+      const url = `${base}${path}`;
+      const logMessage = data.action === 'Page View' ? `Page View ${window.location.pathname}` // if its a page view, include pathname in console log
+      : data.action || path;
+      this.log(logMessage, data);
+      // If analytics is disabled, don't send the request
+      if (this.config.enabled === false) return;
+      try {
+        const response = yield fetch(url, {
+          method: 'POST',
+          headers: {
+            'Content-Type': 'application/json'
+          },
+          body: JSON.stringify(data)
+        });
+        if (!response.ok) {
+          throw new Error(response.status.toString());
+        }
+        return response;
+      } catch (error) {
+        const errorMessage = 'Error with Saasco request: ' + error.message;
+        console.error(errorMessage, path, data);
+        return errorMessage;
       }
-    }).catch(e => {
-      console.error('Error with Saasco request: ' + e.message, path, data);
     });
   }
   /**
@@ -665,14 +682,10 @@ class Saasco {
   log(...args) {
     if (!this.config.debug) return;
     const message = '◍ Saasco Debug';
-    console.log(...[`\x1b[47m\x1b[30m ${message} \x1b[0m`,
+    console.info(...[`\x1b[47m\x1b[30m ${message} \x1b[0m`,
     // Message highlighted for easy finding
     ...args]);
   }
-  getSearchParam(param) {
-    if (typeof window === 'undefined') return undefined;
-    return new URLSearchParams(window.location.search).get(param);
-  }
   /**
    * If autoPageTracking is enabled, this will automatically track page views
    * It listens to url changes to track new pages every time the url changes
@@ -764,8 +777,7 @@ function coerceReservedProperties(properties) {
     schema: z.coerce.string().url().optional()
   }, {
     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'],
-    schema: z.coerce.string().url().optional()
+    coerceFrom: ['display_name', 'displayName', 'user_display_name', 'userDisplayName', 'full_name', 'fullName', 'user_full_name', 'userFullName', 'complete_name', 'completeName', 'user_complete_name', 'userCompleteName', 'name', 'username']
   }];
   return coerce.reduce((acc, {
     key,
@@ -819,49 +831,69 @@ const tinyBirdBaseSchema = z.object({
   }),
   rows: z.number()
 });
+const TinybirdJobResponseSchema = z.object({
+  id: z.string(),
+  job_id: z.string(),
+  job_url: z.string().url(),
+  job: z.object({
+    kind: z.string(),
+    id: z.string(),
+    job_id: z.string(),
+    status: z.string(),
+    created_at: z.string(),
+    updated_at: z.string(),
+    started_at: z.string().nullable(),
+    is_cancellable: z.boolean(),
+    datasource: z.object({
+      id: z.string(),
+      name: z.string()
+    }),
+    delete_condition: z.string().optional()
+  }),
+  status: z.string(),
+  delete_id: z.string().optional(),
+  import_id: z.string().optional()
+});
 const kpisRequestSchema = z.object({
   projectId: z.string(),
   dateTo: z.string().optional(),
   dateFrom: z.string().optional(),
-  referringDomain: z.string().optional(),
+  referrer: z.string().optional(),
   location: z.string().optional()
 });
 const kpisResponseSchema = tinyBirdBaseSchema.extend({
   data: z.array(z.object({
     date: z.string(),
-    visits: z.number(),
-    pageviews: z.number(),
+    users: z.number(),
+    sessions: z.number(),
+    pageViews: z.number(),
+    events: z.number(),
     bounceRate: z.nullable(z.number()),
     avgSessionSec: z.number()
   }))
 });
-const eventsKpisResponseSchema = tinyBirdBaseSchema.extend({
-  data: z.array(z.object({
-    unique: z.number(),
-    total: z.number()
-  }))
-});
 const baseTopRequestSchema = z.object({
   projectId: z.string(),
   dateTo: z.string().optional(),
   dateFrom: z.string().optional(),
   limit: z.number().optional(),
   skip: z.number().optional(),
-  referringDomain: z.string().optional(),
+  referrer: z.string().optional(),
   location: z.string().optional()
 });
 const topPagesResponseSchema = tinyBirdBaseSchema.extend({
   data: z.array(z.object({
     pathname: z.string(),
-    visits: z.number(),
-    hits: z.number()
+    users: z.number(),
+    events: z.number()
   }))
 });
 const topLocationsResponseSchema = tinyBirdBaseSchema.extend({
   data: z.array(z.object({
     location: z.string(),
-    visits: z.number(),
-    hits: z.number(),
+    users: z.number(),
+    sessions: z.number(),
+    pageViews: z.number(),
     bounceRate: z.nullable(z.number()),
     avgSessionSec: z.number()
   }))
@@ -886,8 +918,9 @@ const topBrowsersResponseSchema = tinyBirdBaseSchema.extend({
 });
 const topSourcesSchema = z.object({
   referrer: z.string(),
-  visits: z.number(),
-  hits: z.number(),
+  users: z.number(),
+  sessions: z.number(),
+  pageViews: z.number(),
   bounceRate: z.nullable(z.number()),
   avgSessionSec: z.number()
 });
@@ -897,8 +930,8 @@ const topSourcesResponseSchema = tinyBirdBaseSchema.extend({
 const topActionsResponseSchema = tinyBirdBaseSchema.extend({
   data: z.array(z.object({
     action: z.string(),
-    unique: z.number(),
-    total: z.number()
+    users: z.number(),
+    events: z.number()
   }))
 });
 const analyticsEventSchema = z.object({
@@ -917,7 +950,7 @@ const userEventsResponseSchema = tinyBirdBaseSchema.extend({
 const currentUsersRequestSchema = z.object({
   projectId: z.string(),
   minutes: z.number().optional(),
-  referringDomain: z.string().optional(),
+  referrer: z.string().optional(),
   location: z.string().optional()
 });
 const currentUsersResponseSchema = tinyBirdBaseSchema.extend({
@@ -926,7 +959,7 @@ const currentUsersResponseSchema = tinyBirdBaseSchema.extend({
   }))
 });
 const reservedPropertiesSchema = z.object({
-  age: z.number().nullish(),
+  age: z.number().or(z.string()).nullish(),
   avatar: z.string().url().nullish(),
   birthday: z.string().nullish(),
   createdAt: z.string().nullish(),
@@ -940,9 +973,11 @@ const reservedPropertiesSchema = z.object({
   phone: z.string().nullish(),
   title: z.string().nullish(),
   username: z.string().nullish(),
-  website: z.string().nullish()
+  website: z.string().nullish(),
+  $id: z.string().nullish(),
+  $lastSeen: z.string().nullish()
 });
-const userPropertiesSchema = reservedPropertiesSchema.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 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({
   timestamp: z.string(),
   distinctId: z.string(),
@@ -952,7 +987,7 @@ const analyticsUserRawSchema = z.object({
 const analyticsUserSchema = analyticsUserRawSchema.omit({
   payload: true
 }).and(z.object({
-  properties: userPropertiesSchema
+  properties: contactPropertiesSchema
 }));
 const listUsersParamsSchema = z.object({
   projectId: z.string(),
@@ -969,10 +1004,10 @@ const idenfitySchema = z.object({
   distinctId: z.string(),
   anonymousId: z.string(),
   version: z.string(),
-  payload: userPropertiesSchema,
-  options: z.object({
+  payload: contactPropertiesSchema,
+  context: z.object({
     active: z.boolean().optional()
   }).optional()
 });
 
-export { Saasco, analyticsEventSchema, analyticsUserRawSchema, analyticsUserSchema, baseTopRequestSchema, coerceReservedProperties, currentUsersRequestSchema, currentUsersResponseSchema, eventsKpisResponseSchema, getAnalyticsUserParamsSchema, idenfitySchema, kpisRequestSchema, kpisResponseSchema, listUsersParamsSchema, reservedPropertiesSchema, tbAny, tinyBirdBaseSchema, topActionsResponseSchema, topBrowsersResponseSchema, topDevicesResponseSchema, topLocationsResponseSchema, topPagesResponseSchema, topSourcesResponseSchema, topSourcesSchema, userEventsResponseSchema, userPropertiesSchema };
+export { Saasco, TinybirdJobResponseSchema, analyticsEventSchema, analyticsUserRawSchema, analyticsUserSchema, baseTopRequestSchema, coerceReservedProperties, contactPropertiesSchema, currentUsersRequestSchema, currentUsersResponseSchema, getAnalyticsUserParamsSchema, idenfitySchema, kpisRequestSchema, kpisResponseSchema, listUsersParamsSchema, reservedPropertiesSchema, tbAny, timezones, tinyBirdBaseSchema, topActionsResponseSchema, topBrowsersResponseSchema, topDevicesResponseSchema, topLocationsResponseSchema, topPagesResponseSchema, topSourcesResponseSchema, topSourcesSchema, userEventsResponseSchema };

package/package.json

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

package/src/index.d.ts

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

package/src/lib/analytics.d.ts

@@ -34,14 +34,16 @@ export declare class Saasco {
      * @param name The name of the event eg "Song Played"
      * @param properties The properties of the event eg { genre: "Classics", song: "Never Gonna Give You Up" }
      */
-    track(name: string, properties?: Record<string, any>): void;
+    track(name: string, properties?: Record<string, any>, context?: {
+        active?: boolean;
+    }): Promise<string | Response | undefined> | undefined;
     /**
      * The page method lets you record page views on your website
      * This records the page title and path and names the event useing the reserved property "Page Viewed"
      *
      * Before implementing this make sure you have disabled the autoPageTracking in the config or you will get duplicate page views
      */
-    page(): void;
+    page(): Promise<string | Response | undefined> | undefined;
     /**
      * The identify method lets you tie a user to their actions and record traits about them.
      * We recommend you call this when the user logs in and when any traits get updated.
@@ -49,12 +51,12 @@ export declare class Saasco {
      *
      * @param distinctId The user's id. This should be the user id from your database. This is optional and can be skipped, but you must provide an email address on the user properties.
      * @param properties A dictionary of traits you know about the user like their email, name, plan etc.
-     * @param options Options for the identify call such as whether the user is active.
+     * @param context Context for the identify call such as whether the user is active.
      */
-    identify(properties: Record<string, any>, options?: {
+    identify(properties: Record<string, any>, context?: {
         active?: boolean;
     }): void;
-    identify(distinctId: string | number | null, properties?: Record<string, any>, options?: {
+    identify(distinctId: string | number | null, properties?: Record<string, any>, context?: {
         active?: boolean;
     }): void;
     /**
@@ -68,7 +70,6 @@ export declare class Saasco {
      * @param args Arguments to be logged
      */
     private log;
-    private getSearchParam;
     /**
      * If autoPageTracking is enabled, this will automatically track page views
      * It listens to url changes to track new pages every time the url changes