@amityco/ts-sdk 6.35.2 → 6.35.3-024c022.0

package/src/feedRepository/internalApi/getCustomRankingGlobalFeed.ts

@@ -1,87 +0,0 @@
-import { getActiveClient } from '~/client/api/activeClient';
-
-import { toPage, toToken } from '~/core/query';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import { pullFromCache, pushToCache } from '~/cache/api';
-import { getResolver } from '~/core/model';
-import { prepareMembershipPayload } from '~/group/utils';
-
-export const getCustomRankingGlobalFeed = async (query?: {
-  dataTypes?: ('video' | 'image' | 'file' | 'liveStream')[];
-  page?: Amity.Page;
-}): Promise<Amity.Cached<Amity.Paged<Amity.InternalPost>>> => {
-  const client = getActiveClient();
-  client.log('feed/getCustomRankingGlobalFeed', query);
-
-  const { page, ...params } = query ?? {};
-
-  const { data: queryPayload } = await client.http.get<Amity.PostPayload & Amity.Pagination>(
-    `/api/v5/me/global-feeds`,
-    {
-      params: {
-        ...params,
-        options: {
-          token: toToken(page, 'skiplimit'),
-        },
-      },
-    },
-  );
-
-  const { paging, ...payload } = queryPayload;
-
-  const data = prepareMembershipPayload(payload, 'communityUsers');
-
-  const { posts } = data;
-
-  const cachedAt = client.cache && Date.now();
-
-  if (client.cache) {
-    ingestInCache(data);
-
-    const cacheKey = [
-      'customGlobalFeed',
-      'query',
-      { ...params, options: { ...page } } as Amity.Serializable,
-    ];
-    pushToCache(cacheKey, { posts: posts.map(getResolver('post')), paging });
-  }
-
-  const nextPage = toPage(paging.next);
-  const prevPage = toPage(paging.previous);
-
-  return { data: posts, cachedAt, prevPage, nextPage };
-};
-
-getCustomRankingGlobalFeed.locally = (
-  query?: Parameters<typeof getCustomRankingGlobalFeed>[0],
-): Amity.Cached<Amity.Paged<Amity.InternalPost>> | undefined => {
-  const client = getActiveClient();
-  client.log('post/getCustomRankingGlobalFeed.locally', query);
-
-  if (!client.cache) return;
-
-  const { page, ...params } = query ?? {};
-
-  const queryKey = [
-    'customGlobalFeed',
-    'query',
-    { ...params, options: { ...page } } as Amity.Serializable,
-  ];
-
-  const { data, cachedAt } =
-    pullFromCache<{ posts: Amity.InternalPost['postId'][] } & Amity.Pagination>(queryKey) ?? {};
-
-  if (!data?.posts.length) return;
-
-  const posts: Amity.InternalPost[] = data.posts
-    .map(postId => pullFromCache<Amity.InternalPost>(['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/feedRepository/internalApi/index.ts

@@ -1,2 +0,0 @@
-export * from './queryGlobalFeed';
-export * from './getCustomRankingGlobalFeed';

package/src/feedRepository/internalApi/queryGlobalFeed.ts

@@ -1,95 +0,0 @@
-import { getActiveClient } from '~/client/api/activeClient';
-
-import { toPage, toToken } from '~/core/query';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import { pullFromCache, pushToCache } from '~/cache/api';
-import { getResolver } from '~/core/model';
-import { prepareMembershipPayload } from '~/group/utils';
-
-export const queryGlobalFeed = async (query?: {
-  dataTypes?: ('video' | 'image' | 'file' | 'liveStream')[];
-  useCustomRanking?: boolean;
-  page?: Amity.Page;
-}): Promise<Amity.Cached<Amity.Paged<Amity.InternalPost>>> => {
-  const client = getActiveClient();
-  client.log('feed/queryGlobalFeed', query);
-
-  const { useCustomRanking, page, ...params } = query ?? {};
-
-  /*
-   * TODO: Remove useCustomRanking key from query
-   */
-  if (useCustomRanking)
-    console.warn(
-      'The param "useCustomRanking" has been deprecated. To get custom ranking feed use FeedRepository.getCustomRankingGlobalFeed instead',
-    );
-
-  const { data: queryPayload } = await client.http.get<Amity.PostPayload & Amity.Pagination>(
-    `/api/v4/me/global-feeds`,
-    {
-      params: {
-        ...params,
-        options: {
-          token: toToken(page, 'skiplimit'),
-        },
-      },
-    },
-  );
-
-  const { paging, ...payload } = queryPayload;
-
-  const data = prepareMembershipPayload(payload, 'communityUsers');
-
-  const { posts } = data;
-
-  const cachedAt = client.cache && Date.now();
-
-  if (client.cache) {
-    ingestInCache(data);
-
-    const cacheKey = [
-      'globalFeed',
-      'query',
-      { ...params, options: { ...page } } as Amity.Serializable,
-    ];
-    pushToCache(cacheKey, { posts: posts.map(getResolver('post')), paging });
-  }
-
-  const nextPage = toPage(paging.next);
-  const prevPage = toPage(paging.previous);
-
-  return { data: posts, cachedAt, prevPage, nextPage };
-};
-
-queryGlobalFeed.locally = (
-  query?: Parameters<typeof queryGlobalFeed>[0],
-): Amity.Cached<Amity.Paged<Amity.InternalPost>> | undefined => {
-  const client = getActiveClient();
-  client.log('post/queryGlobalFeed.locally', query);
-
-  if (!client.cache) return;
-
-  const { page, ...params } = query ?? {};
-
-  const queryKey = [
-    'globalFeed',
-    'query',
-    { ...params, options: { ...page } } as Amity.Serializable,
-  ];
-  const { data, cachedAt } =
-    pullFromCache<{ posts: Amity.InternalPost['postId'][] } & Amity.Pagination>(queryKey) ?? {};
-
-  if (!data?.posts.length) return;
-
-  const posts: Amity.InternalPost[] = data.posts
-    .map(postId => pullFromCache<Amity.InternalPost>(['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/feedRepository/internalApi/test/getCustomRankingGlobalFeed.test.ts

@@ -1,138 +0,0 @@
-import { disableCache, enableCache, pullFromCache, pushToCache } from '~/cache/api';
-
-import { client, deepCopy, post11, post12, user11 } from '~/utils/tests';
-
-import { getCustomRankingGlobalFeed } from '../getCustomRankingGlobalFeed';
-
-const pagingToken = {
-  previous: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
-  next: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
-};
-
-const postsToQuery = [post11, post12];
-const postIdsToQuery = postsToQuery.map(post => post.postId);
-const pagingCriteria = { limit: 10 };
-const queryCriteriaWithoutPage = {};
-const queryCriteria = { ...queryCriteriaWithoutPage, page: pagingCriteria };
-
-const resolvedQueryFeedValue = {
-  data: {
-    posts: postsToQuery,
-    postChildren: [],
-    categories: [],
-    comments: [],
-    communityUsers: [],
-    feeds: [],
-    files: [],
-    polls: [],
-    users: [user11],
-    paging: pagingToken,
-  },
-};
-
-describe('getCustomRankingGlobalFeed', () => {
-  test('it should return fetched feed with correct paging', async () => {
-    client.http.get = jest.fn().mockResolvedValueOnce(resolvedQueryFeedValue);
-
-    const result = await getCustomRankingGlobalFeed(queryCriteria);
-
-    expect(deepCopy(result)).toEqual(
-      expect.objectContaining(
-        deepCopy({
-          data: postsToQuery,
-          prevPage: { before: 55, limit: 10 },
-          nextPage: { before: 55, limit: 10 },
-        }),
-      ),
-    );
-  });
-
-  test('it should update cache after fetching feed', async () => {
-    enableCache();
-    client.http.get = jest.fn().mockResolvedValue(resolvedQueryFeedValue);
-
-    await getCustomRankingGlobalFeed(queryCriteria);
-
-    const recieved = pullFromCache([
-      'customGlobalFeed',
-      'query',
-      { ...queryCriteriaWithoutPage, options: pagingCriteria },
-    ])?.data;
-
-    expect(recieved).toEqual({
-      posts: postIdsToQuery,
-      paging: pagingToken,
-    });
-
-    disableCache();
-  });
-
-  test('it should call the correct api', async () => {
-    const resolver = jest.fn().mockResolvedValue(resolvedQueryFeedValue);
-    client.http.get = resolver;
-
-    await getCustomRankingGlobalFeed(queryCriteria);
-
-    expect(resolver).toHaveBeenCalledWith(`/api/v5/me/global-feeds`, expect.any(Object));
-  });
-
-  test('it should throw an error if request fails', async () => {
-    client.http.get = jest.fn().mockRejectedValueOnce(new Error('error'));
-
-    await expect(getCustomRankingGlobalFeed(queryCriteria)).rejects.toThrow('error');
-  });
-});
-
-describe('getCustomRankingGlobalFeed.locally', () => {
-  beforeEach(enableCache);
-  afterEach(disableCache);
-
-  test('it should return cached feed', () => {
-    postsToQuery.forEach(post => pushToCache(['post', 'get', post.postId], post));
-
-    pushToCache(
-      ['customGlobalFeed', 'query', { ...queryCriteriaWithoutPage, options: pagingCriteria }],
-      {
-        posts: postIdsToQuery,
-        paging: pagingToken,
-      },
-    );
-
-    pushToCache(['user', 'get', user11.userId], user11);
-
-    expect(deepCopy(getCustomRankingGlobalFeed.locally(queryCriteria))).toEqual(
-      expect.objectContaining(
-        deepCopy({
-          data: postsToQuery,
-          prevPage: { before: 55, limit: 10 },
-          nextPage: { before: 55, limit: 10 },
-        }),
-      ),
-    );
-  });
-
-  test('it should accept undefined query param', async () => {
-    client.http.get = jest.fn().mockResolvedValueOnce(resolvedQueryFeedValue);
-
-    expect(() => getCustomRankingGlobalFeed.locally()).not.toThrow();
-  });
-
-  test(`it shouldn't return if individual feed cache not exist`, () => {
-    pushToCache(['globalFeed', 'query', { ...queryCriteriaWithoutPage, options: pagingCriteria }], {
-      posts: postIdsToQuery,
-      paging: pagingToken,
-    });
-
-    expect(getCustomRankingGlobalFeed.locally(queryCriteria)).toBeUndefined();
-  });
-
-  test('it should return undefined if feed not in cache', () => {
-    expect(getCustomRankingGlobalFeed.locally({})).toBeUndefined();
-  });
-
-  test('it should return undefined if cache disabled', () => {
-    disableCache();
-
-    expect(getCustomRankingGlobalFeed.locally({})).toBeUndefined();
-  });
-});

package/src/feedRepository/internalApi/test/queryGlobalFeed.test.ts

@@ -1,130 +0,0 @@
-import { disableCache, enableCache, pullFromCache, pushToCache } from '~/cache/api';
-
-import { client, deepCopy, post11, post12, user11 } from '~/utils/tests';
-
-import { queryGlobalFeed } from '../queryGlobalFeed';
-
-const pagingToken = {
-  previous: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
-  next: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
-};
-
-const postsToQuery = [post11, post12];
-const postIdsToQuery = postsToQuery.map(post => post.postId);
-const pagingCriteria = { limit: 10 };
-const queryCriteriaWithoutPage = {};
-const queryCriteria = { ...queryCriteriaWithoutPage, page: pagingCriteria };
-
-const resolvedQueryFeedValue = {
-  data: {
-    posts: postsToQuery,
-    postChildren: [],
-    categories: [],
-    comments: [],
-    communityUsers: [],
-    feeds: [],
-    files: [],
-    polls: [],
-    users: [user11],
-    paging: pagingToken,
-  },
-};
-
-describe('queryGlobalFeed', () => {
-  test('should return fetched feed with correct paging', async () => {
-    client.http.get = jest.fn().mockResolvedValueOnce(resolvedQueryFeedValue);
-
-    const result = await queryGlobalFeed(queryCriteria);
-    expect(deepCopy(result)).toEqual(
-      expect.objectContaining(
-        deepCopy({
-          data: postsToQuery,
-          prevPage: { before: 55, limit: 10 },
-          nextPage: { before: 55, limit: 10 },
-        }),
-      ),
-    );
-  });
-
-  test('should accept undefined query param', async () => {
-    client.http.get = jest.fn().mockResolvedValueOnce(resolvedQueryFeedValue);
-
-    await expect(queryGlobalFeed()).resolves.not.toThrow();
-  });
-
-  test('should update cache after fetching feed', async () => {
-    enableCache();
-    client.http.get = jest.fn().mockResolvedValue(resolvedQueryFeedValue);
-
-    await queryGlobalFeed(queryCriteria);
-
-    const recieved = pullFromCache([
-      'globalFeed',
-      'query',
-      { ...queryCriteriaWithoutPage, options: pagingCriteria },
-    ])?.data;
-
-    expect(recieved).toEqual({
-      posts: postIdsToQuery,
-      paging: pagingToken,
-    });
-
-    disableCache();
-  });
-
-  test('should throw an error if request fails', async () => {
-    client.http.get = jest.fn().mockRejectedValueOnce(new Error('error'));
-
-    await expect(queryGlobalFeed(queryCriteria)).rejects.toThrow('error');
-  });
-});
-
-describe('queryGlobalFeed.locally', () => {
-  beforeEach(enableCache);
-  afterEach(disableCache);
-
-  test('should return cached feed', () => {
-    postsToQuery.forEach(post => pushToCache(['post', 'get', post.postId], post));
-
-    pushToCache(['globalFeed', 'query', { ...queryCriteriaWithoutPage, options: pagingCriteria }], {
-      posts: postIdsToQuery,
-      paging: pagingToken,
-    });
-    pushToCache(['user', 'get', user11.userId], user11);
-
-    expect(deepCopy(queryGlobalFeed.locally(queryCriteria))).toEqual(
-      expect.objectContaining(
-        deepCopy({
-          data: postsToQuery,
-          prevPage: { before: 55, limit: 10 },
-          nextPage: { before: 55, limit: 10 },
-        }),
-      ),
-    );
-  });
-
-  test('should accept undefined query param', async () => {
-    client.http.get = jest.fn().mockResolvedValueOnce(resolvedQueryFeedValue);
-
-    expect(() => queryGlobalFeed.locally()).not.toThrow();
-  });
-
-  test(`shouldn't return if individual feed cache not exist`, () => {
-    pushToCache(['globalFeed', 'query', { ...queryCriteriaWithoutPage, options: pagingCriteria }], {
-      posts: postIdsToQuery,
-      paging: pagingToken,
-    });
-
-    expect(queryGlobalFeed.locally(queryCriteria)).toBeUndefined();
-  });
-
-  test('it should return undefined if feed not in cache', () => {
-    expect(queryGlobalFeed.locally({})).toBeUndefined();
-  });
-
-  test('it should return undefined if cache disabled', () => {
-    disableCache();
-
-    expect(queryGlobalFeed.locally({})).toBeUndefined();
-  });
-});

package/src/fileRepository/api/createFile.ts

@@ -1,59 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
-
-/**
- * ```js
- * import { FileRepository } from '@amityco/ts-sdk'
- * const created = await FileRepository.createFile(formData)
- * ```
- *
- * 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
- * @async
- */
-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 files = formData.getAll('files');
-
-  if (!files.length) throw new Error('The formData object must have a `files` key.');
-
-  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
-  formData.append('accessType', accessType);
-
-  formData.append('preferredFilename', (files[0] as File).name);
-
-  const headers =
-    'getHeaders' in formData
-      ? (formData as any).getHeaders()
-      : { 'content-type': 'multipart/form-data' };
-
-  const { data } = await client.http.post<Amity.CreateFilePayload<T>>('/api/v4/files', formData, {
-    headers,
-    onUploadProgress({ loaded, total = 100 }) {
-      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,
-  };
-};

package/src/fileRepository/api/createImage.ts

@@ -1,59 +0,0 @@
-import { getActiveClient } from '~/client/api';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
-
-/**
- * ```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);
-
-  const files = formData.getAll('files');
-
-  if (!files.length) throw new Error('The formData object must have a `files` key.');
-
-  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
-  formData.append('accessType', accessType);
-
-  formData.append('preferredFilename', (files[0] as File).name);
-
-  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 = 100 }) {
-        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,
-  };
-};
-/* end_public_function */

package/src/fileRepository/api/createVideo.ts

@@ -1,69 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
-
-/**
- * ```js
- * import { FileRepository } from '@amityco/ts-sdk'
- * const created = await FileRepository.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 uploaded {@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);
-
-  const files = formData.getAll('files');
-
-  if (!files.length) throw new Error('The formData object must have a `files` key.');
-
-  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
-  formData.append('accessType', accessType);
-
-  formData.append('preferredFilename', (files[0] as File).name);
-
-  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 = 100 }) {
-        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,
-  };
-};

package/src/fileRepository/observers/index.ts

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

package/src/fileRepository/observers/observeFile.ts

@@ -1,49 +0,0 @@
-import { createQuery, runQuery } from '~/core/query/query';
-
-import { getActiveClient } from '~/client/api';
-
-import { getFile } from '../api';
-
-/**
- * ```js
- * import { observeFile } from '@amityco/ts-sdk'
- *
- * let file = {}
- * const dispose = observeFile(fileId, updated => file = updated)
- * ```
- *
- * Observe all mutation on a given {@link Amity.File}
- *
- * @param fileId the ID of the file 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 file
- *
- * @category File Observer
- */
-export const observeFile = <Events extends ['onFetch']>(
-  fileId: string,
-  callback: Amity.ObjectListener<Amity.Snapshot<Amity.File>, Events>,
-): Amity.Unsubscriber => {
-  const { log } = getActiveClient();
-
-  const timestamp = Date.now();
-  log(`observeFile(tmpid: ${timestamp}) > listen`);
-
-  // wrapper function to make sure
-  const router = (result: Amity.Snapshot<Amity.File>, action: Events[number]) => {
-    // filter function
-    if (result.data?.fileId !== fileId) return;
-
-    if (callback instanceof Function) return callback(result);
-
-    if (action !== 'onFetch') callback.onEvent?.(action, result);
-
-    callback[action]?.(result);
-  };
-
-  runQuery(createQuery(getFile, fileId), result => result.data && router(result, 'onFetch'));
-
-  return () => {
-    log(`observeFile(tmpid: ${timestamp}) > dispose`);
-  };
-};