@amityco/ts-sdk 0.0.1 → 6.0.0

package/src/user/relationship/follow/api/utils.ts

@@ -0,0 +1,86 @@
+import { getActiveClient } from '~/client/api';
+import { toPageRaw, toToken } from '~/core/query';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { pullFromCache, pushToCache } from '~/cache/api';
+import { getResolver } from '~/core/model';
+
+export const queryFollows = async (
+  key: 'followers' | 'following',
+  query: {
+    userId: Amity.User['userId'];
+    status?: Exclude<Amity.FollowStatusType, 'none'>;
+    page?: Amity.PageRaw;
+  },
+): Promise<Amity.Cached<Amity.Paged<Amity.FollowStatus, Amity.PageRaw>>> => {
+  const client = getActiveClient();
+  client.log(`follow/queryF${key.substring(1)}`, query);
+
+  const { userId, page, ...params } = query;
+
+  const { data } = await client.http.get<Amity.FollowersPayload & Amity.Pagination>(
+    client.userId === userId ? `/api/v4/me/${key}` : `/api/v4/users/${userId}/${key}`,
+    {
+      params: {
+        ...params,
+        token: toToken(page, 'afterbeforeraw'),
+      },
+    },
+  );
+
+  const { paging, ...payload } = data;
+  const { follows } = payload;
+
+  const cachedAt = client.cache && Date.now();
+
+  if (client.cache) {
+    ingestInCache(payload as Amity.FollowersPayload, { cachedAt });
+
+    const cacheKey = [
+      'follow',
+      'query',
+      { ...params, userId, options: { ...page }, type: key } as Amity.Serializable,
+    ];
+    pushToCache(cacheKey, { follows: follows.map(getResolver('follow')), paging });
+  }
+
+  const nextPage = toPageRaw(paging.next);
+  const prevPage = toPageRaw(paging.previous);
+
+  return { data: follows, cachedAt, prevPage, nextPage };
+};
+
+queryFollows.locally = (
+  key: Parameters<typeof queryFollows>[0],
+  query: Parameters<typeof queryFollows>[1],
+): Amity.Cached<Amity.Paged<Amity.FollowStatus, Amity.PageRaw>> | undefined => {
+  const client = getActiveClient();
+  client.log(`follow/queryF${key.substring(1)}.locally`, query);
+
+  if (!client.cache) return;
+
+  const { page, ...params } = query;
+
+  const queryKey = [
+    'follow',
+    'query',
+    { ...params, options: { ...page }, type: key } as Amity.Serializable,
+  ];
+  const { data, cachedAt } =
+    pullFromCache<{ follows: string[] } & Amity.Pagination>(queryKey) ?? {};
+
+  if (!data?.follows.length) {
+    return;
+  }
+
+  const follows: Amity.FollowStatus[] = data.follows
+    .map(key => pullFromCache<Amity.FollowStatus>(['follow', 'get', key])!)
+    .filter(Boolean)
+    .map(({ data }) => data);
+
+  const prevPage = toPageRaw(data?.paging.previous);
+  const nextPage = toPageRaw(data?.paging.next);
+
+  return follows.length === data?.follows?.length
+    ? { data: follows, cachedAt, prevPage, nextPage }
+    : undefined;
+};

package/src/user/relationship/follow/events/index.ts

@@ -0,0 +1,10 @@
+export * from './onUserFollowed';
+export * from './onUserUnfollowed';
+export * from './onFollowerDeleted';
+
+export * from './onFollowerRequested';
+export * from './onFollowRequestCanceled';
+export * from './onFollowRequestAccepted';
+export * from './onFollowRequestDeclined';
+
+export * from './onFollowInfoUpdated';

package/src/user/relationship/follow/events/onFollowInfoUpdated.ts

