@amityco/ts-sdk 0.0.1-beta.39 → 0.0.1-beta.40

package/dist/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,OAAO,QAAwC,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,OAAO,QAAe,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "0.0.1-beta.39",
+  "version": "0.0.1-beta.40",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",

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

@@ -59,20 +59,20 @@ declare global {
     } & MqttChannelUserEvents;
 
     type MqttSubChannelEvents = {
-      'message-feed.created': Amity.RawSubChannelPayload;
-      'message-feed.updated': Amity.RawSubChannelPayload;
-      'message-feed.deleted': Amity.RawSubChannelPayload;
+      'message-feed.created': Amity.SubChannelPayload;
+      'message-feed.updated': Amity.SubChannelPayload;
+      'message-feed.deleted': Amity.SubChannelPayload;
     };
 
     type MqttMessageEvents = {
-      'message.created': Amity.RawMessagePayload;
-      'message.updated': Amity.RawMessagePayload;
-      'message.deleted': Amity.RawMessagePayload;
-      'message.flagged': Amity.RawMessagePayload;
-      'message.unflagged': Amity.RawMessagePayload;
-      'message.flagCleared': Amity.RawMessagePayload;
-      'message.reactionAdded': Amity.RawMessagePayload;
-      'message.reactionRemoved': Amity.RawMessagePayload;
+      'message.created': Amity.MessagePayload;
+      'message.updated': Amity.MessagePayload;
+      'message.deleted': Amity.MessagePayload;
+      'message.flagged': Amity.MessagePayload;
+      'message.unflagged': Amity.MessagePayload;
+      'message.flagCleared': Amity.MessagePayload;
+      'message.reactionAdded': Amity.MessagePayload;
+      'message.reactionRemoved': Amity.MessagePayload;
     };
 
     type MqttCommunityUserEvents = {
@@ -83,6 +83,8 @@ declare global {
       'community.userChanged': Amity.CommunityMembershipPayload;
       'community.userBanned': Amity.CommunityMembershipPayload;
       'community.userUnbanned': Amity.CommunityMembershipPayload;
+      'community.roleAdded': Amity.CommunityMembershipPayload;
+      'community.roleRemoved': Amity.CommunityMembershipPayload;
     };
 
     type MqttCommunityEvents = {
@@ -142,15 +144,15 @@ declare global {
       MqttFollowEvents;
 
     type LocalEvents = {
-      'local.channel.updated': { channels: Amity.Channel[] };
-      'local.message.created': Amity.MessagePayload;
-      'local.message.updated': Amity.MessagePayload;
-      'local.message.deleted': Amity.MessagePayload;
-      'local.message.fetched': Amity.MessagePayload;
-      'local.message-feed.fetched': Amity.SubChannelPayload;
-      'local.message-feed.deleted': Amity.SubChannelPayload;
-      'poll.updated': Amity.PollPayload;
-      'poll.deleted': Amity.PollPayload;
+      'local.channel.updated': MakeRequired<Amity.ProcessedChannelPayload, 'channels'>;
+      'local.message.created': MakeRequired<Amity.ProcessedMessagePayload, 'messages'>;
+      'local.message.updated': MakeRequired<Amity.ProcessedMessagePayload, 'messages'>;
+      'local.message.deleted': MakeRequired<Amity.ProcessedMessagePayload, 'messages'>;
+      'local.message.fetched': MakeRequired<Amity.ProcessedMessagePayload, 'messages'>;
+      'local.message-feed.fetched': MakeRequired<Amity.ProcessedSubChannelPayload, 'messageFeeds'>;
+      'local.message-feed.deleted': MakeRequired<Amity.ProcessedSubChannelPayload, 'messageFeeds'>;
+      'poll.updated': MakeRequired<Amity.PollPayload, 'polls'>;
+      'poll.deleted': MakeRequired<Amity.PollPayload, 'polls'>;
 
       sessionStateChange: Amity.SessionStates;
       // used by accessTokenExpiryWatcher

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

@@ -6,7 +6,7 @@ declare global {
      * type map of "domain name -> ASC model"
      * @hidden
      */
-    type Model = {
+    type Models = {
       user: Amity.User;
       file: Amity.File;
       role: Amity.Role;
@@ -32,7 +32,8 @@ declare global {
       feed: Amity.Feed;
     };
 
-    type Domain = keyof Model;
+    type Model = ValueOf<Models>;
+    type Domain = keyof Models;
 
     /**
      * Definition of the minimal set of properties necessary to identify

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

@@ -40,35 +40,66 @@ declare global {
       roles: Amity.Role[];
     };
 
-    type ChannelPayload<
-      T extends Amity.ChannelType = any,
-      U extends Amity.Channel<T> | Amity.ChannelRaw<T> = Amity.ChannelRaw<T>,
-    > = {
-      channels: U[];
-      channelUsers: Amity.MembershipRaw<'channel'>[];
+    type ChannelPayload<T extends Amity.ChannelType = any> = {
+      channels: Amity.RawChannel<T>[];
+      channelUsers: Amity.RawMembership<'channel'>[];
     } & Amity.UserPayload;
 
-    type RawSubChannelPayload = {
-      messageFeeds: Amity.RawSubChannel[];
+    /**
+     * Items that extend from `Amity.Channel`
+     * - channels: `Amity.RawChannel` -> `Amity.Channel` (Added Marker Service related props)
+     * - channelUsers: `Amity.RawMembership` -> `Amity.Membership` (Add user getter prop)
+     */
+    type ProcessedChannelPayload<T extends Amity.ChannelType = any> = Omit<
+      ChannelPayload,
+      'channels' | 'channelUsers'
+    > & {
+      channels: Amity.Channel<T>[];
+      channelUsers: Amity.Membership<'channel'>[];
     };
 
     type SubChannelPayload = {
+      messageFeeds: Amity.RawSubChannel[];
+    };
+
+    /**
+     * Items that extend from `Amity.SubChannelPayload`
+     * - messageFeeds: `Amity.RawSubChannel` -> `Amity.SubChannel` (Model Restructuring)
+     */
+    type ProcessedSubChannelPayload = {
       messageFeeds: Amity.SubChannel[];
     };
 
     type ChannelMembershipPayload = {
-      channels: Amity.ChannelRaw[];
-      channelUsers: Amity.MembershipRaw<'channel'>[];
+      channels: Amity.RawChannel[];
+      channelUsers: Amity.RawMembership<'channel'>[];
     } & Amity.UserPayload;
 
-    type MessagePayload<T extends Amity.MessageContentType = any> = {
+    /**
+     * Items that extend from `Amity.ChannelMembershipPayload`
+     * - channels: `Amity.RawChannel` -> `Amity.Channel` (Added Marker Service related props)
+     * - channelUsers: `Amity.RawMembership` -> `Amity.Membership` (Add user getter prop)
+     */
+    type ProcessedChannelMembershipPayload = Omit<
+      ChannelMembershipPayload,
+      'channels' | 'channelUsers'
+    > & {
+      channels: Amity.Channel[];
+      channelUsers: Amity.Membership<'channel'>[];
+    };
+
+    /**
+     * Items that extend from `Amity.MessagePayload`
+     * - messages: `Amity.RawMessage` -> `Amity.Message` (Model Restructuring)
+     */
+    type ProcessedMessagePayload<T extends Amity.MessageContentType = any> = {
       messages: Amity.Message<T>[];
-      users?: Amity.User[];
-      files?: Amity.File[];
+      users: Amity.User[];
+      files: Amity.File[];
     };
 
-    type RawMessagePayload<T extends Amity.MessageContentType = any> = Omit<
-      MessagePayload<T>,
+    type MessagePayload<T extends Amity.MessageContentType = any> = Omit<
+      ProcessedMessagePayload<T>,
       'messages'
     > & {
       messages: Amity.RawMessage<T>[];
@@ -76,17 +107,27 @@ declare global {
 
     type StreamPayload = {
       videoStreamings: Amity.Stream[];
-      users?: Amity.User[];
-      files?: Amity.File<'image'>[];
+      users: Amity.User[];
+      files: Amity.File<'image'>[];
     };
 
     type CommunityPayload = {
       communities: Amity.RawCommunity[];
-      communityUsers?: Amity.MembershipRaw<'community'>[];
-      categories?: Amity.Category[];
-      feeds?: Amity.Feed[];
-      users?: Amity.User[];
-      files?: Amity.File[];
+      communityUsers: Amity.RawMembership<'community'>[];
+      categories: Amity.Category[];
+      feeds: Amity.Feed[];
+      users: Amity.User[];
+      files: Amity.File[];
+    };
+
+    /**
+     * Items that extend from `Amity.CommunityPayload`
+     * - communities: `Amity.RawCommunity` -> `Amity.Community` (Added Marker Service related props)
+     * - communityUsers: `Amity.RawMembership` -> `Amity.Membership` (Add user getter prop)
+     */
+    type ProcessedCommunityPayload = Omit<CommunityPayload, 'communities' | 'communityUsers'> & {
+      communities: Amity.Community[];
+      communityUsers: Amity.Membership<'community'>[];
     };
 
     type CategoryPayload = {
@@ -96,30 +137,53 @@ declare global {
 
     type CommunityMembershipPayload = {
       communities: Amity.RawCommunity[];
-      communityUsers: Amity.MembershipRaw<'community'>[];
-      categories?: Amity.Category[];
-      feeds?: Amity.Feed[];
+      communityUsers: Amity.RawMembership<'community'>[];
+      categories: Amity.Category[];
+      feeds: Amity.Feed[];
       users: Amity.User[];
-      files?: Amity.File[];
+      files: Amity.File[];
+    };
+
+    /**
+     * Items that extend from `Amity.CommunityMembershipPayload`
+     * - communities: `Amity.RawCommunity` -> `Amity.Community` (Added Marker Service related props)
+     * - communityUsers: `Amity.RawMembership` -> `Amity.Membership` (Add user getter prop)
+     */
+    type ProcessedCommunityMembershipPayload = Omit<
+      CommunityMembershipPayload,
+      'communities' | 'communityUsers'
+    > & {
+      communities: Amity.Community[];
+      communityUsers: Amity.Membership<'community'>[];
     };
 
     type PostPayload<T extends Amity.PostContentType = any> = {
       posts: Amity.Post<T>[];
-      postChildren?: Amity.Post[];
-      communities?: Amity.RawCommunity[];
-      communityUsers?: Amity.MembershipRaw<'community'>[];
-      categories?: Amity.Category[];
-      comments?: Amity.Comment[];
-      feeds?: Amity.Feed[];
-      users?: Amity.User[];
-      files?: Amity.File[];
+      postChildren: Amity.Post[];
+      communities: Amity.RawCommunity[];
+      communityUsers: Amity.RawMembership<'community'>[];
+      categories: Amity.Category[];
+      comments: Amity.Comment[];
+      feeds: Amity.Feed[];
+      users: Amity.User[];
+      files: Amity.File[];
+    };
+
+    /**
+     * Items that extend from `Amity.PostPayload`
+     * - communities: `Amity.RawCommunity` -> `Amity.Community` (Added Marker Service related props)
+     * - communityUsers: `Amity.RawMembership` -> `Amity.Membership` (Add user getter prop)
+     */
+    type ProcessedPostPayload = Omit<PostPayload, 'communities' | 'communityUsers'> & {
+      communities: Amity.Community[];
+      communityUsers: Amity.Membership<'community'>[];
     };
 
     type CommentPayload<T extends Amity.CommentContentType = any> = {
       comments: Amity.Comment<T>[];
-      commentChildren?: Amity.Comment[];
-      users?: Amity.User[];
-      files?: Amity.File[];
+      commentChildren: Amity.Comment[];
+      users: Amity.User[];
+      files: Amity.File[];
     };
 
     type PollPayload = {
@@ -129,7 +193,7 @@ declare global {
 
     type ReactionPayload = {
       reactions: Amity.ReactionQuery[];
-      users: Pick<Amity.User, 'userId' | 'displayName' | 'metadata'>[];
+      users: Amity.User[];
     };
 
     type GlobalFeedPayload = Amity.PostPayload;

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

@@ -60,7 +60,7 @@ declare global {
       Amity.SoftDelete &
       Amity.Subscribable;
 
-    type ChannelRaw<T extends ChannelType = any> = Omit<
+    type RawChannel<T extends ChannelType = any> = Omit<
       Channel<T>,
       | 'defaultSubChannelId'
       | 'defaultSubChannelUnreadCount'

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

@@ -59,9 +59,9 @@ declare global {
     type Device = {
       deviceId: string;
       deviceInfo: {
-        version: string;
         kind: 'node' | 'web';
         model?: string;
+        sdkVersion: string;
       };
     };
 

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

@@ -24,6 +24,7 @@ declare global {
       children: Comment['commentId'][];
       segmentNumber: number;
       editedAt: Amity.timestamp;
+      attachments?: Amity.Attachment[];
     } & Amity.Relationship<CommentReferenceType> &
       Amity.Content<T> &
       Amity.Metadata &
@@ -42,6 +43,12 @@ declare global {
       hasFlag?: boolean;
       isDeleted?: Amity.Comment['isDeleted'];
       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<

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

@@ -31,6 +31,13 @@ declare global {
       | 'onLeft'
       | 'onMemberCountChanged';
 
+    type CommunityMemberActionType =
+      | 'onJoin'
+      | 'onLeft'
+      | 'onBan'
+      | 'onUnban'
+      | 'onMemberCountChanged';
+
     type RawCommunity = {
       communityId: string;
 
@@ -80,5 +87,23 @@ declare global {
       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'>
+    >;
   }
 }

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

@@ -24,6 +24,12 @@ declare global {
       fileId: Amity.File<'image'>['fileId'];
     };
 
+    type Attachment = {
+      type: 'image' | 'link';
+      url?: string;
+      fileId?: Amity.File<'image'>['fileId'];
+    };
+
     type ContentDataVideo = {
       thumbnailFileId: Amity.File<'image'>['fileId'];
       videoFileId: {
@@ -52,8 +58,10 @@ declare global {
       : never;
 
     type Content<T extends ContentType> = {
+      // dataType still retained to maintain backward compatibility
       dataType?: T;
-      data: ContentData<T>;
+      dataTypes?: T[];
+      data?: ContentData<T>;
     };
 
     type ContentSettingText = {

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

@@ -27,7 +27,7 @@ declare global {
 
     type MemberWithUser<T extends GroupType> = Member<T> & { user: Amity.User | undefined };
 
-    type MembershipRaw<T extends GroupType, WithUser = false> = {
+    type RawMembership<T extends GroupType, WithUser = false> = {
       isBanned: boolean;
       isMuted: boolean;
       muteTimeout: string;
@@ -35,6 +35,6 @@ declare global {
     } & (WithUser extends true ? MemberWithUser<T> : Member<T>) &
       Amity.Accredited;
 
-    type Membership<T extends Amity.GroupType> = Amity.MembershipRaw<T, true>;
+    type Membership<T extends Amity.GroupType> = Amity.RawMembership<T, true>;
   }
 }

package/src/@types/global.ts

@@ -27,6 +27,16 @@ declare global {
   }
 
   type ValueOf<T extends Record<any, any>> = T[keyof T];
+
+  /**
+   *  Make properties required otherwise optional
+   */
+  type MakeRequired<T, K extends keyof T> = Required<Pick<T, K>> & Partial<T>;
+
+  /**
+   *  Make properties optional otherwise required
+   */
+  type MakeOptional<T, K extends keyof T> = Partial<Pick<T, K>> & Required<T>;
 }
 
 /*

package/src/cache/api/ingestInCache.ts

@@ -12,7 +12,7 @@ import { upsertInCache } from './upsertInCache';
  * @hidden
  */
 export const ingestInCache = (
-  payload: Record<string, Record<string, unknown>[]> = {},
+  payload: Record<keyof typeof PAYLOAD2MODEL, Amity.Model[]> = {},
   options?: Amity.CacheOptions,
 ) => {
   Object.entries(payload).forEach(([key, models]) => {
@@ -20,13 +20,10 @@ export const ingestInCache = (
     if (!type) return;
 
     const resolver = getResolver(type);
+    if (!resolver) return;
 
     models.forEach(model => {
-      upsertInCache(
-        [type, 'get', resolver(model as any)], // this 'any' cannot be avoided, sorry.
-        model,
-        options,
-      );
+      upsertInCache([type, 'get', resolver(model)], model, options);
     });
   });
 };

package/src/cache/api/tests/ingestInCache.test.ts

@@ -1,3 +1,4 @@
+import { prepareCommunityPayload } from '~/community/utils';
 import { PAYLOAD2MODEL, getResolver } from '~/core/model';
 
 import {
@@ -7,9 +8,7 @@ import {
   messagePayload,
   communityPayload,
   postPayload,
-  commentPayload,
   pollPayload,
-  reactionPayload,
   followPayload,
   feedPayload,
   user11,
@@ -22,16 +21,18 @@ describe('ingestInCache', () => {
   beforeAll(enableCache);
   afterAll(disableCache);
 
-  const payloads: [keyof Amity.Model, Record<string, Record<string, unknown>[]>][] = [
+  const payloads: [keyof Amity.Models, Record<string, Amity.Model[]>][] = [
     ['user', userPayload],
     ['role', rolePayload],
     ['channel', channelPayload],
     ['message', messagePayload],
-    ['community', communityPayload],
+    ['community', prepareCommunityPayload(communityPayload)],
     ['post', postPayload],
-    ['comment', commentPayload],
+    // FIXME: add support for commentChildren in model
+    // ['comment', textCommentPayload],
     ['poll', pollPayload],
-    ['reaction', reactionPayload],
+    // FIXME: correct reactions type in model
+    // ['reaction', reactionPayload],
     ['follow', followPayload],
     ['feed', feedPayload],
   ];
@@ -45,9 +46,10 @@ describe('ingestInCache', () => {
 
       expect(type).toBeDefined();
 
-      v.forEach(entity =>
-        expect(pullFromCache([type, 'get', resolver(entity as any)])).toBeDefined(),
-      );
+      v.forEach(entity => {
+        const received = pullFromCache([type, 'get', resolver(entity)]);
+        return expect(received).toBeDefined();
+      });
     });
   });
 
@@ -57,6 +59,7 @@ describe('ingestInCache', () => {
       users: [user11],
     };
 
+    // @ts-ignore
     ingestInCache(invalidPayload);
 
     expect(pullFromCache(['invalid', 'get', 'invalidId'])).toBeUndefined();

package/src/channel/api/addChannelMembers.ts

@@ -32,20 +32,20 @@ export const addChannelMembers = async (
     { channelId, userIds },
   );
 
-  const data = prepareChannelPayload(payload);
-
-  if (client.cache) ingestInCache(data);
-
   /*
    * should fire event for each user that was added
    */
   userIds.forEach(id =>
     fireEvent('channel.membersAdded', {
       ...payload,
-      channelUsers: data.channelUsers.filter(u => u.userId === id),
+      channelUsers: payload.channelUsers.filter(u => u.userId === id),
     }),
   );
 
+  const data = prepareChannelPayload(payload);
+
+  if (client.cache) ingestInCache(data);
+
   const { channelUsers } = data;
   return !!channelUsers.find(
     channelUser => channelUser.channelId === channelId && channelUser.membership === 'member',

package/src/channel/api/banChannelMembers.ts

@@ -1,7 +1,6 @@
 import { getActiveClient } from '~/client/api/activeClient';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
-import { prepareMembershipPayload } from '~/group/utils';
 
 import { prepareChannelPayload } from '../utils';
 
@@ -33,8 +32,7 @@ export const banChannelMembers = async (
     },
   );
 
-  const channelPayload = prepareChannelPayload(payload);
-  const preparedPayload = prepareMembershipPayload(channelPayload, 'channelUsers');
+  const preparedPayload = prepareChannelPayload(payload);
   const { channelUsers } = preparedPayload;
 
   const cachedAt = client.cache && Date.now();

package/src/channel/api/getChannel.ts

@@ -31,7 +31,7 @@ export const getChannel = async (
 
   isInTombstone('channel', channelId);
 
-  let data: Amity.ChannelPayload<any, Amity.Channel>;
+  let data: Amity.ProcessedChannelPayload;
 
   try {
     const { data: payload } = await client.http.get<Amity.ChannelPayload>(

package/src/channel/api/queryChannelMembers.ts

@@ -6,7 +6,6 @@ import { getResolver } from '~/core/model';
 
 import { pullFromCache, pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
-import { prepareMembershipPayload } from '~/group/utils';
 
 /**
  * ```js
@@ -42,8 +41,7 @@ export const queryChannelMembers = async (
   });
 
   const { paging, ...payload } = queryPayload;
-  const channelPayload = prepareChannelPayload(payload);
-  const preparedPayload = prepareMembershipPayload(channelPayload, 'channelUsers');
+  const preparedPayload = prepareChannelPayload(payload);
   const { channelUsers } = preparedPayload;
 
   const cachedAt = client.cache && Date.now();

package/src/channel/api/removeChannelMembers.ts

@@ -32,20 +32,20 @@ export const removeChannelMembers = async (
     { data: { channelId, userIds } },
   );
 
-  const data = prepareChannelPayload(payload);
-
-  if (client.cache) ingestInCache(data);
-
   /*
    * should fire event for each user that was removed
    */
   userIds.forEach(id =>
     fireEvent('channel.membersRemoved', {
       ...payload,
-      channelUsers: data.channelUsers.filter(u => u.userId === id),
+      channelUsers: payload.channelUsers.filter(u => u.userId === id),
     }),
   );
 
+  const data = prepareChannelPayload(payload);
+
+  if (client.cache) ingestInCache(data);
+
   const { channelUsers } = data;
   return !!channelUsers.find(
     channelUser => channelUser.channelId === channelId && channelUser.membership !== 'member',

package/src/channel/api/tests/addChannelMembers.test.ts

@@ -9,6 +9,7 @@ import {
   rawChannelUser3,
   channel1,
   user11,
+  channelUser,
 } from '~/utils/tests';
 
 import { onChannelMemberAdded } from '~/channel/events';
@@ -37,15 +38,15 @@ describe('addChannelMembers', () => {
     });
 
     const recieved = await addChannelMembers(channelId, [userId]);
-    const channelUser = pullFromCache<Amity.Membership<'channel'>>([
+    const recievedCache = pullFromCache<Amity.Membership<'channel'>>([
       'channelUsers',
       'get',
       channelUserCacheKey,
     ])?.data;
 
     expect(recieved).toBe(true);
-    expect(channelUser).toBeDefined();
-    expect(channelUser).toBe(rawChannelUser);
+    expect(recievedCache).toBeDefined();
+    expect(recievedCache).toEqual(channelUser);
 
     disableCache();
   });