react-native-nitro-sse 0.1.0-beta.1 → 0.1.0-beta.3

package/NitroSse.podspec

@@ -11,7 +11,7 @@ Pod::Spec.new do |s|
   s.authors      = package["author"]
 
   s.platforms    = { :ios => min_ios_version_supported }
-  s.source       = { :git => "https://github.com/MaiThanhNam141/react-native-nitro-sse.git", :tag => "#{s.version}" }
+  s.source       = { :git => "https://github.com/IAmTester35/react-native-nitro-sse.git", :tag => "#{s.version}" }
 
   s.source_files = [
     "ios/**/*.{swift}",

package/android/src/main/java/com/margelo/nitro/nitrosse/NitroSse.kt

@@ -266,6 +266,19 @@ class NitroSse : HybridNitroSseSpec() {
         }
     }
 
+    override fun flush() {
+        flushBufferToJs()
+    }
+
+    override fun restart() {
+        stop()
+        start()
+    }
+
+    override fun isConnected(): Boolean {
+        return isRunning.get()
+    }
+
     override fun stop() {
         isRunning.set(false)
         backoffCounter = 0 
@@ -275,5 +288,6 @@ class NitroSse : HybridNitroSseSpec() {
         synchronized(eventBuffer) {
             eventBuffer.clear()
         }
+        isFlushPending.set(false)
     }
 }

package/ios/NitroSse.swift

