node-sword-interface 1.0.10 → 1.0.11

package/API.md

@@ -51,6 +51,7 @@ This is the main class of node-sword-interface and it provides a set of static f
     * [.getModuleDescription(moduleCode)](#NodeSwordInterface+getModuleDescription) ⇒ <code>String</code>
     * [.enableMarkup()](#NodeSwordInterface+enableMarkup)
     * [.getRawModuleEntry(moduleCode, key)](#NodeSwordInterface+getRawModuleEntry) ⇒ <code>String</code>
+    * [.getReferenceText(moduleCode, key)](#NodeSwordInterface+getReferenceText) ⇒ [<code>VerseObject</code>](#VerseObject)
     * [.getChapterText(moduleCode, bookCode, chapter)](#NodeSwordInterface+getChapterText) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
     * [.getBookText(moduleCode, bookCode, startVerseNr, verseCount)](#NodeSwordInterface+getBookText) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
     * [.getVersesFromReferences(moduleCode, references)](#NodeSwordInterface+getVersesFromReferences) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
@@ -121,7 +122,7 @@ Note that the languages are returned as language codes.
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | repositoryName | <code>String</code> |  | The name of the given repository. |
-| moduleType | <code>String</code> | <code>BIBLE</code> | A filter parameter that defines the moduleType (Options: BIBLE, DICT) |
+| moduleType | <code>String</code> | <code>BIBLE</code> | A filter parameter that defines the moduleType (Options: BIBLE, DICT, COMMENTARY) |
 
 <a name="NodeSwordInterface+getAllRepoModules"></a>
 
@@ -134,7 +135,7 @@ Returns all modules for the given repository (default: Bible modules).
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | repositoryName | <code>String</code> |  | The name of the given repository. |
-| moduleType | <code>String</code> | <code>BIBLE</code> | A filter parameter that defines the moduleType (Options: BIBLE, DICT) |
+| moduleType | <code>String</code> | <code>BIBLE</code> | A filter parameter that defines the moduleType (Options: BIBLE, DICT, COMMENTARY) |
 
 <a name="NodeSwordInterface+getRepoModulesByLang"></a>
 
@@ -148,7 +149,7 @@ Returns all Bible modules for the given repository and language
 | --- | --- | --- | --- |
 | repositoryName | <code>String</code> |  | The name of the given repository. |
 | language | <code>String</code> |  | The language code that shall be used as a filter. |
-| moduleType | <code>String</code> | <code>BIBLE</code> | A filter parameter that defines the moduleType (Options: BIBLE, DICT) |
+| moduleType | <code>String</code> | <code>BIBLE</code> | A filter parameter that defines the moduleType (Options: BIBLE, DICT, COMMENTARY) |
 | headersFilter | <code>Boolean</code> | <code>false</code> | Whether only modules with Headers shall be returned. |
 | strongsFilter | <code>Boolean</code> | <code>false</code> | Whether only modules with Strong's shall be returned. |
 | hebrewStrongsKeys | <code>Boolean</code> | <code>false</code> | Whether only modules with Hebrew Strong's keys shall be returned (only applies to dictionaries). |
@@ -188,7 +189,7 @@ Returns all modules installed locally (default: Bible modules).
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| moduleType | <code>String</code> | <code>BIBLE</code> | A filter parameter that defines the moduleType (Options: BIBLE, DICT) |
+| moduleType | <code>String</code> | <code>BIBLE</code> | A filter parameter that defines the moduleType (Options: BIBLE, DICT, COMMENTARY) |
 
 <a name="NodeSwordInterface+getRepoModuleCount"></a>
 
@@ -201,7 +202,7 @@ Returns the number of modules for a given repository (default: Bible modules).
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | repositoryName | <code>String</code> |  | The name of the given repository. |
-| moduleType | <code>String</code> | <code>BIBLE</code> | A filter parameter that defines the moduleType (Options: BIBLE, DICT) |
+| moduleType | <code>String</code> | <code>BIBLE</code> | A filter parameter that defines the moduleType (Options: BIBLE, DICT, COMMENTARY) |
 
 <a name="NodeSwordInterface+getRepoLanguageModuleCount"></a>
 
@@ -215,7 +216,7 @@ Returns the number of modules for a given repository and language (default: Bibl
 | --- | --- | --- | --- |
 | repositoryName | <code>String</code> |  | The name of the given repository. |
 | language | <code>String</code> |  | The language code that shall be used as a filter. |
-| moduleType | <code>String</code> | <code>BIBLE</code> | A filter parameter that defines the moduleType (Options: BIBLE, DICT) |
+| moduleType | <code>String</code> | <code>BIBLE</code> | A filter parameter that defines the moduleType (Options: BIBLE, DICT, COMMENTARY) |
 
 <a name="NodeSwordInterface+installModule"></a>
 
@@ -310,7 +311,7 @@ This influences the output for getChapterText, getBookText and getBibleText.
 <a name="NodeSwordInterface+getRawModuleEntry"></a>
 
 ### nodeSwordInterface.getRawModuleEntry(moduleCode, key) ⇒ <code>String</code>
-Returns the text of an entry for the given module and key.
+Returns the raw text of an entry for the given module and key.
 If no entry exists for the given key the return value is undefined.
 
 **Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)  
@@ -320,6 +321,19 @@ If no entry exists for the given key the return value is undefined.
 | moduleCode | <code>String</code> | The module code of the SWORD module. |
 | key | <code>String</code> | The key of the entry. |
 
+<a name="NodeSwordInterface+getReferenceText"></a>
+
+### nodeSwordInterface.getReferenceText(moduleCode, key) ⇒ [<code>VerseObject</code>](#VerseObject)
+Returns the text of an entry for the given module and key.
+If no entry exists for the given key the return value is a verse with empty content.
+
+**Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| moduleCode | <code>String</code> | The module code of the SWORD module. |
+| key | <code>String</code> | The key of the entry. |
+
 <a name="NodeSwordInterface+getChapterText"></a>
 
 ### nodeSwordInterface.getChapterText(moduleCode, bookCode, chapter) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
@@ -614,7 +628,7 @@ An object representation of a SWORD module.
 | Name | Type | Description |
 | --- | --- | --- |
 | name | <code>String</code> | The name/code of the SWORD module |
-| type | <code>String</code> | The type of the SWORD module (Currently the following types are supported: Biblical Texts, Lexicons / Dictionaries) |
+| type | <code>String</code> | The type of the SWORD module (Currently the following types are supported: Biblical Texts, Lexicons / Dictionaries, Commentaries) |
 | description | <code>String</code> | The description of the SWORD module |
 | language | <code>String</code> | The language code of the SWORD module |
 | distributionLicense | <code>String</code> | The distribution license of the SWORD module |

package/README.md

@@ -90,7 +90,6 @@ Before installing node-sword-interface you need to make sure that the following
 - nodejs (A version that supports N-API version >= 4, like 8.16.0, 10.16.0 or 12.0.0 (see [N-API Version Matrix](https://nodejs.org/api/n-api.html#n_api_n_api_version_matrix)))
 - Git
 - Mac/Linux dependencies:
-    - ICU library with development headers
     - CURL library with development headers
     - CMake (for building the SWORD library)
 
@@ -102,14 +101,14 @@ These installation instructions are working on Debian/Ubuntu based Linux distrib
 
 To install the dependencies issue the following command on a Debian/Ubuntu based distribution:
     
-    sudo apt-get install build-essential nodejs npm libcurl4-gnutls-dev libicu-dev zlib1g-dev pkg-config cmake subversion
+    sudo apt-get install build-essential nodejs npm libcurl4-gnutls-dev zlib1g-dev pkg-config cmake subversion
 
 #### Install dependencies on macOS
 
 1. Install XCode from the App Store
 2. Install Command Line Developer Tools (contains Compiler toolchain, git, etc.) by running this command:<br/> `xcode-select --install`   
 3. Install the homebrew package manager by running this command:<br/> `/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`
-4. Install some packages with homebrew by running this command:<br/> `brew install pkg-config cmake npm icu4c`
+4. Install some packages with homebrew by running this command:<br/> `brew install pkg-config cmake npm`
 
 #### Install dependencies on Windows
 

package/index.js

@@ -36,7 +36,7 @@ const nodeSwordInterfaceModule = require('./build/Release/node_sword_interface.n
  * @typedef ModuleObject
  * @type {Object}
  * @property {String} name - The name/code of the SWORD module
- * @property {String} type - The type of the SWORD module (Currently the following types are supported: Biblical Texts, Lexicons / Dictionaries)
+ * @property {String} type - The type of the SWORD module (Currently the following types are supported: Biblical Texts, Lexicons / Dictionaries, Commentaries)
  * @property {String} description - The description of the SWORD module
  * @property {String} language - The language code of the SWORD module
  * @property {String} distributionLicense - The distribution license of the SWORD module
@@ -136,7 +136,7 @@ class NodeSwordInterface {
    * Note that the languages are returned as language codes.
    *
    * @param {String} repositoryName - The name of the given repository.
-   * @param {String} moduleType - A filter parameter that defines the moduleType (Options: BIBLE, DICT)
+   * @param {String} moduleType - A filter parameter that defines the moduleType (Options: BIBLE, DICT, COMMENTARY)
    * @return {String[]} An array of strings with the languages codes for the Bible modules from the given repository.
    */
   getRepoLanguages(repositoryName, moduleType="BIBLE") {
@@ -147,7 +147,7 @@ class NodeSwordInterface {
    * Returns all modules for the given repository (default: Bible modules).
    *
    * @param {String} repositoryName - The name of the given repository.
-   * @param {String} moduleType - A filter parameter that defines the moduleType (Options: BIBLE, DICT)
+   * @param {String} moduleType - A filter parameter that defines the moduleType (Options: BIBLE, DICT, COMMENTARY)
    * @return {ModuleObject[]} An array of strings with the module codes for the Bible modules of the given repository.
    */
   getAllRepoModules(repositoryName, moduleType="BIBLE") {
@@ -159,7 +159,7 @@ class NodeSwordInterface {
    *
    * @param {String} repositoryName - The name of the given repository.
    * @param {String} language - The language code that shall be used as a filter.
-   * @param {String} moduleType - A filter parameter that defines the moduleType (Options: BIBLE, DICT)
+   * @param {String} moduleType - A filter parameter that defines the moduleType (Options: BIBLE, DICT, COMMENTARY)
    * @param {Boolean} headersFilter - Whether only modules with Headers shall be returned.
    * @param {Boolean} strongsFilter - Whether only modules with Strong's shall be returned.
    * @param {Boolean} hebrewStrongsKeys - Whether only modules with Hebrew Strong's keys shall be returned (only applies to dictionaries).
@@ -193,7 +193,7 @@ class NodeSwordInterface {
 
   /**
    * Returns all modules installed locally (default: Bible modules).
-   * @param {String} moduleType - A filter parameter that defines the moduleType (Options: BIBLE, DICT)
+   * @param {String} moduleType - A filter parameter that defines the moduleType (Options: BIBLE, DICT, COMMENTARY)
    * @return {ModuleObject[]} An array of ModuleObjects which represents the locally installed Bible modules.
    */
   getAllLocalModules(moduleType="BIBLE") {
@@ -204,7 +204,7 @@ class NodeSwordInterface {
    * Returns the number of modules for a given repository (default: Bible modules).
    *
    * @param {String} repositoryName - The name of the given repository.
-   * @param {String} moduleType - A filter parameter that defines the moduleType (Options: BIBLE, DICT)
+   * @param {String} moduleType - A filter parameter that defines the moduleType (Options: BIBLE, DICT, COMMENTARY)
    * @return {Number} The number of Bible modules for the given repository and module type.
    */
   getRepoModuleCount(repositoryName, moduleType="BIBLE") {
@@ -216,7 +216,7 @@ class NodeSwordInterface {
    *
    * @param {String} repositoryName - The name of the given repository.
    * @param {String} language - The language code that shall be used as a filter.
-   * @param {String} moduleType - A filter parameter that defines the moduleType (Options: BIBLE, DICT)
+   * @param {String} moduleType - A filter parameter that defines the moduleType (Options: BIBLE, DICT, COMMENTARY)
    * @return {Number} The number of Bible modules for the given repository, language and module type.
    */
   getRepoLanguageModuleCount(repositoryName, language, moduleType="BIBLE") {
@@ -330,7 +330,7 @@ class NodeSwordInterface {
   }
 
   /**
-   * Returns the text of an entry for the given module and key.
+   * Returns the raw text of an entry for the given module and key.
    * If no entry exists for the given key the return value is undefined.
    *
    * @param {String} moduleCode - The module code of the SWORD module.
@@ -341,6 +341,18 @@ class NodeSwordInterface {
     return this.nativeInterface.getRawModuleEntry(moduleCode, key);
   }
 
+  /**
+   * Returns the text of an entry for the given module and key.
+   * If no entry exists for the given key the return value is a verse with empty content.
+   *
+   * @param {String} moduleCode - The module code of the SWORD module.
+   * @param {String} key - The key of the entry.
+   * @return {VerseObject}
+   */
+  getReferenceText(moduleCode, key) {
+    return this.nativeInterface.getReferenceText(moduleCode, key);
+  }
+
   /**
    * Returns the text of a chapter for the given module.
    *

package/package.json

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

package/src/napi_module/napi_sword_helper.cpp

@@ -79,7 +79,13 @@ void NapiSwordHelper::swordModuleToNapiObject(const Napi::Env& env, SWModule* sw
     }
 
     if (swModule->getConfigEntry("InstallSize")) {
-        int moduleSize = std::stoi(string(swModule->getConfigEntry("InstallSize")));
+        std::string configInstallSize = string(swModule->getConfigEntry("InstallSize"));
+
+        int moduleSize = -1;
+        if (configInstallSize.length() > 0) {
+            moduleSize = std::stoi(configInstallSize);
+        }
+
         object["size"] = Napi::Number::New(env, moduleSize);
     } else {
         object["size"] = Napi::Number::New(env, -1);

package/src/napi_module/napi_sword_helper.hpp

@@ -45,9 +45,9 @@ public:
     Napi::Array getNapiVerseObjectsFromRawList(const Napi::Env& env, std::string moduleCode, std::vector<Verse>& verses);
     void swordModuleToNapiObject(const Napi::Env& env, sword::SWModule* swModule, Napi::Object& object);
     void strongsEntryToNapiObject(const Napi::Env& env, StrongsEntry* strongsEntry, Napi::Object& object);
+    void verseTextToNapiObject(std::string moduleCode, Verse rawVerse, Napi::Object& object);
 
 private:
-    void verseTextToNapiObject(std::string moduleCode, Verse rawVerse, Napi::Object& object);
     Napi::String getConfigEntry(sword::SWModule* swModule, std::string key, const Napi::Env& env);
 
     ModuleHelper& _moduleHelper;

package/src/napi_module/node_sword_interface.cpp

@@ -90,6 +90,7 @@ Napi::Object NodeSwordInterface::Init(Napi::Env env, Napi::Object exports)
         InstanceMethod("getLocalModule", &NodeSwordInterface::getLocalModule),
         InstanceMethod("enableMarkup", &NodeSwordInterface::enableMarkup),
         InstanceMethod("getRawModuleEntry", &NodeSwordInterface::getRawModuleEntry),
+        InstanceMethod("getReferenceText", &NodeSwordInterface::getReferenceText),
         InstanceMethod("getChapterText", &NodeSwordInterface::getChapterText),
         InstanceMethod("getBookText", &NodeSwordInterface::getBookText),
         InstanceMethod("getBibleText", &NodeSwordInterface::getBibleText),
@@ -345,6 +346,8 @@ ModuleType NodeSwordInterface::getModuleTypeFromString(std::string moduleTypeStr
         return ModuleType::bible;
     } else if (moduleTypeString == "DICT") {
         return ModuleType::dict;
+    } else if (moduleTypeString == "COMMENTARY") {
+        return ModuleType::commentary;
     } else {
         return ModuleType::any;
     }
@@ -544,6 +547,23 @@ Napi::Value NodeSwordInterface::getRawModuleEntry(const Napi::CallbackInfo& info
     }
 }
 
+Napi::Value NodeSwordInterface::getReferenceText(const Napi::CallbackInfo& info)
+{
+    lockApi();
+    INIT_SCOPE_AND_VALIDATE(ParamType::string, ParamType::string);
+    Napi::Env env = info.Env();
+    Napi::String moduleName = info[0].As<Napi::String>();
+    Napi::String key = info[1].As<Napi::String>();
+    ASSERT_SW_MODULE_EXISTS(moduleName);
+
+    Verse rawVerse = this->_textProcessor->getReferenceText(moduleName, key);
+    Napi::Object verseObject = Napi::Object::New(env);
+    this->_napiSwordHelper->verseTextToNapiObject(moduleName, rawVerse, verseObject);
+
+    unlockApi();
+    return verseObject;
+}
+
 Napi::Value NodeSwordInterface::getChapterText(const Napi::CallbackInfo& info)
 {
     lockApi();

package/src/napi_module/node_sword_interface.hpp

@@ -71,6 +71,7 @@ private:
     Napi::Value enableMarkup(const Napi::CallbackInfo& info);
     
     Napi::Value getRawModuleEntry(const Napi::CallbackInfo& info);
+    Napi::Value getReferenceText(const Napi::CallbackInfo& info);
     Napi::Value getChapterText(const Napi::CallbackInfo& info);
     Napi::Value getBookText(const Napi::CallbackInfo& info);
     Napi::Value getBibleText(const Napi::CallbackInfo& info);

package/src/sword_backend/common_defs.hpp

@@ -30,6 +30,7 @@ enum class QueryLimit {
 enum class ModuleType {
     bible,
     dict,
+    commentary,
     any
 };
 

package/src/sword_backend/repository_interface.hpp

@@ -87,6 +87,9 @@ public:
             case ModuleType::dict:
                 moduleTypeFilter = "Lexicons / Dictionaries";
                 break;
+            case ModuleType::commentary:
+                moduleTypeFilter = "Commentaries";
+                break;
             default:
                 moduleTypeFilter = "ANY";
         }

package/src/sword_backend/text_processor.cpp

@@ -80,6 +80,11 @@ string TextProcessor::getFilteredText(const string& text, int chapter, int verse
     static string divineNameStartElement = "<divineName>";
     static string divineNameEndElement = "</divineName>";
     static string strongsWElement = "<w lemma=";
+    static string listStartElement = "<list";
+    static string listEndElement = "</list>";
+    static string itemStartElement = "<item";
+    static string itemEndElement = "</item>";
+    static string hiBold = "<hi type=\"bold";
 
     static regex milestoneFilter = regex("<milestone.*?/>");
     static regex segStartElementFilter = regex("<seg.*?>");
@@ -159,6 +164,11 @@ string TextProcessor::getFilteredText(const string& text, int chapter, int verse
     this->findAndReplaceAll(filteredText, divineNameStartElement, "");
     this->findAndReplaceAll(filteredText, divineNameEndElement, "");
     this->findAndReplaceAll(filteredText, strongsWElement, "<w class=");
+    this->findAndReplaceAll(filteredText, listStartElement, "<ul");
+    this->findAndReplaceAll(filteredText, listEndElement, "</ul>");
+    this->findAndReplaceAll(filteredText, itemStartElement, "<li");
+    this->findAndReplaceAll(filteredText, itemEndElement, "</li>");
+    this->findAndReplaceAll(filteredText, hiBold, "<hi class=\"bold");
 
     filteredText = regex_replace(filteredText, selfClosingElement, "<$2 $3></$2>");
 
@@ -269,6 +279,25 @@ vector<Verse> TextProcessor::getBibleText(string moduleName)
     return this->getText(moduleName, "Gen 1:1");
 }
 
+Verse TextProcessor::getReferenceText(std::string moduleName, std::string reference)
+{
+    SWModule* module = this->_moduleStore.getLocalModule(moduleName);
+    module->setKey(reference.c_str());
+    bool entryExisting = module->hasEntry(module->getKey());
+
+    if (entryExisting) {
+        vector<Verse> verses = this->getText(moduleName, reference, QueryLimit::book, -1, 1);
+        verses[0].absoluteVerseNumber = -1;
+        return verses[0];
+    } else {
+        Verse verse;
+        verse.reference = reference;
+        verse.absoluteVerseNumber = -1;
+        verse.content = "";
+        return verse;
+    }
+}
+
 vector<Verse> TextProcessor::getBookText(string moduleName, string bookCode, int startVerseNumber, int verseCount)
 {
     stringstream key;

package/src/sword_backend/text_processor.hpp

@@ -39,6 +39,7 @@ public:
     void disableMarkup() { this->_markupEnabled = false; }
 
     std::vector<Verse> getBibleText(std::string moduleName);
+    Verse getReferenceText(std::string moduleName, std::string reference);
     std::vector<Verse> getBookText(std::string moduleName, std::string bookCode, int startVerseNumber=-1, int verseCount=-1);
     std::vector<Verse> getChapterText(std::string moduleName, std::string bookCode, int chapter);
     std::vector<Verse> getVersesFromReferences(std::string moduleName, std::vector<std::string>& references);