@amityco/ts-sdk 7.4.1-9b7bc08.0 → 7.4.1-9fe8bb83.0

package/src/@types/index.ts

@@ -38,3 +38,5 @@ export * from './domains/post';
 export * from './domains/story';
 export * from './domains/ad';
 export * from './domains/notification';
+export * from './domains/client';
+export * from './domains/invitation';

package/src/communityRepository/api/createCommunity.ts

@@ -1,3 +1,4 @@
+import { LinkedObject } from '~/utils/linkedObject';
 import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
@@ -11,7 +12,7 @@ import { prepareCommunityPayload, prepareCommunityRequest } from '../utils';
 /**
  * ```js
  * import { createCommunity } from '@amityco/ts-sdk'
- * const created = await createCommunity({ communityId: 'foobar', displayName: 'foobar' })
+ * const created = await createCommunity({ communityId: 'foobar', displayName: 'foobar', isDiscoverable: true, requiresJoinApproval: false })
  * ```
  *
  * Creates an {@link Amity.Community}
@@ -33,6 +34,8 @@ export const createCommunity = async (
     | 'postSetting'
     | 'tags'
     | 'metadata'
+    | 'isDiscoverable'
+    | 'requiresJoinApproval'
   > &
     Amity.CommunityStorySettings & {
       userIds?: string[];
@@ -60,7 +63,7 @@ export const createCommunity = async (
 
   const { communities } = data;
   return {
-    data: communities[0],
+    data: LinkedObject.community(communities[0]),
     cachedAt,
   };
 };

package/src/communityRepository/api/getCommunities.ts

@@ -5,6 +5,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { saveCommunityUsers } from '~/communityRepository/utils/saveCommunityUsers';
 import { prepareCommunityPayload } from '../utils';
+import { LinkedObject } from '~/utils/linkedObject';
 
 /**
  * ```js
@@ -43,7 +44,7 @@ export const getCommunities = async (
   }
 
   return {
-    data: data.communities,
+    data: data.communities.map(community => LinkedObject.community(community)),
     cachedAt,
   };
 };

package/src/communityRepository/api/getCommunity.ts

@@ -5,6 +5,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { saveCommunityUsers } from '~/communityRepository/utils/saveCommunityUsers';
 import { prepareCommunityPayload } from '../utils';
+import { LinkedObject } from '~/utils/linkedObject';
 
 /**
  * ```js
@@ -42,7 +43,9 @@ export const getCommunity = async (
   const { communities } = data;
 
   return {
-    data: communities.find(community => community.communityId === communityId)!,
+    data: LinkedObject.community(
+      communities.find(community => community.communityId === communityId)!,
+    ),
     cachedAt,
   };
 };

package/src/communityRepository/api/getRecommendedCommunities.ts

@@ -4,6 +4,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareCommunityPayload } from '../utils';
 import { COLLECTION_DEFAULT_PAGINATION_LIMIT } from '~/utils/constants';
+import { LinkedObject } from '~/utils/linkedObject';
 
 /* begin_public_function
   id: community.query.recommended_communities
@@ -47,5 +48,5 @@ export const getRecommendedCommunities = async (
     ingestInCache(data, { cachedAt });
   }
 
-  return { data: communities, cachedAt };
+  return { data: communities.map(community => LinkedObject.community(community)), cachedAt };
 };

package/src/communityRepository/api/getTrendingCommunities.ts

@@ -4,6 +4,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareCommunityPayload } from '../utils';
 import { COLLECTION_DEFAULT_PAGINATION_LIMIT } from '~/utils/constants';
+import { LinkedObject } from '~/utils/linkedObject';
 
 /**
  * ```js
@@ -44,5 +45,5 @@ export const getTrendingCommunities = async (
     ingestInCache(data, { cachedAt });
   }
 
-  return { data: communities, cachedAt };
+  return { data: communities.map(community => LinkedObject.community(community)), cachedAt };
 };

package/src/communityRepository/api/queryCommunities.ts

@@ -6,6 +6,7 @@ import { getResolver } from '~/core/model';
 import { inferIsDeleted } from '~/utils/inferIsDeleted';
 import { saveCommunityUsers } from '~/communityRepository/utils/saveCommunityUsers';
 import { prepareCommunityPayload } from '../utils';
+import { LinkedObject } from '~/utils/linkedObject';
 
 /**
  * ```js
@@ -68,5 +69,9 @@ export const queryCommunities = async (
     saveCommunityUsers(data.communities, data.communityUsers);
   }
 
-  return { data: communities, cachedAt, paging };
+  return {
+    data: communities.map(community => LinkedObject.community(community)),
+    cachedAt,
+    paging,
+  };
 };

package/src/communityRepository/api/updateCommunity.ts

@@ -5,6 +5,7 @@ import { fireEvent } from '~/core/events';
 
 import { saveCommunityUsers } from '~/communityRepository/utils/saveCommunityUsers';
 import { prepareCommunityPayload, prepareCommunityRequest } from '../utils';
+import { LinkedObject } from '~/utils/linkedObject';
 
 /* begin_public_function
   id: community.update
@@ -12,7 +13,7 @@ import { prepareCommunityPayload, prepareCommunityRequest } from '../utils';
 /**
  * ```js
  * import { updateCommunity } from '@amityco/ts-sdk'
- * const updated = await updateCommunity(communityId, { displayName: 'foobar' })
+ * const updated = await updateCommunity(communityId, { displayName: 'foobar', isDiscoverable: true, requiresJoinApproval: false })
  * ```
  *
  * Updates an {@link Amity.Community}
@@ -28,7 +29,14 @@ export const updateCommunity = async (
   communityId: Amity.Community['communityId'],
   patch: Patch<
     Amity.Community,
-    'displayName' | 'avatarFileId' | 'description' | 'postSetting' | 'tags' | 'metadata'
+    | 'displayName'
+    | 'avatarFileId'
+    | 'description'
+    | 'postSetting'
+    | 'tags'
+    | 'metadata'
+    | 'isDiscoverable'
+    | 'requiresJoinApproval'
   > &
     Amity.CommunityStorySettings,
 ): Promise<Amity.Cached<Amity.Community>> => {
@@ -53,7 +61,9 @@ export const updateCommunity = async (
   const { communities } = data;
 
   return {
-    data: communities.find(community => community.communityId === communityId)!,
+    data: LinkedObject.community(
+      communities.find(community => community.communityId === communityId)!,
+    ),
     cachedAt,
   };
 };

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

@@ -16,5 +16,5 @@ import { createCommunityMemberEventSubscriber } from './utils';
  * @category Community Events
  */
 export const onCommunityJoined = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ) => createCommunityMemberEventSubscriber('community.joined', callback);

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

