@amityco/ts-sdk 0.0.1-beta.2 → 0.0.1-beta.22

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

@@ -0,0 +1,128 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type Payloads = {
+      user: Amity.UserPayload;
+      file: Amity.FilePayload;
+      role: Amity.RolePayload;
+      channel: Amity.ChannelPayload;
+      channelUser: Amity.ChannelMembershipPayload;
+      message: Amity.MessagePayload;
+      community: Amity.CommunityPayload;
+      category: Amity.CategoryPayload;
+      communityUser: Amity.CommunityMembershipPayload;
+      post: Amity.PostPayload;
+      comment: Amity.CommentPayload;
+      poll: Amity.PollPayload;
+      stream: Amity.StreamPayload;
+      reaction: Amity.ReactionPayload;
+    };
+
+    type UserPayload = {
+      users: Amity.User[];
+      files: Amity.File<'image'>[];
+    };
+
+    // API-FIX: backend should return a payload like { files: Amity.File<T>[] }
+    type CreateFilePayload<T extends Amity.FileType = any> = Amity.File<T>[];
+    type FilePayload<T extends Amity.FileType = any> = Amity.File<T>;
+
+    type RolePayload = {
+      roles: Amity.Role[];
+    };
+
+    type ChannelPayload<T extends Amity.ChannelType = any> = {
+      channels: Amity.Channel<T>[];
+      channelUsers?: Amity.Membership<'channel'>[];
+      users?: Amity.User[];
+      files?: Amity.File[];
+    };
+
+    type ChannelMembershipPayload = {
+      channels: Amity.Channel[];
+      channelUsers: Amity.Membership<'channel'>[];
+      users?: Amity.User[];
+      files?: Amity.File[];
+    };
+
+    type MessagePayload<T extends Amity.MessageContentType = any> = {
+      messages: Amity.Message<T>[];
+      users?: Amity.User[];
+      files?: Amity.File[];
+    };
+
+    type StreamPayload = {
+      videoStreamings: Amity.Stream[];
+      users?: Amity.User[];
+      files?: Amity.File<'image'>[];
+    };
+
+    type CommunityPayload = {
+      communities: Amity.Community[];
+      communityUsers?: Amity.Membership<'community'>[];
+      categories?: Amity.Category[];
+      feeds?: Amity.Feed[];
+      users?: Amity.User[];
+      files?: Amity.File[];
+    };
+
+    type CategoryPayload = {
+      categories: Amity.Category[];
+      files: Amity.File[];
+    };
+
+    type CommunityMembershipPayload = {
+      communities: Amity.Community[];
+      communityUsers: Amity.Membership<'community'>[];
+      categories?: Amity.Category[];
+      feeds?: Amity.Feed[];
+      users: Amity.User[];
+      files?: Amity.File[];
+    };
+
+    type PostPayload<T extends Amity.PostContentType = any> = {
+      posts: Amity.Post<T>[];
+      postChildren?: Amity.Post[];
+      communities?: Amity.Community[];
+      communityUsers?: Amity.Membership<'community'>[];
+      categories?: Amity.Category[];
+      comments?: Amity.Comment[];
+      feeds?: Amity.Feed[];
+      users?: Amity.User[];
+      files?: Amity.File[];
+    };
+
+    type CommentPayload<T extends Amity.CommentContentType = any> = {
+      comments: Amity.Comment<T>[];
+      commentChildren?: Amity.Comment[];
+      users?: Amity.User[];
+      files?: Amity.File[];
+    };
+
+    type PollPayload = {
+      users: Amity.User[];
+      polls: Amity.Poll[];
+    };
+
+    type ReactionPayload = {
+      reactions: Amity.ReactionQuery[];
+      users: Pick<Amity.User, 'userId' | 'displayName' | 'metadata'>[];
+    };
+
+    type GlobalFeedPayload = Amity.PostPayload;
+
+    type FollowersPayload = {
+      follows: Amity.FollowStatus[];
+    } & UserPayload;
+
+    type FollowStatusPayload = {
+      follows: Amity.FollowStatus[];
+    };
+
+    type FollowInfoPayload = {
+      follows: Amity.FollowStatus[];
+      followCounts: Amity.FollowCount[];
+    };
+  }
+}

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

