@amityco/ts-sdk-react-native 6.36.0 → 7.0.0

package/src/communityRepository/api/getTopTrendingCommunities.ts

@@ -1,97 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import { getResolver } from '~/core/model';
-import { pullFromCache, pushToCache } from '~/cache/api';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-
-import { prepareCommunityPayload } from '../utils';
-
-/* begin_public_function
-  id: community.query.trending_communities
-*/
-/**
- * @deprecated This API renamed to `getTrendingCommunities()`.
- * Please use getTrendingCommunities() instead.
- *
- * ```js
- * import { CommunityRepository } from '@amityco/ts-sdk-react-native'
- * const trendingCommunities = await CommunityRepository.getTrendingCommunities()
- * ```
- *
- * Gets a list of top trending {@link Amity.Community} objects
- *
- * @param query The query parameters
- * @returns A list of {@link Amity.Community} objects
- *
- * @category Community API
- * @async
- */
-export const getTopTrendingCommunities = async (
-  query?: Partial<Amity.PageLimit>,
-): Promise<Amity.Cached<Amity.Community[]>> => {
-  const client = getActiveClient();
-  client.log('channel/getTopTrendingCommunities', query);
-
-  const { limit = 5 } = query ?? {};
-
-  // API-FIX: backend doesnt answer Amity.Response
-  // const { data } = await client.http.get<Amity.Response<CommunityPayload>>(
-  const { data: payload } = await client.http.get<Amity.CommunityPayload>(
-    `/api/v3/communities/top-trending`,
-    { params: { options: { limit } } },
-  );
-
-  const data = prepareCommunityPayload(payload);
-  const { communities } = data;
-
-  const cachedAt = client.cache && Date.now();
-
-  if (client.cache) {
-    ingestInCache(data, { cachedAt });
-
-    const cacheKey = ['community', 'top-trending', { params: { options: { limit } } }];
-    pushToCache(cacheKey, { communities: communities.map(getResolver('community')) });
-  }
-
-  return { data: communities, cachedAt };
-};
-/* end_public_function */
-
-/**
- * ```js
- * import { getTopTrendingCommunities } from '@amityco/ts-sdk-react-native'
- * const communities = getTopTrendingCommunities.locally()
- * ```
- *
- * Gets a list of top trending {@link Amity.Community} objects from cache
- *
- * @param query The query parameters
- * @returns communities
- *
- * @category Community API
- */
-getTopTrendingCommunities.locally = (
-  query: Parameters<typeof getTopTrendingCommunities>[0],
-): Amity.Cached<Amity.Community[]> | undefined => {
-  const client = getActiveClient();
-  client.log('community/getTopTrendingCommunities.locally', query);
-
-  if (!client.cache) return;
-
-  const { limit = 5 } = query ?? {};
-
-  const queryKey = ['community', 'top-trending', { params: { options: { limit } } }];
-  const { data, cachedAt } =
-    pullFromCache<{ communities: Pick<Amity.Community, 'communityId'>[] }>(queryKey) ?? {};
-
-  if (!data?.communities.length) return;
-
-  const communities: Amity.Community[] = data.communities
-    .map(communityId => pullFromCache<Amity.Community>(['community', 'get', communityId])!)
-    .filter(Boolean)
-    .map(({ data }) => data);
-
-  return communities.length === data?.communities?.length
-    ? { data: communities, cachedAt }
-    : undefined;
-};

package/src/communityRepository/api/test/getTopTrendingCommunities.test.ts

