@helloao/tools 0.0.6 → 0.0.10

package/{generation → dist/types/generation}/dataset.d.ts

@@ -1,4 +1,4 @@
-import { InputFile, Translation, TranslationBook, TranslationBookChapter } from './common-types';
+import { Commentary, CommentaryBook, CommentaryBookChapter, InputFile, Translation, TranslationBook, TranslationBookChapter } from './common-types.js';
 /**
  * Defines an interface that contains generated dataset info.
  */
@@ -7,6 +7,10 @@ export interface DatasetOutput {
      * The list of translations that are available in the dataset.
      */
     translations: DatasetTranslation[];
+    /**
+     * The list of commentaries that are available in the dataset.
+     */
+    commentaries: DatasetCommentary[];
 }
 /**
  * Defines a translation that is used in the dataset.
@@ -17,6 +21,15 @@ export interface DatasetTranslation extends Translation {
      */
     books: DatasetTranslationBook[];
 }
+/**
+ * Defines a commentary that is used in the dataset.
+ */
+export interface DatasetCommentary extends Commentary {
+    /**
+     * The list of books that are available for the translation.
+     */
+    books: DatasetCommentaryBook[];
+}
 /**
  * Defines a translation book that is used in the dataset.
  */
@@ -26,6 +39,15 @@ export interface DatasetTranslationBook extends TranslationBook {
      */
     chapters: TranslationBookChapter[];
 }
+/**
+ * Defines a commentary book that is used in the dataset.
+ */
+export interface DatasetCommentaryBook extends CommentaryBook {
+    /**
+     * The list of chapters that are available for the book.
+     */
+    chapters: CommentaryBookChapter[];
+}
 /**
  * Generates a list of output files from the given list of input files.
  * @param file The list of files.

package/dist/types/generation/index.d.ts

@@ -0,0 +1,7 @@
+import * as api from './api.js';
+import * as audio from './audio.js';
+import * as dataset from './dataset.js';
+import * as bookOrder from './book-order.js';
+export * from './common-types.js';
+export { api, audio, dataset, bookOrder };
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+import * as utils from './utils.js';
+import * as generation from './generation/index.js';
+import * as parser from './parser/index.js';
+export { utils, generation, parser };
+//# sourceMappingURL=index.d.ts.map

package/{parser → dist/types/parser}/codex-parser.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { ParseTree } from './types';
+import { ParseTree } from './types.js';
 export declare const chapterHeadingSchema: z.ZodObject<{
     type: z.ZodLiteral<"chapter-heading">;
     data: z.ZodObject<{
@@ -20,6 +20,26 @@ export declare const chapterHeadingSchema: z.ZodObject<{
         chapter: number;
     };
 }>;
+export declare const verseSchema: z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    type: "text";
+}, {
+    id: string;
+    type: "text";
+}>;
+export declare const paratextSchema: z.ZodObject<{
+    type: z.ZodLiteral<"paratext">;
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    type: "paratext";
+}, {
+    id: string;
+    type: "paratext";
+}>;
 export declare const metadataSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
     type: z.ZodLiteral<"chapter-heading">;
     data: z.ZodObject<{
@@ -39,10 +59,29 @@ export declare const metadataSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
     data: {
         chapter: number;
     };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    type: "text";
+}, {
+    id: string;
+    type: "text";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"paratext">;
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    type: "paratext";
+}, {
+    id: string;
+    type: "paratext";
 }>]>;
 export declare const codexSchema: z.ZodObject<{
     cells: z.ZodArray<z.ZodObject<{
-        language: z.ZodString;
+        kind: z.ZodNumber;
+        languageId: z.ZodString;
         value: z.ZodString;
         metadata: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             type: z.ZodString;
@@ -52,30 +91,34 @@ export declare const codexSchema: z.ZodObject<{
             type: z.ZodString;
         }, z.ZodTypeAny, "passthrough">>>>;
     }, "strip", z.ZodTypeAny, {
+        kind: number;
         value: string;
-        language: string;
+        languageId: string;
         metadata?: z.objectOutputType<{
             type: z.ZodString;
         }, z.ZodTypeAny, "passthrough"> | null | undefined;
     }, {
+        kind: number;
         value: string;
-        language: string;
+        languageId: string;
         metadata?: z.objectInputType<{
             type: z.ZodString;
         }, z.ZodTypeAny, "passthrough"> | null | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     cells: {
+        kind: number;
         value: string;
-        language: string;
+        languageId: string;
         metadata?: z.objectOutputType<{
             type: z.ZodString;
         }, z.ZodTypeAny, "passthrough"> | null | undefined;
     }[];
 }, {
     cells: {
+        kind: number;
         value: string;
-        language: string;
+        languageId: string;
         metadata?: z.objectInputType<{
             type: z.ZodString;
         }, z.ZodTypeAny, "passthrough"> | null | undefined;
@@ -87,9 +130,9 @@ export declare const codexSchema: z.ZodObject<{
 export declare class CodexParser {
     private _noteCounter;
     /**
-     * Parses the specified USX content.
+     * Parses the specified codex content.
      *
-     * @param usx The USX content to parse.
+     * @param codex The codex content to parse.
      * @returns The parse tree that was generated.
      */
     parse(codex: string): ParseTree;

