@amityco/ts-sdk 0.0.1-beta.3 → 0.0.1-beta.30

package/src/feed/api/queryGlobalFeed.ts

@@ -1,8 +1,9 @@
-import { getActiveClient } from '~/client/api/activeClient'
+import { getActiveClient } from '~/client/api/activeClient';
 
-import { ingestInCache } from '~/core/cache'
-import { toRecord } from '~/core/model'
-import { decoratePayload, toPage, toToken } from '~/core/query'
+import { toPage, toToken } from '~/core/query';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { pullFromCache, pushToCache } from '~/cache/api';
+import { getResolver } from '~/core/model';
 
 /**
  * ```js
@@ -17,34 +18,93 @@ import { decoratePayload, toPage, toToken } from '~/core/query'
  *
  * @category Feed API
  * @async
- **/
+ * */
 export const queryGlobalFeed = async (query?: {
-  dataTypes?: ('video' | 'image' | 'file')[]
-  page?: Amity.Page
-}) => {
-  const client = getActiveClient()
-  client.log('feed/queryGlobalFeed', query)
+  dataTypes?: ('video' | 'image' | 'file' | 'liveStream')[];
+  useCustomRanking?: boolean;
+  page?: Amity.Page;
+}): Promise<Amity.Cached<Amity.Paged<Amity.Post>>> => {
+  const client = getActiveClient();
+  client.log('feed/queryGlobalFeed', query);
 
-  const { page, ...params } = query ?? {}
+  const { useCustomRanking, page, ...params } = query ?? {};
 
   const { data } = await client.http.get<Amity.PostPayload & Amity.Pagination>(
-    `/api/v4/me/global-feeds`, { params: {
-      ...params,
-      options: {
-        token: toToken(page, 'skiplimit')
+    useCustomRanking ? `/api/v5/me/global-feeds` : `/api/v4/me/global-feeds`,
+    {
+      params: {
+        ...params,
+        options: {
+          token: toToken(page, 'skiplimit'),
+        },
       },
-    } }
-  )
+    },
+  );
 
-  const { paging, ...response } = data
+  const { paging, ...payload } = data;
+  const { posts } = payload;
 
-  decoratePayload(response as unknown as Record<string, object[]>)
-  ingestInCache(response as unknown as Record<string, object[]>)
+  const cachedAt = client.cache && Date.now();
 
-  const { posts } = response
+  if (client.cache) {
+    ingestInCache(payload as Amity.PostPayload);
 
-  const nextPage = toPage(paging.next)
-  const prevPage = toPage(paging.previous)
+    const cacheKey = [
+      'globalFeed',
+      'query',
+      { ...params, useCustomRanking, options: { ...page } } as Amity.Serializable,
+    ];
+    pushToCache(cacheKey, { posts: posts.map(getResolver('post')), paging });
+  }
 
-  return { data: toRecord(posts), nextPage, prevPage }
-}
+  const nextPage = toPage(paging.next);
+  const prevPage = toPage(paging.previous);
+
+  return { data: posts, cachedAt, prevPage, nextPage };
+};
+
+/**
+ * ```js
+ * import { queryGlobalFeed } from '@amityco/ts-sdk'
+ * const posts = await queryGlobalFeed.locally()
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.Post} objects from cache
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.Post} objects
+ *
+ * @category Feed API
+ * @async
+ * */
+queryGlobalFeed.locally = (
+  query: Parameters<typeof queryGlobalFeed>[0],
+): Amity.Cached<Amity.Paged<Amity.Post>> | undefined => {
+  const client = getActiveClient();
+  client.log('post/queryGlobalFeed.locally', query);
+
+  if (!client.cache) return;
+
+  const { useCustomRanking, page, ...params } = query ?? {};
+
+  const queryKey = [
+    'globalFeed',
+    'query',
+    { ...params, useCustomRanking, options: { ...page } } as Amity.Serializable,
+  ];
+  const { data, cachedAt } = pullFromCache<{ posts: string[] } & Amity.Pagination>(queryKey) ?? {};
+
+  if (!data?.posts.length) return;
+
+  const posts: Amity.Post[] = data.posts
+    .map(postId => pullFromCache<Amity.Post>(['post', 'get', postId])!)
+    .filter(Boolean)
+    .map(({ data }) => data);
+
+  const prevPage = toPage(data?.paging.previous);
+  const nextPage = toPage(data?.paging.next);
+
+  return posts.length === data?.posts?.length
+    ? { data: posts, cachedAt, prevPage, nextPage }
+    : undefined;
+};

package/src/file/api/createFile.ts

