cordova-plugin-crosswire-sword 0.2.11 → 0.2.13

package/RELEASENOTES.md

@@ -20,6 +20,17 @@
 -->
 # Release Notes
 
+### 0.2.13 (Oct 6, 2026)
+* BibleSync: every call into the library is made under one lock, on both platforms. Its receive loop runs on a thread of the plugin's while the page's sends and questions arrive on Cordova's, and the library keeps no lock of its own; a verse sent as a packet was being received could be refused as "still receiving", or worse
+* iOS: the engine header the Swift bridge compiles against is refreshed whenever the package is built
+
+### 0.2.12 (Oct 5, 2026)
+* BibleSync on a network that loses packets, as Wi-Fi does: each verse carries a sequence number and is sent three times, which a receiver shows once; a peer is kept through half an hour of silence, not one minute; a newcomer is answered at once, twice; a beacon every 10 seconds (biblesync 2.2.0 with pull requests 19 and 20)
+* startBibleSync takes options { repeatCount, repeatDelayMS, peerLifetimeS }; the defaults are 2, 500 and 1800
+* getBibleSyncStatus says whether a running session is still alive on the same network interface (off, alive, disabled, moved), so an app resumed from sleep or the background restarts BibleSync only when it must
+* The page hears BibleSync's interface, its peers and its errors on both platforms ({ cmd: info | peer | error }); a beacon that cannot be sent while the phone sleeps no longer ends the session
+* iOS: BibleSync is offered (features.bibleSync), the app carrying Apple's multicast entitlement; every received message had been dropped
+
 ### 0.2.11 (Oct 1, 2026)
 * Study data (bookmarks and, in time, notes) in a folder of the user's choosing, named sword-studydata so several devices and SWORD apps can share it (doc/bookmarks-format.md in Bishop): a picked folder holding bookmarks/, or itself named sword-studydata, is used as it is, otherwise sword-studydata/ is made inside it
 * iOS: the study-data folder may be in iCloud Drive or any app's folder; where a provider grants files but no folder (Google Drive), the bookmark files are picked in place (SWMgr_chooseDataFiles) or Bishop's own are saved there and opened once (SWMgr_exportDataFiles); a provider's file is rewritten in place so it keeps its identity

package/libs/ios/SWORD.xcframework/ios-arm64/libSWORD.a

@@ -1,4 +1,4 @@
 [diffend] Oversized file quarantined before diffing.
 name: package/libs/ios/SWORD.xcframework/ios-arm64/libSWORD.a
-size: 37229112 bytes
-sha256: 3e031f0b4dbd6b3c5096cadf56adca793363d9d4bb40ad0810e79e2d2d4e7260
+size: 37343432 bytes
+sha256: b0a320876d2a063731888664d4a30338e9fa1044e90c3474c343da2e94d7af50

package/libs/ios/SWORD.xcframework/ios-arm64-simulator/libSWORD.a

@@ -1,4 +1,4 @@
 [diffend] Oversized file quarantined before diffing.
 name: package/libs/ios/SWORD.xcframework/ios-arm64-simulator/libSWORD.a
-size: 37272016 bytes
-sha256: d4a361c089cb1384d15fce6755470d9d3bd012d8acf7af69ba27315ea4f71ae8
+size: 37386424 bytes
+sha256: da32b199627dac42856912d00b71a959e402f45eaf4b72777a30507765fcd26d

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "cordova-plugin-crosswire-sword",
-  "version": "0.2.11",
+  "version": "0.2.13",
   "description": "The SWORD Project Plugin",
