@knocklabs/client 0.8.14 → 0.8.16

package/README.md

@@ -43,10 +43,6 @@ knockClient.authenticate(
 );
 ```
 
-## Usage
-
-You can find an example usage in a React application in the [example/App.js](https://github.com/knocklabs/client-js/blob/main/example/src/App.js) file, which is a plain-old Create React App.
-
 ### Retrieving new items from the feed
 
 ```typescript
@@ -159,7 +155,7 @@ feedClient.markAsUnarchived(feedItemOrItems);
 
 ```typescript
 // Set an entire preference set
-await knockClient.preferences.set({
+await knockClient.user.setPreferences({
   channel_types: { email: true, sms: false },
   workflows: {
     "dinosaurs-loose": {
@@ -169,16 +165,29 @@ await knockClient.preferences.set({
 });
 
 // Retrieve a whole preference set
-const preferences = await knockClient.preferences.get();
+const preferences = await knockClient.user.getPreferences();
+
+// Retrieve all preference sets for the user
+const preferenceSets = await knockClient.user.getAllPreferences();
+```
+
+### Managing the current user's channel data
 
-// Granular preference setting for channel types
-await knockClient.preferences.setChannelType("email", false);
+```typescript
+// Get user channel data
+const channelData = await knockClient.user.getChannelData({
+  channelId: "uuid-knock-channel-id",
+});
+```
 