@@ -16,5 +16,5 @@ import { createCommunityMemberEventSubscriber } from './utils';
  * @category Community Events
  */
 export const onCommunityLeft = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ) => createCommunityMemberEventSubscriber('community.left', callback);

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

@@ -16,5 +16,5 @@ import { createCommunityMemberEventSubscriber } from './utils';
  * @category Community Events
  */
 export const onCommunityUserAdded = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ) => createCommunityMemberEventSubscriber('community.userAdded', callback);

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

@@ -16,5 +16,5 @@ import { createCommunityMemberEventSubscriber } from './utils';
  * @category Community Events
  */
 export const onCommunityUserBanned = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ) => createCommunityMemberEventSubscriber('community.userBanned', callback);

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

@@ -16,5 +16,5 @@ import { createCommunityMemberEventSubscriber } from './utils';
  * @category Community Events
  */
 export const onCommunityUserChanged = (
-  callback: (community: Amity.Community, members: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, members: Amity.Membership<'community'>[]) => void,
 ) => createCommunityMemberEventSubscriber('community.userChanged', callback);

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

@@ -16,5 +16,5 @@ import { createCommunityMemberEventSubscriber } from './utils';
  * @category Community Events
  */
 export const onCommunityUserRemoved = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ) => createCommunityMemberEventSubscriber('community.userRemoved', callback);

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

@@ -16,5 +16,5 @@ import { createCommunityMemberEventSubscriber } from './utils';
  * @category Community Events
  */
 export const onCommunityUserRoleAdded = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ) => createCommunityMemberEventSubscriber('community.roleAdded', callback);

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

@@ -16,5 +16,5 @@ import { createCommunityMemberEventSubscriber } from './utils';
  * @category Community Events
  */
 export const onCommunityUserRoleRemoved = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ) => createCommunityMemberEventSubscriber('community.roleRemoved', callback);

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

@@ -16,5 +16,5 @@ import { createCommunityMemberEventSubscriber } from './utils';
  * @category Community Events
  */
 export const onCommunityUserUnbanned = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ) => createCommunityMemberEventSubscriber('community.userUnbanned', callback);

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

@@ -1,5 +1,5 @@
 import { createLocalCommunityMemberEventSubscriber } from './utils';
 
 export const onLocalCommunityJoined = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ) => createLocalCommunityMemberEventSubscriber('local.community.joined', callback);

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

