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

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

@@ -15,7 +15,7 @@ import { prepareMembershipPayload } from '~/group/utils';
  * ```
  *
  * @param communityId of {@link Amity.Community} from which the users should be banned
- * @param userIds of the {@link Amity.User}'s to be banned
+ * @param userIds of the {@link Amity.InternalUser}'s to be banned
  * @returns the updated {@link Amity.Membership}'s object
  *
  * @category Community API
@@ -23,7 +23,7 @@ import { prepareMembershipPayload } from '~/group/utils';
  * */
 export const banMembers = async (
   communityId: Amity.Community['communityId'],
-  userIds: Amity.User['userId'][],
+  userIds: Amity.InternalUser['userId'][],
 ): Promise<Amity.Cached<Amity.Membership<'community'>[]>> => {
   const client = getActiveClient();
   client.log('community/banMembers', { userIds, communityId });

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

@@ -12,12 +12,12 @@ import { prepareMembershipPayload } from '~/group/utils';
  * const updated = await CommunityRepository.moderation.removeRoles(communityId, ['foo', 'bar'])
  * ```
  *
- * Removes a list of {@link Amity.Role} from a list of {@link Amity.User} on a {@link Amity.Community}
+ * Removes a list of {@link Amity.Role} from a list of {@link Amity.InternalUser} 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 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.Community}
+ * @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.Community}
  *
  * @category Community API
  * @async
