saasco-sdk 0.1.8 → 0.1.10

package/index.cjs.js

@@ -434,6 +434,8 @@ const timezones = {
   'Asia/Calcutta': 'IN'
 };
 
+var version = "0.1.10";
+
 const isBrowser = typeof window !== 'undefined';
 let userId = null;
 const PREF = 'saasco-sdk';
@@ -590,9 +592,10 @@ class Saasco {
       id: uuid.v4(),
       timestamp: new Date().toISOString(),
       action: name,
-      version: '2',
+      version,
       sessionId: getSessionId(),
       anonymousId: getAnonymousId(),
+      distinctId: userId,
       projectId: this.config.projectId,
       payload: JSON.stringify(Object.assign(Object.assign({}, browserContext), {
         properties: properties || {}
@@ -618,12 +621,9 @@ 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 && !!userId;
+    const userIdChangedToNull = distinctId === null && !!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;
+    const reset = userIdChangedToNull;
     setSessionId({
       reset
     });
@@ -640,7 +640,7 @@ class Saasco {
       projectId: this.config.projectId,
       distinctId,
       anonymousId,
-      version: '2',
+      version,
       payload: properties || {},
       context: context || {}
     };
@@ -790,8 +790,15 @@ function coerceReservedProperties(properties) {
   }) => {
     const coercedValue = coerceValue(properties, coerceFrom, schema);
     if (coercedValue) acc[key] = coercedValue;
-    if (!coercedValue && key === 'displayName' && acc['firstName']) {
-      const displayName = `${acc['firstName'] || ''} ${acc['lastName'] || ''}`.trim();
+    if (!coercedValue && key === 'displayName') {
+      let displayName = '';
+      if (acc['firstName']) {
+        displayName = `${acc['firstName'] || ''} ${acc['lastName'] || ''}`.trim();
+      } else if (acc['username'] && typeof acc['username'] === 'string') {
+        displayName = acc['username'];
+      } else if (acc['name'] && typeof acc['name'] === 'string') {
+        displayName = acc['name'];
+      }
       if (displayName) acc[key] = displayName;
     }
     return acc;
@@ -858,6 +865,25 @@ const TinybirdJobResponseSchema = zod.z.object({
   delete_id: zod.z.string().optional(),
   import_id: zod.z.string().optional()
 });
+const latestEventsRequestSchema = zod.z.object({
+  projectId: zod.z.string(),
+  limit: zod.z.number().optional(),
+  payload: zod.z.boolean().optional()
+});
+const latestEventItemSchema = zod.z.object({
+  id: zod.z.string(),
+  timestamp: zod.z.string(),
+  action: zod.z.string(),
+  location: zod.z.string(),
+  referrer: zod.z.string(),
+  href: zod.z.string(),
+  device: zod.z.string(),
+  browser: zod.z.string(),
+  payload: zod.z.string().optional()
+});
+const latestEventsResponseSchema = tinyBirdBaseSchema.extend({
+  data: zod.z.array(latestEventItemSchema)
+});
 const kpisRequestSchema = zod.z.object({
   projectId: zod.z.string(),
   dateTo: zod.z.string().optional(),
@@ -865,16 +891,17 @@ const kpisRequestSchema = zod.z.object({
   referrer: zod.z.string().optional(),
   location: zod.z.string().optional()
 });
+const kpiSchema = zod.z.object({
+  date: zod.z.string(),
+  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 kpisResponseSchema = tinyBirdBaseSchema.extend({
-  data: zod.z.array(zod.z.object({
-    date: zod.z.string(),
-    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()
-  }))
+  data: zod.z.array(kpiSchema)
 });
 const baseTopRequestSchema = zod.z.object({
   projectId: zod.z.string(),
@@ -944,6 +971,7 @@ const analyticsEventSchema = zod.z.object({
   projectId: zod.z.string(),
   anonymousId: zod.z.string(),
   sessionId: zod.z.string(),
+  distinctId: zod.z.string().nullable(),
   version: zod.z.string(),
   action: zod.z.string(),
   payload: zod.z.string()
@@ -953,7 +981,7 @@ const userEventsResponseSchema = tinyBirdBaseSchema.extend({
 });
 const currentUsersRequestSchema = zod.z.object({
   projectId: zod.z.string(),
-  minutes: zod.z.number().optional(),
+  minutes: zod.z.number(),
   referrer: zod.z.string().optional(),
   location: zod.z.string().optional()
 });
@@ -1013,6 +1041,16 @@ const idenfitySchema = zod.z.object({
     active: zod.z.boolean().optional()
   }).optional()
 });
+const latestIdentifiesRequestSchema = zod.z.object({
+  projectId: zod.z.string(),
+  limit: zod.z.number().optional(),
+  fields: zod.z.array(zod.z.string()).optional()
+});
+const latestIdentifiesResponseSchema = tinyBirdBaseSchema.extend({
+  data: zod.z.array(zod.z.object({
+    properties: contactPropertiesSchema
+  }))
+});
 
 exports.Saasco = Saasco;
 exports.TinybirdJobResponseSchema = TinybirdJobResponseSchema;
@@ -1026,8 +1064,14 @@ exports.currentUsersRequestSchema = currentUsersRequestSchema;
 exports.currentUsersResponseSchema = currentUsersResponseSchema;
 exports.getAnalyticsUserParamsSchema = getAnalyticsUserParamsSchema;
 exports.idenfitySchema = idenfitySchema;
+exports.kpiSchema = kpiSchema;
 exports.kpisRequestSchema = kpisRequestSchema;
 exports.kpisResponseSchema = kpisResponseSchema;
+exports.latestEventItemSchema = latestEventItemSchema;
+exports.latestEventsRequestSchema = latestEventsRequestSchema;
+exports.latestEventsResponseSchema = latestEventsResponseSchema;
+exports.latestIdentifiesRequestSchema = latestIdentifiesRequestSchema;
+exports.latestIdentifiesResponseSchema = latestIdentifiesResponseSchema;
 exports.listUsersParamsSchema = listUsersParamsSchema;
 exports.reservedPropertiesSchema = reservedPropertiesSchema;
 exports.tbAny = tbAny;

package/index.esm.js

@@ -430,6 +430,8 @@ const timezones = {
   'Asia/Calcutta': 'IN'
 };
 
+var version = "0.1.10";
+
 const isBrowser = typeof window !== 'undefined';
 let userId = null;
 const PREF = 'saasco-sdk';
@@ -586,9 +588,10 @@ class Saasco {
       id: v4(),
       timestamp: new Date().toISOString(),
       action: name,
-      version: '2',
+      version,
       sessionId: getSessionId(),
       anonymousId: getAnonymousId(),
+      distinctId: userId,
       projectId: this.config.projectId,
       payload: JSON.stringify(Object.assign(Object.assign({}, browserContext), {
         properties: properties || {}
@@ -614,12 +617,9 @@ 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 && !!userId;
+    const userIdChangedToNull = distinctId === null && !!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;
+    const reset = userIdChangedToNull;
     setSessionId({
       reset
     });
@@ -636,7 +636,7 @@ class Saasco {
       projectId: this.config.projectId,
       distinctId,
       anonymousId,
-      version: '2',
+      version,
       payload: properties || {},
       context: context || {}
     };
@@ -786,8 +786,15 @@ function coerceReservedProperties(properties) {
   }) => {
     const coercedValue = coerceValue(properties, coerceFrom, schema);
     if (coercedValue) acc[key] = coercedValue;
-    if (!coercedValue && key === 'displayName' && acc['firstName']) {
-      const displayName = `${acc['firstName'] || ''} ${acc['lastName'] || ''}`.trim();
+    if (!coercedValue && key === 'displayName') {
+      let displayName = '';
+      if (acc['firstName']) {
+        displayName = `${acc['firstName'] || ''} ${acc['lastName'] || ''}`.trim();
+      } else if (acc['username'] && typeof acc['username'] === 'string') {
+        displayName = acc['username'];
+      } else if (acc['name'] && typeof acc['name'] === 'string') {
+        displayName = acc['name'];
+      }
       if (displayName) acc[key] = displayName;
     }
     return acc;
@@ -854,6 +861,25 @@ const TinybirdJobResponseSchema = z.object({
   delete_id: z.string().optional(),
   import_id: z.string().optional()
 });
+const latestEventsRequestSchema = z.object({
+  projectId: z.string(),
+  limit: z.number().optional(),
+  payload: z.boolean().optional()
+});
+const latestEventItemSchema = z.object({
+  id: z.string(),
+  timestamp: z.string(),
+  action: z.string(),
+  location: z.string(),
+  referrer: z.string(),
+  href: z.string(),
+  device: z.string(),
+  browser: z.string(),
+  payload: z.string().optional()
+});
+const latestEventsResponseSchema = tinyBirdBaseSchema.extend({
+  data: z.array(latestEventItemSchema)
+});
 const kpisRequestSchema = z.object({
   projectId: z.string(),
   dateTo: z.string().optional(),
@@ -861,16 +887,17 @@ const kpisRequestSchema = z.object({
   referrer: z.string().optional(),
   location: z.string().optional()
 });
+const kpiSchema = z.object({
+  date: z.string(),
+  users: z.number(),
+  sessions: z.number(),
+  pageViews: z.number(),
+  events: z.number(),
+  bounceRate: z.nullable(z.number()),
+  avgSessionSec: z.number()
+});
 const kpisResponseSchema = tinyBirdBaseSchema.extend({
-  data: z.array(z.object({
-    date: z.string(),
-    users: z.number(),
-    sessions: z.number(),
-    pageViews: z.number(),
-    events: z.number(),
-    bounceRate: z.nullable(z.number()),
-    avgSessionSec: z.number()
-  }))
+  data: z.array(kpiSchema)
 });
 const baseTopRequestSchema = z.object({
   projectId: z.string(),
@@ -940,6 +967,7 @@ const analyticsEventSchema = z.object({
   projectId: z.string(),
   anonymousId: z.string(),
   sessionId: z.string(),
+  distinctId: z.string().nullable(),
   version: z.string(),
   action: z.string(),
   payload: z.string()
@@ -949,7 +977,7 @@ const userEventsResponseSchema = tinyBirdBaseSchema.extend({
 });
 const currentUsersRequestSchema = z.object({
   projectId: z.string(),
-  minutes: z.number().optional(),
+  minutes: z.number(),
   referrer: z.string().optional(),
   location: z.string().optional()
 });
@@ -1009,5 +1037,15 @@ const idenfitySchema = z.object({
     active: z.boolean().optional()
   }).optional()
 });
+const latestIdentifiesRequestSchema = z.object({
+  projectId: z.string(),
+  limit: z.number().optional(),
+  fields: z.array(z.string()).optional()
+});
+const latestIdentifiesResponseSchema = tinyBirdBaseSchema.extend({
+  data: z.array(z.object({
+    properties: contactPropertiesSchema
+  }))
+});
 
-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 };
+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 };

package/package.json

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