@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
@@ -0,0 +1,84 @@
1
+ import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
2
+ import _defineProperty from "@babel/runtime/helpers/defineProperty";
3
+ var DEFAULT_PREFERENCE_SET_ID = "default";
4
+ class UserClient {
5
+ constructor(instance) {
6
+ _defineProperty(this, "instance", void 0);
7
+ this.instance = instance;
8
+ }
9
+ getAllPreferences() {
10
+ var _this = this;
11
+ return _asyncToGenerator(function* () {
12
+ var result = yield _this.instance.client().makeRequest({
13
+ method: "GET",
14
+ url: "/v1/users/".concat(_this.instance.userId, "/preferences")
15
+ });
16
+ return _this.handleResponse(result);
17
+ })();
18
+ }
19
+ getPreferences() {
20
+ var _arguments = arguments,
21
+ _this2 = this;
22
+ return _asyncToGenerator(function* () {
23
+ var options = _arguments.length > 0 && _arguments[0] !== undefined ? _arguments[0] : {};
24
+ var preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;
25
+ var result = yield _this2.instance.client().makeRequest({
26
+ method: "GET",
27
+ url: "/v1/users/".concat(_this2.instance.userId, "/preferences/").concat(preferenceSetId),
28
+ params: {
29
+ tenant: options.tenant
30
+ }
31
+ });
32
+ return _this2.handleResponse(result);
33
+ })();
34
+ }
35
+ setPreferences(preferenceSet) {
36
+ var _arguments2 = arguments,
37
+ _this3 = this;
38
+ return _asyncToGenerator(function* () {
39
+ var options = _arguments2.length > 1 && _arguments2[1] !== undefined ? _arguments2[1] : {};
40
+ var preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;
41
+ var result = yield _this3.instance.client().makeRequest({
42
+ method: "PUT",
43
+ url: "/v1/users/".concat(_this3.instance.userId, "/preferences/").concat(preferenceSetId),
44
+ data: preferenceSet
45
+ });
46
+ return _this3.handleResponse(result);
47
+ })();
48
+ }
49
+ getChannelData(params) {
50
+ var _this4 = this;
51
+ return _asyncToGenerator(function* () {
52
+ var result = yield _this4.instance.client().makeRequest({
53
+ method: "GET",
54
+ url: "/v1/users/".concat(_this4.instance.userId, "/channel_data/").concat(params.channelId)
55
+ });
56
+ return _this4.handleResponse(result);
57
+ })();
58
+ }
59
+ setChannelData(_ref) {
60
+ var _this5 = this;
61
+ return _asyncToGenerator(function* () {
62
+ var {
63
+ channelId,
64
+ channelData
65
+ } = _ref;
66
+ var result = yield _this5.instance.client().makeRequest({
67
+ method: "PUT",
68
+ url: "/v1/users/".concat(_this5.instance.userId, "/channel_data/").concat(channelId),
69
+ data: {
70
+ data: channelData
71
+ }
72
+ });
73
+ return _this5.handleResponse(result);
74
+ })();
75
+ }
76
+ handleResponse(response) {
77
+ if (response.statusCode === "error") {
78
+ throw new Error(response.error || response.body);
79
+ }
80
+ return response.body;
81
+ }
82
+ }
83
+ export default UserClient;
84
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","names":["DEFAULT_PREFERENCE_SET_ID","UserClient","constructor","instance","_defineProperty","getAllPreferences","_this","_asyncToGenerator","result","client","makeRequest","method","url","concat","userId","handleResponse","getPreferences","_arguments","arguments","_this2","options","length","undefined","preferenceSetId","preferenceSet","params","tenant","setPreferences","_arguments2","_this3","data","getChannelData","_this4","channelId","setChannelData","_ref","_this5","channelData","response","statusCode","Error","error","body"],"sources":["../../../../src/clients/users/index.ts"],"sourcesContent":["import { ApiResponse } from \"../../api\";\nimport { ChannelData } from \"../../interfaces\";\nimport Knock from \"../../knock\";\nimport {\n GetPreferencesOptions,\n PreferenceOptions,\n PreferenceSet,\n SetPreferencesProperties,\n} from \"../preferences/interfaces\";\nimport { GetChannelDataInput, SetChannelDataInput } from \"./interfaces\";\n\nconst DEFAULT_PREFERENCE_SET_ID = \"default\";\n\nclass UserClient {\n private instance: Knock;\n\n constructor(instance: Knock) {\n this.instance = instance;\n }\n\n async getAllPreferences() {\n const result = await this.instance.client().makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.instance.userId}/preferences`,\n });\n\n return this.handleResponse<PreferenceSet[]>(result);\n }\n\n async getPreferences(\n options: GetPreferencesOptions = {},\n ): Promise<PreferenceSet> {\n const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n const result = await this.instance.client().makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n params: { tenant: options.tenant },\n });\n\n return this.handleResponse<PreferenceSet>(result);\n }\n\n async setPreferences(\n preferenceSet: SetPreferencesProperties,\n options: PreferenceOptions = {},\n ): Promise<PreferenceSet> {\n const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n const result = await this.instance.client().makeRequest({\n method: \"PUT\",\n url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n data: preferenceSet,\n });\n\n return this.handleResponse<PreferenceSet>(result);\n }\n\n async getChannelData<T = any>(params: GetChannelDataInput) {\n const result = await this.instance.client().makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.instance.userId}/channel_data/${params.channelId}`,\n });\n\n return this.handleResponse<ChannelData<T>>(result);\n }\n\n async setChannelData<T = any>({\n channelId,\n channelData,\n }: SetChannelDataInput) {\n const result = await this.instance.client().makeRequest({\n method: \"PUT\",\n url: `/v1/users/${this.instance.userId}/channel_data/${channelId}`,\n data: { data: channelData },\n });\n\n return this.handleResponse<ChannelData<T>>(result);\n }\n\n private handleResponse<T>(response: ApiResponse) {\n if (response.statusCode === \"error\") {\n throw new Error(response.error || response.body);\n }\n\n return response.body as T;\n }\n}\n\nexport default UserClient;\n"],"mappings":";;AAWA,IAAMA,yBAAyB,GAAG,SAAS;AAE3C,MAAMC,UAAU,CAAC;EAGfC,WAAWA,CAACC,QAAe,EAAE;IAAAC,eAAA;IAC3B,IAAI,CAACD,QAAQ,GAAGA,QAAQ;EAC1B;EAEME,iBAAiBA,CAAA,EAAG;IAAA,IAAAC,KAAA;IAAA,OAAAC,iBAAA;MACxB,IAAMC,MAAM,SAASF,KAAI,CAACH,QAAQ,CAACM,MAAM,CAAC,CAAC,CAACC,WAAW,CAAC;QACtDC,MAAM,EAAE,KAAK;QACbC,GAAG,eAAAC,MAAA,CAAeP,KAAI,CAACH,QAAQ,CAACW,MAAM;MACxC,CAAC,CAAC;MAEF,OAAOR,KAAI,CAACS,cAAc,CAAkBP,MAAM,CAAC;IAAC;EACtD;EAEMQ,cAAcA,CAAA,EAEM;IAAA,IAAAC,UAAA,GAAAC,SAAA;MAAAC,MAAA;IAAA,OAAAZ,iBAAA;MAAA,IADxBa,OAA8B,GAAAH,UAAA,CAAAI,MAAA,QAAAJ,UAAA,QAAAK,SAAA,GAAAL,UAAA,MAAG,CAAC,CAAC;MAEnC,IAAMM,eAAe,GAAGH,OAAO,CAACI,aAAa,IAAIxB,yBAAyB;MAE1E,IAAMQ,MAAM,SAASW,MAAI,CAAChB,QAAQ,CAACM,MAAM,CAAC,CAAC,CAACC,WAAW,CAAC;QACtDC,MAAM,EAAE,KAAK;QACbC,GAAG,eAAAC,MAAA,CAAeM,MAAI,CAAChB,QAAQ,CAACW,MAAM,mBAAAD,MAAA,CAAgBU,eAAe,CAAE;QACvEE,MAAM,EAAE;UAAEC,MAAM,EAAEN,OAAO,CAACM;QAAO;MACnC,CAAC,CAAC;MAEF,OAAOP,MAAI,CAACJ,cAAc,CAAgBP,MAAM,CAAC;IAAC;EACpD;EAEMmB,cAAcA,CAClBH,aAAuC,EAEf;IAAA,IAAAI,WAAA,GAAAV,SAAA;MAAAW,MAAA;IAAA,OAAAtB,iBAAA;MAAA,IADxBa,OAA0B,GAAAQ,WAAA,CAAAP,MAAA,QAAAO,WAAA,QAAAN,SAAA,GAAAM,WAAA,MAAG,CAAC,CAAC;MAE/B,IAAML,eAAe,GAAGH,OAAO,CAACI,aAAa,IAAIxB,yBAAyB;MAE1E,IAAMQ,MAAM,SAASqB,MAAI,CAAC1B,QAAQ,CAACM,MAAM,CAAC,CAAC,CAACC,WAAW,CAAC;QACtDC,MAAM,EAAE,KAAK;QACbC,GAAG,eAAAC,MAAA,CAAegB,MAAI,CAAC1B,QAAQ,CAACW,MAAM,mBAAAD,MAAA,CAAgBU,eAAe,CAAE;QACvEO,IAAI,EAAEN;MACR,CAAC,CAAC;MAEF,OAAOK,MAAI,CAACd,cAAc,CAAgBP,MAAM,CAAC;IAAC;EACpD;EAEMuB,cAAcA,CAAUN,MAA2B,EAAE;IAAA,IAAAO,MAAA;IAAA,OAAAzB,iBAAA;MACzD,IAAMC,MAAM,SAASwB,MAAI,CAAC7B,QAAQ,CAACM,MAAM,CAAC,CAAC,CAACC,WAAW,CAAC;QACtDC,MAAM,EAAE,KAAK;QACbC,GAAG,eAAAC,MAAA,CAAemB,MAAI,CAAC7B,QAAQ,CAACW,MAAM,oBAAAD,MAAA,CAAiBY,MAAM,CAACQ,SAAS;MACzE,CAAC,CAAC;MAEF,OAAOD,MAAI,CAACjB,cAAc,CAAiBP,MAAM,CAAC;IAAC;EACrD;EAEM0B,cAAcA,CAAAC,IAAA,EAGI;IAAA,IAAAC,MAAA;IAAA,OAAA7B,iBAAA;MAAA,IAHM;QAC5B0B,SAAS;QACTI;MACmB,CAAC,GAAAF,IAAA;MACpB,IAAM3B,MAAM,SAAS4B,MAAI,CAACjC,QAAQ,CAACM,MAAM,CAAC,CAAC,CAACC,WAAW,CAAC;QACtDC,MAAM,EAAE,KAAK;QACbC,GAAG,eAAAC,MAAA,CAAeuB,MAAI,CAACjC,QAAQ,CAACW,MAAM,oBAAAD,MAAA,CAAiBoB,SAAS,CAAE;QAClEH,IAAI,EAAE;UAAEA,IAAI,EAAEO;QAAY;MAC5B,CAAC,CAAC;MAEF,OAAOD,MAAI,CAACrB,cAAc,CAAiBP,MAAM,CAAC;IAAC;EACrD;EAEQO,cAAcA,CAAIuB,QAAqB,EAAE;IAC/C,IAAIA,QAAQ,CAACC,UAAU,KAAK,OAAO,EAAE;MACnC,MAAM,IAAIC,KAAK,CAACF,QAAQ,CAACG,KAAK,IAAIH,QAAQ,CAACI,IAAI,CAAC;IAClD;IAEA,OAAOJ,QAAQ,CAACI,IAAI;EACtB;AACF;AAEA,eAAezC,UAAU"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=interfaces.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interfaces.js","names":[],"sources":["../../../../src/clients/users/interfaces.ts"],"sourcesContent":["export interface SetChannelDataInput {\n channelId: string;\n channelData: Record<string, any>;\n}\n\nexport interface GetChannelDataInput {\n channelId: string;\n}\n"],"mappings":""}
package/dist/esm/index.js CHANGED
@@ -4,6 +4,7 @@ export * from "./interfaces";
4
4
  export * from "./clients/feed/types";