@@ -0,0 +1,45 @@
+import { createFollowEventSubscriber } from './utils';
+import { getFollowInfo } from '../api/getFollowInfo';
+
+/**
+ * ```js
+ * import { onFollowInfoUpdated } from '@amityco/ts-sdk'
+ * const dispose = onFollowInfoUpdated(followInfo => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.FollowInfo} has been updated
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Follow Events
+ */
+export const onFollowInfoUpdated = (
+  callback: Amity.Listener<Amity.FollowInfo>,
+): Amity.Unsubscriber => {
+  const handler = async (payload: Amity.FollowStatus) => {
+    const [{ data: followInfoFrom }, { data: followInfoTo }] = await Promise.all([
+      getFollowInfo(payload.from),
+      getFollowInfo(payload.to),
+    ]);
+
+    callback(followInfoFrom);
+    callback(followInfoTo);
+  };
+
+  const disposers = [
+    createFollowEventSubscriber('follow.created', handler),
+    createFollowEventSubscriber('follow.requested', handler),
+    createFollowEventSubscriber('follow.accepted', handler),
+    createFollowEventSubscriber('follow.unfollowed', handler),
+    createFollowEventSubscriber('follow.requestCanceled', handler),
+    createFollowEventSubscriber('follow.requestDeclined', handler),
+    createFollowEventSubscriber('follow.followerDeleted', handler),
+  ];
+
+  return () => {
+    disposers.forEach(fn => fn());
+  };
+};

package/src/user/relationship/follow/events/onFollowRequestAccepted.ts

