@amityco/ts-sdk 0.0.1-cb052d5.0 → 0.0.1-cb5cdb1.0

package/src/comment/observers/liveComments.ts

@@ -0,0 +1,174 @@
+/* eslint-disable no-use-before-define */
+import { getResolver } from '~/core/model';
+import { getActiveClient } from '~/client/api';
+import { pushToCache, pullFromCache } from '~/cache/api';
+import {
+  createQuery,
+  runQuery,
+  queryOptions,
+  filterByPropEquality,
+  sortByFirstCreated,
+  sortByLastCreated,
+} from '~/core/query';
+
+import {
+  COLLECTION_DEFAULT_CACHING_POLICY,
+  COLLECTION_DEFAULT_PAGINATION_LIMIT,
+} from '~/utils/constants';
+
+import {
+  onCommentCreated,
+  onCommentUpdated,
+  onCommentDeleted,
+  onCommentFlagged,
+  onCommentUnflagged,
+  onCommentReactionAdded,
+  onCommentReactionRemoved,
+} from '../events';
+import { queryComments } from '../api';
+
+/**
+ * ```js
+ * import { liveComments } from '@amityco/ts-sdk'
+ *
+ * let comments = []
+ * const unsub = liveComments({
+ *   referenceType: Amity.Comment['referenceType'];
+ *   referenceId: Amity.Comment['referenceId'];
+ * }, response => merge(comments, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.Comment} for a given target object
+ *
+ * @param referenceType the type of the target
+ * @param referenceId the ID of the target
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the messages
+ *
+ * @category Comments Live Collection
+ */
+export const liveComments = (
+  params: Amity.CommentLiveCollection,
+  callback: Amity.LiveCollectionCallback<Amity.Comment>,
+  config?: Amity.LiveCollectionConfig,
+): Amity.Unsubscriber => {
+  const { log, cache } = getActiveClient();
+
+  if (!cache) {
+    console.log('For using Live Collection feature you need to enable Cache!');
+  }
+
+  const timestamp = Date.now();
+  log(`liveComments(tmpid: ${timestamp}) > listen`);
+
+  const { limit: queryLimit, ...queryParams } = params;
+
+  const limit = queryLimit ?? COLLECTION_DEFAULT_PAGINATION_LIMIT;
+  const { policy = COLLECTION_DEFAULT_CACHING_POLICY } = config ?? {};
+
+  const disposers: Amity.Unsubscriber[] = [];
+  const cacheKey = [
+    'comment',
+    'collection',
+    { referenceId: params.referenceType, referenceType: params.referenceId },
+  ];
+
+  const responder = (data: Amity.CommentLiveCollectionCache) => {
+    let comments: Amity.Comment[] =
+      data.data
+        .map(commentId => pullFromCache<Amity.Comment>(['comment', 'get', commentId])!)
+        .filter(Boolean)
+        .map(({ data }) => data) ?? [];
+
+    if (params.includeDeleted === false) {
+      comments = filterByPropEquality(comments, 'isDeleted', false);
+    }
+
+    const sortBy = params.sortBy ? params.sortBy : 'lastCreated';
+
+    comments = comments.sort(sortBy === 'lastCreated' ? sortByLastCreated : sortByFirstCreated);
+
+    callback({
+      onNextPage: onFetch,
+      data: comments,
+      hasNextPage: !!data.params?.page,
+      loading: data.loading,
+      error: data.error,
+    });
+  };
+
+  const realtimeRouter = (action: Amity.CommentActionType) => (comment: Amity.Comment) => {
+    const collection = pullFromCache<Amity.CommentLiveCollectionCache>(cacheKey)?.data;
+
+    if (
+      params.referenceId !== comment.referenceId ||
+      params.referenceType !== comment.referenceType ||
+      !collection
+    )
+      return;
+
+    if (action === 'onCreate') {
+      collection.data = [...new Set([comment.commentId, ...collection.data])];
+    } else if (action === 'onDelete') {
+      collection.data = collection.data.filter(p => p !== comment.commentId);
+    }
+
+    pushToCache(cacheKey, collection);
+
+    responder(collection);
+  };
+
+  const onFetch = () => {
+    const collection = pullFromCache<Amity.CommentLiveCollectionCache>(cacheKey)?.data;
+
+    const comments = collection?.data ?? [];
+
+    if (comments.length > 0 && !collection?.params?.page) return;
+
+    const query = createQuery(queryComments, {
+      ...queryParams,
+      page: collection?.params?.page ?? { limit },
+    });
+
+    runQuery(
+      query,
+      ({ data: result, error, loading, prevPage, nextPage }) => {
+        // depend on sortBy value we have two different pagination type
+        const page = queryParams.sortBy ? nextPage : prevPage;
+
+        const data = {
+          loading,
+          error,
+          params: { page },
+          data: comments,
+        };
+
+        if (result) {
+          data.data = [...new Set([...comments, ...result.map(getResolver('comment'))])];
+        }
+
+        pushToCache(cacheKey, data);
+
+        responder(data);
+      },
+      queryOptions(policy),
+    );
+  };
+
+  disposers.push(
+    onCommentCreated(realtimeRouter('onCreate')),
+    onCommentUpdated(realtimeRouter('onUpdate')),
+    onCommentDeleted(realtimeRouter('onDelete')),
+    onCommentFlagged(realtimeRouter('onFlagged')),
+    onCommentUnflagged(realtimeRouter('onUnflagged')),
+    onCommentReactionAdded(realtimeRouter('onReactionAdded')),
+    onCommentReactionRemoved(realtimeRouter('onReactionRemoved')),
+  );
+
+  onFetch();
+
+  return () => {
+    log(`liveComments(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

package/src/comment/observers/observeComments.ts

@@ -48,17 +48,7 @@ export const observeComments = (
 
   const disposers: Amity.Unsubscriber[] = [];
 
-  const router = (
-    comment: Amity.Comment,
-    action:
-      | 'onCreate'
-      | 'onUpdate'
-      | 'onDelete'
-      | 'onFlagged'
-      | 'onUnflagged'
-      | 'onReactionAdded'
-      | 'onReactionRemoved',
-  ) => {
+  const router = (comment: Amity.Comment, action: Exclude<Amity.CommentActionType, 'onFetch'>) => {
     if (comment.referenceId !== postId) return;
 
     if (callback instanceof Function) return callback(comment);

package/src/comment/observers/tests/liveComment.test.ts

@@ -0,0 +1,111 @@
+import { disableCache, enableCache } from '~/cache/api';
+import {
+  pause,
+  client,
+  connectClient,
+  disconnectClient,
+  generateComment,
+  user12,
+} from '~/utils/tests';
+import { getFutureDate } from '~/core/model';
+
+import { liveComment } from '../liveComment';
+
+describe('liveComment', () => {
+  const comment = generateComment();
+  const response = { data: { comments: [comment] } };
+
+  beforeAll(async () => {
+    await connectClient();
+  });
+
+  afterAll(async () => {
+    await disconnectClient();
+  });
+
+  beforeEach(enableCache);
+
+  afterEach(disableCache);
+
+  const events: [string, keyof Amity.MqttCommentEvents][] = [
+    ['should get update on comment.updated event', 'comment.updated'],
+    ['should get update on comment.deleted event', 'comment.deleted'],
+    ['should get update on comment.flagged event', 'comment.flagged'],
+    ['should get update on comment.unflagged event', 'comment.unflagged'],
+  ];
+
+  test.each(events)('%s', async (test, event) => {
+    const update = {
+      ...comment,
+      data: { text: 'new-text' },
+      updatedAt: getFutureDate(comment.updatedAt),
+    };
+
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(response);
+
+    liveComment(comment.commentId, callback);
+    await pause();
+
+    client.emitter.emit(event, {
+      comments: [update],
+      commentChildren: [],
+      users: [],
+      files: [],
+    });
+
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(3);
+    expect(callback).toHaveBeenNthCalledWith(
+      3,
+      expect.objectContaining({
+        data: update,
+        loading: false,
+      }),
+    );
+  });
+
+  test.each([
+    ['should get update on comment.addReaction event', 'comment.addReaction'],
+    ['should get update on comment.removeReaction event', 'comment.removeReaction'],
+  ] as [string, keyof Amity.MqttCommentEvents][])('%s', async (test, event) => {
+    const update = {
+      ...comment,
+      data: { text: 'new-text' },
+      updatedAt: getFutureDate(comment.updatedAt),
+    };
+    const reactor: Amity.Reaction = {
+      createdAt: getFutureDate(comment.updatedAt),
+      reactionId: 'like',
+      reactionName: 'like',
+      referenceId: comment.commentId,
+      referenceType: 'comment',
+      userId: user12.userId,
+    };
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(response);
+
+    liveComment(comment.commentId, callback);
+    await pause();
+
+    client.emitter.emit(event, {
+      comments: [update],
+      reactor,
+      commentChildren: [],
+      users: [],
+      files: [],
+    });
+
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(3);
+    expect(callback).toHaveBeenNthCalledWith(
+      3,
+      expect.objectContaining({
+        data: update,
+        loading: false,
+      }),
+    );
+  });
+});

package/src/community/api/addCommunityMembers.ts

@@ -2,7 +2,11 @@ import { getActiveClient } from '~/client/api';
 
 import { fireEvent } from '~/core/events';
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: community.membership.add_members
+*/
 /**
  * ```js
  * import { addCommunityMembers } from '@amityco/ts-sdk'
@@ -25,14 +29,16 @@ export const addCommunityMembers = async (
   const client = getActiveClient();
   client.log('community/addCommunityMembers', communityId, userIds);
 
-  const { data } = await client.http.post<Amity.CommunityMembershipPayload>(
+  const { data: payload } = await client.http.post<Amity.CommunityMembershipPayload>(
     `/api/v3/communities/${communityId}/users`,
     { communityId, userIds },
   );
 
-  if (client.cache) ingestInCache(data);
+  fireEvent('community.userAdded', payload);
+
+  const data = prepareMembershipPayload(payload, 'communityUsers');
 
-  fireEvent('community.userAdded', data);
+  if (client.cache) ingestInCache(data);
 
   const { communityUsers } = data;
   return !!communityUsers.find(
@@ -40,3 +46,4 @@ export const addCommunityMembers = async (
       communityUser.communityId === communityId && communityUser.communityMembership === 'member',
   );
 };
+/* end_public_function */

package/src/community/api/addCommunityMembersRoles.ts

@@ -1,7 +1,11 @@
 import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: community.moderation.add_roles
+*/
 /**
  * ```js
  * import { addCommunityMembersRoles } from '@amityco/ts-sdk'
@@ -12,7 +16,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
  *
  * @param communityId The ID of the {@link Amity.Community} to perform
  * @param roleIds Array of IDs of the {@link Amity.Role} to apply
- * @param userId Array of IDs of the {@link Amity.User} to perform
+ * @param userIds Array of IDs of the {@link Amity.User} to perform
  * @returns A success boolean if the {@link Amity.Role} were added to list of {@link Amity.User} in the {@link Amity.Community}
  *
  * @category Community API
@@ -26,11 +30,13 @@ export const addCommunityMembersRoles = async (
   const client = getActiveClient();
   client.log('community/addCommunityMembersRoles', communityId, roleIds, userIds);
 
-  const { data } = await client.http.post<Amity.CommunityMembershipPayload>(
+  const { data: payload } = await client.http.post<Amity.CommunityMembershipPayload>(
     `/api/v4/communities/${communityId}/users/roles`,
     { communityId, roles: roleIds, userIds },
   );
 
+  const data = prepareMembershipPayload(payload, 'communityUsers');
+
   if (client.cache) ingestInCache(data);
 
   const { communityUsers } = data;
@@ -40,3 +46,4 @@ export const addCommunityMembersRoles = async (
       roleIds.some(role => communityUser.roles.includes(role)),
   );
 };
+/* end_public_function */

package/src/community/api/createCommunity.ts

@@ -3,6 +3,11 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
 
+import { prepareCommunityRequest, prepareCommunityPayload } from '../utils';
+
+/* begin_public_function
+  id: community.create
+*/
 /**
  * ```js
  * import { createCommunity } from '@amityco/ts-sdk'
@@ -25,8 +30,7 @@ export const createCommunity = async (
     | 'description'
     | 'isPublic'
     | 'isOfficial'
-    | 'onlyAdminCanPost'
-    | 'needApprovalOnPostCreation'
+    | 'postSetting'
     | 'tags'
     | 'metadata'
   > & {
@@ -38,16 +42,22 @@ export const createCommunity = async (
   const client = getActiveClient();
   client.log('user/createCommunity', bundle);
 
-  const { data } = await client.http.post<Amity.CommunityPayload>('/api/v3/communities/', bundle);
+  const { data: payload } = await client.http.post<Amity.CommunityPayload>(
+    '/api/v3/communities/',
+    prepareCommunityRequest(bundle),
+  );
+
+  fireEvent('community.created', payload);
+
+  const data = prepareCommunityPayload(payload);
 
   const cachedAt = client.cache && Date.now();
   if (client.cache) ingestInCache(data, { cachedAt });
 
-  fireEvent('community.created', data);
-
   const { communities } = data;
   return {
     data: communities[0],
     cachedAt,
   };
 };
+/* end_public_function */

package/src/community/api/deleteCommunity.ts

@@ -3,6 +3,9 @@ import { getActiveClient } from '~/client/api';
 import { fireEvent } from '~/core/events';
 import { getCommunity } from './getCommunity';
 
+/* begin_public_function
+  id: community.delete
+*/
 /**
  * ```js
  * import { deleteCommunity } from '@amityco/ts-sdk'
@@ -27,7 +30,16 @@ export const deleteCommunity = async (
   await client.http.delete<{ success: boolean }>(`/api/v3/communities/${communityId}`);
 
   const deleted = await getCommunity(communityId);
-  fireEvent('community.deleted', { communities: [deleted.data] });
+
+  fireEvent('community.deleted', {
+    communities: [deleted.data],
+    categories: [],
+    communityUsers: [],
+    feeds: [],
+    files: [],
+    users: [],
+  });
 
   return deleted.data;
 };
+/* end_public_function */

package/src/community/api/getCommunities.ts

@@ -3,6 +3,8 @@ import { getActiveClient } from '~/client/api';
 import { pullFromCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
+import { prepareCommunityPayload } from '../utils';
+
 /**
  * ```js
  * import { getCommunities } from '@amityco/ts-sdk'
@@ -24,9 +26,14 @@ export const getCommunities = async (
   client.log('community/getCommunities', communityIds);
 
   // API-FIX: endpoint should not be /list, parameters should be querystring.
-  const { data } = await client.http.get<Amity.CommunityPayload>(`/api/v3/communities/list`, {
-    params: { communityIds },
-  });
+  const { data: payload } = await client.http.get<Amity.CommunityPayload>(
+    `/api/v3/communities/list`,
+    {
+      params: { communityIds },
+    },
+  );
+
+  const data = prepareCommunityPayload(payload);
 
   const cachedAt = client.cache && Date.now();
   if (client.cache) ingestInCache(data, { cachedAt });

package/src/community/api/getCommunity.ts

@@ -3,6 +3,11 @@ import { getActiveClient } from '~/client/api';
 import { pullFromCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
+import { prepareCommunityPayload } from '../utils';
+
+/* begin_public_function
+  id: community.get
+*/
 /**
  * ```js
  * import { getCommunity } from '@amityco/ts-sdk'
@@ -24,10 +29,12 @@ export const getCommunity = async (
   client.log('community/getCommunity', communityId);
 
   // API-FIX: endpoint should not be /list, parameters should be querystring.
-  const { data } = await client.http.get<Amity.CommunityPayload>(
+  const { data: payload } = await client.http.get<Amity.CommunityPayload>(
     `/api/v3/communities/${communityId}`,
   );
 
+  const data = prepareCommunityPayload(payload);
+
   const cachedAt = client.cache && Date.now();
   if (client.cache) ingestInCache(data, { cachedAt });
 
@@ -38,6 +45,7 @@ export const getCommunity = async (
     cachedAt,
   };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/community/api/getRecommendedCommunities.ts

@@ -4,6 +4,11 @@ import { getResolver } from '~/core/model';
 import { pullFromCache, pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
+import { prepareCommunityPayload } from '../utils';
+
+/* begin_public_function
+  id: community.query.recommended_communities
+*/
 /**
  * ```js
  * import { getRecommendedCommunities } from '@amityco/ts-sdk'
@@ -27,12 +32,13 @@ export const getRecommendedCommunities = async (
   const { limit = 5 } = query ?? {};
 
   // API-FIX: backend doesnt answer Amity.Response
-  // const { data } = await client.http.get<Amity.Response<CommunityPayload>>(
-  const { data } = await client.http.get<Amity.CommunityPayload>(
+  // const { data: payload } = await client.http.get<Amity.Response<CommunityPayload>>(
+  const { data: payload } = await client.http.get<Amity.CommunityPayload>(
     `/api/v3/communities/recommended`,
     { params: { options: { limit } } },
   );
 
+  const data = prepareCommunityPayload(payload);
   const { communities } = data;
 
   const cachedAt = client.cache && Date.now();
@@ -46,6 +52,7 @@ export const getRecommendedCommunities = async (
 
   return { data: communities, cachedAt };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/community/api/getTopTrendingCommunities.ts

@@ -4,6 +4,11 @@ import { getResolver } from '~/core/model';
 import { pullFromCache, pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
+import { prepareCommunityPayload } from '../utils';
+
+/* begin_public_function
+  id: community.query.trending_communities
+*/
 /**
  * ```js
  * import { getTopTrendingCommunities } from '@amityco/ts-sdk'
@@ -28,11 +33,12 @@ export const getTopTrendingCommunities = async (
 
   // API-FIX: backend doesnt answer Amity.Response
   // const { data } = await client.http.get<Amity.Response<CommunityPayload>>(
-  const { data } = await client.http.get<Amity.CommunityPayload>(
+  const { data: payload } = await client.http.get<Amity.CommunityPayload>(
     `/api/v3/communities/top-trending`,
     { params: { options: { limit } } },
   );
 
+  const data = prepareCommunityPayload(payload);
   const { communities } = data;
 
   const cachedAt = client.cache && Date.now();
@@ -46,6 +52,7 @@ export const getTopTrendingCommunities = async (
 
   return { data: communities, cachedAt };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/community/api/joinCommunity.ts

@@ -1,8 +1,12 @@
 import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import { prepareCommunityPayload } from '~/community/utils';
 import { fireEvent } from '~/core/events';
 
+/* begin_public_function
+  id: community.join
+*/
 /**
  * ```js
  * import { joinCommunity } from '@amityco/ts-sdk'
@@ -23,15 +27,17 @@ export const joinCommunity = async (
   const client = getActiveClient();
   client.log('community/joinCommunity', communityId);
 
-  const { data } = await client.http.post<Amity.CommunityMembershipPayload>(
+  const { data: payload } = await client.http.post<Amity.CommunityMembershipPayload>(
     `/api/v3/communities/${communityId}/join`,
   );
 
+  fireEvent('community.joined', payload);
+
+  const data = prepareCommunityPayload(payload);
+
   const cachedAt = client.cache && Date.now();
   if (client.cache) ingestInCache(data, { cachedAt });
 
-  fireEvent('community.joined', data);
-
   const { communityUsers } = data;
 
   return !!communityUsers.find(
@@ -39,3 +45,4 @@ export const joinCommunity = async (
       communityUser.communityId === communityId && communityUser.communityMembership === 'member',
   );
 };
+/* end_public_function */

package/src/community/api/leaveCommunity.ts

@@ -1,8 +1,12 @@
 import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import { prepareCommunityPayload } from '~/community/utils';
 import { fireEvent } from '~/core/events';
 
+/* begin_public_function
+  id: community.leave
+*/
 /**
  * ```js
  * import { leaveCommunity } from '@amityco/ts-sdk'
@@ -23,15 +27,17 @@ export const leaveCommunity = async (
   const client = getActiveClient();
   client.log('community/leaveCommunity', communityId);
 
-  const { data } = await client.http.delete<Amity.CommunityMembershipPayload>(
+  const { data: payload } = await client.http.delete<Amity.CommunityMembershipPayload>(
     `/api/v3/communities/${communityId}/leave`,
   );
 
+  fireEvent('community.left', payload);
+
+  const data = prepareCommunityPayload(payload);
+
   const cachedAt = client.cache && Date.now();
   if (client.cache) ingestInCache(data, { cachedAt });
 
-  fireEvent('community.left', data);
-
   const { communityUsers } = data;
 
   return !!communityUsers.find(
@@ -39,3 +45,4 @@ export const leaveCommunity = async (
       communityUser.communityId === communityId && communityUser.communityMembership !== 'member',
   );
 };
+/* end_public_function */