@amityco/ts-sdk 0.0.1-beta.16 → 0.0.1-beta.19

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

@@ -1,32 +1,34 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
-    type Domain = keyof Model
-
     /**
      * type map of "domain name -> ASC model"
      * @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;
+      category: Amity.Category;
+      communityUsers: Amity.Membership<'community'>;
+      post: Amity.Post;
+      comment: Amity.Comment;
+      poll: Amity.Poll;
 
-      'community': Amity.Community
-      'communityUsers': Amity.Membership<'community'>
-      'post': Amity.Post
-      'comment': Amity.Comment
+      stream: Amity.Stream;
 
-      'stream': Amity.Stream
+      follow: Amity.FollowStatus;
+      followCount: Amity.FollowCount;
+    };
 
-      'follow': Amity.FollowStatus
-      'followCount': Amity.FollowCount
-    }
+    type Domain = keyof Model;
 
     /**
      * Definition of the minimal set of properties necessary to identify
@@ -34,26 +36,25 @@ 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'>
-
-      'follow': Pick<Amity.FollowStatus, 'from' | 'to'>
-      'followCount': Pick<Amity.FollowCount, 'userId'>
-    }
+      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'>;
+
+      stream: Pick<Amity.Stream, 'streamId'>;
+
+      follow: Pick<Amity.FollowStatus, 'from' | 'to'>;
+      followCount: Pick<Amity.FollowCount, 'userId'>;
+    };
   }
 }

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

@@ -1,37 +1,37 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
-    type PaginationStyles = 'skiplimit' | 'afterbefore' | 'afterbeforeraw'
+    type PaginationStyles = 'skiplimit' | 'afterbefore' | 'afterbeforeraw';
 
     type PageLimit = {
-      limit: number
-    }
+      limit: number;
+    };
 
     type PrevPage<T extends number | string> = PageLimit & {
-      after?: never
-      before?: T
-    }
+      after?: never;
+      before?: T;
+    };
 
     type NextPage<T extends number | string> = PageLimit & {
-      after?: T
-      before?: never
-    }
+      after?: T;
+      before?: never;
+    };
 
-    type Page = PrevPage<number> | NextPage<number>
+    type Page = PrevPage<number> | NextPage<number>;
 
     /*
       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
-    }
+      updatedAt?: string;
+    };
 
     type SkipLimitPagination = {
-      skip?: number
-      limit?: number
-    }
+      skip?: number;
+      limit?: number;
+    };
 
     /*
       WARNING:
@@ -42,19 +42,19 @@ declare global {
       for comments). so we have to cast this as number.
     */
     type AfterBeforePagination = {
-      before?: number
-      after?: number
-      first?: number
-      last?: number
-    }
+      before?: number;
+      after?: number;
+      first?: number;
+      last?: number;
+    };
 
-    type AfterBeforeRawPagination = PageRaw
+    type AfterBeforeRawPagination = PageRaw;
 
-    type Pages<T extends (Page | PageRaw)> = {
-      nextPage?: T
-      prevPage?: T
-    }
+    type Pages<T extends Page | PageRaw> = {
+      nextPage?: T;
+      prevPage?: T;
+    };
 
-    type Paged<T, K extends (Page | PageRaw) = Page> = { data: T[] } & Pages<K>
+    type Paged<T, K extends Page | PageRaw = Page> = { data: T[] } & Pages<K>;
   }
 }

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

@@ -1,116 +1,122 @@
-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;
+    };
 
     type UserPayload = {
-      users: Amity.User[]
-      files: Amity.File<'image'>[]
-    }
+      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 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[]
-    }
+      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[]
-    }
+      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[]
-    }
+      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.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[]
-    }
+      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.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[]
-    }
+      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[]
-    }
+      comments: Amity.Comment<T>[];
+      commentChildren?: Amity.Comment[];
+      users?: Amity.User[];
+      files?: Amity.File[];
+    };
 
-    type GlobalFeedPayload = Amity.PostPayload
+    type PollPayload = {
+      users: Amity.User[];
+      polls: Amity.Poll[];
+    };
+
+    type GlobalFeedPayload = Amity.PostPayload;
 
     type FollowersPayload = {
-      follows: Amity.FollowStatus[]
-    }
-    & UserPayload
+      follows: Amity.FollowStatus[];
+    } & UserPayload;
 
     type FollowStatusPayload = {
-      follows: Amity.FollowStatus[]
-    }
+      follows: Amity.FollowStatus[];
+    };
 
     type FollowInfoPayload = {
-      follows: Amity.FollowStatus[]
-      followCounts: Amity.FollowCount[]
-    }
+      follows: Amity.FollowStatus[];
+      followCounts: Amity.FollowCount[];
+    };
   }
 }

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

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

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

@@ -1,62 +1,63 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
     type Cachable = {
-      cachedAt: number
-    }
+      cachedAt: number;
+    };
 
     type Local = {
-      cachedAt: -1
-    }
+      cachedAt: -1;
+    };
 
     type AsyncFunc<Args extends any[], Returned extends any> = {
-      (...args: Args): Promise<Returned>
-    }
+      (...args: Args): Promise<Returned>;
+    };
 
     type FetcherFunc<Args extends any[], Returned extends any> = {
-      (...args: Args): Promise<Returned>
-      locally: (...args: Args) => Returned | undefined
-    }
+      (...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
-    }
+      (...args: Args): Promise<Returned>;
+      optimistically: (...args: Args) => Returned | undefined;
+    };
 
-    type OfflineFunc<Args extends any[], Returned extends any> = (
-      FetcherFunc<Args, Returned> | MutatorFunc<Args, Returned>
-    )
+    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
-    }
+      func: AsyncFunc<Args, Returned> | OfflineFunc<Args, Returned>;
+      args: Args;
+    };
 
-    type QueryPolicy = 'server_only' | 'cache_only' | 'cache_then_server' | 'no_fetch'
+    type QueryPolicy = 'server_only' | 'cache_only' | 'cache_then_server' | 'no_fetch';
 
     type QueryOptions = {
-      lifeSpan: number
-    }
+      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 } & Pages<T4> & { cachedAt?: CacheOptions['cachedAt'] }
-          : { data: T2 }  & { cachedAt?: CacheOptions['cachedAt'] }
-        : T extends Amity.Paged<infer T3, infer T4>
-          ? { data: T3[] | undefined } & Pages<T4>
-          : { data: T | undefined }
-    ) & 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
+      : never;
   }
 }

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

@@ -1,46 +1,55 @@
-import { ASCError } from '~/core/errors'
+import { ASCError } from '~/core/errors';
 
-export {}
+export {};
 
 declare global {
   namespace Amity {
     type SuccessResponse<T> = {
-      status: 'success'
-      data: T
-    }
+      status: 'success';
+      data: T;
+    };
 
     type FailResponse = {
-      status: 'fail'
-      code: Amity.ServerError
-    }
+      status: 'fail';
+      code: Amity.ServerError;
+    };
 
     type ErrorResponse = {
-      status: 'error'
-      message: string
-      code: Amity.ServerError
-    }
+      status: 'error';
+      message: string;
+      code: Amity.ServerError;
+    };
 
-    type Response<T> = (SuccessResponse<T> | FailResponse | ErrorResponse)
+    type Response<T> = SuccessResponse<T> | FailResponse | ErrorResponse;
 
-    type Token = string
+    type Token = string;
 
     type Pagination = {
       paging: {
-        previous?: Token
-        next?: Token
-      }
-    }
+        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
-    }
+      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

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