5
5
  export * from "./clients/feed/interfaces";
6
6
  export * from "./clients/preferences/interfaces";
7
+ export * from "./clients/users";
7
8
  export * from "./networkStatus";
8
9
  export default Knock;
9
10
  export { Feed, FeedClient };
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/index.ts"],"names":["Knock","FeedClient","Feed"],"mappings":"AAAA,OAAOA,KAAP,MAAkB,SAAlB;AACA,OAAOC,UAAP,IAAqBC,IAArB,QAAiC,gBAAjC;AAEA,cAAc,cAAd;AACA,cAAc,sBAAd;AACA,cAAc,2BAAd;AACA,cAAc,kCAAd;AACA,cAAc,iBAAd;AAEA,eAAeF,KAAf;AACA,SAASE,IAAT,EAAeD,UAAf","sourcesContent":["import Knock from \"./knock\";\nimport FeedClient, { Feed } from \"./clients/feed\";\n\nexport * from \"./interfaces\";\nexport * from \"./clients/feed/types\";\nexport * from \"./clients/feed/interfaces\";\nexport * from \"./clients/preferences/interfaces\";\nexport * from \"./networkStatus\";\n\nexport default Knock;\nexport { Feed, FeedClient };\n"],"file":"index.js"}
1
+ {"version":3,"file":"index.js","names":["Knock","FeedClient","Feed"],"sources":["../../src/index.ts"],"sourcesContent":["import Knock from \"./knock\";\nimport FeedClient, { Feed } from \"./clients/feed\";\n\nexport * from \"./interfaces\";\nexport * from \"./clients/feed/types\";\nexport * from \"./clients/feed/interfaces\";\nexport * from \"./clients/preferences/interfaces\";\nexport * from \"./clients/users\";\nexport * from \"./networkStatus\";\n\nexport default Knock;\nexport { Feed, FeedClient };\n"],"mappings":"AAAA,OAAOA,KAAK,MAAM,SAAS;AAC3B,OAAOC,UAAU,IAAIC,IAAI,QAAQ,gBAAgB;AAEjD,cAAc,cAAc;AAC5B,cAAc,sBAAsB;AACpC,cAAc,2BAA2B;AACzC,cAAc,kCAAkC;AAChD,cAAc,iBAAiB;AAC/B,cAAc,iBAAiB;AAE/B,eAAeF,KAAK;AACpB,SAASE,IAAI,EAAED,UAAU"}
@@ -1 +1 @@
1
- {"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[],"file":"interfaces.js"}
1
+ {"version":3,"file":"interfaces.js","names":[],"sources":["../../src/interfaces.ts"],"sourcesContent":["export interface KnockOptions {\n host?: string;\n}\n\nexport type GenericData = {\n // eslint-disable-next-line\n [x: string]: any;\n};\n\nexport interface KnockObject<T = GenericData> {\n id: string;\n collection: string;\n properties: T;\n updated_at: string;\n created_at: string | null;\n}\n\nexport interface User extends GenericData {\n id: string;\n email: string | null;\n name: string | null;\n phone_number: string | null;\n avatar: string | null;\n updated_at: string;\n created_at: string | null;\n}\n\nexport interface PageInfo {\n after: string | null;\n before: string | null;\n page_size: number;\n}\n\nexport type Recipient = User | KnockObject;\n\nexport interface Activity<T = GenericData> {\n id: string;\n inserted_at: string;\n updated_at: string;\n recipient: Recipient;\n actor: Recipient | null;\n data: T | null;\n}\n\nexport interface ChannelData<T = any> {\n channel_id: string;\n data: T;\n}\n"],"mappings":""}
package/dist/esm/knock.js CHANGED
@@ -2,38 +2,32 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
2
2
  import ApiClient from "./api";
3
3
  import FeedClient from "./clients/feed";
4
4
  import Preferences from "./clients/preferences";
5
+ import UserClient from "./clients/users";
5
6
  var DEFAULT_HOST = "https://api.knock.app";
6
-
7
7
  class Knock {
8
8
  constructor(apiKey) {
9
9
  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
10
10
  this.apiKey = apiKey;
11
-
12
11
  _defineProperty(this, "host", void 0);
13
-
14
12
  _defineProperty(this, "apiClient", null);
15
-
16
13
  _defineProperty(this, "userId", void 0);
17
-
18
14
  _defineProperty(this, "userToken", void 0);
19
-
20
15
  _defineProperty(this, "feeds", new FeedClient(this));
21
-
22
16
  _defineProperty(this, "preferences", new Preferences(this));
17
+ _defineProperty(this, "user", new UserClient(this));
18
+ this.host = options.host || DEFAULT_HOST;
23
19
 
24
- this.host = options.host || DEFAULT_HOST; // Fail loudly if we're using the wrong API key
25
-
20
+ // Fail loudly if we're using the wrong API key
26
21
  if (this.apiKey && this.apiKey.startsWith("sk_")) {
27
22
  throw new Error("[Knock] You are using your secret API key on the client. Please use the public key.");
28
23
  }
29
24
  }
30
-
31
25
  client() {
32
26
  if (!this.userId) {
33
27
  console.warn("[Knock] You must call authenticate(userId, userToken) first before trying to make a request.\n Typically you'll see this message when you're creating a feed instance before having called\n authenticate with a user Id and token. That means we won't know who to issue the request\n to Knock on behalf of.\n ");
34
- } // Initiate a new API client if we don't have one yet
35
-
28
+ }
36
29
 
30
+ // Initiate a new API client if we don't have one yet
37
31
  if (!this.apiClient) {
38
32
  this.apiClient = new ApiClient({
39
33
  apiKey: this.apiKey,
@@ -41,41 +35,35 @@ class Knock {
41
35
  userToken: this.userToken
42
36
  });
43
37
  }
44
-
45
38
  return this.apiClient;
46
39
  }
40
+
47
41
  /*
48
42
  Authenticates the current user. In non-sandbox environments
49
43
  the userToken must be specified.
50
44
  */
51
-
52
-
53
45
  authenticate(userId, userToken) {
54
46
  this.userId = userId;
55
47
  this.userToken = userToken;
56
48
  return;
57
49
  }
50
+
58
51
  /*
59
52
  Returns whether or this Knock instance is authenticated. Passing `true` will check the presence
60
53
  of the userToken as well.
61
54
  */
62
-
63
-
64
55
  isAuthenticated() {
65
56
  var checkUserToken = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
66
57
  return checkUserToken ? this.userId && this.userToken : this.userId;
67
- } // Used to teardown any connected instances
68
-
58
+ }
69
59
 
60
+ // Used to teardown any connected instances
70
61
  teardown() {
71
62
  if (!this.apiClient) return;
72
-
73
63
  if (this.apiClient.socket) {
74
64
  this.apiClient.socket.disconnect();
75
65
  }
76
66
  }
77
-
78
67
  }
