@amityco/ts-sdk 7.10.1-c2a9783.0 → 7.10.1-ec1ce4a3.0

package/src/reactionRepository/api/addReaction.ts

@@ -1,171 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import { upsertInCache, pullFromCache, pushToCache } from '~/cache/api';
-
-import { UNSYNCED_OBJECT_CACHED_AT_VALUE } from '~/utils/constants';
-import { dispatchReactable } from '../utils';
-import { fireEvent } from '~/core/events';
-import { ASCApiError } from '~/core/errors';
-
-/* begin_public_function
-  id: reaction.add
-*/
-/**
- * ```js
- * import { addReaction } from '@amityco/ts-sdk'
- * const success = await addReaction('post', postId, 'like')
- * ```
- *
- * Creates an {@link Amity.Reaction}
- *
- * @param referenceType The type of thing to add a {@link Amity.Reaction} to, such as a post or a comment.
- * @param referenceId The ID of the thing to add a new {@link Amity.Reaction} to.
- * @param reactionName Reaction name, such as a `like` or `love`.
- * @returns The added result.
- *
- * @category Reaction API
- * @async
- * */
-export const addReaction = async (
-  referenceType: Amity.Reaction['referenceType'],
-  referenceId: Amity.Reaction['referenceId'],
-  reactionName: Amity.InternalReactor['reactionName'],
-): Promise<boolean> => {
-  const client = getActiveClient();
-  client.log('reaction/createReaction', {
-    referenceId,
-    referenceType,
-    reactionName,
-  });
-
-  if (!['post', 'comment', 'story', 'message'].includes(referenceType))
-    throw new ASCApiError(
-      'The reference type is not valid. It should be one of post, comment, story, or message',
-      Amity.ServerError.BAD_REQUEST,
-      Amity.ErrorLevel.ERROR,
-    );
-
-  const { data } = await client.http.post<{ addedId: 'string' }>('/api/v2/reactions', {
-    referenceId,
-    referenceType,
-    reactionName,
-    referenceVersion: referenceType === 'message' ? 5 : undefined,
-  });
-
-  if (client.cache) {
-    const model = pullFromCache<Amity.Models[Amity.ReactableType]>([
-      referenceType,
-      'get',
-      referenceId,
-    ]);
-
-    if (!model || model.data.myReactions?.includes(reactionName)) return true;
-
-    const updatedModel = {
-      ...model.data,
-      reactionsCount: model.data.reactionsCount + 1,
-      myReactions: [...(model.data.myReactions ?? []), reactionName],
-      reactions: {
-        ...model.data.reactions,
-        [reactionName]: (model.data.reactions[reactionName] ?? 0) + 1,
-      },
-      updatedAt: new Date().toISOString(),
-    } as Amity.Models[Amity.ReactableType];
-
-    if (referenceType === 'comment') {
-      fireEvent('local.comment.addReaction', {
-        comment: updatedModel as Amity.InternalComment,
-        reactor: {
-          userId: client.userId!,
-          reactionName,
-          reactionId: data.addedId,
-        },
-      });
-
-      return true;
-    }
-    if (referenceType === 'post') {
-      fireEvent('local.post.addReaction', {
-        post: updatedModel as Amity.InternalPost,
-        reactor: {
-          userId: client.userId!,
-          reactionName,
-          reactionId: data.addedId,
-        },
-      });
-
-      return true;
-    }
-    if (referenceType === 'story') {
-      fireEvent('local.story.reactionAdded', {
-        story: updatedModel as Amity.InternalStory,
-        reactor: {
-          userId: client.userId!,
-          reactionName,
-          reactionId: data.addedId,
-        },
-      });
-
-      return true;
-    }
-  }
-
-  return true;
-};
-/* end_public_function */
-
-/**
- * ```js
- * import { addReaction } from '@amityco/ts-sdk'
- * const success = addReaction.optimistically('post', postId, 'like')
- * ```
- *
- * Creates an {@link Amity.Reaction} optimistically
- *
- * @param referenceType The type of thing to add a {@link Amity.Reaction} to, such as a post or a comment.
- * @param referenceId The ID of the thing to add a new {@link Amity.Reaction} to.
- * @param reactionName Reaction name, such as a `like` or `love`.
- * @returns The added result.
- *
- * @category Reaction API
- * */
-addReaction.optimistically = (
-  referenceType: Amity.ReactableType,
-  referenceId: Amity.Reaction['referenceId'],
-  reactionName: Amity.InternalReactor['reactionName'],
-): boolean | undefined => {
-  const client = getActiveClient();
-  client.log('reaction/createReaction.optimistically', {
-    referenceId,
-    referenceType,
-    reactionName,
-  });
-
-  if (!client.cache) return;
-
-  const model = pullFromCache<Amity.Models[Amity.ReactableType]>([
-    referenceType,
-    'get',
-    referenceId,
-  ]);
-
-  if (!model?.data || model.data.myReactions?.includes(reactionName)) return;
-
-  const reaction = {
-    ...model.data,
-    reactionsCount: model.data.reactionsCount + 1,
-    myReactions: [...(model.data.myReactions ?? []), reactionName],
-    reactions: {
-      ...model.data.reactions,
-      [reactionName]: (model.data.reactions[reactionName] ?? 0) + 1,
-    },
-  } as Amity.Models[Amity.ReactableType];
-
-  upsertInCache([referenceType, 'get', referenceId], reaction, {
-    cachedAt: UNSYNCED_OBJECT_CACHED_AT_VALUE,
-  });
-
-  dispatchReactable(referenceType, reaction);
-
-  return reaction?.myReactions?.includes(reactionName) ?? false;
-};

