@knocklabs/client 0.8.14 → 0.8.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/README.md +22 -13
  2. package/dist/cjs/api.js +33 -56
  3. package/dist/cjs/api.js.map +1 -1
  4. package/dist/cjs/clients/feed/feed.js +492 -624
  5. package/dist/cjs/clients/feed/feed.js.map +1 -1
  6. package/dist/cjs/clients/feed/index.js +1 -10
  7. package/dist/cjs/clients/feed/index.js.map +1 -1
  8. package/dist/cjs/clients/feed/interfaces.js.map +1 -1
  9. package/dist/cjs/clients/feed/store.js +4 -15
  10. package/dist/cjs/clients/feed/store.js.map +1 -1
  11. package/dist/cjs/clients/feed/types.js.map +1 -1
  12. package/dist/cjs/clients/feed/utils.js +0 -5
  13. package/dist/cjs/clients/feed/utils.js.map +1 -1
  14. package/dist/cjs/clients/preferences/index.js +216 -249
  15. package/dist/cjs/clients/preferences/index.js.map +1 -1
  16. package/dist/cjs/clients/preferences/interfaces.js.map +1 -1
  17. package/dist/cjs/clients/users/index.js +185 -0
  18. package/dist/cjs/clients/users/index.js.map +1 -0
  19. package/dist/cjs/clients/users/interfaces.js +6 -0
  20. package/dist/cjs/clients/users/interfaces.js.map +1 -0
  21. package/dist/cjs/index.js +15 -21
  22. package/dist/cjs/index.js.map +1 -1
  23. package/dist/cjs/interfaces.js.map +1 -1
  24. package/dist/cjs/knock.js +11 -21
  25. package/dist/cjs/knock.js.map +1 -1
  26. package/dist/cjs/networkStatus.js +3 -6
  27. package/dist/cjs/networkStatus.js.map +1 -1
  28. package/dist/esm/api.js +9 -21
  29. package/dist/esm/api.js.map +1 -1
  30. package/dist/esm/clients/feed/feed.js +69 -149
  31. package/dist/esm/clients/feed/feed.js.map +1 -1
  32. package/dist/esm/clients/feed/index.js +0 -5
  33. package/dist/esm/clients/feed/index.js.map +1 -1
  34. package/dist/esm/clients/feed/interfaces.js.map +1 -1
  35. package/dist/esm/clients/feed/store.js +2 -8
  36. package/dist/esm/clients/feed/store.js.map +1 -1
  37. package/dist/esm/clients/feed/types.js.map +1 -1
  38. package/dist/esm/clients/feed/utils.js +0 -1
  39. package/dist/esm/clients/feed/utils.js.map +1 -1
  40. package/dist/esm/clients/preferences/index.js +35 -25
  41. package/dist/esm/clients/preferences/index.js.map +1 -1
  42. package/dist/esm/clients/preferences/interfaces.js.map +1 -1
  43. package/dist/esm/clients/users/index.js +84 -0
  44. package/dist/esm/clients/users/index.js.map +1 -0
  45. package/dist/esm/clients/users/interfaces.js +2 -0
  46. package/dist/esm/clients/users/interfaces.js.map +1 -0
  47. package/dist/esm/index.js +1 -0
  48. package/dist/esm/index.js.map +1 -1
  49. package/dist/esm/interfaces.js.map +1 -1
  50. package/dist/esm/knock.js +10 -22
  51. package/dist/esm/knock.js.map +1 -1
  52. package/dist/esm/networkStatus.js +3 -5
  53. package/dist/esm/networkStatus.js.map +1 -1
  54. package/dist/types/api.d.ts +1 -1
  55. package/dist/types/api.d.ts.map +1 -1
  56. package/dist/types/clients/feed/feed.d.ts +1 -1
  57. package/dist/types/clients/feed/feed.d.ts.map +1 -1
  58. package/dist/types/clients/feed/interfaces.d.ts +2 -1
  59. package/dist/types/clients/feed/interfaces.d.ts.map +1 -1
  60. package/dist/types/clients/feed/types.d.ts +10 -10
  61. package/dist/types/clients/feed/types.d.ts.map +1 -1
  62. package/dist/types/clients/preferences/index.d.ts +27 -0
  63. package/dist/types/clients/preferences/index.d.ts.map +1 -1
  64. package/dist/types/clients/preferences/interfaces.d.ts +7 -4
  65. package/dist/types/clients/preferences/interfaces.d.ts.map +1 -1
  66. package/dist/types/clients/users/index.d.ts +16 -0
  67. package/dist/types/clients/users/index.d.ts.map +1 -0
  68. package/dist/types/clients/users/interfaces.d.ts +8 -0
  69. package/dist/types/clients/users/interfaces.d.ts.map +1 -0
  70. package/dist/types/index.d.ts +1 -0
  71. package/dist/types/index.d.ts.map +1 -1
  72. package/dist/types/interfaces.d.ts +6 -2
  73. package/dist/types/interfaces.d.ts.map +1 -1
  74. package/dist/types/knock.d.ts +2 -0
  75. package/dist/types/knock.d.ts.map +1 -1
  76. package/package.json +15 -10
