@amityco/ts-sdk 7.5.3 → 7.5.4-2d34fd5f.0

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

@@ -33,7 +33,7 @@ declare global {
       feedMarker: Amity.FeedMarker;
       userMarker: Amity.UserMarker;
 
-      community: Amity.Community;
+      community: Amity.InternalCommunity;
       category: Amity.InternalCategory;
       communityUsers: Amity.Membership<'community'>;
       post: Amity.InternalPost;
@@ -60,6 +60,10 @@ declare global {
 
       notificationTrayItem: Amity.InternalNotificationTrayItem;
       notificationTraySeen: Amity.InternalNotificationTraySeen;
+
+      invitation: Amity.InternalInvitation;
+
+      joinRequest: Amity.InternalJoinRequest;
     };
 
     type Model = ValueOf<Models>;
@@ -124,6 +128,9 @@ declare global {
 
       notificationTrayItem: Pick<Amity.InternalNotificationTrayItem, '_id'>;
       notificationTraySeen: Pick<Amity.InternalNotificationTraySeen, 'userId'>;
+
+      invitation: Pick<Amity.InternalInvitation, '_id'>;
+      joinRequest: Pick<Amity.InternalJoinRequest, 'joinRequestId'>;
     };
   }
 }

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

@@ -27,6 +27,9 @@ declare global {
       semanticSearchPost: Amity.SemanticSearchPostPayload;
       semanticSearchCommunity: Amity.SemanticSearchCommunityPayload;
       notificationTrayItem: Amity.NotificationTrayPayload;
+      invitation: Amity.InvitationPayload;
+      myInvitation: Amity.MyInvitationsPayload;
+      joinRequest: Amity.CommunityJoinRequestPayload;
     };
 
     type UserPayload = {
@@ -225,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[];
     };
 
@@ -297,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;
 
