@amityco/ts-sdk 6.2.1-ca3e600.0 → 6.2.1-d2d529b.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "6.2.1-ca3e600.0",
+  "version": "6.2.1-d2d529b.0",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",

package/src/communityRepository/communityModeration/api/banMembers.ts

@@ -0,0 +1,50 @@
+import { getActiveClient } from '~/client/api/activeClient';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+import { prepareMembershipPayload } from '~/group/utils';
+
+/* begin_public_function
+  id: community.moderation.ban_members
+*/
+/**
+ * ```js
+ * import { CommunityRepository } from '@amityco/ts-sdk'
+ *
+ * await CommunityRepository.Moderation.banMembers('communityId', ['userId1', 'userId2'])
+ * ```
+ *
+ * @param communityId of {@link Amity.Community} from which the users should be banned
+ * @param userIds of the {@link Amity.User}'s to be banned
+ * @returns the updated {@link Amity.Membership}'s object
+ *
+ * @category Community API
+ * @async
+ * */
+export const banMembers = async (
+  communityId: Amity.Community['communityId'],
+  userIds: Amity.User['userId'][],
+): Promise<Amity.Cached<Amity.Membership<'community'>[]>> => {
+  const client = getActiveClient();
+  client.log('community/banMembers', { userIds, communityId });
+
+  const { data: payload } = await client.http.put<Amity.CommunityMembershipPayload>(
+    `/api/v3/communities/${communityId}/users/ban`,
+    {
+      userIds,
+    },
+  );
+
+  const data = prepareMembershipPayload(payload, 'communityUsers');
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  const { communityUsers } = data;
+
+  return {
+    data: communityUsers.filter(u => userIds.includes(u.userId)),
+    cachedAt,
+  };
+};
+/* end_public_function */

package/src/communityRepository/communityModeration/api/index.ts

@@ -1,4 +1,8 @@
 export * from './addMembers';
 export * from './removeMembers';
+
 export * from './addRoles';
 export * from './removeRoles';
+
+export * from './banMembers';
+export * from './unbanMembers';

package/src/communityRepository/communityModeration/api/test/banMembers.test.ts

@@ -0,0 +1,70 @@
+import { disableCache, enableCache, pullFromCache } from '~/cache/api';
+import { prepareMembershipPayload } from '~/group/utils';
+import { getResolver } from '~/core/model';
+import { ASCError } from '~/core/errors';
+
+import { client, community11, communityUser11, user11 } from '~/utils/tests';
+
+import { banMembers } from '../banMembers';
+
+const userCommunity = community11;
+const user = {
+  ...communityUser11,
+  communityMebership: 'banned',
+};
+const resolvedCommunityValue = {
+  data: {
+    communities: [userCommunity],
+    communityUsers: [user],
+    files: [],
+    users: [user11],
+    categories: [],
+    feeds: [],
+  },
+};
+
+describe('community/ moderation/ banMembers', () => {
+  beforeEach(enableCache);
+  afterEach(disableCache);
+
+  const { communityId } = communityUser11;
+  const { userId } = communityUser11;
+
+  const preparedPayload = prepareMembershipPayload(resolvedCommunityValue.data, 'communityUsers');
+  const { communityUsers: expectedUser } = preparedPayload;
+
+  // integration_test_id: d344e314-4a49-4947-b4d5-8fa2d55f8ecd
+  test('it should return banned members', async () => {
+    client.http.put = jest.fn().mockResolvedValue(resolvedCommunityValue);
+
+    const { data: recieved } = await banMembers(communityId, [userId]);
+
+    expect(recieved).toStrictEqual(expectedUser);
+  });
+
+  test('it should update cache', async () => {
+    client.http.put = jest.fn().mockResolvedValue(resolvedCommunityValue);
+
+    await banMembers(communityId, [userId]);
+    const recieved = pullFromCache([
+      'communityUsers',
+      'get',
+      getResolver('communityUsers')({ communityId, userId }),
+    ])?.data;
+
+    expect([recieved]).toStrictEqual(expectedUser);
+  });
+
+  // integration_test_id: 59b58ec8-8380-49b2-aa39-6da361692c2e
+  test('it should throw valid error', async () => {
+    const err = new ASCError(
+      'Permission Denied',
+      Amity.ServerError.UNAUTHORIZED,
+      Amity.ErrorLevel.ERROR,
+    );
+
+    client.http.put = jest.fn().mockRejectedValue(err);
+
+    await expect(banMembers(communityId, [userId])).rejects.toThrow(err);
+  });
+});

package/src/communityRepository/communityModeration/api/test/unbanMembers.test.ts

