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

package/src/streamRepository/api/queryStreams.ts

@@ -1,63 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import { toPage, toToken } from '~/core/query';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-
-/* begin_public_function
-  id: stream.query
-*/
-/**
- * @deprecated This API renamed to `getStreams`.
- * Please use getStreams() instead.
- * ```js
- * import { getStreams } from '@amityco/ts-sdk'
- * const streams = await getStreams()
- * ```
- *
- * Queries a paginable list of {@link Amity.InternalStream} objects
- *
- * @param query The query parameters
- * @returns A page of {@link Amity.InternalStream} objects
- *
- * @category Stream API
- * @async
- */
-export const queryStreams = async (query?: {
-  isLive?: boolean;
-  statuses?: Amity.StreamStatus[];
-  userPublicIds?: Amity.InternalUser['userId'][];
-  sortBy?: 'lastCreated' | 'firstCreated';
-  isDeleted?: Amity.InternalStream['isDeleted'];
-  page?: Amity.Page;
-}): Promise<Amity.Cached<Amity.Paged<Amity.InternalStream>>> => {
-  const client = getActiveClient();
-  client.log('stream/queryStreams', query);
-
-  const { page, ...params } = query ?? {};
-
-  const { data } = await client.http.get<{ results: Amity.StreamPayload } & Amity.Pagination>(
-    `/api/v3/video-streaming`,
-    {
-      params: {
-        ...params,
-        options: {
-          token: toToken(page, 'skiplimit'),
-        },
-      },
-    },
-  );
-
-  // API-FIX: backend to response Amity.Response: const { paging, videoStreamings } = unwrapPayload(data)
-  // API-FIX: seems returned data has a results identifier on top of data, like no other apis, and this is beautiful
-  const { paging, results: payload } = data;
-  const { videoStreamings } = payload;
-
-  const cachedAt = client.cache && Date.now();
-  if (client.cache) ingestInCache(payload as Amity.StreamPayload, { cachedAt });
-
-  const nextPage = toPage(paging.next);
-  const prevPage = toPage(paging.previous);
-
-  return { data: videoStreamings, cachedAt, prevPage, nextPage };
-};
-/* end_public_function */

package/src/userRepository/observers/getViewedUsers.ts

@@ -1,99 +0,0 @@
-import { getActiveClient } from '~/client';
-import { COLLECTION_DEFAULT_CACHING_POLICY, ENABLE_CACHE_MESSAGE } from '~/utils/constants';
-import { dropFromCache, pullFromCache, pushToCache } from '~/cache/api';
-import { createQuery, queryOptions, runQuery } from '~/core/query';
-import { CACHE_SHORTEN_LIFESPAN } from '~/cache/utils';
-import { queryReachUser } from '~/analytic/api/queryReachUser';
-
-/**
- * @deprecated: Please use {@link UserRepository.getReachUsers} instead
- * @param params
- * @param callback
- */
-export const getViewedUsers = (
-  params: Amity.PostViewedUsersLiveCollection,
-  callback: Amity.LiveCollectionCallback<Amity.User | undefined>,
-): Amity.Unsubscriber => {
-  const { log, cache } = getActiveClient();
-  const cacheKey = ['postViewedUsers', 'collection', { postId: params.postId }];
-
-  if (!cache) {
-    console.log(ENABLE_CACHE_MESSAGE);
-  }
-
-  const timestamp = Date.now();
-  log(`getViewedUsers(tmpid: ${timestamp}) > listen`);
-
-  const { limit: queryLimit, postId } = params;
-
-  const responder = (snapshot: {
-    loading?: boolean;
-    params?: { page: { next: Amity.Token; previous?: Amity.Token } };
-    data: Amity.User['userId'][];
-  }) => {
-    let users: (Amity.User | undefined)[] = [];
-
-    if (snapshot?.data) {
-      users =
-        snapshot.data
-          .map((userId: Amity.User['userId']) => pullFromCache<Amity.User>(['user', 'get', userId]))
-          .filter(Boolean)
-          .map(data => data?.data) || [];
-    }
-
-    callback({
-      // eslint-disable-next-line no-use-before-define
-      onNextPage: onFetch,
-      data: users,
-      hasNextPage: !!snapshot.params?.page?.next,
-      loading: snapshot.loading || false,
-    });
-  };
-
-  const onFetch = (initial = false) => {
-    const collection = pullFromCache<Amity.PostViewedUsersLiveCollectionCache>(cacheKey)?.data;
-
-    const users = collection?.data ?? [];
-
-    if (!initial && users.length > 0 && !collection?.params.page) return;
-
-    const query = createQuery(queryReachUser, {
-      viewId: postId,
-      viewedType: Amity.AnalyticEventContentType.Post,
-      limit: queryLimit || 10,
-      token: !initial ? collection?.params.page?.next : undefined,
-    });
-
-    runQuery(
-      query,
-      result => {
-        let userIds =
-          pullFromCache<Amity.PostViewedUsersLiveCollectionCache>(cacheKey)?.data?.data ?? [];
-
-        if (result.data?.users) {
-          userIds = [
-            ...new Set([...userIds, ...result.data.users.map(({ userId }: Amity.User) => userId)]),
-          ];
-        }
-
-        const saveToCache = {
-          loading: result.loading,
-          params: { page: result.data?.paging },
-          data: userIds || [],
-        };
-
-        pushToCache(cacheKey, saveToCache);
-
-        responder(saveToCache);
-      },
-      queryOptions(COLLECTION_DEFAULT_CACHING_POLICY, CACHE_SHORTEN_LIFESPAN),
-    );
-  };
-
-  onFetch(true);
-
-  return () => {
-    log(`getViewedUsers(tmpid: ${timestamp}) > dispose`);
-    dropFromCache(cacheKey);
-  };
-};

