@amityco/ts-sdk 0.0.1-beta.37 → 0.0.1-beta.38

package/dist/index.esm.js

@@ -3,7 +3,6 @@ import AsyncStorage from '@react-native-async-storage/async-storage';
 import mitt from 'mitt';
 import debug from 'debug';
 import axios from 'axios';
-import qs from 'qs';
 import HttpAgent, { HttpsAgent } from 'agentkeepalive';
 import io from 'socket.io-client';
 import nativeIdGenerator from 'react-native-uuid';
@@ -1079,6 +1078,14 @@ const sortByDisplayName = ({ displayName: a }, { displayName: b }) => {
         return 0;
     return a < b ? -1 : 1;
 };
+/**
+ * Alphabetic sorting of objects having a name
+ */
+const sortByName = ({ name: a }, { name: b }) => {
+    if (a === b)
+        return 0;
+    return a < b ? -1 : 1;
+};
 /**
  * Sorting a collection by their apparition order (oldest first)
  */
@@ -1382,13 +1389,6 @@ const unwrapPayload = (response) => {
     return undefined;
 };
 
-/**
- * Axios param serializer (for querystring)
- * @hidden
- */
-const stringify = (params) => {
-    return qs.stringify(params, { arrayFormat: 'brackets' });
-};
 /**
  * Creates a pre-configured axios instance
  *
@@ -1409,7 +1409,14 @@ const createHttpTransport = (endpoint) => {
         baseURL: endpoint,
         httpAgent: new HttpAgent(options),
         httpsAgent: new HttpsAgent(options),
-        paramsSerializer: stringify,
+        /*
+         * If paramSerializer is required, use the serialize option to stringify
+         * params. The encode option will pass complex params as string only whereas
+         * the serialize option will pass params in the format Record<string, any>
+         *
+         * For more details:
+         * https://github.com/axios/axios#request-config
+         */
     });
     instance.interceptors.request.use(config => {
         var _a;
@@ -1423,10 +1430,8 @@ const createHttpTransport = (endpoint) => {
         return config;
     });
     instance.interceptors.response.use(response => response, error => {
-        var _a;
+        var _a, _b;
         const { response } = error;
-        // eslint-disable-next-line no-console
-        console.error((_a = response === null || response === void 0 ? void 0 : response.data) !== null && _a !== void 0 ? _a : error);
         // handle unauthorized request
         if (response.data.code === 400100 /* Amity.ServerError.UNAUTHORIZED */) {
             fireEvent('tokenTerminated', "terminated" /* Amity.SessionStates.TERMINATED */);
@@ -1436,8 +1441,15 @@ const createHttpTransport = (endpoint) => {
             fireEvent('tokenExpired', "tokenExpired" /* Amity.SessionStates.TOKEN_EXPIRED */);
             throw new ASCError('Token expired', 800403 /* Amity.ClientError.TOKEN_EXPIRED */, "fatal" /* Amity.ErrorLevel.FATAL */);
         }
-        if (response === null || response === void 0 ? void 0 : response.data)
-            unwrapPayload(response.data);
+        // if it's an error with status in the response payload,
+        // then it's an expected error.
+        if ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.status) {
+            unwrapPayload(response === null || response === void 0 ? void 0 : response.data);
+        }
+        // unexpected error.
+        else {
+            throw new Error((_b = response === null || response === void 0 ? void 0 : response.data) !== null && _b !== void 0 ? _b : error);
+        }
     });
     return instance;
 };
@@ -20877,7 +20889,8 @@ const isExpired = (expiresAt) => Date.now() > Date.parse(expiresAt) - COMPENSATE
  *
  * @category private
  */
