@amityco/ts-sdk 0.0.1-003998f.0

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

@@ -0,0 +1,59 @@
+export const CommunityPostSettings = Object.freeze({
+  ONLY_ADMIN_CAN_POST: 'ONLY_ADMIN_CAN_POST',
+  ADMIN_REVIEW_POST_REQUIRED: 'ADMIN_REVIEW_POST_REQUIRED',
+  ANYONE_CAN_POST: 'ANYONE_CAN_POST',
+});
+
+export const CommunityPostSettingMaps = Object.freeze({
+  ONLY_ADMIN_CAN_POST: {
+    needApprovalOnPostCreation: false,
+    onlyAdminCanPost: true,
+  },
+  ADMIN_REVIEW_POST_REQUIRED: {
+    needApprovalOnPostCreation: true,
+    onlyAdminCanPost: false,
+  },
+  ANYONE_CAN_POST: {
+    needApprovalOnPostCreation: false,
+    onlyAdminCanPost: false,
+  },
+});
+
+export const DefaultCommunityPostSetting = 'ONLY_ADMIN_CAN_POST';
+
+declare global {
+  namespace Amity {
+    type RawCommunity = {
+      communityId: string;
+
+      displayName: string;
+      avatarFileId?: File<'image'>['fileId'];
+      description?: string;
+
+      channelId: Amity.Channel['channelId'];
+      userId: Amity.User['userId'];
+
+      isOfficial?: boolean;
+      isPublic?: boolean;
+      isJoined?: boolean;
+      onlyAdminCanPost?: boolean;
+      needApprovalOnPostCreation?: boolean;
+
+      postsCount: number;
+      membersCount: number;
+
+      categoryIds: Amity.Category['categoryId'][];
+
+      hasFlaggedComment: boolean;
+      hasFlaggedPost: boolean;
+    } & Amity.Taggable &
+      Amity.Metadata &
+      Amity.Timestamps &
+      Amity.SoftDelete &
+      Amity.Subscribable;
+
+    type Community = Omit<Amity.RawCommunity, 'onlyAdminCanPost' | 'needApprovalOnPostCreation'> & {
+      postSetting?: ValueOf<typeof CommunityPostSettings>;
+    };
+  }
+}

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

@@ -0,0 +1,79 @@
+export const ContentFeedType = Object.freeze({
+  STORY: 'story',
+  CLIP: 'clip',
+  CHAT: 'chat',
+  POST: 'post',
+  MESSAGE: 'message',
+});
+
+declare global {
+  namespace Amity {
+    type ContentType = 'text' | 'image' | 'file' | 'video' | 'poll' | 'json' | string;
+
+    type ContentFeedType = ValueOf<typeof ContentFeedType>;
+
+    type ContentDataText = {
+      text: string;
+    };
+
+    type ContentDataFile = {
+      fileId: Amity.File<'file'>['fileId'];
+    };
+
+    type ContentDataImage = {
+      fileId: Amity.File<'image'>['fileId'];
+    };
+
+    type ContentDataVideo = {
+      thumbnailFileId: Amity.File<'image'>['fileId'];
+      videoFileId: {
+        [K in Amity.VideoSize]?: Amity.File<'video'>['fileId'];
+      };
+    };
+
+    type ContentDataPoll = {
+      pollId: Amity.Poll['pollId'];
+    };
+
+    type ContentData<T extends ContentType> = T extends 'text'
+      ? ContentDataText
+      : T extends 'file'
+      ? ContentDataFile
+      : T extends 'image'
+      ? ContentDataImage
+      : T extends 'video'
+      ? ContentDataVideo
+      : T extends 'poll'
+      ? ContentDataPoll
+      : T extends 'json'
+      ? Record<string, unknown>
+      : T extends string
+      ? string | Record<string, unknown> // custom type
+      : never;
+
+    type Content<T extends ContentType, K extends 'type' | 'dataType' = 'dataType'> = {
+      [S in K]?: T;
+    } & { data: ContentData<T> };
+
+    type ContentSettingText = {
+      contentType: 'text';
+      allowed: boolean;
+    };
+
+    type ContentSettingVideo = {
+      contentType: 'video';
+      allowed: boolean;
+      maxDurationSeconds: number;
+      transcodeConfig: {
+        maxResolution: Amity.VideoResolution;
+        minResolution: Amity.VideoResolution;
+      };
+    };
+
+    type ContentSetting<T extends ContentType = 'text' | 'video'> = T extends 'text'
+      ? ContentSettingText
+      : T extends 'video'
+      ? ContentSettingVideo
+      : never;
+  }
+}

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