package/src/reactionRepository/api/constants.ts

@@ -1 +0,0 @@
-export const REFERENCE_API_V5 = 5;

package/src/reactionRepository/api/index.ts

@@ -1,2 +0,0 @@
-export * from './addReaction';
-export * from './removeReaction';

package/src/reactionRepository/api/queryReactions.ts

@@ -1,57 +0,0 @@
-import { getActiveClient } from '~/client/api/activeClient';
-
-import { toToken, toPageRaw } from '~/core/query';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import { REFERENCE_API_V5 } from '~/reactionRepository/api/constants';
-
-/**
- * ```js
- * import { queryReactions } from '@amityco/ts-sdk'
- * const { data: reactions, prevPage, nextPage } = await queryReactions({
- *   referenceId: 'postId',
- *   referenceType: 'post',
- * })
- * ```
- *
- * Queries a paginable list of {@link Amity.Reaction} objects
- *
- * @param query The query parameters
- * @returns A page of {@link Amity.Reaction} objects
- *
- * @reaction Reaction API
- * @async
- * */
-export const queryReactions = async (
-  query: Amity.QueryReactions,
-): Promise<Amity.Paged<Amity.Reaction, Amity.Page<string>>> => {
-  const client = getActiveClient();
-  client.log('reaction/queryReactions', query);
-
-  const { page = { limit: 10 }, ...params } = query ?? {};
-
-  const { data } = await client.http.get<Amity.ReactionPayload & Amity.Pagination>(
-    `/api/v3/reactions`,
-    {
-      params: {
-        ...params,
-        referenceVersion: REFERENCE_API_V5, // Need to put this param to make it can query reaction for message in sub-channel
-        options: {
-          token: toToken(page, 'afterbeforeraw'),
-        },
-      },
-    },
-  );
-
-  const { paging, ...payload } = data;
-  const { reactions } = payload;
-
-  // FIXME: correct reactions type in model
-  // @ts-ignore
-  ingestInCache({ ...payload, reactions }); // Save reaction response into cache
-  ingestInCache({ ...payload, reactors: reactions[0].reactors }); // Save reactors data into cache for support reaction query
-
-  const nextPage = toPageRaw(paging.next);
-  const prevPage = toPageRaw(paging.previous);
-
-  return { data: reactions, prevPage, nextPage };
-};

package/src/reactionRepository/api/queryReactor.ts