@@ -0,0 +1,74 @@
+export {};
+
+declare global {
+  namespace Amity {
+    const enum Permission {
+      EditUserPermission = 'EDIT_USER',
+      BanUserPermission = 'BAN_USER',
+      CreateRolePermission = 'CREATE_ROLE',
+      EditRolePermission = 'EDIT_ROLE',
+      DeleteRolePermission = 'DELETE_ROLE',
+      AssignRolePermission = 'ASSIGN_USER_ROLE',
+      EditChannelPermission = 'EDIT_CHANNEL',
+      EditChannelRatelimitPermission = 'EDIT_CHANNEL_RATELIMIT',
+      MuteChannelPermission = 'MUTE_CHANNEL',
+      CloseChannelPermission = 'CLOSE_CHANNEL',
+      AddChannelUserPermission = 'ADD_CHANNEL_USER',
+      EditChannelUserPermission = 'EDIT_CHANNEL_USER',
+      RemoveChannelUserPermission = 'REMOVE_CHANNEL_USER',
+      MuteChannelUserPermission = 'MUTE_CHANNEL_USER',
+      BanChannelUserPermission = 'BAN_CHANNEL_USER',
+      EditMessagePermission = 'EDIT_MESSAGE',
+      DeleteMessagePermission = 'DELETE_MESSAGE',
+      EditCommunityPermission = 'EDIT_COMMUNITY',
+      DeleteCommunityPermission = 'DELETE_COMMUNITY',
+      AddChannelCommunityPermission = 'ADD_COMMUNITY_USER',
+      EditChannelCommunityPermission = 'EDIT_COMMUNITY_USER',
+      RemoveChannelCommunityPermission = 'REMOVE_COMMUNITY_USER',
+      MuteChannelCommunityPermission = 'MUTE_COMMUNITY_USER',
+      BanChannelCommunityPermission = 'BAN_COMMUNITY_USER',
+      EditUserFeedPostPermission = 'EDIT_USER_FEED_POST',
+      DeleteUserFeedPostPermission = 'DELETE_USER_FEED_POST',
+      EditUserFeedCommentPermission = 'EDIT_USER_FEED_COMMENT',
+      DeleteUserFeedCommentPermission = 'DELETE_USER_FEED_COMMENT',
+      EditCommunityFeedPostPermission = 'EDIT_COMMUNITY_FEED_POST',
+      DeleteCommunityFeedPostPermission = 'DELETE_COMMUNITY_FEED_POST',
+      EditCommunityFeedCommentPermission = 'EDIT_COMMUNITY_FEED_COMMENT',
+      DeleteCommunityFeedCommentPermission = 'DELETE_COMMUNITY_FEED_COMMENT',
+      CreateCommunityCategoryPermission = 'CREATE_COMMUNITY_CATEGORY',
+      EditCommunityCategoryPermission = 'EDIT_COMMUNITY_CATEGORY',
+      DeleteCommunityCategoryPermission = 'DELETE_COMMUNITY_CATEGORY',
+    }
+
+    const enum PermissionLegacy {
+      ModeratorRoleLegacy = 'moderator',
+      SuperModeratorRoleLegacy = 'super-moderator',
+      GlobalAdminRoleLegacy = 'global-admin',
+      BanUserPermissionLegacy = 'Channel/BanUser',
+      MuteUserPermissionLegacy = 'Channel/MuteUser',
+      MuteChannelPermissionLegacy = 'Channel/MuteChannel',
+      RateLimitUserPermissionLegacy = 'Channel/RateLimitUser',
+      RateLimitChannelPermissionLegacy = 'Channel/RateLimitChannel',
+      ManageMessagesPermissionLegacy = 'Channel/ManageMessages',
+      ManageUsersPermissionLegacy = 'Channel/ManageUsers',
+      GlobalAccessPermissionLegacy = 'Channel/GlobalAccess',
+      ExemptFromFiltersPermissionLegacy = 'User/ExemptFromFilters',
+      ExemptFromRateLimitsPermissionLegacy = 'User/ExemptFromRateLimits',
+      ExemptFromMutePermissionLegacy = 'User/ExemptFromMute',
+      ExemptFromBanPermissionLegacy = 'User/ExempFromBan',
+      ExemptFromWhitelistPermissionLegacy = 'User/ExempFromWhitelist',
+      ExemptFromBlacklistPermissionLegacy = 'User/ExempFromBlacklist',
+      ExemptFromRepetitionCheckPermissionLegacy = 'User/ExempFromRepetitionCheck',
+      ManagePostsPermissionLegacy = 'Post/ManagePosts',
+      ManageCommentsPermissionLegacy = 'Post/ManageComments',
+      ManageCommunitiesPermissionLegacy = 'Community/ManageCommunities',
+    }
+
+    type Role = {
+      roleId: string;
+      displayName: string;
+      permissions: Permission[];
+    } & Amity.Timestamps &
+      Amity.SoftDelete;
+  }
+}

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

