@amityco/ts-sdk 0.0.1-beta.28 → 0.0.1-beta.29

package/dist/index.cjs.js

@@ -21,11 +21,33 @@ var HttpAgent__default = /*#__PURE__*/_interopDefaultLegacy(HttpAgent);
 var io__default = /*#__PURE__*/_interopDefaultLegacy(io);
 var nativeIdGenerator__default = /*#__PURE__*/_interopDefaultLegacy(nativeIdGenerator);
 
+const CommunityPostSettings = Object.freeze({
+    ONLY_ADMIN_CAN_POST: 'ONLY_ADMIN_CAN_POST',
+    ADMIN_REVIEW_POST_REQUIRED: 'ADMIN_REVIEW_POST_REQUIRED',
+    ANYONE_CAN_POST: 'ANYONE_CAN_POST',
+});
+const CommunityPostSettingMaps = Object.freeze({
+    ONLY_ADMIN_CAN_POST: {
+        needApprovalOnPostCreation: false,
+        onlyAdminCanPost: true,
+    },
+    ADMIN_REVIEW_POST_REQUIRED: {
+        needApprovalOnPostCreation: true,
+        onlyAdminCanPost: false,
+    },
+    ANYONE_CAN_POST: {
+        needApprovalOnPostCreation: false,
+        onlyAdminCanPost: false,
+    },
+});
+const DefaultCommunityPostSetting = 'ONLY_ADMIN_CAN_POST';
+
 const ContentFeedType = Object.freeze({
     STORY: 'story',
-    CHIP: 'clip',
+    CLIP: 'clip',
     CHAT: 'chat',
     POST: 'post',
+    MESSAGE: 'message',
 });
 
 const FileType = Object.freeze({
@@ -257,7 +279,7 @@ const CRITERIAS = {
     channel: ['channelId', 'rateLimit'],
     channelUsers: ['channelId', 'userId', 'membership'],
     message: ['messageId'],
-    community: ['communityId', 'onlyAdminCanPost'],
+    community: ['communityId', 'postSetting'],
     category: ['categoryId'],
     communityUsers: ['userId', 'communityId', 'communityMembership'],
     post: ['postId', 'feedId'],
@@ -21939,6 +21961,33 @@ const updatePost = async (postId, patch) => {
     };
 };
 
+const getMatchPostSetting = (value) => {
+    var _a;
+    return (_a = Object.keys(CommunityPostSettingMaps).find(key => value.needApprovalOnPostCreation ===
+        CommunityPostSettingMaps[key].needApprovalOnPostCreation &&
+        value.onlyAdminCanPost === CommunityPostSettingMaps[key].onlyAdminCanPost)) !== null && _a !== void 0 ? _a : DefaultCommunityPostSetting;
+};
+/*
+ * Unpack community payload by mapping payload field to postSetting value.
+ */
+const unpackCommunityPayload = (_a) => {
+    var { communities } = _a, restPayload = __rest(_a, ["communities"]);
+    return (Object.assign({ communities: communities.map((_a) => {
+            var { needApprovalOnPostCreation, onlyAdminCanPost } = _a, restCommunityPayload = __rest(_a, ["needApprovalOnPostCreation", "onlyAdminCanPost"]);
+            return (Object.assign({ postSetting: getMatchPostSetting({
+                    needApprovalOnPostCreation,
+                    onlyAdminCanPost,
+                }) }, restCommunityPayload));
+        }) }, restPayload));
+};
+/*
+ * Repack community payload by mapping postSetting to the actual value.
+ */
+const packCommunityPayload = (_a) => {
+    var { postSetting = undefined } = _a, restParam = __rest(_a, ["postSetting"]);
+    return (Object.assign(Object.assign({}, restParam), (postSetting ? CommunityPostSettingMaps[postSetting] : undefined)));
+};
+
 /**
  * ```js
  * import { queryCommunities } from '@amityco/ts-sdk'
@@ -21968,10 +22017,11 @@ const queryCommunities = async (query) => {
             } }),
     });
     const { paging } = data, payload = __rest(data, ["paging"]);
-    const { communities } = payload;
+    const unpackedPayload = unpackCommunityPayload(payload);
+    const { communities } = unpackedPayload;
     const cachedAt = client.cache && Date.now();
     if (client.cache) {
-        ingestInCache(payload, { cachedAt });
+        ingestInCache(unpackedPayload, { cachedAt });
         const cacheKey = [
             'community',
             'query',
@@ -22020,9 +22070,10 @@ const getCommunities = async (communityIds) => {
     const client = getActiveClient();
     client.log('community/getCommunities', communityIds);
     // API-FIX: endpoint should not be /list, parameters should be querystring.
-    const { data } = await client.http.get(`/api/v3/communities/list`, {
+    const { data: payload } = await client.http.get(`/api/v3/communities/list`, {
         params: { communityIds },
     });
+    const data = unpackCommunityPayload(payload);
     const cachedAt = client.cache && Date.now();
     if (client.cache)
         ingestInCache(data, { cachedAt });
@@ -22081,7 +22132,8 @@ const getCommunity = async (communityId) => {
     const client = getActiveClient();
     client.log('community/getCommunity', communityId);
     // API-FIX: endpoint should not be /list, parameters should be querystring.
-    const { data } = await client.http.get(`/api/v3/communities/${communityId}`);
+    const { data: payload } = await client.http.get(`/api/v3/communities/${communityId}`);
+    const data = unpackCommunityPayload(payload);
     const cachedAt = client.cache && Date.now();
     if (client.cache)
         ingestInCache(data, { cachedAt });
@@ -22135,7 +22187,8 @@ getCommunity.locally = (communityId) => {
 const createCommunity = async (bundle) => {
     const client = getActiveClient();
     client.log('user/createCommunity', bundle);
-    const { data } = await client.http.post('/api/v3/communities/', bundle);
+    const { data: payload } = await client.http.post('/api/v3/communities/', packCommunityPayload(bundle));
+    const data = unpackCommunityPayload(payload);
     const cachedAt = client.cache && Date.now();
     if (client.cache)
         ingestInCache(data, { cachedAt });
@@ -22165,7 +22218,8 @@ const createCommunity = async (bundle) => {
 const updateCommunity = async (communityId, patch) => {
     const client = getActiveClient();
     client.log('community/updateCommunity', communityId, patch);
-    const { data } = await client.http.put(`/api/v3/communities/${communityId}`, patch);
+    const { data: payload } = await client.http.put(`/api/v3/communities/${communityId}`, packCommunityPayload(patch));
+    const data = unpackCommunityPayload(payload);
     const cachedAt = client.cache && Date.now();
     if (client.cache)
         ingestInCache(data, { cachedAt });
@@ -22431,7 +22485,8 @@ const getTopTrendingCommunities = async (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 { data: payload } = await client.http.get(`/api/v3/communities/top-trending`, { params: { options: { limit } } });
+    const data = unpackCommunityPayload(payload);
     const { communities } = data;
     const cachedAt = client.cache && Date.now();
     if (client.cache) {
@@ -22493,8 +22548,9 @@ const getRecommendedCommunities = async (query) => {
     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 { data: payload } = await client.http.get<Amity.Response<CommunityPayload>>(
+    const { data: payload } = await client.http.get(`/api/v3/communities/recommended`, { params: { options: { limit } } });
+    const data = unpackCommunityPayload(payload);
     const { communities } = data;
     const cachedAt = client.cache && Date.now();
     if (client.cache) {
@@ -24844,6 +24900,125 @@ const observeChannels = (callback) => {
     };
 };
 
+/**
+ * ```js
+ * import { liveChannels } from '@amityco/ts-sdk'
+ *
+ * let channels = []
+ * const unsub = liveChannels({
+ *   displayName: Amity.Channel['displayName'],
+ * }, response => merge(channels, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.Channel}s
+ *
+ * @param params for querying channels
+ * @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 channels
+ *
+ * @category Channel Live Collection
+ */
+const liveChannels = (params, callback, config) => {
+    const { log, cache } = getActiveClient();
+    if (!cache) {
+        console.log(ENABLE_CACHE_MESSAGE);
+    }
+    const timestamp = Date.now();
+    log(`liveChannels(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 = ['channel', 'collection', {}];
+    const responder = (data) => {
+        var _a, _b;
+        let channels = (_a = data.data
+            .map(channelId => pullFromCache(['channel', 'get', channelId]))
+            .filter(Boolean)
+            .map(({ data }) => data)) !== null && _a !== void 0 ? _a : [];
+        channels = filterByPropEquality(channels, 'isDeleted', params.isDeleted);
+        channels = filterByPropEquality(channels, 'displayName', params.displayName);
+        if (params.types) {
+            channels = channels.filter(c => { var _a; return (_a = params.types) === null || _a === void 0 ? void 0 : _a.includes(c.type); });
+        }
+        if (params.tags) {
+            channels = channels.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.excludeTags) {
+            channels = channels.filter(c => { var _a; return !((_a = c.tags) === null || _a === void 0 ? void 0 : _a.some(t => { var _a; return (_a = params.excludeTags) === null || _a === void 0 ? void 0 : _a.includes(t); })); });
+        }
+        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);
+        }
+        callback({
+            onNextPage: onFetch,
+            data: channels,
+            hasNextPage: !!((_b = data.params) === null || _b === void 0 ? void 0 : _b.page),
+            loading: data.loading,
+            error: data.error,
+        });
+    };
+    const realtimeRouter = (channel, action) => {
+        var _a;
+        const collection = (_a = pullFromCache(cacheKey)) === null || _a === void 0 ? void 0 : _a.data;
+        if (!collection)
+            return;
+        if (action === 'onCreate') {
+            collection.data = [...new Set([channel.channelId, ...collection.data])];
+            /*
+             * if the filter isDeleted is set, only collection item must be updated and not
+             * the collection
+             */
+        }
+        else if (action === 'onDelete' && !params.isDeleted) {
+            collection.data = collection.data.filter(c => c !== channel.channelId);
+        }
+        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 channels = (_b = collection === null || collection === void 0 ? void 0 : collection.data) !== null && _b !== void 0 ? _b : [];
+        if (channels.length > 0 && !(collection === null || collection === void 0 ? void 0 : collection.params.page))
+            return;
+        const query = createQuery(queryChannels, 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: channels,
+            };
+            if (result) {
+                data.data = [...new Set([...channels, ...result.map(getResolver('channel'))])];
+            }
+            pushToCache(cacheKey, data);
+            responder(data);
+        }, queryOptions(policy));
+    };
+    disposers.push(onChannelCreated(channel => realtimeRouter(channel, 'onCreate')), onChannelDeleted(channel => realtimeRouter(channel, 'onDelete')), onChannelUpdated(channel => realtimeRouter(channel, 'onUpdate')));
+    onFetch();
+    return () => {
+        log(`liveChannels(tmpid: ${timestamp}) > dispose`);
+        disposers.forEach(fn => fn());
+    };
+};
+
 /**
  * ```js
  * import { onMessageCreated } from '@amityco/ts-sdk'
@@ -25098,16 +25273,17 @@ const liveMessages = (params, callback, config) => {
 const createCommunityEventSubscriber = (event, callback) => {
     const client = getActiveClient();
     const filter = (payload) => {
+        const unpackedPayload = unpackCommunityPayload(payload);
         if (!client.cache) {
             // TODO: here we are missing specific properties here!
-            callback(payload.communities[0]);
+            callback(unpackedPayload.communities[0]);
         }
         else {
-            ingestInCache(payload);
+            ingestInCache(unpackedPayload);
             const community = pullFromCache([
                 'community',
                 'get',
-                payload.communities[0].communityId,
+                unpackedPayload.communities[0].communityId,
             ]);
             callback(community.data);
         }
@@ -25143,21 +25319,22 @@ function getEventRelatedMember(event, payload) {
 const createCommunityMemberEventSubscriber = (event, callback) => {
     const client = getActiveClient();
     const filter = (payload) => {
+        const unpackedPayload = unpackCommunityPayload(payload);
         if (!client.cache) {
             // TODO: here we are missing specific properties here!
-            callback(payload.communities[0], getEventRelatedMember(event, payload));
+            callback(unpackedPayload.communities[0], getEventRelatedMember(event, unpackedPayload));
         }
         else {
-            ingestInCache(payload);
+            ingestInCache(unpackedPayload);
             const community = pullFromCache([
                 'community',
                 'get',
-                payload.communities[0].communityId,
+                unpackedPayload.communities[0].communityId,
             ]);
             const member = pullFromCache([
                 'communityUsers',
                 'get',
-                getResolver('communityUsers')(getEventRelatedMember(event, payload)),
+                getResolver('communityUsers')(getEventRelatedMember(event, unpackedPayload)),
             ]);
             callback(community.data, member.data);
         }
@@ -26185,7 +26362,7 @@ const liveFollowers = (params, callback, config) => {
             .map(key => pullFromCache(['follow', 'get', key]))
             .filter(Boolean)
             .map(({ data }) => data)) !== null && _a !== void 0 ? _a : [];
-        if (params.status) {
+        if (params.status && params.status !== 'all') {
             followers = filterByPropEquality(followers, 'status', params.status);
         }
         callback({
@@ -26275,7 +26452,7 @@ const liveFollowings = (params, callback, config) => {
             .map(key => pullFromCache(['follow', 'get', key]))
             .filter(Boolean)
             .map(({ data }) => data)) !== null && _a !== void 0 ? _a : [];
-        if (params.status) {
+        if (params.status && params.status !== 'all') {
             followings = filterByPropEquality(followings, 'status', params.status);
         }
         callback({
@@ -27276,7 +27453,10 @@ const createUserToken = async (apiKey, apiRegion, params) => {
 };
 
 exports.API_REGIONS = API_REGIONS;
+exports.CommunityPostSettingMaps = CommunityPostSettingMaps;
+exports.CommunityPostSettings = CommunityPostSettings;
 exports.ContentFeedType = ContentFeedType;
+exports.DefaultCommunityPostSetting = DefaultCommunityPostSetting;
 exports.FileType = FileType;
 exports.VERSION = VERSION$1;
 exports.VideoResolution = VideoResolution;
@@ -27371,6 +27551,7 @@ exports.joinChannel = joinChannel;
 exports.joinCommunity = joinCommunity;
 exports.leaveChannel = leaveChannel;
 exports.leaveCommunity = leaveCommunity;
+exports.liveChannels = liveChannels;
 exports.liveComments = liveComments;
 exports.liveFollowers = liveFollowers;
 exports.liveFollowings = liveFollowings;