@amityco/ts-sdk 0.0.1-003998f.0

package/src/poll/api/getPoll.ts

@@ -0,0 +1,64 @@
+import { getActiveClient } from '~/client/api';
+
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { getPoll } from '@amityco/ts-sdk'
+ * const poll = await getPoll('foobar')
+ * ```
+ *
+ * Fetches a {@link Amity.Poll} object
+ *
+ * @param pollId the ID of the {@link Amity.Poll} to fetch
+ * @returns the associated {@link Amity.Poll} object
+ *
+ * @category Poll API
+ * @async
+ */
+export const getPoll = async (pollId: Amity.Poll['pollId']): Promise<Amity.Cached<Amity.Poll>> => {
+  const client = getActiveClient();
+  client.log('poll/getPoll', pollId);
+
+  const { data } = await client.http.get<Amity.PollPayload>(`/api/v3/polls/${pollId}`);
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  const { polls } = data;
+
+  return {
+    data: polls.find(poll => poll.pollId === pollId)!,
+    cachedAt,
+  };
+};
+
+/**
+ * ```js
+ * import { getPoll } from '@amityco/ts-sdk'
+ * const poll = getPoll.locally('foobar')
+ * ```
+ *
+ * Fetches a {@link Amity.Poll} object
+ *
+ * @param pollId the ID of the {@link Amity.Poll} to fetch
+ * @returns the associated {@link Amity.Poll} object
+ *
+ * @category Poll API
+ */
+getPoll.locally = (pollId: Amity.Poll['pollId']): Amity.Cached<Amity.Poll> | undefined => {
+  const client = getActiveClient();
+  client.log('poll/getPoll', pollId);
+
+  if (!client.cache) return;
+
+  const cached = pullFromCache<Amity.Poll>(['poll', 'get', pollId]);
+
+  if (!cached) return;
+
+  return {
+    data: cached.data,
+    cachedAt: cached.cachedAt,
+  };
+};

package/src/poll/api/index.ts

@@ -0,0 +1,7 @@
+export * from './getPoll';
+
+export * from './createPoll';
+export * from './closePoll';
+export * from './deletePoll';
+
+export * from './votePoll';

package/src/poll/api/votePoll.ts

@@ -0,0 +1,44 @@
+import { fireEvent } from '~/core/events';
+import { getActiveClient } from '~/client/api';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { votePoll } from '@amityco/ts-sdk'
+ * const voted = await votePoll(pollId)
+ * ```
+ *
+ * Votes for an {@link Amity.Poll}
+ *
+ * @param pollId The ID of the {@link Amity.Poll} to vote
+ * @param answerIds The IDs of the {@link Amity.Poll} answers to vote {@link Amity.Poll}
+ * @returns the updated {@link Amity.Poll} object
+ *
+ * @category Poll API
+ * @async
+ */
+export const votePoll = async (
+  pollId: Amity.Poll['pollId'],
+  answerIds: string[],
+): Promise<Amity.Cached<Amity.Poll>> => {
+  const client = getActiveClient();
+  client.log('user/votePoll', pollId);
+
+  const { data } = await client.http.post<Amity.PollPayload>(
+    `/api/v3/polls/${encodeURIComponent(pollId)}/votes`,
+    { pollId, answerIds },
+  );
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  const { polls } = data;
+
+  fireEvent('poll.updated', data);
+
+  return {
+    data: polls.find(poll => poll.pollId === pollId)!,
+    cachedAt,
+  };
+};

package/src/poll/events/index.ts

@@ -0,0 +1,2 @@
+export * from './onPollUpdated';
+export * from './onPollDeleted';

package/src/poll/events/onPollDeleted.ts