+  "scripts": {
+    "prepack": "cp ../../../include/defs.h ../../../include/flatapi.h src/ios/"
+  },
   "files": [
     "plugin.xml",
     "libs",

package/plugin.xml

@@ -4,7 +4,7 @@
     xmlns:rim="http://www.blackberry.com/ns/widgets"
     xmlns:android="http://schemas.android.com/apk/res/android"
     id="cordova-plugin-crosswire-sword"
-    version="0.2.11">
+    version="0.2.13">
     <name>cordova-plugin-crosswire-sword</name>
     <description>The SWORD Project Plugin</description>
     <license>GNU 2.0</license>

package/src/android/SWMgr.java

@@ -164,9 +164,32 @@ public class SWMgr {
 	public static interface BibleSyncListener {
 		public void navReceived(String osisRef);
 		public void chatReceived(String user, String message);
+		/** the interface address BibleSync is on */
+		public void infoReceived(String iface);
+		/**
+		 * @param state 'A' a peer announced itself, 'S' it is a speaker we now listen to, 'D' a speaker went quiet
+		 * @param who user @ address ('D': the uuid)
+		 * @param what app version; device; uuid ('D': empty)
+		 */
+		public void peerReceived(char state, String who, String what);
+		/** the library could not send, or stopped itself: what it said, and its detail */
+		public void errorReceived(String message, String detail);
 	}
 	public native void        startBibleSync(String appName, String userName, String passphrase, BibleSyncListener listener);
+	/**
+	 * For the next startBibleSync; a negative value leaves that one as it is.
+	 * @param repeatCount how many more times each verse is sent (nobody resends multicast); default 2
+	 * @param repeatDelayMS at least this long between those; default 500
+	 * @param peerLifetimeS a peer not heard from for this many seconds is given up; default 1800
+	 */
+	public native void        setBibleSyncOptions(int repeatCount, int repeatDelayMS, int peerLifetimeS);
 	public native void        stopBibleSync();
+	/**
+	 * @return "off" (not running), "alive <address>",
+	 * "disabled <address>" (the library shut itself down) or
+	 * "moved <address> <address now>" (the network changed under it)
+	 */
+	public native String      getBibleSyncStatus();
 	public native void        sendBibleSyncMessage(String osisRef);
 }
 

package/src/android/SWORD.java

@@ -552,6 +552,8 @@ Log.d(TAG, "SWModule_getRenderChapter");
 			final String appName = args.getString(0);
 			final String userName = args.getString(1);
 			final String passphrase = args.getString(2);
+			// repeatCount, repeatDelayMS, peerLifetimeS: -1 (or absent) keeps the default
+			mgr.setBibleSyncOptions(args.optInt(3, -1), args.optInt(4, -1), args.optInt(5, -1));
 
 			if (multicastLock == null) {
 				WifiManager wifi = (WifiManager) cordova.getActivity().getApplicationContext().getSystemService(Context.WIFI_SERVICE);
@@ -586,6 +588,42 @@ Log.d(TAG, "SWModule_getRenderChapter");
 						}
 						catch (Exception e) { e.printStackTrace(); }
 					}
+					public void infoReceived(String iface) {
+						try {
+							JSONObject m = new JSONObject();
+							m.put("cmd", "info");
+							m.put("interface", iface);
+							PluginResult result = new PluginResult(PluginResult.Status.OK, m);
+							result.setKeepCallback(true);
+							bibleSyncListener.sendPluginResult(result);
+						}
+						catch (Exception e) { e.printStackTrace(); }
+					}
+					public void peerReceived(char state, String who, String what) {
+						try {
+							JSONObject m = new JSONObject();
+							m.put("cmd", "peer");
+							m.put("state", state == 'A' ? "announce" : (state == 'S' ? "speaker" : "gone"));
+							m.put("who", who);
+							m.put("what", what);
+							PluginResult result = new PluginResult(PluginResult.Status.OK, m);
+							result.setKeepCallback(true);
+							bibleSyncListener.sendPluginResult(result);
+						}
+						catch (Exception e) { e.printStackTrace(); }
+					}
+					public void errorReceived(String message, String detail) {
+						try {
+							JSONObject m = new JSONObject();
+							m.put("cmd", "error");
+							m.put("message", message);
+							m.put("detail", detail);
+							PluginResult result = new PluginResult(PluginResult.Status.OK, m);
+							result.setKeepCallback(true);
+							bibleSyncListener.sendPluginResult(result);
+						}
+						catch (Exception e) { e.printStackTrace(); }
+					}
 				});
 			    }
 			});
@@ -599,6 +637,16 @@ Log.d(TAG, "SWModule_getRenderChapter");
 			if (multicastLock != null && multicastLock.isHeld()) multicastLock.release();
 			callbackContext.success();
 		}
+		else if (action.equals("SWMgr_getBibleSyncStatus")) {
+			// "alive 10.0.0.5" -> { state, alive, interface, current }
+			String[] s = mgr.getBibleSyncStatus().split(" ");
+			JSONObject r = new JSONObject();
+			r.put("state", s[0]);
+			r.put("alive", s[0].equals("alive"));
+			r.put("interface", s.length > 1 ? s[1] : "");
+			r.put("current", s.length > 2 ? s[2] : (s.length > 1 ? s[1] : ""));
+			callbackContext.success(r);
+		}
 		else if (action.equals("SWMgr_setJavascript")) {
 			boolean val = args.getBoolean(0);
 			mgr.setJavascript(val);

package/src/ios/SWORD.swift

@@ -98,8 +98,8 @@ var mySWORDPlugin:SWORD? = nil
             "version": libswordVersion,
             // what the page may offer on iOS (SWORD.features)
             // bibleSync: multicast needs com.apple.developer.networking.multicast,
-            // requested from Apple; true once the app is signed with it
-            "features": [ "dataStorage": true, "dataFiles": true, "sharedStorage": false, "bibleSync": false ]
+            // which Apple granted the account on 2026-10-01 and Bishop's config.xml carries
+            "features": [ "dataStorage": true, "dataFiles": true, "sharedStorage": false, "bibleSync": true ]
         ] as [AnyHashable : Any]
 		self.commandDelegate!.send(CDVPluginResult(status: CDVCommandStatus_OK, messageAs: info), callbackId: command.callbackId)
 	}
