node-sword-interface 1.0.42 → 1.0.44

package/.github/workflows/build.yml

@@ -18,7 +18,7 @@ jobs:
     
     build-windows:
         name: Run Windows build
-        runs-on: windows-2019
+        runs-on: windows-2022
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         steps:

package/API.md

@@ -692,6 +692,7 @@ An object representation of a SWORD module.
 | shortCopyright | <code>String</code> | The short copyright information of the SWORD module |
 | version | <code>String</code> | The version of the SWORD module |
 | lastUpdate | <code>String</code> | The date of the last version update of the SWORD module |
+| history | <code>Array.&lt;String&gt;</code> | The history of the SWORD module. A list of strings where each looks like this: <version>=<version-info> |
 | category | <code>String</code> | The category of the SWORD module |
 | repository | <code>String</code> | The repository of the SWORD module |
 | about | <code>String</code> | Extended description of the SWORD module |

package/index.js

@@ -18,6 +18,10 @@
 
 const path = require('path');
 const nodeSwordInterfaceModule = require('./build/Release/node_sword_interface.node');
+const { Mutex } = require('async-mutex');
+
+// Create a mutex instance
+const searchMutex = new Mutex();
 
 /**
 * An object representation of a Bible verse.
@@ -43,6 +47,7 @@ const nodeSwordInterfaceModule = require('./build/Release/node_sword_interface.n
  * @property {String} shortCopyright - The short copyright information of the SWORD module
  * @property {String} version - The version of the SWORD module
  * @property {String} lastUpdate - The date of the last version update of the SWORD module
+ * @property {String[]} history - The history of the SWORD module. A list of strings where each looks like this: <version>=<version-info>
  * @property {String} category - The category of the SWORD module
  * @property {String} repository - The repository of the SWORD module
  * @property {String} about - Extended description of the SWORD module
@@ -112,7 +117,7 @@ class NodeSwordInterface {
    * @param {Function} progressCB - Optional callback function that is called on progress events.
    * @return {Promise}
    */
