@amityco/ts-sdk 0.0.1-beta.3 → 0.0.1-beta.30

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

@@ -1,60 +1,126 @@
-export {}
+/* eslint-disable camelcase */
+import { IConnectPacket, IDisconnectPacket, IPublishPacket } from 'mqtt/dist/mqtt';
+
+export {};
 
 declare global {
   namespace Amity {
-    type Listener<T = any> = (params: T) => void
-
-    type ObjectListener<T, K extends string[]> = Listener<T> | {
-      onEvent?: (event: K[number], params: T) => void
-    } & {
-      [P in K[number]]?: Listener<T>
-    }
-
-    type Unsubscriber = () => void
-
-    type Subscriber<T = any> = (fn: Amity.Listener<T>) => Unsubscriber
-
-    type Events = {
-      disconnected: string | undefined
-      'v3.user.didUpdate': Amity.UserPayload
-
-      'v3.channel.didCreate': Amity.ChannelPayload
-      'v3.channel.didUpdate': Amity.ChannelPayload
-      'v3.channel.didDelete': Amity.ChannelPayload
-      'v3.channel.didJoin': Amity.ChannelPayload
-      'v3.channel.didLeave': Amity.ChannelPayload
-      'v3.channel.didAddUsers': Amity.ChannelPayload
-      'v3.channel.didRemoveUsers': Amity.ChannelPayload
-      'v3.channel.didBan': Amity.ChannelPayload
-      'v3.channel.didUnban': Amity.ChannelPayload
-
-      'v3.message.didCreate': Amity.MessagePayload
-      'v3.message.didUpdate': Amity.MessagePayload
-      'v3.message.didDelete': Amity.MessagePayload
-
-      'video-streaming.didRecord': Amity.StreamPayload
-      'video-streaming.didStart': Amity.StreamPayload
-      'video-streaming.didStop': Amity.StreamPayload
-
-      // these events have a different shape because they're not supported
-      // by backend yet. since all is internal and wrapped in emitter,
-      // it should be fairly easy and non-breaking to refactor this if
-      // backend were to add events later on.
-      'v3.community.didCreate': Amity.CommunityPayload
-      'v3.community.didUpdate': Amity.CommunityPayload
-      'v3.community.didDelete': Amity.CommunityPayload
-      'v3.community.didJoin': Amity.CommunityPayload
-      'v3.community.didLeave': Amity.CommunityPayload
-      'v3.community.didAddUsers': Amity.CommunityPayload
-      'v3.community.didRemoveUsers': Amity.CommunityPayload
-
-      'v3.post.didCreate': Amity.PostPayload
-      'v3.post.didUpdate': Amity.PostPayload
-      'v3.post.didDelete': Amity.PostPayload
-
-      'v3.comment.didCreate': Amity.CommentPayload
-      'v3.comment.didUpdate': Amity.CommentPayload
-      'v3.comment.didDelete': Amity.CommentPayload
-    }
+    type Listener<T = any> = (params: T) => void;
+
+    type ObjectListener<T, K extends string[]> =
+      | Listener<T>
+      | ({
+          onEvent?: (event: K[number], params: T) => void;
+        } & {
+          [P in K[number]]?: Listener<T>;
+        });
+
+    type Unsubscriber = () => void;
+
+    type Subscriber<T = any> = (fn: Amity.Listener<T>) => Unsubscriber;
+
+    type WsEvents = {
+      disconnected: Amity.ErrorResponse | undefined;
+      error: Amity.ErrorResponse | undefined;
+      connect_error: Amity.ErrorResponse | undefined;
+      reconnect_error: Amity.ErrorResponse | undefined;
+      reconnect_failed: Amity.ErrorResponse | undefined;
+
+      'v3.channel.didCreate': Amity.ChannelPayload;
+      'v3.channel.didUpdate': Amity.ChannelPayload;
+      'v3.channel.didDelete': Amity.ChannelPayload;
+      'v3.channel.didJoin': Amity.ChannelPayload;
+      'v3.channel.didLeave': Amity.ChannelPayload;
+      'v3.channel.didAddUsers': Amity.ChannelMembershipPayload;
+      'v3.channel.didRemoveUsers': Amity.ChannelMembershipPayload;
+      'v3.channel.didBan': Amity.ChannelPayload;
+      'v3.channel.didUnban': Amity.ChannelPayload;
+
+      'v3.message.didCreate': Amity.MessagePayload;
+      'v3.message.didUpdate': Amity.MessagePayload;
+      'v3.message.didDelete': Amity.MessagePayload;
+
+      'video-streaming.didRecord': Amity.StreamPayload;
+      'video-streaming.didStart': Amity.StreamPayload;
+      'video-streaming.didStop': Amity.StreamPayload;
+    };
+
+    type MqttEvents = {
+      connect: IConnectPacket;
+      message: [topic: string, payload: Buffer, packet: IPublishPacket];
+      disconnect: IDisconnectPacket;
+      error: Error;
+      close: Error;
+      end: undefined;
+      reconnect: undefined;
+    };
+
+    type MqttCommunityUserMessageEvents = {
+      'community.joined': Amity.CommunityMembershipPayload;
+      'community.left': Amity.CommunityMembershipPayload;
+      'community.userAdded': Amity.CommunityMembershipPayload;
+      'community.userRemoved': Amity.CommunityMembershipPayload;
+      'community.userBanned': Amity.CommunityMembershipPayload;
+      'community.userUnbanned': Amity.CommunityMembershipPayload;
+    };
+
+    type MqttCommunityMessageEvents = {
+      'community.created': Amity.CommunityPayload;
+      'community.updated': Amity.CommunityPayload;
+      'community.deleted': Amity.CommunityPayload;
+    } & MqttCommunityUserMessageEvents;
+
+    type MqttPostMessageEvents = {
+      'post.created': Amity.PostPayload;
+      'post.updated': Amity.PostPayload;
+      'post.deleted': Amity.PostPayload;
+      'post.approved': Amity.PostPayload;
+      'post.declined': Amity.PostPayload;
+      'post.flagged': Amity.PostPayload;
+      'post.unflagged': Amity.PostPayload;
+      'post.addReaction': Amity.PostPayload & { reactor: Amity.Reaction };
+      'post.removeReaction': Amity.PostPayload & { reactor: Amity.Reaction };
+    };
+
+    type MqttCommentMessageEvents = {
+      'comment.created': Amity.CommentPayload;
+      'comment.updated': Amity.CommentPayload;
+      'comment.deleted': Amity.CommentPayload;
+      'comment.flagged': Amity.CommentPayload;
+      'comment.unflagged': Amity.CommentPayload;
+      'comment.addReaction': Amity.CommentPayload & { reactor: Amity.Reaction };
+      'comment.removeReaction': Amity.CommentPayload & { reactor: Amity.Reaction };
+    };
+
+    type MqttUserMessageEvents = {
+      'user.updated': Amity.UserPayload;
+      'user.deleted': Amity.UserPayload; // received from network topic
+      'user.flagged': Amity.UserPayload;
+      'user.unflagged': Amity.UserPayload;
+      'user.flagCleared': Amity.UserPayload;
+    };
+
+    type MqttFollowMessageEvents = {
+      'follow.created': Amity.FollowersPayload | Amity.FollowStatusPayload;
+      'follow.requested': Amity.FollowersPayload | Amity.FollowStatusPayload;
+      'follow.accepted': Amity.FollowersPayload | Amity.FollowStatusPayload;
+      'follow.unfollowed': Amity.FollowersPayload | Amity.FollowStatusPayload;
+      'follow.requestCanceled': Amity.FollowersPayload | Amity.FollowStatusPayload;
+      'follow.requestDeclined': Amity.FollowersPayload | Amity.FollowStatusPayload;
+      'follow.followerDeleted': Amity.FollowersPayload | Amity.FollowStatusPayload;
+    };
+
+    type MqttMessageEvents = MqttCommunityMessageEvents &
+      MqttPostMessageEvents &
+      MqttCommentMessageEvents &
+      MqttUserMessageEvents &
+      MqttFollowMessageEvents;
+
+    type LocalEvents = {
+      'poll.updated': Amity.PollPayload;
+      'poll.deleted': Amity.PollPayload;
+    };
+
+    type Events = WsEvents & MqttEvents & MqttMessageEvents & LocalEvents;
   }
 }

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