@@ -0,0 +1,70 @@
+import { disableCache, enableCache, pullFromCache } from '~/cache/api';
+import { prepareMembershipPayload } from '~/group/utils';
+import { getResolver } from '~/core/model';
+import { ASCError } from '~/core/errors';
+
+import { client, community11, communityUser11, user11 } from '~/utils/tests';
+
+import { unbanMembers } from '../unbanMembers';
+
+const userCommunity = community11;
+const user = {
+  ...communityUser11,
+  communityMebership: 'none',
+};
+const resolvedCommunityValue = {
+  data: {
+    communities: [userCommunity],
+    communityUsers: [user],
+    files: [],
+    users: [user11],
+    categories: [],
+    feeds: [],
+  },
+};
+
+describe('community/ moderation/ unbanMembers', () => {
+  beforeEach(enableCache);
+  afterEach(disableCache);
+
+  const { communityId } = communityUser11;
+  const { userId } = communityUser11;
+
+  const preparedPayload = prepareMembershipPayload(resolvedCommunityValue.data, 'communityUsers');
+  const { communityUsers: expectedUser } = preparedPayload;
+
+  // integration_test_id: bee19fd4-63f4-403f-9771-6424d94cf144
+  test('it should return banned members', async () => {
+    client.http.put = jest.fn().mockResolvedValue(resolvedCommunityValue);
+
+    const { data: recieved } = await unbanMembers(communityId, [userId]);
+
+    expect(recieved).toStrictEqual(expectedUser);
+  });
+
+  test('it should update cache', async () => {
+    client.http.put = jest.fn().mockResolvedValue(resolvedCommunityValue);
+
+    await unbanMembers(communityId, [userId]);
+    const recieved = pullFromCache([
+      'communityUsers',
+      'get',
+      getResolver('communityUsers')({ communityId, userId }),
+    ])?.data;
+
+    expect([recieved]).toStrictEqual(expectedUser);
+  });
+
+  // integration_test_id: 22ce5ced-641a-48e2-9a89-d3f51119d8ac
+  test('it should throw valid error', async () => {
+    const err = new ASCError(
+      'Permission Denied',
+      Amity.ServerError.UNAUTHORIZED,
+      Amity.ErrorLevel.ERROR,
+    );
+
+    client.http.put = jest.fn().mockRejectedValue(err);
+
+    await expect(unbanMembers(communityId, [userId])).rejects.toThrow(err);
+  });
+});

package/src/communityRepository/communityModeration/api/unbanMembers.ts

@@ -0,0 +1,50 @@
+import { getActiveClient } from '~/client/api/activeClient';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+import { prepareMembershipPayload } from '~/group/utils';
+
+/* begin_public_function
+  id: community.moderation.unban_members
+*/
+/**
+ * ```js
+ * import { CommunityRepository } from '@amityco/ts-sdk'
+ *
+ * await CommunityRepository.Moderation.unbanMembers('communityId', ['userId1', 'userId2'])
+ * ```
+ *
+ * @param communityId of {@link Amity.Community} from which the users should be unbanned
+ * @param userIds of the {@link Amity.User}'s to be unbanned
+ * @returns the updated {@link Amity.Membership}'s object
+ *
+ * @category Community API
+ * @async
+ * */
+export const unbanMembers = async (
+  communityId: Amity.Community['communityId'],
+  userIds: Amity.User['userId'][],
+): Promise<Amity.Cached<Amity.Membership<'community'>[]>> => {
+  const client = getActiveClient();
+  client.log('community/unbanMembers', { userIds, communityId });
+
+  const { data: payload } = await client.http.put<Amity.CommunityMembershipPayload>(
+    `/api/v3/communities/${communityId}/users/unban`,
+    {
+      userIds,
+    },
+  );
+
+  const data = prepareMembershipPayload(payload, 'communityUsers');
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  const { communityUsers } = data;
+
+  return {
+    data: communityUsers.filter(u => userIds.includes(u.userId)),
+    cachedAt,
+  };
+};
+/* end_public_function */

package/src/core/query/filtering.ts

@@ -192,6 +192,10 @@ export const filterBySearchTerm = <T extends { userId: Amity.User['userId']; use
   collection: T[],
   searchTerm: string,
 ): T[] => {
+  /*
+   * Search term should match regardless of the case.
+   * Hence, the flag "i", is passed to the created regex
+   */
   const containsMatcher = new RegExp(searchTerm, 'i');
 
   return collection.filter(m => {

package/src/core/query/tests/filtering.test.ts

@@ -13,6 +13,12 @@ describe('filtering:', () => {
       ]);
     });
 
+    test('it should ignore search term case', () => {
+      expect(filterBySearchTerm(searchTermCollection, 'USER')).toStrictEqual([
+        searchTermCollection[0],
+      ]);
+    });
+
     test('it should return items that match displayName', () => {
       expect(filterBySearchTerm(searchTermCollection, 'displ')).toStrictEqual([
         searchTermCollection[0],