saasco-sdk 0.1.0

package/README.md

@@ -0,0 +1,504 @@
+[Saasco](https://www.saasco.com) is a platform of saas apps where members only pay the infrastructure cost of what they use. As a result Saasco apps are up to 99% cheaper than traditional saas products.
+
+The analytics package makes it easy for javascript projects to track website activity.
+Analytics is a core feature of Saasco and is used to power many other apps.
+
+---
+
+- [Privacy](#privacy)
+- [Getting Started](#initiate-the-lib)
+- [Naming Conflict](#naming-conflict)
+- [Automatic Page View Tracking](#automatic-page-view-tracking)
+- [Tracking Events](#tracking-events)
+- [Identifying Users](#identifying-users)
+- [Debugging and Dev](#debugging-and-dev)
+- [Reserved Properties](#reserved-properties)
+
+<br />
+
+## 🔒 Privacy
+
+By default Saasco is privacy friendly, using no cookies and obscuring all activity behind Anonymous IDs. However if you want to power more complex user tracking you can identify users and then all events they do will be attributed to them in your CRM. This can assist with customer support but also for things like drip campaigns and other marketing activities.
+
+## Getting Started:
+
+Install by running:
+`npm install saasco-analytics`
+
+Copy your Project ID from the project settings page in Saasco:
+[https://saasco.com/your-project/settings/project](https://saasco.com/your-projects/settings/project)
+
+Then import Analytics and initiate the lib with your Project ID.
+
+```tsx
+import { Analytics } from 'saasco-analytics';
+
+// Initiate the lib
+export const analytics = new Analytics({ projectId: "YOUR-PROJECT-ID" });
+```
+
+### Naming Conflict
+
+Because “Analytics” is a common name for analytics tools you can simply import with a different name such as “SaascoAnalytics” to avoid conflicts.
+
+For example:
+
+```tsx
+import { Analytics as SaascoAnalytics } from 'saasco-analytics';
+
+// Initiate the lib
+const saascoAnalytics = new SaascoAnalytics({ projectId: "YOUR-PROJECT-ID" });
+
+// Track an event
+saascoAnalytics.track('Something happened');
+```
+
+## Automatic Page View Tracking
+
+When you initial the lib live above Saasco will automatically start tracking all page views in your app. There is no other configuration. It will automatically track url changes, even for SPAs like NextJs and Vue.
+You can also [manually track pages](https://www.notion.so/Manual-Page-Tracking-in-SPAs-2442fc7586dc4208ae8f669eb7561b1a?pvs=21) by opting our of automatic page tracking. For most use cases you don't need to do this.
+
+## Tracking Events
+
+With events you can track custom actions users are taking on your site with event properties.
+
+Each event has 2 components:
+
+**Name** - this is the name of the action that was taken.
+
+_We like to follow segments [Object Action Framework](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/) for naming events._
+
+**Properties** - This is an object with the values of the event. Such as a the value, currency, or query.
+
+We currently have limited support for properties, but in the future we will support complex querying and actions based on event properties.
+
+```tsx
+// Import analytics
+import { analytics } from '../your-analytics';
+
+// Track an event
+analytics.track("Searched Movies");
+
+// Track an event with properties
+analytics.track("Searched Movies", {
+	query:"batman",
+	sortBy:"relevancy"
+});
+```
+
+## Identifying Users
+
+By default Saasco does not track any identifiable data about users, just anonymous user ids and session ids. However if you want to tie events to users you can identify users which will connect events to users in your CRM and power tools like drip campaigns and customer support.
+
+To do this just identify a user with their DistinctId (usually the user ID from your database) and then any properties on the user.
+
+```tsx
+// Import analytics
+import { analytics } from '../your-analytics';
+
+// Inside your user logged in function identify a user
+// You should only identify users when they login, or their properties change
+function signedIn(){
+	// Identify a user
+	analytics.identify("USER-ID-FROM-YOUR-DB", {
+		// Any user properties you want to record with the user
+		name:"Tony Hawk",
+		email:"tony@xgames.com",
+		bestTrick: 900
+	});
+}
+
+// When a user logs out you can unidentify by identify null
+function signedOut(){
+	analtyics.identify(null)
+}
+```
+
+### Identifying users who don't have an ID
+
+Often times you have a users contact details before they sign up for your site. This could be part of the signup flow, or if they were to subscribe to marketing emails before they sign up as a customer
+
+Saasco allows identifying users without an id by simply skipping the `ID` part of the identify call. This will add contacts to the CRM for email marketing and other tools before users register.
+
+For example:
+
+```tsx
+// Identify a user only by their email
+analytics.identify({
+    name:"Tony Hawk",
+    email:"tony@xgames.com",
+    bestTrick: 900
+});
+```
+
+By doing this users will get tracked and added to your contacts, and as soon as they do login, assuming they use the same email address, all their properties will be connected.
+
+### Soft vs Full identify
+
+When users are identified without a `ID` we call this is a "Soft Identify". Users who are soft identified can also be called "Leads".
+Once a user signs up and you identify them with an `ID` they will be fully registered and can be called "Customers"
+
+In the CRM when you identify a user, either soft or full, they become a contact.
+The type of the contact depends on whether they were fully identified, "Leads" are soft and "Customers" are full.
+
+## Debugging and Dev
+
+When setting up Saasco analytics you probably want to exclude your local environment.
+
+To do so simply turn on dev mode.
+
+```tsx
+export const analytics = new Analytics({
+    projectId: 'YOUR-PROJECT-ID',
+
+    // use an env to only set enabled to true on production
+    enabled: process.env['NODE_ENV'] === 'production',
+});
+```
+
+#### Debugging
+
+You can turn on debugging when you initiate the repo or by running analytics.debug(true) in your code or the browser.
+
+```tsx
+export const analytics = new Analytics({
+    projectId: 'YOUR-PROJECT-ID',
+    enabled: process.env['NODE_ENV'] === 'production',
+    // Set to true to console log analytics events.
+    // This works even when enabled is false - it just wont send the data
+    debug: true,
+});
+```
+
+You can also enable debug mode by calling `analytics.debug(true)` anywhere in your code.
+
+```tsx
+analytics.debug(true);
+// will console log "debug mode activated"
+```
+
+## Reserved Properties
+
+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.
+
+### Reserved Contact Properties
+
+| PROPTERTY   | TYPE   | DESCRIPTION                                                                                                       |
+| ----------- | ------ | ----------------------------------------------------------------------------------------------------------------- |
+| age         | Number | Age of a user                                                                                                     |
+| avatar      | String | URL to an avatar image for the user                                                                               |
+| birthday    | Date   | User’s birthday                                                                                                   |
+| createdAt   | Date   | Date the user’s account was first created. We recomend recommend using ISO-8601 date strings.                     |
+| description | String | Description of the user                                                                                           |
+| email       | String | Email address of a user                                                                                           |
+| 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                                                                                            |
+| title       | String | Title of a user, usually related to their position at a specific company. Example: “VP of Engineering”            |
+| username    | String | User’s username. This should be unique to each user, like the usernames of Twitter or GitHub.                     |
+| website     | String | Website of a user                                                                                                 |
+
+### Default Contact Properties
+
+Our SDKs automatically collect certain properties on every event or user profile.
+Any property that starts with `$` is a property that has been generated by the SDK or ingestion.
+
+| 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.                                                   |
+| $timezone               | Timezone                    | Timezone of the user parsed from the IP.                                               |
+| $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                               |
+| $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.                                            |
+| $initialReferrer        | Initial Referrer            | Referring URL when the user first arrived on your site. Defaults to "direct"           |
+| $referrer               | Last Touch Referrer         | Referring URL when the user last interacted with your site. Defaults to "direct"       |
+| $initialReferringDomain | Initial Referring Domain    | Referring domain at first arrival. Defaults to "direct"                                |
+| $referringDomain        | Last Touch Referring Domain | Referring domain at the user's last interaction. Defaults to "direct"                  |
+| $initialUtmSource       | Initial UTM Source          | The initial UTM source tag from the URL a customer clicked to arrive at your domain.   |
+| $utmSource              | Last Touch UTM Source       | The UTM source tag from the URL a customer clicked during their last interaction.      |
+| $initialUtmMedium       | Initial UTM Medium          | The initial UTM medium tag from the URL a customer clicked to arrive at your domain.   |
+| $utmMedium              | Last Touch UTM Medium       | The UTM medium tag from the URL a customer clicked during their last interaction.      |
+| $initialUtmCampaign     | Initial UTM Campaign        | The initial UTM campaign tag from the URL a customer clicked to arrive at your domain. |
+| $utmCampaign            | Last Touch UTM Campaign     | The UTM campaign tag from the URL a customer clicked during their last interaction.    |
+| $initialUtmTerm         | Initial UTM Term            | The initial UTM term tag from the URL a customer clicked to arrive at your domain.     |
+| $utmTerm                | Last Touch UTM Term         | The UTM term tag from the URL a customer clicked during their last interaction.        |
+| $initialUtmContent      | Initial UTM Content         | The initial UTM content tag from the URL a customer clicked to arrive at your domain.  |
+| $utmContent             | Last Touch UTM Content      | The UTM content tag from the URL a customer clicked during their last interaction.     |
+| $unsubscribed           | Unsubscribed                | Whether the user has unsubscribed from all notifications                               |
+
+### Reserved event properties
+
+Properties used to calculate revenue for different traffic sources and LTV for users.
+
+| PROPERTY | TYPE   | DESCRIPTION                                                                               |
+| -------- | ------ | ----------------------------------------------------------------------------------------- |
+| revenue  | Number | Amount of revenue an event resulted in. This should be a decimal value                    |
+| currency | String | Currency of the revenue an event resulted in. This should be sent in the ISO 4127 format. |
+| value    | Number | An abstract numerical value used internally to score eventsm such as lead scoring.        |
+
+### Default Event Properties
+
+Our SDKs automatically collect certain properties on every event or user profile. The default properties begin with a `$` and can be overwritten with your own identify calls, so we recomend avoiding leading `$` in your identify call properties to avoid conflicts.
+
+| 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.                                             |
+| $timezone        | Timezone                    | Timezone of the user parsed from the IP.                                         |
+| $screenHeight    | Screen Height               | The height of the device screen in pixels                                        |
+| $screenWidth     | Screen Width                | The width of the device screen in pixels                                         |
+| $screenDpi       | Screen DPI                  | Pixel density of the device screen.                                              |
+| $currentUrl      | Current URL                 | The URL of the page on which the event was tracked.                              |
+| $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.                                      |
+| $device          | Device Type                 | The most recent bowser version of the user. eg `Mobile`, `Tablet`, `Desktop`     |
+| $referrer        | Last Touch Referrer         | Referring URL when the user last interacted with your site. Defaults to "direct" |
+| $referringDomain | Last Touch Referring Domain | Referring domain at the user's last interaction. Defaults to "direct"            |
+| $utmSource       | UTM Source                  | The UTM source tag from the URL a customer clicked to arrive at your domain.     |
+| $utmMedium       | UTM Medium                  | The UTM medium tag from the URL a customer clicked to arrive at your domain.     |
+| $utmCampaign     | UTM Campaign                | The UTM campaign tag from the URL a customer clicked to arrive at your domain.   |
+| $utmTerm         | UTM Term                    | The UTM term tag from the URL a customer clicked to arrive at your domain.       |
+| $utmContent      | UTM Content                 | The UTM content tag from the URL a customer clicked to arrive at your domain.    |
+
+### Reserved Events with Optional Properties
+
+> ⚠️ The event schema described below is not yet implemented in the UI. However, if you wish to future-proof your implementation, you can start using this schema in anticipation of its integration.
+
+Reserved events are common events that happen during the lifecycle of a user, with optional properties to capture more detailed information, including revenue data where appropriate.
+
+- [Signed Up](#signed-up)
+- [Signed In](#signed-in)
+- [Signed Out](#signed-out)
+- [Trial Started](#trial-started)
+- [Trial Completed](#trial-completed)
+- [Payment Completed](#payment-completed)
+- [Subscription Started](#subscription-started)
+- [Subscription Cancelled](#subscription-cancelled)
+- [Subscription Upgraded](#subscription-upgraded)
+- [Subscription Downgraded](#subscription-downgraded)
+
+#### Signed Up
+
+Event triggered when a user signs up.
+| Property | Description |
+|----------|----------------------------------|
+| `source` | How the user found your site. |
+| `value` | Track an estimated value of the signup|
+
+Example:
+
+```jsx
+analytics.track('Signed Up', {
+  source: 'Referral by friend',
+});
+```
+
+#### Signed In
+
+Event triggered when a user signs in.
+| Property | Description |
+|----------|--------------------------------------------------|
+| `method` | The method used for signing in (e.g., email, social media). |
+
+Example:
+
+```jsx
+analytics.track('Signed In', {
+  method: 'email',
+});
+```
+
+#### Signed Out
+
+Event triggered when a user signs out.
+No optional properties.
+
+Example:
+
+```jsx
+analytics.track('Signed Out');
+```
+
+#### Trial Started
+
+Event triggered when a user starts a trial.
+| Property | Description |
+|-------------------|---------------------------------------------------------------------|
+| `duration` | The duration of the trial in days |
+| `type`| Values can be `optIn` for then the user didn't provide a cc or `optOut` when the user provided a cc and it will automatically start and the end of the trial period|
+
+Example:
+
+```jsx
+analytics.track('Trial Started', { duration: 14, type: 'optOut' });
+```
+
+#### Trial Completed
+
+Event triggered when a user successfully completes a trial.
+| Property | Description |
+|-------------------|---------------------------------------------------------------------|
+| `daysLeftInTrial`| If a user manual upgrades before the end of the trial you can record this here|
+
+Example:
+
+```jsx
+analytics.track('Trial Completed', { daysLeftInTrial: 4 });
+```
+
+#### Payment Completed
+
+Event triggered when a payment is completed.
+This is may be called on the server side after a confirmation webhook.
+This is helpful for recording ongoing subscription payments.
+
+| Property   | Description                                         |
+| ---------- | --------------------------------------------------- |
+| `revenue`  | The initial payment amount.                         |
+| `currency` | The currency of the payment, otherwise assumed USD. |
+
+Example:
+
+```jsx
+analytics.track('Payment Completed', { revenue: 29.99, currency: 'GBP' });
+```
+
+#### Subscription Started
+
+Event triggered when a user starts a subscription.
+If you have integrated with stripe for revenue tracking or are doing server side revenue tracking with webhooks you should skip the `revenue` and `currency` properties to prevent duplicate revenue tracking.
+
+| Property   | Description                                                                                                             |
+| ---------- | ----------------------------------------------------------------------------------------------------------------------- |
+| `plan`     | The name or ID of the subscription plan.                                                                                |
+| `revenue`  | The initial payment amount. Exclude if triggering `Payment Completed` to avoid double counting.                         |
+| `currency` | The currency of the payment, otherwise assumed USD. Exclude if triggering `Payment Completed` to avoid double counting. |
+
+Example:
+
+```jsx
+analytics.track('Subscription Started', {
+  plan: 'Monthly',
+});
+```
+
+#### Subscription Cancelled
+
+Event triggered when a subscription is cancelled.
+
+| Property | Description                                                                                        |
+| -------- | -------------------------------------------------------------------------------------------------- |
+| `reason` | The reason for cancellation. This can be used in the feedback and analysis of cancellation reasons |
+
+Example:
+
+```jsx
+analytics.track('Subscription Cancelled', {
+  reason: 'Not using it any more',
+});
+```
+
+#### Subscription Upgraded
+
+Event triggered when a subscription is upgraded.
+| Property | Description |
+|-----------------|-----------------------------------------------------------------------------------------------|
+| `fromPlan` | The previous plan. |
+| `toPlan` | The new plan. |
+| `previousRevenue` | The revenue from the previous plan. |
+| `newRevenue` | The revenue from the new plan. |
+| `revenue` | If the customer is charged immediately then include a revenue number here |
+| `currency` | The currency of the payment, assumed to be USD unless otherwise specified. |
+
+Example:
+
+```jsx
+analytics.track('Subscription Cancelled', {
+  fromPlan: 'Monthly',
+  toPlan: 'Annual',
+  previousRevenue: 29,
+  newRevenue: 129,
+});
+```
+
+#### Subscription Downgraded
+
+Event triggered when a subscription is downgraded.
+| Property | Description |
+|------------|-------------------|
+| `fromPlan` | The previous plan. |
+| `toPlan` | The new plan. |
+| `previousRevenue` | The revenue from the previous plan. |
+| `newRevenue` | The revenue from the new plan. |
+| `revenue` | If the customer is refunded immediately then include a revenue number here, in the case of a downgrade this will be a negtive value. Only include the revenue here if it's not tracked on your backend or with a webhook |
+| `currency` | The currency of the payment, assumed to be USD unless otherwise specified. |
+
+Example:
+
+```jsx
+analytics.track('Subscription Cancelled', {
+  fromPlan: 'Annual',
+  toPlan: 'Monthly',
+  previousRevenue: 129,
+  newRevenue: 29,
+  revenue: -36,
+  currency: 'USD',
+});
+```
+
+## Use the hosted SDK
+
+To use the hosted JS SDK, add the following script to your HTML header:
+All properties should be added as data attributes in the format data-[prop name]
+
+```jsx
+<script
+  src="https://saasco.com/sdk/analytics-sdk.js"
+  data-projectId="YOUR-PROJECT-ID"
+></script>
+```
+
+All the properties for initiating the sdk can be passed in like this:
+
+```jsx
+<script
+  src="https://saasco.com/sdk/analytics-sdk.js"
+  data-projectId="YOUR-PROJECT-ID"
+  data-debug="true" // pass any properties as data params
+></script>
+```
+
+You can then call the track and identify methods like so:
+
+```jsx
+analytics.track('Searched Movies');
+```
+
+For type safety in your TypeScript project, you can use the following in an `index.d.ts` file
+
+```jsx
+import { Analytics } from 'saasco-analytics';
+
+declare global {
+  interface Window {
+    analytics?: Analytics;
+  }
+}
+```

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "saasco-sdk",
+  "version": "0.1.0",
+  "dependencies": {
+    "tslib": "^2.3.0",
+    "@lukeed/uuid": "^2.0.1",
+    "zod": "^3.22.4"
+  },
+  "type": "module",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "module": "./src/index.js"
+}

package/src/index.d.ts

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

package/src/index.js

@@ -0,0 +1,4 @@
+export * from './lib/analytics';
+export * from './lib/coerceReservedProperties';
+export * from './lib/types';
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../libs/analytics/shared/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,aAAa,CAAC"}

package/src/lib/analytics.d.ts

@@ -0,0 +1,77 @@
+declare global {
+    interface Window {
+        saascoAutoPageTrackingActive?: boolean;
+    }
+}
+export declare class Analytics {
+    private config;
+    private lastPageViewHref;
+    /**
+     * Creates an instance of Analytics.
+     * @param config Configuration options for analytics.
+     * @param config.projectId The unique identifier for the project.
+     * @param config.proxy The URL of the proxy server to use, if any.
+     * @param config.autoPageTracking Whether to automatically track page views. Default is false.
+     * @param config.enabled Whether analytics is enabled. Default is true. Set to false for development and staging envioronments. Will still allow debug mode to be true, just no events will be sent
+     * @param config.debug Whether to log debug information. Default is false.
+     */
+    constructor(config: {
+        projectId: string;
+        proxy?: string;
+        autoPageTracking?: boolean;
+        enabled?: boolean;
+        debug?: boolean;
+    });
+    init(): void;
+    debug(value: boolean): void;
+    /**
+     * The track method lets you record the actions your users perform.
+     * Its good to keep a conistent naming convention for your events.
+     * We like the Object Action Framework from segment:
+     * https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/
+     *
+     * @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;
+    /**
+     * 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;
+    /**
+     * 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.
+     * You can also identify a user as null when they logout to clear the user
+     *
+     * @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.
+     */
+    identify(properties: Record<string, any>, options?: {
+        active?: boolean;
+    }): void;
+    identify(distinctId: string | number | null, properties?: Record<string, any>, options?: {
+        active?: boolean;
+    }): void;
+    /**
+     * Handles sending data to the Saasco Analytics API
+     * If you have a proxy set up, it will send the data to the proxy and you can handle forawrding the data to the Saasco events API
+     * @param path
+     * @param data
+     */
+    private doRequest;
+    /**
+     * @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
+     * @returns
+     */
+    private initiAutoPageTracking;
+}