@amityco/ts-sdk 0.0.1-beta.13 → 0.0.1-beta.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (190) hide show
  1. package/README.md +3 -3
  2. package/dist/@types/core/cache.d.ts +2 -2
  3. package/dist/@types/core/cache.d.ts.map +1 -1
  4. package/dist/@types/core/events.d.ts +12 -3
  5. package/dist/@types/core/events.d.ts.map +1 -1
  6. package/dist/@types/core/model.d.ts +4 -0
  7. package/dist/@types/core/model.d.ts.map +1 -1
  8. package/dist/@types/core/paging.d.ts +22 -41
  9. package/dist/@types/core/paging.d.ts.map +1 -1
  10. package/dist/@types/core/payload.d.ts +10 -0
  11. package/dist/@types/core/payload.d.ts.map +1 -1
  12. package/dist/@types/core/query.d.ts +13 -4
  13. package/dist/@types/core/query.d.ts.map +1 -1
  14. package/dist/@types/domains/client.d.ts +0 -1
  15. package/dist/@types/domains/client.d.ts.map +1 -1
  16. package/dist/@types/domains/comment.d.ts +1 -2
  17. package/dist/@types/domains/comment.d.ts.map +1 -1
  18. package/dist/@types/domains/follow.d.ts +20 -0
  19. package/dist/@types/domains/follow.d.ts.map +1 -0
  20. package/dist/@types/domains/mention.d.ts +23 -0
  21. package/dist/@types/domains/mention.d.ts.map +1 -0
  22. package/dist/@types/domains/message.d.ts +1 -1
  23. package/dist/@types/domains/message.d.ts.map +1 -1
  24. package/dist/@types/domains/partials.d.ts +0 -10
  25. package/dist/@types/domains/partials.d.ts.map +1 -1
  26. package/dist/@types/domains/post.d.ts +1 -2
  27. package/dist/@types/domains/post.d.ts.map +1 -1
  28. package/dist/@types/index.d.ts +2 -0
  29. package/dist/@types/index.d.ts.map +1 -1
  30. package/dist/category/api/queryCategories.d.ts +2 -2
  31. package/dist/channel/api/createChannel.d.ts +1 -1
  32. package/dist/channel/api/queryChannelMembers.d.ts.map +1 -1
  33. package/dist/client/api/activeUser.d.ts +6 -0
  34. package/dist/client/api/activeUser.d.ts.map +1 -0
  35. package/dist/client/api/connectClient.d.ts.map +1 -1
  36. package/dist/client/api/createClient.d.ts +3 -3
  37. package/dist/client/api/createClient.d.ts.map +1 -1
  38. package/dist/client/utils/endpoints.d.ts +12 -0
  39. package/dist/client/utils/endpoints.d.ts.map +1 -0
  40. package/dist/community/api/getRecommendedCommunities.d.ts +32 -0
  41. package/dist/community/api/getRecommendedCommunities.d.ts.map +1 -0
  42. package/dist/community/api/getTopTrendingCommunities.d.ts +32 -0
  43. package/dist/community/api/getTopTrendingCommunities.d.ts.map +1 -0
  44. package/dist/community/api/index.d.ts +2 -0
  45. package/dist/community/api/index.d.ts.map +1 -1
  46. package/dist/core/debug.d.ts.map +1 -1
  47. package/dist/core/device.d.ts.map +1 -1
  48. package/dist/core/events.d.ts +3 -3
  49. package/dist/core/events.d.ts.map +1 -1
  50. package/dist/core/microtasks.d.ts +13 -0
  51. package/dist/core/microtasks.d.ts.map +1 -0
  52. package/dist/core/model/idResolvers.d.ts.map +1 -1
  53. package/dist/core/model/identifyModel.d.ts.map +1 -1
  54. package/dist/core/model/index.d.ts.map +1 -1
  55. package/dist/core/query/paging.d.ts +5 -16
  56. package/dist/core/query/paging.d.ts.map +1 -1
  57. package/dist/core/query/query.d.ts +1 -1
  58. package/dist/core/query/query.d.ts.map +1 -1
  59. package/dist/core/subscription.d.ts +2 -0
  60. package/dist/core/subscription.d.ts.map +1 -1
  61. package/dist/feed/api/queryGlobalFeed.d.ts +22 -4
  62. package/dist/feed/api/queryGlobalFeed.d.ts.map +1 -1
  63. package/dist/follow/api/acceptFollower.d.ts +16 -0
  64. package/dist/follow/api/acceptFollower.d.ts.map +1 -0
  65. package/dist/follow/api/declineFollower.d.ts +16 -0
  66. package/dist/follow/api/declineFollower.d.ts.map +1 -0
  67. package/dist/follow/api/follow.d.ts +16 -0
  68. package/dist/follow/api/follow.d.ts.map +1 -0
  69. package/dist/follow/api/getFollowInfo.d.ts +32 -0
  70. package/dist/follow/api/getFollowInfo.d.ts.map +1 -0
  71. package/dist/follow/api/index.d.ts +8 -0
  72. package/dist/follow/api/index.d.ts.map +1 -0
  73. package/dist/follow/api/queryFollowers.d.ts +36 -0
  74. package/dist/follow/api/queryFollowers.d.ts.map +1 -0
  75. package/dist/follow/api/queryFollowings.d.ts +36 -0
  76. package/dist/follow/api/queryFollowings.d.ts.map +1 -0
  77. package/dist/follow/api/unfollow.d.ts +16 -0
  78. package/dist/follow/api/unfollow.d.ts.map +1 -0
  79. package/dist/follow/api/utils.d.ts +9 -0
  80. package/dist/follow/api/utils.d.ts.map +1 -0
  81. package/dist/follow/events/index.d.ts +9 -0
  82. package/dist/follow/events/index.d.ts.map +1 -0
  83. package/dist/follow/events/onFollowInfoUpdated.d.ts +17 -0
  84. package/dist/follow/events/onFollowInfoUpdated.d.ts.map +1 -0
  85. package/dist/follow/events/onFollowRequestAccepted.d.ts +17 -0
  86. package/dist/follow/events/onFollowRequestAccepted.d.ts.map +1 -0
  87. package/dist/follow/events/onFollowRequestCanceled.d.ts +17 -0
  88. package/dist/follow/events/onFollowRequestCanceled.d.ts.map +1 -0
  89. package/dist/follow/events/onFollowRequestDeclined.d.ts +17 -0
  90. package/dist/follow/events/onFollowRequestDeclined.d.ts.map +1 -0
  91. package/dist/follow/events/onFollowerDeleted.d.ts +17 -0
  92. package/dist/follow/events/onFollowerDeleted.d.ts.map +1 -0
  93. package/dist/follow/events/onFollowerRequested.d.ts +17 -0
  94. package/dist/follow/events/onFollowerRequested.d.ts.map +1 -0
  95. package/dist/follow/events/onUserFollowed.d.ts +17 -0
  96. package/dist/follow/events/onUserFollowed.d.ts.map +1 -0
  97. package/dist/follow/events/onUserUnfollowed.d.ts +17 -0
  98. package/dist/follow/events/onUserUnfollowed.d.ts.map +1 -0
  99. package/dist/follow/events/utils.d.ts +2 -0
  100. package/dist/follow/events/utils.d.ts.map +1 -0
  101. package/dist/follow/observers/index.d.ts +4 -0
  102. package/dist/follow/observers/index.d.ts.map +1 -0
  103. package/dist/follow/observers/observeFollowInfo.d.ts +18 -0
  104. package/dist/follow/observers/observeFollowInfo.d.ts.map +1 -0
  105. package/dist/follow/observers/observeFollowers.d.ts +18 -0
  106. package/dist/follow/observers/observeFollowers.d.ts.map +1 -0
  107. package/dist/follow/observers/observeFollowings.d.ts +18 -0
  108. package/dist/follow/observers/observeFollowings.d.ts.map +1 -0
  109. package/dist/index.cjs.js +845 -74
  110. package/dist/index.d.ts +4 -0
  111. package/dist/index.d.ts.map +1 -1
  112. package/dist/index.esm.js +823 -74
  113. package/dist/index.umd.js +5 -5
  114. package/dist/message/api/createMessage.d.ts +2 -2
  115. package/dist/message/api/createMessage.d.ts.map +1 -1
  116. package/dist/message/api/updateMessage.d.ts +2 -2
  117. package/dist/message/api/updateMessage.d.ts.map +1 -1
  118. package/dist/post/api/queryPosts.d.ts +3 -3
  119. package/dist/post/api/queryPosts.d.ts.map +1 -1
  120. package/dist/utils/env.d.ts +5 -0
  121. package/dist/utils/env.d.ts.map +1 -0
  122. package/dist/version.d.ts.map +1 -1
  123. package/package.json +1 -1
  124. package/src/@types/core/cache.ts +2 -2
  125. package/src/@types/core/events.ts +12 -1
  126. package/src/@types/core/model.ts +6 -0
  127. package/src/@types/core/paging.ts +31 -46
  128. package/src/@types/core/payload.ts +14 -0
  129. package/src/@types/core/query.ts +11 -3
  130. package/src/@types/domains/client.ts +0 -1
  131. package/src/@types/domains/comment.ts +1 -3
  132. package/src/@types/domains/follow.ts +25 -0
  133. package/src/@types/domains/mention.ts +26 -0
  134. package/src/@types/domains/message.ts +1 -0
  135. package/src/@types/domains/partials.ts +0 -8
  136. package/src/@types/domains/post.ts +1 -3
  137. package/src/@types/index.ts +3 -0
  138. package/src/channel/api/createChannel.ts +1 -1
  139. package/src/channel/api/queryChannelMembers.ts +2 -1
  140. package/src/client/api/activeUser.ts +26 -0
  141. package/src/client/api/connectClient.ts +3 -1
  142. package/src/client/api/createClient.ts +7 -7
  143. package/src/client/utils/endpoints.ts +14 -0
  144. package/src/community/api/getRecommendedCommunities.ts +86 -0
  145. package/src/community/api/getTopTrendingCommunities.ts +86 -0
  146. package/src/community/api/index.ts +3 -0
  147. package/src/community/api/queryCommunityMembers.ts +1 -1
  148. package/src/core/debug.ts +3 -1
  149. package/src/core/device.ts +3 -2
  150. package/src/core/events.ts +3 -1
  151. package/src/core/microtasks.ts +27 -0
  152. package/src/core/model/idResolvers.ts +3 -0
  153. package/src/core/model/identifyModel.ts +2 -0
  154. package/src/core/model/index.ts +3 -0
  155. package/src/core/query/paging.ts +16 -51
  156. package/src/core/query/query.ts +5 -5
  157. package/src/core/subscription.ts +21 -3
  158. package/src/feed/api/queryGlobalFeed.ts +58 -5
  159. package/src/follow/api/acceptFollower.ts +32 -0
  160. package/src/follow/api/declineFollower.ts +32 -0
  161. package/src/follow/api/follow.ts +40 -0
  162. package/src/follow/api/getFollowInfo.ts +75 -0
  163. package/src/follow/api/index.ts +8 -0
  164. package/src/follow/api/queryFollowers.ts +42 -0
  165. package/src/follow/api/queryFollowings.ts +42 -0
  166. package/src/follow/api/unfollow.ts +32 -0
  167. package/src/follow/api/utils.ts +77 -0
  168. package/src/follow/events/index.ts +10 -0
  169. package/src/follow/events/onFollowInfoUpdated.ts +43 -0
  170. package/src/follow/events/onFollowRequestAccepted.ts +19 -0
  171. package/src/follow/events/onFollowRequestCanceled.ts +19 -0
  172. package/src/follow/events/onFollowRequestDeclined.ts +19 -0
  173. package/src/follow/events/onFollowerDeleted.ts +19 -0
  174. package/src/follow/events/onFollowerRequested.ts +19 -0
  175. package/src/follow/events/onUserFollowed.ts +19 -0
  176. package/src/follow/events/onUserUnfollowed.ts +19 -0
  177. package/src/follow/events/utils.ts +38 -0
  178. package/src/follow/observers/index.ts +3 -0
  179. package/src/follow/observers/observeFollowInfo.ts +68 -0
  180. package/src/follow/observers/observeFollowers.ts +78 -0
  181. package/src/follow/observers/observeFollowings.ts +78 -0
  182. package/src/index.ts +5 -0
  183. package/src/message/api/createMessage.ts +2 -2
  184. package/src/message/api/updateMessage.ts +2 -2
  185. package/src/post/api/queryPosts.ts +5 -5
  186. package/src/utils/env.ts +7 -0
  187. package/src/version.ts +3 -1
  188. package/dist/core/network.d.ts +0 -11
  189. package/dist/core/network.d.ts.map +0 -1
  190. package/src/core/network.ts +0 -14