@@ -306,8 +315,18 @@ declare global {
      * - communityUsers: `Amity.RawMembership` -> `Amity.Membership` (Add user getter prop)
      */
     type ProcessedCommunityPayload = Omit<CommunityPayload, 'communities' | 'communityUsers'> & {
-      communities: Amity.Community[];
+      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 = {
@@ -333,7 +352,7 @@ declare global {
       CommunityMembershipPayload,
       'communities' | 'communityUsers'
     > & {
-      communities: Amity.Community[];
+      communities: Amity.InternalCommunity[];
       communityUsers: Amity.Membership<'community'>[];
     };
 
@@ -383,7 +402,7 @@ declare global {
       Amity.StoryTargetPayload;
 
     type ProcessedGlobalStoryFeed = Omit<GlobalStoryFeedPayload, 'communities'> & {
-      communities: Amity.Community[];
+      communities: Amity.InternalCommunity[];
     };
 
     // Original Payload form BE
@@ -436,7 +455,7 @@ declare global {
      */
     type ProcessedPostPayload = Omit<PostPayload, 'communities' | 'communityUsers' | 'posts'> & {
       posts: Amity.InternalPost[];
-      communities: Amity.Community[];
+      communities: Amity.InternalCommunity[];
       communityUsers: Amity.Membership<'community'>[];
     };
 
@@ -545,5 +564,29 @@ declare global {
       Amity.Flaggable &
       Amity.Taggable &
       Amity.Timestamps;
+
+    type InvitationPayload = {
+      invitations: Amity.RawInvitation[];
+      users: Amity.RawUser[];
+    };
+
+    type ProcessedInvitationPayload = {
+      invitations: Amity.InternalInvitation[];
+      users: Amity.InternalUser[];
+    };
+
+    type MyInvitationsPayload = {
+      invitations: Amity.RawInvitation[];
+      users: Amity.RawUser[];
+    };
+
+    type ProcessedMyInvitationsPayload = {
+      invitations: Amity.InternalInvitation[];
+      users: Amity.InternalUser[];
+    };
+
+    type JoinRequestPayload = {
+      joinRequests: Amity.RawJoinRequest[];
+    };
   }
 }

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

@@ -1,10 +1,17 @@
 import { AxiosInstance } from 'axios';
 import { Emitter } from 'mitt';
 
+export const enum MembershipAcceptanceTypeEnum {
+  AUTOMATIC = 'automatic',
+  INVITATION = 'invitation',
+}
+
 declare global {
   namespace Amity {
     type Logger = (topic: string, ...args: any[]) => void;
 
+    type MembershipAcceptanceType = MembershipAcceptanceTypeEnum;
+
     const enum TokenTerminationReason {
       GLOBAL_BAN = 'globalBan',
       USER_DELETED = 'userDeleted',
@@ -124,7 +131,12 @@ declare global {
         showMyPost: boolean;
         showOnlyMyFeed: boolean;
       };
+      story: {
+        allowAllUserToCreateStory: boolean;
+        expiryTimeMinutes: number;
+      };
       userPrivacySetting: 'public' | 'private';
+      membershipAcceptance: Amity.MembershipAcceptanceType;
     };
 
     type ConnectClientParams = {

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

@@ -95,17 +95,25 @@ declare global {
       hasFlaggedPost: boolean;
 
       allowCommentInStory?: boolean;
+
+      isDiscoverable?: boolean;
+      requiresJoinApproval?: boolean;
     } & Amity.Taggable &
       Amity.Metadata &
       Amity.Timestamps &
       Amity.SoftDelete &
       Amity.Subscribable;
 
-    type Community = Omit<Amity.RawCommunity, 'onlyAdminCanPost' | 'needApprovalOnPostCreation'> &
+    type InternalCommunity = Omit<
+      Amity.RawCommunity,
+      'onlyAdminCanPost' | 'needApprovalOnPostCreation'
+    > &
       Amity.CommunityStorySettings & {
         postSetting?: ValueOf<typeof CommunityPostSettings>;
       };
 
+    type Community = Amity.InternalCommunity & Amity.CommunityLinkedObject;
+
     type QueryCommunities = {
       membership?: 'all' | 'member' | 'notMember';
       categoryId?: Amity.InternalCategory['categoryId'];
@@ -114,6 +122,17 @@ declare global {
       sortBy?: Amity.CommunitySortBy | Amity.CommunitySortByEnum;
       page?: string;
       limit?: number;
+      includeDiscoverablePrivateCommunity?: boolean;
+    };
+
+    type QueryJoinCommunity = {
+      communityId: string;
+      status: Amity.JoinRequestStatus;
+      sortBy?: Amity.CommunitySortBy | Amity.CommunitySortByEnum;
+      options?: {
+        limit?: number;
+        token?: string;
+      };
     };
 
     type SearchQueryCommunities = {
@@ -125,12 +144,46 @@ declare global {
       sortBy?: Amity.SearchCommunitySortBy | Amity.SearchCommunitySortByEnum;
       page?: string;
       limit?: number;
+      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 RecommendedCommunityLiveCollection = Amity.LiveCollectionParams<{
+      limit?: number;
+      includeDiscoverablePrivateCommunity?: boolean;
+    }>;
+    type TrendingCommunityLiveCollection = Amity.LiveCollectionParams<{
+      limit?: number;
+      includeDiscoverablePrivateCommunity?: boolean;
+    }>;
+
+    type JoinRequestLiveCollection = Amity.LiveCollectionParams<QueryJoinRequest>;
+
+    type JoinRequestListLiveCollection = Amity.LiveCollectionParams<QueryJoinRequestList>;
 
     type SearchCommunityLiveCollection = Amity.LiveCollectionParams<
       Omit<SearchQueryCommunities, 'page'>
@@ -149,6 +202,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')[];
@@ -197,6 +260,7 @@ declare global {
         token?: string;
       };
       tags?: string[];
+      includeDiscoverablePrivateCommunity?: boolean;
     };
 
     type SemanticSearchCommunityLiveCollection = Amity.LiveCollectionParams<
@@ -209,5 +273,20 @@ declare global {
       Amity.Community['communityId'], // communityId:score
       QuerySemanticSearchCommunity
     >;
+
+    type CommunityLinkedObject = {
+      createInvitations: (userIds: string[]) => Promise<void>;
+      getMemberInvitations: (
+        params: Pick<Amity.InvitationLiveCollection, 'limit' | 'sortBy' | 'statuses'>,
+        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/content.ts

@@ -24,7 +24,16 @@ declare global {
       | Exclude<`${ContentFlagReasonEnum}`, `${ContentFlagReasonEnum.Others}`>
       | (string & {});
 
-    type ContentType = 'text' | 'image' | 'file' | 'video' | 'poll' | 'json' | string;
+    type ContentType =
+      | 'text'
+      | 'image'
+      | 'file'
+      | 'video'
+      | 'poll'
+      | 'json'
+      | 'liveStream'
+      | 'clip'
+      | string;
 
     type ContentFeedType = ValueOf<typeof ContentFeedType>;
 
@@ -54,10 +63,21 @@ declare global {
       };
     };
 
+    type ContentDataClip = {
+      thumbnailFileId: Amity.File<'image'>['fileId'];
+      fileId: Amity.File<'clip'>['fileId'];
+      isMuted?: boolean;
+      displayMode?: Amity.ClipDisplayMode;
+    };
+
     type ContentDataPoll = {
       pollId: Amity.Poll['pollId'];
     };
 
+    type ContentDataStream = {
+      streamId: Amity.Stream['streamId'];
+    };
+
     type ContentData<T extends ContentType> = T extends 'text'
       ? ContentDataText
       : T extends 'file'
@@ -68,6 +88,10 @@ declare global {
       ? ContentDataVideo
       : T extends 'poll'
       ? ContentDataPoll
+      : T extends 'liveStream'
+      ? ContentDataStream
+      : T extends 'clip'
+      ? ContentDataClip
       : T extends 'json'
       ? Record<string, unknown>
       : T extends string

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

@@ -11,8 +11,9 @@ declare global {
     } & Amity.Timestamps;
 
     type QueryGlobalFeed = {
-      dataType?: 'video' | 'image' | 'file' | 'liveStream';
+      dataTypes?: ('video' | 'image' | 'file' | 'liveStream' | 'clip')[];
       queryToken?: string;
+      resolveParent?: boolean;
     };
   }
 }

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

@@ -2,6 +2,7 @@ export const FileType = Object.freeze({
   FILE: 'file',
   IMAGE: 'image',
   VIDEO: 'video',
+  CLIP: 'clip',
 });
 
 export const VideoResolution = Object.freeze({
@@ -55,12 +56,16 @@ declare global {
 
     type VideoMetadata = Record<string, never>;
 
+    type ClipMetadata = Record<string, never>;
+
     type MetadataFor<T extends FileType> = T extends 'file'
       ? FileMetadata
       : T extends 'image'
       ? ImageMetadata
       : T extends 'video'
       ? VideoMetadata
+      : T extends 'clip'
+      ? ClipMetadata
       : never;
 
     type File<T extends FileType = any> = Amity.FilePayload<T>;

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

@@ -0,0 +1,119 @@
+export {};
+
+export const enum InvitationTypeEnum {
+  CommunityMemberInvite = 'communityMemberInvite',
+  LivestreamInvite = 'livestreamInvite',
+}
+
+export const enum InvitationStatusEnum {
+  Pending = 'pending',
+  Approved = 'approved',
+  Rejected = 'rejected',
+  Cancelled = 'cancelled',
+}
+
+export const enum InvitationSortByEnum {
+  FirstCreated = 'firstCreated',
+  LastCreated = 'lastCreated',
+}
+
+declare global {
+  namespace Amity {
+    type InvitationType = InvitationTypeEnum;
+
+    type InvitationStatus = InvitationStatusEnum;
+
+    type InvitationTargetType = Extract<Amity.Domain, 'community'>;
+
+    type InvitationTargetMap = {
+      community: Amity.InternalCommunity;
+    };
+
+    type InvitationTarget<T extends InvitationTargetType> = InvitationTargetMap[T];
+
+    type InvitationSortBy = InvitationSortByEnum;
+
+    type InvitationDomain<T extends Amity.InvitationTargetType = Amity.InvitationTargetType> =
+      T extends 'community' ? { communityId: string } : { communityId?: string };
+
+    type RawInvitation = {
+      _id: string;
+      networkId: string;
+      type: Amity.InvitationType;
+      targetId: string;
+      targetType: Amity.InvitationTargetType;
+      userId: string;
+      status: Amity.InvitationStatus;
+      respondedAt: Amity.timestamp;
+      createdBy: string;
+      invitationId: string;
+      invitedUserId: string;
+      invitedUserInternalId: string;
+      invitedUserPublicId: string;
+      inviterUserId: string;
+      inviterUserInternalId: string;
+      inviterUserPublicId: string;
+    } & Amity.Timestamps &
+      Amity.InvitationDomain<Amity.InvitationTargetType>;
+
+    type InternalInvitation = Omit<RawInvitation, 'createdBy'> & {
+      createdById: string;
+    };
+
+    type Invitation = Omit<Amity.InternalInvitation, 'createdBy'> &
+      Amity.InvitationLinkedObject & {
+        user?: Amity.User;
+        createdById: string;
+        createdBy?: Amity.User;
+        target?: Amity.InvitationTarget<Amity.InvitationTargetType>;
+      };
+
+    type QueryInvitations = {
+      targetId: string;
+      statuses?: string[];
+      token?: Amity.Token;
+      type: Amity.InvitationType;
+      sortBy?: Amity.InvitationSortBy;
+      limit?: Amity.PageLimit['limit'];
+      targetType: Amity.InvitationTargetType;
+    };
+
+    type InvitationLiveCollection = Amity.LiveCollectionParams<Omit<QueryInvitations, 'limit'>>;
+
+    type InvitationLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.InternalInvitation['_id'],
+      Pick<QueryInvitations, 'limit'>
+    >;
+
+    type QueryMyInvitations = {
+      targetId?: string;
+      token?: Amity.Token;
+      type?: Amity.InvitationType;
+      sortBy?: Amity.InvitationSortBy;
+      limit?: Amity.PageLimit['limit'];
+      statuses?: InvitationStatusEnum[];
+      targetType?: Amity.InvitationTargetType;
+    };
+
+    type MyInvitationsLiveCollection = Amity.LiveCollectionParams<
+      Omit<QueryMyInvitations, 'limit'>
+    >;
+
+    type MyInvitationsLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.InternalInvitation['_id'],
+      Pick<QueryMyInvitations, 'limit'>
+    >;
+
+    type InvitationLinkedObject = {
+      accept: () => Promise<void>;
+      reject: () => Promise<void>;
+    };
+
+    type CreateInvitations = {
+      type: Amity.InvitationType;
+      targetType: Amity.InvitationTargetType;
+      targetId: string;
+      userIds: string[];
+    };
+  }
+}

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/domains/pinnedPost.ts

@@ -32,6 +32,6 @@ declare global {
       pinnedAt: Date;
     };
 
-    type GlobalPinnedPostLiveCollection = Amity.LiveCollectionParams<Record<string, never>>;
+    type GlobalPinnedPostLiveCollection = Amity.LiveCollectionParams<{}>;
   }
 }

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

@@ -5,6 +5,7 @@ export const PostContentType = Object.freeze({
   VIDEO: 'video',
   LIVESTREAM: 'liveStream',
   POLL: 'poll',
+  CLIP: 'clip',
 });
 
 declare global {
@@ -82,10 +83,13 @@ declare global {
       getVideoInfo: () => Amity.File<'video'> | undefined;
       getVideoThumbnailInfo: () => Amity.File<'image'> | undefined;
       getFileInfo: () => Amity.File<'file'> | undefined;
+      getClipInfo: () => Amity.File<'clip'> | undefined;
     };
 
     type Post<T extends PostContentType = any> = Amity.InternalPost<T> & Amity.PostLinkObject;
 
+    type ClipDisplayMode = 'fill' | 'fit';
+
     type QueryPosts = {
       targetId: string;
       targetType: Amity.InternalPost['targetType'];

package/src/@types/index.ts

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

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/deleteCommunity.ts

@@ -2,6 +2,7 @@ import { getActiveClient } from '~/client/api';
 
 import { fireEvent } from '~/core/events';
 import { getCommunity } from './getCommunity';
+import { LinkedObject } from '~/utils/linkedObject';
 
 /* begin_public_function
   id: community.delete
@@ -40,6 +41,6 @@ export const deleteCommunity = async (
     users: [],
   });
 
-  return deleted.data;
+  return LinkedObject.community(deleted.data);
 };
 /* end_public_function */