@amityco/ts-sdk 6.30.5-b3b15ee.0 → 6.31.0

package/dist/index.esm.js

@@ -87,8 +87,8 @@ const PostContentType = Object.freeze({
 
 function getVersion() {
     try {
-        // the string ''v6.30.4-esm'' should be replaced by actual value by @rollup/plugin-replace
-        return 'v6.30.4-esm';
+        // the string ''v6.31.0-esm'' should be replaced by actual value by @rollup/plugin-replace
+        return 'v6.31.0-esm';
     }
     catch (error) {
         return '__dev__';
@@ -536,6 +536,18 @@ const idResolvers = {
  */
 const getResolver = (name) => idResolvers[name];
 
+/*
+ * To check if an id is a local referenceId, the id must start with 'LOCAL_'.
+ *
+ * Example: LOCAL_155f5158-281a-4a9d-a445-9243138d2041
+ *
+ * @param id as string
+ * @returns true if the id is a local referenceId, false otherwise
+ */
+const isLocalId = (id) => {
+    return id.startsWith('LOCAL_');
+};
+
 /**
  * A map of v3 response keys to a store name.
  * @hidden
@@ -22880,21 +22892,26 @@ function convertFromRaw$1(_a) {
         } }, rest), { channelId: channelPublicId, creatorId: creatorPublicId, displayName: name, lastActivity: lastMessageTimestamp, latestMessageId: lastMessageId, messageCount: childCount, subChannelId: messageFeedId, isUnreadCountSupport: isUnreadCountSupport$1({ channelType }) });
 }
 
-const mergePayloadWithLocal = (payload) => {
-    var _a, _b, _c;
-    const localMessage = (_b = (_a = queryCache(['message', 'get'])) === null || _a === void 0 ? void 0 : _a.find(({ data }) => data.messageId === payload.messageId)) === null || _b === void 0 ? void 0 : _b.data;
-    if (localMessage) {
-        return Object.assign(Object.assign(Object.assign({}, localMessage), payload), { 
-            // NOTE: referenceId is missing in the payload. If we have local message data with referenceId, use it instead.
-            // TODO: Remove this logic when BE fixes the payload
-            referenceId: (_c = localMessage.referenceId) !== null && _c !== void 0 ? _c : payload.referenceId });
-    }
-    return payload;
+const addLocalReferenceId = (payload) => {
+    const client = getActiveClient();
+    const { objectSyncMap } = client;
+    return Object.assign(Object.assign({}, payload), { 
+        /* NOTE: This logic is used to get local referenceId for each message.
+         *
+         * if messageId is a local reference id, use it as referenceId else get referenceId from objectSyncMap.
+         * if find referenceId in objectSyncMap, this means this message is a local created message. The referenceId will be local reference id.
+         * if cannot find referenceId in objectSyncMap, referenceId will be undefined.
+         *
+         * The referenceId is undefined means this message is not a local created message (optimistic creation message).
+         */
+        referenceId: isLocalId(payload.messageId)
+            ? payload.messageId
+            : objectSyncMap.get(payload.messageId) });
 };
 function convertFromRaw(message, reactors, event) {
     var _a;
-    const mergeMessage = mergePayloadWithLocal(message);
-    const { channelPublicId, childCount, creatorPublicId, mentionedUsers, messageFeedId, myReactions, reactionCount, reactions, referenceId, segment, messageId, creatorId } = mergeMessage, rest = __rest(mergeMessage, ["channelPublicId", "childCount", "creatorPublicId", "mentionedUsers", "messageFeedId", "myReactions", "reactionCount", "reactions", "referenceId", "segment", "messageId", "creatorId"]);
+    const messageWithReferenceId = addLocalReferenceId(message);
+    const { channelPublicId, childCount, creatorPublicId, mentionedUsers, messageFeedId, myReactions, reactionCount, reactions, referenceId, segment, messageId, creatorId } = messageWithReferenceId, rest = __rest(messageWithReferenceId, ["channelPublicId", "childCount", "creatorPublicId", "mentionedUsers", "messageFeedId", "myReactions", "reactionCount", "reactions", "referenceId", "segment", "messageId", "creatorId"]);
     let cache;
     if (referenceId) {
         cache = pullFromCache(['message', 'get', referenceId]);
@@ -24681,6 +24698,42 @@ const updateSubChannelUnreadFromMessage = (message) => {
     pushToCache(cacheKeyUnreadCount, updatedCachedUnreadCount);
 };
 
+/*
+ * To get message identifier ids used as a cache key for the each message.
+ * These ids are used to store in the query stream and use to get messages from cache.
+ *
+ * The query stream data keeps the message identifier ids as follows:
+ * ['server_message_id_1', 'server_message_id_2', 'LOCAL_message_id_1', 'LOCAL_message_id_2']
+ *
+ * Example use case: Message created locally and then created on the server.
+ *
+ * 1. Message created locally has `LOCAL_message_id_2` as referenceId.
+ * 2. The `message.created` event will be fired from server with message payload that has no the referenceId.
+ * 3. SDK use this function to find indentifer id for each message in the payload. If the message is created locally, the identifier id will be the local reference id.
+ * 4. The SDK use this identifier ids to check if the message is already in the query stream before appending it.
+ *
+ * @param The raw message payload from server response
+ * @returns The identifier ids of the messages
+ */
+function getMessageIdentifierIds(messages) {
+    const client = getActiveClient();
+    const { objectSyncMap } = client;
+    return messages
+        .map(message => {
+        var _a;
+        /* NOTE: This logic is used to get identifier id for each message.
+         *
+         * if messageId is a local id, use it as identifier id else get identifier id from objectSyncMap.
+         * if find referenceId in objectSyncMap, this means this message is a local created message. The identifier id will be local message id.
+         * if cannot find identifier id in objectSyncMap, this means this message is not a local created message. The identifier id will be server message id.
+         */
+        if (isLocalId(message.messageId))
+            return message.messageId;
+        return (_a = objectSyncMap.get(message.messageId)) !== null && _a !== void 0 ? _a : message.messageId;
+    })
+        .filter(Boolean);
+}
+
 /**
  * ```js
  * import { onMessageCreated } from '@amityco/ts-sdk'
@@ -25381,6 +25434,7 @@ const createClient = (apiKey, apiRegion = API_REGIONS.SG, { debugSession = DEFAU
     const sessionState = "notLoggedIn" /* Amity.SessionStates.NOT_LOGGED_IN */;
     const sessionHandler = undefined;
     const isUnreadCountEnabled = false;
+    const objectSyncMap = new Map();
     const client = {
         version: `${VERSION}`,
         apiKey,
@@ -25411,6 +25465,29 @@ const createClient = (apiKey, apiRegion = API_REGIONS.SG, { debugSession = DEFAU
         use: () => setActiveClient(client),
         isUnreadCountEnabled,
         getMarkerSyncConsistentMode,
+        /*
+         * The objectSyncMap is used to keep the map between local referenceId and server id in two ways mapping.
+         *
+         * For objects created locally (optimistic creation), the SDK stores them with their local ID as the cache key, which is used throughout the entire SDK session (in-memory) for syncing updates.
+         * If the payload or response only contains the remote ID of the same object, the SDK will look up the corresponding local ID to retrieve the object through ObjectSyncMap.
+         *
+         * This is useful for syncing updates to the object, as the SDK can find the local ID from the server ID and update the object in the cache correctly.
+         *
+         * Example:
+         * In the case of message optimistically creation. The referenceId is created locally.
+         *
+         * 1. When creating a message optimistically, a local referenceId is created. The objectSyncMap will have the following structure.
+         * {
+         *   "LOCAL_uuid": undefined,
+         * }
+         *
+         * 2. After the message was created on the server and SDK received the response from server, the objectSyncMap will be updated to
+         * {
+         *  "LOCAL_uuid": "server_message_id",
+         *  "server_message_id": "LOCAL_uuid"
+         * }
+         */
+        objectSyncMap,
     };
     try {
         const activeClient = getActiveClient();
@@ -30990,12 +31067,24 @@ const unmuteChannel = async (channelId) => {
 /* end_public_function */
 
 const convertEventPayload = (eventHandler, sourceModelProp, destinationDomain) => (callback) => eventHandler(sourceModel => {
-    var _a;
+    var _a, _b;
     if (!sourceModel) {
         return sourceModel;
     }
-    const cacheKey = [destinationDomain, 'get', `${sourceModel[sourceModelProp]}`];
-    const model = (_a = pullFromCache(cacheKey)) === null || _a === void 0 ? void 0 : _a.data;
+    const client = getActiveClient();
+    const { objectSyncMap } = client;
+    /*
+     * NOTE: For objects created locally (optimistic creation), the SDK stores them with their local ID as the cache key, which is used throughout the entire SDK session (in-memory) for syncing updates.
+     * If the payload or response only contains the remote ID of the same object, the SDK will look up the corresponding local ID to retrieve the object.
+     */
+    const resolvedId = isLocalId(sourceModel[sourceModelProp])
+        ? sourceModel[sourceModelProp]
+        : (_a = objectSyncMap.get(sourceModel[sourceModelProp])) !== null && _a !== void 0 ? _a : sourceModel[sourceModelProp];
+    const model = (_b = pullFromCache([
+        destinationDomain,
+        'get',
+        `${resolvedId}`,
+    ])) === null || _b === void 0 ? void 0 : _b.data;
     if (!model)
         return;
     return callback(model);
@@ -31423,6 +31512,7 @@ let uniqueId;
 const createMessageOptimistic = (bundle) => {
     var _a, _b;
     const client = getActiveClient();
+    const { objectSyncMap } = client;
     if (!client.cache)
         return;
     /*
@@ -31451,6 +31541,7 @@ const createMessageOptimistic = (bundle) => {
     const message = Object.assign({ creatorId: client.userId, creatorPrivateId: getActiveUser()._id, channelSegment: ((_b = subChannel === null || subChannel === void 0 ? void 0 : subChannel.data.messageCount) !== null && _b !== void 0 ? _b : 0) + 1, childrenNumber: 0, createdAt: createdTime, updatedAt: createdTime, syncState: "syncing" /* Amity.SyncState.Syncing */, isDeleted: false }, bundleWithMessageId);
     const cachedAt = UNSYNCED_OBJECT_CACHED_AT_VALUE;
     pushToCache(['message', 'get', message.messageId], message, { cachedAt });
+    objectSyncMap.set(message.messageId, undefined);
     fireEvent('local.message.created', { messages: [message] });
     return message;
 };
@@ -31478,12 +31569,15 @@ const createMessageOptimistic = (bundle) => {
  */
 const createMessage = async (bundle) => {
     const client = getActiveClient();
+    const { objectSyncMap } = client;
     client.log('message/createMessage', bundle);
     const optimisticData = createMessageOptimistic(bundle);
     const referenceId = bundle.referenceId || uniqueId || getLocalId();
     uniqueId = undefined;
     try {
         const { data: payload } = await client.http.post('/api/v5/messages', Object.assign(Object.assign({}, convertParams(bundle)), { referenceId }));
+        objectSyncMap.set(referenceId, payload.messages[0].messageId);
+        objectSyncMap.set(payload.messages[0].messageId, referenceId);
         const data = await prepareMessagePayload(payload);
         const { messages } = data;
         const cachedAt = client.cache && Date.now();
@@ -32238,7 +32332,7 @@ class MessageQueryStreamController extends QueryStreamController {
         var _a, _b;
         if (refresh) {
             pushToCache(this.cacheKey, {
-                data: response.messages.map(getResolver('message')),
+                data: getMessageIdentifierIds(response.messages),
                 query: this.query,
             });
         }
@@ -32246,8 +32340,8 @@ class MessageQueryStreamController extends QueryStreamController {
             const collection = (_a = pullFromCache(this.cacheKey)) === null || _a === void 0 ? void 0 : _a.data;
             const messages = (_b = collection === null || collection === void 0 ? void 0 : collection.data) !== null && _b !== void 0 ? _b : [];
             pushToCache(this.cacheKey, Object.assign(Object.assign({}, collection), { data: direction === 'next'
-                    ? [...new Set([...messages, ...response.messages.map(getResolver('message'))])]
-                    : [...new Set([...response.messages.map(getResolver('message')), ...messages])] }));
+                    ? [...new Set([...messages, ...getMessageIdentifierIds(response.messages)])]
+                    : [...new Set([...getMessageIdentifierIds(response.messages), ...messages])] }));
         }
     }
     reactor(action) {
@@ -32321,12 +32415,12 @@ class MessagePaginationController extends PaginationController {
 
 const getMessageFromMainDB = (messageId) => {
     var _a, _b;
-    const message = (_a = pullFromCache(['message', 'get', messageId])) === null || _a === void 0 ? void 0 : _a.data;
-    if (message)
-        return message;
-    // If message is not found by messageId as a key, query all messages in cache and find the message by messageId
-    const messages = queryCache(['message', 'get']);
-    return (_b = messages === null || messages === void 0 ? void 0 : messages.find(({ data }) => data.messageId === messageId)) === null || _b === void 0 ? void 0 : _b.data;
+    const client = getActiveClient();
+    const { objectSyncMap } = client;
+    const resolvedMessageId = isLocalId(messageId)
+        ? messageId
+        : (_a = objectSyncMap.get(messageId)) !== null && _a !== void 0 ? _a : messageId;
+    return (_b = pullFromCache(['message', 'get', resolvedMessageId])) === null || _b === void 0 ? void 0 : _b.data;
 };
 
 class MessageLiveCollectionController extends LiveCollectionController {
@@ -32666,7 +32760,8 @@ var index$g = /*#__PURE__*/Object.freeze({
   convertFromRaw: convertFromRaw,
   prepareMessagePayload: prepareMessagePayload,
   convertParams: convertParams,
-  convertQueryParams: convertQueryParams$1
+  convertQueryParams: convertQueryParams$1,
+  getMessageIdentifierIds: getMessageIdentifierIds
 });
 
 /**
@@ -40727,7 +40822,7 @@ var index$3 = /*#__PURE__*/Object.freeze({
   getPoll: getPoll
 });
 
-const privateKey = "-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDAARz+hmBgi8pJ\nQb8LeY41gtHhk+ACMwRfhsn7GqpqRQNG2qU0755mzZuVDUqjQMGSo8THJB7O+OJs\nflbZRkFXlFoFOVNw1UpNOgwEQZ6wB9oRwzepTJAfF1sVhm/o/ixvXh1zDFNDy6yZ\npXyiiJHUVxqyjllZhxnwdvjoVtDs6hW6awG09bB9nh/TTejlUKXoAgzqVwu/1QMu\nUVViET495elEe19aUarEy+oL2iKeXCEvqda/pWNBdbieFyJvvZ08HN8dPuT88wq2\njZLEAth1vrwQ2IAa4ktaLcBQdLJgIkrbDvAiVZ8lQAjS/bq5vXQikTGvoPlC5bbn\nvuOM/3eLAgMBAAECggEAVZ+peHAghq2QVj71nX5lxsNCKaCyYwixSJBpfouTt7Rz\nE6PpzMOXFi1W1o+I22jDakuSM2SOQKqI/u0QefB0r0O/KVk5NrZHXk0mkrdYtxOp\nUgaGyf8UvmjB+8VqHrNKyZdk9qtmbnNj01kTTcAtmE4H39zPR7eR/8Rul94vaZbs\nwCnKJS3mLT3JxyGug6lxanveKkjG+CKC1nJQYWaxCJxaFSzbwXQPvDhB+TvrIbee\npd5v4EAyEJohpr+T9oDGGJkb/KARBZCtwLyB976PKJwwBA8MRVL1i5QwawuMiMq5\nUtnOnbGKtCeFzaLbNU0Qi8bqyims84EQxC6DOu1fkQKBgQDdvsoBsEhsOXV7hlIJ\naEd0eSJZVkdqimxH8uGoMM2FeNaOrcB6yBXqTSP0R3OIyf8eaY6yjRvP30ZNXcll\n/gD3O1Mu6YmWQdt1W2WA6pKOsUuPXasf0pdOF7IiFZKlSabz5YHXFqwVuqm8loaj\nsXel3YWqPVdHiankE7tz+3ssnQKBgQDdqi4TNdD1MdEpihx19jr0QjUiXW3939FK\nqp30HESPEGDGQzXdmJgif9HhZb+cJSuWaHEbjgBrYahvgCF+y6LbEpOD+D/dmT+s\nDEAQaR84sah6dokwPjV8fjBSrcVFjCS+doxv0d3p/9OUEeyUhFrY03nxtIEYkLIE\n/Zvn37b4RwKBgQCLENVFe9XfsaVhQ5r9dV2iyTlmh7qgMZG5CbTFs12hQGhm8McO\n+Z7s41YSJCFr/yq1WwP4LJDtrBw99vyQr1zRsG35tNLp3gGRNzGQSQyC2uQFVHw2\np+7mNewsfhUK/gbrXNsyFnDz6635rPlhfbII3sWuP2wWXFqkxE9CbMwR7QKBgQC6\nawDMzxmo2/iYArrkyevSuEuPVxvFwpF1RgAI6C0QVCnPE38dmdN4UB7mfHekje4W\nVEercMURidPp0cxZolCYBQtilUjAyL0vqC3In1/Ogjq6oy3FEMxSop1pKxMY5j+Q\nnoqFD+6deLUrddeNH7J3X4LSr4dSbX4JjG+tlgt+yQKBgQCuwTL4hA6KqeInQ0Ta\n9VQX5Qr8hFlqJz1gpymi/k63tW/Ob8yedbg3WWNWyShwRMFYyY9S81ITFWM95uL6\nvF3x9rmRjwElJw9PMwVu6dmf/CO0Z1wzXSp2VVD12gbrUD/0/d7MUoJ9LgC8X8f/\nn0txLHYGHbx+nf95+JUg6lV3hg==\n-----END PRIVATE KEY-----";
+const privateKey = "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDHo80SecH7FuF2\nhFYnb+l26/VN8UMLXAQFLnxciNTEwkGVFMpdezlH8rU2HtUJL4RETogbAOLVY0XM\njs6sPn8G1nALmh9qeDpUtVqFOVtBHxEZ910TLOtQiunjqJKO5nWdqZ71EC3OFluR\niGQkO84BiIFbv37ub7xl3S8XarbtKoLcyVpkDHi+1wx1pgCAn6gtBUgckPL5NR8j\nLseabl3HAXQfhTCKo4tmOFM2Dxwl1IUMmIJrJg/aIU/U0tj/1Eoo7mG0JcNWX19l\nW3EecCbi0ncCJOrkUdwlBrcjaMayaX/ubEwyUeTGiLdyc4L3GRLHjyK8xgVNXRMH\nbZWJ2a5NAgMBAAECggEASxuE+35zTFO/XydKgmvIGcWL9FbgMlXb7Vcf0nBoG945\nbiz0NVc2paraIhJXc608xbYF3qLmtAE1MVBI0ORyRdBHNxY024l/6H6SH60Ed+uI\nM4ysp5ourY6Vj+DLwpdRiI9YDjqYAQDIUmhNxJP7XPhOMoZI6st+xZQBM34ic/bv\nAMSJm9OZphSp3+qXVkFZztr2mxD2EZSJJLYxi8BCdgM2qhazalbcJ6zDKHCZWVWm\n8RRxDGldyMb/237JxETzP40tAlzOZDmBAbUgEnurDJ93RVDIE3rbZUshwgeQd18a\nem096mWgvB1AIKYgsTAR3pw+V19YWAjq/glP6fz8wQKBgQD/oQq+ukKF0PRgBeM5\ngeTjSwsdGppQLmf5ndujvoiz/TpdjDEPu6R8kigQr1rG2t4K/yfdZoI8RdmJD1al\n3Q7N9hofooSy4rj6E3txzWZCHJjHad2cnCp/O26HiReGAl7wTcfTmNdiFHhZQzm5\nJBkvWAiwuvQMNfEbnXxw6/vIDwKBgQDH7fX8gsc77JLvAWgp1MaQN/sbqVb6JeT1\nFQfR8E/WFCSmzQBtNzd5KgYuCeelwr/8DyYytvN2BzCYZXp73gI1jF3YlW5jVn74\nOY6TwQ095digwo6Z0yuxopdIOApKgAkL9PRKgNrqAf3NAyMua6lOGifzjDojC3KU\nfylQmxMn4wKBgHp2B9O/H0dEBw5JQ8W0+JX6yWQz7mEjGiR2/1W+XXb8hQ1zr709\nw1r6Gb+EghRpnZ3fBpYGGbYOMFx8wKHM+N6qW3F0ReX8v2juFGE8aRSa5oYBrWzt\nU16Idjbv8hj84cZ1PJmdyvDtpYn9rpWHOZl4rxEbPvbqkIsOMyNVqdT5AoGAOSge\nmwIIU2le2FVeohbibXiToWTYKMuMmURZ5/r72AgKMmWJKbAPe+Q3wBG01/7FRBpQ\noU8Ma0HC8s6QJbliiEyIx9JwrJWd1vkdecBHONrtA4ibm/5zD2WcOllLF+FitLhi\n3qnX6+6F0IaFGFBPJrTzlv0P4dTz/OAdv52V7GECgYEA2TttOKBAqWllgOaZOkql\nLVMJVmgR7s6tLi1+cEP8ZcapV9aRbRzTAKXm4f8AEhtlG9F9kCOvHYCYGi6JaiWJ\nZkHjeex3T+eE6Di6y5Bm/Ift5jtVhJ4jCVwHOKTMej79NPUFTJfv8hCo29haBDv6\nRXFrv+T21KCcw8k3sJeJWWQ=\n-----END PRIVATE KEY-----";
 /*
  * The crypto algorithm used for importing key and signing string
  */