@@ -1,31 +0,0 @@
-import { getActiveClient } from '~/client/api/activeClient';
-
-import { queryReactions } from './queryReactions';
-
-/**
- * ```js
- * import { queryReactor } from '@amityco/ts-sdk'
- * const { data: reactions, prevPage, nextPage } = await queryReactor({
- *   referenceId: 'postId',
- *   referenceType: 'post',
- * })
- * ```
- *
- * Queries a paginable list of {@link Amity.InternalReactor} objects
- *
- * @param query The query parameters
- * @returns A page of {@link Amity.InternalReactor} objects
- *
- * @reaction Reaction API
- * @async
- * */
-export const queryReactor = async (
-  query: Amity.QueryReactions,
-): Promise<Amity.Paged<Amity.InternalReactor, Amity.Page<string>>> => {
-  const client = getActiveClient();
-  client.log('reaction/queryReactor', query);
-
-  const { data, ...response } = await queryReactions(query);
-
-  return { ...response, data: data[0].reactors };
-};

package/src/reactionRepository/api/removeReaction.ts

@@ -1,175 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import { upsertInCache, pullFromCache, pushToCache } from '~/cache/api';
-
-import { UNSYNCED_OBJECT_CACHED_AT_VALUE } from '~/utils/constants';
-
-import { dispatchReactable } from '../utils';
-import { fireEvent } from '~/core/events';
-import { ASCApiError } from '~/core/errors';
-
-/* begin_public_function
-  id: reaction.remove
-*/
-/**
- * ```js
- * import { deleteReaction } from '@amityco/ts-sdk'
- * const success = await deleteReaction('post', 'foobar', 'like')
- * ```
- *
- * Removes a {@link Amity.Reaction} from a {@link Amity.Reactable} object
- *
- * @param referenceType The type of thing to add a {@link Amity.Reaction} to, such as a post or a comment.
- * @param referenceId The ID of the thing to add a new {@link Amity.Reaction} to.
- * @param reactionName Reaction name, such as a `like` or `love`.
- * @returns The removed result.
- *
- * @category Reaction API
- * @async
- * */
-export const removeReaction = async (
-  referenceType: Amity.Reaction['referenceType'],
-  referenceId: Amity.Reaction['referenceId'],
-  reactionName: Amity.InternalReactor['reactionName'],
-): Promise<boolean> => {
-  const client = getActiveClient();
-  client.log('reaction/removeReaction', {
-    referenceId,
-    referenceType,
-    reactionName,
-  });
-
-  if (!['post', 'comment', 'story', 'message'].includes(referenceType))
-    throw new ASCApiError(
-      'The reference type is not valid. It should be one of post, comment, story, or message',
-      Amity.ServerError.BAD_REQUEST,
-      Amity.ErrorLevel.ERROR,
-    );
-
-  const { data } = await client.http.delete<{ removedId: string }>(`/api/v2/reactions`, {
-    data: {
-      referenceId,
-      referenceType,
-      reactionName,
-      referenceVersion: referenceType === 'message' ? 5 : undefined,
-    },
-  });
-
-  if (client.cache) {
-    const model = pullFromCache<Amity.Models[Amity.ReactableType]>([
-      referenceType,
-      'get',
-      referenceId,
-    ]);
-
-    if (!model) return true;
-
-    const updatedModel = {
-      ...model.data,
-      reactionsCount: Math.max(0, model.data.reactionsCount - 1),
-      myReactions: (model.data.myReactions ?? []).filter(item => item !== reactionName),
-      reactions: {
-        ...model.data.reactions,
-        [reactionName]: Math.max(0, (model.data.reactions[reactionName] ?? 0) - 1),
-      },
-      updatedAt: new Date().toISOString(),
-    } as Amity.Models[Amity.ReactableType];
-
-    if (referenceType === 'comment') {
-      fireEvent('local.comment.removeReaction', {
-        comment: updatedModel as Amity.InternalComment,
-        reactor: {
-          reactionId: data.removedId,
-          reactionName,
-          userId: client.userId!,
-        },
-      });
-
-      return true;
-    }
-    if (referenceType === 'post') {
-      fireEvent('local.post.removeReaction', {
-        post: updatedModel as Amity.InternalPost,
-        reactor: {
-          reactionId: data.removedId,
-          reactionName,
-          userId: client.userId!,
-        },
-      });
-
-      return true;
-    }
-
-    if (referenceType === 'story') {
-      fireEvent('local.story.reactionAdded', {
-        story: updatedModel as Amity.InternalStory,
-        reactor: {
-          userId: client.userId!,
-          reactionName,
-          reactionId: data.removedId,
-        },
-      });
-
-      return true;
-    }
-  }
-
-  return true;
-};
-/* end_public_function */
-
-/**
- * ```js
- * import { removeReaction } from '@amityco/ts-sdk'
- * const success = removeReaction.optimistically('post', postId, 'like')
- * ```
- *
- * Removes a {@link Amity.Reaction} from a {@link Amity.Reactable} object optimistically
- *
- * @param referenceType The type of thing to add a {@link Amity.Reaction} to, such as a post or a comment.
- * @param referenceId The ID of the thing to add a new {@link Amity.Reaction} to.
- * @param reactionName Reaction name, such as a `like` or `love`.
- * @returns The added result.
- *
- * @category Reaction API
- * */
-removeReaction.optimistically = (
-  referenceType: Amity.ReactableType,
-  referenceId: Amity.Reaction['referenceId'],
-  reactionName: Amity.InternalReactor['reactionName'],
-): boolean | undefined => {
-  const client = getActiveClient();
-  client.log('reaction/removeReaction.optimistically', {
-    referenceId,
-    referenceType,
-    reactionName,
-  });
-
-  if (!client.cache) return;
-
-  const model = pullFromCache<Amity.Models[Amity.ReactableType]>([
-    referenceType,
-    'get',
-    referenceId,
-  ]);
-
-  if (!model?.data || !model.data.myReactions?.includes(reactionName)) return;
-
-  const reaction = {
-    ...model.data,
-    reactionsCount: Math.max(0, model.data.reactionsCount - 1),
-    myReactions: (model.data.myReactions ?? []).filter(item => item !== reactionName),
-    reactions: {
-      ...model.data.reactions,
-      [reactionName]: Math.max(0, (model.data.reactions[reactionName] ?? 0) - 1),
-    },
-  } as Amity.Models[Amity.ReactableType];
-
-  upsertInCache([referenceType, 'get', referenceId], reaction, {
-    cachedAt: UNSYNCED_OBJECT_CACHED_AT_VALUE,
-  });
-
-  dispatchReactable(referenceType, reaction);
-
-  return !reaction?.myReactions?.includes(reactionName);
-};

