node-sword-interface 1.0.95 → 1.0.96

package/API.md

@@ -31,6 +31,7 @@ This is the main class of node-sword-interface and it provides a set of static f
 **Kind**: global class  
 
 * [NodeSwordInterface](#NodeSwordInterface)
+    * [new NodeSwordInterface(customHomeDir, localesBasePath, timeoutMillis)](#new_NodeSwordInterface_new)
     * [.repositoryConfigExisting()](#NodeSwordInterface+repositoryConfigExisting) ⇒ <code>Boolean</code>
     * [.updateRepositoryConfig(progressCB)](#NodeSwordInterface+updateRepositoryConfig) ⇒ <code>Promise</code>
     * [.getRepoNames()](#NodeSwordInterface+getRepoNames) ⇒ <code>Array.&lt;String&gt;</code>
@@ -84,6 +85,17 @@ This is the main class of node-sword-interface and it provides a set of static f
     * [.getSwordVersion()](#NodeSwordInterface+getSwordVersion) ⇒ <code>String</code>
     * [.getSwordPath()](#NodeSwordInterface+getSwordPath) ⇒ <code>String</code>
 
+<a name="new_NodeSwordInterface_new"></a>
+
+### 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. |
+
 <a name="NodeSwordInterface+repositoryConfigExisting"></a>
 
 ### nodeSwordInterface.repositoryConfigExisting() ⇒ <code>Boolean</code>

package/index.js

@@ -105,9 +105,15 @@ const searchMutex = new Mutex();
 
 /** This is the main class of node-sword-interface and it provides a set of static functions that wrap SWORD library functionality. */
 class NodeSwordInterface {
-  constructor(customHomeDir=undefined, localesBasePath=__dirname) {
+  /**
+   * Creates an instance of NodeSwordInterface.
+   * @param {String} customHomeDir - Optional custom home directory for SWORD data.
+   * @param {String} localesBasePath - Optional base path for locales (default: __dirname).
+   * @param {Number} timeoutMillis - Optional timeout in milliseconds for repository operations (default: 20000).
+   */
+  constructor(customHomeDir=undefined, localesBasePath=__dirname, timeoutMillis=20000) {
     var localesDir = path.join(localesBasePath, './locales.d');
-    this.nativeInterface = new nodeSwordInterfaceModule.NodeSwordInterface(customHomeDir, localesDir);
+    this.nativeInterface = new nodeSwordInterfaceModule.NodeSwordInterface(customHomeDir, localesDir, timeoutMillis);
   }
 
   /**

package/package.json

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

package/src/napi_module/node_sword_interface.cpp

@@ -151,6 +151,7 @@ NodeSwordInterface::NodeSwordInterface(const Napi::CallbackInfo& info) : Napi::O
 
     std::string localeDir = "";
     this->customHomeDir = "";
+    long timeoutMillis = 20000;
 
     bool homeDirError = false;
     bool localeDirError = false;
@@ -177,11 +178,17 @@ NodeSwordInterface::NodeSwordInterface(const Napi::CallbackInfo& info) : Napi::O
         localeDirError = true;
     }
 
+    if (info[2].IsNumber()) {
+        timeoutMillis = info[2].As<Napi::Number>().Int64Value();
+    } else if (!info[2].IsUndefined() && !info[2].IsNull()) {
+        cerr << "Warning: Invalid timeoutMillis value (not a number), using default (20000)" << endl;
+    }
+
     if (!homeDirError && !localeDirError) { // We only proceed if there has not been any issue with the homeDir or localeDir
         this->_moduleStore = new ModuleStore(this->customHomeDir);
         this->_moduleHelper = new ModuleHelper(*(this->_moduleStore));
         this->_dictHelper = new DictHelper(*(this->_moduleStore));
-        this->_repoInterface = new RepositoryInterface(this->_swordStatusReporter, *(this->_moduleHelper), *(this->_moduleStore), this->customHomeDir);
+        this->_repoInterface = new RepositoryInterface(this->_swordStatusReporter, *(this->_moduleHelper), *(this->_moduleStore), this->customHomeDir, timeoutMillis);
         this->_moduleInstaller = new ModuleInstaller(*(this->_repoInterface), *(this->_moduleStore), this->customHomeDir);
         this->_napiSwordHelper = new NapiSwordHelper(*(this->_moduleHelper), *(this->_moduleStore));
         this->_textProcessor = new TextProcessor(*(this->_moduleStore), *(this->_moduleHelper));

package/src/node_sword_cli.cpp

@@ -183,7 +183,8 @@ int main(int argc, char** argv)
     ModuleHelper moduleHelper(moduleStore);
     DictHelper dictHelper(moduleStore);
     SwordStatusReporter statusReporter;
-    RepositoryInterface repoInterface(statusReporter, moduleHelper, moduleStore);
+    long timeoutMillis = 20000;
+    RepositoryInterface repoInterface(statusReporter, moduleHelper, moduleStore, "", timeoutMillis);
     ModuleInstaller moduleInstaller(repoInterface, moduleStore);
     TextProcessor textProcessor(moduleStore, moduleHelper);
     ModuleSearch moduleSearch(moduleStore, moduleHelper, textProcessor);

package/src/sword_backend/repository_interface.cpp

@@ -53,9 +53,16 @@ static Mutex remoteSourceUpdateMutex;
 RepositoryInterface::RepositoryInterface(SwordStatusReporter& statusReporter,
                                          ModuleHelper& moduleHelper,
                                          ModuleStore& moduleStore,
-                                         string customHomeDir) 
+                                         string customHomeDir,
+                                         long timeoutMillis) 
     : _statusReporter(statusReporter), _moduleHelper(moduleHelper), _moduleStore(moduleStore)
 {
+    if (timeoutMillis <= 0) {
+        cerr << "Warning: Invalid timeoutMillis value (" << timeoutMillis << "), using default (20000)" << endl;
+        this->_timeoutMillis = 20000;
+    } else {
+        this->_timeoutMillis = timeoutMillis;
+    }
     this->_fileSystemHelper.setCustomHomeDir(customHomeDir);
     this->resetMgr();
     remoteSourceUpdateMutex.init();
@@ -72,8 +79,7 @@ void RepositoryInterface::resetMgr()
     this->_installMgr = new InstallMgr(this->_fileSystemHelper.getInstallMgrDir().c_str(), &this->_statusReporter);
     this->_installMgr->setUserDisclaimerConfirmed(true);
 
-    long timeoutMillis = 20000;
-    this->_installMgr->setTimeoutMillis(timeoutMillis);
+    this->_installMgr->setTimeoutMillis(this->_timeoutMillis);
 }
 
 int RepositoryInterface::refreshRepositoryConfig()

package/src/sword_backend/repository_interface.hpp

@@ -43,7 +43,8 @@ public:
     RepositoryInterface(SwordStatusReporter& statusReporter,
                         ModuleHelper& moduleHelper,
                         ModuleStore& moduleStore,
-                        std::string customHomeDir="");
+                        std::string customHomeDir="",
+                        long timeoutMillis=20000);
 
     virtual ~RepositoryInterface(){}
 
@@ -115,6 +116,7 @@ private:
     FileSystemHelper _fileSystemHelper;
     ModuleHelper& _moduleHelper;
     ModuleStore& _moduleStore;
+    long _timeoutMillis = 20000;
 };
 
 #endif // _REPOSITORY_INTERFACE