@bellachu/xteambail 2.0.0

package/lib/Utils/decode-wa-message.js

@@ -0,0 +1,380 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SERVER_ERROR_CODES = exports.NO_MESSAGE_FOUND_ERROR_TEXT = exports.NACK_REASONS = exports.MISSING_KEYS_ERROR_TEXT = exports.DECRYPTION_RETRY_CONFIG = exports.ACCOUNT_RESTRICTED_TEXT = exports.setBotMessageSecret = void 0;
+exports.decodeMessageNode = decodeMessageNode;
+exports.getDecryptionJid = exports.extractAddressingContext = exports.decryptMessageNode = void 0;
+var _boom = require("@hapi/boom");
+var _index = require("../../WAProto/index.js");
+var _index2 = require("../WABinary/index.js");
+var _generics = require("./generics.js");
+const getDecryptionJid = async (sender, repository) => {
+  if ((0, _index2.isLidUser)(sender) || (0, _index2.isHostedLidUser)(sender)) {
+    return sender;
+  }
+  const mapped = await repository.lidMapping.getLIDForPN(sender);
+  return mapped || sender;
+};
+exports.getDecryptionJid = getDecryptionJid;
+const storeMappingFromEnvelope = async (stanza, sender, repository, decryptionJid, logger) => {
+  // TODO: Handle hosted IDs
+  const {
+    senderAlt
+  } = extractAddressingContext(stanza);
+  if (senderAlt && (0, _index2.isLidUser)(senderAlt) && (0, _index2.isPnUser)(sender) && decryptionJid === sender) {
+    try {
+      await repository.lidMapping.storeLIDPNMappings([{
+        lid: senderAlt,
+        pn: sender
+      }]);
+      await repository.migrateSession(sender, senderAlt);
+      logger.debug({
+        sender,
+        senderAlt
+      }, 'Stored LID mapping from envelope');
+    } catch (error) {
+      logger.warn({
+        sender,
+        senderAlt,
+        error
+      }, 'Failed to store LID mapping');
+    }
+  }
+};
+const MAX_SECRETS_PER_CHAT = 20;
+const botMessageSecrets = new Map();
+const botRecentSecretsByChat = new Map();
+const pushRecentChatSecret = (chatJid, id, secretBuf) => {
+  if (!chatJid || !secretBuf) return;
+  const existing = botRecentSecretsByChat.get(chatJid) || [];
+  const filtered = existing.filter(item => item.id !== id && !item.secret.equals(secretBuf));
+  filtered.unshift({
+    id,
+    secret: secretBuf
+  });
+  if (filtered.length > MAX_SECRETS_PER_CHAT) {
+    filtered.length = MAX_SECRETS_PER_CHAT;
+  }
+  botRecentSecretsByChat.set(chatJid, filtered);
+};
+const setBotMessageSecret = (id, secret, chatJid) => {
+  if (!id || !secret) return;
+  let buf;
+  if (Buffer.isBuffer(secret)) {
+    buf = secret;
+  } else if (secret instanceof Uint8Array) {
+    buf = Buffer.from(secret.buffer, secret.byteOffset, secret.byteLength);
+  } else if (typeof secret === "string") {
+    buf = Buffer.from(secret, "base64");
+  } else {
+    return;
+  }
+  botMessageSecrets.set(id, buf);
+  if (chatJid) {
+    pushRecentChatSecret(chatJid, id, buf);
+  }
+};
+exports.setBotMessageSecret = setBotMessageSecret;
+const NO_MESSAGE_FOUND_ERROR_TEXT = exports.NO_MESSAGE_FOUND_ERROR_TEXT = 'Message absent from node';
+const MISSING_KEYS_ERROR_TEXT = exports.MISSING_KEYS_ERROR_TEXT = 'Key used already or never filled';
+const ACCOUNT_RESTRICTED_TEXT = exports.ACCOUNT_RESTRICTED_TEXT = 'Your account has been restricted';
+// Retry configuration for failed decryption
+const DECRYPTION_RETRY_CONFIG = exports.DECRYPTION_RETRY_CONFIG = {
+  maxRetries: 3,
+  baseDelayMs: 100,
+  sessionRecordErrors: ['No session record', 'SessionError: No session record']
+};
+/** NACK reason codes we send to the server (client → server) */
+const NACK_REASONS = exports.NACK_REASONS = {
+  SenderReachoutTimelocked: 463,
+  ParsingError: 487,
+  UnrecognizedStanza: 488,
+  UnrecognizedStanzaClass: 489,
+  UnrecognizedStanzaType: 490,
+  InvalidProtobuf: 491,
+  InvalidHostedCompanionStanza: 493,
+  MissingMessageSecret: 495,
+  SignalErrorOldCounter: 496,
+  MessageDeletedOnPeer: 499,
+  UnhandledError: 500,
+  UnsupportedAdminRevoke: 550,
+  UnsupportedLIDGroup: 551,
+  DBOperationFailed: 552
+};
+/**
+ * Server-side error codes returned in ack stanzas (server → client) that we
+ * currently have dedicated handlers for. Extend as more handlers are added.
+ * Distinct from the client-side NackReason enum (WAWebCreateNackFromStanza).
+ */
+const SERVER_ERROR_CODES = exports.SERVER_ERROR_CODES = {
+  /**
+   * 1:1 message missing privacy token (tctoken). Usually means the account is
+   * restricted: WhatsApp blocks starting new chats but preserves existing ones,
+   * since established chats already carry a tctoken.
+   */
+  MessageAccountRestriction: '463',
+  /** Stanza validation failure (SMAX_INVALID) — likely stale device session */
+  SmaxInvalid: '479'
+};
+const extractAddressingContext = stanza => {
+  let senderAlt;
+  let recipientAlt;
+  const sender = stanza.attrs.participant || stanza.attrs.from;
+  const addressingMode = stanza.attrs.addressing_mode || (sender?.endsWith('lid') ? 'lid' : 'pn');
+  if (addressingMode === 'lid') {
+    // Message is LID-addressed: sender is LID, extract corresponding PN
+    // without device data
+    senderAlt = stanza.attrs.participant_pn || stanza.attrs.sender_pn || stanza.attrs.peer_recipient_pn;
+    recipientAlt = stanza.attrs.recipient_pn;
+    // with device data
+    //if (sender && senderAlt) senderAlt = transferDevice(sender, senderAlt)
+  } else {
+    // Message is PN-addressed: sender is PN, extract corresponding LID
+    // without device data
+    senderAlt = stanza.attrs.participant_lid || stanza.attrs.sender_lid || stanza.attrs.peer_recipient_lid;
+    recipientAlt = stanza.attrs.recipient_lid;
+    //with device data
+    //if (sender && senderAlt) senderAlt = transferDevice(sender, senderAlt)
+  }
+  return {
+    addressingMode,
+    senderAlt,
+    recipientAlt
+  };
+};
+/**
+ * Decode the received node as a message.
+ * @note this will only parse the message, not decrypt it
+ */
+exports.extractAddressingContext = extractAddressingContext;
+function decodeMessageNode(stanza, meId, meLid) {
+  let msgType;
+  let chatId;
+  let author;
+  let fromMe = false;
+  const msgId = stanza.attrs.id;
+  const from = stanza.attrs.from;
+  const participant = stanza.attrs.participant;
+  const recipient = stanza.attrs.recipient;
+  if (!msgId) {
+    throw new _boom.Boom('Invalid message stanza: missing id attribute', {
+      data: stanza
+    });
+  }
+  if (!from) {
+    throw new _boom.Boom('Invalid message stanza: missing from attribute', {
+      data: stanza
+    });
+  }
+  const addressingContext = extractAddressingContext(stanza);
+  const isMe = jid => (0, _index2.areJidsSameUser)(jid, meId);
+  const isMeLid = jid => (0, _index2.areJidsSameUser)(jid, meLid);
+  if ((0, _index2.isPnUser)(from) || (0, _index2.isLidUser)(from) || (0, _index2.isHostedLidUser)(from) || (0, _index2.isHostedPnUser)(from)) {
+    if (recipient && !(0, _index2.isJidMetaAI)(recipient)) {
+      if (!isMe(from) && !isMeLid(from)) {
+        throw new _boom.Boom('receipient present, but msg not from me', {
+          data: stanza
+        });
+      }
+      if (isMe(from) || isMeLid(from)) {
+        fromMe = true;
+      }
+      chatId = recipient;
+    } else {
+      // Peer-routed self stanzas (history sync, app-state sync, etc.) arrive
+      // with `from` set to our own device but no `recipient` attribute —
+      // still mark as fromMe so self-only protocolMessage handlers run.
+      if (isMe(from) || isMeLid(from)) {
+        fromMe = true;
+      }
+      chatId = from;
+    }
+    msgType = 'chat';
+    author = from;
+  } else if ((0, _index2.isJidGroup)(from)) {
+    if (!participant) {
+      throw new _boom.Boom('No participant in group message');
+    }
+    if (isMe(participant) || isMeLid(participant)) {
+      fromMe = true;
+    }
+    msgType = 'group';
+    author = participant;
+    chatId = from;
+  } else if ((0, _index2.isJidBroadcast)(from)) {
+    if (!participant) {
+      throw new _boom.Boom('No participant in group message');
+    }
+    const isParticipantMe = isMe(participant);
+    if ((0, _index2.isJidStatusBroadcast)(from)) {
+      msgType = isParticipantMe ? 'direct_peer_status' : 'other_status';
+    } else {
+      msgType = isParticipantMe ? 'peer_broadcast' : 'other_broadcast';
+    }
+    fromMe = isParticipantMe;
+    chatId = from;
+    author = participant;
+  } else if ((0, _index2.isJidNewsletter)(from)) {
+    msgType = 'newsletter';
+    chatId = from;
+    author = from;
+    if (isMe(from) || isMeLid(from)) {
+      fromMe = true;
+    }
+  } else {
+    throw new _boom.Boom('Unknown message type', {
+      data: stanza
+    });
+  }
+  const pushname = stanza?.attrs?.notify;
+  const key = {
+    remoteJid: chatId,
+    remoteJidAlt: !(0, _index2.isJidGroup)(chatId) ? addressingContext.senderAlt : undefined,
+    remoteJidUsername: !(0, _index2.isJidGroup)(chatId) ? stanza.attrs.peer_recipient_username || stanza.attrs.recipient_username : undefined,
+    fromMe,
+    id: msgId,
+    participant,
+    participantAlt: (0, _index2.isJidGroup)(chatId) ? addressingContext.senderAlt : undefined,
+    participantUsername: stanza.attrs.participant ? stanza.attrs.participant_username : undefined,
+    addressingMode: addressingContext.addressingMode,
+    ...(msgType === 'newsletter' && stanza.attrs.server_id ? {
+      server_id: stanza.attrs.server_id
+    } : {})
+  };
+  const fullMessage = {
+    key,
+    category: stanza.attrs.category,
+    messageTimestamp: +stanza.attrs.t,
+    pushName: pushname,
+    broadcast: (0, _index2.isJidBroadcast)(from)
+  };
+  if (key.fromMe) {
+    fullMessage.status = _index.proto.WebMessageInfo.Status.SERVER_ACK;
+  }
+  return {
+    fullMessage,
+    author,
+    sender: msgType === 'chat' ? author : chatId
+  };
+}
+const decryptMessageNode = (stanza, meId, meLid, repository, logger) => {
+  const {
+    fullMessage,
+    author,
+    sender
+  } = decodeMessageNode(stanza, meId, meLid);
+  return {
+    fullMessage,
+    category: stanza.attrs.category,
+    author,
+    async decrypt() {
+      let decryptables = 0;
+      if (Array.isArray(stanza.content)) {
+        for (const {
+          tag,
+          attrs,
+          content
+        } of stanza.content) {
+          if (tag === 'verified_name' && content instanceof Uint8Array) {
+            const cert = _index.proto.VerifiedNameCertificate.decode(content);
+            const details = _index.proto.VerifiedNameCertificate.Details.decode(cert.details);
+            fullMessage.verifiedBizName = details.verifiedName;
+          }
+          if (tag === 'unavailable' && attrs.type === 'view_once') {
+            fullMessage.key.isViewOnce = true; // TODO: remove from here and add a STUB TYPE
+          }
+          if (attrs.count && tag === 'enc') {
+            fullMessage.retryCount = Number(attrs.count);
+          }
+          if (tag !== 'enc' && tag !== 'plaintext') {
+            continue;
+          }
+          if (!(content instanceof Uint8Array)) {
+            continue;
+          }
+          decryptables += 1;
+          let msgBuffer;
+          const decryptionJid = await getDecryptionJid(author, repository);
+          if (tag !== 'plaintext') {
+            // TODO: Handle hosted devices
+            await storeMappingFromEnvelope(stanza, author, repository, decryptionJid, logger);
+          }
+          try {
+            const e2eType = tag === 'plaintext' ? 'plaintext' : attrs.type;
+            switch (e2eType) {
+              case 'skmsg':
+                msgBuffer = await repository.decryptGroupMessage({
+                  group: sender,
+                  authorJid: author,
+                  msg: content
+                });
+                break;
+              case 'pkmsg':
+              case 'msg':
+                msgBuffer = await repository.decryptMessage({
+                  jid: decryptionJid,
+                  type: e2eType,
+                  ciphertext: content
+                });
+                break;
+              case 'plaintext':
+                msgBuffer = content;
+                break;
+              default:
+                throw new Error(`Unknown e2e type: ${e2eType}`);
+            }
+            let msg = _index.proto.Message.decode(e2eType !== 'plaintext' ? (0, _generics.unpadRandomMax16)(msgBuffer) : msgBuffer);
+            msg = msg.deviceSentMessage?.message || msg;
+            if (msg.senderKeyDistributionMessage) {
+              //eslint-disable-next-line max-depth
+              try {
+                await repository.processSenderKeyDistributionMessage({
+                  authorJid: author,
+                  item: msg.senderKeyDistributionMessage
+                });
+              } catch (err) {
+                logger.error({
+                  key: fullMessage.key,
+                  err
+                }, 'failed to process sender key distribution message');
+              }
+            }
+            if (fullMessage.message) {
+              Object.assign(fullMessage.message, msg);
+            } else {
+              fullMessage.message = msg;
+            }
+          } catch (err) {
+            const errorContext = {
+              key: fullMessage.key,
+              err,
+              messageType: tag === 'plaintext' ? 'plaintext' : attrs.type,
+              sender,
+              author,
+              isSessionRecordError: isSessionRecordError(err)
+            };
+            logger.error(errorContext, 'failed to decrypt message');
+            fullMessage.messageStubType = _index.proto.WebMessageInfo.StubType.CIPHERTEXT;
+            fullMessage.messageStubParameters = [err.message.toString()];
+          }
+        }
+      }
+      // if nothing was found to decrypt
+      if (!decryptables && !fullMessage.key?.isViewOnce) {
+        fullMessage.messageStubType = _index.proto.WebMessageInfo.StubType.CIPHERTEXT;
+        fullMessage.messageStubParameters = [NO_MESSAGE_FOUND_ERROR_TEXT];
+      }
+    }
+  };
+};
+/**
+ * Utility function to check if an error is related to missing session record
+ */
+exports.decryptMessageNode = decryptMessageNode;
+function isSessionRecordError(error) {
+  const errorMessage = error?.message || error?.toString() || '';
+  return DECRYPTION_RETRY_CONFIG.sessionRecordErrors.some(errorPattern => errorMessage.includes(errorPattern));
+}
+//# sourceMappingURL=decode-wa-message.js.map