package/src/reactionRepository/api/tests/addReaction.test.ts

@@ -1,86 +0,0 @@
-import { ASCApiError } from '~/core/errors';
-import { disableCache, enableCache, pullFromCache, pushToCache } from '~/cache/api';
-
-import { onMessageUpdated } from '~/messageRepository/events';
-import { addReaction } from '~/reactionRepository/api';
-
-import { client, message11 as message, pause } from '~/utils/tests';
-import { UNSYNCED_OBJECT_CACHED_AT_VALUE } from '~/utils/constants';
-
-const cacheKey = ['message', 'get', message.messageId];
-
-describe('addReaction', () => {
-  // integration_test_id: 6252e6ed-afd7-460f-a285-f95650ec513a
-  test('it should add a reaction', async () => {
-    client.http.post = jest.fn().mockResolvedValue({ data: { addedId: 'reactionId' } });
-
-    const success = await addReaction('message', message.messageId, 'like');
-
-    expect(success).toEqual(true);
-  });
-
-  // integration_test_id: ddc6da15-cfa3-4f54-ad52-be50c2841d6e
-  test('it should throw 400400 when resource not found', async () => {
-    client.http.post = jest
-      .fn()
-      .mockRejectedValueOnce(
-        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
-      );
-
-    await expect(addReaction('message', message.messageId, 'like')).rejects.toThrow();
-  });
-
-  test('it should update cache after adding reaction', async () => {
-    enableCache();
-
-    pushToCache(cacheKey, message);
-    client.http.post = jest.fn().mockResolvedValue({ data: { addedId: 'reactionId' } });
-
-    const success = await addReaction('message', message.messageId, 'like');
-
-    expect(success).toEqual(true);
-    expect(pullFromCache(cacheKey)?.cachedAt).toBeDefined();
-    expect(pullFromCache(cacheKey)?.cachedAt).not.toBe(UNSYNCED_OBJECT_CACHED_AT_VALUE);
-    expect(pullFromCache(cacheKey)?.cachedAt).not.toBe(-1);
-
-    disableCache();
-  });
-});
-
-describe('addReaction > optimistically', () => {
-  beforeEach(enableCache);
-
-  afterEach(disableCache);
-
-  test('it should return undefined if cache disabled', () => {
-    disableCache();
-
-    expect(addReaction.optimistically('message', message.messageId, 'like')).toBeUndefined();
-  });
-
-  test('it should optimistically add a reaction', async () => {
-    const callback = jest.fn();
-    pushToCache(cacheKey, message);
-    onMessageUpdated(callback);
-
-    const success = addReaction.optimistically('message', message.messageId, 'like');
-
-    expect(success).toEqual(true);
-    expect(pullFromCache(cacheKey)?.data).toMatchObject({
-      myReactions: ['like'],
-      reactions: { like: 1 },
-      reactionsCount: 1,
-    });
-    await pause();
-    expect(callback).toBeCalledTimes(1);
-  });
-
-  test('it should mark optimistic object as unsynced', async () => {
-    pushToCache(cacheKey, message);
-
-    const success = addReaction.optimistically('message', message.messageId, 'like');
-
-    expect(success).toEqual(true);
-    expect(pullFromCache(cacheKey)?.cachedAt).toBe(UNSYNCED_OBJECT_CACHED_AT_VALUE);
-  });
-});