package/dist/esm/api.js CHANGED
@@ -3,23 +3,18 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
3
3
  import axios from "axios";
4
4
  import axiosRetry from "axios-retry";
5
5
  import { Socket } from "phoenix";
6
-
7
6
  class ApiClient {
8
7
  constructor(options) {
9
8
  _defineProperty(this, "host", void 0);
10
-
11
9
  _defineProperty(this, "apiKey", void 0);
12
-
13
10
  _defineProperty(this, "userToken", void 0);
14
-
15
11
  _defineProperty(this, "axiosClient", void 0);
16
-
17
12
  _defineProperty(this, "socket", void 0);
18
-
19
13
  this.host = options.host;
20
14
  this.apiKey = options.apiKey;
21
- this.userToken = options.userToken || null; // Create a retryable axios client
15
+ this.userToken = options.userToken || null;
22
16
 
17
+ // Create a retryable axios client
23
18
  this.axiosClient = axios.create({
24
19
  baseURL: this.host,
25
20
  headers: {
@@ -29,7 +24,6 @@ class ApiClient {
29
24
  "X-Knock-User-Token": this.userToken
30
25
  }
31
26
  });
32
-
33
27
  if (typeof window !== "undefined") {
34
28
  this.socket = new Socket("".concat(this.host.replace("http", "ws"), "/ws/v1"), {
35
29
  params: {
@@ -38,17 +32,14 @@ class ApiClient {
38
32
  }
39
33
  });
40
34
  }
41
-
42
35
  axiosRetry(this.axiosClient, {
43
36
  retries: 3,
44
37
  retryCondition: this.canRetryRequest,
45
38
  retryDelay: axiosRetry.exponentialDelay
46
39
  });
47
40
  }
48
-
49
41
  makeRequest(req) {
50
42
  var _this = this;
51
-
52
43
  return _asyncToGenerator(function* () {
53
44
  try {
54
45
  var result = yield _this.axiosClient(req);
@@ -57,7 +48,9 @@ class ApiClient {
57
48
  body: result.data,
58
49
  error: undefined,
59
50
  status: result.status
60
- }; // eslint:disable-next-line
51
+ };
52
+
53
+ // eslint:disable-next-line
61
54
  } catch (e) {
62
55
  console.error(e);
63
56
  return {
@@ -69,32 +62,27 @@ class ApiClient {
69
62
  }
70
63
  })();
71
64
  }
72
-
73
65
  canRetryRequest(error) {
74
66
  // Retry Network Errors.
75
67
  if (axiosRetry.isNetworkError(error)) {
76
68
  return true;
77
69
  }
78
-
79
70
  if (!error.response) {
80
71
  // Cannot determine if the request can be retried
81
72
  return false;
82
- } // Retry Server Errors (5xx).
83
-
73
+ }
84
74
 
75
+ // Retry Server Errors (5xx).
85
76
  if (error.response.status >= 500 && error.response.status <= 599) {
86
77
  return true;
87
- } // Retry if rate limited.
88
-
78
+ }
89
79
 
80
+ // Retry if rate limited.
90
81
  if (error.response.status === 429) {
91
82
  return true;
92
83
  }
93
-
94
84
  return false;
95
85
  }
96
-
97
86
  }
98
-
99
87
  export default ApiClient;
100
88
  //# sourceMappingURL=api.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/api.ts"],"names":["axios","axiosRetry","Socket","ApiClient","constructor","options","host","apiKey","userToken","axiosClient","create","baseURL","headers","Accept","Authorization","window","socket","replace","params","user_token","api_key","retries","retryCondition","canRetryRequest","retryDelay","exponentialDelay","makeRequest","req","result","statusCode","status","body","data","error","undefined","e","console","isNetworkError","response"],"mappings":";;AAAA,OAAOA,KAAP,MAAyD,OAAzD;AACA,OAAOC,UAAP,MAAuB,aAAvB;AACA,SAASC,MAAT,QAAuB,SAAvB;;AAkBA,MAAMC,SAAN,CAAgB;AAQdC,EAAAA,WAAW,CAACC,OAAD,EAA4B;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,GAAmBT,KAAK,CAACU,MAAN,CAAa;AAC9BC,MAAAA,OAAO,EAAE,KAAKL,IADgB;AAE9BM,MAAAA,OAAO,EAAE;AACPC,QAAAA,MAAM,EAAE,kBADD;AAEP,wBAAgB,kBAFT;AAGPC,QAAAA,aAAa,mBAAY,KAAKP,MAAjB,CAHN;AAIP,8BAAsB,KAAKC;AAJpB;AAFqB,KAAb,CAAnB;;AAUA,QAAI,OAAOO,MAAP,KAAkB,WAAtB,EAAmC;AACjC,WAAKC,MAAL,GAAc,IAAId,MAAJ,WAAc,KAAKI,IAAL,CAAUW,OAAV,CAAkB,MAAlB,EAA0B,IAA1B,CAAd,aAAuD;AACnEC,QAAAA,MAAM,EAAE;AACNC,UAAAA,UAAU,EAAE,KAAKX,SADX;AAENY,UAAAA,OAAO,EAAE,KAAKb;AAFR;AAD2D,OAAvD,CAAd;AAMD;;AAEDN,IAAAA,UAAU,CAAC,KAAKQ,WAAN,EAAmB;AAC3BY,MAAAA,OAAO,EAAE,CADkB;AAE3BC,MAAAA,cAAc,EAAE,KAAKC,eAFM;AAG3BC,MAAAA,UAAU,EAAEvB,UAAU,CAACwB;AAHI,KAAnB,CAAV;AAKD;;AAEKC,EAAAA,WAAW,CAACC,GAAD,EAAgD;AAAA;;AAAA;AAC/D,UAAI;AACF,YAAMC,MAAM,SAAS,KAAI,CAACnB,WAAL,CAAiBkB,GAAjB,CAArB;AAEA,eAAO;AACLE,UAAAA,UAAU,EAAED,MAAM,CAACE,MAAP,GAAgB,GAAhB,GAAsB,IAAtB,GAA6B,OADpC;AAELC,UAAAA,IAAI,EAAEH,MAAM,CAACI,IAFR;AAGLC,UAAAA,KAAK,EAAEC,SAHF;AAILJ,UAAAA,MAAM,EAAEF,MAAM,CAACE;AAJV,SAAP,CAHE,CAUF;AACD,OAXD,CAWE,OAAOK,CAAP,EAAmB;AACnBC,QAAAA,OAAO,CAACH,KAAR,CAAcE,CAAd;AAEA,eAAO;AACLN,UAAAA,UAAU,EAAE,OADP;AAELC,UAAAA,MAAM,EAAE,GAFH;AAGLC,UAAAA,IAAI,EAAEG,SAHD;AAILD,UAAAA,KAAK,EAAEE;AAJF,SAAP;AAMD;AArB8D;AAsBhE;;AAEOZ,EAAAA,eAAe,CAACU,KAAD,EAAoB;AACzC;AACA,QAAIhC,UAAU,CAACoC,cAAX,CAA0BJ,KAA1B,CAAJ,EAAsC;AACpC,aAAO,IAAP;AACD;;AAED,QAAI,CAACA,KAAK,CAACK,QAAX,EAAqB;AACnB;AACA,aAAO,KAAP;AACD,KATwC,CAWzC;;;AACA,QAAIL,KAAK,CAACK,QAAN,CAAeR,MAAf,IAAyB,GAAzB,IAAgCG,KAAK,CAACK,QAAN,CAAeR,MAAf,IAAyB,GAA7D,EAAkE;AAChE,aAAO,IAAP;AACD,KAdwC,CAgBzC;;;AACA,QAAIG,KAAK,CAACK,QAAN,CAAeR,MAAf,KAA0B,GAA9B,EAAmC;AACjC,aAAO,IAAP;AACD;;AAED,WAAO,KAAP;AACD;;AAtFa;;AAyFhB,eAAe3B,SAAf","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"}
1
+ {"version":3,"file":"api.js","names":["axios","axiosRetry","Socket","ApiClient","constructor","options","_defineProperty","host","apiKey","userToken","axiosClient","create","baseURL","headers","Accept","Authorization","concat","window","socket","replace","params","user_token","api_key","retries","retryCondition","canRetryRequest","retryDelay","exponentialDelay","makeRequest","req","_this","_asyncToGenerator","result","statusCode","status","body","data","error","undefined","e","console","isNetworkError","response"],"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,OAAOA,KAAK,MAA6C,OAAO;AAChE,OAAOC,UAAU,MAAM,aAAa;AACpC,SAASC,MAAM,QAAQ,SAAS;AAkBhC,MAAMC,SAAS,CAAC;EAQdC,WAAWA,CAACC,OAAyB,EAAE;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IACrC,IAAI,CAACC,IAAI,GAAGF,OAAO,CAACE,IAAI;IACxB,IAAI,CAACC,MAAM,GAAGH,OAAO,CAACG,MAAM;IAC5B,IAAI,CAACC,SAAS,GAAGJ,OAAO,CAACI,SAAS,IAAI,IAAI;;IAE1C;IACA,IAAI,CAACC,WAAW,GAAGV,KAAK,CAACW,MAAM,CAAC;MAC9BC,OAAO,EAAE,IAAI,CAACL,IAAI;MAClBM,OAAO,EAAE;QACPC,MAAM,EAAE,kBAAkB;QAC1B,cAAc,EAAE,kBAAkB;QAClCC,aAAa,YAAAC,MAAA,CAAY,IAAI,CAACR,MAAM,CAAE;QACtC,oBAAoB,EAAE,IAAI,CAACC;MAC7B;IACF,CAAC,CAAC;IAEF,IAAI,OAAOQ,MAAM,KAAK,WAAW,EAAE;MACjC,IAAI,CAACC,MAAM,GAAG,IAAIhB,MAAM,IAAAc,MAAA,CAAI,IAAI,CAACT,IAAI,CAACY,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,aAAU;QACnEC,MAAM,EAAE;UACNC,UAAU,EAAE,IAAI,CAACZ,SAAS;UAC1Ba,OAAO,EAAE,IAAI,CAACd;QAChB;MACF,CAAC,CAAC;IACJ;IAEAP,UAAU,CAAC,IAAI,CAACS,WAAW,EAAE;MAC3Ba,OAAO,EAAE,CAAC;MACVC,cAAc,EAAE,IAAI,CAACC,eAAe;MACpCC,UAAU,EAAEzB,UAAU,CAAC0B;IACzB,CAAC,CAAC;EACJ;EAEMC,WAAWA,CAACC,GAAuB,EAAwB;IAAA,IAAAC,KAAA;IAAA,OAAAC,iBAAA;MAC/D,IAAI;QACF,IAAMC,MAAM,SAASF,KAAI,CAACpB,WAAW,CAACmB,GAAG,CAAC;QAE1C,OAAO;UACLI,UAAU,EAAED,MAAM,CAACE,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,OAAO;UAChDC,IAAI,EAAEH,MAAM,CAACI,IAAI;UACjBC,KAAK,EAAEC,SAAS;UAChBJ,MAAM,EAAEF,MAAM,CAACE;QACjB,CAAC;;QAED;MACF,CAAC,CAAC,OAAOK,CAAU,EAAE;QACnBC,OAAO,CAACH,KAAK,CAACE,CAAC,CAAC;QAEhB,OAAO;UACLN,UAAU,EAAE,OAAO;UACnBC,MAAM,EAAE,GAAG;UACXC,IAAI,EAAEG,SAAS;UACfD,KAAK,EAAEE;QACT,CAAC;MACH;IAAC;EACH;EAEQd,eAAeA,CAACY,KAAiB,EAAE;IACzC;IACA,IAAIpC,UAAU,CAACwC,cAAc,CAACJ,KAAK,CAAC,EAAE;MACpC,OAAO,IAAI;IACb;IAEA,IAAI,CAACA,KAAK,CAACK,QAAQ,EAAE;MACnB;MACA,OAAO,KAAK;IACd;;IAEA;IACA,IAAIL,KAAK,CAACK,QAAQ,CAACR,MAAM,IAAI,GAAG,IAAIG,KAAK,CAACK,QAAQ,CAACR,MAAM,IAAI,GAAG,EAAE;MAChE,OAAO,IAAI;IACb;;IAEA;IACA,IAAIG,KAAK,CAACK,QAAQ,CAACR,MAAM,KAAK,GAAG,EAAE;MACjC,OAAO,IAAI;IACb;IAEA,OAAO,KAAK;EACd;AACF;AAEA,eAAe/B,SAAS"}