@amityco/ts-sdk 7.4.1-4207cb63.0 → 7.4.1-82bb9867.0

package/dist/postRepository/observers/getGlobalPinnedPosts/GlobalPinnedPostQueryStreamController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GlobalPinnedPostQueryStreamController.d.ts","sourceRoot":"","sources":["../../../../src/postRepository/observers/getGlobalPinnedPosts/GlobalPinnedPostQueryStreamController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6CAA6C,CAAC;AAKpF,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C,qBAAa,qCAAsC,SAAQ,qBAAqB,CAC9E,KAAK,CAAC,iBAAiB,EACvB,KAAK,CAAC,8BAA8B,CACrC;IACC,OAAO,CAAC,YAAY,CAAqD;IAEzE,OAAO,CAAC,cAAc,CAAoE;gBAGxF,KAAK,EAAE,KAAK,CAAC,8BAA8B,EAC3C,QAAQ,EAAE,MAAM,EAAE,EAClB,YAAY,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,0BAA0B,KAAK,IAAI,EAChE,cAAc,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB,KAAK,KAAK,CAAC,oBAAoB;IAQ7E,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB;IASpD,mBAAmB,CACjB,QAAQ,EAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAC7D,SAAS,EAAE,KAAK,CAAC,2BAA2B,EAC5C,OAAO,UAAQ;IAuBjB,OAAO,CAAC,MAAM,EAAE,eAAe,UACf,MAAM,YAAY;IAgBlC,YAAY,CACV,gBAAgB,EAAE;QAChB,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,KAAK,IAAI,KAAK,KAAK,CAAC,YAAY,CAAC;QACxE,MAAM,EAAE,eAAe,CAAC;KACzB,EAAE;CAIN"}
+{"version":3,"file":"GlobalPinnedPostQueryStreamController.d.ts","sourceRoot":"","sources":["../../../../src/postRepository/observers/getGlobalPinnedPosts/GlobalPinnedPostQueryStreamController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6CAA6C,CAAC;AAKpF,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAG3C,qBAAa,qCAAsC,SAAQ,qBAAqB,CAC9E,KAAK,CAAC,iBAAiB,EACvB,KAAK,CAAC,8BAA8B,CACrC;IACC,OAAO,CAAC,YAAY,CAAqD;IAEzE,OAAO,CAAC,cAAc,CAAoE;gBAGxF,KAAK,EAAE,KAAK,CAAC,8BAA8B,EAC3C,QAAQ,EAAE,MAAM,EAAE,EAClB,YAAY,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,0BAA0B,KAAK,IAAI,EAChE,cAAc,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB,KAAK,KAAK,CAAC,oBAAoB;IAQ7E,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB;IAcpD,mBAAmB,CACjB,QAAQ,EAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAC7D,SAAS,EAAE,KAAK,CAAC,2BAA2B,EAC5C,OAAO,UAAQ;IAuBjB,OAAO,CAAC,MAAM,EAAE,eAAe,UACf,MAAM,YAAY;IAgBlC,YAAY,CACV,gBAAgB,EAAE;QAChB,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,KAAK,IAAI,KAAK,KAAK,CAAC,YAAY,CAAC;QACxE,MAAM,EAAE,eAAe,CAAC;KACzB,EAAE;CAIN"}

package/dist/postRepository/observers/getPinnedPosts/PinnedPostQueryStreamController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PinnedPostQueryStreamController.d.ts","sourceRoot":"","sources":["../../../../src/postRepository/observers/getPinnedPosts/PinnedPostQueryStreamController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6CAA6C,CAAC;AAMpF,qBAAa,+BAAgC,SAAQ,qBAAqB,CACxE,KAAK,CAAC,iBAAiB,EACvB,KAAK,CAAC,wBAAwB,CAC/B;IACC,OAAO,CAAC,YAAY,CAAqD;IAEzE,OAAO,CAAC,cAAc,CAAoE;gBAGxF,KAAK,EAAE,KAAK,CAAC,wBAAwB,EACrC,QAAQ,EAAE,MAAM,EAAE,EAClB,YAAY,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,0BAA0B,KAAK,IAAI,EAChE,cAAc,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB,KAAK,KAAK,CAAC,oBAAoB;IAQ7E,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB;IASpD,mBAAmB,CACjB,QAAQ,EAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAC7D,SAAS,EAAE,KAAK,CAAC,2BAA2B,EAC5C,OAAO,UAAQ;CAsBlB"}
+{"version":3,"file":"PinnedPostQueryStreamController.d.ts","sourceRoot":"","sources":["../../../../src/postRepository/observers/getPinnedPosts/PinnedPostQueryStreamController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6CAA6C,CAAC;AAOpF,qBAAa,+BAAgC,SAAQ,qBAAqB,CACxE,KAAK,CAAC,iBAAiB,EACvB,KAAK,CAAC,wBAAwB,CAC/B;IACC,OAAO,CAAC,YAAY,CAAqD;IAEzE,OAAO,CAAC,cAAc,CAAoE;gBAGxF,KAAK,EAAE,KAAK,CAAC,wBAAwB,EACrC,QAAQ,EAAE,MAAM,EAAE,EAClB,YAAY,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,0BAA0B,KAAK,IAAI,EAChE,cAAc,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB,KAAK,KAAK,CAAC,oBAAoB;IAQ7E,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB;IAcpD,mBAAmB,CACjB,QAAQ,EAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAC7D,SAAS,EAAE,KAAK,CAAC,2BAA2B,EAC5C,OAAO,UAAQ;CAsBlB"}

package/dist/subChannelRepository/utils/prepareSubChannelPayload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prepareSubChannelPayload.d.ts","sourceRoot":"","sources":["../../../src/subChannelRepository/utils/prepareSubChannelPayload.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,gCAAgC,UAA6C,CAAC;AAE3F;;GAEG;AACH,eAAO,MAAM,oBAAoB,oBAAqB,KAAK,MAAM,aAAa,EAAE,aAAa,CAAC,YACtC,CAAC;AAEzD,eAAO,MAAM,wBAAwB,eAAgB,MAAM,iBAAiB,SAI3E,CAAC;AAEF,eAAO,MAAM,wBAAwB,eACvB,MAAM,iBAAiB,KAClC,QAAQ,MAAM,0BAA0B,CA4B1C,CAAC;AAEF,aAAK,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,0BAA0B,CAAC,GAAG;IACpF,yBAAyB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,0BAA0B,CAAC,CAAC;CAChF,CAAC;AAEF,wBAAgB,kBAAkB,CAAC,EACjC,wBAAwB,EACxB,GAAG,IAAI,EACR,EAAE,KAAK,CAAC,gBAAgB,GAAG,mBAAmB,CAQ9C"}
+{"version":3,"file":"prepareSubChannelPayload.d.ts","sourceRoot":"","sources":["../../../src/subChannelRepository/utils/prepareSubChannelPayload.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,gCAAgC,UAA6C,CAAC;AAE3F;;GAEG;AACH,eAAO,MAAM,oBAAoB,oBAAqB,KAAK,MAAM,aAAa,EAAE,aAAa,CAAC,YACtC,CAAC;AAEzD,eAAO,MAAM,wBAAwB,eAAgB,MAAM,iBAAiB,SAI3E,CAAC;AAEF,eAAO,MAAM,wBAAwB,eACvB,MAAM,iBAAiB,KAClC,QAAQ,MAAM,0BAA0B,CA+B1C,CAAC;AAEF,aAAK,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,0BAA0B,CAAC,GAAG;IACpF,yBAAyB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,0BAA0B,CAAC,CAAC;CAChF,CAAC;AAEF,wBAAgB,kBAAkB,CAAC,EACjC,wBAAwB,EACxB,GAAG,IAAI,EACR,EAAE,KAAK,CAAC,gBAAgB,GAAG,mBAAmB,CAQ9C"}

package/dist/utils/linkedObject/communityLinkedObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"communityLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/communityLinkedObject.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,qBAAqB,cAAe,MAAM,iBAAiB,KAAG,MAAM,SA8BhF,CAAC"}
+{"version":3,"file":"communityLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/communityLinkedObject.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,qBAAqB,cAAe,MAAM,iBAAiB,KAAG,MAAM,SAiDhF,CAAC"}

package/dist/utils/linkedObject/index.d.ts

@@ -14,5 +14,6 @@ export declare const LinkedObject: {
     notificationTray: (noti: Amity.RawNotificationTrayItem) => Amity.NotificationTrayItem;
     community: (community: Amity.InternalCommunity) => Amity.Community;
     invitation: (invitation: Amity.InternalInvitation) => Amity.Invitation;
+    joinRequest: (joinRequest: Amity.InternalJoinRequest) => Amity.JoinRequest;
 };
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/linkedObject/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/index.ts"],"names":[],"mappings":"AAgBA,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;CAgBxB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/index.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;CAiBxB,CAAC"}

package/dist/utils/linkedObject/joinRequestLinkedObject.d.ts

@@ -0,0 +1,2 @@
+export declare const joinRequestLinkedObject: (joinRequest: Amity.InternalJoinRequest) => Amity.JoinRequest;
+//# sourceMappingURL=joinRequestLinkedObject.d.ts.map

package/dist/utils/linkedObject/joinRequestLinkedObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"joinRequestLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/joinRequestLinkedObject.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,uBAAuB,gBACrB,MAAM,mBAAmB,KACrC,MAAM,WAsBR,CAAC"}

package/package.json

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

package/src/@types/core/events.ts

@@ -188,7 +188,7 @@ declare global {
     };
 
     type LocalCommunityEvents = {
-      'local.community.joined': Amity.CommunityMembershipPayload;
+      'local.community.joined': Amity.CommunityMembershipPayload; // v3 join community
       'local.community.left': Amity.CommunityMembershipPayload;
       'local.community.roleAdded': Amity.ProcessedCommunityPayload;
       'local.community.roleRemoved': Amity.ProcessedCommunityPayload;
@@ -265,6 +265,12 @@ declare global {
       'local.invitation.updated': Amity.InternalInvitation[];
       'local.invitation.deleted': Amity.InternalInvitation[];
 
+      'local.community.join': Amity.InternalJoinRequest[]; // v4 join community with status
+
+      'local.joinRequest.created': Amity.InternalJoinRequest[];
+      'local.joinRequest.updated': Amity.InternalJoinRequest[];
+      'local.joinRequest.deleted': Amity.InternalJoinRequest[];
+
       sessionStateChange: Amity.SessionStates;
       // used by accessTokenExpiryWatcher
       tokenExpired: Amity.SessionStates.TOKEN_EXPIRED;

package/src/@types/core/model.ts

@@ -62,6 +62,8 @@ declare global {
       notificationTraySeen: Amity.InternalNotificationTraySeen;
 
       invitation: Amity.InternalInvitation;
+
+      joinRequest: Amity.InternalJoinRequest;
     };
 
     type Model = ValueOf<Models>;
@@ -128,6 +130,7 @@ declare global {
       notificationTraySeen: Pick<Amity.InternalNotificationTraySeen, 'userId'>;
 
       invitation: Pick<Amity.InternalInvitation, '_id'>;
+      joinRequest: Pick<Amity.InternalJoinRequest, 'joinRequestId'>;
     };
   }
 }

package/src/@types/core/payload.ts

@@ -29,6 +29,7 @@ declare global {
       notificationTrayItem: Amity.NotificationTrayPayload;
       invitation: Amity.InvitationPayload;
       myInvitation: Amity.MyInvitationsPayload;
+      joinRequest: Amity.CommunityJoinRequestPayload;
     };
 
     type UserPayload = {
@@ -227,7 +228,7 @@ declare global {
     type SubChannelPayload<T extends Amity.MessageContentType = any> = {
       messageFeeds: Amity.RawSubChannel[];
       messages: Amity.RawMessage<T>[];
-      users: Amity.InternalUser[];
+      users: Amity.RawUser[];
       files: Amity.File[];
     };
 
@@ -299,6 +300,12 @@ declare global {
       files: Amity.File[];
     };
 
+    type CommunityJoinRequestPayload = {
+      joinRequests: Amity.RawJoinRequest[];
+      users: Amity.RawUser[];
+      files: Amity.File[];
+    };
+
     type RecommendedCommunityPayload = Amity.CommunityPayload;
     type TrendingCommunityPayload = Amity.CommunityPayload;
 
@@ -310,6 +317,16 @@ declare global {
     type ProcessedCommunityPayload = Omit<CommunityPayload, 'communities' | 'communityUsers'> & {
       communities: Amity.InternalCommunity[];
       communityUsers: Amity.Membership<'community'>[];
+      users: Amity.InternalUser[];
+    };
+
+    type ProcessedJoinRequestPayload = Omit<
+      CommunityJoinRequestPayload,
+      'communities' | 'communityUsers' | 'joinRequests' | 'users'
+    > & {
+      joinRequests: Amity.InternalJoinRequest[];
+      files: Amity.File[];
+      users: Amity.InternalUser[];
     };
 
     type CategoryPayload = {
@@ -567,5 +584,9 @@ declare global {
       invitations: Amity.InternalInvitation[];
       users: Amity.InternalUser[];
     };
+
+    type JoinRequestPayload = {
+      joinRequests: Amity.RawJoinRequest[];
+    };
   }
 }

package/src/@types/domains/community.ts

@@ -96,8 +96,8 @@ declare global {
 
       allowCommentInStory?: boolean;
 
-      isDiscoverable: boolean;
-      requiresJoinApproval: boolean;
+      isDiscoverable?: boolean;
+      requiresJoinApproval?: boolean;
     } & Amity.Taggable &
       Amity.Metadata &
       Amity.Timestamps &
@@ -124,6 +124,16 @@ declare global {
       limit?: number;
     };
 
+    type QueryJoinCommunity = {
+      communityId: string;
+      status: Amity.JoinRequestStatus;
+      sortBy?: Amity.CommunitySortBy | Amity.CommunitySortByEnum;
+      options?: {
+        limit?: number;
+        token?: string;
+      };
+    };
+
     type SearchQueryCommunities = {
       displayName?: string;
       membership?: 'all' | 'member' | 'notMember';
@@ -136,11 +146,38 @@ declare global {
       includeDiscoverablePrivateCommunity?: boolean;
     };
 
+    type QueryJoinRequest = {
+      communityId: string;
+      status: Amity.JoinRequestStatus;
+      targetType: 'community';
+      type: Amity.JoinRequestType;
+      sortBy?: Amity.CommunitySortBy | Amity.CommunitySortByEnum;
+      options?: {
+        limit?: number;
+        token?: string;
+      };
+      page?: string;
+    };
+
+    type QueryJoinRequestList = {
+      communityIds: string[];
+      sortBy?: Amity.CommunitySortBy | Amity.CommunitySortByEnum;
+      options?: {
+        limit?: number;
+        token?: string;
+      };
+      page?: string;
+    };
+
     type CommunityLiveCollection = Amity.LiveCollectionParams<Omit<QueryCommunities, 'page'>>;
 
     type RecommendedCommunityLiveCollection = Amity.LiveCollectionParams<{ limit?: number }>;
     type TrendingCommunityLiveCollection = Amity.LiveCollectionParams<{ limit?: number }>;
 
+    type JoinRequestLiveCollection = Amity.LiveCollectionParams<QueryJoinRequest>;
+
+    type JoinRequestListLiveCollection = Amity.LiveCollectionParams<QueryJoinRequestList>;
+
     type SearchCommunityLiveCollection = Amity.LiveCollectionParams<
       Omit<SearchQueryCommunities, 'page'>
     >;
@@ -158,6 +195,16 @@ declare global {
       Pick<SearchQueryCommunities, 'page'>
     >;
 
+    type JoinRequestLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.JoinRequest['joinRequestId'],
+      Pick<QueryJoinRequest, 'page'>
+    >;
+
+    type JoinRequestListLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.JoinRequest['joinRequestId'],
+      Pick<QueryJoinRequestList, 'page'>
+    >;
+
     type QueryCommunityMembers = {
       communityId: string;
       memberships?: ('banned' | 'member')[];
@@ -227,6 +274,12 @@ declare global {
         callback: Amity.LiveCollectionCallback<Amity.Invitation>,
       ) => Amity.Unsubscriber;
       getInvitation: () => Promise<Amity.Invitation | undefined>;
+      join: () => Promise<Amity.JoinResult>;
+      getJoinRequests: (
+        params: QueryJoinRequest,
+        callback: Amity.LiveCollectionCallback<Amity.JoinRequest>,
+      ) => Amity.Unsubscriber;
+      getMyJoinRequest: () => Promise<Amity.JoinRequest | undefined>;
     };
   }
 }

package/src/@types/domains/joinRequest.ts

@@ -0,0 +1,66 @@
+export {};
+
+export const enum JoinRequestStatusEnum {
+  Pending = 'pending',
+  Approved = 'approved',
+  Rejected = 'rejected',
+  Cancelled = 'cancelled',
+}
+
+export const enum JoinResultStatusEnum {
+  Success = 'success',
+  Pending = 'pending',
+}
+
+declare global {
+  namespace Amity {
+    type JoinRequestStatus = JoinRequestStatusEnum;
+
+    type JoinResultStatus = JoinResultStatusEnum;
+
+    type JoinRequestType = 'communityJoinRequest';
+
+    type JoinResult = {
+      status: Amity.JoinResultStatus;
+      request?: Amity.JoinRequest;
+    };
+
+    type RawJoinRequest = {
+      _id: string;
+      createdAt: Amity.timestamp;
+      joinRequestId: string;
+      networkId: string;
+
+      requestorId: string;
+      requestorInternalId: string;
+      requestorPublicId: string;
+
+      respondedAt: Amity.timestamp | null;
+      responderId: string | null;
+      responderInternalId: string | null;
+      responderPublicId: string | null;
+
+      status: Amity.JoinRequestStatus;
+      targetId: string;
+      targetType: string;
+      type: Amity.JoinRequestType;
+      updatedAt: Amity.timestamp;
+      userId: string;
+    };
+
+    type InternalJoinRequest = Omit<RawJoinRequest, '_id'>;
+
+    type JoinRequest = Omit<Amity.InternalJoinRequest, 'responderId'> &
+      Amity.JoinRequestLinkedObject & {
+        user?: Amity.User;
+        feeds?: Amity.Feed[];
+        files?: Amity.File[];
+      };
+
+    type JoinRequestLinkedObject = {
+      cancel: () => Promise<void>;
+      approve: () => Promise<void>;
+      reject: () => Promise<void>;
+    };
+  }
+}

package/src/@types/domains/notification.ts

@@ -10,6 +10,7 @@ declare global {
       POST_REACT = 'reaction_on_post',
       COMMENT_REACT = 'reaction_on_comment',
       REPLY_REACT = 'reaction_on_reply',
+      RESPONSE_JOIN_REQUEST = 'respond_on_join_request',
     }
 
     const enum TrayAction {
@@ -19,6 +20,7 @@ declare global {
       REACTION = 'reaction',
       MENTION = 'mention',
       REPLY = 'reply',
+      JOIN_REQUEST = 'join_request',
     }
 
     type RawNotificationTrayItem = {

package/src/@types/index.ts

@@ -40,3 +40,4 @@ export * from './domains/ad';
 export * from './domains/notification';
 export * from './domains/client';
 export * from './domains/invitation';
+export * from './domains/joinRequest';

package/src/communityRepository/api/getCommunities.ts

@@ -28,12 +28,14 @@ export const getCommunities = async (
   const client = getActiveClient();
   client.log('community/getCommunities', communityIds);
 
+  const encodedCommunityIds = communityIds.map(communityId => encodeURIComponent(communityId));
+
   // API-FIX: endpoint should not be /list, parameters should be querystring.
   const { data: payload } = await client.http.get<Amity.CommunityPayload>(
     `/api/v3/communities/list`,
     {
       params: {
-        communityIds,
+        communityIds: encodedCommunityIds,
         includeDiscoverablePrivateCommunity: includeDiscoverablePrivateCommunity ?? true,
       },
     },

package/src/communityRepository/api/getCommunity.ts

@@ -23,6 +23,8 @@ import { LinkedObject } from '~/utils/linkedObject';
  */
 export const getCommunity = async (
   communityId: Amity.Community['communityId'],
+  type?: Amity.JoinRequestType,
+  includeDiscoverablePrivateCommunity?: boolean,
 ): Promise<Amity.Cached<Amity.Community>> => {
   const client = getActiveClient();
   client.log('community/getCommunity', communityId);
@@ -30,6 +32,12 @@ export const getCommunity = async (
   // API-FIX: endpoint should not be /list, parameters should be querystring.
   const { data: payload } = await client.http.get<Amity.CommunityPayload>(
     `/api/v3/communities/${communityId}`,
+    {
+      params: {
+        type: 'communityJoinRequest',
+        includeDiscoverablePrivateCommunity: includeDiscoverablePrivateCommunity ?? true,
+      },
+    },
   );
 
   const data = prepareCommunityPayload(payload);

package/src/communityRepository/api/joinCommunity.ts

@@ -1,9 +1,12 @@
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { prepareCommunityPayload } from '~/communityRepository/utils';
 import { fireEvent } from '~/core/events';
 
+/**
+ * @deprecated This function will to be deprecated and use the new community.join().
+ */
 /* begin_public_function
   id: community.join
 */

package/src/communityRepository/communityMembership/events/index.ts

@@ -12,3 +12,4 @@ export * from './onCommunityJoined';
 export * from './onCommunityLeft';
 export * from './onLocalCommunityJoined';
 export * from './onLocalCommunityLeft';
+export * from './onLocalCommunityJoin';

package/src/communityRepository/communityMembership/events/onLocalCommunityJoin.ts

@@ -0,0 +1,20 @@
+import { getActiveClient } from '~/client/api/activeClient';
+import { createEventSubscriber } from '~/core/events';
+
+export const onLocalCommunityJoin = (
+  callback: (joinRequest: Amity.InternalJoinRequest) => void,
+) => {
+  const client = getActiveClient();
+
+  const filter = async (rawPayload: Amity.InternalJoinRequest[]) => {
+    callback(rawPayload[0]);
+  };
+
+  const disposers = [
+    createEventSubscriber(client, 'onCommunityUpdate', 'local.community.join', filter),
+  ];
+
+  return () => {
+    disposers.forEach(fn => fn());
+  };
+};

package/src/communityRepository/internalAPI/getMyJoinRequest.ts

@@ -0,0 +1,43 @@
+import { getActiveClient } from '~/client/api/activeClient';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { prepareCommunityJoinRequestPayload } from '~/communityRepository/utils';
+import { joinRequestLinkedObject } from '~/utils/linkedObject/joinRequestLinkedObject';
+
+/* begin_public_function
+  id: community.getMyJoinRequest
+*/
+/**
+ * ```js
+ * import { community } from '@amityco/ts-sdk'
+ * const isJoined = await community.getMyJoinRequest('foobar')
+ * ```
+ *
+ * Joins a {@link Amity.Community} object
+ *
+ * @param communityId the {@link Amity.Community} to join
+ * @returns A success boolean if the {@link Amity.Community} was joined
+ *
+ * @category Community API
+ * @async
+ */
+export const getMyJoinRequest = async (
+  communityId: Amity.Community['communityId'],
+): Promise<Amity.Cached<Amity.JoinRequest | undefined>> => {
+  const client = getActiveClient();
+  client.log('community/myJoinRequest', communityId);
+
+  const { data: payload } = await client.http.get<Amity.CommunityJoinRequestPayload>(
+    `/api/v4/communities/${communityId}/join/me`,
+  );
+
+  const data = prepareCommunityJoinRequestPayload(payload);
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  return {
+    data: data.joinRequests[0] ? joinRequestLinkedObject(data.joinRequests[0]) : undefined,
+    cachedAt,
+  };
+};
+/* end_public_function */

package/src/communityRepository/internalAPI/joinCommunity.ts

@@ -0,0 +1,66 @@
+import { getActiveClient } from '~/client/api/activeClient';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { pullFromCache } from '~/cache/api/pullFromCache';
+import { upsertInCache } from '~/cache/api/upsertInCache';
+import { prepareCommunityJoinRequestPayload } from '~/communityRepository/utils';
+import { fireEvent } from '~/core/events';
+import { JoinRequestStatusEnum, JoinResultStatusEnum } from '~/@types/domains/joinRequest';
+import { joinRequestLinkedObject } from '~/utils/linkedObject/joinRequestLinkedObject';
+
+/* begin_public_function
+  id: community.join
+*/
+/**
+ * ```js
+ * import { community } from '@amityco/ts-sdk'
+ * const isJoined = await community.join('foobar')
+ * ```
+ *
+ * Joins a {@link Amity.Community} object
+ *
+ * @param communityId the {@link Amity.Community} to join
+ * @returns A status join result
+ *
+ * @category Community API
+ * @async
+ */
+export const joinRequest = async (
+  communityId: Amity.Community['communityId'],
+): Promise<Amity.JoinResult> => {
+  const client = getActiveClient();
+  client.log('community/joinRequest', communityId);
+
+  const { data: payload } = await client.http.post<Amity.CommunityJoinRequestPayload>(
+    `/api/v4/communities/${communityId}/join`,
+  );
+
+  const data = prepareCommunityJoinRequestPayload(payload);
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  const status =
+    data.joinRequests[0].status === JoinRequestStatusEnum.Approved
+      ? JoinResultStatusEnum.Success
+      : JoinResultStatusEnum.Pending;
+
+  if (status === JoinResultStatusEnum.Success && client.cache) {
+    const community = pullFromCache<Amity.Community>(['community', 'get', communityId])?.data;
+
+    if (community) {
+      const updatedCommunity = {
+        ...community,
+        isJoined: true,
+      };
+
+      upsertInCache(['community', 'get', communityId], updatedCommunity);
+    }
+  }
+
+  fireEvent('local.community.join', data.joinRequests);
+
+  return status === JoinResultStatusEnum.Success
+    ? { status }
+    : { status, request: joinRequestLinkedObject(data.joinRequests[0]) };
+};
+/* end_public_function */

package/src/communityRepository/joinRequest/events/index.ts

@@ -0,0 +1,3 @@
+export * from './onJoinRequestCreated';
+export * from './onJoinRequestUpdated';
+export * from './onJoinRequestDeleted';

package/src/communityRepository/joinRequest/events/onJoinRequestCreated.ts

@@ -0,0 +1,33 @@
+import { getActiveClient } from '~/client/api/activeClient';
+import { createEventSubscriber } from '~/core/events';
+
+/**
+ * ```js
+ * import { onJoinRequestCreated } from '@amityco/ts-sdk'
+ * const dispose = onJoinRequestCreated(data => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when an {@link Amity.CommunityJoinRequestPayload} has been created
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category JoinRequest Events
+ */
+export const onJoinRequestCreated = (
+  callback: Amity.Listener<Amity.InternalJoinRequest[]>,
+): Amity.Unsubscriber => {
+  const client = getActiveClient();
+
+  const disposers = [
+    createEventSubscriber(client, 'onJoinRequestCreated', 'local.joinRequest.created', payload =>
+      callback(payload),
+    ),
+  ];
+
+  return () => {
+    disposers.forEach(fn => fn());
+  };
+};

package/src/communityRepository/joinRequest/events/onJoinRequestDeleted.ts

@@ -0,0 +1,33 @@
+import { getActiveClient } from '~/client/api/activeClient';
+import { createEventSubscriber } from '~/core/events';
+
+/**
+ * ```js
+ * import { onJoinRequestDeleted } from '@amityco/ts-sdk'
+ * const dispose = onJoinRequestDeleted(data => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when an {@link Amity.CommunityJoinRequestPayload} has been created
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category JoinRequest Events
+ */
+export const onJoinRequestDeleted = (
+  callback: Amity.Listener<Amity.InternalJoinRequest[]>,
+): Amity.Unsubscriber => {
+  const client = getActiveClient();
+
+  const disposers = [
+    createEventSubscriber(client, 'onJoinRequestDeleted', 'local.joinRequest.deleted', payload =>
+      callback(payload),
+    ),
+  ];
+
+  return () => {
+    disposers.forEach(fn => fn());
+  };
+};

package/src/communityRepository/joinRequest/events/onJoinRequestUpdated.ts

@@ -0,0 +1,33 @@
+import { getActiveClient } from '~/client/api/activeClient';
+import { createEventSubscriber } from '~/core/events';
+
+/**
+ * ```js
+ * import { onJoinRequestUpdated } from '@amityco/ts-sdk'
+ * const dispose = onJoinRequestUpdated(data => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when an {@link Amity.CommunityJoinRequestPayload} has been created
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category JoinRequest Events
+ */
+export const onJoinRequestUpdated = (
+  callback: Amity.Listener<Amity.InternalJoinRequest[]>,
+): Amity.Unsubscriber => {
+  const client = getActiveClient();
+
+  const disposers = [
+    createEventSubscriber(client, 'onJoinRequestUpdated', 'local.joinRequest.updated', payload =>
+      callback(payload),
+    ),
+  ];
+
+  return () => {
+    disposers.forEach(fn => fn());
+  };
+};