package/dist/types/parser/commentary-csv-parser.d.ts

@@ -0,0 +1,12 @@
+import { CommentaryParseTree } from './types';
+export interface CsvLine {
+    book: string;
+    chapter: string;
+    verse: string;
+    commentaries: string;
+}
+export declare class CommentaryCsvParser {
+    parse(data: string): CommentaryParseTree;
+    parseLines(data: CsvLine[]): CommentaryParseTree;
+}
+//# sourceMappingURL=commentary-csv-parser.d.ts.map

package/dist/types/parser/index.d.ts

@@ -0,0 +1,8 @@
+export * from './types.js';
+export * from './usfm-parser.js';
+export * from './usx-parser.js';
+export * from './codex-parser.js';
+export * from './commentary-csv-parser.js';
+import * as iterators from './iterators.js';
+export { iterators };
+//# sourceMappingURL=index.d.ts.map

package/{parser → dist/types/parser}/types.d.ts

@@ -24,7 +24,7 @@ export interface Heading {
     type: 'heading';
     content: string[];
 }
-export type ChapterContent = (Heading | Verse | HebrewSubtitle | LineBreak);
+export type ChapterContent = Heading | Verse | HebrewSubtitle | LineBreak;
 export type VerseContent = string | FootnoteReference | Text;
 /**
  * Defines an interface that represents a chapter.
@@ -141,4 +141,31 @@ export interface Footnote {
 export interface LineBreak {
     type: 'line_break';
 }
+/**
+ * The parse tree that is gathered.
+ */
+export interface CommentaryParseTree {
+    type: 'commentary/root';
+    /**
+     * The books that are contained in the commentary.
+     */
+    books: CommentaryBookNode[];
+}
+export interface CommentaryBookNode {
+    type: 'book';
+    book: string;
+    introduction: string | null;
+    chapters: CommentaryChapterNode[];
+}
+export interface CommentaryChapterNode {
+    type: 'chapter';
+    number: number;
+    introduction: string | null;
+    verses: CommentaryVerseNode[];
+}
+export interface CommentaryVerseNode {
+    type: 'verse';
+    number: number;
+    content: string[];
+}
 //# sourceMappingURL=types.d.ts.map

package/{parser → dist/types/parser}/usfm-parser.d.ts

@@ -1,4 +1,4 @@
-import { ParseTree } from './types';
+import { ParseTree } from './types.js';
 /**
  * Defines a class that can tokenize a stream of characters into tokens.
  */

package/{parser → dist/types/parser}/usx-parser.d.ts

@@ -1,10 +1,10 @@
-import { Chapter, ChapterContent, FootnoteReference, ParseTree, Verse, Text, HebrewSubtitle, InlineLineBreak } from './types';
-import { RewindableIterator } from './iterators';
+import { Chapter, ChapterContent, FootnoteReference, ParseTree, Verse, Text, HebrewSubtitle, InlineLineBreak } from './types.js';
+import { RewindableIterator } from './iterators.js';
 /**
  * The version of the parser.
  * Used to determine whether input files need to be re-parsed.
  */
-export declare const PARSER_VERSION = "1";
+export declare const PARSER_VERSION = "2";
 /**
  * Defines a class that is able to parse USX content.
  */

package/{utils.d.ts → dist/types/utils.d.ts}

