@amityco/ts-sdk 0.0.1-be4fc2f.0 → 0.0.1-bef76fa.0

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

@@ -1,27 +1,59 @@
-export {}
+export const MessageContentType = Object.freeze({
+  TEXT: 'text',
+  IMAGE: 'image',
+  FILE: 'file',
+  VIDEO: 'video',
+  AUDIO: 'audio',
+  CUSTOM: 'custom',
+});
 
 declare global {
   namespace Amity {
-    type MessageContentType = ('text' | 'file' | 'image')
+    type MessageContentType = ValueOf<typeof MessageContentType>;
+
+    type MessageContent<T extends Amity.MessageContentType = any> = {
+      fileId: T extends 'file' | 'image' | 'video' | 'audio' ? string : null;
+    };
+
+    type MessageActionType = 'onCreate' | 'onUpdate' | 'onDelete' | 'onFetch';
 
     type Message<T extends Amity.MessageContentType = any> = {
-      messageId: string
+      messageId: string;
+
+      channelId: Amity.Channel['channelId'];
+      userId: Amity.User['userId'];
+
+      parentId?: Message['messageId'];
+      childrenNumber: number;
+
+      channelSegment: number;
 
-      channelId: Amity.Channel['channelId']
-      userId: Amity.User['userId']
+      editedAt: Amity.timestamp;
+    } & Amity.Content<T, 'type'> &
+      Amity.MessageContent<T> &
+      Amity.Metadata &
+      Amity.Timestamps &
+      Amity.SoftDelete &
+      Amity.Taggable &
+      Amity.Reactable &
+      Amity.Mentionable<'user' | 'channel'>;
 
-      parentId?: Message['messageId']
-      childrenNumber: number
+    type QueryMessages = {
+      channelId: Amity.Channel['channelId'];
+      type?: Amity.MessageContentType;
+      parentId?: Amity.Message['parentId'];
+      filterByParentId?: boolean;
+      isDeleted?: boolean;
+      tags?: Amity.Taggable['tags'];
+      excludeTags?: Amity.Taggable['tags'];
+      page?: Amity.Page;
+    };
 
-      channelSegment: number
+    type MessagesLiveCollection = Amity.LiveCollectionParams<Omit<QueryMessages, 'page'>>;
 
-      editedAt: timestamp
-    }
-    & Amity.Content<T, 'type'>
-    & Amity.Metadata
-    & Amity.Timestamps
-    & Amity.SoftDelete
-    & Amity.Syncable
-    & Amity.Reactable
+    type MessageLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Message['channelId'],
+      Pick<QueryMessages, 'page'>
+    >;
   }
 }

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

@@ -1,56 +1,56 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
-    type timestamp = string
+    type timestamp = string;
 
     type CreatedAt = {
-      createdAt: timestamp
-    }
+      createdAt: timestamp;
+    };
 
     type UpdatedAt = {
-      updatedAt?: timestamp
-    }
+      updatedAt?: timestamp;
+    };
 
     type DeletedAt = {
-      deletedAt?: timestamp
-    }
+      deletedAt?: timestamp;
+    };
 
-    type Timestamps = CreatedAt & UpdatedAt
+    type Timestamps = CreatedAt & UpdatedAt;
 
     type SoftDelete = DeletedAt & {
-      isDeleted?: boolean
-    }
+      isDeleted?: boolean;
+    };
 
     type Metadata = {
-      metadata?: Record<string, any>
-    }
+      metadata?: Record<string, any>;
+    };
 
     type Relationship<T extends string> = {
-      referenceId: string
-      referenceType: T
-    }
+      referenceId: string;
+      referenceType: T;
+    };
 
     type Flaggable = {
-      flagCount: number
+      flagCount: number;
       hashFlag: {
-        bits: number
-        hashes: number
-        hash: string
-      } | null
-    }
+        bits: number;
+        hashes: number;
+        hash: string;
+      } | null;
+    };
 
     type Taggable = {
-      tags?: string[]
-    }
+      tags?: string[];
+    };
 
     type Accredited = {
-        roles: Amity.Role['displayName'][]
-        permissions: Amity.Permission[]
-    }
+      roles: Amity.Role['displayName'][];
+      permissions: Amity.Permission[];
+    };
 
     type Subscribable = {
-      path: string
-    }
+      path: string;
+    };
   }
 }

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

@@ -0,0 +1,32 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type PollDataType = 'text';
+
+    type PollAnswerType = 'single' | 'multiple';
+
+    type PollAnswer = {
+      id: string;
+      dataType: PollDataType;
+      data: string;
+      voteCount: number;
+      isVotedByUser: boolean;
+    };
+
+    type PollStatus = 'closed' | 'open';
+
+    type Poll = {
+      pollId: string;
+      question: string;
+      answers: PollAnswer[];
+      answerType: PollAnswerType;
+      closedAt?: Amity.timestamp;
+      closedIn?: number;
+      isVoted?: boolean;
+      status: PollStatus;
+      userId: Amity.User['userId'];
+    } & Amity.Timestamps &
+      Amity.SoftDelete;
+  }
+}

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

