@amityco/ts-sdk 0.0.1-beta.20 → 0.0.1-beta.23

package/dist/index.cjs.js

@@ -9,6 +9,7 @@ var debug = require('debug');
 var axios = require('axios');
 var HttpAgent = require('agentkeepalive');
 var io = require('socket.io-client');
+var nativeIdGenerator = require('react-native-uuid');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -18,6 +19,7 @@ var debug__default = /*#__PURE__*/_interopDefaultLegacy(debug);
 var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
 var HttpAgent__default = /*#__PURE__*/_interopDefaultLegacy(HttpAgent);
 var io__default = /*#__PURE__*/_interopDefaultLegacy(io);
+var nativeIdGenerator__default = /*#__PURE__*/_interopDefaultLegacy(nativeIdGenerator);
 
 var _a$1;
 /* eslint-disable no-undef */
@@ -98,19 +100,19 @@ const toToken = (paging, style) => {
           "before" or "after" value. if that would change,
           we'd need to move toward a more simple: `!paging.before`
         */
-        if (!Number.isNaN(paging === null || paging === void 0 ? void 0 : paging.before)) {
+        if (!Number.isNaN(Number(paging === null || paging === void 0 ? void 0 : paging.before))) {
             payload = {
                 before: paging.before,
                 last: paging.limit,
             };
         }
-        else if (!Number.isNaN(paging === null || paging === void 0 ? void 0 : paging.after)) {
+        else if (!Number.isNaN(Number(paging === null || paging === void 0 ? void 0 : paging.after))) {
             payload = {
                 after: paging.after,
                 first: paging.limit,
             };
         }
-        else if (!Number.isNaN(paging === null || paging === void 0 ? void 0 : paging.limit)) {
+        else if (!Number.isNaN(Number(paging === null || paging === void 0 ? void 0 : paging.limit))) {
             payload = {
                 last: paging.limit,
             };
@@ -179,6 +181,121 @@ const toPageRaw = (token) => {
     return undefined;
 };
 
+/** @hidden */
+const idResolvers = {
+    user: ({ userId }) => userId,
+    file: ({ fileId }) => fileId,
+    role: ({ roleId }) => roleId,
+    channel: ({ channelId }) => channelId,
+    channelUsers: ({ channelId, userId }) => `${channelId}#${userId}`,
+    message: ({ messageId }) => messageId,
+    community: ({ communityId }) => communityId,
+    category: ({ categoryId }) => categoryId,
+    communityUsers: ({ communityId, userId }) => `${communityId}#${userId}`,
+    post: ({ postId }) => postId,
+    comment: ({ commentId }) => commentId,
+    poll: ({ pollId }) => pollId,
+    reaction: ({ reactionId }) => reactionId,
+    stream: ({ streamId }) => streamId,
+    follow: ({ from, to }) => `${from}#${to}`,
+    followCount: ({ userId }) => userId,
+};
+/**
+ * Retrieve the id resolver matching a domain name
+ *
+ * @param name the domain name for the resolve
+ * @returns an idResolver function for the given domain name
+ */
+const getResolver = (name) => idResolvers[name];
+
+/**
+ * Identification criterias
+ *
+ * As key, the name of the identified model ;
+ * As value, the list of properties to consider a given model as of type
+ *
+ * Used as source of truth for {@link identifyModel}
+ *
+ * @hidden
+ */
+const CRITERIAS = {
+    file: ['fileId', 'attributes'],
+    user: ['userId', 'avatarFileId'],
+    role: ['roleId'],
+    channel: ['channelId', 'rateLimit'],
+    channelUsers: ['channelId', 'userId', 'membership'],
+    message: ['messageId'],
+    community: ['communityId', 'onlyAdminCanPost'],
+    category: ['categoryId'],
+    communityUsers: ['userId', 'communityId', 'communityMembership'],
+    post: ['postId', 'feedId'],
+    comment: ['commentId', 'referenceId'],
+    poll: ['pollId'],
+    reaction: ['reactionId'],
+    stream: ['streamId'],
+    follow: ['from', 'to'],
+    followCount: ['userId', 'followerCount'],
+};
+/** @hidden */
+const hasKeys = (object, needles) => {
+    const haystack = Object.keys(object);
+    return needles.every(needle => haystack.includes(needle));
+};
+/**
+ * Finds the name of the store for a given unknown model
+ *
+ * @param model one of the {@link Amity.Model} to identify
+ * @returns the name of the corresponding store
+ */
+const identifyModel = (model) => {
+    var _a;
+    // we cannot avoid "as" in here because Object.entries does not
+    // allow anything else than "string" as key in the iterator type
+    const criterias = Object.entries(CRITERIAS);
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    return (_a = criterias.find(([_, keys]) => hasKeys(model, keys))) === null || _a === void 0 ? void 0 : _a[0];
+};
+/*
+ * Identify the modal key for a model
+ * Used to get args for optimistic updates
+ * Example: createMessage: get messageId on optimistic message creation
+ *
+ * @param model to be recognized
+ * @returns model key array if one if found or undefined
+ */
+const identifyModelKey = (model) => {
+    var _a;
+    const modalKey = identifyModel(model);
+    if (!modalKey) {
+        return undefined;
+    }
+    return (_a = CRITERIAS[modalKey]) === null || _a === void 0 ? void 0 : _a[0];
+};
+
+/**
+ * A map of v3 response keys to a store name.
+ * @hidden
+ */
+const PAYLOAD2MODEL = {
+    users: 'user',
+    files: 'file',
+    roles: 'role',
+    channels: 'channel',
+    channelUsers: 'channelUsers',
+    messages: 'message',
+    communities: 'community',
+    categories: 'category',
+    communityUsers: 'communityUsers',
+    posts: 'post',
+    postChildren: 'post',
+    comments: 'comment',
+    polls: 'poll',
+    reactions: 'reaction',
+    videoStreamings: 'stream',
+    follows: 'follow',
+    followCounts: 'followCount',
+};
+
 /* eslint-disable no-use-before-define */
 /**
  * Type guard to check and cast that a given async function is has the ".locally" property
@@ -323,7 +440,23 @@ const runQuery = ({ func, args }, callback, options = queryOptions('cache_then_s
             loading: true,
         }));
     }
-    func(...args)
+    let optimisticArgs = args;
+    /* get args for optimistic method calls
+     *
+     * On optimistic updates, the modal key for the update needs to be passed to
+     * the server so as to avoid duplicate modal creation
+     *
+     * ex: on creating a new message pass the modalKey is messageId, pass this
+     * id onto the server so that a duplicate with seperate messageId is not
+     * created.
+     */
+    if (isMutator(func)) {
+        // @ts-ignore
+        const modelKey = local && local.data && identifyModelKey(local.data);
+        // @ts-ignore
+        optimisticArgs = modelKey ? [Object.assign(Object.assign({}, args[0]), { [modelKey]: local.data[modelKey] })] : args;
+    }
+    func(...optimisticArgs)
         .then(fresh => {
         // @ts-ignore i know.
         // isLocal(local) && syncInCache(local, fresh)
@@ -20216,57 +20349,6 @@ const onClientBanned = (callback) => {
     });
 };
 
-/** @hidden */
-const idResolvers = {
-    user: ({ userId }) => userId,
-    file: ({ fileId }) => fileId,
-    role: ({ roleId }) => roleId,
-    channel: ({ channelId }) => channelId,
-    channelUsers: ({ channelId, userId }) => `${channelId}#${userId}`,
-    message: ({ messageId }) => messageId,
-    community: ({ communityId }) => communityId,
-    category: ({ categoryId }) => categoryId,
-    communityUsers: ({ communityId, userId }) => `${communityId}#${userId}`,
-    post: ({ postId }) => postId,
-    comment: ({ commentId }) => commentId,
-    poll: ({ pollId }) => pollId,
-    reaction: ({ reactionId }) => reactionId,
-    stream: ({ streamId }) => streamId,
-    follow: ({ from, to }) => `${from}#${to}`,
-    followCount: ({ userId }) => userId,
-};
-/**
- * Retrieve the id resolver matching a domain name
- *
- * @param name the domain name for the resolve
- * @returns an idResolver function for the given domain name
- */
-const getResolver = (name) => idResolvers[name];
-
-/**
- * A map of v3 response keys to a store name.
- * @hidden
- */
-const PAYLOAD2MODEL = {
-    users: 'user',
-    files: 'file',
-    roles: 'role',
-    channels: 'channel',
-    channelUsers: 'channelUsers',
-    messages: 'message',
-    communities: 'community',
-    categories: 'category',
-    communityUsers: 'communityUsers',
-    posts: 'post',
-    postChildren: 'post',
-    comments: 'comment',
-    polls: 'poll',
-    reactions: 'reaction',
-    videoStreamings: 'stream',
-    follows: 'follow',
-    followCounts: 'followCount',
-};
-
 /**
  * Ingest a payload (v3) into the cache
  *
@@ -20340,7 +20422,7 @@ const onUserDeleted = (callback) => createUserEventSubscriber('user.deleted', ca
  * @category Client API
  * @async
  */
-const connectClient = async (params) => {
+const connectClient = async (params, config) => {
     var _a;
     const client = getActiveClient();
     client.log('client/api/connectClient', Object.assign({ apiKey: client.apiKey }, params));
@@ -20365,7 +20447,9 @@ const connectClient = async (params) => {
     client.userId = params.userId;
     client.accessToken = accessToken;
     setActiveUser(users[0]);
-    subscribeTopic(getNetworkTopic());
+    if ((config === null || config === void 0 ? void 0 : config.disableRTE) !== true) {
+        subscribeTopic(getNetworkTopic());
+    }
     const subscriptions = [
         onClientBanned(() => {
             disconnectClient();
@@ -21311,6 +21395,8 @@ queryMessages.locally = (query) => {
         : undefined;
 };
 
+const uuid = () => nativeIdGenerator__default["default"].v4().toString();
+
 /**
  * ```js
  * import { createMessage } from '@amityco/ts-sdk'
@@ -21361,12 +21447,20 @@ const createMessage = async (bundle) => {
 createMessage.optimistically = (bundle) => {
     var _a, _b;
     const client = getActiveClient();
-    client.log('user/createMessage.locally', bundle);
     if (!client.cache)
         return;
-    const channel = pullFromCache(['channel', 'get', bundle.channelId]);
-    upsertInCache(['channel', 'get', bundle.channelId], Object.assign(Object.assign({}, channel === null || channel === void 0 ? void 0 : channel.data), { messageCount: ((_a = channel === null || channel === void 0 ? void 0 : channel.data.messageCount) !== null && _a !== void 0 ? _a : 0) + 1 }));
-    const message = Object.assign({ messageId: Math.random().toString(16), userId: client.userId, channelSegment: ((_b = channel === null || channel === void 0 ? void 0 : channel.data.messageCount) !== null && _b !== void 0 ? _b : 0) + 1, createdAt: new Date().toISOString() }, bundle);
+    /*
+     * when creating messages optimistically a messageId needs to be added by the
+     * client, created a new variable so as to allow backward compatibility of API
+     */
+    const bundleWithMessageId = Object.assign(Object.assign({}, bundle), { messageId: uuid() });
+    // only log if cache is enabled
+    client.log('user/createMessage.locally', bundleWithMessageId);
+    const channel = pullFromCache(['channel', 'get', bundleWithMessageId.channelId]);
+    upsertInCache(['channel', 'get', bundleWithMessageId.channelId], Object.assign(Object.assign({}, channel === null || channel === void 0 ? void 0 : channel.data), { messageCount: ((_a = channel === null || channel === void 0 ? void 0 : channel.data.messageCount) !== null && _a !== void 0 ? _a : 0) + 1 }));
+    // as reused to update created and updated time, which should be the same
+    const createdTime = new Date().toISOString();
+    const message = Object.assign({ userId: client.userId, channelSegment: ((_b = channel === null || channel === void 0 ? void 0 : channel.data.messageCount) !== null && _b !== void 0 ? _b : 0) + 1, createdAt: createdTime, updatedAt: createdTime }, bundleWithMessageId);
     pushToCache(['message', 'get', message.messageId], message, { cachedAt: -1 });
     fireEvent('v3.message.didCreate', { messages: [message] });
     return {
@@ -22427,6 +22521,10 @@ const queryComments = async (query) => {
     const client = getActiveClient();
     client.log('comment/queryComments', query);
     const { page = { limit: 10 } } = query, params = __rest(query, ["page"]);
+    const options = {
+        type: params.sortBy ? 'pagination' : undefined,
+        token: toToken(page, params.sortBy ? 'skiplimit' : 'afterbefore'),
+    };
     // const filterByParentId = query.parentId !== undefined
     // API-FIX: parameters should be querystring. (1)
     // API-FIX: backend should answer Amity.Response (2)
@@ -22434,9 +22532,7 @@ const queryComments = async (query) => {
     const { data } = await client.http.get(`/api/v3/comments`, {
         params: Object.assign(Object.assign({}, params), { 
             //      filterByParentId, API-FIX: backend does not support this boolean LOL. what the hell seriously.
-            options: {
-                token: toToken(page, 'afterbefore'),
-            } }),
+            options }),
     });
     // API-FIX: backend should answer Amity.Response (2)
     // const { paging, comments } = unwrapPayload(data)
@@ -22771,6 +22867,38 @@ const preparePayloadForCache = (event, payload) => {
     }
 };
 
+/** @hidden */
+/*
+ * @param message payload from http request without myReactions
+ * add myReactions to http response if the event was a reaction event
+ */
+const prepareMessagePayloadForCache = (payload) => {
+    const client = getActiveClient();
+    const cached = pullFromCache(['message', 'get', payload.messageId]);
+    // '[]' in cases where the new reaction is the first one
+    const myReactions = (cached === null || cached === void 0 ? void 0 : cached.data.myReactions) || [];
+    // add myReactions to the payload
+    Object.assign(payload, { myReactions });
+    // check if there are any updates to the reactions
+    const latestReaction = payload === null || payload === void 0 ? void 0 : payload.latestReaction;
+    const isLatestReactionMine = latestReaction && latestReaction.userId === client.userId;
+    if (!isLatestReactionMine) {
+        return;
+    }
+    // new reaction added
+    if (latestReaction.eventName === 'add' && !myReactions.includes(latestReaction.reactionName)) {
+        Object.assign(payload, {
+            myReactions: [...myReactions, latestReaction.reactionName],
+        });
+    }
+    // existing reaction removed
+    if (latestReaction.eventName === 'remove' && myReactions.includes(latestReaction.reactionName)) {
+        Object.assign(payload, {
+            myReactions: myReactions.filter(x => x !== latestReaction.reactionName),
+        });
+    }
+};
+
 /**
  * ```js
  * import { addReaction } from '@amityco/ts-sdk'
@@ -23819,9 +23947,9 @@ const leaveChannel = async (channelId) => {
 const queryChannelMembers = async (query) => {
     const client = getActiveClient();
     client.log('channel/queryChannelMembers', query);
-    const _a = query !== null && query !== void 0 ? query : {}, { page, channelId, membership } = _a, params = __rest(_a, ["page", "channelId", "membership"]);
-    const { data } = await client.http.get(`/api/v3/channels/${encodeURIComponent(channelId)}/users`, {
-        params: Object.assign(Object.assign({}, params), { filter: membership, options: {
+    const _a = query !== null && query !== void 0 ? query : {}, { page, channelId } = _a, params = __rest(_a, ["page", "channelId"]);
+    const { data } = await client.http.get(`/api/v4/channels/${encodeURIComponent(channelId)}/users`, {
+        params: Object.assign(Object.assign({}, params), { options: {
                 token: toToken(page, 'skiplimit'),
             } }),
     });
@@ -23877,6 +24005,7 @@ const addChannelMembers = async (channelId, userIds) => {
         ingestInCache(data);
     fireEvent('v3.channel.didAddUsers', {
         channels: data.channels,
+        channelUsers: data.channelUsers,
     });
     const { channelUsers } = data;
     return !!channelUsers.find(channelUser => channelUser.channelId === channelId && channelUser.membership === 'member');
@@ -23905,6 +24034,7 @@ const removeChannelMembers = async (channelId, userIds) => {
         ingestInCache(data);
     fireEvent('v3.channel.didRemoveUsers', {
         channels: data.channels,
+        channelUsers: data.channelUsers,
     });
     const { channelUsers } = data;
     return !!channelUsers.find(channelUser => channelUser.channelId === channelId && channelUser.membership !== 'member');
@@ -24060,8 +24190,8 @@ const onChannelLeft = (callback) => {
 
 /**
  * ```js
- * import { onMemberAdded } from '@amityco/ts-sdk'
- * const dispose = onMemberAdded(channel => {
+ * import { onChannelMemberAdded } from '@amityco/ts-sdk'
+ * const dispose = onChannelMemberAdded((channel, member) => {
  *   // ...
  * })
  * ```
@@ -24073,19 +24203,19 @@ const onChannelLeft = (callback) => {
  *
  * @category Channel Events
  */
-const onMemberAdded = (callback) => {
+const onChannelMemberAdded = (callback) => {
     const client = getActiveClient();
     const filter = (payload) => {
         ingestInCache(payload);
-        callback(payload.channels[0]);
+        callback(payload.channels[0], payload.channelUsers[0]);
     };
-    return createEventSubscriber(client, 'onMemberAdded', 'v3.channel.didAddUsers', filter);
+    return createEventSubscriber(client, 'onChannelMemberAdded', 'v3.channel.didAddUsers', filter);
 };
 
 /**
  * ```js
- * import { onMemberRemoved } from '@amityco/ts-sdk'
- * const dispose = onMemberRemoved(channel => {
+ * import { onChannelMemberRemoved } from '@amityco/ts-sdk'
+ * const dispose = onChannelMemberRemoved((channel, member) => {
  *   // ...
  * })
  * ```
@@ -24097,13 +24227,13 @@ const onMemberAdded = (callback) => {
  *
  * @category Channel Events
  */
-const onMemberRemoved = (callback) => {
+const onChannelMemberRemoved = (callback) => {
     const client = getActiveClient();
     const filter = (payload) => {
         ingestInCache(payload);
-        callback(payload.channels[0]);
+        callback(payload.channels[0], payload.channelUsers[0]);
     };
-    return createEventSubscriber(client, 'onMemberRemoved', 'v3.channel.didRemoveUsers', filter);
+    return createEventSubscriber(client, 'onChannelMemberRemoved', 'v3.channel.didRemoveUsers', filter);
 };
 
 /**
@@ -24139,7 +24269,7 @@ const observeChannel = (channelId, callback) => {
         (_c = callback[action]) === null || _c === void 0 ? void 0 : _c.call(callback, result);
     };
     const disposers = [];
-    disposers.push(onChannelUpdated(data => router({ data, loading: false, origin: 'event' }, 'onUpdate')), onChannelDeleted(data => router({ data, loading: false, origin: 'event' }, 'onDelete')), onChannelJoined(data => router({ data, loading: false, origin: 'event' }, 'onJoin')), onChannelLeft(data => router({ data, loading: false, origin: 'event' }, 'onLeft')), onMemberAdded(data => router({ data, loading: false, origin: 'event' }, 'onMemberAdded')), onMemberRemoved(data => router({ data, loading: false, origin: 'event' }, 'onMemberRemoved')));
+    disposers.push(onChannelUpdated(data => router({ data, loading: false, origin: 'event' }, 'onUpdate')), onChannelDeleted(data => router({ data, loading: false, origin: 'event' }, 'onDelete')), onChannelJoined(data => router({ data, loading: false, origin: 'event' }, 'onJoin')), onChannelLeft(data => router({ data, loading: false, origin: 'event' }, 'onLeft')), onChannelMemberAdded(data => router({ data, loading: false, origin: 'event' }, 'onMemberAdded')), onChannelMemberRemoved(data => router({ data, loading: false, origin: 'event' }, 'onMemberRemoved')));
     runQuery(createQuery(getChannel, channelId), result => result.data && router(result, 'onFetch'));
     return () => {
         log(`observeChannel(tmpid: ${timestamp}) > dispose`);
@@ -24190,7 +24320,12 @@ const onMessageUpdated = (callback) => {
     const client = getActiveClient();
     const filter = (payload) => {
         ingestInCache(payload);
-        callback(payload.messages[0]);
+        const message = payload.messages[0];
+        // if payload does not have myReactions
+        if (!(message === null || message === void 0 ? void 0 : message.myReactions)) {
+            prepareMessagePayloadForCache(message);
+        }
+        callback(message);
     };
     return createEventSubscriber(client, 'message/onMessageUpdated', 'v3.message.didUpdate', filter);
 };
@@ -26107,6 +26242,8 @@ exports.observeUser = observeUser;
 exports.onChannelDeleted = onChannelDeleted;
 exports.onChannelJoined = onChannelJoined;
 exports.onChannelLeft = onChannelLeft;
+exports.onChannelMemberAdded = onChannelMemberAdded;
+exports.onChannelMemberRemoved = onChannelMemberRemoved;
 exports.onChannelUpdated = onChannelUpdated;
 exports.onClientBanned = onClientBanned;
 exports.onClientDisconnected = onClientDisconnected;
@@ -26133,8 +26270,6 @@ exports.onFollowRequestCanceled = onFollowRequestCanceled;
 exports.onFollowRequestDeclined = onFollowRequestDeclined;
 exports.onFollowerDeleted = onFollowerDeleted;
 exports.onFollowerRequested = onFollowerRequested;
-exports.onMemberAdded = onMemberAdded;
-exports.onMemberRemoved = onMemberRemoved;
 exports.onMessageCreated = onMessageCreated;
 exports.onMessageDeleted = onMessageDeleted;
 exports.onMessageUpdated = onMessageUpdated;