node-sword-interface 1.0.23 → 1.0.25

package/API.md

@@ -57,9 +57,11 @@ This is the main class of node-sword-interface and it provides a set of static f
     * [.getVersesFromReferences(moduleCode, references)](#NodeSwordInterface+getVersesFromReferences) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
     * [.getReferencesFromReferenceRange(referenceRange)](#NodeSwordInterface+getReferencesFromReferenceRange) ⇒ <code>Array.&lt;String&gt;</code>
     * [.getBookList(moduleCode)](#NodeSwordInterface+getBookList) ⇒ <code>Array.&lt;String&gt;</code>
-    * [.getBookHeaderList(moduleCode, bookCode, withAbsoluteVerseNumbers)](#NodeSwordInterface+getBookHeaderList) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
+    * [.getBookHeaderList(moduleCode, bookCode, startVerseNumber, verseCount)](#NodeSwordInterface+getBookHeaderList) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
     * [.getBookChapterCount(moduleCode, bookCode)](#NodeSwordInterface+getBookChapterCount)
     * [.getChapterVerseCount(moduleCode, bookCode, chapter)](#NodeSwordInterface+getChapterVerseCount)
+    * [.getAllChapterVerseCounts(moduleCode, bookCode)](#NodeSwordInterface+getAllChapterVerseCounts) ⇒ <code>Number</code>
+    * [.getBookVerseCount(moduleCode, bookCode)](#NodeSwordInterface+getBookVerseCount) ⇒ <code>Number</code>
     * [.getBibleText(moduleCode)](#NodeSwordInterface+getBibleText) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
     * [.getBookIntroduction(moduleCode, bookCode)](#NodeSwordInterface+getBookIntroduction) ⇒ <code>String</code>
     * [.moduleHasBook(moduleCode, bookCode)](#NodeSwordInterface+moduleHasBook) ⇒ <code>Boolean</code>
@@ -402,16 +404,17 @@ Returns the list of books available in the given module. By default the book cod
 
 <a name="NodeSwordInterface+getBookHeaderList"></a>
 
-### nodeSwordInterface.getBookHeaderList(moduleCode, bookCode, withAbsoluteVerseNumbers) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
+### nodeSwordInterface.getBookHeaderList(moduleCode, bookCode, startVerseNumber, verseCount) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
 Returns the list of headers available in the given book. The headers are returned as an array of VerseObjects.
 
 **Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)  
 
-| Param | Type | Default |
-| --- | --- | --- |
-| moduleCode | <code>String</code> |  | 
-| bookCode | <code>String</code> |  | 
-| withAbsoluteVerseNumbers | <code>Boolean</code> | <code>false</code> | 
+| Param | Type |
+| --- | --- |
+| moduleCode | <code>String</code> | 
+| bookCode | <code>String</code> | 
+| startVerseNumber | <code>Number</code> | 
+| verseCount | <code>Number</code> | 
 
 <a name="NodeSwordInterface+getBookChapterCount"></a>
 
@@ -438,6 +441,32 @@ Returns the number of verses in the given chapter.
 | bookCode | <code>String</code> | The book code of the SWORD module. |
 | chapter | <code>Number</code> | The chapter of the book. |
 
+<a name="NodeSwordInterface+getAllChapterVerseCounts"></a>
+
+### nodeSwordInterface.getAllChapterVerseCounts(moduleCode, bookCode) ⇒ <code>Number</code>
+Returns an array with the chapter verse counts of all chapters of a given book.
+
+**Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)  
+**Returns**: <code>Number</code> - chapterVerseCounts  
+
+| Param | Type |
+| --- | --- |
+| moduleCode | <code>String</code> | 
+| bookCode | <code>String</code> | 
+
+<a name="NodeSwordInterface+getBookVerseCount"></a>
+
+### nodeSwordInterface.getBookVerseCount(moduleCode, bookCode) ⇒ <code>Number</code>
+Returns the number verses in the given book.
+
+**Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)  
+**Returns**: <code>Number</code> - The verse count of the book.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| moduleCode | <code>String</code> | The module code of the SWORD module. |
+| bookCode | <code>String</code> | The book code of the SWORD module. |
+
 <a name="NodeSwordInterface+getBibleText"></a>
 
 ### nodeSwordInterface.getBibleText(moduleCode) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)

package/index.js

@@ -416,12 +416,54 @@ class NodeSwordInterface {
    * 
    * @param {String} moduleCode 
    * @param {String} bookCode 
-   * @param {Boolean} withAbsoluteVerseNumbers
+   * @param {Number} startVerseNumber
+   * @param {Number} verseCount
    * 
    * @return {VerseObject[]}
    */
-  getBookHeaderList(moduleCode, bookCode, withAbsoluteVerseNumbers=false) {
-    return this.nativeInterface.getBookHeaderList(moduleCode, bookCode, withAbsoluteVerseNumbers);
+  getBookHeaderList(moduleCode, bookCode, startVerseNumber=-1, verseCount=-1) {
+    const bookTextJson = this.nativeInterface.getBookText(moduleCode, bookCode, startVerseNumber, verseCount);
+
+    let bookTextHtml = "<div>";
+    bookTextJson.forEach((verse) => { bookTextHtml += verse.content; });
+    bookTextHtml += "</div>";
+
+    const HTMLParser = require('node-html-parser');
+    const root = HTMLParser.parse(bookTextHtml);
+    const rawSectionHeaders = root.querySelectorAll('.sword-section-title');
+    let sectionHeaders = [];
+
+    rawSectionHeaders.forEach((header) => {
+      let newSectionHeader = {};
+
+      newSectionHeader['moduleCode'] = moduleCode;
+      newSectionHeader['bibleBookShortTitle'] = bookCode;
+      newSectionHeader['type'] = header._attrs.type;
+      newSectionHeader['subType'] = header._attrs.subtype;
+      newSectionHeader['chapter'] = header._attrs.chapter;
+      newSectionHeader['verseNr'] = header._attrs.verse;
+
+      let content = "";
+
+      // You may expect that a header only has one child node (the text). But there are modules like the NET Bible
+      // where the header actually contains several child nodes and some of them are Strongs elements.
+      // Therefore, we have to go through individually and also differentiate between text nodes and other types of nodes.
+      for (let i = 0; i < header.childNodes.length; i++) {
+        let currentNode = header.childNodes[i];
+
+        if (currentNode.nodeType == HTMLParser.NodeType.TEXT_NODE) {
+          content += currentNode._rawText;
+        } else {
+          content += currentNode.firstChild._rawText;
+        }
+      }
+
+      newSectionHeader['content'] = content;
+
+      sectionHeaders.push(newSectionHeader);
+    });
+
+    return sectionHeaders;
   }
 
   /**
@@ -445,6 +487,25 @@ class NodeSwordInterface {
     return this.nativeInterface.getChapterVerseCount(moduleCode, bookCode, chapter);
   }
 
+  /**
+   * Returns an array with the chapter verse counts of all chapters of a given book.
+   * 
+   * @param {String} moduleCode 
+   * @param {String} bookCode 
+   * @returns {Number} chapterVerseCounts
+   */
+  getAllChapterVerseCounts(moduleCode, bookCode) {
+    let chapterVerseCounts = [];
+
+    let bookChapterCount = this.nativeInterface.getBookChapterCount(moduleCode, bookCode);
+    for (let i = 0; i < bookChapterCount; i++) {
+      let currentChapterVerseCount = this.nativeInterface.getChapterVerseCount(moduleCode, bookCode, i);
+      chapterVerseCounts.push(currentChapterVerseCount);
+    }
+
+    return chapterVerseCounts;
+  }
+
   /**
    * Returns the number verses in the given book.
    * 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-sword-interface",
-  "version": "1.0.23",
+  "version": "1.0.25",
   "description": "Javascript (N-API) interface to SWORD library",
   "keywords": [
     "C++",
@@ -23,14 +23,15 @@
   "license": "GPL-2.0+",
   "dependencies": {
     "glob": "^8.0.3",
-    "node-addon-api": "^7.1.0"
+    "node-addon-api": "^7.1.0",
+    "node-html-parser": "^6.1.13"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/ezra-project/node-sword-interface.git"
   },
   "devDependencies": {
-    "jsdoc-to-markdown": "^8.0.0",
+    "jsdoc-to-markdown": "^8.0.3",
     "node-gyp": "^9.1.0"
   }
 }

package/src/napi_module/node_sword_interface.cpp

@@ -98,7 +98,6 @@ Napi::Object NodeSwordInterface::Init(Napi::Env env, Napi::Object exports)
         InstanceMethod("getReferencesFromReferenceRange", &NodeSwordInterface::getReferencesFromReferenceRange),
         InstanceMethod("getBookList", &NodeSwordInterface::getBookList),
         InstanceMethod("getBookChapterCount", &NodeSwordInterface::getBookChapterCount),
-        InstanceMethod("getBookHeaderList", &NodeSwordInterface::getBookHeaderList),
         InstanceMethod("getChapterVerseCount", &NodeSwordInterface::getChapterVerseCount),
         InstanceMethod("getBookIntroduction", &NodeSwordInterface::getBookIntroduction),
         InstanceMethod("moduleHasBook", &NodeSwordInterface::moduleHasBook),
@@ -668,26 +667,6 @@ Napi::Value NodeSwordInterface::getBookChapterCount(const Napi::CallbackInfo& in
     return bookChapterCount;
 }
 
-Napi::Value NodeSwordInterface::getBookHeaderList(const Napi::CallbackInfo& info)
-{
-    lockApi();
-    Napi::Env env = info.Env();
-    INIT_SCOPE_AND_VALIDATE(ParamType::string, ParamType::string, ParamType::boolean);
-    Napi::String moduleName = info[0].As<Napi::String>();
-    Napi::String bookCode = info[1].As<Napi::String>();
-    Napi::Boolean withAbsoluteVerseNumbers = info[2].As<Napi::Boolean>();
-
-    #ifdef _WIN32
-        Napi::Array headerList = Napi::Array::New(env, 0);
-    #else
-        vector<Verse> rawHeaderList = this->_textProcessor->getBookHeaderList(moduleName, bookCode, withAbsoluteVerseNumbers);
-        Napi::Array headerList = this->_napiSwordHelper->getNapiVerseObjectsFromRawList(env, string(moduleName), rawHeaderList);
-    #endif
-
-    unlockApi();
-    return headerList;
-}
-
 Napi::Value NodeSwordInterface::getChapterVerseCount(const Napi::CallbackInfo& info)
 {
     lockApi();

package/src/napi_module/node_sword_interface.hpp

@@ -79,7 +79,6 @@ private:
     Napi::Value getReferencesFromReferenceRange(const Napi::CallbackInfo& info);
     Napi::Value getBookList(const Napi::CallbackInfo& info);
     Napi::Value getBookChapterCount(const Napi::CallbackInfo& info);
-    Napi::Value getBookHeaderList(const Napi::CallbackInfo& info);
     Napi::Value getChapterVerseCount(const Napi::CallbackInfo& info);
     Napi::Value getBookIntroduction(const Napi::CallbackInfo& info);
     Napi::Value moduleHasBook(const Napi::CallbackInfo& info);

package/src/node_sword_cli.cpp

@@ -126,14 +126,6 @@ void get_book_list(ModuleHelper& module_helper)
     }
 }
 
-void get_book_headers(TextProcessor& text_processor)
-{
-    vector<Verse> headerList = text_processor.getBookHeaderList("NASB", "John");
-    for (int i = 0; i < headerList.size(); i++) {
-        cout << headerList[i].content << endl;
-    }
-}
-
 void test_unlock_key(ModuleInstaller& module_installer, ModuleStore& module_store, TextProcessor& text_processor)
 {
     module_installer.uninstallModule("NA28");
@@ -236,8 +228,6 @@ int main(int argc, char** argv)
 
     //get_updated_repo_modules(repoInterface);
 
-    /*get_book_headers(textProcessor);*/
-
     return 0;
 }
 

package/src/sword_backend/text_processor.cpp

@@ -519,75 +519,6 @@ string TextProcessor::getBookIntroduction(string moduleName, string bookCode)
     return filteredText;
 }
 
-vector<Verse> TextProcessor::getBookHeaderList(string moduleName, string bookCode, bool withAbsoluteVerseNumbers)
-{
-    vector<Verse> headerList;
-    SWModule* module = this->_moduleStore.getLocalModule(moduleName);
-
-    if (module == 0) {
-        cerr << "getBookHeaderList: getLocalModule returned zero pointer for " << moduleName << endl;
-    } else {
-        map<string, int> absoluteVerseNumbers;
-        
-        if (withAbsoluteVerseNumbers) {
-            absoluteVerseNumbers = this->_moduleHelper.getAbsoluteVerseNumberMap(module, { bookCode });
-        }
-
-        ListKey scopeList = VerseKey().parseVerseList(bookCode.c_str(), "", true);
-        SWKey* scope = &scopeList;
-
-        ListKey resultKey = module->search("/Heading", SWModule::SEARCHTYPE_ENTRYATTR, 0, scope);
-
-        static string titleStartElementFilter = "<title";
-        static string titleEndElementFilter = "</title>";
-        static string divTitleElementFilter = "<div class=\"title\"";
-        static string secHeadClassFilter = "class=\"sechead\"";
-
-        for (resultKey = TOP; !resultKey.popError(); resultKey++) {
-            module->setKey(resultKey);
-            module->renderText();
-
-            VerseKey currentKey(resultKey.getShortText());
-
-            // get both Preverse and Interverse Headings and just merge them into the same map
-            AttributeValue headings = module->getEntryAttributes()["Heading"]["Preverse"];
-            AttributeValue interverseHeadings = module->getEntryAttributes()["Heading"]["Interverse"];
-            headings.insert(interverseHeadings.begin(), interverseHeadings.end());
-
-            stringstream currentHeaderTextStream;
-
-            Verse currentHeader;
-            currentHeader.reference = module->getKey()->getShortText();
-            currentHeader.absoluteVerseNumber = -1;
-            if (withAbsoluteVerseNumbers) {
-                currentHeader.absoluteVerseNumber = absoluteVerseNumbers[currentHeader.reference];
-            }
-
-            for (AttributeValue::const_iterator it = headings.begin(); it != headings.end(); ++it) {
-                currentHeaderTextStream << it->second << endl;
-            }
-
-            string currentHeaderText = currentHeaderTextStream.str();
-            stringstream sectionTitleElement;
-            sectionTitleElement << "<div class=\"sword-markup sword-section-title\" ";
-            sectionTitleElement << "chapter=\"" << currentKey.getChapter() << "\"";
-            this->findAndReplaceAll(currentHeaderText, titleStartElementFilter, sectionTitleElement.str());
-            this->findAndReplaceAll(currentHeaderText, divTitleElementFilter, sectionTitleElement.str());
-
-            stringstream secHead;
-            secHead << "class=\"sword-markup sword-section-title\" ";
-            secHead << "chapter=\"" << currentKey.getChapter() << "\"";
-            this->findAndReplaceAll(currentHeaderText, secHeadClassFilter, secHead.str());
-            this->findAndReplaceAll(currentHeaderText, titleEndElementFilter, "</div>");
-
-            currentHeader.content = currentHeaderText;
-            headerList.push_back(currentHeader);
-        }
-    }
-
-    return headerList;
-}
-
 string TextProcessor::replaceSpacesInStrongs(const string& text)
 {
     string input = text;

package/src/sword_backend/text_processor.hpp

@@ -46,7 +46,6 @@ public:
     std::vector<std::string> getReferencesFromReferenceRange(std::string referenceRange);
     std::string getCurrentVerseText(sword::SWModule* module, bool hasStrongs, bool hasInconsistentClosingEndDivs=false, bool forceNoMarkup=false);
     std::string getBookIntroduction(std::string moduleName, std::string bookCode);
-    std::vector<Verse> getBookHeaderList(std::string moduleName, std::string bookCode, bool withAbsoluteVerseNumbers=false);
 
     StrongsEntry* getStrongsEntry(std::string key);