package/src/userRepository/observers/observeUser.ts

@@ -1,71 +0,0 @@
-import { createQuery, runQuery } from '~/core/query/query';
-
-import { getActiveClient } from '~/client/api';
-
-import { getUser } from '../api/getUser';
-import {
-  onUserUpdated,
-  onUserDeleted,
-  onUserFlagged,
-  onUserUnflagged,
-  onUserFlagCleared,
-} from '../events';
-import { LinkedObject } from '~/utils/linkedObject';
-
-/**
- * ```js
- * import { observeUser } from '@amityco/ts-sdk'
- *
- * let user = {}
- * const dispose = observeUser(userId, updated => user = updated)
- * ```
- *
- * @param userId the ID of the user 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 user
- *
- * Observe all mutation on a given {@link Amity.InternalUser}
- * @category User Observer
- */
-export const observeUser = <
-  Events extends ['onFetch', 'onUpdate', 'onDelete', 'onFlagged', 'onUnflagged', 'onFlagCleared'],
->(
-  userId: string,
-  callback: Amity.ObjectListener<Amity.Snapshot<Amity.InternalUser>, Events>,
-): Amity.Unsubscriber => {
-  const { log } = getActiveClient();
-
-  const timestamp = Date.now();
-  log(`observeUser(tmpid: ${timestamp}) > listen`);
-
-  // wrapper function to make sure
-  const router = (result: Amity.Snapshot<Amity.InternalUser>, action: Events[number]) => {
-    // filter function
-    if (result.data?.userId !== userId) return;
-
-    const newResult = { ...result, data: LinkedObject.user(result.data) };
-
-    if (callback instanceof Function) return callback(newResult);
-
-    if (action !== 'onFetch') callback.onEvent?.(action, newResult);
-
-    callback[action]?.(newResult);
-  };
-
-  const disposers: Amity.Unsubscriber[] = [];
-
-  disposers.push(
-    onUserUpdated(data => router({ data, loading: false, origin: 'event' }, 'onUpdate')),
-    onUserDeleted(data => router({ data, loading: false, origin: 'event' }, 'onDelete')),
-    onUserFlagged(data => router({ data, loading: false, origin: 'event' }, 'onFlagged')),
-    onUserUnflagged(data => router({ data, loading: false, origin: 'event' }, 'onUnflagged')),
-    onUserFlagCleared(data => router({ data, loading: false, origin: 'event' }, 'onFlagCleared')),
-  );
-
-  runQuery(createQuery(getUser, userId), result => result.data && router(result, 'onFetch'));
-
-  return () => {
-    log(`observeUser(tmpid: ${timestamp}) > dispose`);
-    disposers.forEach(fn => fn());
-  };
-};

