@amityco/ts-sdk 0.0.1-beta.10 → 0.0.1-beta.14

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 (148) hide show
  1. package/dist/@types/core/cache.d.ts +2 -2
  2. package/dist/@types/core/cache.d.ts.map +1 -1
  3. package/dist/@types/core/events.d.ts +6 -6
  4. package/dist/@types/core/events.d.ts.map +1 -1
  5. package/dist/@types/core/paging.d.ts +19 -38
  6. package/dist/@types/core/paging.d.ts.map +1 -1
  7. package/dist/@types/core/payload.d.ts +2 -2
  8. package/dist/@types/core/payload.d.ts.map +1 -1
  9. package/dist/@types/core/query.d.ts +12 -4
  10. package/dist/@types/core/query.d.ts.map +1 -1
  11. package/dist/@types/domains/client.d.ts +1 -1
  12. package/dist/@types/domains/client.d.ts.map +1 -1
  13. package/dist/@types/domains/comment.d.ts +1 -1
  14. package/dist/@types/domains/comment.d.ts.map +1 -1
  15. package/dist/@types/domains/file.d.ts +2 -2
  16. package/dist/@types/domains/file.d.ts.map +1 -1
  17. package/dist/@types/domains/mention.d.ts +23 -0
  18. package/dist/@types/domains/mention.d.ts.map +1 -0
  19. package/dist/@types/domains/message.d.ts +1 -1
  20. package/dist/@types/domains/message.d.ts.map +1 -1
  21. package/dist/@types/domains/post.d.ts +2 -2
  22. package/dist/@types/domains/post.d.ts.map +1 -1
  23. package/dist/@types/index.d.ts +1 -0
  24. package/dist/@types/index.d.ts.map +1 -1
  25. package/dist/category/api/queryCategories.d.ts +3 -3
  26. package/dist/channel/api/getChannels.d.ts.map +1 -1
  27. package/dist/channel/api/queryChannelMembers.d.ts.map +1 -1
  28. package/dist/channel/api/queryChannels.d.ts +1 -1
  29. package/dist/channel/events/onChannelCreated.d.ts.map +1 -1
  30. package/dist/client/api/disconnectClient.d.ts.map +1 -1
  31. package/dist/comment/api/createComment.d.ts +1 -1
  32. package/dist/comment/api/createComment.d.ts.map +1 -1
  33. package/dist/comment/api/getComments.d.ts.map +1 -1
  34. package/dist/comment/api/updateComment.d.ts +1 -1
  35. package/dist/comment/api/updateComment.d.ts.map +1 -1
  36. package/dist/comment/events/onCommentReactionAdded.d.ts.map +1 -1
  37. package/dist/comment/events/onCommentReactionRemoved.d.ts.map +1 -1
  38. package/dist/comment/events/utils.d.ts.map +1 -1
  39. package/dist/community/api/addCommunityMembers.d.ts.map +1 -1
  40. package/dist/community/api/joinCommunity.d.ts.map +1 -1
  41. package/dist/community/api/leaveCommunity.d.ts.map +1 -1
  42. package/dist/community/api/queryCommunities.d.ts +1 -1
  43. package/dist/community/api/removeCommunityMembers.d.ts.map +1 -1
  44. package/dist/community/events/utils.d.ts.map +1 -1
  45. package/dist/core/debug.d.ts.map +1 -1
  46. package/dist/core/device.d.ts.map +1 -1
  47. package/dist/core/events.d.ts.map +1 -1
  48. package/dist/core/microtasks.d.ts +13 -0
  49. package/dist/core/microtasks.d.ts.map +1 -0
  50. package/dist/core/query/paging.d.ts +2 -13
  51. package/dist/core/query/paging.d.ts.map +1 -1
  52. package/dist/core/query/query.d.ts +1 -1
  53. package/dist/core/query/query.d.ts.map +1 -1
  54. package/dist/feed/api/queryGlobalFeed.d.ts +22 -4
  55. package/dist/feed/api/queryGlobalFeed.d.ts.map +1 -1
  56. package/dist/index.cjs.js +138 -148
  57. package/dist/index.esm.js +139 -147
  58. package/dist/index.umd.js +5 -5
  59. package/dist/message/api/createMessage.d.ts +2 -2
  60. package/dist/message/api/createMessage.d.ts.map +1 -1
  61. package/dist/message/api/updateMessage.d.ts +2 -2
  62. package/dist/message/api/updateMessage.d.ts.map +1 -1
  63. package/dist/post/api/createPost.d.ts +7 -3
  64. package/dist/post/api/createPost.d.ts.map +1 -1
  65. package/dist/post/api/getPosts.d.ts.map +1 -1
  66. package/dist/post/api/queryPosts.d.ts +3 -3
  67. package/dist/post/api/queryPosts.d.ts.map +1 -1
  68. package/dist/post/api/updatePost.d.ts +1 -1
  69. package/dist/post/api/updatePost.d.ts.map +1 -1
  70. package/dist/post/events/onPostReactionAdded.d.ts.map +1 -1
  71. package/dist/post/events/onPostReactionRemoved.d.ts.map +1 -1
  72. package/dist/post/events/utils.d.ts.map +1 -1
  73. package/dist/role/api/queryRoles.d.ts +1 -1
  74. package/dist/stream/api/queryStreams.d.ts +1 -1
  75. package/dist/user/api/getUsers.d.ts.map +1 -1
  76. package/dist/utils/env.d.ts +5 -0
  77. package/dist/utils/env.d.ts.map +1 -0
  78. package/dist/version.d.ts.map +1 -1
  79. package/package.json +1 -3
  80. package/rollup.config.js +3 -0
  81. package/src/@types/core/cache.ts +2 -2
  82. package/src/@types/core/events.ts +6 -6
  83. package/src/@types/core/paging.ts +29 -44
  84. package/src/@types/core/payload.ts +2 -2
  85. package/src/@types/core/query.ts +7 -3
  86. package/src/@types/domains/client.ts +1 -1
  87. package/src/@types/domains/comment.ts +1 -0
  88. package/src/@types/domains/file.ts +2 -1
  89. package/src/@types/domains/mention.ts +26 -0
  90. package/src/@types/domains/message.ts +1 -0
  91. package/src/@types/domains/post.ts +2 -1
  92. package/src/@types/index.ts +2 -0
  93. package/src/channel/api/addChannelMembers.ts +1 -1
  94. package/src/channel/api/addChannelMembersRole.ts +1 -1
  95. package/src/channel/api/deleteChannel.ts +1 -1
  96. package/src/channel/api/getChannel.ts +1 -1
  97. package/src/channel/api/getChannels.ts +3 -1
  98. package/src/channel/api/joinChannel.ts +1 -1
  99. package/src/channel/api/leaveChannel.ts +1 -1
  100. package/src/channel/api/queryChannelMembers.ts +3 -2
  101. package/src/channel/api/removeChannelMembers.ts +1 -1
  102. package/src/channel/api/removeChannelMembersRole.ts +1 -1
  103. package/src/channel/api/updateChannel.ts +1 -1
  104. package/src/channel/events/onChannelCreated.ts +1 -3
  105. package/src/client/api/connectClient.ts +1 -1
  106. package/src/client/api/disconnectClient.ts +0 -1
  107. package/src/client/events/onConnectionError.ts +1 -1
  108. package/src/comment/api/createComment.ts +1 -2
  109. package/src/comment/api/deleteComment.ts +1 -1
  110. package/src/comment/api/getComment.ts +1 -1
  111. package/src/comment/api/getComments.ts +3 -1
  112. package/src/comment/api/updateComment.ts +2 -2
  113. package/src/comment/events/onCommentReactionAdded.ts +0 -7
  114. package/src/comment/events/onCommentReactionRemoved.ts +0 -7
  115. package/src/comment/events/utils.ts +3 -10
  116. package/src/community/api/addCommunityMembers.ts +3 -5
  117. package/src/community/api/joinCommunity.ts +1 -3
  118. package/src/community/api/leaveCommunity.ts +1 -3
  119. package/src/community/api/queryCommunityMembers.ts +1 -1
  120. package/src/community/api/removeCommunityMembers.ts +1 -3
  121. package/src/community/events/utils.ts +19 -33
  122. package/src/core/debug.ts +3 -1
  123. package/src/core/device.ts +3 -2
  124. package/src/core/events.ts +3 -1
  125. package/src/core/microtasks.ts +27 -0
  126. package/src/core/query/paging.ts +6 -41
  127. package/src/core/query/query.ts +5 -5
  128. package/src/core/subscription.ts +4 -4
  129. package/src/feed/api/queryGlobalFeed.ts +58 -5
  130. package/src/message/api/createMessage.ts +2 -2
  131. package/src/message/api/deleteMessage.ts +1 -1
  132. package/src/message/api/getMessage.ts +1 -1
  133. package/src/message/api/updateMessage.ts +3 -3
  134. package/src/post/api/createPost.ts +6 -5
  135. package/src/post/api/deletePost.ts +1 -1
  136. package/src/post/api/getPost.ts +1 -1
  137. package/src/post/api/getPosts.ts +3 -1
  138. package/src/post/api/queryPosts.ts +5 -5
  139. package/src/post/api/updatePost.ts +2 -2
  140. package/src/post/events/onPostReactionAdded.ts +0 -7
  141. package/src/post/events/onPostReactionRemoved.ts +0 -7
  142. package/src/post/events/utils.ts +2 -10
  143. package/src/report/api/createReport.ts +2 -2
  144. package/src/report/api/deleteReport.ts +2 -2
  145. package/src/user/api/getUser.ts +1 -1
  146. package/src/user/api/getUsers.ts +3 -1
  147. package/src/utils/env.ts +7 -0
  148. package/src/version.ts +3 -1
