@trycourier/courier-js 1.0.0 → 1.2.0

package/README.md

@@ -0,0 +1,45 @@
+[![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
+
+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)
+
+## Installation
+
+```sh
+# npm
+npm install @trycourier/courier-js
+# yarn
+yarn add @trycourier/courier-js
+# pnpm
+pnpm add @trycourier/courier-js
+```
+
+## Usage
+
+```ts
+import courier from "@trycourier/courier-js";
+
+courier.init({
+  clientKey: "<REPLACE_WITH_YOUR_CLIENT_KEY>",
+  debug: true,
+});
+
+/*
+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",
+});
+```
+
+## 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.
+
+```ts
+const prefCenterLink = courier.generatePreferencesUrl("<your_user_id>", {
+  // optional
+  brandId: "<your_brand_id>",
+});
+```

package/dist/index.d.ts

@@ -6,10 +6,13 @@ type CourierOptions = {
     userId?: string;
     userSignature?: string;
 };
+type PreferenceLinkOptions = {
+    brandId?: string;
+};
 declare class Courier {
     private authorization?;
     private baseUrl;
-    private clientKey?;
+    private clientKey;
     private debug?;
     private userId?;
     private userSignature?;
@@ -18,6 +21,7 @@ declare class Courier {
     post<T>(path: string, body: T): Promise<void>;
     put<T>(path: string, body?: T): Promise<void>;
     delete(path: string): Promise<void>;
+    generatePreferencesUrl(userId: string, options?: PreferenceLinkOptions): string;
 }
 
 declare const client: {
@@ -27,6 +31,7 @@ declare const client: {
     identify(userId: string, payload: Record<string, unknown>): Promise<void>;
     subscribe(userId: string, listId: string): Promise<void>;
     unsubscribe(userId: string, listId: string): Promise<void>;
+    generatePreferencesUrl(userId: string, options?: PreferenceLinkOptions): string;
 };
 
 export { client as default };

package/dist/index.js

@@ -25,7 +25,24 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // package.json
-var version = "1.0.0";
+var version = "1.2.0";
+
+// src/helpers/decode.ts
+function decode(clientKey) {
+  const binaryString = atob(clientKey);
+  const bytes = new Uint8Array(binaryString.length);
+  for (let i = 0; i < binaryString.length; i++) {
+    bytes[i] = binaryString.charCodeAt(i);
+  }
+  return String.fromCharCode(...bytes);
+}
+function encode(key) {
+  const bytes = new Uint8Array(key.length);
+  for (let i = 0; i < key.length; i++) {
+    bytes[i] = key.charCodeAt(i);
+  }
+  return btoa(String.fromCharCode(...bytes));
+}
 
 // src/helpers/client.ts
 async function tryCatch(fn, debug = true) {
@@ -46,7 +63,7 @@ var Courier = class {
     userId,
     userSignature
   }) {
-    if (!clientKey || authorization) {
+    if (!clientKey) {
       throw new Error("Courier client key is required");
     }
     this.authorization = authorization;
@@ -98,6 +115,16 @@ var Courier = class {
     };
     await tryCatch(deleteFn, this.debug);
   }
+  generatePreferencesUrl(userId, options) {
+    var _a;
+    if (!userId) {
+      throw new Error("User ID is required to generate preferences URL");
+    }
+    const id = decode(this.clientKey);
+    return `https://view.notificationcenter.app/p/${encode(
+      `${id}#${(_a = options == null ? void 0 : options.brandId) != null ? _a : ""}#${userId}#${false}`
+    )}`;
+  }
 };
 
 // src/index.ts
@@ -116,7 +143,11 @@ var client = {
     if (!userId) {
       throw new Error("userId is required");
     }
-    await this.instance.post(`identify/${userId}`, payload);
+    await this.instance.post(`identify/${userId}`, {
+      profile: {
+        ...payload
+      }
+    });
   },
   async subscribe(userId, listId) {
     if (!userId || !listId) {
@@ -129,6 +160,9 @@ var client = {
       throw new Error("userId is required");
     }
     this.instance.delete(`lists/${listId}/unsubscribe/${userId}`);
+  },
+  generatePreferencesUrl(userId, options) {
+    return this.instance.generatePreferencesUrl(userId, options);
   }
 };
 var src_default = client;

package/dist/index.mjs

@@ -1,5 +1,22 @@
 // package.json
-var version = "1.0.0";
+var version = "1.2.0";
+
+// src/helpers/decode.ts
+function decode(clientKey) {
+  const binaryString = atob(clientKey);
+  const bytes = new Uint8Array(binaryString.length);
+  for (let i = 0; i < binaryString.length; i++) {
+    bytes[i] = binaryString.charCodeAt(i);
+  }
+  return String.fromCharCode(...bytes);
+}
+function encode(key) {
+  const bytes = new Uint8Array(key.length);
+  for (let i = 0; i < key.length; i++) {
+    bytes[i] = key.charCodeAt(i);
+  }
+  return btoa(String.fromCharCode(...bytes));
+}
 
 // src/helpers/client.ts
 async function tryCatch(fn, debug = true) {
@@ -20,7 +37,7 @@ var Courier = class {
     userId,
     userSignature
   }) {
-    if (!clientKey || authorization) {
+    if (!clientKey) {
       throw new Error("Courier client key is required");
     }
     this.authorization = authorization;
@@ -72,6 +89,16 @@ var Courier = class {
     };
     await tryCatch(deleteFn, this.debug);
   }
+  generatePreferencesUrl(userId, options) {
+    var _a;
+    if (!userId) {
+      throw new Error("User ID is required to generate preferences URL");
+    }
+    const id = decode(this.clientKey);
+    return `https://view.notificationcenter.app/p/${encode(
+      `${id}#${(_a = options == null ? void 0 : options.brandId) != null ? _a : ""}#${userId}#${false}`
+    )}`;
+  }
 };
 
 // src/index.ts
@@ -90,7 +117,11 @@ var client = {
     if (!userId) {
       throw new Error("userId is required");
     }
-    await this.instance.post(`identify/${userId}`, payload);
+    await this.instance.post(`identify/${userId}`, {
+      profile: {
+        ...payload
+      }
+    });
   },
   async subscribe(userId, listId) {
     if (!userId || !listId) {
@@ -103,6 +134,9 @@ var client = {
       throw new Error("userId is required");
     }
     this.instance.delete(`lists/${listId}/unsubscribe/${userId}`);
+  },
+  generatePreferencesUrl(userId, options) {
+    return this.instance.generatePreferencesUrl(userId, options);
   }
 };
 var src_default = client;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trycourier/courier-js",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",