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

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

@@ -0,0 +1,200 @@
+import { date, rolesAndPermissions, user11, user12, user13, user14, file11 } from '.';
+
+const mockPage = {
+  paging: {
+    previous: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
+    next: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
+  },
+};
+
+export const channelRaw1: Amity.ChannelRaw = {
+  tags: ['tag2'],
+  messageCount: 1,
+  createdAt: date,
+  isDeleted: false,
+  type: 'community',
+  channelId: 'channelId11',
+};
+
+export const channelRaw2: Amity.ChannelRaw = {
+  tags: ['tag1'],
+  messageCount: 3,
+  createdAt: date,
+  isDeleted: true,
+  type: 'conversation',
+  channelId: 'channelId12',
+};
+
+export const channelRaw3: Amity.ChannelRaw = {
+  messageCount: 3,
+  createdAt: date,
+  type: 'community',
+  channelId: 'channelId21',
+};
+
+export const channel11: Amity.Channel = {
+  ...channelRaw1,
+  hasMention: false,
+  unreadCount: 0,
+  type: 'community',
+};
+
+export const channel12: Amity.Channel = {
+  ...channelRaw2,
+  hasMention: true,
+  unreadCount: 2,
+};
+
+export const channel21: Amity.Channel = {
+  ...channelRaw3,
+  hasMention: false,
+  unreadCount: 0,
+  type: 'conversation',
+  isDeleted: true,
+  tags: ['tag1'],
+};
+
+export const channelUser1: Amity.MembershipRaw<'channel'> = {
+  isMuted: false,
+  createdAt: date,
+  muteTimeout: '',
+  isBanned: false,
+  readToSegment: 1,
+  lastActivity: date,
+  membership: 'member',
+  userId: user11.userId,
+  ...rolesAndPermissions,
+  lastMentionedSegment: 0,
+  channelId: channel11.channelId,
+};
+
+export const channelUser2: Amity.MembershipRaw<'channel'> = {
+  ...channelUser1,
+  readToSegment: 1,
+  lastMentionedSegment: 2,
+  channelId: channel12.channelId,
+};
+
+export const channelUser3: Amity.MembershipRaw<'channel'> = {
+  isMuted: false,
+  createdAt: date,
+  muteTimeout: '',
+  isBanned: false,
+  readToSegment: 1,
+  lastActivity: date,
+  userId: user12.userId,
+  ...rolesAndPermissions,
+  membership: 'none',
+  roles: ['test-role'],
+  lastMentionedSegment: 0,
+  channelId: channel11.channelId,
+};
+
+export const channelUser4: Amity.MembershipRaw<'channel'> = {
+  ...channelUser3,
+  userId: user13.userId,
+};
+
+export const channelUser5: Amity.MembershipRaw<'channel'> = {
+  isMuted: false,
+  createdAt: date,
+  muteTimeout: '',
+  isBanned: true,
+  readToSegment: 1,
+  lastActivity: date,
+  userId: user13.userId,
+  ...rolesAndPermissions,
+  membership: 'banned',
+  lastMentionedSegment: 0,
+  channelId: channel11.channelId,
+};
+
+export const channelUser6: Amity.MembershipRaw<'channel'> = {
+  isMuted: true,
+  createdAt: date,
+  muteTimeout: '',
+  isBanned: true,
+  readToSegment: 1,
+  lastActivity: date,
+  userId: 'test',
+  ...rolesAndPermissions,
+  membership: 'banned',
+  lastMentionedSegment: 0,
+  channelId: channel11.channelId,
+};
+
+export const channelUser7: Amity.MembershipRaw<'channel'> = {
+  ...channelUser3,
+  membership: 'member',
+  userId: user14.userId,
+};
+
+export const channelQueryResponse = {
+  data: {
+    channels: [channel11, channel12],
+    channelUsers: [],
+    files: [],
+    users: [],
+    ...mockPage,
+  },
+};
+
+export const channelQueryResponsePage2 = {
+  data: {
+    channels: [channel21],
+    channelUsers: [],
+    files: [],
+    users: [],
+    ...mockPage,
+  },
+};
+
+export const channelUserQueryResponse = {
+  data: {
+    channels: [channel11],
+    channelUsers: [channelUser1, channelUser3],
+    users: [user11, user12],
+    files: [],
+    ...mockPage,
+  },
+};
+
+export const channelUserModel = [
+  { ...channelUser1, user: user11 },
+  { ...channelUser3, user: user12 },
+];
+
+export const channelUserQueryResponsePage2 = {
+  data: {
+    channels: [channel11],
+    channelUsers: [channelUser4],
+    users: [user13],
+    files: [],
+    ...mockPage,
+  },
+};
+
+export const channelUserModel2 = [{ ...channelUser4, user: user13 }];
+
+export const channelUserQueryResponsePage3 = {
+  data: {
+    channels: [channel11],
+    channelUsers: [channelUser7, channelUser6],
+    users: [user11, user14],
+    files: [],
+    ...mockPage,
+  },
+};
+
+export const channelUserModel3 = [
+  { ...channelUser7, user: user14 },
+  { ...channelUser6, user: user11 },
+];
+
+// for testing ingest in cache
+export const channelPayload = {
+  channels: [channel11],
+  channelUsers: [channelUser7, channelUser6],
+  users: [user14, user11],
+  files: [file11],
+};

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