package/src/userRepository/observers/tests/getViewedUsers.test.ts

@@ -1,39 +0,0 @@
-import { disableCache, enableCache } from '~/cache/api';
-import {
-  client,
-  connectClient,
-  deepCopy,
-  disconnectClient,
-  pause,
-  post11,
-  viewedUserQueryResponse,
-} from '~/utils/tests';
-
-import { getViewedUsers } from '../getViewedUsers';
-
-describe('getViewedUsers', () => {
-  beforeAll(connectClient);
-  afterAll(disconnectClient);
-
-  beforeEach(enableCache);
-  afterEach(disableCache);
-
-  test('should return users collection', async () => {
-    const callback = jest.fn();
-    client.http.get = jest.fn().mockResolvedValue(viewedUserQueryResponse);
-
-    getViewedUsers({ postId: post11.postId }, callback);
-    await pause();
-
-    expect(callback).toHaveBeenCalledTimes(2);
-    expect(deepCopy(callback.mock.calls[1][0])).toEqual(
-      expect.objectContaining(
-        deepCopy({
-          data: viewedUserQueryResponse.data.users,
-          loading: false,
-          hasNextPage: false,
-        }),
-      ),
-    );
-  });
-});

package/src/userRepository/relationship/block/observers/getBlockedUsers.ts

@@ -1,13 +0,0 @@
-/* eslint-disable no-use-before-define */
-import { getBlockedUsers as _getBlockedUsers } from '../../../observers/getBlockedUsers';
-
-export const getBlockedUsers = (
-  params: Amity.BlockedUsersLiveCollection,
-  callback: Amity.LiveCollectionCallback<Amity.InternalUser>,
-  config?: Amity.LiveCollectionConfig,
-) => {
-  console.log(
-    'Deprecation Notice: UserRepository.Relationship.getBlockedUsers will be deprecated on 9th June 2023, please use UserRepository.getBlockedUsers instead.',
-  );
-  return _getBlockedUsers(params, callback, config);
-};

package/src/userRepository/relationship/block/observers/index.ts

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

package/src/userRepository/relationship/follow/api/acceptFollower.ts

@@ -1,40 +0,0 @@
-import { getActiveClient } from '~/client/api';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import { fireEvent } from '~/core/events';
-import { prepareFollowStatusPayload } from '../utils';
-
-/**
- * @deprecated This API renamed to `acceptMyFollower`.
- * Please use acceptMyFollower() instead.
- *
- * ```js
- * import { acceptFollower } from '@amityco/ts-sdk'
- * await acceptFollower('foobar')
- * ```
- *
- * Accept the follow request
- *
- * @param userId the ID of the {@link Amity.InternalUser} follower
- * @returns A success boolean if the follow request was accepted
- *
- * @category Follow API
- * @async
- */
-export const acceptFollower = async (userId: Amity.InternalUser['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);
-  }
-
-  const payload = prepareFollowStatusPayload(data);
-
-  fireEvent('local.follow.accepted', payload);
-
-  return true;
-};

package/src/userRepository/relationship/follow/api/declineFollower.ts

@@ -1,40 +0,0 @@
-import { getActiveClient } from '~/client/api';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import { fireEvent } from '~/core/events';
-import { prepareFollowStatusPayload } from '../utils';
-
-/**
- * @deprecated This API renamed to `declineMyFollower`.
- * Please use declineMyFollower() instead.
- *
- * ```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.InternalUser} follower
- * @returns A success boolean if the follow request was decline
- *
- * @category Follow API
- * @async
- */
-export const declineFollower = async (userId: Amity.InternalUser['userId']): Promise<boolean> => {
-  const client = getActiveClient();
-  client.log('follow/declineFollower', userId);
-
-  const { data } = await client.http.delete<Amity.FollowStatusPayload>(
-    `/api/v4/me/followers/${userId}`,
-  );
-
-  if (client.cache) {
-    ingestInCache(data);
-  }
-
-  const payload = prepareFollowStatusPayload(data);
-
-  fireEvent('local.follow.requestDeclined', payload);
-
-  return true;
-};

