saasco-sdk 0.1.20 → 0.1.22

package/README.md

@@ -292,7 +292,7 @@ Reserved events are common events that happen during the lifecycle of a user, wi
 - [Signed In](#signed-in)
 - [Signed Out](#signed-out)
 - [Trial Started](#trial-started)
-- [Trial Completed](#trial-completed)
+- [Trial Ended](#trial-ended)
 - [Payment Completed](#payment-completed)
 - [Subscription Started](#subscription-started)
 - [Subscription Cancelled](#subscription-cancelled)
@@ -355,9 +355,9 @@ Example:
 saasco.track('Trial Started', { duration: 14, type: 'optOut' });
 ```
 
-#### Trial Completed
+#### Trial Ended
 
-Event triggered when a user successfully completes a trial.
+Event triggered when a users trial ends.
 | Property | Description |
 |-------------------|---------------------------------------------------------------------|
 | `daysLeftInTrial`| If a user manual upgrades before the end of the trial you can record this here|
@@ -365,10 +365,10 @@ Event triggered when a user successfully completes a trial.
 Example:
 
 ```jsx
-saasco.track('Trial Completed', { daysLeftInTrial: 4 });
+saasco.track('Trial Ended', { daysLeftInTrial: 4 });
 ```
 
-#### Payment Completed
+#### Payment Ended
 
 Event triggered when a payment is completed.
 This is may be called on the server side after a confirmation webhook.

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.20";
+var version = "0.1.22";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -623,6 +623,7 @@ class Saasco {
       payload: JSON.stringify(Object.assign(Object.assign({}, browserContext || {}), {
         properties: properties || {}
       })),
+      source: isBrowser ? 'client' : 'server',
       context: JSON.stringify(context || {})
     };
     return this.doRequest('events', data);
@@ -815,107 +816,6 @@ class Saasco {
   }
 }
 
-function coerceReservedProperties(properties) {
-  const coerce = [{
-    key: 'age',
-    coerceFrom: ['age', 'age_value', 'ageValue', 'user_age', 'userAge', 'user_age_value', 'userAgeValue', 'age_of_user', 'ageOfUser', 'age_in_years', 'ageInYears', 'years_old', 'yearsOld', 'age_years', 'ageYears'],
-    schema: zod.z.coerce.number().optional()
-  }, {
-    key: 'avatar',
-    coerceFrom: ['avatar', 'user_avatar', 'userAvatar', 'avatar_url', 'avatarUrl', 'profile_picture', 'profilePicture', 'picture', 'user_picture', 'userPicture', 'profile_pic', 'profilePic', 'pic', 'user_pic', 'userPic', 'image', 'user_image', 'userImage', 'profile_image', 'profileImage', 'profile_image_url', 'profileImageUrl', 'profile_pic_url', 'profilePicUrl', 'pic_url', 'picUrl', 'image_url', 'imageUrl', 'user_image_url', 'userImageUrl', 'user_pic_url', 'userPicUrl', 'profile_pic_url', 'profilePicUrl', 'pic_url', 'picUrl', 'image_url', 'imageUrl', 'user_image_url', 'userImageUrl', 'user_pic_url', 'userPicUrl'],
-    schema: zod.z.coerce.string().url().optional()
-  }, {
-    key: 'birthday',
-    coerceFrom: ['birthday', 'birth_date', 'birthDate', 'date_of_birth', 'dateOfBirth', 'dob', 'Dob', 'birth_day', 'birthDay']
-  }, {
-    key: 'createdAt',
-    coerceFrom: ['createdAt', 'created_at', 'created', 'createdDate', 'created_date', 'dateCreated', 'date_created', 'date_created_at', 'dateCreatedAt', 'date_created_at', 'dateCreated', 'date_created'],
-    schema: zod.z.coerce.date().optional()
-  }, {
-    key: 'description',
-    coerceFrom: ['description', 'bio', 'about', 'about_me', 'aboutMe', 'user_description', 'userDescription', 'profile_description', 'profileDescription']
-  }, {
-    key: 'email',
-    coerceFrom: ['email', 'user_email', 'userEmail', 'email_address', 'emailAddress', 'e_mail', 'E_Mail', 'mail', 'Mail', 'contact_email', 'contactEmail', 'primary_email', 'primaryEmail'],
-    schema: zod.z.coerce.string().email().optional()
-  }, {
-    key: 'firstName',
-    coerceFrom: ['first_name', 'firstName', 'firstname', 'given_name', 'givenName', 'user_first_name', 'userFirstName', 'name_first', 'nameFirst', 'f_name', 'fName']
-  }, {
-    key: 'gender',
-    coerceFrom: ['gender', 'user_gender', 'userGender', 'sex', 'user_sex', 'userSex']
-  }, {
-    key: 'lastName',
-    coerceFrom: ['last_name', 'lastName', 'lastname', 'surname', 'user_last_name', 'userLastName', 'name_last', 'nameLast', 'l_name', 'lName']
-  }, {
-    key: 'name',
-    coerceFrom: ['name', 'full_name', 'fullName', 'user_name', 'userName', 'complete_name', 'completeName']
-  }, {
-    key: 'phone',
-    coerceFrom: ['phone', 'phone_number', 'phoneNumber', 'mobile', 'mobile_number', 'mobileNumber', 'contact_number', 'contactNumber', 'tel', 'telephone']
-  }, {
-    key: 'title',
-    coerceFrom: ['title', 'user_title', 'userTitle', 'position', 'job_title', 'jobTitle']
-  }, {
-    key: 'username',
-    coerceFrom: ['username', 'user_name', 'userName', 'user_login', 'userLogin', 'account_name', 'accountName', 'screen_name', 'screenName', 'handle']
-  }, {
-    key: 'website',
-    coerceFrom: ['website', 'web_site', 'site', 'web', 'personal_website', 'personalWebsite', 'company_website', 'companyWebsite'],
-    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']
-  }, {
-    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,
-    coerceFrom,
-    schema
-  }) => {
-    const coercedValue = coerceValue(properties, coerceFrom, schema);
-    if (coercedValue) acc[key] = coercedValue;
-    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;
-  }, properties);
-}
-/**
- * Coerces the first non-null value from the properties object
- * @param properties
- * @param keys Provided in priority order, the first to match will return
- * @returns
- */
-function coerceValue(properties, keys, schema) {
-  let coercedValue = null;
-  for (const key of keys) {
-    if (properties[key] !== undefined) {
-      if (!schema) {
-        coercedValue = properties[key];
-        break;
-      } else {
-        const result = schema.safeParse(properties[key]);
-        if (result.success) {
-          coercedValue = properties[key];
-          break;
-        }
-      }
-    }
-  }
-  return coercedValue;
-}
-
 const browserContextSchema = zod.z.object({
   $locale: zod.z.string(),
   $location: zod.z.string(),
@@ -928,322 +828,8 @@ const browserContextSchema = zod.z.object({
   $title: zod.z.string(),
   $userAgent: zod.z.string()
 });
-const serverContextSchema = zod.z.object({
-  $city: zod.z.string().optional(),
-  $country: zod.z.string().optional(),
-  $continent: zod.z.string().optional(),
-  $latitude: zod.z.number().optional(),
-  $longitude: zod.z.number().optional(),
-  $timezone: zod.z.string().optional(),
-  $userAgent: zod.z.string().optional(),
-  $referrer: zod.z.string().optional(),
-  $ip: zod.z.string().optional(),
-  $processedAt: zod.z.string().datetime().optional(),
-  $identityHash: zod.z.string().optional()
-});
-const trackedEventTypesSchema = zod.z.enum(['SHORTLINK_REDIRECT']);
-const trackedEventSchema = zod.z.object({
-  id: zod.z.string().uuid(),
-  timestamp: zod.z.string().datetime(),
-  projectId: zod.z.string(),
-  version: zod.z.string(),
-  type: trackedEventTypesSchema,
-  payload: zod.z.object({
-    browserContext: browserContextSchema.optional(),
-    serverContext: serverContextSchema.optional(),
-    properties: zod.z.record(zod.z.string(), zod.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 = zod.z.literal(type);
-  return trackedEventSchema.extend({
-    type: typeSchema,
-    payload: zod.z.object(Object.assign(Object.assign({}, trackedEventSchema.shape.payload.shape), {
-      properties: payloadSchema
-    }))
-  });
-}
-
-const tbAny = zod.z.union([zod.z.string(), zod.z.number(), zod.z.array(zod.z.union([zod.z.string(), zod.z.number()]))]);
-const tinyBirdBaseSchema = zod.z.object({
-  meta: zod.z.array(zod.z.object({
-    name: zod.z.string(),
-    type: zod.z.string()
-  })),
-  statistics: zod.z.object({
-    elapsed: zod.z.number(),
-    rows_read: zod.z.number(),
-    bytes_read: zod.z.number()
-  }),
-  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 latestEventsRequestSchema = zod.z.object({
-  projectId: zod.z.string(),
-  limit: zod.z.number().optional(),
-  payload: zod.z.boolean().optional(),
-  distinctId: zod.z.string().optional(),
-  action: zod.z.string().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(),
-  distinctId: zod.z.string().optional(),
-  unique: zod.z.boolean().optional()
-});
-const latestEventsResponseSchema = tinyBirdBaseSchema.extend({
-  data: zod.z.array(latestEventItemSchema)
-});
-const kpisRequestSchema = zod.z.object({
-  projectId: zod.z.string(),
-  dateTo: zod.z.string().optional(),
-  dateFrom: zod.z.string().optional(),
-  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(kpiSchema)
-});
-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(),
-  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(),
-    users: zod.z.number(),
-    events: zod.z.number()
-  }))
-});
-const topLocationsResponseSchema = tinyBirdBaseSchema.extend({
-  data: zod.z.array(zod.z.object({
-    location: zod.z.string(),
-    users: zod.z.number(),
-    sessions: zod.z.number(),
-    pageViews: zod.z.number(),
-    bounceRate: zod.z.nullable(zod.z.number()),
-    avgSessionSec: zod.z.number()
-  }))
-});
-const topDevicesResponseSchema = tinyBirdBaseSchema.extend({
-  data: zod.z.array(zod.z.object({
-    device: zod.z.string(),
-    visits: zod.z.number(),
-    hits: zod.z.number(),
-    bounceRate: zod.z.nullable(zod.z.number()),
-    avgSessionSec: zod.z.number()
-  }))
-});
-const topBrowsersResponseSchema = tinyBirdBaseSchema.extend({
-  data: zod.z.array(zod.z.object({
-    browser: zod.z.string(),
-    visits: zod.z.number(),
-    hits: zod.z.number(),
-    bounceRate: zod.z.nullable(zod.z.number()),
-    avgSessionSec: zod.z.number()
-  }))
-});
-const topSourcesSchema = zod.z.object({
-  referrer: zod.z.string(),
-  users: zod.z.number(),
-  sessions: zod.z.number(),
-  pageViews: zod.z.number(),
-  bounceRate: zod.z.nullable(zod.z.number()),
-  avgSessionSec: zod.z.number()
-});
-const topSourcesResponseSchema = tinyBirdBaseSchema.extend({
-  data: zod.z.array(topSourcesSchema)
-});
-const topActionsResponseSchema = tinyBirdBaseSchema.extend({
-  data: zod.z.array(zod.z.object({
-    action: zod.z.string(),
-    users: zod.z.number(),
-    events: zod.z.number()
-  }))
-});
-const analyticsEventSchema = zod.z.object({
-  id: zod.z.string(),
-  timestamp: zod.z.string(),
-  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()
-});
-const userEventsResponseSchema = tinyBirdBaseSchema.extend({
-  data: zod.z.array(analyticsEventSchema)
-});
-const currentUsersRequestSchema = zod.z.object({
-  projectId: zod.z.string(),
-  minutes: zod.z.number(),
-  referrer: zod.z.string().optional(),
-  location: zod.z.string().optional()
-});
-const currentUsersResponseSchema = tinyBirdBaseSchema.extend({
-  data: zod.z.array(zod.z.object({
-    visits: zod.z.number()
-  }))
-});
-const reservedPropertiesSchema = zod.z.object({
-  age: zod.z.number().nullish(),
-  avatar: zod.z.string().url().nullish(),
-  birthday: zod.z.string().nullish(),
-  createdAt: zod.z.string().nullish(),
-  description: zod.z.string().nullish(),
-  email: zod.z.string().email().or(zod.z.literal('')).nullish(),
-  firstName: zod.z.string().nullish(),
-  gender: zod.z.string().nullish(),
-  id: zod.z.string().nullish(),
-  lastName: zod.z.string().nullish(),
-  name: zod.z.string().nullish(),
-  phone: zod.z.string().nullish(),
-  title: zod.z.string().nullish(),
-  username: zod.z.string().nullish(),
-  website: zod.z.string().nullish(),
-  // Default Properties
-  $id: zod.z.string().nullish(),
-  $lastSeen: zod.z.string().nullish(),
-  $lastIdentifiedAt: zod.z.string().nullish(),
-  $unsubscribed: zod.z.boolean().nullish(),
-  $unsubscribeReason: zod.z.enum(['manual', 'complained', 'bounced']).nullish(),
-  // Stripe Properties
-  $stripeCustomerId: zod.z.string().nullish(),
-  $stripeTotalPayments: zod.z.number().or(zod.z.string()).nullish(),
-  $stripeTotalSpent: zod.z.number().or(zod.z.string()).nullish(),
-  // Internal properties
-  $_toDelete: zod.z.boolean().nullish()
-});
-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(),
-  projectId: zod.z.string(),
-  payload: zod.z.string()
-});
-const analyticsUserSchema = analyticsUserRawSchema.omit({
-  payload: true
-}).and(zod.z.object({
-  properties: contactPropertiesSchema
-}));
-const listUsersParamsSchema = zod.z.object({
-  projectId: zod.z.string(),
-  limit: zod.z.number().optional()
-});
-const getAnalyticsUserParamsSchema = zod.z.object({
-  projectId: zod.z.string(),
-  distinctId: zod.z.string()
-});
-const idenfitySchema = zod.z.object({
-  id: zod.z.string(),
-  timestamp: zod.z.string(),
-  projectId: zod.z.string(),
-  distinctId: zod.z.string(),
-  anonymousId: zod.z.string(),
-  version: zod.z.string(),
-  payload: contactPropertiesSchema,
-  context: 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;
-exports.analyticsEventSchema = analyticsEventSchema;
-exports.analyticsUserRawSchema = analyticsUserRawSchema;
-exports.analyticsUserSchema = analyticsUserSchema;
-exports.baseTopRequestSchema = baseTopRequestSchema;
 exports.browserContextSchema = browserContextSchema;
-exports.coerceReservedProperties = coerceReservedProperties;
-exports.contactPropertiesSchema = contactPropertiesSchema;
-exports.createTrackedEventTypeSchema = createTrackedEventTypeSchema;
-exports.currentUsersRequestSchema = currentUsersRequestSchema;
-exports.currentUsersResponseSchema = currentUsersResponseSchema;
-exports.getAnalyticsUserParamsSchema = getAnalyticsUserParamsSchema;
 exports.getBrowserContext = getBrowserContext;
-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.serverContextSchema = serverContextSchema;
-exports.tbAny = tbAny;
 exports.timezones = timezones;
-exports.tinyBirdBaseSchema = tinyBirdBaseSchema;
-exports.topActionsResponseSchema = topActionsResponseSchema;
-exports.topBrowsersResponseSchema = topBrowsersResponseSchema;
-exports.topDevicesResponseSchema = topDevicesResponseSchema;
-exports.topLocationsResponseSchema = topLocationsResponseSchema;
-exports.topPagesResponseSchema = topPagesResponseSchema;
-exports.topSourcesResponseSchema = topSourcesResponseSchema;
-exports.topSourcesSchema = topSourcesSchema;
-exports.trackedEventSchema = trackedEventSchema;
-exports.trackedEventTypesSchema = trackedEventTypesSchema;
-exports.userEventsResponseSchema = userEventsResponseSchema;