@amityco/ts-sdk 0.0.1-cb052d5.0 → 0.0.1-cb393db.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.
Files changed (427) hide show
  1. package/.eslintrc.json +5 -1
  2. package/dist/@types/core/events.d.ts +15 -10
  3. package/dist/@types/core/events.d.ts.map +1 -1
  4. package/dist/@types/core/live.d.ts +23 -0
  5. package/dist/@types/core/live.d.ts.map +1 -0
  6. package/dist/@types/core/model.d.ts +2 -0
  7. package/dist/@types/core/model.d.ts.map +1 -1
  8. package/dist/@types/core/paging.d.ts +1 -1
  9. package/dist/@types/core/paging.d.ts.map +1 -1
  10. package/dist/@types/core/payload.d.ts +23 -18
  11. package/dist/@types/core/payload.d.ts.map +1 -1
  12. package/dist/@types/domains/channel.d.ts +18 -3
  13. package/dist/@types/domains/channel.d.ts.map +1 -1
  14. package/dist/@types/domains/client.d.ts +13 -0
  15. package/dist/@types/domains/client.d.ts.map +1 -1
  16. package/dist/@types/domains/comment.d.ts +14 -0
  17. package/dist/@types/domains/comment.d.ts.map +1 -1
  18. package/dist/@types/domains/community.d.ts +24 -2
  19. package/dist/@types/domains/community.d.ts.map +1 -1
  20. package/dist/@types/domains/content.d.ts +32 -5
  21. package/dist/@types/domains/content.d.ts.map +1 -1
  22. package/dist/@types/domains/file.d.ts +36 -3
  23. package/dist/@types/domains/file.d.ts.map +1 -1
  24. package/dist/@types/domains/follow.d.ts +13 -1
  25. package/dist/@types/domains/follow.d.ts.map +1 -1
  26. package/dist/@types/domains/group.d.ts +1 -0
  27. package/dist/@types/domains/group.d.ts.map +1 -1
  28. package/dist/@types/domains/message.d.ts +18 -2
  29. package/dist/@types/domains/message.d.ts.map +1 -1
  30. package/dist/@types/domains/post.d.ts +17 -0
  31. package/dist/@types/domains/post.d.ts.map +1 -1
  32. package/dist/@types/domains/reaction.d.ts +18 -8
  33. package/dist/@types/domains/reaction.d.ts.map +1 -1
  34. package/dist/@types/domains/user.d.ts +1 -1
  35. package/dist/@types/domains/user.d.ts.map +1 -1
  36. package/dist/@types/global.d.ts +1 -0
  37. package/dist/@types/global.d.ts.map +1 -1
  38. package/dist/@types/index.d.ts +4 -3
  39. package/dist/@types/index.d.ts.map +1 -1
  40. package/dist/cache/api/ingestInCache.d.ts +1 -1
  41. package/dist/cache/api/ingestInCache.d.ts.map +1 -1
  42. package/dist/cache/api/mergeInCache.d.ts +1 -1
  43. package/dist/cache/api/mergeInCache.d.ts.map +1 -1
  44. package/dist/category/api/queryCategories.d.ts +3 -3
  45. package/dist/category/api/queryCategories.d.ts.map +1 -1
  46. package/dist/channel/api/addChannelMembers.d.ts.map +1 -1
  47. package/dist/channel/api/addChannelMembersRole.d.ts.map +1 -1
  48. package/dist/channel/api/banChannelMembers.d.ts +16 -0
  49. package/dist/channel/api/banChannelMembers.d.ts.map +1 -0
  50. package/dist/channel/api/createChannel.d.ts.map +1 -1
  51. package/dist/channel/api/getChannel.d.ts.map +1 -1
  52. package/dist/channel/api/getChannels.d.ts.map +1 -1
  53. package/dist/channel/api/index.d.ts +2 -0
  54. package/dist/channel/api/index.d.ts.map +1 -1
  55. package/dist/channel/api/joinChannel.d.ts.map +1 -1
  56. package/dist/channel/api/leaveChannel.d.ts.map +1 -1
  57. package/dist/channel/api/queryChannelMembers.d.ts +2 -1
  58. package/dist/channel/api/queryChannelMembers.d.ts.map +1 -1
  59. package/dist/channel/api/queryChannels.d.ts +1 -9
  60. package/dist/channel/api/queryChannels.d.ts.map +1 -1
  61. package/dist/channel/api/removeChannelMembers.d.ts.map +1 -1
  62. package/dist/channel/api/removeChannelMembersRole.d.ts.map +1 -1
  63. package/dist/channel/api/unbanChannelMembers.d.ts +16 -0
  64. package/dist/channel/api/unbanChannelMembers.d.ts.map +1 -0
  65. package/dist/channel/api/updateChannel.d.ts +1 -1
  66. package/dist/channel/api/updateChannel.d.ts.map +1 -1
  67. package/dist/channel/events/index.d.ts +3 -2
  68. package/dist/channel/events/index.d.ts.map +1 -1
  69. package/dist/channel/events/onChannelCreated.d.ts.map +1 -1
  70. package/dist/channel/events/onChannelDeleted.d.ts.map +1 -1
  71. package/dist/channel/events/onChannelJoined.d.ts.map +1 -1
  72. package/dist/channel/events/onChannelLeft.d.ts.map +1 -1
  73. package/dist/channel/events/onChannelMemberAdded.d.ts +17 -0
  74. package/dist/channel/events/onChannelMemberAdded.d.ts.map +1 -0
  75. package/dist/channel/events/onChannelMemberRemoved.d.ts +17 -0
  76. package/dist/channel/events/onChannelMemberRemoved.d.ts.map +1 -0
  77. package/dist/channel/events/onChannelUpdated.d.ts.map +1 -1
  78. package/dist/channel/observers/index.d.ts +2 -0
  79. package/dist/channel/observers/index.d.ts.map +1 -1
  80. package/dist/channel/observers/liveChannels.d.ts +20 -0
  81. package/dist/channel/observers/liveChannels.d.ts.map +1 -0
  82. package/dist/channel/observers/observeChannel.d.ts +1 -1
  83. package/dist/channel/observers/observeChannel.d.ts.map +1 -1
  84. package/dist/channel/observers/observeChannels.d.ts +17 -0
  85. package/dist/channel/observers/observeChannels.d.ts.map +1 -0
  86. package/dist/channel/observers/tests/liveChannels.test.d.ts +2 -0
  87. package/dist/channel/observers/tests/liveChannels.test.d.ts.map +1 -0
  88. package/dist/channel/tests/utils/prepareChannelPayload.test.d.ts +2 -0
  89. package/dist/channel/tests/utils/prepareChannelPayload.test.d.ts.map +1 -0
  90. package/dist/channel/utils/index.d.ts +2 -0
  91. package/dist/channel/utils/index.d.ts.map +1 -0
  92. package/dist/channel/utils/prepareChannelPayload.d.ts +3 -0
  93. package/dist/channel/utils/prepareChannelPayload.d.ts.map +1 -0
  94. package/dist/client/api/connectClient.d.ts +1 -6
  95. package/dist/client/api/connectClient.d.ts.map +1 -1
  96. package/dist/client/api/createClient.d.ts +8 -1
  97. package/dist/client/api/createClient.d.ts.map +1 -1
  98. package/dist/client/api/getFeedSettings.d.ts +16 -0
  99. package/dist/client/api/getFeedSettings.d.ts.map +1 -0
  100. package/dist/client/api/index.d.ts +1 -0
  101. package/dist/client/api/index.d.ts.map +1 -1
  102. package/dist/comment/api/queryComments.d.ts +1 -8
  103. package/dist/comment/api/queryComments.d.ts.map +1 -1
  104. package/dist/comment/observers/index.d.ts +1 -0
  105. package/dist/comment/observers/index.d.ts.map +1 -1
  106. package/dist/comment/observers/liveComments.d.ts +22 -0
  107. package/dist/comment/observers/liveComments.d.ts.map +1 -0
  108. package/dist/comment/observers/observeComments.d.ts.map +1 -1
  109. package/dist/community/api/createCommunity.d.ts +1 -1
  110. package/dist/community/api/createCommunity.d.ts.map +1 -1
  111. package/dist/community/api/getCommunities.d.ts.map +1 -1
  112. package/dist/community/api/getCommunity.d.ts.map +1 -1
  113. package/dist/community/api/getRecommendedCommunities.d.ts +1 -1
  114. package/dist/community/api/getRecommendedCommunities.d.ts.map +1 -1
  115. package/dist/community/api/getTopTrendingCommunities.d.ts +1 -1
  116. package/dist/community/api/getTopTrendingCommunities.d.ts.map +1 -1
  117. package/dist/community/api/queryCommunities.d.ts +7 -7
  118. package/dist/community/api/queryCommunities.d.ts.map +1 -1
  119. package/dist/community/api/updateCommunity.d.ts +1 -1
  120. package/dist/community/api/updateCommunity.d.ts.map +1 -1
  121. package/dist/community/events/utils.d.ts.map +1 -1
  122. package/dist/community/utils/index.d.ts +2 -0
  123. package/dist/community/utils/index.d.ts.map +1 -0
  124. package/dist/community/utils/payload.d.ts +11 -0
  125. package/dist/community/utils/payload.d.ts.map +1 -0
  126. package/dist/core/debug.d.ts +1 -1
  127. package/dist/core/debug.d.ts.map +1 -1
  128. package/dist/core/events.d.ts +3 -3
  129. package/dist/core/events.d.ts.map +1 -1
  130. package/dist/core/model/idResolvers.d.ts.map +1 -1
  131. package/dist/core/model/identifyModel.d.ts +1 -0
  132. package/dist/core/model/identifyModel.d.ts.map +1 -1
  133. package/dist/core/model/index.d.ts.map +1 -1
  134. package/dist/core/query/paging.d.ts +2 -2
  135. package/dist/core/query/paging.d.ts.map +1 -1
  136. package/dist/core/query/query.d.ts +2 -2
  137. package/dist/core/query/query.d.ts.map +1 -1
  138. package/dist/core/subscription.d.ts +2 -0
  139. package/dist/core/subscription.d.ts.map +1 -1
  140. package/dist/core/tests/query/filtering.test.d.ts +2 -0
  141. package/dist/core/tests/query/filtering.test.d.ts.map +1 -0
  142. package/dist/core/tests/query/query/runQuery.test.d.ts +2 -0
  143. package/dist/core/tests/query/query/runQuery.test.d.ts.map +1 -0
  144. package/dist/core/tests/query/query.test.d.ts +2 -0
  145. package/dist/core/tests/query/query.test.d.ts.map +1 -0
  146. package/dist/core/transports/ws.d.ts +1 -1
  147. package/dist/core/transports/ws.d.ts.map +1 -1
  148. package/dist/external/api/createUserToken.d.ts +1 -1
  149. package/dist/external/api/createUserToken.d.ts.map +1 -1
  150. package/dist/feed/api/queryGlobalFeed.d.ts +4 -4
  151. package/dist/feed/api/queryGlobalFeed.d.ts.map +1 -1
  152. package/dist/file/api/createVideo.d.ts +2 -1
  153. package/dist/file/api/createVideo.d.ts.map +1 -1
  154. package/dist/follow/api/follow.d.ts.map +1 -1
  155. package/dist/follow/api/getFollowInfo.d.ts.map +1 -1
  156. package/dist/follow/api/queryFollowers.d.ts +2 -6
  157. package/dist/follow/api/queryFollowers.d.ts.map +1 -1
  158. package/dist/follow/api/queryFollowings.d.ts +2 -6
  159. package/dist/follow/api/queryFollowings.d.ts.map +1 -1
  160. package/dist/follow/api/utils.d.ts +4 -4
  161. package/dist/follow/api/utils.d.ts.map +1 -1
  162. package/dist/follow/events/utils.d.ts.map +1 -1
  163. package/dist/follow/observers/index.d.ts +2 -0
  164. package/dist/follow/observers/index.d.ts.map +1 -1
  165. package/dist/follow/observers/liveFollowers.d.ts +20 -0
  166. package/dist/follow/observers/liveFollowers.d.ts.map +1 -0
  167. package/dist/follow/observers/liveFollowings.d.ts +20 -0
  168. package/dist/follow/observers/liveFollowings.d.ts.map +1 -0
  169. package/dist/follow/tests/observers/liveFollowers.test.d.ts +2 -0
  170. package/dist/follow/tests/observers/liveFollowers.test.d.ts.map +1 -0
  171. package/dist/follow/tests/observers/liveFollowings.test.d.ts +2 -0
  172. package/dist/follow/tests/observers/liveFollowings.test.d.ts.map +1 -0
  173. package/dist/index.cjs.js +20466 -14218
  174. package/dist/index.d.ts +4 -1
  175. package/dist/index.d.ts.map +1 -1
  176. package/dist/index.esm.js +20429 -14213
  177. package/dist/index.umd.js +4 -19
  178. package/dist/message/api/createMessage.d.ts +2 -2
  179. package/dist/message/api/createMessage.d.ts.map +1 -1
  180. package/dist/message/api/queryMessages.d.ts +1 -10
  181. package/dist/message/api/queryMessages.d.ts.map +1 -1
  182. package/dist/message/api/updateMessage.d.ts +2 -2
  183. package/dist/message/api/updateMessage.d.ts.map +1 -1
  184. package/dist/message/events/onMessageUpdated.d.ts.map +1 -1
  185. package/dist/message/observers/index.d.ts +1 -0
  186. package/dist/message/observers/index.d.ts.map +1 -1
  187. package/dist/message/observers/liveMessages.d.ts +20 -0
  188. package/dist/message/observers/liveMessages.d.ts.map +1 -0
  189. package/dist/message/observers/observeMessages.d.ts +0 -1
  190. package/dist/message/observers/observeMessages.d.ts.map +1 -1
  191. package/dist/message/observers/tests/liveMessages.test.d.ts +2 -0
  192. package/dist/message/observers/tests/liveMessages.test.d.ts.map +1 -0
  193. package/dist/poll/api/closePoll.d.ts.map +1 -1
  194. package/dist/poll/api/deletePoll.d.ts.map +1 -1
  195. package/dist/poll/api/votePoll.d.ts.map +1 -1
  196. package/dist/poll/events/index.d.ts +3 -0
  197. package/dist/poll/events/index.d.ts.map +1 -0
  198. package/dist/poll/events/onPollDeleted.d.ts +17 -0
  199. package/dist/poll/events/onPollDeleted.d.ts.map +1 -0
  200. package/dist/poll/events/onPollUpdated.d.ts +17 -0
  201. package/dist/poll/events/onPollUpdated.d.ts.map +1 -0
  202. package/dist/poll/observers/index.d.ts +2 -0
  203. package/dist/poll/observers/index.d.ts.map +1 -0
  204. package/dist/poll/observers/observePoll.d.ts +18 -0
  205. package/dist/poll/observers/observePoll.d.ts.map +1 -0
  206. package/dist/post/api/approvePost.d.ts +17 -0
  207. package/dist/post/api/approvePost.d.ts.map +1 -0
  208. package/dist/post/api/declinePost.d.ts +17 -0
  209. package/dist/post/api/declinePost.d.ts.map +1 -0
  210. package/dist/post/api/index.d.ts +2 -0
  211. package/dist/post/api/index.d.ts.map +1 -1
  212. package/dist/post/api/queryPosts.d.ts +1 -12
  213. package/dist/post/api/queryPosts.d.ts.map +1 -1
  214. package/dist/post/observers/index.d.ts +1 -0
  215. package/dist/post/observers/index.d.ts.map +1 -1
  216. package/dist/post/observers/livePosts.d.ts +22 -0
  217. package/dist/post/observers/livePosts.d.ts.map +1 -0
  218. package/dist/post/observers/observePosts.d.ts.map +1 -1
  219. package/dist/post/tests/api/getPost.test.d.ts +2 -0
  220. package/dist/post/tests/api/getPost.test.d.ts.map +1 -0
  221. package/dist/post/tests/api/queryPosts.test.d.ts +2 -0
  222. package/dist/post/tests/api/queryPosts.test.d.ts.map +1 -0
  223. package/dist/reaction/api/index.d.ts +1 -0
  224. package/dist/reaction/api/index.d.ts.map +1 -1
  225. package/dist/reaction/api/queryReactions.d.ts +19 -0
  226. package/dist/reaction/api/queryReactions.d.ts.map +1 -0
  227. package/dist/reaction/events/index.d.ts +3 -0
  228. package/dist/reaction/events/index.d.ts.map +1 -1
  229. package/dist/reaction/events/onReactionAdded.d.ts.map +1 -1
  230. package/dist/reaction/events/onReactorAdded.d.ts +19 -0
  231. package/dist/reaction/events/onReactorAdded.d.ts.map +1 -0
  232. package/dist/reaction/events/onReactorRemoved.d.ts +19 -0
  233. package/dist/reaction/events/onReactorRemoved.d.ts.map +1 -0
  234. package/dist/reaction/observers/index.d.ts +2 -0
  235. package/dist/reaction/observers/index.d.ts.map +1 -0
  236. package/dist/reaction/observers/liveReactions.d.ts +22 -0
  237. package/dist/reaction/observers/liveReactions.d.ts.map +1 -0
  238. package/dist/reaction/utils/index.d.ts +1 -0
  239. package/dist/reaction/utils/index.d.ts.map +1 -1
  240. package/dist/reaction/utils/prepareMessagePayloadForCache.d.ts +3 -0
  241. package/dist/reaction/utils/prepareMessagePayloadForCache.d.ts.map +1 -0
  242. package/dist/report/api/createReport.d.ts.map +1 -1
  243. package/dist/report/api/deleteReport.d.ts.map +1 -1
  244. package/dist/role/api/queryRoles.d.ts +4 -4
  245. package/dist/role/api/queryRoles.d.ts.map +1 -1
  246. package/dist/stream/api/queryStreams.d.ts +6 -6
  247. package/dist/stream/api/queryStreams.d.ts.map +1 -1
  248. package/dist/user/events/index.d.ts +1 -0
  249. package/dist/user/events/index.d.ts.map +1 -1
  250. package/dist/user/events/onUserDeleted.d.ts +17 -0
  251. package/dist/user/events/onUserDeleted.d.ts.map +1 -0
  252. package/dist/user/observers/observeUser.d.ts +1 -1
  253. package/dist/user/observers/observeUser.d.ts.map +1 -1
  254. package/dist/utils/constants.d.ts +4 -0
  255. package/dist/utils/constants.d.ts.map +1 -0
  256. package/dist/utils/tests/client.d.ts +6 -0
  257. package/dist/utils/tests/client.d.ts.map +1 -0
  258. package/dist/utils/tests/dummy/channel.d.ts +33 -0
  259. package/dist/utils/tests/dummy/channel.d.ts.map +1 -0
  260. package/dist/utils/tests/dummy/follow.d.ts +12 -0
  261. package/dist/utils/tests/dummy/follow.d.ts.map +1 -0
  262. package/dist/utils/tests/dummy/index.d.ts +11 -0
  263. package/dist/utils/tests/dummy/index.d.ts.map +1 -0
  264. package/dist/utils/tests/dummy/message.d.ts +8 -0
  265. package/dist/utils/tests/dummy/message.d.ts.map +1 -0
  266. package/dist/utils/tests/dummy/post.d.ts +9 -0
  267. package/dist/utils/tests/dummy/post.d.ts.map +1 -0
  268. package/dist/utils/tests/dummy/user.d.ts +5 -0
  269. package/dist/utils/tests/dummy/user.d.ts.map +1 -0
  270. package/dist/utils/tests/index.d.ts +4 -0
  271. package/dist/utils/tests/index.d.ts.map +1 -0
  272. package/dist/utils/tests/utils.d.ts +2 -0
  273. package/dist/utils/tests/utils.d.ts.map +1 -0
  274. package/jest.config.ts +15 -0
  275. package/package.json +22 -17
  276. package/src/@types/core/events.ts +16 -10
  277. package/src/@types/core/live.ts +28 -0
  278. package/src/@types/core/model.ts +2 -0
  279. package/src/@types/core/paging.ts +1 -1
  280. package/src/@types/core/payload.ts +30 -19
  281. package/src/@types/domains/channel.ts +35 -3
  282. package/src/@types/domains/client.ts +17 -0
  283. package/src/@types/domains/comment.ts +31 -0
  284. package/src/@types/domains/community.ts +27 -2
  285. package/src/@types/domains/content.ts +42 -4
  286. package/src/@types/domains/file.ts +42 -3
  287. package/src/@types/domains/follow.ts +31 -1
  288. package/src/@types/domains/group.ts +1 -0
  289. package/src/@types/domains/message.ts +31 -1
  290. package/src/@types/domains/post.ts +37 -0
  291. package/src/@types/domains/reaction.ts +26 -9
  292. package/src/@types/domains/user.ts +1 -0
  293. package/src/@types/global.ts +2 -0
  294. package/src/@types/index.ts +5 -3
  295. package/src/channel/api/addChannelMembers.ts +6 -4
  296. package/src/channel/api/addChannelMembersRole.ts +5 -1
  297. package/src/channel/api/banChannelMembers.ts +45 -0
  298. package/src/channel/api/createChannel.ts +6 -2
  299. package/src/channel/api/getChannel.ts +5 -1
  300. package/src/channel/api/getChannels.ts +5 -1
  301. package/src/channel/api/index.ts +3 -0
  302. package/src/channel/api/joinChannel.ts +5 -1
  303. package/src/channel/api/leaveChannel.ts +5 -1
  304. package/src/channel/api/queryChannelMembers.ts +19 -15
  305. package/src/channel/api/queryChannels.ts +12 -13
  306. package/src/channel/api/removeChannelMembers.ts +6 -4
  307. package/src/channel/api/removeChannelMembersRole.ts +5 -1
  308. package/src/channel/api/unbanChannelMembers.ts +45 -0
  309. package/src/channel/api/updateChannel.ts +6 -2
  310. package/src/channel/events/index.ts +3 -2
  311. package/src/channel/events/onChannelCreated.ts +6 -2
  312. package/src/channel/events/onChannelDeleted.ts +6 -2
  313. package/src/channel/events/onChannelJoined.ts +6 -2
  314. package/src/channel/events/onChannelLeft.ts +6 -2
  315. package/src/channel/events/onChannelMemberAdded.ts +36 -0
  316. package/src/channel/events/onChannelMemberRemoved.ts +41 -0
  317. package/src/channel/events/onChannelUpdated.ts +6 -2
  318. package/src/channel/observers/index.ts +2 -0
  319. package/src/channel/observers/liveChannels.ts +178 -0
  320. package/src/channel/observers/observeChannel.ts +9 -15
  321. package/src/channel/observers/observeChannels.ts +59 -0
  322. package/src/channel/observers/tests/liveChannels.test.ts +182 -0
  323. package/src/channel/tests/utils/prepareChannelPayload.test.ts +120 -0
  324. package/src/channel/utils/index.ts +1 -0
  325. package/src/channel/utils/prepareChannelPayload.ts +31 -0
  326. package/src/client/api/connectClient.ts +18 -11
  327. package/src/client/api/createClient.ts +19 -4
  328. package/src/client/api/getFeedSettings.ts +29 -0
  329. package/src/client/api/index.ts +2 -0
  330. package/src/comment/api/queryComments.ts +8 -11
  331. package/src/comment/observers/index.ts +1 -0
  332. package/src/comment/observers/liveComments.ts +172 -0
  333. package/src/comment/observers/observeComments.ts +1 -11
  334. package/src/community/api/createCommunity.ts +9 -3
  335. package/src/community/api/getCommunities.ts +10 -3
  336. package/src/community/api/getCommunity.ts +5 -1
  337. package/src/community/api/getRecommendedCommunities.ts +5 -2
  338. package/src/community/api/getTopTrendingCommunities.ts +4 -1
  339. package/src/community/api/queryCommunities.ts +5 -2
  340. package/src/community/api/updateCommunity.ts +7 -3
  341. package/src/community/events/utils.ts +13 -7
  342. package/src/community/utils/index.ts +1 -0
  343. package/src/community/utils/payload.ts +44 -0
  344. package/src/core/events.ts +2 -1
  345. package/src/core/model/idResolvers.ts +1 -0
  346. package/src/core/model/identifyModel.ts +20 -1
  347. package/src/core/model/index.ts +1 -0
  348. package/src/core/query/paging.ts +3 -3
  349. package/src/core/query/query.ts +33 -2
  350. package/src/core/subscription.ts +10 -1
  351. package/src/core/tests/query/filtering.test.ts +11 -0
  352. package/src/core/tests/query/query/runQuery.test.ts +182 -0
  353. package/src/core/tests/query/query.test.ts +19 -0
  354. package/src/file/api/createVideo.ts +6 -0
  355. package/src/follow/api/acceptFollower.ts +1 -1
  356. package/src/follow/api/declineFollower.ts +1 -1
  357. package/src/follow/api/follow.ts +1 -4
  358. package/src/follow/api/getFollowInfo.ts +8 -5
  359. package/src/follow/api/queryFollowers.ts +5 -6
  360. package/src/follow/api/queryFollowings.ts +5 -6
  361. package/src/follow/api/unfollow.ts +1 -1
  362. package/src/follow/api/utils.ts +17 -13
  363. package/src/follow/events/utils.ts +9 -6
  364. package/src/follow/observers/index.ts +3 -0
  365. package/src/follow/observers/liveFollowers.ts +149 -0
  366. package/src/follow/observers/liveFollowings.ts +149 -0
  367. package/src/follow/tests/observers/liveFollowers.test.ts +240 -0
  368. package/src/follow/tests/observers/liveFollowings.test.ts +239 -0
  369. package/src/index.ts +4 -1
  370. package/src/message/api/createMessage.ts +24 -8
  371. package/src/message/api/queryMessages.ts +3 -10
  372. package/src/message/api/updateMessage.ts +2 -2
  373. package/src/message/events/onMessageUpdated.ts +9 -1
  374. package/src/message/observers/index.ts +1 -0
  375. package/src/message/observers/liveMessages.ts +141 -0
  376. package/src/message/observers/observeMessages.ts +0 -1
  377. package/src/message/observers/tests/liveMessages.test.ts +313 -0
  378. package/src/poll/api/closePoll.ts +3 -0
  379. package/src/poll/api/deletePoll.ts +3 -0
  380. package/src/poll/api/votePoll.ts +3 -0
  381. package/src/poll/events/index.ts +2 -0
  382. package/src/poll/events/onPollDeleted.ts +31 -0
  383. package/src/poll/events/onPollUpdated.ts +31 -0
  384. package/src/poll/observers/index.ts +1 -0
  385. package/src/poll/observers/observePoll.ts +67 -0
  386. package/src/post/api/approvePost.ts +48 -0
  387. package/src/post/api/declinePost.ts +48 -0
  388. package/src/post/api/index.ts +3 -0
  389. package/src/post/api/queryPosts.ts +3 -12
  390. package/src/post/observers/index.ts +1 -0
  391. package/src/post/observers/livePosts.ts +171 -0
  392. package/src/post/observers/observePosts.ts +1 -13
  393. package/src/post/tests/api/getPost.test.ts +88 -0
  394. package/src/post/tests/api/queryPosts.test.ts +23 -0
  395. package/src/reaction/api/index.ts +1 -0
  396. package/src/reaction/api/queryReactions.ts +52 -0
  397. package/src/reaction/events/index.ts +4 -0
  398. package/src/reaction/events/onReactionAdded.ts +4 -0
  399. package/src/reaction/events/onReactorAdded.ts +80 -0
  400. package/src/reaction/events/onReactorRemoved.ts +85 -0
  401. package/src/reaction/observers/index.ts +1 -0
  402. package/src/reaction/observers/liveReactions.ts +142 -0
  403. package/src/reaction/utils/index.ts +1 -0
  404. package/src/reaction/utils/prepareMessagePayloadForCache.ts +40 -0
  405. package/src/report/api/createReport.ts +7 -1
  406. package/src/report/api/deleteReport.ts +7 -1
  407. package/src/user/events/index.ts +1 -0
  408. package/src/user/events/onUserDeleted.ts +19 -0
  409. package/src/user/events/utils.ts +1 -1
  410. package/src/user/observers/observeUser.ts +9 -2
  411. package/src/utils/constants.ts +3 -0
  412. package/src/utils/tests/client.ts +33 -0
  413. package/src/utils/tests/dummy/channel.ts +95 -0
  414. package/src/utils/tests/dummy/follow.ts +60 -0
  415. package/src/utils/tests/dummy/index.ts +8 -0
  416. package/src/utils/tests/dummy/message.ts +21 -0
  417. package/src/utils/tests/dummy/post.ts +31 -0
  418. package/src/utils/tests/dummy/user.ts +26 -0
  419. package/src/utils/tests/index.ts +3 -0
  420. package/src/utils/tests/utils.ts +3 -0
  421. package/tsconfig.json +23 -22
  422. package/dist/channel/events/onMemberAdded.d.ts +0 -17
  423. package/dist/channel/events/onMemberAdded.d.ts.map +0 -1
  424. package/dist/channel/events/onMemberRemoved.d.ts +0 -17
  425. package/dist/channel/events/onMemberRemoved.d.ts.map +0 -1
  426. package/src/channel/events/onMemberAdded.ts +0 -30
  427. package/src/channel/events/onMemberRemoved.ts +0 -30