@@ -0,0 +1,92 @@
+import { baseMembership, date, user11, user12, file11 } from '.';
+
+const mockPage: Amity.Pagination = {
+  paging: {
+    previous: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
+    next: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
+  },
+};
+
+export const baseCommunity: Amity.Community = {
+  categoryIds: [],
+  channelId: '',
+  communityId: '',
+  createdAt: '',
+  displayName: '',
+  hasFlaggedComment: false,
+  hasFlaggedPost: false,
+  membersCount: 0,
+  path: '',
+  postsCount: 0,
+  userId: '',
+};
+
+export const community11: Amity.Community = {
+  ...baseCommunity,
+  isOfficial: false,
+  isPublic: true,
+  postsCount: 7,
+  membersCount: 1,
+  updatedAt: '2022-10-31T05:06:57.999Z',
+  createdAt: '2022-10-31T02:48:34.978Z',
+  isDeleted: false,
+  displayName: 'HardDelete1',
+  tags: [],
+  metadata: {},
+  hasFlaggedComment: false,
+  hasFlaggedPost: true,
+  communityId: 'community11',
+  channelId: '635f3782064bf304f786707d',
+  userId: user11.userId,
+  isJoined: false,
+  avatarFileId: undefined,
+  categoryIds: [],
+};
+
+export const communityUser11: Amity.MembershipRaw<'community'> = {
+  ...baseMembership,
+  communityMembership: 'member',
+  lastActivity: '2022-10-25T11:10:13.048Z',
+  updatedAt: '2022-10-25T11:10:13.048Z',
+  createdAt: '2022-10-25T11:10:13.048Z',
+  muteTimeout: '2022-10-25T11:10:13.048Z',
+  isMuted: false,
+  isBanned: false,
+  userId: 'test',
+  communityId: community11.communityId,
+  roles: ['channel-moderator', 'community-moderator'],
+  permissions: [Amity.Permission.CreateRolePermission],
+};
+
+export const communityUser12: Amity.MembershipRaw<'community'> = {
+  ...baseMembership,
+  createdAt: date,
+  lastActivity: date,
+  userId: user12.userId,
+  communityId: community11.communityId,
+  communityMembership: 'member',
+};
+
+export const communityPayload: Amity.CommunityPayload = {
+  communities: [community11],
+  communityUsers: [communityUser11],
+  files: [file11],
+  users: [user11],
+};
+
+export const communityUserQueryResponse = {
+  data: {
+    communities: [community11],
+    communityUsers: [communityUser11, communityUser12],
+    users: [user11, user12],
+    files: [],
+    categories: [],
+    feeds: [],
+    ...mockPage,
+  },
+};
+
+export const communityUserModel = [
+  { ...communityUser11, user: user11 },
+  { ...communityUser12, user: user12 },
+];

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

@@ -0,0 +1,20 @@
+export const file11: Amity.File<'image'> = {
+  fileId: 'file-Id',
+  fileUrl: 'https://fileUrl.com/test-file',
+  type: 'image',
+  createdAt: '2022-10-28T08:01:51.996Z',
+  updatedAt: '2022-10-28T08:01:51.996Z',
+  attributes: {
+    name: 'test.png',
+    extension: 'png',
+    size: '166904',
+    mimeType: 'image/png',
+    metadata: {
+      height: 966,
+      width: 1918,
+      isFull: false,
+      exif: {},
+      gps: {},
+    },
+  },
+};

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