package/src/reactionRepository/api/tests/removeReaction.test.ts

@@ -1,92 +0,0 @@
-import { ASCApiError } from '~/core/errors';
-import { disableCache, enableCache, pullFromCache, pushToCache } from '~/cache/api';
-
-import { onMessageUpdated } from '~/messageRepository/events';
-import { removeReaction } from '~/reactionRepository/api';
-
-import { UNSYNCED_OBJECT_CACHED_AT_VALUE } from '~/utils/constants';
-import { client, message11, pause } from '~/utils/tests';
-
-const message = {
-  ...message11,
-  myReactions: ['like'],
-  reactions: { like: 1 },
-  reactionsCount: 1,
-};
-const cacheKey = ['message', 'get', message.messageId];
-
-describe('removeReaction', () => {
-  // integration_test_id: dda62dbf-7649-4f1e-b264-0f79984ae1c8
-  test('it should remove a reaction', async () => {
-    client.http.delete = jest.fn().mockResolvedValue({ data: { removedId: 'reactionId' } });
-
-    const success = await removeReaction('message', message.messageId, 'like');
-
-    expect(success).toEqual(true);
-  });
-
-  // integration_test_id: b5ab2716-044c-488a-839e-4a7517e58ca9
-  test('it should throw 400400 when resource not found', async () => {
-    client.http.delete = jest
-      .fn()
-      .mockRejectedValueOnce(
-        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
-      );
-
-    await expect(removeReaction('message', message.messageId, 'like')).rejects.toThrow();
-  });
-
-  test('it should update cache after adding reaction', async () => {
-    enableCache();
-
-    pushToCache(cacheKey, message);
-    client.http.post = jest.fn().mockResolvedValue({ data: { addedId: 'reactionId' } });
-
-    const success = await removeReaction('message', message.messageId, 'like');
-
-    expect(success).toEqual(true);
-    expect(pullFromCache(cacheKey)?.cachedAt).toBeDefined();
-    expect(pullFromCache(cacheKey)?.cachedAt).not.toBe(UNSYNCED_OBJECT_CACHED_AT_VALUE);
-    expect(pullFromCache(cacheKey)?.cachedAt).not.toBe(-1);
-
-    disableCache();
-  });
-});
-
-describe('removeReaction > optimistically', () => {
-  beforeEach(enableCache);
-
-  afterEach(disableCache);
-
-  test('it should return undefined if cache disabled', () => {
-    disableCache();
-
-    expect(removeReaction.optimistically('message', message.messageId, 'like')).toBeUndefined();
-  });
-
-  test('it should optimistically remove a reaction', async () => {
-    const callback = jest.fn();
-    pushToCache(cacheKey, message);
-    onMessageUpdated(callback);
-
-    const success = removeReaction.optimistically('message', message.messageId, 'like');
-
-    expect(success).toEqual(true);
-    expect(pullFromCache(cacheKey)?.data).toMatchObject({
-      myReactions: [],
-      reactions: { like: 0 },
-      reactionsCount: 0,
-    });
-    await pause();
-    expect(callback).toBeCalledTimes(1);
-  });
-
-  test('it should mark optimistic object as unsynced', async () => {
-    pushToCache(cacheKey, message);
-
-    const success = removeReaction.optimistically('message', message.messageId, 'like');
-
-    expect(success).toEqual(true);
-    expect(pullFromCache(cacheKey)?.cachedAt).toBe(UNSYNCED_OBJECT_CACHED_AT_VALUE);
-  });
-});

