@amityco/ts-sdk 0.0.1-e5fb0d2.0 → 0.0.1-e643f6f.0

package/src/post/api/getPost.ts

@@ -1,13 +1,19 @@
-import { getActiveClient } from '~/client/api'
-import { ingestInCache, pullFromCache } from '~/core/cache'
-import { decoratePayload } from '~/core/query'
+import { getActiveClient } from '~/client/api';
 
-import { getPosts } from './getPosts'
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { isInTombstone } from '~/cache/api/isInTombstone';
+import { checkIfShouldGoesToTombstone } from '~/cache/utils';
+import { pushToTombstone } from '~/cache/api/pushToTombstone';
+import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: post.get
+*/
 /**
  * ```js
  * import { getPost } from '@amityco/ts-sdk'
- * const post = await getPost('foobar')
+ * const { data: post } = await getPost('foobar')
  * ```
  *
  * Fetches a {@link Amity.Post} object
@@ -18,43 +24,67 @@ import { getPosts } from './getPosts'
  * @category Post API
  * @async
  */
-export const getPost = async (
-  postId: Amity.Post['postId']
-) => {
-  const client = getActiveClient()
-  client.log('post/getPost', postId)
+export const getPost = async (postId: Amity.Post['postId']): Promise<Amity.Cached<Amity.Post>> => {
+  const client = getActiveClient();
+  client.log('post/getPost', postId);
 
-  // API-FIX: endpoint should not be /list, parameters should be querystring.
-  const { data } = await client.http.get<Amity.PostPayload>(
-    `/api/v3/posts/${postId}`,
-  )
+  isInTombstone('post', postId);
 
-  decoratePayload(data)
-  ingestInCache(data)
+  let payload: Amity.PostPayload;
 
-  const { posts } = data
-  return posts.find(post => post.postId === postId)!
-}
+  try {
+    // API-FIX: endpoint should not be /list, parameters should be querystring.
+    const response = await client.http.get<Amity.PostPayload>(
+      `/api/v3/posts/${encodeURIComponent(postId)}`,
+    );
+    payload = response.data;
+  } catch (error) {
+    if (checkIfShouldGoesToTombstone((error as Amity.ErrorResponse)?.code)) {
+      pushToTombstone('post', postId);
+    }
+
+    throw error;
+  }
+
+  const data = prepareMembershipPayload(payload, 'communityUsers');
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  const { posts } = data;
+
+  return {
+    data: posts.find(post => post.postId === postId)!,
+    cachedAt,
+  };
+};
+/* end_public_function */
 
 /**
  * ```js
  * import { getPost } from '@amityco/ts-sdk'
- * const post = getPost.locally('foobar')
+ * const { data: post } = getPost.locally('foobar')
  * ```
  *
- * Fetches a {@link Amity.Post} object
+ * Fetches a {@link Amity.Post} object from cache
  *
  * @param postId the ID of the {@link Amity.Post} to fetch
  * @returns the associated {@link Amity.Post} object
  *
  * @category Post API
  */
-getPost.locally = (
-  postId: Amity.Post['postId']
-) => {
-  const client = getActiveClient()
-  client.log('post/getPost.locally', postId)
-
-  const [post] = pullFromCache('post', postId) ?? []
-  return post
-}
+getPost.locally = (postId: Amity.Post['postId']): Amity.Cached<Amity.Post> | undefined => {
+  const client = getActiveClient();
+  client.log('post/getPost.locally', postId);
+
+  if (!client.cache) return;
+
+  const cached = pullFromCache<Amity.Post>(['post', 'get', postId]);
+
+  if (!cached) return;
+
+  return {
+    data: cached.data,
+    cachedAt: cached.cachedAt,
+  };
+};

package/src/post/api/getPosts.ts