@@ -0,0 +1,66 @@
+import { date, user11, user12, user13, user14 } from '.';
+
+const timeStamps: Amity.Timestamps = {
+  createdAt: date,
+  updatedAt: date,
+};
+
+// user11 follows user12
+export const follow11: Amity.FollowStatus = {
+  ...timeStamps,
+  to: user12.userId,
+  status: 'accepted',
+  from: user11.userId,
+};
+
+// user11 pineding user13
+export const follow12: Amity.FollowStatus = {
+  ...timeStamps,
+  status: 'pending',
+  to: user13.userId,
+  from: user11.userId,
+};
+
+// user14 declined user11
+export const follow13: Amity.FollowStatus = {
+  ...timeStamps,
+  status: 'none',
+  to: user14.userId,
+  from: user11.userId,
+};
+
+// user12 follows user11
+export const follow21: Amity.FollowStatus = {
+  ...timeStamps,
+  status: 'accepted',
+  to: user11.userId,
+  from: user12.userId,
+};
+
+// user13 pineding user11
+export const follow22: Amity.FollowStatus = {
+  ...timeStamps,
+  status: 'pending',
+  to: user11.userId,
+  from: user13.userId,
+};
+
+// user11 declined user14
+export const follow23: Amity.FollowStatus = {
+  ...timeStamps,
+  status: 'none',
+  to: user11.userId,
+  from: user14.userId,
+};
+
+export const follows = {
+  userId: user11.userId,
+  page1: [follow11, follow12, follow13],
+  page2: [follow21, follow22, follow23],
+};
+
+export const followPayload: Amity.FollowersPayload = {
+  users: [user11, user12],
+  files: [],
+  follows: [follow11, follow12],
+};

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

@@ -0,0 +1,19 @@
+export const date = new Date().toISOString();
+export const rolesAndPermissions = { roles: [], permissions: [] };
+
+export * from './user';
+export * from './role';
+export * from './file';
+
+export * from './post';
+
+export * from './poll';
+export * from './follow';
+export * from './reaction';
+
+export * from './channel';
+export * from './community';
+
+export * from './message';
+export * from './member';
+export * from './community';

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

@@ -0,0 +1,18 @@
+import { rolesAndPermissions } from '.';
+
+export const baseMembership: Amity.MembershipRaw<Amity.GroupType> = {
+  channelId: '',
+  communityId: '',
+  communityMembership: 'member',
+  createdAt: '',
+  isBanned: false,
+  isMuted: false,
+  lastActivity: '',
+  lastMentionedSegment: 0,
+  membership: 'member',
+  muteTimeout: '',
+  readToSegment: 0,
+  updatedAt: '',
+  userId: '',
+  ...rolesAndPermissions,
+};

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

@@ -0,0 +1,42 @@
+import { date, channel11, user11, file11 } from '.';
+
+export const message11: Amity.Message = {
+  fileId: null,
+  type: 'text',
+  reactions: {},
+  editedAt: date,
+  createdAt: date,
+  reactionsCount: 0,
+  channelSegment: 1,
+  childrenNumber: 0,
+  userId: user11.userId,
+  messageId: 'message11',
+  channelId: channel11.channelId,
+  data: { text: 'message1' },
+};
+
+export const messages = {
+  channelId: 'channelId',
+  page1: [message11.messageId, 'messageId12', 'messageId13'],
+  page2: ['messageId21', 'messageId22', 'messageId23'],
+  page3: ['messageId31', 'messageId32', 'messageId33'],
+};
+
+export const messageQueryResponse = {
+  data: {
+    messages: [message11],
+    files: [],
+    users: [],
+    paging: {
+      previous: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
+      next: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
+    },
+  },
+};
+
+// for testing ingest in cache
+export const messagePayload = {
+  messages: [message11],
+  files: [file11],
+  users: [user11],
+};

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

@@ -0,0 +1,43 @@
+import { user11 } from '.';
+
+export const poll11: Amity.Poll = {
+  pollId: 'c7b7c3e52be052be3fd5b5f0b4033d501667195535489',
+  userId: 'test',
+  question: 'Yellow',
+  answers: [
+    {
+      dataType: 'text',
+      data: '1',
+      isVotedByUser: false,
+      voteCount: 0,
+      id: '635f628f651eeb361624a8b6',
+    },
+    {
+      dataType: 'text',
+      data: '2',
+      isVotedByUser: false,
+      voteCount: 0,
+      id: '635f628f651eeb619424a8b7',
+    },
+    {
+      dataType: 'text',
+      data: '3',
+      isVotedByUser: false,
+      voteCount: 0,
+      id: '635f628f651eeb391f24a8b8',
+    },
+  ],
+  answerType: 'single',
+  closedAt: '2022-11-30T05:52:15.489Z',
+  createdAt: '2022-10-31T05:52:15.493Z',
+  updatedAt: '2022-10-31T05:52:15.493Z',
+  isVoted: false,
+  status: 'open',
+  closedIn: 2592000000,
+  isDeleted: false,
+};
+
+export const pollPayload: Amity.PollPayload = {
+  polls: [poll11],
+  users: [user11],
+};

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

