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

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

@@ -0,0 +1,62 @@
+export {};
+
+declare global {
+  namespace Amity {
+    /**
+     * type map of "domain name -> ASC model"
+     * @hidden
+     */
+    type Model = {
+      user: Amity.User;
+      file: Amity.File;
+      role: Amity.Role;
+
+      channel: Amity.Channel;
+      channelUsers: Amity.Membership<'channel'>;
+      message: Amity.Message;
+
+      community: Amity.Community;
+      category: Amity.Category;
+      communityUsers: Amity.Membership<'community'>;
+      post: Amity.Post;
+      comment: Amity.Comment;
+      poll: Amity.Poll;
+      reaction: Amity.Reaction;
+
+      stream: Amity.Stream;
+
+      follow: Amity.FollowStatus;
+      followCount: Amity.FollowCount;
+    };
+
+    type Domain = keyof Model;
+
+    /**
+     * Definition of the minimal set of properties necessary to identify
+     * successfully a model.
+     * @hidden
+     */
+    type Minimal = {
+      user: Pick<Amity.User, 'userId'>;
+      file: Pick<Amity.File, 'fileId'>;
+      role: Pick<Amity.Role, 'roleId'>;
+
+      channel: Pick<Amity.Channel, 'channelId'>;
+      channelUsers: Pick<Amity.Membership<'channel'>, 'channelId' | 'userId'>;
+      message: Pick<Amity.Message, 'messageId'>;
+
+      community: Pick<Amity.Community, 'communityId'>;
+      category: Pick<Amity.Category, 'categoryId'>;
+      communityUsers: Pick<Amity.Membership<'community'>, 'communityId' | 'userId'>;
+      post: Pick<Amity.Post, 'postId'>;
+      comment: Pick<Amity.Comment, 'commentId'>;
+      poll: Pick<Amity.Poll, 'pollId'>;
+      reaction: Pick<Amity.Reaction, 'reactionId'>;
+
+      stream: Pick<Amity.Stream, 'streamId'>;
+
+      follow: Pick<Amity.FollowStatus, 'from' | 'to'>;
+      followCount: Pick<Amity.FollowCount, 'userId'>;
+    };
+  }
+}

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

@@ -0,0 +1,60 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type PaginationStyles = 'skiplimit' | 'afterbefore' | 'afterbeforeraw';
+
+    type PageLimit = {
+      limit: number;
+    };
+
+    type PrevPage<T extends number | string> = PageLimit & {
+      after?: never;
+      before?: T;
+    };
+
+    type NextPage<T extends number | string> = PageLimit & {
+      after?: T;
+      before?: never;
+    };
+
+    type Page<T extends number | string = number> = PrevPage<T> | NextPage<T>;
+
+    /*
+      updatedAt is here because if you need sort by updatedAt you
+      need to include this data in query also
+    */
+    type PageRaw = (PrevPage<string> | NextPage<string>) & {
+      updatedAt?: string;
+    };
+
+    type SkipLimitPagination = {
+      skip?: number;
+      limit?: number;
+    };
+
+    /*
+      WARNING:
+      in traditional "before/after" pagination, 'before' and 'after'
+      normally should be strings representing the unique id of the
+      resource. for some reason, our backend uses a number instead,
+      bound to "channelSegment" (for message) and "segmentNumber" (
+      for comments). so we have to cast this as number.
+    */
+    type AfterBeforePagination = {
+      before?: number;
+      after?: number;
+      first?: number;
+      last?: number;
+    };
+
+    type AfterBeforeRawPagination = PageRaw;
+
+    type Pages<T extends Page | PageRaw> = {
+      nextPage?: T;
+      prevPage?: T;
+    };
+
+    type Paged<T, K extends Page | PageRaw = Page> = { data: T[] } & Pages<K>;
+  }
+}

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