package/src/userRepository/relationship/follow/observers/observeFollowInfo.ts

@@ -1,64 +0,0 @@
-import { getActiveClient } from '~/client/api';
-import { createQuery, runQuery, queryOptions } from '~/core/query';
-import { getFollowInfo } from '../api/getFollowInfo';
-import { onFollowInfoUpdated } from '../events';
-
-/**
- * ```js
- * import { observeFollowInfo } from '@amityco/ts-sdk'
- *
- * let followInfo = {}
- * const dispose = observeFollowInfo(userId, updated => followInfo = updated)
- * ```
- *
- * Observe all mutation on a given {@link Amity.FollowInfo}
- *
- * @param userId the ID of the user 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 post
- *
- * @category Follow Observer
- */
-export const observeFollowInfo = <Events extends ['onFetch', 'onUpdate']>(
-  userId: Amity.InternalUser['userId'],
-  callback: Amity.ObjectListener<Amity.Snapshot<Amity.FollowInfo>, Events>,
-  policy: Amity.QueryPolicy = 'cache_then_server',
-): Amity.Unsubscriber => {
-  const { log } = getActiveClient();
-
-  const timestamp = Date.now();
-  log(`observeFollowInfo(tmpid: ${timestamp}) > listen`);
-
-  const router = (result: Amity.Snapshot<Amity.FollowInfo>, 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.FollowInfo>, action: Events[number]) => {
-    if (result.data?.userId !== userId) return;
-
-    router(result, action);
-  };
-
-  const disposers: Amity.Unsubscriber[] = [];
-
-  disposers.push(
-    onFollowInfoUpdated(data =>
-      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUpdate'),
-    ),
-  );
-
-  runQuery(
-    createQuery(getFollowInfo, userId),
-    result => (result.data || result.error) && router(result, 'onFetch'),
-    queryOptions(policy),
-  );
-
-  return () => {
-    log(`observeFollowInfo(tmpid: ${timestamp}) > dispose`);
-    disposers.forEach(fn => fn());
-  };
-};

package/src/userRepository/relationship/follow/observers/observeFollowers.ts

@@ -1,74 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import {
-  onFollowerRequested,
-  onFollowRequestAccepted,
-  onFollowRequestDeclined,
-  onFollowRequestCanceled,
-  onUserFollowed,
-  onUserUnfollowed,
-  onFollowerDeleted,
-  onLocalFollowerRequested,
-  onLocalFollowRequestAccepted,
-  onLocalFollowRequestDeclined,
-  onLocalUserFollowed,
-  onLocalUserUnfollowed,
-} from '../events';
-
-/**
- * ```js
- * import { observeFollowers } from '@amityco/ts-sdk'
- *
- * let followers = []
- * const unsub = observeFollowers('userId', follower => merge(followers, follower))
- * ```
- *
- * Observe all mutations on a list of followers {@link Amity.FollowStatus} for a given user
- *
- * @param userId the ID of the {@link Amity.InternalUser}
- * @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 messages
- *
- * @category Follow Observer
- */
-export const observeFollowers = <Events extends Amity.FollowActionType[]>(
-  userId: Amity.User['userId'],
-  callback: Amity.ObjectListener<Amity.FollowStatus, Events>,
-): Amity.Unsubscriber => {
-  const { log } = getActiveClient();
-
-  const timestamp = Date.now();
-  log(`observeFollowers(tmpid: ${timestamp}) > listen`);
-
-  const disposers: Amity.Unsubscriber[] = [];
-
-  const router = (status: Amity.FollowStatus, action: Events[number]) => {
-    if (callback instanceof Function) {
-      return callback(status);
-    }
-
-    callback.onEvent?.(action, status);
-    callback[action]?.(status);
-  };
-
-  disposers.push(
-    onFollowerRequested(x => router(x, 'onRequested')),
-    onFollowRequestAccepted(x => router(x, 'onAccepted')),
-    onFollowRequestDeclined(x => router(x, 'onDeclined')),
-    onFollowRequestCanceled(x => router(x, 'onCanceled')),
-    onUserFollowed(x => router(x, 'onFollowed')),
-    onUserUnfollowed(x => router(x, 'onUnfollowed')),
-    onFollowerDeleted(x => router(x, 'onDeleted')),
-
-    onLocalFollowerRequested(x => router(x, 'onRequested')),
-    onLocalFollowRequestAccepted(x => router(x, 'onAccepted')),
-    onLocalFollowRequestDeclined(x => router(x, 'onDeclined')),
-    onLocalUserFollowed(x => router(x, 'onFollowed')),
-    onLocalUserUnfollowed(x => router(x, 'onUnfollowed')),
-  );
-
-  return () => {
-    log(`observeFollowers(tmpid: ${timestamp}) > dispose`);
-    disposers.forEach(fn => fn());
-  };
-};

