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

package/dist/index.cjs.js

@@ -177,14 +177,14 @@ const partialMatch = (predicate, candidate) => {
 const checkIfShouldGoesToTombstone = (errorCode) => [400400 /* Amity.ServerError.ITEM_NOT_FOUND */, 400300 /* Amity.ServerError.FORBIDDEN */].includes(errorCode);
 
 /**
- * Type guard to find if the a given decoded backend token uses "skip/limit" pagination style
+ * Type guard to find if the a given decoded backend token uses "skip" pagination style
  *
  * @param json any json object as extracted from the backend
  * @returns success boolean if the token has either "skip" or "limit" props
  *
  * @hidden
  */
-const isSkipLimit = (json) => ['skip', 'limit'].some(prop => prop in json);
+const isSkip = (json) => ['skip'].some(prop => prop in json);
 /**
  * Type guard to find if the a given decoded backend token uses "after/before" pagination style
  *
@@ -284,7 +284,7 @@ const toPage = (token) => {
         return undefined;
     // don't try catch, let it throw
     const json = JSON.parse(jsBase64.decode(token));
-    if (isSkipLimit(json)) {
+    if (isSkip(json)) {
         return {
             after: json.skip,
             limit: json.limit,
@@ -511,6 +511,7 @@ const idResolvers = {
     stream: ({ streamId }) => streamId,
     follow: ({ from, to }) => `${from}#${to}`,
     followCount: ({ userId }) => userId,
+    feed: ({ targetId, feedId }) => `${targetId}#${feedId}`,
 };
 /**
  * Retrieve the id resolver matching a domain name
@@ -548,6 +549,7 @@ const CRITERIAS = {
     stream: ['streamId'],
     follow: ['from', 'to'],
     followCount: ['userId', 'followerCount'],
+    feed: ['feedId', 'feedType'],
 };
 /** @hidden */
 const hasKeys = (object, needles) => {
@@ -608,6 +610,7 @@ const PAYLOAD2MODEL = {
     videoStreamings: 'stream',
     follows: 'follow',
     followCounts: 'followCount',
+    feeds: 'feed',
 };
 /** hidden */
 const hasUpdates = (prevData, nextData) => {
@@ -1074,10 +1077,36 @@ const filterByChannelMembership = (collection, membership, userId) => {
             'get',
             channelUserCacheKey,
         ])) === null || _a === void 0 ? void 0 : _a.data;
-        if (membership === 'member' && channelUser && channelUser.membership !== 'none') {
-            return true;
+        if (membership === 'member') {
+            return channelUser && channelUser.membership !== 'none';
         }
-        return membership === 'notMember' && (!channelUser || channelUser.membership === 'none');
+        // only membership value remainging is 'notMember'
+        return !channelUser || channelUser.membership === 'none';
+    });
+};
+/**
+ * Filter a channel collection by membership of the userId
+ *
+ * @param collection the channel collection to filter
+ * @param feedType to be filtered by
+ * @returns a filtered collection with items only matching the criteria
+ *
+ * @hidden
+ */
+const filterByFeedType = (collection, feedType) => {
+    /*
+     * It is possible that the targetId & feedId are the same for most of the posts
+     * But since cache is in-memory, i've avoided memoizing, to avoid premature
+     * optimization. Can be revisited if performance issues arise
+     */
+    return collection.filter(({ targetId, feedId }) => {
+        var _a;
+        const feed = (_a = pullFromCache([
+            'feed',
+            'get',
+            getResolver('feed')({ targetId, feedId }),
+        ])) === null || _a === void 0 ? void 0 : _a.data;
+        return feed && feed.feedType === feedType;
     });
 };
 
@@ -20820,7 +20849,7 @@ const connectClient = async (params, sessionHandler, config) => {
         setSessionState(state);
         disconnectClient();
         subscriptions.forEach(fn => fn());
-    }), onUserDeleted(() => null));
+    }));
     return client.ws.connected;
 };
 
@@ -21509,6 +21538,101 @@ const liveUser = (userId, callback) => {
     ]);
 };
 
