saasco-sdk 0.1.6 → 0.1.8

package/README.md

@@ -166,6 +166,7 @@ saasco.debug(true);
 
 Saasco has reserved some properties that have semantic meanings for contacts and, and will handle them in special ways.
 For example, Saasco always expects email to be a string of the user’s email address, this is important for when sending emails using the marketing app.
+The SDK will do its best to match these properties, eg (created_at will be mapped to createdAt), but if possible you should use the reserved properties.
 
 ### Reserved Contact Properties
 
@@ -180,7 +181,6 @@ For example, Saasco always expects email to be a string of the user’s email ad
 | firstName   | String | First name of a user                                                                                              |
 | displayName | String | The prefered users display name, will default to "firstName lastName"                                             |
 | gender      | String | Gender of a user                                                                                                  |
-| id          | String | The ID of the user from your database, coerced to a string. eg 1 becomes "1"                                      |
 | lastName    | String | Last name of a user                                                                                               |
 | name        | String | Full name of a user. If you only pass a first and last name Segment automatically fills in the full name for you. |
 | phone       | String | Phone number of a user                                                                                            |
@@ -195,8 +195,8 @@ Any property that starts with `$` is a property that has been generated by the S
 
 | Property                | Display Name                | Description                                                                            |
 | ----------------------- | --------------------------- | -------------------------------------------------------------------------------------- |
+| $id                     | ID                          | The ID of the user from your database, coerced to a string. eg 1 becomes "1"           |
 | $city                   | City                        | The city of the user parsed from the IP.                                               |
-| $region                 | Region                      | The region of the user parsed from the IP                                              |
 | $countryCode            | Country Code                | The country of the user parsed from the IP property.                                   |
 | $latitude               | Latitude                    | Latitude of the user's IP location.                                                    |
 | $longitude              | Longitude                   | Longitude of the user's IP location.                                                   |
@@ -205,7 +205,7 @@ Any property that starts with `$` is a property that has been generated by the S
 | $screenHeight           | Screen Height               | The most recent height of the device screen in pixels                                  |
 | $screenWidth            | Screen Width                | The most recent width of the device screen in pixels                                   |
 | $screenDpi              | Screen DPI                  | The most recent Pixel density of the device screen.                                    |
-| $lastSeen               | Updated at                  | The last time a user profile property was set or updated                               |
+| $lastSeen               | Last Seen                   | The last time a user was identified while active was not false in the context          |
 | $os                     | Operating System            | The most recent OS of the user.                                                        |
 | $browser                | Browser                     | The most recent browser of the user.                                                   |
 | $browserVersion         | Browser Version             | The most recent bowser version of the user.                                            |
@@ -242,7 +242,6 @@ Our SDKs automatically collect certain properties on every event or user profile
 | Property         | Display Name                | Description                                                                      |
 | ---------------- | --------------------------- | -------------------------------------------------------------------------------- |
 | $city            | City                        | The city of the user parsed from the IP.                                         |
-| $region          | Region                      | The region of the user parsed from the IP                                        |
 | $countryCode     | Country Code                | The country of the user parsed from the IP property.                             |
 | $latitude        | Latitude                    | Latitude of the user's IP location.                                              |
 | $longitude       | Longitude                   | Longitude of the user's IP location.                                             |

package/index.cjs.js

@@ -2,6 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var tslib = require('tslib');
 var uuid = require('@lukeed/uuid');
 var zod = require('zod');
 
@@ -433,7 +434,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';
@@ -501,6 +501,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.
@@ -542,8 +572,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) {
@@ -556,20 +585,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: uuid.v4(),
       timestamp: new Date().toISOString(),
@@ -578,21 +594,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
@@ -601,18 +608,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_${uuid.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
     });
