@multiplatform.one/frappe 6.6.0 → 7.0.0

package/dist/cjs/realtime.native.js

@@ -78,9 +78,14 @@ var RealtimeModule = /* @__PURE__ */function () {
   function RealtimeModule2(config) {
     _class_call_check(this, RealtimeModule2);
     _define_property(this, "socket", void 0);
+    _define_property(this, "eventSource", void 0);
     _define_property(this, "handlerMap", /* @__PURE__ */new Map());
     _define_property(this, "attachedSocketEvents", /* @__PURE__ */new Set());
     _define_property(this, "socketEventHandlers", /* @__PURE__ */new Map());
+    _define_property(this, "attachedSseEvents", /* @__PURE__ */new Set());
+    _define_property(this, "sseListeners", /* @__PURE__ */new Map());
+    _define_property(this, "sseRoomNoticeLogged", false);
+    _define_property(this, "sseEmitNoticeLogged", false);
     _define_property(this, "docRooms", /* @__PURE__ */new Map());
     _define_property(this, "listRooms", /* @__PURE__ */new Map());
     _define_property(this, "socketHealthy", false);
@@ -108,19 +113,31 @@ var RealtimeModule = /* @__PURE__ */function () {
     key: "getSocketURL",
     value: function getSocketURL() {
       var base = this.config.baseURL.replace(/\/$/, "");
+      if (this.config.socketBaseURL) {
+        var socketBase = this.config.socketBaseURL.replace(/\/$/, "");
+        var siteName = this.config.siteName;
+        if (!siteName) {
+          try {
+            siteName = new URL(base).hostname;
+          } catch (unused) {
+            siteName = base.replace(/^https?:\/\//, "").split(/[/:]/)[0];
+          }
+        }
+        return `${socketBase}/${siteName}`;
+      }
       try {
         var url = new URL(base);
         var port = this.config.socketPort ? String(this.config.socketPort) : url.port;
         var host = port ? `${url.hostname}:${port}` : url.hostname;
-        var siteName = this.config.siteName || url.hostname;
-        return `${url.protocol}//${host}/${siteName}`;
+        var siteName1 = this.config.siteName || url.hostname;
+        return `${url.protocol}//${host}/${siteName1}`;
       } catch (unused) {
         var result = base;
         if (this.config.socketPort) {
           result = result.replace(/(:\d+)/, `:${this.config.socketPort}`);
         }
-        var siteName1 = this.config.siteName || result.replace(/^https?:\/\//, "").split(/[/:]/)[0];
-        return `${result}/${siteName1}`;
+        var siteName2 = this.config.siteName || result.replace(/^https?:\/\//, "").split(/[/:]/)[0];
+        return `${result}/${siteName2}`;
       }
     }
   }, {
@@ -226,13 +243,17 @@ var RealtimeModule = /* @__PURE__ */function () {
       }
       this.healthyWaiters.clear();
     }
+  }, {
+    key: "isSSE",
+    value: function isSSE() {
+      return this.config.transport === "sse";
+    }
   }, {
     key: "waitUntilHealthy",
     value: function waitUntilHealthy() {
       var _this = this;
       var timeoutMs = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : 2e4;
-      var _this_socket;
-      if (this.socketHealthy && ((_this_socket = this.socket) === null || _this_socket === void 0 ? void 0 : _this_socket.connected)) return Promise.resolve(true);
+      if (this.isHealthy()) return Promise.resolve(true);
       return new Promise(function (resolve) {
         var timer = setTimeout(function () {
           _this.healthyWaiters.delete(onReady);
@@ -248,9 +269,8 @@ var RealtimeModule = /* @__PURE__ */function () {
   }, {
     key: "ensureConnected",
     value: async function ensureConnected() {
-      var _this_socket;
-      if (this.socketHealthy && ((_this_socket = this.socket) === null || _this_socket === void 0 ? void 0 : _this_socket.connected)) return;
-      if (!this.socket && !this.isConnecting) {
+      if (this.isHealthy()) return;
+      if (!this.socket && !this.eventSource && !this.isConnecting) {
         await this.connect();
       }
       await this.waitUntilHealthy();
@@ -306,7 +326,17 @@ var RealtimeModule = /* @__PURE__ */function () {
     }
   }, {
     key: "connect",
-    value: async function connect() {
+    value: (
+    /**
+    * Open the realtime transport now. Room-driven auto-connect
+    * (subscribeDoc/subscribeList) remains the primary lifecycle in both
+    * transports — this is public for SSE consumers that use no doc/list room
+    * bookkeeping: a one-way stream has nothing to emit on join, so nothing
+    * else would ever open it. Idempotent while a transport exists or a
+    * connect is in flight.
+    */
+    async function connect() {
+      if (this.isSSE()) return this.connectSSE();
       if (this.socket || this.isConnecting) return;
       this.isConnecting = true;
       try {
@@ -334,7 +364,259 @@ var RealtimeModule = /* @__PURE__ */function () {
         this.resolveHealthyWaiters(false);
         throw err;
       }
+    })
+  }, {
+    key: "connectSSE",
+    value: (
+    /**
+    * SSE branch of connect(): construct an EventSource against the configured
+    * stream URL. EventSource connects at construction, auto-reconnects on
+    * failure, and resumes missed frames itself by sending the stream's last
+    * `id:` as the `Last-Event-ID` request header — none of that is
+    * reimplemented here.
+    */
+    async function connectSSE() {
+      if (this.eventSource || this.isConnecting) return;
+      this.isConnecting = true;
+      try {
+        var _ref;
+        var sse = this.config.sse;
+        var EventSourceCtor = (_ref = sse === null || sse === void 0 ? void 0 : sse.EventSource) !== null && _ref !== void 0 ? _ref : globalThis.EventSource;
+        if (!EventSourceCtor) {
+          throw new Error('[RealtimeModule] transport "sse" needs an EventSource implementation, and this runtime has no global EventSource (React Native and Node < 22 ship none). Pass a constructor via config.sse.EventSource \u2014 e.g. the "eventsource" npm package on Node or "react-native-sse" on React Native.');
+        }
+        var url = await this.buildSSEURL();
+        this.eventSource = new EventSourceCtor(url, {
+          withCredentials: sse === null || sse === void 0 ? void 0 : sse.withCredentials
+        });
+        this.initSSEHandlers();
+      } catch (err) {
+        this.isConnecting = false;
+        this.resolveHealthyWaiters(false);
+        throw err;
+      }
+    })
+  }, {
+    key: "buildSSEURL",
+    value: async function buildSSEURL() {
+      var _ref;
+      var _this_config_sse;
+      var sse = this.config.sse;
+      var url;
+      if (sse === null || sse === void 0 ? void 0 : sse.url) {
+        url = sse.url;
+      } else if (sse === null || sse === void 0 ? void 0 : sse.path) {
+        var base = this.config.baseURL.replace(/\/$/, "");
+        url = `${base}${sse.path.startsWith("/") ? "" : "/"}${sse.path}`;
+      } else {
+        throw new Error('[RealtimeModule] transport "sse" requires config.sse.url or config.sse.path. There is no default stream path: SSE endpoints are server-specific (the SHC daemon serves "/api/method/shc.events.stream"; a real Frappe bench has no SSE endpoint at all), so a framework default would only ever 404.');
+      }
+      var params = Object.entries((_ref = (_this_config_sse = this.config.sse) === null || _this_config_sse === void 0 ? void 0 : _this_config_sse.queryParams) !== null && _ref !== void 0 ? _ref : {});
+      if (params.length === 0) return url;
+      var parts = [];
+      var _iteratorNormalCompletion = true,
+        _didIteratorError = false,
+        _iteratorError = void 0;
+      try {
+        for (var _iterator = params[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+          var [key, value] = _step.value;
+          var resolved = typeof value === "function" ? await value() : value;
+          parts.push(`${encodeURIComponent(key)}=${encodeURIComponent(resolved)}`);
+        }
+      } catch (err) {
+        _didIteratorError = true;
+        _iteratorError = err;
+      } finally {
+        try {
+          if (!_iteratorNormalCompletion && _iterator.return != null) {
+            _iterator.return();
+          }
+        } finally {
+          if (_didIteratorError) {
+            throw _iteratorError;
+          }
+        }
+      }
+      return `${url}${url.includes("?") ? "&" : "?"}${parts.join("&")}`;
     }
+  }, {
+    key: "initSSEHandlers",
+    value: function initSSEHandlers() {
+      var _ref;
+      var _this_config_sse;
+      this.attachedSseEvents.clear();
+      this.sseListeners.clear();
+      this.attachSSEListener("open");
+      this.attachSSEListener("error");
+      this.attachSSEListener("message");
+      var _iteratorNormalCompletion = true,
+        _didIteratorError = false,
+        _iteratorError = void 0;
+      try {
+        for (var _iterator = ((_ref = (_this_config_sse = this.config.sse) === null || _this_config_sse === void 0 ? void 0 : _this_config_sse.events) !== null && _ref !== void 0 ? _ref : [])[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+          var type = _step.value;
+          this.attachSSEListener(type);
+        }
+      } catch (err) {
+        _didIteratorError = true;
+        _iteratorError = err;
+      } finally {
+        try {
+          if (!_iteratorNormalCompletion && _iterator.return != null) {
+            _iterator.return();
+          }
+        } finally {
+          if (_didIteratorError) {
+            throw _iteratorError;
+          }
+        }
+      }
+      var _iteratorNormalCompletion1 = true,
+        _didIteratorError1 = false,
+        _iteratorError1 = void 0;
+      try {
+        for (var _iterator1 = this.handlerMap.keys()[Symbol.iterator](), _step1; !(_iteratorNormalCompletion1 = (_step1 = _iterator1.next()).done); _iteratorNormalCompletion1 = true) {
+          var event = _step1.value;
+          this.attachSSEListener(event);
+        }
+      } catch (err) {
+        _didIteratorError1 = true;
+        _iteratorError1 = err;
+      } finally {
+        try {
+          if (!_iteratorNormalCompletion1 && _iterator1.return != null) {
+            _iterator1.return();
+          }
+        } finally {
+          if (_didIteratorError1) {
+            throw _iteratorError1;
+          }
+        }
+      }
+    }
+  }, {
+    key: "attachSSEListener",
+    value: function attachSSEListener(type) {
+      var _this = this;
+      if (!this.eventSource || this.attachedSseEvents.has(type)) return;
+      var listener = function listener2(event) {
+        _this.handleSSEEvent(type, event);
+      };
+      this.sseListeners.set(type, listener);
+      this.attachedSseEvents.add(type);
+      this.eventSource.addEventListener(type, listener);
+    }
+  }, {
+    key: "detachSSEListener",
+    value: function detachSSEListener(type) {
+      if (this.isCoreSSEType(type)) return;
+      if (!this.eventSource || !this.attachedSseEvents.has(type)) return;
+      var listener = this.sseListeners.get(type);
+      if (listener) {
+        this.eventSource.removeEventListener(type, listener);
+        this.sseListeners.delete(type);
+      }
+      this.attachedSseEvents.delete(type);
+    }
+  }, {
+    key: "isCoreSSEType",
+    value: function isCoreSSEType(type) {
+      var _ref;
+      var _this_config_sse;
+      return type === "open" || type === "error" || type === "message" || ((_ref = (_this_config_sse = this.config.sse) === null || _this_config_sse === void 0 ? void 0 : _this_config_sse.events) !== null && _ref !== void 0 ? _ref : []).includes(type);
+    }
+  }, {
+    key: "handleSSEEvent",
+    value: (
+    /**
+    * Single entry point for everything the EventSource dispatches. Dataless
+    * events are transport lifecycle (`open`/`error` as plain Events); anything
+    * carrying `data` is a server frame — including frames the server
+    * classified `event: error`, which arrive as MessageEvents WITH data and
+    * must not be mistaken for connection errors.
+    */
+    function handleSSEEvent(type, event) {
+      var _event_lastEventId;
+      var _this_config_sse;
+      if ((event === null || event === void 0 ? void 0 : event.data) === void 0) {
+        if (type === "open") {
+          this.isConnecting = false;
+          this.socketHealthy = true;
+          this.emitToHandlers("connected", {
+            transport: "sse"
+          });
+          this.resolveHealthyWaiters(true);
+        } else if (type === "error") {
+          this.isConnecting = false;
+          this.socketHealthy = false;
+          this.emitToHandlers("disconnect", {
+            reason: "sse-error"
+          });
+          this.resolveHealthyWaiters(false);
+        }
+        return;
+      }
+      var frame = {
+        type,
+        data: String(event.data),
+        lastEventId: (_event_lastEventId = event.lastEventId) !== null && _event_lastEventId !== void 0 ? _event_lastEventId : ""
+      };
+      var mapFrame = (_this_config_sse = this.config.sse) === null || _this_config_sse === void 0 ? void 0 : _this_config_sse.mapFrame;
+      if (mapFrame) {
+        var mapped;
+        try {
+          mapped = mapFrame(frame);
+        } catch (err) {
+          console.warn("[RealtimeModule] sse.mapFrame threw; frame dropped:", err);
+          return;
+        }
+        if (!mapped) return;
+        var _iteratorNormalCompletion = true,
+          _didIteratorError = false,
+          _iteratorError = void 0;
+        try {
+          for (var _iterator = mapped[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+            var {
+              event: mappedEvent,
+              payload
+            } = _step.value;
+            this.emitToHandlers(mappedEvent, payload);
+          }
+        } catch (err) {
+          _didIteratorError = true;
+          _iteratorError = err;
+        } finally {
+          try {
+            if (!_iteratorNormalCompletion && _iterator.return != null) {
+              _iterator.return();
+            }
+          } finally {
+            if (_didIteratorError) {
+              throw _iteratorError;
+            }
+          }
+        }
+        return;
+      }
+      var payload1 = frame.data;
+      try {
+        payload1 = JSON.parse(frame.data);
+      } catch (unused) {}
+      this.emitToHandlers(frame.type, payload1);
+    })
+  }, {
+    key: "logSSERoomNoticeOnce",
+    value: (
+    /**
+    * Logged once: SSE is one-way, so doc/list room membership can't be sent
+    * upstream — rooms are recorded client-side (see getDocRooms/getListRooms)
+    * for mapFrame-driven filtering and for a future two-way transport.
+    */
+    function logSSERoomNoticeOnce() {
+      if (this.sseRoomNoticeLogged) return;
+      this.sseRoomNoticeLogged = true;
+      console.debug("[RealtimeModule] SSE transport is one-way: doc/list room subscriptions are recorded client-side only (getDocRooms()/getListRooms()) and nothing is sent to the server \u2014 filter server-side via sse.queryParams or route frames with sse.mapFrame.");
+    })
   }, {
     key: "softDisconnect",
     value: (
@@ -350,8 +632,36 @@ var RealtimeModule = /* @__PURE__ */function () {
         this.socket.disconnect();
         this.socket = void 0;
       }
+      if (this.eventSource) {
+        var _iteratorNormalCompletion = true,
+          _didIteratorError = false,
+          _iteratorError = void 0;
+        try {
+          for (var _iterator = this.sseListeners[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+            var [type, listener] = _step.value;
+            this.eventSource.removeEventListener(type, listener);
+          }
+        } catch (err) {
+          _didIteratorError = true;
+          _iteratorError = err;
+        } finally {
+          try {
+            if (!_iteratorNormalCompletion && _iterator.return != null) {
+              _iterator.return();
+            }
+          } finally {
+            if (_didIteratorError) {
+              throw _iteratorError;
+            }
+          }
+        }
+        this.eventSource.close();
+        this.eventSource = void 0;
+      }
       this.attachedSocketEvents.clear();
       this.socketEventHandlers.clear();
+      this.attachedSseEvents.clear();
+      this.sseListeners.clear();
       this.socketHealthy = false;
       this.isConnecting = false;
       this.resolveHealthyWaiters(false);
@@ -482,7 +792,11 @@ var RealtimeModule = /* @__PURE__ */function () {
         this.handlerMap.set(event, handlerSet);
       }
       handlerSet.add(handler);
-      this.attachSocketListener(event);
+      if (this.isSSE()) {
+        this.attachSSEListener(event);
+      } else {
+        this.attachSocketListener(event);
+      }
     }
   }, {
     key: "off",
@@ -492,7 +806,11 @@ var RealtimeModule = /* @__PURE__ */function () {
       handlerSet.delete(handler);
       if (handlerSet.size === 0) {
         this.handlerMap.delete(event);
-        this.detachSocketListener(event);
+        if (this.isSSE()) {
+          this.detachSSEListener(event);
+        } else {
+          this.detachSocketListener(event);
+        }
       }
     }
   }, {
@@ -502,8 +820,9 @@ var RealtimeModule = /* @__PURE__ */function () {
         doctype,
         name
       });
+      if (this.isSSE()) this.logSSERoomNoticeOnce();
       await this.ensureConnected();
-      if (this.socket && this.socketHealthy) {
+      if (!this.isSSE() && this.socket && this.socketHealthy) {
         this.socket.emit("doc_subscribe", doctype, name);
       }
     }
@@ -511,7 +830,7 @@ var RealtimeModule = /* @__PURE__ */function () {
     key: "unsubscribeDoc",
     value: function unsubscribeDoc(doctype, name) {
       this.docRooms.delete(docRoomKey(doctype, name));
-      if (this.socket && this.socketHealthy) {
+      if (!this.isSSE() && this.socket && this.socketHealthy) {
         this.socket.emit("doc_unsubscribe", doctype, name);
       }
       this.teardownWhenIdle();
@@ -531,8 +850,9 @@ var RealtimeModule = /* @__PURE__ */function () {
         doctype,
         filters
       });
+      if (this.isSSE()) this.logSSERoomNoticeOnce();
       await this.ensureConnected();
-      if (this.socket && this.socketHealthy) {
+      if (!this.isSSE() && this.socket && this.socketHealthy) {
         this.socket.emit("doctype_subscribe", doctype);
       }
     })
@@ -540,7 +860,7 @@ var RealtimeModule = /* @__PURE__ */function () {
     key: "unsubscribeList",
     value: function unsubscribeList(doctype) {
       this.listRooms.delete(doctype);
-      if (this.socket && this.socketHealthy) {
+      if (!this.isSSE() && this.socket && this.socketHealthy) {
         this.socket.emit("doctype_unsubscribe", doctype);
       }
       this.teardownWhenIdle();
@@ -559,7 +879,7 @@ var RealtimeModule = /* @__PURE__ */function () {
     */
     function teardownWhenIdle() {
       if (this.docRooms.size > 0 || this.listRooms.size > 0) return;
-      if (!this.socket && !this.isConnecting) return;
+      if (!this.socket && !this.eventSource && !this.isConnecting) return;
       this.emitToHandlers("disconnect", {
         reason: "idle-teardown"
       });
@@ -569,6 +889,7 @@ var RealtimeModule = /* @__PURE__ */function () {
     key: "isHealthy",
     value: function isHealthy() {
       var _this_socket;
+      if (this.isSSE()) return this.socketHealthy && this.eventSource !== void 0;
       return this.socketHealthy && ((_this_socket = this.socket) === null || _this_socket === void 0 ? void 0 : _this_socket.connected) === true;
     }
   }, {
@@ -583,7 +904,7 @@ var RealtimeModule = /* @__PURE__ */function () {
     key: "updateAuth",
     value: async function updateAuth(auth) {
       this.config.auth = auth;
-      var shouldReconnect = this.docRooms.size > 0 || this.listRooms.size > 0;
+      var shouldReconnect = this.docRooms.size > 0 || this.listRooms.size > 0 || this.isSSE() && this.eventSource !== void 0;
       this.softDisconnect();
       if (shouldReconnect) {
         await this.connect();
@@ -592,6 +913,13 @@ var RealtimeModule = /* @__PURE__ */function () {
   }, {
     key: "emit",
     value: function emit(event, data) {
+      if (this.isSSE()) {
+        if (!this.sseEmitNoticeLogged) {
+          this.sseEmitNoticeLogged = true;
+          console.debug("[RealtimeModule] emit() is a no-op under the SSE transport \u2014 SSE is one-way (server \u2192 client). Use HTTP calls for client \u2192 server communication.");
+        }
+        return;
+      }
       if (this.socket && this.socketHealthy) {
         this.socket.emit(event, data);
       }
@@ -601,6 +929,28 @@ var RealtimeModule = /* @__PURE__ */function () {
     value: function getSocket() {
       return this.socket;
     }
+  }, {
+    /** Live EventSource when the SSE transport is connected (undefined otherwise). */
+    key: "getEventSource",
+    value: function getEventSource() {
+      return this.eventSource;
+    }
+  }, {
+    /**
+    * Doc rooms recorded by subscribeDoc. Under SSE these are client-side
+    * bookkeeping only (nothing is emitted upstream) — mapFrame-driven apps
+    * consult them to filter or route frames.
+    */
+    key: "getDocRooms",
+    value: function getDocRooms() {
+      return [...this.docRooms.values()];
+    }
+  }, {
+    /** List rooms recorded by subscribeList — same client-side semantics as getDocRooms. */
+    key: "getListRooms",
+    value: function getListRooms() {
+      return [...this.listRooms.values()];
+    }
   }]);
   return RealtimeModule2;
 }();