@@ -1,13 +1,16 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache, pullFromCache } from '~/core/cache'
-import { toRecord } from '~/core/model'
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: post.get_by_ids
+*/
 /**
  * ```js
  * import { getPosts } from '@amityco/ts-sdk'
- * const posts = await getPosts(['foo', 'bar'])
+ * const { data: posts } = await getPosts(['foo', 'bar'])
  * ```
  *
  * Fetches a collection of {@link Amity.Post} objects
@@ -19,28 +22,33 @@ import { toRecord } from '~/core/model'
  * @async
  */
 export const getPosts = async (
-  postIds: Amity.Post['postId'][]
-) => {
-  const client = getActiveClient()
-  client.log('post/getPosts', postIds)
+  postIds: Amity.Post['postId'][],
+): Promise<Amity.Cached<Amity.Post[]>> => {
+  const client = getActiveClient();
+  client.log('post/getPosts', postIds);
+
+  const encodedPostIds = postIds.map(postId => encodeURIComponent(postId));
 
   // API-FIX: endpoint should not be /list, parameters should be querystring.
-  const { data } = await client.http.get<Amity.PostPayload>(
-    `/api/v3/posts/list`,
-    { params: { postIds } }
-  )
+  const { data: payload } = await client.http.get<Amity.PostPayload>(`/api/v3/posts/list`, {
+    params: { postIds: encodedPostIds },
+  });
+
+  const data = prepareMembershipPayload(payload, 'communityUsers');
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
-  const { posts } = data
-  return posts
-}
+  return {
+    data: data.posts,
+    cachedAt,
+  };
+};
 
 /**
  * ```js
  * import { getPosts } from '@amityco/ts-sdk'
- * const posts = getPosts.locally(['foo', 'bar'])
+ * const { data: posts } = getPosts.locally(['foo', 'bar'])
  * ```
  *
  * Fetches a collection of {@link Amity.Post} objects from cache
@@ -50,14 +58,23 @@ export const getPosts = async (
  *
  * @category Post API
  */
-getPosts.locally = (
-  postIds: Amity.Post['postId'][]
-) => {
-  const client = getActiveClient()
-  client.log('post/getPosts.locally', postIds)
+getPosts.locally = (postIds: Amity.Post['postId'][]): Amity.Cached<Amity.Post[]> | undefined => {
+  const client = getActiveClient();
+  client.log('post/getPosts.locally', postIds);
+
+  if (!client.cache) return;
+
+  const cached = postIds
+    .map(postId => pullFromCache<Amity.Post>(['post', 'get', postId])!)
+    .filter(Boolean);
+
+  const posts = cached.map(({ data }) => data);
+  const oldest = cached.sort((a, b) => (a.cachedAt! < b.cachedAt! ? -1 : 1))?.[0];
 
-  const cached = pullFromCache('post', ...postIds) ?? []
+  if (cached?.length < postIds.length) return;
 
-  if (cached?.length === postIds.length)
-    return toRecord(cached)
-}
+  return {
+    data: posts,
+    cachedAt: oldest.cachedAt,
+  };
+};

package/src/post/api/index.ts

@@ -1,7 +1,10 @@
-export * from './queryPosts'
-export * from './getPosts'
-export * from './getPost'
+export * from './queryPosts';
+export * from './getPosts';
+export * from './getPost';
 
-export * from './createPost'
-export * from './updatePost'
-export * from './deletePost'
+export * from './createPost';
+export * from './updatePost';
+export * from './deletePost';
+
+export * from './approvePost';
+export * from './declinePost';

package/src/post/api/queryPosts.ts

@@ -1,14 +1,19 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { decoratePayload, toPage, toToken } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { toToken, toPageRaw } from '~/core/query';
 
