node-sword-interface 1.0.97 → 1.0.98

package/API.md

@@ -39,17 +39,17 @@ This is the main class of node-sword-interface and it provides a set of static f
     * [.getAllRepoModules(repositoryName, moduleType)](#NodeSwordInterface+getAllRepoModules) ⇒ [<code>Array.&lt;ModuleObject&gt;</code>](#ModuleObject)
     * [.getRepoModulesByLang(repositoryName, language, moduleType, headersFilter, strongsFilter, hebrewStrongsKeys, greekStrongsKeys)](#NodeSwordInterface+getRepoModulesByLang) ⇒ [<code>Array.&lt;ModuleObject&gt;</code>](#ModuleObject)
     * [.getUpdatedRepoModules(repositoryName, includeBeta)](#NodeSwordInterface+getUpdatedRepoModules) ⇒ [<code>Array.&lt;ModuleObject&gt;</code>](#ModuleObject)
-    * [.getRepoModule(moduleCode)](#NodeSwordInterface+getRepoModule) ⇒ [<code>ModuleObject</code>](#ModuleObject)
+    * [.getRepoModule(repositoryName, moduleCode)](#NodeSwordInterface+getRepoModule) ⇒ [<code>ModuleObject</code>](#ModuleObject)
     * [.getAllLocalModules(moduleType)](#NodeSwordInterface+getAllLocalModules) ⇒ [<code>Array.&lt;ModuleObject&gt;</code>](#ModuleObject)
     * [.getRepoModuleCount(repositoryName, moduleType)](#NodeSwordInterface+getRepoModuleCount) ⇒ <code>Number</code>
     * [.getRepoLanguageModuleCount(repositoryName, language, moduleType)](#NodeSwordInterface+getRepoLanguageModuleCount) ⇒ <code>Number</code>
-    * [.installModule(moduleCode, progressCB)](#NodeSwordInterface+installModule) ⇒ <code>Promise</code>
+    * [.installModule(repositoryName, moduleCode, progressCB)](#NodeSwordInterface+installModule) ⇒ <code>Promise</code>
     * [.cancelInstallation()](#NodeSwordInterface+cancelInstallation)
     * [.uninstallModule(moduleCode)](#NodeSwordInterface+uninstallModule) ⇒ <code>Promise</code>
     * [.refreshLocalModules()](#NodeSwordInterface+refreshLocalModules)
     * [.saveModuleUnlockKey(moduleCode, key)](#NodeSwordInterface+saveModuleUnlockKey)
     * [.isModuleReadable(moduleCode)](#NodeSwordInterface+isModuleReadable) ⇒ <code>Boolean</code>
-    * [.getModuleDescription(moduleCode)](#NodeSwordInterface+getModuleDescription) ⇒ <code>String</code>
+    * [.getModuleDescription(repositoryName, moduleCode)](#NodeSwordInterface+getModuleDescription) ⇒ <code>String</code>
     * [.enableMarkup()](#NodeSwordInterface+enableMarkup)
     * [.disableMarkup()](#NodeSwordInterface+disableMarkup)
     * [.enableStrongsWithNbsp()](#NodeSwordInterface+enableStrongsWithNbsp)
@@ -77,7 +77,7 @@ This is the main class of node-sword-interface and it provides a set of static f
     * [.getStrongsEntry(strongsKey)](#NodeSwordInterface+getStrongsEntry) ⇒ [<code>StrongsEntry</code>](#StrongsEntry)
     * [.getLocalModule(moduleCode)](#NodeSwordInterface+getLocalModule) ⇒ [<code>ModuleObject</code>](#ModuleObject)
     * [.isModuleInUserDir(moduleCode)](#NodeSwordInterface+isModuleInUserDir) ⇒ <code>Boolean</code>
-    * [.isModuleAvailableInRepo(moduleCode)](#NodeSwordInterface+isModuleAvailableInRepo) ⇒ <code>Boolean</code>
+    * [.isModuleAvailableInRepo(moduleCode, repositoryName)](#NodeSwordInterface+isModuleAvailableInRepo) ⇒ <code>Boolean</code>
     * [.getSwordTranslation(originalString, localeCode)](#NodeSwordInterface+getSwordTranslation)
     * [.getBookAbbreviation(moduleName, bookCode, localeCode)](#NodeSwordInterface+getBookAbbreviation)
     * [.unTarGZ(filePath, destPath)](#NodeSwordInterface+unTarGZ) ⇒ <code>Boolean</code>
@@ -90,11 +90,12 @@ This is the main class of node-sword-interface and it provides a set of static f
 ### new NodeSwordInterface(customHomeDir, localesBasePath, timeoutMillis)
 Creates an instance of NodeSwordInterface.
 
+
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| customHomeDir | <code>String</code> | <code>undefined</code> | Optional custom home directory for SWORD data. |
-| localesBasePath | <code>String</code> | <code>__dirname</code> | Optional base path for locales. |
-| timeoutMillis | <code>Number</code> | <code>20000</code> | Optional timeout in milliseconds for repository operations. Invalid values (≤ 0 or non-numeric) trigger a warning and fallback to the default. |
+| customHomeDir | <code>String</code> |  | Optional custom home directory for SWORD data. |
+| localesBasePath | <code>String</code> |  | Optional base path for locales (default: __dirname). |
+| timeoutMillis | <code>Number</code> | <code>20000</code> | Optional timeout in milliseconds for repository operations (default: 20000). |
 
 <a name="NodeSwordInterface+repositoryConfigExisting"></a>
 
@@ -189,13 +190,14 @@ Returns all updated modules from all repositories or one specific repository.
 
 <a name="NodeSwordInterface+getRepoModule"></a>
 
-### nodeSwordInterface.getRepoModule(moduleCode) ⇒ [<code>ModuleObject</code>](#ModuleObject)
+### nodeSwordInterface.getRepoModule(repositoryName, moduleCode) ⇒ [<code>ModuleObject</code>](#ModuleObject)
 Returns an object representation of a SWORD module from a repository.
 
 **Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)  
 
 | Param | Type | Description |
 | --- | --- | --- |
+| repositoryName | <code>String</code> | The name of the repository to search in. |
 | moduleCode | <code>String</code> | The module code of the SWORD module. |
 
 <a name="NodeSwordInterface+getAllLocalModules"></a>
@@ -239,9 +241,9 @@ Returns the number of modules for a given repository and language (default: Bibl
 
 <a name="NodeSwordInterface+installModule"></a>
 
-### nodeSwordInterface.installModule(moduleCode, progressCB) ⇒ <code>Promise</code>
-Installs a module. The repository is automatically determined. The module is downloaded
-from the corresponding repository and then installed in the local SWORD directory.
+### nodeSwordInterface.installModule(repositoryName, moduleCode, progressCB) ⇒ <code>Promise</code>
+Installs a module. The module is downloaded from the corresponding repository 
+and then installed in the local SWORD directory.
 This operation may take some time depending on the available bandwidth and geographical
 distance to the SWORD repository server.
 
@@ -255,6 +257,7 @@ If the installation fails, the Promise will be rejected with the following statu
 
 | Param | Type | Description |
 | --- | --- | --- |
+| repositoryName | <code>String</code> | The name of the repository from which to install. |
 | moduleCode | <code>String</code> | The module code of the SWORD module that shall be installed. |
 | progressCB | <code>function</code> | Callback function that is called on progress events. |
 
@@ -310,7 +313,7 @@ Checks whether the module is readable.
 
 <a name="NodeSwordInterface+getModuleDescription"></a>
 
-### nodeSwordInterface.getModuleDescription(moduleCode) ⇒ <code>String</code>
+### nodeSwordInterface.getModuleDescription(repositoryName, moduleCode) ⇒ <code>String</code>
 Returns the description of a module.
 
 **Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)  
@@ -318,6 +321,7 @@ Returns the description of a module.
 
 | Param | Type | Description |
 | --- | --- | --- |
+| repositoryName | <code>String</code> | The name of the repository to search in. |
 | moduleCode | <code>String</code> | The module code of the SWORD module. |
 
 <a name="NodeSwordInterface+enableMarkup"></a>
@@ -623,14 +627,15 @@ Checks whether the module resides in the user directory.
 
 <a name="NodeSwordInterface+isModuleAvailableInRepo"></a>
 
-### nodeSwordInterface.isModuleAvailableInRepo(moduleCode) ⇒ <code>Boolean</code>
-Checks whether the module is available in any repository.
+### nodeSwordInterface.isModuleAvailableInRepo(moduleCode, repositoryName) ⇒ <code>Boolean</code>
+Checks whether the module is available in any repository (default) or in a specific repository.
 
 **Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| moduleCode | <code>String</code> | The module code of the SWORD module. |
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| moduleCode | <code>String</code> |  | The module code of the SWORD module. |
+| repositoryName | <code>String</code> | <code>all</code> | The name of the repository to check. |
 
 <a name="NodeSwordInterface+getSwordTranslation"></a>
 

package/examples/install_kjv.js

@@ -27,7 +27,7 @@ async function installKJV() {
 
   console.log("Installing King James module");
   // Install the King James Version (Uses the internet connection to download and install the module)
-  await interface.installModule('KJV');
+  await interface.installModule('CrossWire', 'KJV');
 }
 
 installKJV().then(() => {

package/index.js

@@ -213,11 +213,12 @@ class NodeSwordInterface {
   /**
    * Returns an object representation of a SWORD module from a repository.
    *
+   * @param {String} repositoryName - The name of the repository to search in.
    * @param {String} moduleCode - The module code of the SWORD module.
    * @return {ModuleObject}
    */
-  getRepoModule(moduleCode) {
-    return this.nativeInterface.getRepoModule(moduleCode);
+  getRepoModule(repositoryName, moduleCode) {
+    return this.nativeInterface.getRepoModule(repositoryName, moduleCode);
   }
 
   /**
@@ -253,8 +254,8 @@ class NodeSwordInterface {
   }
 
   /**
-   * Installs a module. The repository is automatically determined. The module is downloaded
-   * from the corresponding repository and then installed in the local SWORD directory.
+   * Installs a module. The module is downloaded from the corresponding repository 
+   * and then installed in the local SWORD directory.
    * This operation may take some time depending on the available bandwidth and geographical
    * distance to the SWORD repository server.
    *
@@ -264,17 +265,18 @@ class NodeSwordInterface {
    * -1: General installation issue
    * -9: Installation cancelled by user or internet connection suddenly interrupted
    *
+   * @param {String} repositoryName - The name of the repository from which to install.
    * @param {String} moduleCode - The module code of the SWORD module that shall be installed.
    * @param {Function} progressCB - Callback function that is called on progress events.
    * @return {Promise}
    */
-  async installModule(moduleCode, progressCB=undefined) {
+  async installModule(repositoryName, moduleCode, progressCB=undefined) {
     if (progressCB === undefined) {
       progressCB = function(progress) {};
     }
 
     return new Promise((resolve, reject) => {
-      this.nativeInterface.installModule(moduleCode, progressCB, function(result) {
+      this.nativeInterface.installModule(repositoryName, moduleCode, progressCB, function(result) {
         if (result == 0) {
           resolve();
         } else {
@@ -343,11 +345,12 @@ class NodeSwordInterface {
   /**
    * Returns the description of a module.
    *
+   * @param {String} repositoryName - The name of the repository to search in.
    * @param {String} moduleCode - The module code of the SWORD module.
    * @return {String} The description of the respective module.
    */
-  getModuleDescription(moduleCode) {
-    return this.nativeInterface.getModuleDescription(moduleCode);
+  getModuleDescription(repositoryName, moduleCode) {
+    return this.nativeInterface.getModuleDescription(repositoryName, moduleCode);
   }
 
   /**
@@ -730,13 +733,14 @@ class NodeSwordInterface {
   }
 
   /**
-   * Checks whether the module is available in any repository.
+   * Checks whether the module is available in any repository (default) or in a specific repository.
    *
    * @param {String} moduleCode - The module code of the SWORD module.
+   * @param {String} repositoryName - The name of the repository to check.
    * @return {Boolean}
    */
-  isModuleAvailableInRepo(moduleCode) {
-    return this.nativeInterface.isModuleAvailableInRepo(moduleCode);
+  isModuleAvailableInRepo(moduleCode, repositoryName="all") {
+    return this.nativeInterface.isModuleAvailableInRepo(moduleCode, repositoryName);
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-sword-interface",
-  "version": "1.0.97",
+  "version": "1.0.98",
   "description": "Javascript (N-API) interface to SWORD library",
   "keywords": [
     "C++",

package/scripts/build_sword.sh

@@ -132,4 +132,4 @@ else
   fi
 fi
 
-make -j4 sword_static
+make -j8 sword_static

package/src/napi_module/install_module_worker.cpp

@@ -80,7 +80,8 @@ void InstallModuleWorker::Execute(const ExecutionProgress& progress)
     this->_totalPercent = 0;
     this->_filePercent = 0;
 
-    this->_result = this->_moduleInstaller.installModule(this->_moduleName);
+    // Always use repository-specific installation
+    this->_result = this->_moduleInstaller.installModule(this->_repoName, this->_moduleName);
 
     statusReporter.resetCallbacks();
     unlockApi();

package/src/napi_module/install_module_worker.hpp

@@ -29,12 +29,14 @@ public:
                         ModuleInstaller& moduleInstaller,
                         const Napi::Function& jsProgressCallback,
                         const Napi::Function& callback,
+                        std::string repoName,
                         std::string moduleName)
 
         : ProgressWorker(repoInterface,
                          jsProgressCallback,
                          callback),
                          _moduleInstaller(moduleInstaller),
+                         _repoName(repoName),
                          _moduleName(moduleName) {}
 
     void swordPreStatusCB(long totalBytes, long completedBytes, const char *message);
@@ -46,6 +48,7 @@ private:
     ModuleInstaller& _moduleInstaller;
     int _result;
     std::string _moduleName;
+    std::string _repoName;
     long _completedBytes = 0;
     long _totalBytes = 0;
     int _totalPercent = 0;

package/src/napi_module/node_sword_interface.cpp

@@ -324,9 +324,23 @@ Napi::Value NodeSwordInterface::isModuleInUserDir(const Napi::CallbackInfo& info
 Napi::Value NodeSwordInterface::isModuleAvailableInRepo(const Napi::CallbackInfo& info)
 {
     lockApi();
-    INIT_SCOPE_AND_VALIDATE(ParamType::string);
+    INIT_SCOPE_AND_VALIDATE(ParamType::string, ParamType::string);
     Napi::String moduleName = info[0].As<Napi::String>();
-    bool moduleAvailable = this->_repoInterface->isModuleAvailableInRepo(moduleName);
+    Napi::String repoName = info[1].As<Napi::String>();
+
+    if (string(moduleName).empty()) {
+        Napi::TypeError::New(info.Env(), "Module name cannot be empty").ThrowAsJavaScriptException();
+        unlockApi();
+        return info.Env().Null();
+    }
+
+    if (string(repoName).empty()) {
+        Napi::TypeError::New(info.Env(), "Repository name cannot be empty").ThrowAsJavaScriptException();
+        unlockApi();
+        return info.Env().Null();
+    }
+    
+    bool moduleAvailable = this->_repoInterface->isModuleAvailableInRepo(moduleName, repoName);
     unlockApi();
     return Napi::Boolean::New(info.Env(), moduleAvailable);
 }
@@ -469,11 +483,23 @@ Napi::Value NodeSwordInterface::getRepoModule(const Napi::CallbackInfo& info)
 {
     lockApi();
     Napi::Env env = info.Env();
-    INIT_SCOPE_AND_VALIDATE(ParamType::string);
+    INIT_SCOPE_AND_VALIDATE(ParamType::string, ParamType::string);
     Napi::Object napiObject = Napi::Object::New(env);
-    Napi::String moduleName = info[0].As<Napi::String>();
+    Napi::String repoName = info[0].As<Napi::String>();
+    Napi::String moduleName = info[1].As<Napi::String>();
+
+    if (string(repoName).empty()) {
+        Napi::TypeError::New(env, "Repository name cannot be empty").ThrowAsJavaScriptException();
+        unlockApi();
+        return env.Null();
+    }
 
-    std::string repoName = this->_repoInterface->getModuleRepo(moduleName);
+    if (string(moduleName).empty()) {
+        Napi::TypeError::New(env, "Module name cannot be empty").ThrowAsJavaScriptException();
+        unlockApi();
+        return env.Null();
+    }
+    
     SWModule* swordModule = this->_repoInterface->getRepoModule(moduleName, repoName);
 
     if (swordModule == 0) {
@@ -492,10 +518,23 @@ Napi::Value NodeSwordInterface::getModuleDescription(const Napi::CallbackInfo& i
 {
     lockApi();
     Napi::Env env = info.Env();
-    INIT_SCOPE_AND_VALIDATE(ParamType::string);
-    Napi::String moduleName = info[0].As<Napi::String>();
+    INIT_SCOPE_AND_VALIDATE(ParamType::string, ParamType::string);
+    Napi::String repoName = info[0].As<Napi::String>();
+    Napi::String moduleName = info[1].As<Napi::String>();
+
+    if (string(repoName).empty()) {
+        Napi::TypeError::New(env, "Repository name cannot be empty").ThrowAsJavaScriptException();
+        unlockApi();
+        return env.Null();
+    }
 
-    SWModule* swordModule = this->_repoInterface->getRepoModule(moduleName);
+    if (string(moduleName).empty()) {
+        Napi::TypeError::New(env, "Module name cannot be empty").ThrowAsJavaScriptException();
+        unlockApi();
+        return env.Null();
+    }
+
+    SWModule* swordModule = this->_repoInterface->getRepoModule(moduleName, repoName);
     if (swordModule == 0) {
         string errorMessage = "getRepoModule returned 0 for '" + string(moduleName) + "'";
         THROW_JS_EXCEPTION(errorMessage);
@@ -867,15 +906,29 @@ Napi::Value NodeSwordInterface::getStrongsEntry(const Napi::CallbackInfo& info)
 Napi::Value NodeSwordInterface::installModule(const Napi::CallbackInfo& info)
 {
     lockApi();
-    INIT_SCOPE_AND_VALIDATE(ParamType::string, ParamType::function, ParamType::function);
-    Napi::String moduleName = info[0].As<Napi::String>();
-    Napi::Function progressCallback = info[1].As<Napi::Function>();
-    Napi::Function callback = info[2].As<Napi::Function>();
+    INIT_SCOPE_AND_VALIDATE(ParamType::string, ParamType::string, ParamType::function, ParamType::function);
+    Napi::String repoName = info[0].As<Napi::String>();
+    Napi::String moduleName = info[1].As<Napi::String>();
+    Napi::Function progressCallback = info[2].As<Napi::Function>();
+    Napi::Function callback = info[3].As<Napi::Function>();
+
+    if (string(repoName).empty()) {
+        Napi::TypeError::New(info.Env(), "Repository name cannot be empty").ThrowAsJavaScriptException();
+        unlockApi();
+        return info.Env().Null();
+    }
+
+    if (string(moduleName).empty()) {
+        Napi::TypeError::New(info.Env(), "Module name cannot be empty").ThrowAsJavaScriptException();
+        unlockApi();
+        return info.Env().Null();
+    }
 
     InstallModuleWorker* worker = new InstallModuleWorker(*(this->_repoInterface),
                                                           *(this->_moduleInstaller),
                                                           progressCallback,
                                                           callback,
+                                                          repoName,
                                                           moduleName);
     worker->Queue();
     return info.Env().Undefined();

package/src/node_sword_cli.cpp

@@ -157,7 +157,7 @@ void get_dict_key_list(DictHelper& dict_helper)
 void test_unlock_key(ModuleInstaller& module_installer, ModuleStore& module_store, TextProcessor& text_processor)
 {
     module_installer.uninstallModule("NA28");
-    module_installer.installModule("NA28");
+    module_installer.installModule("Deutsche Bibelgesellschaft", "NA28");
     module_installer.saveModuleUnlockKey("NA28", "");
     SWModule* m = module_store.getLocalModule("NA28");
     cout << "Module readable: " << text_processor.isModuleReadable(m) << endl;
@@ -243,7 +243,7 @@ int main(int argc, char** argv)
 
     //get_module_text(textProcessor);
 
-    get_reference_text(moduleStore, textProcessor);
+    //get_reference_text(moduleStore, textProcessor);
 
     //get_book_intro(textProcessor);
 

package/src/sword_backend/module_installer.cpp

@@ -57,18 +57,6 @@ void ModuleInstaller::resetAllMgrs()
     this->refreshMgr();
 }
 
-int ModuleInstaller::installModule(string moduleName)
-{
-    string repoName = this->_repoInterface.getModuleRepo(moduleName);
-
-    if (repoName == "") {
-        cerr << "Could not find repository for module " << moduleName << endl;
-        return -1;
-    }
-
-    return this->installModule(repoName, moduleName);
-}
-
 int ModuleInstaller::installModule(string repoName, string moduleName)
 {
     InstallSource* remoteSource = this->_repoInterface.getRemoteSource(repoName);

package/src/sword_backend/module_installer.hpp

@@ -37,7 +37,6 @@ public:
     ModuleInstaller(RepositoryInterface& repoInterface, ModuleStore& moduleStore, std::string customHomeDir="");
     virtual ~ModuleInstaller();
 
-    int installModule(std::string moduleName);
     int installModule(std::string repoName, std::string moduleName);
     void cancelInstallation();
     int uninstallModule(std::string moduleName);