@amityco/ts-sdk 0.0.1-beta.14 → 0.0.1-beta.17

package/src/file/api/createFile.ts

@@ -1,6 +1,6 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -11,6 +11,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
  * Creates an {@link Amity.File}
  *
  * @param formData The data necessary to create a new {@link Amity.File}
+ * @param onProgress The callback to track the upload progress
  * @returns The newly created {@link Amity.File}
  *
  * @category File API
@@ -20,34 +21,34 @@ export const createFile = async <T extends Amity.FileType = any>(
   formData: FormData,
   onProgress?: (percent: number) => void,
 ): Promise<Amity.Cached<Amity.File>> => {
-  const client = getActiveClient()
-  client.log('file/createFile', formData)
+  const client = getActiveClient();
+  client.log('file/createFile', formData);
 
   if (!formData.getAll('file').length)
-    throw new Error('The formData object must have a `file` key.')
+    throw new Error('The formData object must have a `file` key.');
 
-  const headers = 'getHeaders' in formData
-    ? (formData as any).getHeaders()
-    : { 'content-type': 'multipart/form-data' }
+  const headers =
+    'getHeaders' in formData
+      ? (formData as any).getHeaders()
+      : { 'content-type': 'multipart/form-data' };
 
-  const { data } = await client.http.post<Amity.CreateFilePayload<T>>(
-    '/api/v3/files', formData, {
-      headers, onUploadProgress({ loaded, total }) {
-        onProgress && onProgress(Math.round((loaded * 100) / total))
-      }
-    }
-  )
+  const { data } = await client.http.post<Amity.CreateFilePayload<T>>('/api/v3/files', formData, {
+    headers,
+    onUploadProgress({ loaded, total }) {
+      onProgress && onProgress(Math.round((loaded * 100) / total));
+    },
+  });
 
   // API-FIX: payload should be serialized properly
   // const { files } = data
 
-  const cachedAt = client.cache && Date.now()
-  if (client.cache) ingestInCache({ files: data }, { cachedAt })
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache({ files: data }, { cachedAt });
 
   return {
     data: data[0],
     cachedAt,
-  }
-}
+  };
+};
 
 // TODO: consider doing local creation with URL.createObjectURL()

package/src/file/api/createVideo.ts

@@ -0,0 +1,58 @@
+import { getActiveClient } from '~/client/api';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { createVideo } from '@amityco/ts-sdk'
+ * const created = await createVideo(formData)
+ * ```
+ *
+ * Creates an {@link Amity.File<'video'>}
+ *
+ * @param formData The data necessary to create a new {@link Amity.File<'video'>}
+ * @param onProgress The callback to track the upload progress
+ * @returns The newly created {@link Amity.File<'video'>}
+ *
+ * @category File API
+ * @async
+ */
+export const createVideo = async (
+  formData: FormData,
+  onProgress?: (percent: number) => void,
+): Promise<Amity.Cached<Amity.File<'video'>[]>> => {
+  const client = getActiveClient();
+  client.log('file/createVideo', formData);
+
+  if (!formData.getAll('files').length)
+    throw new Error('The formData object must have a `files` key.');
+
+  const headers =
+    'getHeaders' in formData
+      ? (formData as any).getHeaders()
+      : { 'content-type': 'multipart/form-data' };
+
+  const { data } = await client.http.post<Amity.CreateFilePayload<'video'>>(
+    '/api/v4/videos',
+    formData,
+    {
+      headers,
+      onUploadProgress({ loaded, total }) {
+        onProgress && onProgress(Math.round((loaded * 100) / total));
+      },
+    },
+  );
+
+  // API-FIX: payload should be serialized properly
+  // const { files } = data
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache({ files: data }, { cachedAt });
+
+  return {
+    data,
+    cachedAt,
+  };
+};
+
+// TODO: consider doing local creation with URL.createObjectURL()

package/src/file/api/deleteFile.ts

@@ -1,6 +1,6 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { dropFromCache } from '~/cache/api'
+import { dropFromCache } from '~/cache/api';
 
 /**
  * ```js