-import { toRecord } from '~/core/model'
+import { pullFromCache, pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { getResolver } from '~/core/model';
+import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: post.query, feed.query.community_feed, feed.query.user_feed
+*/
 /**
  * ```js
  * import { queryPosts } from '@amityco/ts-sdk'
- * const posts = await queryPosts({ targetId, targetType })
+ * const { data: posts, prevPage, nextPage } = await queryPosts({ targetId, targetType })
  * ```
  *
  * Queries a paginable list of {@link Amity.Post} objects
@@ -20,53 +25,62 @@ import { toRecord } from '~/core/model'
  * @async
  */
 export const queryPosts = async (
-  query: {
-    targetId: string,
-    targetType: Amity.Post['targetType'],
-    sortBy?: 'lastCreated' | 'firstCreated' | 'lastUpdated' | 'firstUpdated'
-    dataType?: string
-    isDeleted?: Amity.Post['isDeleted']
-    hasFlag?: boolean
-    feedType?: 'reviewing' | 'published'
-    page?: Amity.Page
-  }
-) => {
-  const client = getActiveClient()
-  client.log('post/queryPosts', query)
+  query: Amity.QueryPosts,
+): Promise<Amity.Cached<Amity.Paged<Amity.Post, Amity.PageRaw>>> => {
+  const client = getActiveClient();
+  client.log('post/queryPosts', query);
 
-  const { page, ...params } = query ?? {}
+  const { page = { limit: 10 }, includeDeleted, ...params } = query;
+  const { dataTypes, matchingOnlyParentPost } = params;
 
   // API-FIX: parameters should be querystring. (1)
   // API-FIX: backend should answer Amity.Response (2)
   // const { data } = await client.http.get<Amity.Response<Amity.PagedResponse<Amity.PostPayload>>>(
-  const { data } = await client.http.get<Amity.PostPayload & Amity.Pagination>(
-    `/api/v3/posts`, { params: {
+  const { data } = await client.http.get<Amity.PostPayload & Amity.Pagination>(`/api/v4/posts`, {
+    params: {
       ...params,
+      isDeleted: includeDeleted === false ? false : undefined,
+      /*
+       * when creating post like image, file, video BE will create 2 posts
+       * 1. parent post to store text with dataType=text
+       * 2. child post to store dataTypes post data
+       *
+       * By default BE queries only parent post
+       */
+      matchingOnlyParentPost: matchingOnlyParentPost ?? !dataTypes?.length,
       options: {
-        token: toToken(page, 'skiplimit'),
+        token: toToken(page, 'afterbeforeraw'),
       },
-    }, }
-  )
+    },
+  });
 
   // API-FIX: backend should answer Amity.Response (2)
   // const { paging, posts } = unwrapPayload(data)
-  const { paging, ...response } = data
+  // unpacking
+  const { paging, ...payload } = data;
+  const paperedPayload = prepareMembershipPayload(payload, 'communityUsers');
+  const { posts } = payload;
+
+  const cachedAt = client.cache && Date.now();
 
-  decoratePayload(response as unknown as Record<string, Object[]>)
-  ingestInCache(response as unknown as Record<string, Object[]>)
+  if (client.cache) {
+    ingestInCache(paperedPayload, { cachedAt });
 
-  const { posts } = response
+    const cacheKey = ['post', 'query', { ...params, options: { ...page } } as Amity.Serializable];
+    pushToCache(cacheKey, { posts: posts.map(getResolver('post')), paging });
+  }
 
-  const nextPage = toPage(paging.next)
-  const prevPage = toPage(paging.previous)
+  const nextPage = toPageRaw(paging.next);
+  const prevPage = toPageRaw(paging.previous);
 
-  return { data: toRecord(posts), nextPage, prevPage }
-}
+  return { data: posts, cachedAt, prevPage, nextPage };
+};
+/* end_public_function */
 
 /**
  * ```js
  * import { queryPosts } from '@amityco/ts-sdk'
- * const posts = queryPosts.locally({ targetId, targetType })
+ * const { data: posts, prevPage, nextPage } = queryPosts.locally({ targetId, targetType })
  * ```
  *
  * Queries a paginable list of {@link Amity.Post} objects from cache
@@ -78,9 +92,29 @@ export const queryPosts = async (
  */
 queryPosts.locally = (
   query: Parameters<typeof queryPosts>[0],
-) => {
-  const client = getActiveClient()
-  client.log('post/queryPosts.locally', query)
+): Amity.Cached<Amity.Paged<Amity.Post, Amity.PageRaw>> | undefined => {
+  const client = getActiveClient();
+  client.log('post/queryPosts.locally', query);
+
+  if (!client.cache) return;
+
+  const { page = { limit: 10 }, ...params } = query;
+
+  const queryKey = ['post', 'query', { ...params, options: { ...page } } as Amity.Serializable];
+  const { data, cachedAt } =
+    pullFromCache<{ posts: Pick<Amity.Post, 'postId'>[] } & Amity.Pagination>(queryKey) ?? {};
+
+  if (!data?.posts.length) return;
+
+  const posts: Amity.Post[] = data.posts
+    .map(postId => pullFromCache<Amity.Post>(['post', 'get', postId])!)
+    .filter(Boolean)
+    .map(({ data }) => data);
+
+  const prevPage = toPageRaw(data?.paging.previous);
+  const nextPage = toPageRaw(data?.paging.next);
 
-  // TODO
-}
+  return posts.length === data?.posts?.length
+    ? { data: posts, cachedAt, prevPage, nextPage }
+    : undefined;
+};

