@amityco/ts-sdk 0.0.1-beta.13 → 0.0.1-beta.16

package/dist/index.esm.js

@@ -6,11 +6,14 @@ import io from 'socket.io-client';
 import mitt from 'mitt';
 import AsyncStorage from '@react-native-async-storage/async-storage';
 
-var _a;
-// used in createClient
-const VERSION$1 = (_a = 'v0.0.1-beta.13-esm') !== null && _a !== void 0 ? _a : '__dev__';
+var _a$1;
+const theGlobal = globalThis || global || window;
+const { process: safeProcess = {} } = theGlobal;
+const isProduction = ((_a$1 = safeProcess.env) === null || _a$1 === void 0 ? void 0 : _a$1.NODE_ENV) === 'production';
+
+var _a, _b;
+const VERSION$1 = (_b = (_a = safeProcess.env) === null || _a === void 0 ? void 0 : _a.VERSION) !== null && _b !== void 0 ? _b : '__dev__';
 
-// @ts-ignore
 /**
  * Type guard to find if the a given decoded backend token uses "skip/limit" pagination style
  *
@@ -28,7 +31,7 @@ const isSkipLimit = (json) => (['skip', 'limit'].some(prop => prop in json));
  *
  * @hidden
  */
-const isAfterBefore = (json) => (['after', 'before', 'first', 'last'].some(prop => prop in json));
+const isAfterBefore = (json) => (['after', 'before', 'first', 'last', 'limit'].some(prop => prop in json));
 /**
  * Type guard to find if the a given decoded backend token uses v4 or newer "after/before" pagination style
  *
@@ -37,7 +40,7 @@ const isAfterBefore = (json) => (['after', 'before', 'first', 'last'].some(prop
  *
  * @hidden
  */
-const isAfterBeforeRaw = (json) => (['after', 'before'].some(prop => prop in json));
+const isAfterBeforeRaw = (json) => ('limit' in json);
 /**
  * Type guard to find if the a given object is wrapped around Amity.Paged<>
  *
@@ -72,7 +75,7 @@ const toToken = (paging, style) => {
             limit: paging.limit,
         };
     }
-    else if (style === 'afterbefore') {
+    else if (style === 'afterbefore' && isAfterBefore(paging)) {
         /*
           Caution: this testing style is only valid because
           our backend expects nothing else than a number as
@@ -116,7 +119,7 @@ const toToken = (paging, style) => {
  */
 const toPage = (token) => {
     if (!token)
-        return null;
+        return undefined;
     // don't try catch, let it throw
     const json = JSON.parse(decode(token));
     if (isSkipLimit(json)) {
@@ -139,7 +142,7 @@ const toPage = (token) => {
             };
         }
     }