@@ -0,0 +1,63 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type Cachable = {
+      cachedAt: number;
+    };
+
+    type Local = {
+      cachedAt: -1;
+    };
+
+    type AsyncFunc<Args extends any[], Returned extends any> = {
+      (...args: Args): Promise<Returned>;
+    };
+
+    type FetcherFunc<Args extends any[], Returned extends any> = {
+      (...args: Args): Promise<Returned>;
+      locally: (...args: Args) => Returned | undefined;
+    };
+
+    type MutatorFunc<Args extends any[], Returned extends any> = {
+      (...args: Args): Promise<Returned>;
+      optimistically: (...args: Args) => Returned | undefined;
+    };
+
+    type OfflineFunc<Args extends any[], Returned extends any> =
+      | FetcherFunc<Args, Returned>
+      | MutatorFunc<Args, Returned>;
+
+    type Query<Args extends any[], Returned extends any> = {
+      func: AsyncFunc<Args, Returned> | OfflineFunc<Args, Returned>;
+      args: Args;
+    };
+
+    type QueryPolicy = 'server_only' | 'cache_only' | 'cache_then_server' | 'no_fetch';
+
+    type QueryOptions = {
+      lifeSpan: number;
+    };
+
+    type SnapshotOptions = {
+      origin: 'local' | 'server' | 'event';
+      loading: boolean;
+      error?: any;
+    };
+
+    type Snapshot<T> = (T extends Amity.Cached<infer T2>
+      ? T2 extends Amity.Paged<infer T3, infer T4>
+        ? { data: T3[] | undefined } & Amity.Pages<T4> & {
+              cachedAt?: Amity.CacheOptions['cachedAt'];
+            }
+        : { data: T2 } & { cachedAt?: Amity.CacheOptions['cachedAt'] }
+      : T extends Amity.Paged<infer T3, infer T4>
+      ? { data: T3[] | undefined } & Amity.Pages<T4>
+      : { data: T | undefined }) &
+      SnapshotOptions;
+
+    type RunQueryOptions<T> = T extends Amity.AsyncFunc<infer Args, infer Returned>
+      ? Omit<Amity.Snapshot<Returned>, 'data'>
+      : never;
+  }
+}

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

@@ -0,0 +1,55 @@
+import { ASCError } from '~/core/errors';
+
+export {};
+
+declare global {
+  namespace Amity {
+    type SuccessResponse<T> = {
+      status: 'success';
+      data: T;
+    };
+
+    type FailResponse = {
+      status: 'fail';
+      code: Amity.ServerError;
+    };
+
+    type ErrorResponse = {
+      status: 'error';
+      message: string;
+      code: Amity.ServerError;
+    };
+
+    type Response<T> = SuccessResponse<T> | FailResponse | ErrorResponse;
+
+    type Token = string;
+
+    type Pagination = {
+      paging: {
+        previous?: Token;
+        next?: Token;
+      };
+    };
+
+    type MqttClient = {
+      connect: (params: { accessToken: string; userId: string }) => Promise<void>;
+      disconnect: () => Promise<void>;
+      get connected(): boolean;
+      on: <T extends keyof Amity.MqttEvents>(
+        event: T,
+        handler: (payload: Amity.MqttEvents[T]) => void,
+      ) => void;
+      once: <T extends keyof Amity.MqttEvents>(
+        event: T,
+        handler: (payload: Amity.MqttEvents[T]) => void,
+      ) => void;
+      off: <T extends keyof Amity.MqttEvents>(
+        event: T,
+        handler?: (payload: Amity.MqttEvents[T]) => void,
+      ) => void;
+      removeAllListeners: () => void;
+      subscribe: (topic: string, callback?: Amity.Listener<ASCError | void>) => Amity.Unsubscriber;
+      unsubscribe: (topic: string) => void;
+    };
+  }
+}

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

@@ -0,0 +1,13 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type Category = {
+      categoryId: string;
+      name: string;
+      avatarFileId?: Amity.File<'image'>['fileId'];
+    } & Amity.Metadata &
+      Amity.Timestamps &
+      Amity.SoftDelete;
+  }
+}

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