79
-
80
68
  export default Knock;
81
69
  //# sourceMappingURL=knock.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/knock.ts"],"names":["ApiClient","FeedClient","Preferences","DEFAULT_HOST","Knock","constructor","apiKey","options","host","startsWith","Error","client","userId","console","warn","apiClient","userToken","authenticate","isAuthenticated","checkUserToken","teardown","socket","disconnect"],"mappings":";AAAA,OAAOA,SAAP,MAAsB,OAAtB;AACA,OAAOC,UAAP,MAAuB,gBAAvB;AACA,OAAOC,WAAP,MAAwB,uBAAxB;AAGA,IAAMC,YAAY,GAAG,uBAArB;;AAEA,MAAMC,KAAN,CAAY;AASVC,EAAAA,WAAW,CAAUC,MAAV,EAAsD;AAAA,QAA5BC,OAA4B,uEAAJ,EAAI;AAAA,SAA5CD,MAA4C,GAA5CA,MAA4C;;AAAA;;AAAA,uCAP3B,IAO2B;;AAAA;;AAAA;;AAAA,mCAHhD,IAAIL,UAAJ,CAAe,IAAf,CAGgD;;AAAA,yCAF1C,IAAIC,WAAJ,CAAgB,IAAhB,CAE0C;;AAC/D,SAAKM,IAAL,GAAYD,OAAO,CAACC,IAAR,IAAgBL,YAA5B,CAD+D,CAG/D;;AACA,QAAI,KAAKG,MAAL,IAAe,KAAKA,MAAL,CAAYG,UAAZ,CAAuB,KAAvB,CAAnB,EAAkD;AAChD,YAAM,IAAIC,KAAJ,CACJ,qFADI,CAAN;AAGD;AACF;;AAEDC,EAAAA,MAAM,GAAG;AACP,QAAI,CAAC,KAAKC,MAAV,EAAkB;AAChBC,MAAAA,OAAO,CAACC,IAAR;AAOD,KATM,CAWP;;;AACA,QAAI,CAAC,KAAKC,SAAV,EAAqB;AACnB,WAAKA,SAAL,GAAiB,IAAIf,SAAJ,CAAc;AAC7BM,QAAAA,MAAM,EAAE,KAAKA,MADgB;AAE7BE,QAAAA,IAAI,EAAE,KAAKA,IAFkB;AAG7BQ,QAAAA,SAAS,EAAE,KAAKA;AAHa,OAAd,CAAjB;AAKD;;AAED,WAAO,KAAKD,SAAZ;AACD;AAED;AACF;AACA;AACA;;;AACEE,EAAAA,YAAY,CAACL,MAAD,EAAiBI,SAAjB,EAAqC;AAC/C,SAAKJ,MAAL,GAAcA,MAAd;AACA,SAAKI,SAAL,GAAiBA,SAAjB;AAEA;AACD;AAED;AACF;AACA;AACA;;;AACEE,EAAAA,eAAe,GAAyB;AAAA,QAAxBC,cAAwB,uEAAP,KAAO;AACtC,WAAOA,cAAc,GAAG,KAAKP,MAAL,IAAe,KAAKI,SAAvB,GAAmC,KAAKJ,MAA7D;AACD,GA5DS,CA8DV;;;AACAQ,EAAAA,QAAQ,GAAG;AACT,QAAI,CAAC,KAAKL,SAAV,EAAqB;;AACrB,QAAI,KAAKA,SAAL,CAAeM,MAAnB,EAA2B;AACzB,WAAKN,SAAL,CAAeM,MAAf,CAAsBC,UAAtB;AACD;AACF;;AApES;;AAuEZ,eAAelB,KAAf","sourcesContent":["import ApiClient from \"./api\";\nimport FeedClient from \"./clients/feed\";\nimport Preferences from \"./clients/preferences\";\nimport { KnockOptions } from \"./interfaces\";\n\nconst DEFAULT_HOST = \"https://api.knock.app\";\n\nclass Knock {\n private host: string;\n private apiClient: ApiClient | null = null;\n public userId: string | undefined;\n public userToken: string | undefined;\n\n readonly feeds = new FeedClient(this);\n readonly preferences = new Preferences(this);\n\n constructor(readonly apiKey: string, options: KnockOptions = {}) {\n this.host = options.host || DEFAULT_HOST;\n\n // Fail loudly if we're using the wrong API key\n if (this.apiKey && this.apiKey.startsWith(\"sk_\")) {\n throw new Error(\n \"[Knock] You are using your secret API key on the client. Please use the public key.\",\n );\n }\n }\n\n client() {\n if (!this.userId) {\n console.warn(\n `[Knock] You must call authenticate(userId, userToken) first before trying to make a request.\n Typically you'll see this message when you're creating a feed instance before having called\n authenticate with a user Id and token. That means we won't know who to issue the request\n to Knock on behalf of.\n `,\n );\n }\n\n // Initiate a new API client if we don't have one yet\n if (!this.apiClient) {\n this.apiClient = new ApiClient({\n apiKey: this.apiKey,\n host: this.host,\n userToken: this.userToken,\n });\n }\n\n return this.apiClient;\n }\n\n /*\n Authenticates the current user. In non-sandbox environments\n the userToken must be specified.\n */\n authenticate(userId: string, userToken?: string) {\n this.userId = userId;\n this.userToken = userToken;\n\n return;\n }\n\n /*\n Returns whether or this Knock instance is authenticated. Passing `true` will check the presence\n of the userToken as well.\n */\n isAuthenticated(checkUserToken = false) {\n return checkUserToken ? this.userId && this.userToken : this.userId;\n }\n\n // Used to teardown any connected instances\n teardown() {\n if (!this.apiClient) return;\n if (this.apiClient.socket) {\n this.apiClient.socket.disconnect();\n }\n }\n}\n\nexport default Knock;\n"],"file":"knock.js"}