@@ -0,0 +1,28 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type LiveCollection<T extends any> = {
+      data: T[];
+      onNextPage: () => void;
+      hasNextPage: boolean;
+      error?: any;
+      loading: boolean;
+    };
+
+    type LiveCollectionCallback<T extends any> = Amity.Listener<LiveCollection<T>>;
+
+    type LiveCollectionConfig = {
+      policy?: Exclude<Amity.QueryPolicy, 'no_fetch'>;
+    };
+
+    type LiveCollectionParams<T extends any> = T & {
+      limit?: number;
+    };
+
+    type LiveCollectionCache<T extends any, U extends any> = Pick<
+      LiveCollection<T>,
+      'data' | 'error' | 'loading'
+    > & { params: U };
+  }
+}

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

@@ -1,4 +1,4 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
@@ -7,21 +7,29 @@ declare global {
      * @hidden
      */
     type Model = {
-      'user': Amity.User
-      'file': Amity.File
-      'role': Amity.Role
+      user: Amity.User;
+      file: Amity.File;
+      role: Amity.Role;
 
-      'channel': Amity.Channel
-      'channelUsers': Amity.Membership<'channel'>
-      'message': Amity.Message
+      channel: Amity.Channel;
+      channelUsers: Amity.Membership<'channel'>;
+      message: Amity.Message;
 
-      'community': Amity.Community
-      'communityUsers': Amity.Membership<'community'>
-      'post': Amity.Post
-      'comment': Amity.Comment
+      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
-    }
+      stream: Amity.Stream;
+
+      follow: Amity.FollowStatus;
+      followCount: Amity.FollowCount;
+    };
+
+    type Domain = keyof Model;
 
     /**
      * Definition of the minimal set of properties necessary to identify
@@ -29,23 +37,26 @@ declare global {
      * @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'>
-      'communityUsers': Pick<
-        Amity.Membership<'community'>,
-        'communityId' | 'userId'
-      >
-      'post': Pick<Amity.Post, 'postId'>
-      'comment': Pick<Amity.Comment, 'commentId'>
-
-      'stream': Pick<Amity.Stream, 'streamId'>
-    }
+      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

@@ -1,102 +1,133 @@
-export {}
+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
-      communityUser: Amity.CommunityMembershipPayload
-      post: Amity.PostPayload
-      comment: Amity.CommentPayload
-      stream: Amity.StreamPayload
-    }
+      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'>[]
-    }
+      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 CreateFilePayload<T extends Amity.FileType = any> = Amity.File<T>[];
+    type FilePayload<T extends Amity.FileType = any> = Amity.File<T>;
 
     type RolePayload = {
-      roles: Amity.Role[]
-    }
+      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 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.Channel[]
-      channelUsers: Amity.Membership<'channel'>[]
-      users?: Amity.User[]
-      files?: Amity.File[]
-    }
+      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[]
-    }
+      messages: Amity.Message<T>[];
+      users?: Amity.User[];
+      files?: Amity.File[];
+    };
 
     type StreamPayload = {
-      videoStreamings: Amity.Stream[]
-      users?: Amity.User[]
-      files?: Amity.File<'image'>[]
-    }
+      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[]
-    }
+      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[]
-    }
+      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[]
-    }
+      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.Community[]
-      communityUsers?: Amity.Membership<'community'>[]
-      categories?: Amity.Category[]
-      comments?: Amity.Comment[]
-      feeds?: Amity.Feed[]
-      users?: Amity.User[]
-      files?: Amity.File[]
-    }
+      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[]
-    }
+      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 GlobalFeedPayload = Amity.PostPayload
+    type FollowInfoPayload = FollowInfoMePayload & Amity.FollowStatusPayload;
   }
 }

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

@@ -1,4 +1,4 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
@@ -65,12 +65,10 @@ declare global {
     }
 
     type Role = {
-      roleId: string
-      displayName: string
-      permissions: Permission[]
-    }
-    & Amity.Timestamps
-    & Amity.SoftDelete
-    & Amity.Syncable
+      roleId: string;
+      displayName: string;
+      permissions: Permission[];
+    } & Amity.Timestamps &
+      Amity.SoftDelete;
   }
 }