+/**
+ * ```js
+ * import { liveUsers } from '@amityco/ts-sdk'
+ *
+ * let users = []
+ * const unsub = liveUsers({}, response => merge(users, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.User}s
+ *
+ * @param params for querying users
+ * @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 users
+ *
+ * @category Category Live Collection
+ */
+const liveUsers = (params, callback, config) => {
+    const { log, cache } = getActiveClient();
+    if (!cache) {
+        console.log(ENABLE_CACHE_MESSAGE);
+    }
+    const timestamp = Date.now();
+    log(`liveUsers(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 = ['user', 'collection', {}];
+    const responder = (data) => {
+        var _a, _b;
+        let users = (_a = data.data
+            .map(userId => pullFromCache(['user', 'get', userId]))
+            .filter(Boolean)
+            .map(({ data }) => data)) !== null && _a !== void 0 ? _a : [];
+        users = filterByPropEquality(users, 'displayName', params.displayName);
+        switch (params.sortBy) {
+            case 'firstCreated':
+                users = users.sort(sortByFirstCreated);
+                break;
+            case 'lastCreated':
+                users = users.sort(sortByLastCreated);
+                break;
+            default:
+                users = users
+                    // this needs to be aligned with the backend data type
+                    .map(u => (u.displayName ? u : Object.assign(Object.assign({}, u), { displayName: '' })))
+                    // @ts-ignore
+                    .sort(sortByDisplayName);
+        }
+        callback({
+            onNextPage: onFetch,
+            data: users,
+            hasNextPage: !!((_b = data.params) === null || _b === void 0 ? void 0 : _b.page),
+            loading: data.loading,
+            error: data.error,
+        });
+    };
+    const realtimeRouter = (_) => (user) => {
+        var _a;
+        const collection = (_a = pullFromCache(cacheKey)) === null || _a === void 0 ? void 0 : _a.data;
+        if (!collection)
+            return;
+        collection.data = [...new Set([user.userId, ...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 users = (_b = collection === null || collection === void 0 ? void 0 : collection.data) !== null && _b !== void 0 ? _b : [];
+        if (users.length > 0 && !(collection === null || collection === void 0 ? void 0 : collection.params.page))
+            return;
+        const query = createQuery(queryUsers, 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: users,
+            };
+            if (result) {
+                data.data = [...new Set([...users, ...result.map(getResolver('user'))])];
+            }
+            pushToCache(cacheKey, data);
+            responder(data);
+        }, queryOptions(policy));
+    };
+    disposers.push(onUserUpdated(realtimeRouter()), onUserDeleted(realtimeRouter()), onUserFlagged(realtimeRouter()), onUserUnflagged(realtimeRouter()), onUserFlagCleared(realtimeRouter()));
+    onFetch();
+    return () => {
+        log(`liveUsers(tmpid: ${timestamp}) > dispose`);
+        disposers.forEach(fn => fn());
+    };
+};
+
 /**
  * ```js
  * import { observeUser } from '@amityco/ts-sdk'
@@ -22190,8 +22314,8 @@ const queryMessages = async (query) => {
         pushToCache(cacheKey, { messages: messages.map(getResolver('message')), paging });
     }
     fireEvent('local.message.fetched', { messages });
-    const nextPage = toPage(paging.next);
-    const prevPage = toPage(paging.previous);
+    const nextPage = toPageRaw(paging.next);
+    const prevPage = toPageRaw(paging.previous);
     return { data: messages, cachedAt, prevPage, nextPage };
 };
 /**
@@ -22222,8 +22346,8 @@ queryMessages.locally = (query) => {
         .map(messageId => pullFromCache(['message', 'get', messageId]))
         .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);
+    const prevPage = toPageRaw(data === null || data === void 0 ? void 0 : data.paging.previous);
+    const nextPage = toPageRaw(data === null || data === void 0 ? void 0 : data.paging.next);
     return messages.length === ((_b = data === null || data === void 0 ? void 0 : data.messages) === null || _b === void 0 ? void 0 : _b.length)
         ? { data: messages, cachedAt, prevPage, nextPage }
         : undefined;
@@ -24868,13 +24992,7 @@ const createReport = async (referenceType, referenceId) => {
     const { data } = await client.http.post(getAPIUrl());
     if (client.cache)
         ingestInCache(referenceType === 'message' ? prepareMessagePayload(data) : data);
-    if (referenceType === 'message') {
-        fireEvent('message.flagged', data);
-    }
-    else {
-        // @ts-ignore
-        fireEvent(`${referenceType}.flagged`, data);
-    }
+    fireEvent(`${referenceType}.flagged`, data);
     return !!data;
 };
 
@@ -24907,13 +25025,8 @@ const deleteReport = async (referenceType, referenceId) => {
     const { data } = await client.http.delete(getAPIUrl());
     if (client.cache)
         ingestInCache(referenceType === 'message' ? prepareMessagePayload(data) : data);
-    if (referenceType === 'message') {
-        fireEvent('message.unflagged', data);
-    }
-    else {
-        // @ts-ignore
-        fireEvent(`${referenceType}.unflagged`, data);
-    }
+    // @ts-ignore
+    fireEvent(`${referenceType}.unflagged`, data);
     return !!data;
 };
 
@@ -26355,22 +26468,29 @@ const liveChannels = (params, callback, config) => {
         if (params.membership && userId) {
             channels = filterByChannelMembership(channels, params.membership, userId);
         }
-        const sortBy = params.sortBy || 'lastCreated';
-        if (sortBy === 'lastCreated' || sortBy === 'firstCreated') {
-            channels = channels.sort(sortBy === 'lastCreated' ? sortByLastCreated : sortByFirstCreated);
-        }
-        /*
-         * The server returns channels with empty | null displayName's first before
-         * returning sorted list of channels with displayNames
-         *
-         * This section needs to be updated as displayNames can be null as well
-         */
-        if (sortBy === 'displayName') {
-            channels = channels
-                // 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);
+        switch (params.sortBy) {
+            case 'firstCreated':
+                channels = channels.sort(sortByFirstCreated);
+                break;
+            case 'lastCreated':
+                channels = channels.sort(sortByLastCreated);
+                break;
+            case 'displayName':
+                /*
+                 * The server returns channels with empty | null displayName's first before
+                 * returning sorted list of channels with displayNames
+                 *
+                 * This section needs to be updated as displayNames can be null as well
+                 */
+                channels = channels
+                    // 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);
+                break;
+            default:
+                channels = channels.sort(sortByLastActivity);
+                break;
         }
         callback({
             onNextPage: onFetch,
@@ -26380,17 +26500,12 @@ const liveChannels = (params, callback, config) => {
             error: data.error,
         });
     };
-    const realtimeRouter = (action) => (channel) => {
+    const realtimeRouter = (_) => (channel) => {
         var _a;
         const collection = (_a = pullFromCache(cacheKey)) === null || _a === void 0 ? void 0 : _a.data;
         if (!collection)
             return;
-        if (action === 'onDelete' && params.isDeleted === false) {
-            collection.data = collection.data.filter(c => c !== channel.channelId);
-        }
-        else {
-            collection.data = [...new Set([channel.channelId, ...collection.data])];
-        }
+        collection.data = [...new Set([channel.channelId, ...collection.data])];
         pushToCache(cacheKey, collection);
         responder(collection);
     };
@@ -26415,7 +26530,7 @@ const liveChannels = (params, callback, config) => {
             responder(data);
         }, queryOptions(policy));
     };
-    disposers.push(onChannelCreated(realtimeRouter('onCreate')), onChannelDeleted(realtimeRouter('onDelete')), onChannelUpdated(realtimeRouter('onUpdate')), onChannelMuted(realtimeRouter('onMute')), onChannelJoined(realtimeRouter('onJoin')), onChannelLeft(realtimeRouter('onLeft')), onChannelMemberAdded(realtimeRouter('onMemberAdded')), onChannelMemberRemoved(realtimeRouter('onMemberRemoved')), onMessageCreated(() => null));
+    disposers.push(onChannelCreated(realtimeRouter()), onChannelDeleted(realtimeRouter()), onChannelUpdated(realtimeRouter()), onChannelMuted(realtimeRouter()), onChannelJoined(realtimeRouter()), onChannelLeft(realtimeRouter()), onChannelMemberAdded(realtimeRouter()), onChannelMemberRemoved(realtimeRouter()), onMessageCreated(() => null));
     onFetch();
     return () => {
         log(`liveChannels(tmpid: ${timestamp}) > dispose`);
@@ -28909,8 +29024,8 @@ const livePost = (postId, callback) => {
  *
  * Observe all mutations on a list of {@link Amity.Post} for a given target object
  *
- * @param targetType the type of the target
- * @param targetId the ID of the target
+ * @param param.targetType the type of the target
+ * @param param.targetId the ID of the target
  * @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
  *
@@ -28944,6 +29059,9 @@ const livePosts = (params, callback, config) => {
         if (params.tags) {
             posts = posts.filter(p => { var _a; return (_a = p.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.targetType === 'community' && params.feedType) {
+            posts = filterByFeedType(posts, params.feedType);
+        }
         callback({
             onNextPage: onFetch,
             data: posts,
@@ -28957,27 +29075,16 @@ const livePosts = (params, callback, config) => {
         const collection = (_a = pullFromCache(cacheKey)) === null || _a === void 0 ? void 0 : _a.data;
         if (params.targetId !== post.targetId || params.targetType !== post.targetType || !collection)
             return;
-        if (['onCreate', 'onApproved'].includes(action)) {
-            collection.data = [...new Set([post.postId, ...collection.data])];
-        }
-        else if (['onDelete', 'onDeclined'].includes(action)) {
-            collection.data = collection.data.filter(p => p !== post.postId);
-            /*
-             * if isDeleted is true, collection should add deleted items to the
-             * begining of the collection
-             */
-            if (params.isDeleted)
-                collection.data.unshift(post.postId);
-        }
         /*
-         * FIX-ME
-         * This is a shortcoming as the feed object is not saved to the cache.
-         * The responder should pull the feed from cache once available and should
-         * match the collection to feedType param
-         * https://ekoapp.atlassian.net/browse/ASC-9382
+         * This is not ideal, but currently this is the only way to update the
+         * collection on post declined
          */
-        if (params.feedType === 'reviewing' && action === 'onApproved')
-            collection.data = collection.data.filter(p => p !== post.postId);
+        if (action === 'onDeclined') {
+            collection.data = collection.data.filter(postId => postId !== post.postId);
+        }
+        else {
+            collection.data = [...new Set([post.postId, ...collection.data])];
+        }
         pushToCache(cacheKey, collection);
         responder(collection);
     };
@@ -29862,6 +29969,7 @@ exports.dropFromCache = dropFromCache;
 exports.enableCache = enableCache;
 exports.fileUrlWithSize = fileUrlWithSize;
 exports.filterByChannelMembership = filterByChannelMembership;
+exports.filterByFeedType = filterByFeedType;
 exports.filterByPropEquality = filterByPropEquality;
 exports.filterByPropInclusion = filterByPropInclusion;
 exports.follow = follow;
@@ -29913,7 +30021,7 @@ exports.isMutator = isMutator;
 exports.isOffline = isOffline;
 exports.isPaged = isPaged;
 exports.isReportedByMe = isReportedByMe;
-exports.isSkipLimit = isSkipLimit;
+exports.isSkip = isSkip;
 exports.joinChannel = joinChannel;
 exports.joinCommunity = joinCommunity;
 exports.leaveChannel = leaveChannel;
@@ -29935,6 +30043,7 @@ exports.liveReactions = liveReactions;
 exports.liveSubChannel = liveSubChannel;
 exports.liveSubChannels = liveSubChannels;
 exports.liveUser = liveUser;
+exports.liveUsers = liveUsers;
 exports.mergeInCache = mergeInCache;
 exports.observeChannel = observeChannel;
 exports.observeChannels = observeChannels;