@@ -25,7 +25,7 @@ import { prepareMembershipPayload } from '~/group/utils';
 export const removeRoles = async (
   communityId: Amity.Community['communityId'],
   roleIds: Amity.Role['roleId'][],
-  userIds: Amity.User['userId'][],
+  userIds: Amity.InternalUser['userId'][],
 ): Promise<boolean> => {
   const client = getActiveClient();
   client.log('community/moderation/removeRoles', communityId, roleIds, userIds);

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

@@ -15,7 +15,7 @@ import { prepareMembershipPayload } from '~/group/utils';
  * ```
  *
  * @param communityId of {@link Amity.Community} from which 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 Community API
@@ -23,7 +23,7 @@ import { prepareMembershipPayload } from '~/group/utils';
  * */
 export const unbanMembers = async (
   communityId: Amity.Community['communityId'],
-  userIds: Amity.User['userId'][],
+  userIds: Amity.InternalUser['userId'][],
 ): Promise<Amity.Cached<Amity.Membership<'community'>[]>> => {
   const client = getActiveClient();
   client.log('community/unbanMembers', { userIds, communityId });

package/src/core/device.ts

@@ -68,7 +68,7 @@ export const getDeviceId = async () => {
   return deviceId;
 };
 
-export const getMQTTClientId = async (userId: Amity.User['userId']) => {
+export const getMQTTClientId = async (userId: Amity.InternalUser['userId']) => {
   const savedDeviceId = await getDeviceId();
   return `mqttjs_${savedDeviceId}_${userId}_${tabIndex}`;
 };

package/src/core/query/filtering.ts

@@ -225,7 +225,9 @@ export const filterByPostDataTypes = <T extends Amity.Post>(
  *
  * @hidden
  */
-export const filterBySearchTerm = <T extends { userId: Amity.User['userId']; user?: Amity.User }>(
+export const filterBySearchTerm = <
+  T extends { userId: Amity.InternalUser['userId']; user?: Amity.InternalUser },
+>(
   collection: T[],
   searchTerm: string,
 ): T[] => {

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

@@ -1,8 +1,8 @@
 import { filterByPropEquality, filterBySearchTerm, filterByStringComparePartially } from '..';
 
 const searchTermCollection = [
-  { userId: 'userId', user: { displayName: 'displayName' } as Amity.User },
-  { userId: 'notSearched', user: { displayName: 'do-not-return' } as Amity.User },
+  { userId: 'userId', user: { displayName: 'displayName' } as Amity.InternalUser },
+  { userId: 'notSearched', user: { displayName: 'do-not-return' } as Amity.InternalUser },
 ];
 
 describe('filtering:', () => {

package/src/external/api/createUserToken.ts

@@ -20,8 +20,8 @@ export const createUserToken = async (
   apiKey: string,
   apiRegion: typeof API_REGIONS[keyof typeof API_REGIONS],
   params: {
-    userId: Amity.User['userId'];
-    displayName?: Amity.User['displayName'];
+    userId: Amity.InternalUser['userId'];
+    displayName?: Amity.InternalUser['displayName'];
     authToken?: string;
   },
 ) => {

package/src/group/utils/withUser.ts

@@ -23,7 +23,7 @@ export const withUser = <
   member: M,
   userIdProp: I = <I>'userId',
   userProp: U = <U>'user',
-): Record<U, Amity.User | undefined> & M => {
+): Record<U, Amity.InternalUser | undefined> & M => {
   // If the user prop already exists, do not overwrite.
   if (member[userProp]) return member;
 
@@ -33,7 +33,11 @@ export const withUser = <
 
       if (!client.cache) return undefined;
 
-      const userCache = pullFromCache<Amity.User>(['user', 'get', member[userIdProp]])?.data;
+      const userCache = pullFromCache<Amity.InternalUser>([
+        'user',
+        'get',
+        member[userIdProp],
+      ])?.data;
 
       if (!userCache) {
         return undefined;
@@ -63,7 +67,7 @@ export const withUsers = <
   members: M,
   userIdProp: I = <I>'userId',
   userProp: U = <U>'user',
-): (Record<U, Amity.User | undefined> & M[number])[] => {
+): (Record<U, Amity.InternalUser | undefined> & M[number])[] => {
   return members?.map(member => withUser(member, userIdProp, userProp)) ?? members;
 };
 
@@ -87,7 +91,7 @@ export const prepareMembershipPayload = <
   memberProp: M,
   userIdProp: I = <I>'userId',
   userProp: U = <U>'user',
-): Omit<P, M> & Record<M, (Record<U, Amity.User | undefined> & P[M][number])[]> => {
+): Omit<P, M> & Record<M, (Record<U, Amity.InternalUser | undefined> & P[M][number])[]> => {
   const { [memberProp]: memberPayload, ...rest } = payload;
   const members = withUsers(memberPayload, userIdProp, userProp);
 

package/src/liveStreamPlayer/api/getPlayer.ts

@@ -51,7 +51,7 @@ export const getPlayer = async (parameters: { streamId: string }): Promise<HTMLV
 
     hls.loadSource(url);
   } else {
-    const recording = recordings[0];
+    const recording = recordings.find(rec => !!rec.mp4);
 
     if (!recording || !recording.mp4) {
       throw new Error('No playable recording available');

package/src/messagePreview/utils/getChannelMessagePreviewWithUser.ts

@@ -9,7 +9,7 @@ export const getChannelMessagePreviewWithUser = (channel: Amity.Channel) => {
   const messagePreviewWithUser = messagePreview
     ? {
         ...messagePreview,
-        user: pullFromCache<Amity.User>(['user', 'get', messagePreview?.creatorId])?.data,
+        user: pullFromCache<Amity.InternalUser>(['user', 'get', messagePreview?.creatorId])?.data,
       }
     : null;
 

package/src/messagePreview/utils/getSubChannelMessagePreviewWithUser.ts

@@ -9,7 +9,7 @@ export const getSubChannelMessagePreviewWithUser = (subChannel: Amity.SubChannel
   const messagePreviewWithUser = messagePreview
     ? {
         ...messagePreview,
-        user: pullFromCache<Amity.User>(['user', 'get', messagePreview?.creatorId])?.data,
+        user: pullFromCache<Amity.InternalUser>(['user', 'get', messagePreview?.creatorId])?.data,
       }
     : null;
 

package/src/messageRepository/api/getDeliveredUsers.ts

@@ -13,17 +13,17 @@ import { convertSubChannelMarkerResponse } from '~/utils/marker';
  * })
  * ```
  *
- * Queries a paginable list of delivered {@link Amity.User} by messageId
+ * Queries a paginable list of delivered {@link Amity.InternalUser} by messageId
  *
  * @param query The query parameters
- * @returns A page of {@link Amity.User} objects
+ * @returns A page of {@link Amity.InternalUser} objects
  *
  * @category Message API
  * @async
  */
 export const getDeliveredUsers = async (
   query: Amity.QueryDeliveredUsers,
-): Promise<Amity.Cached<Amity.Paged<Amity.User>>> => {
+): Promise<Amity.Cached<Amity.Paged<Amity.InternalUser>>> => {
   const client = getActiveClient();
   client.log('user/getDeliveredUsers', query);
 
@@ -62,7 +62,7 @@ export const getDeliveredUsers = async (
     pushToCache(cacheKey, { users: deliveredUsers, paging });
   }
 
-  let users: Amity.User[] = [];
+  let users: Amity.InternalUser[] = [];
 
   if (deliveredUsers.length > 0) {
     ({ data: users } = await getUserByIds(deliveredUsers));
@@ -82,16 +82,16 @@ export const getDeliveredUsers = async (
  * })
  * ```
  *
- * Queries a paginable list of delivered {@link Amity.User} objects from cache
+ * Queries a paginable list of delivered {@link Amity.InternalUser} objects from cache
  *
  * @param query The query parameters
- * @returns A page of {@link Amity.User} objects
+ * @returns A page of {@link Amity.InternalUser} objects
  *
  * @category Message API
  */
 getDeliveredUsers.locally = (
   query: Amity.QueryDeliveredUsers,
-): Amity.Cached<Amity.Paged<Amity.User>> | undefined => {
+): Amity.Cached<Amity.Paged<Amity.InternalUser>> | undefined => {
   const client = getActiveClient();
   client.log('user/getDeliveredUsers.locally', query);
 
@@ -110,12 +110,14 @@ getDeliveredUsers.locally = (
       cacheKey,
     ) ?? {};
 
-  const users = data?.users.map(userId => pullFromCache<Amity.User>(['user', 'get', userId])?.data);
+  const users = data?.users.map(
+    userId => pullFromCache<Amity.InternalUser>(['user', 'get', userId])?.data,
+  );
 
   if (!users || users.some(user => !user)) return;
 
   const prevPage = toPage(data?.paging.previous);
   const nextPage = toPage(data?.paging.next);
 
-  return { data: users as Amity.User[], cachedAt, prevPage, nextPage };
+  return { data: users as Amity.InternalUser[], cachedAt, prevPage, nextPage };
 };

package/src/messageRepository/api/getReadUsers.ts

@@ -14,17 +14,17 @@ import { convertSubChannelMarkerResponse } from '~/utils/marker';
  * })
  * ```
  *
- * Queries a paginable list of read {@link Amity.User} by messageId
+ * Queries a paginable list of read {@link Amity.InternalUser} by messageId
  *
  * @param query The query parameters
- * @returns A page of {@link Amity.User} objects
+ * @returns A page of {@link Amity.InternalUser} objects
  *
  * @category Message API
  * @async
  */
 export const getReadUsers = async (
   query: Amity.QueryReadUsers,
-): Promise<Amity.Cached<Amity.Paged<Amity.User>>> => {
+): Promise<Amity.Cached<Amity.Paged<Amity.InternalUser>>> => {
   const client = getActiveClient();
   client.log('user/getReadUsers', query);
 
@@ -60,7 +60,7 @@ export const getReadUsers = async (
     pushToCache(cacheKey, { users: readUsers, paging });
   }
 
-  let users: Amity.User[] = [];
+  let users: Amity.InternalUser[] = [];
 
   if (readUsers.length > 0) {
     ({ data: users } = await getUserByIds(readUsers));
@@ -81,16 +81,16 @@ export const getReadUsers = async (
  * })
  * ```
  *
- * Queries a paginable list of read {@link Amity.User} objects from cache
+ * Queries a paginable list of read {@link Amity.InternalUser} objects from cache
  *
  * @param query The query parameters
- * @returns A page of {@link Amity.User} objects
+ * @returns A page of {@link Amity.InternalUser} objects
  *
  * @category Message API
  */
 getReadUsers.locally = (
   query: Amity.QueryReadUsers,
-): Amity.Cached<Amity.Paged<Amity.User>> | undefined => {
+): Amity.Cached<Amity.Paged<Amity.InternalUser>> | undefined => {
   const client = getActiveClient();
   client.log('user/getReadUsers.locally', query);
 
@@ -109,12 +109,14 @@ getReadUsers.locally = (
       cacheKey,
     ) ?? {};
 
-  const users = data?.users.map(userId => pullFromCache<Amity.User>(['user', 'get', userId])?.data);
+  const users = data?.users.map(
+    userId => pullFromCache<Amity.InternalUser>(['user', 'get', userId])?.data,
+  );
 
   if (!users || users.some(user => !user)) return;
 
   const prevPage = toPage(data?.paging.previous);
   const nextPage = toPage(data?.paging.next);
 
-  return { data: users as Amity.User[], cachedAt, prevPage, nextPage };
+  return { data: users as Amity.InternalUser[], cachedAt, prevPage, nextPage };
 };