-const isAboutToExpire = (expiresAt, issuedAt) => {
+const isAboutToExpire = (params) => {
+    const { expiresAt, issuedAt } = params;
     const expires = Date.parse(expiresAt);
     const issued = Date.parse(issuedAt);
     const now = Date.now();
@@ -20912,7 +20925,7 @@ const accessTokenExpiryWatcher = (expiresAt, issuedAt, sessionHandler) => {
             scheduleTask(() => sessionHandler.sessionWillRenewAccessToken(renewal()));
             return;
         }
-        if (isAboutToExpire(issuedAt, expiresAt)) {
+        if (isAboutToExpire({ expiresAt, issuedAt })) {
             sessionHandler.sessionWillRenewAccessToken(renewal());
         }
     }, ACCESS_TOKEN_WATCHER_INTERVAL);
@@ -21383,6 +21396,58 @@ const onUserUnflagged = (callback) => createUserEventSubscriber('user.unflagged'
  */
 const onUserFlagCleared = (callback) => createUserEventSubscriber('user.flagCleared', callback);
 
+const liveObject = (id, callback, key, fetcher, eventHandlers) => {
+    const { cache } = getActiveClient();
+    if (!cache) {
+        console.log(LIVE_OBJECT_ENABLE_CACHE_MESSAGE);
+    }
+    let model;
+    let isUnsyncedModel = false; // for messages
+    const disposers = [];
+    const dispatcher = (data) => {
+        model = data.data;
+        callback(data);
+    };
+    const realtimeRouter = (eventModel) => {
+        if (id !== eventModel[key]) {
+            return;
+        }
+        if (model && !hasUpdates(model, eventModel)) {
+            return;
+        }
+        dispatcher({ loading: false, data: eventModel, origin: 'event' });
+    };
+    const onFetch = () => {
+        // @ts-ignore
+        const query = createQuery(fetcher, id, true);
+        runQuery(query, ({ error, data, loading, origin, cachedAt }) => {
+            if (cachedAt === UNSYNCED_OBJECT_CACHED_AT_VALUE) {
+                dispatcher({
+                    // @ts-ignore
+                    data,
+                    origin,
+                    loading: false,
+                    error: new ASCApiError(UNSYNCED_OBJECT_CACHED_AT_MESSAGE, 800800 /* Amity.ClientError.DISALOOW_UNSYNCED_OBJECT */, "error" /* Amity.ErrorLevel.ERROR */),
+                });
+                isUnsyncedModel = true;
+                disposers.forEach(fn => fn());
+            }
+            else if (!isUnsyncedModel) {
+                // @ts-ignore
+                dispatcher({ loading, data, origin, error });
+            }
+            if (error) {
+                disposers.forEach(fn => fn());
+            }
+        });
+    };
+    disposers.push(...eventHandlers.map(fn => fn(realtimeRouter)));
+    onFetch();
+    return () => {
+        disposers.forEach(fn => fn());
+    };
+};
+
 /**
  * ```js
  * import { onUserFetched } from '@amityco/ts-sdk'
@@ -21420,42 +21485,14 @@ const onUserFetched = (callback) => createUserEventSubscriber('user.fetched', ca
  * @category Message Live Object
  */
 const liveUser = (userId, callback) => {
-    const { log, cache } = getActiveClient();
-    const timestamp = Date.now();
-    log(`liveUser(tmpid: ${timestamp}) > listen`);
-    if (!cache) {
-        console.log(LIVE_OBJECT_ENABLE_CACHE_MESSAGE);
-    }
-    let user;
-    const disposers = [];
-    const dispatcher = (data) => {
-        user = data.data;
-        callback(data);
-    };
-    const realtimeRouter = (eventUser) => {
-        if (userId !== eventUser.userId) {
-            return;
-        }
-        if (user && !hasUpdates(user, eventUser)) {
-            return;
-        }
-        dispatcher({ loading: false, data: eventUser, origin: 'event' });
-    };
-    const onFetch = () => {
-        const query = createQuery(getUser, userId, true);
-        runQuery(query, ({ loading, data, error, origin }) => {
-            dispatcher({ loading, data, origin, error });
-            if (error) {
-                disposers.forEach(fn => fn());
-            }
-        });
-    };
-    disposers.push(onUserFetched(realtimeRouter), onUserUpdated(realtimeRouter), onUserDeleted(realtimeRouter), onUserFlagged(realtimeRouter), onUserUnflagged(realtimeRouter), onUserFlagCleared(realtimeRouter));
-    onFetch();
-    return () => {
-        log(`liveUser(tmpid: ${timestamp}) > dispose`);
-        disposers.forEach(fn => fn());
-    };
+    return liveObject(userId, callback, 'userId', getUser, [
+        onUserFetched,
+        onUserUpdated,
+        onUserDeleted,
+        onUserFlagged,
+        onUserUnflagged,
+        onUserFlagCleared,
+    ]);
 };
 
 /**
@@ -21579,7 +21616,7 @@ const createFile = async (formData, onProgress) => {
         : { 'content-type': 'multipart/form-data' };
     const { data } = await client.http.post('/api/v4/files', formData, {
         headers,
-        onUploadProgress({ loaded, total }) {
+        onUploadProgress({ loaded, total = 100 }) {
             onProgress && onProgress(Math.round((loaded * 100) / total));
         },
     });
@@ -21658,7 +21695,7 @@ const createVideo = async (formData, feedType, onProgress) => {
         : { 'content-type': 'multipart/form-data' };
     const { data } = await client.http.post('/api/v4/videos', formData, {
         headers,
-        onUploadProgress({ loaded, total }) {
+        onUploadProgress({ loaded, total = 100 }) {
             onProgress && onProgress(Math.round((loaded * 100) / total));
         },
     });
@@ -21699,7 +21736,7 @@ const createImage = async (formData, onProgress) => {
         : { 'content-type': 'multipart/form-data' };
     const { data } = await client.http.post('/api/v4/images', formData, {
         headers,
-        onUploadProgress({ loaded, total }) {
+        onUploadProgress({ loaded, total = 100 }) {
             onProgress && onProgress(Math.round((loaded * 100) / total));
         },
     });
@@ -23678,6 +23715,7 @@ getComments.locally = (commentIds) => {
 const getComment = async (commentId) => {
     const client = getActiveClient();
     client.log('comment/getComment', commentId);
+    isInTombstone('comment', commentId);
     let data;
     try {
         // API-FIX: endpoint should not be /list, parameters should be querystring.
@@ -23685,8 +23723,8 @@ const getComment = async (commentId) => {
         data = response.data;
     }
     catch (error) {
-        if ((error === null || error === void 0 ? void 0 : error.code) === 400400 /* Amity.ServerError.ITEM_NOT_FOUND */) {
-            dropFromCache(['comment', 'get', commentId], true);
+        if (checkIfShouldGoesToTombstone(error === null || error === void 0 ? void 0 : error.code)) {
+            pushToTombstone('comment', commentId);
         }
         throw error;
     }
@@ -23820,9 +23858,7 @@ const deleteComment = async (commentId, permanent = false) => {
     fireEvent('post.updated', { posts: [post.data] });
     fireEvent('comment.deleted', { comments: [deleted] });
     if (permanent) {
-        setTimeout(() => {
-            dropFromCache(['comment', 'get', commentId], true);
-        }, 0);
+        scheduleTask(() => pushToTombstone('comment', commentId));
     }
     else {
         upsertInCache(['comment', 'get', commentId], { isDeleted: true });
@@ -26245,55 +26281,13 @@ const onMessageReactionRemoved = (callback) => {
  * @category Message Live Object
  */
 const liveChannel = (channelId, callback) => {
-    const { log, cache } = getActiveClient();
-    const timestamp = Date.now();
-    log(`liveChannel(tmpid: ${timestamp}) > listen`);
-    if (!cache) {
-        console.log(LIVE_OBJECT_ENABLE_CACHE_MESSAGE);
-    }
-    let channel;
-    let isUnsyncedObject = false;
-    const disposers = [];
-    const dispatcher = (data) => {
-        channel = data.data;
-        callback(data);
-    };
-    const realtimeRouter = (eventChannel) => {
-        if (channelId !== eventChannel.channelId) {
-            return;
-        }
-        if (channel && !hasUpdates(channel, eventChannel)) {
-            return;
-        }
-        dispatcher({ loading: false, data: eventChannel, origin: 'event' });
-    };
-    const onFetch = () => {
-        const query = createQuery(getChannel, channelId);
-        runQuery(query, ({ loading, data, error, origin, cachedAt }) => {
-            if (cachedAt === UNSYNCED_OBJECT_CACHED_AT_VALUE) {
-                dispatcher({
-                    data,
-                    origin,
-                    loading: false,
-                    error: new ASCApiError(UNSYNCED_OBJECT_CACHED_AT_MESSAGE, 800800 /* Amity.ClientError.DISALOOW_UNSYNCED_OBJECT */, "error" /* Amity.ErrorLevel.ERROR */),
-                });
-                isUnsyncedObject = true;
-                disposers.forEach(fn => fn());
-            }
-            else if (!isUnsyncedObject) {
-                dispatcher({ loading, data, origin, error });
-            }
-            if (error) {
-                disposers.forEach(fn => fn());
-            }
-        });
-    };
-    disposers.push(onChannelUpdated(realtimeRouter), onChannelDeleted(realtimeRouter), onChannelJoined(realtimeRouter), onChannelMuted(realtimeRouter), onMessageCreated(() => null));
-    onFetch();
-    return () => {
-        log(`liveChannel(tmpid: ${timestamp}) > dispose`);
-        disposers.forEach(fn => fn());
-    };
+    return liveObject(channelId, callback, 'channelId', getChannel, [
+        onChannelUpdated,
+        onChannelDeleted,
+        onChannelJoined,
+        onChannelMuted,
+        () => onMessageCreated(() => null), // watch unread count
+    ]);
 };
 
 /**
@@ -26954,42 +26948,11 @@ const onSubChannelFetched = (callback) => {
  * @category SubChannel Live Object
  */
 const liveSubChannel = (subChannelId, callback) => {
-    const { log, cache } = getActiveClient();
-    const timestamp = Date.now();
-    log(`liveSubChannel(tmpid: ${timestamp}) > listen`);
-    if (!cache) {
-        console.log(LIVE_OBJECT_ENABLE_CACHE_MESSAGE);
-    }
-    let subChannel;
-    const disposers = [];
-    const dispatcher = (data) => {
-        subChannel = data.data;
-        callback(data);
-    };
-    const realtimeRouter = (eventSubChannel) => {
-        if (subChannelId !== eventSubChannel.subChannelId) {
-            return;
-        }
-        if (subChannel && !hasUpdates(subChannel, eventSubChannel)) {
-            return;
-        }
-        dispatcher({ loading: false, data: eventSubChannel, origin: 'event' });
-    };
-    const onFetch = () => {
-        const query = createQuery(getSubChannel, subChannelId);
-        runQuery(query, ({ error, data, loading, origin }) => {
-            dispatcher({ error, data, loading, origin });
-            if (error) {
-                disposers.forEach(fn => fn());
-            }
-        });
-    };
-    disposers.push(onSubChannelFetched(realtimeRouter), onSubChannelUpdated(realtimeRouter), onSubChannelDeleted(realtimeRouter));
-    onFetch();
-    return () => {
-        log(`liveSubChannel(tmpid: ${timestamp}) > dispose`);
-        disposers.forEach(fn => fn());
-    };
+    return liveObject(subChannelId, callback, 'subChannelId', getSubChannel, [
+        onSubChannelFetched,
+        onSubChannelUpdated,
+        onSubChannelDeleted,
+    ]);
 };
 
 /**
@@ -27120,55 +27083,16 @@ const onMessageFetched = (callback) => {
  * @category Message Live Object
  */
 const liveMessage = (messageId, callback) => {
-    const { log, cache } = getActiveClient();
-    const timestamp = Date.now();
-    log(`liveMessage(tmpid: ${timestamp}) > listen`);
-    if (!cache) {
-        console.log(LIVE_OBJECT_ENABLE_CACHE_MESSAGE);
-    }
-    let message;
-    let isUnsyncedObject = false;
-    const disposers = [];
-    const dispatcher = (data) => {
-        message = data.data;
-        callback(data);
-    };
-    const realtimeRouter = (eventMessage) => {
-        if (messageId !== eventMessage.messageId) {
-            return;
-        }
-        if (message && !hasUpdates(message, eventMessage)) {
-            return;
-        }
-        dispatcher({ loading: false, data: eventMessage, origin: 'event' });
-    };
-    const onFetch = () => {
-        const query = createQuery(getMessage, messageId, true);
-        runQuery(query, ({ loading, data, error, origin, cachedAt }) => {
-            if (cachedAt === UNSYNCED_OBJECT_CACHED_AT_VALUE) {
-                dispatcher({
-                    data,
-                    origin,
-                    loading: false,
-                    error: new ASCApiError(UNSYNCED_OBJECT_CACHED_AT_MESSAGE, 800800 /* Amity.ClientError.DISALOOW_UNSYNCED_OBJECT */, "error" /* Amity.ErrorLevel.ERROR */),
-                });
-                isUnsyncedObject = true;
-                disposers.forEach(fn => fn());
-            }
-            else if (!isUnsyncedObject) {
-                dispatcher({ loading, data, origin, error });
-            }
-            if (error) {
-                disposers.forEach(fn => fn());
-            }
-        });
-    };
-    disposers.push(onMessageFetched(realtimeRouter), onMessageUpdated(realtimeRouter), onMessageDeleted(realtimeRouter), onMessageFlagged(realtimeRouter), onMessageUnflagged(realtimeRouter), onMessageFlagCleared(realtimeRouter), onMessageReactionAdded(realtimeRouter), onMessageReactionRemoved(realtimeRouter));
-    onFetch();
-    return () => {
-        log(`liveMessage(tmpid: ${timestamp}) > dispose`);
-        disposers.forEach(fn => fn());
-    };
+    return liveObject(messageId, callback, 'messageId', getMessage, [
+        onMessageFetched,
+        onMessageUpdated,
+        onMessageDeleted,
+        onMessageFlagged,
+        onMessageUnflagged,
+        onMessageFlagCleared,
+        onMessageReactionAdded,
+        onMessageReactionRemoved,
+    ]);
 };
 
 /**
@@ -27369,6 +27293,30 @@ const createCommunityEventSubscriber = (event, callback) => {
     };
     return createEventSubscriber(client, event, event, filter);
 };
+/*
+ * verifies membership status
+ */
+function isMember(membership) {
+    return membership !== 'none';
+}
+/*
+ * checks if currently logged in user is part of the community
+ */
+function isCurrentUserPartOfCommunity(c, m) {
+    const { userId } = getActiveUser();
+    return c.communityId === m.communityId && m.userId === userId;
+}
+/*
+ * For mqtt events server will not send user specific data as it's broadcasted
+ * to multiple users. Althought this can be calculated, it's not scalable. Hence
+ * the client SDK needs to calculate this info
+ */
+function updateMembershipStatus(communities, communityUsers) {
+    return communities.map(c => {
+        const isJoined = communityUsers.some(m => isCurrentUserPartOfCommunity(c, m) && isMember(m.communityMembership));
+        return Object.assign(Object.assign({}, c), { isJoined });
+    });
+}
 function hasPermission(member, payload, permission) {
     if (member.permissions.some(x => x === permission)) {
         return true;
@@ -27399,7 +27347,15 @@ const createCommunityMemberEventSubscriber = (event, callback) => {
     const client = getActiveClient();
     const filter = (payload) => {
         const communityPayload = unpackCommunityPayload(payload);
+        const { communities } = communityPayload;
         const preparedPayload = prepareMembershipPayload(communityPayload, 'communityUsers');
+        const { communityUsers } = preparedPayload;
+        /*
+         * community.isJoined is not part of the communityMembership payload, and needs
+         * to be calculated based on the communityMembership value
+         */
+        const communitiesWithMembership = updateMembershipStatus(communities, communityUsers);
+        preparedPayload.communities = communitiesWithMembership;
         if (!client.cache) {
             // TODO: here we are missing specific properties here!
             callback(preparedPayload.communities[0], getEventRelatedMember(event, preparedPayload));
@@ -27541,6 +27497,23 @@ const onCommunityUserAdded = (callback) => createCommunityMemberEventSubscriber(
  */
 const onCommunityUserRemoved = (callback) => createCommunityMemberEventSubscriber('community.userRemoved', callback);
 
+/**
+ * ```js
+ * import { onCommunityUserChanged } from '@amityco/ts-sdk'
+ * const dispose = onCommunityUserChanged((community, member) => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a user has been added or removed from a {@link Amity.Community}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Community Events
+ */
+const onCommunityUserChanged = (callback) => createCommunityMemberEventSubscriber('community.userChanged', callback);
+
 /**
  * ```js
  * import { onCommunityUserBanned } from '@amityco/ts-sdk'
@@ -27619,6 +27592,122 @@ const observeCommunity = (communityId, callback) => {
     };
 };
 
+/**
+ * ```js
+ * import { liveCommunities } from '@amityco/ts-sdk'
+ *
+ * let communities = []
+ * const unsub = liveCommunities({
+ *   displayName: Amity.Community['displayName'],
+ * }, response => merge(communities, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.Community}s
+ *
+ * @param params for querying communities
+ * @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 communities
+ *
+ * @category Community Live Collection
+ */
+const liveCommunities = (params, callback, config) => {
+    const { log, cache } = getActiveClient();
+    if (!cache) {
+        console.log(ENABLE_CACHE_MESSAGE);
+    }
+    const timestamp = Date.now();
+    log(`liveCommunities(tmpid: ${timestamp}) > listen`);
+    const { limit: queryLimit } = params, queryParams = __rest(params, ["limit"]);
+    const limit = queryLimit !== null && queryLimit !== void 0 ? queryLimit : COLLECTION_DEFAULT_PAGINATION_LIMIT;
+    const { policy = COLLECTION_DEFAULT_CACHING_POLICY } = config !== null && config !== void 0 ? config : {};
+    const disposers = [];
+    const cacheKey = ['community', 'collection', {}];
+    const responder = (data) => {
+        var _a, _b;
+        let communities = (_a = data.data
+            .map(communityId => pullFromCache(['community', 'get', communityId]))
+            .filter(Boolean)
+            .map(({ data }) => data)) !== null && _a !== void 0 ? _a : [];
+        communities = filterByPropEquality(communities, 'isDeleted', params.isDeleted);
+        communities = filterByPropEquality(communities, 'displayName', params.displayName);
+        if (params.categoryId) {
+            communities = communities.filter(c => { var _a; return (_a = c.categoryIds) === null || _a === void 0 ? void 0 : _a.includes(params.categoryId); });
+        }
+        if (params.tags) {
+            communities = communities.filter(c => { var _a; return (_a = c.tags) === null || _a === void 0 ? void 0 : _a.some(t => { var _a; return (_a = params.tags) === null || _a === void 0 ? void 0 : _a.includes(t); }); });
+        }
+        if (params.membership === 'member') {
+            communities = filterByPropEquality(communities, 'isJoined', true);
+        }
+        if (params.membership === 'notMember') {
+            communities = filterByPropEquality(communities, 'isJoined', false);
+        }
+        const sortBy = params.sortBy || 'lastCreated';
+        if (sortBy === 'lastCreated' || sortBy === 'firstCreated') {
+            communities = communities.sort(sortBy === 'lastCreated' ? sortByLastCreated : sortByFirstCreated);
+        }
+        /*
+         * The server returns communities with empty | null displayName's first before
+         * returning sorted list of communities with displayNames
+         *
+         * This section needs to be updated as displayNames can be null as well
+         */
+        if (sortBy === 'displayName') {
+            communities = communities
+                // this needs to be aligned with the backend data type
+                .map(c => (c.displayName ? c : Object.assign(Object.assign({}, c), { displayName: '' })))
+                // @ts-ignore
+                .sort(sortByDisplayName);
+        }
+        callback({
+            onNextPage: onFetch,
+            data: communities,
+            hasNextPage: !!((_b = data.params) === null || _b === void 0 ? void 0 : _b.page),
+            loading: data.loading,
+            error: data.error,
+        });
+    };
+    const realtimeRouter = (_) => (community) => {
+        var _a;
+        const collection = (_a = pullFromCache(cacheKey)) === null || _a === void 0 ? void 0 : _a.data;
+        if (!collection)
+            return;
+        /*
+         * Simply update collection and let responder decide what to do with data
+         */
+        collection.data = [...new Set([community.communityId, ...collection.data])];
+        pushToCache(cacheKey, collection);
+        responder(collection);
+    };
+    const onFetch = () => {
+        var _a, _b, _c;
+        const collection = (_a = pullFromCache(cacheKey)) === null || _a === void 0 ? void 0 : _a.data;
+        const communities = (_b = collection === null || collection === void 0 ? void 0 : collection.data) !== null && _b !== void 0 ? _b : [];
+        if (communities.length > 0 && !(collection === null || collection === void 0 ? void 0 : collection.params.page))
+            return;
+        const query = createQuery(queryCommunities, Object.assign(Object.assign({}, queryParams), { page: (_c = collection === null || collection === void 0 ? void 0 : collection.params.page) !== null && _c !== void 0 ? _c : { limit } }));
+        runQuery(query, ({ data: result, error, loading, nextPage: page }) => {
+            const data = {
+                loading,
+                error,
+                params: { page },
+                data: communities,
+            };
+            if (result) {
+                data.data = [...new Set([...communities, ...result.map(getResolver('community'))])];
+            }
+            pushToCache(cacheKey, data);
+            responder(data);
+        }, queryOptions(policy));
+    };
+    disposers.push(onCommunityCreated(realtimeRouter()), onCommunityDeleted(realtimeRouter()), onCommunityUpdated(realtimeRouter()), onCommunityJoined(realtimeRouter()), onCommunityLeft(realtimeRouter()), onCommunityUserChanged(realtimeRouter()));
+    onFetch();
+    return () => {
+        log(`liveCommunities(tmpid: ${timestamp}) > dispose`);
+        disposers.forEach(fn => fn());
+    };
+};
+
 /**
  * ```js
  * import { queryCategories } from '@amityco/ts-sdk'
@@ -27747,6 +27836,96 @@ getCategory.locally = (categoryId) => {
     };
 };
 
+/**
+ * ```js
+ * import { liveCategories } from '@amityco/ts-sdk'
+ *
+ * let categories = []
+ * const unsub = liveCategories({}, response => merge(categories, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.Category}s
+ *
+ * @param params for querying categories
+ * @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 categories
+ *
+ * @category Category Live Collection
+ */
+const liveCategories = (params, callback, config) => {
+    const { log, cache } = getActiveClient();
+    if (!cache) {
+        console.log(ENABLE_CACHE_MESSAGE);
+    }
+    const timestamp = Date.now();
+    log(`liveCategories(tmpid: ${timestamp}) > listen`);
+    const { limit: queryLimit } = params, queryParams = __rest(params, ["limit"]);
+    const limit = queryLimit !== null && queryLimit !== void 0 ? queryLimit : COLLECTION_DEFAULT_PAGINATION_LIMIT;
+    const { policy = COLLECTION_DEFAULT_CACHING_POLICY } = config !== null && config !== void 0 ? config : {};
+    const disposers = [];
+    const cacheKey = ['category', 'collection', {}];
+    const responder = (data) => {
+        var _a, _b;
+        let categories = (_a = data.data
+            .map(categoryId => pullFromCache(['category', 'get', categoryId]))
+            .filter(Boolean)
+            .map(({ data }) => data)) !== null && _a !== void 0 ? _a : [];
+        categories = filterByPropEquality(categories, 'isDeleted', params.isDeleted);
+        switch (params.sortBy) {
+            case 'firstCreated':
+                categories = categories.sort(sortByFirstCreated);
+                break;
+            case 'lastCreated':
+                categories = categories.sort(sortByLastCreated);
+                break;
+            default:
+                categories = categories.sort(sortByName);
+        }
+        callback({
+            onNextPage: onFetch,
+            data: categories,
+            hasNextPage: !!((_b = data.params) === null || _b === void 0 ? void 0 : _b.page),
+            loading: data.loading,
+            error: data.error,
+        });
+    };
+    /*
+     * const realtimeRouter = () => {
+     * @TODO: At the time of creating this method category does not have any
+     * observers
+     *};
+     */
+    const onFetch = () => {
+        var _a, _b, _c;
+        const collection = (_a = pullFromCache(cacheKey)) === null || _a === void 0 ? void 0 : _a.data;
+        const categories = (_b = collection === null || collection === void 0 ? void 0 : collection.data) !== null && _b !== void 0 ? _b : [];
+        if (categories.length > 0 && !(collection === null || collection === void 0 ? void 0 : collection.params.page))
+            return;
+        const query = createQuery(queryCategories, Object.assign(Object.assign({}, queryParams), { page: (_c = collection === null || collection === void 0 ? void 0 : collection.params.page) !== null && _c !== void 0 ? _c : { limit } }));
+        runQuery(query, ({ data: result, error, loading, nextPage: page }) => {
+            const data = {
+                loading,
+                error,
+                params: { page },
+                data: categories,
+            };
+            if (result) {
+                data.data = [...new Set([...categories, ...result.map(getResolver('category'))])];
+            }
+            pushToCache(cacheKey, data);
+            responder(data);
+        }, queryOptions(policy));
+    };
+    disposers.push(() => {
+        // @TODO -> update once observers added
+    });
+    onFetch();
+    return () => {
+        log(`liveCategories(tmpid: ${timestamp}) > dispose`);
+        disposers.forEach(fn => fn());
+    };
+};
+
 /**
  * ```js
  * import { queryGlobalFeed } from '@amityco/ts-sdk'
@@ -28671,6 +28850,38 @@ const observePost = (postId, callback, policy = 'cache_then_server') => {
     };
 };
 
+/**
+ * ```js
+ * import { livePost } from '@amityco/ts-sdk';
+ *
+ * let post;
+ *
+ * const unsubscribe = livePost(postId, response => {
+ *   post = response.data;
+ * });
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.Post}
+ *
+ * @param postId the ID of the message 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 sub channel
+ *
+ * @category Post Live Object
+ */
+const livePost = (postId, callback) => {
+    return liveObject(postId, callback, 'postId', getPost, [
+        onPostApproved,
+        onPostDeclined,
+        onPostDeleted,
+        onPostFlagged,
+        onPostReactionAdded,
+        onPostReactionRemoved,
+        onPostUnflagged,
+        onPostUpdated,
+    ]);
+};
+
 /**
  * ```js
  * import { livePosts } from '@amityco/ts-sdk'
@@ -28866,6 +29077,36 @@ const observeComment = (commentId, callback, policy = 'cache_then_server') => {
     };
 };
 
+/**
+ * ```js
+ * import { liveComment } from '@amityco/ts-sdk';
+ *
+ * let comment;
+ *
+ * const unsubscribe = liveComment(commentId, response => {
+ *   comment = response.data;
+ * });
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.Comment}
+ *
+ * @param commentId the ID of the comment 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 comment
+ *
+ * @category Comment Live Object
+ */
+const liveComment = (commentId, callback) => {
+    return liveObject(commentId, callback, 'commentId', getComment, [
+        onCommentDeleted,
+        onCommentFlagged,
+        onCommentReactionAdded,
+        onCommentReactionRemoved,
+        onCommentUnflagged,
+        onCommentUpdated,
+    ]);
+};
+
 /**
  * ```js
  * import { liveComments } from '@amityco/ts-sdk'
@@ -29550,4 +29791,4 @@ const createUserToken = async (apiKey, apiRegion, params) => {
     return { accessToken: data.accessToken };
 };
 
-export { API_REGIONS, CommunityPostSettingMaps, CommunityPostSettings, ContentFeedType, DefaultCommunityPostSetting, FileType, MessageContentType, PostContentType, SubscriptionLevels, VERSION$1 as VERSION, VideoResolution, VideoSize, VideoTranscodingStatus, acceptFollower, addChannelMembers, addChannelMembersRole, addCommunityMembers, addCommunityMembersRoles, addReaction, approvePost, backupCache, banChannelMembers, closePoll, connectClient, createChannel, createClient, createComment, createCommunity, createFile, createImage, createMessage, createPoll, createPost, createQuery, createReport, createStream, createSubChannel, createUserToken, createVideo, declineFollower, declinePost, deleteChannel, deleteComment, deleteCommunity, deleteFile, deleteMessage, deletePoll, deletePost, deleteReport, deleteStream, deleteSubChannel, disableCache, disconnectClient, disposeStream, dropFromCache, enableCache, fileUrlWithSize, filterByChannelMembership, filterByPropEquality, filterByPropInclusion, follow, getActiveClient, getCategory, getChannel, getChannelTopic, getChannels, getComment, getCommentTopic, getComments, getCommunities, getCommunity, getCommunityTopic, getFeedSettings, getFile, getFollowInfo, getMessage, getMessageTopic, getMessages, getMyFollowersTopic, getMyFollowingsTopic, getNetworkTopic, getPoll, getPost, getPostTopic, getPosts, getRecommendedCommunities, getRole, getSmartFeedChannelTopic, getSmartFeedMessageTopic, getSmartFeedSubChannelTopic, getStream, getSubChannel, getSubChannelTopic, getSubChannels, getTopTrendingCommunities, getUser, getUserTopic, getUsers, isAfterBefore, isAfterBeforeRaw, isCachable, isConnected, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkipLimit, joinChannel, joinCommunity, leaveChannel, leaveCommunity, liveChannel, liveChannelMembers, liveChannels, liveComments, liveFollowers, liveFollowings, liveMessage, liveMessages, livePosts, liveReactions, liveSubChannel, liveSubChannels, liveUser, mergeInCache, observeChannel, observeChannels, observeComment, observeComments, observeCommunity, observeFile, observeFollowInfo, observeFollowers, observeFollowings, observeMessage, observeMessages, observePoll, observePost, observePosts, observeUser, onChannelCreated, onChannelDeleted, onChannelJoined, onChannelLeft, onChannelMemberAdded, onChannelMemberBanned, onChannelMemberRemoved, onChannelMemberUnbanned, onChannelMuted, 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, onMessageCreated, onMessageDeleted, onMessageFlagCleared, onMessageFlagged, onMessageReactionAdded, onMessageReactionRemoved, onMessageUnflagged, onMessageUpdated, onPollDeleted, onPollUpdated, onPostApproved, onPostCreated, onPostDeclined, onPostDeleted, onPostFlagged, onPostReactionAdded, onPostReactionRemoved, onPostUnflagged, onPostUpdated, onReactionAdded, onReactionRemoved, onReactorAdded, onReactorRemoved, onSessionStateChange, onStreamRecorded, onStreamStarted, onStreamStopped, onSubChannelCreated, onSubChannelDeleted, onSubChannelUpdated, onUserDeleted, onUserFlagCleared, onUserFlagged, onUserFollowed, onUserUnflagged, onUserUnfollowed, onUserUpdated, pullFromCache, pushToCache, queryCache, queryCategories, queryChannelMembers, queryChannels, queryComments, queryCommunities, queryCommunityMembers, queryFollowers, queryFollowings, queryGlobalFeed, queryMessages, queryOptions, queryPosts, queryReactions, queryRoles, queryStreams, querySubChannels, queryUsers, removeChannelMembers, removeChannelMembersRole, removeCommunityMembers, removeCommunityMembersRoles, removeReaction, renewal, restoreCache, runQuery, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByLastActivity, sortByLastCreated, sortBySegmentNumber, startReading, stopReading, subscribeTopic, toPage, toPageRaw, toToken, unbanChannelMembers, unfollow, updateChannel, updateComment, updateCommunity, updateMessage, updatePost, updateStream, updateSubChannel, updateUser, upsertInCache, votePoll, wipeCache };
+export { API_REGIONS, CommunityPostSettingMaps, CommunityPostSettings, ContentFeedType, DefaultCommunityPostSetting, FileType, MessageContentType, PostContentType, SubscriptionLevels, VERSION$1 as VERSION, VideoResolution, VideoSize, VideoTranscodingStatus, acceptFollower, addChannelMembers, addChannelMembersRole, addCommunityMembers, addCommunityMembersRoles, addReaction, approvePost, backupCache, banChannelMembers, closePoll, connectClient, createChannel, createClient, createComment, createCommunity, createFile, createImage, createMessage, createPoll, createPost, createQuery, createReport, createStream, createSubChannel, createUserToken, createVideo, declineFollower, declinePost, deleteChannel, deleteComment, deleteCommunity, deleteFile, deleteMessage, deletePoll, deletePost, deleteReport, deleteStream, deleteSubChannel, disableCache, disconnectClient, disposeStream, dropFromCache, enableCache, fileUrlWithSize, filterByChannelMembership, filterByPropEquality, filterByPropInclusion, follow, getActiveClient, getCategory, getChannel, getChannelTopic, getChannels, getComment, getCommentTopic, getComments, getCommunities, getCommunity, getCommunityTopic, getFeedSettings, getFile, getFollowInfo, getMessage, getMessageTopic, getMessages, getMyFollowersTopic, getMyFollowingsTopic, getNetworkTopic, getPoll, getPost, getPostTopic, getPosts, getRecommendedCommunities, getRole, getSmartFeedChannelTopic, getSmartFeedMessageTopic, getSmartFeedSubChannelTopic, getStream, getSubChannel, getSubChannelTopic, getSubChannels, getTopTrendingCommunities, getUser, getUserTopic, getUsers, isAfterBefore, isAfterBeforeRaw, isCachable, isConnected, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkipLimit, joinChannel, joinCommunity, leaveChannel, leaveCommunity, liveCategories, liveChannel, liveChannelMembers, liveChannels, liveComment, liveComments, liveCommunities, liveFollowers, liveFollowings, liveMessage, liveMessages, livePost, livePosts, liveReactions, liveSubChannel, liveSubChannels, liveUser, mergeInCache, observeChannel, observeChannels, observeComment, observeComments, observeCommunity, observeFile, observeFollowInfo, observeFollowers, observeFollowings, observeMessage, observeMessages, observePoll, observePost, observePosts, observeUser, onChannelCreated, onChannelDeleted, onChannelJoined, onChannelLeft, onChannelMemberAdded, onChannelMemberBanned, onChannelMemberRemoved, onChannelMemberUnbanned, onChannelMuted, onChannelUpdated, onClientBanned, onClientDisconnected, onCommentCreated, onCommentDeleted, onCommentFlagged, onCommentReactionAdded, onCommentReactionRemoved, onCommentUnflagged, onCommentUpdated, onCommunityCreated, onCommunityDeleted, onCommunityJoined, onCommunityLeft, onCommunityUpdated, onCommunityUserAdded, onCommunityUserBanned, onCommunityUserChanged, onCommunityUserRemoved, onCommunityUserUnbanned, onConnectionError, onFollowInfoUpdated, onFollowRequestAccepted, onFollowRequestCanceled, onFollowRequestDeclined, onFollowerDeleted, onFollowerRequested, onMessageCreated, onMessageDeleted, onMessageFlagCleared, onMessageFlagged, onMessageReactionAdded, onMessageReactionRemoved, onMessageUnflagged, onMessageUpdated, onPollDeleted, onPollUpdated, onPostApproved, onPostCreated, onPostDeclined, onPostDeleted, onPostFlagged, onPostReactionAdded, onPostReactionRemoved, onPostUnflagged, onPostUpdated, onReactionAdded, onReactionRemoved, onReactorAdded, onReactorRemoved, onSessionStateChange, onStreamRecorded, onStreamStarted, onStreamStopped, onSubChannelCreated, onSubChannelDeleted, onSubChannelUpdated, onUserDeleted, onUserFlagCleared, onUserFlagged, onUserFollowed, onUserUnflagged, onUserUnfollowed, onUserUpdated, pullFromCache, pushToCache, queryCache, queryCategories, queryChannelMembers, queryChannels, queryComments, queryCommunities, queryCommunityMembers, queryFollowers, queryFollowings, queryGlobalFeed, queryMessages, queryOptions, queryPosts, queryReactions, queryRoles, queryStreams, querySubChannels, queryUsers, removeChannelMembers, removeChannelMembersRole, removeCommunityMembers, removeCommunityMembersRoles, removeReaction, renewal, restoreCache, runQuery, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByLastActivity, sortByLastCreated, sortByName, sortBySegmentNumber, startReading, stopReading, subscribeTopic, toPage, toPageRaw, toToken, unbanChannelMembers, unfollow, updateChannel, updateComment, updateCommunity, updateMessage, updatePost, updateStream, updateSubChannel, updateUser, upsertInCache, votePoll, wipeCache };