@@ -66,7 +66,7 @@ export const connectClient = async (params: {
66
66
  })
67
67
 
68
68
  client.userId = params.userId
69
- client.user = users[0]
69
+ client._internalUserId = users[0]._id
70
70
  client.accessToken = accessToken
71
71
 
72
72
  return client.ws.connected
@@ -29,7 +29,6 @@ export const disconnectClient = async (): Promise<boolean> => {
29
29
  client.ws.removeAllListeners()
30
30
  client.mqtt.removeAllListeners()
31
31
  client.userId = undefined
32
- client.user = undefined
33
32
  client.accessToken = undefined
34
33
 
35
34
  return !client.ws.connected
@@ -38,7 +38,7 @@ export const onConnectionError = (
38
38
  `client/onConnectionError(${event})`,
39
39
  event,
40
40
  (response) => {
41
- const error = (response && 'code' in response)
41
+ const error = response?.code
42
42
  ? new ASCError(response.message, response.code, Amity.ErrorLevel.FATAL)
43
43
  : new ASCConnectionError(event)
44
44
 
@@ -20,7 +20,7 @@ import { getPost } from '~/post/api/getPost'
20
20
  * @async
21
21
  */
22
22
  export const createComment = async <T extends Amity.CommentContentType>(
23
- bundle: Pick<Amity.Comment<T>, 'referenceType' | 'referenceId' | 'parentId' | 'data' | 'metadata'>,
23
+ bundle: Pick<Amity.Comment<T>, 'referenceType' | 'referenceId' | 'parentId' | 'data' | 'metadata' | 'mentionees'>,
24
24
  ): Promise<Amity.Cached<Amity.Comment>> => {
25
25
  const client = getActiveClient()
26
26
  client.log('comment/createComment', bundle)
@@ -29,7 +29,6 @@ export const createComment = async <T extends Amity.CommentContentType>(
29
29
  '/api/v3/comments', bundle,
30
30
  )
31
31
 
32
-
33
32
  const cachedAt = client.cache && Date.now()
34
33
  if (client.cache) ingestInCache(data, { cachedAt })
35
34
 
@@ -32,7 +32,7 @@ export const deleteComment = async (
32
32
 
33
33
  // API-FIX: This endpoint has not been implemented yet.
34
34
  await client.http.delete<{ success: boolean }>(
35
- `/api/v4/comments/${commentId}`, {
35
+ `/api/v4/comments/${encodeURIComponent(commentId)}`, {
36
36
  params: {
37
37
  commentId,
38
38
  permanent,
@@ -28,7 +28,7 @@ export const getComment = async (
28
28
  try {
29
29
  // API-FIX: endpoint should not be /list, parameters should be querystring.
30
30
  const response = await client.http.get<Amity.CommentPayload>(
31
- `/api/v3/comments/${commentId}`,
31
+ `/api/v3/comments/${encodeURIComponent(commentId)}`,
32
32
  )
33
33
 
34
34
  data = response.data;
@@ -23,10 +23,12 @@ export const getComments = async (
23
23
  const client = getActiveClient()
24
24
  client.log('comment/getComments', commentIds)
25
25
 
26
+ const encodedCommentIds = commentIds.map(commentId => encodeURIComponent(commentId))
27
+
26
28
  // API-FIX: endpoint should not be /list, parameters should be querystring.
27
29
  const { data } = await client.http.get<Amity.CommentPayload>(
28
30
  `/api/v3/comments/list`,
29
- { params: { commentIds } },
31
+ { params: { commentIds: encodedCommentIds } },
30
32
  )
31
33
 
32
34
  const cachedAt = client.cache && Date.now()
@@ -22,13 +22,13 @@ import { fireEvent } from '~/core/events'
22
22
  */
23
23
  export const updateComment = async (
24
24
  commentId: Amity.Comment['commentId'],
25
- patch: Patch<Amity.Comment, 'data' | 'metadata'>,
25
+ patch: Patch<Amity.Comment, 'data' | 'metadata' | 'mentionees'>,
26
26
  ): Promise<Amity.Cached<Amity.Comment>> => {
27
27
  const client = getActiveClient()
28
28
  client.log('user/updateComment', patch)
29
29
 
30
30
  const { data } = await client.http.put<Amity.CommentPayload>(
31
- `/api/v3/comments/${commentId}`, patch,
31
+ `/api/v3/comments/${encodeURIComponent(commentId)}`, patch,
32
32
  )
33
33
 
34
34
  const cachedAt = client.cache && Date.now()
@@ -1,4 +1,3 @@
1
- import isMatch from 'lodash.ismatch'
2
1
  import { getActiveClient } from '~/client/api'
3
2
  import { pullFromCache } from '~/cache/api'
4
3
  import { ingestInCache } from '~/cache/api/ingestInCache'
@@ -29,8 +28,6 @@ export const onCommentReactionAdded = (
29
28
  if (!client.cache) {
30
29
  callback(payload.comments[0])
31
30
  } else {
32
- const cached = pullFromCache<Amity.Comment>(['comment', 'get', payload.comments[0].commentId])
33
-
34
31
  preparePayloadForCache('comment.addReaction', payload)
35
32
  const { reactor, ...commentPayload } = payload;
36
33
 
@@ -38,10 +35,6 @@ export const onCommentReactionAdded = (
38
35
 
39
36
  const comment = pullFromCache<Amity.Comment>(['comment', 'get', payload.comments[0].commentId])!
40
37
 
41
- if (cached && isMatch(cached.data, comment.data)) {
42
- return
43
- }
44
-
45
38
  callback(comment.data)
46
39
  }
47
40
  }
@@ -1,4 +1,3 @@
1
- import isMatch from 'lodash.ismatch'
2
1
  import { getActiveClient } from '~/client/api'
3
2
  import { pullFromCache } from '~/cache/api'
4
3
  import { ingestInCache } from '~/cache/api/ingestInCache'
@@ -29,8 +28,6 @@ export const onCommentReactionRemoved = (
29
28
  if (!client.cache) {
30
29
  callback(payload.comments[0])
31
30
  } else {
32
- const cached = pullFromCache<Amity.Comment>(['comment', 'get', payload.comments[0].commentId])
33
-
34
31
  preparePayloadForCache('comment.removeReaction', payload)
35
32
  const { reactor, ...commentPayload } = payload;
36
33
 
@@ -38,10 +35,6 @@ export const onCommentReactionRemoved = (
38
35
 
39
36
  const comment = pullFromCache<Amity.Comment>(['comment', 'get', payload.comments[0].commentId])!
40
37
 
41
- if (cached && isMatch(cached.data, comment.data)) {
42
- return
43
- }
44
-
45
38
  callback(comment.data)
46
39
  }
47
40
  }
@@ -1,9 +1,7 @@
1
- import isMatch from 'lodash.ismatch'
2
1
  import { getActiveClient } from '~/client/api'
3
- import { pullFromCache } from '~/cache/api'
4
- import { ingestInCache } from '~/cache/api/ingestInCache'
5
2
  import { createEventSubscriber } from '~/core/events'
6
- import { queryCache, upsertInCache } from '~/cache/api'
3
+ import { queryCache, upsertInCache, pullFromCache } from '~/cache/api'
4
+ import { ingestInCache } from '~/cache/api/ingestInCache'
7
5
 
8
6
  export const createCommentEventSubscriber = (
9
7
  event: keyof Amity.MqttCommentMessageEvents,
@@ -13,18 +11,13 @@ export const createCommentEventSubscriber = (
13
11
 
14
12
  const filter = (payload: Amity.CommentPayload) => {
15
13
  if (!client.cache) {
14
+ // TODO: here we are missing specific properties here!
16
15
  callback(payload.comments[0])
17
16
  } else {
18
- const cached = pullFromCache<Amity.Comment>(['comment', 'get', payload.comments[0].commentId])
19
-
20
17
  ingestInCache(payload)
21
18
 
22
19
  const comment = pullFromCache<Amity.Comment>(['comment', 'get', payload.comments[0].commentId])!
23
20
 
24
- if (cached && isMatch(cached.data, comment.data)) {
25
- return
26
- }
27
-
28
21
  if (['comment.created'].includes(event)) {
29
22
  const queries = queryCache(['comment', 'query'])
30
23
  // @ts-ignore
@@ -1,7 +1,8 @@
1
1
  import { getActiveClient } from '~/client/api'
2
2
 
3
- import { ingestInCache } from '~/cache/api/ingestInCache'
4
3
  import { fireEvent } from '~/core/events'
4
+ import { ingestInCache } from '~/cache/api/ingestInCache'
5
+
5
6
  /**
6
7
  * ```js
7
8
  * import { addCommunityMembers } from '@amityco/ts-sdk'
@@ -29,12 +30,9 @@ export const addCommunityMembers = async (
29
30
  { communityId, userIds }
30
31
  )
31
32
 
32
-
33
33
  if (client.cache) ingestInCache(data)
34
34
 
35
- fireEvent('community.userAdded', {
36
- communities: data.communities!,
37
- })
35
+ fireEvent('community.userAdded', data)
38
36
 
39
37
  const { communityUsers } = data
40
38
  return !!communityUsers.find(
@@ -30,9 +30,7 @@ export const joinCommunity = async (
30
30
  const cachedAt = client.cache && Date.now()
31
31
  if (client.cache) ingestInCache(data, { cachedAt })
32
32
 
33
- fireEvent('community.joined', {
34
- communities: data.communities!
35
- })
33
+ fireEvent('community.joined', data)
36
34
 
37
35
  const { communityUsers } = data
38
36
 
@@ -30,9 +30,7 @@ export const leaveCommunity = async (
30
30
  const cachedAt = client.cache && Date.now()
31
31
  if (client.cache) ingestInCache(data, { cachedAt })
32
32
 
33
- fireEvent('community.left', {
34
- communities: data.communities!,
35
- })
33
+ fireEvent('community.left', data)
36
34
 
37
35
  const { communityUsers } = data
38
36
 
@@ -51,7 +51,7 @@ export const queryCommunityMembers = async (query: {
51
51
  const nextPage = toPage(paging.next)
52
52
  const prevPage = toPage(paging.previous)
53
53
 
54
- return { data: communityUsers, nextPage, prevPage }
54
+ return { data: communityUsers, cachedAt, nextPage, prevPage }
55
55
  }
56
56
 
57
57
  /**
@@ -32,9 +32,7 @@ export const removeCommunityMembers = async (
32
32
 
33
33
  if (client.cache) ingestInCache(data)
34
34
 
35
- fireEvent('community.userRemoved', {
36
- communities: data.communities!,
37
- })
35
+ fireEvent('community.userRemoved', data)
38
36
 
39
37
  const { communityUsers } = data
40
38
  return !!communityUsers.find(
@@ -1,8 +1,7 @@
1
- import isMatch from 'lodash.ismatch'
2
1
  import { getActiveClient } from '~/client/api'
3
- import { pullFromCache } from '~/cache/api'
4
2
  import { ingestInCache } from '~/cache/api/ingestInCache'
5
3
  import { createEventSubscriber } from '~/core/events'
4
+ import { pullFromCache } from '~/cache/api'
6
5
  import { getResolver } from '~/core/model'
7
6
 
8
7
  export const createCommunityEventSubscriber = (
@@ -13,18 +12,13 @@ export const createCommunityEventSubscriber = (
13
12
 
14
13
  const filter = (payload: Amity.CommunityPayload) => {
15
14
  if (!client.cache) {
15
+ // TODO: here we are missing specific properties here!
16
16
  callback(payload.communities[0])
17
17
  } else {
18
- const cached = pullFromCache<Amity.Community>(['community', 'get', payload.communities[0].communityId])
19
-
20
18
  ingestInCache(payload)
21
19
 
22
20
  const community = pullFromCache<Amity.Community>(['community', 'get', payload.communities[0].communityId])!
23
21
 
24
- if (cached && isMatch(cached.data, community?.data)) {
25
- return
26
- }
27
-
28
22
  callback(community.data)
29
23
  }
30
24
  }
@@ -37,7 +31,7 @@ export const createCommunityEventSubscriber = (
37
31
  )
38
32
  }
39
33
 
40
- function hasPermission(member: Amity.Membership<'community'>, payload: Amity.CommunityPayload, permission: string) {
34
+ function hasPermission(member: Amity.Membership<'community'>, payload: Amity.CommunityMembershipPayload, permission: string) {
41
35
  if (member.permissions.some(x => x === permission)) {
42
36
  return true;
43
37
  }
@@ -47,10 +41,9 @@ function hasPermission(member: Amity.Membership<'community'>, payload: Amity.Com
47
41
  .permissions.some(x => x === permission)
48
42
  }
49
43
 
50
-
51
44
  function getEventRelatedMember(
52
45
  event: keyof Amity.MqttCommunityUserMessageEvents,
53
- payload: Amity.CommunityPayload
46
+ payload: Amity.CommunityMembershipPayload
54
47
  ) {
55
48
  if (event === 'community.joined' || event === 'community.left') {
56
49
  return payload.communityUsers![0];
@@ -80,29 +73,22 @@ export const createCommunityMemberEventSubscriber = (
80
73
  ) => {
81
74
  const client = getActiveClient()
82
75
 
83
- const filter = (payload: Amity.CommunityPayload) => {
84
- const cachedCommunity = pullFromCache<Amity.Community>(['community', 'get', payload.communities[0].communityId])
85
- const cachedMember = pullFromCache<Amity.Membership<'community'>>([
86
- 'communityUsers',
87
- 'get',
88
- getResolver('communityUsers')(getEventRelatedMember(event, payload))
89
- ])
90
-
91
- ingestInCache(payload)
92
-
93
- const community = pullFromCache<Amity.Community>(['community', 'get', payload.communities[0].communityId])!
94
- const member = pullFromCache<Amity.Membership<'community'>>([
95
- 'communityUsers',
96
- 'get',
97
- getResolver('communityUsers')(getEventRelatedMember(event, payload))
98
- ])!
99
-
100
- if (cachedCommunity && isMatch(cachedCommunity.data, community.data)
101
- && cachedMember && isMatch(cachedMember.data, member.data)) {
102
- return
103
- }
76
+ const filter = (payload: Amity.CommunityMembershipPayload) => {
77
+ if (!client.cache) {
78
+ // TODO: here we are missing specific properties here!
79
+ callback(payload.communities[0], getEventRelatedMember(event, payload))
80
+ } else {
81
+ ingestInCache(payload)
104
82
 
105
- callback(community.data, member.data)
83
+ const community = pullFromCache<Amity.Community>(['community', 'get', payload.communities[0].communityId])!
84
+ const member = pullFromCache<Amity.Membership<'community'>>([
85
+ 'communityUsers',
86
+ 'get',
87
+ getResolver('communityUsers')(getEventRelatedMember(event, payload))
88
+ ])!
89
+
90
+ callback(community.data, member.data)
91
+ }
106
92
  }
107
93
 
108
94
  return createEventSubscriber(
package/src/core/debug.ts CHANGED
@@ -1,5 +1,7 @@
1
1
  import debug from 'debug'
2
2
 
3
+ import { isProduction } from '~/utils/env'
4
+
3
5
  /**
4
6
  * Creates a pre-configured logger instance
5
7
  *
@@ -12,7 +14,7 @@ import debug from 'debug'
12
14
  export const createLogger = (session?: string) => {
13
15
  const active = (
14
16
  `${session?.trim()}`.length > 0
15
- && process.env.NODE_ENV !== 'production'
17
+ && !isProduction
16
18
  )
17
19
 
18
20
  const logger = debug(session!)
@@ -1,5 +1,6 @@
1
1
  // TODO: find a way to uniquely identify the device
2
2
  // import { getStorage } from './storage'
3
+ import { safeProcess } from '~/utils/env'
3
4
 
4
5
  /** @hidden */
5
6
  const VERSION = '11.0.0'
@@ -16,8 +17,8 @@ export const getDeviceId = () => {
16
17
 
17
18
  /** @hidden */
18
19
  export const getDeviceModel = () => {
19
- if (process?.versions?.node)
20
- return process.versions.node
20
+ if (safeProcess.versions?.node)
21
+ return safeProcess.versions.node
21
22
 
22
23
  if (navigator)
23
24
  return `${navigator.product.toLowerCase()}#${navigator.userAgent ?? 'unknown_agent'}`
@@ -2,6 +2,8 @@ import mitt from 'mitt'
2
2
 
3
3
  import { getActiveClient } from '~/client/api/activeClient'
4
4
 
5
+ import { scheduleTask } from './microtasks'
6
+
5
7
  // need to sync up the list
6
8
  const WS_EVENTS = [
7
9
  'disconnected',
@@ -134,5 +136,5 @@ export const fireEvent = <T extends keyof Amity.Events>(
134
136
  payload: Amity.Events[T],
135
137
  ) => {
136
138
  const { emitter } = getActiveClient()
137
- setTimeout(() => { emitter.emit(event, payload) }, 0)
139
+ scheduleTask(() => { emitter.emit(event, payload) })
138
140
  }
@@ -0,0 +1,27 @@
1
+ let tasks: Function[] = []
2
+ let timer: NodeJS.Timeout
3
+
4
+ /**
5
+ * Add a function to run just before the next tick
6
+ *
7
+ * @param task function to schedule for later execution
8
+ */
9
+ export const scheduleTask = (task: Function) => {
10
+ clearTimeout(timer)
11
+ tasks.push(task)
12
+
13
+ timer = setTimeout(() => {
14
+ tasks.forEach(fn => fn())
15
+ tasks = []
16
+ }, 0)
17
+ }
18
+
19
+ /**
20
+ * Cancel the scheduling operation
21
+ *
22
+ * @param task function to be removed from later execution
23
+ */
24
+ export const cancelTask = (task: Function) => {
25
+ tasks = tasks.filter(fn => fn !== task)
26
+ if (!tasks.length) clearTimeout(timer)
27
+ }
@@ -1,4 +1,3 @@
1
- // @ts-ignore
2
1
  import { encode, decode } from 'js-base64'
3
2
 
4
3
  /**
@@ -22,7 +21,7 @@ export const isSkipLimit = (json: Object): json is Amity.SkipLimitPagination =>
22
21
  * @hidden
23
22
  */
24
23
  export const isAfterBefore = (json: Object): json is Amity.AfterBeforePagination => (
25
- ['after', 'before', 'first', 'last'].some(prop => prop in json)
24
+ ['after', 'before', 'first', 'last', 'limit'].some(prop => prop in json)
26
25
  )
27
26
 
28
27
  /**
@@ -34,7 +33,7 @@ export const isAfterBefore = (json: Object): json is Amity.AfterBeforePagination
34
33
  * @hidden
35
34
  */
36
35
  export const isAfterBeforeRaw = (json: Object): json is Amity.AfterBeforeRawPagination => (
37
- ['after', 'before'].some(prop => prop in json)
36
+ 'limit' in json
38
37
  )
39
38
 
40
39
  /**
@@ -63,9 +62,8 @@ export const isPaged = <T extends unknown>(payload: any): payload is Amity.Paged
63
62
  * @hidden
64
63
  */
65
64
  export const toToken = (
66
- paging: Amity.Page | undefined,
67
- style: 'skiplimit' | 'afterbefore' | 'afterbeforeraw',
68
-
65
+ paging: Amity.Page | Amity.PageRaw | undefined,
66
+ style: Amity.PaginationStyles,
69
67
  ): Amity.Token | undefined => {
70
68
  if (!paging || !Object.keys(paging).length)
71
69
  return
@@ -79,7 +77,7 @@ export const toToken = (
79
77
  limit: paging.limit,
80
78
  }
81
79
  }
82
- else if (style === 'afterbefore') {
80
+ else if (style === 'afterbefore' && isAfterBefore(paging)) {
83
81
  /*
84
82
  Caution: this testing style is only valid because
85
83
  our backend expects nothing else than a number as
@@ -114,6 +112,7 @@ export const toToken = (
114
112
  return encode(JSON.stringify(payload))
115
113
  }
116
114
 
115
+
117
116
  /**
118
117
  * Converts a b64 string token into a paging object
119
118
  *
@@ -170,37 +169,3 @@ export const toPageRaw = (token?: Amity.Token): Amity.PageRaw | null => {
170
169
 
171
170
  return null
172
171
  }
173
-
174
- /**
175
- * Slices a collection according to its paging
176
- *
177
- * @param type the type of collection (for unique id identification with after/before)
178
- * @param collection the collection to slice
179
- * @param paging the paging object
180
- * @returns the sliced collection according to the paging definition
181
- *
182
- * @hidden
183
- */
184
- export const sliceByPaging = <K extends Amity.Domain, T extends Amity.Model[K]>(
185
- type: K, collection: T[], page?: Amity.Page
186
- ) => {
187
- console.log('slice by paging', page)
188
- if (!page) return collection.slice()
189
-
190
- let start: number | undefined = 0
191
- let end: number | undefined = undefined
192
-
193
- // next page behavior
194
- if (page.after) {
195
- start = page.after
196
- end = start + page.limit
197
- // prev page behavior
198
- } else if (page.before) {
199
- end = page.before + 1
200
- start = end > page.limit ? end - page.limit : 0
201
- }
202
-
203
- const paged = collection.slice(start, end)
204
-
205
- return paged.length === page.limit ? paged : undefined
206
- }
@@ -170,7 +170,7 @@ const isEmpty = (local: any) => {
170
170
  */
171
171
  export const runQuery = <Args extends any[], Returned extends any>(
172
172
  { func, args }: Amity.Query<Args, Returned>,
173
- callback?: (args: Amity.Snapshot<Returned | undefined>) => void,
173
+ callback?: (args: Amity.Snapshot<Returned>) => void,
174
174
  options: Amity.QueryOptions = queryOptions('cache_then_server')
175
175
  ) => {
176
176
  let local: Returned | undefined
@@ -193,7 +193,7 @@ export const runQuery = <Args extends any[], Returned extends any>(
193
193
 
194
194
  const shouldAbort = isCachable(local) && isFresh(local, options.lifeSpan)
195
195
 
196
- callback?.(createSnapshot(local , {
196
+ callback?.(createSnapshot<Returned>(local , {
197
197
  origin: 'local',
198
198
  loading: !(isFetcher(func) && shouldAbort)
199
199
  }))
@@ -201,7 +201,7 @@ export const runQuery = <Args extends any[], Returned extends any>(
201
201
  if (shouldAbort)
202
202
  return
203
203
  } else {
204
- callback?.(createSnapshot(undefined, {
204
+ callback?.(createSnapshot<Returned>(undefined, {
205
205
  origin: 'local',
206
206
  loading: true
207
207
  }))
@@ -213,7 +213,7 @@ export const runQuery = <Args extends any[], Returned extends any>(
213
213
  // isLocal(local) && syncInCache(local, fresh)
214
214
 
215
215
  callback?.(
216
- createSnapshot(fresh, {
216
+ createSnapshot<Returned>(fresh, {
217
217
  origin: 'server',
218
218
  loading: false,
219
219
  })
@@ -221,7 +221,7 @@ export const runQuery = <Args extends any[], Returned extends any>(
221
221
  })
222
222
  .catch(error => {
223
223
  callback?.(
224
- createSnapshot(undefined, {
224
+ createSnapshot<Returned>(undefined, {
225
225
  origin: 'server',
226
226
  loading: false,
227
227
  error,
@@ -61,13 +61,13 @@ export function subscribeTopic(
61
61
  topic: string,
62
62
  callback?: Amity.Listener<ASCError | void>
63
63
  ): Amity.Unsubscriber {
64
- const { mqtt, emitter, accessToken, user } = getActiveClient()
64
+ const { mqtt, emitter, accessToken, _internalUserId } = getActiveClient()
65
65
 
66
- if (mqttAccessToken !== accessToken || mqttUserId !== user!._id) {
66
+ if (mqttAccessToken !== accessToken || mqttUserId !== _internalUserId) {
67
67
  mqttAccessToken = accessToken!
68
- mqttUserId = user!._id
68
+ mqttUserId = _internalUserId!
69
69
 
70
- mqtt.connect({ accessToken: accessToken!, userId: user!._id })
70
+ mqtt.connect({ accessToken: mqttAccessToken, userId: mqttUserId })
71
71
  proxyMqttEvents(mqtt, emitter)
72
72
  }
73
73
 
@@ -2,6 +2,8 @@ import { getActiveClient } from '~/client/api/activeClient'
2
2
 
3
3
  import { toPage, toToken } from '~/core/query'
4
4
  import { ingestInCache } from '~/cache/api/ingestInCache'
5
+ import { pullFromCache, pushToCache } from '~/cache/api'
6
+ import { getResolver } from '~/core/model'
5
7
 
6
8
  /**
7
9
  * ```js
@@ -19,15 +21,16 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
19
21
  **/
20
22
  export const queryGlobalFeed = async (query?: {
21
23
  dataTypes?: ('video' | 'image' | 'file' | 'liveStream')[]
24
+ useCustomRanking?: boolean
22
25
  page?: Amity.Page
23
- }): Promise<Amity.Paged<Amity.Post>> => {
26
+ }): Promise<Amity.Cached<Amity.Paged<Amity.Post>>> => {
24
27
  const client = getActiveClient()
25
28
  client.log('feed/queryGlobalFeed', query)
26
29
 
27
- const { page, ...params } = query ?? {}
30
+ const { useCustomRanking, page, ...params } = query ?? {}
28
31
 
29
32
  const { data } = await client.http.get<Amity.PostPayload & Amity.Pagination>(
30
- `/api/v4/me/global-feeds`, { params: {
33
+ useCustomRanking ? `/api/v5/me/global-feeds` : `/api/v4/me/global-feeds`, { params: {
31
34
  ...params,
32
35
  options: {
33
36
  token: toToken(page, 'skiplimit')
@@ -38,10 +41,60 @@ export const queryGlobalFeed = async (query?: {
38
41
  const { paging, ...payload } = data
39
42
  const { posts } = payload
40
43
 
41
- if (client.cache) ingestInCache(payload as Amity.PostPayload)
44
+ const cachedAt = client.cache && Date.now()
45
+
46
+ if (client.cache) {
47
+ ingestInCache(payload as Amity.PostPayload)
48
+
49
+ const cacheKey = ['globalFeed', 'query', { ...params, useCustomRanking, options: { ...page } } as Amity.Serializable]
50
+ pushToCache(cacheKey, { posts: posts.map(getResolver('post')), paging })
51
+ }
42
52
 
43
53
  const nextPage = toPage(paging.next)
44
54
  const prevPage = toPage(paging.previous)
45
55
 
46
- return { data: posts, prevPage, nextPage }
56
+ return { data: posts, cachedAt, prevPage, nextPage }
57
+ }
58
+
59
+ /**
60
+ * ```js
61
+ * import { queryGlobalFeed } from '@amityco/ts-sdk'
62
+ * const posts = await queryGlobalFeed.locally()
63
+ * ```
64
+ *
65
+ * Queries a paginable list of {@link Amity.Post} objects from cache
66
+ *
67
+ * @param query The query parameters
68
+ * @returns A page of {@link Amity.Post} objects
69
+ *
70
+ * @category Feed API
71
+ * @async
72
+ **/
73
+ queryGlobalFeed.locally = (
74
+ query: Parameters<typeof queryGlobalFeed>[0],
75
+ ): Amity.Cached<Amity.Paged<Amity.Post>> | undefined => {
76
+ const client = getActiveClient()
77
+ client.log('post/queryGlobalFeed.locally', query)
78
+
79
+ if (!client.cache) return
80
+
81
+ const { useCustomRanking, page, ...params } = query ?? {}
82
+
83
+ const queryKey = ['globalFeed', 'query', { ...params, useCustomRanking, options: { ...page }} as Amity.Serializable];
84
+ const { data, cachedAt } = pullFromCache<{ posts: string[] } & Amity.Pagination>(queryKey) ?? {}
85
+
86
+ if (!data?.posts.length)
87
+ return
88
+
89
+ const posts: Amity.Post[] = data.posts
90
+ .map(postId => pullFromCache<Amity.Post>(['post', 'get', postId])!)
91
+ .filter(Boolean)
92
+ .map(({ data }) => data)
93
+
94
+ const prevPage = toPage(data?.paging.previous)
95
+ const nextPage = toPage(data?.paging.next)
96
+
97
+ return posts.length === data?.posts?.length
98
+ ? { data: posts, cachedAt, prevPage, nextPage }
99
+ : undefined
47
100
  }