package/lib/Utils/decode-wa-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decode-wa-message.js","sourceRoot":"","sources":["../../src/Utils/decode-wa-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AAG9C,OAAO,EACN,eAAe,EAEf,eAAe,EACf,cAAc,EACd,cAAc,EACd,UAAU,EACV,WAAW,EACX,eAAe,EACf,oBAAoB,EACpB,SAAS,EACT,QAAQ;AACR,iBAAiB;EACjB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAG7C,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EAAE,MAAc,EAAE,UAAwC,EAAmB,EAAE;IACnH,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,OAAO,MAAM,CAAA;IACd,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9D,OAAO,MAAM,IAAI,MAAM,CAAA;AACxB,CAAC,CAAA;AAED,MAAM,wBAAwB,GAAG,KAAK,EACrC,MAAkB,EAClB,MAAc,EACd,UAAwC,EACxC,aAAqB,EACrB,MAAe,EACC,EAAE;IAClB,0BAA0B;IAC1B,MAAM,EAAE,SAAS,EAAE,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAA;IAEtD,IAAI,SAAS,IAAI,SAAS,CAAC,SAAS,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,aAAa,KAAK,MAAM,EAAE,CAAC;QACvF,IAAI,CAAC;YACJ,MAAM,UAAU,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAA;YAChF,MAAM,UAAU,CAAC,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;YAClD,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,kCAAkC,CAAC,CAAA;QACxE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,6BAA6B,CAAC,CAAA;QACzE,CAAC;IACF,CAAC;AACF,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,2BAA2B,GAAG,0BAA0B,CAAA;AACrE,MAAM,CAAC,MAAM,uBAAuB,GAAG,kCAAkC,CAAA;AACzE,MAAM,CAAC,MAAM,uBAAuB,GAAG,kCAAkC,CAAA;AAEzE,4CAA4C;AAC5C,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACtC,UAAU,EAAE,CAAC;IACb,WAAW,EAAE,GAAG;IAChB,mBAAmB,EAAE,CAAC,mBAAmB,EAAE,iCAAiC,CAAC;CAC7E,CAAA;AAED,gEAAgE;AAChE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B,wBAAwB,EAAE,GAAG;IAC7B,YAAY,EAAE,GAAG;IACjB,kBAAkB,EAAE,GAAG;IACvB,uBAAuB,EAAE,GAAG;IAC5B,sBAAsB,EAAE,GAAG;IAC3B,eAAe,EAAE,GAAG;IACpB,4BAA4B,EAAE,GAAG;IACjC,oBAAoB,EAAE,GAAG;IACzB,qBAAqB,EAAE,GAAG;IAC1B,oBAAoB,EAAE,GAAG;IACzB,cAAc,EAAE,GAAG;IACnB,sBAAsB,EAAE,GAAG;IAC3B,mBAAmB,EAAE,GAAG;IACxB,iBAAiB,EAAE,GAAG;CACtB,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IACjC;;;;OAIG;IACH,yBAAyB,EAAE,KAAK;IAChC,6EAA6E;IAC7E,WAAW,EAAE,KAAK;CACT,CAAA;AAWV,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,MAAkB,EAAE,EAAE;IAC9D,IAAI,SAA6B,CAAA;IACjC,IAAI,YAAgC,CAAA;IAEpC,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,WAAW,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAA;IAC5D,MAAM,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IAE/F,IAAI,cAAc,KAAK,KAAK,EAAE,CAAC;QAC9B,oEAAoE;QACpE,sBAAsB;QACtB,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,cAAc,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAA;QACnG,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAA;QACxC,mBAAmB;QACnB,wEAAwE;IACzE,CAAC;SAAM,CAAC;QACP,mEAAmE;QACnE,sBAAsB;QACtB,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,eAAe,IAAI,MAAM,CAAC,KAAK,CAAC,UAAU,IAAI,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAA;QACtG,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,aAAa,CAAA;QAEzC,kBAAkB;QAClB,wEAAwE;IACzE,CAAC;IAED,OAAO;QACN,cAAc;QACd,SAAS;QACT,YAAY;KACZ,CAAA;AACF,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAkB,EAAE,IAAY,EAAE,KAAa;IAChF,IAAI,OAAoB,CAAA;IACxB,IAAI,MAAc,CAAA;IAClB,IAAI,MAAc,CAAA;IAClB,IAAI,MAAM,GAAG,KAAK,CAAA;IAElB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAA;IAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAA;IAC9B,MAAM,WAAW,GAAuB,MAAM,CAAC,KAAK,CAAC,WAAW,CAAA;IAChE,MAAM,SAAS,GAAuB,MAAM,CAAC,KAAK,CAAC,SAAS,CAAA;IAE5D,IAAI,CAAC,KAAK,EAAE,CAAC;QACZ,MAAM,IAAI,IAAI,CAAC,8CAA8C,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;IACjF,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,CAAC;QACX,MAAM,IAAI,IAAI,CAAC,gDAAgD,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;IACnF,CAAC;IAED,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAA;IAE1D,MAAM,IAAI,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IACxD,MAAM,OAAO,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAE5D,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QACxF,IAAI,SAAS,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnC,MAAM,IAAI,IAAI,CAAC,yCAAyC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;YAC5E,CAAC;YAED,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjC,MAAM,GAAG,IAAI,CAAA;YACd,CAAC;YAED,MAAM,GAAG,SAAS,CAAA;QACnB,CAAC;aAAM,CAAC;YACP,uEAAuE;YACvE,mEAAmE;YACnE,kEAAkE;YAClE,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjC,MAAM,GAAG,IAAI,CAAA;YACd,CAAC;YAED,MAAM,GAAG,IAAI,CAAA;QACd,CAAC;QAED,OAAO,GAAG,MAAM,CAAA;QAChB,MAAM,GAAG,IAAI,CAAA;IACd,CAAC;SAAM,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,IAAI,CAAC,WAAW,EAAE,CAAC;YAClB,MAAM,IAAI,IAAI,CAAC,iCAAiC,CAAC,CAAA;QAClD,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/C,MAAM,GAAG,IAAI,CAAA;QACd,CAAC;QAED,OAAO,GAAG,OAAO,CAAA;QACjB,MAAM,GAAG,WAAW,CAAA;QACpB,MAAM,GAAG,IAAI,CAAA;IACd,CAAC;SAAM,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC,WAAW,EAAE,CAAC;YAClB,MAAM,IAAI,IAAI,CAAC,iCAAiC,CAAC,CAAA;QAClD,CAAC;QAED,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,CAAA;QACzC,IAAI,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,OAAO,GAAG,eAAe,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,cAAc,CAAA;QAClE,CAAC;aAAM,CAAC;YACP,OAAO,GAAG,eAAe,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,iBAAiB,CAAA;QACjE,CAAC;QAED,MAAM,GAAG,eAAe,CAAA;QACxB,MAAM,GAAG,IAAI,CAAA;QACb,MAAM,GAAG,WAAW,CAAA;IACrB,CAAC;SAAM,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;QAClC,OAAO,GAAG,YAAY,CAAA;QACtB,MAAM,GAAG,IAAI,CAAA;QACb,MAAM,GAAG,IAAI,CAAA;QAEb,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,MAAM,GAAG,IAAI,CAAA;QACd,CAAC;IACF,CAAC;SAAM,CAAC;QACP,MAAM,IAAI,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;IACzD,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,EAAE,KAAK,EAAE,MAAM,CAAA;IAEtC,MAAM,GAAG,GAAiB;QACzB,SAAS,EAAE,MAAM;QACjB,YAAY,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;QAC3E,iBAAiB,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC;YACrC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,IAAI,MAAM,CAAC,KAAK,CAAC,kBAAkB;YACzE,CAAC,CAAC,SAAS;QACZ,MAAM;QACN,EAAE,EAAE,KAAK;QACT,WAAW;QACX,cAAc,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;QAC5E,mBAAmB,EAAE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS;QAC7F,cAAc,EAAE,iBAAiB,CAAC,cAAc;QAChD,GAAG,CAAC,OAAO,KAAK,YAAY,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACpG,CAAA;IAED,MAAM,WAAW,GAAc;QAC9B,GAAG;QACH,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC/B,gBAAgB,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAE;QAClC,QAAQ,EAAE,QAAQ;QAClB,SAAS,EAAE,cAAc,CAAC,IAAI,CAAC;KAC/B,CAAA;IAED,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAChB,WAAW,CAAC,MAAM,GAAG,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAA;IAC5D,CAAC;IAED,OAAO;QACN,WAAW;QACX,MAAM;QACN,MAAM,EAAE,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM;KAC5C,CAAA;AACF,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CACjC,MAAkB,EAClB,IAAY,EACZ,KAAa,EACb,UAAwC,EACxC,MAAe,EACd,EAAE;IACH,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;IAC9E,OAAO;QACN,WAAW;QACX,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC/B,MAAM;QACN,KAAK,CAAC,OAAO;YACZ,IAAI,YAAY,GAAG,CAAC,CAAA;YACpB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBACnC,KAAK,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACtD,IAAI,GAAG,KAAK,eAAe,IAAI,OAAO,YAAY,UAAU,EAAE,CAAC;wBAC9D,MAAM,IAAI,GAAG,KAAK,CAAC,uBAAuB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;wBAC1D,MAAM,OAAO,GAAG,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAQ,CAAC,CAAA;wBAC3E,WAAW,CAAC,eAAe,GAAG,OAAO,CAAC,YAAY,CAAA;oBACnD,CAAC;oBAED,IAAI,GAAG,KAAK,aAAa,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;wBACzD,WAAW,CAAC,GAAG,CAAC,UAAU,GAAG,IAAI,CAAA,CAAC,6CAA6C;oBAChF,CAAC;oBAED,IAAI,KAAK,CAAC,KAAK,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;wBAClC,WAAW,CAAC,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;oBAC7C,CAAC;oBAED,IAAI,GAAG,KAAK,KAAK,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;wBAC1C,SAAQ;oBACT,CAAC;oBAED,IAAI,CAAC,CAAC,OAAO,YAAY,UAAU,CAAC,EAAE,CAAC;wBACtC,SAAQ;oBACT,CAAC;oBAED,YAAY,IAAI,CAAC,CAAA;oBAEjB,IAAI,SAAqB,CAAA;oBAEzB,MAAM,aAAa,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;oBAEhE,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;wBACzB,8BAA8B;wBAC9B,MAAM,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,CAAC,CAAA;oBAClF,CAAC;oBAED,IAAI,CAAC;wBACJ,MAAM,OAAO,GAAG,GAAG,KAAK,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAA;wBAE9D,QAAQ,OAAO,EAAE,CAAC;4BACjB,KAAK,OAAO;gCACX,SAAS,GAAG,MAAM,UAAU,CAAC,mBAAmB,CAAC;oCAChD,KAAK,EAAE,MAAM;oCACb,SAAS,EAAE,MAAM;oCACjB,GAAG,EAAE,OAAO;iCACZ,CAAC,CAAA;gCACF,MAAK;4BACN,KAAK,OAAO,CAAC;4BACb,KAAK,KAAK;gCACT,SAAS,GAAG,MAAM,UAAU,CAAC,cAAc,CAAC;oCAC3C,GAAG,EAAE,aAAa;oCAClB,IAAI,EAAE,OAAO;oCACb,UAAU,EAAE,OAAO;iCACnB,CAAC,CAAA;gCACF,MAAK;4BACN,KAAK,WAAW;gCACf,SAAS,GAAG,OAAO,CAAA;gCACnB,MAAK;4BACN;gCACC,MAAM,IAAI,KAAK,CAAC,qBAAqB,OAAO,EAAE,CAAC,CAAA;wBACjD,CAAC;wBAED,IAAI,GAAG,GAAmB,KAAK,CAAC,OAAO,CAAC,MAAM,CAC7C,OAAO,KAAK,WAAW,CAAC,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CACjE,CAAA;wBACD,GAAG,GAAG,GAAG,CAAC,iBAAiB,EAAE,OAAO,IAAI,GAAG,CAAA;wBAC3C,IAAI,GAAG,CAAC,4BAA4B,EAAE,CAAC;4BACtC,oCAAoC;4BACpC,IAAI,CAAC;gCACJ,MAAM,UAAU,CAAC,mCAAmC,CAAC;oCACpD,SAAS,EAAE,MAAM;oCACjB,IAAI,EAAE,GAAG,CAAC,4BAA4B;iCACtC,CAAC,CAAA;4BACH,CAAC;4BAAC,OAAO,GAAG,EAAE,CAAC;gCACd,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,mDAAmD,CAAC,CAAA;4BACjG,CAAC;wBACF,CAAC;wBAED,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;4BACzB,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;wBACxC,CAAC;6BAAM,CAAC;4BACP,WAAW,CAAC,OAAO,GAAG,GAAG,CAAA;wBAC1B,CAAC;oBACF,CAAC;oBAAC,OAAO,GAAQ,EAAE,CAAC;wBACnB,MAAM,YAAY,GAAG;4BACpB,GAAG,EAAE,WAAW,CAAC,GAAG;4BACpB,GAAG;4BACH,WAAW,EAAE,GAAG,KAAK,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;4BAC3D,MAAM;4BACN,MAAM;4BACN,oBAAoB,EAAE,oBAAoB,CAAC,GAAG,CAAC;yBAC/C,CAAA;wBAED,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,2BAA2B,CAAC,CAAA;wBAEvD,WAAW,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,UAAU,CAAA;wBACtE,WAAW,CAAC,qBAAqB,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAA;oBAC7D,CAAC;gBACF,CAAC;YACF,CAAC;YAED,kCAAkC;YAClC,IAAI,CAAC,YAAY,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,UAAU,EAAE,CAAC;gBACnD,WAAW,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,UAAU,CAAA;gBACtE,WAAW,CAAC,qBAAqB,GAAG,CAAC,2BAA2B,CAAC,CAAA;YAClE,CAAC;QACF,CAAC;KACD,CAAA;AACF,CAAC,CAAA;AAED;;GAEG;AACH,SAAS,oBAAoB,CAAC,KAAU;IACvC,MAAM,YAAY,GAAG,KAAK,EAAE,OAAO,IAAI,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAA;IAC9D,OAAO,uBAAuB,CAAC,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAA;AAC7G,CAAC"}