@@ -183,13 +183,38 @@ class NitroSse: HybridNitroSseSpec, EventHandler {
 
     func stop() {
         sseQueue.async {
-            self.isRunning = false
-            self.eventSource?.stop()
-            self.eventSource = nil
-            self.backoffCounter = 0
-            self.eventBuffer.removeAll()
-            self.isFlushPending = false
-            self.cleanupBackgroundTask()
+            self.stopInternal()
+        }
+    }
+
+    private func stopInternal() {
+        self.isRunning = false
+        self.eventSource?.stop()
+        self.eventSource = nil
+        self.backoffCounter = 0
+        self.eventBuffer.removeAll()
+        self.isFlushPending = false
+        self.cleanupBackgroundTask()
+    }
+
+    func flush() {
+        sseQueue.async {
+            self.flushEventsToJs()
+        }
+    }
+
+    func restart() {
+        sseQueue.async {
+            self.stopInternal()
+            guard !self.isRunning else { return } // Should be false now
+            self.isRunning = true
+            self.establishConnection()
+        }
+    }
+
+    func isConnected() -> Bool {
+        return sseQueue.sync {
+            return isRunning
         }
     }
     

package/lib/module/index.js

@@ -3,20 +3,15 @@
 import { NitroModules } from 'react-native-nitro-modules';
 export * from "./SseInterface.js";
 export * from "./NitroSse.nitro.js";
-
-// Load the Hybrid Object from Native
-let realNitroSse;
-try {
-  realNitroSse = NitroModules.createHybridObject('NitroSse');
-} catch {
-  console.debug('Native NitroSse not found. This might be a test environment or web.');
-}
-
-/**
- * Public interface to use SSE.
- */
-if (!realNitroSse || !realNitroSse.setup) {
-  throw new Error('NitroSse: Native module not found. Ensure you have linked the library and built the app for iOS/Android.');
+export function createNitroSse() {
+  let nativeSse;
+  try {
+    nativeSse = NitroModules.createHybridObject('NitroSse');
+  } catch {}
+  if (!nativeSse) {
+    console.debug('Native NitroSse not found. This might be a test environment or web.');
+    throw new Error('NitroSse: Native module not found. Ensure you have linked the library and built the app for iOS/Android.');
+  }
+  return nativeSse;
 }
-export const NitroSseModule = realNitroSse;
 //# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["NitroModules","realNitroSse","createHybridObject","console","debug","setup","Error","NitroSseModule"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,SAASA,YAAY,QAAQ,4BAA4B;AAGzD,cAAc,mBAAgB;AAC9B,cAAc,qBAAkB;;AAEhC;AACA,IAAIC,YAAkC;AACtC,IAAI;EACFA,YAAY,GAAGD,YAAY,CAACE,kBAAkB,CAAW,UAAU,CAAC;AACtE,CAAC,CAAC,MAAM;EACNC,OAAO,CAACC,KAAK,CACX,qEACF,CAAC;AACH;;AAEA;AACA;AACA;AACA,IAAI,CAACH,YAAY,IAAI,CAAEA,YAAY,CAASI,KAAK,EAAE;EACjD,MAAM,IAAIC,KAAK,CACb,0GACF,CAAC;AACH;AAEA,OAAO,MAAMC,cAAwB,GAAGN,YAAY","ignoreList":[]}
+{"version":3,"names":["NitroModules","createNitroSse","nativeSse","createHybridObject","console","debug","Error"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,SAASA,YAAY,QAAQ,4BAA4B;AAGzD,cAAc,mBAAgB;AAC9B,cAAc,qBAAkB;AAEhC,OAAO,SAASC,cAAcA,CAAA,EAAa;EACzC,IAAIC,SAA+B;EACnC,IAAI;IACFA,SAAS,GAAGF,YAAY,CAACG,kBAAkB,CAAW,UAAU,CAAC;EACnE,CAAC,CAAC,MAAM,CAAC;EAET,IAAI,CAACD,SAAS,EAAE;IACdE,OAAO,CAACC,KAAK,CACX,qEACF,CAAC;IACD,MAAM,IAAIC,KAAK,CACb,0GACF,CAAC;EACH;EACA,OAAOJ,SAAS;AAClB","ignoreList":[]}

package/lib/typescript/src/NitroSse.nitro.d.ts

@@ -30,5 +30,19 @@ export interface NitroSse extends HybridObject<{
      * Get connection statistics.
      */
     getStats(): SseStats;
+    /**
+     * Manually flush the event buffer.
+     * Useful when batching is enabled but you need to process pending events immediately.
+     */
+    flush(): void;
+    /**
+     * Force a reconnection.
+     * This resets the connection state and attempts to reconnect immediately.
+     */
+    restart(): void;
+    /**
+     * Check if the connection is currently active.
+     */
+    isConnected(): boolean;
 }
 //# sourceMappingURL=NitroSse.nitro.d.ts.map

package/lib/typescript/src/NitroSse.nitro.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NitroSse.nitro.d.ts","sourceRoot":"","sources":["../../../src/NitroSse.nitro.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAEpE,MAAM,WAAW,QACf,SAAQ,YAAY,CAAC;IAAE,GAAG,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC;IACzD;;OAEG;IACH,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;IAEtE;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;;OAGG;IACH,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,QAAQ,IAAI,QAAQ,CAAC;CACtB"}
+{"version":3,"file":"NitroSse.nitro.d.ts","sourceRoot":"","sources":["../../../src/NitroSse.nitro.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAEpE,MAAM,WAAW,QACf,SAAQ,YAAY,CAAC;IAAE,GAAG,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC;IACzD;;OAEG;IACH,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;IAEtE;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;;OAGG;IACH,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,QAAQ,IAAI,QAAQ,CAAC;IACrB;;;OAGG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;OAGG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC;CACxB"}

package/lib/typescript/src/SseInterface.d.ts

@@ -1,25 +1,70 @@
+/**
+ * HTTP method to use for the SSE connection.
+ */
 export type HttpMethod = 'get' | 'post';
+/**
+ * Type of event received from the SSE stream.
+ * - `open`: Connection established.
+ * - `message`: Standard data message.
+ * - `error`: Connection error or other failure.
+ * - `close`: Connection closed (not typical for SSE, but used for cleanup).
+ * - `heartbeat`: Ping/Keep-alive signal.
+ */
 export type SseEventType = 'open' | 'message' | 'error' | 'close' | 'heartbeat';
+/**
+ * Configuration for the SSE connection.
+ */
 export interface SseConfig {
+    /** The URL of the SSE endpoint. */
     url: string;
+    /** HTTP method (default: 'GET'). */
     method?: HttpMethod;
+    /** Custom HTTP headers to include in the request. */
     headers?: Record<string, string>;
+    /** Body for POST requests. */
     body?: string;
+    /**
+     * Whether to continue processing events when the app is in the background.
+     * Note: OS limitations may restrict background execution time.
+     * @default false
+     */
     backgroundExecution?: boolean;
+    /**
+     * Interval in milliseconds to batch events before sending them to JS.
+     * Set to 0 to disable batching (real-time mode).
+     */
     batchingIntervalMs?: number;
+    /**
+     * Maximum number of events to hold in the buffer before forced flushing.
+     */
     maxBufferSize?: number;
 }
+/**
+ * Represents a single SSE event.
+ */
 export interface SseEvent {
+    /** The type of the event. */
     type: SseEventType;
+    /** The data payload of the event. */
     data?: string;
+    /** The event ID, if provided. */
     id?: string;
+    /** The event name, if provided (internal 'event' field in SSE). */
     event?: string;
+    /** System message or error description. */
     message?: string;
 }
+/**
+ * Statistics about the SSE connection.
+ */
 export interface SseStats {
+    /** Total bytes received so far. */
     totalBytesReceived: number;
+    /** Number of times the connection has been re-established. */
     reconnectCount: number;
+    /** Timestamp of the last error event. */
     lastErrorTime?: number;
+    /** Error code of the last error. */
     lastErrorCode?: string;
 }
 //# sourceMappingURL=SseInterface.d.ts.map

package/lib/typescript/src/SseInterface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SseInterface.d.ts","sourceRoot":"","sources":["../../../src/SseInterface.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,CAAC;AAExC,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,WAAW,CAAC;AAEhF,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,QAAQ;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}
+{"version":3,"file":"SseInterface.d.ts","sourceRoot":"","sources":["../../../src/SseInterface.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,CAAC;AAExC;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,WAAW,CAAC;AAEhF;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,oCAAoC;IACpC,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,qDAAqD;IACrD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,8BAA8B;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,6BAA6B;IAC7B,IAAI,EAAE,YAAY,CAAC;IACnB,qCAAqC;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,mCAAmC;IACnC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,8DAA8D;IAC9D,cAAc,EAAE,MAAM,CAAC;IACvB,yCAAyC;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}

package/lib/typescript/src/index.d.ts

@@ -1,5 +1,5 @@
 import type { NitroSse } from './NitroSse.nitro';
 export * from './SseInterface';
 export * from './NitroSse.nitro';
-export declare const NitroSseModule: NitroSse;
+export declare function createNitroSse(): NitroSse;
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AAqBjC,eAAO,MAAM,cAAc,EAAE,QAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AAEjC,wBAAgB,cAAc,IAAI,QAAQ,CAezC"}

package/nitrogen/generated/android/c++/JHybridNitroSseSpec.cpp

@@ -106,5 +106,18 @@ namespace margelo::nitro::nitrosse {
     auto __result = method(_javaPart);
     return __result->toCpp();
   }
+  void JHybridNitroSseSpec::flush() {
+    static const auto method = javaClassStatic()->getMethod<void()>("flush");
+    method(_javaPart);
+  }
+  void JHybridNitroSseSpec::restart() {
+    static const auto method = javaClassStatic()->getMethod<void()>("restart");
+    method(_javaPart);
+  }
+  bool JHybridNitroSseSpec::isConnected() {
+    static const auto method = javaClassStatic()->getMethod<jboolean()>("isConnected");
+    auto __result = method(_javaPart);
+    return static_cast<bool>(__result);
+  }
 
 } // namespace margelo::nitro::nitrosse

package/nitrogen/generated/android/c++/JHybridNitroSseSpec.hpp

@@ -61,6 +61,9 @@ namespace margelo::nitro::nitrosse {
     void setLastProcessedId(const std::string& id) override;
     void updateHeaders(const std::unordered_map<std::string, std::string>& headers) override;
     SseStats getStats() override;
+    void flush() override;
+    void restart() override;
+    bool isConnected() override;
 
   private:
     friend HybridBase;

package/nitrogen/generated/android/kotlin/com/margelo/nitro/nitrosse/HybridNitroSseSpec.kt

@@ -73,6 +73,18 @@ abstract class HybridNitroSseSpec: HybridObject() {
   @DoNotStrip
   @Keep
   abstract fun getStats(): SseStats
+  
+  @DoNotStrip
+  @Keep
+  abstract fun flush(): Unit
+  
+  @DoNotStrip
+  @Keep
+  abstract fun restart(): Unit
+  
+  @DoNotStrip
+  @Keep
+  abstract fun isConnected(): Boolean
 
   private external fun initHybrid(): HybridData
 

package/nitrogen/generated/ios/NitroSse-Swift-Cxx-Bridge.hpp

@@ -206,5 +206,14 @@ namespace margelo::nitro::nitrosse::bridge::swift {
   inline Result_SseStats_ create_Result_SseStats_(const std::exception_ptr& error) noexcept {
     return Result<SseStats>::withError(error);
   }
+  
+  // pragma MARK: Result<bool>
+  using Result_bool_ = Result<bool>;
+  inline Result_bool_ create_Result_bool_(bool value) noexcept {
+    return Result<bool>::withValue(std::move(value));
+  }
+  inline Result_bool_ create_Result_bool_(const std::exception_ptr& error) noexcept {
+    return Result<bool>::withError(error);
+  }
 
 } // namespace margelo::nitro::nitrosse::bridge::swift

package/nitrogen/generated/ios/c++/HybridNitroSseSpecSwift.hpp

@@ -122,6 +122,26 @@ namespace margelo::nitro::nitrosse {
       auto __value = std::move(__result.value());
       return __value;
     }
+    inline void flush() override {
+      auto __result = _swiftPart.flush();
+      if (__result.hasError()) [[unlikely]] {
+        std::rethrow_exception(__result.error());
+      }
+    }
+    inline void restart() override {
+      auto __result = _swiftPart.restart();
+      if (__result.hasError()) [[unlikely]] {
+        std::rethrow_exception(__result.error());
+      }
+    }
+    inline bool isConnected() override {
+      auto __result = _swiftPart.isConnected();
+      if (__result.hasError()) [[unlikely]] {
+        std::rethrow_exception(__result.error());
+      }
+      auto __value = std::move(__result.value());
+      return __value;
+    }
 
   private:
     NitroSse::HybridNitroSseSpec_cxx _swiftPart;

package/nitrogen/generated/ios/swift/HybridNitroSseSpec.swift

@@ -19,6 +19,9 @@ public protocol HybridNitroSseSpec_protocol: HybridObject {
   func setLastProcessedId(id: String) throws -> Void
   func updateHeaders(headers: Dictionary<String, String>) throws -> Void
   func getStats() throws -> SseStats
+  func flush() throws -> Void
+  func restart() throws -> Void
+  func isConnected() throws -> Bool
 }
 
 public extension HybridNitroSseSpec_protocol {

package/nitrogen/generated/ios/swift/HybridNitroSseSpec_cxx.swift

@@ -209,4 +209,38 @@ open class HybridNitroSseSpec_cxx {
       return bridge.create_Result_SseStats_(__exceptionPtr)
     }
   }
+  
+  @inline(__always)
+  public final func flush() -> bridge.Result_void_ {
+    do {
+      try self.__implementation.flush()
+      return bridge.create_Result_void_()
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_void_(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func restart() -> bridge.Result_void_ {
+    do {
+      try self.__implementation.restart()
+      return bridge.create_Result_void_()
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_void_(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func isConnected() -> bridge.Result_bool_ {
+    do {
+      let __result = try self.__implementation.isConnected()
+      let __resultCpp = __result
+      return bridge.create_Result_bool_(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_bool_(__exceptionPtr)
+    }
+  }
 }

package/nitrogen/generated/shared/c++/HybridNitroSseSpec.cpp

@@ -20,6 +20,9 @@ namespace margelo::nitro::nitrosse {
       prototype.registerHybridMethod("setLastProcessedId", &HybridNitroSseSpec::setLastProcessedId);
       prototype.registerHybridMethod("updateHeaders", &HybridNitroSseSpec::updateHeaders);
       prototype.registerHybridMethod("getStats", &HybridNitroSseSpec::getStats);
+      prototype.registerHybridMethod("flush", &HybridNitroSseSpec::flush);
+      prototype.registerHybridMethod("restart", &HybridNitroSseSpec::restart);
+      prototype.registerHybridMethod("isConnected", &HybridNitroSseSpec::isConnected);
     });
   }
 

package/nitrogen/generated/shared/c++/HybridNitroSseSpec.hpp

@@ -65,6 +65,9 @@ namespace margelo::nitro::nitrosse {
       virtual void setLastProcessedId(const std::string& id) = 0;
       virtual void updateHeaders(const std::unordered_map<std::string, std::string>& headers) = 0;
       virtual SseStats getStats() = 0;
+      virtual void flush() = 0;
+      virtual void restart() = 0;
+      virtual bool isConnected() = 0;
 
     protected:
       // Hybrid Setup

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-nitro-sse",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0-beta.3",
   "description": "High-performance Server-Sent Events (SSE) for React Native, powered by Nitro Modules.",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",

package/src/NitroSse.nitro.ts

@@ -34,4 +34,20 @@ export interface NitroSse
    * Get connection statistics.
    */
   getStats(): SseStats;
+  /**
+   * Manually flush the event buffer.
+   * Useful when batching is enabled but you need to process pending events immediately.
+   */
+  flush(): void;
+
+  /**
+   * Force a reconnection.
+   * This resets the connection state and attempts to reconnect immediately.
+   */
+  restart(): void;
+
+  /**
+   * Check if the connection is currently active.
+   */
+  isConnected(): boolean;
 }

package/src/SseInterface.ts

@@ -1,28 +1,73 @@
+/**
+ * HTTP method to use for the SSE connection.
+ */
 export type HttpMethod = 'get' | 'post';
 
+/**
+ * Type of event received from the SSE stream.
+ * - `open`: Connection established.
+ * - `message`: Standard data message.
+ * - `error`: Connection error or other failure.
+ * - `close`: Connection closed (not typical for SSE, but used for cleanup).
+ * - `heartbeat`: Ping/Keep-alive signal.
+ */
 export type SseEventType = 'open' | 'message' | 'error' | 'close' | 'heartbeat';
 
+/**
+ * Configuration for the SSE connection.
+ */
 export interface SseConfig {
+  /** The URL of the SSE endpoint. */
   url: string;
+  /** HTTP method (default: 'GET'). */
   method?: HttpMethod;
+  /** Custom HTTP headers to include in the request. */
   headers?: Record<string, string>;
+  /** Body for POST requests. */
   body?: string;
+  /**
+   * Whether to continue processing events when the app is in the background.
+   * Note: OS limitations may restrict background execution time.
+   * @default false
+   */
   backgroundExecution?: boolean;
+  /**
+   * Interval in milliseconds to batch events before sending them to JS.
+   * Set to 0 to disable batching (real-time mode).
+   */
   batchingIntervalMs?: number;
+  /**
+   * Maximum number of events to hold in the buffer before forced flushing.
+   */
   maxBufferSize?: number;
 }
 
+/**
+ * Represents a single SSE event.
+ */
 export interface SseEvent {
+  /** The type of the event. */
   type: SseEventType;
+  /** The data payload of the event. */
   data?: string;
+  /** The event ID, if provided. */
   id?: string;
+  /** The event name, if provided (internal 'event' field in SSE). */
   event?: string;
+  /** System message or error description. */
   message?: string;
 }
 
+/**
+ * Statistics about the SSE connection.
+ */
 export interface SseStats {
+  /** Total bytes received so far. */
   totalBytesReceived: number;
+  /** Number of times the connection has been re-established. */
   reconnectCount: number;
+  /** Timestamp of the last error event. */
   lastErrorTime?: number;
+  /** Error code of the last error. */
   lastErrorCode?: string;
 }

package/src/index.tsx

@@ -4,23 +4,19 @@ import type { NitroSse } from './NitroSse.nitro';
 export * from './SseInterface';
 export * from './NitroSse.nitro';
 
-// Load the Hybrid Object from Native
-let realNitroSse: NitroSse | undefined;
-try {
-  realNitroSse = NitroModules.createHybridObject<NitroSse>('NitroSse');
-} catch {
-  console.debug(
-    'Native NitroSse not found. This might be a test environment or web.'
-  );
-}
+export function createNitroSse(): NitroSse {
+  let nativeSse: NitroSse | undefined;
+  try {
+    nativeSse = NitroModules.createHybridObject<NitroSse>('NitroSse');
+  } catch {}
 
-/**
- * Public interface to use SSE.
- */
-if (!realNitroSse || !(realNitroSse as any).setup) {
-  throw new Error(
-    'NitroSse: Native module not found. Ensure you have linked the library and built the app for iOS/Android.'
-  );
+  if (!nativeSse) {
+    console.debug(
+      'Native NitroSse not found. This might be a test environment or web.'
+    );
+    throw new Error(
+      'NitroSse: Native module not found. Ensure you have linked the library and built the app for iOS/Android.'
+    );
+  }
+  return nativeSse;
 }
-
-export const NitroSseModule: NitroSse = realNitroSse;