@@ -1210,6 +1210,12 @@ debugPrint("initMgr, mgr: " + String(describing: mgr))
         let appName = command.arguments[0] as? String ?? ""
         let userName = command.arguments[1] as? String ?? ""
         let passphrase = command.arguments[2] as? String ?? ""
+        // optional: how often a verse is repeated and how far apart, and how long
+        // a silent peer is kept (-1 or absent = the library's default)
+        let opt = { (i: Int) -> Int32 in
+            command.arguments.count > i ? Int32(truncatingIfNeeded: (command.arguments[i] as? Int) ?? -1) : -1
+        }
+        org_crosswire_sword_SWMgr_setBibleSyncOptions(mgr, opt(3), opt(4), opt(5))
             bibleSyncCallbackID = command.callbackId
             DispatchQueue.global().async {
                 mySWORDPlugin = self
@@ -1217,8 +1223,10 @@ debugPrint("initMgr, mgr: " + String(describing: mgr))
                     // a nav message carries no second string (flatapi passes 0)
                     let response1 = str1 == nil ? "" : String(cString: str1!)
                     let response2 = str2 == nil ? "" : String(cString: str2!)
+                    // (CChar("N") is Int8's failable parse of the string "N", i.e. nil,
+                    // which equals no command: every message was dropped that way)
                     if (mySWORDPlugin != nil && mySWORDPlugin!.bibleSyncCallbackID != "") {
-			if (cmd == CChar("N")) {
+			if (cmd == CChar(UInt8(ascii: "N"))) {
 				var retVal = [String:Any]()
 				retVal["cmd"]     = "nav";
 				retVal["osisRef"] = response1;
@@ -1226,7 +1234,7 @@ debugPrint("initMgr, mgr: " + String(describing: mgr))
 				result.setKeepCallbackAs(true)
 				mySWORDPlugin!.commandDelegate!.send(result, callbackId: mySWORDPlugin!.bibleSyncCallbackID)
 			}
-			else if (cmd == CChar("C")	) {
+			else if (cmd == CChar(UInt8(ascii: "C"))	) {
 				var retVal = [String:Any]()
 				retVal["cmd"]     = "chat";
 				retVal["user"]    = response1;
@@ -1235,6 +1243,36 @@ debugPrint("initMgr, mgr: " + String(describing: mgr))
 				result.setKeepCallbackAs(true)
 				mySWORDPlugin!.commandDelegate!.send(result, callbackId: mySWORDPlugin!.bibleSyncCallbackID)
 			}
+			else if (cmd == CChar(UInt8(ascii: "I"))) {
+				// the interface address BibleSync is on
+				var retVal = [String:Any]()
+				retVal["cmd"]       = "info";
+				retVal["interface"] = response1;
+				let result = CDVPluginResult(status: CDVCommandStatus_OK, messageAs: retVal)
+				result.setKeepCallbackAs(true)
+				mySWORDPlugin!.commandDelegate!.send(result, callbackId: mySWORDPlugin!.bibleSyncCallbackID)
+			}
+			else if (cmd == CChar(UInt8(ascii: "A")) || cmd == CChar(UInt8(ascii: "S")) || cmd == CChar(UInt8(ascii: "D"))) {
+				// a peer announced itself, became a speaker we listen to, or went quiet
+				var retVal = [String:Any]()
+				retVal["cmd"]   = "peer";
+				retVal["state"] = cmd == CChar(UInt8(ascii: "A")) ? "announce" : (cmd == CChar(UInt8(ascii: "S")) ? "speaker" : "gone");
+				retVal["who"]   = response1;	// user @ address ('gone': the uuid)
+				retVal["what"]  = response2;	// app version; device; uuid
+				let result = CDVPluginResult(status: CDVCommandStatus_OK, messageAs: retVal)
+				result.setKeepCallbackAs(true)
+				mySWORDPlugin!.commandDelegate!.send(result, callbackId: mySWORDPlugin!.bibleSyncCallbackID)
+			}
+			else if (cmd == CChar(UInt8(ascii: "E"))) {
+				// the library stopped itself: what it said, and its detail
+				var retVal = [String:Any]()
+				retVal["cmd"]     = "error";
+				retVal["message"] = response1;
+				retVal["detail"]  = response2;
+				let result = CDVPluginResult(status: CDVCommandStatus_OK, messageAs: retVal)
+				result.setKeepCallbackAs(true)
+				mySWORDPlugin!.commandDelegate!.send(result, callbackId: mySWORDPlugin!.bibleSyncCallbackID)
+			}
                     }
                 });
                 
@@ -1250,6 +1288,21 @@ debugPrint("initMgr, mgr: " + String(describing: mgr))
             self.commandDelegate!.send(result, callbackId: command.callbackId)
     }
     
