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

package/src/user/tests/observers/liveUser.test.ts

@@ -1,6 +1,4 @@
-import { ASCApiError } from '~/core/errors';
 import { disableCache, enableCache } from '~/cache/api';
-import { LIVE_OBJECT_ENABLE_CACHE_MESSAGE } from '~/utils/constants';
 import {
   client,
   connectClient,
@@ -29,161 +27,10 @@ describe('liveUser', () => {
     await disconnectClient();
   });
 
-  beforeEach(async () => {
-    enableCache();
-  });
+  beforeEach(enableCache);
 
   afterEach(disableCache);
 
-  test('it should show user if cache not enabled', () => {
-    /*
-     * NOTE: at the time of writing this test cache is diabled by default, but
-     * there is a proposal to enable cache by default. So I'm disabling cache
-     * here to ensure cache is disabled
-     */
-    disableCache();
-
-    const callback = jest.fn();
-    jest.spyOn(global.console, 'log');
-    client.http.get = jest.fn();
-
-    // call liveUser check if mocked console get's called with the correct
-    // user
-    client.use();
-    liveUser(defaultUser.userId, callback);
-
-    expect(console.log).toBeCalledWith(LIVE_OBJECT_ENABLE_CACHE_MESSAGE);
-  });
-
-  test('it should return user live object', async () => {
-    const snapshot = getSnapshot();
-
-    // mock response of queryUsers and validate
-    const callback = jest.fn();
-    client.http.get = jest.fn().mockResolvedValue(userQueryResponse);
-
-    liveUser(defaultUser.userId, callback);
-
-    expect(callback).toHaveBeenCalledTimes(1);
-
-    // check if cache data returned (should be empty)
-    expect(callback).toHaveBeenCalledWith(expect.objectContaining(snapshot));
-
-    await pause();
-
-    expect(callback).toHaveBeenCalledTimes(2);
-
-    snapshot.loading = false;
-    snapshot.data = defaultUser;
-
-    expect(callback).toHaveBeenCalledWith(expect.objectContaining(snapshot));
-  });
-
-  test('it should return error on api failure', async () => {
-    const snapshot = getSnapshot();
-    const error = new ASCApiError(
-      'server error!',
-      Amity.ServerError.ITEM_NOT_FOUND,
-      Amity.ErrorLevel.ERROR,
-    );
-
-    // mock response of queryUsers and validate
-    const callback = jest.fn();
-    client.http.get = jest.fn().mockRejectedValue(error);
-
-    liveUser(defaultUser.userId, callback);
-
-    expect(callback).toHaveBeenCalledTimes(1);
-
-    // check if cache data returned (should be empty)
-    expect(callback).toHaveBeenCalledWith(expect.objectContaining(snapshot));
-
-    await pause();
-
-    expect(callback).toHaveBeenCalledTimes(2);
-
-    snapshot.error = error;
-    snapshot.loading = false;
-    expect(callback).toHaveBeenLastCalledWith(expect.objectContaining(snapshot));
-  });
-
-  test('it should terminate updates on api failure', async () => {
-    const snapshot = getSnapshot();
-    const error = new ASCApiError(
-      'server error!',
-      Amity.ServerError.ITEM_NOT_FOUND,
-      Amity.ErrorLevel.ERROR,
-    );
-
-    // mock response of queryUsers and validate
-    const callback = jest.fn();
-    client.http.get = jest.fn().mockRejectedValue(error);
-
-    liveUser(defaultUser.userId, callback);
-
-    expect(callback).toHaveBeenCalledTimes(1);
-
-    // check if cache data returned (should be empty)
-    expect(callback).toHaveBeenCalledWith(expect.objectContaining(snapshot));
-
-    await pause();
-
-    expect(callback).toHaveBeenCalledTimes(2);
-
-    snapshot.error = error;
-    snapshot.loading = false;
-    expect(callback).toHaveBeenLastCalledWith(expect.objectContaining(snapshot));
-
-    const updatedAt = new Date(defaultUser?.updatedAt ?? new Date());
-    updatedAt.setDate(updatedAt.getDate() + 7);
-
-    const updatedUser = {
-      ...defaultUser,
-      updatedAt: updatedAt.toISOString(),
-    };
-    client.emitter.emit('user.updated', { users: [updatedUser], files: [] });
-
-    delete snapshot.error;
-    snapshot.loading = false;
-    snapshot.data = updatedUser;
-    expect(callback).not.toHaveBeenNthCalledWith(3, expect.objectContaining(snapshot));
-  });
-
-  test('it should not return updates on obtain once!', async () => {
-    const snapshot = getSnapshot();
-
-    // mock response of queryUsers and validate
-    const callback = jest.fn();
-    client.http.get = jest.fn().mockResolvedValue(userQueryResponse);
-
-    const unsub = liveUser(defaultUser.userId, callback);
-
-    expect(callback).toHaveBeenCalledTimes(1);
-
-    // check if cache data returned (should be empty)
-    expect(callback).toHaveBeenCalledWith(expect.objectContaining(snapshot));
-
-    await pause();
-
-    expect(callback).toHaveBeenCalledTimes(2);
-
-    unsub();
-
-    const updatedAt = new Date(defaultUser?.updatedAt ?? new Date());
-    updatedAt.setDate(updatedAt.getDate() + 7);
-
-    const updatedUser = {
-      ...defaultUser,
-      updatedAt: updatedAt.toISOString(),
-    };
-    client.emitter.emit('user.updated', { users: [updatedUser], files: [] });
-
-    delete snapshot.error;
-    snapshot.loading = false;
-    snapshot.data = updatedUser;
-    expect(callback).not.toHaveBeenNthCalledWith(3, expect.objectContaining(snapshot));
-  });
-
   const events: [string, keyof Amity.Events][] = [
     ['it should return updated user on onFetch', 'user.fetched'],
     ['it should return updated user on onUpdate', 'user.updated'],

package/src/utils/liveObject.ts

@@ -0,0 +1,86 @@
+import { getActiveClient } from '~/client/api';
+import {
+  LIVE_OBJECT_ENABLE_CACHE_MESSAGE,
+  UNSYNCED_OBJECT_CACHED_AT_MESSAGE,
+  UNSYNCED_OBJECT_CACHED_AT_VALUE,
+} from '~/utils/constants';
+import { hasUpdates } from '~/core/model';
+import { createQuery, runQuery } from '~/core/query';
+import { ASCApiError } from '~/core/errors';
+
+export const liveObject = <
+  T extends Exclude<Amity.Model[Amity.Domain], Amity.Reaction | Amity.FollowCount>,
+  K extends keyof T,
+>(
+  id: T[K],
+  callback: Amity.LiveObjectCallback<T>,
+  key: K,
+  fetcher: (id: T[K]) => Promise<Amity.Cached<T>>,
+  eventHandlers: Array<(callback: Amity.Listener<T>) => Amity.Unsubscriber>,
+): Amity.Unsubscriber => {
+  const { cache } = getActiveClient();
+
+  if (!cache) {
+    console.log(LIVE_OBJECT_ENABLE_CACHE_MESSAGE);
+  }
+
+  let model: T;
+  let isUnsyncedModel = false; // for messages
+  const disposers: Amity.Unsubscriber[] = [];
+
+  const dispatcher = (data: Amity.LiveObject<T>) => {
+    model = data.data;
+    callback(data);
+  };
+
+  const realtimeRouter = (eventModel: T) => {
+    if (id !== eventModel[key]) {
+      return;
+    }
+
+    if (model && !hasUpdates(model, eventModel)) {
+      return;
+    }
+
+    dispatcher({ loading: false, data: eventModel, origin: 'event' });
+  };
+
+  const onFetch = () => {
+    // @ts-ignore
+    const query = createQuery(fetcher, id, true);
+
+    runQuery(query, ({ error, data, loading, origin, cachedAt }) => {
+      if (cachedAt === UNSYNCED_OBJECT_CACHED_AT_VALUE) {
+        dispatcher({
+          // @ts-ignore
+          data,
+          origin,
+          loading: false,
+          error: new ASCApiError(
+            UNSYNCED_OBJECT_CACHED_AT_MESSAGE,
+            Amity.ClientError.DISALOOW_UNSYNCED_OBJECT,
+            Amity.ErrorLevel.ERROR,
+          ),
+        });
+
+        isUnsyncedModel = true;
+        disposers.forEach(fn => fn());
+      } else if (!isUnsyncedModel) {
+        // @ts-ignore
+        dispatcher({ loading, data, origin, error });
+      }
+
+      if (error) {
+        disposers.forEach(fn => fn());
+      }
+    });
+  };
+
+  disposers.push(...eventHandlers.map(fn => fn(realtimeRouter)));
+
+  onFetch();
+
+  return () => {
+    disposers.forEach(fn => fn());
+  };
+};

package/src/utils/tests/dummy/category.ts

@@ -0,0 +1,57 @@
+export const category11 = {
+  name: 'a-hello',
+  updatedAt: '2022-11-25T04:19:34.446Z',
+  createdAt: '2022-11-25T04:19:34.446Z',
+  isDeleted: false,
+  categoryId: '2ddea5ad242d0a2bd5dc5be8ae9fc8c2',
+};
+
+export const category12 = {
+  name: 'b-testing-category',
+  updatedAt: '2022-11-25T03:56:06.238Z',
+  createdAt: '2022-11-25T03:56:06.238Z',
+  isDeleted: false,
+  categoryId: '88d175da65cbfeb39b81e722b322430e',
+};
+
+export const category13 = {
+  name: 'c-deleted-category',
+  updatedAt: '2022-11-25T03:56:06.238Z',
+  createdAt: '2022-11-25T03:56:06.238Z',
+  isDeleted: true,
+  categoryId: '88d175da65cbfeb39b81e722b322430d',
+};
+
+export const category21 = {
+  name: 'a-0asd',
+  updatedAt: '2022-11-25T04:18:59.180Z',
+  createdAt: '2022-11-25T04:18:59.180Z',
+  isDeleted: false,
+  categoryId: '10051d82a1f371c6be3a8f4a4654b8a1',
+};
+
+export const category22 = {
+  name: 'b-A Category',
+  updatedAt: '2022-11-25T03:56:29.037Z',
+  createdAt: '2022-11-25T03:56:29.037Z',
+  isDeleted: false,
+  categoryId: '639942c6b2f121bed3901cf4a4c296e7',
+};
+
+export const categoryQueryResponse = {
+  data: {
+    categories: [category11, category12, category13],
+    paging: {
+      next: 'eyJza2lwIjoxMCwibGltaXQiOjEwfQ==',
+    },
+  },
+};
+
+export const categoryQueryResponsePage2 = {
+  data: {
+    categories: [category21, category22],
+    paging: {
+      next: 'eyJza2lwIjoxMCwibGltaXQiOjEwfQ==',
+    },
+  },
+};

package/src/utils/tests/dummy/channel.ts

@@ -6,6 +6,7 @@ export function generateRawChannel(params?: Partial<Amity.ChannelRaw>): Amity.Ch
 
   return {
     _id: `${channelId}-internalId`,
+    lastActivity: '',
     channelId,
     createdAt: date,
     isDeleted: false,
@@ -54,7 +55,13 @@ export const mockPage = {
   },
 };
 
-export const channelRaw1: Amity.ChannelRaw = generateRawChannel();
+export const channelRaw1: Amity.ChannelRaw = generateRawChannel({ type: 'community' });
+
+export const channelRawLive1: Amity.ChannelRaw = generateRawChannel({ type: 'live' });
+
+export const channelRawConversation1: Amity.ChannelRaw = generateRawChannel({
+  type: 'conversation',
+});
 
 export const channelRaw2: Amity.ChannelRaw = generateRawChannel({
   channelId: 'channelId12',
@@ -132,6 +139,16 @@ export const channelQueryResponse = {
   },
 };
 
+export const getChannelsResponse = {
+  data: {
+    channels: [channelRaw1, channelRaw2, channelRaw3],
+    channelUsers: [],
+    files: [],
+    users: [],
+    ...mockPage,
+  },
+};
+
 export const channelQueryResponsePage2 = {
   data: {
     channels: [channelRaw3],
@@ -142,6 +159,26 @@ export const channelQueryResponsePage2 = {
   },
 };
 
+export const channelTagQueryResponse = {
+  data: {
+    channels: [channelRaw2],
+    channelUsers: [],
+    files: [],
+    users: [],
+    ...mockPage,
+  },
+};
+
+export const channelExcludeTagQueryResponse = {
+  data: {
+    channels: [channelRaw1, channelRaw3],
+    channelUsers: [],
+    files: [],
+    users: [],
+    ...mockPage,
+  },
+};
+
 export const channelUserQueryResponse = {
   data: {
     channels: [channelRaw1],
@@ -191,3 +228,17 @@ export const channelPayload = {
   users: [user14, user11],
   files: [file11],
 };
+
+export const liveChannelPayload = {
+  channels: [channelRawLive1],
+  channelUsers: [rawChannelUserWithRole, rawMutedChannelUser],
+  users: [user14, user11],
+  files: [file11],
+};
+
+export const conversationChannelPayload = {
+  channels: [channelRawConversation1],
+  channelUsers: [rawChannelUserWithRole, rawMutedChannelUser],
+  users: [user14, user11],
+  files: [file11],
+};

package/src/utils/tests/dummy/community.ts

@@ -106,3 +106,97 @@ export const communityUserModel = [
   { ...communityUser11, user: user11 },
   { ...communityUser12, user: user12 },
 ];
+
+export const communityRaw1 = {
+  path: '631f16be1e440400da5663b0/social/community/63c8e023d2474637568ece5e',
+  isOfficial: false,
+  isPublic: true,
+  onlyAdminCanPost: false,
+  postsCount: 0,
+  membersCount: 1,
+  moderatorMemberCount: 1,
+  updatedAt: '2023-01-19T06:16:03.818Z',
+  createdAt: '2023-01-19T06:16:03.818Z',
+  isDeleted: true,
+  needApprovalOnPostCreation: false,
+  displayName: 'community 1',
+  tags: ['test-community-tag'],
+  metadata: {},
+  hasFlaggedComment: false,
+  hasFlaggedPost: true,
+  communityId: '63c8e023d2474637568ece5e',
+  channelId: '63c8e023d2474637568ece5e',
+  userId: user11.userId,
+  isJoined: true,
+  avatarFileId: '',
+  categoryIds: ['test-category-id'],
+};
+
+export const communityRaw2 = {
+  path: '631f16be1e440400da5663b0/social/community/63c8cd098309f85d2ec7dad7',
+  isOfficial: false,
+  isPublic: true,
+  onlyAdminCanPost: false,
+  postsCount: 0,
+  membersCount: 1,
+  moderatorMemberCount: 1,
+  updatedAt: '2023-01-19T04:54:57.078Z',
+  createdAt: '2023-01-19T04:54:33.716Z',
+  isDeleted: false,
+  needApprovalOnPostCreation: false,
+  displayName: 'new community ....1',
+  tags: [],
+  metadata: {},
+  hasFlaggedComment: false,
+  hasFlaggedPost: false,
+  communityId: '63c8cd098309f85d2ec7dad7',
+  channelId: '63c8cd098309f85d2ec7dad7',
+  userId: user12.userId,
+  isJoined: false,
+  avatarFileId: '',
+  categoryIds: [],
+};
+
+export const communityQueryResponse = {
+  data: {
+    communities: [communityRaw1, communityRaw2],
+    communityUsers: [communityUser11],
+    categories: [
+      {
+        name: '$testing category',
+        metadata: {},
+        updatedAt: '2022-11-25T03:56:06.238Z',
+        createdAt: '2022-11-25T03:56:06.238Z',
+        isDeleted: false,
+        categoryId: '88d175da65cbfeb39b81e722b322430d',
+      },
+    ],
+    users: [user11, user12],
+    feeds: [],
+    paging: {
+      next: 'eyJza2lwIjoxMCwibGltaXQiOjEwfQ==',
+    },
+  },
+};
+
+export const communityQueryResponsePage2 = {
+  data: {
+    communities: [communityRaw1],
+    communityUsers: [communityUser11],
+    categories: [
+      {
+        name: '$testing category',
+        metadata: {},
+        updatedAt: '2022-11-25T03:56:06.238Z',
+        createdAt: '2022-11-25T03:56:06.238Z',
+        isDeleted: false,
+        categoryId: '88d175da65cbfeb39b81e722b322430d',
+      },
+    ],
+    users: [user11, user12],
+    feeds: [],
+    paging: {
+      next: 'eyJza2lwIjoxMCwibGltaXQiOjEwfQ==',
+    },
+  },
+};

package/src/utils/tests/dummy/feed.ts

@@ -0,0 +1,13 @@
+export const feed11 = {
+  targetType: 'community',
+  targetId: '6396a419becb56760a7b0bb9',
+  feedType: 'published',
+  feedId: '16708167935683a5eb158a39f40ffbdd49b7f70dc9bfd',
+  postCount: 4,
+  createdAt: '2022-12-12T03:46:33.557Z',
+  updatedAt: '2022-12-12T05:51:37.927Z',
+};
+
+export const feedPayload = {
+  feeds: [feed11],
+};

package/src/utils/tests/dummy/file.ts

@@ -1,3 +1,5 @@
+import MockFormData from 'form-data';
+
 export const file11: Amity.File<'image'> = {
   fileId: 'file-Id',
   fileUrl: 'https://fileUrl.com/test-file',
@@ -18,3 +20,33 @@ export const file11: Amity.File<'image'> = {
     },
   },
 };
+
+export const file12: Amity.File<'video'> = {
+  fileId: 'file-Id-12',
+  feedType: 'post',
+  status: 'uploaded',
+  fileUrl: 'https://fileUrl.com/test-file',
+  type: 'video',
+  createdAt: '2023-01-20T18:37:19.583Z',
+  updatedAt: '2023-01-20T18:37:19.583Z',
+  attributes: {
+    name: 'test.mp4',
+    extension: 'mp4',
+    size: '3652304',
+    mimeType: 'video/mp4',
+    metadata: {},
+  },
+};
+
+export const createFileFormData = () => {
+  const fd = new MockFormData() as unknown as FormData;
+  fd.append('files', 'file');
+  fd.getAll = jest.fn().mockImplementation(() => ['file']);
+  return fd;
+};
+
+export const createEmptyFormData = () => {
+  const fd = new MockFormData() as unknown as FormData;
+  fd.getAll = jest.fn().mockImplementation(() => []);
+  return fd;
+};

package/src/utils/tests/dummy/index.ts

@@ -18,5 +18,8 @@ export * from './message';
 export * from './token';
 export * from './member';
 export * from './community';
+export * from './category';
 
 export * from './stream';
+
+export * from './feed';

package/src/utils/tests/dummy/post.ts

@@ -1,52 +1,64 @@
-import { user11, file11, communityUser11, date } from '.';
+import { user11, file11, date, feed11 } from '.';
 import { encodeJson } from '..';
 
-export const post11: Amity.Post = {
-  path: '',
-  feedId: '',
-  children: [],
-  comments: [],
-  flagCount: 0,
-  reactions: {},
-  hashFlag: null,
-  editedAt: date,
-  createdAt: date,
-  commentsCount: 0,
-  reactionsCount: 0,
-  postId: 'postId11',
-  targetType: 'user',
-  parentId: 'postId12',
-  data: { text: 'post11' },
-  targetId: user11.userId,
-  hasFlaggedComment: false,
-  hasFlaggedChildren: false,
-  postedUserId: user11.userId,
-};
+export function generatePost(params?: Partial<Amity.Post>): Amity.Post {
+  return {
+    children: [],
+    comments: [],
+    commentsCount: 0,
+    createdAt: date,
+    data: { text: 'post11' },
+    editedAt: date,
+    feedId: '',
+    flagCount: 0,
+    hashFlag: null,
+    hasFlaggedComment: false,
+    hasFlaggedChildren: false,
+    parentId: 'postId12',
+    path: '',
+    postedUserId: user11.userId,
+    postId: 'postId11',
+    isDeleted: false,
+    reactions: {},
+    reactionsCount: 0,
+    targetId: user11.userId,
+    targetType: 'user',
+    updatedAt: date,
+    ...params,
+  };
+}
 
-export const comment11: Amity.Comment = {
-  path: '',
-  referenceType: 'post',
-  dataType: 'text',
-  rootId: 'test',
-  data: {
-    text: 'yellow new world',
-  },
-  childrenNumber: 0,
-  isDeleted: false,
-  editedAt: '2022-10-31T05:57:45.661Z',
-  updatedAt: '2022-10-31T05:57:45.670Z',
-  createdAt: '2022-10-31T05:57:45.661Z',
-  segmentNumber: 2,
-  commentId: 'comment11',
-  userId: 'test',
-  referenceId: post11.postId,
-  flagCount: 0,
-  hashFlag: null,
-  children: [],
-  mentionees: [],
-  reactions: {},
-  reactionsCount: 0,
-};
+export function generateComment(params?: Partial<Amity.Comment>): Amity.Comment {
+  return {
+    path: '',
+    referenceType: 'post',
+    dataType: 'text',
+    rootId: 'test',
+    data: {
+      text: 'yellow new world',
+    },
+    childrenNumber: 0,
+    isDeleted: false,
+    editedAt: '2022-10-31T05:57:45.661Z',
+    updatedAt: '2022-10-31T05:57:45.670Z',
+    createdAt: '2022-10-31T05:57:45.661Z',
+    segmentNumber: 2,
+    commentId: 'comment11',
+    userId: 'test',
+    referenceId: 'postId11',
+    flagCount: 0,
+    hashFlag: null,
+    children: [],
+    mentionees: [],
+    reactions: {},
+    reactionsCount: 0,
+    ...params,
+  };
+}
+
+export const post11: Amity.Post = generatePost();
+
+export const comment11: Amity.Comment = generateComment();
 
 export const post12: Amity.Post = {
   ...post11,
@@ -62,6 +74,7 @@ export const post14: Amity.Post = {
   ...post11,
   postId: 'post14',
   targetType: 'community',
+  feedId: 'feedId',
   isDeleted: false,
   children: [],
 };
@@ -71,6 +84,7 @@ export const post15: Amity.Post = {
   postId: 'post15',
   isDeleted: true,
   children: [post11.postId],
+  feedId: 'feedId',
   targetType: 'community',
   tags: ['test_tag'],
 };
@@ -117,8 +131,9 @@ export const postQueryResponse = {
 
 export const postQueryResponsePage2 = {
   data: {
-    posts: [post14, post15, post16],
+    posts: [post14, post15],
     files: [],
+    feeds: [{ ...feed11, feedType: 'reviewing', targetId: post14.targetId, feedId: post14.feedId }],
     paging: {
       next: nextPage,
     },