@knocklabs/client 0.5.10 → 0.7.0-rc.0

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.
package/dist/cjs/api.js CHANGED
@@ -24,16 +24,12 @@ var _axiosRetry = _interopRequireDefault(require("axios-retry"));
24
24
  var _phoenix = require("phoenix");
25
25
 
26
26
  var ApiClient = /*#__PURE__*/function () {
27
- /**
28
- * @deprecated Use `socket.connectionState` instead.
29
- */
30
27
  function ApiClient(options) {
31
28
  (0, _classCallCheck2["default"])(this, ApiClient);
32
29
  (0, _defineProperty2["default"])(this, "host", void 0);
33
30
  (0, _defineProperty2["default"])(this, "apiKey", void 0);
34
31
  (0, _defineProperty2["default"])(this, "userToken", void 0);
35
32
  (0, _defineProperty2["default"])(this, "axiosClient", void 0);
36
- (0, _defineProperty2["default"])(this, "socketConnected", false);
37
33
  (0, _defineProperty2["default"])(this, "socket", void 0);
38
34
  this.host = options.host;
39
35
  this.apiKey = options.apiKey;
@@ -49,6 +45,8 @@ var ApiClient = /*#__PURE__*/function () {
49
45
  }
50
46
  });
51
47
  this.socket = new _phoenix.Socket("".concat(this.host.replace("http", "ws"), "/ws/v1"), {
48
+ // If we're in a non-browser environment, then fallback to longpolling
49
+ transport: typeof window === "undefined" ? _phoenix.LongPoll : window.WebSocket,
52
50
  params: {
53
51
  user_token: this.userToken,
54
52
  api_key: this.apiKey
@@ -60,46 +58,8 @@ var ApiClient = /*#__PURE__*/function () {
60
58
  retryDelay: _axiosRetry["default"].exponentialDelay
61
59
  });
62
60
  }
63
- /**
64
- * @deprecated Use `socket.connect()` instead.
65
- */
66
-
67
61
 
68
62
  (0, _createClass2["default"])(ApiClient, [{
69
- key: "connectSocket",
70
- value: function connectSocket() {
71
- var _this = this;
72
-
73
- if (this.socketConnected) {
74
- return;
75
- }
76
-
77
- this.socket.connect();
78
- this.socket.onOpen(function () {
79
- _this.socketConnected = true;
80
- });
81
- }
82
- /**
83
- * @deprecated Use `socket.disconnect()` instead.
84
- */
85
-
86
- }, {
87
- key: "disconnectSocket",
88
- value: function disconnectSocket() {
89
- this.socket.disconnect();
90
- this.socketConnected = false;
91
- return;
92
- }
93
- /**
94
- * @deprecated Use `socket.channel(name: string, params?: object)` instead.
95
- */
96
-
97
- }, {
98
- key: "createChannel",
99
- value: function createChannel(name, params) {
100
- return this.socket.channel(name, params);
101
- }
102
- }, {
103
63
  key: "makeRequest",
104
64
  value: function () {
105
65
  var _makeRequest = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(req) {
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/api.ts"],"names":["ApiClient","options","host","apiKey","userToken","axiosClient","axios","create","baseURL","headers","Accept","Authorization","socket","Socket","replace","params","user_token","api_key","retries","retryCondition","canRetryRequest","retryDelay","axiosRetry","exponentialDelay","socketConnected","connect","onOpen","disconnect","name","channel","req","result","statusCode","status","body","data","error","undefined","console","isNetworkError","response"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;;AACA;;AACA;;IAkBMA,S;AAMJ;AACF;AACA;AAIE,qBAAYC,OAAZ,EAAuC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,8DAHd,KAGc;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,SAAKQ,MAAL,GAAc,IAAIC,eAAJ,WAAc,KAAKX,IAAL,CAAUY,OAAV,CAAkB,MAAlB,EAA0B,IAA1B,CAAd,aAAuD;AACnEC,MAAAA,MAAM,EAAE;AACNC,QAAAA,UAAU,EAAE,KAAKZ,SADX;AAENa,QAAAA,OAAO,EAAE,KAAKd;AAFR;AAD2D,KAAvD,CAAd;AAOA,gCAAW,KAAKE,WAAhB,EAA6B;AAC3Ba,MAAAA,OAAO,EAAE,CADkB;AAE3BC,MAAAA,cAAc,EAAE,KAAKC,eAFM;AAG3BC,MAAAA,UAAU,EAAEC,uBAAWC;AAHI,KAA7B;AAKD;AAED;AACF;AACA;;;;;WACE,yBAAgB;AAAA;;AACd,UAAI,KAAKC,eAAT,EAA0B;AACxB;AACD;;AAED,WAAKZ,MAAL,CAAYa,OAAZ;AACA,WAAKb,MAAL,CAAYc,MAAZ,CAAmB,YAAM;AACvB,QAAA,KAAI,CAACF,eAAL,GAAuB,IAAvB;AACD,OAFD;AAGD;AAED;AACF;AACA;;;;WACE,4BAAmB;AACjB,WAAKZ,MAAL,CAAYe,UAAZ;AACA,WAAKH,eAAL,GAAuB,KAAvB;AACA;AACD;AAED;AACF;AACA;;;;WACE,uBAAcI,IAAd,EAA4Bb,MAA5B,EAA6C;AAC3C,aAAO,KAAKH,MAAL,CAAYiB,OAAZ,CAAoBD,IAApB,EAA0Bb,MAA1B,CAAP;AACD;;;;uGAED,iBAAkBe,GAAlB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAEyB,KAAKzB,WAAL,CAAiByB,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,UAAId,uBAAWiB,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;;;;;eAGYjC,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 /**\n * @deprecated Use `socket.connectionState` instead.\n */\n public socketConnected = false;\n public socket: Socket;\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 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 axiosRetry(this.axiosClient, {\n retries: 3,\n retryCondition: this.canRetryRequest,\n retryDelay: axiosRetry.exponentialDelay,\n });\n }\n\n /**\n * @deprecated Use `socket.connect()` instead.\n */\n connectSocket() {\n if (this.socketConnected) {\n return;\n }\n\n this.socket.connect();\n this.socket.onOpen(() => {\n this.socketConnected = true;\n });\n }\n\n /**\n * @deprecated Use `socket.disconnect()` instead.\n */\n disconnectSocket() {\n this.socket.disconnect();\n this.socketConnected = false;\n return;\n }\n\n /**\n * @deprecated Use `socket.channel(name: string, params?: object)` instead.\n */\n createChannel(name: string, params?: object) {\n return this.socket.channel(name, params);\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,"sources":["../../src/api.ts"],"names":["ApiClient","options","host","apiKey","userToken","axiosClient","axios","create","baseURL","headers","Accept","Authorization","socket","Socket","replace","transport","window","LongPoll","WebSocket","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,SAAKQ,MAAL,GAAc,IAAIC,eAAJ,WAAc,KAAKX,IAAL,CAAUY,OAAV,CAAkB,MAAlB,EAA0B,IAA1B,CAAd,aAAuD;AACnE;AACAC,MAAAA,SAAS,EAAE,OAAOC,MAAP,KAAkB,WAAlB,GAAgCC,iBAAhC,GAA2CD,MAAM,CAACE,SAFM;AAGnEC,MAAAA,MAAM,EAAE;AACNC,QAAAA,UAAU,EAAE,KAAKhB,SADX;AAENiB,QAAAA,OAAO,EAAE,KAAKlB;AAFR;AAH2D,KAAvD,CAAd;AASA,gCAAW,KAAKE,WAAhB,EAA6B;AAC3BiB,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,KAAKvB,WAAL,CAAiBuB,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;;;;;eAGY/B,S","sourcesContent":["import axios, { AxiosInstance, AxiosRequestConfig } from \"axios\";\nimport axiosRetry from \"axios-retry\";\nimport { LongPoll, 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;\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 this.socket = new Socket(`${this.host.replace(\"http\", \"ws\")}/ws/v1`, {\n // If we're in a non-browser environment, then fallback to longpolling\n transport: typeof window === \"undefined\" ? LongPoll : window.WebSocket,\n params: {\n user_token: this.userToken,\n api_key: this.apiKey,\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"}
@@ -27,9 +27,16 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
27
27
 
28
28
  function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
29
29
 
30
+ // Default options to apply
31
+ var feedClientDefaults = {
32
+ archived: "exclude"
33
+ };
34
+
30
35
  var Feed = /*#__PURE__*/function () {
31
36
  // The raw store instance, used for binding in React and other environments
32
37
  function Feed(knock, feedId, options) {
38
+ var _this = this;
39
+
33
40
  (0, _classCallCheck2["default"])(this, Feed);
34
41
  this.knock = knock;
35
42
  this.feedId = feedId;
@@ -47,46 +54,43 @@ var Feed = /*#__PURE__*/function () {
47
54
  wildcard: true,
48
55
  delimiter: "."
49
56
  });
50
- this.defaultOptions = options; // Try and connect to the socket
51
-
52
- this.apiClient.socket.connect();
57
+ this.defaultOptions = _objectSpread(_objectSpread({}, feedClientDefaults), options);
53
58
  this.channel = this.apiClient.socket.channel("feeds:".concat(this.userFeedId), this.defaultOptions);
59
+ this.channel.on("new-message", function (resp) {
60
+ return _this.onNewMessageReceived(resp);
61
+ });
54
62
  }
55
- /*
56
- Returns a socket to listen for feed updates
57
- */
63
+ /**
64
+ * Cleans up a feed instance by destroying the store and disconnecting
65
+ * an open socket connection.
66
+ */
58
67
 
59
68
 
60
69
  (0, _createClass2["default"])(Feed, [{
70
+ key: "teardown",
71
+ value: function teardown() {
72
+ this.channel.leave();
73
+ this.broadcaster.removeAllListeners();
74
+ this.channel.off("new-message");
75
+ this.store.destroy();
76
+ }
77
+ /*
78
+ Initializes a real-time connection to Knock, connecting the websocket for the
79
+ current ApiClient instance if the socket is not already connected.
80
+ */
81
+
82
+ }, {
61
83
  key: "listenForUpdates",
62
84
  value: function listenForUpdates() {
63
- var _this = this;
85
+ // Connect the socket only if we don't already have a connection
86
+ if (!this.apiClient.socket.isConnected()) {
87
+ this.apiClient.socket.connect();
88
+ } // Only join the channel if we're not already in a joining state
89
+
64
90
 
65
- try {
91
+ if (["closed", "errored"].includes(this.channel.state)) {
66
92
  this.channel.join();
67
- } catch (e) {
68
- // Phoenix raises an error when trying to call join more than once. Given calling listenForUpdates unintentionally
69
- // may happen fairly often, we choose to supress the error and print a warning.
70
- if (e.message.includes("join")) {
71
- console.warn(e.message);
72
- } else {
73
- throw e;
74
- }
75
93
  }
76
-
77
- this.channel.on("new-message", function (resp) {
78
- return _this.onNewMessageReceived(resp);
79
- });
80
- return function () {
81
- try {
82
- _this.channel.leave();
83
-
84
- _this.channel.off("new-message");
85
- } catch (e) {
86
- // tslint:disable-next-line
87
- console.error("error while leaving channel", e);
88
- }
89
- };
90
94
  }
91
95
  /* Binds a handler to be invoked when event occurs */
92
96
 
@@ -220,7 +224,7 @@ var Feed = /*#__PURE__*/function () {
220
224
  /*
221
225
  Marking one or more items as archived should:
222
226
  - Decrement the badge count for any unread / unseen items
223
- - Remove the item from the feed list, when the include_archived flag is not true)
227
+ - Remove the item from the feed list when the `archived` flag is "exclude" (default)
224
228
  TODO: how do we handle rollbacks?
225
229
  */
226
230
 
@@ -228,7 +232,7 @@ var Feed = /*#__PURE__*/function () {
228
232
  key: "markAsArchived",
229
233
  value: function () {
230
234
  var _markAsArchived = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee5(itemOrItems) {
231
- var _this$store, getState, setState, state, shouldRemoveItems, normalizedItems, itemIds, unseenCount, unreadCount, meta, entries;
235
+ var _this$store, getState, setState, state, shouldOptimisticallyRemoveItems, normalizedItems, itemIds, unseenCount, unreadCount, updatedMetadata, entriesToSet;
232
236
 
233
237
  return _regenerator["default"].wrap(function _callee5$(_context5) {
234
238
  while (1) {
@@ -236,50 +240,67 @@ var Feed = /*#__PURE__*/function () {
236
240
  case 0:
237
241
  _this$store = this.store, getState = _this$store.getState, setState = _this$store.setState;
238
242
  state = getState();
239
- shouldRemoveItems = this.defaultOptions.include_archived !== true;
243
+ shouldOptimisticallyRemoveItems = this.defaultOptions.archived === "exclude";
240
244
  normalizedItems = Array.isArray(itemOrItems) ? itemOrItems : [itemOrItems];
241
245
  itemIds = normalizedItems.map(function (item) {
242
246
  return item.id;
243
- }); // If any of the items are unseen or unread, then capture as we'll want to decrement
244
- // the counts for these in the metadata we have
245
-
246
- unseenCount = normalizedItems.filter(function (i) {
247
- return !i.seen_at;
248
- }).length;
249
- unreadCount = normalizedItems.filter(function (i) {
250
- return !i.read_at;
251
- }).length; // Build the new metadata
252
-
253
- meta = _objectSpread(_objectSpread({}, state.metadata), {}, {
254
- total_count: state.metadata.total_count - normalizedItems.length,
255
- unseen_count: state.metadata.unseen_count - unseenCount,
256
- unread_count: state.metadata.unread_count - unreadCount
257
- }); // Perform optimistic updates on the items in the feed
258
-
259
- if (shouldRemoveItems) {
260
- // Filter the items out of the list
261
- entries = state.items.filter(function (item) {
247
+ });
248
+ /*
249
+ In the proceeding code here we want to optimistically update counts and items
250
+ that are persisted such that we can display updates immediately on the feed
251
+ without needing to make a network request.
252
+ Note: right now this does *not* take into account offline handling or any extensive retry
253
+ logic, so rollbacks aren't considered. That probably needs to be a future consideration for
254
+ this library.
255
+ Scenarios to consider:
256
+ ## Feed scope to archived *only*
257
+ - Counts should not be decremented
258
+ - Items should not be removed
259
+ ## Feed scoped to exclude archived items (the default)
260
+
261
+ - Counts should be decremented
262
+ - Items should be removed
263
+ ## Feed scoped to include archived items as well
264
+ - Counts should not be decremented
265
+ - Items should not be removed
266
+ */
267
+
268
+ if (shouldOptimisticallyRemoveItems) {
269
+ // If any of the items are unseen or unread, then capture as we'll want to decrement
270
+ // the counts for these in the metadata we have
271
+ unseenCount = normalizedItems.filter(function (i) {
272
+ return !i.seen_at;
273
+ }).length;
274
+ unreadCount = normalizedItems.filter(function (i) {
275
+ return !i.read_at;
276
+ }).length; // Build the new metadata
277
+
278
+ updatedMetadata = _objectSpread(_objectSpread({}, state.metadata), {}, {
279
+ total_count: state.metadata.total_count - normalizedItems.length,
280
+ unseen_count: state.metadata.unseen_count - unseenCount,
281
+ unread_count: state.metadata.unread_count - unreadCount
282
+ }); // Remove the archiving entries
283
+
284
+ entriesToSet = state.items.filter(function (item) {
262
285
  return !itemIds.includes(item.id);
263
286
  });
264
287
  setState(function (state) {
265
288
  return state.setResult({
266
- entries: entries,
267
- meta: meta,
289
+ entries: entriesToSet,
290
+ meta: updatedMetadata,
268
291
  page_info: state.pageInfo
269
292
  });
270
293
  });
271
294
  } else {
272
- setState(function (state) {
273
- state.setMetadata(meta);
274
- state.setItemAttrs(itemIds, {
275
- archived_at: new Date().toISOString()
276
- });
295
+ // Mark all the entries being updated as archived either way so the state is correct
296
+ state.setItemAttrs(itemIds, {
297
+ archived_at: new Date().toISOString()
277
298
  });
278
299
  }
279
300
 
280
301
  return _context5.abrupt("return", this.makeStatusUpdate(itemOrItems, "archived"));
281
302
 
282
- case 10:
303
+ case 7:
283
304
  case "end":
284
305
  return _context5.stop();
285
306
  }
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../../src/clients/feed/feed.ts"],"names":["Feed","knock","feedId","options","apiClient","client","userFeedId","buildUserFeedId","store","broadcaster","EventEmitter","wildcard","delimiter","defaultOptions","socket","connect","channel","join","e","message","includes","console","warn","on","resp","onNewMessageReceived","leave","off","error","eventName","callback","getState","itemOrItems","now","Date","toISOString","optimisticallyPerformStatusUpdate","seen_at","makeStatusUpdate","read_at","setState","state","shouldRemoveItems","include_archived","normalizedItems","Array","isArray","itemIds","map","item","id","unseenCount","filter","i","length","unreadCount","meta","metadata","total_count","unseen_count","unread_count","entries","items","setResult","page_info","pageInfo","setMetadata","setItemAttrs","archived_at","networkStatus","setNetworkStatus","__loadingType","NetworkStatus","loading","queryParams","makeRequest","method","url","userId","params","result","statusCode","body","status","data","response","before","opts","shouldSetPage","shouldAppend","after","broadcast","feedEventType","__fetchSource","eventPayload","event","fetch","fetchMore","emit","currentHead","__cursor","type","attrs","badgeCountAttr","direction","startsWith","Math","max","message_ids"],"mappings":";;;;;;;;;;;;;;;;;;;AAEA;;AAEA;;AAmBA;;;;;;IAUMA,I;AAOJ;AAGA,gBACWC,KADX,EAEWC,MAFX,EAGEC,OAHF,EAIE;AAAA;AAAA,SAHSF,KAGT,GAHSA,KAGT;AAAA,SAFSC,MAET,GAFSA,MAET;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,SAAKE,SAAL,GAAiBH,KAAK,CAACI,MAAN,EAAjB;AACA,SAAKH,MAAL,GAAcA,MAAd;AACA,SAAKI,UAAL,GAAkB,KAAKC,eAAL,EAAlB;AACA,SAAKC,KAAL,GAAa,wBAAb;AACA,SAAKC,WAAL,GAAmB,IAAIC,2BAAJ,CAAiB;AAAEC,MAAAA,QAAQ,EAAE,IAAZ;AAAkBC,MAAAA,SAAS,EAAE;AAA7B,KAAjB,CAAnB;AACA,SAAKC,cAAL,GAAsBV,OAAtB,CANA,CAQA;;AACA,SAAKC,SAAL,CAAeU,MAAf,CAAsBC,OAAtB;AAEA,SAAKC,OAAL,GAAe,KAAKZ,SAAL,CAAeU,MAAf,CAAsBE,OAAtB,iBACJ,KAAKV,UADD,GAEb,KAAKO,cAFQ,CAAf;AAID;AAED;AACF;AACA;;;;;WACE,4BAAmB;AAAA;;AACjB,UAAI;AACF,aAAKG,OAAL,CAAaC,IAAb;AACD,OAFD,CAEE,OAAOC,CAAP,EAAU;AACV;AACA;AACA,YAAIA,CAAC,CAACC,OAAF,CAAUC,QAAV,CAAmB,MAAnB,CAAJ,EAAgC;AAC9BC,UAAAA,OAAO,CAACC,IAAR,CAAaJ,CAAC,CAACC,OAAf;AACD,SAFD,MAEO;AACL,gBAAMD,CAAN;AACD;AACF;;AAED,WAAKF,OAAL,CAAaO,EAAb,CAAgB,aAAhB,EAA+B,UAACC,IAAD;AAAA,eAAU,KAAI,CAACC,oBAAL,CAA0BD,IAA1B,CAAV;AAAA,OAA/B;AAEA,aAAO,YAAM;AACX,YAAI;AACF,UAAA,KAAI,CAACR,OAAL,CAAaU,KAAb;;AACA,UAAA,KAAI,CAACV,OAAL,CAAaW,GAAb,CAAiB,aAAjB;AACD,SAHD,CAGE,OAAOT,CAAP,EAAU;AACV;AACAG,UAAAA,OAAO,CAACO,KAAR,CAAc,6BAAd,EAA6CV,CAA7C;AACD;AACF,OARD;AASD;AAED;;;;WACA,YACEW,SADF,EAEEC,QAFF,EAGE;AACA,WAAKrB,WAAL,CAAiBc,EAAjB,CAAoBM,SAApB,EAA+BC,QAA/B;AACD;;;WAED,aACED,SADF,EAEEC,QAFF,EAGE;AACA,WAAKrB,WAAL,CAAiBkB,GAAjB,CAAqBE,SAArB,EAAgCC,QAAhC;AACD;;;WAED,oBAAW;AACT,aAAO,KAAKtB,KAAL,CAAWuB,QAAX,EAAP;AACD;;;;sGAED,iBAAiBC,WAAjB;AAAA;AAAA;AAAA;AAAA;AAAA;AACQC,gBAAAA,GADR,GACc,IAAIC,IAAJ,GAAWC,WAAX,EADd;AAEE,qBAAKC,iCAAL,CACEJ,WADF,EAEE,MAFF,EAGE;AAAEK,kBAAAA,OAAO,EAAEJ;AAAX,iBAHF,EAIE,cAJF;AAFF,iDAQS,KAAKK,gBAAL,CAAsBN,WAAtB,EAAmC,MAAnC,CART;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;;wGAWA,kBAAmBA,WAAnB;AAAA;AAAA;AAAA;AAAA;AACE,qBAAKI,iCAAL,CACEJ,WADF,EAEE,QAFF,EAGE;AAAEK,kBAAAA,OAAO,EAAE;AAAX,iBAHF,EAIE,cAJF;AADF,kDAOS,KAAKC,gBAAL,CAAsBN,WAAtB,EAAmC,QAAnC,CAPT;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;;sGAUA,kBAAiBA,WAAjB;AAAA;AAAA;AAAA;AAAA;AAAA;AACQC,gBAAAA,GADR,GACc,IAAIC,IAAJ,GAAWC,WAAX,EADd;AAEE,qBAAKC,iCAAL,CACEJ,WADF,EAEE,MAFF,EAGE;AAAEO,kBAAAA,OAAO,EAAEN;AAAX,iBAHF,EAIE,cAJF;AAFF,kDAQS,KAAKK,gBAAL,CAAsBN,WAAtB,EAAmC,MAAnC,CART;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;;wGAWA,kBAAmBA,WAAnB;AAAA;AAAA;AAAA;AAAA;AACE,qBAAKI,iCAAL,CACEJ,WADF,EAEE,QAFF,EAGE;AAAEO,kBAAAA,OAAO,EAAE;AAAX,iBAHF,EAIE,cAJF;AADF,kDAOS,KAAKD,gBAAL,CAAsBN,WAAtB,EAAmC,QAAnC,CAPT;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;AAUA;AACF;AACA;AACA;AACA;AACA;;;;;0GAGE,kBAAqBA,WAArB;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA,8BACiC,KAAKxB,KADtC,EACUuB,QADV,eACUA,QADV,EACoBS,QADpB,eACoBA,QADpB;AAEQC,gBAAAA,KAFR,GAEgBV,QAAQ,EAFxB;AAGQW,gBAAAA,iBAHR,GAG4B,KAAK7B,cAAL,CAAoB8B,gBAApB,KAAyC,IAHrE;AAKQC,gBAAAA,eALR,GAK0BC,KAAK,CAACC,OAAN,CAAcd,WAAd,IACpBA,WADoB,GAEpB,CAACA,WAAD,CAPN;AASQe,gBAAAA,OATR,GAS4BH,eAAe,CAACI,GAAhB,CAAoB,UAACC,IAAD;AAAA,yBAAUA,IAAI,CAACC,EAAf;AAAA,iBAApB,CAT5B,EAWE;AACA;;AACMC,gBAAAA,WAbR,GAasBP,eAAe,CAACQ,MAAhB,CAAuB,UAACC,CAAD;AAAA,yBAAO,CAACA,CAAC,CAAChB,OAAV;AAAA,iBAAvB,EAA0CiB,MAbhE;AAcQC,gBAAAA,WAdR,GAcsBX,eAAe,CAACQ,MAAhB,CAAuB,UAACC,CAAD;AAAA,yBAAO,CAACA,CAAC,CAACd,OAAV;AAAA,iBAAvB,EAA0Ce,MAdhE,EAgBE;;AACME,gBAAAA,IAjBR,mCAkBOf,KAAK,CAACgB,QAlBb;AAmBIC,kBAAAA,WAAW,EAAEjB,KAAK,CAACgB,QAAN,CAAeC,WAAf,GAA6Bd,eAAe,CAACU,MAnB9D;AAoBIK,kBAAAA,YAAY,EAAElB,KAAK,CAACgB,QAAN,CAAeE,YAAf,GAA8BR,WApBhD;AAqBIS,kBAAAA,YAAY,EAAEnB,KAAK,CAACgB,QAAN,CAAeG,YAAf,GAA8BL;AArBhD,oBAwBE;;AACA,oBAAIb,iBAAJ,EAAuB;AACrB;AACMmB,kBAAAA,OAFe,GAELpB,KAAK,CAACqB,KAAN,CAAYV,MAAZ,CAAmB,UAACH,IAAD;AAAA,2BAAU,CAACF,OAAO,CAAC3B,QAAR,CAAiB6B,IAAI,CAACC,EAAtB,CAAX;AAAA,mBAAnB,CAFK;AAIrBV,kBAAAA,QAAQ,CAAC,UAACC,KAAD;AAAA,2BACPA,KAAK,CAACsB,SAAN,CAAgB;AAAEF,sBAAAA,OAAO,EAAPA,OAAF;AAAWL,sBAAAA,IAAI,EAAJA,IAAX;AAAiBQ,sBAAAA,SAAS,EAAEvB,KAAK,CAACwB;AAAlC,qBAAhB,CADO;AAAA,mBAAD,CAAR;AAGD,iBAPD,MAOO;AACLzB,kBAAAA,QAAQ,CAAC,UAACC,KAAD,EAAW;AAClBA,oBAAAA,KAAK,CAACyB,WAAN,CAAkBV,IAAlB;AACAf,oBAAAA,KAAK,CAAC0B,YAAN,CAAmBpB,OAAnB,EAA4B;AAAEqB,sBAAAA,WAAW,EAAE,IAAIlC,IAAJ,GAAWC,WAAX;AAAf,qBAA5B;AACD,mBAHO,CAAR;AAID;;AArCH,kDAuCS,KAAKG,gBAAL,CAAsBN,WAAtB,EAAmC,UAAnC,CAvCT;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;;4GA0CA,kBAAuBA,WAAvB;AAAA;AAAA;AAAA;AAAA;AACE,qBAAKI,iCAAL,CAAuCJ,WAAvC,EAAoD,YAApD,EAAkE;AAChEoC,kBAAAA,WAAW,EAAE;AADmD,iBAAlE;AADF,kDAIS,KAAK9B,gBAAL,CAAsBN,WAAtB,EAAmC,YAAnC,CAJT;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;AAOA;;;;;iGACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAY7B,gBAAAA,OAAZ,8DAAwC,EAAxC;AAAA,+BACiC,KAAKK,KADtC,EACUgC,QADV,gBACUA,QADV,EACoBT,QADpB,gBACoBA,QADpB;AAAA,4BAE4BA,QAAQ,EAFpC,EAEUsC,aAFV,aAEUA,aAFV,EAIE;;AAJF,qBAKM,sCAAkBA,aAAlB,CALN;AAAA;AAAA;AAAA;;AAAA;;AAAA;AASE;AACA7B,gBAAAA,QAAQ,CAAC,UAAChC,KAAD;AAAA;;AAAA,yBACPA,KAAK,CAAC8D,gBAAN,0BAAuBnE,OAAO,CAACoE,aAA/B,yEAAgDC,6BAAcC,OAA9D,CADO;AAAA,iBAAD,CAAR,CAVF,CAcE;;AACMC,gBAAAA,WAfR,mCAe2B,KAAK7D,cAfhC,GAemDV,OAfnD;AAAA;AAAA,uBAiBuB,KAAKC,SAAL,CAAeuE,WAAf,CAA2B;AAC9CC,kBAAAA,MAAM,EAAE,KADsC;AAE9CC,kBAAAA,GAAG,sBAAe,KAAK5E,KAAL,CAAW6E,MAA1B,oBAA0C,KAAK5E,MAA/C,CAF2C;AAG9C6E,kBAAAA,MAAM,EAAEL;AAHsC,iBAA3B,CAjBvB;;AAAA;AAiBQM,gBAAAA,MAjBR;;AAAA,sBAuBMA,MAAM,CAACC,UAAP,KAAsB,OAAtB,IAAiC,CAACD,MAAM,CAACE,IAvB/C;AAAA;AAAA;AAAA;;AAwBI1C,gBAAAA,QAAQ,CAAC,UAAChC,KAAD;AAAA,yBAAWA,KAAK,CAAC8D,gBAAN,CAAuBE,6BAAc5C,KAArC,CAAX;AAAA,iBAAD,CAAR;AAxBJ,kDA0BW;AACLuD,kBAAAA,MAAM,EAAEH,MAAM,CAACC,UADV;AAELG,kBAAAA,IAAI,EAAEJ,MAAM,CAACpD,KAAP,IAAgBoD,MAAM,CAACE;AAFxB,iBA1BX;;AAAA;AAgCQG,gBAAAA,QAhCR,GAgCmB;AACfxB,kBAAAA,OAAO,EAAEmB,MAAM,CAACE,IAAP,CAAYrB,OADN;AAEfL,kBAAAA,IAAI,EAAEwB,MAAM,CAACE,IAAP,CAAY1B,IAFH;AAGfQ,kBAAAA,SAAS,EAAEgB,MAAM,CAACE,IAAP,CAAYlB;AAHR,iBAhCnB;;AAsCE,oBAAI7D,OAAO,CAACmF,MAAZ,EAAoB;AACZC,kBAAAA,IADY,GACL;AAAEC,oBAAAA,aAAa,EAAE,KAAjB;AAAwBC,oBAAAA,YAAY,EAAE;AAAtC,mBADK;AAElBjD,kBAAAA,QAAQ,CAAC,UAACC,KAAD;AAAA,2BAAWA,KAAK,CAACsB,SAAN,CAAgBsB,QAAhB,EAA0BE,IAA1B,CAAX;AAAA,mBAAD,CAAR;AACD,iBAHD,MAGO,IAAIpF,OAAO,CAACuF,KAAZ,EAAmB;AAClBH,kBAAAA,KADkB,GACX;AAAEC,oBAAAA,aAAa,EAAE,IAAjB;AAAuBC,oBAAAA,YAAY,EAAE;AAArC,mBADW;AAExBjD,kBAAAA,QAAQ,CAAC,UAACC,KAAD;AAAA,2BAAWA,KAAK,CAACsB,SAAN,CAAgBsB,QAAhB,EAA0BE,KAA1B,CAAX;AAAA,mBAAD,CAAR;AACD,iBAHM,MAGA;AACL/C,kBAAAA,QAAQ,CAAC,UAACC,KAAD;AAAA,2BAAWA,KAAK,CAACsB,SAAN,CAAgBsB,QAAhB,CAAX;AAAA,mBAAD,CAAR;AACD,iBA9CH,CAgDE;;;AACA,qBAAKM,SAAL,CAAe,cAAf,EAA+BN,QAA/B,EAjDF,CAmDE;;AACMO,gBAAAA,aApDR,GAqDIzF,OAAO,CAAC0F,aAAR,KAA0B,QAA1B,GACI,yBADJ,GAEI,qBAvDR;AAyDQC,gBAAAA,YAzDR,GAyDuB;AACnBhC,kBAAAA,KAAK,EAAEuB,QAAQ,CAACxB,OADG;AAEnBJ,kBAAAA,QAAQ,EAAE4B,QAAQ,CAAC7B,IAFA;AAGnBuC,kBAAAA,KAAK,EAAEH;AAHY,iBAzDvB;AA+DE,qBAAKD,SAAL,CAAeG,YAAY,CAACC,KAA5B,EAAmCD,YAAnC;AA/DF,kDAiES;AAAEV,kBAAAA,IAAI,EAAEC,QAAR;AAAkBF,kBAAAA,MAAM,EAAEH,MAAM,CAACC;AAAjC,iBAjET;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;;yGAoEA;AAAA;;AAAA;AAAA;AAAA;AAAA;AACE;AACQlD,gBAAAA,QAFV,GAEuB,KAAKvB,KAF5B,CAEUuB,QAFV;AAAA,6BAGuBA,QAAQ,EAH/B,EAGUkC,QAHV,cAGUA,QAHV;;AAAA,oBAKOA,QAAQ,CAACyB,KALhB;AAAA;AAAA;AAAA;;AAAA;;AAAA;AAUE,qBAAKM,KAAL,CAAW;AACTN,kBAAAA,KAAK,EAAEzB,QAAQ,CAACyB,KADP;AAETnB,kBAAAA,aAAa,EAAEC,6BAAcyB;AAFpB,iBAAX;;AAVF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;WAgBA,mBACEpE,SADF,EAEEuD,IAFF,EAGE;AACA,WAAK3E,WAAL,CAAiByF,IAAjB,CAAsBrE,SAAtB,EAAiCuD,IAAjC;AACD,K,CAED;;;;;gHACA;AAAA;;AAAA;AAAA;AAAA;AAAA;AACE3B,gBAAAA,QADF,QACEA,QADF;AAGE;AAHF,+BAIiC,KAAKjD,KAJtC,EAIUuB,QAJV,gBAIUA,QAJV,EAIoBS,QAJpB,gBAIoBA,QAJpB;AAAA,6BAKoBT,QAAQ,EAL5B,EAKU+B,KALV,cAKUA,KALV;AAMQqC,gBAAAA,WANR,GAM4CrC,KAAK,CAAC,CAAD,CANjD,EAOE;;AACAtB,gBAAAA,QAAQ,CAAC,UAACC,KAAD;AAAA,yBAAWA,KAAK,CAACyB,WAAN,CAAkBT,QAAlB,CAAX;AAAA,iBAAD,CAAR,CARF,CASE;;AACA,qBAAKuC,KAAL,CAAW;AAAEV,kBAAAA,MAAM,EAAEa,WAAF,aAAEA,WAAF,uBAAEA,WAAW,CAAEC,QAAvB;AAAiCP,kBAAAA,aAAa,EAAE;AAAhD,iBAAX;;AAVF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;WAaA,2BAA0B;AACxB,uBAAU,KAAK3F,MAAf,cAAyB,KAAKD,KAAL,CAAW6E,MAApC;AACD;;;WAED,2CACE9C,WADF,EAEEqE,IAFF,EAGEC,KAHF,EAIEC,cAJF,EAKE;AACA,yBAA+B,KAAK/F,KAApC;AAAA,UAAQuB,QAAR,gBAAQA,QAAR;AAAA,UAAkBS,QAAlB,gBAAkBA,QAAlB;AACA,UAAMO,OAAO,GAAGF,KAAK,CAACC,OAAN,CAAcd,WAAd,IACZA,WAAW,CAACgB,GAAZ,CAAgB,UAACC,IAAD;AAAA,eAAUA,IAAI,CAACC,EAAf;AAAA,OAAhB,CADY,GAEZ,CAAClB,WAAW,CAACkB,EAAb,CAFJ;;AAIA,UAAIqD,cAAJ,EAAoB;AAClB,yBAAqBxE,QAAQ,EAA7B;AAAA,YAAQ0B,QAAR,cAAQA,QAAR,CADkB,CAGlB;AACA;;;AACA,YAAM+C,SAAS,GAAGH,IAAI,CAACI,UAAL,CAAgB,IAAhB,IACd1D,OAAO,CAACO,MADM,GAEd,CAACP,OAAO,CAACO,MAFb;AAIAd,QAAAA,QAAQ,CAAC,UAAChC,KAAD;AAAA,iBACPA,KAAK,CAAC0D,WAAN,iCACKT,QADL,4CAEG8C,cAFH,EAEoBG,IAAI,CAACC,GAAL,CAAS,CAAT,EAAYlD,QAAQ,CAAC8C,cAAD,CAAR,GAA2BC,SAAvC,CAFpB,GADO;AAAA,SAAD,CAAR;AAMD,OArBD,CAuBA;;;AACAhE,MAAAA,QAAQ,CAAC,UAAChC,KAAD;AAAA,eAAWA,KAAK,CAAC2D,YAAN,CAAmBpB,OAAnB,EAA4BuD,KAA5B,CAAX;AAAA,OAAD,CAAR;AACD;;;;4GAED,mBAA+BtE,WAA/B,EAA6DqE,IAA7D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qBAEMxD,KAAK,CAACC,OAAN,CAAcd,WAAd,CAFN;AAAA;AAAA;AAAA;;AAGUe,gBAAAA,OAHV,GAGoBf,WAAW,CAACgB,GAAZ,CAAgB,UAACC,IAAD;AAAA,yBAAUA,IAAI,CAACC,EAAf;AAAA,iBAAhB,CAHpB;AAAA;AAAA,uBAKiB,KAAK9C,SAAL,CAAeuE,WAAf,CAA2B;AACtCC,kBAAAA,MAAM,EAAE,MAD8B;AAEtCC,kBAAAA,GAAG,+BAAwBwB,IAAxB,CAFmC;AAGtCjB,kBAAAA,IAAI,EAAE;AAAEwB,oBAAAA,WAAW,EAAE7D;AAAf;AAHgC,iBAA3B,CALjB;;AAAA;AAAA;;AAAA;AAAA;AAAA,uBAauB,KAAK3C,SAAL,CAAeuE,WAAf,CAA2B;AAC9CC,kBAAAA,MAAM,EAAEyB,IAAI,CAACI,UAAL,CAAgB,IAAhB,IAAwB,QAAxB,GAAmC,KADG;AAE9C5B,kBAAAA,GAAG,yBAAkB7C,WAAW,CAACkB,EAA9B,cAAoCmD,IAApC;AAF2C,iBAA3B,CAbvB;;AAAA;AAaQrB,gBAAAA,MAbR;AAAA,mDAkBSA,MAlBT;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;;;eAsBahF,I","sourcesContent":["import { Channel } from \"phoenix\";\nimport { StoreApi } from \"zustand\";\nimport { EventEmitter2 as EventEmitter } from \"eventemitter2\";\nimport ApiClient from \"../../api\";\nimport createStore from \"./store\";\nimport {\n BindableFeedEvent,\n FeedMessagesReceivedPayload,\n FeedEventCallback,\n FeedEvent,\n FeedItemOrItems,\n FeedStoreState,\n FeedEventPayload,\n FeedRealTimeCallback,\n} from \"./types\";\nimport {\n FeedItem,\n FeedClientOptions,\n FetchFeedOptions,\n FeedResponse,\n FeedMetadata,\n} from \"./interfaces\";\nimport Knock from \"../../knock\";\nimport { isRequestInFlight, NetworkStatus } from \"../../networkStatus\";\n\nexport type Status =\n | \"seen\"\n | \"read\"\n | \"archived\"\n | \"unseen\"\n | \"unread\"\n | \"unarchived\";\n\nclass Feed {\n private apiClient: ApiClient;\n private userFeedId: string;\n private channel: Channel;\n private broadcaster: EventEmitter;\n private defaultOptions: FeedClientOptions;\n\n // The raw store instance, used for binding in React and other environments\n public store: StoreApi<FeedStoreState>;\n\n constructor(\n readonly knock: Knock,\n readonly feedId: string,\n options: FeedClientOptions,\n ) {\n this.apiClient = knock.client();\n this.feedId = feedId;\n this.userFeedId = this.buildUserFeedId();\n this.store = createStore();\n this.broadcaster = new EventEmitter({ wildcard: true, delimiter: \".\" });\n this.defaultOptions = options;\n\n // Try and connect to the socket\n this.apiClient.socket.connect();\n\n this.channel = this.apiClient.socket.channel(\n `feeds:${this.userFeedId}`,\n this.defaultOptions,\n );\n }\n\n /*\n Returns a socket to listen for feed updates\n */\n listenForUpdates() {\n try {\n this.channel.join();\n } catch (e) {\n // Phoenix raises an error when trying to call join more than once. Given calling listenForUpdates unintentionally\n // may happen fairly often, we choose to supress the error and print a warning.\n if (e.message.includes(\"join\")) {\n console.warn(e.message);\n } else {\n throw e;\n }\n }\n\n this.channel.on(\"new-message\", (resp) => this.onNewMessageReceived(resp));\n\n return () => {\n try {\n this.channel.leave();\n this.channel.off(\"new-message\")\n } catch (e) {\n // tslint:disable-next-line\n console.error(\"error while leaving channel\", e);\n }\n };\n }\n\n /* Binds a handler to be invoked when event occurs */\n on(\n eventName: BindableFeedEvent,\n callback: FeedEventCallback | FeedRealTimeCallback,\n ) {\n this.broadcaster.on(eventName, callback);\n }\n\n off(\n eventName: BindableFeedEvent,\n callback: FeedEventCallback | FeedRealTimeCallback,\n ) {\n this.broadcaster.off(eventName, callback);\n }\n\n getState() {\n return this.store.getState();\n }\n\n async markAsSeen(itemOrItems: FeedItemOrItems) {\n const now = new Date().toISOString();\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"seen\",\n { seen_at: now },\n \"unseen_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"seen\");\n }\n\n async markAsUnseen(itemOrItems: FeedItemOrItems) {\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"unseen\",\n { seen_at: null },\n \"unseen_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"unseen\");\n }\n\n async markAsRead(itemOrItems: FeedItemOrItems) {\n const now = new Date().toISOString();\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"read\",\n { read_at: now },\n \"unread_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"read\");\n }\n\n async markAsUnread(itemOrItems: FeedItemOrItems) {\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"unread\",\n { read_at: null },\n \"unread_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"unread\");\n }\n\n /*\n Marking one or more items as archived should:\n\n - Decrement the badge count for any unread / unseen items\n - Remove the item from the feed list, when the include_archived flag is not true)\n\n TODO: how do we handle rollbacks?\n */\n async markAsArchived(itemOrItems: FeedItemOrItems) {\n const { getState, setState } = this.store;\n const state = getState();\n const shouldRemoveItems = this.defaultOptions.include_archived !== true;\n\n const normalizedItems = Array.isArray(itemOrItems)\n ? itemOrItems\n : [itemOrItems];\n\n const itemIds: string[] = normalizedItems.map((item) => item.id);\n\n // If any of the items are unseen or unread, then capture as we'll want to decrement\n // the counts for these in the metadata we have\n const unseenCount = normalizedItems.filter((i) => !i.seen_at).length;\n const unreadCount = normalizedItems.filter((i) => !i.read_at).length;\n\n // Build the new metadata\n const meta = {\n ...state.metadata,\n total_count: state.metadata.total_count - normalizedItems.length,\n unseen_count: state.metadata.unseen_count - unseenCount,\n unread_count: state.metadata.unread_count - unreadCount,\n };\n\n // Perform optimistic updates on the items in the feed\n if (shouldRemoveItems) {\n // Filter the items out of the list\n const entries = state.items.filter((item) => !itemIds.includes(item.id));\n\n setState((state) =>\n state.setResult({ entries, meta, page_info: state.pageInfo }),\n );\n } else {\n setState((state) => {\n state.setMetadata(meta);\n state.setItemAttrs(itemIds, { archived_at: new Date().toISOString() });\n });\n }\n\n return this.makeStatusUpdate(itemOrItems, \"archived\");\n }\n\n async markAsUnarchived(itemOrItems: FeedItemOrItems) {\n this.optimisticallyPerformStatusUpdate(itemOrItems, \"unarchived\", {\n archived_at: null,\n });\n return this.makeStatusUpdate(itemOrItems, \"unarchived\");\n }\n\n /* Fetches the feed content, appending it to the store */\n async fetch(options: FetchFeedOptions = {}) {\n const { setState, getState } = this.store;\n const { networkStatus } = getState();\n\n // If there's an existing request in flight, then do nothing\n if (isRequestInFlight(networkStatus)) {\n return;\n }\n\n // Set the loading type based on the request type it is\n setState((store) =>\n store.setNetworkStatus(options.__loadingType ?? NetworkStatus.loading),\n );\n\n // Always include the default params, if they have been set\n const queryParams = { ...this.defaultOptions, ...options };\n\n const result = await this.apiClient.makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.knock.userId}/feeds/${this.feedId}`,\n params: queryParams,\n });\n\n if (result.statusCode === \"error\" || !result.body) {\n setState((store) => store.setNetworkStatus(NetworkStatus.error));\n\n return {\n status: result.statusCode,\n data: result.error || result.body,\n };\n }\n\n const response = {\n entries: result.body.entries,\n meta: result.body.meta,\n page_info: result.body.page_info,\n };\n\n if (options.before) {\n const opts = { shouldSetPage: false, shouldAppend: true };\n setState((state) => state.setResult(response, opts));\n } else if (options.after) {\n const opts = { shouldSetPage: true, shouldAppend: true };\n setState((state) => state.setResult(response, opts));\n } else {\n setState((state) => state.setResult(response));\n }\n\n // Legacy `messages.new` event, should be removed in a future version\n this.broadcast(\"messages.new\", response);\n\n // Broadcast the appropriate event type depending on the fetch source\n const feedEventType: FeedEvent =\n options.__fetchSource === \"socket\"\n ? \"items.received.realtime\"\n : \"items.received.page\";\n\n const eventPayload = {\n items: response.entries as FeedItem[],\n metadata: response.meta as FeedMetadata,\n event: feedEventType,\n };\n\n this.broadcast(eventPayload.event, eventPayload);\n\n return { data: response, status: result.statusCode };\n }\n\n async fetchNextPage() {\n // Attempts to fetch the next page of results (if we have any)\n const { getState } = this.store;\n const { pageInfo } = getState();\n\n if (!pageInfo.after) {\n // Nothing more to fetch\n return;\n }\n\n this.fetch({\n after: pageInfo.after,\n __loadingType: NetworkStatus.fetchMore,\n });\n }\n\n private broadcast(\n eventName: FeedEvent,\n data: FeedResponse | FeedEventPayload,\n ) {\n this.broadcaster.emit(eventName, data);\n }\n\n // Invoked when a new real-time message comes in from the socket\n private async onNewMessageReceived({\n metadata,\n }: FeedMessagesReceivedPayload) {\n // Handle the new message coming in\n const { getState, setState } = this.store;\n const { items } = getState();\n const currentHead: FeedItem | undefined = items[0];\n // Optimistically set the badge counts\n setState((state) => state.setMetadata(metadata));\n // Fetch the items before the current head (if it exists)\n this.fetch({ before: currentHead?.__cursor, __fetchSource: \"socket\" });\n }\n\n private buildUserFeedId() {\n return `${this.feedId}:${this.knock.userId}`;\n }\n\n private optimisticallyPerformStatusUpdate(\n itemOrItems: FeedItemOrItems,\n type: Status,\n attrs: object,\n badgeCountAttr?: \"unread_count\" | \"unseen_count\",\n ) {\n const { getState, setState } = this.store;\n const itemIds = Array.isArray(itemOrItems)\n ? itemOrItems.map((item) => item.id)\n : [itemOrItems.id];\n\n if (badgeCountAttr) {\n const { metadata } = getState();\n\n // Tnis is a hack to determine the direction of whether we're\n // adding or removing from the badge count\n const direction = type.startsWith(\"un\")\n ? itemIds.length\n : -itemIds.length;\n\n setState((store) =>\n store.setMetadata({\n ...metadata,\n [badgeCountAttr]: Math.max(0, metadata[badgeCountAttr] + direction),\n }),\n );\n }\n\n // Update the items with the given attributes\n setState((store) => store.setItemAttrs(itemIds, attrs));\n }\n\n private async makeStatusUpdate(itemOrItems: FeedItemOrItems, type: Status) {\n // If we're interacting with an array, then we want to send this as a batch\n if (Array.isArray(itemOrItems)) {\n const itemIds = itemOrItems.map((item) => item.id);\n\n return await this.apiClient.makeRequest({\n method: \"POST\",\n url: `/v1/messages/batch/${type}`,\n data: { message_ids: itemIds },\n });\n }\n\n // If its a single then we can just call the regular endpoint\n const result = await this.apiClient.makeRequest({\n method: type.startsWith(\"un\") ? \"DELETE\" : \"PUT\",\n url: `/v1/messages/${itemOrItems.id}/${type}`,\n });\n\n return result;\n }\n}\n\nexport default Feed;\n"],"file":"feed.js"}
1
+ {"version":3,"sources":["../../../../src/clients/feed/feed.ts"],"names":["feedClientDefaults","archived","Feed","knock","feedId","options","apiClient","client","userFeedId","buildUserFeedId","store","broadcaster","EventEmitter","wildcard","delimiter","defaultOptions","channel","socket","on","resp","onNewMessageReceived","leave","removeAllListeners","off","destroy","isConnected","connect","includes","state","join","eventName","callback","getState","itemOrItems","now","Date","toISOString","optimisticallyPerformStatusUpdate","seen_at","makeStatusUpdate","read_at","setState","shouldOptimisticallyRemoveItems","normalizedItems","Array","isArray","itemIds","map","item","id","unseenCount","filter","i","length","unreadCount","updatedMetadata","metadata","total_count","unseen_count","unread_count","entriesToSet","items","setResult","entries","meta","page_info","pageInfo","setItemAttrs","archived_at","networkStatus","setNetworkStatus","__loadingType","NetworkStatus","loading","queryParams","makeRequest","method","url","userId","params","result","statusCode","body","error","status","data","response","before","opts","shouldSetPage","shouldAppend","after","broadcast","feedEventType","__fetchSource","eventPayload","event","fetch","fetchMore","emit","currentHead","setMetadata","__cursor","type","attrs","badgeCountAttr","direction","startsWith","Math","max","message_ids"],"mappings":";;;;;;;;;;;;;;;;;;;AAEA;;AAEA;;AAmBA;;;;;;AAUA;AACA,IAAMA,kBAAuD,GAAG;AAC9DC,EAAAA,QAAQ,EAAE;AADoD,CAAhE;;IAIMC,I;AAOJ;AAGA,gBACWC,KADX,EAEWC,MAFX,EAGEC,OAHF,EAIE;AAAA;;AAAA;AAAA,SAHSF,KAGT,GAHSA,KAGT;AAAA,SAFSC,MAET,GAFSA,MAET;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,SAAKE,SAAL,GAAiBH,KAAK,CAACI,MAAN,EAAjB;AACA,SAAKH,MAAL,GAAcA,MAAd;AACA,SAAKI,UAAL,GAAkB,KAAKC,eAAL,EAAlB;AACA,SAAKC,KAAL,GAAa,wBAAb;AACA,SAAKC,WAAL,GAAmB,IAAIC,2BAAJ,CAAiB;AAAEC,MAAAA,QAAQ,EAAE,IAAZ;AAAkBC,MAAAA,SAAS,EAAE;AAA7B,KAAjB,CAAnB;AACA,SAAKC,cAAL,mCAA2Bf,kBAA3B,GAAkDK,OAAlD;AAEA,SAAKW,OAAL,GAAe,KAAKV,SAAL,CAAeW,MAAf,CAAsBD,OAAtB,iBACJ,KAAKR,UADD,GAEb,KAAKO,cAFQ,CAAf;AAKA,SAAKC,OAAL,CAAaE,EAAb,CAAgB,aAAhB,EAA+B,UAACC,IAAD;AAAA,aAAU,KAAI,CAACC,oBAAL,CAA0BD,IAA1B,CAAV;AAAA,KAA/B;AACD;AAED;AACF;AACA;AACA;;;;;WACE,oBAAW;AACT,WAAKH,OAAL,CAAaK,KAAb;AACA,WAAKV,WAAL,CAAiBW,kBAAjB;AACA,WAAKN,OAAL,CAAaO,GAAb,CAAiB,aAAjB;AACA,WAAKb,KAAL,CAAWc,OAAX;AACD;AAED;AACF;AACA;AACA;;;;WACE,4BAAmB;AACjB;AACA,UAAI,CAAC,KAAKlB,SAAL,CAAeW,MAAf,CAAsBQ,WAAtB,EAAL,EAA0C;AACxC,aAAKnB,SAAL,CAAeW,MAAf,CAAsBS,OAAtB;AACD,OAJgB,CAMjB;;;AACA,UAAI,CAAC,QAAD,EAAW,SAAX,EAAsBC,QAAtB,CAA+B,KAAKX,OAAL,CAAaY,KAA5C,CAAJ,EAAwD;AACtD,aAAKZ,OAAL,CAAaa,IAAb;AACD;AACF;AAED;;;;WACA,YACEC,SADF,EAEEC,QAFF,EAGE;AACA,WAAKpB,WAAL,CAAiBO,EAAjB,CAAoBY,SAApB,EAA+BC,QAA/B;AACD;;;WAED,aACED,SADF,EAEEC,QAFF,EAGE;AACA,WAAKpB,WAAL,CAAiBY,GAAjB,CAAqBO,SAArB,EAAgCC,QAAhC;AACD;;;WAED,oBAAW;AACT,aAAO,KAAKrB,KAAL,CAAWsB,QAAX,EAAP;AACD;;;;sGAED,iBAAiBC,WAAjB;AAAA;AAAA;AAAA;AAAA;AAAA;AACQC,gBAAAA,GADR,GACc,IAAIC,IAAJ,GAAWC,WAAX,EADd;AAEE,qBAAKC,iCAAL,CACEJ,WADF,EAEE,MAFF,EAGE;AAAEK,kBAAAA,OAAO,EAAEJ;AAAX,iBAHF,EAIE,cAJF;AAFF,iDAQS,KAAKK,gBAAL,CAAsBN,WAAtB,EAAmC,MAAnC,CART;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;;wGAWA,kBAAmBA,WAAnB;AAAA;AAAA;AAAA;AAAA;AACE,qBAAKI,iCAAL,CACEJ,WADF,EAEE,QAFF,EAGE;AAAEK,kBAAAA,OAAO,EAAE;AAAX,iBAHF,EAIE,cAJF;AADF,kDAOS,KAAKC,gBAAL,CAAsBN,WAAtB,EAAmC,QAAnC,CAPT;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;;sGAUA,kBAAiBA,WAAjB;AAAA;AAAA;AAAA;AAAA;AAAA;AACQC,gBAAAA,GADR,GACc,IAAIC,IAAJ,GAAWC,WAAX,EADd;AAEE,qBAAKC,iCAAL,CACEJ,WADF,EAEE,MAFF,EAGE;AAAEO,kBAAAA,OAAO,EAAEN;AAAX,iBAHF,EAIE,cAJF;AAFF,kDAQS,KAAKK,gBAAL,CAAsBN,WAAtB,EAAmC,MAAnC,CART;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;;wGAWA,kBAAmBA,WAAnB;AAAA;AAAA;AAAA;AAAA;AACE,qBAAKI,iCAAL,CACEJ,WADF,EAEE,QAFF,EAGE;AAAEO,kBAAAA,OAAO,EAAE;AAAX,iBAHF,EAIE,cAJF;AADF,kDAOS,KAAKD,gBAAL,CAAsBN,WAAtB,EAAmC,QAAnC,CAPT;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;AAUA;AACF;AACA;AACA;AACA;AACA;;;;;0GAGE,kBAAqBA,WAArB;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA,8BACiC,KAAKvB,KADtC,EACUsB,QADV,eACUA,QADV,EACoBS,QADpB,eACoBA,QADpB;AAEQb,gBAAAA,KAFR,GAEgBI,QAAQ,EAFxB;AAIQU,gBAAAA,+BAJR,GAKI,KAAK3B,cAAL,CAAoBd,QAApB,KAAiC,SALrC;AAOQ0C,gBAAAA,eAPR,GAO0BC,KAAK,CAACC,OAAN,CAAcZ,WAAd,IACpBA,WADoB,GAEpB,CAACA,WAAD,CATN;AAWQa,gBAAAA,OAXR,GAW4BH,eAAe,CAACI,GAAhB,CAAoB,UAACC,IAAD;AAAA,yBAAUA,IAAI,CAACC,EAAf;AAAA,iBAApB,CAX5B;AAaE;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASI,oBAAIP,+BAAJ,EAAqC;AACnC;AACA;AACMQ,kBAAAA,WAH6B,GAGfP,eAAe,CAACQ,MAAhB,CAAuB,UAACC,CAAD;AAAA,2BAAO,CAACA,CAAC,CAACd,OAAV;AAAA,mBAAvB,EAA0Ce,MAH3B;AAI7BC,kBAAAA,WAJ6B,GAIfX,eAAe,CAACQ,MAAhB,CAAuB,UAACC,CAAD;AAAA,2BAAO,CAACA,CAAC,CAACZ,OAAV;AAAA,mBAAvB,EAA0Ca,MAJ3B,EAMnC;;AACME,kBAAAA,eAP6B,mCAQ9B3B,KAAK,CAAC4B,QARwB;AASjCC,oBAAAA,WAAW,EAAE7B,KAAK,CAAC4B,QAAN,CAAeC,WAAf,GAA6Bd,eAAe,CAACU,MATzB;AAUjCK,oBAAAA,YAAY,EAAE9B,KAAK,CAAC4B,QAAN,CAAeE,YAAf,GAA8BR,WAVX;AAWjCS,oBAAAA,YAAY,EAAE/B,KAAK,CAAC4B,QAAN,CAAeG,YAAf,GAA8BL;AAXX,sBAcnC;;AACMM,kBAAAA,YAf6B,GAedhC,KAAK,CAACiC,KAAN,CAAYV,MAAZ,CACnB,UAACH,IAAD;AAAA,2BAAU,CAACF,OAAO,CAACnB,QAAR,CAAiBqB,IAAI,CAACC,EAAtB,CAAX;AAAA,mBADmB,CAfc;AAmBnCR,kBAAAA,QAAQ,CAAC,UAACb,KAAD;AAAA,2BACPA,KAAK,CAACkC,SAAN,CAAgB;AACdC,sBAAAA,OAAO,EAAEH,YADK;AAEdI,sBAAAA,IAAI,EAAET,eAFQ;AAGdU,sBAAAA,SAAS,EAAErC,KAAK,CAACsC;AAHH,qBAAhB,CADO;AAAA,mBAAD,CAAR;AAOD,iBA1BD,MA0BO;AACL;AACAtC,kBAAAA,KAAK,CAACuC,YAAN,CAAmBrB,OAAnB,EAA4B;AAAEsB,oBAAAA,WAAW,EAAE,IAAIjC,IAAJ,GAAWC,WAAX;AAAf,mBAA5B;AACD;;AArEH,kDAuES,KAAKG,gBAAL,CAAsBN,WAAtB,EAAmC,UAAnC,CAvET;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;;4GA0EA,kBAAuBA,WAAvB;AAAA;AAAA;AAAA;AAAA;AACE,qBAAKI,iCAAL,CAAuCJ,WAAvC,EAAoD,YAApD,EAAkE;AAChEmC,kBAAAA,WAAW,EAAE;AADmD,iBAAlE;AADF,kDAIS,KAAK7B,gBAAL,CAAsBN,WAAtB,EAAmC,YAAnC,CAJT;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;AAOA;;;;;iGACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAY5B,gBAAAA,OAAZ,8DAAwC,EAAxC;AAAA,+BACiC,KAAKK,KADtC,EACU+B,QADV,gBACUA,QADV,EACoBT,QADpB,gBACoBA,QADpB;AAAA,4BAE4BA,QAAQ,EAFpC,EAEUqC,aAFV,aAEUA,aAFV,EAIE;;AAJF,qBAKM,sCAAkBA,aAAlB,CALN;AAAA;AAAA;AAAA;;AAAA;;AAAA;AASE;AACA5B,gBAAAA,QAAQ,CAAC,UAAC/B,KAAD;AAAA;;AAAA,yBACPA,KAAK,CAAC4D,gBAAN,0BAAuBjE,OAAO,CAACkE,aAA/B,yEAAgDC,6BAAcC,OAA9D,CADO;AAAA,iBAAD,CAAR,CAVF,CAcE;;AACMC,gBAAAA,WAfR,mCAe2B,KAAK3D,cAfhC,GAemDV,OAfnD;AAAA;AAAA,uBAiBuB,KAAKC,SAAL,CAAeqE,WAAf,CAA2B;AAC9CC,kBAAAA,MAAM,EAAE,KADsC;AAE9CC,kBAAAA,GAAG,sBAAe,KAAK1E,KAAL,CAAW2E,MAA1B,oBAA0C,KAAK1E,MAA/C,CAF2C;AAG9C2E,kBAAAA,MAAM,EAAEL;AAHsC,iBAA3B,CAjBvB;;AAAA;AAiBQM,gBAAAA,MAjBR;;AAAA,sBAuBMA,MAAM,CAACC,UAAP,KAAsB,OAAtB,IAAiC,CAACD,MAAM,CAACE,IAvB/C;AAAA;AAAA;AAAA;;AAwBIzC,gBAAAA,QAAQ,CAAC,UAAC/B,KAAD;AAAA,yBAAWA,KAAK,CAAC4D,gBAAN,CAAuBE,6BAAcW,KAArC,CAAX;AAAA,iBAAD,CAAR;AAxBJ,kDA0BW;AACLC,kBAAAA,MAAM,EAAEJ,MAAM,CAACC,UADV;AAELI,kBAAAA,IAAI,EAAEL,MAAM,CAACG,KAAP,IAAgBH,MAAM,CAACE;AAFxB,iBA1BX;;AAAA;AAgCQI,gBAAAA,QAhCR,GAgCmB;AACfvB,kBAAAA,OAAO,EAAEiB,MAAM,CAACE,IAAP,CAAYnB,OADN;AAEfC,kBAAAA,IAAI,EAAEgB,MAAM,CAACE,IAAP,CAAYlB,IAFH;AAGfC,kBAAAA,SAAS,EAAEe,MAAM,CAACE,IAAP,CAAYjB;AAHR,iBAhCnB;;AAsCE,oBAAI5D,OAAO,CAACkF,MAAZ,EAAoB;AACZC,kBAAAA,IADY,GACL;AAAEC,oBAAAA,aAAa,EAAE,KAAjB;AAAwBC,oBAAAA,YAAY,EAAE;AAAtC,mBADK;AAElBjD,kBAAAA,QAAQ,CAAC,UAACb,KAAD;AAAA,2BAAWA,KAAK,CAACkC,SAAN,CAAgBwB,QAAhB,EAA0BE,IAA1B,CAAX;AAAA,mBAAD,CAAR;AACD,iBAHD,MAGO,IAAInF,OAAO,CAACsF,KAAZ,EAAmB;AAClBH,kBAAAA,KADkB,GACX;AAAEC,oBAAAA,aAAa,EAAE,IAAjB;AAAuBC,oBAAAA,YAAY,EAAE;AAArC,mBADW;AAExBjD,kBAAAA,QAAQ,CAAC,UAACb,KAAD;AAAA,2BAAWA,KAAK,CAACkC,SAAN,CAAgBwB,QAAhB,EAA0BE,KAA1B,CAAX;AAAA,mBAAD,CAAR;AACD,iBAHM,MAGA;AACL/C,kBAAAA,QAAQ,CAAC,UAACb,KAAD;AAAA,2BAAWA,KAAK,CAACkC,SAAN,CAAgBwB,QAAhB,CAAX;AAAA,mBAAD,CAAR;AACD,iBA9CH,CAgDE;;;AACA,qBAAKM,SAAL,CAAe,cAAf,EAA+BN,QAA/B,EAjDF,CAmDE;;AACMO,gBAAAA,aApDR,GAqDIxF,OAAO,CAACyF,aAAR,KAA0B,QAA1B,GACI,yBADJ,GAEI,qBAvDR;AAyDQC,gBAAAA,YAzDR,GAyDuB;AACnBlC,kBAAAA,KAAK,EAAEyB,QAAQ,CAACvB,OADG;AAEnBP,kBAAAA,QAAQ,EAAE8B,QAAQ,CAACtB,IAFA;AAGnBgC,kBAAAA,KAAK,EAAEH;AAHY,iBAzDvB;AA+DE,qBAAKD,SAAL,CAAeG,YAAY,CAACC,KAA5B,EAAmCD,YAAnC;AA/DF,kDAiES;AAAEV,kBAAAA,IAAI,EAAEC,QAAR;AAAkBF,kBAAAA,MAAM,EAAEJ,MAAM,CAACC;AAAjC,iBAjET;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;;yGAoEA;AAAA;;AAAA;AAAA;AAAA;AAAA;AACE;AACQjD,gBAAAA,QAFV,GAEuB,KAAKtB,KAF5B,CAEUsB,QAFV;AAAA,6BAGuBA,QAAQ,EAH/B,EAGUkC,QAHV,cAGUA,QAHV;;AAAA,oBAKOA,QAAQ,CAACyB,KALhB;AAAA;AAAA;AAAA;;AAAA;;AAAA;AAUE,qBAAKM,KAAL,CAAW;AACTN,kBAAAA,KAAK,EAAEzB,QAAQ,CAACyB,KADP;AAETpB,kBAAAA,aAAa,EAAEC,6BAAc0B;AAFpB,iBAAX;;AAVF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;WAgBA,mBACEpE,SADF,EAEEuD,IAFF,EAGE;AACA,WAAK1E,WAAL,CAAiBwF,IAAjB,CAAsBrE,SAAtB,EAAiCuD,IAAjC;AACD,K,CAED;;;;;gHACA;AAAA;;AAAA;AAAA;AAAA;AAAA;AACE7B,gBAAAA,QADF,QACEA,QADF;AAGE;AAHF,+BAIiC,KAAK9C,KAJtC,EAIUsB,QAJV,gBAIUA,QAJV,EAIoBS,QAJpB,gBAIoBA,QAJpB;AAAA,6BAKoBT,QAAQ,EAL5B,EAKU6B,KALV,cAKUA,KALV;AAMQuC,gBAAAA,WANR,GAM4CvC,KAAK,CAAC,CAAD,CANjD,EAOE;;AACApB,gBAAAA,QAAQ,CAAC,UAACb,KAAD;AAAA,yBAAWA,KAAK,CAACyE,WAAN,CAAkB7C,QAAlB,CAAX;AAAA,iBAAD,CAAR,CARF,CASE;;AACA,qBAAKyC,KAAL,CAAW;AAAEV,kBAAAA,MAAM,EAAEa,WAAF,aAAEA,WAAF,uBAAEA,WAAW,CAAEE,QAAvB;AAAiCR,kBAAAA,aAAa,EAAE;AAAhD,iBAAX;;AAVF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;WAaA,2BAA0B;AACxB,uBAAU,KAAK1F,MAAf,cAAyB,KAAKD,KAAL,CAAW2E,MAApC;AACD;;;WAED,2CACE7C,WADF,EAEEsE,IAFF,EAGEC,KAHF,EAIEC,cAJF,EAKE;AACA,yBAA+B,KAAK/F,KAApC;AAAA,UAAQsB,QAAR,gBAAQA,QAAR;AAAA,UAAkBS,QAAlB,gBAAkBA,QAAlB;AACA,UAAMK,OAAO,GAAGF,KAAK,CAACC,OAAN,CAAcZ,WAAd,IACZA,WAAW,CAACc,GAAZ,CAAgB,UAACC,IAAD;AAAA,eAAUA,IAAI,CAACC,EAAf;AAAA,OAAhB,CADY,GAEZ,CAAChB,WAAW,CAACgB,EAAb,CAFJ;;AAIA,UAAIwD,cAAJ,EAAoB;AAClB,yBAAqBzE,QAAQ,EAA7B;AAAA,YAAQwB,QAAR,cAAQA,QAAR,CADkB,CAGlB;AACA;;;AACA,YAAMkD,SAAS,GAAGH,IAAI,CAACI,UAAL,CAAgB,IAAhB,IACd7D,OAAO,CAACO,MADM,GAEd,CAACP,OAAO,CAACO,MAFb;AAIAZ,QAAAA,QAAQ,CAAC,UAAC/B,KAAD;AAAA,iBACPA,KAAK,CAAC2F,WAAN,iCACK7C,QADL,4CAEGiD,cAFH,EAEoBG,IAAI,CAACC,GAAL,CAAS,CAAT,EAAYrD,QAAQ,CAACiD,cAAD,CAAR,GAA2BC,SAAvC,CAFpB,GADO;AAAA,SAAD,CAAR;AAMD,OArBD,CAuBA;;;AACAjE,MAAAA,QAAQ,CAAC,UAAC/B,KAAD;AAAA,eAAWA,KAAK,CAACyD,YAAN,CAAmBrB,OAAnB,EAA4B0D,KAA5B,CAAX;AAAA,OAAD,CAAR;AACD;;;;4GAED,mBAA+BvE,WAA/B,EAA6DsE,IAA7D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qBAEM3D,KAAK,CAACC,OAAN,CAAcZ,WAAd,CAFN;AAAA;AAAA;AAAA;;AAGUa,gBAAAA,OAHV,GAGoBb,WAAW,CAACc,GAAZ,CAAgB,UAACC,IAAD;AAAA,yBAAUA,IAAI,CAACC,EAAf;AAAA,iBAAhB,CAHpB;AAAA;AAAA,uBAKiB,KAAK3C,SAAL,CAAeqE,WAAf,CAA2B;AACtCC,kBAAAA,MAAM,EAAE,MAD8B;AAEtCC,kBAAAA,GAAG,+BAAwB0B,IAAxB,CAFmC;AAGtClB,kBAAAA,IAAI,EAAE;AAAEyB,oBAAAA,WAAW,EAAEhE;AAAf;AAHgC,iBAA3B,CALjB;;AAAA;AAAA;;AAAA;AAAA;AAAA,uBAauB,KAAKxC,SAAL,CAAeqE,WAAf,CAA2B;AAC9CC,kBAAAA,MAAM,EAAE2B,IAAI,CAACI,UAAL,CAAgB,IAAhB,IAAwB,QAAxB,GAAmC,KADG;AAE9C9B,kBAAAA,GAAG,yBAAkB5C,WAAW,CAACgB,EAA9B,cAAoCsD,IAApC;AAF2C,iBAA3B,CAbvB;;AAAA;AAaQvB,gBAAAA,MAbR;AAAA,mDAkBSA,MAlBT;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,O;;;;;;;;;;;;eAsBa9E,I","sourcesContent":["import { Channel } from \"phoenix\";\nimport { StoreApi } from \"zustand\";\nimport { EventEmitter2 as EventEmitter } from \"eventemitter2\";\nimport ApiClient from \"../../api\";\nimport createStore from \"./store\";\nimport {\n BindableFeedEvent,\n FeedMessagesReceivedPayload,\n FeedEventCallback,\n FeedEvent,\n FeedItemOrItems,\n FeedStoreState,\n FeedEventPayload,\n FeedRealTimeCallback,\n} from \"./types\";\nimport {\n FeedItem,\n FeedClientOptions,\n FetchFeedOptions,\n FeedResponse,\n FeedMetadata,\n} from \"./interfaces\";\nimport Knock from \"../../knock\";\nimport { isRequestInFlight, NetworkStatus } from \"../../networkStatus\";\n\nexport type Status =\n | \"seen\"\n | \"read\"\n | \"archived\"\n | \"unseen\"\n | \"unread\"\n | \"unarchived\";\n\n// Default options to apply\nconst feedClientDefaults: Pick<FeedClientOptions, \"archived\"> = {\n archived: \"exclude\",\n};\n\nclass Feed {\n private apiClient: ApiClient;\n private userFeedId: string;\n private channel: Channel;\n private broadcaster: EventEmitter;\n private defaultOptions: FeedClientOptions;\n\n // The raw store instance, used for binding in React and other environments\n public store: StoreApi<FeedStoreState>;\n\n constructor(\n readonly knock: Knock,\n readonly feedId: string,\n options: FeedClientOptions,\n ) {\n this.apiClient = knock.client();\n this.feedId = feedId;\n this.userFeedId = this.buildUserFeedId();\n this.store = createStore();\n this.broadcaster = new EventEmitter({ wildcard: true, delimiter: \".\" });\n this.defaultOptions = { ...feedClientDefaults, ...options };\n\n this.channel = this.apiClient.socket.channel(\n `feeds:${this.userFeedId}`,\n this.defaultOptions,\n );\n\n this.channel.on(\"new-message\", (resp) => this.onNewMessageReceived(resp));\n }\n\n /**\n * Cleans up a feed instance by destroying the store and disconnecting\n * an open socket connection.\n */\n teardown() {\n this.channel.leave();\n this.broadcaster.removeAllListeners();\n this.channel.off(\"new-message\");\n this.store.destroy();\n }\n\n /*\n Initializes a real-time connection to Knock, connecting the websocket for the\n current ApiClient instance if the socket is not already connected.\n */\n listenForUpdates() {\n // Connect the socket only if we don't already have a connection\n if (!this.apiClient.socket.isConnected()) {\n this.apiClient.socket.connect();\n }\n\n // Only join the channel if we're not already in a joining state\n if ([\"closed\", \"errored\"].includes(this.channel.state)) {\n this.channel.join();\n }\n }\n\n /* Binds a handler to be invoked when event occurs */\n on(\n eventName: BindableFeedEvent,\n callback: FeedEventCallback | FeedRealTimeCallback,\n ) {\n this.broadcaster.on(eventName, callback);\n }\n\n off(\n eventName: BindableFeedEvent,\n callback: FeedEventCallback | FeedRealTimeCallback,\n ) {\n this.broadcaster.off(eventName, callback);\n }\n\n getState() {\n return this.store.getState();\n }\n\n async markAsSeen(itemOrItems: FeedItemOrItems) {\n const now = new Date().toISOString();\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"seen\",\n { seen_at: now },\n \"unseen_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"seen\");\n }\n\n async markAsUnseen(itemOrItems: FeedItemOrItems) {\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"unseen\",\n { seen_at: null },\n \"unseen_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"unseen\");\n }\n\n async markAsRead(itemOrItems: FeedItemOrItems) {\n const now = new Date().toISOString();\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"read\",\n { read_at: now },\n \"unread_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"read\");\n }\n\n async markAsUnread(itemOrItems: FeedItemOrItems) {\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"unread\",\n { read_at: null },\n \"unread_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"unread\");\n }\n\n /*\n Marking one or more items as archived should:\n\n - Decrement the badge count for any unread / unseen items\n - Remove the item from the feed list when the `archived` flag is \"exclude\" (default)\n\n TODO: how do we handle rollbacks?\n */\n async markAsArchived(itemOrItems: FeedItemOrItems) {\n const { getState, setState } = this.store;\n const state = getState();\n\n const shouldOptimisticallyRemoveItems =\n this.defaultOptions.archived === \"exclude\";\n\n const normalizedItems = Array.isArray(itemOrItems)\n ? itemOrItems\n : [itemOrItems];\n\n const itemIds: string[] = normalizedItems.map((item) => item.id);\n\n /*\n In the proceeding code here we want to optimistically update counts and items\n that are persisted such that we can display updates immediately on the feed\n without needing to make a network request.\n\n Note: right now this does *not* take into account offline handling or any extensive retry\n logic, so rollbacks aren't considered. That probably needs to be a future consideration for\n this library.\n\n Scenarios to consider:\n\n ## Feed scope to archived *only* \n\n - Counts should not be decremented\n - Items should not be removed\n\n ## Feed scoped to exclude archived items (the default)\n \n - Counts should be decremented\n - Items should be removed\n\n ## Feed scoped to include archived items as well\n\n - Counts should not be decremented\n - Items should not be removed\n */\n\n if (shouldOptimisticallyRemoveItems) {\n // If any of the items are unseen or unread, then capture as we'll want to decrement\n // the counts for these in the metadata we have\n const unseenCount = normalizedItems.filter((i) => !i.seen_at).length;\n const unreadCount = normalizedItems.filter((i) => !i.read_at).length;\n\n // Build the new metadata\n const updatedMetadata = {\n ...state.metadata,\n total_count: state.metadata.total_count - normalizedItems.length,\n unseen_count: state.metadata.unseen_count - unseenCount,\n unread_count: state.metadata.unread_count - unreadCount,\n };\n\n // Remove the archiving entries\n const entriesToSet = state.items.filter(\n (item) => !itemIds.includes(item.id),\n );\n\n setState((state) =>\n state.setResult({\n entries: entriesToSet,\n meta: updatedMetadata,\n page_info: state.pageInfo,\n }),\n );\n } else {\n // Mark all the entries being updated as archived either way so the state is correct\n state.setItemAttrs(itemIds, { archived_at: new Date().toISOString() });\n }\n\n return this.makeStatusUpdate(itemOrItems, \"archived\");\n }\n\n async markAsUnarchived(itemOrItems: FeedItemOrItems) {\n this.optimisticallyPerformStatusUpdate(itemOrItems, \"unarchived\", {\n archived_at: null,\n });\n return this.makeStatusUpdate(itemOrItems, \"unarchived\");\n }\n\n /* Fetches the feed content, appending it to the store */\n async fetch(options: FetchFeedOptions = {}) {\n const { setState, getState } = this.store;\n const { networkStatus } = getState();\n\n // If there's an existing request in flight, then do nothing\n if (isRequestInFlight(networkStatus)) {\n return;\n }\n\n // Set the loading type based on the request type it is\n setState((store) =>\n store.setNetworkStatus(options.__loadingType ?? NetworkStatus.loading),\n );\n\n // Always include the default params, if they have been set\n const queryParams = { ...this.defaultOptions, ...options };\n\n const result = await this.apiClient.makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.knock.userId}/feeds/${this.feedId}`,\n params: queryParams,\n });\n\n if (result.statusCode === \"error\" || !result.body) {\n setState((store) => store.setNetworkStatus(NetworkStatus.error));\n\n return {\n status: result.statusCode,\n data: result.error || result.body,\n };\n }\n\n const response = {\n entries: result.body.entries,\n meta: result.body.meta,\n page_info: result.body.page_info,\n };\n\n if (options.before) {\n const opts = { shouldSetPage: false, shouldAppend: true };\n setState((state) => state.setResult(response, opts));\n } else if (options.after) {\n const opts = { shouldSetPage: true, shouldAppend: true };\n setState((state) => state.setResult(response, opts));\n } else {\n setState((state) => state.setResult(response));\n }\n\n // Legacy `messages.new` event, should be removed in a future version\n this.broadcast(\"messages.new\", response);\n\n // Broadcast the appropriate event type depending on the fetch source\n const feedEventType: FeedEvent =\n options.__fetchSource === \"socket\"\n ? \"items.received.realtime\"\n : \"items.received.page\";\n\n const eventPayload = {\n items: response.entries as FeedItem[],\n metadata: response.meta as FeedMetadata,\n event: feedEventType,\n };\n\n this.broadcast(eventPayload.event, eventPayload);\n\n return { data: response, status: result.statusCode };\n }\n\n async fetchNextPage() {\n // Attempts to fetch the next page of results (if we have any)\n const { getState } = this.store;\n const { pageInfo } = getState();\n\n if (!pageInfo.after) {\n // Nothing more to fetch\n return;\n }\n\n this.fetch({\n after: pageInfo.after,\n __loadingType: NetworkStatus.fetchMore,\n });\n }\n\n private broadcast(\n eventName: FeedEvent,\n data: FeedResponse | FeedEventPayload,\n ) {\n this.broadcaster.emit(eventName, data);\n }\n\n // Invoked when a new real-time message comes in from the socket\n private async onNewMessageReceived({\n metadata,\n }: FeedMessagesReceivedPayload) {\n // Handle the new message coming in\n const { getState, setState } = this.store;\n const { items } = getState();\n const currentHead: FeedItem | undefined = items[0];\n // Optimistically set the badge counts\n setState((state) => state.setMetadata(metadata));\n // Fetch the items before the current head (if it exists)\n this.fetch({ before: currentHead?.__cursor, __fetchSource: \"socket\" });\n }\n\n private buildUserFeedId() {\n return `${this.feedId}:${this.knock.userId}`;\n }\n\n private optimisticallyPerformStatusUpdate(\n itemOrItems: FeedItemOrItems,\n type: Status,\n attrs: object,\n badgeCountAttr?: \"unread_count\" | \"unseen_count\",\n ) {\n const { getState, setState } = this.store;\n const itemIds = Array.isArray(itemOrItems)\n ? itemOrItems.map((item) => item.id)\n : [itemOrItems.id];\n\n if (badgeCountAttr) {\n const { metadata } = getState();\n\n // Tnis is a hack to determine the direction of whether we're\n // adding or removing from the badge count\n const direction = type.startsWith(\"un\")\n ? itemIds.length\n : -itemIds.length;\n\n setState((store) =>\n store.setMetadata({\n ...metadata,\n [badgeCountAttr]: Math.max(0, metadata[badgeCountAttr] + direction),\n }),\n );\n }\n\n // Update the items with the given attributes\n setState((store) => store.setItemAttrs(itemIds, attrs));\n }\n\n private async makeStatusUpdate(itemOrItems: FeedItemOrItems, type: Status) {\n // If we're interacting with an array, then we want to send this as a batch\n if (Array.isArray(itemOrItems)) {\n const itemIds = itemOrItems.map((item) => item.id);\n\n return await this.apiClient.makeRequest({\n method: \"POST\",\n url: `/v1/messages/batch/${type}`,\n data: { message_ids: itemIds },\n });\n }\n\n // If its a single then we can just call the regular endpoint\n const result = await this.apiClient.makeRequest({\n method: type.startsWith(\"un\") ? \"DELETE\" : \"PUT\",\n url: `/v1/messages/${itemOrItems.id}/${type}`,\n });\n\n return result;\n }\n}\n\nexport default Feed;\n"],"file":"feed.js"}
package/dist/cjs/knock.js CHANGED
@@ -73,10 +73,7 @@ var Knock = /*#__PURE__*/function () {
73
73
  }, {
74
74
  key: "teardown",
75
75
  value: function teardown() {
76
- if (!this.apiClient) {
77
- return;
78
- }
79
-
76
+ if (!this.apiClient) return;
80
77
  this.apiClient.socket.disconnect();
81
78
  }
82
79
  }]);
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/knock.ts"],"names":["DEFAULT_HOST","Knock","apiKey","options","FeedClient","Preferences","host","startsWith","Error","userId","userToken","console","warn","apiClient","ApiClient","socket","disconnect"],"mappings":";;;;;;;;;;;;;;;AAAA;;AACA;;AACA;;AAGA,IAAMA,YAAY,GAAG,uBAArB;;IAEMC,K;AASJ,iBAAqBC,MAArB,EAAiE;AAAA,QAA5BC,OAA4B,uEAAJ,EAAI;AAAA;AAAA,SAA5CD,MAA4C,GAA5CA,MAA4C;AAAA;AAAA;AAAA,wDAN3B,IAM2B;AAAA;AAAA,oDAHhD,IAAIE,gBAAJ,CAAe,IAAf,CAGgD;AAAA,0DAF1C,IAAIC,uBAAJ,CAAgB,IAAhB,CAE0C;AAC/D,SAAKC,IAAL,GAAYH,OAAO,CAACG,IAAR,IAAgBN,YAA5B,CAD+D,CAG/D;;AACA,QAAI,KAAKE,MAAL,IAAe,KAAKA,MAAL,CAAYK,UAAZ,CAAuB,KAAvB,CAAnB,EAAkD;AAChD,YAAM,IAAIC,KAAJ,CACJ,qFADI,CAAN;AAGD;AACF;;;;WAED,kBAAS;AACP,UAAI,CAAC,KAAKC,MAAN,IAAgB,CAAC,KAAKC,SAA1B,EAAqC;AACnCC,QAAAA,OAAO,CAACC,IAAR;AAOD,OATM,CAWP;;;AACA,UAAI,CAAC,KAAKC,SAAV,EAAqB;AACnB,aAAKA,SAAL,GAAiB,IAAIC,eAAJ,CAAc;AAC7BZ,UAAAA,MAAM,EAAE,KAAKA,MADgB;AAE7BI,UAAAA,IAAI,EAAE,KAAKA,IAFkB;AAG7BI,UAAAA,SAAS,EAAE,KAAKA;AAHa,SAAd,CAAjB;AAKD;;AAED,aAAO,KAAKG,SAAZ;AACD;AAED;AACF;AACA;AACA;;;;WACE,sBAAaJ,MAAb,EAA6BC,SAA7B,EAAiD;AAC/C,WAAKD,MAAL,GAAcA,MAAd;AACA,WAAKC,SAAL,GAAiBA,SAAjB;AAEA;AACD,K,CAED;;;;WACA,oBAAW;AACT,UAAI,CAAC,KAAKG,SAAV,EAAqB;AACnB;AACD;;AAED,WAAKA,SAAL,CAAeE,MAAf,CAAsBC,UAAtB;AACD;;;;;eAGYf,K","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 userToken: string | undefined;\n private apiClient: ApiClient | null = null;\n public userId: 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 && !this.userToken) {\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 // Used to teardown any connected instances\n teardown() {\n if (!this.apiClient) {\n return;\n }\n\n this.apiClient.socket.disconnect();\n }\n}\n\nexport default Knock;\n"],"file":"knock.js"}
1
+ {"version":3,"sources":["../../src/knock.ts"],"names":["DEFAULT_HOST","Knock","apiKey","options","FeedClient","Preferences","host","startsWith","Error","userId","userToken","console","warn","apiClient","ApiClient","socket","disconnect"],"mappings":";;;;;;;;;;;;;;;AAAA;;AACA;;AACA;;AAGA,IAAMA,YAAY,GAAG,uBAArB;;IAEMC,K;AASJ,iBAAqBC,MAArB,EAAiE;AAAA,QAA5BC,OAA4B,uEAAJ,EAAI;AAAA;AAAA,SAA5CD,MAA4C,GAA5CA,MAA4C;AAAA;AAAA;AAAA,wDAN3B,IAM2B;AAAA;AAAA,oDAHhD,IAAIE,gBAAJ,CAAe,IAAf,CAGgD;AAAA,0DAF1C,IAAIC,uBAAJ,CAAgB,IAAhB,CAE0C;AAC/D,SAAKC,IAAL,GAAYH,OAAO,CAACG,IAAR,IAAgBN,YAA5B,CAD+D,CAG/D;;AACA,QAAI,KAAKE,MAAL,IAAe,KAAKA,MAAL,CAAYK,UAAZ,CAAuB,KAAvB,CAAnB,EAAkD;AAChD,YAAM,IAAIC,KAAJ,CACJ,qFADI,CAAN;AAGD;AACF;;;;WAED,kBAAS;AACP,UAAI,CAAC,KAAKC,MAAN,IAAgB,CAAC,KAAKC,SAA1B,EAAqC;AACnCC,QAAAA,OAAO,CAACC,IAAR;AAOD,OATM,CAWP;;;AACA,UAAI,CAAC,KAAKC,SAAV,EAAqB;AACnB,aAAKA,SAAL,GAAiB,IAAIC,eAAJ,CAAc;AAC7BZ,UAAAA,MAAM,EAAE,KAAKA,MADgB;AAE7BI,UAAAA,IAAI,EAAE,KAAKA,IAFkB;AAG7BI,UAAAA,SAAS,EAAE,KAAKA;AAHa,SAAd,CAAjB;AAKD;;AAED,aAAO,KAAKG,SAAZ;AACD;AAED;AACF;AACA;AACA;;;;WACE,sBAAaJ,MAAb,EAA6BC,SAA7B,EAAiD;AAC/C,WAAKD,MAAL,GAAcA,MAAd;AACA,WAAKC,SAAL,GAAiBA,SAAjB;AAEA;AACD,K,CAED;;;;WACA,oBAAW;AACT,UAAI,CAAC,KAAKG,SAAV,EAAqB;AACrB,WAAKA,SAAL,CAAeE,MAAf,CAAsBC,UAAtB;AACD;;;;;eAGYf,K","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 userToken: string | undefined;\n private apiClient: ApiClient | null = null;\n public userId: 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 && !this.userToken) {\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 // Used to teardown any connected instances\n teardown() {\n if (!this.apiClient) return;\n this.apiClient.socket.disconnect();\n }\n}\n\nexport default Knock;\n"],"file":"knock.js"}
package/dist/esm/api.js CHANGED
@@ -2,12 +2,9 @@ import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
2
2
  import _defineProperty from "@babel/runtime/helpers/defineProperty";
3
3
  import axios from "axios";
4
4
  import axiosRetry from "axios-retry";
5
- import { Socket } from "phoenix";
5
+ import { LongPoll, Socket } from "phoenix";
6
6
 
7
7
  class ApiClient {
8
- /**
9
- * @deprecated Use `socket.connectionState` instead.
10
- */
11
8
  constructor(options) {
12
9
  _defineProperty(this, "host", void 0);
13
10
 
@@ -17,8 +14,6 @@ class ApiClient {
17
14
 
18
15
  _defineProperty(this, "axiosClient", void 0);
19
16
 
20
- _defineProperty(this, "socketConnected", false);
21
-
22
17
  _defineProperty(this, "socket", void 0);
23
18
 
24
19
  this.host = options.host;
@@ -35,6 +30,8 @@ class ApiClient {
35
30
  }
36
31
  });
37
32
  this.socket = new Socket("".concat(this.host.replace("http", "ws"), "/ws/v1"), {
33
+ // If we're in a non-browser environment, then fallback to longpolling
34
+ transport: typeof window === "undefined" ? LongPoll : window.WebSocket,
38
35
  params: {
39
36
  user_token: this.userToken,
40
37
  api_key: this.apiKey
@@ -46,39 +43,6 @@ class ApiClient {
46
43
  retryDelay: axiosRetry.exponentialDelay
47
44
  });
48
45
  }
49
- /**
50
- * @deprecated Use `socket.connect()` instead.
51
- */
52
-
53
-
54
- connectSocket() {
55
- if (this.socketConnected) {
56
- return;
57
- }
58
-
59
- this.socket.connect();
60
- this.socket.onOpen(() => {
61
- this.socketConnected = true;
62
- });
63
- }
64
- /**
65
- * @deprecated Use `socket.disconnect()` instead.
66
- */
67
-
68
-
69
- disconnectSocket() {
70
- this.socket.disconnect();
71
- this.socketConnected = false;
72
- return;
73
- }
74
- /**
75
- * @deprecated Use `socket.channel(name: string, params?: object)` instead.
76
- */
77
-
78
-
79
- createChannel(name, params) {
80
- return this.socket.channel(name, params);
81
- }
82
46
 
83
47
  makeRequest(req) {
84
48
  var _this = this;
@@ -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","socket","replace","params","user_token","api_key","retries","retryCondition","canRetryRequest","retryDelay","exponentialDelay","connectSocket","socketConnected","connect","onOpen","disconnectSocket","disconnect","createChannel","name","channel","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;AAMd;AACF;AACA;AAIEC,EAAAA,WAAW,CAACC,OAAD,EAA4B;AAAA;;AAAA;;AAAA;;AAAA;;AAAA,6CAHd,KAGc;;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,SAAKO,MAAL,GAAc,IAAIb,MAAJ,WAAc,KAAKI,IAAL,CAAUU,OAAV,CAAkB,MAAlB,EAA0B,IAA1B,CAAd,aAAuD;AACnEC,MAAAA,MAAM,EAAE;AACNC,QAAAA,UAAU,EAAE,KAAKV,SADX;AAENW,QAAAA,OAAO,EAAE,KAAKZ;AAFR;AAD2D,KAAvD,CAAd;AAOAN,IAAAA,UAAU,CAAC,KAAKQ,WAAN,EAAmB;AAC3BW,MAAAA,OAAO,EAAE,CADkB;AAE3BC,MAAAA,cAAc,EAAE,KAAKC,eAFM;AAG3BC,MAAAA,UAAU,EAAEtB,UAAU,CAACuB;AAHI,KAAnB,CAAV;AAKD;AAED;AACF;AACA;;;AACEC,EAAAA,aAAa,GAAG;AACd,QAAI,KAAKC,eAAT,EAA0B;AACxB;AACD;;AAED,SAAKX,MAAL,CAAYY,OAAZ;AACA,SAAKZ,MAAL,CAAYa,MAAZ,CAAmB,MAAM;AACvB,WAAKF,eAAL,GAAuB,IAAvB;AACD,KAFD;AAGD;AAED;AACF;AACA;;;AACEG,EAAAA,gBAAgB,GAAG;AACjB,SAAKd,MAAL,CAAYe,UAAZ;AACA,SAAKJ,eAAL,GAAuB,KAAvB;AACA;AACD;AAED;AACF;AACA;;;AACEK,EAAAA,aAAa,CAACC,IAAD,EAAef,MAAf,EAAgC;AAC3C,WAAO,KAAKF,MAAL,CAAYkB,OAAZ,CAAoBD,IAApB,EAA0Bf,MAA1B,CAAP;AACD;;AAEKiB,EAAAA,WAAW,CAACC,GAAD,EAAgD;AAAA;;AAAA;AAC/D,UAAI;AACF,YAAMC,MAAM,SAAS,KAAI,CAAC3B,WAAL,CAAiB0B,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;;AAEOrB,EAAAA,eAAe,CAACmB,KAAD,EAAoB;AACzC;AACA,QAAIxC,UAAU,CAAC4C,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;;AAtHa;;AAyHhB,eAAenC,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 /**\n * @deprecated Use `socket.connectionState` instead.\n */\n public socketConnected = false;\n public socket: Socket;\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 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 axiosRetry(this.axiosClient, {\n retries: 3,\n retryCondition: this.canRetryRequest,\n retryDelay: axiosRetry.exponentialDelay,\n });\n }\n\n /**\n * @deprecated Use `socket.connect()` instead.\n */\n connectSocket() {\n if (this.socketConnected) {\n return;\n }\n\n this.socket.connect();\n this.socket.onOpen(() => {\n this.socketConnected = true;\n });\n }\n\n /**\n * @deprecated Use `socket.disconnect()` instead.\n */\n disconnectSocket() {\n this.socket.disconnect();\n this.socketConnected = false;\n return;\n }\n\n /**\n * @deprecated Use `socket.channel(name: string, params?: object)` instead.\n */\n createChannel(name: string, params?: object) {\n return this.socket.channel(name, params);\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,"sources":["../../src/api.ts"],"names":["axios","axiosRetry","LongPoll","Socket","ApiClient","constructor","options","host","apiKey","userToken","axiosClient","create","baseURL","headers","Accept","Authorization","socket","replace","transport","window","WebSocket","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,QAAT,EAAmBC,MAAnB,QAAiC,SAAjC;;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,GAAmBV,KAAK,CAACW,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,SAAKO,MAAL,GAAc,IAAIb,MAAJ,WAAc,KAAKI,IAAL,CAAUU,OAAV,CAAkB,MAAlB,EAA0B,IAA1B,CAAd,aAAuD;AACnE;AACAC,MAAAA,SAAS,EAAE,OAAOC,MAAP,KAAkB,WAAlB,GAAgCjB,QAAhC,GAA2CiB,MAAM,CAACC,SAFM;AAGnEC,MAAAA,MAAM,EAAE;AACNC,QAAAA,UAAU,EAAE,KAAKb,SADX;AAENc,QAAAA,OAAO,EAAE,KAAKf;AAFR;AAH2D,KAAvD,CAAd;AASAP,IAAAA,UAAU,CAAC,KAAKS,WAAN,EAAmB;AAC3Bc,MAAAA,OAAO,EAAE,CADkB;AAE3BC,MAAAA,cAAc,EAAE,KAAKC,eAFM;AAG3BC,MAAAA,UAAU,EAAE1B,UAAU,CAAC2B;AAHI,KAAnB,CAAV;AAKD;;AAEKC,EAAAA,WAAW,CAACC,GAAD,EAAgD;AAAA;;AAAA;AAC/D,UAAI;AACF,YAAMC,MAAM,SAAS,KAAI,CAACrB,WAAL,CAAiBoB,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,QAAInC,UAAU,CAACuC,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,eAAe7B,SAAf","sourcesContent":["import axios, { AxiosInstance, AxiosRequestConfig } from \"axios\";\nimport axiosRetry from \"axios-retry\";\nimport { LongPoll, 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;\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 this.socket = new Socket(`${this.host.replace(\"http\", \"ws\")}/ws/v1`, {\n // If we're in a non-browser environment, then fallback to longpolling\n transport: typeof window === \"undefined\" ? LongPoll : window.WebSocket,\n params: {\n user_token: this.userToken,\n api_key: this.apiKey,\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"}
@@ -8,6 +8,10 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
8
8
  import { EventEmitter2 as EventEmitter } from "eventemitter2";
9
9
  import createStore from "./store";
10
10
  import { isRequestInFlight, NetworkStatus } from "../../networkStatus";
11
+ // Default options to apply
12
+ var feedClientDefaults = {
13
+ archived: "exclude"
14
+ };
11
15
 
12
16
  class Feed {
13
17
  // The raw store instance, used for binding in React and other environments
@@ -35,39 +39,38 @@ class Feed {
35
39
  wildcard: true,
36
40
  delimiter: "."
37
41
  });
38
- this.defaultOptions = options; // Try and connect to the socket
39
-
40
- this.apiClient.socket.connect();
42
+ this.defaultOptions = _objectSpread(_objectSpread({}, feedClientDefaults), options);
41
43
  this.channel = this.apiClient.socket.channel("feeds:".concat(this.userFeedId), this.defaultOptions);
44
+ this.channel.on("new-message", resp => this.onNewMessageReceived(resp));
45
+ }
46
+ /**
47
+ * Cleans up a feed instance by destroying the store and disconnecting
48
+ * an open socket connection.
49
+ */
50
+
51
+
52
+ teardown() {
53
+ this.channel.leave();
54
+ this.broadcaster.removeAllListeners();
55
+ this.channel.off("new-message");
56
+ this.store.destroy();
42
57
  }
43
58
  /*
44
- Returns a socket to listen for feed updates
59
+ Initializes a real-time connection to Knock, connecting the websocket for the
60
+ current ApiClient instance if the socket is not already connected.
45
61
  */
46
62
 
47
63
 
48
64
  listenForUpdates() {
49
- try {
65
+ // Connect the socket only if we don't already have a connection
66
+ if (!this.apiClient.socket.isConnected()) {
67
+ this.apiClient.socket.connect();
68
+ } // Only join the channel if we're not already in a joining state
69
+
70
+
71
+ if (["closed", "errored"].includes(this.channel.state)) {
50
72
  this.channel.join();
51
- } catch (e) {
52
- // Phoenix raises an error when trying to call join more than once. Given calling listenForUpdates unintentionally
53
- // may happen fairly often, we choose to supress the error and print a warning.
54
- if (e.message.includes("join")) {
55
- console.warn(e.message);
56
- } else {
57
- throw e;
58
- }
59
73
  }
60
-
61
- this.channel.on("new-message", resp => this.onNewMessageReceived(resp));
62
- return () => {
63
- try {
64
- this.channel.leave();
65
- this.channel.off("new-message");
66
- } catch (e) {
67
- // tslint:disable-next-line
68
- console.error("error while leaving channel", e);
69
- }
70
- };
71
74
  }
72
75
  /* Binds a handler to be invoked when event occurs */
73
76
 
@@ -138,7 +141,7 @@ class Feed {
138
141
  /*
139
142
  Marking one or more items as archived should:
140
143
  - Decrement the badge count for any unread / unseen items
141
- - Remove the item from the feed list, when the include_archived flag is not true)
144
+ - Remove the item from the feed list when the `archived` flag is "exclude" (default)
142
145
  TODO: how do we handle rollbacks?
143
146
  */
144
147
 
@@ -152,35 +155,52 @@ class Feed {
152
155
  setState
153
156
  } = _this5.store;
154
157
  var state = getState();
155
- var shouldRemoveItems = _this5.defaultOptions.include_archived !== true;
158
+ var shouldOptimisticallyRemoveItems = _this5.defaultOptions.archived === "exclude";
156
159
  var normalizedItems = Array.isArray(itemOrItems) ? itemOrItems : [itemOrItems];
157
- var itemIds = normalizedItems.map(item => item.id); // If any of the items are unseen or unread, then capture as we'll want to decrement
158
- // the counts for these in the metadata we have
159
-
160
- var unseenCount = normalizedItems.filter(i => !i.seen_at).length;
161
- var unreadCount = normalizedItems.filter(i => !i.read_at).length; // Build the new metadata
162
-
163
- var meta = _objectSpread(_objectSpread({}, state.metadata), {}, {
164
- total_count: state.metadata.total_count - normalizedItems.length,
165
- unseen_count: state.metadata.unseen_count - unseenCount,
166
- unread_count: state.metadata.unread_count - unreadCount
167
- }); // Perform optimistic updates on the items in the feed
168
-
169
-
170
- if (shouldRemoveItems) {
171
- // Filter the items out of the list
172
- var entries = state.items.filter(item => !itemIds.includes(item.id));
160
+ var itemIds = normalizedItems.map(item => item.id);
161
+ /*
162
+ In the proceeding code here we want to optimistically update counts and items
163
+ that are persisted such that we can display updates immediately on the feed
164
+ without needing to make a network request.
165
+ Note: right now this does *not* take into account offline handling or any extensive retry
166
+ logic, so rollbacks aren't considered. That probably needs to be a future consideration for
167
+ this library.
168
+ Scenarios to consider:
169
+ ## Feed scope to archived *only*
170
+ - Counts should not be decremented
171
+ - Items should not be removed
172
+ ## Feed scoped to exclude archived items (the default)
173
+
174
+ - Counts should be decremented
175
+ - Items should be removed
176
+ ## Feed scoped to include archived items as well
177
+ - Counts should not be decremented
178
+ - Items should not be removed
179
+ */
180
+
181
+ if (shouldOptimisticallyRemoveItems) {
182
+ // If any of the items are unseen or unread, then capture as we'll want to decrement
183
+ // the counts for these in the metadata we have
184
+ var unseenCount = normalizedItems.filter(i => !i.seen_at).length;
185
+ var unreadCount = normalizedItems.filter(i => !i.read_at).length; // Build the new metadata
186
+
187
+ var updatedMetadata = _objectSpread(_objectSpread({}, state.metadata), {}, {
188
+ total_count: state.metadata.total_count - normalizedItems.length,
189
+ unseen_count: state.metadata.unseen_count - unseenCount,
190
+ unread_count: state.metadata.unread_count - unreadCount
191
+ }); // Remove the archiving entries
192
+
193
+
194
+ var entriesToSet = state.items.filter(item => !itemIds.includes(item.id));
173
195
  setState(state => state.setResult({
174
- entries,
175
- meta,
196
+ entries: entriesToSet,
197
+ meta: updatedMetadata,
176
198
  page_info: state.pageInfo
177
199
  }));
178
200
  } else {
179
- setState(state => {
180
- state.setMetadata(meta);
181
- state.setItemAttrs(itemIds, {
182
- archived_at: new Date().toISOString()
183
- });
201
+ // Mark all the entries being updated as archived either way so the state is correct
202
+ state.setItemAttrs(itemIds, {
203
+ archived_at: new Date().toISOString()
184
204
  });
185
205
  }
186
206
 
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../../src/clients/feed/feed.ts"],"names":["EventEmitter2","EventEmitter","createStore","isRequestInFlight","NetworkStatus","Feed","constructor","knock","feedId","options","apiClient","client","userFeedId","buildUserFeedId","store","broadcaster","wildcard","delimiter","defaultOptions","socket","connect","channel","listenForUpdates","join","e","message","includes","console","warn","on","resp","onNewMessageReceived","leave","off","error","eventName","callback","getState","markAsSeen","itemOrItems","now","Date","toISOString","optimisticallyPerformStatusUpdate","seen_at","makeStatusUpdate","markAsUnseen","markAsRead","read_at","markAsUnread","markAsArchived","setState","state","shouldRemoveItems","include_archived","normalizedItems","Array","isArray","itemIds","map","item","id","unseenCount","filter","i","length","unreadCount","meta","metadata","total_count","unseen_count","unread_count","entries","items","setResult","page_info","pageInfo","setMetadata","setItemAttrs","archived_at","markAsUnarchived","fetch","networkStatus","setNetworkStatus","__loadingType","loading","queryParams","result","makeRequest","method","url","userId","params","statusCode","body","status","data","response","before","opts","shouldSetPage","shouldAppend","after","broadcast","feedEventType","__fetchSource","eventPayload","event","fetchNextPage","fetchMore","emit","currentHead","__cursor","type","attrs","badgeCountAttr","direction","startsWith","Math","max","message_ids"],"mappings":";;;;;;;AAEA,SAASA,aAAa,IAAIC,YAA1B,QAA8C,eAA9C;AAEA,OAAOC,WAAP,MAAwB,SAAxB;AAmBA,SAASC,iBAAT,EAA4BC,aAA5B,QAAiD,qBAAjD;;AAUA,MAAMC,IAAN,CAAW;AAOT;AAGAC,EAAAA,WAAW,CACAC,KADA,EAEAC,MAFA,EAGTC,OAHS,EAIT;AAAA,SAHSF,KAGT,GAHSA,KAGT;AAAA,SAFSC,MAET,GAFSA,MAET;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AACA,SAAKE,SAAL,GAAiBH,KAAK,CAACI,MAAN,EAAjB;AACA,SAAKH,MAAL,GAAcA,MAAd;AACA,SAAKI,UAAL,GAAkB,KAAKC,eAAL,EAAlB;AACA,SAAKC,KAAL,GAAaZ,WAAW,EAAxB;AACA,SAAKa,WAAL,GAAmB,IAAId,YAAJ,CAAiB;AAAEe,MAAAA,QAAQ,EAAE,IAAZ;AAAkBC,MAAAA,SAAS,EAAE;AAA7B,KAAjB,CAAnB;AACA,SAAKC,cAAL,GAAsBT,OAAtB,CANA,CAQA;;AACA,SAAKC,SAAL,CAAeS,MAAf,CAAsBC,OAAtB;AAEA,SAAKC,OAAL,GAAe,KAAKX,SAAL,CAAeS,MAAf,CAAsBE,OAAtB,iBACJ,KAAKT,UADD,GAEb,KAAKM,cAFQ,CAAf;AAID;AAED;AACF;AACA;;;AACEI,EAAAA,gBAAgB,GAAG;AACjB,QAAI;AACF,WAAKD,OAAL,CAAaE,IAAb;AACD,KAFD,CAEE,OAAOC,CAAP,EAAU;AACV;AACA;AACA,UAAIA,CAAC,CAACC,OAAF,CAAUC,QAAV,CAAmB,MAAnB,CAAJ,EAAgC;AAC9BC,QAAAA,OAAO,CAACC,IAAR,CAAaJ,CAAC,CAACC,OAAf;AACD,OAFD,MAEO;AACL,cAAMD,CAAN;AACD;AACF;;AAED,SAAKH,OAAL,CAAaQ,EAAb,CAAgB,aAAhB,EAAgCC,IAAD,IAAU,KAAKC,oBAAL,CAA0BD,IAA1B,CAAzC;AAEA,WAAO,MAAM;AACX,UAAI;AACF,aAAKT,OAAL,CAAaW,KAAb;AACA,aAAKX,OAAL,CAAaY,GAAb,CAAiB,aAAjB;AACD,OAHD,CAGE,OAAOT,CAAP,EAAU;AACV;AACAG,QAAAA,OAAO,CAACO,KAAR,CAAc,6BAAd,EAA6CV,CAA7C;AACD;AACF,KARD;AASD;AAED;;;AACAK,EAAAA,EAAE,CACAM,SADA,EAEAC,QAFA,EAGA;AACA,SAAKrB,WAAL,CAAiBc,EAAjB,CAAoBM,SAApB,EAA+BC,QAA/B;AACD;;AAEDH,EAAAA,GAAG,CACDE,SADC,EAEDC,QAFC,EAGD;AACA,SAAKrB,WAAL,CAAiBkB,GAAjB,CAAqBE,SAArB,EAAgCC,QAAhC;AACD;;AAEDC,EAAAA,QAAQ,GAAG;AACT,WAAO,KAAKvB,KAAL,CAAWuB,QAAX,EAAP;AACD;;AAEKC,EAAAA,UAAU,CAACC,WAAD,EAA+B;AAAA;;AAAA;AAC7C,UAAMC,GAAG,GAAG,IAAIC,IAAJ,GAAWC,WAAX,EAAZ;;AACA,MAAA,KAAI,CAACC,iCAAL,CACEJ,WADF,EAEE,MAFF,EAGE;AAAEK,QAAAA,OAAO,EAAEJ;AAAX,OAHF,EAIE,cAJF;;AAMA,aAAO,KAAI,CAACK,gBAAL,CAAsBN,WAAtB,EAAmC,MAAnC,CAAP;AAR6C;AAS9C;;AAEKO,EAAAA,YAAY,CAACP,WAAD,EAA+B;AAAA;;AAAA;AAC/C,MAAA,MAAI,CAACI,iCAAL,CACEJ,WADF,EAEE,QAFF,EAGE;AAAEK,QAAAA,OAAO,EAAE;AAAX,OAHF,EAIE,cAJF;;AAMA,aAAO,MAAI,CAACC,gBAAL,CAAsBN,WAAtB,EAAmC,QAAnC,CAAP;AAP+C;AAQhD;;AAEKQ,EAAAA,UAAU,CAACR,WAAD,EAA+B;AAAA;;AAAA;AAC7C,UAAMC,GAAG,GAAG,IAAIC,IAAJ,GAAWC,WAAX,EAAZ;;AACA,MAAA,MAAI,CAACC,iCAAL,CACEJ,WADF,EAEE,MAFF,EAGE;AAAES,QAAAA,OAAO,EAAER;AAAX,OAHF,EAIE,cAJF;;AAMA,aAAO,MAAI,CAACK,gBAAL,CAAsBN,WAAtB,EAAmC,MAAnC,CAAP;AAR6C;AAS9C;;AAEKU,EAAAA,YAAY,CAACV,WAAD,EAA+B;AAAA;;AAAA;AAC/C,MAAA,MAAI,CAACI,iCAAL,CACEJ,WADF,EAEE,QAFF,EAGE;AAAES,QAAAA,OAAO,EAAE;AAAX,OAHF,EAIE,cAJF;;AAMA,aAAO,MAAI,CAACH,gBAAL,CAAsBN,WAAtB,EAAmC,QAAnC,CAAP;AAP+C;AAQhD;AAED;AACF;AACA;AACA;AACA;AACA;;;AAGQW,EAAAA,cAAc,CAACX,WAAD,EAA+B;AAAA;;AAAA;AACjD,UAAM;AAAEF,QAAAA,QAAF;AAAYc,QAAAA;AAAZ,UAAyB,MAAI,CAACrC,KAApC;AACA,UAAMsC,KAAK,GAAGf,QAAQ,EAAtB;AACA,UAAMgB,iBAAiB,GAAG,MAAI,CAACnC,cAAL,CAAoBoC,gBAApB,KAAyC,IAAnE;AAEA,UAAMC,eAAe,GAAGC,KAAK,CAACC,OAAN,CAAclB,WAAd,IACpBA,WADoB,GAEpB,CAACA,WAAD,CAFJ;AAIA,UAAMmB,OAAiB,GAAGH,eAAe,CAACI,GAAhB,CAAqBC,IAAD,IAAUA,IAAI,CAACC,EAAnC,CAA1B,CATiD,CAWjD;AACA;;AACA,UAAMC,WAAW,GAAGP,eAAe,CAACQ,MAAhB,CAAwBC,CAAD,IAAO,CAACA,CAAC,CAACpB,OAAjC,EAA0CqB,MAA9D;AACA,UAAMC,WAAW,GAAGX,eAAe,CAACQ,MAAhB,CAAwBC,CAAD,IAAO,CAACA,CAAC,CAAChB,OAAjC,EAA0CiB,MAA9D,CAdiD,CAgBjD;;AACA,UAAME,IAAI,mCACLf,KAAK,CAACgB,QADD;AAERC,QAAAA,WAAW,EAAEjB,KAAK,CAACgB,QAAN,CAAeC,WAAf,GAA6Bd,eAAe,CAACU,MAFlD;AAGRK,QAAAA,YAAY,EAAElB,KAAK,CAACgB,QAAN,CAAeE,YAAf,GAA8BR,WAHpC;AAIRS,QAAAA,YAAY,EAAEnB,KAAK,CAACgB,QAAN,CAAeG,YAAf,GAA8BL;AAJpC,QAAV,CAjBiD,CAwBjD;;;AACA,UAAIb,iBAAJ,EAAuB;AACrB;AACA,YAAMmB,OAAO,GAAGpB,KAAK,CAACqB,KAAN,CAAYV,MAAZ,CAAoBH,IAAD,IAAU,CAACF,OAAO,CAAChC,QAAR,CAAiBkC,IAAI,CAACC,EAAtB,CAA9B,CAAhB;AAEAV,QAAAA,QAAQ,CAAEC,KAAD,IACPA,KAAK,CAACsB,SAAN,CAAgB;AAAEF,UAAAA,OAAF;AAAWL,UAAAA,IAAX;AAAiBQ,UAAAA,SAAS,EAAEvB,KAAK,CAACwB;AAAlC,SAAhB,CADM,CAAR;AAGD,OAPD,MAOO;AACLzB,QAAAA,QAAQ,CAAEC,KAAD,IAAW;AAClBA,UAAAA,KAAK,CAACyB,WAAN,CAAkBV,IAAlB;AACAf,UAAAA,KAAK,CAAC0B,YAAN,CAAmBpB,OAAnB,EAA4B;AAAEqB,YAAAA,WAAW,EAAE,IAAItC,IAAJ,GAAWC,WAAX;AAAf,WAA5B;AACD,SAHO,CAAR;AAID;;AAED,aAAO,MAAI,CAACG,gBAAL,CAAsBN,WAAtB,EAAmC,UAAnC,CAAP;AAvCiD;AAwClD;;AAEKyC,EAAAA,gBAAgB,CAACzC,WAAD,EAA+B;AAAA;;AAAA;AACnD,MAAA,MAAI,CAACI,iCAAL,CAAuCJ,WAAvC,EAAoD,YAApD,EAAkE;AAChEwC,QAAAA,WAAW,EAAE;AADmD,OAAlE;;AAGA,aAAO,MAAI,CAAClC,gBAAL,CAAsBN,WAAtB,EAAmC,YAAnC,CAAP;AAJmD;AAKpD;AAED;;;AACM0C,EAAAA,KAAK,GAAiC;AAAA;AAAA;;AAAA;AAAA,UAAhCxE,OAAgC,0EAAJ,EAAI;AAC1C,UAAM;AAAE0C,QAAAA,QAAF;AAAYd,QAAAA;AAAZ,UAAyB,MAAI,CAACvB,KAApC;AACA,UAAM;AAAEoE,QAAAA;AAAF,UAAoB7C,QAAQ,EAAlC,CAF0C,CAI1C;;AACA,UAAIlC,iBAAiB,CAAC+E,aAAD,CAArB,EAAsC;AACpC;AACD,OAPyC,CAS1C;;;AACA/B,MAAAA,QAAQ,CAAErC,KAAD;AAAA;;AAAA,eACPA,KAAK,CAACqE,gBAAN,0BAAuB1E,OAAO,CAAC2E,aAA/B,yEAAgDhF,aAAa,CAACiF,OAA9D,CADO;AAAA,OAAD,CAAR,CAV0C,CAc1C;;AACA,UAAMC,WAAW,mCAAQ,MAAI,CAACpE,cAAb,GAAgCT,OAAhC,CAAjB;;AAEA,UAAM8E,MAAM,SAAS,MAAI,CAAC7E,SAAL,CAAe8E,WAAf,CAA2B;AAC9CC,QAAAA,MAAM,EAAE,KADsC;AAE9CC,QAAAA,GAAG,sBAAe,MAAI,CAACnF,KAAL,CAAWoF,MAA1B,oBAA0C,MAAI,CAACnF,MAA/C,CAF2C;AAG9CoF,QAAAA,MAAM,EAAEN;AAHsC,OAA3B,CAArB;;AAMA,UAAIC,MAAM,CAACM,UAAP,KAAsB,OAAtB,IAAiC,CAACN,MAAM,CAACO,IAA7C,EAAmD;AACjD3C,QAAAA,QAAQ,CAAErC,KAAD,IAAWA,KAAK,CAACqE,gBAAN,CAAuB/E,aAAa,CAAC8B,KAArC,CAAZ,CAAR;AAEA,eAAO;AACL6D,UAAAA,MAAM,EAAER,MAAM,CAACM,UADV;AAELG,UAAAA,IAAI,EAAET,MAAM,CAACrD,KAAP,IAAgBqD,MAAM,CAACO;AAFxB,SAAP;AAID;;AAED,UAAMG,QAAQ,GAAG;AACfzB,QAAAA,OAAO,EAAEe,MAAM,CAACO,IAAP,CAAYtB,OADN;AAEfL,QAAAA,IAAI,EAAEoB,MAAM,CAACO,IAAP,CAAY3B,IAFH;AAGfQ,QAAAA,SAAS,EAAEY,MAAM,CAACO,IAAP,CAAYnB;AAHR,OAAjB;;AAMA,UAAIlE,OAAO,CAACyF,MAAZ,EAAoB;AAClB,YAAMC,IAAI,GAAG;AAAEC,UAAAA,aAAa,EAAE,KAAjB;AAAwBC,UAAAA,YAAY,EAAE;AAAtC,SAAb;AACAlD,QAAAA,QAAQ,CAAEC,KAAD,IAAWA,KAAK,CAACsB,SAAN,CAAgBuB,QAAhB,EAA0BE,IAA1B,CAAZ,CAAR;AACD,OAHD,MAGO,IAAI1F,OAAO,CAAC6F,KAAZ,EAAmB;AACxB,YAAMH,KAAI,GAAG;AAAEC,UAAAA,aAAa,EAAE,IAAjB;AAAuBC,UAAAA,YAAY,EAAE;AAArC,SAAb;AACAlD,QAAAA,QAAQ,CAAEC,KAAD,IAAWA,KAAK,CAACsB,SAAN,CAAgBuB,QAAhB,EAA0BE,KAA1B,CAAZ,CAAR;AACD,OAHM,MAGA;AACLhD,QAAAA,QAAQ,CAAEC,KAAD,IAAWA,KAAK,CAACsB,SAAN,CAAgBuB,QAAhB,CAAZ,CAAR;AACD,OA9CyC,CAgD1C;;;AACA,MAAA,MAAI,CAACM,SAAL,CAAe,cAAf,EAA+BN,QAA/B,EAjD0C,CAmD1C;;;AACA,UAAMO,aAAwB,GAC5B/F,OAAO,CAACgG,aAAR,KAA0B,QAA1B,GACI,yBADJ,GAEI,qBAHN;AAKA,UAAMC,YAAY,GAAG;AACnBjC,QAAAA,KAAK,EAAEwB,QAAQ,CAACzB,OADG;AAEnBJ,QAAAA,QAAQ,EAAE6B,QAAQ,CAAC9B,IAFA;AAGnBwC,QAAAA,KAAK,EAAEH;AAHY,OAArB;;AAMA,MAAA,MAAI,CAACD,SAAL,CAAeG,YAAY,CAACC,KAA5B,EAAmCD,YAAnC;;AAEA,aAAO;AAAEV,QAAAA,IAAI,EAAEC,QAAR;AAAkBF,QAAAA,MAAM,EAAER,MAAM,CAACM;AAAjC,OAAP;AAjE0C;AAkE3C;;AAEKe,EAAAA,aAAa,GAAG;AAAA;;AAAA;AACpB;AACA,UAAM;AAAEvE,QAAAA;AAAF,UAAe,MAAI,CAACvB,KAA1B;AACA,UAAM;AAAE8D,QAAAA;AAAF,UAAevC,QAAQ,EAA7B;;AAEA,UAAI,CAACuC,QAAQ,CAAC0B,KAAd,EAAqB;AACnB;AACA;AACD;;AAED,MAAA,MAAI,CAACrB,KAAL,CAAW;AACTqB,QAAAA,KAAK,EAAE1B,QAAQ,CAAC0B,KADP;AAETlB,QAAAA,aAAa,EAAEhF,aAAa,CAACyG;AAFpB,OAAX;AAVoB;AAcrB;;AAEON,EAAAA,SAAS,CACfpE,SADe,EAEf6D,IAFe,EAGf;AACA,SAAKjF,WAAL,CAAiB+F,IAAjB,CAAsB3E,SAAtB,EAAiC6D,IAAjC;AACD,GA5QQ,CA8QT;;;AACcjE,EAAAA,oBAAoB,OAEF;AAAA;;AAAA;AAAA,UAFG;AACjCqC,QAAAA;AADiC,OAEH;AAC9B;AACA,UAAM;AAAE/B,QAAAA,QAAF;AAAYc,QAAAA;AAAZ,UAAyB,MAAI,CAACrC,KAApC;AACA,UAAM;AAAE2D,QAAAA;AAAF,UAAYpC,QAAQ,EAA1B;AACA,UAAM0E,WAAiC,GAAGtC,KAAK,CAAC,CAAD,CAA/C,CAJ8B,CAK9B;;AACAtB,MAAAA,QAAQ,CAAEC,KAAD,IAAWA,KAAK,CAACyB,WAAN,CAAkBT,QAAlB,CAAZ,CAAR,CAN8B,CAO9B;;AACA,MAAA,MAAI,CAACa,KAAL,CAAW;AAAEiB,QAAAA,MAAM,EAAEa,WAAF,aAAEA,WAAF,uBAAEA,WAAW,CAAEC,QAAvB;AAAiCP,QAAAA,aAAa,EAAE;AAAhD,OAAX;AAR8B;AAS/B;;AAEO5F,EAAAA,eAAe,GAAG;AACxB,qBAAU,KAAKL,MAAf,cAAyB,KAAKD,KAAL,CAAWoF,MAApC;AACD;;AAEOhD,EAAAA,iCAAiC,CACvCJ,WADuC,EAEvC0E,IAFuC,EAGvCC,KAHuC,EAIvCC,cAJuC,EAKvC;AACA,QAAM;AAAE9E,MAAAA,QAAF;AAAYc,MAAAA;AAAZ,QAAyB,KAAKrC,KAApC;AACA,QAAM4C,OAAO,GAAGF,KAAK,CAACC,OAAN,CAAclB,WAAd,IACZA,WAAW,CAACoB,GAAZ,CAAiBC,IAAD,IAAUA,IAAI,CAACC,EAA/B,CADY,GAEZ,CAACtB,WAAW,CAACsB,EAAb,CAFJ;;AAIA,QAAIsD,cAAJ,EAAoB;AAClB,UAAM;AAAE/C,QAAAA;AAAF,UAAe/B,QAAQ,EAA7B,CADkB,CAGlB;AACA;;AACA,UAAM+E,SAAS,GAAGH,IAAI,CAACI,UAAL,CAAgB,IAAhB,IACd3D,OAAO,CAACO,MADM,GAEd,CAACP,OAAO,CAACO,MAFb;AAIAd,MAAAA,QAAQ,CAAErC,KAAD,IACPA,KAAK,CAAC+D,WAAN,iCACKT,QADL;AAEE,SAAC+C,cAAD,GAAkBG,IAAI,CAACC,GAAL,CAAS,CAAT,EAAYnD,QAAQ,CAAC+C,cAAD,CAAR,GAA2BC,SAAvC;AAFpB,SADM,CAAR;AAMD,KArBD,CAuBA;;;AACAjE,IAAAA,QAAQ,CAAErC,KAAD,IAAWA,KAAK,CAACgE,YAAN,CAAmBpB,OAAnB,EAA4BwD,KAA5B,CAAZ,CAAR;AACD;;AAEarE,EAAAA,gBAAgB,CAACN,WAAD,EAA+B0E,IAA/B,EAA6C;AAAA;;AAAA;AACzE;AACA,UAAIzD,KAAK,CAACC,OAAN,CAAclB,WAAd,CAAJ,EAAgC;AAC9B,YAAMmB,OAAO,GAAGnB,WAAW,CAACoB,GAAZ,CAAiBC,IAAD,IAAUA,IAAI,CAACC,EAA/B,CAAhB;AAEA,qBAAa,OAAI,CAACnD,SAAL,CAAe8E,WAAf,CAA2B;AACtCC,UAAAA,MAAM,EAAE,MAD8B;AAEtCC,UAAAA,GAAG,+BAAwBuB,IAAxB,CAFmC;AAGtCjB,UAAAA,IAAI,EAAE;AAAEwB,YAAAA,WAAW,EAAE9D;AAAf;AAHgC,SAA3B,CAAb;AAKD,OAVwE,CAYzE;;;AACA,UAAM6B,MAAM,SAAS,OAAI,CAAC7E,SAAL,CAAe8E,WAAf,CAA2B;AAC9CC,QAAAA,MAAM,EAAEwB,IAAI,CAACI,UAAL,CAAgB,IAAhB,IAAwB,QAAxB,GAAmC,KADG;AAE9C3B,QAAAA,GAAG,yBAAkBnD,WAAW,CAACsB,EAA9B,cAAoCoD,IAApC;AAF2C,OAA3B,CAArB;AAKA,aAAO1B,MAAP;AAlByE;AAmB1E;;AAnVQ;;AAsVX,eAAelF,IAAf","sourcesContent":["import { Channel } from \"phoenix\";\nimport { StoreApi } from \"zustand\";\nimport { EventEmitter2 as EventEmitter } from \"eventemitter2\";\nimport ApiClient from \"../../api\";\nimport createStore from \"./store\";\nimport {\n BindableFeedEvent,\n FeedMessagesReceivedPayload,\n FeedEventCallback,\n FeedEvent,\n FeedItemOrItems,\n FeedStoreState,\n FeedEventPayload,\n FeedRealTimeCallback,\n} from \"./types\";\nimport {\n FeedItem,\n FeedClientOptions,\n FetchFeedOptions,\n FeedResponse,\n FeedMetadata,\n} from \"./interfaces\";\nimport Knock from \"../../knock\";\nimport { isRequestInFlight, NetworkStatus } from \"../../networkStatus\";\n\nexport type Status =\n | \"seen\"\n | \"read\"\n | \"archived\"\n | \"unseen\"\n | \"unread\"\n | \"unarchived\";\n\nclass Feed {\n private apiClient: ApiClient;\n private userFeedId: string;\n private channel: Channel;\n private broadcaster: EventEmitter;\n private defaultOptions: FeedClientOptions;\n\n // The raw store instance, used for binding in React and other environments\n public store: StoreApi<FeedStoreState>;\n\n constructor(\n readonly knock: Knock,\n readonly feedId: string,\n options: FeedClientOptions,\n ) {\n this.apiClient = knock.client();\n this.feedId = feedId;\n this.userFeedId = this.buildUserFeedId();\n this.store = createStore();\n this.broadcaster = new EventEmitter({ wildcard: true, delimiter: \".\" });\n this.defaultOptions = options;\n\n // Try and connect to the socket\n this.apiClient.socket.connect();\n\n this.channel = this.apiClient.socket.channel(\n `feeds:${this.userFeedId}`,\n this.defaultOptions,\n );\n }\n\n /*\n Returns a socket to listen for feed updates\n */\n listenForUpdates() {\n try {\n this.channel.join();\n } catch (e) {\n // Phoenix raises an error when trying to call join more than once. Given calling listenForUpdates unintentionally\n // may happen fairly often, we choose to supress the error and print a warning.\n if (e.message.includes(\"join\")) {\n console.warn(e.message);\n } else {\n throw e;\n }\n }\n\n this.channel.on(\"new-message\", (resp) => this.onNewMessageReceived(resp));\n\n return () => {\n try {\n this.channel.leave();\n this.channel.off(\"new-message\")\n } catch (e) {\n // tslint:disable-next-line\n console.error(\"error while leaving channel\", e);\n }\n };\n }\n\n /* Binds a handler to be invoked when event occurs */\n on(\n eventName: BindableFeedEvent,\n callback: FeedEventCallback | FeedRealTimeCallback,\n ) {\n this.broadcaster.on(eventName, callback);\n }\n\n off(\n eventName: BindableFeedEvent,\n callback: FeedEventCallback | FeedRealTimeCallback,\n ) {\n this.broadcaster.off(eventName, callback);\n }\n\n getState() {\n return this.store.getState();\n }\n\n async markAsSeen(itemOrItems: FeedItemOrItems) {\n const now = new Date().toISOString();\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"seen\",\n { seen_at: now },\n \"unseen_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"seen\");\n }\n\n async markAsUnseen(itemOrItems: FeedItemOrItems) {\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"unseen\",\n { seen_at: null },\n \"unseen_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"unseen\");\n }\n\n async markAsRead(itemOrItems: FeedItemOrItems) {\n const now = new Date().toISOString();\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"read\",\n { read_at: now },\n \"unread_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"read\");\n }\n\n async markAsUnread(itemOrItems: FeedItemOrItems) {\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"unread\",\n { read_at: null },\n \"unread_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"unread\");\n }\n\n /*\n Marking one or more items as archived should:\n\n - Decrement the badge count for any unread / unseen items\n - Remove the item from the feed list, when the include_archived flag is not true)\n\n TODO: how do we handle rollbacks?\n */\n async markAsArchived(itemOrItems: FeedItemOrItems) {\n const { getState, setState } = this.store;\n const state = getState();\n const shouldRemoveItems = this.defaultOptions.include_archived !== true;\n\n const normalizedItems = Array.isArray(itemOrItems)\n ? itemOrItems\n : [itemOrItems];\n\n const itemIds: string[] = normalizedItems.map((item) => item.id);\n\n // If any of the items are unseen or unread, then capture as we'll want to decrement\n // the counts for these in the metadata we have\n const unseenCount = normalizedItems.filter((i) => !i.seen_at).length;\n const unreadCount = normalizedItems.filter((i) => !i.read_at).length;\n\n // Build the new metadata\n const meta = {\n ...state.metadata,\n total_count: state.metadata.total_count - normalizedItems.length,\n unseen_count: state.metadata.unseen_count - unseenCount,\n unread_count: state.metadata.unread_count - unreadCount,\n };\n\n // Perform optimistic updates on the items in the feed\n if (shouldRemoveItems) {\n // Filter the items out of the list\n const entries = state.items.filter((item) => !itemIds.includes(item.id));\n\n setState((state) =>\n state.setResult({ entries, meta, page_info: state.pageInfo }),\n );\n } else {\n setState((state) => {\n state.setMetadata(meta);\n state.setItemAttrs(itemIds, { archived_at: new Date().toISOString() });\n });\n }\n\n return this.makeStatusUpdate(itemOrItems, \"archived\");\n }\n\n async markAsUnarchived(itemOrItems: FeedItemOrItems) {\n this.optimisticallyPerformStatusUpdate(itemOrItems, \"unarchived\", {\n archived_at: null,\n });\n return this.makeStatusUpdate(itemOrItems, \"unarchived\");\n }\n\n /* Fetches the feed content, appending it to the store */\n async fetch(options: FetchFeedOptions = {}) {\n const { setState, getState } = this.store;\n const { networkStatus } = getState();\n\n // If there's an existing request in flight, then do nothing\n if (isRequestInFlight(networkStatus)) {\n return;\n }\n\n // Set the loading type based on the request type it is\n setState((store) =>\n store.setNetworkStatus(options.__loadingType ?? NetworkStatus.loading),\n );\n\n // Always include the default params, if they have been set\n const queryParams = { ...this.defaultOptions, ...options };\n\n const result = await this.apiClient.makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.knock.userId}/feeds/${this.feedId}`,\n params: queryParams,\n });\n\n if (result.statusCode === \"error\" || !result.body) {\n setState((store) => store.setNetworkStatus(NetworkStatus.error));\n\n return {\n status: result.statusCode,\n data: result.error || result.body,\n };\n }\n\n const response = {\n entries: result.body.entries,\n meta: result.body.meta,\n page_info: result.body.page_info,\n };\n\n if (options.before) {\n const opts = { shouldSetPage: false, shouldAppend: true };\n setState((state) => state.setResult(response, opts));\n } else if (options.after) {\n const opts = { shouldSetPage: true, shouldAppend: true };\n setState((state) => state.setResult(response, opts));\n } else {\n setState((state) => state.setResult(response));\n }\n\n // Legacy `messages.new` event, should be removed in a future version\n this.broadcast(\"messages.new\", response);\n\n // Broadcast the appropriate event type depending on the fetch source\n const feedEventType: FeedEvent =\n options.__fetchSource === \"socket\"\n ? \"items.received.realtime\"\n : \"items.received.page\";\n\n const eventPayload = {\n items: response.entries as FeedItem[],\n metadata: response.meta as FeedMetadata,\n event: feedEventType,\n };\n\n this.broadcast(eventPayload.event, eventPayload);\n\n return { data: response, status: result.statusCode };\n }\n\n async fetchNextPage() {\n // Attempts to fetch the next page of results (if we have any)\n const { getState } = this.store;\n const { pageInfo } = getState();\n\n if (!pageInfo.after) {\n // Nothing more to fetch\n return;\n }\n\n this.fetch({\n after: pageInfo.after,\n __loadingType: NetworkStatus.fetchMore,\n });\n }\n\n private broadcast(\n eventName: FeedEvent,\n data: FeedResponse | FeedEventPayload,\n ) {\n this.broadcaster.emit(eventName, data);\n }\n\n // Invoked when a new real-time message comes in from the socket\n private async onNewMessageReceived({\n metadata,\n }: FeedMessagesReceivedPayload) {\n // Handle the new message coming in\n const { getState, setState } = this.store;\n const { items } = getState();\n const currentHead: FeedItem | undefined = items[0];\n // Optimistically set the badge counts\n setState((state) => state.setMetadata(metadata));\n // Fetch the items before the current head (if it exists)\n this.fetch({ before: currentHead?.__cursor, __fetchSource: \"socket\" });\n }\n\n private buildUserFeedId() {\n return `${this.feedId}:${this.knock.userId}`;\n }\n\n private optimisticallyPerformStatusUpdate(\n itemOrItems: FeedItemOrItems,\n type: Status,\n attrs: object,\n badgeCountAttr?: \"unread_count\" | \"unseen_count\",\n ) {\n const { getState, setState } = this.store;\n const itemIds = Array.isArray(itemOrItems)\n ? itemOrItems.map((item) => item.id)\n : [itemOrItems.id];\n\n if (badgeCountAttr) {\n const { metadata } = getState();\n\n // Tnis is a hack to determine the direction of whether we're\n // adding or removing from the badge count\n const direction = type.startsWith(\"un\")\n ? itemIds.length\n : -itemIds.length;\n\n setState((store) =>\n store.setMetadata({\n ...metadata,\n [badgeCountAttr]: Math.max(0, metadata[badgeCountAttr] + direction),\n }),\n );\n }\n\n // Update the items with the given attributes\n setState((store) => store.setItemAttrs(itemIds, attrs));\n }\n\n private async makeStatusUpdate(itemOrItems: FeedItemOrItems, type: Status) {\n // If we're interacting with an array, then we want to send this as a batch\n if (Array.isArray(itemOrItems)) {\n const itemIds = itemOrItems.map((item) => item.id);\n\n return await this.apiClient.makeRequest({\n method: \"POST\",\n url: `/v1/messages/batch/${type}`,\n data: { message_ids: itemIds },\n });\n }\n\n // If its a single then we can just call the regular endpoint\n const result = await this.apiClient.makeRequest({\n method: type.startsWith(\"un\") ? \"DELETE\" : \"PUT\",\n url: `/v1/messages/${itemOrItems.id}/${type}`,\n });\n\n return result;\n }\n}\n\nexport default Feed;\n"],"file":"feed.js"}
1
+ {"version":3,"sources":["../../../../src/clients/feed/feed.ts"],"names":["EventEmitter2","EventEmitter","createStore","isRequestInFlight","NetworkStatus","feedClientDefaults","archived","Feed","constructor","knock","feedId","options","apiClient","client","userFeedId","buildUserFeedId","store","broadcaster","wildcard","delimiter","defaultOptions","channel","socket","on","resp","onNewMessageReceived","teardown","leave","removeAllListeners","off","destroy","listenForUpdates","isConnected","connect","includes","state","join","eventName","callback","getState","markAsSeen","itemOrItems","now","Date","toISOString","optimisticallyPerformStatusUpdate","seen_at","makeStatusUpdate","markAsUnseen","markAsRead","read_at","markAsUnread","markAsArchived","setState","shouldOptimisticallyRemoveItems","normalizedItems","Array","isArray","itemIds","map","item","id","unseenCount","filter","i","length","unreadCount","updatedMetadata","metadata","total_count","unseen_count","unread_count","entriesToSet","items","setResult","entries","meta","page_info","pageInfo","setItemAttrs","archived_at","markAsUnarchived","fetch","networkStatus","setNetworkStatus","__loadingType","loading","queryParams","result","makeRequest","method","url","userId","params","statusCode","body","error","status","data","response","before","opts","shouldSetPage","shouldAppend","after","broadcast","feedEventType","__fetchSource","eventPayload","event","fetchNextPage","fetchMore","emit","currentHead","setMetadata","__cursor","type","attrs","badgeCountAttr","direction","startsWith","Math","max","message_ids"],"mappings":";;;;;;;AAEA,SAASA,aAAa,IAAIC,YAA1B,QAA8C,eAA9C;AAEA,OAAOC,WAAP,MAAwB,SAAxB;AAmBA,SAASC,iBAAT,EAA4BC,aAA5B,QAAiD,qBAAjD;AAUA;AACA,IAAMC,kBAAuD,GAAG;AAC9DC,EAAAA,QAAQ,EAAE;AADoD,CAAhE;;AAIA,MAAMC,IAAN,CAAW;AAOT;AAGAC,EAAAA,WAAW,CACAC,KADA,EAEAC,MAFA,EAGTC,OAHS,EAIT;AAAA,SAHSF,KAGT,GAHSA,KAGT;AAAA,SAFSC,MAET,GAFSA,MAET;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AACA,SAAKE,SAAL,GAAiBH,KAAK,CAACI,MAAN,EAAjB;AACA,SAAKH,MAAL,GAAcA,MAAd;AACA,SAAKI,UAAL,GAAkB,KAAKC,eAAL,EAAlB;AACA,SAAKC,KAAL,GAAad,WAAW,EAAxB;AACA,SAAKe,WAAL,GAAmB,IAAIhB,YAAJ,CAAiB;AAAEiB,MAAAA,QAAQ,EAAE,IAAZ;AAAkBC,MAAAA,SAAS,EAAE;AAA7B,KAAjB,CAAnB;AACA,SAAKC,cAAL,mCAA2Bf,kBAA3B,GAAkDM,OAAlD;AAEA,SAAKU,OAAL,GAAe,KAAKT,SAAL,CAAeU,MAAf,CAAsBD,OAAtB,iBACJ,KAAKP,UADD,GAEb,KAAKM,cAFQ,CAAf;AAKA,SAAKC,OAAL,CAAaE,EAAb,CAAgB,aAAhB,EAAgCC,IAAD,IAAU,KAAKC,oBAAL,CAA0BD,IAA1B,CAAzC;AACD;AAED;AACF;AACA;AACA;;;AACEE,EAAAA,QAAQ,GAAG;AACT,SAAKL,OAAL,CAAaM,KAAb;AACA,SAAKV,WAAL,CAAiBW,kBAAjB;AACA,SAAKP,OAAL,CAAaQ,GAAb,CAAiB,aAAjB;AACA,SAAKb,KAAL,CAAWc,OAAX;AACD;AAED;AACF;AACA;AACA;;;AACEC,EAAAA,gBAAgB,GAAG;AACjB;AACA,QAAI,CAAC,KAAKnB,SAAL,CAAeU,MAAf,CAAsBU,WAAtB,EAAL,EAA0C;AACxC,WAAKpB,SAAL,CAAeU,MAAf,CAAsBW,OAAtB;AACD,KAJgB,CAMjB;;;AACA,QAAI,CAAC,QAAD,EAAW,SAAX,EAAsBC,QAAtB,CAA+B,KAAKb,OAAL,CAAac,KAA5C,CAAJ,EAAwD;AACtD,WAAKd,OAAL,CAAae,IAAb;AACD;AACF;AAED;;;AACAb,EAAAA,EAAE,CACAc,SADA,EAEAC,QAFA,EAGA;AACA,SAAKrB,WAAL,CAAiBM,EAAjB,CAAoBc,SAApB,EAA+BC,QAA/B;AACD;;AAEDT,EAAAA,GAAG,CACDQ,SADC,EAEDC,QAFC,EAGD;AACA,SAAKrB,WAAL,CAAiBY,GAAjB,CAAqBQ,SAArB,EAAgCC,QAAhC;AACD;;AAEDC,EAAAA,QAAQ,GAAG;AACT,WAAO,KAAKvB,KAAL,CAAWuB,QAAX,EAAP;AACD;;AAEKC,EAAAA,UAAU,CAACC,WAAD,EAA+B;AAAA;;AAAA;AAC7C,UAAMC,GAAG,GAAG,IAAIC,IAAJ,GAAWC,WAAX,EAAZ;;AACA,MAAA,KAAI,CAACC,iCAAL,CACEJ,WADF,EAEE,MAFF,EAGE;AAAEK,QAAAA,OAAO,EAAEJ;AAAX,OAHF,EAIE,cAJF;;AAMA,aAAO,KAAI,CAACK,gBAAL,CAAsBN,WAAtB,EAAmC,MAAnC,CAAP;AAR6C;AAS9C;;AAEKO,EAAAA,YAAY,CAACP,WAAD,EAA+B;AAAA;;AAAA;AAC/C,MAAA,MAAI,CAACI,iCAAL,CACEJ,WADF,EAEE,QAFF,EAGE;AAAEK,QAAAA,OAAO,EAAE;AAAX,OAHF,EAIE,cAJF;;AAMA,aAAO,MAAI,CAACC,gBAAL,CAAsBN,WAAtB,EAAmC,QAAnC,CAAP;AAP+C;AAQhD;;AAEKQ,EAAAA,UAAU,CAACR,WAAD,EAA+B;AAAA;;AAAA;AAC7C,UAAMC,GAAG,GAAG,IAAIC,IAAJ,GAAWC,WAAX,EAAZ;;AACA,MAAA,MAAI,CAACC,iCAAL,CACEJ,WADF,EAEE,MAFF,EAGE;AAAES,QAAAA,OAAO,EAAER;AAAX,OAHF,EAIE,cAJF;;AAMA,aAAO,MAAI,CAACK,gBAAL,CAAsBN,WAAtB,EAAmC,MAAnC,CAAP;AAR6C;AAS9C;;AAEKU,EAAAA,YAAY,CAACV,WAAD,EAA+B;AAAA;;AAAA;AAC/C,MAAA,MAAI,CAACI,iCAAL,CACEJ,WADF,EAEE,QAFF,EAGE;AAAES,QAAAA,OAAO,EAAE;AAAX,OAHF,EAIE,cAJF;;AAMA,aAAO,MAAI,CAACH,gBAAL,CAAsBN,WAAtB,EAAmC,QAAnC,CAAP;AAP+C;AAQhD;AAED;AACF;AACA;AACA;AACA;AACA;;;AAGQW,EAAAA,cAAc,CAACX,WAAD,EAA+B;AAAA;;AAAA;AACjD,UAAM;AAAEF,QAAAA,QAAF;AAAYc,QAAAA;AAAZ,UAAyB,MAAI,CAACrC,KAApC;AACA,UAAMmB,KAAK,GAAGI,QAAQ,EAAtB;AAEA,UAAMe,+BAA+B,GACnC,MAAI,CAAClC,cAAL,CAAoBd,QAApB,KAAiC,SADnC;AAGA,UAAMiD,eAAe,GAAGC,KAAK,CAACC,OAAN,CAAchB,WAAd,IACpBA,WADoB,GAEpB,CAACA,WAAD,CAFJ;AAIA,UAAMiB,OAAiB,GAAGH,eAAe,CAACI,GAAhB,CAAqBC,IAAD,IAAUA,IAAI,CAACC,EAAnC,CAA1B;AAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASI,UAAIP,+BAAJ,EAAqC;AACnC;AACA;AACA,YAAMQ,WAAW,GAAGP,eAAe,CAACQ,MAAhB,CAAwBC,CAAD,IAAO,CAACA,CAAC,CAAClB,OAAjC,EAA0CmB,MAA9D;AACA,YAAMC,WAAW,GAAGX,eAAe,CAACQ,MAAhB,CAAwBC,CAAD,IAAO,CAACA,CAAC,CAACd,OAAjC,EAA0Ce,MAA9D,CAJmC,CAMnC;;AACA,YAAME,eAAe,mCAChBhC,KAAK,CAACiC,QADU;AAEnBC,UAAAA,WAAW,EAAElC,KAAK,CAACiC,QAAN,CAAeC,WAAf,GAA6Bd,eAAe,CAACU,MAFvC;AAGnBK,UAAAA,YAAY,EAAEnC,KAAK,CAACiC,QAAN,CAAeE,YAAf,GAA8BR,WAHzB;AAInBS,UAAAA,YAAY,EAAEpC,KAAK,CAACiC,QAAN,CAAeG,YAAf,GAA8BL;AAJzB,UAArB,CAPmC,CAcnC;;;AACA,YAAMM,YAAY,GAAGrC,KAAK,CAACsC,KAAN,CAAYV,MAAZ,CAClBH,IAAD,IAAU,CAACF,OAAO,CAACxB,QAAR,CAAiB0B,IAAI,CAACC,EAAtB,CADQ,CAArB;AAIAR,QAAAA,QAAQ,CAAElB,KAAD,IACPA,KAAK,CAACuC,SAAN,CAAgB;AACdC,UAAAA,OAAO,EAAEH,YADK;AAEdI,UAAAA,IAAI,EAAET,eAFQ;AAGdU,UAAAA,SAAS,EAAE1C,KAAK,CAAC2C;AAHH,SAAhB,CADM,CAAR;AAOD,OA1BD,MA0BO;AACL;AACA3C,QAAAA,KAAK,CAAC4C,YAAN,CAAmBrB,OAAnB,EAA4B;AAAEsB,UAAAA,WAAW,EAAE,IAAIrC,IAAJ,GAAWC,WAAX;AAAf,SAA5B;AACD;;AAED,aAAO,MAAI,CAACG,gBAAL,CAAsBN,WAAtB,EAAmC,UAAnC,CAAP;AAvEiD;AAwElD;;AAEKwC,EAAAA,gBAAgB,CAACxC,WAAD,EAA+B;AAAA;;AAAA;AACnD,MAAA,MAAI,CAACI,iCAAL,CAAuCJ,WAAvC,EAAoD,YAApD,EAAkE;AAChEuC,QAAAA,WAAW,EAAE;AADmD,OAAlE;;AAGA,aAAO,MAAI,CAACjC,gBAAL,CAAsBN,WAAtB,EAAmC,YAAnC,CAAP;AAJmD;AAKpD;AAED;;;AACMyC,EAAAA,KAAK,GAAiC;AAAA;AAAA;;AAAA;AAAA,UAAhCvE,OAAgC,0EAAJ,EAAI;AAC1C,UAAM;AAAE0C,QAAAA,QAAF;AAAYd,QAAAA;AAAZ,UAAyB,MAAI,CAACvB,KAApC;AACA,UAAM;AAAEmE,QAAAA;AAAF,UAAoB5C,QAAQ,EAAlC,CAF0C,CAI1C;;AACA,UAAIpC,iBAAiB,CAACgF,aAAD,CAArB,EAAsC;AACpC;AACD,OAPyC,CAS1C;;;AACA9B,MAAAA,QAAQ,CAAErC,KAAD;AAAA;;AAAA,eACPA,KAAK,CAACoE,gBAAN,0BAAuBzE,OAAO,CAAC0E,aAA/B,yEAAgDjF,aAAa,CAACkF,OAA9D,CADO;AAAA,OAAD,CAAR,CAV0C,CAc1C;;AACA,UAAMC,WAAW,mCAAQ,MAAI,CAACnE,cAAb,GAAgCT,OAAhC,CAAjB;;AAEA,UAAM6E,MAAM,SAAS,MAAI,CAAC5E,SAAL,CAAe6E,WAAf,CAA2B;AAC9CC,QAAAA,MAAM,EAAE,KADsC;AAE9CC,QAAAA,GAAG,sBAAe,MAAI,CAAClF,KAAL,CAAWmF,MAA1B,oBAA0C,MAAI,CAAClF,MAA/C,CAF2C;AAG9CmF,QAAAA,MAAM,EAAEN;AAHsC,OAA3B,CAArB;;AAMA,UAAIC,MAAM,CAACM,UAAP,KAAsB,OAAtB,IAAiC,CAACN,MAAM,CAACO,IAA7C,EAAmD;AACjD1C,QAAAA,QAAQ,CAAErC,KAAD,IAAWA,KAAK,CAACoE,gBAAN,CAAuBhF,aAAa,CAAC4F,KAArC,CAAZ,CAAR;AAEA,eAAO;AACLC,UAAAA,MAAM,EAAET,MAAM,CAACM,UADV;AAELI,UAAAA,IAAI,EAAEV,MAAM,CAACQ,KAAP,IAAgBR,MAAM,CAACO;AAFxB,SAAP;AAID;;AAED,UAAMI,QAAQ,GAAG;AACfxB,QAAAA,OAAO,EAAEa,MAAM,CAACO,IAAP,CAAYpB,OADN;AAEfC,QAAAA,IAAI,EAAEY,MAAM,CAACO,IAAP,CAAYnB,IAFH;AAGfC,QAAAA,SAAS,EAAEW,MAAM,CAACO,IAAP,CAAYlB;AAHR,OAAjB;;AAMA,UAAIlE,OAAO,CAACyF,MAAZ,EAAoB;AAClB,YAAMC,IAAI,GAAG;AAAEC,UAAAA,aAAa,EAAE,KAAjB;AAAwBC,UAAAA,YAAY,EAAE;AAAtC,SAAb;AACAlD,QAAAA,QAAQ,CAAElB,KAAD,IAAWA,KAAK,CAACuC,SAAN,CAAgByB,QAAhB,EAA0BE,IAA1B,CAAZ,CAAR;AACD,OAHD,MAGO,IAAI1F,OAAO,CAAC6F,KAAZ,EAAmB;AACxB,YAAMH,KAAI,GAAG;AAAEC,UAAAA,aAAa,EAAE,IAAjB;AAAuBC,UAAAA,YAAY,EAAE;AAArC,SAAb;AACAlD,QAAAA,QAAQ,CAAElB,KAAD,IAAWA,KAAK,CAACuC,SAAN,CAAgByB,QAAhB,EAA0BE,KAA1B,CAAZ,CAAR;AACD,OAHM,MAGA;AACLhD,QAAAA,QAAQ,CAAElB,KAAD,IAAWA,KAAK,CAACuC,SAAN,CAAgByB,QAAhB,CAAZ,CAAR;AACD,OA9CyC,CAgD1C;;;AACA,MAAA,MAAI,CAACM,SAAL,CAAe,cAAf,EAA+BN,QAA/B,EAjD0C,CAmD1C;;;AACA,UAAMO,aAAwB,GAC5B/F,OAAO,CAACgG,aAAR,KAA0B,QAA1B,GACI,yBADJ,GAEI,qBAHN;AAKA,UAAMC,YAAY,GAAG;AACnBnC,QAAAA,KAAK,EAAE0B,QAAQ,CAACxB,OADG;AAEnBP,QAAAA,QAAQ,EAAE+B,QAAQ,CAACvB,IAFA;AAGnBiC,QAAAA,KAAK,EAAEH;AAHY,OAArB;;AAMA,MAAA,MAAI,CAACD,SAAL,CAAeG,YAAY,CAACC,KAA5B,EAAmCD,YAAnC;;AAEA,aAAO;AAAEV,QAAAA,IAAI,EAAEC,QAAR;AAAkBF,QAAAA,MAAM,EAAET,MAAM,CAACM;AAAjC,OAAP;AAjE0C;AAkE3C;;AAEKgB,EAAAA,aAAa,GAAG;AAAA;;AAAA;AACpB;AACA,UAAM;AAAEvE,QAAAA;AAAF,UAAe,MAAI,CAACvB,KAA1B;AACA,UAAM;AAAE8D,QAAAA;AAAF,UAAevC,QAAQ,EAA7B;;AAEA,UAAI,CAACuC,QAAQ,CAAC0B,KAAd,EAAqB;AACnB;AACA;AACD;;AAED,MAAA,MAAI,CAACtB,KAAL,CAAW;AACTsB,QAAAA,KAAK,EAAE1B,QAAQ,CAAC0B,KADP;AAETnB,QAAAA,aAAa,EAAEjF,aAAa,CAAC2G;AAFpB,OAAX;AAVoB;AAcrB;;AAEON,EAAAA,SAAS,CACfpE,SADe,EAEf6D,IAFe,EAGf;AACA,SAAKjF,WAAL,CAAiB+F,IAAjB,CAAsB3E,SAAtB,EAAiC6D,IAAjC;AACD,GAzSQ,CA2ST;;;AACczE,EAAAA,oBAAoB,OAEF;AAAA;;AAAA;AAAA,UAFG;AACjC2C,QAAAA;AADiC,OAEH;AAC9B;AACA,UAAM;AAAE7B,QAAAA,QAAF;AAAYc,QAAAA;AAAZ,UAAyB,MAAI,CAACrC,KAApC;AACA,UAAM;AAAEyD,QAAAA;AAAF,UAAYlC,QAAQ,EAA1B;AACA,UAAM0E,WAAiC,GAAGxC,KAAK,CAAC,CAAD,CAA/C,CAJ8B,CAK9B;;AACApB,MAAAA,QAAQ,CAAElB,KAAD,IAAWA,KAAK,CAAC+E,WAAN,CAAkB9C,QAAlB,CAAZ,CAAR,CAN8B,CAO9B;;AACA,MAAA,MAAI,CAACc,KAAL,CAAW;AAAEkB,QAAAA,MAAM,EAAEa,WAAF,aAAEA,WAAF,uBAAEA,WAAW,CAAEE,QAAvB;AAAiCR,QAAAA,aAAa,EAAE;AAAhD,OAAX;AAR8B;AAS/B;;AAEO5F,EAAAA,eAAe,GAAG;AACxB,qBAAU,KAAKL,MAAf,cAAyB,KAAKD,KAAL,CAAWmF,MAApC;AACD;;AAEO/C,EAAAA,iCAAiC,CACvCJ,WADuC,EAEvC2E,IAFuC,EAGvCC,KAHuC,EAIvCC,cAJuC,EAKvC;AACA,QAAM;AAAE/E,MAAAA,QAAF;AAAYc,MAAAA;AAAZ,QAAyB,KAAKrC,KAApC;AACA,QAAM0C,OAAO,GAAGF,KAAK,CAACC,OAAN,CAAchB,WAAd,IACZA,WAAW,CAACkB,GAAZ,CAAiBC,IAAD,IAAUA,IAAI,CAACC,EAA/B,CADY,GAEZ,CAACpB,WAAW,CAACoB,EAAb,CAFJ;;AAIA,QAAIyD,cAAJ,EAAoB;AAClB,UAAM;AAAElD,QAAAA;AAAF,UAAe7B,QAAQ,EAA7B,CADkB,CAGlB;AACA;;AACA,UAAMgF,SAAS,GAAGH,IAAI,CAACI,UAAL,CAAgB,IAAhB,IACd9D,OAAO,CAACO,MADM,GAEd,CAACP,OAAO,CAACO,MAFb;AAIAZ,MAAAA,QAAQ,CAAErC,KAAD,IACPA,KAAK,CAACkG,WAAN,iCACK9C,QADL;AAEE,SAACkD,cAAD,GAAkBG,IAAI,CAACC,GAAL,CAAS,CAAT,EAAYtD,QAAQ,CAACkD,cAAD,CAAR,GAA2BC,SAAvC;AAFpB,SADM,CAAR;AAMD,KArBD,CAuBA;;;AACAlE,IAAAA,QAAQ,CAAErC,KAAD,IAAWA,KAAK,CAAC+D,YAAN,CAAmBrB,OAAnB,EAA4B2D,KAA5B,CAAZ,CAAR;AACD;;AAEatE,EAAAA,gBAAgB,CAACN,WAAD,EAA+B2E,IAA/B,EAA6C;AAAA;;AAAA;AACzE;AACA,UAAI5D,KAAK,CAACC,OAAN,CAAchB,WAAd,CAAJ,EAAgC;AAC9B,YAAMiB,OAAO,GAAGjB,WAAW,CAACkB,GAAZ,CAAiBC,IAAD,IAAUA,IAAI,CAACC,EAA/B,CAAhB;AAEA,qBAAa,OAAI,CAACjD,SAAL,CAAe6E,WAAf,CAA2B;AACtCC,UAAAA,MAAM,EAAE,MAD8B;AAEtCC,UAAAA,GAAG,+BAAwByB,IAAxB,CAFmC;AAGtClB,UAAAA,IAAI,EAAE;AAAEyB,YAAAA,WAAW,EAAEjE;AAAf;AAHgC,SAA3B,CAAb;AAKD,OAVwE,CAYzE;;;AACA,UAAM8B,MAAM,SAAS,OAAI,CAAC5E,SAAL,CAAe6E,WAAf,CAA2B;AAC9CC,QAAAA,MAAM,EAAE0B,IAAI,CAACI,UAAL,CAAgB,IAAhB,IAAwB,QAAxB,GAAmC,KADG;AAE9C7B,QAAAA,GAAG,yBAAkBlD,WAAW,CAACoB,EAA9B,cAAoCuD,IAApC;AAF2C,OAA3B,CAArB;AAKA,aAAO5B,MAAP;AAlByE;AAmB1E;;AAhXQ;;AAmXX,eAAejF,IAAf","sourcesContent":["import { Channel } from \"phoenix\";\nimport { StoreApi } from \"zustand\";\nimport { EventEmitter2 as EventEmitter } from \"eventemitter2\";\nimport ApiClient from \"../../api\";\nimport createStore from \"./store\";\nimport {\n BindableFeedEvent,\n FeedMessagesReceivedPayload,\n FeedEventCallback,\n FeedEvent,\n FeedItemOrItems,\n FeedStoreState,\n FeedEventPayload,\n FeedRealTimeCallback,\n} from \"./types\";\nimport {\n FeedItem,\n FeedClientOptions,\n FetchFeedOptions,\n FeedResponse,\n FeedMetadata,\n} from \"./interfaces\";\nimport Knock from \"../../knock\";\nimport { isRequestInFlight, NetworkStatus } from \"../../networkStatus\";\n\nexport type Status =\n | \"seen\"\n | \"read\"\n | \"archived\"\n | \"unseen\"\n | \"unread\"\n | \"unarchived\";\n\n// Default options to apply\nconst feedClientDefaults: Pick<FeedClientOptions, \"archived\"> = {\n archived: \"exclude\",\n};\n\nclass Feed {\n private apiClient: ApiClient;\n private userFeedId: string;\n private channel: Channel;\n private broadcaster: EventEmitter;\n private defaultOptions: FeedClientOptions;\n\n // The raw store instance, used for binding in React and other environments\n public store: StoreApi<FeedStoreState>;\n\n constructor(\n readonly knock: Knock,\n readonly feedId: string,\n options: FeedClientOptions,\n ) {\n this.apiClient = knock.client();\n this.feedId = feedId;\n this.userFeedId = this.buildUserFeedId();\n this.store = createStore();\n this.broadcaster = new EventEmitter({ wildcard: true, delimiter: \".\" });\n this.defaultOptions = { ...feedClientDefaults, ...options };\n\n this.channel = this.apiClient.socket.channel(\n `feeds:${this.userFeedId}`,\n this.defaultOptions,\n );\n\n this.channel.on(\"new-message\", (resp) => this.onNewMessageReceived(resp));\n }\n\n /**\n * Cleans up a feed instance by destroying the store and disconnecting\n * an open socket connection.\n */\n teardown() {\n this.channel.leave();\n this.broadcaster.removeAllListeners();\n this.channel.off(\"new-message\");\n this.store.destroy();\n }\n\n /*\n Initializes a real-time connection to Knock, connecting the websocket for the\n current ApiClient instance if the socket is not already connected.\n */\n listenForUpdates() {\n // Connect the socket only if we don't already have a connection\n if (!this.apiClient.socket.isConnected()) {\n this.apiClient.socket.connect();\n }\n\n // Only join the channel if we're not already in a joining state\n if ([\"closed\", \"errored\"].includes(this.channel.state)) {\n this.channel.join();\n }\n }\n\n /* Binds a handler to be invoked when event occurs */\n on(\n eventName: BindableFeedEvent,\n callback: FeedEventCallback | FeedRealTimeCallback,\n ) {\n this.broadcaster.on(eventName, callback);\n }\n\n off(\n eventName: BindableFeedEvent,\n callback: FeedEventCallback | FeedRealTimeCallback,\n ) {\n this.broadcaster.off(eventName, callback);\n }\n\n getState() {\n return this.store.getState();\n }\n\n async markAsSeen(itemOrItems: FeedItemOrItems) {\n const now = new Date().toISOString();\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"seen\",\n { seen_at: now },\n \"unseen_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"seen\");\n }\n\n async markAsUnseen(itemOrItems: FeedItemOrItems) {\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"unseen\",\n { seen_at: null },\n \"unseen_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"unseen\");\n }\n\n async markAsRead(itemOrItems: FeedItemOrItems) {\n const now = new Date().toISOString();\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"read\",\n { read_at: now },\n \"unread_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"read\");\n }\n\n async markAsUnread(itemOrItems: FeedItemOrItems) {\n this.optimisticallyPerformStatusUpdate(\n itemOrItems,\n \"unread\",\n { read_at: null },\n \"unread_count\",\n );\n return this.makeStatusUpdate(itemOrItems, \"unread\");\n }\n\n /*\n Marking one or more items as archived should:\n\n - Decrement the badge count for any unread / unseen items\n - Remove the item from the feed list when the `archived` flag is \"exclude\" (default)\n\n TODO: how do we handle rollbacks?\n */\n async markAsArchived(itemOrItems: FeedItemOrItems) {\n const { getState, setState } = this.store;\n const state = getState();\n\n const shouldOptimisticallyRemoveItems =\n this.defaultOptions.archived === \"exclude\";\n\n const normalizedItems = Array.isArray(itemOrItems)\n ? itemOrItems\n : [itemOrItems];\n\n const itemIds: string[] = normalizedItems.map((item) => item.id);\n\n /*\n In the proceeding code here we want to optimistically update counts and items\n that are persisted such that we can display updates immediately on the feed\n without needing to make a network request.\n\n Note: right now this does *not* take into account offline handling or any extensive retry\n logic, so rollbacks aren't considered. That probably needs to be a future consideration for\n this library.\n\n Scenarios to consider:\n\n ## Feed scope to archived *only* \n\n - Counts should not be decremented\n - Items should not be removed\n\n ## Feed scoped to exclude archived items (the default)\n \n - Counts should be decremented\n - Items should be removed\n\n ## Feed scoped to include archived items as well\n\n - Counts should not be decremented\n - Items should not be removed\n */\n\n if (shouldOptimisticallyRemoveItems) {\n // If any of the items are unseen or unread, then capture as we'll want to decrement\n // the counts for these in the metadata we have\n const unseenCount = normalizedItems.filter((i) => !i.seen_at).length;\n const unreadCount = normalizedItems.filter((i) => !i.read_at).length;\n\n // Build the new metadata\n const updatedMetadata = {\n ...state.metadata,\n total_count: state.metadata.total_count - normalizedItems.length,\n unseen_count: state.metadata.unseen_count - unseenCount,\n unread_count: state.metadata.unread_count - unreadCount,\n };\n\n // Remove the archiving entries\n const entriesToSet = state.items.filter(\n (item) => !itemIds.includes(item.id),\n );\n\n setState((state) =>\n state.setResult({\n entries: entriesToSet,\n meta: updatedMetadata,\n page_info: state.pageInfo,\n }),\n );\n } else {\n // Mark all the entries being updated as archived either way so the state is correct\n state.setItemAttrs(itemIds, { archived_at: new Date().toISOString() });\n }\n\n return this.makeStatusUpdate(itemOrItems, \"archived\");\n }\n\n async markAsUnarchived(itemOrItems: FeedItemOrItems) {\n this.optimisticallyPerformStatusUpdate(itemOrItems, \"unarchived\", {\n archived_at: null,\n });\n return this.makeStatusUpdate(itemOrItems, \"unarchived\");\n }\n\n /* Fetches the feed content, appending it to the store */\n async fetch(options: FetchFeedOptions = {}) {\n const { setState, getState } = this.store;\n const { networkStatus } = getState();\n\n // If there's an existing request in flight, then do nothing\n if (isRequestInFlight(networkStatus)) {\n return;\n }\n\n // Set the loading type based on the request type it is\n setState((store) =>\n store.setNetworkStatus(options.__loadingType ?? NetworkStatus.loading),\n );\n\n // Always include the default params, if they have been set\n const queryParams = { ...this.defaultOptions, ...options };\n\n const result = await this.apiClient.makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.knock.userId}/feeds/${this.feedId}`,\n params: queryParams,\n });\n\n if (result.statusCode === \"error\" || !result.body) {\n setState((store) => store.setNetworkStatus(NetworkStatus.error));\n\n return {\n status: result.statusCode,\n data: result.error || result.body,\n };\n }\n\n const response = {\n entries: result.body.entries,\n meta: result.body.meta,\n page_info: result.body.page_info,\n };\n\n if (options.before) {\n const opts = { shouldSetPage: false, shouldAppend: true };\n setState((state) => state.setResult(response, opts));\n } else if (options.after) {\n const opts = { shouldSetPage: true, shouldAppend: true };\n setState((state) => state.setResult(response, opts));\n } else {\n setState((state) => state.setResult(response));\n }\n\n // Legacy `messages.new` event, should be removed in a future version\n this.broadcast(\"messages.new\", response);\n\n // Broadcast the appropriate event type depending on the fetch source\n const feedEventType: FeedEvent =\n options.__fetchSource === \"socket\"\n ? \"items.received.realtime\"\n : \"items.received.page\";\n\n const eventPayload = {\n items: response.entries as FeedItem[],\n metadata: response.meta as FeedMetadata,\n event: feedEventType,\n };\n\n this.broadcast(eventPayload.event, eventPayload);\n\n return { data: response, status: result.statusCode };\n }\n\n async fetchNextPage() {\n // Attempts to fetch the next page of results (if we have any)\n const { getState } = this.store;\n const { pageInfo } = getState();\n\n if (!pageInfo.after) {\n // Nothing more to fetch\n return;\n }\n\n this.fetch({\n after: pageInfo.after,\n __loadingType: NetworkStatus.fetchMore,\n });\n }\n\n private broadcast(\n eventName: FeedEvent,\n data: FeedResponse | FeedEventPayload,\n ) {\n this.broadcaster.emit(eventName, data);\n }\n\n // Invoked when a new real-time message comes in from the socket\n private async onNewMessageReceived({\n metadata,\n }: FeedMessagesReceivedPayload) {\n // Handle the new message coming in\n const { getState, setState } = this.store;\n const { items } = getState();\n const currentHead: FeedItem | undefined = items[0];\n // Optimistically set the badge counts\n setState((state) => state.setMetadata(metadata));\n // Fetch the items before the current head (if it exists)\n this.fetch({ before: currentHead?.__cursor, __fetchSource: \"socket\" });\n }\n\n private buildUserFeedId() {\n return `${this.feedId}:${this.knock.userId}`;\n }\n\n private optimisticallyPerformStatusUpdate(\n itemOrItems: FeedItemOrItems,\n type: Status,\n attrs: object,\n badgeCountAttr?: \"unread_count\" | \"unseen_count\",\n ) {\n const { getState, setState } = this.store;\n const itemIds = Array.isArray(itemOrItems)\n ? itemOrItems.map((item) => item.id)\n : [itemOrItems.id];\n\n if (badgeCountAttr) {\n const { metadata } = getState();\n\n // Tnis is a hack to determine the direction of whether we're\n // adding or removing from the badge count\n const direction = type.startsWith(\"un\")\n ? itemIds.length\n : -itemIds.length;\n\n setState((store) =>\n store.setMetadata({\n ...metadata,\n [badgeCountAttr]: Math.max(0, metadata[badgeCountAttr] + direction),\n }),\n );\n }\n\n // Update the items with the given attributes\n setState((store) => store.setItemAttrs(itemIds, attrs));\n }\n\n private async makeStatusUpdate(itemOrItems: FeedItemOrItems, type: Status) {\n // If we're interacting with an array, then we want to send this as a batch\n if (Array.isArray(itemOrItems)) {\n const itemIds = itemOrItems.map((item) => item.id);\n\n return await this.apiClient.makeRequest({\n method: \"POST\",\n url: `/v1/messages/batch/${type}`,\n data: { message_ids: itemIds },\n });\n }\n\n // If its a single then we can just call the regular endpoint\n const result = await this.apiClient.makeRequest({\n method: type.startsWith(\"un\") ? \"DELETE\" : \"PUT\",\n url: `/v1/messages/${itemOrItems.id}/${type}`,\n });\n\n return result;\n }\n}\n\nexport default Feed;\n"],"file":"feed.js"}
package/dist/esm/knock.js CHANGED
@@ -58,10 +58,7 @@ class Knock {
58
58
 
59
59
 
60
60
  teardown() {
61
- if (!this.apiClient) {
62
- return;
63
- }
64
-
61
+ if (!this.apiClient) return;
65
62
  this.apiClient.socket.disconnect();
66
63
  }
67
64
 
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/knock.ts"],"names":["ApiClient","FeedClient","Preferences","DEFAULT_HOST","Knock","constructor","apiKey","options","host","startsWith","Error","client","userId","userToken","console","warn","apiClient","authenticate","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;;AAAA,uCAN3B,IAM2B;;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,MAAN,IAAgB,CAAC,KAAKC,SAA1B,EAAqC;AACnCC,MAAAA,OAAO,CAACC,IAAR;AAOD,KATM,CAWP;;;AACA,QAAI,CAAC,KAAKC,SAAV,EAAqB;AACnB,WAAKA,SAAL,GAAiB,IAAIhB,SAAJ,CAAc;AAC7BM,QAAAA,MAAM,EAAE,KAAKA,MADgB;AAE7BE,QAAAA,IAAI,EAAE,KAAKA,IAFkB;AAG7BK,QAAAA,SAAS,EAAE,KAAKA;AAHa,OAAd,CAAjB;AAKD;;AAED,WAAO,KAAKG,SAAZ;AACD;AAED;AACF;AACA;AACA;;;AACEC,EAAAA,YAAY,CAACL,MAAD,EAAiBC,SAAjB,EAAqC;AAC/C,SAAKD,MAAL,GAAcA,MAAd;AACA,SAAKC,SAAL,GAAiBA,SAAjB;AAEA;AACD,GApDS,CAsDV;;;AACAK,EAAAA,QAAQ,GAAG;AACT,QAAI,CAAC,KAAKF,SAAV,EAAqB;AACnB;AACD;;AAED,SAAKA,SAAL,CAAeG,MAAf,CAAsBC,UAAtB;AACD;;AA7DS;;AAgEZ,eAAehB,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 userToken: string | undefined;\n private apiClient: ApiClient | null = null;\n public userId: 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 && !this.userToken) {\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 // Used to teardown any connected instances\n teardown() {\n if (!this.apiClient) {\n return;\n }\n\n this.apiClient.socket.disconnect();\n }\n}\n\nexport default Knock;\n"],"file":"knock.js"}
1
+ {"version":3,"sources":["../../src/knock.ts"],"names":["ApiClient","FeedClient","Preferences","DEFAULT_HOST","Knock","constructor","apiKey","options","host","startsWith","Error","client","userId","userToken","console","warn","apiClient","authenticate","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;;AAAA,uCAN3B,IAM2B;;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,MAAN,IAAgB,CAAC,KAAKC,SAA1B,EAAqC;AACnCC,MAAAA,OAAO,CAACC,IAAR;AAOD,KATM,CAWP;;;AACA,QAAI,CAAC,KAAKC,SAAV,EAAqB;AACnB,WAAKA,SAAL,GAAiB,IAAIhB,SAAJ,CAAc;AAC7BM,QAAAA,MAAM,EAAE,KAAKA,MADgB;AAE7BE,QAAAA,IAAI,EAAE,KAAKA,IAFkB;AAG7BK,QAAAA,SAAS,EAAE,KAAKA;AAHa,OAAd,CAAjB;AAKD;;AAED,WAAO,KAAKG,SAAZ;AACD;AAED;AACF;AACA;AACA;;;AACEC,EAAAA,YAAY,CAACL,MAAD,EAAiBC,SAAjB,EAAqC;AAC/C,SAAKD,MAAL,GAAcA,MAAd;AACA,SAAKC,SAAL,GAAiBA,SAAjB;AAEA;AACD,GApDS,CAsDV;;;AACAK,EAAAA,QAAQ,GAAG;AACT,QAAI,CAAC,KAAKF,SAAV,EAAqB;AACrB,SAAKA,SAAL,CAAeG,MAAf,CAAsBC,UAAtB;AACD;;AA1DS;;AA6DZ,eAAehB,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 userToken: string | undefined;\n private apiClient: ApiClient | null = null;\n public userId: 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 && !this.userToken) {\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 // Used to teardown any connected instances\n teardown() {\n if (!this.apiClient) return;\n this.apiClient.socket.disconnect();\n }\n}\n\nexport default Knock;\n"],"file":"knock.js"}
@@ -16,24 +16,8 @@ declare class ApiClient {
16
16
  private apiKey;
17
17
  private userToken;
18
18
  private axiosClient;
19
- /**
20
- * @deprecated Use `socket.connectionState` instead.
21
- */
22
- socketConnected: boolean;
23
19
  socket: Socket;
24
20
  constructor(options: ApiClientOptions);
25
- /**
26
- * @deprecated Use `socket.connect()` instead.
27
- */
28
- connectSocket(): void;
29
- /**
30
- * @deprecated Use `socket.disconnect()` instead.
31
- */
32
- disconnectSocket(): void;
33
- /**
34
- * @deprecated Use `socket.channel(name: string, params?: object)` instead.
35
- */
36
- createChannel(name: string, params?: object): import("phoenix").Channel;
37
21
  makeRequest(req: AxiosRequestConfig): Promise<ApiResponse>;
38
22
  private canRetryRequest;
39
23
  }
@@ -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;IAEnC;;OAEG;IACI,eAAe,UAAS;IACxB,MAAM,EAAE,MAAM,CAAC;gBAEV,OAAO,EAAE,gBAAgB;IA8BrC;;OAEG;IACH,aAAa;IAWb;;OAEG;IACH,gBAAgB;IAMhB;;OAEG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;IAIrC,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,EAAY,MAAM,EAAE,MAAM,SAAS,CAAC;AAG3C,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,CAAC;gBAEV,OAAO,EAAE,gBAAgB;IAgC/B,WAAW,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAwBhE,OAAO,CAAC,eAAe;CAuBxB;AAED,eAAe,SAAS,CAAC"}
@@ -13,7 +13,12 @@ declare class Feed {
13
13
  private defaultOptions;
14
14
  store: StoreApi<FeedStoreState>;
15
15
  constructor(knock: Knock, feedId: string, options: FeedClientOptions);
16
- listenForUpdates(): () => void;
16
+ /**
17
+ * Cleans up a feed instance by destroying the store and disconnecting
18
+ * an open socket connection.
19
+ */
20
+ teardown(): void;
21
+ listenForUpdates(): void;
17
22
  on(eventName: BindableFeedEvent, callback: FeedEventCallback | FeedRealTimeCallback): void;
18
23
  off(eventName: BindableFeedEvent, callback: FeedEventCallback | FeedRealTimeCallback): void;
19
24
  getState(): FeedStoreState;
@@ -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,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,YAAY,CAAC;AAEjB,cAAM,IAAI;IAWN,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM;IAXzB,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,WAAW,CAAe;IAClC,OAAO,CAAC,cAAc,CAAoB;IAGnC,KAAK,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;gBAG5B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,EACvB,OAAO,EAAE,iBAAiB;IAqB5B,gBAAgB;IA2BhB,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;IAWvC,YAAY,CAAC,WAAW,EAAE,eAAe;IAUzC,UAAU,CAAC,WAAW,EAAE,eAAe;IAWvC,YAAY,CAAC,WAAW,EAAE,eAAe;IAkBzC,cAAc,CAAC,WAAW,EAAE,eAAe;IA0C3C,gBAAgB,CAAC,WAAW,EAAE,eAAe;IAQ7C,KAAK,CAAC,OAAO,GAAE,gBAAqB;;;;IAoEpC,aAAa;IAgBnB,OAAO,CAAC,SAAS;YAQH,oBAAoB;IAalC,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,iCAAiC;YAgC3B,gBAAgB;CAoB/B;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,oBAAY,MAAM,GACd,MAAM,GACN,MAAM,GACN,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,YAAY,CAAC;AAOjB,cAAM,IAAI;IAWN,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM;IAXzB,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,WAAW,CAAe;IAClC,OAAO,CAAC,cAAc,CAAoB;IAGnC,KAAK,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;gBAG5B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,EACvB,OAAO,EAAE,iBAAiB;IAiB5B;;;OAGG;IACH,QAAQ;IAWR,gBAAgB;IAahB,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;IAWvC,YAAY,CAAC,WAAW,EAAE,eAAe;IAUzC,UAAU,CAAC,WAAW,EAAE,eAAe;IAWvC,YAAY,CAAC,WAAW,EAAE,eAAe;IAkBzC,cAAc,CAAC,WAAW,EAAE,eAAe;IA0E3C,gBAAgB,CAAC,WAAW,EAAE,eAAe;IAQ7C,KAAK,CAAC,OAAO,GAAE,gBAAqB;;;;IAoEpC,aAAa;IAgBnB,OAAO,CAAC,SAAS;YAQH,oBAAoB;IAalC,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,iCAAiC;YAgC3B,gBAAgB;CAoB/B;AAED,eAAe,IAAI,CAAC"}
@@ -7,7 +7,7 @@ export interface FeedClientOptions {
7
7
  status?: "unread" | "read" | "unseen" | "seen" | "all";
8
8
  source?: string;
9
9
  tenant?: string;
10
- include_archived?: boolean;
10
+ archived?: "include" | "exclude" | "only";
11
11
  }
12
12
  export declare type FetchFeedOptions = {
13
13
  __loadingType?: NetworkStatus.loading | NetworkStatus.fetchMore;
@@ -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,IAAI,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACzE,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;IAChB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;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,iBAAiB,CAAC;AAEtB,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,EAAE,CAAC;IACvB,MAAM,EAAE,IAAI,EAAE,CAAC;IACf,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;CAC5B;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,IAAI,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACzE,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;IAGhB,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;CAC3C;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,iBAAiB,CAAC;AAEtB,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,EAAE,CAAC;IACvB,MAAM,EAAE,IAAI,EAAE,CAAC;IACf,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;CAC5B;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 +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,CAAqB;IACtC,OAAO,CAAC,SAAS,CAA0B;IACpC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAElC,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;IAQ/C,QAAQ;CAOT;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,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAI5C,cAAM,KAAK;IASG,QAAQ,CAAC,MAAM,EAAE,MAAM;IARnC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,SAAS,CAA0B;IACpC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAElC,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;IAQ/C,QAAQ;CAIT;AAED,eAAe,KAAK,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knocklabs/client",
3
- "version": "0.5.10",
3
+ "version": "0.7.0-rc.0",
4
4
  "description": "The clientside library for interacting with Knock",
5
5
  "homepage": "https://github.com/knocklabs/knock-client-js",
6
6
  "author": "@knocklabs",
@@ -48,7 +48,7 @@
48
48
  "@babel/plugin-transform-runtime": "^7.16.7",
49
49
  "@babel/preset-env": "^7.16.7",
50
50
  "@babel/preset-typescript": "^7.16.7",
51
- "@types/phoenix": "^1.5.1",
51
+ "@types/phoenix": "^1.5.4",
52
52
  "@typescript-eslint/eslint-plugin": "^5.4.0",
53
53
  "@typescript-eslint/parser": "^5.4.0",
54
54
  "cross-env": "^7.0.3",
@@ -63,6 +63,6 @@
63
63
  "axios-retry": "^3.1.9",
64
64
  "eventemitter2": "^6.4.5",
65
65
  "phoenix": "1.5.8",
66
- "zustand": "^3.5.10"
66
+ "zustand": "^3.7.2"
67
67
  }
68
68
  }