@amityco/ts-sdk 6.12.2-d74459e.0 → 6.12.2-e855934.0

package/src/channelRepsitory/channelModeration/api/removeRole.ts

@@ -14,12 +14,12 @@ import { fireEvent } from '~/core/events';
  * const updated = await removeRole(channelId, 'foo', ['bar'])
  * ```
  *
- * Removes an {@link Amity.Role} from a list of {@link Amity.User} on a {@link Amity.Channel}
+ * Removes an {@link Amity.Role} from a list of {@link Amity.InternalUser} on a {@link Amity.Channel}
  *
  * @param channelId The ID of the {@link Amity.Channel} to perform
  * @param roleId The ID of the {@link Amity.Role} to apply
- * @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}
+ * @param userIds Array of IDs of the {@link Amity.InternalUser} to perform
+ * @returns A success boolean if the {@link Amity.Role} were removed from list of {@link Amity.InternalUser} in the {@link Amity.Channel}
  *
  * @category Channel API
  * @async
@@ -27,7 +27,7 @@ import { fireEvent } from '~/core/events';
 export const removeRole = async (
   channelId: Amity.Channel['channelId'],
   roleId: Amity.Role['roleId'],
-  userIds: Amity.User['userId'][],
+  userIds: Amity.InternalUser['userId'][],
 ): Promise<boolean> => {
   const client = getActiveClient();
   client.log('channel/removeRole', channelId, roleId, userIds);

package/src/channelRepsitory/channelModeration/api/unbanMembers.ts

@@ -15,7 +15,7 @@ import { prepareChannelPayload } from '../../utils';
  * ```
  *
  * @param channelId of {@link Amity.Channel} where the users should be unbanned
- * @param userIds of the {@link Amity.User}'s to be unbanned
+ * @param userIds of the {@link Amity.InternalUser}'s to be unbanned
  * @returns the updated {@link Amity.Membership}'s object
  *
  * @category Channel API
@@ -23,7 +23,7 @@ import { prepareChannelPayload } from '../../utils';
  * */
 export const unbanMembers = async (
   channelId: Amity.Channel['channelId'],
-  userIds: Amity.User['userId'][],
+  userIds: Amity.InternalUser['userId'][],
 ): Promise<Amity.Cached<Amity.Membership<'channel'>[]>> => {
   const client = getActiveClient();
   client.log('channel/unbanMembers', { userIds, channelId });

package/src/channelRepsitory/events/onChannelMemberAdded.ts

@@ -12,7 +12,7 @@ import { prepareChannelPayload } from '../utils';
  * })
  * ```
  *
- * Fired when any {@link Amity.User} has been added to any {@link Amity.Channel}
+ * Fired when any {@link Amity.InternalUser} has been added to any {@link Amity.Channel}
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening

package/src/channelRepsitory/events/onChannelMemberBanned.ts

@@ -13,7 +13,7 @@ import { prepareChannelPayload } from '../utils';
  * })
  * ```
  *
- * Fired when any {@link Amity.User} has been banned from any {@link Amity.Channel}
+ * Fired when any {@link Amity.InternalUser} has been banned from any {@link Amity.Channel}
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening

package/src/channelRepsitory/events/onChannelMemberRemoved.ts

@@ -13,7 +13,7 @@ import { prepareChannelPayload } from '../utils';
  * })
  * ```
  *
- * Fired when any {@link Amity.User} has been removed from any {@link Amity.Channel}
+ * Fired when any {@link Amity.InternalUser} has been removed from any {@link Amity.Channel}
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening

package/src/channelRepsitory/events/onChannelMemberUnbanned.ts

@@ -13,7 +13,7 @@ import { prepareChannelPayload } from '../utils';
  * })
  * ```
  *
- * Fired when any {@link Amity.User} has been unbanned from any {@link Amity.Channel}
+ * Fired when any {@link Amity.InternalUser} has been unbanned from any {@link Amity.Channel}
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening

package/src/channelRepsitory/observers/tests/getChannel.test.ts

@@ -0,0 +1,73 @@
+import {
+  channelQueryResponse,
+  client,
+  connectClient,
+  convertRawChannelPayload,
+  disconnectClient,
+  pause,
+} from '~/utils/tests';
+import { getChannel } from '../getChannel';
+
+describe('getChannel (observer)', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  test('When user gets valid channel, it should return valid channel', async () => {
+    const callback = jest.fn();
+    const { channelId } = channelQueryResponse.data.channels[0];
+
+    client.http.get = jest.fn().mockResolvedValue(channelQueryResponse);
+
+    getChannel(channelId, callback);
+
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+    expect(callback).toHaveBeenNthCalledWith(
+      1,
+      expect.objectContaining({
+        data: undefined,
+        loading: true,
+        error: undefined,
+      }),
+    );
+
+    expect(callback).toHaveBeenNthCalledWith(
+      2,
+      expect.objectContaining({
+        data: convertRawChannelPayload(channelQueryResponse.data).channels[0],
+        loading: false,
+        error: undefined,
+      }),
+    );
+  });
+
+  test('When user queries invalid channel, it should return error', async () => {
+    const callback = jest.fn();
+
+    client.http.get = jest.fn().mockRejectedValue(new Error('error'));
+
+    getChannel('xxxxxx', callback);
+
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+    expect(callback).toHaveBeenNthCalledWith(
+      1,
+      expect.objectContaining({
+        data: undefined,
+        loading: true,
+        error: undefined,
+      }),
+    );
+
+    expect(callback).toHaveBeenNthCalledWith(
+      2,
+      expect.objectContaining({
+        data: undefined,
+        loading: false,
+        error: new Error('error'),
+      }),
+    );
+  });
+});