@@ -3,6 +3,8 @@ import { getActiveClient } from '~/client/api';
3
3
  import { toPage, toToken } from '~/core/query';
4
4
  import { ingestInCache } from '~/cache/api/ingestInCache';
5
5
 
6
+ import { prepareChannelPayload } from '../utils';
7
+
6
8
  /**
7
9
  * ```js
8
10
  * import { queryChannelMembers } from '@amityco/ts-sdk'
@@ -19,35 +21,37 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
19
21
  * */
20
22
  export const queryChannelMembers = async (query: {
21
23
  channelId: string;
22
- membership?: 'all' | 'muted' | 'banned' | 'member&banned';
24
+ memberships?: ('muted' | 'banned' | 'member')[];
23
25
  roles?: string[];
24
26
  sortBy?: 'firstCreated' | 'lastCreated';
27
+ search?: string;
25
28
  page?: Amity.Page;
26
29
  }): Promise<Amity.Cached<Amity.Paged<Amity.Membership<'channel'>>>> => {
27
30
  const client = getActiveClient();
28
31
  client.log('channel/queryChannelMembers', query);
29
32
 
30
- const { page, channelId, membership, ...params } = query ?? {};
33
+ const { page, channelId, ...params } = query ?? {};
31
34
 
32
- const { data } = await client.http.get<Amity.ChannelMembershipPayload & Amity.Pagination>(
33
- `/api/v3/channels/${encodeURIComponent(channelId)}/users`,
34
- {
35
- params: {
36
- ...params,
37
- filter: membership,
38
- options: {
39
- token: toToken(page, 'skiplimit'),
40
- },
35
+ const { data: queryPayload } = await client.http.get<
36
+ Amity.ChannelMembershipPayload & Amity.Pagination
37
+ >(`/api/v4/channels/${encodeURIComponent(channelId)}/users`, {
38
+ params: {
39
+ ...params,
40
+ options: {
41
+ token: toToken(page, 'skiplimit'),
41
42
  },
42
43
  },
43
- );
44
+ });
45
+
46
+ const { paging, ...payload } = queryPayload;
47
+
48
+ const data = prepareChannelPayload(payload);
44
49
 
45
- const { paging, ...payload } = data;
46
- const { channelUsers } = payload;
50
+ const { channelUsers } = data;
47
51
 
48
52
  const cachedAt = client.cache && Date.now();
49
53
  if (client.cache) {
50
- ingestInCache(payload as Amity.ChannelMembershipPayload);
54
+ ingestInCache(data as Amity.ChannelMembershipPayload);
51
55
  }
52
56
 
53
57
  const nextPage = toPage(paging.next);
@@ -5,6 +5,8 @@ import { pushToCache } from '~/cache/api';
5
5
  import { ingestInCache } from '~/cache/api/ingestInCache';
6
6
  import { getResolver } from '~/core/model';
7
7
 
8
+ import { prepareChannelPayload } from '../utils';
9
+
8
10
  /**
9
11
  * ```js
10
12
  * import { queryChannels } from '@amityco/ts-sdk'
@@ -20,15 +22,9 @@ import { getResolver } from '~/core/model';
20
22
  * @category Channel API
21
23
  * @async
22
24
  */
23
- export const queryChannels = async (query?: {
24
- displayName?: string;
25
- membership?: 'all' | 'member' | 'notMember';
26
- sortBy?: 'displayName' | 'firstCreated' | 'lastCreated';
27
- types?: Amity.ChannelType;
28
- tags?: Amity.Taggable['tags'];
29
- excludeTags?: Amity.Taggable['tags'];
30
- page?: Amity.Page;
31
- }): Promise<Amity.Cached<Amity.Paged<Amity.Channel>>> => {
25
+ export const queryChannels = async (
26
+ query?: Amity.QueryChannels,
27
+ ): Promise<Amity.Cached<Amity.Paged<Amity.Channel>>> => {
32
28
  const client = getActiveClient();
33
29
  client.log('channel/queryChannels', query);
34
30
 
@@ -38,7 +34,7 @@ export const queryChannels = async (query?: {
38
34
  // API-FIX: parameters should be querystring.
39
35
  // API-FIX: backend doesnt answer Amity.Response
40
36
  // const { data } = await client.http.get<Amity.Response<Amity.Paged<ChannelPayload>>>(
41
- const { data } = await client.http.get<Amity.ChannelPayload & Amity.Pagination>(
37
+ const { data: queryPayload } = await client.http.get<Amity.ChannelPayload & Amity.Pagination>(
42
38
  `/api/v3/channels`,
43
39
  {
44
40
  params: {
@@ -52,13 +48,16 @@ export const queryChannels = async (query?: {
52
48
  },
53
49
  );
54
50
 
55
- const { paging, ...payload } = data;
56
- const { channels } = payload;
51
+ const { paging, ...payload } = queryPayload;
52
+
53
+ const data = prepareChannelPayload(payload);
54
+
55
+ const { channels } = data;
57
56
 
58
57
  const cachedAt = client.cache && Date.now();
59
58
 
60
59
  if (client.cache) {
61
- ingestInCache(payload as Amity.ChannelPayload, { cachedAt });
60
+ ingestInCache(data as Amity.ChannelPayload, { cachedAt });
62
61
 
63
62
  const cacheKey = [
64
63
  'channel',
@@ -3,6 +3,8 @@ import { getActiveClient } from '~/client/api';
3
3
  import { ingestInCache } from '~/cache/api/ingestInCache';
4
4
  import { fireEvent } from '~/core/events';
5
5
 
6
+ import { prepareChannelPayload } from '../utils';
7
+
6
8
  /**
7
9
  * ```js
8
10
  * import { removeChannelMembers } from '@amityco/ts-sdk'
@@ -25,16 +27,16 @@ export const removeChannelMembers = async (
25
27
  const client = getActiveClient();
26
28
  client.log('channel/removeChannelMembers', channelId, userIds);
27
29
 
28
- const { data } = await client.http.delete<Amity.ChannelMembershipPayload>(
30
+ const { data: payload } = await client.http.delete<Amity.ChannelMembershipPayload>(
29
31
  `/api/v3/channels/${encodeURIComponent(channelId)}/users`,
30
32
  { data: { channelId, userIds } },
31
33
  );
32
34
 
35
+ const data = prepareChannelPayload(payload);
36
+
33
37
  if (client.cache) ingestInCache(data);
34
38
 
35
- fireEvent('v3.channel.didRemoveUsers', {
36
- channels: data.channels!,
37
- });
39
+ fireEvent('v3.channel.didRemoveUsers', data);
38
40
 
39
41
  const { channelUsers } = data;
40
42
  return !!channelUsers.find(
@@ -2,6 +2,8 @@ import { getActiveClient } from '~/client/api';
2
2
 
3
3
  import { ingestInCache } from '~/cache/api/ingestInCache';
4
4
 
5
+ import { prepareChannelPayload } from '../utils';
6
+
5
7
  /**
6
8
  * ```js
7
9
  * import { removeChannelMembersRole } from '@amityco/ts-sdk'
@@ -26,11 +28,13 @@ export const removeChannelMembersRole = async (
26
28
  const client = getActiveClient();
27
29
  client.log('channel/removeChannelMembersRole', channelId, roleId, userIds);
28
30
 
29
- const { data } = await client.http.delete<Amity.ChannelMembershipPayload>(
31
+ const { data: payload } = await client.http.delete<Amity.ChannelMembershipPayload>(
30
32
  `/api/v3/channels/${encodeURIComponent(channelId)}/users/roles`,
31
33
  { data: { channelId, role: roleId, userIds } },
32
34
  );
33
35
 
36
+ const data = prepareChannelPayload(payload);
37
+
34
38
  if (client.cache) ingestInCache(data);
35
39
 
36
40
  const { channelUsers } = data;
@@ -0,0 +1,45 @@
1
+ import { getActiveClient } from '~/client/api/activeClient';
2
+
3
+ import { ingestInCache } from '~/cache/api/ingestInCache';
4
+
5
+ import { prepareChannelPayload } from '../utils';
6
+
7
+ /**
8
+ * ```js
9
+ * import { unbanChannelMembers } from '@amityco/ts-sdk'
10
+ *
11
+ * await unbanChannelMembers('channel-id-1', ['userId1', 'userId2'])
12
+ * ```
13
+ *
14
+ * @param channelId of {@link Amity.Channel} where the users should be unbanned
15
+ * @param userIds of the {@link Amity.User}'s to be unbanned
16
+ * @returns the updated {@link Amity.Membership}'s object
17
+ *
18
+ * @category Channel API
19
+ * @async
20
+ * */
21
+ export const unbanChannelMembers = async (
22
+ channelId: Amity.Channel['channelId'],
23
+ userIds: Amity.User['userId'][],
24
+ ): Promise<Amity.Cached<Amity.Membership<'channel'>[]>> => {
25
+ const client = getActiveClient();
26
+ client.log('channel/unbanChannelMembers', { userIds, channelId });
27
+
28
+ const { data: payload } = await client.http.put<Amity.ChannelPayload>(
29
+ `/api/v3/channels/${encodeURIComponent(channelId)}/users/unban`,
30
+ {
31
+ userIds,
32
+ },
33
+ );
34
+
35
+ const data = prepareChannelPayload(payload);
36
+
37
+ const cachedAt = client.cache && Date.now();
38
+ if (client.cache) ingestInCache(data, { cachedAt });
39
+
40
+ const { channelUsers } = data;
41
+ return {
42
+ data: channelUsers?.filter(user => user.membership === 'member')!,
43
+ cachedAt,
44
+ };
45
+ };
@@ -2,6 +2,8 @@ import { getActiveClient } from '~/client/api';
2
2
 
3
3
  import { ingestInCache } from '~/cache/api/ingestInCache';
4
4
 
5
+ import { prepareChannelPayload } from '../utils';
6
+
5
7
  /**
6
8
  * ```js
7
9
  * import { updateChannel } from '@amityco/ts-sdk'
@@ -19,16 +21,18 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
19
21
  */
20
22
  export const updateChannel = async (
21
23
  channelId: Amity.Channel['channelId'],
22
- patch: Patch<Amity.Channel, 'displayName' | 'description' | 'avatarFileId' | 'metadata'>,
24
+ patch: Patch<Amity.Channel, 'displayName' | 'avatarFileId' | 'tags' | 'metadata'>,
23
25
  ): Promise<Amity.Cached<Amity.Channel>> => {
24
26
  const client = getActiveClient();
25
27
  client.log('channel/updateChannel', channelId, patch);
26
28
 
27
- const { data } = await client.http.put<Amity.ChannelPayload>(
29
+ const { data: payload } = await client.http.put<Amity.ChannelPayload>(
28
30
  `/api/v3/channels/${encodeURIComponent(channelId)}`,
29
31
  patch,
30
32
  );
31
33
 
34
+ const data = prepareChannelPayload(payload);
35
+
32
36
  const cachedAt = client.cache && Date.now();
33
37
  if (client.cache) ingestInCache(data, { cachedAt });
34
38
 
@@ -1,6 +1,7 @@
1
+ export * from './onChannelCreated';
1
2
  export * from './onChannelUpdated';
2
3
  export * from './onChannelDeleted';
3
4
  export * from './onChannelJoined';
4
5
  export * from './onChannelLeft';
5
- export * from './onMemberAdded';
6
- export * from './onMemberRemoved';
6
+ export * from './onChannelMemberAdded';
7
+ export * from './onChannelMemberRemoved';
@@ -3,6 +3,8 @@ import { createEventSubscriber } from '~/core/events';
3
3
 
4
4
  import { ingestInCache } from '~/cache/api/ingestInCache';
5
5
 
6
+ import { prepareChannelPayload } from '../utils';
7
+
6
8
  /**
7
9
  * ```js
8
10
  * import { onChannelCreated } from '@amityco/ts-sdk'
@@ -22,8 +24,10 @@ export const onChannelCreated = (callback: Amity.Listener<Amity.Channel>) => {
22
24
  const client = getActiveClient();
23
25
 
24
26
  const filter = (payload: Amity.ChannelPayload) => {
25
- ingestInCache(payload);
26
- callback(payload.channels[0]);
27
+ const data = prepareChannelPayload(payload);
28
+
29
+ ingestInCache(data);
30
+ callback(data.channels[0]);
27
31
  };
28
32
 
29
33
  return createEventSubscriber(client, 'onChannelCreated', 'v3.channel.didCreate', filter);
@@ -3,6 +3,8 @@ import { createEventSubscriber } from '~/core/events';
3
3
 
4
4
  import { ingestInCache } from '~/cache/api/ingestInCache';
5
5
 
6
+ import { prepareChannelPayload } from '../utils';
7
+
6
8
  /**
7
9
  * ```js
8
10
  * import { onChannelDeleted } from '@amityco/ts-sdk'
@@ -22,8 +24,10 @@ export const onChannelDeleted = (callback: Amity.Listener<Amity.Channel>) => {
22
24
  const client = getActiveClient();
23
25
 
24
26
  const filter = (payload: Amity.ChannelPayload) => {
25
- ingestInCache(payload);
26
- callback(payload.channels[0]);
27
+ const data = prepareChannelPayload(payload);
28
+
29
+ ingestInCache(data);
30
+ callback(data.channels[0]);
27
31
  };
28
32
 
29
33
  return createEventSubscriber(client, 'onChannelDeleted', 'v3.channel.didDelete', filter);
@@ -3,6 +3,8 @@ import { createEventSubscriber } from '~/core/events';
3
3
 
4
4
  import { ingestInCache } from '~/cache/api/ingestInCache';
5
5
 
6
+ import { prepareChannelPayload } from '../utils';
7
+
6
8
  /**
7
9
  * ```js
8
10
  * import { onChannelJoined } from '@amityco/ts-sdk'
@@ -22,8 +24,10 @@ export const onChannelJoined = (callback: Amity.Listener<Amity.Channel>) => {
22
24
  const client = getActiveClient();
23
25
 
24
26
  const filter = (payload: Amity.ChannelPayload) => {
25
- ingestInCache(payload);
26
- callback(payload.channels[0]);
27
+ const data = prepareChannelPayload(payload);
28
+
29
+ ingestInCache(data);
30
+ callback(data.channels[0]);
27
31
  };
28
32
 
29
33
  return createEventSubscriber(client, 'onChannelJoined', 'v3.channel.didJoin', filter);
@@ -3,6 +3,8 @@ import { createEventSubscriber } from '~/core/events';
3
3
 
4
4
  import { ingestInCache } from '~/cache/api/ingestInCache';
5
5
 
6
+ import { prepareChannelPayload } from '../utils';
7
+
6
8
  /**
7
9
  * ```js
8
10
  * import { onChannelLeft } from '@amityco/ts-sdk'
@@ -22,8 +24,10 @@ export const onChannelLeft = (callback: Amity.Listener<Amity.Channel>) => {
22
24
  const client = getActiveClient();
23
25
 
24
26
  const filter = (payload: Amity.ChannelPayload) => {
25
- ingestInCache(payload);
26
- callback(payload.channels[0]);
27
+ const data = prepareChannelPayload(payload);
28
+
29
+ ingestInCache(data);
30
+ callback(data.channels[0]);
27
31
  };
28
32
 
29
33
  return createEventSubscriber(client, 'onChannelLeft', 'v3.channel.didLeave', filter);
@@ -0,0 +1,36 @@
1
+ import { getActiveClient } from '~/client/api';
2
+ import { createEventSubscriber } from '~/core/events';
3
+
4
+ import { ingestInCache } from '~/cache/api/ingestInCache';
5
+
6
+ import { prepareChannelPayload } from '../utils';
7
+
8
+ /**
9
+ * ```js
10
+ * import { onChannelMemberAdded } from '@amityco/ts-sdk'
11
+ * const dispose = onChannelMemberAdded((channel, member) => {
12
+ * // ...
13
+ * })
14
+ * ```
15
+ *
16
+ * Fired when any {@link Amity.User} has been added to any {@link Amity.Channel}
17
+ *
18
+ * @param callback The function to call when the event was fired
19
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
20
+ *
21
+ * @category Channel Events
22
+ */
23
+ export const onChannelMemberAdded = (
24
+ callback: (channel: Amity.Channel, member: Amity.Membership<'channel'>) => void,
25
+ ) => {
26
+ const client = getActiveClient();
27
+
28
+ const filter = (payload: Amity.ChannelMembershipPayload) => {
29
+ const data = prepareChannelPayload(payload);
30
+
31
+ ingestInCache(data);
32
+ callback(data.channels[0], data.channelUsers[0]);
33
+ };
34
+
35
+ return createEventSubscriber(client, 'onChannelMemberAdded', 'v3.channel.didAddUsers', filter);
36
+ };
@@ -0,0 +1,41 @@
1
+ import { getActiveClient } from '~/client/api';
2
+ import { createEventSubscriber } from '~/core/events';
3
+
4
+ import { ingestInCache } from '~/cache/api/ingestInCache';
5
+
6
+ import { prepareChannelPayload } from '../utils';
7
+
8
+ /**
9
+ * ```js
10
+ * import { onChannelMemberRemoved } from '@amityco/ts-sdk'
11
+ * const dispose = onChannelMemberRemoved((channel, member) => {
12
+ * // ...
13
+ * })
14
+ * ```
15
+ *
16
+ * Fired when any {@link Amity.User} has been removed from any {@link Amity.Channel}
17
+ *
18
+ * @param callback The function to call when the event was fired
19
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
20
+ *
21
+ * @category Channel Events
22
+ */
23
+ export const onChannelMemberRemoved = (
24
+ callback: (channel: Amity.Channel, member: Amity.Membership<'channel'>) => void,
25
+ ) => {
26
+ const client = getActiveClient();
27
+
28
+ const filter = (payload: Amity.ChannelMembershipPayload) => {
29
+ const data = prepareChannelPayload(payload);
30
+
31
+ ingestInCache(data);
32
+ callback(data.channels[0], data.channelUsers[0]);
33
+ };
34
+
35
+ return createEventSubscriber(
36
+ client,
37
+ 'onChannelMemberRemoved',
38
+ 'v3.channel.didRemoveUsers',
39
+ filter,
40
+ );
41
+ };
@@ -3,6 +3,8 @@ import { createEventSubscriber } from '~/core/events';
3
3
 
4
4
  import { ingestInCache } from '~/cache/api/ingestInCache';
5
5
 
6
+ import { prepareChannelPayload } from '../utils';
7
+
6
8
  /**
7
9
  * ```js
8
10
  * import { onChannelUpdated } from '@amityco/ts-sdk'
@@ -22,8 +24,10 @@ export const onChannelUpdated = (callback: Amity.Listener<Amity.Channel>) => {
22
24
  const client = getActiveClient();
23
25
 
24
26
  const filter = (payload: Amity.ChannelPayload) => {
25
- ingestInCache(payload);
26
- callback(payload.channels[0]);
27
+ const data = prepareChannelPayload(payload);
28
+
29
+ ingestInCache(data);
30
+ callback(data.channels[0]);
27
31
  };
28
32
 
29
33
  return createEventSubscriber(client, 'onChannelUpdated', 'v3.channel.didUpdate', filter);
@@ -1 +1,3 @@
1
1
  export * from './observeChannel';
2
+ export * from './observeChannels';
3
+ export * from './liveChannels';
@@ -0,0 +1,178 @@
1
+ /* eslint-disable no-use-before-define */
2
+ import { getResolver } from '~/core/model';
3
+ import { pullFromCache, pushToCache } from '~/cache/api';
4
+ import { getActiveClient } from '~/client/api';
5
+ import {
6
+ createQuery,
7
+ runQuery,
8
+ queryOptions,
9
+ filterByPropEquality,
10
+ sortByLastCreated,
11
+ sortByDisplayName,
12
+ sortByFirstCreated,
13
+ } from '~/core/query';
14
+ import { onChannelCreated, onChannelDeleted, onChannelUpdated } from '../events';
15
+ import { queryChannels } from '../api';
16
+
17
+ import {
18
+ COLLECTION_DEFAULT_CACHING_POLICY,
19
+ COLLECTION_DEFAULT_PAGINATION_LIMIT,
20
+ ENABLE_CACHE_MESSAGE,
21
+ } from '~/utils/constants';
22
+
23
+ /**
24
+ * ```js
25
+ * import { liveChannels } from '@amityco/ts-sdk'
26
+ *
27
+ * let channels = []
28
+ * const unsub = liveChannels({
29
+ * displayName: Amity.Channel['displayName'],
30
+ * }, response => merge(channels, response.data))
31
+ * ```
32
+ *
33
+ * Observe all mutations on a list of {@link Amity.Channel}s
34
+ *
35
+ * @param params for querying channels
36
+ * @param callback the function to call when new data are available
37
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the channels
38
+ *
39
+ * @category Channel Live Collection
40
+ */
41
+ export const liveChannels = (
42
+ params: Amity.ChannelLiveCollection,
43
+ callback: Amity.LiveCollectionCallback<Amity.Channel>,
44
+ config?: Amity.LiveCollectionConfig,
45
+ ) => {
46
+ const { log, cache } = getActiveClient();
47
+
48
+ if (!cache) {
49
+ console.log(ENABLE_CACHE_MESSAGE);
50
+ }
51
+
52
+ const timestamp = Date.now();
53
+ log(`liveChannels(tmpid: ${timestamp}) > listen`);
54
+
55
+ const { limit: queryLimit, ...queryParams } = params;
56
+
57
+ const limit = queryLimit ?? COLLECTION_DEFAULT_PAGINATION_LIMIT;
58
+ const { policy = COLLECTION_DEFAULT_CACHING_POLICY } = config ?? {};
59
+
60
+ const disposers: Amity.Unsubscriber[] = [];
61
+ const cacheKey = ['channel', 'collection', {}];
62
+
63
+ const responder = (data: Amity.ChannelLiveCollectionCache) => {
64
+ let channels: Amity.Channel[] =
65
+ data.data
66
+ .map(channelId => pullFromCache<Amity.Channel>(['channel', 'get', channelId])!)
67
+ .filter(Boolean)
68
+ .map(({ data }) => data) ?? [];
69
+
70
+ channels = filterByPropEquality(channels, 'isDeleted', params.isDeleted);
71
+ channels = filterByPropEquality(channels, 'displayName', params.displayName);
72
+
73
+ if (params.types) {
74
+ channels = channels.filter(c => params.types?.includes(c.type));
75
+ }
76
+
77
+ if (params.tags) {
78
+ channels = channels.filter(c => c.tags?.some(t => params.tags?.includes(t)));
79
+ }
80
+
81
+ if (params.excludeTags) {
82
+ channels = channels.filter(c => !c.tags?.some(t => params.excludeTags?.includes(t)));
83
+ }
84
+
85
+ const sortBy = params.sortBy || 'lastCreated';
86
+
87
+ if (sortBy === 'lastCreated' || sortBy === 'firstCreated') {
88
+ channels = channels.sort(sortBy === 'lastCreated' ? sortByLastCreated : sortByFirstCreated);
89
+ }
90
+
91
+ /*
92
+ * The server returns channels with empty | null displayName's first before
93
+ * returning sorted list of channels with displayNames
94
+ *
95
+ * This section needs to be updated as displayNames can be null as well
96
+ */
97
+ if (sortBy === 'displayName') {
98
+ channels = channels
99
+ // this needs to be aligned with the backend data type
100
+ .map(c => (c.displayName ? c : { ...c, displayName: '' }))
101
+ // @ts-ignore
102
+ .sort(sortByDisplayName);
103
+ }
104
+
105
+ callback({
106
+ onNextPage: onFetch,
107
+ data: channels,
108
+ hasNextPage: !!data.params?.page,
109
+ loading: data.loading,
110
+ error: data.error,
111
+ });
112
+ };
113
+
114
+ const realtimeRouter = (channel: Amity.Channel, action: Amity.ChannelActionType) => {
115
+ const collection = pullFromCache<Amity.ChannelLiveCollectionCache>(cacheKey)?.data;
116
+ if (!collection) return;
117
+
118
+ if (action === 'onCreate') {
119
+ collection.data = [...new Set([channel.channelId, ...collection.data])];
120
+ /*
121
+ * if the filter isDeleted is set, only collection item must be updated and not
122
+ * the collection
123
+ */
124
+ } else if (action === 'onDelete' && !params.isDeleted) {
125
+ collection.data = collection.data.filter(c => c !== channel.channelId);
126
+ }
127
+
128
+ pushToCache(cacheKey, collection);
129
+ responder(collection);
130
+ };
131
+
132
+ const onFetch = () => {
133
+ const collection = pullFromCache<Amity.ChannelLiveCollectionCache>(cacheKey)?.data;
134
+
135
+ const channels = collection?.data ?? [];
136
+
137
+ if (channels.length > 0 && !collection?.params.page) return;
138
+
139
+ const query = createQuery(queryChannels, {
140
+ ...queryParams,
141
+ page: collection?.params.page ?? { limit },
142
+ });
143
+
144
+ runQuery(
145
+ query,
146
+ ({ data: result, error, loading, nextPage: page }) => {
147
+ const data = {
148
+ loading,
149
+ error,
150
+ params: { page },
151
+ data: channels,
152
+ };
153
+
154
+ if (result) {
155
+ data.data = [...new Set([...channels, ...result.map(getResolver('channel'))])];
156
+ }
157
+
158
+ pushToCache(cacheKey, data);
159
+
160
+ responder(data);
161
+ },
162
+ queryOptions(policy),
163
+ );
164
+ };
165
+
166
+ disposers.push(
167
+ onChannelCreated(channel => realtimeRouter(channel, 'onCreate')),
168
+ onChannelDeleted(channel => realtimeRouter(channel, 'onDelete')),
169
+ onChannelUpdated(channel => realtimeRouter(channel, 'onUpdate')),
170
+ );
171
+
172
+ onFetch();
173
+
174
+ return () => {
175
+ log(`liveChannels(tmpid: ${timestamp}) > dispose`);
176
+ disposers.forEach(fn => fn());
177
+ };
178
+ };
@@ -9,8 +9,8 @@ import {
9
9
  onChannelDeleted,
10
10
  onChannelJoined,
11
11
  onChannelLeft,
12
- onMemberAdded,
13
- onMemberRemoved,
12
+ onChannelMemberAdded,
13
+ onChannelMemberRemoved,
14
14
  } from '../events';
15
15
 
16
16
  /**
@@ -29,17 +29,7 @@ import {
29
29
  *
30
30
  * @category Channel Observer
31
31
  */
32
- export const observeChannel = <
33
- Events extends [
34
- 'onFetch',
35
- 'onUpdate',
36
- 'onDelete',
37
- 'onJoin',
38
- 'onLeft',
39
- 'onMemberAdded',
40
- 'onMemberRemoved',
41
- ],
42
- >(
32
+ export const observeChannel = <Events extends [Exclude<Amity.ChannelActionType, 'onCreate'>]>(
43
33
  channelId: string,
44
34
  callback: Amity.ObjectListener<Amity.Snapshot<Amity.Channel>, Events>,
45
35
  ): Amity.Unsubscriber => {
@@ -67,8 +57,12 @@ export const observeChannel = <
67
57
  onChannelDeleted(data => router({ data, loading: false, origin: 'event' }, 'onDelete')),
68
58
  onChannelJoined(data => router({ data, loading: false, origin: 'event' }, 'onJoin')),
69
59
  onChannelLeft(data => router({ data, loading: false, origin: 'event' }, 'onLeft')),
70
- onMemberAdded(data => router({ data, loading: false, origin: 'event' }, 'onMemberAdded')),
71
- onMemberRemoved(data => router({ data, loading: false, origin: 'event' }, 'onMemberRemoved')),
60
+ onChannelMemberAdded(data =>
61
+ router({ data, loading: false, origin: 'event' }, 'onMemberAdded'),
62
+ ),
63
+ onChannelMemberRemoved(data =>
64
+ router({ data, loading: false, origin: 'event' }, 'onMemberRemoved'),
65
+ ),
72
66
  );
73
67
 
74
68
  runQuery(createQuery(getChannel, channelId), result => result.data && router(result, 'onFetch'));