@@ -1,102 +0,0 @@
-import { disableCache, enableCache, pullFromCache, pushToCache } from '~/cache/api';
-import { client, community11, community21 } from '~/utils/tests';
-
-import { getTopTrendingCommunities } from '../getTopTrendingCommunities';
-
-const topTrendCommunities = [community11, community21];
-const topTrendIds = topTrendCommunities.map(({ communityId }) => communityId);
-
-const pagingToken = {
-  previous: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
-  next: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
-};
-
-const pagingCriteria = { limit: 10 };
-
-const resolvedGetValue = {
-  data: {
-    communities: topTrendCommunities,
-    communityUsers: [community11, community21],
-    files: [],
-    users: [],
-    categories: [],
-    feeds: [],
-    paging: pagingToken,
-  },
-};
-
-describe('getTopTrendingCommunities', () => {
-  test('should return fetched top trend communities with correct paging', async () => {
-    client.http.get = jest.fn().mockResolvedValueOnce(resolvedGetValue);
-
-    await expect(getTopTrendingCommunities(pagingCriteria)).resolves.toEqual(
-      expect.objectContaining({ data: topTrendCommunities }),
-    );
-  });
-
-  test('should update cache after fetching top trend communities', async () => {
-    enableCache();
-    client.http.get = jest.fn().mockResolvedValue(resolvedGetValue);
-
-    await getTopTrendingCommunities(pagingCriteria);
-
-    const recieved = pullFromCache([
-      'community',
-      'top-trending',
-      { params: { options: pagingCriteria } },
-    ])?.data;
-
-    expect(recieved).toEqual({ communities: topTrendIds });
-
-    disableCache();
-  });
-
-  test('should throw an error if request fails', async () => {
-    client.http.get = jest.fn().mockRejectedValueOnce(new Error('error'));
-
-    await expect(getTopTrendingCommunities(pagingCriteria)).rejects.toThrow('error');
-  });
-});
-
-describe('getTopTrendingCommunities.locally', () => {
-  beforeEach(() => enableCache());
-  afterEach(() => disableCache());
-
-  test('should return cached top trend communities', () => {
-    topTrendCommunities.forEach(community =>
-      pushToCache(['community', 'get', community.communityId], community),
-    );
-
-    pushToCache(['community', 'top-trending', { params: { options: pagingCriteria } }], {
-      communities: topTrendIds,
-    });
-
-    expect(getTopTrendingCommunities.locally(pagingCriteria)?.data).toEqual(topTrendCommunities);
-  });
-
-  test('it should return undefined if top trend communities not in cache', () => {
-    topTrendCommunities.forEach(community =>
-      pushToCache(['community', 'get', community.communityId], community),
-    );
-
-    pushToCache(['community', 'top-trending', { params: { options: pagingCriteria } }], {
-      communities: topTrendIds,
-    });
-
-    expect(getTopTrendingCommunities.locally({ limit: -1 })).toBeUndefined();
-  });
-
-  test('should return undefined if cache not enabled', () => {
-    disableCache();
-
-    topTrendCommunities.forEach(community =>
-      pushToCache(['community', 'get', community.communityId], community),
-    );
-
-    pushToCache(['community', 'top-trending', { params: { options: pagingCriteria } }], {
-      communities: topTrendIds,
-    });
-
-    expect(getTopTrendingCommunities.locally(pagingCriteria)).toBeUndefined();
-  });
-});

package/src/communityRepository/observers/observeCommunity.ts

@@ -1,103 +0,0 @@
-import { createQuery, runQuery } from '~/core/query/query';
-
-import { getActiveClient } from '~/client/api';
-
-import { getCommunity } from '../api/getCommunity';
-
-import { onCommunityUpdated, onCommunityDeleted } from '../events';
-import {
-  onCommunityUserAdded,
-  onCommunityUserRemoved,
-  onCommunityUserBanned,
-  onCommunityUserUnbanned,
-  onCommunityJoined,
-  onCommunityLeft,
-} from '../communityMembership/events';
-
-/**
- * ```js
- * import { observeCommunity } from '@amityco/ts-sdk-react-native'
- *
- * let community = {}
- * const dispose = observeCommunity(communityId, updated => community = updated)
- * ```
- *
- * Observe all mutation on a given {@link Amity.Community}
- *
- * @param communityId the ID of the community 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 community
- *
- * @category Community Observer
- */
-export const observeCommunity = <
-  Events extends [
-    'onFetch',
-    'onUpdate',
-    'onDelete',
-    'onJoin',
-    'onLeft',
-    'onUserAdded',
-    'onUserRemoved',
-    'onUserBanned',
-    'onUserUnbanned',
-  ],
->(
-  communityId: string,
-  callback: Amity.ObjectListener<Amity.Snapshot<Amity.Community | undefined>, Events>,
-): Amity.Unsubscriber => {
-  const { log } = getActiveClient();
-
-  const timestamp = Date.now();
-  log(`observeCommunity(tmpid: ${timestamp}) > listen`);
-
-  // wrapper function to make sure
-  const router = (result: Amity.Snapshot<Amity.Community | 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.Community>, action: Events[number]) => {
-    if (result.data?.communityId !== communityId) return;
-
-    router(result, action);
-  };
-
-  const disposers: Amity.Unsubscriber[] = [];
-
-  disposers.push(
-    onCommunityUpdated(data =>
-      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUpdate'),
-    ),
-    onCommunityDeleted(data =>
-      realtimeRouter({ data, loading: false, origin: 'event' }, 'onDelete'),
-    ),
-    onCommunityJoined(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onJoin')),
-    onCommunityLeft(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onLeft')),
-    onCommunityUserAdded(data =>
-      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserAdded'),
-    ),
-    onCommunityUserRemoved(data =>
-      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserRemoved'),
-    ),
-    onCommunityUserBanned(data =>
-      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserBanned'),
-    ),
-    onCommunityUserUnbanned(data =>
-      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserUnbanned'),
-    ),
-  );
-
-  runQuery(
-    createQuery(getCommunity, communityId),
-    result => (result.data || result.error) && router(result, 'onFetch'),
-  );
-
-  return () => {
-    log(`observeCommunity(tmpid: ${timestamp}) > dispose`);
-    disposers.forEach(fn => fn());
-  };
-};

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();
-  });
-});