saasco-sdk 0.1.19 → 0.1.21

package/index.esm.js

@@ -1,38 +1,8 @@
+import { __awaiter } from 'tslib';
 import { v4 } from '@lukeed/uuid';
 import { z } from 'zod';
-import { useEffect } from 'react';
 
-/******************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-
-function __awaiter(thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-}
-
-typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-};
-
-var version = "0.1.19";
+var version = "0.1.21";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -605,6 +575,8 @@ class Saasco {
       window.saasco = this;
     }
     this.log('Saasco initialized', this.config);
+    if (this.config.debug) this.log('Debug mode active. This will log all events to the console.');
+    if (!this.config.enabled) this.log('Analytics is disabled. No requests will be sent to the server.');
     this.initiAutoPageTracking();
     this.isInitialized = true;
   }
@@ -738,9 +710,11 @@ class Saasco {
     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 (data.action === 'Page View') {
+        this.log('Page View', window.location.href, data);
+      } else {
+        this.log(data.action || path, data);
+      }
       // If analytics is disabled, don't send the request
       if (this.config.enabled === false) return {
         success: false,
@@ -777,18 +751,18 @@ class Saasco {
   log(...args) {
     if (!this.config.debug) return;
     const message = '◍ Saasco Debug';
-    console.info(...[`\x1b[47m\x1b[30m ${message} \x1b[0m`,
+    console.info(
     // Message highlighted for easy finding
-    ...args]);
+    `%c ${message}`, 'background: #eee; color: #000; padding: 2px 4px; border-radius: 2px;', ...args);
   }
   /**
    * @param args Arguments to be logged
    */
   error(...args) {
     const message = '◍ Saasco Error';
-    console.error(...[`\x1b[41m\x1b[37m ${message} \x1b[0m`,
+    console.error(
     // Message highlighted for easy finding
-    ...args]);
+    `%c ${message}`, 'background: red; color: white; padding: 2px 4px; border-radius: 2px;', ...args);
     return {
       success: false,
       message: args.join(' ')
@@ -837,107 +811,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: 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: 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: 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: 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: 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 = z.object({
   $locale: z.string(),
   $location: z.string(),
@@ -950,302 +823,5 @@ const browserContextSchema = z.object({
   $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({
-    name: z.string(),
-    type: z.string()
-  })),
-  statistics: z.object({
-    elapsed: z.number(),
-    rows_read: z.number(),
-    bytes_read: z.number()
-  }),
-  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 latestEventsRequestSchema = z.object({
-  projectId: z.string(),
-  limit: z.number().optional(),
-  payload: z.boolean().optional(),
-  distinctId: z.string().optional(),
-  action: z.string().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(),
-  distinctId: z.string().optional(),
-  unique: z.boolean().optional()
-});
-const latestEventsResponseSchema = tinyBirdBaseSchema.extend({
-  data: z.array(latestEventItemSchema)
-});
-const kpisRequestSchema = z.object({
-  projectId: z.string(),
-  dateTo: z.string().optional(),
-  dateFrom: z.string().optional(),
-  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(kpiSchema)
-});
-const baseTopRequestSchema = z.object({
-  projectId: z.string(),
-  dateTo: z.string().optional(),
-  dateFrom: z.string().optional(),
-  limit: z.number().optional(),
-  skip: z.number().optional(),
-  referrer: z.string().optional(),
-  location: z.string().optional()
-});
-const topPagesResponseSchema = tinyBirdBaseSchema.extend({
-  data: z.array(z.object({
-    pathname: z.string(),
-    users: z.number(),
-    events: z.number()
-  }))
-});
-const topLocationsResponseSchema = tinyBirdBaseSchema.extend({
-  data: z.array(z.object({
-    location: z.string(),
-    users: z.number(),
-    sessions: z.number(),
-    pageViews: z.number(),
-    bounceRate: z.nullable(z.number()),
-    avgSessionSec: z.number()
-  }))
-});
-const topDevicesResponseSchema = tinyBirdBaseSchema.extend({
-  data: z.array(z.object({
-    device: z.string(),
-    visits: z.number(),
-    hits: z.number(),
-    bounceRate: z.nullable(z.number()),
-    avgSessionSec: z.number()
-  }))
-});
-const topBrowsersResponseSchema = tinyBirdBaseSchema.extend({
-  data: z.array(z.object({
-    browser: z.string(),
-    visits: z.number(),
-    hits: z.number(),
-    bounceRate: z.nullable(z.number()),
-    avgSessionSec: z.number()
-  }))
-});
-const topSourcesSchema = z.object({
-  referrer: z.string(),
-  users: z.number(),
-  sessions: z.number(),
-  pageViews: z.number(),
-  bounceRate: z.nullable(z.number()),
-  avgSessionSec: z.number()
-});
-const topSourcesResponseSchema = tinyBirdBaseSchema.extend({
-  data: z.array(topSourcesSchema)
-});
-const topActionsResponseSchema = tinyBirdBaseSchema.extend({
-  data: z.array(z.object({
-    action: z.string(),
-    users: z.number(),
-    events: z.number()
-  }))
-});
-const analyticsEventSchema = z.object({
-  id: z.string(),
-  timestamp: z.string(),
-  projectId: z.string(),
-  anonymousId: z.string(),
-  sessionId: z.string(),
-  distinctId: z.string().nullable(),
-  version: z.string(),
-  action: z.string(),
-  payload: z.string()
-});
-const userEventsResponseSchema = tinyBirdBaseSchema.extend({
-  data: z.array(analyticsEventSchema)
-});
-const currentUsersRequestSchema = z.object({
-  projectId: z.string(),
-  minutes: z.number(),
-  referrer: z.string().optional(),
-  location: z.string().optional()
-});
-const currentUsersResponseSchema = tinyBirdBaseSchema.extend({
-  data: z.array(z.object({
-    visits: z.number()
-  }))
-});
-const reservedPropertiesSchema = z.object({
-  age: z.number().nullish(),
-  avatar: z.string().url().nullish(),
-  birthday: z.string().nullish(),
-  createdAt: z.string().nullish(),
-  description: z.string().nullish(),
-  email: z.string().email().or(z.literal('')).nullish(),
-  firstName: z.string().nullish(),
-  gender: z.string().nullish(),
-  id: z.string().nullish(),
-  lastName: z.string().nullish(),
-  name: z.string().nullish(),
-  phone: z.string().nullish(),
-  title: z.string().nullish(),
-  username: z.string().nullish(),
-  website: z.string().nullish(),
-  // Default Properties
-  $id: z.string().nullish(),
-  $lastSeen: z.string().nullish(),
-  $lastIdentifiedAt: 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({
-  timestamp: z.string(),
-  distinctId: z.string(),
-  projectId: z.string(),
-  payload: z.string()
-});
-const analyticsUserSchema = analyticsUserRawSchema.omit({
-  payload: true
-}).and(z.object({
-  properties: contactPropertiesSchema
-}));
-const listUsersParamsSchema = z.object({
-  projectId: z.string(),
-  limit: z.number().optional()
-});
-const getAnalyticsUserParamsSchema = z.object({
-  projectId: z.string(),
-  distinctId: z.string()
-});
-const idenfitySchema = z.object({
-  id: z.string(),
-  timestamp: z.string(),
-  projectId: z.string(),
-  distinctId: z.string(),
-  anonymousId: z.string(),
-  version: z.string(),
-  payload: contactPropertiesSchema,
-  context: 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
-  }))
-});
-
-function SaascoProvider({
-  projectId,
-  debug = false,
-  enabled = true,
-  proxy
-}) {
-  useEffect(() => {
-    const saasco = new Saasco({
-      projectId,
-      debug,
-      enabled,
-      proxy
-    });
-    saasco.init();
-  }, [projectId, debug, enabled, proxy]);
-  return null;
-}
 
-export { Saasco, SaascoProvider, 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 };
+export { Saasco, browserContextSchema, getBrowserContext, timezones };

package/package.json

@@ -1,16 +1,11 @@
 {
   "name": "saasco-sdk",
-  "version": "0.1.19",
+  "version": "0.1.21",
   "dependencies": {
+    "tslib": "^2.3.0",
     "@lukeed/uuid": "^2.0.1",
     "zod": "^3.22.4"
   },
-  "peerDependencies": {
-    "react": "^18.0.0"
-  },
-  "devDependencies": {
-    "tslib": "^2.3.0"
-  },
   "main": "./index.cjs.js",
   "typings": "./src/index.d.ts",
   "module": "./index.esm.js"

package/src/index.d.ts

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

package/src/lib/getBrowserContext.d.ts

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