@amityco/ts-sdk 7.4.1-4207cb63.0 → 7.4.1-7cfcde16.0

package/src/communityRepository/observers/getJoinRequests/JoinRequestsQueryStreamController.ts

@@ -0,0 +1,108 @@
+import { QueryStreamController } from '~/core/liveCollection/QueryStreamController';
+import { pullFromCache, pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { getResolver } from '~/core/model';
+import { getActiveClient } from '~/client/api/activeClient';
+import { EnumJoinRequestAction } from './enum';
+
+export class JoinRequestsQueryStreamController extends QueryStreamController<
+  Amity.CommunityJoinRequestPayload,
+  Amity.JoinRequestLiveCollection
+> {
+  private notifyChange: (params: Amity.LiveCollectionNotifyParams) => void;
+
+  private preparePayload: (
+    response: Amity.CommunityJoinRequestPayload,
+  ) => Amity.ProcessedJoinRequestPayload;
+
+  constructor(
+    query: Amity.JoinRequestLiveCollection,
+    cacheKey: string[],
+    notifyChange: (params: Amity.LiveCollectionNotifyParams) => void,
+    preparePayload: (
+      response: Amity.CommunityJoinRequestPayload,
+    ) => Amity.ProcessedJoinRequestPayload,
+  ) {
+    super(query, cacheKey);
+    this.notifyChange = notifyChange;
+    this.preparePayload = preparePayload;
+  }
+
+  async saveToMainDB(response: Amity.CommunityJoinRequestPayload) {
+    const processedPayload = await this.preparePayload(response);
+
+    const client = getActiveClient();
+    const cachedAt = client.cache && Date.now();
+
+    if (client.cache) {
+      ingestInCache(processedPayload, { cachedAt });
+    }
+  }
+
+  appendToQueryStream(
+    response: Amity.CommunityJoinRequestPayload & Partial<Amity.Pagination>,
+    direction: Amity.LiveCollectionPageDirection,
+    refresh = false,
+  ) {
+    if (refresh) {
+      pushToCache(this.cacheKey, {
+        data: response.joinRequests.map(joinRequest =>
+          getResolver('joinRequest')({ joinRequestId: joinRequest._id }),
+        ),
+      });
+    } else {
+      const collection = pullFromCache<Amity.JoinRequestLiveCollectionCache>(this.cacheKey)?.data;
+
+      const joinRequests = collection?.data ?? [];
+
+      pushToCache(this.cacheKey, {
+        ...collection,
+        data: [
+          ...new Set([
+            ...joinRequests,
+            ...response.joinRequests.map(joinRequest =>
+              getResolver('joinRequest')({ joinRequestId: joinRequest._id }),
+            ),
+          ]),
+        ],
+      });
+    }
+  }
+
+  reactor(action: EnumJoinRequestAction) {
+    return (joinRequest: Amity.InternalJoinRequest[]) => {
+      const collection = pullFromCache<Amity.JoinRequestLiveCollectionCache>(this.cacheKey)?.data;
+      if (!collection) return;
+
+      if (action === EnumJoinRequestAction.OnLocalJoinRequestUpdated) {
+        const isExist = collection.data.find(id => id === joinRequest[0].joinRequestId);
+        if (!isExist) return;
+      }
+
+      if (action === EnumJoinRequestAction.OnLocalJoinRequestCreated) {
+        collection.data = [
+          ...new Set([
+            ...joinRequest.map(joinRequest => joinRequest.joinRequestId),
+            ...collection.data,
+          ]),
+        ];
+      }
+
+      if (action === EnumJoinRequestAction.OnLocalJoinRequestDeleted) {
+        collection.data = collection.data.filter(id => id !== joinRequest[0].joinRequestId);
+      }
+
+      pushToCache(this.cacheKey, collection);
+      this.notifyChange({ origin: Amity.LiveDataOrigin.EVENT, loading: false });
+    };
+  }
+
+  subscribeRTE(
+    createSubscriber: {
+      fn: (reactor: Amity.Listener<Amity.InternalJoinRequest[]>) => Amity.Unsubscriber;
+      action: EnumJoinRequestAction;
+    }[],
+  ) {
+    return createSubscriber.map(subscriber => subscriber.fn(this.reactor(subscriber.action)));
+  }
+}

package/src/communityRepository/observers/getJoinRequests/enum.ts

@@ -0,0 +1,5 @@
+export enum EnumJoinRequestAction {
+  OnLocalJoinRequestCreated = 'OnLocalJoinRequestCreated',
+  OnLocalJoinRequestUpdated = 'OnLocalJoinRequestUpdated',
+  OnLocalJoinRequestDeleted = 'OnLocalJoinRequestDeleted',
+}

package/src/communityRepository/observers/getJoinRequests.ts

@@ -0,0 +1,44 @@
+import { dropFromCache } from '~/cache/api/dropFromCache';
+import { getActiveClient } from '~/client/api/activeClient';
+import { ENABLE_CACHE_MESSAGE } from '~/utils/constants';
+import { JoinRequestsLiveCollectionController } from './getJoinRequests/JoinRequestsLiveCollectionController';
+
+/**
+ * Get Join Requests
+ *
+ * @param params the query parameters
+ * @param callback the callback to be called when the join request are updated
+ * @returns joinRequests
+ *
+ * @category joinRequest Live Collection
+ *
+ */
+export const getJoinRequests = (
+  params: Amity.JoinRequestLiveCollection,
+  callback: Amity.LiveCollectionCallback<Amity.JoinRequest>,
+  config?: Amity.LiveCollectionConfig,
+) => {
+  const { log, cache } = getActiveClient();
+
+  if (!cache) {
+    console.log(ENABLE_CACHE_MESSAGE);
+  }
+
+  const timestamp = Date.now();
+  log(`getJoinRequests: (tmpid: ${timestamp}) > listen`);
+
+  const joinRequestLiveCollection = new JoinRequestsLiveCollectionController(params, callback);
+
+  const disposers = joinRequestLiveCollection.startSubscription();
+
+  const cacheKey = joinRequestLiveCollection.getCacheKey();
+
+  disposers.push(() => {
+    dropFromCache(cacheKey);
+  });
+
+  return () => {
+    log(`getJoinRequests (tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

package/src/communityRepository/observers/getRecommendedCommunities/RecommendedCommunitiesLiveCollectionController.ts

@@ -15,6 +15,7 @@ import {
   onCommunityUserChanged,
 } from '~/communityRepository/communityMembership';
 import { isNonNullable } from '~/utils';
+import { communityLinkedObject } from '~/utils/linkedObject/communityLinkedObject';
 
 export class RecommendedCommunityLiveCollectionController extends LiveCollectionController<
   'community',
@@ -94,7 +95,7 @@ export class RecommendedCommunityLiveCollectionController extends LiveCollection
       collection.data
         .map(id => pullFromCache<Amity.Community>(['community', 'get', id]))
         .filter(isNonNullable)
-        .map(({ data }) => data) ?? [];
+        .map(({ data }) => communityLinkedObject(data)) ?? [];
 
     if (!this.shouldNotify(data) && origin === 'event') return;
 

package/src/communityRepository/observers/getTrendingCommunities/TrendingCommunitiesLiveCollectionController.ts

@@ -15,6 +15,7 @@ import {
   onCommunityUserChanged,
 } from '~/communityRepository/communityMembership';
 import { isNonNullable } from '~/utils';
+import { communityLinkedObject } from '~/utils/linkedObject/communityLinkedObject';
 
 export class TrendingCommunityLiveCollectionController extends LiveCollectionController<
   'community',
@@ -94,7 +95,7 @@ export class TrendingCommunityLiveCollectionController extends LiveCollectionCon
       collection.data
         .map(id => pullFromCache<Amity.Community>(['community', 'get', id]))
         .filter(isNonNullable)
-        .map(({ data }) => data) ?? [];
+        .map(({ data }) => communityLinkedObject(data)) ?? [];
 
     if (!this.shouldNotify(data) && origin === 'event') return;
 

package/src/communityRepository/observers/index.ts

@@ -5,3 +5,4 @@ export * from './getTrendingCommunities';
 export * from './getRecommendedCommunities';
 
 export * from './semanticSearchCommunities';
+export * from './getJoinRequestList';

package/src/communityRepository/observers/searchCommunities/SearchCommunitiesPaginationController.ts

@@ -22,6 +22,7 @@ export class CommunitiesPaginationController extends PaginationController<
           isDeleted: inferIsDeleted(params.includeDeleted),
           keyword: params.displayName,
           filter: params.membership,
+          includeDiscoverablePrivateCommunity: params.includeDiscoverablePrivateCommunity ?? true,
           options,
         },
       },

package/src/communityRepository/utils/communityWithMembership.ts

@@ -1,5 +1,5 @@
 import { pullFromCache } from '~/cache/api';
-import { getActiveUser } from '~/client';
+import { getActiveUser } from '~/client/api/activeUser';
 
 /*
  * verifies membership status

package/src/communityRepository/utils/payload.ts

@@ -1,5 +1,6 @@
 import { CommunityPostSettingMaps, DefaultCommunityPostSetting } from '~/@types';
 import { updateMembershipStatus } from './communityWithMembership';
+import { convertRawUserToInternalUser } from '~/userRepository/utils/convertRawUserToInternalUser';
 
 const getMatchPostSetting = (value: {
   needApprovalOnPostCreation: Amity.RawCommunity['needApprovalOnPostCreation'];
@@ -29,10 +30,13 @@ export const prepareCommunityPayload = (
 ): Amity.ProcessedCommunityPayload => {
   const communitiesWithPostSetting = addPostSetting({ communities: rawPayload.communities });
 
+  // Convert users to internal format
+  const internalUsers = rawPayload.users.map(convertRawUserToInternalUser);
+
   // map users with community
   const mappedCommunityUsers: Array<Amity.Membership<'community'>> = rawPayload.communityUsers.map(
     communityUser => {
-      const user = rawPayload.users.find(user => user.userId === communityUser.userId)!;
+      const user = internalUsers.find(user => user.userId === communityUser.userId)!;
 
       return {
         ...communityUser,
@@ -48,11 +52,33 @@ export const prepareCommunityPayload = (
 
   return {
     ...rawPayload,
+    users: rawPayload.users.map(convertRawUserToInternalUser),
     communities: communityWithMembershipStatus,
     communityUsers: mappedCommunityUsers,
   };
 };
 
+export const prepareCommunityJoinRequestPayload = (
+  rawPayload: Amity.CommunityJoinRequestPayload,
+): Amity.ProcessedJoinRequestPayload => {
+  const mappedJoinRequests: Array<Amity.InternalJoinRequest> = rawPayload.joinRequests.map(
+    joinRequest => {
+      return {
+        ...joinRequest,
+        joinRequestId: joinRequest._id,
+      };
+    },
+  );
+
+  const users = rawPayload.users.map(convertRawUserToInternalUser);
+
+  return {
+    ...rawPayload,
+    joinRequests: mappedJoinRequests,
+    users,
+  };
+};
+
 export const prepareCommunityMembershipPayload = (
   rawPayload: Amity.CommunityMembershipPayload,
 ): Amity.ProcessedCommunityMembershipPayload => {

package/src/core/model/idResolvers.ts

@@ -66,6 +66,7 @@ const idResolvers: Resolvers = {
   notificationTraySeen: ({ userId }) => userId,
 
   invitation: ({ _id }) => _id,
+  joinRequest: ({ joinRequestId }) => joinRequestId,
 };
 
 /**

package/src/core/model/index.ts

@@ -56,6 +56,7 @@ export const PAYLOAD2MODEL: Record<string, Amity.Domain> = {
   notificationTrayItems: 'notificationTrayItem',
 
   invitations: 'invitation',
+  joinRequests: 'joinRequest',
 };
 
 /** hidden */

package/src/invitationRepository/internalApi/index.ts

@@ -1,4 +1,3 @@
 export * from './createInvitations';
 export * from './acceptInvitation';
 export * from './rejectInvitation';
-export * from './cancelInvitation';

package/src/postRepository/observers/getGlobalPinnedPosts/GlobalPinnedPostQueryStreamController.ts

@@ -4,6 +4,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 import { getResolver } from '~/core/model';
 import { getActiveClient } from '~/client';
 import { EnumPostActions } from '../enums';
+import { convertRawUserToInternalUser } from '~/userRepository/utils/convertRawUserToInternalUser';
 
 export class GlobalPinnedPostQueryStreamController extends QueryStreamController<
   Amity.PinnedPostPayload,
@@ -30,7 +31,12 @@ export class GlobalPinnedPostQueryStreamController extends QueryStreamController
     const cachedAt = client.cache && Date.now();
 
     if (client.cache) {
-      ingestInCache(response, { cachedAt });
+      const processedPayload = {
+        ...response,
+        users: response.users.map(convertRawUserToInternalUser),
+      };
+
+      ingestInCache(processedPayload, { cachedAt });
     }
   }
 

package/src/postRepository/observers/getPinnedPosts/PinnedPostQueryStreamController.ts

@@ -3,6 +3,7 @@ import { pullFromCache, pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { getResolver } from '~/core/model';
 import { getActiveClient } from '~/client';
+import { convertRawUserToInternalUser } from '~/userRepository/utils/convertRawUserToInternalUser';
 
 export class PinnedPostQueryStreamController extends QueryStreamController<
   Amity.PinnedPostPayload,
@@ -29,7 +30,12 @@ export class PinnedPostQueryStreamController extends QueryStreamController<
     const cachedAt = client.cache && Date.now();
 
     if (client.cache) {
-      ingestInCache(response, { cachedAt });
+      const processedPayload = {
+        ...response,
+        users: response.users ? response.users.map(convertRawUserToInternalUser) : [],
+      };
+
+      ingestInCache(processedPayload, { cachedAt });
     }
   }
 

package/src/subChannelRepository/utils/prepareSubChannelPayload.ts

@@ -4,6 +4,7 @@ import { convertFromRaw as convertMessageFromRaw } from '~/messageRepository/uti
 import { convertFromRaw as convertSubChannelFromRaw } from './convertSubChannelFromRaw';
 
 import { updateSubChannelMessagePreviewCache } from '../../messagePreview/utils/updateSubChannelMessagePreviewCache';
+import { convertRawUserToInternalUser } from '~/userRepository/utils/convertRawUserToInternalUser';
 
 export const MARKER_INCLUDED_SUB_CHANNEL_TYPE = ['broadcast', 'conversation', 'community'];
 
@@ -44,10 +45,13 @@ export const prepareSubChannelPayload = async (
 
   const messages = rawPayload.messages.map(m => convertMessageFromRaw(m));
 
+  const user = rawPayload.users.map(convertRawUserToInternalUser);
+
   return {
     ...rawPayload,
     messageFeeds,
     messages,
+    users: user,
   };
 };
 

package/src/utils/linkedObject/communityLinkedObject.ts

@@ -1,4 +1,7 @@
 import { InvitationTypeEnum } from '~/@types';
+import { getMyJoinRequest } from '~/communityRepository/internalAPI/getMyJoinRequest';
+import { joinRequest } from '~/communityRepository/internalAPI/joinCommunity';
+import { getJoinRequests } from '~/communityRepository/observers/getJoinRequests';
 import { createInvitations } from '~/invitationRepository/internalApi';
 import { getInvitation } from '~/invitationRepository/internalApi/getInvitation';
 import { getInvitations } from '~/invitationRepository/observers/getInvitations';
@@ -32,5 +35,22 @@ export const communityLinkedObject = (community: Amity.InternalCommunity): Amity
       const { data } = await getInvitation('community', community.communityId);
       return data;
     },
+    join: joinRequest(community.communityId),
+    getJoinRequests: (
+      params: Omit<Amity.QueryJoinRequest, 'communityId'>,
+      callback: Amity.LiveCollectionCallback<Amity.JoinRequest>,
+    ): Amity.Unsubscriber => {
+      return getJoinRequests(
+        {
+          ...params,
+          communityId: community.communityId,
+        },
+        callback,
+      );
+    },
+    getMyJoinRequest: async () => {
+      const { data } = await getMyJoinRequest(community.communityId);
+      return data;
+    },
   };
 };

package/src/utils/linkedObject/index.ts

@@ -13,6 +13,7 @@ import { pinnedPostLinkedObject } from './pinnedPostLinkedObject';
 import { notificationTrayLinkedObject } from './notificationTrayLinkedObject';
 import { communityLinkedObject } from './communityLinkedObject';
 import { invitationLinkedObject } from './invitationLinkedObject';
+import { joinRequestLinkedObject } from './joinRequestLinkedObject';
 
 export const LinkedObject = {
   ad: adLinkedObject,
@@ -30,4 +31,5 @@ export const LinkedObject = {
   notificationTray: notificationTrayLinkedObject,
   community: communityLinkedObject,
   invitation: invitationLinkedObject,
+  joinRequest: joinRequestLinkedObject,
 };

package/src/utils/linkedObject/invitationLinkedObject.ts

@@ -1,10 +1,6 @@
 import { pullFromCache } from '~/cache/api';
 import { userLinkedObject } from './userLinkedObject';
-import {
-  acceptInvitation,
-  cancelInvitation,
-  rejectInvitation,
-} from '~/invitationRepository/internalApi';
+import { acceptInvitation, rejectInvitation } from '~/invitationRepository/internalApi';
 
 export const invitationLinkedObject = (invitation: Amity.InternalInvitation): Amity.Invitation => {
   return {
@@ -37,8 +33,5 @@ export const invitationLinkedObject = (invitation: Amity.InternalInvitation): Am
     reject: async () => {
       await rejectInvitation(invitation._id);
     },
-    cancel: async () => {
-      await cancelInvitation(invitation._id);
-    },
   };
 };

package/src/utils/linkedObject/joinRequestLinkedObject.ts

@@ -0,0 +1,25 @@
+import { pullFromCache } from '~/cache/api';
+import { userLinkedObject } from './userLinkedObject';
+import { approveJoinRequest } from '~/communityRepository/joinRequest/internalAPI/approveJoinRequest';
+import { cancelJoinRequest } from '~/communityRepository/joinRequest/internalAPI/cancelJoinRequest';
+import { rejectJoinRequest } from '~/communityRepository/joinRequest/internalAPI/rejectJoinRequest';
+
+export const joinRequestLinkedObject = (
+  joinRequest: Amity.InternalJoinRequest,
+): Amity.JoinRequest => {
+  return {
+    ...joinRequest,
+    get user(): Amity.User | undefined {
+      const user = pullFromCache<Amity.InternalUser>([
+        'user',
+        'get',
+        joinRequest.requestorPublicId,
+      ])?.data;
+      if (!user) return undefined;
+      return userLinkedObject(user);
+    },
+    cancel: () => cancelJoinRequest(joinRequest),
+    approve: () => approveJoinRequest(joinRequest),
+    reject: () => rejectJoinRequest(joinRequest),
+  };
+};

package/dist/invitationRepository/internalApi/cancelInvitation.d.ts

@@ -1,16 +0,0 @@
-/**
- * ```js
- * import { cancelInvitation } from '@amityco/ts-sdk'
- * const isCanceled = await cancelInvitation(invitationId)
- * ```
- *
- * Cancels a {@link Amity.Invitation} object
- *
- * @param invitationId the {@link Amity.Invitation} to cancel
- * @returns A success boolean if the {@link Amity.Invitation} was canceled
- *
- * @category Invitation API
- * @async
- */
-export declare const cancelInvitation: (invitationId: Amity.Invitation['_id']) => Promise<boolean>;
-//# sourceMappingURL=cancelInvitation.d.ts.map

package/dist/invitationRepository/internalApi/cancelInvitation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"cancelInvitation.d.ts","sourceRoot":"","sources":["../../../src/invitationRepository/internalApi/cancelInvitation.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gBAAgB,iBAAwB,MAAM,UAAU,CAAC,KAAK,CAAC,KAAG,QAAQ,OAAO,CAqB7F,CAAC"}

package/src/invitationRepository/internalApi/cancelInvitation.ts

@@ -1,44 +0,0 @@
-import { fireEvent } from '~/core/events';
-import { dropFromCache, pullFromCache } from '~/cache/api';
-import { getActiveClient } from '~/client/api/activeClient';
-
-/* begin_public_function
-  id: invitation.cancel
-*/
-/**
- * ```js
- * import { cancelInvitation } from '@amityco/ts-sdk'
- * const isCanceled = await cancelInvitation(invitationId)
- * ```
- *
- * Cancels a {@link Amity.Invitation} object
- *
- * @param invitationId the {@link Amity.Invitation} to cancel
- * @returns A success boolean if the {@link Amity.Invitation} was canceled
- *
- * @category Invitation API
- * @async
- */
-export const cancelInvitation = async (invitationId: Amity.Invitation['_id']): Promise<boolean> => {
-  const client = getActiveClient();
-  client.log('invitation/cancelInvitation', invitationId);
-
-  const { data } = await client.http.delete<{ success: boolean }>(
-    `/api/v1/invitations/${invitationId}`,
-  );
-
-  const invitation = pullFromCache<Amity.InternalInvitation>([
-    'invitation',
-    'get',
-    invitationId,
-  ])?.data;
-
-  if (invitation) {
-    dropFromCache(['invitation', 'get', invitationId]);
-
-    fireEvent('local.invitation.deleted', [invitation]);
-  }
-
-  return data.success;
-};
-/* end_public_function */