node-sword-interface 1.0.3 → 1.0.5

package/API.md

@@ -35,7 +35,7 @@ This is the main class of node-sword-interface and it provides a set of static f
     * [.updateRepositoryConfig(progressCB)](#NodeSwordInterface+updateRepositoryConfig) ⇒ <code>Promise</code>
     * [.getRepoNames()](#NodeSwordInterface+getRepoNames) ⇒ <code>Array.&lt;String&gt;</code>
     * [.getRepoLanguages(repositoryName, moduleType)](#NodeSwordInterface+getRepoLanguages) ⇒ <code>Array.&lt;String&gt;</code>
-    * [.getAllRepoModules(repositoryName, moduleType)](#NodeSwordInterface+getAllRepoModules) ⇒ <code>Array.&lt;String&gt;</code>
+    * [.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)
@@ -125,11 +125,11 @@ Note that the languages are returned as language codes.
 
 <a name="NodeSwordInterface+getAllRepoModules"></a>
 
-### nodeSwordInterface.getAllRepoModules(repositoryName, moduleType) ⇒ <code>Array.&lt;String&gt;</code>
+### nodeSwordInterface.getAllRepoModules(repositoryName, moduleType) ⇒ [<code>Array.&lt;ModuleObject&gt;</code>](#ModuleObject)
 Returns all modules for the given repository (default: Bible modules).
 
 **Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)  
-**Returns**: <code>Array.&lt;String&gt;</code> - An array of strings with the module codes for the Bible modules of the given repository.  
+**Returns**: [<code>Array.&lt;ModuleObject&gt;</code>](#ModuleObject) - An array of strings with the module codes for the Bible modules of the given repository.  
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |

package/binding.gyp

@@ -112,8 +112,7 @@
                 ],
                 "libraries": [
                     '<(module_root_dir)/sword_build/libsword.a',
-                    '<!@(pkg-config --libs libcurl)',
-                    '<!@(PKG_CONFIG_PATH="/opt/homebrew/opt/icu4c/lib/pkgconfig:/usr/local/opt/icu4c/lib/pkgconfig" pkg-config --libs icu-uc icu-io icu-i18n)'
+                    '<!@(pkg-config --libs libcurl)'
                 ],
                 "dependencies": [
                     "<!(node -p \"require('node-addon-api').gyp\")",

package/index.js

@@ -148,7 +148,7 @@ class NodeSwordInterface {
    *
    * @param {String} repositoryName - The name of the given repository.
    * @param {String} moduleType - A filter parameter that defines the moduleType (Options: BIBLE, DICT)
-   * @return {String[]} An array of strings with the module codes for the Bible modules of the given repository.
+   * @return {ModuleObject[]} An array of strings with the module codes for the Bible modules of the given repository.
    */
   getAllRepoModules(repositoryName, moduleType="BIBLE") {
     return this.nativeInterface.getAllRepoModules(repositoryName, moduleType);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-sword-interface",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Javascript (N-API) interface to SWORD library",
   "keywords": [
     "C++",
@@ -16,11 +16,13 @@
     "clean": "node-gyp clean",
     "doc": "jsdoc2md index.js > API.md",
     "pub": "rm -rf build node_modules sword sword_build test && npm publish ./",
-    "deploy": "scripts/deploy_local.sh"
+    "deploy": "scripts/deploy_local.sh",
+    "postinstall": "node scripts/postinstall.js"
   },
   "author": "Tobias Klein",
   "license": "GPL-2.0+",
   "dependencies": {
+    "glob": "^8.0.3",
     "node-addon-api": "^4.2.0"
   },
   "repository": {
@@ -28,7 +30,7 @@
     "url": "https://github.com/ezra-project/node-sword-interface.git"
   },
   "devDependencies": {
-    "jsdoc-to-markdown": "^7.1.0",
+    "jsdoc-to-markdown": "^8.0.0",
     "node-gyp": "^8.0.0"
   }
 }

package/scripts/build_sword.sh

@@ -34,18 +34,11 @@ git clone https://github.com/bibletime/crosswire-sword-mirror sword
 git -C sword checkout 1460f9
 patch --batch --forward -d sword -p 0 < patch/sword_globconf.patch
 
-
 # PATCHES
 case "$(uname -s)" in
-#    Linux)
-#    # We only apply the Sword ICU patch on Linux
-#        patch --batch --forward -d sword -p 0 < patch/sword_icu.patch
-#    ;;
     Darwin)
     # We only apply the following patch on macOS
         export MACOSX_DEPLOYMENT_TARGET=10.10
-        export CMAKE_PREFIX_PATH=/usr/local/opt/icu4c
-#        patch --batch --forward -d sword -p 0 < patch/sword_mac.patch
     ;;
 esac
 

package/scripts/postinstall.js

@@ -0,0 +1,37 @@
+/* This file is part of node-sword-interface.
+
+   Copyright (C) 2019 - 2022 Tobias Klein <contact@tklein.info>
+
+   node-sword-interface is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 2 of the License, or
+   (at your option) any later version.
+
+   node-sword-interface is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of 
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+   See the GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with node-sword-interface. See the file COPYING.
+   If not, see <http://www.gnu.org/licenses/>. */
+
+const glob = require('glob');
+const path = require('path');
+const fs = require('fs');
+
+function postInstall() {
+  if (process.platform.indexOf("win") != -1) {
+    console.log("Copying build dependencies to build output folder.");
+
+    glob('build/sword-build-win32/lib/*.*', null, function (er, files) {
+      files.forEach((srcPath) => {
+        let fileName = path.basename(srcPath);
+        let destPath = path.join('build/Release', fileName);
+        fs.copyFileSync(srcPath, destPath);
+      });
+    });
+  }
+}
+
+postInstall();

package/src/node_sword_cli.cpp

@@ -88,8 +88,8 @@ void get_repo_module(RepositoryInterface& repoInterface)
 
 void get_updated_repo_modules(RepositoryInterface& repoInterface)
 {
-    //ModuleStore moduleStore;
-    //ModuleHelper moduleHelper(moduleStore);
+    ModuleStore moduleStore;
+    ModuleHelper moduleHelper(moduleStore);
 
     vector<SWModule*> updatedModules = repoInterface.getUpdatedRepoModules();
 

package/patch/sword_icu.patch

@@ -1,55 +0,0 @@
-Index: include/utf8transliterator.h
-===================================================================
---- include/utf8transliterator.h	(Revision 3673)
-+++ include/utf8transliterator.h	(Arbeitskopie)
-@@ -45,6 +45,9 @@
- #include <defs.h>
- #include <map>
- 
-+using icu::UnicodeString;
-+using icu::Transliterator;
-+
- SWORD_NAMESPACE_START
- 
- class SWModule;
-Index: src/modules/filters/scsuutf8.cpp
-===================================================================
---- src/modules/filters/scsuutf8.cpp	(Revision 3673)
-+++ src/modules/filters/scsuutf8.cpp	(Arbeitskopie)
-@@ -35,8 +35,8 @@
- #include <unicode/unistr.h>
- #endif
- 
-+using icu::UnicodeString;
- 
--
- SWORD_NAMESPACE_START
- 
- 
-Index: src/modules/filters/utf8nfc.cpp
-===================================================================
---- src/modules/filters/utf8nfc.cpp	(Revision 3673)
-+++ src/modules/filters/utf8nfc.cpp	(Arbeitskopie)
-@@ -30,6 +30,9 @@
- #include <utf8nfc.h>
- #include <swbuf.h>
- 
-+using icu::UnicodeString;
-+using icu::Normalizer;
-+
- SWORD_NAMESPACE_START
- 
- UTF8NFC::UTF8NFC() {
-Index: src/modules/filters/utf8scsu.cpp
-===================================================================
---- src/modules/filters/utf8scsu.cpp	(Revision 3673)
-+++ src/modules/filters/utf8scsu.cpp	(Arbeitskopie)
-@@ -25,6 +25,8 @@
- #include <utf8scsu.h>
- #include <swbuf.h>
- 
-+using icu::UnicodeString;
-+
- SWORD_NAMESPACE_START
- 
- 

package/patch/sword_mac.patch

@@ -1,62 +0,0 @@
-Index include/utf8transliterator.h
-===================================================================
---- include/utf8transliterator.h
-+++ include/utf8transliterator.h
-@@ -42,6 +42,9 @@ SE_JAMO, SE_HAN, SE_KANJI
- 
- #include <unicode/translit.h>
- 
-+using icu_64::UnicodeString;
-+using icu_64::Transliterator;
-+
- #include <defs.h>
- #include <map>
- 
-Index src/modules/filters/scsuutf8.cpp
-===================================================================
---- src/modules/filters/scsuutf8.cpp
-+++ src/modules/filters/scsuutf8.cpp
-@@ -29,13 +29,14 @@
-  * in http://www.unicode.org/unicode/reports/tr6.html
-  */
- 
--#include <scsuutf8.h>
--#include <swbuf.h>
- #ifdef _ICU_
- #include <unicode/unistr.h>
- #endif
- 
-+using icu_64::UnicodeString;
- 
-+#include <scsuutf8.h>
-+#include <swbuf.h>
- 
- SWORD_NAMESPACE_START
- 
-Index src/modules/filters/utf8nfc.cpp
-===================================================================
---- src/modules/filters/utf8nfc.cpp
-+++ src/modules/filters/utf8nfc.cpp
-@@ -27,6 +27,9 @@
- #include <unicode/normlzr.h>
- #include <unicode/unorm.h>
- 
-+using icu_64::UnicodeString;
-+using icu_64::Normalizer;
-+
- #include <utf8nfc.h>
- #include <swbuf.h>
- 
-Index src/modules/filters/utf8scsu.cpp
-===================================================================
---- src/modules/filters/utf8scsu.cpp
-+++ src/modules/filters/utf8scsu.cpp
-@@ -25,6 +25,8 @@
- #include <utf8scsu.h>
- #include <swbuf.h>
- 
-+using icu_64::UnicodeString;
-+
- SWORD_NAMESPACE_START
- 
-