@@ -18,16 +18,14 @@ import { dropFromCache } from '~/cache/api'
  */
 export const deleteFile = async (
   fileId: Amity.File<any>['fileId'],
-): Promise<{success: boolean}> => {
-  const client = getActiveClient()
-  client.log('file/deleteFile', fileId)
+): Promise<{ success: boolean }> => {
+  const client = getActiveClient();
+  client.log('file/deleteFile', fileId);
 
   // API-FIX: payload is different than swagger docs!!
-  await client.http.delete<{ fileId: string }>(
-    `/api/v3/files/${fileId}`,
-  )
+  await client.http.delete<{ fileId: string }>(`/api/v3/files/${fileId}`);
 
-  dropFromCache(['file', 'get', fileId], true)
+  dropFromCache(['file', 'get', fileId], true);
 
-  return { success: true }
-}
+  return { success: true };
+};

package/src/file/api/fileUrlWithSize.ts

@@ -9,5 +9,5 @@ export const fileUrlWithSize = (
   fileUrl: Amity.File['fileUrl'],
   size: 'small' | 'medium' | 'large' | 'full',
 ) => {
-  return `${fileUrl}?size=${size}`
-}
+  return `${fileUrl}?size=${size}`;
+};

package/src/file/api/getFile.ts

@@ -1,7 +1,7 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { pullFromCache } from '~/cache/api'
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -11,7 +11,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
  *
  * Fetches a {@link Amity.File} object
  *
- * @param filelId the ID of the {@link Amity.File} to fetch
+ * @param fileId the ID of the {@link Amity.File} to fetch
  * @returns the associated {@link Amity.File} object
  *
  * @category File API
@@ -20,24 +20,22 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
 export const getFile = async <T extends Amity.FileType = any>(
   fileId: Amity.File<any>['fileId'],
 ): Promise<Amity.Cached<Amity.File>> => {
-  const client = getActiveClient()
-  client.log('file/getFile', fileId)
+  const client = getActiveClient();
+  client.log('file/getFile', fileId);
 
-  const { data } = await client.http.get<Amity.FilePayload<T>>(
-    `/api/v3/files/${fileId}`,
-  )
+  const { data } = await client.http.get<Amity.FilePayload<T>>(`/api/v3/files/${fileId}`);
 
   // API-FIX: backend bad serializer issue. it should be:
   // const { files } = data
 
-  const cachedAt = client.cache && Date.now()
-  if (client.cache) ingestInCache({files: [data]}, { cachedAt })
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache({ files: [data] }, { cachedAt });
 
   return {
     data,
     cachedAt,
-  }
-}
+  };
+};
 
 /**
  * ```js
@@ -52,21 +50,18 @@ export const getFile = async <T extends Amity.FileType = any>(
  *
  * @category File API
  */
-getFile.locally = (
-  fileId: Amity.File<any>['fileId'],
-): Amity.Cached<Amity.File> | undefined => {
-  const client = getActiveClient()
-  client.log('file/getFile.locally', fileId)
+getFile.locally = (fileId: Amity.File<any>['fileId']): Amity.Cached<Amity.File> | undefined => {
+  const client = getActiveClient();
+  client.log('file/getFile.locally', fileId);
 
-  if (!client.cache) return
+  if (!client.cache) return;
 
-  const cached = pullFromCache<Amity.File>(['file', 'get', fileId])
+  const cached = pullFromCache<Amity.File>(['file', 'get', fileId]);
 
-  if (!cached)
-    return
+  if (!cached) return;
 
   return {
     data: cached.data,
     cachedAt: cached.cachedAt,
-  }
-}
+  };
+};

package/src/file/api/index.ts

@@ -1,4 +1,5 @@
-export * from './getFile'
-export * from './createFile'
-export * from './deleteFile'
-export * from './fileUrlWithSize'
+export * from './getFile';
+export * from './createFile';
+export * from './deleteFile';
+export * from './fileUrlWithSize';
+export * from './createVideo';

package/src/file/observers/index.ts

