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

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;
   }
 }

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

@@ -1,95 +1,63 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
-    type Syncable = {
-      localId: string
-      syncedAt: number
-    }
+    type Cachable = {
+      cachedAt: number;
+    };
 
     type Local = {
-      localId: string
-      syncedAt: -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
-    }
+      (...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
-    }
+      (...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 = 'cache_only' | 'cache_then_server' | 'no_fetch';
 
     type QueryOptions = {
-      lifeSpan: number
-    }
-
-    type QueryMetadata = {
-      origin?: 'local' | 'server',
-      loading?: boolean,
-      error?: Error,
-    }
-
-    type QueryResult<T> = T extends Amity.Paged<infer U>
-      ? { data?: U } & Amity.Pages & QueryMetadata
-      : { data?: T } & QueryMetadata
-
-    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 PrevPage = {
-      after?: never
-      before?: number
-      limit: number
-    }
-
-    type NextPage = {
-      after?: number
-      before?: never
-      limit: number
-    }
-
-    type Page = (PrevPage | NextPage)
-
-    type Pages = {
-      nextPage: Page | null
-      prevPage: Page | null
-    }
-
-    type Paged<T> = { data: T } & Pages
+      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

@@ -1,32 +1,55 @@
-export {}
+import { ASCError } from '~/core/errors';
+
+export {};
 
 declare global {
   namespace Amity {
     type SuccessResponse<T> = {
-      status: 'success'
-      data: T
-    }
+      status: 'success';
+      data: T;
+    };
 
     type FailResponse = {
-      status: 'fail'
-      code: Amity.ClientError
-    }
+      status: 'fail';
+      code: Amity.ServerError;
+    };
 
     type ErrorResponse = {
-      status: 'error'
-      message: string
-      code: Amity.ClientError
-    }
+      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;
+    };
   }
 }

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

@@ -1,15 +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
-    & Amity.Syncable
+      categoryId: string;
+      name: string;
+      avatarFileId?: Amity.File<'image'>['fileId'];
+    } & Amity.Metadata &
+      Amity.Timestamps &
+      Amity.SoftDelete;
   }
 }

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

@@ -1,38 +1,93 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
-    type ChannelType = 'standard' | 'live' | 'conversation' | 'broadcast'
+    type ChannelType = 'broadcast' | 'conversation' | 'community' | 'live';
+
+    type ChannelMemberActionType =
+      | 'onMemberAdded'
+      | 'onMemberRemoved'
+      | 'onChannelMemberBanned'
+      | 'onChannelMemberUnbanned';
+
+    type ChannelActionType =
+      | 'onFetch'
+      | 'onCreate'
+      | 'onUpdate'
+      | 'onDelete'
+      | 'onJoin'
+      | 'onLeft'
+      | 'onMemberAdded'
+      | 'onMemberRemoved';
 
     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?: timestamp
-    }
-    & Amity.Metadata
-    & Amity.Taggable
-    & Amity.Timestamps
-    & Amity.SoftDelete
-    & Amity.Syncable
+      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;
+
+    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

@@ -1,36 +1,57 @@
-import { AxiosInstance } from 'axios'
-import { Emitter } from 'mitt'
+import { AxiosInstance } from 'axios';
+import { Emitter } from 'mitt';
 
 declare global {
   namespace Amity {
-    type Logger = (topic: string, ...args: any[]) => void
+    type Logger = (topic: string, ...args: any[]) => void;
 
     type Client = {
-      log: Logger
-      http: AxiosInstance
-      ws: SocketIOClient.Socket
-      emitter: Emitter<Amity.Events>
+      version: string;
 
-      cache?: Amity.Cache
+      log: Logger;
+      http: AxiosInstance;
+      mqtt: Amity.MqttClient;
+      ws: SocketIOClient.Socket;
+      emitter: Emitter<Amity.Events>;
 
-      apiKey?: string
-      userId?: string
+      cache?: Amity.Cache;
 
-      use: () => void
-    }
+      apiKey?: string;
+      userId?: string;
+      accessToken?: string;
+
+      use: () => void;
+
+      getFeedSettings: () => Promise<Amity.FeedSettings>;
+    };
 
     type Device = {
-      deviceId: string
+      deviceId: string;
       deviceInfo: {
-        version: string
-        kind: 'node' | 'web'
-        model?: string
-      }
-    }
+        version: string;
+        kind: 'node' | 'web';
+        model?: string;
+      };
+    };
 
     type Tokens = {
-      accessToken: string
-      refreshToken: string
-    }
+      accessToken: string;
+      refreshToken: string;
+    };
+
+    type FeedSettings = {
+      [name in Amity.ContentFeedType]?: Amity.ContentSetting[];
+    };
+
+    type ConnectClientParams = {
+      userId: Amity.User['userId'];
+      displayName?: Amity.User['displayName'];
+      authToken?: string;
+      deviceId?: Amity.Device['deviceId'];
+    };
+
+    type ConnectClientConfig = {
+      disableRTE: boolean;
+    };
   }
 }