@@ -26,4 +26,10 @@ export interface VerseRef {
  * @param text The reference to parse.
  */
 export declare function parseVerseReference(text: string): VerseRef | null;
+/**
+ * Gets the ID of the given book.
+ * Returns null if the ID could not be found.
+ * @param book The name/ID of the book.
+ */
+export declare function getBookId(book: string): string | null;
 //# sourceMappingURL=utils.d.ts.map

package/package.json

@@ -1,14 +1,35 @@
 {
   "name": "@helloao/tools",
-  "version": "0.0.6",
+  "version": "0.0.10",
   "description": "A set of tools for managing HelloAO's Free Bible API",
-  "module": "index.js",
-  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.cjs"
+    },
+    "./*.js": {
+      "types": "./dist/types/*.d.ts",
+      "import": "./dist/esm/*.js",
+      "require": "./dist/cjs/*.cjs"
+    },
+    "./parser/*.js": {
+      "types": "./dist/types/parser/*.d.ts",
+      "import": "./dist/esm/parser/*.js",
+      "require": "./dist/cjs/parser/*.cjs"
+    },
+    "./generation/*.js": {
+      "types": "./dist/types/generation/*.d.ts",
+      "import": "./dist/esm/generation/*.js",
+      "require": "./dist/cjs/generation/*.cjs"
+    }
+  },
   "author": "Kallyn Gowdy <kal@helloao.org>",
   "license": "MIT",
   "dependencies": {
     "lodash": "4.17.21",
-    "zod": "^3.23.8"
+    "zod": "^3.23.8",
+    "papaparse": "5.4.1"
   },
   "devDependencies": {
     "linkedom": "0.18.4",
@@ -20,6 +41,8 @@
     "/migrations/**/*.sql",
     "**/*.js",
     "**/*.js.map",
+    "**/*.cjs",
+    "**/*.cjs.map",
     "**/*.d.ts"
   ],
   "scripts": {}

package/generation/api.js