@@ -0,0 +1,15 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type FeedType = 'community' | 'user';
+
+    type Feed = {
+      feedId: string;
+      feedType: 'reviewing' | 'published';
+      targetType: FeedType;
+      targetId: string;
+      postCount: number;
+    } & Amity.Timestamps;
+  }
+}

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

@@ -0,0 +1,80 @@
+export const FileType = Object.freeze({
+  FILE: 'file',
+  IMAGE: 'image',
+  VIDEO: 'video',
+});
+
+export const VideoResolution = Object.freeze({
+  '1080P': '1080p',
+  '720P': '720p',
+  '480P': '480p',
+  '360P': '360p',
+  ORIGINAL: 'original',
+});
+
+export const VideoTranscodingStatus = Object.freeze({
+  UPLOADED: 'uploaded',
+  TRANSCODING: 'transcoding',
+  TRANSCODED: 'transcoded',
+  TRANSCODE_FAILED: 'transcodeFailed',
+});
+
+export const VideoSize = Object.freeze({
+  LOW: 'low',
+  MEDIUM: 'medium',
+  HIGH: 'high',
+  ORIGINAL: 'original',
+});
+
+declare global {
+  namespace Amity {
+    type FileType = ValueOf<typeof FileType>;
+
+    type VideoResolution = ValueOf<typeof VideoResolution>;
+
+    type VideoTranscodingStatus = ValueOf<typeof VideoTranscodingStatus>;
+
+    type VideoSize = ValueOf<typeof VideoSize>;
+
+    type FileMetadata = Record<string, never>;
+
+    type ImageMetadata = {
+      exif: Record<string, unknown>;
+      gps: Record<string, unknown>;
+      width: number;
+      height: number;
+      isFull: boolean;
+    };
+
+    type VideoMetadata = Record<string, never>;
+
+    type MetadataFor<T extends FileType> = T extends 'file'
+      ? FileMetadata
+      : T extends 'image'
+      ? ImageMetadata
+      : T extends 'video'
+      ? VideoMetadata
+      : never;
+
+    type VideoFileExtraPayload = {
+      feedType: Amity.ContentFeedType;
+      status: VideoTranscodingStatus;
+      videoUrl?: { [name in VideoResolution]?: string } | null;
+    };
+
+    type File<T extends FileType = any> = {
+      fileId: string;
+      type: T;
+      fileUrl: string;
+      attributes: {
+        name: string;
+        extension: string;
+        size: string;
+        mimeType: string;
+        metadata: MetadataFor<T>;
+      };
+    } & (T extends 'video' ? VideoFileExtraPayload : unknown) &
+      Amity.Timestamps &
+      Amity.SoftDelete;
+  }
+}

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

