@amityco/ts-sdk 0.0.1-beta.40 → 0.0.1-beta.42.1

package/src/channel/api/addChannelMembers.ts

@@ -5,6 +5,9 @@ import { fireEvent } from '~/core/events';
 
 import { prepareChannelPayload } from '../utils';
 
+/* begin_public_function
+  id: channel.member.add
+*/
 /**
  * ```js
  * import { addChannelMembers } from '@amityco/ts-sdk'
@@ -51,3 +54,4 @@ export const addChannelMembers = async (
     channelUser => channelUser.channelId === channelId && channelUser.membership === 'member',
   );
 };
+/* end_public_function */

package/src/channel/api/addChannelMembersRole.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../utils';
 
+/* begin_public_function
+  id: channel.moderation.add_roles
+*/
 /**
  * ```js
  * import { addChannelMembersRole } from '@amityco/ts-sdk'
@@ -42,3 +45,4 @@ export const addChannelMembersRole = async (
     channelUser => channelUser.channelId === channelId && channelUser.roles.includes(roleId),
   );
 };
+/* end_public_function */

package/src/channel/api/banChannelMembers.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../utils';
 
+/* begin_public_function
+  id: channel.moderation.ban_members
+*/
 /**
  * ```js
  * import { banChannelMembers } from '@amityco/ts-sdk'
@@ -43,3 +46,4 @@ export const banChannelMembers = async (
     cachedAt,
   };
 };
+/* end_public_function */

package/src/channel/api/createChannel.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../utils';
 
+/* begin_public_function
+  id: channel.create
+*/
 /**
  * ```js
  * import { createChannel } from '@amityco/ts-sdk'
@@ -49,3 +52,4 @@ export const createChannel = async <T extends Amity.ChannelType>(
     cachedAt,
   };
 };
+/* end_public_function */

package/src/channel/api/getChannel.ts

@@ -9,6 +9,9 @@ import { pushToTombstone } from '~/cache/api/pushToTombstone';
 
 import { prepareChannelPayload } from '../utils';
 
+/* begin_public_function
+  id: channel.get
+*/
 /**
  * ```js
  * import { getChannel } from '@amityco/ts-sdk'
@@ -57,6 +60,7 @@ export const getChannel = async (
     cachedAt,
   };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/channel/api/joinChannel.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../utils';
 
+/* begin_public_function
+  id: channel.join
+*/
 /**
  * ```js
  * import { joinChannel } from '@amityco/ts-sdk'
@@ -36,3 +39,4 @@ export const joinChannel = async (channelId: Amity.Channel['channelId']): Promis
     channelUser => channelUser.channelId === channelId && channelUser.membership === 'member',
   );
 };
+/* end_public_function */

package/src/channel/api/leaveChannel.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../utils';
 
+/* begin_public_function
+  id: channel.leave
+*/
 /**
  * ```js
  * import { leaveChannel } from '@amityco/ts-sdk'
@@ -36,3 +39,4 @@ export const leaveChannel = async (channelId: Amity.Channel['channelId']): Promi
     channelUser => channelUser.channelId === channelId && channelUser.membership !== 'member',
   );
 };
+/* end_public_function */

package/src/channel/api/queryChannelMembers.ts