@@ -1,5 +1,5 @@
 import { createLocalCommunityMemberEventSubscriber } from './utils';
 
 export const onLocalCommunityLeft = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ) => createLocalCommunityMemberEventSubscriber('local.community.left', callback);

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

@@ -16,5 +16,5 @@ import { createLocalCommunityMemberEventSubscriber } from './utils';
  * @category Community Events
  */
 export const onLocalCommunityUserAdded = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ) => createLocalCommunityMemberEventSubscriber('local.community.userAdded', callback);

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

@@ -16,5 +16,5 @@ import { createLocalCommunityMemberEventSubscriber } from './utils';
  * @category Community Events
  */
 export const onLocalCommunityUserRemoved = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ) => createLocalCommunityMemberEventSubscriber('local.community.userRemoved', callback);

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

@@ -22,7 +22,9 @@ import { getResolver } from '~/core/model';
  */
 export const onUserDeleted =
   (communityId: string) =>
-  (callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void) => {
+  (
+    callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
+  ) => {
     const client = getActiveClient();
 
     const filter = (payload: Amity.UserPayload) => {

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

@@ -53,7 +53,7 @@ function getEventRelatedMember(
 
 export const createCommunityMemberEventSubscriber = (
   event: keyof Amity.MqttCommunityUserEvents,
-  callback: (community: Amity.Community, members: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, members: Amity.Membership<'community'>[]) => void,
 ) => {
   const client = getActiveClient();
 
@@ -102,7 +102,7 @@ export const createCommunityMemberEventSubscriber = (
 
 export const createLocalCommunityMemberEventSubscriber = (
   event: keyof Amity.LocalCommunityEvents,
-  callback: (community: Amity.Community, members: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, members: Amity.Membership<'community'>[]) => void,
 ) => {
   const client = getActiveClient();
 

package/src/communityRepository/communityMembership/observers/getMembers/CommunityMembersQueryStreamController.ts

@@ -70,7 +70,10 @@ export class CommunityMembersQueryStreamController extends QueryStreamController
   }
 
   reactor(action: EnumCommunityMemberActions) {
-    return (community: Amity.Community, communityMembers: Amity.Membership<'community'>[]) => {
+    return (
+      community: Amity.InternalCommunity,
+      communityMembers: Amity.Membership<'community'>[],
+    ) => {
       const collection = pullFromCache<Amity.CommunityMemberLiveCollectionCache>(
         this.cacheKey,
       )?.data;
@@ -97,7 +100,10 @@ export class CommunityMembersQueryStreamController extends QueryStreamController
   subscribeRTE(
     createSubscriber: {
       fn: (
-        reactor: (channel: Amity.Community, communityUser: Amity.Membership<'community'>[]) => void,
+        reactor: (
+          channel: Amity.InternalCommunity,
+          communityUser: Amity.Membership<'community'>[],
+        ) => void,
       ) => Amity.Unsubscriber;
       action: EnumCommunityMemberActions;
     }[],

package/src/communityRepository/communityMembership/observers/searchMembers/SearchCommunityMembersQueryStreamController.ts

@@ -70,7 +70,10 @@ export class SearchCommunityMembersQueryStreamController extends QueryStreamCont
   }
 
   reactor(action: EnumCommunityMemberActions) {
-    return (community: Amity.Community, communityMembers: Amity.Membership<'community'>[]) => {
+    return (
+      community: Amity.InternalCommunity,
+      communityMembers: Amity.Membership<'community'>[],
+    ) => {
       const collection = pullFromCache<Amity.SearchCommunityMemberLiveCollectionCache>(
         this.cacheKey,
       )?.data;
@@ -95,7 +98,10 @@ export class SearchCommunityMembersQueryStreamController extends QueryStreamCont
   subscribeRTE(
     createSubscriber: {
       fn: (
-        reactor: (channel: Amity.Community, communityUser: Amity.Membership<'community'>[]) => void,
+        reactor: (
+          channel: Amity.InternalCommunity,
+          communityUser: Amity.Membership<'community'>[],
+        ) => void,
       ) => Amity.Unsubscriber;
       action: EnumCommunityMemberActions;
     }[],

package/src/communityRepository/communityModeration/events/onLocalCommunityRoleAdded.ts

@@ -17,7 +17,7 @@ import { createEventSubscriber } from '~/core/events';
  * @category Community Events
  */
 export const onLocalCommunityRoleAdded = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ): Amity.Unsubscriber => {
   const client = getActiveClient();
 

package/src/communityRepository/communityModeration/events/onLocalCommunityRoleRemoved.ts

@@ -17,7 +17,7 @@ import { createEventSubscriber } from '~/core/events';
  * @category Community Events
  */
 export const onLocalCommunityRoleRemoved = (
-  callback: (community: Amity.Community, member: Amity.Membership<'community'>[]) => void,
+  callback: (community: Amity.InternalCommunity, member: Amity.Membership<'community'>[]) => void,
 ): Amity.Unsubscriber => {
   const client = getActiveClient();
 

package/src/communityRepository/events/onCommunityCreated.ts

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

package/src/communityRepository/events/onCommunityDeleted.ts

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

package/src/communityRepository/events/onCommunityUpdated.ts

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

package/src/communityRepository/events/utils.ts

@@ -7,7 +7,7 @@ import { prepareCommunityPayload } from '../utils';
 
 export const createCommunityEventSubscriber = (
   event: keyof Amity.MqttCommunityEvents,
-  callback: Amity.Listener<Amity.Community>,
+  callback: Amity.Listener<Amity.InternalCommunity>,
 ) => {
   const client = getActiveClient();
 

package/src/communityRepository/observers/getCommunities/CommunitiesQueryStreamController.ts

@@ -60,7 +60,7 @@ export class CommunitiesQueryStreamController extends QueryStreamController<
   }
 
   reactor(action: EnumCommunityActions | EnumCommunityMemberActions) {
-    return (community: Amity.Community) => {
+    return (community: Amity.InternalCommunity) => {
       const collection = pullFromCache<Amity.CommunityLiveCollectionCache>(this.cacheKey)?.data;
       if (!collection) return;
 
@@ -76,7 +76,7 @@ export class CommunitiesQueryStreamController extends QueryStreamController<
 
   subscribeRTE(
     createSubscriber: {
-      fn: (reactor: (channel: Amity.Community) => void) => Amity.Unsubscriber;
+      fn: (reactor: (channel: Amity.InternalCommunity) => void) => Amity.Unsubscriber;
       action: EnumCommunityActions | EnumCommunityMemberActions;
     }[],
   ) {

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

@@ -66,7 +66,7 @@ export class RecommendedCommunitiesQueryStreamController extends QueryStreamCont
   }
 
   reactor(action: EnumCommunityActions | EnumCommunityMemberActions) {
-    return (community: Amity.Community) => {
+    return (community: Amity.InternalCommunity) => {
       const collection = pullFromCache<Amity.RecommendedCommunityLiveCollectionCache>(
         this.cacheKey,
       )?.data;
@@ -79,7 +79,7 @@ export class RecommendedCommunitiesQueryStreamController extends QueryStreamCont
 
   subscribeRTE(
     createSubscriber: {
-      fn: (reactor: (channel: Amity.Community) => void) => Amity.Unsubscriber;
+      fn: (reactor: (channel: Amity.InternalCommunity) => void) => Amity.Unsubscriber;
       action: EnumCommunityActions | EnumCommunityMemberActions;
     }[],
   ) {

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

@@ -64,7 +64,7 @@ export class TrendingCommunitiesQueryStreamController extends QueryStreamControl
   }
 
   reactor(action: EnumCommunityActions | EnumCommunityMemberActions) {
-    return (community: Amity.Community) => {
+    return (community: Amity.InternalCommunity) => {
       const collection = pullFromCache<Amity.TrendingCommunityLiveCollectionCache>(
         this.cacheKey,
       )?.data;
@@ -77,7 +77,7 @@ export class TrendingCommunitiesQueryStreamController extends QueryStreamControl
 
   subscribeRTE(
     createSubscriber: {
-      fn: (reactor: (channel: Amity.Community) => void) => Amity.Unsubscriber;
+      fn: (reactor: (channel: Amity.InternalCommunity) => void) => Amity.Unsubscriber;
       action: EnumCommunityActions | EnumCommunityMemberActions;
     }[],
   ) {

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

@@ -60,7 +60,7 @@ export class CommunitiesQueryStreamController extends QueryStreamController<
   }
 
   reactor(action: EnumCommunityActions | EnumCommunityMemberActions) {
-    return (community: Amity.Community) => {
+    return (community: Amity.InternalCommunity) => {
       const collection = pullFromCache<Amity.SearchCommunityLiveCollectionCache>(
         this.cacheKey,
       )?.data;
@@ -73,7 +73,7 @@ export class CommunitiesQueryStreamController extends QueryStreamController<
 
   subscribeRTE(
     createSubscriber: {
-      fn: (reactor: (channel: Amity.Community) => void) => Amity.Unsubscriber;
+      fn: (reactor: (channel: Amity.InternalCommunity) => void) => Amity.Unsubscriber;
       action: EnumCommunityActions | EnumCommunityMemberActions;
     }[],
   ) {

package/src/communityRepository/observers/semanticSearch/SemanticSearchCommunityQueryStreamController.ts

@@ -63,7 +63,7 @@ export class SemanticSearchCommunityQueryStreamController extends QueryStreamCon
   }
 
   reactor(action: EnumCommunityActions | EnumCommunityMemberActions) {
-    return (community: Amity.Community) => {
+    return (community: Amity.InternalCommunity) => {
       const collection = pullFromCache<Amity.CommunityLiveCollectionCache>(this.cacheKey)?.data;
       if (!collection) return;
 
@@ -77,7 +77,7 @@ export class SemanticSearchCommunityQueryStreamController extends QueryStreamCon
 
   subscribeRTE(
     createSubscriber: {
-      fn: (reactor: (community: Amity.Community) => void) => Amity.Unsubscriber;
+      fn: (reactor: (community: Amity.InternalCommunity) => void) => Amity.Unsubscriber;
       action: EnumCommunityActions | EnumCommunityMemberActions;
     }[],
   ) {

package/src/communityRepository/utils/communityWithMembership.ts

@@ -12,7 +12,7 @@ function isMember(membership: Amity.Membership<'community'>['communityMembership
  * checks if currently logged in user is part of the community
  */
 function isCurrentUserPartOfCommunity(
-  c: Amity.Community,
+  c: Amity.InternalCommunity,
   m: Amity.Membership<'community'>,
 ): boolean {
   const { userId } = getActiveUser();
@@ -28,11 +28,15 @@ function isCurrentUserPartOfCommunity(
  * Althought this can be calculated, it's not scalable.
  */
 export function updateMembershipStatus(
-  communities: Amity.Community[],
+  communities: Amity.RawCommunity[],
   communityUsers: Amity.Membership<'community'>[],
-): Amity.Community[] {
+): Amity.InternalCommunity[] {
   return communities.map(c => {
-    const cachedCommunity = pullFromCache<Amity.Community>(['community', 'get', c.communityId]);
+    const cachedCommunity = pullFromCache<Amity.InternalCommunity>([
+      'community',
+      'get',
+      c.communityId,
+    ]);
     if (cachedCommunity?.data && cachedCommunity?.data.hasOwnProperty('isJoined')) {
       return {
         ...cachedCommunity.data,

package/src/communityRepository/utils/payload.ts

@@ -13,7 +13,7 @@ const getMatchPostSetting = (value: {
   ) ?? DefaultCommunityPostSetting;
 
 export function addPostSetting({ communities }: { communities: Amity.RawCommunity[] }) {
-  return communities.map<Amity.Community>(
+  return communities.map<Amity.InternalCommunity>(
     ({ needApprovalOnPostCreation, onlyAdminCanPost, ...restCommunityPayload }) => ({
       postSetting: getMatchPostSetting({
         needApprovalOnPostCreation,

package/src/core/liveCollection/PaginationController.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from 'axios';
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 
 export abstract class PaginationController<
   TPayloadDomain extends keyof Amity.Payloads,

package/src/core/liveCollection/PaginationNoPageController.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from 'axios';
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 
 export abstract class PaginationNoPageController<
   TPayloadDomain extends keyof Amity.Payloads,

package/src/core/model/idResolvers.ts

@@ -64,6 +64,8 @@ const idResolvers: Resolvers = {
 
   notificationTrayItem: ({ _id }) => _id,
   notificationTraySeen: ({ userId }) => userId,
+
+  invitation: ({ _id }) => _id,
 };
 
 /**

package/src/core/model/index.ts

@@ -54,6 +54,8 @@ export const PAYLOAD2MODEL: Record<string, Amity.Domain> = {
   pins: 'pin',
 
   notificationTrayItems: 'notificationTrayItem',
+
+  invitations: 'invitation',
 };
 
 /** hidden */

package/src/index.ts

@@ -51,3 +51,5 @@ export * as AdRepository from './adRepository';
 export * from './external/api';
 
 export * as notificationTray from './notificationTray';
+
+export * as InvitationRepository from './invitationRepository';

package/src/invitationRepository/events/index.ts

@@ -0,0 +1,3 @@
+export * from './onLocalInvitationCreated';
+export * from './onLocalInvitationUpdated';
+export * from './onLocalInvitationDeleted';

package/src/invitationRepository/events/onLocalInvitationCreated.ts

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