json-bible 1.0.0

package/README.md

@@ -0,0 +1,119 @@
+<img align="right" width="150" height="150" src="JSON_bible_icon.png">
+
+# JSON Bible Format
+
+> A universal digital Bible format in JSON that can be used with any language.
+
+## Format
+
+```json
+{
+    "name": "Bible Name",
+    "metadata": { "publisher": "" },
+    "books": [
+        {
+            "number": 1,
+            "name": "Genesis",
+            "chapters": [
+                {
+                    "number": 1,
+                    "verses": [
+                        {
+                            "number": 1,
+                            "text": "In the beginning God created..."
+                        },
+                        ...
+                    ]
+                },
+                ...
+            ]
+        },
+        ...
+    ]
+}
+```
+
+### Types
+
+This is a selection of the [types found here](./lib/Bible.ts).
+
+```js
+type Bible = {
+    name: string
+    metadata: Metadata
+    books: Book[]
+}
+
+type Book = {
+    number: number
+    name: string
+    chapters: Chapter[]
+}
+
+type Chapter = {
+    number: number
+    header?: string // chapter header
+    verses: Verse[]
+}
+
+type Verse = {
+    number: number
+    endNumber?: number // multiple combined verses
+    text: string
+}
+```
+
+### Markdown:
+
+> Markdown formatting should be used instead of HTML as it is more universal!
+
+Check out the [MD regex parsing here](./lib/markdown.ts).
+
+-   Undertitle: # Text #
+-   Cross Reference & Notes: \*{text}\* | \*{\[reference](id) text}\*
+-   Jesus Red Words: !{text}!
+-   Uncertain: \[text]
+-   Bold: \*\*text\*\* or \_\_text\_\_
+-   Italic: \*text\* or \_text\_
+-   Underline: ++text++
+-   Strikethrough: \~~text~~
+-   Quote: "text"
+-   Line Break: \n
+-   Paragraph: ¶
+
+## Module
+
+Use this NPM module to simplify the use/rendering of the JSON Bible Format! It has a Markdown to HTML parser, search & lots of more helpful utility features!
+
+```js
+import Bible from "json-bible"
+
+const bible = Bible("file-path") // path/url/object
+
+bible.data // JSON data
+
+const book = bible.getBook("Romans")
+const chapter = book.getChapter(5)
+const verse = chapter.getVerse() // get first verse
+const verses = chapter.getVerses([1, 15]).getReference() // "Romans 5:1+15"
+
+verse.getText() // verse text
+verse.getHTML() // HTML formatted verse text
+
+bible.bookSearch("John 3:16-20+22") // book search with auto complete
+bible.textSearch("Jesus") // text search in entire Bible, or one book
+
+// and lots more...
+```
+
+See also [bible.html](./preview/bible.html) as a preview and use example!
+
+## Converter
+
+Use [this converter](https://github.com/vassbo/bible-converter) to convert from other formats like XML Zefania, OSIS, OpenSong, etc.
+
+---
+
+Currently used by [FreeShow Presentation Software](https://freeshow.app).
+
+You are granted the permission to use this in any project!

package/add-js-extension.js

@@ -0,0 +1,42 @@
+import fs from "fs"
+import path from "path"
+import { fileURLToPath } from "url"
+
+function addJsExtension(dir) {
+    fs.readdirSync(dir).forEach((file) => {
+        const fullPath = path.join(dir, file)
+
+        if (fs.lstatSync(fullPath).isDirectory()) {
+            if (file.includes("node_modules")) return
+            addJsExtension(fullPath)
+            return
+        }
+
+        if (file.endsWith(".js") && !file.includes("add-js-extension")) {
+            let content = fs.readFileSync(fullPath, "utf-8")
+
+            // update require statements
+            content = content.replace(/(require\(["'])([^'"]+?)(["']\))/g, (match, p1, p2, p3) => {
+                if (!p2.endsWith(".js") && !p2.startsWith(".") && !p2.startsWith("/")) {
+                    return match
+                }
+                return `${p1}${p2}.js${p3}`
+            })
+
+            // update import statements
+            content = content.replace(/(import\s.*?from\s["'])([^'"]+?)(["'];?)/g, (match, p1, p2, p3) => {
+                if (!p2.endsWith(".js") && (p2.startsWith(".") || p2.startsWith("/"))) {
+                    return `${p1}${p2}.js${p3}`
+                }
+                return match
+            })
+
+            fs.writeFileSync(fullPath, content, "utf-8")
+        }
+    })
+}
+
+const __filename = fileURLToPath(import.meta.url) // get the resolved path to the file
+const __dirname = path.dirname(__filename) // get the name of the directory
+const directoryPath = path.join(__dirname)
+addJsExtension(directoryPath)

package/index.ts

@@ -0,0 +1,243 @@
+import { Bible } from "./lib/Bible"
+import { BIBLE_SIZE, getBookCategory, getDefault, getDefaultBooks, NT_SIZE, OT_SIZE } from "./lib/defaults"
+import { _getBible, _getBook, _getChapter, _getCloseChapter, _getHTML, _getMetadata, _getRandomVerse, _getShortName, _getText, _getVerse, formatText, getBookIndex, getChapterIndex, getVerseIndex } from "./lib/get"
+import { getReferenceString, getVerseReferences } from "./lib/reference"
+import { _bookSearch, _textSearch } from "./lib/search"
+
+/**
+ * JSON Bible Helper
+ * @param bibleOrPath path to Bible file or a Bible JSON object
+ */
+export default async function Bible(bibleOrPath: Bible | string) {
+    const bible = await _getBible(bibleOrPath)
+
+    return { data: bible, getBook, getAbbreviation, getMetadata, getDefaultBooks, getDefault, getOT, getNT, getRandom, getFromReference, bookSearch, textSearch }
+
+    /**
+     * Get a specified book or the first one if not provided
+     * @param number book number/name/id
+     * @return book data
+     */
+    function getBook(numberOrName?: string | number) {
+        if (numberOrName === undefined) numberOrName = bible.books[0].number
+        let bookIndex = getBookIndex(bible, numberOrName)
+        const book = _getBook(bible, bookIndex)
+
+        return { data: book, index: bookIndex, number: book.number, name: book.name, getChapter, getAbbreviation: getNameShort, getCategory }
+
+        /**
+         * Get a specified chapter or the first one if no number provided
+         * @param number chapter number
+         * @return chapter data
+         */
+        function getChapter(number?: number) {
+            if (number === undefined) number = book.chapters[0].number
+            let chapterIndex = getChapterIndex(book, number)
+            const chapter = _getChapter(book, chapterIndex)
+
+            return { data: chapter, index: chapterIndex, number, getVerse, getVerses, getNext, getPrevious, getReference }
+
+            /**
+             * Get a specified verse or the first one if no number provided
+             * @param number verse number
+             * @return verse data
+             */
+            function getVerse(number?: number) {
+                if (number === undefined) number = chapter.verses[0].number
+                let verseIndex = getVerseIndex(chapter, number)
+                const verse = _getVerse(chapter, verseIndex)
+
+                return { data: verse, index: verseIndex, number, getText, getHTML, getReference }
+
+                /**
+                 * A plain text string of the verse
+                 * @param includeNumbers should verse numbers be included
+                 * @return verse text
+                 */
+                function getText(includeNumber: boolean = false) {
+                    return _getText(verse, includeNumber)
+                }
+
+                /**
+                 * A HTML string of the verse with parsed markdown
+                 * @param includeNumbers should verse numbers be included
+                 * @return HTML string value
+                 */
+                function getHTML(includeNumber: boolean = false) {
+                    return _getHTML(verse, includeNumber)
+                }
+
+                /**
+                 * Get verse reference
+                 * @param addBibleVersion add Bible abbreviation at the end of the reference
+                 * @return reference string, e.g. "Genesis 1:1"
+                 */
+                function getReference(addBibleVersion: boolean = false) {
+                    return _getReference([verse.number], addBibleVersion)
+                }
+            }
+
+            /**
+             * Get a selection of verses based in an array of numbers
+             * @param verseNumbers verse numbers
+             * @param html should markdown text be parsed to HTML
+             * @return verses data
+             */
+            function getVerses(verseNumbers: number[] = [], html: boolean = false) {
+                let verses = chapter.verses
+                if (verseNumbers.length) verses = verses.filter((a) => verseNumbers.includes(a.number))
+
+                const data = verses.reduce((obj, { number, text }) => ({ ...obj, [number]: formatText(text, html) }), {} as { [key: number]: string })
+                const numbers = verseNumbers.length ? verseNumbers : verses.map((a) => a.number)
+
+                return { data, numbers, getText, getHTML, getReference }
+
+                /**
+                 * A plain text string of the verses
+                 * @param includeNumbers should verse numbers be included
+                 * @return verse text
+                 */
+                function getText(includeNumbers: boolean = false) {
+                    return verses.map((v) => _getText(v, includeNumbers)).join(" ")
+                }
+
+                /**
+                 * A HTML string of the verses with parsed markdown
+                 * @param includeNumbers should verse numbers be included
+                 * @return HTML string value
+                 */
+                function getHTML(includeNumbers: boolean = false) {
+                    return verses.map((v, i) => _getHTML(v, includeNumbers, i === 0)).join(" ")
+                }
+
+                /**
+                 * Get verses reference
+                 * @param addBibleVersion add Bible abbreviation at the end of the reference
+                 * @return reference string, e.g. "Genesis 1:1-3"
+                 */
+                function getReference(addBibleVersion: boolean = false) {
+                    return _getReference(numbers, addBibleVersion)
+                }
+            }
+
+            /**
+             * Get next chapter relative to the one currently selected
+             * @return a reference to the next chapter, including possibly changed book - null if none available
+             */
+            function getNext() {
+                return _getCloseChapter(bible, book.number, chapter.number, true)
+            }
+
+            /**
+             * Get previous chapter relative to the one currently selected
+             * @return a reference to the previous chapter, including possibly changed book - null if none available
+             */
+            function getPrevious() {
+                return _getCloseChapter(bible, book.number, chapter.number, false)
+            }
+
+            /**
+             * Get chapter reference
+             * @param addBibleVersion add Bible abbreviation at the end of the reference
+             * @return reference string, e.g. "Genesis 1"
+             */
+            function getReference(addBibleVersion: boolean = false) {
+                return _getReference([], addBibleVersion)
+            }
+
+            // HELPER
+            function _getReference(verses: number[], addBibleVersion: boolean = false) {
+                return getReferenceString({ book: book.number, chapter: chapter.number, verses }, bible) + (addBibleVersion ? ` ${getAbbreviation()}` : "")
+            }
+        }
+
+        /**
+         * Get three letter book abbreviation/short name
+         * @return e.g. "Genesis" = "Gen"
+         */
+        function getNameShort() {
+            const abbr = getDefaultBooks().ids[book.number - 1]
+            return abbr[0] + abbr.slice(1).toLowerCase()
+        }
+
+        /**
+         * Get current book category name/color, all categories are:
+         * "The Law", "History", "Poetry & Wisdom", "Prophets", "The Gospels & Acts", "Letters" & "Apocalyptic"
+         * @return book category object
+         */
+        function getCategory() {
+            return getBookCategory(book)
+        }
+    }
+
+    /**
+     * @return bible name abbreviation/identifier
+     */
+    function getAbbreviation() {
+        return _getShortName(bible)
+    }
+
+    /**
+     * @return trimmed metadata object
+     */
+    function getMetadata() {
+        return _getMetadata(bible)
+    }
+
+    /**
+     * Get all books in the Bible from the Old Testament
+     * @return list of max 39 books
+     */
+    function getOT() {
+        if (bible.books.length === OT_SIZE) return bible.books
+        if (bible.books.length === BIBLE_SIZE) return bible.books.slice(0, OT_SIZE)
+        return bible.books.filter((a) => a.number >= 1 && a.number <= OT_SIZE)
+    }
+
+    /**
+     * Get all books in the Bible from the New Testament
+     * @return list of max 27 books
+     */
+    function getNT() {
+        if (bible.books.length === NT_SIZE) return bible.books
+        if (bible.books.length === BIBLE_SIZE) return bible.books.slice(OT_SIZE)
+        return bible.books.filter((a) => a.number > OT_SIZE && a.number <= BIBLE_SIZE)
+    }
+
+    /**
+     * Get a random verse
+     * @return random verse
+     */
+    function getRandom() {
+        return _getRandomVerse(bible)
+    }
+
+    /**
+     * Get book/chapter/verses from a string reference
+     * @param value e.g. "Genesis 1:1-3" / "GEN.1.2-3" / "1.1.1"
+     * @return matching content
+     */
+    function getFromReference(value: string) {
+        return getVerseReferences(bible, value)
+    }
+
+    /**
+     * Search for book/chapter/verses with autocomplete
+     * @param value e.g. "Genesis 1:1-3"
+     * @return matching content
+     */
+    function bookSearch(value: string) {
+        return _bookSearch(bible, value)
+    }
+
+    /**
+     * Search for text content in the entire Bible
+     * @param value search string
+     * @param limit max results, lower number means quicker search
+     * @param bookNumber search only in a specified book
+     * @return an array of verses
+     */
+    function textSearch(value: string, limit: number = 500, bookNumber?: number) {
+        return _textSearch(bible, value, limit, bookNumber)
+    }
+}

package/lib/Bible.ts

@@ -0,0 +1,45 @@
+export interface Bible {
+    name: string // e.g. "King James Version"
+    abbreviation?: string // e.g. "KJV"
+    metadata: Metadata
+
+    books: Book[]
+}
+
+export type Book = {
+    number: number // starting from 1
+    name: string // e.g. "Genesis"
+    id?: string // e.g. "GEN"
+
+    chapters: Chapter[]
+}
+
+export type Chapter = {
+    number: number // starting from 1
+    header?: string // e.g. "Book I" / "A Psalm by David"
+
+    verses: Verse[]
+}
+
+export type Verse = {
+    number: number // starting from 1
+    endNumber?: number // if multiple verses are combined (end verse is different than start "number") enter value here
+
+    text: string // verse text with markdown supported formatting!
+}
+
+export type Metadata = {
+    title?: string // e.g. "King James Version"
+    identifier?: string // e.g. "KJV"
+    description?: string // e.g. "In 1604, King James I of England authorized that a new translation of the Bible into English be started. It was finished in 1611..."
+    language?: string // e.g. "en"
+
+    publisher?: string // e.g. "FREE BIBLE SOFTWARE GROUP"
+    publishDate?: string // e.g. "2009-01-23"
+    contributors?: string[]
+
+    copyright?: string
+
+    // custom keys allowed
+    [key: string]: any
+}

package/lib/defaults.ts

@@ -0,0 +1,136 @@
+import { Bible, Book, Chapter, Metadata, Verse } from "./Bible"
+import { clone } from "./util"
+
+export const BIBLE_SIZE = 66
+export const OT_SIZE = 39
+export const NT_SIZE = 27
+
+export function getDefault() {
+    const bible: Bible = { name: "", metadata: {}, books: [] }
+    const book: Book = { number: 0, name: "", chapters: [] }
+    const chapter: Chapter = { number: 0, verses: [] }
+    const verse: Verse = { number: 0, text: "" }
+
+    return { bible, book, chapter, verse }
+}
+
+export function getDefaultMetadata() {
+    const metadata: Metadata = {
+        title: "",
+        identifier: "",
+        description: "",
+        language: "",
+        publisher: "",
+        contributors: [],
+        date: 0,
+        copyright: ""
+    }
+
+    return metadata
+}
+
+// BOOKS
+
+const BOOKS = {
+    GEN: "Genesis",
+    EXO: "Exodus",
+    LEV: "Leviticus",
+    NUM: "Numbers",
+    DEU: "Deuteronomy",
+    JOS: "Joshua",
+    JDG: "Judges",
+    RUT: "Ruth",
+    "1SA": "1 Samuel",
+    "2SA": "2 Samuel",
+    "1KI": "1 Kings",
+    "2KI": "2 Kings",
+    "1CH": "1 Chronicles",
+    "2CH": "2 Chronicles",
+    EZR: "Ezra",
+    NEH: "Nehemiah",
+    EST: "Esther",
+    JOB: "Job",
+    PSA: "Psalms",
+    PRO: "Proverbs",
+    ECC: "Ecclesiastes",
+    SNG: "Song of Solomon",
+    ISA: "Isaiah",
+    JER: "Jeremiah",
+    LAM: "Lamentations",
+    EZE: "Ezekiel",
+    DAN: "Daniel",
+    HOS: "Hosea",
+    JOE: "Joel",
+    AMO: "Amos",
+    OBA: "Obadiah",
+    JON: "Jonah",
+    MIC: "Micah",
+    NAH: "Nahum",
+    HAB: "Habakkuk",
+    ZEP: "Zephaniah",
+    HAG: "Haggai",
+    ZEC: "Zechariah",
+    MAL: "Malachi",
+
+    MAT: "Matthew",
+    MRK: "Mark",
+    LUK: "Luke",
+    JHN: "John",
+    ACT: "Acts",
+    ROM: "Romans",
+    "1CO": "1 Corinthians",
+    "2CO": "2 Corinthians",
+    GAL: "Galatians",
+    EPH: "Ephesians",
+    PHP: "Philippians",
+    COL: "Colossians",
+    "1TH": "1 Thessalonians",
+    "2TH": "2 Thessalonians",
+    "1TI": "1 Timothy",
+    "2TI": "2 Timothy",
+    TIT: "Titus",
+    PHM: "Philemon",
+    HEB: "Hebrews",
+    JAS: "James",
+    "1PE": "1 Peter",
+    "2PE": "2 Peter",
+    "1JN": "1 John",
+    "2JN": "2 John",
+    "3JN": "3 John",
+    JUD: "Jude",
+    REV: "Revelation"
+}
+type BookId = keyof typeof BOOKS
+
+const categories = [
+    { id: "law", start: "GEN", name: "The Law", color: "#e84242" },
+    { id: "history", start: "JOS", name: "History", color: "#e89d42" },
+    { id: "poetry", start: "JOB", name: "Poetry & Wisdom", color: "#b542e8" }, // #e8de42
+    { id: "prophets", start: "ISA", name: "Prophets", color: "#42e84d" },
+    { id: "gospels", start: "MAT", name: "The Gospels & Acts", color: "#42c4e8" },
+    { id: "letters", start: "ROM", name: "Letters", color: "#e8de42" }, // #b542e8
+    { id: "prophecy", start: "REV", name: "Apocalyptic", color: "#e842e5" }
+]
+
+export function getDefaultBooks() {
+    const ids = Object.keys(BOOKS) as BookId[]
+    const names = Object.values(BOOKS)
+
+    return { data: clone(BOOKS), ids, names, byId, byNumber }
+
+    function byId(id: string) {
+        return BOOKS[id as BookId] || ""
+    }
+
+    function byNumber(number: number) {
+        return names[number - 1] || ""
+    }
+}
+
+export function getBookCategory(book: Book) {
+    return categories.find((a, i) => {
+        const startNumber = Object.keys(BOOKS).indexOf(a.start) + 1
+        const endNumber = Object.keys(BOOKS).indexOf(categories[i + 1]?.start) + 1 || startNumber + 1
+        return book.number >= startNumber && book.number < endNumber
+    })
+}