@@ -0,0 +1,36 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type ChannelType = 'standard' | 'live' | 'conversation' | 'broadcast';
+
+    type Channel<T extends ChannelType = any> = {
+      channelId: string;
+      displayName?: string;
+      avatarFileId?: File<'image'>['fileId'];
+      description?: string;
+      type: T;
+
+      isDistinct?: boolean;
+
+      isMuted?: boolean;
+      muteTimeout?: string;
+
+      isRateLimited?: boolean;
+      rateLimit?: number;
+      rateLimitWindow?: number;
+      rateLimitTimeout?: number;
+
+      messageAutoDeleteEnabled?: boolean;
+      autoDeleteMessageByFlagLimit?: number;
+
+      memberCount?: number;
+      messageCount?: number;
+
+      lastActivity?: Amity.timestamp;
+    } & Amity.Metadata &
+      Amity.Taggable &
+      Amity.Timestamps &
+      Amity.SoftDelete;
+  }
+}

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

@@ -0,0 +1,40 @@
+import { AxiosInstance } from 'axios';
+import { Emitter } from 'mitt';
+
+declare global {
+  namespace Amity {
+    type Logger = (topic: string, ...args: any[]) => void;
+
+    type Client = {
+      version: string;
+
+      log: Logger;
+      http: AxiosInstance;
+      mqtt: Amity.MqttClient;
+      ws: SocketIOClient.Socket;
+      emitter: Emitter<Amity.Events>;
+
+      cache?: Amity.Cache;
+
+      apiKey?: string;
+      userId?: string;
+      accessToken?: string;
+
+      use: () => void;
+    };
+
+    type Device = {
+      deviceId: string;
+      deviceInfo: {
+        version: string;
+        kind: 'node' | 'web';
+        model?: string;
+      };
+    };
+
+    type Tokens = {
+      accessToken: string;
+      refreshToken: string;
+    };
+  }
+}

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

@@ -0,0 +1,27 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type CommentContentType = 'text';
+    type CommentReferenceType = 'content' | 'post';
+
+    type Comment<T extends CommentContentType = any> = {
+      commentId: string;
+      userId: string;
+      parentId?: Comment['commentId'];
+      rootId: Comment['commentId'];
+      childrenNumber: number;
+      children: Comment['commentId'][];
+      segmentNumber: number;
+      editedAt: Amity.timestamp;
+    } & Amity.Relationship<CommentReferenceType> &
+      Amity.Content<T> &
+      Amity.Metadata &
+      Amity.Flaggable &
+      Amity.Reactable &
+      Amity.Timestamps &
+      Amity.SoftDelete &
+      Amity.Subscribable &
+      Amity.Mentionable<'user'>;
+  }
+}

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

@@ -0,0 +1,34 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type Community = {
+      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;
+  }
+}

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

@@ -0,0 +1,47 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type ContentType = 'text' | 'image' | 'file' | 'video' | 'poll' | 'json' | string;
+
+    type ContentDataText = {
+      text: string;
+    };
+
+    type ContentDataFile = {
+      fileId: Amity.File<'file'>['fileId'];
+    };
+
+    type ContentDataImage = {
+      imageId: Amity.File<'image'>['fileId'];
+    };
+
+    type ContentDataVideo = {
+      videoId: Amity.File<'file'>['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> };
+  }
+}

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,41 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type FileType = 'file' | 'image' | 'video';
+
+    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 File<T extends FileType = any> = {
+      fileId: string;
+      type: T;
+      fileUrl: string;
+      attributes: {
+        name: string;
+        extension: string;
+        size: string;
+        mimeType: string;
+        metadata: MetadataFor<T>;
+      };
+    } & Amity.Timestamps &
+      Amity.SoftDelete;
+  }
+}

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

@@ -0,0 +1,23 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type FollowStatus = {
+      from: Amity.User['userId'];
+      to: Amity.User['userId'];
+      status: 'pending' | 'accepted' | 'none';
+    } & Amity.CreatedAt &
+      Amity.UpdatedAt;
+
+    type FollowCount = {
+      userId: Amity.User['userId'];
+      followerCount: number;
+      followingCount: number;
+      pendingCount: number;
+    };
+
+    type FollowInfo = {
+      status?: FollowStatus['status'];
+    } & FollowCount;
+  }
+}

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

@@ -0,0 +1,35 @@
+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;
+        }
+      : 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][];
+    };
+  }
+}