@@ -7,6 +7,9 @@ import { getResolver } from '~/core/model';
 import { pullFromCache, pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
+/* begin_public_function
+  id: channel.member.query, channel.member.search
+*/
 /**
  * ```js
  * import { queryChannelMembers } from '@amityco/ts-sdk'
@@ -73,6 +76,7 @@ export const queryChannelMembers = async (
     prevPage,
   };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/channel/api/queryChannels.ts

@@ -8,6 +8,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../utils';
 
+/* begin_public_function
+  id: channel.query
+*/
 /**
  * ```js
  * import { queryChannels } from '@amityco/ts-sdk'
@@ -73,6 +76,7 @@ export const queryChannels = async (
 
   return { data: channels, cachedAt, prevPage, nextPage };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/channel/api/removeChannelMembers.ts

@@ -5,6 +5,9 @@ import { fireEvent } from '~/core/events';
 
 import { prepareChannelPayload } from '../utils';
 
+/* begin_public_function
+  id: channel.member.remove
+*/
 /**
  * ```js
  * import { removeChannelMembers } from '@amityco/ts-sdk'
@@ -51,3 +54,4 @@ export const removeChannelMembers = async (
     channelUser => channelUser.channelId === channelId && channelUser.membership !== 'member',
   );
 };
+/* end_public_function */

package/src/channel/api/removeChannelMembersRole.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../utils';
 
+/* begin_public_function
+  id: channel.moderation.remove_roles
+*/
 /**
  * ```js
  * import { removeChannelMembersRole } from '@amityco/ts-sdk'
@@ -14,7 +17,7 @@ import { prepareChannelPayload } from '../utils';
  *
  * @param channelId The ID of the {@link Amity.Channel} to perform
  * @param roleId The ID of the {@link Amity.Role} to apply
- * @param userId Array of IDs of the {@link Amity.User} to perform
+ * @param userIds Array of IDs of the {@link Amity.User} to perform
  * @returns A success boolean if the {@link Amity.Role} were removed from list of {@link Amity.User} in the {@link Amity.Channel}
  *
  * @category Channel API
@@ -42,3 +45,4 @@ export const removeChannelMembersRole = async (
     channelUser => channelUser.channelId === channelId && !channelUser.roles.includes(roleId),
   );
 };
+/* end_public_function */

package/src/channel/api/startReading.ts

@@ -2,6 +2,9 @@ import { getActiveClient } from '~/client/api';
 import { synchronousWSCall } from '~/core/transports';
 import { pullFromCache, pushToCache } from '~/cache/api';
 
+/* begin_public_function
+  id: channel.start_reading
+*/
 /**
  * ```js
  * import { startReading } from '@amityco/ts-sdk'
@@ -10,9 +13,9 @@ import { pullFromCache, pushToCache } from '~/cache/api';
  *
  * Mark all messages as read and start reading message inside channel
  *
- * @param {string} subChannelId - The channel ID to start reading.
- * @param {string} userId - The user ID of channel member.
- * @return {Promise<boolean>>} A success boolean if the channel reading of the sub channel had begun.
+ * @param subChannelId - The channel ID to start reading.
+ * @param userId - The user ID of channel member.
+ * @return A success boolean if the channel reading of the sub channel had begun.
  *
  * @category Message API
  * @async
@@ -51,3 +54,4 @@ export const startReading = async (subChannelId: string, userId = getActiveClien
 
   return !!result;
 };
+/* end_public_function */

package/src/channel/api/stopReading.ts

@@ -2,6 +2,9 @@ import { getActiveClient } from '~/client/api';
 import { synchronousWSCall } from '~/core/transports';
 import { pullFromCache, pushToCache } from '~/cache/api';
 
+/* begin_public_function
+  id: channel.stop_reading
+*/
 /**
  * ```js
  * import { stopReading } from '@amityco/ts-sdk'
@@ -10,8 +13,8 @@ import { pullFromCache, pushToCache } from '~/cache/api';
  *
  * Stop reading message inside channel
  *
- * @param {string} subChannelId - The channel ID to stop reading.
- * @return {Promise<boolean>>} A success boolean if the sub channel reading was halted.
+ * @param subChannelId - The channel ID to stop reading.
+ * @return A success boolean if the sub channel reading was halted.
  *
  * @category Message API
  * @async
@@ -47,3 +50,4 @@ export const stopReading = async (subChannelId: string) => {
 
   return !!result;
 };
+/* end_public_function */

package/src/channel/api/unbanChannelMembers.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../utils';
 
+/* begin_public_function
+  id: channel.moderation.unban_members
+*/
 /**
  * ```js
  * import { unbanChannelMembers } from '@amityco/ts-sdk'
@@ -44,3 +47,4 @@ export const unbanChannelMembers = async (
     cachedAt,
   };
 };
+/* end_public_function */

package/src/channel/api/updateChannel.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../utils';
 
+/* begin_public_function
+  id: channel.update
+*/
 /**
  * ```js
  * import { updateChannel } from '@amityco/ts-sdk'
@@ -43,3 +46,4 @@ export const updateChannel = async (
     cachedAt,
   };
 };
+/* end_public_function */

package/src/channel/observers/liveChannel.ts

@@ -1,7 +1,17 @@
 import { liveObject } from '~/utils/liveObject';
 import { onMessageCreated } from '~/message/events';
 import { getChannel } from '../api';
-import { onChannelDeleted, onChannelJoined, onChannelMuted, onChannelUpdated } from '../events';
+import {
+  onChannelDeleted,
+  onChannelJoined,
+  onChannelLeft,
+  onChannelMemberAdded,
+  onChannelMemberBanned,
+  onChannelMemberRemoved,
+  onChannelMemberUnbanned,
+  onChannelMuted,
+  onChannelUpdated,
+} from '../events';
 
 /**
  * ```js
@@ -30,6 +40,11 @@ export const liveChannel = (
     onChannelUpdated,
     onChannelDeleted,
     onChannelJoined,
+    onChannelLeft,
+    onChannelMemberAdded,
+    onChannelMemberRemoved,
+    onChannelMemberBanned,
+    onChannelMemberUnbanned,
     onChannelMuted,
     () => onMessageCreated(() => null), // watch unread count
   ]);

package/src/client/api/connectClient.ts

@@ -33,6 +33,9 @@ import { setClientToken } from '../utils/setClientToken';
  */
 const subscriptions: Amity.Unsubscriber[] = [];
 
+/* begin_public_function
+  id: client.login
+*/
 /**
  * ```js
  * import { connectClient } from '@amityco/ts-sdk/client/api'
@@ -168,3 +171,4 @@ export const connectClient = async (
 
   return client.ws.connected;
 };
+/* end_public_function */

package/src/client/api/disconnectClient.ts

@@ -1,6 +1,9 @@
 import { getActiveClient } from './activeClient';
 import { setSessionState } from './setSessionState';
 
+/* begin_public_function
+  id: client.logout
+*/
 /**
  * ```js
  * import { disconnectClient } from '@amityco/ts-sdk'
@@ -57,3 +60,4 @@ export const disconnectClient = async (): Promise<boolean> => {
 
   return !client.ws.connected;
 };
+/* end_public_function */

package/src/client/api/getToken.ts

@@ -26,7 +26,7 @@ export const getToken = async (params: {
   const deviceInfo = getDeviceInfo();
 
   const { data } = await client.http.post<Amity.Tokens & { users: Amity.User[] }>(
-    '/api/v3/sessions',
+    '/api/v4/sessions',
     {
       ...params,
       deviceInfo,

package/src/client/api/renewal.ts

@@ -6,6 +6,9 @@ import { setClientToken as refreshToken } from '../utils/setClientToken';
 import { getActiveClient } from './activeClient';
 import { connectClient } from './connectClient';
 
+/* begin_public_function
+  id: client.renew_access_token
+*/
 /*
  * Renewal defintion accepted by SessionHandler interface
  *
@@ -72,3 +75,4 @@ export const renewal = (): Amity.AccessTokenRenewal => {
     },
   };
 };
+/* end_public_function */

package/src/client/api/tests/getToken.test.ts

@@ -8,8 +8,8 @@ describe('getToken', () => {
   const deviceId = 'test-deviceId';
   const params = { userId, displayName, deviceId };
 
-  test('it should call v3/sessions api', async () => {
-    const expected = '/api/v3/sessions';
+  test('it should call v4/sessions api', async () => {
+    const expected = '/api/v4/sessions';
     const mockApi = jest.fn().mockResolvedValue(sessionResponse);
     client.http.post = mockApi;
 

package/src/comment/api/createComment.ts

@@ -5,6 +5,9 @@ import { fireEvent } from '~/core/events';
 
 import { getPost } from '~/post/api/getPost';
 
+/* begin_public_function
+  id: comment.create
+*/
 /**
  * ```js
  * import { createComment } from '@amityco/ts-sdk'
@@ -60,3 +63,4 @@ export const createComment = async (
     cachedAt,
   };
 };
+/* end_public_function */

package/src/comment/api/deleteComment.ts

@@ -9,6 +9,9 @@ import { scheduleTask } from '~/core/microtasks';
 
 import { getComment } from './getComment';
 
+/* begin_public_function
+  id: comment.soft_delete, comment.hard_delete
+*/
 /**
  * ```js
  * import { deleteComment } from '@amityco/ts-sdk'
@@ -75,3 +78,4 @@ export const deleteComment = async (
 
   return deleted;
 };
+/* end_public_function */

package/src/comment/api/getComment.ts

@@ -6,6 +6,9 @@ import { isInTombstone } from '~/cache/api/isInTombstone';
 import { checkIfShouldGoesToTombstone } from '~/cache/utils';
 import { pushToTombstone } from '~/cache/api/pushToTombstone';
 
+/* begin_public_function
+  id: comment.get
+*/
 /**
  * ```js
  * import { getComment } from '@amityco/ts-sdk'
@@ -54,6 +57,7 @@ export const getComment = async (
     cachedAt,
   };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/comment/api/getComments.ts

@@ -3,6 +3,9 @@ import { getActiveClient } from '~/client/api';
 import { pullFromCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
+/* begin_public_function
+  id: comment.get_by_ids
+*/
 /**
  * ```js
  * import { getComments } from '@amityco/ts-sdk'
@@ -38,6 +41,7 @@ export const getComments = async (
     cachedAt,
   };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/comment/api/queryComments.ts

@@ -5,6 +5,9 @@ import { pullFromCache, pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { getResolver } from '~/core/model';
 
+/* begin_public_function
+  id: comment.query
+*/
 /**
  * ```js
  * import { queryComments } from '@amityco/ts-sdk'
@@ -25,7 +28,7 @@ export const queryComments = async (
   const client = getActiveClient();
   client.log('comment/queryComments', query);
 
-  const { page = { limit: 10 }, ...params } = query;
+  const { page = { limit: 10 }, includeDeleted, ...params } = query;
 
   const options = {
     type: params.sortBy ? 'pagination' : undefined,
@@ -41,6 +44,7 @@ export const queryComments = async (
     {
       params: {
         ...params,
+        isDeleted: includeDeleted === false ? false : undefined,
         //      filterByParentId, API-FIX: backend does not support this boolean LOL. what the hell seriously.
         options,
       },
@@ -70,6 +74,7 @@ export const queryComments = async (
 
   return { data: comments, cachedAt, prevPage, nextPage };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/comment/api/tests/createComment.test.ts

@@ -7,122 +7,27 @@ import {
   imageComment11,
   textImageComment11,
   textMentionComment11,
-  textWithParentComment11,
+  comment12,
   post11,
-  textCommentPayload,
-  imageCommentPayload,
-  textImageCommentPayload,
-  textCommentMentionPayload,
-  textCommentParentIdPayload,
-  file11,
-  user11,
-  user12,
-  post12,
+  imageCommentResponse,
+  textCommentParentIdResponse,
+  textCommentResponse,
+  textImageCommentResponse,
+  textMentionCommentResponse,
+  imageCommentRequestPayload,
+  textCommentParentIdRequestPayload,
+  textCommentRequestPayload,
+  textCommentWithMentionRequestPayload,
+  textImageCommentRequestPayload,
 } from '~/utils/tests';
 import { ASCApiError } from '~/core/errors';
 import { createComment } from '../createComment';
 
-const createTextCommentResponse = {
-  data: {
-    ...textCommentPayload,
-    files: [],
-    commentChildren: [],
-  },
-};
-
-const createImageCommentResponse = {
-  data: {
-    ...imageCommentPayload,
-    files: [],
-    commentChildren: [],
-  },
-};
-
-const createTextImageCommentResponse = {
-  data: {
-    ...textImageCommentPayload,
-    files: [],
-    commentChildren: [],
-  },
-};
-
-const createTextMentionCommentResponse = {
-  data: {
-    ...textCommentMentionPayload,
-    files: [],
-    commentChildren: [],
-  },
-};
-
-const createTextCommentParentIdResponse = {
-  data: {
-    ...textCommentParentIdPayload,
-    files: [],
-    commentChildren: [],
-  },
-};
-
 const getPostResponse = {
   data: post11,
   cachedAt: 1673337034544,
 };
 
-const textCommentRequestPayload: Parameters<typeof createComment>[0] = {
-  referenceId: post11.postId,
-  referenceType: 'post',
-  data: {
-    text: 'test',
-  },
-};
-
-const textCommentParentIdRequestPayload: Parameters<typeof createComment>[0] = {
-  referenceId: post11.postId,
-  referenceType: 'post',
-  parentId: post12.postId,
-  data: {
-    text: 'test',
-  },
-};
-
-const imageCommentRequestPayload: Parameters<typeof createComment>[0] = {
-  referenceId: post11.postId,
-  referenceType: 'post',
-  attachments: [
-    {
-      type: 'image',
-      fileId: file11.fileId,
-    },
-  ],
-};
-
-const textImageCommentRequestPayload: Parameters<typeof createComment>[0] = {
-  referenceId: post11.postId,
-  referenceType: 'post',
-  data: {
-    text: 'test',
-  },
-  attachments: [
-    {
-      type: 'image',
-      fileId: file11.fileId,
-    },
-  ],
-};
-
-const textCommentWithMentionRequestPayload: Parameters<typeof createComment>[0] = {
-  referenceId: post11.postId,
-  referenceType: 'post',
-  data: {
-    text: 'test',
-  },
-  mentionees: [
-    {
-      type: 'user',
-      userIds: [user11._id, user12._id],
-    },
-  ],
-};
-
 jest.mock('~/post/api/getPost', () => ({
   getPost: jest.fn(() => Promise.resolve(getPostResponse)),
 }));
@@ -133,7 +38,7 @@ describe('createComment', () => {
 
   // integration_test_id: 2f83eabc-46db-43d8-89c6-1b5339d6a273
   it('creates a text comment and returns the new valid comment', async () => {
-    client.http.post = jest.fn().mockResolvedValueOnce(createTextCommentResponse);
+    client.http.post = jest.fn().mockResolvedValueOnce(textCommentResponse);
 
     const newComment = await createComment(textCommentRequestPayload);
 
@@ -146,7 +51,7 @@ describe('createComment', () => {
 
   // integration_test_id: 81e7d5bc-6881-4f9b-b8d4-deb5fe67200c
   it('creates a image comment and returns the new valid comment', async () => {
-    client.http.post = jest.fn().mockResolvedValueOnce(createImageCommentResponse);
+    client.http.post = jest.fn().mockResolvedValueOnce(imageCommentResponse);
 
     const newComment = await createComment(imageCommentRequestPayload);
 
@@ -159,7 +64,7 @@ describe('createComment', () => {
 
   // integration_test_id: 015838a8-3267-4253-920a-9ae83197cf22
   it('creates an image + text comment and returns the new valid comment', async () => {
-    client.http.post = jest.fn().mockResolvedValueOnce(createTextImageCommentResponse);
+    client.http.post = jest.fn().mockResolvedValueOnce(textImageCommentResponse);
 
     const newComment = await createComment(textImageCommentRequestPayload);
 
@@ -172,7 +77,7 @@ describe('createComment', () => {
 
   // integration_test_id: c2285355-f3b6-4e22-926b-11bcf0393161
   it('creates text comment with mention and returns the new valid comment', async () => {
-    client.http.post = jest.fn().mockResolvedValueOnce(createTextMentionCommentResponse);
+    client.http.post = jest.fn().mockResolvedValueOnce(textMentionCommentResponse);
 
     const newComment = await createComment(textCommentWithMentionRequestPayload);
 
@@ -185,7 +90,7 @@ describe('createComment', () => {
 
   // integration_test_id: cb1bfe11-c11a-4324-aeb5-03370da820ad
   it('creates text comment with parent_id and returns the new valid comment', async () => {
-    client.http.post = jest.fn().mockResolvedValueOnce(createTextCommentParentIdResponse);
+    client.http.post = jest.fn().mockResolvedValueOnce(textCommentParentIdResponse);
 
     const newComment = await createComment(textCommentParentIdRequestPayload);
 
@@ -193,7 +98,7 @@ describe('createComment', () => {
       '/api/v3/comments',
       textCommentParentIdRequestPayload,
     );
-    expect(newComment.data).toEqual(textWithParentComment11);
+    expect(newComment.data).toEqual(comment12);
   });
 
   // integration_test_id: 7f411488-abba-46d1-8707-a1d8adbd7242