@@ -1,7 +1,6 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { decorateModels } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -12,6 +11,7 @@ import { ingestInCache } from '~/core/cache'
  * 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,32 +20,35 @@ import { ingestInCache } from '~/core/cache'
 export const createFile = async <T extends Amity.FileType = any>(
   formData: FormData,
   onProgress?: (percent: number) => void,
-) => {
-  const client = getActiveClient()
-  client.log('file/createFile', formData)
+): Promise<Amity.Cached<Amity.File[]>> => {
+  const client = getActiveClient();
+  client.log('file/createFile', formData);
 
-  if (!formData.getAll('file').length)
-    throw new Error('The formData object must have a `file` key.')
+  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 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/v4/files', formData, {
+    headers,
+    onUploadProgress({ loaded, total }) {
+      onProgress && onProgress(Math.round((loaded * 100) / total));
+    },
+  });
 
   // API-FIX: payload should be serialized properly
   // const { files } = data
 
-  decorateModels(data)
-  ingestInCache({ files: data })
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache({ files: data }, { cachedAt });
 
-  return data[0]
-}
+  return {
+    data,
+    cachedAt,
+  };
+};
 
 // TODO: consider doing local creation with URL.createObjectURL()

package/src/file/api/createImage.ts

@@ -0,0 +1,58 @@
+import { getActiveClient } from '~/client/api';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { createImage } from '@amityco/ts-sdk'
+ * const created = await createImage(formData)
+ * ```
+ *
+ * Creates an {@link Amity.File<'image'>}
+ *
+ * @param formData The data necessary to create a new {@link Amity.File<'image'>}
+ * @param onProgress The callback to track the upload progress
+ * @returns The newly created {@link Amity.File<'image'>}
+ *
+ * @category File API
+ * @async
+ */
+export const createImage = async (
+  formData: FormData,
+  onProgress?: (percent: number) => void,
+): Promise<Amity.Cached<Amity.File<'image'>[]>> => {
+  const client = getActiveClient();
+  client.log('file/createImage', 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<'image'>>(
+    '/api/v4/images',
+    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/createVideo.ts

@@ -0,0 +1,64 @@
+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 feedType The {@link Amity.File<'video'>} feed type
+ * @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,
+  feedType?: Amity.ContentFeedType,
+  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.');
+
+  if (feedType) {
+    formData.append('feedType', feedType);
+  }
+
+  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 { mergeInCache } from '~/core/cache'
+import { dropFromCache } from '~/cache/api';
 
 /**
  * ```js
@@ -18,18 +18,14 @@ import { mergeInCache } from '~/core/cache'
  */
 export const deleteFile = async (
   fileId: Amity.File<any>['fileId'],
-) => {
-  const client = getActiveClient()
-  client.log('file/deleteFile', fileId)
+): Promise<{ success: boolean }> => {
+  const client = getActiveClient();
+  client.log('file/deleteFile', fileId);
 
-  const { data } = await client.http.delete<{ success: boolean }>(
-    `/api/v3/files/${fileId}`,
-  )
+  // API-FIX: payload is different than swagger docs!!
+  await client.http.delete<{ fileId: string }>(`/api/v3/files/${fileId}`);
 
-  const { success } = data
+  dropFromCache(['file', 'get', fileId], true);
 
-  if (success)
-    mergeInCache('file', { fileId, isDeleted: true })
-
-  return success
-}
+  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 { decorateModel } from '~/core/query'
-import { ingestInCache, pullFromCache } from '~/core/cache'
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -11,7 +11,7 @@ import { ingestInCache, pullFromCache } from '~/core/cache'
  *
  * 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
@@ -19,22 +19,23 @@ import { ingestInCache, pullFromCache } from '~/core/cache'
  */
 export const getFile = async <T extends Amity.FileType = any>(
   fileId: Amity.File<any>['fileId'],
-) => {
-  const client = getActiveClient()
-  client.log('file/getFile', fileId)
+): Promise<Amity.Cached<Amity.File>> => {
+  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
 
-  decorateModel(data)
-  ingestInCache({ files: [data] })
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache({ files: [data] }, { cachedAt });
 
-  return data
-}
+  return {
+    data,
+    cachedAt,
+  };
+};
 
 /**
  * ```js
@@ -49,12 +50,18 @@ export const getFile = async <T extends Amity.FileType = any>(
  *
  * @category File API
  */
-getFile.locally = (
-  fileId: Amity.File<any>['fileId'],
-) => {
-  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;
+
+  const cached = pullFromCache<Amity.File>(['file', 'get', fileId]);
+
+  if (!cached) return;
 
-  const [file] = pullFromCache('file', fileId) ?? []
-  return file
-}
+  return {
+    data: cached.data,
+    cachedAt: cached.cachedAt,
+  };
+};

package/src/file/api/index.ts

@@ -1,4 +1,6 @@
-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';
+export * from './createImage';

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,36 +22,28 @@ import { getFile } from '../api'
  */
 export const observeFile = <Events extends ['onFetch']>(
   fileId: string,
-  callback: Amity.ObjectListener<Amity.QueryResult<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.QueryResult<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);
+
+  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);
+
+  return true;
+};

package/src/follow/api/follow.ts

@@ -0,0 +1,41 @@
+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);
+
+  return {
+    data: data.follows[0],
+    cachedAt,
+  };
+};