@@ -0,0 +1,53 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type FollowActionType =
+      | 'onRequested'
+      | 'onAccepted'
+      | 'onDeclined'
+      | 'onCanceled'
+      | 'onFollowed'
+      | 'onUnfollowed'
+      | 'onDeleted';
+
+    type FollowStatusType = 'all' | 'pending' | 'accepted' | 'none';
+
+    type FollowStatus = {
+      from: Amity.User['userId'];
+      to: Amity.User['userId'];
+      status: Exclude<FollowStatusType, 'all'>;
+    } & Amity.CreatedAt &
+      Amity.UpdatedAt;
+
+    type FollowCount = {
+      userId: Amity.User['userId'];
+      followerCount: number;
+      followingCount: number;
+      pendingCount: number;
+    };
+
+    type FollowInfo = {
+      status?: FollowStatus['status'];
+    } & FollowCount;
+
+    type QueryFollowers = {
+      userId: Amity.User['userId'];
+      status?: Exclude<Amity.FollowStatusType, 'none'>;
+      page?: Amity.PageRaw;
+    };
+
+    type FollowerLiveCollection = Amity.LiveCollectionParams<Omit<QueryFollowers, 'page'>>;
+
+    type FollowerLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.FollowInfo['userId'],
+      Pick<QueryFollowers, 'page'>
+    >;
+
+    type QueryFollowings = QueryFollowers;
+
+    type FollowingLiveCollection = FollowerLiveCollection;
+
+    type FollowingLiveCollectionCache = FollowerLiveCollectionCache;
+  }
+}

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

@@ -0,0 +1,36 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type GroupType = 'channel' | 'community';
+
+    type Group = {
+      membersCount: number;
+    };
+
+    type Member<T extends GroupType> = {
+      userId: Amity.User['userId'];
+    } & (T extends 'channel'
+      ? {
+          channelId: Amity.Channel['channelId'];
+          membership: 'member' | 'none' | 'banned';
+          readToSegment: number;
+          lastMentionedSegment: number;
+        }
+      : T extends 'community'
+      ? {
+          communityId: Amity.Community['communityId'];
+          communityMembership: 'member' | 'none' | 'banned';
+        }
+      : never) &
+      Amity.Timestamps;
+
+    type Membership<T extends GroupType> = {
+      isBanned: boolean;
+      isMuted: boolean;
+      muteTimeout: string;
+      lastActivity: Amity.timestamp;
+    } & Member<T> &
+      Amity.Accredited;
+  }
+}

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

@@ -0,0 +1,27 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type Mention = {
+      type: 'user' | 'channel';
+    };
+
+    type ChannelMention = Mention & {
+      type: 'channel';
+    };
+
+    type UserMention = Mention & {
+      type: 'user';
+      userIds: string[];
+    };
+
+    type MentionType = {
+      channel: ChannelMention;
+      user: UserMention;
+    };
+
+    type Mentionable<T extends keyof MentionType = 'channel' | 'user'> = {
+      mentionees?: MentionType[T][];
+    };
+  }
+}

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

@@ -0,0 +1,60 @@
+export const MessageContentType = Object.freeze({
+  TEXT: 'text',
+  IMAGE: 'image',
+  FILE: 'file',
+  VIDEO: 'video',
+  AUDIO: 'audio',
+  CUSTOM: 'custom',
+});
+
+declare global {
+  namespace Amity {
+    type MessageContentType = ValueOf<typeof MessageContentType>;
+
+    type MessageContent<T extends Amity.MessageContentType = any> = {
+      fileId: T extends 'file' | 'image' | 'video' | 'audio' ? string : null;
+    };
+
+    type MessageActionType = 'onCreate' | 'onUpdate' | 'onDelete' | 'onFetch';
+
+    type Message<T extends Amity.MessageContentType = any> = {
+      messageId: string;
+
+      channelId: Amity.Channel['channelId'];
+      userId: Amity.User['userId'];
+
+      parentId?: Message['messageId'];
+      childrenNumber: number;
+
+      channelSegment: number;
+
+      editedAt: Amity.timestamp;
+    } & Amity.Content<T, 'type'> &
+      Amity.MessageContent<T> &
+      Amity.Metadata &
+      Amity.Timestamps &
+      Amity.SoftDelete &
+      Amity.Taggable &
+      Amity.Reactable &
+      Amity.Mentionable<'user' | 'channel'> &
+      Amity.Subscribable;
+
+    type QueryMessages = {
+      channelId: Amity.Channel['channelId'];
+      type?: Amity.MessageContentType;
+      parentId?: Amity.Message['parentId'];
+      filterByParentId?: boolean;
+      isDeleted?: boolean;
+      tags?: Amity.Taggable['tags'];
+      excludeTags?: Amity.Taggable['tags'];
+      page?: Amity.Page;
+    };
+
+    type MessagesLiveCollection = Amity.LiveCollectionParams<Omit<QueryMessages, 'page'>>;
+
+    type MessageLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Message['channelId'],
+      Pick<QueryMessages, 'page'>
+    >;
+  }
+}

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

