@amityco/ts-sdk 0.0.1-e5fb0d2.0 → 0.0.1-e643f6f.0

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,26 @@
-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;
+
+    type QueryCategories = {
+      includeDeleted?: boolean;
+      sortBy?: 'name' | 'firstCreated' | 'lastCreated';
+      page?: Amity.Page;
+    };
+
+    type CategoryLiveCollection = Amity.LiveCollectionParams<Omit<QueryCategories, 'page'>>;
+
+    type CategoryLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Category['categoryId'],
+      Pick<QueryCategories, 'page'>
+    >;
   }
 }

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

@@ -1,38 +1,110 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
-    type ChannelType = 'standard' | 'live' | 'conversation' | 'broadcast'
+    type ChannelType = 'broadcast' | 'conversation' | 'community' | 'live';
+
+    type ChannelMemberActionType =
+      | 'onJoin'
+      | 'onLeft'
+      | 'onMemberRead'
+      | '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?: 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;
+      defaultSubChannelId: 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; // TODO remove from public interface
+      moderatorMemberCount?: number;
+
+      lastActivity: Amity.timestamp;
+
+      defaultSubChannelUnreadCount: number;
+      defaultSubChannelHasUnreadMention: boolean;
+      localReadToSegment: number;
+      localLastMentionSegment: number;
+    } & Amity.Metadata &
+      Amity.Taggable &
+      Amity.Timestamps &
+      Amity.SoftDelete &
+      Amity.Subscribable;
+
+    type RawChannel<T extends ChannelType = any> = Omit<
+      Channel<T>,
+      | 'defaultSubChannelId'
+      | 'defaultSubChannelUnreadCount'
+      | 'defaultSubChannelHasUnreadMention'
+      | 'localReadToSegment'
+      | 'localLastMentionSegment'
+    > & {
+      _id: string;
+    };
+
+    type QueryChannels = {
+      displayName?: string;
+      membership?: 'all' | 'member' | 'notMember';
+      sortBy?: 'displayName' | 'firstCreated' | 'lastCreated' | 'lastActivity';
+      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,122 @@
-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>
+    const enum SessionStates {
+      NOT_LOGGED_IN = 'notLoggedIn',
 
-      cache?: Amity.Cache
+      ESTABLISHING = 'establishing',
+      ESTABLISHED = 'established',
 
-      apiKey?: string
-      userId?: string
+      TOKEN_EXPIRED = 'tokenExpired',
 
-      use: () => void
+      /*
+       * Terminated is slightly different from NOT_LOGGED_IN:
+       *
+       * After established, upon receiving the termination code, the SDK will move to terminated.
+       * Unlike tokenExpired that users can regain SDK usability by giving an auth token.
+       * This state represents unrecoverable failures. The app must manually re-login with a valid user.
+       *
+       * For more details, please check tech spec:
+       * https://ekoapp.atlassian.net/wiki/spaces/UP/pages/2082537485/ASC+Core+-+Session+Management+3.0#terminated
+       */
+      TERMINATED = 'terminated',
     }
 
+    type Client = {
+      version: string;
+
+      log: Logger;
+      http: AxiosInstance;
+      mqtt: Amity.MqttClient;
+      ws: SocketIOClient.Socket;
+      emitter: Emitter<Amity.Events>;
+
+      sessionState: Amity.SessionStates;
+      sessionHandler?: Amity.SessionHandler;
+
+      cache?: Amity.Cache;
+
+      apiKey?: string;
+      userId?: string;
+
+      token?: Omit<Amity.Tokens, 'refreshToken'>;
+
+      use: () => void;
+
+      accessTokenExpiryWatcher: (
+        expiresAt: Amity.Tokens['expiresAt'],
+        issuedAt: Amity.Tokens['issuedAt'],
+        sessionHandler: Amity.SessionHandler,
+      ) => Amity.Unsubscriber;
+
+      getFeedSettings: () => Promise<Amity.FeedSettings>;
+    };
+
     type Device = {
-      deviceId: string
+      deviceId: string;
       deviceInfo: {
-        version: string
-        kind: 'node' | 'web'
-        model?: string
-      }
-    }
+        kind: 'node' | 'web';
+        model?: string;
+        sdkVersion: string;
+      };
+    };
 
     type Tokens = {
-      accessToken: string
-      refreshToken: string
+      accessToken: string;
+      refreshToken: string;
+      // issuedAt, expiresAt is in iso Date format
+      issuedAt: string;
+      expiresAt: string;
+    };
+
+    type AccessTokenRenewal = {
+      renew: () => void;
+      renewWithAuthToken: (authToken: string) => void;
+      unableToRetrieveAuthToken: () => void;
+    };
+
+    interface SessionHandler {
+      sessionWillRenewAccessToken(renewal: AccessTokenRenewal): void;
     }
