@amityco/ts-sdk 0.0.1-beta.22 → 0.0.1-beta.25

package/src/poll/observers/observePoll.ts

@@ -0,0 +1,67 @@
+import { getActiveClient } from '~/client/api';
+
+import { createQuery, runQuery, queryOptions } from '~/core/query';
+
+import { getPoll } from '../api';
+
+import { onPollUpdated, onPollDeleted } from '../events';
+
+/**
+ * ```js
+ * import { observePoll } from '@amityco/ts-sdk'
+ *
+ * let poll = {}
+ * const dispose = observePoll(pollId, updated => poll = updated)
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.Poll}
+ *
+ * @param pollId the ID of the poll to observe
+ * @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 poll
+ *
+ * @category Poll Observer
+ */
+export const observePoll = <Events extends ['onFetch', 'onUpdate', 'onDelete']>(
+  pollId: string,
+  callback: Amity.ObjectListener<Amity.Snapshot<Amity.Poll | undefined>, Events>,
+  policy: Amity.QueryPolicy = 'cache_then_server',
+): Amity.Unsubscriber => {
+  const { log } = getActiveClient();
+
+  const timestamp = Date.now();
+  log(`observePoll(tmpid: ${timestamp}) > listen`);
+
+  // wrapper function to make sure
+  const router = (result: Amity.Snapshot<Amity.Poll | undefined>, action: Events[number]) => {
+    if (callback instanceof Function) return callback(result);
+
+    if (action !== 'onFetch') callback.onEvent?.(action, result);
+
+    callback[action]?.(result);
+  };
+
+  const realtimeRouter = (result: Amity.Snapshot<Amity.Poll>, action: Events[number]) => {
+    if (result.data?.pollId !== pollId) return;
+
+    router(result, action);
+  };
+
+  const disposers: Amity.Unsubscriber[] = [];
+
+  disposers.push(
+    onPollUpdated(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onUpdate')),
+    onPollDeleted(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onDelete')),
+  );
+
+  runQuery(
+    createQuery(getPoll, pollId),
+    result => (result.data || result.error) && router(result, 'onFetch'),
+    queryOptions(policy),
+  );
+
+  return () => {
+    log(`observePoll(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

package/src/post/api/approvePost.ts

@@ -0,0 +1,48 @@
+import { getActiveClient } from '~/client/api';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
+
+/**
+ * ```js
+ * import { approvePost } from '@amityco/ts-sdk'
+ *
+ * const { data: post } = await approvePost('postId')
+ * ```
+ *
+ * Approves a {@link Amity.Post}
+ *
+ * @param postId The {@link Amity.Post} ID to be approved
+ * @return A {@link Amity.Post} that was approved
+ *
+ * @category Post API
+ * @async
+ */
+export const approvePost = async (
+  postId: Amity.Post['postId'],
+): Promise<Amity.Cached<Amity.Post>> => {
+  const client = getActiveClient();
+  client.log('post/approvePost', postId);
+
+  const { data: approved } = await client.http.post<Amity.PostPayload>(
+    `/api/v3/posts/${encodeURIComponent(postId)}/approve`,
+  );
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(approved, { cachedAt });
+
+  // fire virtual event for community update
+  if (approved.posts[0].targetType === 'community') {
+    const community = approved.communities?.[0];
+
+    // @ts-ignore as communities is optional currently in PostPayload
+    fireEvent('community.updated', { communities: [community] });
+  }
+
+  fireEvent('post.approved', { posts: [approved.posts[0]] });
+
+  return {
+    data: approved.posts.find(post => post.postId === postId)!,
+    cachedAt,
+  };
+};

package/src/post/api/declinePost.ts

@@ -0,0 +1,48 @@
+import { getActiveClient } from '~/client/api';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
+
+/**
+ * ```js
+ * import { declinePost } from '@amityco/ts-sdk'
+ *
+ * const {data: post} = await declinePost('postId')
+ * ```
+ *
+ * Declines a {@link Amity.Post}
+ *
+ * @param postId The {@link Amity.Post} ID to be declined
+ * @return A {@link Amity.Post} that was declined
+ *
+ * @category Post API
+ * @async
+ */
+export const declinePost = async (
+  postId: Amity.Post['postId'],
+): Promise<Amity.Cached<Amity.Post>> => {
+  const client = getActiveClient();
+  client.log('post/declinePost', postId);
+
+  const { data: declined } = await client.http.post<Amity.PostPayload>(
+    `/api/v3/posts/${encodeURIComponent(postId)}/decline`,
+  );
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(declined, { cachedAt });
+
+  // fire virtual event
+  if (declined.posts[0].targetType === 'community') {
+    const community = declined.communities?.[0];
+
+    // @ts-ignore as communities is optional currently in PostPayload
+    fireEvent('community.updated', { communities: [community] });
+  }
+
+  fireEvent('post.declined', { posts: [declined.posts[0]] });
+
+  return {
+    data: declined.posts.find(post => post.postId === postId)!,
+    cachedAt,
+  };
+};

package/src/post/api/index.ts

@@ -5,3 +5,6 @@ export * from './getPost';
 export * from './createPost';
 export * from './updatePost';
 export * from './deletePost';
+
+export * from './approvePost';
+export * from './declinePost';

package/src/reaction/events/onReactionAdded.ts

@@ -34,6 +34,10 @@ export const onReactionAdded = (
     }
   };
 
+  /*
+   * Important: Want to point out that reference type will never be 'message'
+   * for onReactionAdded
+   */
   if (referenceType === 'message') {
     const client = getActiveClient();
 

package/src/reaction/utils/index.ts

@@ -1,3 +1,4 @@
 export * from './dispatchReactable';
 export * from './fetchReference';
 export * from './preparePayloadForCache';
+export * from './prepareMessagePayloadForCache';

package/src/reaction/utils/prepareMessagePayloadForCache.ts

@@ -0,0 +1,40 @@
+import { pullFromCache } from '~/cache/api';
+import { getActiveClient } from '~/client/api';
+
+/** @hidden */
+/*
+ * @param message payload from http request without myReactions
+ * add myReactions to http response if the event was a reaction event
+ */
+export const prepareMessagePayloadForCache = (payload: Amity.Message) => {
+  const client = getActiveClient();
+
+  const cached = pullFromCache<Amity.Message>(['message', 'get', payload.messageId]);
+  // '[]' in cases where the new reaction is the first one
+  const myReactions = cached?.data.myReactions || [];
+
+  // add myReactions to the payload
+  Object.assign(payload, { myReactions });
+
+  // check if there are any updates to the reactions
+  const latestReaction = payload?.latestReaction;
+  const isLatestReactionMine = latestReaction && latestReaction.userId === client.userId;
+
+  if (!isLatestReactionMine) {
+    return;
+  }
+
+  // new reaction added
+  if (latestReaction.eventName === 'add' && !myReactions.includes(latestReaction.reactionName)) {
+    Object.assign(payload, {
+      myReactions: [...myReactions, latestReaction.reactionName],
+    });
+  }
+
+  // existing reaction removed
+  if (latestReaction.eventName === 'remove' && myReactions.includes(latestReaction.reactionName)) {
+    Object.assign(payload, {
+      myReactions: myReactions.filter(x => x !== latestReaction.reactionName),
+    });
+  }
+};

package/src/report/api/createReport.ts

@@ -29,7 +29,13 @@ export const createReport = async (
 
   const { data } = await client.http.post<
     Amity.PostPayload | Amity.CommentPayload | Amity.MessagePayload | Amity.UserPayload
-  >(`/api/v3/${domainName}/${encodeURIComponent(referenceId)}/flag`);
+  >(
+    `/api/${
+      referenceType === 'user'
+        ? `v4/me/flags/${encodeURIComponent(referenceId)}`
+        : `v3/${domainName}/${encodeURIComponent(referenceId)}/flag`
+    }`,
+  );
 
   if (client.cache) ingestInCache(data);
 

package/src/report/api/deleteReport.ts

@@ -29,7 +29,13 @@ export const deleteReport = async (
 
   const { data } = await client.http.delete<
     Amity.PostPayload | Amity.CommentPayload | Amity.MessagePayload | Amity.UserPayload
-  >(`/api/v3/${domainName}/${encodeURIComponent(referenceId)}/unflag`);
+  >(
+    `/api/${
+      referenceType === 'user'
+        ? `v4/me/flags/${encodeURIComponent(referenceId)}`
+        : `v3/${domainName}/${encodeURIComponent(referenceId)}/unflag`
+    }`,
+  );
 
   if (client.cache) ingestInCache(data);