@@ -0,0 +1,56 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type timestamp = string;
+
+    type CreatedAt = {
+      createdAt: timestamp;
+    };
+
+    type UpdatedAt = {
+      updatedAt?: timestamp;
+    };
+
+    type DeletedAt = {
+      deletedAt?: timestamp;
+    };
+
+    type Timestamps = CreatedAt & UpdatedAt;
+
+    type SoftDelete = DeletedAt & {
+      isDeleted?: boolean;
+    };
+
+    type Metadata = {
+      metadata?: Record<string, any>;
+    };
+
+    type Relationship<T extends string> = {
+      referenceId: string;
+      referenceType: T;
+    };
+
+    type Flaggable = {
+      flagCount: number;
+      hashFlag: {
+        bits: number;
+        hashes: number;
+        hash: string;
+      } | null;
+    };
+
+    type Taggable = {
+      tags?: string[];
+    };
+
+    type Accredited = {
+      roles: Amity.Role['displayName'][];
+      permissions: Amity.Permission[];
+    };
+
+    type Subscribable = {
+      path: string;
+    };
+  }
+}

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

@@ -0,0 +1,32 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type PollDataType = 'text';
+
+    type PollAnswerType = 'single' | 'multiple';
+
+    type PollAnswer = {
+      id: string;
+      dataType: PollDataType;
+      data: string;
+      voteCount: number;
+      isVotedByUser: boolean;
+    };
+
+    type PollStatus = 'closed' | 'open';
+
+    type Poll = {
+      pollId: string;
+      question: string;
+      answers: PollAnswer[];
+      answerType: PollAnswerType;
+      closedAt?: Amity.timestamp;
+      closedIn?: number;
+      isVoted?: boolean;
+      status: PollStatus;
+      userId: Amity.User['userId'];
+    } & Amity.Timestamps &
+      Amity.SoftDelete;
+  }
+}

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

@@ -0,0 +1,77 @@
+export const PostContentType = Object.freeze({
+  TEXT: 'text',
+  IMAGE: 'image',
+  FILE: 'file',
+  VIDEO: 'video',
+  LIVESTREAM: 'liveStream',
+  POLL: 'poll',
+});
+
+declare global {
+  namespace Amity {
+    // bad hack until we get proper feed objects in backend
+    type PostTargetType = Amity.FeedType | 'content';
+
+    type PostContentType = ValueOf<typeof PostContentType>;
+
+    type PostActionType =
+      | 'onFetch'
+      | 'onCreate'
+      | 'onUpdate'
+      | 'onDelete'
+      | 'onApproved'
+      | 'onDeclined'
+      | 'onFlagged'
+      | 'onUnflagged'
+      | 'onReactionAdded'
+      | 'onReactionRemoved';
+
+    type Post<T extends PostContentType = any> = {
+      postId: string;
+      postedUserId: Amity.User['userId']; // API-FIX: it should be "userId"
+      parentId: Post['postId'];
+      targetType: PostTargetType;
+      targetId: string;
+      feedId: Amity.Feed['feedId'];
+      children: Amity.Post['postId'][];
+      comments: Amity.Comment['commentId'][];
+      commentsCount: number; // API-FIX: backend doesnt follow its own convention
+      hasFlaggedChildren: false;
+      hasFlaggedComment: false;
+      editedAt: Amity.timestamp;
+    } & Amity.Content<T, 'dataType'> &
+      Amity.Metadata &
+      Amity.Flaggable &
+      Amity.Reactable &
+      Amity.Taggable &
+      Amity.Timestamps &
+      Amity.SoftDelete &
+      Amity.Subscribable &
+      Amity.Mentionable<'user'>;
+
+    type QueryPosts = {
+      targetId: string;
+      targetType: Amity.Post['targetType'];
+      sortBy?: 'lastCreated' | 'firstCreated' | 'lastUpdated' | 'firstUpdated';
+      dataType?: Exclude<Amity.PostContentType, 'text'>;
+      isDeleted?: Amity.Post['isDeleted'];
+      hasFlag?: boolean;
+      feedType?: 'reviewing' | 'published';
+      tags?: Amity.Taggable['tags'];
+      matchingOnlyParentPost?: boolean;
+      page?: Amity.PageRaw;
+    };
+
+    // Omit sortBy explained in asc-3398
+    type PostLiveCollection = Amity.LiveCollectionParams<
+      Omit<QueryPosts, 'sortBy' | 'page'> & {
+        sortBy?: 'lastCreated' | 'firstCreated';
+      }
+    >;
+
+    type PostLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Post['postId'],
+      Pick<QueryPosts, 'page'>
+    >;
+  }
+}

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