@@ -1,32 +1,77 @@
-export {}
+export const PostContentType = Object.freeze({
+  TEXT: 'text',
+  IMAGE: 'image',
+  FILE: 'file',
+  VIDEO: 'video',
+  LIVESTREAM: 'liveStream',
+  POLL: 'poll',
+});
 
 declare global {
   namespace Amity {
     // bad hack until we get proper feed objects in backend
-    type PostTargetType = Amity.FeedType | 'content'
+    type PostTargetType = Amity.FeedType | 'content';
 
-    type PostContentType = ('text' | 'image' | 'file')
+    type PostContentType = ValueOf<typeof PostContentType>;
+
+    type PostActionType =
+      | 'onFetch'
+      | 'onCreate'
+      | 'onUpdate'
+      | 'onDelete'
+      | 'onApproved'
+      | 'onDeclined'
+      | 'onFlagged'
+      | 'onUnflagged'
+      | 'onReactionAdded'
+      | 'onReactionRemoved';
 
     type Post<T extends PostContentType = any> = {
-      postId: string
-      postedUserId: User['userId'] // API-FIX: it should be "userId"
-      parentId: Post['postId']
-      targetType: PostTargetType
-      targetId: string
-      feedId: Feed['feedId']
-      children: Amity.Post['postId'][]
-      comments: Amity.Comment['commentId'][]
-      commentsCount: number // API-FIX: backend doesnt follow its own convention
-      hasFlaggedChildren: false
-      hasFlaggedComment: false
-      editedAt: timestamp,
+      postId: string;
+      postedUserId: Amity.User['userId']; // API-FIX: it should be "userId"
+      parentId: Post['postId'];
+      targetType: PostTargetType;
+      targetId: string;
+      feedId: Amity.Feed['feedId'];
+      children: Amity.Post['postId'][];
+      comments: Amity.Comment['commentId'][];
+      commentsCount: number; // API-FIX: backend doesnt follow its own convention
+      hasFlaggedChildren: false;
+      hasFlaggedComment: false;
+      editedAt: Amity.timestamp;
     } & Amity.Content<T, 'dataType'> &
       Amity.Metadata &
       Amity.Flaggable &
       Amity.Reactable &
+      Amity.Taggable &
       Amity.Timestamps &
       Amity.SoftDelete &
-      Amity.Syncable
-      & Amity.Subscribable
+      Amity.Subscribable &
+      Amity.Mentionable<'user'>;
+
+    type QueryPosts = {
+      targetId: string;
+      targetType: Amity.Post['targetType'];
+      sortBy?: 'lastCreated' | 'firstCreated' | 'lastUpdated' | 'firstUpdated';
+      dataTypes?: Exclude<Amity.PostContentType, 'text'>[];
+      isDeleted?: Amity.Post['isDeleted'];
+      hasFlag?: boolean;
+      feedType?: 'reviewing' | 'published';
+      tags?: Amity.Taggable['tags'];
+      matchingOnlyParentPost?: boolean;
+      page?: Amity.PageRaw;
+    };
+
+    // Omit sortBy explained in asc-3398
+    type PostLiveCollection = Amity.LiveCollectionParams<
+      Omit<QueryPosts, 'sortBy' | 'page'> & {
+        sortBy?: 'lastCreated' | 'firstCreated';
+      }
+    >;
+
+    type PostLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Post['postId'],
+      Pick<QueryPosts, 'page'>
+    >;
   }
 }

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

@@ -1,30 +1,46 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
-    type ReactableType = ('message' | 'post' | 'comment')
+    type ReactableType = 'message' | 'post' | 'comment';
 
-    type Reaction =  {
-      reactionId: string
-      userId: string
-      reactionName: string
-    }
-    & Amity.CreatedAt
-    & Amity.Relationship<ReactableType>
+    type ReactionActionType = 'onAdded' | 'onRemoved';
 
