saasco-sdk 0.1.0 → 0.1.3

package/README.md

@@ -1,8 +1,5 @@
 [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)
@@ -23,34 +20,23 @@ By default Saasco is privacy friendly, using no cookies and obscuring all activi
 ## Getting Started:
 
 Install by running:
-`npm install saasco-analytics`
+`npm install saasco-sdk`
 
 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" });
-```
+Then import Saasco and initiate the lib with your Project ID.
 
-### Naming Conflict
+```ts
 
-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';
+// lib/saasco.ts
+import { Saasco } from 'saasco-sdk';
 
 // Initiate the lib
-const saascoAnalytics = new SaascoAnalytics({ projectId: "YOUR-PROJECT-ID" });
+const saasco = new Saasco({ projectId: "YOUR-PROJECT-ID" });
+saasco.init();
 
-// Track an event
-saascoAnalytics.track('Something happened');
+export saasco;
 ```
 
 ## Automatic Page View Tracking
@@ -73,14 +59,14 @@ _We like to follow segments [Object Action Framework](https://segment.com/academ
 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';
+// Import saasco
+import { saasco } from '../lib/saasco.ts';
 
 // Track an event
-analytics.track("Searched Movies");
+saasco.track("Searched Movies");
 
 // Track an event with properties
-analytics.track("Searched Movies", {
+saasco.track("Searched Movies", {
 	query:"batman",
 	sortBy:"relevancy"
 });
@@ -93,14 +79,14 @@ By default Saasco does not track any identifiable data about users, just anonymo
 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';
+// Import saasco
+import { saasco } from '../lib/saasco.ts';
 
 // 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", {
+	saasco.identify("USER-ID-FROM-YOUR-DB", {
 		// Any user properties you want to record with the user
 		name:"Tony Hawk",
 		email:"tony@xgames.com",
@@ -110,7 +96,7 @@ function signedIn(){
 
 // When a user logs out you can unidentify by identify null
 function signedOut(){
-	analtyics.identify(null)
+	saasco.identify(null)
 }
 ```
 
@@ -124,7 +110,7 @@ For example:
 
 ```tsx
 // Identify a user only by their email
-analytics.identify({
+saasco.identify({
     name:"Tony Hawk",
     email:"tony@xgames.com",
     bestTrick: 900
@@ -148,7 +134,7 @@ When setting up Saasco analytics you probably want to exclude your local environ
 To do so simply turn on dev mode.
 
 ```tsx
-export const analytics = new Analytics({
+export const saasco = new Saasco({
     projectId: 'YOUR-PROJECT-ID',
 
     // use an env to only set enabled to true on production
@@ -158,10 +144,10 @@ export const analytics = new Analytics({
 
 #### Debugging
 
-You can turn on debugging when you initiate the repo or by running analytics.debug(true) in your code or the browser.
+You can turn on debugging when you initiate the repo or by running saasco.debug(true) in your code or the browser.
 
 ```tsx
-export const analytics = new Analytics({
+export const saasco = new Saasco({
     projectId: 'YOUR-PROJECT-ID',
     enabled: process.env['NODE_ENV'] === 'production',
     // Set to true to console log analytics events.
@@ -170,10 +156,10 @@ export const analytics = new Analytics({
 });
 ```
 
-You can also enable debug mode by calling `analytics.debug(true)` anywhere in your code.
+You can also enable debug mode by calling `saasco.debug(true)` anywhere in your code.
 
 ```tsx
-analytics.debug(true);
+saasco.debug(true);
 // will console log "debug mode activated"
 ```
 
@@ -305,7 +291,7 @@ Event triggered when a user signs up.
 Example:
 
 ```jsx
-analytics.track('Signed Up', {
+saasco.track('Signed Up', {
   source: 'Referral by friend',
 });
 ```
@@ -320,7 +306,7 @@ Event triggered when a user signs in.
 Example:
 
 ```jsx
-analytics.track('Signed In', {
+saasco.track('Signed In', {
   method: 'email',
 });
 ```
@@ -333,7 +319,7 @@ No optional properties.
 Example:
 
 ```jsx
-analytics.track('Signed Out');
+saasco.track('Signed Out');
 ```
 
 #### Trial Started
@@ -347,7 +333,7 @@ Event triggered when a user starts a trial.
 Example:
 
 ```jsx
-analytics.track('Trial Started', { duration: 14, type: 'optOut' });
+saasco.track('Trial Started', { duration: 14, type: 'optOut' });
 ```
 
 #### Trial Completed
@@ -360,7 +346,7 @@ Event triggered when a user successfully completes a trial.
 Example:
 
 ```jsx
-analytics.track('Trial Completed', { daysLeftInTrial: 4 });
+saasco.track('Trial Completed', { daysLeftInTrial: 4 });
 ```
 
 #### Payment Completed
@@ -377,7 +363,7 @@ This is helpful for recording ongoing subscription payments.
 Example:
 
 ```jsx
-analytics.track('Payment Completed', { revenue: 29.99, currency: 'GBP' });
+saasco.track('Payment Completed', { revenue: 29.99, currency: 'GBP' });
 ```
 
 #### Subscription Started
@@ -394,7 +380,7 @@ If you have integrated with stripe for revenue tracking or are doing server side
 Example:
 
 ```jsx
-analytics.track('Subscription Started', {
+saasco.track('Subscription Started', {
   plan: 'Monthly',
 });
 ```
@@ -410,7 +396,7 @@ Event triggered when a subscription is cancelled.
 Example:
 
 ```jsx
-analytics.track('Subscription Cancelled', {
+saasco.track('Subscription Cancelled', {
   reason: 'Not using it any more',
 });
 ```
@@ -430,7 +416,7 @@ Event triggered when a subscription is upgraded.
 Example:
 
 ```jsx
-analytics.track('Subscription Cancelled', {
+saasco.track('Subscription Cancelled', {
   fromPlan: 'Monthly',
   toPlan: 'Annual',
   previousRevenue: 29,
@@ -453,7 +439,7 @@ Event triggered when a subscription is downgraded.
 Example:
 
 ```jsx
-analytics.track('Subscription Cancelled', {
+saasco.track('Subscription Cancelled', {
   fromPlan: 'Annual',
   toPlan: 'Monthly',
   previousRevenue: 129,
@@ -470,7 +456,7 @@ All properties should be added as data attributes in the format data-[prop name]
 
 ```jsx
 <script
-  src="https://saasco.com/sdk/analytics-sdk.js"
+  src="https://saasco.com/sdk/saasco-sdk.js"
   data-projectId="YOUR-PROJECT-ID"
 ></script>
 ```
@@ -479,7 +465,7 @@ All the properties for initiating the sdk can be passed in like this:
 
 ```jsx
 <script
-  src="https://saasco.com/sdk/analytics-sdk.js"
+  src="https://saasco.com/sdk/saasco-sdk.js"
   data-projectId="YOUR-PROJECT-ID"
   data-debug="true" // pass any properties as data params
 ></script>
@@ -488,17 +474,17 @@ All the properties for initiating the sdk can be passed in like this:
 You can then call the track and identify methods like so:
 
 ```jsx
-analytics.track('Searched Movies');
+saasco.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';
+import { Saasco } from 'saasco-sdk';
 
 declare global {
   interface Window {
-    analytics?: Analytics;
+    saasco?: Saasco;
   }
 }
 ```

package/index.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";