@trycourier/courier-js 1.2.0 → 1.4.2

package/README.md

@@ -1,10 +1,73 @@
 [![Courier: Your Complete Communication Stack](https://www.courier.com/_next/image/?url=https%3A%2F%2Fimages.ctfassets.net%2Fz7iqk1q8njt4%2F1PZo9WNTdmoDoYH3yulXa0%2Fb10830f7bfb09af5e644a39ac3d20c41%2FCourierJS_header_alt2.png&w=1920&q=75)](https://courier.com)
 
-## Requirements
+# Overview
+SDK used by client applications to interface with the Courier API.
+ 
+<table>
+    <thead>
+        <tr>
+            <th width="880px" align="left">Requirements</th>
+            <th width="120px" align="center"></th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr width="600px">
+            <td align="left">Courier Account</td>
+            <td align="center">
+                <a href="https://app.courier.com/signup">
+                    <code>Sign Up</code>
+                </a>
+            </td>
+        </tr>
+        <tr width="600px">
+            <td align="left">Client API Key</td>
+            <td align="center">
+                <a href="https://app.courier.com/settings/api-keys">
+                    <code>Get key</code>
+                </a>
+            </td>
+        </tr>
+    </tbody>
+</table>
+&emsp;
 
-Sign up to [Courier](https://app.courier.com/signup) if you do not have an account with us and get your clientKey from [here](https://app.courier.com/settings/api-keys)
+# Supported Interfaces
+<table>
+    <thead>
+        <tr>
+            <th width="250px" align="left">Feature</th>
+            <th width="725px" align="left">Description</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr width="600px">
+            <td align="left">
+              <code>Identify</code>
+            </td>
+            <td align="left">
+                Event that triggers a user <a href="https://www.courier.com/docs/reference/profiles/create/"><code>Create</code></a> or <a href="https://www.courier.com/docs/reference/profiles/patch/"><code>Update</code></a> within Courier Profiles.
+            </td>
+        </tr>
+        <tr width="600px">
+            <td align="left">
+              <code>Track</code>
+            </td>
+            <td align="left">
+                Event ingested by Courier can be used to<a href="https://www.courier.com/docs/automations/designer/"> trigger an automation</a> or supply inline payloads within an <a href="https://app.courier.com/automations">existing</a> automation workflow.
+            </td>
+        </tr>
+        <tr width="600px">
+            <td align="left">
+                <code>GeneratePreferencesUrl</code>
+            </td>
+            <td align="left">
+                Generates URL that can be used to link users to <a href="https://www.courier.com/docs/courier-preferences/preference-center/introduction/">Preferences Center</a> to manage their notification preferences.
+            </td>
+        </tr>
+    </tbody>
+</table>
 
-## Installation
+# Installation
 
 ```sh
 # npm
@@ -14,32 +77,47 @@ yarn add @trycourier/courier-js
 # pnpm
 pnpm add @trycourier/courier-js
 ```
+&emsp;
+# Usage
 
-## Usage
-
+## Initializing Client
 ```ts
 import courier from "@trycourier/courier-js";
 
 courier.init({
   clientKey: "<REPLACE_WITH_YOUR_CLIENT_KEY>",
-  debug: true,
+  debug: true, // debug enables client side logs for error catching
 });
-
-/*
-Upon initialization, you can use the SDK. All the methods are async and return a Promise `user | identify` means that you are identifying a user with a unique id in Courier and optionally passing in some user attributes like email, phone, etc. so that you can reach out to your users on right channels of their choice.
-*/
-courier.identify("<your_user_id>", {
-  email: "suhas+from+ui@courier.com",
+```
+## Identify
+```ts
+await courierSDK.identify("purbleUserId", {
+      email: "customer@purbleplace.com",
+      favoriteColor: "purple",
 });
 ```
-
-## Send User to Preference Center
-
-This method generates a URL that you can use to send your users to the Courier Preference Center to let them manage their notification preferences. You can use this URL in your application to send your users to the Preference Center.
-
+## Track
+### Basic
 ```ts
-const prefCenterLink = courier.generatePreferencesUrl("<your_user_id>", {
+await courierSDK.track("user-signup");
+```
+### With data payload
+```ts
+await courierSDK.track("bake-cake", { 
+    cakeFlavor: "carrot", 
+    frosting: "cream cheese"
+});
+```
+## GeneratePreferencesUrl
+```ts
+const prefCenterLink = courier.generatePreferencesUrl("<user-id>", {
   // optional
-  brandId: "<your_brand_id>",
+  brandId: "<brand-id>",
 });
 ```
+# **Share feedback with Courier**
+
+We are building the best SDKs for handling notifications! Have an idea or feedback about our SDKs? Here are some links to contact us:
+
+- [Courier Feedback](https://feedback.courier.com/)
+- [Courier JS Issues](https://github.com/trycourier/courier-js/issues)

package/dist/index.d.ts

@@ -8,6 +8,7 @@ type CourierOptions = {
 };
 type PreferenceLinkOptions = {
     brandId?: string;
+    tenantId?: string;
 };
 declare class Courier {
     private authorization?;
@@ -18,10 +19,11 @@ declare class Courier {
     private userSignature?;
     constructor({ authorization, baseUrl, clientKey, debug, userId, userSignature, }: CourierOptions);
     private getHeaders;
-    post<T>(path: string, body: T): Promise<void>;
-    put<T>(path: string, body?: T): Promise<void>;
-    delete(path: string): Promise<void>;
+    post<T>(path: string, body: T, useClientPath?: boolean): Promise<void>;
+    put<T>(path: string, body?: T, useClientPath?: boolean): Promise<void>;
+    delete(path: string, useClientPath?: boolean): Promise<void>;
     generatePreferencesUrl(userId: string, options?: PreferenceLinkOptions): string;
+    private getPathURL;
 }
 
 declare const client: {
@@ -30,6 +32,7 @@ declare const client: {
     readonly instance: Courier;
     identify(userId: string, payload: Record<string, unknown>): Promise<void>;
     subscribe(userId: string, listId: string): Promise<void>;
+    track(event: string, properties?: Record<string, unknown>): Promise<void>;
     unsubscribe(userId: string, listId: string): Promise<void>;
     generatePreferencesUrl(userId: string, options?: PreferenceLinkOptions): string;
 };

package/dist/index.js

@@ -25,7 +25,7 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // package.json
-var version = "1.2.0";
+var version = "1.4.2";
 
 // src/helpers/decode.ts
 function decode(clientKey) {
@@ -67,7 +67,7 @@ var Courier = class {
       throw new Error("Courier client key is required");
     }
     this.authorization = authorization;
-    this.baseUrl = `${baseUrl != null ? baseUrl : "https://api.courier.com"}/client/`;
+    this.baseUrl = `${baseUrl != null ? baseUrl : "https://api.courier.com"}`;
     this.clientKey = clientKey;
     this.debug = debug;
     this.userId = userId;
@@ -86,9 +86,9 @@ var Courier = class {
       ...this.clientKey && { "x-courier-client-key": this.clientKey }
     });
   }
-  async post(path, body) {
+  async post(path, body, useClientPath = true) {
     const postFn = () => {
-      return fetch(`${this.baseUrl}${path}`, {
+      return fetch(this.getPathURL(path, useClientPath), {
         body: JSON.stringify(body),
         headers: this.getHeaders(),
         method: "POST"
@@ -96,9 +96,9 @@ var Courier = class {
     };
     await tryCatch(postFn, this.debug);
   }
-  async put(path, body) {
+  async put(path, body, useClientPath = true) {
     const putFn = () => {
-      return fetch(`${this.baseUrl}${path}`, {
+      return fetch(this.getPathURL(path, useClientPath), {
         ...body ? { body: JSON.stringify(body) } : {},
         headers: this.getHeaders(),
         method: "PUT"
@@ -106,9 +106,9 @@ var Courier = class {
     };
     await tryCatch(putFn, this.debug);
   }
-  async delete(path) {
+  async delete(path, useClientPath = true) {
     const deleteFn = () => {
-      return fetch(`${this.baseUrl}${path}`, {
+      return fetch(this.getPathURL(path, useClientPath), {
         headers: this.getHeaders(),
         method: "DELETE"
       });
@@ -122,9 +122,16 @@ var Courier = class {
     }
     const id = decode(this.clientKey);
     return `https://view.notificationcenter.app/p/${encode(
-      `${id}#${(_a = options == null ? void 0 : options.brandId) != null ? _a : ""}#${userId}#${false}`
+      `${id}#${(_a = options == null ? void 0 : options.brandId) != null ? _a : ""}#${userId}${(options == null ? void 0 : options.tenantId) ? `#${options.tenantId}` : ""}#${false}`
     )}`;
   }
+  getPathURL(path, useClientPath) {
+    let pathUrl = this.baseUrl;
+    if (useClientPath) {
+      pathUrl = pathUrl.concat("/client");
+    }
+    return pathUrl.concat(path);
+  }
 };
 
 // src/index.ts
@@ -143,7 +150,7 @@ var client = {
     if (!userId) {
       throw new Error("userId is required");
     }
-    await this.instance.post(`identify/${userId}`, {
+    await this.instance.post(`/identify/${userId}`, {
       profile: {
         ...payload
       }
@@ -153,13 +160,25 @@ var client = {
     if (!userId || !listId) {
       throw new Error("userId is required");
     }
-    await this.instance.put(`lists/${listId}/subscribe/${userId}`);
+    await this.instance.put(`/lists/${listId}/subscribe/${userId}`);
+  },
+  async track(event, properties) {
+    if (!event) {
+      throw new Error("event is required");
+    }
+    let indempotentKey = self.crypto.randomUUID ? self.crypto.randomUUID() : Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
+    await this.instance.post(`/inbound/courier`, {
+      messageId: indempotentKey,
+      type: "track",
+      event,
+      properties: { ...properties }
+    }, false);
   },
   async unsubscribe(userId, listId) {
     if (!userId || !listId) {
       throw new Error("userId is required");
     }
-    this.instance.delete(`lists/${listId}/unsubscribe/${userId}`);
+    this.instance.delete(`/lists/${listId}/unsubscribe/${userId}`);
   },
   generatePreferencesUrl(userId, options) {
     return this.instance.generatePreferencesUrl(userId, options);

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // package.json
-var version = "1.2.0";
+var version = "1.4.2";
 
 // src/helpers/decode.ts
 function decode(clientKey) {
@@ -41,7 +41,7 @@ var Courier = class {
       throw new Error("Courier client key is required");
     }
     this.authorization = authorization;
-    this.baseUrl = `${baseUrl != null ? baseUrl : "https://api.courier.com"}/client/`;
+    this.baseUrl = `${baseUrl != null ? baseUrl : "https://api.courier.com"}`;
     this.clientKey = clientKey;
     this.debug = debug;
     this.userId = userId;
@@ -60,9 +60,9 @@ var Courier = class {
       ...this.clientKey && { "x-courier-client-key": this.clientKey }
     });
   }
-  async post(path, body) {
+  async post(path, body, useClientPath = true) {
     const postFn = () => {
-      return fetch(`${this.baseUrl}${path}`, {
+      return fetch(this.getPathURL(path, useClientPath), {
         body: JSON.stringify(body),
         headers: this.getHeaders(),
         method: "POST"
@@ -70,9 +70,9 @@ var Courier = class {
     };
     await tryCatch(postFn, this.debug);
   }
-  async put(path, body) {
+  async put(path, body, useClientPath = true) {
     const putFn = () => {
-      return fetch(`${this.baseUrl}${path}`, {
+      return fetch(this.getPathURL(path, useClientPath), {
         ...body ? { body: JSON.stringify(body) } : {},
         headers: this.getHeaders(),
         method: "PUT"
@@ -80,9 +80,9 @@ var Courier = class {
     };
     await tryCatch(putFn, this.debug);
   }
-  async delete(path) {
+  async delete(path, useClientPath = true) {
     const deleteFn = () => {
-      return fetch(`${this.baseUrl}${path}`, {
+      return fetch(this.getPathURL(path, useClientPath), {
         headers: this.getHeaders(),
         method: "DELETE"
       });
@@ -96,9 +96,16 @@ var Courier = class {
     }
     const id = decode(this.clientKey);
     return `https://view.notificationcenter.app/p/${encode(
-      `${id}#${(_a = options == null ? void 0 : options.brandId) != null ? _a : ""}#${userId}#${false}`
+      `${id}#${(_a = options == null ? void 0 : options.brandId) != null ? _a : ""}#${userId}${(options == null ? void 0 : options.tenantId) ? `#${options.tenantId}` : ""}#${false}`
     )}`;
   }
+  getPathURL(path, useClientPath) {
+    let pathUrl = this.baseUrl;
+    if (useClientPath) {
+      pathUrl = pathUrl.concat("/client");
+    }
+    return pathUrl.concat(path);
+  }
 };
 
 // src/index.ts
@@ -117,7 +124,7 @@ var client = {
     if (!userId) {
       throw new Error("userId is required");
     }
-    await this.instance.post(`identify/${userId}`, {
+    await this.instance.post(`/identify/${userId}`, {
       profile: {
         ...payload
       }
@@ -127,13 +134,25 @@ var client = {
     if (!userId || !listId) {
       throw new Error("userId is required");
     }
-    await this.instance.put(`lists/${listId}/subscribe/${userId}`);
+    await this.instance.put(`/lists/${listId}/subscribe/${userId}`);
+  },
+  async track(event, properties) {
+    if (!event) {
+      throw new Error("event is required");
+    }
+    let indempotentKey = self.crypto.randomUUID ? self.crypto.randomUUID() : Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
+    await this.instance.post(`/inbound/courier`, {
+      messageId: indempotentKey,
+      type: "track",
+      event,
+      properties: { ...properties }
+    }, false);
   },
   async unsubscribe(userId, listId) {
     if (!userId || !listId) {
       throw new Error("userId is required");
     }
-    this.instance.delete(`lists/${listId}/unsubscribe/${userId}`);
+    this.instance.delete(`/lists/${listId}/unsubscribe/${userId}`);
   },
   generatePreferencesUrl(userId, options) {
     return this.instance.generatePreferencesUrl(userId, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trycourier/courier-js",
-  "version": "1.2.0",
+  "version": "1.4.2",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -13,8 +13,8 @@
     "eslint": "^7.32.0",
     "tsup": "^5.10.1",
     "typescript": "^4.5.3",
-    "@trycourier/tsconfig": "1.0.0",
-    "eslint-config-courier": "1.0.0"
+    "eslint-config-courier": "1.0.0",
+    "@trycourier/tsconfig": "1.0.0"
   },
   "publishConfig": {
     "access": "public"