-    return null;
+    return undefined;
 };
 /**
  * Converts a b64 string token into a paging object
@@ -151,42 +154,13 @@ const toPage = (token) => {
  */
 const toPageRaw = (token) => {
     if (!token)
-        return null;
+        return undefined;
     // don't try catch, let it throw
     const json = JSON.parse(decode(token));
     if (isAfterBeforeRaw(json)) {
         return json;
     }
-    return null;
-};
-/**
- * Slices a collection according to its paging
- *
- * @param type the type of collection (for unique id identification with after/before)
- * @param collection the collection to slice
- * @param paging the paging object
- * @returns the sliced collection according to the paging definition
- *
- * @hidden
- */
-const sliceByPaging = (type, collection, page) => {
-    console.log('slice by paging', page);
-    if (!page)
-        return collection.slice();
-    let start = 0;
-    let end = undefined;
-    // next page behavior
-    if (page.after) {
-        start = page.after;
-        end = start + page.limit;
-        // prev page behavior
-    }
-    else if (page.before) {
-        end = page.before + 1;
-        start = end > page.limit ? end - page.limit : 0;
-    }
-    const paged = collection.slice(start, end);
-    return paged.length === page.limit ? paged : undefined;
+    return undefined;
 };
 
 /**
@@ -499,9 +473,8 @@ const setActiveClient = (client) => {
  * @hidden
  */
 const createLogger = (session) => {
-    var _a;
     const active = (`${session === null || session === void 0 ? void 0 : session.trim()}`.length > 0
-        && ((_a = process === null || process === void 0 ? void 0 : process.env) === null || _a === void 0 ? void 0 : _a.NODE_ENV) !== 'production');
+        && !isProduction);
     const logger = debug(session);
     const print = (topic, ...args) => {
         active && logger(topic, args);
@@ -510,19 +483,18 @@ const createLogger = (session) => {
     return print;
 };
 
-const API_ENDPOINT = {
+const API_REGIONS = {
     EU: 'eu',
     SG: 'sg',
     US: 'us',
 };
-var UrlTemplate;
-(function (UrlTemplate) {
-    UrlTemplate["HTTP"] = "https://api.{region}.amity.co";
-    UrlTemplate["MQTT"] = "wss://sse.{region}.amity.co:443/mqtt";
-})(UrlTemplate || (UrlTemplate = {}));
-const getUrlFromTemplate = (template, region) => {
-    return template.replace('{region}', region);
-};
+const URLS = {
+    http: 'https://api.{region}.amity.co',
+    mqtt: 'wss://sse.{region}.amity.co:443/mqtt',
+};
+function computeUrl(type, region) {
+    return URLS[type].replace('{region}', region);
+}
 
 /**
  * Unwraps v3 server payload (for error handling and type extraction)
@@ -14728,6 +14700,22 @@ const createMqttTransport = (endpoint) => {
     };
 };
 
+let tasks = [];
+let timer;
+/**
+ * Add a function to run just before the next tick
+ *
+ * @param task function to schedule for later execution
+ */
+const scheduleTask = (task) => {
+    clearTimeout(timer);
+    tasks.push(task);
+    timer = setTimeout(() => {
+        tasks.forEach(fn => fn());
+        tasks = [];
+    }, 0);
+};
+
 // need to sync up the list
 const WS_EVENTS = [
     'disconnected',
@@ -14818,7 +14806,7 @@ const createEventSubscriber = (client, namespace, event, fn) => {
  */
 const fireEvent = (event, payload) => {
     const { emitter } = getActiveClient();
-    setTimeout(() => { emitter.emit(event, payload); }, 0);
+    scheduleTask(() => { emitter.emit(event, payload); });
 };
 
 /**
@@ -14830,21 +14818,21 @@ const fireEvent = (event, payload) => {
  * Creates a new {@link Amity.Client} instance
  *
  * @param apiKey for the {@link Amity.Client} instance
- * @param apiEndpoint endpoint to connect to
+ * @param apiRegion endpoint to connect to
  * @param debugSession session's identifier for the client's logger instance
  * @returns A {@link Amity.Client} instance
  *
  * @category Client API
  **/
-const createClient = (apiKey, apiEndpoint = API_ENDPOINT.SG, debugSession = 'amity') => {
+const createClient = (apiKey, apiRegion = API_REGIONS.SG, debugSession = 'amity') => {
     const log = createLogger(debugSession);
     log('client/api/createClient', {
         apiKey: apiKey.replace(/.{5}$/g, 'xxxxx'),
-        apiEndpoint,
+        apiRegion,
     });
-    const http = createHttpTransport(getUrlFromTemplate(UrlTemplate.HTTP, apiEndpoint));
-    const ws = createWebsocketTransport(getUrlFromTemplate(UrlTemplate.HTTP, apiEndpoint));
-    const mqtt = createMqttTransport(getUrlFromTemplate(UrlTemplate.MQTT, apiEndpoint));
+    const http = createHttpTransport(computeUrl('http', apiRegion));
+    const ws = createWebsocketTransport(computeUrl('http', apiRegion));
+    const mqtt = createMqttTransport(computeUrl('mqtt', apiRegion));
     const emitter = createEventEmitter();
     const client = {
         version: `${VERSION$1}`,
@@ -14897,7 +14885,6 @@ const disconnectClient = async () => {
 };
 
 // TODO: find a way to uniquely identify the device
-// import { getStorage } from './storage'
 /** @hidden */
 const VERSION = '11.0.0';
 /** @hidden */
@@ -14912,8 +14899,8 @@ const getDeviceId = () => {
 /** @hidden */
 const getDeviceModel = () => {
     var _a, _b;
-    if ((_a = process === null || process === void 0 ? void 0 : process.versions) === null || _a === void 0 ? void 0 : _a.node)
-        return process.versions.node;
+    if ((_a = safeProcess.versions) === null || _a === void 0 ? void 0 : _a.node)
+        return safeProcess.versions.node;
     if (navigator)
         return `${navigator.product.toLowerCase()}#${(_b = navigator.userAgent) !== null && _b !== void 0 ? _b : 'unknown_agent'}`;
     return 'unknown_model';
@@ -14929,6 +14916,24 @@ const getDeviceInfo = () => {
     };
 };
 
+let activeUser = null;
+/**
+ * for internal use
+ */
+const getActiveUser = () => {
+    if (!activeUser) {
+        throw new ASCError('Connect client first', 800000 /* UNKNOWN_ERROR */, "fatal" /* FATAL */);
+    }
+    return activeUser;
+};
+const setActiveUser = (user) => {
+    activeUser = {
+        _id: user._id,
+        userId: user.userId,
+        path: user.path,
+    };
+};
+
 /**
  * Retrieves a pair of {@link Amity.Tokens} necessary for connection
  *
@@ -15076,8 +15081,8 @@ const connectClient = async (params) => {
         unsubscribe();
     });
     client.userId = params.userId;
-    client._internalUserId = users[0]._id;
     client.accessToken = accessToken;
+    setActiveUser(users[0]);
     return client.ws.connected;
 };
 
@@ -15135,13 +15140,24 @@ const getPostTopic = ({ path }, level = SubscriptionLevels.POST) => {
 const getCommentTopic = ({ path }) => {
     return path;
 };
+const getMyFollowersTopic = () => {
+    const user = getActiveUser();
+    const [networkId] = user.path.split('/user/');
+    return `${networkId}/membership/${user._id}/+/+`;
+};
+const getMyFollowingsTopic = () => {
+    const user = getActiveUser();
+    const [networkId] = user.path.split('/user/');
+    return `${networkId}/membership/+/${user._id}/+`;
+};
 let mqttAccessToken;
 let mqttUserId;
 function subscribeTopic(topic, callback) {
-    const { mqtt, emitter, accessToken, _internalUserId } = getActiveClient();
-    if (mqttAccessToken !== accessToken || mqttUserId !== _internalUserId) {
+    const { mqtt, emitter, accessToken } = getActiveClient();
+    const user = getActiveUser();
+    if (mqttAccessToken !== accessToken || mqttUserId !== user._id) {
         mqttAccessToken = accessToken;
-        mqttUserId = _internalUserId;
+        mqttUserId = user._id;
         mqtt.connect({ accessToken: mqttAccessToken, userId: mqttUserId });
         proxyMqttEvents(mqtt, emitter);
     }
@@ -15547,6 +15563,8 @@ const idResolvers = {
     post: ({ postId }) => postId,
     comment: ({ commentId }) => commentId,
     stream: ({ streamId }) => streamId,
+    follow: ({ from, to }) => `${from}#${to}`,
+    followCount: ({ userId }) => userId,
 };
 /**
  * Retrieve the id resolver matching a domain name
@@ -15573,6 +15591,8 @@ const PAYLOAD2MODEL = {
     postChildren: 'post',
     comments: 'comment',
     videoStreamings: 'stream',
+    follows: 'follow',
+    followCounts: 'followCount'
 };
 
 /**
@@ -16636,11 +16656,11 @@ const queryPosts = async (query) => {
     const { page = { limit: 10 } } = query, params = __rest(query
     // API-FIX: parameters should be querystring. (1)
     // API-FIX: backend should answer Amity.Response (2)
-    // const { data } = await client.http.get<Amity.Response<Amity.PagedRawResponse<Amity.PostPayload>>>(
+    // const { data } = await client.http.get<Amity.Response<Amity.PagedResponse<Amity.PostPayload>>>(
     , ["page"]);
     // API-FIX: parameters should be querystring. (1)
     // API-FIX: backend should answer Amity.Response (2)
-    // const { data } = await client.http.get<Amity.Response<Amity.PagedRawResponse<Amity.PostPayload>>>(
+    // const { data } = await client.http.get<Amity.Response<Amity.PagedResponse<Amity.PostPayload>>>(
     const { data } = await client.http.get(`/api/v4/posts`, { params: Object.assign(Object.assign({}, params), { options: {
                 token: toToken(page, 'afterbeforeraw'),
             } }), });
@@ -17227,7 +17247,7 @@ const queryCommunityMembers = async (query) => {
     }
     const nextPage = toPage(paging.next);
     const prevPage = toPage(paging.previous);
-    return { data: communityUsers, nextPage, prevPage };
+    return { data: communityUsers, cachedAt, nextPage, prevPage };
 };
 /**
  * ```js
@@ -17354,6 +17374,132 @@ const removeCommunityMembersRole = async (communityId, roleId, userIds) => {
     return !!communityUsers.find(communityUser => communityUser.communityId === communityId && !communityUser.roles.includes(roleId));
 };
 
+/**
+ * ```js
+ * import { getTopTrendingCommunities } from '@amityco/ts-sdk'
+ * const trendingCommunities = await getTopTrendingCommunities()
+ * ```
+ *
+ * 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
+ */
+const getTopTrendingCommunities = async (query) => {
+    const client = getActiveClient();
+    client.log('channel/getTopTrendingCommunities', query);
+    const { limit = 5 } = query !== null && query !== void 0 ? query : {};
+    // API-FIX: backend doesnt answer Amity.Response
+    // const { data } = await client.http.get<Amity.Response<CommunityPayload>>(
+    const { data } = await client.http.get(`/api/v3/communities/top-trending`, { params: { options: { limit } } });
+    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 };
+};
+/**
+ * ```js
+ * import { getTopTrendingCommunities } from '@amityco/ts-sdk'
+ * 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) => {
+    var _a, _b;
+    const client = getActiveClient();
+    client.log('community/getTopTrendingCommunities.locally', query);
+    if (!client.cache)
+        return;
+    const { limit = 5 } = query !== null && query !== void 0 ? query : {};
+    const queryKey = ['community', 'top-trending', { params: { options: { limit } } }];
+    const { data, cachedAt } = (_a = pullFromCache(queryKey)) !== null && _a !== void 0 ? _a : {};
+    if (!(data === null || data === void 0 ? void 0 : data.communities.length))
+        return;
+    const communities = data.communities
+        .map(communityId => pullFromCache(['community', 'get', communityId]))
+        .filter(Boolean)
+        .map(({ data }) => data);
+    return communities.length === ((_b = data === null || data === void 0 ? void 0 : data.communities) === null || _b === void 0 ? void 0 : _b.length)
+        ? { data: communities, cachedAt }
+        : undefined;
+};
+
+/**
+ * ```js
+ * import { getRecommendedCommunities } from '@amityco/ts-sdk'
+ * const communities = await getRecommendedCommunities()
+ * ```
+ *
+ * Gets a list of recommended {@link Amity.Community} objects
+ *
+ * @param query The query parameters
+ * @returns A list of {@link Amity.Community} objects
+ *
+ * @category Community API
+ * @async
+ */
+const getRecommendedCommunities = async (query) => {
+    const client = getActiveClient();
+    client.log('channel/getRecommendedCommunities', query);
+    const { limit = 5 } = query !== null && query !== void 0 ? query : {};
+    // API-FIX: backend doesnt answer Amity.Response
+    // const { data } = await client.http.get<Amity.Response<CommunityPayload>>(
+    const { data } = await client.http.get(`/api/v3/communities/recommended`, { params: { options: { limit } } });
+    const { communities } = data;
+    const cachedAt = client.cache && Date.now();
+    if (client.cache) {
+        ingestInCache(data, { cachedAt });
+        const cacheKey = ['community', 'recommended', { params: { options: { limit } } }];
+        pushToCache(cacheKey, { communities: communities.map(getResolver('community')) });
+    }
+    return { data: communities, cachedAt };
+};
+/**
+ * ```js
+ * import { getRecommendedCommunities } from '@amityco/ts-sdk'
+ * const communities = getRecommendedCommunities.locally()
+ * ```
+ *
+ * Gets a list of recommended {@link Amity.Community} objects from cache
+ *
+ * @param query The query parameters
+ * @returns communities
+ *
+ * @category Community API
+ */
+getRecommendedCommunities.locally = (query) => {
+    var _a, _b;
+    const client = getActiveClient();
+    client.log('community/getRecommendedCommunities.locally', query);
+    if (!client.cache)
+        return;
+    const { limit = 5 } = query !== null && query !== void 0 ? query : {};
+    const queryKey = ['community', 'recommended', { params: { options: { limit } } }];
+    const { data, cachedAt } = (_a = pullFromCache(queryKey)) !== null && _a !== void 0 ? _a : {};
+    if (!(data === null || data === void 0 ? void 0 : data.communities.length))
+        return;
+    const communities = data.communities
+        .map(communityId => pullFromCache(['community', 'get', communityId]))
+        .filter(Boolean)
+        .map(({ data }) => data);
+    return communities.length === ((_b = data === null || data === void 0 ? void 0 : data.communities) === null || _b === void 0 ? void 0 : _b.length)
+        ? { data: communities, cachedAt }
+        : undefined;
+};
+
 /**
  * ```js
  * import { deletePost } from '@amityco/ts-sdk'
@@ -18745,12 +18891,13 @@ const queryChannelMembers = async (query) => {
     });
     const { paging } = data, payload = __rest(data, ["paging"]);
     const { channelUsers } = payload;
+    const cachedAt = client.cache && Date.now();
     if (client.cache) {
         ingestInCache(payload);
     }
     const nextPage = toPage(paging.next);
     const prevPage = toPage(paging.previous);
-    return { data: channelUsers, nextPage, prevPage };
+    return { data: channelUsers, cachedAt, nextPage, prevPage };
 };
 /**
  * ```js
@@ -19495,17 +19642,619 @@ const observeCommunity = (communityId, callback) => {
 const queryGlobalFeed = async (query) => {
     const client = getActiveClient();
     client.log('feed/queryGlobalFeed', query);
-    const _a = query !== null && query !== void 0 ? query : {}, { page } = _a, params = __rest(_a, ["page"]);
-    const { data } = await client.http.get(`/api/v4/me/global-feeds`, { params: Object.assign(Object.assign({}, params), { options: {
+    const _a = query !== null && query !== void 0 ? query : {}, { useCustomRanking, page } = _a, params = __rest(_a, ["useCustomRanking", "page"]);
+    const { data } = await client.http.get(useCustomRanking ? `/api/v5/me/global-feeds` : `/api/v4/me/global-feeds`, { params: Object.assign(Object.assign({}, params), { options: {
                 token: toToken(page, 'skiplimit')
             } }) });
     const { paging } = data, payload = __rest(data, ["paging"]);
     const { posts } = payload;
-    if (client.cache)
+    const cachedAt = client.cache && Date.now();
+    if (client.cache) {
         ingestInCache(payload);
+        const cacheKey = ['globalFeed', 'query', Object.assign(Object.assign({}, params), { useCustomRanking, options: Object.assign({}, page) })];
+        pushToCache(cacheKey, { posts: posts.map(getResolver('post')), paging });
+    }
+    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) => {
+    var _a, _b;
+    const client = getActiveClient();
+    client.log('post/queryGlobalFeed.locally', query);
+    if (!client.cache)
+        return;
+    const _c = query !== null && query !== void 0 ? query : {}, { useCustomRanking, page } = _c, params = __rest(_c, ["useCustomRanking", "page"]);
+    const queryKey = ['globalFeed', 'query', Object.assign(Object.assign({}, params), { useCustomRanking, options: Object.assign({}, page) })];
+    const { data, cachedAt } = (_a = pullFromCache(queryKey)) !== null && _a !== void 0 ? _a : {};
+    if (!(data === null || data === void 0 ? void 0 : data.posts.length))
+        return;
+    const posts = data.posts
+        .map(postId => pullFromCache(['post', 'get', postId]))
+        .filter(Boolean)
+        .map(({ data }) => data);
+    const prevPage = toPage(data === null || data === void 0 ? void 0 : data.paging.previous);
+    const nextPage = toPage(data === null || data === void 0 ? void 0 : data.paging.next);
+    return posts.length === ((_b = data === null || data === void 0 ? void 0 : data.posts) === null || _b === void 0 ? void 0 : _b.length)
+        ? { data: posts, cachedAt, prevPage, nextPage }
+        : undefined;
+};
+
+const queryFollows = async (key, query) => {
+    const client = getActiveClient();
+    client.log(`follow/queryF${key.substring(1)}`, query);
+    const { userId, page } = query, params = __rest(query, ["userId", "page"]);
+    const { data } = await client.http.get(client.userId === userId ? `/api/v4/me/${key}` : `/api/v4/users/${userId}/${key}`, {
+        params: Object.assign(Object.assign({}, params), { token: toToken(page, 'skiplimit') }),
+    });
+    const { paging } = data, payload = __rest(data, ["paging"]);
+    const { follows } = payload;
+    const cachedAt = client.cache && Date.now();
+    if (client.cache) {
+        ingestInCache(payload, { cachedAt });
+        const cacheKey = [key, 'query', Object.assign(Object.assign({}, params), { userId, options: Object.assign({}, page) })];
+        pushToCache(cacheKey, { follows: follows.map(getResolver('follow')), paging });
+    }
     const nextPage = toPage(paging.next);
     const prevPage = toPage(paging.previous);
-    return { data: posts, prevPage, nextPage };
+    return { data: follows, cachedAt, prevPage, nextPage };
+};
+queryFollows.locally = (key, query) => {
+    var _a, _b;
+    const client = getActiveClient();
+    client.log(`follow/queryF${key.substring(1)}.locally`, query);
+    if (!client.cache)
+        return;
+    const { page } = query, params = __rest(query, ["page"]);
+    const queryKey = [key, 'query', Object.assign(Object.assign({}, params), { options: Object.assign({}, page) })];
+    const { data, cachedAt } = (_a = pullFromCache(queryKey)) !== null && _a !== void 0 ? _a : {};
+    if (!(data === null || data === void 0 ? void 0 : data.follows.length)) {
+        return;
+    }
+    const follows = data.follows
+        .map(key => pullFromCache(['follow', 'get', key]))
+        .filter(Boolean)
+        .map(({ data }) => data);
+    const prevPage = toPage(data === null || data === void 0 ? void 0 : data.paging.previous);
+    const nextPage = toPage(data === null || data === void 0 ? void 0 : data.paging.next);
+    return follows.length === ((_b = data === null || data === void 0 ? void 0 : data.follows) === null || _b === void 0 ? void 0 : _b.length)
+        ? { data: follows, cachedAt, prevPage, nextPage }
+        : undefined;
+};
+
+/**
+ * ```js
+ * import { queryFollowers } from '@amityco/ts-sdk'
+ * const { data: followers, prevPage, nextPage } = await queryFollowers({ userId })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.FollowStatus}
+ *
+ * @param query The query parameters
+ * @returns followers
+ *
+ * @category Follow API
+ * @async
+ */
+const queryFollowers = async (query) => queryFollows('followers', query);
+/**
+ * ```js
+ * import { queryFollowers } from '@amityco/ts-sdk'
+ * const { data: followers, prevPage, nextPage } = queryFollowers.locally({ userId })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.FollowStatus} objects from cache
+ *
+ * @param query The query parameters
+ * @returns followers
+ *
+ * @category Post API
+ */
+queryFollowers.locally = (query) => queryFollows.locally('followers', query);
+
+/**
+ * ```js
+ * import { queryFollowings } from '@amityco/ts-sdk'
+ * const { data: followings, prevPage, nextPage } = await queryFollowings({ userId })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.FollowStatus}
+ *
+ * @param query The query parameters
+ * @returns followings
+ *
+ * @category Follow API
+ * @async
+ */
+const queryFollowings = async (query) => queryFollows('following', query);
+/**
+ * ```js
+ * import { queryFollowings } from '@amityco/ts-sdk'
+ * const { data: followings, prevPage, nextPage } = queryFollowings.locally({ userId })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.FollowStatus} objects from cache
+ *
+ * @param query The query parameters
+ * @returns followings
+ *
+ * @category Post API
+ */
+queryFollowings.locally = (query) => queryFollows.locally('following', query);
+
+const getCacheKey = (userId) => ['followInfo', 'get', `${getActiveClient().userId}#${userId}`];
+/**
+ * ```js
+ * import { getFollowInfo } from '@amityco/ts-sdk'
+ * const { data: followInfo } = await getFollowInfo('foobar')
+ * ```
+ *
+ * Fetches the number of followers, followings, pending requests and the follow status for current user
+ *
+ * @param userId the ID of the {@link Amity.User}
+ * @returns the associated {@link Amity.FollowInfo} object
+ *
+ * @category Follow API
+ * @async
+ */
+const getFollowInfo = async (userId) => {
+    var _a, _b;
+    const client = getActiveClient();
+    client.log('follow/getFollowInfo', userId);
+    const { data } = await client.http.get(client.userId === userId ? `/api/v4/me/followInfo` : `/api/v4/users/${userId}/followInfo`);
+    const cachedAt = client.cache && Date.now();
+    const followInfo = Object.assign(Object.assign({}, data.followCounts[0]), { status: (_b = (_a = data.follows) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.status });
+    if (client.cache) {
+        pushToCache(getCacheKey(userId), followInfo, { cachedAt });
+    }
+    return {
+        data: followInfo,
+        cachedAt,
+    };
+};
+/**
+ * ```js
+ * import { getFollowInfo } from '@amityco/ts-sdk'
+ * const { data: followInfo } = getFollowInfo.locally('foobar')
+ * ```
+ *
+ * Fetches the number of followers, followings, pending requests and the follow status for current user from cache
+ *
+ * @param userId the ID of the {@link Amity.User}
+ * @returns the associated {@link Amity.FollowInfo} object
+ *
+ * @category Follow API
+ */
+getFollowInfo.locally = (userId) => {
+    const client = getActiveClient();
+    client.log('follow/getFollowInfo.locally', userId);
+    if (!client.cache) {
+        return;
+    }
+    const cached = pullFromCache(getCacheKey(userId));
+    if (!cached) {
+        return;
+    }
+    return {
+        data: cached.data,
+        cachedAt: cached.cachedAt,
+    };
+};
+
+/**
+ * ```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
+ */
+const follow = async (userId) => {
+    const client = getActiveClient();
+    client.log('follow/follow', userId);
+    const { data } = await client.http.post(`/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.follows[0]);
+    return {
+        data: data.follows[0],
+        cachedAt,
+    };
+};
+
+/**
+ * ```js
+ * import { unfollow } from '@amityco/ts-sdk'
+ * await unfollow('foobar')
+ * ```
+ *
+ * Cancel the follow request or unfollow the user
+ *
+ * @param userId the ID of the {@link Amity.User}
+ * @returns A success boolean if the user {@link Amity.User} was unfollowed
+ *
+ * @category Follow API
+ * @async
+ */
+const unfollow = async (userId) => {
+    const client = getActiveClient();
+    client.log('follow/unfollow', userId);
+    const { data } = await client.http.delete(`/api/v4/me/following/${userId}`);
+    if (client.cache) {
+        ingestInCache(data);
+    }
+    fireEvent('follow.unfollowed', data.follows[0]);
+    return true;
+};
+
+/**
+ * ```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
+ */
+const acceptFollower = async (userId) => {
+    const client = getActiveClient();
+    client.log('follow/acceptFollower', userId);
+    const { data } = await client.http.post(`/api/v4/me/followers/${userId}`);
+    if (client.cache) {
+        ingestInCache(data);
+    }
+    fireEvent('follow.accepted', data.follows[0]);
+    return true;
+};
+
+/**
+ * ```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
+ */
+const declineFollower = async (userId) => {
+    const client = getActiveClient();
+    client.log('follow/declineFollower', userId);
+    const { data } = await client.http.delete(`/api/v4/me/followers/${userId}`);
+    if (client.cache) {
+        ingestInCache(data);
+    }
+    fireEvent('follow.requestDeclined', data.follows[0]);
+    return true;
+};
+
+const createFollowEventSubscriber = (event, callback) => {
+    const client = getActiveClient();
+    const filter = (payload) => {
+        var _a, _b;
+        if (!client.cache) {
+            callback(payload);
+        }
+        else {
+            ingestInCache({ follows: [payload] });
+            const queries = [
+                ...(_a = queryCache(['followers', 'query'])) !== null && _a !== void 0 ? _a : [],
+                ...(_b = queryCache(['followings', 'query'])) !== null && _b !== void 0 ? _b : [],
+            ];
+            queries
+                // @ts-ignore
+                .filter(({ key }) => key[2].userId === payload.from || key[2].userId === payload.to)
+                .forEach(({ key, data }) => upsertInCache(key, data, { cachedAt: -1 }));
+            callback(payload);
+        }
+    };
+    return createEventSubscriber(client, event, event, filter);
+};
+
+/**
+ * ```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
+ */
+const onUserFollowed = (callback) => createFollowEventSubscriber('follow.created', callback);
+
+/**
+ * ```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
+ */
+const onUserUnfollowed = (callback) => createFollowEventSubscriber('follow.unfollowed', callback);
+
+/**
+ * ```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
+ */
+const onFollowerDeleted = (callback) => createFollowEventSubscriber('follow.followerDeleted', callback);
+
+/**
+ * ```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
+ */
+const onFollowerRequested = (callback) => createFollowEventSubscriber('follow.requested', callback);
+
+/**
+ * ```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
+ */
+const onFollowRequestCanceled = (callback) => createFollowEventSubscriber('follow.requestCanceled', callback);
+
+/**
+ * ```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
+ */
+const onFollowRequestAccepted = (callback) => createFollowEventSubscriber('follow.accepted', callback);
+
+/**
+ * ```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
+ */
+const onFollowRequestDeclined = (callback) => createFollowEventSubscriber('follow.requestDeclined', callback);
+
+/**
+ * ```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
+ */
+const onFollowInfoUpdated = (callback) => {
+    const handler = async (payload) => {
+        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());
+    };
+};
+
+/**
+ * ```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
+ */
+const observeFollowInfo = (userId, callback, policy = 'cache_then_server') => {
+    const { log } = getActiveClient();
+    const timestamp = Date.now();
+    log(`observeFollowInfo(tmpid: ${timestamp}) > listen`);
+    const router = (result, action) => {
+        var _a, _b;
+        if (callback instanceof Function)
+            return callback(result);
+        if (action !== 'onFetch')
+            (_a = callback.onEvent) === null || _a === void 0 ? void 0 : _a.call(callback, action, result);
+        (_b = callback[action]) === null || _b === void 0 ? void 0 : _b.call(callback, result);
+    };
+    const realtimeRouter = (result, action) => {
+        var _a;
+        if (((_a = result.data) === null || _a === void 0 ? void 0 : _a.userId) !== userId)
+            return;
+        router(result, action);
+    };
+    const disposers = [];
+    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());
+    };
+};
+
+/**
+ * ```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.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 Follow Observer
+ */
+const observeFollowers = (userId, callback) => {
+    const { log } = getActiveClient();
+    const timestamp = Date.now();
+    log(`observeFollowers(tmpid: ${timestamp}) > listen`);
+    const disposers = [];
+    const router = (status, action) => {
+        var _a, _b;
+        if (status.from !== userId) {
+            return;
+        }
+        if (callback instanceof Function) {
+            return callback(status);
+        }
+        (_a = callback.onEvent) === null || _a === void 0 ? void 0 : _a.call(callback, action, status);
+        (_b = callback[action]) === null || _b === void 0 ? void 0 : _b.call(callback, 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')));
+    return () => {
+        log(`observeFollowers(tmpid: ${timestamp}) > dispose`);
+        disposers.forEach(fn => fn());
+    };
+};
+
+/**
+ * ```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.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 Follow Observer
+ */
+const observeFollowings = (userId, callback) => {
+    const { log } = getActiveClient();
+    const timestamp = Date.now();
+    log(`observeFollowings(tmpid: ${timestamp}) > listen`);
+    const disposers = [];
+    const router = (status, action) => {
+        var _a, _b;
+        if (status.to !== userId) {
+            return;
+        }
+        if (callback instanceof Function) {
+            return callback(status);
+        }
+        (_a = callback.onEvent) === null || _a === void 0 ? void 0 : _a.call(callback, action, status);
+        (_b = callback[action]) === null || _b === void 0 ? void 0 : _b.call(callback, 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')));
+    return () => {
+        log(`observeFollowings(tmpid: ${timestamp}) > dispose`);
+        disposers.forEach(fn => fn());
+    };
 };
 
 /**
@@ -19966,4 +20715,4 @@ const onStreamRecorded = (callback) => {
     return createEventSubscriber(client, 'stream/onStreamRecorded', 'video-streaming.didRecord', filter);
 };
 
-export { SubscriptionLevels, VERSION$1 as VERSION, addChannelMembers, addChannelMembersRole, addCommunityMembers, addCommunityMembersRole, addReaction, backupCache, connectClient, createChannel, createClient, createComment, createCommunity, createFile, createMessage, createPost, createQuery, createReport, createStream, deleteChannel, deleteComment, deleteCommunity, deleteFile, deleteMessage, deletePost, deleteReport, deleteStream, disableCache, disconnectClient, disposeStream, dropFromCache, enableCache, fileUrlWithSize, filterByPropEquality, getActiveClient, getChannel, getChannels, getComment, getCommentTopic, getComments, getCommunities, getCommunity, getCommunityTopic, getFile, getMessage, getMessages, getPost, getPostTopic, getPosts, getRole, getStream, getUser, getUserTopic, getUsers, isAfterBefore, isAfterBeforeRaw, isCachable, isConnected, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkipLimit, joinChannel, joinCommunity, leaveChannel, leaveCommunity, mergeInCache, observeChannel, observeComment, observeComments, observeCommunity, observeFile, observeMessage, observeMessages, observePost, observePosts, observeUser, onChannelDeleted, onChannelJoined, onChannelLeft, onChannelUpdated, onClientBanned, onClientDisconnected, onCommentCreated, onCommentDeleted, onCommentFlagged, onCommentReactionAdded, onCommentReactionRemoved, onCommentUnflagged, onCommentUpdated, onCommunityCreated, onCommunityDeleted, onCommunityJoined, onCommunityLeft, onCommunityUpdated, onCommunityUserAdded, onCommunityUserBanned, onCommunityUserRemoved, onCommunityUserUnbanned, onConnectionError, onMemberAdded, onMemberRemoved, onMessageCreated, onMessageDeleted, onMessageUpdated, onPostApproved, onPostCreated, onPostDeclined, onPostDeleted, onPostFlagged, onPostReactionAdded, onPostReactionRemoved, onPostUnflagged, onPostUpdated, onReactionRemoved, onStreamRecorded, onStreamStarted, onStreamStopped, onUserFlagCleared, onUserFlagged, onUserUnflagged, onUserUpdated, pullFromCache, pushToCache, queryCache, queryChannelMembers, queryChannels, queryComments, queryCommunities, queryCommunityMembers, queryGlobalFeed, queryMessages, queryOptions, queryPosts, queryRoles, queryStreams, queryUsers, removeChannelMembers, removeChannelMembersRole, removeCommunityMembers, removeCommunityMembersRole, removeReaction, restoreCache, runQuery, sliceByPaging, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByLastActivity, sortByLastCreated, sortBySegmentNumber, subscribeTopic, toPage, toPageRaw, toToken, updateChannel, updateComment, updateCommunity, updateMessage, updatePost, updateStream, updateUser, upsertInCache, wipeCache };
+export { API_REGIONS, SubscriptionLevels, VERSION$1 as VERSION, acceptFollower, addChannelMembers, addChannelMembersRole, addCommunityMembers, addCommunityMembersRole, addReaction, backupCache, connectClient, createChannel, createClient, createComment, createCommunity, createFile, createMessage, createPost, createQuery, createReport, createStream, declineFollower, deleteChannel, deleteComment, deleteCommunity, deleteFile, deleteMessage, deletePost, deleteReport, deleteStream, disableCache, disconnectClient, disposeStream, dropFromCache, enableCache, fileUrlWithSize, filterByPropEquality, follow, getActiveClient, getChannel, getChannels, getComment, getCommentTopic, getComments, getCommunities, getCommunity, getCommunityTopic, getFile, getFollowInfo, getMessage, getMessages, getMyFollowersTopic, getMyFollowingsTopic, getPost, getPostTopic, getPosts, getRecommendedCommunities, getRole, getStream, getTopTrendingCommunities, getUser, getUserTopic, getUsers, isAfterBefore, isAfterBeforeRaw, isCachable, isConnected, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkipLimit, joinChannel, joinCommunity, leaveChannel, leaveCommunity, mergeInCache, observeChannel, observeComment, observeComments, observeCommunity, observeFile, observeFollowInfo, observeFollowers, observeFollowings, observeMessage, observeMessages, observePost, observePosts, observeUser, onChannelDeleted, onChannelJoined, onChannelLeft, onChannelUpdated, onClientBanned, onClientDisconnected, onCommentCreated, onCommentDeleted, onCommentFlagged, onCommentReactionAdded, onCommentReactionRemoved, onCommentUnflagged, onCommentUpdated, onCommunityCreated, onCommunityDeleted, onCommunityJoined, onCommunityLeft, onCommunityUpdated, onCommunityUserAdded, onCommunityUserBanned, onCommunityUserRemoved, onCommunityUserUnbanned, onConnectionError, onFollowInfoUpdated, onFollowRequestAccepted, onFollowRequestCanceled, onFollowRequestDeclined, onFollowerDeleted, onFollowerRequested, onMemberAdded, onMemberRemoved, onMessageCreated, onMessageDeleted, onMessageUpdated, onPostApproved, onPostCreated, onPostDeclined, onPostDeleted, onPostFlagged, onPostReactionAdded, onPostReactionRemoved, onPostUnflagged, onPostUpdated, onReactionRemoved, onStreamRecorded, onStreamStarted, onStreamStopped, onUserFlagCleared, onUserFlagged, onUserFollowed, onUserUnflagged, onUserUnfollowed, onUserUpdated, pullFromCache, pushToCache, queryCache, queryChannelMembers, queryChannels, queryComments, queryCommunities, queryCommunityMembers, queryFollowers, queryFollowings, queryGlobalFeed, queryMessages, queryOptions, queryPosts, queryRoles, queryStreams, queryUsers, removeChannelMembers, removeChannelMembersRole, removeCommunityMembers, removeCommunityMembersRole, removeReaction, restoreCache, runQuery, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByLastActivity, sortByLastCreated, sortBySegmentNumber, subscribeTopic, toPage, toPageRaw, toToken, unfollow, updateChannel, updateComment, updateCommunity, updateMessage, updatePost, updateStream, updateUser, upsertInCache, wipeCache };