@@ -0,0 +1,20 @@
+import { createFollowEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onFollowRequestAccepted } from '@amityco/ts-sdk'
+ * const dispose = onFollowRequestAccepted(status => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a follow request has been accepted
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Follow Events
+ */
+export const onFollowRequestAccepted = (
+  callback: Amity.Listener<Amity.FollowStatus>,
+): Amity.Unsubscriber => createFollowEventSubscriber('follow.accepted', callback);

package/src/user/relationship/follow/events/onFollowRequestCanceled.ts

@@ -0,0 +1,20 @@
+import { createFollowEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onFollowRequestCanceled } from '@amityco/ts-sdk'
+ * const dispose = onFollowRequestCanceled(status => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a follow request has been canceled
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Follow Events
+ */
+export const onFollowRequestCanceled = (
+  callback: Amity.Listener<Amity.FollowStatus>,
+): Amity.Unsubscriber => createFollowEventSubscriber('follow.requestCanceled', callback);

package/src/user/relationship/follow/events/onFollowRequestDeclined.ts

@@ -0,0 +1,20 @@
+import { createFollowEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onFollowRequestDeclined } from '@amityco/ts-sdk'
+ * const dispose = onFollowRequestDeclined(status => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a follow request has been declined
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Follow Events
+ */
+export const onFollowRequestDeclined = (
+  callback: Amity.Listener<Amity.FollowStatus>,
+): Amity.Unsubscriber => createFollowEventSubscriber('follow.requestDeclined', callback);

package/src/user/relationship/follow/events/onFollowerDeleted.ts

@@ -0,0 +1,20 @@
+import { createFollowEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onFollowerDeleted } from '@amityco/ts-sdk'
+ * const dispose = onFollowerDeleted(status => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a follower has been deleted
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Follow Events
+ */
+export const onFollowerDeleted = (
+  callback: Amity.Listener<Amity.FollowStatus>,
+): Amity.Unsubscriber => createFollowEventSubscriber('follow.followerDeleted', callback);

package/src/user/relationship/follow/events/onFollowerRequested.ts

@@ -0,0 +1,20 @@
+import { createFollowEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onFollowerRequested } from '@amityco/ts-sdk'
+ * const dispose = onFollowerRequested(status => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a user follows another users and confirmation is required
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Follow Events
+ */
+export const onFollowerRequested = (
+  callback: Amity.Listener<Amity.FollowStatus>,
+): Amity.Unsubscriber => createFollowEventSubscriber('follow.requested', callback);

package/src/user/relationship/follow/events/onUserFollowed.ts

@@ -0,0 +1,19 @@
+import { createFollowEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onUserFollowed } from '@amityco/ts-sdk'
+ * const dispose = onUserFollowed(status => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a user follows another users and confirmation is not required
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Follow Events
+ */
+export const onUserFollowed = (callback: Amity.Listener<Amity.FollowStatus>): Amity.Unsubscriber =>
+  createFollowEventSubscriber('follow.created', callback);

package/src/user/relationship/follow/events/onUserUnfollowed.ts

@@ -0,0 +1,20 @@
+import { createFollowEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onUserUnfollowed } from '@amityco/ts-sdk'
+ * const dispose = onUserFollowed(status => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a user unfollows
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Follow Events
+ */
+export const onUserUnfollowed = (
+  callback: Amity.Listener<Amity.FollowStatus>,
+): Amity.Unsubscriber => createFollowEventSubscriber('follow.unfollowed', callback);

package/src/user/relationship/follow/events/utils.ts

@@ -0,0 +1,36 @@
+import { getActiveClient } from '~/client/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { createEventSubscriber } from '~/core/events';
+import { queryCache, upsertInCache } from '~/cache/api';
+
+export const createFollowEventSubscriber = (
+  event: keyof Amity.MqttFollowEvents,
+  callback: Amity.Listener<Amity.FollowStatus>,
+) => {
+  const client = getActiveClient();
+
+  const filter = (payload: Amity.FollowersPayload | Amity.FollowStatusPayload) => {
+    if (!client.cache) {
+      callback(payload.follows[0]);
+    } else {
+      ingestInCache(payload);
+
+      const queries = [
+        ...(queryCache(['followers', 'query']) ?? []),
+        ...(queryCache(['followings', 'query']) ?? []),
+      ];
+
+      queries
+        .filter(
+          ({ key }) =>
+            // @ts-ignore
+            key[2].userId === payload.follows[0].from || key[2].userId === payload.follows[0].to,
+        )
+        .forEach(({ key, data }) => upsertInCache(key, data as any, { cachedAt: -1 }));
+
+      callback(payload.follows[0]);
+    }
+  };
+
+  return createEventSubscriber(client, event, event, filter);
+};

package/src/user/relationship/follow/index.ts

@@ -0,0 +1,3 @@
+export * from './api';
+export * from './events';
+export * from './observers';

package/src/user/relationship/follow/observers/getFollowInfo.ts

@@ -0,0 +1,29 @@
+import { liveObject } from '~/utils/liveObject';
+import { getFollowInfo as _getFollowInfo } from '../api/getFollowInfo';
+import { onFollowInfoUpdated } from '../events';
+
+/**
+ * ```js
+ * import { getFollowInfo } from '@amityco/ts-sdk';
+ *
+ * let followInfo;
+ *
+ * const unsubscribe = liveFollowInfo(userId, response => {
+ *   followInfo = response.data;
+ * });
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.FollowCount} object
+ *
+ * @param userId the ID of the current user
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing
+ *
+ * @category FollowInfo Live Object
+ */
+export const getFollowInfo = (
+  userId: Amity.FollowInfo['userId'],
+  callback: Amity.LiveObjectCallback<Amity.FollowInfo>,
+): Amity.Unsubscriber => {
+  return liveObject(userId, callback, 'userId', _getFollowInfo, [onFollowInfoUpdated]);
+};

package/src/user/relationship/follow/observers/getFollowers.ts

@@ -0,0 +1,149 @@
+/* eslint-disable no-use-before-define */
+import { getResolver } from '~/core/model';
+import { getActiveClient } from '~/client/api';
+import { pushToCache, pullFromCache } from '~/cache/api';
+import { createQuery, runQuery, queryOptions, filterByPropEquality } from '~/core/query';
+
+import {
+  COLLECTION_DEFAULT_CACHING_POLICY,
+  COLLECTION_DEFAULT_PAGINATION_LIMIT,
+} from '~/utils/constants';
+
+import {
+  onFollowerRequested,
+  onFollowRequestAccepted,
+  onFollowRequestDeclined,
+  onFollowRequestCanceled,
+  onUserFollowed,
+  onUserUnfollowed,
+  onFollowerDeleted,
+} from '../events';
+import { queryFollowers } from '../api/queryFollowers';
+
+/**
+ * ```js
+ * import { getFollowers } from '@amityco/ts-sdk'
+ *
+ * let followers = []
+ * const unsub = getFollowers({
+ *   userId: Amity.User['userId'];
+ * }, response => merge(followers, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.FollowStatus} followers for a given userId
+ *
+ * @param userId the user
+ * @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 Followers Live Collection
+ */
+export const getFollowers = (
+  params: Amity.FollowerLiveCollection,
+  callback: Amity.LiveCollectionCallback<Amity.FollowStatus>,
+  config?: Amity.LiveCollectionConfig,
+): Amity.Unsubscriber => {
+  const { log, cache } = getActiveClient();
+
+  if (!cache) {
+    console.log('For using Live Collection feature you need to enable Cache!');
+  }
+
+  const timestamp = Date.now();
+  log(`getFollowers(tmpid: ${timestamp}) > listen`);
+
+  const { limit: queryLimit, ...queryParams } = params;
+
+  const limit = queryLimit ?? COLLECTION_DEFAULT_PAGINATION_LIMIT;
+  const { policy = COLLECTION_DEFAULT_CACHING_POLICY } = config ?? {};
+
+  const disposers: Amity.Unsubscriber[] = [];
+  const cacheKey = ['follow', 'collection', { userId: params.userId, type: 'follower' }];
+
+  const responder = (data: Amity.FollowerLiveCollectionCache) => {
+    let followers: Amity.FollowStatus[] =
+      data.data
+        .map(key => pullFromCache<Amity.FollowStatus>(['follow', 'get', key])!)
+        .filter(Boolean)
+        .map(({ data }) => data) ?? [];
+
+    if (params.status && params.status !== 'all') {
+      followers = filterByPropEquality(followers, 'status', params.status);
+    }
+
+    callback({
+      onNextPage: onFetch,
+      data: followers,
+      hasNextPage: !!data.params?.page,
+      loading: data.loading,
+      error: data.error,
+    });
+  };
+
+  const realtimeRouter = (action: Amity.FollowActionType) => (followStatus: Amity.FollowStatus) => {
+    const collection = pullFromCache<Amity.FollowerLiveCollectionCache>(cacheKey)?.data;
+
+    if (params.userId !== followStatus.to || !collection) return;
+
+    if (['onDeclined', 'onCanceled', 'onUnfollowed', 'onDeleted'].includes(action)) {
+      collection.data = collection.data.filter(p => p !== getResolver('follow')(followStatus));
+    } else if (['onRequested', 'onAccepted', 'onFollowed'].includes(action)) {
+      collection.data = [...new Set([getResolver('follow')(followStatus), ...collection.data])];
+    }
+
+    pushToCache(cacheKey, collection);
+
+    responder(collection);
+  };
+
+  const onFetch = () => {
+    const collection = pullFromCache<Amity.FollowerLiveCollectionCache>(cacheKey)?.data;
+
+    const followers = collection?.data ?? [];
+
+    if (followers.length > 0 && !collection?.params?.page) return;
+
+    const query = createQuery(queryFollowers, {
+      ...queryParams,
+      page: collection?.params?.page ?? { limit },
+    });
+
+    runQuery(
+      query,
+      ({ data: result, error, loading, nextPage: page }) => {
+        const data = {
+          loading,
+          error,
+          params: { page },
+          data: followers,
+        };
+
+        if (result) {
+          data.data = [...new Set([...followers, ...result.map(getResolver('follow'))])];
+        }
+
+        pushToCache(cacheKey, data);
+
+        responder(data);
+      },
+      queryOptions(policy),
+    );
+  };
+
+  disposers.push(
+    onFollowerRequested(realtimeRouter('onRequested')),
+    onFollowRequestAccepted(realtimeRouter('onAccepted')),
+    onFollowRequestDeclined(realtimeRouter('onDeclined')),
+    onFollowRequestCanceled(realtimeRouter('onCanceled')),
+    onUserFollowed(realtimeRouter('onFollowed')),
+    onUserUnfollowed(realtimeRouter('onUnfollowed')),
+    onFollowerDeleted(realtimeRouter('onDeleted')),
+  );
+
+  onFetch();
+
+  return () => {
+    log(`getFollowers(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

package/src/user/relationship/follow/observers/getFollowings.ts

@@ -0,0 +1,149 @@
+/* eslint-disable no-use-before-define */
+import { getResolver } from '~/core/model';
+import { getActiveClient } from '~/client/api';
+import { pushToCache, pullFromCache } from '~/cache/api';
+import { createQuery, runQuery, queryOptions, filterByPropEquality } from '~/core/query';
+
+import {
+  COLLECTION_DEFAULT_CACHING_POLICY,
+  COLLECTION_DEFAULT_PAGINATION_LIMIT,
+} from '~/utils/constants';
+
+import {
+  onFollowerRequested,
+  onFollowRequestAccepted,
+  onFollowRequestDeclined,
+  onFollowRequestCanceled,
+  onUserFollowed,
+  onUserUnfollowed,
+  onFollowerDeleted,
+} from '../events';
+import { queryFollowings } from '../api/queryFollowings';
+
+/**
+ * ```js
+ * import { getFollowings } from '@amityco/ts-sdk'
+ *
+ * let followings = []
+ * const unsub = getFollowings({
+ *   userId: Amity.User['userId'];
+ * }, response => merge(followings, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.FollowStatus} followings for a given userId
+ *
+ * @param userId the user
+ * @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 Followings Live Collection
+ */
+export const getFollowings = (
+  params: Amity.FollowingLiveCollection,
+  callback: Amity.LiveCollectionCallback<Amity.FollowStatus>,
+  config?: Amity.LiveCollectionConfig,
+): Amity.Unsubscriber => {
+  const { log, cache } = getActiveClient();
+
+  if (!cache) {
+    console.log('For using Live Collection feature you need to enable Cache!');
+  }
+
+  const timestamp = Date.now();
+  log(`getFollowings(tmpid: ${timestamp}) > listen`);
+
+  const { limit: queryLimit, ...queryParams } = params;
+
+  const limit = queryLimit ?? COLLECTION_DEFAULT_PAGINATION_LIMIT;
+  const { policy = COLLECTION_DEFAULT_CACHING_POLICY } = config ?? {};
+
+  const disposers: Amity.Unsubscriber[] = [];
+  const cacheKey = ['follow', 'collection', { userId: params.userId, type: 'following' }];
+
+  const responder = (data: Amity.FollowingLiveCollectionCache) => {
+    let followings: Amity.FollowStatus[] =
+      data.data
+        .map(key => pullFromCache<Amity.FollowStatus>(['follow', 'get', key])!)
+        .filter(Boolean)
+        .map(({ data }) => data) ?? [];
+
+    if (params.status && params.status !== 'all') {
+      followings = filterByPropEquality(followings, 'status', params.status);
+    }
+
+    callback({
+      onNextPage: onFetch,
+      data: followings,
+      hasNextPage: !!data.params?.page,
+      loading: data.loading,
+      error: data.error,
+    });
+  };
+
+  const realtimeRouter = (action: Amity.FollowActionType) => (followStatus: Amity.FollowStatus) => {
+    const collection = pullFromCache<Amity.FollowingLiveCollectionCache>(cacheKey)?.data;
+
+    if (params.userId !== followStatus.from || !collection) return;
+
+    if (['onDeclined', 'onCanceled', 'onUnfollowed', 'onDeleted'].includes(action)) {
+      collection.data = collection.data.filter(p => p !== getResolver('follow')(followStatus));
+    } else if (['onRequested', 'onAccepted', 'onFollowed'].includes(action)) {
+      collection.data = [...new Set([getResolver('follow')(followStatus), ...collection.data])];
+    }
+
+    pushToCache(cacheKey, collection);
+
+    responder(collection);
+  };
+
+  const onFetch = () => {
+    const collection = pullFromCache<Amity.FollowingLiveCollectionCache>(cacheKey)?.data;
+
+    const followings = collection?.data ?? [];
+
+    if (followings.length > 0 && !collection?.params?.page) return;
+
+    const query = createQuery(queryFollowings, {
+      ...queryParams,
+      page: collection?.params?.page ?? { limit },
+    });
+
+    runQuery(
+      query,
+      ({ data: result, error, loading, nextPage: page }) => {
+        const data = {
+          loading,
+          error,
+          params: { page },
+          data: followings,
+        };
+
+        if (result) {
+          data.data = [...new Set([...followings, ...result.map(getResolver('follow'))])];
+        }
+
+        pushToCache(cacheKey, data);
+
+        responder(data);
+      },
+      queryOptions(policy),
+    );
+  };
+
+  disposers.push(
+    onFollowerRequested(realtimeRouter('onRequested')),
+    onFollowRequestAccepted(realtimeRouter('onAccepted')),
+    onFollowRequestDeclined(realtimeRouter('onDeclined')),
+    onFollowRequestCanceled(realtimeRouter('onCanceled')),
+    onUserFollowed(realtimeRouter('onFollowed')),
+    onUserUnfollowed(realtimeRouter('onUnfollowed')),
+    onFollowerDeleted(realtimeRouter('onDeleted')),
+  );
+
+  onFetch();
+
+  return () => {
+    log(`getFollowings(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

package/src/user/relationship/follow/observers/index.ts

@@ -0,0 +1,7 @@
+export * from './observeFollowInfo';
+export * from './observeFollowers';
+export * from './observeFollowings';
+
+export * from './getFollowers';
+export * from './getFollowings';
+export * from './getFollowInfo';