@@ -1 +1 @@
-export * from './observeFile'
+export * from './observeFile';

package/src/file/observers/observeFile.ts

@@ -1,8 +1,8 @@
-import { createQuery, runQuery } from '~/core/query/query'
+import { createQuery, runQuery } from '~/core/query/query';
 
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { getFile } from '../api'
+import { getFile } from '../api';
 
 /**
  * ```js
@@ -22,34 +22,28 @@ import { getFile } from '../api'
  */
 export const observeFile = <Events extends ['onFetch']>(
   fileId: string,
-  callback: Amity.ObjectListener<Amity.Snapshot<Amity.File>, Events>
+  callback: Amity.ObjectListener<Amity.Snapshot<Amity.File>, Events>,
 ): Amity.Unsubscriber => {
-  const { log } = getActiveClient()
+  const { log } = getActiveClient();
 
-  const timestamp = Date.now()
-  log(`observeFile(tmpid: ${timestamp}) > listen`)
+  const timestamp = Date.now();
+  log(`observeFile(tmpid: ${timestamp}) > listen`);
 
   // wrapper function to make sure
-  const router = (
-    result: Amity.Snapshot<Amity.File>,
-    action: Events[number]
-  ) => {
+  const router = (result: Amity.Snapshot<Amity.File>, action: Events[number]) => {
     // filter function
-    if (result.data?.fileId !== fileId) return
+    if (result.data?.fileId !== fileId) return;
 
-    if (callback instanceof Function) return callback(result)
+    if (callback instanceof Function) return callback(result);
 
-    if (action !== 'onFetch') callback.onEvent?.(action, result)
+    if (action !== 'onFetch') callback.onEvent?.(action, result);
 
-    callback[action]?.(result)
-  }
+    callback[action]?.(result);
+  };
 
-  runQuery(
-    createQuery(getFile, fileId),
-    result => result.data && router(result, 'onFetch')
-  )
+  runQuery(createQuery(getFile, fileId), result => result.data && router(result, 'onFetch'));
 
   return () => {
-    log(`observeFile(tmpid: ${timestamp}) > dispose`)
-  }
-}
+    log(`observeFile(tmpid: ${timestamp}) > dispose`);
+  };
+};

package/src/follow/api/acceptFollower.ts

@@ -0,0 +1,34 @@
+import { getActiveClient } from '~/client/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
+
+/**
+ * ```js
+ * import { acceptFollower } from '@amityco/ts-sdk'
+ * await acceptFollower('foobar')
+ * ```
+ *
+ * Accept the follow request
+ *
+ * @param userId the ID of the {@link Amity.User} follower
+ * @returns A success boolean if the follow request was accepted
+ *
+ * @category Follow API
+ * @async
+ */
+export const acceptFollower = async (userId: Amity.User['userId']): Promise<boolean> => {
+  const client = getActiveClient();
+  client.log('follow/acceptFollower', userId);
+
+  const { data } = await client.http.post<Amity.FollowStatusPayload>(
+    `/api/v4/me/followers/${userId}`,
+  );
+
+  if (client.cache) {
+    ingestInCache(data);
+  }
+
+  fireEvent('follow.accepted', data.follows[0]);
+
+  return true;
+};

package/src/follow/api/declineFollower.ts

@@ -0,0 +1,34 @@
+import { getActiveClient } from '~/client/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
+
+/**
+ * ```js
+ * import { declineFollower } from '@amityco/ts-sdk'
+ * await declineFollower('foobar')
+ * ```
+ *
+ * Decline the follow request or delete the follower
+ *
+ * @param userId the ID of the {@link Amity.User} follower
+ * @returns A success boolean if the follow request was decline
+ *
+ * @category Follow API
+ * @async
+ */
+export const declineFollower = async (userId: Amity.User['userId']): Promise<boolean> => {
+  const client = getActiveClient();
+  client.log('follow/declineFollower', userId);
+
+  const { data } = await client.http.delete<{ follows: Amity.FollowStatus[] }>(
+    `/api/v4/me/followers/${userId}`,
+  );
+
+  if (client.cache) {
+    ingestInCache(data);
+  }
+
+  fireEvent('follow.requestDeclined', data.follows[0]);
+
+  return true;
+};