@@ -0,0 +1,46 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type ReactableType = 'message' | 'post' | 'comment';
+
+    type ReactionActionType = 'onAdded' | 'onRemoved';
+
+    type Reactor = {
+      reactionId: string;
+      reactionName: string;
+      userId: Amity.User['userId'];
+    } & Amity.CreatedAt;
+
+    type Reaction = Amity.Reactor & Amity.Relationship<ReactableType>;
+
+    type Reactable = {
+      reactionsCount: number;
+      reactions: Record<string, number>;
+      myReactions?: string[];
+
+      latestReaction?: Amity.Reaction & {
+        eventName: 'add' | 'remove';
+        userDisplayName: string;
+      };
+    };
+
+    type ReactionQuery = {
+      reactors: Reactor[];
+    } & Amity.Relationship<ReactableType>;
+
+    type QueryReactions = {
+      referenceId: Amity.Reaction['referenceId'];
+      referenceType: Amity.Reaction['referenceType'];
+      reactionName?: Amity.Reaction['reactionName'];
+      page?: Amity.Page<string>;
+    };
+
+    type ReactionLiveCollection = Amity.LiveCollectionParams<Omit<QueryReactions, 'page'>>;
+
+    type ReactionLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Reactor['reactionId'],
+      Pick<QueryReactions, 'page'>
+    >;
+  }
+}

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

@@ -0,0 +1,67 @@
+export {};
+
+declare global {
+  namespace Amity {
+    const enum StreamStatus {
+      IDLE = 'idle',
+      LIVE = 'live',
+      ENDED = 'ended',
+      RECORDED = 'recorded',
+    }
+
+    const enum StreamResolution {
+      SD = 'SD',
+      HD = 'HD',
+      FHD = 'FHD',
+    }
+
+    type MultiFormat<T> = {
+      flv?: T;
+      mp4?: T;
+      m3u8?: T;
+    };
+
+    type StreamPlatform = {
+      name: string;
+      version: string;
+    };
+
+    type StreamEndpoint = {
+      url: string;
+      components: {
+        origin: string;
+        appName: string;
+        streamName: string;
+        query: string;
+      };
+    };
+
+    type StreamRecording = {
+      url: string;
+      duration: number;
+      startTime: number;
+      stopTime: number;
+    };
+
+    type Stream = {
+      streamId: string;
+      title: string;
+      thumbnailFileId?: Amity.File<'image'>['fileId'];
+      description?: string;
+      status: StreamStatus;
+      platform: StreamPlatform;
+
+      isLive?: boolean;
+      endedAt: Amity.timestamp;
+      startedAt: Amity.timestamp;
+      userId: Amity.User['userId'];
+      resolution: StreamResolution;
+
+      streamerUrl: StreamEndpoint;
+      watcherUrl: MultiFormat<StreamEndpoint>;
+      recordings: MultiFormat<StreamRecording>[];
+    } & Amity.Metadata &
+      Amity.Timestamps &
+      Amity.SoftDelete;
+  }
+}