@@ -1,187 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateApiForDataset = generateApiForDataset;
-exports.generateFilesForApi = generateFilesForApi;
-exports.generateOutputFilesFromDatasets = generateOutputFilesFromDatasets;
-exports.listOfBooksApiLink = listOfBooksApiLink;
-exports.bookChapterApiLink = bookChapterApiLink;
-exports.bookChapterAudioApiLink = bookChapterAudioApiLink;
-exports.jsonFile = jsonFile;
-exports.downloadedFile = downloadedFile;
-exports.replaceSpacesWithUnderscores = replaceSpacesWithUnderscores;
-/**
- * Generates the API output for the given dataset.
- * @param dataset The dataset to generate the API for.
- * @param options The options for generating the API.
- */
-function generateApiForDataset(dataset, options = {}) {
-    const { useCommonName, pathPrefix } = options;
-    const apiPathPrefix = pathPrefix ? pathPrefix : '';
-    let api = {
-        availableTranslations: {
-            translations: [],
-        },
-        translationBooks: [],
-        translationBookChapters: [],
-        translationBookChapterAudio: [],
-        pathPrefix: apiPathPrefix,
-    };
-    const getNativeName = options.getNativeName;
-    const getEnglishName = options.getEnglishName;
-    for (let { books, ...translation } of dataset.translations) {
-        const apiTranslation = {
-            ...translation,
-            availableFormats: ['json'],
-            listOfBooksApiLink: listOfBooksApiLink(translation.id, apiPathPrefix),
-            numberOfBooks: books.length,
-            totalNumberOfChapters: 0,
-            totalNumberOfVerses: 0,
-            languageName: getNativeName
-                ? getNativeName(translation.language) ?? undefined
-                : undefined,
-            languageEnglishName: getEnglishName
-                ? getEnglishName(translation.language) ?? undefined
-                : undefined,
-        };
-        const translationBooks = {
-            translation: apiTranslation,
-            books: [],
-        };
-        let translationChapters = [];
-        for (let { chapters, ...book } of books) {
-            const apiBook = {
-                ...book,
-                firstChapterApiLink: bookChapterApiLink(translation.id, getBookLink(book), 1, 'json', apiPathPrefix),
-                lastChapterApiLink: bookChapterApiLink(translation.id, getBookLink(book), chapters.length, 'json', apiPathPrefix),
-                numberOfChapters: chapters.length,
-                totalNumberOfVerses: 0,
-            };
-            for (let { chapter, thisChapterAudioLinks } of chapters) {
-                const audio = {};
-                const apiBookChapter = {
-                    translation: apiTranslation,
-                    book: apiBook,
-                    chapter: chapter,
-                    thisChapterLink: bookChapterApiLink(translation.id, getBookLink(book), chapter.number, 'json', apiPathPrefix),
-                    thisChapterAudioLinks: audio,
-                    nextChapterApiLink: null,
-                    nextChapterAudioLinks: null,
-                    previousChapterApiLink: null,
-                    previousChapterAudioLinks: null,
-                    numberOfVerses: 0,
-                };
-                for (let reader in thisChapterAudioLinks) {
-                    if (options.generateAudioFiles) {
-                        const apiAudio = {
-                            chapter: apiBookChapter,
-                            link: bookChapterAudioApiLink(translation.id, getBookLink(book), chapter.number, reader, apiPathPrefix),
-                            originalUrl: thisChapterAudioLinks[reader],
-                        };
-                        audio[reader] = apiAudio.link;
-                        api.translationBookChapterAudio.push(apiAudio);
-                    }
-                    else {
-                        audio[reader] = thisChapterAudioLinks[reader];
-                    }
-                }
-                for (let c of chapter.content) {
-                    if (c.type === 'verse') {
-                        apiBookChapter.numberOfVerses++;
-                    }
-                }
-                apiBook.totalNumberOfVerses += apiBookChapter.numberOfVerses;
-                translationChapters.push(apiBookChapter);
-                api.translationBookChapters.push(apiBookChapter);
-            }
-            translationBooks.books.push(apiBook);
-            apiTranslation.totalNumberOfChapters += apiBook.numberOfChapters;
-            apiTranslation.totalNumberOfVerses += apiBook.totalNumberOfVerses;
-        }
-        for (let i = 0; i < translationChapters.length; i++) {
-            if (i > 0) {
-                translationChapters[i].previousChapterApiLink =
-                    bookChapterApiLink(translation.id, getBookLink(translationChapters[i - 1].book), translationChapters[i - 1].chapter.number, 'json', apiPathPrefix);
-                translationChapters[i].previousChapterAudioLinks =
-                    translationChapters[i - 1].thisChapterAudioLinks;
-            }
-            if (i < translationChapters.length - 1) {
-                translationChapters[i].nextChapterApiLink = bookChapterApiLink(translation.id, getBookLink(translationChapters[i + 1].book), translationChapters[i + 1].chapter.number, 'json', apiPathPrefix);
-                translationChapters[i].nextChapterAudioLinks =
-                    translationChapters[i + 1].thisChapterAudioLinks;
-            }
-        }
-        api.availableTranslations.translations.push(apiTranslation);
-        api.translationBooks.push(translationBooks);
-    }
-    return api;
-    function getBookLink(book) {
-        return useCommonName ? book.commonName : book.id;
-    }
-}
-/**
- * Generates the output files for the given API.
- * @param api The API that the files should be generated for.
- */
-function generateFilesForApi(api) {
-    let files = [];
-    files.push(jsonFile(`${api.pathPrefix}/api/available_translations.json`, api.availableTranslations, true));
-    for (let translationBooks of api.translationBooks) {
-        files.push(jsonFile(translationBooks.translation.listOfBooksApiLink, translationBooks));
-    }
-    for (let bookChapter of api.translationBookChapters) {
-        files.push(jsonFile(bookChapter.thisChapterLink, bookChapter));
-    }
-    for (let audio of api.translationBookChapterAudio) {
-        files.push(downloadedFile(audio.link, audio.originalUrl));
-    }
-    return files;
-}
-/**
- * Generates the output files for the given datasets.
- * @param datasets The datasets to generate the output files for.
- * @param options The options for generating the API files.
- */
-async function* generateOutputFilesFromDatasets(datasets, options) {
-    for await (let dataset of datasets) {
-        const api = generateApiForDataset(dataset, options);
-        const files = generateFilesForApi(api);
-        yield files;
-    }
-}
-/**
- * Gets the API Link for the list of books endpoint for a translation.
- * @param translationId The ID of the translation.
- * @returns
- */
-function listOfBooksApiLink(translationId, prefix = '') {
-    return `${prefix}/api/${translationId}/books.json`;
-}
-/**
- * Getes the API link for a book chapter.
- * @param translationId The ID of the translation.
- * @param commonName The name of the book.
- * @param chapterNumber The number of the book.
- * @param extension The extension of the file.
- */
-function bookChapterApiLink(translationId, commonName, chapterNumber, extension, prefix = '') {
-    return `${prefix}/api/${translationId}/${replaceSpacesWithUnderscores(commonName)}/${chapterNumber}.${extension}`;
-}
-function bookChapterAudioApiLink(translationId, bookId, chapterNumber, reader, prefix = '') {
-    return `${prefix}/api/${translationId}/${replaceSpacesWithUnderscores(bookId)}/${chapterNumber}.${reader}.mp3`;
-}
-function jsonFile(path, content, mergable) {
-    return {
-        path,
-        content,
-        mergable,
-    };
-}
-function downloadedFile(path, url) {
-    return {
-        path,
-        content: () => fetch(url).then((response) => response.body),
-    };
-}
-function replaceSpacesWithUnderscores(str) {
-    return str.replace(/[<>:"/\\|?*\s]/g, '_');
-}

package/generation/api.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=api.spec.d.ts.map