@amityco/ts-sdk 0.0.1-be4fc2f.0 → 0.0.1-beta.10

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 (527) hide show
  1. package/README.md +2 -2
  2. package/dist/@types/core/cache.d.ts +49 -9
  3. package/dist/@types/core/cache.d.ts.map +1 -1
  4. package/dist/@types/core/events.d.ts +22 -12
  5. package/dist/@types/core/events.d.ts.map +1 -1
  6. package/dist/@types/core/model.d.ts +1 -0
  7. package/dist/@types/core/model.d.ts.map +1 -1
  8. package/dist/@types/core/paging.d.ts +59 -0
  9. package/dist/@types/core/paging.d.ts.map +1 -0
  10. package/dist/@types/core/permissions.d.ts +1 -1
  11. package/dist/@types/core/permissions.d.ts.map +1 -1
  12. package/dist/@types/core/query.d.ts +13 -43
  13. package/dist/@types/core/query.d.ts.map +1 -1
  14. package/dist/@types/core/transport.d.ts +3 -2
  15. package/dist/@types/core/transport.d.ts.map +1 -1
  16. package/dist/@types/domains/category.d.ts +1 -1
  17. package/dist/@types/domains/category.d.ts.map +1 -1
  18. package/dist/@types/domains/channel.d.ts +1 -1
  19. package/dist/@types/domains/channel.d.ts.map +1 -1
  20. package/dist/@types/domains/client.d.ts +2 -0
  21. package/dist/@types/domains/client.d.ts.map +1 -1
  22. package/dist/@types/domains/comment.d.ts +1 -1
  23. package/dist/@types/domains/comment.d.ts.map +1 -1
  24. package/dist/@types/domains/community.d.ts +1 -1
  25. package/dist/@types/domains/community.d.ts.map +1 -1
  26. package/dist/@types/domains/content.d.ts +1 -2
  27. package/dist/@types/domains/content.d.ts.map +1 -1
  28. package/dist/@types/domains/file.d.ts +1 -1
  29. package/dist/@types/domains/file.d.ts.map +1 -1
  30. package/dist/@types/domains/group.d.ts +3 -3
  31. package/dist/@types/domains/group.d.ts.map +1 -1
  32. package/dist/@types/domains/message.d.ts +1 -1
  33. package/dist/@types/domains/message.d.ts.map +1 -1
  34. package/dist/@types/domains/post.d.ts +1 -1
  35. package/dist/@types/domains/post.d.ts.map +1 -1
  36. package/dist/@types/domains/stream.d.ts +1 -1
  37. package/dist/@types/domains/stream.d.ts.map +1 -1
  38. package/dist/@types/domains/user.d.ts +2 -1
  39. package/dist/@types/domains/user.d.ts.map +1 -1
  40. package/dist/@types/index.d.ts +1 -1
  41. package/dist/@types/index.d.ts.map +1 -1
  42. package/dist/cache/api/backupCache.d.ts +24 -0
  43. package/dist/cache/api/backupCache.d.ts.map +1 -0
  44. package/dist/cache/api/disableCache.d.ts +13 -0
  45. package/dist/cache/api/disableCache.d.ts.map +1 -0
  46. package/dist/cache/api/dropFromCache.d.ts +17 -0
  47. package/dist/cache/api/dropFromCache.d.ts.map +1 -0
  48. package/dist/cache/api/enableCache.d.ts +18 -0
  49. package/dist/cache/api/enableCache.d.ts.map +1 -0
  50. package/dist/cache/api/index.d.ts +12 -0
  51. package/dist/cache/api/index.d.ts.map +1 -0
  52. package/dist/cache/api/ingestInCache.d.ts +11 -0
  53. package/dist/cache/api/ingestInCache.d.ts.map +1 -0
  54. package/dist/cache/api/mergeInCache.d.ts +20 -0
  55. package/dist/cache/api/mergeInCache.d.ts.map +1 -0
  56. package/dist/cache/api/pullFromCache.d.ts +17 -0
  57. package/dist/cache/api/pullFromCache.d.ts.map +1 -0
  58. package/dist/cache/api/pushToCache.d.ts +17 -0
  59. package/dist/cache/api/pushToCache.d.ts.map +1 -0
  60. package/dist/cache/api/queryCache.d.ts +17 -0
  61. package/dist/cache/api/queryCache.d.ts.map +1 -0
  62. package/dist/cache/api/restoreCache.d.ts +22 -0
  63. package/dist/cache/api/restoreCache.d.ts.map +1 -0
  64. package/dist/cache/api/snipeIdFromCollection.d.ts +18 -0
  65. package/dist/cache/api/snipeIdFromCollection.d.ts.map +1 -0
  66. package/dist/cache/api/upsertInCache.d.ts +19 -0
  67. package/dist/cache/api/upsertInCache.d.ts.map +1 -0
  68. package/dist/cache/api/wipeCache.d.ts +21 -0
  69. package/dist/cache/api/wipeCache.d.ts.map +1 -0
  70. package/dist/cache/utils/index.d.ts +41 -0
  71. package/dist/cache/utils/index.d.ts.map +1 -0
  72. package/dist/category/api/getCategory.d.ts.map +1 -1
  73. package/dist/category/api/queryCategories.d.ts +5 -4
  74. package/dist/category/api/queryCategories.d.ts.map +1 -1
  75. package/dist/channel/api/addChannelMembers.d.ts.map +1 -1
  76. package/dist/channel/api/addChannelMembersRole.d.ts.map +1 -1
  77. package/dist/channel/api/createChannel.d.ts +1 -1
  78. package/dist/channel/api/createChannel.d.ts.map +1 -1
  79. package/dist/channel/api/deleteChannel.d.ts +1 -1
  80. package/dist/channel/api/deleteChannel.d.ts.map +1 -1
  81. package/dist/channel/api/getChannel.d.ts +2 -2
  82. package/dist/channel/api/getChannel.d.ts.map +1 -1
  83. package/dist/channel/api/getChannels.d.ts +2 -2
  84. package/dist/channel/api/getChannels.d.ts.map +1 -1
  85. package/dist/channel/api/joinChannel.d.ts.map +1 -1
  86. package/dist/channel/api/leaveChannel.d.ts.map +1 -1
  87. package/dist/channel/api/queryChannelMembers.d.ts +1 -5
  88. package/dist/channel/api/queryChannelMembers.d.ts.map +1 -1
  89. package/dist/channel/api/queryChannels.d.ts +1 -5
  90. package/dist/channel/api/queryChannels.d.ts.map +1 -1
  91. package/dist/channel/api/removeChannelMembers.d.ts.map +1 -1
  92. package/dist/channel/api/removeChannelMembersRole.d.ts.map +1 -1
  93. package/dist/channel/api/updateChannel.d.ts +1 -1
  94. package/dist/channel/api/updateChannel.d.ts.map +1 -1
  95. package/dist/channel/events/onChannelDeleted.d.ts.map +1 -1
  96. package/dist/channel/events/onChannelJoined.d.ts.map +1 -1
  97. package/dist/channel/events/onChannelLeft.d.ts.map +1 -1
  98. package/dist/channel/events/onChannelUpdated.d.ts.map +1 -1
  99. package/dist/channel/events/onMemberAdded.d.ts.map +1 -1
  100. package/dist/channel/events/onMemberRemoved.d.ts.map +1 -1
  101. package/dist/channel/observers/observeChannel.d.ts +1 -3
  102. package/dist/channel/observers/observeChannel.d.ts.map +1 -1
  103. package/dist/client/api/connectClient.d.ts.map +1 -1
  104. package/dist/client/api/disconnectClient.d.ts.map +1 -1
  105. package/dist/client/api/getToken.d.ts +3 -1
  106. package/dist/client/api/getToken.d.ts.map +1 -1
  107. package/dist/client/api/index.d.ts +0 -2
  108. package/dist/client/api/index.d.ts.map +1 -1
  109. package/dist/comment/api/createComment.d.ts +1 -1
  110. package/dist/comment/api/createComment.d.ts.map +1 -1
  111. package/dist/comment/api/deleteComment.d.ts +1 -37
  112. package/dist/comment/api/deleteComment.d.ts.map +1 -1
  113. package/dist/comment/api/getComment.d.ts +2 -2
  114. package/dist/comment/api/getComment.d.ts.map +1 -1
  115. package/dist/comment/api/getComments.d.ts +2 -2
  116. package/dist/comment/api/getComments.d.ts.map +1 -1
  117. package/dist/comment/api/queryComments.d.ts +4 -18
  118. package/dist/comment/api/queryComments.d.ts.map +1 -1
  119. package/dist/comment/api/updateComment.d.ts +1 -1
  120. package/dist/comment/api/updateComment.d.ts.map +1 -1
  121. package/dist/comment/events/onCommentCreated.d.ts +2 -2
  122. package/dist/comment/events/onCommentCreated.d.ts.map +1 -1
  123. package/dist/comment/events/onCommentDeleted.d.ts +2 -2
  124. package/dist/comment/events/onCommentDeleted.d.ts.map +1 -1
  125. package/dist/comment/events/onCommentFlagged.d.ts +2 -2
  126. package/dist/comment/events/onCommentFlagged.d.ts.map +1 -1
  127. package/dist/comment/events/onCommentReactionAdded.d.ts +2 -2
  128. package/dist/comment/events/onCommentReactionAdded.d.ts.map +1 -1
  129. package/dist/comment/events/onCommentReactionRemoved.d.ts +2 -2
  130. package/dist/comment/events/onCommentReactionRemoved.d.ts.map +1 -1
  131. package/dist/comment/events/onCommentUnflagged.d.ts +2 -2
  132. package/dist/comment/events/onCommentUnflagged.d.ts.map +1 -1
  133. package/dist/comment/events/onCommentUpdated.d.ts +2 -2
  134. package/dist/comment/events/onCommentUpdated.d.ts.map +1 -1
  135. package/dist/comment/events/utils.d.ts +1 -1
  136. package/dist/comment/events/utils.d.ts.map +1 -1
  137. package/dist/comment/observers/observeComment.d.ts +1 -3
  138. package/dist/comment/observers/observeComment.d.ts.map +1 -1
  139. package/dist/community/api/addCommunityMembers.d.ts.map +1 -1
  140. package/dist/community/api/addCommunityMembersRole.d.ts.map +1 -1
  141. package/dist/community/api/createCommunity.d.ts +1 -1
  142. package/dist/community/api/createCommunity.d.ts.map +1 -1
  143. package/dist/community/api/deleteCommunity.d.ts.map +1 -1
  144. package/dist/community/api/getCommunities.d.ts +2 -2
  145. package/dist/community/api/getCommunities.d.ts.map +1 -1
  146. package/dist/community/api/getCommunity.d.ts +2 -2
  147. package/dist/community/api/getCommunity.d.ts.map +1 -1
  148. package/dist/community/api/joinCommunity.d.ts.map +1 -1
  149. package/dist/community/api/leaveCommunity.d.ts.map +1 -1
  150. package/dist/community/api/queryCommunities.d.ts +1 -5
  151. package/dist/community/api/queryCommunities.d.ts.map +1 -1
  152. package/dist/community/api/queryCommunityMembers.d.ts +1 -5
  153. package/dist/community/api/queryCommunityMembers.d.ts.map +1 -1
  154. package/dist/community/api/removeCommunityMembers.d.ts.map +1 -1
  155. package/dist/community/api/removeCommunityMembersRole.d.ts.map +1 -1
  156. package/dist/community/api/updateCommunity.d.ts +1 -1
  157. package/dist/community/api/updateCommunity.d.ts.map +1 -1
  158. package/dist/community/events/onCommunityCreated.d.ts +1 -1
  159. package/dist/community/events/onCommunityDeleted.d.ts +1 -1
  160. package/dist/community/events/onCommunityJoined.d.ts +3 -3
  161. package/dist/community/events/onCommunityJoined.d.ts.map +1 -1
  162. package/dist/community/events/onCommunityLeft.d.ts +3 -3
  163. package/dist/community/events/onCommunityLeft.d.ts.map +1 -1
  164. package/dist/community/events/onCommunityUpdated.d.ts +1 -1
  165. package/dist/community/events/onCommunityUserAdded.d.ts +3 -3
  166. package/dist/community/events/onCommunityUserAdded.d.ts.map +1 -1
  167. package/dist/community/events/onCommunityUserBanned.d.ts +3 -3
  168. package/dist/community/events/onCommunityUserBanned.d.ts.map +1 -1
  169. package/dist/community/events/onCommunityUserRemoved.d.ts +3 -3
  170. package/dist/community/events/onCommunityUserRemoved.d.ts.map +1 -1
  171. package/dist/community/events/onCommunityUserUnbanned.d.ts +3 -3
  172. package/dist/community/events/onCommunityUserUnbanned.d.ts.map +1 -1
  173. package/dist/community/events/utils.d.ts +1 -0
  174. package/dist/community/events/utils.d.ts.map +1 -1
  175. package/dist/community/observers/observeCommunity.d.ts +1 -3
  176. package/dist/community/observers/observeCommunity.d.ts.map +1 -1
  177. package/dist/core/events.d.ts +3 -3
  178. package/dist/core/events.d.ts.map +1 -1
  179. package/dist/core/model/idResolvers.d.ts +9 -11
  180. package/dist/core/model/idResolvers.d.ts.map +1 -1
  181. package/dist/core/model/identifyModel.d.ts +1 -1
  182. package/dist/core/model/identifyModel.d.ts.map +1 -1
  183. package/dist/core/model/index.d.ts +6 -2
  184. package/dist/core/model/index.d.ts.map +1 -1
  185. package/dist/core/query/index.d.ts +0 -1
  186. package/dist/core/query/index.d.ts.map +1 -1
  187. package/dist/core/query/paging.d.ts +21 -3
  188. package/dist/core/query/paging.d.ts.map +1 -1
  189. package/dist/core/query/query.d.ts +9 -21
  190. package/dist/core/query/query.d.ts.map +1 -1
  191. package/dist/core/subscription.d.ts +13 -2
  192. package/dist/core/subscription.d.ts.map +1 -1
  193. package/dist/core/transports/mqtt.d.ts +2 -1
  194. package/dist/core/transports/mqtt.d.ts.map +1 -1
  195. package/dist/core/transports/ws.d.ts.map +1 -1
  196. package/dist/feed/api/queryGlobalFeed.d.ts +1 -5
  197. package/dist/feed/api/queryGlobalFeed.d.ts.map +1 -1
  198. package/dist/file/api/createFile.d.ts +1 -1
  199. package/dist/file/api/createFile.d.ts.map +1 -1
  200. package/dist/file/api/deleteFile.d.ts.map +1 -1
  201. package/dist/file/api/getFile.d.ts +2 -2
  202. package/dist/file/api/getFile.d.ts.map +1 -1
  203. package/dist/file/observers/observeFile.d.ts +1 -3
  204. package/dist/file/observers/observeFile.d.ts.map +1 -1
  205. package/dist/index.cjs.js +17428 -2854
  206. package/dist/index.d.ts +3 -2
  207. package/dist/index.d.ts.map +1 -1
  208. package/dist/index.esm.js +17411 -2840
  209. package/dist/index.umd.js +6 -4
  210. package/dist/message/api/createMessage.d.ts +2 -2
  211. package/dist/message/api/createMessage.d.ts.map +1 -1
  212. package/dist/message/api/deleteMessage.d.ts +2 -2
  213. package/dist/message/api/deleteMessage.d.ts.map +1 -1
  214. package/dist/message/api/getMessage.d.ts +2 -2
  215. package/dist/message/api/getMessage.d.ts.map +1 -1
  216. package/dist/message/api/getMessages.d.ts +2 -2
  217. package/dist/message/api/getMessages.d.ts.map +1 -1
  218. package/dist/message/api/queryMessages.d.ts +2 -16
  219. package/dist/message/api/queryMessages.d.ts.map +1 -1
  220. package/dist/message/api/updateMessage.d.ts +2 -2
  221. package/dist/message/api/updateMessage.d.ts.map +1 -1
  222. package/dist/message/events/onMessageCreated.d.ts.map +1 -1
  223. package/dist/message/events/onMessageDeleted.d.ts.map +1 -1
  224. package/dist/message/events/onMessageUpdated.d.ts.map +1 -1
  225. package/dist/message/observers/observeMessage.d.ts +1 -3
  226. package/dist/message/observers/observeMessage.d.ts.map +1 -1
  227. package/dist/message/observers/observeMessages.d.ts +1 -1
  228. package/dist/message/observers/observeMessages.d.ts.map +1 -1
  229. package/dist/post/api/createPost.d.ts +1 -1
  230. package/dist/post/api/createPost.d.ts.map +1 -1
  231. package/dist/post/api/deletePost.d.ts +1 -40
  232. package/dist/post/api/deletePost.d.ts.map +1 -1
  233. package/dist/post/api/getPost.d.ts +5 -5
  234. package/dist/post/api/getPost.d.ts.map +1 -1
  235. package/dist/post/api/getPosts.d.ts +4 -4
  236. package/dist/post/api/getPosts.d.ts.map +1 -1
  237. package/dist/post/api/queryPosts.d.ts +4 -8
  238. package/dist/post/api/queryPosts.d.ts.map +1 -1
  239. package/dist/post/api/updatePost.d.ts +1 -1
  240. package/dist/post/api/updatePost.d.ts.map +1 -1
  241. package/dist/post/events/onPostApproved.d.ts +1 -1
  242. package/dist/post/events/onPostCreated.d.ts +1 -1
  243. package/dist/post/events/onPostDeclined.d.ts +1 -1
  244. package/dist/post/events/onPostDeleted.d.ts +1 -1
  245. package/dist/post/events/onPostDeleted.d.ts.map +1 -1
  246. package/dist/post/events/onPostFlagged.d.ts +1 -1
  247. package/dist/post/events/onPostReactionAdded.d.ts +1 -1
  248. package/dist/post/events/onPostReactionAdded.d.ts.map +1 -1
  249. package/dist/post/events/onPostReactionRemoved.d.ts +1 -1
  250. package/dist/post/events/onPostReactionRemoved.d.ts.map +1 -1
  251. package/dist/post/events/onPostUnflagged.d.ts +1 -1
  252. package/dist/post/events/onPostUpdated.d.ts +1 -1
  253. package/dist/post/events/utils.d.ts.map +1 -1
  254. package/dist/post/observers/observePost.d.ts +1 -3
  255. package/dist/post/observers/observePost.d.ts.map +1 -1
  256. package/dist/reaction/api/addReaction.d.ts +1 -1
  257. package/dist/reaction/api/addReaction.d.ts.map +1 -1
  258. package/dist/reaction/api/removeReaction.d.ts +1 -1
  259. package/dist/reaction/api/removeReaction.d.ts.map +1 -1
  260. package/dist/reaction/events/onReactionAdded.d.ts +4 -2
  261. package/dist/reaction/events/onReactionAdded.d.ts.map +1 -1
  262. package/dist/reaction/events/onReactionRemoved.d.ts +4 -2
  263. package/dist/reaction/events/onReactionRemoved.d.ts.map +1 -1
  264. package/dist/reaction/utils/fetchReference.d.ts +1 -1
  265. package/dist/reaction/utils/fetchReference.d.ts.map +1 -1
  266. package/dist/reaction/utils/index.d.ts +1 -0
  267. package/dist/reaction/utils/index.d.ts.map +1 -1
  268. package/dist/reaction/utils/preparePayloadForCache.d.ts +3 -0
  269. package/dist/reaction/utils/preparePayloadForCache.d.ts.map +1 -0
  270. package/dist/report/api/createReport.d.ts.map +1 -1
  271. package/dist/report/api/deleteReport.d.ts.map +1 -1
  272. package/dist/role/api/getRole.d.ts +2 -2
  273. package/dist/role/api/getRole.d.ts.map +1 -1
  274. package/dist/role/api/queryRoles.d.ts +1 -5
  275. package/dist/role/api/queryRoles.d.ts.map +1 -1
  276. package/dist/stream/api/createStream.d.ts +1 -1
  277. package/dist/stream/api/createStream.d.ts.map +1 -1
  278. package/dist/stream/api/deleteStream.d.ts.map +1 -1
  279. package/dist/stream/api/disposeStream.d.ts +1 -1
  280. package/dist/stream/api/disposeStream.d.ts.map +1 -1
  281. package/dist/stream/api/getStream.d.ts +2 -2
  282. package/dist/stream/api/getStream.d.ts.map +1 -1
  283. package/dist/stream/api/queryStreams.d.ts +1 -5
  284. package/dist/stream/api/queryStreams.d.ts.map +1 -1
  285. package/dist/stream/api/updateStream.d.ts +1 -1
  286. package/dist/stream/api/updateStream.d.ts.map +1 -1
  287. package/dist/stream/events/onStreamRecorded.d.ts.map +1 -1
  288. package/dist/stream/events/onStreamStarted.d.ts.map +1 -1
  289. package/dist/stream/events/onStreamStopped.d.ts.map +1 -1
  290. package/dist/user/api/getUser.d.ts +4 -4
  291. package/dist/user/api/getUser.d.ts.map +1 -1
  292. package/dist/user/api/getUsers.d.ts +4 -4
  293. package/dist/user/api/getUsers.d.ts.map +1 -1
  294. package/dist/user/api/queryUsers.d.ts +7 -11
  295. package/dist/user/api/queryUsers.d.ts.map +1 -1
  296. package/dist/user/api/updateUser.d.ts +1 -1
  297. package/dist/user/api/updateUser.d.ts.map +1 -1
  298. package/dist/user/events/onUserFlagCleared.d.ts +1 -1
  299. package/dist/user/events/onUserFlagged.d.ts +1 -1
  300. package/dist/user/events/onUserUnflagged.d.ts +1 -1
  301. package/dist/user/events/onUserUpdated.d.ts +1 -1
  302. package/dist/user/events/utils.d.ts.map +1 -1
  303. package/dist/user/observers/observeUser.d.ts +1 -3
  304. package/dist/user/observers/observeUser.d.ts.map +1 -1
  305. package/package.json +6 -5
  306. package/src/@types/core/cache.ts +56 -9
  307. package/src/@types/core/events.ts +14 -11
  308. package/src/@types/core/model.ts +2 -0
  309. package/src/@types/core/paging.ts +75 -0
  310. package/src/@types/core/permissions.ts +0 -1
  311. package/src/@types/core/query.ts +14 -55
  312. package/src/@types/core/transport.ts +4 -2
  313. package/src/@types/domains/category.ts +0 -1
  314. package/src/@types/domains/channel.ts +0 -1
  315. package/src/@types/domains/client.ts +2 -0
  316. package/src/@types/domains/comment.ts +0 -1
  317. package/src/@types/domains/community.ts +0 -1
  318. package/src/@types/domains/content.ts +17 -15
  319. package/src/@types/domains/file.ts +0 -1
  320. package/src/@types/domains/group.ts +2 -3
  321. package/src/@types/domains/message.ts +0 -1
  322. package/src/@types/domains/post.ts +8 -8
  323. package/src/@types/domains/stream.ts +0 -1
  324. package/src/@types/domains/user.ts +1 -1
  325. package/src/@types/index.ts +1 -1
  326. package/src/@types/mqtt.d.ts +3 -0
  327. package/src/cache/api/backupCache.ts +53 -0
  328. package/src/cache/api/disableCache.ts +23 -0
  329. package/src/cache/api/dropFromCache.ts +44 -0
  330. package/src/cache/api/enableCache.ts +29 -0
  331. package/src/cache/api/index.ts +23 -0
  332. package/src/cache/api/ingestInCache.ts +33 -0
  333. package/src/cache/api/mergeInCache.ts +45 -0
  334. package/src/cache/api/pullFromCache.ts +33 -0
  335. package/src/cache/api/pushToCache.ts +40 -0
  336. package/src/cache/api/queryCache.ts +35 -0
  337. package/src/cache/api/restoreCache.ts +43 -0
  338. package/src/cache/api/snipeIdFromCollection.ts +53 -0
  339. package/src/cache/api/upsertInCache.ts +39 -0
  340. package/src/cache/api/wipeCache.ts +36 -0
  341. package/src/cache/utils/index.ts +84 -0
  342. package/src/category/api/getCategory.ts +3 -4
  343. package/src/category/api/queryCategories.ts +5 -6
  344. package/src/channel/api/addChannelMembers.ts +4 -5
  345. package/src/channel/api/addChannelMembersRole.ts +3 -5
  346. package/src/channel/api/createChannel.ts +16 -11
  347. package/src/channel/api/deleteChannel.ts +2 -2
  348. package/src/channel/api/getChannel.ts +22 -9
  349. package/src/channel/api/getChannels.ts +25 -12
  350. package/src/channel/api/joinChannel.ts +5 -6
  351. package/src/channel/api/leaveChannel.ts +5 -6
  352. package/src/channel/api/queryChannelMembers.ts +9 -11
  353. package/src/channel/api/queryChannels.ts +19 -12
  354. package/src/channel/api/removeChannelMembers.ts +4 -5
  355. package/src/channel/api/removeChannelMembersRole.ts +3 -5
  356. package/src/channel/api/updateChannel.ts +9 -7
  357. package/src/channel/events/onChannelDeleted.ts +1 -3
  358. package/src/channel/events/onChannelJoined.ts +1 -3
  359. package/src/channel/events/onChannelLeft.ts +1 -3
  360. package/src/channel/events/onChannelUpdated.ts +1 -3
  361. package/src/channel/events/onMemberAdded.ts +1 -3
  362. package/src/channel/events/onMemberRemoved.ts +1 -3
  363. package/src/channel/observers/observeChannel.ts +20 -14
  364. package/src/client/api/connectClient.ts +7 -7
  365. package/src/client/api/disconnectClient.ts +3 -0
  366. package/src/client/api/getToken.ts +3 -2
  367. package/src/client/api/index.ts +3 -2
  368. package/src/comment/api/createComment.ts +10 -7
  369. package/src/comment/api/deleteComment.ts +9 -8
  370. package/src/comment/api/getComment.ts +22 -10
  371. package/src/comment/api/getComments.ts +25 -12
  372. package/src/comment/api/queryComments.ts +35 -89
  373. package/src/comment/api/updateComment.ts +9 -6
  374. package/src/comment/events/onCommentCreated.ts +3 -3
  375. package/src/comment/events/onCommentDeleted.ts +3 -3
  376. package/src/comment/events/onCommentFlagged.ts +3 -3
  377. package/src/comment/events/onCommentReactionAdded.ts +40 -6
  378. package/src/comment/events/onCommentReactionRemoved.ts +40 -6
  379. package/src/comment/events/onCommentUnflagged.ts +3 -3
  380. package/src/comment/events/onCommentUpdated.ts +3 -3
  381. package/src/comment/events/utils.ts +30 -8
  382. package/src/comment/observers/observeComment.ts +20 -25
  383. package/src/community/api/addCommunityMembers.ts +5 -6
  384. package/src/community/api/addCommunityMembersRole.ts +3 -5
  385. package/src/community/api/createCommunity.ts +9 -6
  386. package/src/community/api/deleteCommunity.ts +3 -3
  387. package/src/community/api/getCommunities.ts +25 -12
  388. package/src/community/api/getCommunity.ts +23 -9
  389. package/src/community/api/joinCommunity.ts +7 -5
  390. package/src/community/api/leaveCommunity.ts +7 -5
  391. package/src/community/api/queryCommunities.ts +18 -12
  392. package/src/community/api/queryCommunityMembers.ts +10 -11
  393. package/src/community/api/removeCommunityMembers.ts +4 -5
  394. package/src/community/api/removeCommunityMembersRole.ts +3 -5
  395. package/src/community/api/updateCommunity.ts +10 -7
  396. package/src/community/events/onCommunityCreated.ts +1 -1
  397. package/src/community/events/onCommunityDeleted.ts +1 -1
  398. package/src/community/events/onCommunityJoined.ts +5 -5
  399. package/src/community/events/onCommunityLeft.ts +5 -5
  400. package/src/community/events/onCommunityUpdated.ts +1 -1
  401. package/src/community/events/onCommunityUserAdded.ts +5 -5
  402. package/src/community/events/onCommunityUserBanned.ts +5 -5
  403. package/src/community/events/onCommunityUserRemoved.ts +5 -5
  404. package/src/community/events/onCommunityUserUnbanned.ts +5 -5
  405. package/src/community/events/utils.ts +94 -4
  406. package/src/community/observers/observeCommunity.ts +21 -22
  407. package/src/core/model/idResolvers.ts +10 -40
  408. package/src/core/model/identifyModel.ts +37 -16
  409. package/src/core/model/index.ts +22 -2
  410. package/src/core/query/index.ts +0 -1
  411. package/src/core/query/paging.ts +43 -3
  412. package/src/core/query/query.ts +63 -115
  413. package/src/core/subscription.ts +66 -17
  414. package/src/core/transports/mqtt.ts +86 -20
  415. package/src/core/transports/ws.ts +1 -0
  416. package/src/feed/api/queryGlobalFeed.ts +7 -10
  417. package/src/file/api/createFile.ts +8 -6
  418. package/src/file/api/deleteFile.ts +5 -6
  419. package/src/file/api/getFile.ts +21 -9
  420. package/src/file/observers/observeFile.ts +5 -7
  421. package/src/index.ts +6 -6
  422. package/src/message/api/createMessage.ts +21 -17
  423. package/src/message/api/deleteMessage.ts +12 -11
  424. package/src/message/api/getMessage.ts +22 -10
  425. package/src/message/api/getMessages.ts +25 -12
  426. package/src/message/api/queryMessages.ts +34 -68
  427. package/src/message/api/updateMessage.ts +22 -12
  428. package/src/message/events/onMessageCreated.ts +1 -3
  429. package/src/message/events/onMessageDeleted.ts +1 -3
  430. package/src/message/events/onMessageUpdated.ts +1 -3
  431. package/src/message/observers/observeMessage.ts +8 -10
  432. package/src/message/observers/observeMessages.ts +6 -6
  433. package/src/post/api/createPost.ts +9 -6
  434. package/src/post/api/deletePost.ts +11 -9
  435. package/src/post/api/getPost.ts +26 -14
  436. package/src/post/api/getPosts.ts +27 -14
  437. package/src/post/api/queryPosts.ts +46 -19
  438. package/src/post/api/updatePost.ts +10 -6
  439. package/src/post/events/onPostApproved.ts +1 -1
  440. package/src/post/events/onPostCreated.ts +1 -1
  441. package/src/post/events/onPostDeclined.ts +1 -1
  442. package/src/post/events/onPostDeleted.ts +2 -2
  443. package/src/post/events/onPostFlagged.ts +1 -1
  444. package/src/post/events/onPostReactionAdded.ts +38 -4
  445. package/src/post/events/onPostReactionRemoved.ts +38 -4
  446. package/src/post/events/onPostUnflagged.ts +1 -1
  447. package/src/post/events/onPostUpdated.ts +1 -1
  448. package/src/post/events/utils.ts +39 -6
  449. package/src/post/observers/observePost.ts +22 -27
  450. package/src/reaction/api/addReaction.ts +30 -20
  451. package/src/reaction/api/removeReaction.ts +30 -20
  452. package/src/reaction/events/onReactionAdded.ts +37 -18
  453. package/src/reaction/events/onReactionRemoved.ts +38 -15
  454. package/src/reaction/utils/fetchReference.ts +1 -1
  455. package/src/reaction/utils/index.ts +1 -0
  456. package/src/reaction/utils/preparePayloadForCache.ts +45 -0
  457. package/src/report/api/createReport.ts +4 -5
  458. package/src/report/api/deleteReport.ts +4 -5
  459. package/src/role/api/getRole.ts +25 -9
  460. package/src/role/api/queryRoles.ts +10 -12
  461. package/src/stream/api/createStream.ts +9 -6
  462. package/src/stream/api/deleteStream.ts +10 -1
  463. package/src/stream/api/disposeStream.ts +10 -6
  464. package/src/stream/api/getStream.ts +23 -10
  465. package/src/stream/api/queryStreams.ts +10 -11
  466. package/src/stream/api/updateStream.ts +9 -6
  467. package/src/stream/events/onStreamRecorded.ts +1 -3
  468. package/src/stream/events/onStreamStarted.ts +1 -3
  469. package/src/stream/events/onStreamStopped.ts +1 -3
  470. package/src/user/api/getUser.ts +14 -11
  471. package/src/user/api/getUsers.ts +30 -14
  472. package/src/user/api/queryUsers.ts +40 -17
  473. package/src/user/api/updateUser.ts +10 -7
  474. package/src/user/events/onUserFlagCleared.ts +1 -1
  475. package/src/user/events/onUserFlagged.ts +1 -1
  476. package/src/user/events/onUserUnflagged.ts +1 -1
  477. package/src/user/events/onUserUpdated.ts +1 -1
  478. package/src/user/events/utils.ts +6 -4
  479. package/src/user/observers/observeUser.ts +9 -11
  480. package/dist/@types/core/store.d.ts +0 -46
  481. package/dist/@types/core/store.d.ts.map +0 -1
  482. package/dist/client/api/clearCache.d.ts +0 -15
  483. package/dist/client/api/clearCache.d.ts.map +0 -1
  484. package/dist/client/api/enableCache.d.ts +0 -15
  485. package/dist/client/api/enableCache.d.ts.map +0 -1
  486. package/dist/core/cache/drop.d.ts +0 -11
  487. package/dist/core/cache/drop.d.ts.map +0 -1
  488. package/dist/core/cache/index.d.ts +0 -19
  489. package/dist/core/cache/index.d.ts.map +0 -1
  490. package/dist/core/cache/ingest.d.ts +0 -10
  491. package/dist/core/cache/ingest.d.ts.map +0 -1
  492. package/dist/core/cache/merge.d.ts +0 -10
  493. package/dist/core/cache/merge.d.ts.map +0 -1
  494. package/dist/core/cache/mutate.d.ts +0 -10
  495. package/dist/core/cache/mutate.d.ts.map +0 -1
  496. package/dist/core/cache/pull.d.ts +0 -11
  497. package/dist/core/cache/pull.d.ts.map +0 -1
  498. package/dist/core/cache/push.d.ts +0 -10
  499. package/dist/core/cache/push.d.ts.map +0 -1
  500. package/dist/core/cache/sync.d.ts +0 -10
  501. package/dist/core/cache/sync.d.ts.map +0 -1
  502. package/dist/core/model/toRecord.d.ts +0 -10
  503. package/dist/core/model/toRecord.d.ts.map +0 -1
  504. package/dist/core/query/decorate.d.ts +0 -23
  505. package/dist/core/query/decorate.d.ts.map +0 -1
  506. package/dist/core/stores/index.d.ts +0 -3
  507. package/dist/core/stores/index.d.ts.map +0 -1
  508. package/dist/core/stores/memory.d.ts +0 -30
  509. package/dist/core/stores/memory.d.ts.map +0 -1
  510. package/dist/core/stores/persistent.d.ts +0 -13
  511. package/dist/core/stores/persistent.d.ts.map +0 -1
  512. package/src/@types/core/store.ts +0 -52
  513. package/src/client/api/clearCache.ts +0 -23
  514. package/src/client/api/enableCache.ts +0 -36
  515. package/src/core/cache/drop.ts +0 -24
  516. package/src/core/cache/index.ts +0 -24
  517. package/src/core/cache/ingest.ts +0 -24
  518. package/src/core/cache/merge.ts +0 -19
  519. package/src/core/cache/mutate.ts +0 -25
  520. package/src/core/cache/pull.ts +0 -31
  521. package/src/core/cache/push.ts +0 -41
  522. package/src/core/cache/sync.ts +0 -41
  523. package/src/core/model/toRecord.ts +0 -11
  524. package/src/core/query/decorate.ts +0 -64
  525. package/src/core/stores/index.ts +0 -2
  526. package/src/core/stores/memory.ts +0 -59
  527. package/src/core/stores/persistent.ts +0 -63