1
+ {"version":3,"file":"knock.js","names":["ApiClient","FeedClient","Preferences","UserClient","DEFAULT_HOST","Knock","constructor","apiKey","options","arguments","length","undefined","_defineProperty","host","startsWith","Error","client","userId","console","warn","apiClient","userToken","authenticate","isAuthenticated","checkUserToken","teardown","socket","disconnect"],"sources":["../../src/knock.ts"],"sourcesContent":["import ApiClient from \"./api\";\nimport FeedClient from \"./clients/feed\";\nimport Preferences from \"./clients/preferences\";\nimport UserClient from \"./clients/users\";\nimport { KnockOptions } from \"./interfaces\";\n\nconst DEFAULT_HOST = \"https://api.knock.app\";\n\nclass Knock {\n private host: string;\n private apiClient: ApiClient | null = null;\n public userId: string | undefined;\n public userToken: string | undefined;\n\n readonly feeds = new FeedClient(this);\n readonly preferences = new Preferences(this);\n readonly user = new UserClient(this);\n\n constructor(readonly apiKey: string, options: KnockOptions = {}) {\n this.host = options.host || DEFAULT_HOST;\n\n // Fail loudly if we're using the wrong API key\n if (this.apiKey && this.apiKey.startsWith(\"sk_\")) {\n throw new Error(\n \"[Knock] You are using your secret API key on the client. Please use the public key.\",\n );\n }\n }\n\n client() {\n if (!this.userId) {\n console.warn(\n `[Knock] You must call authenticate(userId, userToken) first before trying to make a request.\n Typically you'll see this message when you're creating a feed instance before having called\n authenticate with a user Id and token. That means we won't know who to issue the request\n to Knock on behalf of.\n `,\n );\n }\n\n // Initiate a new API client if we don't have one yet\n if (!this.apiClient) {\n this.apiClient = new ApiClient({\n apiKey: this.apiKey,\n host: this.host,\n userToken: this.userToken,\n });\n }\n\n return this.apiClient;\n }\n\n /*\n Authenticates the current user. In non-sandbox environments\n the userToken must be specified.\n */\n authenticate(userId: string, userToken?: string) {\n this.userId = userId;\n this.userToken = userToken;\n\n return;\n }\n\n /*\n Returns whether or this Knock instance is authenticated. Passing `true` will check the presence\n of the userToken as well.\n */\n isAuthenticated(checkUserToken = false) {\n return checkUserToken ? this.userId && this.userToken : this.userId;\n }\n\n // Used to teardown any connected instances\n teardown() {\n if (!this.apiClient) return;\n if (this.apiClient.socket) {\n this.apiClient.socket.disconnect();\n }\n }\n}\n\nexport default Knock;\n"],"mappings":";AAAA,OAAOA,SAAS,MAAM,OAAO;AAC7B,OAAOC,UAAU,MAAM,gBAAgB;AACvC,OAAOC,WAAW,MAAM,uBAAuB;AAC/C,OAAOC,UAAU,MAAM,iBAAiB;AAGxC,IAAMC,YAAY,GAAG,uBAAuB;AAE5C,MAAMC,KAAK,CAAC;EAUVC,WAAWA,CAAUC,MAAc,EAA8B;IAAA,IAA5BC,OAAqB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;IAAA,KAA1CF,MAAc,GAAdA,MAAc;IAAAK,eAAA;IAAAA,eAAA,oBARG,IAAI;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA,gBAIzB,IAAIX,UAAU,CAAC,IAAI,CAAC;IAAAW,eAAA,sBACd,IAAIV,WAAW,CAAC,IAAI,CAAC;IAAAU,eAAA,eAC5B,IAAIT,UAAU,CAAC,IAAI,CAAC;IAGlC,IAAI,CAACU,IAAI,GAAGL,OAAO,CAACK,IAAI,IAAIT,YAAY;;IAExC;IACA,IAAI,IAAI,CAACG,MAAM,IAAI,IAAI,CAACA,MAAM,CAACO,UAAU,CAAC,KAAK,CAAC,EAAE;MAChD,MAAM,IAAIC,KAAK,CACb,qFACF,CAAC;IACH;EACF;EAEAC,MAAMA,CAAA,EAAG;IACP,IAAI,CAAC,IAAI,CAACC,MAAM,EAAE;MAChBC,OAAO,CAACC,IAAI,gVAMZ,CAAC;IACH;;IAEA;IACA,IAAI,CAAC,IAAI,CAACC,SAAS,EAAE;MACnB,IAAI,CAACA,SAAS,GAAG,IAAIpB,SAAS,CAAC;QAC7BO,MAAM,EAAE,IAAI,CAACA,MAAM;QACnBM,IAAI,EAAE,IAAI,CAACA,IAAI;QACfQ,SAAS,EAAE,IAAI,CAACA;MAClB,CAAC,CAAC;IACJ;IAEA,OAAO,IAAI,CAACD,SAAS;EACvB;;EAEA;AACF;AACA;AACA;EACEE,YAAYA,CAACL,MAAc,EAAEI,SAAkB,EAAE;IAC/C,IAAI,CAACJ,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACI,SAAS,GAAGA,SAAS;IAE1B;EACF;;EAEA;AACF;AACA;AACA;EACEE,eAAeA,CAAA,EAAyB;IAAA,IAAxBC,cAAc,GAAAf,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,KAAK;IACpC,OAAOe,cAAc,GAAG,IAAI,CAACP,MAAM,IAAI,IAAI,CAACI,SAAS,GAAG,IAAI,CAACJ,MAAM;EACrE;;EAEA;EACAQ,QAAQA,CAAA,EAAG;IACT,IAAI,CAAC,IAAI,CAACL,SAAS,EAAE;IACrB,IAAI,IAAI,CAACA,SAAS,CAACM,MAAM,EAAE;MACzB,IAAI,CAACN,SAAS,CAACM,MAAM,CAACC,UAAU,CAAC,CAAC;IACpC;EACF;AACF;AAEA,eAAetB,KAAK"}
@@ -1,12 +1,10 @@
1
- export var NetworkStatus;
2
-
3
- (function (NetworkStatus) {
1
+ export var NetworkStatus = /*#__PURE__*/function (NetworkStatus) {
4
2
  NetworkStatus["loading"] = "loading";
5
3
  NetworkStatus["fetchMore"] = "fetchMore";
6
4
  NetworkStatus["ready"] = "ready";
7
5
  NetworkStatus["error"] = "error";
8
- })(NetworkStatus || (NetworkStatus = {}));
9
-
6
+ return NetworkStatus;
7
+ }({});
10
8
  export function isRequestInFlight(networkStatus) {
11
9
  return [NetworkStatus.loading, NetworkStatus.fetchMore].includes(networkStatus);
12
10
  }
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/networkStatus.ts"],"names":["NetworkStatus","isRequestInFlight","networkStatus","loading","fetchMore","includes"],"mappings":"AAAA,WAAYA,aAAZ;;WAAYA,a;AAAAA,EAAAA,a;AAAAA,EAAAA,a;AAAAA,EAAAA,a;AAAAA,EAAAA,a;GAAAA,a,KAAAA,a;;AAcZ,OAAO,SAASC,iBAAT,CAA2BC,aAA3B,EAAkE;AACvE,SAAO,CAACF,aAAa,CAACG,OAAf,EAAwBH,aAAa,CAACI,SAAtC,EAAiDC,QAAjD,CACLH,aADK,CAAP;AAGD","sourcesContent":["export enum NetworkStatus {\n // Performing a top level loading operation\n loading = \"loading\",\n\n // Performing a fetch more on some already loaded data\n fetchMore = \"fetchMore\",\n\n // No operation is currently in progress\n ready = \"ready\",\n\n // The last operation failed with an error\n error = \"error\",\n}\n\nexport function isRequestInFlight(networkStatus: NetworkStatus): boolean {\n return [NetworkStatus.loading, NetworkStatus.fetchMore].includes(\n networkStatus,\n );\n}\n"],"file":"networkStatus.js"}
1
+ {"version":3,"file":"networkStatus.js","names":["NetworkStatus","isRequestInFlight","networkStatus","loading","fetchMore","includes"],"sources":["../../src/networkStatus.ts"],"sourcesContent":["export enum NetworkStatus {\n // Performing a top level loading operation\n loading = \"loading\",\n\n // Performing a fetch more on some already loaded data\n fetchMore = \"fetchMore\",\n\n // No operation is currently in progress\n ready = \"ready\",\n\n // The last operation failed with an error\n error = \"error\",\n}\n\nexport function isRequestInFlight(networkStatus: NetworkStatus): boolean {\n return [NetworkStatus.loading, NetworkStatus.fetchMore].includes(\n networkStatus,\n );\n}\n"],"mappings":"AAAA,WAAYA,aAAa,0BAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAA,OAAbA,aAAa;AAAA;AAczB,OAAO,SAASC,iBAAiBA,CAACC,aAA4B,EAAW;EACvE,OAAO,CAACF,aAAa,CAACG,OAAO,EAAEH,aAAa,CAACI,SAAS,CAAC,CAACC,QAAQ,CAC9DH,aACF,CAAC;AACH"}
@@ -1,6 +1,6 @@
1
1
  import { AxiosRequestConfig } from "axios";
2
2
  import { Socket } from "phoenix";
3
- declare type ApiClientOptions = {
3
+ type ApiClientOptions = {
4
4
  host: string;
5
5
  apiKey: string;
6
6
  userToken: string | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA,OAAc,EAAiB,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAEjE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAGjC,aAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,WAAW;IAE1B,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,UAAU,EAAE,IAAI,GAAG,OAAO,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,cAAM,SAAS;IACb,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,WAAW,CAAgB;IAE5B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEtB,OAAO,EAAE,gBAAgB;IAgC/B,WAAW,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAwBhE,OAAO,CAAC,eAAe;CAuBxB;AAED,eAAe,SAAS,CAAC"}
1
+ {"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA,OAAc,EAAiB,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAEjE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAGjC,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,WAAW;IAE1B,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,UAAU,EAAE,IAAI,GAAG,OAAO,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,cAAM,SAAS;IACb,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,WAAW,CAAgB;IAE5B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEtB,OAAO,EAAE,gBAAgB;IAgC/B,WAAW,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAwBhE,OAAO,CAAC,eAAe;CAuBxB;AAED,eAAe,SAAS,CAAC"}
@@ -2,7 +2,7 @@ import { StoreApi } from "zustand";
2
2
  import { BindableFeedEvent, FeedEventCallback, FeedItemOrItems, FeedStoreState, FeedRealTimeCallback } from "./types";
3
3
  import { FeedClientOptions, FetchFeedOptions } from "./interfaces";
4
4
  import Knock from "../../knock";
5
- export declare type Status = "seen" | "read" | "interacted" | "archived" | "unseen" | "unread" | "unarchived";
5
+ export type Status = "seen" | "read" | "interacted" | "archived" | "unseen" | "unread" | "unarchived";
6
6
  declare class Feed {
7
7
  readonly knock: Knock;
8
8
  readonly feedId: string;
@@ -1 +1 @@
1
- {"version":3,"file":"feed.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/feed.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAInC,OAAO,EACL,iBAAiB,EAEjB,iBAAiB,EAEjB,eAAe,EACf,cAAc,EAEd,oBAAoB,EACrB,MAAM,SAAS,CAAC;AACjB,OAAO,EAEL,iBAAiB,EACjB,gBAAgB,EAGjB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,MAAM,aAAa,CAAC;AAGhC,oBAAY,MAAM,GACd,MAAM,GACN,MAAM,GACN,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,YAAY,CAAC;AAOjB,cAAM,IAAI;IAYN,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM;IAZzB,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,WAAW,CAAe;IAClC,OAAO,CAAC,cAAc,CAAoB;IAC1C,OAAO,CAAC,gBAAgB,CAA0B;IAG3C,KAAK,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;gBAG5B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,EACvB,OAAO,EAAE,iBAAiB;IA2B5B;;;OAGG;IACH,QAAQ;IAkBR,gBAAgB;IAyChB,EAAE,CACA,SAAS,EAAE,iBAAiB,EAC5B,QAAQ,EAAE,iBAAiB,GAAG,oBAAoB;IAKpD,GAAG,CACD,SAAS,EAAE,iBAAiB,EAC5B,QAAQ,EAAE,iBAAiB,GAAG,oBAAoB;IAKpD,QAAQ;IAIF,UAAU,CAAC,WAAW,EAAE,eAAe;IAYvC,aAAa;IA+Cb,YAAY,CAAC,WAAW,EAAE,eAAe;IAWzC,UAAU,CAAC,WAAW,EAAE,eAAe;IAYvC,aAAa;IA+Cb,YAAY,CAAC,WAAW,EAAE,eAAe;IAWzC,gBAAgB,CAAC,WAAW,EAAE,eAAe;IAuB7C,cAAc,CAAC,WAAW,EAAE,eAAe;IA0E3C,iBAAiB;IAgCjB,gBAAgB,CAAC,WAAW,EAAE,eAAe;IAS7C,KAAK,CAAC,OAAO,GAAE,gBAAqB;;;;IA2EpC,aAAa;IAgBnB,OAAO,CAAC,SAAS;YAQH,oBAAoB;IAalC,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,iCAAiC;YAmD3B,gBAAgB;YAmBhB,oBAAoB;IAyBlC,OAAO,CAAC,oBAAoB;CAmB7B;AAED,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"feed.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/feed.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAInC,OAAO,EACL,iBAAiB,EAEjB,iBAAiB,EAEjB,eAAe,EACf,cAAc,EAEd,oBAAoB,EACrB,MAAM,SAAS,CAAC;AACjB,OAAO,EAEL,iBAAiB,EACjB,gBAAgB,EAGjB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,MAAM,aAAa,CAAC;AAGhC,MAAM,MAAM,MAAM,GACd,MAAM,GACN,MAAM,GACN,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,YAAY,CAAC;AAOjB,cAAM,IAAI;IAYN,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM;IAZzB,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,WAAW,CAAe;IAClC,OAAO,CAAC,cAAc,CAAoB;IAC1C,OAAO,CAAC,gBAAgB,CAA0B;IAG3C,KAAK,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;gBAG5B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,EACvB,OAAO,EAAE,iBAAiB;IA2B5B;;;OAGG;IACH,QAAQ;IAkBR,gBAAgB;IAyChB,EAAE,CACA,SAAS,EAAE,iBAAiB,EAC5B,QAAQ,EAAE,iBAAiB,GAAG,oBAAoB;IAKpD,GAAG,CACD,SAAS,EAAE,iBAAiB,EAC5B,QAAQ,EAAE,iBAAiB,GAAG,oBAAoB;IAKpD,QAAQ;IAIF,UAAU,CAAC,WAAW,EAAE,eAAe;IAYvC,aAAa;IA+Cb,YAAY,CAAC,WAAW,EAAE,eAAe;IAWzC,UAAU,CAAC,WAAW,EAAE,eAAe;IAYvC,aAAa;IA+Cb,YAAY,CAAC,WAAW,EAAE,eAAe;IAWzC,gBAAgB,CAAC,WAAW,EAAE,eAAe;IAuB7C,cAAc,CAAC,WAAW,EAAE,eAAe;IA0E3C,iBAAiB;IAgCjB,gBAAgB,CAAC,WAAW,EAAE,eAAe;IAS7C,KAAK,CAAC,OAAO,GAAE,gBAAqB;;;;IA2EpC,aAAa;IAgBnB,OAAO,CAAC,SAAS;YAQH,oBAAoB;IAalC,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,iCAAiC;YAmD3B,gBAAgB;YAmBhB,oBAAoB;IAyBlC,OAAO,CAAC,oBAAoB;CAmB7B;AAED,eAAe,IAAI,CAAC"}
@@ -8,11 +8,12 @@ export interface FeedClientOptions {
8
8
  source?: string;
9
9
  tenant?: string;
10
10
  has_tenant?: boolean;
11
+ workflow_categories?: string[];
11
12
  archived?: "include" | "exclude" | "only";
12
13
  trigger_data?: GenericData;
13
14
  __experimentalCrossBrowserUpdates?: boolean;
14
15
  }
15
- export declare type FetchFeedOptions = {
16
+ export type FetchFeedOptions = {
16
17
  __loadingType?: NetworkStatus.loading | NetworkStatus.fetchMore;
17
18
  __fetchSource?: "socket" | "http";
18
19
  } & Omit<FeedClientOptions, "__experimentalCrossBrowserUpdates">;
@@ -1 +1 @@
1
- {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAIpD,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC;IAEvD,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAE1C,YAAY,CAAC,EAAE,WAAW,CAAC;IAE3B,iCAAiC,CAAC,EAAE,OAAO,CAAC;CAC7C;AAED,oBAAY,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,SAAS,CAAC;IAChE,aAAa,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CACnC,GAAG,IAAI,CAAC,iBAAiB,EAAE,mCAAmC,CAAC,CAAC;AAEjE,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,WAAW;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1B,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IACf,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,QAAQ,EAAE,CAAC;IACpB,IAAI,EAAE,YAAY,CAAC;IACnB,SAAS,EAAE,QAAQ,CAAC;CACrB"}
1
+ {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAIpD,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC;IAEvD,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAE1C,YAAY,CAAC,EAAE,WAAW,CAAC;IAE3B,iCAAiC,CAAC,EAAE,OAAO,CAAC;CAC7C;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,SAAS,CAAC;IAChE,aAAa,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CACnC,GAAG,IAAI,CAAC,iBAAiB,EAAE,mCAAmC,CAAC,CAAC;AAEjE,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,WAAW;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1B,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IACf,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,QAAQ,EAAE,CAAC;IACpB,IAAI,EAAE,YAAY,CAAC;IACnB,SAAS,EAAE,QAAQ,CAAC;CACrB"}
@@ -1,11 +1,11 @@
1
1
  import { PageInfo } from "../../interfaces";
2
2
  import { NetworkStatus } from "../../networkStatus";
3
3
  import { FeedItem, FeedMetadata, FeedResponse } from "./interfaces";
4
- export declare type StoreFeedResultOptions = {
4
+ export type StoreFeedResultOptions = {
5
5
  shouldSetPage?: boolean;
6
6
  shouldAppend?: boolean;
7
7
  };
8
- export declare type FeedStoreState = {
8
+ export type FeedStoreState = {
9
9
  items: FeedItem[];
10
10
  pageInfo: PageInfo;
11
11
  metadata: FeedMetadata;
@@ -18,18 +18,18 @@ export declare type FeedStoreState = {
18
18
  setItemAttrs: (itemIds: string[], attrs: object) => void;
19
19
  resetStore: (metadata?: FeedMetadata) => void;
20
20
  };
21
- export declare type FeedMessagesReceivedPayload = {
21
+ export type FeedMessagesReceivedPayload = {
22
22
  metadata: FeedMetadata;
23
23
  };
24
- export declare type FeedRealTimeEvent = "messages.new";
25
- export declare type FeedEvent = FeedRealTimeEvent | "items.received.page" | "items.received.realtime" | "items.archived" | "items.unarchived" | "items.seen" | "items.unseen" | "items.read" | "items.unread" | "items.all_archived" | "items.all_read" | "items.all_seen";
26
- export declare type BindableFeedEvent = FeedEvent | "items.received.*" | "items.*";
27
- export declare type FeedEventPayload = {
24
+ export type FeedRealTimeEvent = "messages.new";
25
+ export type FeedEvent = FeedRealTimeEvent | "items.received.page" | "items.received.realtime" | "items.archived" | "items.unarchived" | "items.seen" | "items.unseen" | "items.read" | "items.unread" | "items.all_archived" | "items.all_read" | "items.all_seen";
26
+ export type BindableFeedEvent = FeedEvent | "items.received.*" | "items.*";
27
+ export type FeedEventPayload = {
28
28
  event: Omit<FeedEvent, "messages.new">;
29
29
  items: FeedItem[];
30
30
  metadata: FeedMetadata;
31
31
  };
32
- export declare type FeedRealTimeCallback = (resp: FeedResponse) => void;
33
- export declare type FeedEventCallback = (payload: FeedEventPayload) => void;
34
- export declare type FeedItemOrItems = FeedItem | FeedItem[];
32
+ export type FeedRealTimeCallback = (resp: FeedResponse) => void;
33
+ export type FeedEventCallback = (payload: FeedEventPayload) => void;
34
+ export type FeedItemOrItems = FeedItem | FeedItem[];
35
35
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEpE,oBAAY,sBAAsB,GAAG;IACnC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC3B,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,aAAa,CAAC;IAC7B,SAAS,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAC3E,WAAW,EAAE,CAAC,QAAQ,EAAE,YAAY,KAAK,IAAI,CAAC;IAC9C,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IACvC,gBAAgB,EAAE,CAAC,aAAa,EAAE,aAAa,KAAK,IAAI,CAAC;IACzD,YAAY,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,UAAU,EAAE,CAAC,QAAQ,CAAC,EAAE,YAAY,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,oBAAY,2BAA2B,GAAG;IACxC,QAAQ,EAAE,YAAY,CAAC;CACxB,CAAC;AAQF,oBAAY,iBAAiB,GAAG,cAAc,CAAC;AAE/C,oBAAY,SAAS,GACjB,iBAAiB,GACjB,qBAAqB,GACrB,yBAAyB,GACzB,gBAAgB,GAChB,kBAAkB,GAClB,YAAY,GACZ,cAAc,GACd,YAAY,GACZ,cAAc,GACd,oBAAoB,GACpB,gBAAgB,GAChB,gBAAgB,CAAC;AAGrB,oBAAY,iBAAiB,GAAG,SAAS,GAAG,kBAAkB,GAAG,SAAS,CAAC;AAE3E,oBAAY,gBAAgB,GAAG;IAC7B,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IACvC,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,QAAQ,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF,oBAAY,oBAAoB,GAAG,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,CAAC;AAEhE,oBAAY,iBAAiB,GAAG,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;AAEpE,oBAAY,eAAe,GAAG,QAAQ,GAAG,QAAQ,EAAE,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEpE,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,aAAa,CAAC;IAC7B,SAAS,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAC3E,WAAW,EAAE,CAAC,QAAQ,EAAE,YAAY,KAAK,IAAI,CAAC;IAC9C,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IACvC,gBAAgB,EAAE,CAAC,aAAa,EAAE,aAAa,KAAK,IAAI,CAAC;IACzD,YAAY,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,UAAU,EAAE,CAAC,QAAQ,CAAC,EAAE,YAAY,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,QAAQ,EAAE,YAAY,CAAC;CACxB,CAAC;AAQF,MAAM,MAAM,iBAAiB,GAAG,cAAc,CAAC;AAE/C,MAAM,MAAM,SAAS,GACjB,iBAAiB,GACjB,qBAAqB,GACrB,yBAAyB,GACzB,gBAAgB,GAChB,kBAAkB,GAClB,YAAY,GACZ,cAAc,GACd,YAAY,GACZ,cAAc,GACd,oBAAoB,GACpB,gBAAgB,GAChB,gBAAgB,CAAC;AAGrB,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,kBAAkB,GAAG,SAAS,CAAC;AAE3E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IACvC,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,QAAQ,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,CAAC;AAEhE,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;AAEpE,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,QAAQ,EAAE,CAAC"}
@@ -3,14 +3,41 @@ import { ChannelTypePreferences, ChannelType, PreferenceOptions, SetPreferencesP
3
3
  declare class Preferences {
4
4
  private instance;
5
5
  constructor(instance: Knock);
6
+ /**
7
+ * @deprecated Use `user.getAllPreferences()` instead
8
+ */
6
9
  getAll(): Promise<PreferenceSet>;
10
+ /**
11
+ * @deprecated Use `user.getPreferences()` instead
12
+ */
7
13
  get(options?: PreferenceOptions): Promise<PreferenceSet>;
14
+ /**
15
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
16
+ */
8
17
  set(preferenceSet: SetPreferencesProperties, options?: PreferenceOptions): Promise<PreferenceSet>;
18
+ /**
19
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
20
+ */
9
21
  setChannelTypes(channelTypePreferences: ChannelTypePreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
22
+ /**
23
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
24
+ */
10
25
  setChannelType(channelType: ChannelType, setting: boolean, options?: PreferenceOptions): Promise<PreferenceSet>;
26
+ /**
27
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
28
+ */
11
29
  setWorkflows(workflowPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
30
+ /**
31
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
32
+ */
12
33
  setWorkflow(workflowKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
34
+ /**
35
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
36
+ */
13
37
  setCategories(categoryPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
38
+ /**
39
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
40
+ */
14
41
  setCategory(categoryKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
15
42
  private handleResponse;
16
43
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/preferences/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,aAAa,CAAC;AAChC,OAAO,EACL,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,wBAAwB,EACxB,yBAAyB,EACzB,mBAAmB,EACnB,aAAa,EACd,MAAM,cAAc,CAAC;AAYtB,cAAM,WAAW;IACf,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,QAAQ,EAAE,KAAK;IAIrB,MAAM;IASN,GAAG,CAAC,OAAO,GAAE,iBAAsB;IAWnC,GAAG,CACP,aAAa,EAAE,wBAAwB,EACvC,OAAO,GAAE,iBAAsB;IAa3B,eAAe,CACnB,sBAAsB,EAAE,sBAAsB,EAC9C,OAAO,GAAE,iBAAsB;IAa3B,cAAc,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,iBAAsB;IAa3B,YAAY,CAChB,mBAAmB,EAAE,mBAAmB,EACxC,OAAO,GAAE,iBAAsB;IAa3B,WAAW,CACf,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,yBAAyB,EAClC,OAAO,GAAE,iBAAsB;IAc3B,aAAa,CACjB,mBAAmB,EAAE,mBAAmB,EACxC,OAAO,GAAE,iBAAsB;IAa3B,WAAW,CACf,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,yBAAyB,EAClC,OAAO,GAAE,iBAAsB;IAcjC,OAAO,CAAC,cAAc;CAOvB;AAED,eAAe,WAAW,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/preferences/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,aAAa,CAAC;AAChC,OAAO,EACL,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,wBAAwB,EACxB,yBAAyB,EACzB,mBAAmB,EACnB,aAAa,EACd,MAAM,cAAc,CAAC;AAYtB,cAAM,WAAW;IACf,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,QAAQ,EAAE,KAAK;IAI3B;;OAEG;IACG,MAAM;IASZ;;OAEG;IACG,GAAG,CAAC,OAAO,GAAE,iBAAsB;IAWzC;;OAEG;IACG,GAAG,CACP,aAAa,EAAE,wBAAwB,EACvC,OAAO,GAAE,iBAAsB;IAajC;;OAEG;IACG,eAAe,CACnB,sBAAsB,EAAE,sBAAsB,EAC9C,OAAO,GAAE,iBAAsB;IAajC;;OAEG;IACG,cAAc,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,iBAAsB;IAajC;;OAEG;IACG,YAAY,CAChB,mBAAmB,EAAE,mBAAmB,EACxC,OAAO,GAAE,iBAAsB;IAajC;;OAEG;IACG,WAAW,CACf,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,yBAAyB,EAClC,OAAO,GAAE,iBAAsB;IAcjC;;OAEG;IACG,aAAa,CACjB,mBAAmB,EAAE,mBAAmB,EACxC,OAAO,GAAE,iBAAsB;IAajC;;OAEG;IACG,WAAW,CACf,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,yBAAyB,EAClC,OAAO,GAAE,iBAAsB;IAcjC,OAAO,CAAC,cAAc;CAOvB;AAED,eAAe,WAAW,CAAC"}
@@ -1,11 +1,11 @@
1
- export declare type ChannelType = "email" | "in_app_feed" | "sms" | "push" | "chat" | "http";
2
- export declare type ChannelTypePreferences = {
1
+ export type ChannelType = "email" | "in_app_feed" | "sms" | "push" | "chat" | "http";
2
+ export type ChannelTypePreferences = {
3
3
  [K in ChannelType]?: boolean;
4
4
  };
5
- export declare type WorkflowPreferenceSetting = boolean | {
5
+ export type WorkflowPreferenceSetting = boolean | {
6
6
  channel_types: ChannelTypePreferences;
7
7
  };
8
- export declare type WorkflowPreferences = Partial<Record<string, WorkflowPreferenceSetting>>;
8
+ export type WorkflowPreferences = Partial<Record<string, WorkflowPreferenceSetting>>;
9
9
  export interface SetPreferencesProperties {
10
10
  workflows: WorkflowPreferences;
11
11
  categories: WorkflowPreferences;
@@ -20,4 +20,7 @@ export interface PreferenceSet {
20
20
  export interface PreferenceOptions {
21
21
  preferenceSet?: string;
22
22
  }
23
+ export interface GetPreferencesOptions extends PreferenceOptions {
24
+ tenant?: string;
25
+ }
23
26
  //# sourceMappingURL=interfaces.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/preferences/interfaces.ts"],"names":[],"mappings":"AAEA,oBAAY,WAAW,GAAG,OAAO,GAAG,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAErF,oBAAY,sBAAsB,GAAG;KAClC,CAAC,IAAI,WAAW,CAAC,CAAC,EAAE,OAAO;CAC7B,CAAC;AAEF,oBAAY,yBAAyB,GACjC,OAAO,GACP;IAAE,aAAa,EAAE,sBAAsB,CAAA;CAAE,CAAC;AAE9C,oBAAY,mBAAmB,GAAG,OAAO,CACvC,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAC1C,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,UAAU,EAAE,mBAAmB,CAAC;IAChC,aAAa,EAAE,sBAAsB,CAAC;CACvC;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,mBAAmB,CAAC;IAChC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,aAAa,EAAE,sBAAsB,CAAC;CACvC;AAED,MAAM,WAAW,iBAAiB;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}
1
+ {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/preferences/interfaces.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,WAAW,GACnB,OAAO,GACP,aAAa,GACb,KAAK,GACL,MAAM,GACN,MAAM,GACN,MAAM,CAAC;AAEX,MAAM,MAAM,sBAAsB,GAAG;KAClC,CAAC,IAAI,WAAW,CAAC,CAAC,EAAE,OAAO;CAC7B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC,OAAO,GACP;IAAE,aAAa,EAAE,sBAAsB,CAAA;CAAE,CAAC;AAE9C,MAAM,MAAM,mBAAmB,GAAG,OAAO,CACvC,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAC1C,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,UAAU,EAAE,mBAAmB,CAAC;IAChC,aAAa,EAAE,sBAAsB,CAAC;CACvC;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,mBAAmB,CAAC;IAChC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,aAAa,EAAE,sBAAsB,CAAC;CACvC;AAED,MAAM,WAAW,iBAAiB;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
@@ -0,0 +1,16 @@
1
+ import { ChannelData } from "../../interfaces";
2
+ import Knock from "../../knock";
3
+ import { GetPreferencesOptions, PreferenceOptions, PreferenceSet, SetPreferencesProperties } from "../preferences/interfaces";
4
+ import { GetChannelDataInput, SetChannelDataInput } from "./interfaces";
5
+ declare class UserClient {
6
+ private instance;
7
+ constructor(instance: Knock);
8
+ getAllPreferences(): Promise<PreferenceSet[]>;
9
+ getPreferences(options?: GetPreferencesOptions): Promise<PreferenceSet>;
10
+ setPreferences(preferenceSet: SetPreferencesProperties, options?: PreferenceOptions): Promise<PreferenceSet>;
11
+ getChannelData<T = any>(params: GetChannelDataInput): Promise<ChannelData<T>>;
12
+ setChannelData<T = any>({ channelId, channelData, }: SetChannelDataInput): Promise<ChannelData<T>>;
13
+ private handleResponse;
14
+ }
15
+ export default UserClient;
16
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/users/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,MAAM,aAAa,CAAC;AAChC,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,aAAa,EACb,wBAAwB,EACzB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAIxE,cAAM,UAAU;IACd,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,QAAQ,EAAE,KAAK;IAIrB,iBAAiB;IASjB,cAAc,CAClB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;IAYnB,cAAc,CAClB,aAAa,EAAE,wBAAwB,EACvC,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,aAAa,CAAC;IAYnB,cAAc,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,mBAAmB;IASnD,cAAc,CAAC,CAAC,GAAG,GAAG,EAAE,EAC5B,SAAS,EACT,WAAW,GACZ,EAAE,mBAAmB;IAUtB,OAAO,CAAC,cAAc;CAOvB;AAED,eAAe,UAAU,CAAC"}
@@ -0,0 +1,8 @@
1
+ export interface SetChannelDataInput {
2
+ channelId: string;
3
+ channelData: Record<string, any>;
4
+ }
5
+ export interface GetChannelDataInput {
6
+ channelId: string;
7
+ }
8
+ //# sourceMappingURL=interfaces.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/users/interfaces.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;CACnB"}
@@ -4,6 +4,7 @@ export * from "./interfaces";
4
4
  export * from "./clients/feed/types";
5
5
  export * from "./clients/feed/interfaces";
6
6
  export * from "./clients/preferences/interfaces";
7
+ export * from "./clients/users";
7
8
  export * from "./networkStatus";
8
9
  export default Knock;
9
10
  export { Feed, FeedClient };
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAElD,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kCAAkC,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAEhC,eAAe,KAAK,CAAC;AACrB,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAElD,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kCAAkC,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAEhC,eAAe,KAAK,CAAC;AACrB,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC"}
@@ -1,7 +1,7 @@
1
1
  export interface KnockOptions {
2
2
  host?: string;
3
3
  }
4
- export declare type GenericData = {
4
+ export type GenericData = {
5
5
  [x: string]: any;
6
6
  };
7
7
  export interface KnockObject<T = GenericData> {
@@ -25,7 +25,7 @@ export interface PageInfo {
25
25
  before: string | null;
26
26
  page_size: number;
27
27
  }
28
- export declare type Recipient = User | KnockObject;
28
+ export type Recipient = User | KnockObject;
29
29
  export interface Activity<T = GenericData> {
30
30
  id: string;
31
31
  inserted_at: string;
@@ -34,4 +34,8 @@ export interface Activity<T = GenericData> {
34
34
  actor: Recipient | null;
35
35
  data: T | null;
36
36
  }
37
+ export interface ChannelData<T = any> {
38
+ channel_id: string;
39
+ data: T;
40
+ }
37
41
  //# sourceMappingURL=interfaces.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,oBAAY,WAAW,GAAG;IAExB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CAClB,CAAC;AAEF,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,WAAW;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,CAAC,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,oBAAY,SAAS,GAAG,IAAI,GAAG,WAAW,CAAC;AAE3C,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,WAAW;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;CAChB"}
1
+ {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,WAAW,GAAG;IAExB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CAClB,CAAC;AAEF,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,WAAW;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,CAAC,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,SAAS,GAAG,IAAI,GAAG,WAAW,CAAC;AAE3C,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,WAAW;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;CAChB;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,CAAC,CAAC;CACT"}
@@ -1,6 +1,7 @@
1
1
  import ApiClient from "./api";
2
2
  import FeedClient from "./clients/feed";
3
3
  import Preferences from "./clients/preferences";
4
+ import UserClient from "./clients/users";
4
5
  import { KnockOptions } from "./interfaces";
5
6
  declare class Knock {
6
7
  readonly apiKey: string;
@@ -10,6 +11,7 @@ declare class Knock {
10
11
  userToken: string | undefined;
11
12
  readonly feeds: FeedClient;
12
13
  readonly preferences: Preferences;
14
+ readonly user: UserClient;
13
15
  constructor(apiKey: string, options?: KnockOptions);
14
16
  client(): ApiClient;
15
17
  authenticate(userId: string, userToken?: string): void;
@@ -1 +1 @@
1
- {"version":3,"file":"knock.d.ts","sourceRoot":"","sources":["../../src/knock.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,OAAO,CAAC;AAC9B,OAAO,UAAU,MAAM,gBAAgB,CAAC;AACxC,OAAO,WAAW,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAI5C,cAAM,KAAK;IASG,QAAQ,CAAC,MAAM,EAAE,MAAM;IARnC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,SAAS,CAA0B;IACpC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC,QAAQ,CAAC,KAAK,aAAwB;IACtC,QAAQ,CAAC,WAAW,cAAyB;gBAExB,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB;IAW/D,MAAM;IA2BN,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;IAW/C,eAAe,CAAC,cAAc,UAAQ;IAKtC,QAAQ;CAMT;AAED,eAAe,KAAK,CAAC"}
1
+ {"version":3,"file":"knock.d.ts","sourceRoot":"","sources":["../../src/knock.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,OAAO,CAAC;AAC9B,OAAO,UAAU,MAAM,gBAAgB,CAAC;AACxC,OAAO,WAAW,MAAM,uBAAuB,CAAC;AAChD,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAI5C,cAAM,KAAK;IAUG,QAAQ,CAAC,MAAM,EAAE,MAAM;IATnC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,SAAS,CAA0B;IACpC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC,QAAQ,CAAC,KAAK,aAAwB;IACtC,QAAQ,CAAC,WAAW,cAAyB;IAC7C,QAAQ,CAAC,IAAI,aAAwB;gBAEhB,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB;IAW/D,MAAM;IA2BN,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;IAW/C,eAAe,CAAC,cAAc,UAAQ;IAKtC,QAAQ;CAMT;AAED,eAAe,KAAK,CAAC"}