@@ -0,0 +1,17 @@
1
+ /**
2
+ * ```js
3
+ * import { onFollowerDeleted } from '@amityco/ts-sdk'
4
+ * const dispose = onFollowerDeleted(status => {
5
+ * // ...
6
+ * })
7
+ * ```
8
+ *
9
+ * Fired when a follower has been deleted
10
+ *
11
+ * @param callback The function to call when the event was fired
12
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
13
+ *
14
+ * @category Follow Events
15
+ */
16
+ export declare const onFollowerDeleted: (callback: Amity.Listener<Amity.FollowStatus>) => Amity.Unsubscriber;
17
+ //# sourceMappingURL=onFollowerDeleted.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"onFollowerDeleted.d.ts","sourceRoot":"","sources":["../../../src/follow/events/onFollowerDeleted.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iBAAiB,aAAc,MAAM,QAAQ,CAAC,MAAM,YAAY,CAAC,KAAG,MAAM,YACtB,CAAA"}
@@ -0,0 +1,17 @@
1
+ /**
2
+ * ```js
3
+ * import { onFollowerRequested } from '@amityco/ts-sdk'
4
+ * const dispose = onFollowerRequested(status => {
5
+ * // ...
6
+ * })
7
+ * ```
8
+ *
9
+ * Fired when a user follows another users and confirmation is required
10
+ *
11
+ * @param callback The function to call when the event was fired
12
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
13
+ *
14
+ * @category Follow Events
15
+ */
16
+ export declare const onFollowerRequested: (callback: Amity.Listener<Amity.FollowStatus>) => Amity.Unsubscriber;
17
+ //# sourceMappingURL=onFollowerRequested.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"onFollowerRequested.d.ts","sourceRoot":"","sources":["../../../src/follow/events/onFollowerRequested.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,QAAQ,CAAC,MAAM,YAAY,CAAC,KAAG,MAAM,YAC9B,CAAA"}
@@ -0,0 +1,17 @@
1
+ /**
2
+ * ```js
3
+ * import { onUserFollowed } from '@amityco/ts-sdk'
4
+ * const dispose = onUserFollowed(status => {
5
+ * // ...
6
+ * })
7
+ * ```
8
+ *
9
+ * Fired when a user follows another users and confirmation is not required
10
+ *
11
+ * @param callback The function to call when the event was fired
12
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
13
+ *
14
+ * @category Follow Events
15
+ */
16
+ export declare const onUserFollowed: (callback: Amity.Listener<Amity.FollowStatus>) => Amity.Unsubscriber;
17
+ //# sourceMappingURL=onUserFollowed.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"onUserFollowed.d.ts","sourceRoot":"","sources":["../../../src/follow/events/onUserFollowed.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,cAAc,aAAc,MAAM,QAAQ,CAAC,MAAM,YAAY,CAAC,KAAG,MAAM,YAC3B,CAAA"}
@@ -0,0 +1,17 @@
1
+ /**
2
+ * ```js
3
+ * import { onUserUnfollowed } from '@amityco/ts-sdk'
4
+ * const dispose = onUserFollowed(status => {
5
+ * // ...
6
+ * })
7
+ * ```
8
+ *
9
+ * Fired when a user unfollows
10
+ *
11
+ * @param callback The function to call when the event was fired
12
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
13
+ *
14
+ * @category Follow Events
15
+ */
16
+ export declare const onUserUnfollowed: (callback: Amity.Listener<Amity.FollowStatus>) => Amity.Unsubscriber;
17
+ //# sourceMappingURL=onUserUnfollowed.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"onUserUnfollowed.d.ts","sourceRoot":"","sources":["../../../src/follow/events/onUserUnfollowed.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,QAAQ,CAAC,MAAM,YAAY,CAAC,KAAG,MAAM,YAC1B,CAAA"}
@@ -0,0 +1,2 @@
1
+ export declare const createFollowEventSubscriber: (event: keyof Amity.MqttFollowMessageEvents, callback: Amity.Listener<Amity.FollowStatus>) => Amity.Unsubscriber;
2
+ //# sourceMappingURL=utils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/follow/events/utils.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,2BAA2B,UAC/B,MAAM,MAAM,uBAAuB,YAChC,MAAM,QAAQ,CAAC,MAAM,YAAY,CAAC,uBA8B7C,CAAA"}
@@ -0,0 +1,4 @@
1
+ export * from './observeFollowInfo';
2
+ export * from './observeFollowers';
3
+ export * from './observeFollowings';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/follow/observers/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA"}
@@ -0,0 +1,18 @@
1
+ /**
2
+ * ```js
3
+ * import { observeFollowInfo } from '@amityco/ts-sdk'
4
+ *
5
+ * let followInfo = {}
6
+ * const dispose = observeFollowInfo(userId, updated => followInfo = updated)
7
+ * ```
8
+ *
9
+ * Observe all mutation on a given {@link Amity.FollowInfo}
10
+ *
11
+ * @param userId the ID of the user to observe
12
+ * @param callback the function to call when new data are available
13
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the post
14
+ *
15
+ * @category Follow Observer
16
+ */
17
+ export declare const observeFollowInfo: <Events extends ["onFetch", "onUpdate"]>(userId: Amity.User['userId'], callback: Amity.ObjectListener<Amity.Snapshot<Amity.FollowInfo>, Events>, policy?: Amity.QueryPolicy) => Amity.Unsubscriber;
18
+ //# sourceMappingURL=observeFollowInfo.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"observeFollowInfo.d.ts","sourceRoot":"","sources":["../../../src/follow/observers/observeFollowInfo.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,iBAAiB,mDACpB,MAAM,IAAI,CAAC,QAAQ,CAAC,qFAEpB,MAAM,WAAW,KACxB,MAAM,YA0CR,CAAA"}
@@ -0,0 +1,18 @@
1
+ /**
2
+ * ```js
3
+ * import { observeFollowers } from '@amityco/ts-sdk'
4
+ *
5
+ * let followers = []
6
+ * const unsub = observeFollowers('userId', follower => merge(followers, follower))
7
+ * ```
8
+ *
9
+ * Observe all mutations on a list of followers {@link Amity.FollowStatus} for a given user
10
+ *
11
+ * @param userId the ID of the {@link Amity.User}
12
+ * @param callback the function to call when new data are available
13
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the messages
14
+ *
15
+ * @category Follow Observer
16
+ */
17
+ export declare const observeFollowers: <Events extends ["onRequested", "onAccepted", "onDeclined", "onCanceled", "onFollowed", "onUnfollowed", "onDeleted"]>(userId: Amity.User['userId'], callback: Amity.ObjectListener<Amity.FollowStatus, Events>) => Amity.Unsubscriber;
18
+ //# sourceMappingURL=observeFollowers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"observeFollowers.d.ts","sourceRoot":"","sources":["../../../src/follow/observers/observeFollowers.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,gBAAgB,gIASnB,MAAM,IAAI,CAAC,QAAQ,CAAC,iEAE3B,MAAM,YAsCR,CAAA"}
@@ -0,0 +1,18 @@
1
+ /**
2
+ * ```js
3
+ * import { observeFollowings } from '@amityco/ts-sdk'
4
+ *
5
+ * let followings = []
6
+ * const unsub = observeFollowers('userId', follower => merge(followings, following))
7
+ * ```
8
+ *
9
+ * Observe all mutations on a list of followings {@link Amity.FollowStatus} for a given user
10
+ *
11
+ * @param userId the ID of the {@link Amity.User}
12
+ * @param callback the function to call when new data are available
13
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the messages
14
+ *
15
+ * @category Follow Observer
16
+ */
17
+ export declare const observeFollowings: <Events extends ["onRequested", "onAccepted", "onDeclined", "onCanceled", "onFollowed", "onUnfollowed", "onDeleted"]>(userId: Amity.User['userId'], callback: Amity.ObjectListener<Amity.FollowStatus, Events>) => Amity.Unsubscriber;
18
+ //# sourceMappingURL=observeFollowings.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"observeFollowings.d.ts","sourceRoot":"","sources":["../../../src/follow/observers/observeFollowings.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,iBAAiB,gIASpB,MAAM,IAAI,CAAC,QAAQ,CAAC,iEAE3B,MAAM,YAsCR,CAAA"}