@amityco/ts-sdk 0.0.1-beta.12 → 0.0.1-beta.15

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.12-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
@@ -158,35 +161,6 @@ const toPageRaw = (token) => {
         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;
 };
 
 /**
@@ -500,7 +474,7 @@ const setActiveClient = (client) => {
  */
 const createLogger = (session) => {
     const active = (`${session === null || session === void 0 ? void 0 : session.trim()}`.length > 0
-        && process.env.NODE_ENV !== 'production');
+        && !isProduction);
     const logger = debug(session);
     const print = (topic, ...args) => {
         active && logger(topic, args);
@@ -509,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)
@@ -14727,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',
@@ -14817,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); });
 };
 
 /**
@@ -14829,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}`,
@@ -14891,13 +14880,11 @@ const disconnectClient = async () => {
     client.ws.removeAllListeners();
     client.mqtt.removeAllListeners();
     client.userId = undefined;
-    client.user = undefined;
     client.accessToken = undefined;
     return !client.ws.connected;
 };
 
 // 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';
@@ -15076,7 +15063,7 @@ const connectClient = async (params) => {
         unsubscribe();
     });
     client.userId = params.userId;
-    client.user = users[0];
+    client._internalUserId = users[0]._id;
     client.accessToken = accessToken;
     return client.ws.connected;
 };
@@ -15138,11 +15125,11 @@ const getCommentTopic = ({ path }) => {
 let mqttAccessToken;
 let mqttUserId;
 function subscribeTopic(topic, callback) {
-    const { mqtt, emitter, accessToken, user } = getActiveClient();
-    if (mqttAccessToken !== accessToken || mqttUserId !== user._id) {
+    const { mqtt, emitter, accessToken, _internalUserId } = getActiveClient();
+    if (mqttAccessToken !== accessToken || mqttUserId !== _internalUserId) {
         mqttAccessToken = accessToken;
-        mqttUserId = user._id;
-        mqtt.connect({ accessToken: accessToken, userId: user._id });
+        mqttUserId = _internalUserId;
+        mqtt.connect({ accessToken: mqttAccessToken, userId: mqttUserId });
         proxyMqttEvents(mqtt, emitter);
     }
     return mqtt.subscribe(topic, callback);
@@ -16636,11 +16623,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'),
             } }), });
@@ -16842,9 +16829,9 @@ const createPost = async (bundle) => {
     const client = getActiveClient();
     client.log('post/createPost', bundle);
     // API-FIX: backend rejects that we pass the dataType manually T_T
-    if (!bundle.dataType || ['text', 'image', 'file'].includes(bundle.dataType))
+    if (!bundle.dataType || ['text', 'image', 'file', 'video'].includes(bundle.dataType))
         delete bundle.dataType;
-    const { data } = await client.http.post('/api/v3/posts', bundle);
+    const { data } = await client.http.post('/api/v4/posts', bundle);
     const cachedAt = client.cache && Date.now();
     if (client.cache)
         ingestInCache(data, { cachedAt });
@@ -16876,7 +16863,7 @@ const createPost = async (bundle) => {
 const updatePost = async (postId, patch) => {
     const client = getActiveClient();
     client.log('user/updatePost', patch);
-    const { data } = await client.http.put(`/api/v3/posts/${encodeURIComponent(postId)}`, patch);
+    const { data } = await client.http.put(`/api/v4/posts/${encodeURIComponent(postId)}`, patch);
     const cachedAt = client.cache && Date.now();
     if (client.cache)
         ingestInCache(data, { cachedAt });
@@ -17227,7 +17214,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
@@ -18745,12 +18732,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 +19483,56 @@ 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, prevPage, nextPage };
+    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;
 };
 
 /**
@@ -19966,4 +19993,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, 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, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByLastActivity, sortByLastCreated, sortBySegmentNumber, subscribeTopic, toPage, toPageRaw, toToken, updateChannel, updateComment, updateCommunity, updateMessage, updatePost, updateStream, updateUser, upsertInCache, wipeCache };