@@ -0,0 +1,31 @@
+import { getActiveClient } from '~/client/api';
+import { createEventSubscriber } from '~/core/events';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { onPollDeleted } from '@amityco/ts-sdk'
+ * const dispose = onPollDeleted(poll => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when an {@link Amity.Poll} has been deleted
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Poll Events
+ */
+export const onPollDeleted = (callback: Amity.Listener<Amity.Poll>): Amity.Unsubscriber => {
+  const client = getActiveClient();
+
+  const filter = (payload: Amity.PollPayload) => {
+    if (client.cache) ingestInCache(payload);
+
+    callback(payload.polls[0]);
+  };
+
+  return createEventSubscriber(client, 'poll/onPollDeleted', 'poll.deleted', filter);
+};

package/src/poll/events/onPollUpdated.ts

@@ -0,0 +1,31 @@
+import { getActiveClient } from '~/client/api';
+import { createEventSubscriber } from '~/core/events';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { onPollUpdated } from '@amityco/ts-sdk'
+ * const dispose = onPollUpdated(poll => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when an {@link Amity.Poll} has been updated
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Poll Events
+ */
+export const onPollUpdated = (callback: Amity.Listener<Amity.Poll>): Amity.Unsubscriber => {
+  const client = getActiveClient();
+
+  const filter = (payload: Amity.PollPayload) => {
+    if (client.cache) ingestInCache(payload);
+
+    callback(payload.polls[0]);
+  };
+
+  return createEventSubscriber(client, 'poll/onPollUpdated', 'poll.updated', filter);
+};

package/src/poll/observers/index.ts

@@ -0,0 +1 @@
+export * from './observePoll';

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/createPost.ts

@@ -0,0 +1,53 @@
+import { getActiveClient } from '~/client/api';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
+
+/**
+ * ```js
+ * import { createPost } from '@amityco/ts-sdk'
+ * const created = await createPost({
+ *   targetType: 'user',
+ *   targetId: 'foobar',
+ *   data: { text: 'hello world' }
+ * }))
+ * ```
+ *
+ * Creates an {@link Amity.Post}
+ *
+ * @param bundle The data necessary to create a new {@link Amity.Post}
+ * @returns The newly created {@link Amity.Post}
+ *
+ * @category Post API
+ * @async
+ */
+export const createPost = async <T extends Amity.PostContentType | string>(
+  bundle: Pick<Amity.Post, 'targetType' | 'targetId' | 'metadata' | 'mentionees' | 'tags'> & {
+    dataType?: T;
+    data?: { [k: string]: any };
+    attachments?: { type: T; fileId: Amity.File['fileId'] }[];
+  },
+): Promise<Amity.Cached<Amity.Post>> => {
+  const client = getActiveClient();
+  client.log('post/createPost', bundle);
+
+  // API-FIX: backend rejects that we pass the dataType manually T_T
+  if (!bundle.dataType || ['text', 'image', 'file', 'video'].includes(bundle.dataType)) {
+    // eslint-disable-next-line no-param-reassign
+    delete bundle.dataType;
+  }
+
+  const { data } = await client.http.post<Amity.PostPayload>('/api/v4/posts', bundle);
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  fireEvent('post.created', data);
+
+  const { posts } = data;
+
+  return {
+    data: posts[0],
+    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/deletePost.ts

@@ -0,0 +1,64 @@
+import { getActiveClient } from '~/client/api';
+
+import { fireEvent } from '~/core/events';
+import { upsertInCache } from '~/cache/api';
+import { getCommunity } from '~/community/api';
+import { pushToTombstone } from '~/cache/api/pushToTombstone';
+
+import { getPost } from './getPost';
+
+/**
+ * ```js
+ * import { deletePost } from '@amityco/ts-sdk'
+ * const success = await deletePost('foobar')
+ * ```
+ *
+ * Deletes a {@link Amity.Post}
+ *
+ * @param postId The {@link Amity.Post} ID to delete
+ * @return A success boolean if the {@link Amity.Post} was deleted
+ *
+ * @category Post API
+ * @async
+ */
+export const deletePost = async (
+  postId: Amity.Post['postId'],
+  permanent = false,
+): Promise<Amity.Post> => {
+  const client = getActiveClient();
+  client.log('post/deletePost', postId);
+
+  const post = await getPost(postId);
+
+  // API-FIX: This endpoint has not been implemented yet.
+  await client.http.delete<{ success: boolean }>(`/api/v4/posts/${encodeURIComponent(postId)}`, {
+    params: {
+      postId,
+      permanent,
+    },
+  });
+
+  // there is currently a limitation which doesn't allow us to fire event to tell that community
+  // has been updated. reason is that, when the object is deleted, we don't have its `communityId`
+  // and so we cannot refetch the community or advertise on events. hopefully this should be solved
+  // later when realtime events covers that for us.
+  if (post.data.targetType === 'community') {
+    const community = await getCommunity(post.data.targetId);
+    fireEvent('community.updated', { communities: [community.data] });
+  }
+
+  // to support hard deletion
+  const deleted = { ...post.data, isDeleted: true };
+
+  fireEvent('post.deleted', { posts: [deleted] });
+
+  if (permanent) {
+    setTimeout(() => {
+      pushToTombstone('post', postId);
+    }, 0);
+  } else {
+    upsertInCache(['post', 'get', postId], { isDeleted: true });
+  }
+
+  return deleted;
+};

package/src/post/api/getPost.ts

@@ -0,0 +1,83 @@
+import { getActiveClient } from '~/client/api';
+
+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';
+
+/**
+ * ```js
+ * import { getPost } from '@amityco/ts-sdk'
+ * const { data: post } = await getPost('foobar')
+ * ```
+ *
+ * Fetches a {@link Amity.Post} object
+ *
+ * @param postId the ID of the {@link Amity.Post} to fetch
+ * @returns the associated {@link Amity.Post} object
+ *
+ * @category Post API
+ * @async
+ */
+export const getPost = async (postId: Amity.Post['postId']): Promise<Amity.Cached<Amity.Post>> => {
+  const client = getActiveClient();
+  client.log('post/getPost', postId);
+
+  isInTombstone('post', postId);
+
+  let data: Amity.PostPayload;
+
+  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)}`,
+    );
+    data = response.data;
+  } catch (error) {
+    if (checkIfShouldGoesToTombstone((error as Amity.ErrorResponse)?.code)) {
+      pushToTombstone('post', postId);
+    }
+
+    throw error;
+  }
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  const { posts } = data;
+
+  return {
+    data: posts.find(post => post.postId === postId)!,
+    cachedAt,
+  };
+};
+
+/**
+ * ```js
+ * import { getPost } from '@amityco/ts-sdk'
+ * const { data: post } = getPost.locally('foobar')
+ * ```
+ *
+ * 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']): 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

@@ -0,0 +1,74 @@
+import { getActiveClient } from '~/client/api';
+
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { getPosts } from '@amityco/ts-sdk'
+ * const { data: posts } = await getPosts(['foo', 'bar'])
+ * ```
+ *
+ * Fetches a collection of {@link Amity.Post} objects
+ *
+ * @param postIds the IDs of the {@link Amity.Post} to fetch
+ * @returns the associated collection of {@link Amity.Post} objects
+ *
+ * @category Post API
+ * @async
+ */
+export const getPosts = async (
+  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: encodedPostIds },
+  });
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  return {
+    data: data.posts,
+    cachedAt,
+  };
+};
+
+/**
+ * ```js
+ * import { getPosts } from '@amityco/ts-sdk'
+ * const { data: posts } = getPosts.locally(['foo', 'bar'])
+ * ```
+ *
+ * Fetches a collection of {@link Amity.Post} objects from cache
+ *
+ * @param postIds the IDs of the {@link Amity.Post} to fetch
+ * @returns the associated collection of {@link Amity.Post} objects
+ *
+ * @category Post API
+ */
+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];
+
+  if (cached?.length < postIds.length) return;
+
+  return {
+    data: posts,
+    cachedAt: oldest.cachedAt,
+  };
+};

package/src/post/api/index.ts

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