-    type Reactions = {
-      reactions: Record<string, number>
-      count: number
-    }
+    type Reactor = {
+      reactionId: string;
+      reactionName: string;
+      userId: Amity.User['userId'];
+    } & Amity.CreatedAt;
+
+    type Reaction = Amity.Reactor & Amity.Relationship<ReactableType>;
 
     type Reactable = {
-      reactionsCount: number
-      reactions: Record<string, number>
-      myReactions?: string[]
+      reactionsCount: number;
+      reactions: Record<string, number>;
+      myReactions?: string[];
 
       latestReaction?: Amity.Reaction & {
-        eventName: ('added' | 'removed')
-      }
-    }
+        eventName: 'add' | 'remove';
+        userDisplayName: string;
+      };
+    };
+
+    type ReactionQuery = {
+      reactors: Reactor[];
+    } & Amity.Relationship<ReactableType>;
+
+    type QueryReactions = {
+      referenceId: Amity.Reaction['referenceId'];
+      referenceType: Amity.Reaction['referenceType'];
+      reactionName?: Amity.Reaction['reactionName'];
+      page?: Amity.Page<string>;
+    };
+
+    type ReactionLiveCollection = Amity.LiveCollectionParams<Omit<QueryReactions, 'page'>>;
+
+    type ReactionLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Reactor['reactionId'],
+      Pick<QueryReactions, 'page'>
+    >;
   }
 }

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

@@ -1,4 +1,4 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
@@ -16,54 +16,52 @@ declare global {
     }
 
     type MultiFormat<T> = {
-      flv?: T
-      mp4?: T
-      m3u8?: T
-    }
+      flv?: T;
+      mp4?: T;
+      m3u8?: T;
+    };
 
     type StreamPlatform = {
-      name: string
-      version: string
-    }
+      name: string;
+      version: string;
+    };
 
     type StreamEndpoint = {
-      url: string
+      url: string;
       components: {
-        origin: string
-        appName: string
-        streamName: string
-        query: string
-      }
-    }
+        origin: string;
+        appName: string;
+        streamName: string;
+        query: string;
+      };
+    };
 
     type StreamRecording = {
-      url: string
-      duration: number
-      startTime: number
-      stopTime: number
-    }
+      url: string;
+      duration: number;
+      startTime: number;
+      stopTime: number;
+    };
 
     type Stream = {
-      streamId: string
-      title: string
-      thumbnailFileId?: Amity.File<'image'>['fileId']
-      description?: string
-      status: StreamStatus
-      platform: StreamPlatform
+      streamId: string;
+      title: string;
+      thumbnailFileId?: Amity.File<'image'>['fileId'];
+      description?: string;
+      status: StreamStatus;
+      platform: StreamPlatform;
 
-      isLive?: boolean
-      endedAt: timestamp
-      startedAt: timestamp
-      userId: User['userId']
-      resolution: StreamResolution
+      isLive?: boolean;
+      endedAt: Amity.timestamp;
+      startedAt: Amity.timestamp;
+      userId: Amity.User['userId'];
+      resolution: StreamResolution;
 
-      streamerUrl: StreamEndpoint
-      watcherUrl: MultiFormat<StreamEndpoint>
-      recordings: MultiFormat<StreamRecording>[]
-    }
-    & Amity.Metadata
-    & Amity.Timestamps
-    & Amity.SoftDelete
-    & Amity.Syncable
+      streamerUrl: StreamEndpoint;
+      watcherUrl: MultiFormat<StreamEndpoint>;
+      recordings: MultiFormat<StreamRecording>[];
+    } & Amity.Metadata &
+      Amity.Timestamps &
+      Amity.SoftDelete;
   }
 }

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

@@ -1,19 +1,28 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
+    type UserActionType =
+      | 'onFetch'
+      | 'onUpdate'
+      | 'onDelete'
+      | 'onFlagged'
+      | 'onUnflagged'
+      | 'onFlagCleared';
+
     type User = {
-      userId: string
-      displayName?: string
-      avatarFileId?: Amity.File<'image'>['fileId']
-      description?: string
-    }
-    & Amity.Metadata
-    & Amity.Taggable
-    & Amity.Flaggable
-    & Amity.Accredited
-    & Amity.Timestamps
-    & Amity.Syncable
-    & Amity.Subscribable
+      _id: string;
+      userId: string;
+      displayName?: string;
+      avatarFileId?: Amity.File<'image'>['fileId'];
+      avatarCustomUrl?: string;
+      description?: string;
+    } & Amity.Metadata &
+      Amity.Taggable &
+      Amity.Flaggable &
+      Amity.Accredited &
+      Amity.Timestamps &
+      Amity.SoftDelete &
+      Amity.Subscribable;
   }
 }

package/src/@types/global.ts