package/lib/Utils/event-buffer.d.ts

@@ -0,0 +1,36 @@
+import type { xrlEventEmitter, xrlEventMap } from '../Types/index.js';
+import type { ILogger } from './logger.js';
+/**
+ * A map that contains a list of all events that have been triggered
+ *
+ * Note, this can contain different type of events
+ * this can make processing events extremely efficient -- since everything
+ * can be done in a single transaction
+ */
+type xrlEventData = Partial<xrlEventMap>;
+type xrlBufferableEventEmitter = xrlEventEmitter & {
+    /** Use to process events in a batch */
+    process(handler: (events: xrlEventData) => void | Promise<void>): () => void;
+    /**
+     * starts buffering events, call flush() to release them
+     * */
+    buffer(): void;
+    /** buffers all events till the promise completes */
+    createBufferedFunction<A extends any[], T>(work: (...args: A) => Promise<T>): (...args: A) => Promise<T>;
+    /**
+     * flushes all buffered events
+     * @returns returns true if the flush actually happened, otherwise false
+     */
+    flush(): boolean;
+    /** is there an ongoing buffer */
+    isBuffering(): boolean;
+    /** destroy the event buffer, clearing all resources */
+    destroy(): void;
+};
+/**
+ * The event buffer logically consolidates different events into a single event
+ * making the data processing more efficient.
+ */
+export declare const makeEventBuffer: (logger: ILogger) => xrlBufferableEventEmitter;
+export {};
+//# sourceMappingURL=event-buffer.d.ts.map

package/lib/Utils/event-buffer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-buffer.d.ts","sourceRoot":"","sources":["../../src/Utils/event-buffer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAEX,mBAAmB,EACnB,eAAe,EAOf,MAAM,UAAU,CAAA;AAGjB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAqBvC;;;;;;GAMG;AACH,KAAK,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;AAIhD,KAAK,6BAA6B,GAAG,mBAAmB,GAAG;IAC1D,uCAAuC;IACvC,OAAO,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,CAAA;IAChF;;SAEK;IACL,MAAM,IAAI,IAAI,CAAA;IACd,oDAAoD;IAEpD,sBAAsB,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;IACxG;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAA;IAChB,iCAAiC;IACjC,WAAW,IAAI,OAAO,CAAA;IACtB,uDAAuD;IACvD,OAAO,IAAI,IAAI,CAAA;CACf,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,OAAO,KAAG,6BA8LjD,CAAA"}