-// Granular preference setting for workflows
-await knockClient.preferences.setWorkflow("dinosaurs-loose", {
-  channel_types: {
-    email: true,
-    in_app_feed: false,
+```typescript
+// Set push channel data for a user
+await knockClient.user.setChannelData({
+  channelId: "uuid-knock-channel-id",
+  channelData: {
+    tokens: ["apns-user-push-token"],
   },
 });
 ```
+
+See provider requirements for setting channel data [here]("https://docs.knock.app/managing-recipients/setting-channel-data#provider-data-requirements").

package/dist/cjs/api.js

@@ -1,28 +1,18 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _axios = _interopRequireDefault(require("axios"));
-
 var _axiosRetry = _interopRequireDefault(require("axios-retry"));
-
 var _phoenix = require("phoenix");
-
 var ApiClient = /*#__PURE__*/function () {
   function ApiClient(options) {
     (0, _classCallCheck2["default"])(this, ApiClient);
@@ -33,8 +23,9 @@ var ApiClient = /*#__PURE__*/function () {
     (0, _defineProperty2["default"])(this, "socket", void 0);
     this.host = options.host;
     this.apiKey = options.apiKey;
-    this.userToken = options.userToken || null; // Create a retryable axios client
+    this.userToken = options.userToken || null;
 
+    // Create a retryable axios client
     this.axiosClient = _axios["default"].create({
       baseURL: this.host,
       headers: {
@@ -44,7 +35,6 @@ var ApiClient = /*#__PURE__*/function () {
         "X-Knock-User-Token": this.userToken
       }
     });
-
     if (typeof window !== "undefined") {
       this.socket = new _phoenix.Socket("".concat(this.host.replace("http", "ws"), "/ws/v1"), {
         params: {
@@ -53,59 +43,50 @@ var ApiClient = /*#__PURE__*/function () {
         }
       });
     }
-
     (0, _axiosRetry["default"])(this.axiosClient, {
       retries: 3,
       retryCondition: this.canRetryRequest,
       retryDelay: _axiosRetry["default"].exponentialDelay
     });
   }
-
   (0, _createClass2["default"])(ApiClient, [{
     key: "makeRequest",
     value: function () {
       var _makeRequest = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(req) {
         var result;
         return _regenerator["default"].wrap(function _callee$(_context) {
-          while (1) {
-            switch (_context.prev = _context.next) {
-              case 0:
-                _context.prev = 0;
-                _context.next = 3;
-                return this.axiosClient(req);
-
-              case 3:
-                result = _context.sent;
-                return _context.abrupt("return", {
-                  statusCode: result.status < 300 ? "ok" : "error",
-                  body: result.data,
-                  error: undefined,
-                  status: result.status
-                });
-
-              case 7:
-                _context.prev = 7;
-                _context.t0 = _context["catch"](0);
-                console.error(_context.t0);
-                return _context.abrupt("return", {
-                  statusCode: "error",
-                  status: 500,
-                  body: undefined,
-                  error: _context.t0
-                });
-
-              case 11:
-              case "end":
-                return _context.stop();
-            }
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.prev = 0;
+              _context.next = 3;
+              return this.axiosClient(req);
+            case 3:
+              result = _context.sent;
+              return _context.abrupt("return", {
+                statusCode: result.status < 300 ? "ok" : "error",
+                body: result.data,
+                error: undefined,
+                status: result.status
+              });
+            case 7:
+              _context.prev = 7;
+              _context.t0 = _context["catch"](0);
+              console.error(_context.t0);
+              return _context.abrupt("return", {
+                statusCode: "error",
+                status: 500,
+                body: undefined,
+                error: _context.t0
+              });
+            case 11:
+            case "end":
+              return _context.stop();
           }
         }, _callee, this, [[0, 7]]);
       }));
-
       function makeRequest(_x) {
         return _makeRequest.apply(this, arguments);
       }
-
       return makeRequest;
     }()
   }, {
@@ -115,28 +96,24 @@ var ApiClient = /*#__PURE__*/function () {
       if (_axiosRetry["default"].isNetworkError(error)) {
         return true;
       }
-
       if (!error.response) {
         // Cannot determine if the request can be retried
         return false;
-      } // Retry Server Errors (5xx).
-
+      }
 
+      // Retry Server Errors (5xx).
       if (error.response.status >= 500 && error.response.status <= 599) {
         return true;
-      } // Retry if rate limited.
-
+      }
 
+      // Retry if rate limited.
       if (error.response.status === 429) {
         return true;
       }
-
       return false;
     }
   }]);
   return ApiClient;
 }();
-
-var _default = ApiClient;
-exports["default"] = _default;
+var _default = exports["default"] = ApiClient;
 //# sourceMappingURL=api.js.map

package/dist/cjs/api.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/api.ts"],"names":["ApiClient","options","host","apiKey","userToken","axiosClient","axios","create","baseURL","headers","Accept","Authorization","window","socket","Socket","replace","params","user_token","api_key","retries","retryCondition","canRetryRequest","retryDelay","axiosRetry","exponentialDelay","req","result","statusCode","status","body","data","error","undefined","console","isNetworkError","response"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;;AACA;;AACA;;IAkBMA,S;AAQJ,qBAAYC,OAAZ,EAAuC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACrC,SAAKC,IAAL,GAAYD,OAAO,CAACC,IAApB;AACA,SAAKC,MAAL,GAAcF,OAAO,CAACE,MAAtB;AACA,SAAKC,SAAL,GAAiBH,OAAO,CAACG,SAAR,IAAqB,IAAtC,CAHqC,CAKrC;;AACA,SAAKC,WAAL,GAAmBC,kBAAMC,MAAN,CAAa;AAC9BC,MAAAA,OAAO,EAAE,KAAKN,IADgB;AAE9BO,MAAAA,OAAO,EAAE;AACPC,QAAAA,MAAM,EAAE,kBADD;AAEP,wBAAgB,kBAFT;AAGPC,QAAAA,aAAa,mBAAY,KAAKR,MAAjB,CAHN;AAIP,8BAAsB,KAAKC;AAJpB;AAFqB,KAAb,CAAnB;;AAUA,QAAI,OAAOQ,MAAP,KAAkB,WAAtB,EAAmC;AACjC,WAAKC,MAAL,GAAc,IAAIC,eAAJ,WAAc,KAAKZ,IAAL,CAAUa,OAAV,CAAkB,MAAlB,EAA0B,IAA1B,CAAd,aAAuD;AACnEC,QAAAA,MAAM,EAAE;AACNC,UAAAA,UAAU,EAAE,KAAKb,SADX;AAENc,UAAAA,OAAO,EAAE,KAAKf;AAFR;AAD2D,OAAvD,CAAd;AAMD;;AAED,gCAAW,KAAKE,WAAhB,EAA6B;AAC3Bc,MAAAA,OAAO,EAAE,CADkB;AAE3BC,MAAAA,cAAc,EAAE,KAAKC,eAFM;AAG3BC,MAAAA,UAAU,EAAEC,uBAAWC;AAHI,KAA7B;AAKD;;;;;uGAED,iBAAkBC,GAAlB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAEyB,KAAKpB,WAAL,CAAiBoB,GAAjB,CAFzB;;AAAA;AAEUC,gBAAAA,MAFV;AAAA,iDAIW;AACLC,kBAAAA,UAAU,EAAED,MAAM,CAACE,MAAP,GAAgB,GAAhB,GAAsB,IAAtB,GAA6B,OADpC;AAELC,kBAAAA,IAAI,EAAEH,MAAM,CAACI,IAFR;AAGLC,kBAAAA,KAAK,EAAEC,SAHF;AAILJ,kBAAAA,MAAM,EAAEF,MAAM,CAACE;AAJV,iBAJX;;AAAA;AAAA;AAAA;AAaIK,gBAAAA,OAAO,CAACF,KAAR;AAbJ,iDAeW;AACLJ,kBAAAA,UAAU,EAAE,OADP;AAELC,kBAAAA,MAAM,EAAE,GAFH;AAGLC,kBAAAA,IAAI,EAAEG,SAHD;AAILD,kBAAAA,KAAK;AAJA,iBAfX;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;WAwBA,yBAAwBA,KAAxB,EAA2C;AACzC;AACA,UAAIR,uBAAWW,cAAX,CAA0BH,KAA1B,CAAJ,EAAsC;AACpC,eAAO,IAAP;AACD;;AAED,UAAI,CAACA,KAAK,CAACI,QAAX,EAAqB;AACnB;AACA,eAAO,KAAP;AACD,OATwC,CAWzC;;;AACA,UAAIJ,KAAK,CAACI,QAAN,CAAeP,MAAf,IAAyB,GAAzB,IAAgCG,KAAK,CAACI,QAAN,CAAeP,MAAf,IAAyB,GAA7D,EAAkE;AAChE,eAAO,IAAP;AACD,OAdwC,CAgBzC;;;AACA,UAAIG,KAAK,CAACI,QAAN,CAAeP,MAAf,KAA0B,GAA9B,EAAmC;AACjC,eAAO,IAAP;AACD;;AAED,aAAO,KAAP;AACD;;;;;eAGY5B,S","sourcesContent":["import axios, { AxiosInstance, AxiosRequestConfig } from \"axios\";\nimport axiosRetry from \"axios-retry\";\nimport { Socket } from \"phoenix\";\nimport { AxiosError } from \"axios\";\n\ntype ApiClientOptions = {\n  host: string;\n  apiKey: string;\n  userToken: string | undefined;\n};\n\nexport interface ApiResponse {\n  // eslint-disable-next-line\n  error?: any;\n  // eslint-disable-next-line\n  body?: any;\n  statusCode: \"ok\" | \"error\";\n  status: number;\n}\n\nclass ApiClient {\n  private host: string;\n  private apiKey: string;\n  private userToken: string | null;\n  private axiosClient: AxiosInstance;\n\n  public socket: Socket | undefined;\n\n  constructor(options: ApiClientOptions) {\n    this.host = options.host;\n    this.apiKey = options.apiKey;\n    this.userToken = options.userToken || null;\n\n    // Create a retryable axios client\n    this.axiosClient = axios.create({\n      baseURL: this.host,\n      headers: {\n        Accept: \"application/json\",\n        \"Content-Type\": \"application/json\",\n        Authorization: `Bearer ${this.apiKey}`,\n        \"X-Knock-User-Token\": this.userToken,\n      },\n    });\n\n    if (typeof window !== \"undefined\") {\n      this.socket = new Socket(`${this.host.replace(\"http\", \"ws\")}/ws/v1`, {\n        params: {\n          user_token: this.userToken,\n          api_key: this.apiKey,\n        },\n      });\n    }\n\n    axiosRetry(this.axiosClient, {\n      retries: 3,\n      retryCondition: this.canRetryRequest,\n      retryDelay: axiosRetry.exponentialDelay,\n    });\n  }\n\n  async makeRequest(req: AxiosRequestConfig): Promise<ApiResponse> {\n    try {\n      const result = await this.axiosClient(req);\n\n      return {\n        statusCode: result.status < 300 ? \"ok\" : \"error\",\n        body: result.data,\n        error: undefined,\n        status: result.status,\n      };\n\n      // eslint:disable-next-line\n    } catch (e: unknown) {\n      console.error(e);\n\n      return {\n        statusCode: \"error\",\n        status: 500,\n        body: undefined,\n        error: e,\n      };\n    }\n  }\n\n  private canRetryRequest(error: AxiosError) {\n    // Retry Network Errors.\n    if (axiosRetry.isNetworkError(error)) {\n      return true;\n    }\n\n    if (!error.response) {\n      // Cannot determine if the request can be retried\n      return false;\n    }\n\n    // Retry Server Errors (5xx).\n    if (error.response.status >= 500 && error.response.status <= 599) {\n      return true;\n    }\n\n    // Retry if rate limited.\n    if (error.response.status === 429) {\n      return true;\n    }\n\n    return false;\n  }\n}\n\nexport default ApiClient;\n"],"file":"api.js"}
+{"version":3,"file":"api.js","names":["_axios","_interopRequireDefault","require","_axiosRetry","_phoenix","ApiClient","options","_classCallCheck2","_defineProperty2","host","apiKey","userToken","axiosClient","axios","create","baseURL","headers","Accept","Authorization","concat","window","socket","Socket","replace","params","user_token","api_key","axiosRetry","retries","retryCondition","canRetryRequest","retryDelay","exponentialDelay","_createClass2","key","value","_makeRequest","_asyncToGenerator2","_regenerator","mark","_callee","req","result","wrap","_callee$","_context","prev","next","sent","abrupt","statusCode","status","body","data","error","undefined","t0","console","stop","makeRequest","_x","apply","arguments","isNetworkError","response","_default","exports"],"sources":["../../src/api.ts"],"sourcesContent":["import axios, { AxiosInstance, AxiosRequestConfig } from \"axios\";\nimport axiosRetry from \"axios-retry\";\nimport { Socket } from \"phoenix\";\nimport { AxiosError } from \"axios\";\n\ntype ApiClientOptions = {\n  host: string;\n  apiKey: string;\n  userToken: string | undefined;\n};\n\nexport interface ApiResponse {\n  // eslint-disable-next-line\n  error?: any;\n  // eslint-disable-next-line\n  body?: any;\n  statusCode: \"ok\" | \"error\";\n  status: number;\n}\n\nclass ApiClient {\n  private host: string;\n  private apiKey: string;\n  private userToken: string | null;\n  private axiosClient: AxiosInstance;\n\n  public socket: Socket | undefined;\n\n  constructor(options: ApiClientOptions) {\n    this.host = options.host;\n    this.apiKey = options.apiKey;\n    this.userToken = options.userToken || null;\n\n    // Create a retryable axios client\n    this.axiosClient = axios.create({\n      baseURL: this.host,\n      headers: {\n        Accept: \"application/json\",\n        \"Content-Type\": \"application/json\",\n        Authorization: `Bearer ${this.apiKey}`,\n        \"X-Knock-User-Token\": this.userToken,\n      },\n    });\n\n    if (typeof window !== \"undefined\") {\n      this.socket = new Socket(`${this.host.replace(\"http\", \"ws\")}/ws/v1`, {\n        params: {\n          user_token: this.userToken,\n          api_key: this.apiKey,\n        },\n      });\n    }\n\n    axiosRetry(this.axiosClient, {\n      retries: 3,\n      retryCondition: this.canRetryRequest,\n      retryDelay: axiosRetry.exponentialDelay,\n    });\n  }\n\n  async makeRequest(req: AxiosRequestConfig): Promise<ApiResponse> {\n    try {\n      const result = await this.axiosClient(req);\n\n      return {\n        statusCode: result.status < 300 ? \"ok\" : \"error\",\n        body: result.data,\n        error: undefined,\n        status: result.status,\n      };\n\n      // eslint:disable-next-line\n    } catch (e: unknown) {\n      console.error(e);\n\n      return {\n        statusCode: \"error\",\n        status: 500,\n        body: undefined,\n        error: e,\n      };\n    }\n  }\n\n  private canRetryRequest(error: AxiosError) {\n    // Retry Network Errors.\n    if (axiosRetry.isNetworkError(error)) {\n      return true;\n    }\n\n    if (!error.response) {\n      // Cannot determine if the request can be retried\n      return false;\n    }\n\n    // Retry Server Errors (5xx).\n    if (error.response.status >= 500 && error.response.status <= 599) {\n      return true;\n    }\n\n    // Retry if rate limited.\n    if (error.response.status === 429) {\n      return true;\n    }\n\n    return false;\n  }\n}\n\nexport default ApiClient;\n"],"mappings":";;;;;;;;;;;;AAAA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,WAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,QAAA,GAAAF,OAAA;AAAiC,IAkB3BG,SAAS;EAQb,SAAAA,UAAYC,OAAyB,EAAE;IAAA,IAAAC,gBAAA,mBAAAF,SAAA;IAAA,IAAAG,gBAAA;IAAA,IAAAA,gBAAA;IAAA,IAAAA,gBAAA;IAAA,IAAAA,gBAAA;IAAA,IAAAA,gBAAA;IACrC,IAAI,CAACC,IAAI,GAAGH,OAAO,CAACG,IAAI;IACxB,IAAI,CAACC,MAAM,GAAGJ,OAAO,CAACI,MAAM;IAC5B,IAAI,CAACC,SAAS,GAAGL,OAAO,CAACK,SAAS,IAAI,IAAI;;IAE1C;IACA,IAAI,CAACC,WAAW,GAAGC,iBAAK,CAACC,MAAM,CAAC;MAC9BC,OAAO,EAAE,IAAI,CAACN,IAAI;MAClBO,OAAO,EAAE;QACPC,MAAM,EAAE,kBAAkB;QAC1B,cAAc,EAAE,kBAAkB;QAClCC,aAAa,YAAAC,MAAA,CAAY,IAAI,CAACT,MAAM,CAAE;QACtC,oBAAoB,EAAE,IAAI,CAACC;MAC7B;IACF,CAAC,CAAC;IAEF,IAAI,OAAOS,MAAM,KAAK,WAAW,EAAE;MACjC,IAAI,CAACC,MAAM,GAAG,IAAIC,eAAM,IAAAH,MAAA,CAAI,IAAI,CAACV,IAAI,CAACc,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,aAAU;QACnEC,MAAM,EAAE;UACNC,UAAU,EAAE,IAAI,CAACd,SAAS;UAC1Be,OAAO,EAAE,IAAI,CAAChB;QAChB;MACF,CAAC,CAAC;IACJ;IAEA,IAAAiB,sBAAU,EAAC,IAAI,CAACf,WAAW,EAAE;MAC3BgB,OAAO,EAAE,CAAC;MACVC,cAAc,EAAE,IAAI,CAACC,eAAe;MACpCC,UAAU,EAAEJ,sBAAU,CAACK;IACzB,CAAC,CAAC;EACJ;EAAC,IAAAC,aAAA,aAAA5B,SAAA;IAAA6B,GAAA;IAAAC,KAAA;MAAA,IAAAC,YAAA,OAAAC,kBAAA,2BAAAC,YAAA,YAAAC,IAAA,CAED,SAAAC,QAAkBC,GAAuB;QAAA,IAAAC,MAAA;QAAA,OAAAJ,YAAA,YAAAK,IAAA,UAAAC,SAAAC,QAAA;UAAA,kBAAAA,QAAA,CAAAC,IAAA,GAAAD,QAAA,CAAAE,IAAA;YAAA;cAAAF,QAAA,CAAAC,IAAA;cAAAD,QAAA,CAAAE,IAAA;cAAA,OAEhB,IAAI,CAACnC,WAAW,CAAC6B,GAAG,CAAC;YAAA;cAApCC,MAAM,GAAAG,QAAA,CAAAG,IAAA;cAAA,OAAAH,QAAA,CAAAI,MAAA,WAEL;gBACLC,UAAU,EAAER,MAAM,CAACS,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,OAAO;gBAChDC,IAAI,EAAEV,MAAM,CAACW,IAAI;gBACjBC,KAAK,EAAEC,SAAS;gBAChBJ,MAAM,EAAET,MAAM,CAACS;cACjB,CAAC;YAAA;cAAAN,QAAA,CAAAC,IAAA;cAAAD,QAAA,CAAAW,EAAA,GAAAX,QAAA;cAIDY,OAAO,CAACH,KAAK,CAAAT,QAAA,CAAAW,EAAE,CAAC;cAAC,OAAAX,QAAA,CAAAI,MAAA,WAEV;gBACLC,UAAU,EAAE,OAAO;gBACnBC,MAAM,EAAE,GAAG;gBACXC,IAAI,EAAEG,SAAS;gBACfD,KAAK,EAAAT,QAAA,CAAAW;cACP,CAAC;YAAA;YAAA;cAAA,OAAAX,QAAA,CAAAa,IAAA;UAAA;QAAA,GAAAlB,OAAA;MAAA,CAEJ;MAAA,SAAAmB,YAAAC,EAAA;QAAA,OAAAxB,YAAA,CAAAyB,KAAA,OAAAC,SAAA;MAAA;MAAA,OAAAH,WAAA;IAAA;EAAA;IAAAzB,GAAA;IAAAC,KAAA,EAED,SAAAL,gBAAwBwB,KAAiB,EAAE;MACzC;MACA,IAAI3B,sBAAU,CAACoC,cAAc,CAACT,KAAK,CAAC,EAAE;QACpC,OAAO,IAAI;MACb;MAEA,IAAI,CAACA,KAAK,CAACU,QAAQ,EAAE;QACnB;QACA,OAAO,KAAK;MACd;;MAEA;MACA,IAAIV,KAAK,CAACU,QAAQ,CAACb,MAAM,IAAI,GAAG,IAAIG,KAAK,CAACU,QAAQ,CAACb,MAAM,IAAI,GAAG,EAAE;QAChE,OAAO,IAAI;MACb;;MAEA;MACA,IAAIG,KAAK,CAACU,QAAQ,CAACb,MAAM,KAAK,GAAG,EAAE;QACjC,OAAO,IAAI;MACb;MAEA,OAAO,KAAK;IACd;EAAC;EAAA,OAAA9C,SAAA;AAAA;AAAA,IAAA4D,QAAA,GAAAC,OAAA,cAGY7D,SAAS"}