package/src/post/api/tests/queryPosts.test.ts

@@ -0,0 +1,180 @@
+import { getResolver } from '~/core/model';
+
+import { disableCache, enableCache, pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+import { client, postQueryResponse, post11 } from '~/utils/tests';
+
+import { queryPosts } from '../queryPosts';
+
+const { targetId, targetType } = post11;
+const params = { targetId, targetType };
+
+describe('queryPosts', () => {
+  test('it should return posts', async () => {
+    const { posts: expected } = postQueryResponse.data;
+    client.http.get = jest.fn().mockResolvedValue(postQueryResponse);
+
+    const { data } = await queryPosts(params);
+
+    expect(data).toEqual(expected);
+  });
+
+  test('it should throw error', async () => {
+    client.http.get = jest.fn().mockRejectedValueOnce(new Error('error'));
+
+    await expect(queryPosts(params)).rejects.toThrow('error');
+  });
+
+  test('it should send matchingOnlyParentPost as true if there are no dataTypes', async () => {
+    const mockFn = jest.fn();
+    client.http.get = mockFn.mockResolvedValue(postQueryResponse);
+
+    await queryPosts(params);
+
+    const mockFnParams = mockFn.mock.lastCall;
+
+    expect(mockFnParams).toBeDefined();
+    expect(mockFnParams).toHaveLength(2);
+    expect(mockFnParams[1].params.matchingOnlyParentPost).toBe(true);
+  });
+
+  test('it should send matchingOnlyParentPost as false if there are dataTypes', async () => {
+    const mockFn = jest.fn();
+    client.http.get = mockFn.mockResolvedValue(postQueryResponse);
+
+    await queryPosts({ ...params, dataTypes: ['image'] });
+
+    const mockFnParams = mockFn.mock.lastCall;
+
+    expect(mockFnParams).toBeDefined();
+    expect(mockFnParams).toHaveLength(2);
+    expect(mockFnParams[1].params.matchingOnlyParentPost).toBe(false);
+  });
+
+  test('it should update cache upon fetching data from server', async () => {
+    enableCache();
+
+    client.http.get = jest.fn().mockResolvedValue(postQueryResponse);
+
+    const { data: expected } = await queryPosts(params);
+    const { data: received } = queryPosts.locally(params)!;
+
+    expect(received).toBeDefined();
+    expect(received).toEqual(expected);
+
+    disableCache();
+  });
+
+  test('it should set isDeleted to undefined if includeDeleted is true', async () => {
+    const mockFn = jest.fn();
+    client.http.get = mockFn.mockResolvedValue(postQueryResponse);
+
+    await queryPosts({ ...params, includeDeleted: true });
+
+    expect(mockFn.mock.lastCall).toHaveLength(2);
+    expect(mockFn.mock.lastCall[1].params.isDeleted).toBeUndefined();
+  });
+
+  test('it should set isDeleted to false if includeDeleted is false', async () => {
+    const mockFn = jest.fn();
+    client.http.get = mockFn.mockResolvedValue(postQueryResponse);
+
+    await queryPosts({ ...params, includeDeleted: false });
+
+    expect(mockFn.mock.lastCall).toHaveLength(2);
+    expect(mockFn.mock.lastCall[1].params.isDeleted).toBe(false);
+  });
+
+  test('it should set isDeleted to undefined if includeDeleted is undefined', async () => {
+    const mockFn = jest.fn();
+    client.http.get = mockFn.mockResolvedValue(postQueryResponse);
+
+    await queryPosts({ ...params, includeDeleted: true });
+
+    expect(mockFn.mock.lastCall).toHaveLength(2);
+    expect(mockFn.mock.lastCall[1].params.isDeleted).toBeUndefined();
+  });
+});
+
+describe('queryPosts.locally', () => {
+  const cacheKey = ['post', 'query', { ...params, options: { limit: 10 } } as Amity.Serializable];
+
+  test('it should fetch query locally if present in cache', () => {
+    enableCache();
+
+    const { data } = postQueryResponse;
+    const { paging, ...payload } = data;
+    const { posts: expected } = payload;
+
+    ingestInCache(payload as Amity.ProcessedPostPayload);
+
+    pushToCache(cacheKey, { posts: expected.map(getResolver('post')), paging });
+
+    const { data: received } = queryPosts.locally(params)!;
+
+    expect(received).toBeDefined();
+    expect(received).toEqual(expected);
+
+    disableCache();
+  });
+
+  test('it should return undefined if only partial data in cache', () => {
+    enableCache();
+
+    const { data } = postQueryResponse;
+    const { posts, paging } = data;
+
+    // ingest incomplete data
+    ingestInCache({
+      ...data,
+      posts: [data.posts[0]],
+    } as Amity.ProcessedPostPayload);
+
+    pushToCache(cacheKey, {
+      posts: posts.map(getResolver('post')),
+      paging,
+    });
+
+    const received = queryPosts.locally(params)!;
+
+    expect(received).toBeUndefined();
+
+    disableCache();
+  });
+
+  // added because of comment above cache key in queryPosts
+  test('it should return undefined if params do not match', () => {
+    enableCache();
+
+    const { data } = postQueryResponse;
+    const { posts: expected, paging } = data;
+
+    ingestInCache(data as Amity.ProcessedPostPayload);
+
+    pushToCache(cacheKey, { posts: expected.map(getResolver('post')), paging });
+
+    const { data: received } = queryPosts.locally(params)!;
+    const received2 = queryPosts.locally({ ...params, targetId: 'does-not-exist' })!;
+
+    expect(received).toBeDefined();
+    expect(received).toEqual(expected);
+    expect(received2).toBeUndefined();
+
+    disableCache();
+  });
+
+  test('it should return undefined if data not in cache', () => {
+    enableCache();
+
+    const received = queryPosts.locally(params);
+
+    expect(received).toBeUndefined();
+
+    disableCache();
+  });
+
+  test('it should return undefined if cache disabled', () => {
+    expect(queryPosts.locally(params)).toBeUndefined();
+  });
+});

package/src/post/api/updatePost.ts

@@ -1,9 +1,12 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
-import { fireEvent } from '~/core/events'
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
+import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: post.edit
+*/
 /**
  * ```js
  * import { updatePost } from '@amityco/ts-sdk'
@@ -23,20 +26,33 @@ import { fireEvent } from '~/core/events'
  */
 export const updatePost = async (
   postId: Amity.Post['postId'],
-  patch: Patch<Amity.Post, 'data' | 'metadata'>,
-) => {
-  const client = getActiveClient()
-  client.log('user/updatePost', patch)
+  patch: Patch<Amity.Post, 'data' | 'metadata' | 'mentionees' | 'tags'> & {
+    attachments?: {
+      type: 'image' | 'file' | 'video';
+      fileId: Amity.File['fileId'];
+    }[];
+  },
+): Promise<Amity.Cached<Amity.Post>> => {
+  const client = getActiveClient();
+  client.log('user/updatePost', patch);
 
-  const { data } = await client.http.put<Amity.PostPayload>(
-    `/api/v3/posts/${postId}`, patch,
-  )
+  const { data: payload } = await client.http.put<Amity.PostPayload>(
+    `/api/v4/posts/${encodeURIComponent(postId)}`,
+    patch,
+  );
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const data = prepareMembershipPayload(payload, 'communityUsers');
 
-  fireEvent('v3.post.didUpdate', data)
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
-  const { posts } = data
-  return posts.find(post => post.postId === postId)!
-}
+  fireEvent('post.updated', data);
+
+  const { posts } = data;
+
+  return {
+    data: posts.find(post => post.postId === postId)!,
+    cachedAt,
+  };
+};
+/* end_public_function */

package/src/post/events/index.ts

@@ -1,3 +1,12 @@
-export * from './onPostCreated'
-export * from './onPostUpdated'
-export * from './onPostDeleted'
+export * from './onPostCreated';
+export * from './onPostUpdated';
+export * from './onPostDeleted';
+
+export * from './onPostApproved';
+export * from './onPostDeclined';
+
+export * from './onPostFlagged';
+export * from './onPostUnflagged';
+
+export * from './onPostReactionAdded';
+export * from './onPostReactionRemoved';

package/src/post/events/onPostApproved.ts

@@ -0,0 +1,19 @@
+import { createPostEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onPostApproved } from '@amityco/ts-sdk'
+ * const dispose = onPostApproved(post => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.Post} has been updated
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Post Events
+ */
+export const onPostApproved = (callback: Amity.Listener<Amity.Post>): Amity.Unsubscriber =>
+  createPostEventSubscriber('post.approved', callback);