package/src/reactionRepository/events/index.ts

@@ -1,5 +0,0 @@
-export * from './onReactionAdded';
-export * from './onReactionRemoved';
-
-export * from './onReactorAdded';
-export * from './onReactorRemoved';

package/src/reactionRepository/events/onReactionAdded.ts

@@ -1,70 +0,0 @@
-import { getActiveClient } from '~/client/api';
-import { pullFromCache } from '~/cache/api';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import { createEventSubscriber } from '~/core/events';
-import { getResolver } from '~/core/model';
-import { onPostReactionAdded } from '~/postRepository/events';
-import { onCommentReactionAdded } from '~/commentRepository/events';
-import { prepareMessagePayload } from '~/messageRepository/utils';
-
-/**
- * ```js
- * import { onReactionAdded } from '@amityco/ts-sdk'
- * const dispose = onReactionAdded('post', postId, post => {
- *   // ...
- * })
- * ```
- *
- * Fired when an {@link Amity.Reaction} has been added
- *
- * @param {@link Amity.ReactableType} referenceType
- * @param {string} referenceId
- * @param callback The function to call when the event was fired
- * @returns an {@link Amity.Unsubscriber} function to stop listening
- *
- * @category Message Events
- * */
-export const onReactionAdded = (
-  referenceType: Amity.ReactableType,
-  referenceId: Amity.Reaction['referenceId'],
-  callback: Amity.Listener<Amity.Models[typeof referenceType]>,
-): Amity.Unsubscriber => {
-  const callbackWrapper = (model: Amity.Models[typeof referenceType]) => {
-    if (getResolver(referenceType)(model as any) === referenceId) {
-      callback(model);
-    }
-  };
-
-  /*
-   * Important: Want to point out that reference type will never be 'message'
-   * for onReactionAdded
-   */
-
-  if (referenceType === 'message') {
-    const client = getActiveClient();
-
-    const filter = async (rawPayload: Amity.MessagePayload) => {
-      const payload = await prepareMessagePayload(rawPayload);
-      const cached = pullFromCache<Amity.Message>([
-        'message',
-        'get',
-        payload.messages[0].messageId,
-      ]);
-      const isReactionEvent = cached?.data?.reactionsCount !== payload.messages[0].reactionsCount;
-
-      ingestInCache(payload);
-
-      if (isReactionEvent) {
-        callbackWrapper(payload.messages[0]);
-      }
-    };
-
-    return createEventSubscriber(client, 'reaction/onReactionAdded', 'message.updated', filter);
-  }
-
-  if (referenceType === 'post') {
-    return onPostReactionAdded(callbackWrapper);
-  }
-
-  return onCommentReactionAdded(callbackWrapper);
-};