@@ -1,25 +1,30 @@
-export {}
+export {};
 
 declare global {
-  type Writeable<T> = { -readonly [P in keyof T]: T[P] }
+  type Writeable<T> = { -readonly [P in keyof T]: T[P] };
 
-  type Patch<T, K extends keyof T> = Partial<Pick<T, K>>
+  type Patch<T, K extends keyof T> = Partial<Pick<T, K>>;
 
-  type Unwrap<T> = (
-    T extends Promise<infer U> ? U :
-    T extends (...args: any) => Promise<infer U> ? U :
-    T extends (...args: any) => infer U ? U :
-    T
-  )
+  type Unwrap<T> = T extends Promise<infer U>
+    ? U
+    : T extends (...args: any) => Promise<infer U>
+    ? U
+    : T extends (...args: any) => infer U
+    ? U
+    : T;
+
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  type ObjectKeys<T> = T extends object
+    ? (keyof T)[]
+    : T extends number
+    ? []
+    : T extends Array<any> | string
+    ? string[]
+    : never;
 
   interface ObjectConstructor {
-    keys<T>(o: T): ObjectKeys<T>
+    keys<T>(o: T): ObjectKeys<T>;
   }
 
-  type ObjectKeys<T> =  (
-    T extends object ? (keyof T)[] :
-    T extends number ? [] :
-    T extends Array<any> | string ? string[] :
-    never
-  )
+  type ValueOf<T extends Record<any, any>> = T[keyof T];
 }

package/src/@types/index.ts

@@ -1,31 +1,38 @@
-import './global' // global types (system)
+import './global'; // global types (system)
 
-import './core/errors' // global errors
-import './core/permissions' // permissions enum
+import './core/errors'; // global errors
+import './core/permissions'; // permissions enum
 
-import './core/payload' // backend payload definition
-import './core/events' // sdk events definitions
-import './core/query' // createQuery, runQuery
-import './core/store' // store definition
-import './core/cache' // cache.pull('user', ...)
+import './core/payload'; // backend payload definition
+import './core/events'; // sdk events definitions
+import './core/paging'; // createQuery, runQuery
+import './core/query'; // createQuery, runQuery
+import './core/cache'; // cache.pull('user', ...)
+import './core/live';
 
 // domains
-import './domains/client' // client definition
+import './domains/client'; // client definition
 
-import './domains/user'
-import './domains/file'
+import './domains/user';
+import './domains/follow';
 
-import './domains/partials' // small model partials (CreatedAt, etc...)
-import './domains/content' // content partial
-import './domains/reaction'
+import './domains/partials'; // small model partials (CreatedAt, etc...)
+import './domains/reaction';
 
-import './domains/group'
-import './domains/channel'
-import './domains/message'
+import './domains/group';
+import './domains/channel';
 
-import './domains/community'
-import './domains/category'
-import './domains/post'
-import './domains/comment'
+import './domains/category';
+import './domains/comment';
 
-import './domains/stream'
+import './domains/stream';
+
+import './domains/mention';
+
+import './domains/poll';
+
+export * from './domains/community';
+export * from './domains/content';
+export * from './domains/file';
+export * from './domains/message';
+export * from './domains/post';

package/src/@types/mqtt.d.ts

@@ -0,0 +1,3 @@
+declare module 'mqtt/dist/mqtt' {
+  export * from 'mqtt';
+}

package/src/cache/api/backupCache.ts

@@ -0,0 +1,48 @@
+import AsyncStorage from '@react-native-async-storage/async-storage';
+
+import { getActiveClient } from '~/client/api/activeClient';
+
+/**
+ * ```js
+ * import { backupCache } from '@amityco/ts-sdk'
+ * const success = await backupCache()
+ * ```
+ *
+ * Writes the {@link Amity.Cache} to a persistent storage.
+ *
+ * The strategy for persistent storage will depend on the runtime,
+ * which is supported by @react-native-async-storage/async-storage.
+ *
+ * The current userId will be appended to the given storageKey to avoid
+ * collision between multiple client instances over time.
+ *
+ * @param storageKey the name of the persistent storage
+ * @param persistIf a custom function to define the persistence policy. Default
+ * will check the value of {@link Amity.CacheEntry["offline"]}, which can be
+ * defined globally when customizing {@link Amity.Cache["persistIf"]}
+ * @returns a success boolean if the cache was dumped to persistent storage
+ *
+ * @category Cache API
+ */
+export const backupCache = async (
+  storageKey = 'amitySdk',
+  persistIf = (entry: Amity.CacheEntry) => entry.offline,
+): Promise<boolean> => {
+  const { log, cache, userId } = getActiveClient();
+
+  if (!cache) return false;
+  log('cache/api/backupCache', { storageKey });
+
+  // prepare a subset of the cache where only
+  // objects to backup are there
+  const offlineEntries = Object.fromEntries(
+    Object.entries(cache.data).filter(([_, entry]) => persistIf(entry)),
+  );
+
+  // nothing to backup, abort
+  if (!Object.keys(offlineEntries).length) return false;
+
+  await AsyncStorage.setItem(`${storageKey}#${userId}`, JSON.stringify(offlineEntries));
+
+  return true;
+};