package/src/follow/api/follow.ts

@@ -0,0 +1,44 @@
+import { getActiveClient } from '~/client/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
+
+/**
+ * ```js
+ * import { follow } from '@amityco/ts-sdk'
+ * const status = await follow('foobar')
+ * ```
+ *
+ * Follow the user
+ *
+ * @param userId the ID of the {@link Amity.User}
+ * @returns the status {@link Amity.FollowStatus}
+ *
+ * @category Follow API
+ * @async
+ */
+export const follow = async (
+  userId: Amity.User['userId'],
+): Promise<Amity.Cached<Amity.FollowStatus>> => {
+  const client = getActiveClient();
+  client.log('follow/follow', userId);
+
+  const { data } = await client.http.post<Amity.FollowStatusPayload>(
+    `/api/v4/me/following/${userId}`,
+  );
+
+  const cachedAt = client.cache && Date.now();
+
+  if (client.cache) {
+    ingestInCache(data, { cachedAt });
+  }
+
+  fireEvent(
+    data.follows[0].status === 'accepted' ? 'follow.created' : 'follow.requested',
+    data.follows[0],
+  );
+
+  return {
+    data: data.follows[0],
+    cachedAt,
+  };
+};

package/src/follow/api/getFollowInfo.ts

@@ -0,0 +1,83 @@
+import { getActiveClient } from '~/client/api';
+import { pullFromCache, pushToCache } from '~/cache/api';
+
+const getCacheKey = (userId: Amity.User['userId']) => [
+  'followInfo',
+  'get',
+  `${getActiveClient().userId}#${userId}`,
+];
+
+/**
+ * ```js
+ * import { getFollowInfo } from '@amityco/ts-sdk'
+ * const { data: followInfo } = await getFollowInfo('foobar')
+ * ```
+ *
+ * Fetches the number of followers, followings, pending requests and the follow status for current user
+ *
+ * @param userId the ID of the {@link Amity.User}
+ * @returns the associated {@link Amity.FollowInfo} object
+ *
+ * @category Follow API
+ * @async
+ */
+export const getFollowInfo = async (
+  userId: Amity.User['userId'],
+): Promise<Amity.Cached<Amity.FollowInfo>> => {
+  const client = getActiveClient();
+  client.log('follow/getFollowInfo', userId);
+
+  const { data } = await client.http.get<Amity.FollowInfoPayload>(
+    client.userId === userId ? `/api/v4/me/followInfo` : `/api/v4/users/${userId}/followInfo`,
+  );
+
+  const cachedAt = client.cache && Date.now();
+  const followInfo = {
+    ...data.followCounts[0],
+    status: data.follows?.[0]?.status,
+  };
+
+  if (client.cache) {
+    pushToCache(getCacheKey(userId), followInfo, { cachedAt });
+  }
+
+  return {
+    data: followInfo,
+    cachedAt,
+  };
+};
+
+/**
+ * ```js
+ * import { getFollowInfo } from '@amityco/ts-sdk'
+ * const { data: followInfo } = getFollowInfo.locally('foobar')
+ * ```
+ *
+ * Fetches the number of followers, followings, pending requests and the follow status for current user from cache
+ *
+ * @param userId the ID of the {@link Amity.User}
+ * @returns the associated {@link Amity.FollowInfo} object
+ *
+ * @category Follow API
+ */
+getFollowInfo.locally = (
+  userId: Amity.User['userId'],
+): Amity.Cached<Amity.FollowInfo> | undefined => {
+  const client = getActiveClient();
+  client.log('follow/getFollowInfo.locally', userId);
+
+  if (!client.cache) {
+    return;
+  }
+
+  const cached = pullFromCache<Amity.FollowInfo>(getCacheKey(userId));
+
+  if (!cached) {
+    return;
+  }
+
+  return {
+    data: cached.data,
+    cachedAt: cached.cachedAt,
+  };
+};