-  updateRepositoryConfig(progressCB=undefined) {
+  async updateRepositoryConfig(progressCB=undefined) {
     return new Promise((resolve, reject) => {
       if (progressCB === undefined) {
         progressCB = function(progress) {};
@@ -241,7 +246,7 @@ class NodeSwordInterface {
    * @param {Function} progressCB - Callback function that is called on progress events.
    * @return {Promise}
    */
-  installModule(moduleCode, progressCB=undefined) {
+  async installModule(moduleCode, progressCB=undefined) {
     if (progressCB === undefined) {
       progressCB = function(progress) {};
     }
@@ -272,7 +277,7 @@ class NodeSwordInterface {
    * @param {String} moduleCode - The module code of the SWORD module that shall be uninstalled.
    * @return {Promise}
    */
-  uninstallModule(moduleCode) {
+  async uninstallModule(moduleCode) {
     return new Promise((resolve, reject) => {
       this.nativeInterface.uninstallModule(moduleCode, function(uninstallSuccessful) {
         if (uninstallSuccessful) {
@@ -595,21 +600,27 @@ class NodeSwordInterface {
    * @param {Boolean} filterOnWordBoundaries - Whether to filter results based on word boundaries.
    * @return {Promise}
    */
-  getModuleSearchResults(moduleCode,
-                         searchTerm,
-                         progressCB = undefined,
-                         searchType = "phrase",
-                         searchScope = "BIBLE",
-                         isCaseSensitive = false,
-                         useExtendedVerseBoundaries = false,
-                         filterOnWordBoundaries = false) {
+  async getModuleSearchResults(moduleCode,
+                               searchTerm,
+                               progressCB = undefined,
+                               searchType = "phrase",
+                               searchScope = "BIBLE",
+                               isCaseSensitive = false,
+                               useExtendedVerseBoundaries = false,
+                               filterOnWordBoundaries = false) {
 
     if (progressCB === undefined) {
       progressCB = function(progress) {};
     }
 
-    return new Promise((resolve, reject) => {
-      try {
+    if (searchMutex.isLocked()) {
+      throw new Error("Module search in progress. Wait until it is finished.");
+    }
+
+    const release = await searchMutex.acquire();
+
+    try {
+      return new Promise((resolve, reject) => {
         this.nativeInterface.getModuleSearchResults(moduleCode,
                                                     searchTerm,
                                                     searchType,
@@ -618,11 +629,15 @@ class NodeSwordInterface {
                                                     useExtendedVerseBoundaries,
                                                     filterOnWordBoundaries,
                                                     progressCB,
-                                                    function(searchResults) { resolve(searchResults); });
-      } catch (error) {
-        reject(error);
-      }
-    });
+                                                    function(searchResults) {
+          release();
+          resolve(searchResults);
+        });
+      });
+    } catch (error) {
+      release();
+      throw error;
+    }
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-sword-interface",
-  "version": "1.0.42",
+  "version": "1.0.44",
   "description": "Javascript (N-API) interface to SWORD library",
   "keywords": [
     "C++",
@@ -17,11 +17,13 @@
     "doc": "jsdoc2md index.js > API.md",
     "pub": "rm -rf build node_modules sword sword_build test && npm publish ./",
     "deploy": "scripts/deploy_local.sh",
-    "postinstall": "node scripts/postinstall.js"
+    "postinstall": "node scripts/postinstall.js",
+    "test": "jest"
   },
   "author": "Tobias Klein",
   "license": "GPL-2.0+",
   "dependencies": {
+    "async-mutex": "^0.5.0",
     "glob": "^8.0.3",
     "node-addon-api": "^8.2.2",
     "node-html-parser": "^6.1.13"
@@ -31,6 +33,7 @@
     "url": "git+https://github.com/ezra-bible-app/node-sword-interface.git"
   },
   "devDependencies": {
+    "jest": "^30.0.5",
     "jsdoc-to-markdown": "^9.1.1",
     "node-gyp": "^9.1.0"
   }

package/scripts/build_sword.sh

@@ -47,6 +47,10 @@ mkdir -p sword_build
 
 SWORD_BUILD_TYPE="Release"
 
+# Newer CMake versions have removed compatibility with CMake < 3.5.
+# SWORD is configured with CMake minimum 2.6.0, which leads to a build error with newer CMake versions (e.g. 4.0.3).
+export CMAKE_POLICY_VERSION_MINIMUM=3.5
+
 if [ "$1" = "--android" ] ; then
   git clone https://github.com/karlkleinpaste/biblesync.git
   git -C biblesync checkout 2.1.0

package/scripts/get_sword_build_win32.ps1

@@ -57,9 +57,12 @@ if (Test-Path sword-build-win32) {
 }
 
 # --- Download the file to the current location
-$OutputPath = "$((Get-Location).Path)\$ZipName"
+$OutputPath = Join-Path -Path (Get-Location).Path -ChildPath $ZipName
 Invoke-RestMethod -Method Get -Uri $ZipUrl -OutFile $OutputPath -Headers $headers
 
+Write-Host "OutputPath: $OutputPath"
+Write-Host "ZipUrl: $ZipUrl"
+
 # --- Unzip the zip file and remove it afterwards
 unzip $OutputPath $((Get-Location).Path)
 Remove-Item $OutputPath

package/src/napi_module/napi_sword_helper.cpp

@@ -128,6 +128,10 @@ void NapiSwordHelper::swordModuleToNapiObject(const Napi::Env& env, SWModule* sw
 
     object["hasGreekStrongsKeys"] = Napi::Boolean::New(env, this->_moduleHelper.moduleHasFeature(swModule, "GreekDef"));
     object["hasHebrewStrongsKeys"] = Napi::Boolean::New(env, this->_moduleHelper.moduleHasFeature(swModule, "HebrewDef"));
+    
+    // Add module history entries
+    std::vector<std::string> historyEntries = this->_moduleHelper.getModuleHistoryEntries(swModule);
+    object["history"] = this->getNapiArrayFromStringVector(env, historyEntries);
 }
 
 Napi::String NapiSwordHelper::getConfigEntry(sword::SWModule* swModule, std::string key, const Napi::Env& env)

package/src/sword_backend/module_helper.cpp

@@ -198,6 +198,45 @@ map<string, int> ModuleHelper::getAbsoluteVerseNumberMap(SWModule* module, vecto
     return absoluteVerseNumbers;
 }
 
+vector<string> ModuleHelper::getModuleConfigEntries(sword::SWModule* module)
+{
+    vector<string> configEntries;
+    
+    const ConfigEntMap& config = module->getConfig();
+    
+    for (ConfigEntMap::const_iterator it = config.begin(); it != config.end(); ++it) {
+        configEntries.push_back(it->first.c_str());
+    }
+    
+    return configEntries;
+}
+
+std::vector<std::string> ModuleHelper::getModuleHistoryEntries(sword::SWModule* module)
+{
+    std::vector<std::string> historyEntries;
+    
+    if (module == 0) {
+        cerr << "module is 0! Cannot get history entries!" << endl;
+        return historyEntries;
+    }
+    
+    // Get all config entries
+    const ConfigEntMap& config = module->getConfig();
+    
+    // Find all entries that start with "History_"
+    for (ConfigEntMap::const_iterator it = config.begin(); it != config.end(); ++it) {
+        std::string key = it->first.c_str();
+        if (key.find("History_") == 0) {
+            std::string value = it->second.c_str();
+            std::string version = key.substr(8); // Remove "History_" prefix
+            std::string entry = version + "=" + value;
+            historyEntries.push_back(entry);
+        }
+    }
+    
+    return historyEntries;
+}
+
 bool ModuleHelper::isBrokenMarkupModule(std::string moduleName)
 {
     return std::find(this->_brokenMarkupModules.begin(),

package/src/sword_backend/module_helper.hpp

@@ -50,6 +50,8 @@ public:
     std::map<std::string, int> getAbsoluteVerseNumberMap(sword::SWModule* module, std::vector<std::string> bookList={});
     bool isBrokenMarkupModule(std::string moduleName);
     bool isInconsistentClosingEndDivModule(std::string moduleName);
+    std::vector<std::string> getModuleConfigEntries(sword::SWModule* module);
+    std::vector<std::string> getModuleHistoryEntries(sword::SWModule* module);
 
 private:
     bool moduleHasKeyValuePair(sword::SWModule* module, std::string key, std::string value);