@amityco/ts-sdk 6.4.6-bdc04db.0 → 6.4.6-be7e4df.0

package/src/postRepository/observers/tests/getPosts.test.ts

@@ -201,7 +201,7 @@ describe('getPosts', () => {
   const reactionEvents: [
     string,
     keyof Amity.Events,
-    Amity.PostPayload & { reactor: Amity.Reaction },
+    Amity.PostPayload & { reactor: Amity.Reactor },
   ][] = [
     [
       'it should update post in collection onReactionAdded',
@@ -210,8 +210,6 @@ describe('getPosts', () => {
         ...emptyPostPayload,
         posts: [{ ...post11, reactionsCount: 1 }],
         reactor: {
-          referenceId: post11.postId,
-          referenceType: 'post',
           reactionId: 'test-reaction-id',
           reactionName: 'like',
           userId: 'test',
@@ -226,8 +224,6 @@ describe('getPosts', () => {
         ...emptyPostPayload,
         posts: [{ ...post11, reactionsCount: 0 }],
         reactor: {
-          referenceId: post11.postId,
-          referenceType: 'post',
           reactionId: 'test-reaction-id',
           reactionName: 'like',
           userId: 'test',

package/src/reactionRepository/api/addReaction.ts

@@ -27,7 +27,7 @@ import { dispatchReactable } from '../utils';
 export const addReaction = async (
   referenceType: Amity.Reaction['referenceType'],
   referenceId: Amity.Reaction['referenceId'],
-  reactionName: Amity.Reaction['reactionName'],
+  reactionName: Amity.Reactor['reactionName'],
 ): Promise<boolean> => {
   const client = getActiveClient();
   client.log('reaction/createReaction', {
@@ -76,7 +76,7 @@ export const addReaction = async (
 addReaction.optimistically = (
   referenceType: Amity.ReactableType,
   referenceId: Amity.Reaction['referenceId'],
-  reactionName: Amity.Reaction['reactionName'],
+  reactionName: Amity.Reactor['reactionName'],
 ): boolean | undefined => {
   const client = getActiveClient();
   client.log('reaction/createReaction.optimistically', {

package/src/reactionRepository/api/queryReactions.ts

@@ -12,7 +12,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
  * })
  * ```
  *
- * Queries a paginable list of {@link Amity.ReactionQuery} objects
+ * Queries a paginable list of {@link Amity.Reaction} objects
  *
  * @param query The query parameters
  * @returns A page of {@link Amity.Reaction} objects
@@ -22,7 +22,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
  * */
 export const queryReactions = async (
   query: Amity.QueryReactions,
-): Promise<Amity.Paged<Amity.ReactionQuery, Amity.Page<string>>> => {
+): Promise<Amity.Paged<Amity.Reaction, Amity.Page<string>>> => {
   const client = getActiveClient();
   client.log('reaction/queryReactions', query);
 

package/src/reactionRepository/api/queryReactor.ts

@@ -0,0 +1,31 @@
+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.Reactor} objects
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.Reactor} objects
+ *
+ * @reaction Reaction API
+ * @async
+ * */
+export const queryReactor = async (
+  query: Amity.QueryReactions,
+): Promise<Amity.Paged<Amity.Reactor, 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

@@ -28,7 +28,7 @@ import { dispatchReactable } from '../utils';
 export const removeReaction = async (
   referenceType: Amity.Reaction['referenceType'],
   referenceId: Amity.Reaction['referenceId'],
-  reactionName: Amity.Reaction['reactionName'],
+  reactionName: Amity.Reactor['reactionName'],
 ): Promise<boolean> => {
   const client = getActiveClient();
   client.log('reaction/removeReaction', {
@@ -79,7 +79,7 @@ export const removeReaction = async (
 removeReaction.optimistically = (
   referenceType: Amity.ReactableType,
   referenceId: Amity.Reaction['referenceId'],
-  reactionName: Amity.Reaction['reactionName'],
+  reactionName: Amity.Reactor['reactionName'],
 ): boolean | undefined => {
   const client = getActiveClient();
   client.log('reaction/removeReaction.optimistically', {

package/src/reactionRepository/observers/getReactions.ts

@@ -10,7 +10,7 @@ import {
 } from '~/utils/constants';
 
 import { onReactorAdded, onReactorRemoved } from '../events';
-import { queryReactions } from '../api/queryReactions';
+import { queryReactor } from '../api/queryReactor';
 
 /* begin_public_function
   id: reaction.query
@@ -26,11 +26,11 @@ import { queryReactions } from '../api/queryReactions';
  * }, response => merge(reactions, response.data))
  * ```
  *
- * Observe all mutations on a list of {@link Amity.Reaction} for a given target object
+ * Observe all mutations on a list of {@link Amity.Reactor} for a given target object
  *
- * @param params.referenceType the type of the target
- * @param params.referenceId the ID of the target
+ * @param params for querying reactions
  * @param callback the function to call when new data are available
+ * @param config the live collection configuration
  * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the messages
  *
  * @category Reactions Live Collection
@@ -98,7 +98,7 @@ export const getReactions = (
 
     if (!initial && reactions.length > 0 && !collection?.params?.page) return;
 
-    const query = createQuery(queryReactions, {
+    const query = createQuery(queryReactor, {
       ...queryParams,
       page: (!initial ? collection?.params.page : undefined) ?? { limit },
     });
@@ -114,9 +114,7 @@ export const getReactions = (
         };
 
         if (result) {
-          data.data = [
-            ...new Set([...reactions, ...result[0].reactors.map(getResolver('reaction'))]),
-          ];
+          data.data = [...new Set([...reactions, ...result.map(getResolver('reactor'))])];
         }
 
         pushToCache(cacheKey, data);

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

@@ -1,22 +1,18 @@
 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 reaction11: Amity.Reaction = {
+  referenceId: post11.postId,
+  referenceType: 'post',
+  reactors: [reactor11],
+};
 
 export const reactionPayload: Amity.ReactionPayload = {
-  reactions: [{ ...reaction11, reactors: [reactor11] }],
+  reactions: [reaction11],
   users: [user11],
 };