package/src/follow/api/index.ts

@@ -0,0 +1,8 @@
+export * from './queryFollowers';
+export * from './queryFollowings';
+export * from './getFollowInfo';
+
+export * from './follow';
+export * from './unfollow';
+export * from './acceptFollower';
+export * from './declineFollower';

package/src/follow/api/queryFollowers.ts

@@ -0,0 +1,39 @@
+import { queryFollows } from './utils';
+
+/**
+ * ```js
+ * import { queryFollowers } from '@amityco/ts-sdk'
+ * const { data: followers, prevPage, nextPage } = await queryFollowers({ userId })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.FollowStatus}
+ *
+ * @param query The query parameters
+ * @returns followers
+ *
+ * @category Follow API
+ * @async
+ */
+export const queryFollowers = async (query: {
+  userId: Amity.User['userId'];
+  status?: 'all' | Exclude<Amity.FollowStatus['status'], 'none'>;
+  page?: Amity.Page;
+}): Promise<Amity.Cached<Amity.Paged<Amity.FollowStatus>>> => queryFollows('followers', query);
+
+/**
+ * ```js
+ * import { queryFollowers } from '@amityco/ts-sdk'
+ * const { data: followers, prevPage, nextPage } = queryFollowers.locally({ userId })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.FollowStatus} objects from cache
+ *
+ * @param query The query parameters
+ * @returns followers
+ *
+ * @category Post API
+ */
+queryFollowers.locally = (
+  query: Parameters<typeof queryFollowers>[0],
+): Amity.Cached<Amity.Paged<Amity.FollowStatus>> | undefined =>
+  queryFollows.locally('followers', query);

package/src/follow/api/queryFollowings.ts

@@ -0,0 +1,39 @@
+import { queryFollows } from './utils';
+
+/**
+ * ```js
+ * import { queryFollowings } from '@amityco/ts-sdk'
+ * const { data: followings, prevPage, nextPage } = await queryFollowings({ userId })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.FollowStatus}
+ *
+ * @param query The query parameters
+ * @returns followings
+ *
+ * @category Follow API
+ * @async
+ */
+export const queryFollowings = async (query: {
+  userId: Amity.User['userId'];
+  status?: Exclude<Amity.FollowStatus['status'], 'none'>;
+  page?: Amity.Page;
+}): Promise<Amity.Cached<Amity.Paged<Amity.FollowStatus>>> => queryFollows('following', query);
+
+/**
+ * ```js
+ * import { queryFollowings } from '@amityco/ts-sdk'
+ * const { data: followings, prevPage, nextPage } = queryFollowings.locally({ userId })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.FollowStatus} objects from cache
+ *
+ * @param query The query parameters
+ * @returns followings
+ *
+ * @category Post API
+ */
+queryFollowings.locally = (
+  query: Parameters<typeof queryFollowings>[0],
+): Amity.Cached<Amity.Paged<Amity.FollowStatus>> | undefined =>
+  queryFollows.locally('following', query);

package/src/follow/api/unfollow.ts

@@ -0,0 +1,34 @@
+import { getActiveClient } from '~/client/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
+
+/**
+ * ```js
+ * import { unfollow } from '@amityco/ts-sdk'
+ * await unfollow('foobar')
+ * ```
+ *
+ * Cancel the follow request or unfollow the user
+ *
+ * @param userId the ID of the {@link Amity.User}
+ * @returns A success boolean if the user {@link Amity.User} was unfollowed
+ *
+ * @category Follow API
+ * @async
+ */
+export const unfollow = async (userId: Amity.User['userId']): Promise<boolean> => {
+  const client = getActiveClient();
+  client.log('follow/unfollow', userId);
+
+  const { data } = await client.http.delete<Amity.FollowStatusPayload>(
+    `/api/v4/me/following/${userId}`,
+  );
+
+  if (client.cache) {
+    ingestInCache(data);
+  }
+
+  fireEvent('follow.unfollowed', data.follows[0]);
+
+  return true;
+};