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

package/src/community/api/removeCommunityMembers.ts

@@ -1,7 +1,7 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { ingestInCache } from '~/cache/api/ingestInCache'
-import { fireEvent } from '~/core/events'
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
 
 /**
  * ```js
@@ -20,24 +20,23 @@ import { fireEvent } from '~/core/events'
  */
 export const removeCommunityMembers = async (
   communityId: Amity.Community['communityId'],
-  userIds: Amity.User['userId'][]
+  userIds: Amity.User['userId'][],
 ): Promise<boolean> => {
-  const client = getActiveClient()
-  client.log('community/removeCommunityMembers', communityId, userIds)
+  const client = getActiveClient();
+  client.log('community/removeCommunityMembers', communityId, userIds);
 
   const { data } = await client.http.delete<Amity.CommunityMembershipPayload>(
     `/api/v3/communities/${communityId}/users`,
-    { data: { communityId, userIds } }
-  )
+    { data: { communityId, userIds } },
+  );
 
-  if (client.cache) ingestInCache(data)
+  if (client.cache) ingestInCache(data);
 
-  fireEvent('community.userRemoved', data)
+  fireEvent('community.userRemoved', data);
 
-  const { communityUsers } = data
+  const { communityUsers } = data;
   return !!communityUsers.find(
     communityUser =>
-      communityUser.communityId === communityId &&
-      communityUser.communityMembership !== 'member'
-  )
-}
+      communityUser.communityId === communityId && communityUser.communityMembership !== 'member',
+  );
+};

package/src/community/api/removeCommunityMembersRoles.ts

@@ -0,0 +1,42 @@
+import { getActiveClient } from '~/client/api';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { removeCommunityMembersRoles } from '@amityco/ts-sdk'
+ * const updated = await removeCommunityMembersRoles(communityId,  ['foo'], ['bar'])
+ * ```
+ *
+ * Removes a list of {@link Amity.Role} from a list of {@link Amity.User} on a {@link Amity.Community}
+ *
+ * @param communityId The ID of the {@link Amity.Community} to perform
+ * @param roleIds Array of IDs of the {@link Amity.Role} to apply
+ * @param userId 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.Community}
+ *
+ * @category Community API
+ * @async
+ */
+export const removeCommunityMembersRoles = async (
+  communityId: Amity.Community['communityId'],
+  roleIds: Amity.Role['roleId'][],
+  userIds: Amity.User['userId'][],
+): Promise<boolean> => {
+  const client = getActiveClient();
+  client.log('community/removeCommunityMembersRoles', communityId, roleIds, userIds);
+
+  const { data } = await client.http.delete<Amity.CommunityMembershipPayload>(
+    `/api/v4/communities/${communityId}/users/roles`,
+    { data: { communityId, roles: roleIds, userIds } },
+  );
+
+  if (client.cache) ingestInCache(data);
+
+  const { communityUsers } = data;
+  return !!communityUsers.find(
+    communityUser =>
+      communityUser.communityId === communityId &&
+      !roleIds.some(role => communityUser.roles.includes(role)),
+  );
+};

package/src/community/api/updateCommunity.ts

@@ -1,7 +1,7 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { ingestInCache } from '~/cache/api/ingestInCache'
-import { fireEvent } from '~/core/events'
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
 
 /**
  * ```js
@@ -20,24 +20,28 @@ import { fireEvent } from '~/core/events'
  */
 export const updateCommunity = async (
   communityId: Amity.Community['communityId'],
-  patch: Patch<Amity.Community, 'displayName' | 'description' | 'avatarFileId' | 'tags' | 'metadata'>,
+  patch: Patch<
+    Amity.Community,
+    'displayName' | 'description' | 'avatarFileId' | 'tags' | 'metadata'
+  >,
 ): Promise<Amity.Cached<Amity.Community>> => {
-  const client = getActiveClient()
-  client.log('community/updateCommunity', communityId, patch)
+  const client = getActiveClient();
+  client.log('community/updateCommunity', communityId, patch);
 
   const { data } = await client.http.put<Amity.CommunityPayload>(
-    `/api/v3/communities/${communityId}`, patch,
-  )
+    `/api/v3/communities/${communityId}`,
+    patch,
+  );
 