@@ -631,9 +642,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
@@ -642,25 +653,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 tslib.__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);
     });
   }
   /**
@@ -669,14 +686,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
@@ -768,8 +781,7 @@ function coerceReservedProperties(properties) {
     schema: zod.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: zod.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,
@@ -823,49 +835,69 @@ const tinyBirdBaseSchema = zod.z.object({
   }),
   rows: zod.z.number()
 });
+const TinybirdJobResponseSchema = zod.z.object({
+  id: zod.z.string(),
+  job_id: zod.z.string(),
+  job_url: zod.z.string().url(),
+  job: zod.z.object({
+    kind: zod.z.string(),
+    id: zod.z.string(),
+    job_id: zod.z.string(),
+    status: zod.z.string(),
+    created_at: zod.z.string(),
+    updated_at: zod.z.string(),
+    started_at: zod.z.string().nullable(),
+    is_cancellable: zod.z.boolean(),
+    datasource: zod.z.object({
+      id: zod.z.string(),
+      name: zod.z.string()
+    }),
+    delete_condition: zod.z.string().optional()
+  }),
+  status: zod.z.string(),
+  delete_id: zod.z.string().optional(),
+  import_id: zod.z.string().optional()
+});
 const kpisRequestSchema = zod.z.object({
   projectId: zod.z.string(),
   dateTo: zod.z.string().optional(),
   dateFrom: zod.z.string().optional(),
-  referringDomain: zod.z.string().optional(),
+  referrer: zod.z.string().optional(),
   location: zod.z.string().optional()
 });
 const kpisResponseSchema = tinyBirdBaseSchema.extend({
   data: zod.z.array(zod.z.object({
     date: zod.z.string(),
-    visits: zod.z.number(),
-    pageviews: zod.z.number(),
+    users: zod.z.number(),
+    sessions: zod.z.number(),
+    pageViews: zod.z.number(),
+    events: zod.z.number(),
     bounceRate: zod.z.nullable(zod.z.number()),
     avgSessionSec: zod.z.number()
   }))
 });
-const eventsKpisResponseSchema = tinyBirdBaseSchema.extend({
-  data: zod.z.array(zod.z.object({
-    unique: zod.z.number(),
-    total: zod.z.number()
-  }))
-});
 const baseTopRequestSchema = zod.z.object({
   projectId: zod.z.string(),
   dateTo: zod.z.string().optional(),
   dateFrom: zod.z.string().optional(),
   limit: zod.z.number().optional(),
   skip: zod.z.number().optional(),
-  referringDomain: zod.z.string().optional(),
+  referrer: zod.z.string().optional(),
   location: zod.z.string().optional()
 });
 const topPagesResponseSchema = tinyBirdBaseSchema.extend({
   data: zod.z.array(zod.z.object({
     pathname: zod.z.string(),
-    visits: zod.z.number(),
-    hits: zod.z.number()
+    users: zod.z.number(),
+    events: zod.z.number()
   }))
 });
 const topLocationsResponseSchema = tinyBirdBaseSchema.extend({
   data: zod.z.array(zod.z.object({
     location: zod.z.string(),
-    visits: zod.z.number(),
-    hits: zod.z.number(),
+    users: zod.z.number(),
+    sessions: zod.z.number(),
+    pageViews: zod.z.number(),
     bounceRate: zod.z.nullable(zod.z.number()),
     avgSessionSec: zod.z.number()
   }))
@@ -890,8 +922,9 @@ const topBrowsersResponseSchema = tinyBirdBaseSchema.extend({
 });
 const topSourcesSchema = zod.z.object({
   referrer: zod.z.string(),
-  visits: zod.z.number(),
-  hits: zod.z.number(),
+  users: zod.z.number(),
+  sessions: zod.z.number(),
+  pageViews: zod.z.number(),
   bounceRate: zod.z.nullable(zod.z.number()),
   avgSessionSec: zod.z.number()
 });
@@ -901,8 +934,8 @@ const topSourcesResponseSchema = tinyBirdBaseSchema.extend({
 const topActionsResponseSchema = tinyBirdBaseSchema.extend({
   data: zod.z.array(zod.z.object({
     action: zod.z.string(),
-    unique: zod.z.number(),
-    total: zod.z.number()
+    users: zod.z.number(),
+    events: zod.z.number()
   }))
 });
 const analyticsEventSchema = zod.z.object({
@@ -921,7 +954,7 @@ const userEventsResponseSchema = tinyBirdBaseSchema.extend({
 const currentUsersRequestSchema = zod.z.object({
   projectId: zod.z.string(),
   minutes: zod.z.number().optional(),
-  referringDomain: zod.z.string().optional(),
+  referrer: zod.z.string().optional(),
   location: zod.z.string().optional()
 });
 const currentUsersResponseSchema = tinyBirdBaseSchema.extend({
@@ -930,7 +963,7 @@ const currentUsersResponseSchema = tinyBirdBaseSchema.extend({
   }))
 });
 const reservedPropertiesSchema = zod.z.object({
-  age: zod.z.number().nullish(),
+  age: zod.z.number().or(zod.z.string()).nullish(),
   avatar: zod.z.string().url().nullish(),
   birthday: zod.z.string().nullish(),
   createdAt: zod.z.string().nullish(),
@@ -944,9 +977,11 @@ const reservedPropertiesSchema = zod.z.object({
   phone: zod.z.string().nullish(),
   title: zod.z.string().nullish(),
   username: zod.z.string().nullish(),
-  website: zod.z.string().nullish()
+  website: zod.z.string().nullish(),
+  $id: zod.z.string().nullish(),
+  $lastSeen: zod.z.string().nullish()
 });
-const userPropertiesSchema = reservedPropertiesSchema.and(zod.z.record(zod.z.union([zod.z.string(), zod.z.number(), zod.z.boolean(), zod.z.date(), zod.z.null(), zod.z.array(zod.z.union([zod.z.string(), zod.z.number(), zod.z.boolean(), zod.z.date(), zod.z.null()]))])));
+const contactPropertiesSchema = reservedPropertiesSchema.optional().and(zod.z.record(zod.z.union([zod.z.string(), zod.z.number(), zod.z.boolean(), zod.z.date(), zod.z.null(), zod.z.array(zod.z.union([zod.z.string(), zod.z.number(), zod.z.boolean(), zod.z.date(), zod.z.null()]))])));
 const analyticsUserRawSchema = zod.z.object({
   timestamp: zod.z.string(),
   distinctId: zod.z.string(),
@@ -956,7 +991,7 @@ const analyticsUserRawSchema = zod.z.object({
 const analyticsUserSchema = analyticsUserRawSchema.omit({
   payload: true
 }).and(zod.z.object({
-  properties: userPropertiesSchema
+  properties: contactPropertiesSchema
 }));
 const listUsersParamsSchema = zod.z.object({
   projectId: zod.z.string(),
@@ -973,21 +1008,22 @@ const idenfitySchema = zod.z.object({
   distinctId: zod.z.string(),
   anonymousId: zod.z.string(),
   version: zod.z.string(),
-  payload: userPropertiesSchema,
-  options: zod.z.object({
+  payload: contactPropertiesSchema,
+  context: zod.z.object({
     active: zod.z.boolean().optional()
   }).optional()
 });
 
 exports.Saasco = Saasco;
+exports.TinybirdJobResponseSchema = TinybirdJobResponseSchema;
 exports.analyticsEventSchema = analyticsEventSchema;
 exports.analyticsUserRawSchema = analyticsUserRawSchema;
 exports.analyticsUserSchema = analyticsUserSchema;
 exports.baseTopRequestSchema = baseTopRequestSchema;
 exports.coerceReservedProperties = coerceReservedProperties;
+exports.contactPropertiesSchema = contactPropertiesSchema;
 exports.currentUsersRequestSchema = currentUsersRequestSchema;
 exports.currentUsersResponseSchema = currentUsersResponseSchema;
-exports.eventsKpisResponseSchema = eventsKpisResponseSchema;
 exports.getAnalyticsUserParamsSchema = getAnalyticsUserParamsSchema;
 exports.idenfitySchema = idenfitySchema;
 exports.kpisRequestSchema = kpisRequestSchema;
@@ -995,6 +1031,7 @@ exports.kpisResponseSchema = kpisResponseSchema;
 exports.listUsersParamsSchema = listUsersParamsSchema;
 exports.reservedPropertiesSchema = reservedPropertiesSchema;
 exports.tbAny = tbAny;
+exports.timezones = timezones;
 exports.tinyBirdBaseSchema = tinyBirdBaseSchema;
 exports.topActionsResponseSchema = topActionsResponseSchema;
 exports.topBrowsersResponseSchema = topBrowsersResponseSchema;
@@ -1004,4 +1041,3 @@ exports.topPagesResponseSchema = topPagesResponseSchema;
 exports.topSourcesResponseSchema = topSourcesResponseSchema;
 exports.topSourcesSchema = topSourcesSchema;
 exports.userEventsResponseSchema = userEventsResponseSchema;
-exports.userPropertiesSchema = userPropertiesSchema;