+    // "off" | "alive <addr>" | "disabled <addr>" | "moved <addr> <addr now>", as
+    // { state, alive, interface, current }: the page asks before restarting on resume
+    @objc(SWMgr_getBibleSyncStatus:)
+    func SWMgr_getBibleSyncStatus(command: CDVInvokedUrlCommand) {
+        initMgr()
+        let status = String(cString: org_crosswire_sword_SWMgr_getBibleSyncStatus(mgr))
+        let parts = status.split(separator: " ").map { String($0) }
+        var retVal = [String:Any]()
+        retVal["state"]     = parts.count > 0 ? parts[0] : "off"
+        retVal["alive"]     = parts.count > 0 && parts[0] == "alive"
+        retVal["interface"] = parts.count > 1 ? parts[1] : ""
+        retVal["current"]   = parts.count > 2 ? parts[2] : (parts.count > 1 ? parts[1] : "")
+        self.commandDelegate!.send(CDVPluginResult(status: CDVCommandStatus_OK, messageAs: retVal), callbackId: command.callbackId)
+    }
+
     @objc(SWMgr_stopBibleSync:)
     func SWMgr_stopBibleSync(command: CDVInvokedUrlCommand) {
         initMgr()

package/src/ios/flatapi.h

@@ -611,6 +611,22 @@ void SWDLLEXPORT org_crosswire_sword_SWMgr_startBibleSync
 void SWDLLEXPORT org_crosswire_sword_SWMgr_stopBibleSync
 	(SWHANDLE hMgr);
 
+/*
+ * Class:     org_crosswire_android_sword_SWMgr
+ * Method:    setBibleSyncOptions
+ * Signature: (III)V
+ */
+void SWDLLEXPORT org_crosswire_sword_SWMgr_setBibleSyncOptions
+	(SWHANDLE hMgr, int repeatCount, int repeatDelayMS, int peerLifetimeS);
+
+/*
+ * Class:     org_crosswire_android_sword_SWMgr
+ * Method:    getBibleSyncStatus
+ * Signature: ()Ljava/lang/String;
+ */
+const char * SWDLLEXPORT org_crosswire_sword_SWMgr_getBibleSyncStatus
+	(SWHANDLE hMgr);
+
 /*
  * Class:     org_crosswire_android_sword_SWMgr
  * Method:    sendBibleSyncMessage

package/www/SWORD.js

@@ -381,10 +381,16 @@ SWMgr.prototype.addExtraConfig = function(confBlob, callback) {
 	return retVal;
 }
 
-SWMgr.prototype.startBibleSync = function(appName, userName, passphrase, callback) {
+// options (all optional; the plugin's defaults otherwise):
+//   repeatCount    how many more times each verse is sent, since nobody resends multicast (2)
+//   repeatDelayMS  at least this long between those (500)
+//   peerLifetimeS  a peer not heard from for this many seconds is given up (1800)
+SWMgr.prototype.startBibleSync = function(appName, userName, passphrase, callback, options) {
+	var o = options || {};
+	var opt = function(v) { return (typeof v === 'number' && v >= 0) ? Math.floor(v) : -1; };
 	exec(callback,
 		function(err) { utils.alert('[ERROR] problem: ' + err); },
-		"SWORD", "SWMgr_startBibleSync", [appName, userName, passphrase]
+		"SWORD", "SWMgr_startBibleSync", [appName, userName, passphrase, opt(o.repeatCount), opt(o.repeatDelayMS), opt(o.peerLifetimeS)]
 	);
 }
 
@@ -395,6 +401,16 @@ SWMgr.prototype.stopBibleSync = function() {
 	);
 }
 
+// whether a running BibleSync session is still worth keeping (after sleep or
+// the background): { state: 'off'|'alive'|'disabled'|'moved', alive, interface,
+// current }; null where the platform cannot say
+SWMgr.prototype.getBibleSyncStatus = function(callback) {
+	exec(callback,
+		function(err) { callback(null); },
+		"SWORD", "SWMgr_getBibleSyncStatus", []
+	);
+}
+
 SWMgr.prototype.sendBibleSyncMessage = function(osisRef, callback) {
 	exec(callback?callback:function() {},
 		function(err) { utils.alert('[ERROR] problem: ' + err); },