package/src/userRepository/relationship/follow/observers/observeFollowings.ts

@@ -1,74 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import {
-  onFollowerRequested,
-  onFollowRequestAccepted,
-  onFollowRequestDeclined,
-  onFollowRequestCanceled,
-  onUserFollowed,
-  onUserUnfollowed,
-  onFollowerDeleted,
-  onLocalFollowerRequested,
-  onLocalFollowRequestAccepted,
-  onLocalFollowRequestDeclined,
-  onLocalUserFollowed,
-  onLocalUserUnfollowed,
-} from '../events';
-
-/**
- * ```js
- * import { observeFollowings } from '@amityco/ts-sdk'
- *
- * let followings = []
- * const unsub = observeFollowers('userId', follower => merge(followings, following))
- * ```
- *
- * Observe all mutations on a list of followings {@link Amity.FollowStatus} for a given user
- *
- * @param userId the ID of the {@link Amity.InternalUser}
- * @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 messages
- *
- * @category Follow Observer
- */
-export const observeFollowings = <Events extends Amity.FollowActionType[]>(
-  userId: Amity.User['userId'],
-  callback: Amity.ObjectListener<Amity.FollowStatus, Events>,
-): Amity.Unsubscriber => {
-  const { log } = getActiveClient();
-
-  const timestamp = Date.now();
-  log(`observeFollowings(tmpid: ${timestamp}) > listen`);
-
-  const disposers: Amity.Unsubscriber[] = [];
-
-  const router = (status: Amity.FollowStatus, action: Events[number]) => {
-    if (callback instanceof Function) {
-      return callback(status);
-    }
-
-    callback.onEvent?.(action, status);
-    callback[action]?.(status);
-  };
-
-  disposers.push(
-    onFollowerRequested(x => router(x, 'onRequested')),
-    onFollowRequestAccepted(x => router(x, 'onAccepted')),
-    onFollowRequestDeclined(x => router(x, 'onDeclined')),
-    onFollowRequestCanceled(x => router(x, 'onCanceled')),
-    onUserFollowed(x => router(x, 'onFollowed')),
-    onUserUnfollowed(x => router(x, 'onUnfollowed')),
-    onFollowerDeleted(x => router(x, 'onDeleted')),
-
-    onLocalFollowerRequested(x => router(x, 'onRequested')),
-    onLocalFollowRequestAccepted(x => router(x, 'onAccepted')),
-    onLocalFollowRequestDeclined(x => router(x, 'onDeclined')),
-    onLocalUserFollowed(x => router(x, 'onFollowed')),
-    onLocalUserUnfollowed(x => router(x, 'onUnfollowed')),
-  );
-
-  return () => {
-    log(`observeFollowings(tmpid: ${timestamp}) > dispose`);
-    disposers.forEach(fn => fn());
-  };
-};