+
+    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

@@ -1,26 +1,65 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
-    type CommentContentType = ('text')
-    type CommentReferenceType = ('content' | 'post')
+    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
-    }
-    & Amity.Relationship<CommentReferenceType>
-    & Amity.Content<T>
-    & Amity.Metadata
-    & Amity.Flaggable
-    & Amity.Reactable
-    & Amity.Timestamps
-    & Amity.SoftDelete
-    & Amity.Syncable
+      commentId: string;
+      userId: string;
+      parentId?: Comment['commentId'];
+      rootId: Comment['commentId'];
+      childrenNumber: number;
+      children: Comment['commentId'][];
+      segmentNumber: number;
+      editedAt: Amity.timestamp;
+      attachments?: Amity.Attachment[];
+    } & 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;
+      includeDeleted?: boolean;
+      page?: Amity.Page;
+      dataTypes?: {
+        values: ('image' | 'text')[];
+        // matchType is a query format that you can set to any to query any type of comment
+        // or exact to get a comment with exactly type that defined in dataTypes
+        matchType: 'any' | 'exact';
+      };
+    };
+
+    type CommentLiveCollection = Amity.LiveCollectionParams<
+      Omit<QueryComments, 'sortBy' | 'page'> & {
+        sortBy?: 'lastCreated' | 'firstCreated';
+      }
+    >;
+
+    type CommentLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Comment['commentId'],
+      Pick<QueryComments, 'page'>
+    >;
   }
 }

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

@@ -1,35 +1,109 @@
-export {}
+export const CommunityPostSettings = Object.freeze({
+  ONLY_ADMIN_CAN_POST: 'ONLY_ADMIN_CAN_POST',
+  ADMIN_REVIEW_POST_REQUIRED: 'ADMIN_REVIEW_POST_REQUIRED',
+  ANYONE_CAN_POST: 'ANYONE_CAN_POST',
+});
+
+export const CommunityPostSettingMaps = Object.freeze({
+  ONLY_ADMIN_CAN_POST: {
+    needApprovalOnPostCreation: false,
+    onlyAdminCanPost: true,
+  },
+  ADMIN_REVIEW_POST_REQUIRED: {
+    needApprovalOnPostCreation: true,
+    onlyAdminCanPost: false,
+  },
+  ANYONE_CAN_POST: {
+    needApprovalOnPostCreation: false,
+    onlyAdminCanPost: false,
+  },
+});
+
+export const DefaultCommunityPostSetting = 'ONLY_ADMIN_CAN_POST';
 
 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.Syncable
+    type CommunityActionType =
+      | 'onCreate'
+      | 'onUpdate'
+      | 'onDelete'
+      | 'onJoin'
+      | 'onLeft'
+      | 'onMemberCountChanged';
+
+    type CommunityMemberActionType =
+      | 'onJoin'
+      | 'onLeft'
+      | 'onBan'
+      | 'onUnban'
+      | 'onMemberCountChanged';
+
+    type RawCommunity = {
+      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;
+
+    type Community = Omit<Amity.RawCommunity, 'onlyAdminCanPost' | 'needApprovalOnPostCreation'> & {
+      postSetting?: ValueOf<typeof CommunityPostSettings>;
+    };
+
+    type QueryCommunities = {
+      displayName?: string;
+      membership?: 'all' | 'member' | 'notMember';
+      categoryId?: Amity.Category['categoryId'];
+      includeDeleted?: boolean;
+      tags?: Amity.Taggable['tags'];
+      sortBy?: 'displayName' | 'firstCreated' | 'lastCreated';
+      page?: Amity.Page;
+    };
+
+    type CommunityLiveCollection = Amity.LiveCollectionParams<Omit<QueryCommunities, 'page'>>;
+
+    type CommunityLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Community['communityId'],
+      Pick<QueryCommunities, 'page'>
+    >;
+
+    type QueryCommunityMembers = {
+      communityId: string;
+      membership?: ('banned' | 'member')[];
+      roles?: string[];
+      sortBy?: 'firstCreated' | 'lastCreated';
+      search?: Amity.User['displayName'] | Amity.User['userId'];
+      page?: Amity.Page;
+    };
+
+    type CommunityMemberLiveCollection = Amity.LiveCollectionParams<
+      Omit<QueryCommunityMembers, 'page'>
+    >;
+
+    type CommunityMemberLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Membership<'community'>['userId'],
+      Pick<QueryCommunityMembers, 'page'>
+    >;
   }
 }