-  const cachedAt = client.cache && Date.now()
-  if (client.cache) ingestInCache(data, { cachedAt })
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
-  fireEvent('community.updated', data)
+  fireEvent('community.updated', data);
 
-  const { communities } = data
+  const { communities } = data;
 
   return {
     data: communities.find(community => community.communityId === communityId)!,
     cachedAt,
-  }
-}
+  };
+};

package/src/community/events/index.ts

@@ -1,11 +1,11 @@
-export * from './onCommunityCreated'
-export * from './onCommunityUpdated'
-export * from './onCommunityDeleted'
+export * from './onCommunityCreated';
+export * from './onCommunityUpdated';
+export * from './onCommunityDeleted';
 
-export * from './onCommunityJoined'
-export * from './onCommunityLeft'
+export * from './onCommunityJoined';
+export * from './onCommunityLeft';
 
-export * from './onCommunityUserAdded'
-export * from './onCommunityUserRemoved'
-export * from './onCommunityUserBanned'
-export * from './onCommunityUserUnbanned'
+export * from './onCommunityUserAdded';
+export * from './onCommunityUserRemoved';
+export * from './onCommunityUserBanned';
+export * from './onCommunityUserUnbanned';

package/src/community/events/onCommunityCreated.ts

@@ -1,4 +1,4 @@
-import { createCommunityEventSubscriber } from './utils'
+import { createCommunityEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -16,4 +16,4 @@ import { createCommunityEventSubscriber } from './utils'
  * @category Community Events
  */
 export const onCommunityCreated = (callback: Amity.Listener<Amity.Community>) =>
-  createCommunityEventSubscriber('community.created', callback)
+  createCommunityEventSubscriber('community.created', callback);

package/src/community/events/onCommunityDeleted.ts

@@ -1,4 +1,4 @@
-import { createCommunityEventSubscriber } from './utils'
+import { createCommunityEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -16,4 +16,4 @@ import { createCommunityEventSubscriber } from './utils'
  * @category Community Events
  */
 export const onCommunityDeleted = (callback: Amity.Listener<Amity.Community>) =>
-  createCommunityEventSubscriber('community.deleted', callback)
+  createCommunityEventSubscriber('community.deleted', callback);

package/src/community/events/onCommunityJoined.ts

@@ -1,4 +1,4 @@
-import { createCommunityMemberEventSubscriber } from './utils'
+import { createCommunityMemberEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -15,5 +15,6 @@ import { createCommunityMemberEventSubscriber } from './utils'
  *
  * @category Community Events
  */
-export const onCommunityJoined = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
-  createCommunityMemberEventSubscriber('community.joined', callback)
+export const onCommunityJoined = (
+  callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void,
+) => createCommunityMemberEventSubscriber('community.joined', callback);

package/src/community/events/onCommunityLeft.ts

@@ -1,4 +1,4 @@
-import { createCommunityMemberEventSubscriber } from './utils'
+import { createCommunityMemberEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -15,5 +15,6 @@ import { createCommunityMemberEventSubscriber } from './utils'
  *
  * @category Community Events
  */
-export const onCommunityLeft = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
-  createCommunityMemberEventSubscriber('community.left', callback)
+export const onCommunityLeft = (
+  callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void,
+) => createCommunityMemberEventSubscriber('community.left', callback);

package/src/community/events/onCommunityUpdated.ts

@@ -1,4 +1,4 @@
-import { createCommunityEventSubscriber } from './utils'
+import { createCommunityEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -16,4 +16,4 @@ import { createCommunityEventSubscriber } from './utils'
  * @category Community Events
  */
 export const onCommunityUpdated = (callback: Amity.Listener<Amity.Community>) =>
-  createCommunityEventSubscriber('community.updated', callback)
+  createCommunityEventSubscriber('community.updated', callback);

package/src/community/events/onCommunityUserAdded.ts

@@ -1,4 +1,4 @@
-import { createCommunityMemberEventSubscriber } from './utils'
+import { createCommunityMemberEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -15,5 +15,6 @@ import { createCommunityMemberEventSubscriber } from './utils'
  *
  * @category Community Events
  */
-export const onCommunityUserAdded = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
-  createCommunityMemberEventSubscriber('community.userAdded', callback)
+export const onCommunityUserAdded = (
+  callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void,
+) => createCommunityMemberEventSubscriber('community.userAdded', callback);

package/src/community/events/onCommunityUserBanned.ts

@@ -1,4 +1,4 @@
-import { createCommunityMemberEventSubscriber } from './utils'
+import { createCommunityMemberEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -15,5 +15,6 @@ import { createCommunityMemberEventSubscriber } from './utils'
  *
  * @category Community Events
  */
-export const onCommunityUserBanned = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
-  createCommunityMemberEventSubscriber('community.userBanned', callback)
+export const onCommunityUserBanned = (
+  callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void,
+) => createCommunityMemberEventSubscriber('community.userBanned', callback);

package/src/community/events/onCommunityUserRemoved.ts

@@ -1,4 +1,4 @@
-import { createCommunityMemberEventSubscriber } from './utils'
+import { createCommunityMemberEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -15,5 +15,6 @@ import { createCommunityMemberEventSubscriber } from './utils'
  *
  * @category Community Events
  */
-export const onCommunityUserRemoved = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
-  createCommunityMemberEventSubscriber('community.userRemoved', callback)
+export const onCommunityUserRemoved = (
+  callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void,
+) => createCommunityMemberEventSubscriber('community.userRemoved', callback);

package/src/community/events/onCommunityUserUnbanned.ts

@@ -1,4 +1,4 @@
-import { createCommunityMemberEventSubscriber } from './utils'
+import { createCommunityMemberEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -15,5 +15,6 @@ import { createCommunityMemberEventSubscriber } from './utils'
  *
  * @category Community Events
  */
-export const onCommunityUserUnbanned = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
-  createCommunityMemberEventSubscriber('community.userUnbanned', callback)
+export const onCommunityUserUnbanned = (
+  callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void,
+) => createCommunityMemberEventSubscriber('community.userUnbanned', callback);

package/src/community/events/utils.ts

@@ -1,50 +1,53 @@
-import { getActiveClient } from '~/client/api'
-import { ingestInCache } from '~/cache/api/ingestInCache'
-import { createEventSubscriber } from '~/core/events'
-import { pullFromCache } from '~/cache/api'
-import { getResolver } from '~/core/model'
+import { getActiveClient } from '~/client/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { createEventSubscriber } from '~/core/events';
+import { pullFromCache } from '~/cache/api';
+import { getResolver } from '~/core/model';
 
 export const createCommunityEventSubscriber = (
   event: keyof Amity.MqttCommunityMessageEvents,
-  callback: Amity.Listener<Amity.Community>
+  callback: Amity.Listener<Amity.Community>,
 ) => {
-  const client = getActiveClient()
+  const client = getActiveClient();
 
   const filter = (payload: Amity.CommunityPayload) => {
     if (!client.cache) {
       // TODO: here we are missing specific properties here!
-      callback(payload.communities[0])
+      callback(payload.communities[0]);
     } else {
-      ingestInCache(payload)
+      ingestInCache(payload);
 
-      const community = pullFromCache<Amity.Community>(['community', 'get', payload.communities[0].communityId])!
+      const community = pullFromCache<Amity.Community>([
+        'community',
+        'get',
+        payload.communities[0].communityId,
+      ])!;
 
-      callback(community.data)
+      callback(community.data);
     }
-  }
+  };
 
-  return createEventSubscriber(
-    client,
-    event,
-    event,
-    filter
-  )
-}
+  return createEventSubscriber(client, event, event, filter);
+};
 
-function hasPermission(member: Amity.Membership<'community'>, payload: Amity.CommunityMembershipPayload, permission: string) {
+function hasPermission(
+  member: Amity.Membership<'community'>,
+  payload: Amity.CommunityMembershipPayload,
+  permission: string,
+) {
   if (member.permissions.some(x => x === permission)) {
     return true;
   }
 
-  return payload.users!
-    .find(user => user.userId === member.userId)!
-    .permissions.some(x => x === permission)
+  return payload
+    .users!.find(user => user.userId === member.userId)!
+    .permissions.some(x => x === permission);
 }
 
 function getEventRelatedMember(
   event: keyof Amity.MqttCommunityUserMessageEvents,
-  payload: Amity.CommunityMembershipPayload
-)  {
+  payload: Amity.CommunityMembershipPayload,
+) {
   if (event === 'community.joined' || event === 'community.left') {
     return payload.communityUsers![0];
   }
@@ -52,49 +55,48 @@ function getEventRelatedMember(
   // NOTE: backend returns the one who took the action and the one on whom
   // the action was taken. We need the 2nd one
   if (event === 'community.userRemoved') {
-    return payload.communityUsers!.filter(x => x.communityMembership === 'none')[0]
+    return payload.communityUsers!.filter(x => x.communityMembership === 'none')[0];
   }
 
   if (event === 'community.userBanned') {
-    return payload.communityUsers!.filter(x => x.communityMembership === 'banned')[0]
+    return payload.communityUsers!.filter(x => x.communityMembership === 'banned')[0];
   }
 
   // NOTE: it might be that in certain edge cases permission check won't be enough
   if (event === 'community.userUnbanned') {
-    return payload.communityUsers!.filter(x => !hasPermission(x, payload, 'BAN_COMMUNITY_USER'))[0]
+    return payload.communityUsers!.filter(x => !hasPermission(x, payload, 'BAN_COMMUNITY_USER'))[0];
   }
 
-  return payload.communityUsers!.filter(x => !hasPermission(x, payload, 'ADD_COMMUNITY_USER'))[0]
+  return payload.communityUsers!.filter(x => !hasPermission(x, payload, 'ADD_COMMUNITY_USER'))[0];
 }
 
 export const createCommunityMemberEventSubscriber = (
   event: keyof Amity.MqttCommunityUserMessageEvents,
   callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void,
 ) => {
-  const client = getActiveClient()
+  const client = getActiveClient();
 
   const filter = (payload: Amity.CommunityMembershipPayload) => {
     if (!client.cache) {
       // TODO: here we are missing specific properties here!
-      callback(payload.communities[0], getEventRelatedMember(event, payload))
+      callback(payload.communities[0], getEventRelatedMember(event, payload));
     } else {
-      ingestInCache(payload)
+      ingestInCache(payload);
 
-      const community = pullFromCache<Amity.Community>(['community', 'get', payload.communities[0].communityId])!
+      const community = pullFromCache<Amity.Community>([
+        'community',
+        'get',
+        payload.communities[0].communityId,
+      ])!;
       const member = pullFromCache<Amity.Membership<'community'>>([
         'communityUsers',
         'get',
-        getResolver('communityUsers')(getEventRelatedMember(event, payload))
-      ])!
+        getResolver('communityUsers')(getEventRelatedMember(event, payload)),
+      ])!;
 
-      callback(community.data, member.data)
+      callback(community.data, member.data);
     }
-  }
+  };
 
-  return createEventSubscriber(
-    client,
-    event,
-    event,
-    filter
-  )
-}
+  return createEventSubscriber(client, event, event, filter);
+};

package/src/community/observers/index.ts

@@ -1 +1 @@
-export * from './observeCommunity'
+export * from './observeCommunity';

package/src/community/observers/observeCommunity.ts

@@ -1,8 +1,8 @@
-import { createQuery, runQuery } from '~/core/query/query'
+import { createQuery, runQuery } from '~/core/query/query';
 
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { getCommunity } from '../api'
+import { getCommunity } from '../api';
 
 import {
   onCommunityUpdated,
@@ -12,8 +12,8 @@ import {
   onCommunityUserAdded,
   onCommunityUserRemoved,
   onCommunityUserBanned,
-  onCommunityUserUnbanned
-} from '../events'
+  onCommunityUserUnbanned,
+} from '../events';
 
 /**
  * ```js
@@ -31,56 +31,74 @@ import {
  *
  * @category Community Observer
  */
-export const observeCommunity = <Events extends ['onFetch', 'onUpdate', 'onDelete', 'onJoin', 'onLeft', 'onUserAdded', 'onUserRemoved', 'onUserBanned', 'onUserUnbanned']>(
+export const observeCommunity = <
+  Events extends [
+    'onFetch',
+    'onUpdate',
+    'onDelete',
+    'onJoin',
+    'onLeft',
+    'onUserAdded',
+    'onUserRemoved',
+    'onUserBanned',
+    'onUserUnbanned',
+  ],
+>(
   communityId: string,
-  callback: Amity.ObjectListener<Amity.Snapshot<Amity.Community | undefined>, Events>
+  callback: Amity.ObjectListener<Amity.Snapshot<Amity.Community | undefined>, Events>,
 ): Amity.Unsubscriber => {
-  const { log } = getActiveClient()
+  const { log } = getActiveClient();
 
-  const timestamp = Date.now()
-  log(`observeCommunity(tmpid: ${timestamp}) > listen`)
+  const timestamp = Date.now();
+  log(`observeCommunity(tmpid: ${timestamp}) > listen`);
 
   // wrapper function to make sure
-  const router = (
-    result: Amity.Snapshot<Amity.Community | undefined>,
-    action: Events[number]
-  ) => {
-    if (callback instanceof Function) return callback(result)
+  const router = (result: Amity.Snapshot<Amity.Community | undefined>, action: Events[number]) => {
+    if (callback instanceof Function) return callback(result);
 
-    if (action !== 'onFetch') callback.onEvent?.(action, result)
+    if (action !== 'onFetch') callback.onEvent?.(action, result);
 
-    callback[action]?.(result)
-  }
+    callback[action]?.(result);
+  };
 
-  const realtimeRouter = (
-    result: Amity.Snapshot<Amity.Community>,
-    action: Events[number]
-  ) => {
-    if (result.data?.communityId !== communityId) return
+  const realtimeRouter = (result: Amity.Snapshot<Amity.Community>, action: Events[number]) => {
+    if (result.data?.communityId !== communityId) return;
 
-    router(result, action)
-  }
+    router(result, action);
+  };
 
-  const disposers: Amity.Unsubscriber[] = []
+  const disposers: Amity.Unsubscriber[] = [];
 
   disposers.push(
-    onCommunityUpdated(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onUpdate')),
-    onCommunityDeleted(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onDelete')),
+    onCommunityUpdated(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUpdate'),
+    ),
+    onCommunityDeleted(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onDelete'),
+    ),
     onCommunityJoined(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onJoin')),
     onCommunityLeft(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onLeft')),
-    onCommunityUserAdded(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserAdded')),
-    onCommunityUserRemoved(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserRemoved')),
-    onCommunityUserBanned(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserBanned')),
-    onCommunityUserUnbanned(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserUnbanned')),
-  )
+    onCommunityUserAdded(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserAdded'),
+    ),
+    onCommunityUserRemoved(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserRemoved'),
+    ),
+    onCommunityUserBanned(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserBanned'),
+    ),
+    onCommunityUserUnbanned(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserUnbanned'),
+    ),
+  );
 
   runQuery(
     createQuery(getCommunity, communityId),
-    result => (result.data || result.error) && router(result, 'onFetch')
-  )
+    result => (result.data || result.error) && router(result, 'onFetch'),
+  );
 
   return () => {
-    log(`observeCommunity(tmpid: ${timestamp}) > dispose`)
-    disposers.forEach(fn => fn())
-  }
-}
+    log(`observeCommunity(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

package/src/core/debug.ts

@@ -1,6 +1,6 @@
-import debug from 'debug'
+import debug from 'debug';
 
-import { isProduction } from '~/utils/env'
+import { isProduction } from '~/utils/env';
 
 /**
  * Creates a pre-configured logger instance
@@ -12,17 +12,15 @@ import { isProduction } from '~/utils/env'
  * @hidden
  */
 export const createLogger = (session?: string) => {
-  const active = (
-      `${session?.trim()}`.length > 0
-    && !isProduction
-  )
+  const active = `${session?.trim()}`.length > 0 && !isProduction;
 
-  const logger = debug(session!)
+  const logger = debug(session!);
 
   const print = (topic: string, ...args: any[]) => {
-    active && logger(topic, args)
-  }
+    active && logger(topic, args);
+  };
 
-  print.__instance__ = logger
-  return print
-}
+  // eslint-disable-next-line no-underscore-dangle
+  print.__instance__ = logger;
+  return print;
+};