@@ -8,7 +8,7 @@ import { createUserEventSubscriber } from './utils'
8
8
  * })
9
9
  * ```
10
10
  *
11
- * Fired when any {@link Amity.User} have been updated
11
+ * Fired when a {@link Amity.User} has been updated
12
12
  *
13
13
  * @param callback The function to call when the event was fired
14
14
  * @returns an {@link Amity.Unsubscriber} function to stop listening
@@ -1,8 +1,8 @@
1
1
  import { getActiveClient } from '~/client/api'
2
- import { decoratePayload } from '~/core/query'
3
- import { ingestInCache } from '~/core/cache'
4
2
  import { createEventSubscriber } from '~/core/events'
5
3
 
4
+ import { ingestInCache } from '~/cache/api/ingestInCache'
5
+
6
6
  export const createUserEventSubscriber = (
7
7
  event: keyof Amity.MqttUserMessageEvents,
8
8
  callback: Amity.Listener<Amity.User>
@@ -10,8 +10,10 @@ export const createUserEventSubscriber = (
10
10
  const client = getActiveClient()
11
11
 
12
12
  const filter = (payload: Amity.UserPayload) => {
13
- decoratePayload(payload)
14
- ingestInCache(payload)
13
+ if (client.cache) {
14
+ ingestInCache(payload)
15
+ }
16
+
15
17
  callback(payload.users[0])
16
18
  }
17
19
 
@@ -27,7 +27,7 @@ import {
27
27
  */
28
28
  export const observeUser = <Events extends ['onFetch', 'onUpdate', 'onFlagged', 'onUnflagged', 'onFlagCleared']>(
29
29
  userId: string,
30
- callback: Amity.ObjectListener<Amity.QueryResult<Amity.User>, Events>,
30
+ callback: Amity.ObjectListener<Amity.Snapshot<Amity.User>, Events>
31
31
  ): Amity.Unsubscriber => {
32
32
  const { log } = getActiveClient()
33
33
 
@@ -36,17 +36,15 @@ export const observeUser = <Events extends ['onFetch', 'onUpdate', 'onFlagged',
36
36
 
37
37
  // wrapper function to make sure
38
38
  const router = (
39
- result: Amity.QueryResult<Amity.User>,
39
+ result: Amity.Snapshot<Amity.User>,
40
40
  action: Events[number]
41
41
  ) => {
42
42
  // filter function
43
43
  if (result.data?.userId !== userId) return
44
44
 
45
- if (callback instanceof Function)
46
- return callback(result)
45
+ if (callback instanceof Function) return callback(result)
47
46
 
48
- if (action !== 'onFetch')
49
- callback.onEvent?.(action, result)
47
+ if (action !== 'onFetch') callback.onEvent?.(action, result)
50
48
 
51
49
  callback[action]?.(result)
52
50
  }
@@ -54,15 +52,15 @@ export const observeUser = <Events extends ['onFetch', 'onUpdate', 'onFlagged',
54
52
  const disposers: Amity.Unsubscriber[] = []
55
53
 
56
54
  disposers.push(
57
- onUserUpdated(data => router({ data }, 'onUpdate')),
58
- onUserFlagged(data => router({ data }, 'onFlagged')),
59
- onUserUnflagged(data => router({ data }, 'onUnflagged')),
60
- onUserFlagCleared(data => router({ data }, 'onFlagCleared'))
55
+ onUserUpdated(data => router({ data, loading: false, origin: 'event' }, 'onUpdate')),
56
+ onUserFlagged(data => router({ data, loading: false, origin: 'event' }, 'onFlagged')),
57
+ onUserUnflagged(data => router({ data, loading: false, origin: 'event' }, 'onUnflagged')),
58
+ onUserFlagCleared(data => router({ data, loading: false, origin: 'event' }, 'onFlagCleared'))
61
59
  )
62
60
 
63
61
  runQuery(
64
62
  createQuery(getUser, userId),
65
- (result) => result.data && router(result, 'onFetch'),
63
+ result => result.data && router(result, 'onFetch')
66
64
  )
67
65
 
68
66
  return () => {
@@ -1,46 +0,0 @@
1
- export {};
2
- declare global {
3
- namespace Amity {
4
- /**
5
- * Represents what needs to be done to read the state of a store
6
- * @hidden
7
- */
8
- type StateReader<T extends {}> = () => Record<string, T>;
9
- /**
10
- * Represents what needs to be done to write in the state of a store.
11
- * @hidden
12
- */
13
- type StateWriter<T extends {}> = (payload: Record<string, T>) => void;
14
- /**
15
- * Represents what needs to be done to erase records in the state of a store.
16
- * @hidden
17
- */
18
- type StateEraser = (...payload: string[]) => void;
19
- /**
20
- * Every object which has a read:StateReader function and a write:StateWriter function can be
21
- * considered as a valid store. This opens the door for open and generic storage implementations.
22
- * We can imagine linking this to React Context, Redux, MobX, VueX, any local database...
23
- *
24
- * Below "defaultStore" is a minimal "in memory + mutable" storage implementation, which is the
25
- * bare minimum required to make the cache implementation working.
26
- *
27
- * Further storage strategies (offline, immutables, etc...) could be provided as
28
- * core or community plugins.
29
- * @hidden
30
- */
31
- type Store<T extends {} = any> = {
32
- read: StateReader<T>;
33
- write: StateWriter<T>;
34
- erase: StateEraser;
35
- };
36
- /**
37
- * Manually computed type to output a dictionary of { StoreName: Amity.Store<Model> }
38
- * with proper typing based on T
39
- * @hidden
40
- */
41
- type StoreCollection<T extends Amity.Domain[]> = {
42
- [K in T[number]]: Store<Amity.Model[K]>;
43
- };
44
- }
45
- }
46
- //# sourceMappingURL=store.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../src/@types/core/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAA;AAET,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd;;;WAGG;QACH,KAAK,WAAW,CAAC,CAAC,SAAS,EAAE,IAAI,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;QAExD;;;WAGG;QACH,KAAK,WAAW,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,IAAI,CAAA;QAErE;;;WAGG;QACH,KAAK,WAAW,GAAG,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,KAAK,IAAI,CAAA;QAEjD;;;;;;;;;;;WAWG;QACH,KAAK,KAAK,CAAC,CAAC,SAAS,EAAE,GAAG,GAAG,IAAI;YAC/B,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;YACpB,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;YACrB,KAAK,EAAE,WAAW,CAAA;SACnB,CAAA;QAED;;;;WAIG;QACH,KAAK,eAAe,CAClB,CAAC,SAAS,KAAK,CAAC,MAAM,EAAE,IACtB;aACD,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACxC,CAAA;KACF;CACF"}
@@ -1,15 +0,0 @@
1
- /**
2
- * ```js
3
- * import { clearCache } from '@amityco/ts-sdk'
4
- * clearCache()
5
- * ```
6
- *
7
- * Resets the state of the given {@link Amity.Store} names within
8
- * the {@link Amity.Cache} object of a {@link Amity.Client} instance
9
- *
10
- * @param stores an array of the stores names to be wiped
11
- *
12
- * @category Client API
13
- */
14
- export declare const clearCache: (stores?: Amity.Domain[]) => void;
15
- //# sourceMappingURL=clearCache.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"clearCache.d.ts","sourceRoot":"","sources":["../../../src/client/api/clearCache.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,YACb,MAAM,MAAM,EAAE,SAMvB,CAAA"}
@@ -1,15 +0,0 @@
1
- import { createCache } from '~/core/cache';
2
- /**
3
- * ```js
4
- * import { enableCache } from '@amityco/ts-sdk'
5
- * enableCache()
6
- * ```
7
- *
8
- * Adds a new {@link Amity.Cache} object to an {@link Amity.Client} instance
9
- *
10
- * @param stores a partial dictionary of stores to be used for caching
11
- *
12
- * @category Client API
13
- */
14
- export declare const enableCache: (stores?: Parameters<typeof createCache>[0]) => void;
15
- //# sourceMappingURL=enableCache.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"enableCache.d.ts","sourceRoot":"","sources":["../../../src/client/api/enableCache.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAG1C;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,WAAW,YACd,WAAW,kBAAkB,CAAC,CAAC,CAAC,CAAC,SAiB1C,CAAA"}
@@ -1,11 +0,0 @@
1
- /**
2
- * Pull objects from the cache layer
3
- *
4
- * @param name The name of the store to query
5
- * @param keys A collection of unique keys for the store
6
- * @returns The collection of objects matching the keys. Keys which don't match object will be omitted
7
- *
8
- * @category Cache
9
- */
10
- export declare const dropFromCache: <T extends keyof Amity.Model>(name: T, partial: Amity.Minimal[T] & Partial<Amity.Model[T]>) => never[] | undefined;
11
- //# sourceMappingURL=drop.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"drop.d.ts","sourceRoot":"","sources":["../../../src/core/cache/drop.ts"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,oHAWzB,CAAA"}
@@ -1,19 +0,0 @@
1
- export * from './pull';
2
- export * from './push';
3
- export * from './drop';
4
- export * from './sync';
5
- export * from './ingest';
6
- export * from './mutate';
7
- export * from './merge';
8
- /**
9
- * Creates a cache instance. The cache instance will handle stores
10
- * given to it as input, and will be used as the first source of cached data
11
- * in the SDK.
12
- *
13
- * @param stores A partial collection of stores
14
- * @returns A cache instance
15
- *
16
- * @category Cache
17
- */
18
- export declare const createCache: (stores: Partial<Amity.StoreCollection<Amity.Domain[]>>) => Amity.Cache;
19
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/cache/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,QAAQ,CAAA;AACtB,cAAc,QAAQ,CAAA;AACtB,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AAEvB;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,WACd,QAAQ,MAAM,eAAe,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC,KACrD,WAGF,CAAA"}
@@ -1,10 +0,0 @@
1
- /**
2
- * Ingest a payload (v3) into the cache
3
- *
4
- * @param payload a "backend v3" payload object
5
- * @param order the order of the keys to process (in case of need)
6
- *
7
- * @category Cache
8
- */
9
- export declare const ingestInCache: (payload?: Record<string, any[]>, order?: string[]) => void;
10
- //# sourceMappingURL=ingest.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ingest.d.ts","sourceRoot":"","sources":["../../../src/core/cache/ingest.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,aACf,OAAO,MAAM,EAAE,GAAG,EAAE,CAAC,2BAU/B,CAAA"}
@@ -1,10 +0,0 @@
1
- /**
2
- * Apply partial mutation to objects in the cache
3
- *
4
- * @param name The name of the store to query
5
- * @param mutation A partial view of the object to update
6
- *
7
- * @category Cache
8
- */
9
- export declare const mergeInCache: <T extends keyof Amity.Model>(name: T, mutation: Amity.Minimal[T] & Partial<Amity.Model[T]>) => void;
10
- //# sourceMappingURL=merge.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"merge.d.ts","sourceRoot":"","sources":["../../../src/core/cache/merge.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,sGAMxB,CAAA"}
@@ -1,10 +0,0 @@
1
- /**
2
- * Apply partial mutation to objects in the cache
3
- *
4
- * @param name The name of the store to query
5
- * @param mutation A partial view of the object to update
6
- *
7
- * @category Cache
8
- */
9
- export declare const mutateCache: <T extends keyof Amity.Model>(name: T, key: string, mutator: (model: Amity.Model[T]) => Amity.Model[T] | undefined) => Amity.Model[T] | undefined;
10
- //# sourceMappingURL=mutate.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"mutate.d.ts","sourceRoot":"","sources":["../../../src/core/cache/mutate.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,8CAEjB,MAAM,+FAWZ,CAAA"}
@@ -1,11 +0,0 @@
1
- /**
2
- * Pull objects from the cache layer
3
- *
4
- * @param name The name of the store to query
5
- * @param keys A collection of unique keys for the store
6
- * @returns The collection of objects matching the keys. Keys which don't match object will be omitted
7
- *
8
- * @category Cache
9
- */
10
- export declare const pullFromCache: <K extends keyof Amity.Model>(name: K, ...keys: string[]) => Amity.Model[K][] | undefined;
11
- //# sourceMappingURL=pull.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"pull.d.ts","sourceRoot":"","sources":["../../../src/core/cache/pull.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,kDAA8C,MAAM,EAAE,iCAmB/E,CAAA"}
@@ -1,10 +0,0 @@
1
- /**
2
- * Pull objects from the cache layer
3
- *
4
- * @param name The name of the store to query
5
- * @param models A collection of models t store
6
- *
7
- * @category Cache
8
- */
9
- export declare const pushToCache: <T extends keyof Amity.Model>(name: T, ...models: Amity.Model[T][]) => void;
10
- //# sourceMappingURL=push.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"push.d.ts","sourceRoot":"","sources":["../../../src/core/cache/push.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,6EA4BvB,CAAA"}
@@ -1,10 +0,0 @@
1
- /**
2
- * Sync-up local ids of objects in the cache
3
- *
4
- * @param original The object holding the localId to keep
5
- * @param replacement The object holding the localId to discard
6
- *
7
- * @category Cache
8
- */
9
- export declare const syncInCache: <T extends keyof Amity.Model>(original: Amity.Model[T], replacement: Amity.Model[T]) => void;
10
- //# sourceMappingURL=sync.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../../../src/core/cache/sync.ts"],"names":[],"mappings":"AAOA;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,8FAyBvB,CAAA"}
@@ -1,10 +0,0 @@
1
- /**
2
- * converts an array looking collection to an object collection, grouped by localId
3
- *
4
- * @param array array of {@link Amity.Syncable}
5
- * @returns array converted to object, grouped by localId
6
- *
7
- * @hidden
8
- */
9
- export declare const toRecord: <T extends Amity.Syncable>(array: T[]) => Record<string, T>;
10
- //# sourceMappingURL=toRecord.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"toRecord.d.ts","sourceRoot":"","sources":["../../../src/core/model/toRecord.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,6DAEpB,CAAA"}
@@ -1,23 +0,0 @@
1
- /**
2
- * Set the model's syncedAt property and localId
3
- *
4
- * @param model the model to decorate
5
- * @param timestamp the given timestamp
6
- */
7
- export declare const decoratePayload: (payload: Record<string, object[]>, timestamp?: number, keyMapping?: Record<string, Amity.Domain>) => void;
8
- /**
9
- * Set the model's syncedAt property and localId
10
- *
11
- * @param model the model to decorate
12
- * @param timestamp the given timestamp
13
- */
14
- export declare const decorateModels: <T extends Amity.User | Amity.File<any> | Amity.Role | Amity.Channel<any> | Amity.Membership<"channel"> | Amity.Message<any> | Amity.Community | Amity.Membership<"community"> | Amity.Post<any> | Amity.Comment<any> | Amity.Stream>(models: T[], timestamp?: number, type?: keyof Amity.Model | undefined) => void;
15
- /**
16
- * Set the model's syncedAt property and localId
17
- *
18
- * @param model the model to decorate
19
- * @param syncedAt the given timestamp
20
- * @param type An opportunity to manually pass the type. If undefined, it will be smartly computed
21
- */
22
- export declare const decorateModel: <T extends Amity.User | Amity.File<any> | Amity.Role | Amity.Channel<any> | Amity.Membership<"channel"> | Amity.Message<any> | Amity.Community | Amity.Membership<"community"> | Amity.Post<any> | Amity.Comment<any> | Amity.Stream>(model: T, timestamp?: number, type?: keyof Amity.Model | undefined) => void;
23
- //# sourceMappingURL=decorate.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"decorate.d.ts","sourceRoot":"","sources":["../../../src/core/query/decorate.ts"],"names":[],"mappings":"AAUA;;;;;GAKG;AACH,eAAO,MAAM,eAAe,YACjB,OAAO,MAAM,EAAE,MAAM,EAAE,CAAC,cACtB,MAAM,eACL,OAAO,MAAM,EAAE,MAAM,MAAM,CAAC,SAQzC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,iQAEd,MAAM,+CAIlB,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,8PAEb,MAAM,+CAWlB,CAAA"}
@@ -1,3 +0,0 @@
1
- export * from './memory';
2
- export * from './persistent';
3
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/stores/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA"}
@@ -1,30 +0,0 @@
1
- /**
2
- * Minimal store implementation.
3
- *
4
- * Beware, the state is mutable! it is your responsibility
5
- * handle the state's mutations correctly. We do so in
6
- * order for users with mutable/observable stacks to be able
7
- * to decorate the state with their favorite libraries.
8
- *
9
- * @param defaultValue the hydration state value of the store
10
- * @returns A store instance with an "in memory" storage strategy
11
- *
12
- * @category Storage
13
- * @hidden
14
- */
15
- export declare const memoryStore: <T extends {}>(defaultValue?: Record<string, T>) => Amity.Store<T>;
16
- /**
17
- * ```js
18
- * import { memoryStores } from '@amityco/core/cache/store/volatile'
19
- * const stores = imemoryStores('user', 'file')
20
- * ```
21
- *
22
- * Builds a collection of in memory stores based on the available store names
23
- *
24
- * @param names collection of store names
25
- * @returns a dictionary of { storeName: storeInstance } according to the given names
26
- *
27
- * @category Storage
28
- */
29
- export declare const memoryStores: <T extends (keyof Amity.Model)[]>(...names: T) => Amity.StoreCollection<T>;
30
- //# sourceMappingURL=memory.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../../src/core/stores/memory.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW,oEAsBvB,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,4EAOxB,CAAA"}
@@ -1,13 +0,0 @@
1
- /**
2
- * Persistent store implementation.
3
- *
4
- * @param persistentKey the name of the store in persistent storage
5
- * @param defaultValue the hydration state value of the store
6
- * @param debounceTime a delay to avoid spamming the persistent storage while writing,
7
- * @returns A store instance with an "persistent" storage strategy
8
- *
9
- * @category Storage
10
- * @hidden
11
- */
12
- export declare const persistentStore: <T extends {}>(persistentKey: string, defaultValue?: Record<string, T>, debounceTime?: number) => Promise<Amity.Store<T>>;
13
- //# sourceMappingURL=persistent.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"persistent.d.ts","sourceRoot":"","sources":["../../../src/core/stores/persistent.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,gCACX,MAAM,qFA4CtB,CAAA"}
@@ -1,52 +0,0 @@
1
- export {}
2
-
3
- declare global {
4
- namespace Amity {
5
- /**
6
- * Represents what needs to be done to read the state of a store
7
- * @hidden
8
- */
9
- type StateReader<T extends {}> = () => Record<string, T>
10
-
11
- /**
12
- * Represents what needs to be done to write in the state of a store.
13
- * @hidden
14
- */
15
- type StateWriter<T extends {}> = (payload: Record<string, T>) => void
16
-
17
- /**
18
- * Represents what needs to be done to erase records in the state of a store.
19
- * @hidden
20
- */
21
- type StateEraser = (...payload: string[]) => void
22
-
23
- /**
24
- * Every object which has a read:StateReader function and a write:StateWriter function can be
25
- * considered as a valid store. This opens the door for open and generic storage implementations.
26
- * We can imagine linking this to React Context, Redux, MobX, VueX, any local database...
27
- *
28
- * Below "defaultStore" is a minimal "in memory + mutable" storage implementation, which is the
29
- * bare minimum required to make the cache implementation working.
30
- *
31
- * Further storage strategies (offline, immutables, etc...) could be provided as
32
- * core or community plugins.
33
- * @hidden
34
- */
35
- type Store<T extends {} = any> = {
36
- read: StateReader<T>
37
- write: StateWriter<T>
38
- erase: StateEraser
39
- }
40
-
41
- /**
42
- * Manually computed type to output a dictionary of { StoreName: Amity.Store<Model> }
43
- * with proper typing based on T
44
- * @hidden
45
- */
46
- type StoreCollection<
47
- T extends Amity.Domain[],
48
- > = {
49
- [K in T[number]]: Store<Amity.Model[K]>
50
- }
51
- }
52
- }
@@ -1,23 +0,0 @@
1
- import { getActiveClient } from './activeClient'
2
-
3
- /**
4
- * ```js
5
- * import { clearCache } from '@amityco/ts-sdk'
6
- * clearCache()
7
- * ```
8
- *
9
- * Resets the state of the given {@link Amity.Store} names within
10
- * the {@link Amity.Cache} object of a {@link Amity.Client} instance
11
- *
12
- * @param stores an array of the stores names to be wiped
13
- *
14
- * @category Client API
15
- */
16
- export const clearCache = (
17
- stores: Amity.Domain[] = ['user', 'file', 'channel', 'message', 'community', 'post', 'comment']
18
- ) => {
19
- const client = getActiveClient()
20
- client.log('client/api/enableCache')
21
-
22
- stores.forEach(store => client.cache?.[store]?.erase())
23
- }
@@ -1,36 +0,0 @@
1
- import { getActiveClient } from './activeClient'
2
-
3
- import { createCache } from '~/core/cache'
4
- import { memoryStores } from '~/core/stores'
5
-
6
- /**
7
- * ```js
8
- * import { enableCache } from '@amityco/ts-sdk'
9
- * enableCache()
10
- * ```
11
- *
12
- * Adds a new {@link Amity.Cache} object to an {@link Amity.Client} instance
13
- *
14
- * @param stores a partial dictionary of stores to be used for caching
15
- *
16
- * @category Client API
17
- */
18
- export const enableCache = (
19
- stores: Parameters<typeof createCache>[0] = memoryStores(
20
- 'user',
21
- 'file',
22
- 'channel',
23
- 'message',
24
- 'community',
25
- 'post',
26
- 'comment',
27
- 'communityUsers',
28
- 'channelUsers',
29
- 'stream',
30
- ),
31
- ) => {
32
- const client = getActiveClient()
33
- client.log('client/api/enableCache')
34
-
35
- client.cache = createCache(stores)
36
- }
@@ -1,24 +0,0 @@
1
- import { getActiveClient } from '~/client/api/activeClient'
2
- import { getResolver } from '../model/idResolvers'
3
-
4
- /**
5
- * Pull objects from the cache layer
6
- *
7
- * @param name The name of the store to query
8
- * @param keys A collection of unique keys for the store
9
- * @returns The collection of objects matching the keys. Keys which don't match object will be omitted
10
- *
11
- * @category Cache
12
- */
13
- export const dropFromCache = <T extends Amity.Domain>(name: T, partial: Amity.Minimal[T] & Partial<Amity.Model[T]>) => {
14
- const { cache } = getActiveClient()
15
- const store = cache?.[name] as unknown as Amity.Store<Amity.Model[T]>
16
-
17
- if (!cache || !store) return []
18
-
19
- const modelId = getResolver(name)(partial)
20
- const localId = cache.lookup[`${name}#${modelId}`]
21
-
22
- delete cache.lookup[`${name}#${modelId}`]
23
- store.erase(localId)
24
- }
@@ -1,24 +0,0 @@
1
- export * from './pull'
2
- export * from './push'
3
- export * from './drop'
4
- export * from './sync'
5
- export * from './ingest'
6
- export * from './mutate'
7
- export * from './merge'
8
-
9
- /**
10
- * Creates a cache instance. The cache instance will handle stores
11
- * given to it as input, and will be used as the first source of cached data
12
- * in the SDK.
13
- *
14
- * @param stores A partial collection of stores
15
- * @returns A cache instance
16
- *
17
- * @category Cache
18
- */
19
- export const createCache = (
20
- stores: Partial<Amity.StoreCollection<Amity.Domain[]>>
21
- ): Amity.Cache => {
22
- const lookup: Record<string, string> = {}
23
- return { lookup, ...stores }
24
- }
@@ -1,24 +0,0 @@
1
- import { pushToCache } from './push'
2
-
3
- import { storeInterests } from '../model/idResolvers'
4
-
5
- /**
6
- * Ingest a payload (v3) into the cache
7
- *
8
- * @param payload a "backend v3" payload object
9
- * @param order the order of the keys to process (in case of need)
10
- *
11
- * @category Cache
12
- */
13
- export const ingestInCache = (
14
- payload: Record<string, any[]> = {},
15
- order = Object.keys(payload),
16
- ) => {
17
- order
18
- .forEach(key => {
19
- const name = storeInterests[key]
20
- if (!name) return
21
-
22
- pushToCache(name, ...payload[key])
23
- })
24
- }
@@ -1,19 +0,0 @@
1
- import { getResolver } from '../model/idResolvers'
2
-
3
- import { mutateCache } from './mutate'
4
-
5
- /**
6
- * Apply partial mutation to objects in the cache
7
- *
8
- * @param name The name of the store to query
9
- * @param mutation A partial view of the object to update
10
- *
11
- * @category Cache
12
- */
13
- export const mergeInCache = <T extends Amity.Domain>(
14
- name: T,
15
- mutation: Amity.Minimal[T] & Partial<Amity.Model[T]>
16
- ) => {
17
- const key = getResolver(name)(mutation)
18
- mutateCache(name, key, model => ({ ...model, ...mutation }))
19
- }