@@ -0,0 +1,92 @@
+import { user11, file11, communityUser11, date } 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 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 const post12: Amity.Post = {
+  ...post11,
+  postId: 'post12',
+};
+
+export const post13: Amity.Post = {
+  ...post11,
+  postId: 'post13',
+};
+
+export const posts = {
+  targetId: user11.userId,
+  targetType: 'user' as Amity.PostTargetType,
+  page1: [post11.postId, post12.postId, post13.postId],
+  page2: ['postId21', 'postId22', 'postId23'],
+  page3: ['postId31', 'postId32', 'postId33'],
+};
+
+export const commentPayload: Amity.CommentPayload = {
+  comments: [comment11],
+  users: [user11],
+};
+
+export const postPayload: Amity.PostPayload = {
+  posts: [post11],
+  users: [user11],
+  files: [file11],
+  comments: [comment11],
+  communityUsers: [],
+};
+
+const nextPage = encodeJson({ before: post13.postId, limit: 10 });
+
+export const postQueryResponse = {
+  data: {
+    posts: [post11, post12, post13],
+    files: [],
+    paging: {
+      next: nextPage,
+    },
+  },
+};

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

@@ -0,0 +1,22 @@
+import { post11, user11 } from '.';
+
+export const reaction11: Amity.Reaction = {
+  reactionName: 'reaction11',
+  reactionId: 'reaction11',
+  referenceId: post11.postId,
+  referenceType: 'post',
+  userId: user11.userId,
+  createdAt: '',
+};
+
+export const reactor11: Amity.Reactor = {
+  reactionName: 'reaction11',
+  reactionId: 'reaction11',
+  userId: user11.userId,
+  createdAt: '',
+};
+
+export const reactionPayload: Amity.ReactionPayload = {
+  reactions: [{ ...reaction11, reactors: [reactor11] }],
+  users: [user11],
+};

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

@@ -0,0 +1,21 @@
+export const role11: Amity.Role = {
+  roleId: 'channel moderator',
+  displayName: 'channel moderator',
+  createdAt: '2022-10-31T04:03:56.786Z',
+  updatedAt: '2022-10-31T04:03:56.786Z',
+  permissions: [],
+  isDeleted: false,
+};
+
+export const role12: Amity.Role = {
+  roleId: 'test',
+  displayName: 'test',
+  createdAt: '2022-10-26T04:33:17.344Z',
+  updatedAt: '2022-10-26T04:33:17.344Z',
+  permissions: [],
+  isDeleted: false,
+};
+
+export const rolePayload: Amity.RolePayload = {
+  roles: [role11, role12],
+};

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

@@ -0,0 +1,44 @@
+import { date, rolesAndPermissions } from '.';
+
+export const user11: Amity.User = {
+  _id: '',
+  path: '',
+  flagCount: 0,
+  userId: 'test',
+  hashFlag: null,
+  createdAt: date,
+  ...rolesAndPermissions,
+};
+
+export const user12: Amity.User = {
+  ...user11,
+  userId: 'user2',
+};
+
+export const user13: Amity.User = {
+  ...user11,
+  userId: 'user3',
+};
+
+export const user14: Amity.User = {
+  ...user11,
+  userId: 'user4',
+};
+
+export const userQueryResponse = {
+  data: {
+    users: [user11, user12],
+    files: [],
+    paging: {
+      previous: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
+      next: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
+    },
+  },
+};
+export const users = [user11, user12, user13, user14];
+
+// user payload with file
+export const userPayload: Amity.UserPayload = {
+  users: [user11, user12],
+  files: [{ fileId: 'test-file-id' } as Amity.File<'image'>],
+};

package/src/utils/tests/index.ts

@@ -0,0 +1,3 @@
+export * from './utils';
+export * from './dummy';
+export * from './client';

package/src/utils/tests/utils.ts

@@ -0,0 +1,13 @@
+import { encode } from 'js-base64';
+
+export const encodeJson = (value: Record<string, any>) => encode(JSON.stringify(value));
+
+/*
+ * Used instead of asserting an async request is completed, when the async
+ * request is not the API being tested. This util makes tests readable by moving
+ * all assertions to the end of the test
+ */
+export const pause = (ms = 50) =>
+  new Promise(resolve => {
+    setTimeout(resolve, ms);
+  });