@@ -0,0 +1,133 @@
+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'>[];
+    };
+
+    type FeedSettingPayload = {
+      feedSettings: {
+        contentSettings: Amity.ContentSetting[];
+        feedType: Amity.ContentFeedType;
+      }[];
+    };
+
+    // 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,
+      U extends Amity.Channel<T> | Amity.ChannelRaw<T> = Amity.ChannelRaw<T>,
+    > = {
+      channels: U[];
+      channelUsers: Amity.Membership<'channel'>[];
+    } & Amity.UserPayload;
+
+    type ChannelMembershipPayload = {
+      channels: Amity.ChannelRaw[];
+      channelUsers: Amity.Membership<'channel'>[];
+    } & Amity.UserPayload;
+
+    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.RawCommunity[];
+      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.RawCommunity[];
+      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.RawCommunity[];
+      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 FollowStatusPayload = {
+      follows: Amity.FollowStatus[];
+    };
+
+    type FollowInfoMePayload = {
+      followCounts: Amity.FollowCount[];
+    };
+
+    type FollowersPayload = Amity.FollowStatusPayload & UserPayload;
+
+    type FollowInfoPayload = FollowInfoMePayload & Amity.FollowStatusPayload;
+  }
+}

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 = '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,95 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type ChannelType = 'broadcast' | 'conversation' | 'community' | 'live';
+
+    type ChannelMemberActionType =
+      | 'onMemberAdded'
+      | 'onMemberRemoved'
+      | 'onChannelMemberBanned'
+      | 'onChannelMemberUnbanned';
+
+    type ChannelActionType =
+      | 'onFetch'
+      | 'onCreate'
+      | 'onUpdate'
+      | 'onDelete'
+      | 'onJoin'
+      | 'onLeft'
+      | 'onMute'
+      | 'onMemberAdded'
+      | 'onMemberRemoved';
+
+    type Channel<T extends ChannelType = any> = {
+      channelId: string;
+      displayName?: string;
+      avatarFileId?: Amity.File<'image'>['fileId'];
+      type: T;
+
+      isDistinct?: boolean;
+
+      isMuted?: boolean;
+      muteTimeout?: string;
+
+      isRateLimited?: boolean;
+      rateLimit?: number;
+      rateLimitWindow?: number;
+      rateLimitTimeout?: number;
+
+      messageAutoDeleteEnabled?: boolean;
+      autoDeleteMessageByFlagLimit?: number;
+
+      memberCount?: number;
+      messageCount?: number;
+      moderatorMemberCount?: number;
+
+      lastActivity?: Amity.timestamp;
+
+      unreadCount: number;
+      hasMention: boolean;
+    } & Amity.Metadata &
+      Amity.Taggable &
+      Amity.Timestamps &
+      Amity.SoftDelete &
+      Amity.Subscribable;
+
+    type ChannelRaw<T extends ChannelType = any> = Omit<Channel<T>, 'unreadCount' | 'hasMention'>;
+
+    type QueryChannels = {
+      displayName?: string;
+      membership?: 'all' | 'member' | 'notMember';
+      sortBy?: 'displayName' | 'firstCreated' | 'lastCreated';
+      types?: Amity.ChannelType[];
+      isDeleted?: Amity.Channel['isDeleted'];
+      tags?: Amity.Taggable['tags'];
+      excludeTags?: Amity.Taggable['tags'];
+      page?: Amity.Page;
+    };
+
+    type ChannelLiveCollection = Amity.LiveCollectionParams<Omit<QueryChannels, 'page'>>;
+
+    type ChannelLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Channel['channelId'],
+      Pick<QueryChannels, 'page'>
+    >;
+
+    type QueryChannelMembers = {
+      channelId: Amity.Channel['channelId'];
+      memberships?: Array<Exclude<Amity.Membership<'channel'>['membership'], 'none'> | 'muted'>;
+      roles?: string[];
+      sortBy?: 'firstCreated' | 'lastCreated';
+      search?: string;
+      page?: Amity.Page;
+    };
+
+    type ChannelMembersLiveCollection = Amity.LiveCollectionParams<
+      Omit<QueryChannelMembers, 'page'>
+    >;
+
+    type ChannelMembersLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Membership<'channel'>['userId'],
+      Pick<QueryChannelMembers, 'page'>
+    >;
+  }
+}

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

@@ -0,0 +1,78 @@
+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;
+
+      getFeedSettings: () => Promise<Amity.FeedSettings>;
+    };
+
+    type Device = {
+      deviceId: string;
+      deviceInfo: {
+        version: string;
+        kind: 'node' | 'web';
+        model?: string;
+      };
+    };
+
+    type Tokens = {
+      accessToken: string;
+      refreshToken: string;
+    };
+
+    type ChatSettings = {
+      enabled: boolean;
+      mention: {
+        isAllowMentionedChannelEnabled: boolean;
+      };
+    };
+
+    type FeedSettings = {
+      [name in Amity.ContentFeedType]?: Amity.ContentSetting[];
+    };
+
+    type SocialSettings = {
+      enabled: boolean;
+      isAllowEditPostWhenReviewingEnabled: boolean;
+      isFollowWithRequestEnabled: boolean;
+      globalFeed: {
+        showCommunityPost: boolean;
+        showEveryonePost: boolean;
+        showFollowingPost: boolean;
+        showMyPost: boolean;
+        showOnlyMyFeed: boolean;
+      };
+      userPrivacySetting: 'public' | 'private ';
+    };
+
+    type ConnectClientParams = {
+      userId: Amity.User['userId'];
+      displayName?: Amity.User['displayName'];
+      authToken?: string;
+      deviceId?: Amity.Device['deviceId'];
+    };
+
+    type ConnectClientConfig = {
+      disableRTE: boolean;
+    };
+  }
+}

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

@@ -0,0 +1,58 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type CommentContentType = 'text';
+    type CommentReferenceType = 'content' | 'post';
+
+    type CommentActionType =
+      | 'onFetch'
+      | 'onCreate'
+      | 'onUpdate'
+      | 'onDelete'
+      | 'onFlagged'
+      | 'onUnflagged'
+      | 'onReactionAdded'
+      | 'onReactionRemoved';
+
+    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'>;
+
+    type QueryComments = {
+      referenceType: Amity.Comment['referenceType'];
+      referenceId: Amity.Comment['referenceId'];
+      sortBy?: 'lastCreated' | 'firstCreated' | 'lastUpdated' | 'firstUpdated';
+      parentId?: Amity.Comment['commentId'] | null;
+      hasFlag?: boolean;
+      isDeleted?: Amity.Comment['isDeleted'];
+      page?: Amity.Page;
+    };
+
+    type CommentLiveCollection = Amity.LiveCollectionParams<
+      Omit<QueryComments, 'sortBy' | 'page'> & {
+        sortBy?: 'lastCreated' | 'firstCreated';
+      }
+    >;
+
+    type CommentLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Comment['commentId'],
+      Pick<QueryComments, 'page'>
+    >;
+  }
+}