@helloao/tools 0.1.0 → 0.2.0

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

@@ -1,5 +1,6 @@
 import { Commentary, CommentaryBook, CommentaryBookChapter, CommentaryProfile, InputFile, Translation, TranslationBook, TranslationBookChapter, Dataset as CommonDataset, DatasetBook, DatasetBookChapter } from './common-types.js';
 import { ParseMessage } from '../parser/types.js';
+export declare const DATASET_VERSION = 1;
 /**
  * Defines an interface that contains generated dataset info.
  */

package/dist/types/parser/codex-parser.d.ts

@@ -3,23 +3,9 @@ import { ParseTree } from './types.js';
 export declare const chapterHeadingSchema: z.ZodObject<{
     type: z.ZodLiteral<"chapter-heading">;
     data: z.ZodObject<{
-        chapter: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        chapter: number;
-    }, {
-        chapter: number;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    type: "chapter-heading";
-    data: {
-        chapter: number;
-    };
-}, {
-    type: "chapter-heading";
-    data: {
-        chapter: number;
-    };
-}>;
+        chapter: z.ZodCoercedNumber<unknown>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
 export declare const verseSchema: z.ZodObject<{
     type: z.ZodLiteral<"text">;
     id: z.ZodString;
@@ -27,101 +13,31 @@ export declare const verseSchema: z.ZodObject<{
     chapter: z.ZodOptional<z.ZodNumber>;
     verse: z.ZodOptional<z.ZodNumber>;
     data: z.ZodOptional<z.ZodObject<{
-        globalReferences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        globalReferences?: string[] | undefined;
-    }, {
-        globalReferences?: string[] | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    type: "text";
-    chapter?: number | undefined;
-    verse?: number | undefined;
-    data?: {
-        globalReferences?: string[] | undefined;
-    } | undefined;
-    bookCode?: string | undefined;
-}, {
-    id: string;
-    type: "text";
-    chapter?: number | undefined;
-    verse?: number | undefined;
-    data?: {
-        globalReferences?: string[] | undefined;
-    } | undefined;
-    bookCode?: string | undefined;
-}>;
+        globalReferences: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 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<{
+}, z.core.$strip>;
+export declare const metadataSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"chapter-heading">;
     data: z.ZodObject<{
-        chapter: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        chapter: number;
-    }, {
-        chapter: number;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    type: "chapter-heading";
-    data: {
-        chapter: number;
-    };
-}, {
-    type: "chapter-heading";
-    data: {
-        chapter: number;
-    };
-}>, z.ZodObject<{
+        chapter: z.ZodCoercedNumber<unknown>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"text">;
     id: z.ZodString;
     bookCode: z.ZodOptional<z.ZodString>;
     chapter: z.ZodOptional<z.ZodNumber>;
     verse: z.ZodOptional<z.ZodNumber>;
     data: z.ZodOptional<z.ZodObject<{
-        globalReferences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        globalReferences?: string[] | undefined;
-    }, {
-        globalReferences?: string[] | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    type: "text";
-    chapter?: number | undefined;
-    verse?: number | undefined;
-    data?: {
-        globalReferences?: string[] | undefined;
-    } | undefined;
-    bookCode?: string | undefined;
-}, {
-    id: string;
-    type: "text";
-    chapter?: number | undefined;
-    verse?: number | undefined;
-    data?: {
-        globalReferences?: string[] | undefined;
-    } | undefined;
-    bookCode?: string | undefined;
-}>, z.ZodObject<{
+        globalReferences: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"paratext">;
     id: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    type: "paratext";
-}, {
-    id: string;
-    type: "paratext";
-}>]>;
+}, z.core.$strip>], "type">;
 export declare const codexSchema: z.ZodObject<{
     cells: z.ZodArray<z.ZodObject<{
         kind: z.ZodNumber;
@@ -129,45 +45,9 @@ export declare const codexSchema: z.ZodObject<{
         value: z.ZodString;
         metadata: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             type: z.ZodString;
-        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-            type: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-            type: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">>>>;
-    }, "strip", z.ZodTypeAny, {
-        kind: number;
-        value: string;
-        languageId: string;
-        metadata?: z.objectOutputType<{
-            type: z.ZodString;
-        }, z.ZodTypeAny, "passthrough"> | null | undefined;
-    }, {
-        kind: number;
-        value: string;
-        languageId: string;
-        metadata?: z.objectInputType<{
-            type: z.ZodString;
-        }, z.ZodTypeAny, "passthrough"> | null | undefined;
-    }>, "many">;
-}, "strip", z.ZodTypeAny, {
-    cells: {
-        kind: number;
-        value: string;
-        languageId: string;
-        metadata?: z.objectOutputType<{
-            type: z.ZodString;
-        }, z.ZodTypeAny, "passthrough"> | null | undefined;
-    }[];
-}, {
-    cells: {
-        kind: number;
-        value: string;
-        languageId: string;
-        metadata?: z.objectInputType<{
-            type: z.ZodString;
-        }, z.ZodTypeAny, "passthrough"> | null | undefined;
-    }[];
-}>;
+        }, z.core.$loose>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 /**
  * Defines a parser for codex files.
  */

package/dist/types/parser/lockman-parser.d.ts

@@ -0,0 +1,14 @@
+import { ParseTree } from './types';
+export declare const LOCKMAN_PARSER_VERSION = 3;
+export declare class LockmanParser {
+    parse(text: string): ParseTree[];
+    private getBookIdFromVerseTag;
+    private parseVerseContent;
+    private addText;
+    private parseHebrewSubtitleContent;
+    private addSubtitleText;
+    private processFootnote;
+    private processFootnoteForSubtitle;
+    private extractFootnoteText;
+}
+//# sourceMappingURL=lockman-parser.d.ts.map

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

@@ -94,6 +94,10 @@ export interface Text {
      * This is only used for "hebrew subtitles" that are included inside the verse markers.
      */
     descriptive?: boolean;
+    /**
+     * Whether the text should be displayed in italics.
+     */
+    italics?: boolean;
 }
 /**
  * Defines an interface that represents a heading that is embedded in a verse.

package/dist/types/parser/usx-parser.d.ts

@@ -4,7 +4,7 @@ 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 = "2";
+export declare const PARSER_VERSION = 3;
 /**
  * Defines a class that is able to parse USX content.
  */
@@ -25,7 +25,7 @@ export declare class USXParser {
     parse(usx: string): ParseTree;
     iterateRootContent(usxElement: Element): Generator<ParseTree['content'][0]>;
     iterateChapterContent(chapter: Chapter, nodes: RewindableIterator<Node>): IterableIterator<ChapterContent>;
-    iterateVerseContent(chapter: Chapter, verse: Verse, nodes: RewindableIterator<Node>): IterableIterator<string | FootnoteReference | Text | InlineLineBreak>;
+    iterateVerseContent(chapter: Chapter, verse: Verse, nodes: RewindableIterator<Node>, previousVerse?: Verse | null): IterableIterator<string | FootnoteReference | Text | InlineLineBreak>;
     parseVerse(element: Element, chapter: Chapter, nodes: RewindableIterator<Node>): Verse;
     parseHebrewSubtitle(para: Element, chapter: Chapter, nodes: RewindableIterator<Node>): IterableIterator<HebrewSubtitle | Verse>;
     iterateHebrewSubtitleContent(element: Element, chapter: Chapter, nodes: RewindableIterator<Node>): IterableIterator<Verse | string | Text | FootnoteReference | InlineLineBreak>;

package/dist/types/utils.d.ts

@@ -1,3 +1,4 @@
+import z from "zod";
 /**
  * Normalizes the given language code into a ISO 639 code.
  * @param language The language code to normalize.
@@ -10,23 +11,227 @@ export declare function normalizeLanguage(language: string): string;
 export declare function getTranslationId(translationId: string): string;
 export declare function isEmptyOrWhitespace(str: string | null | undefined): boolean;
 export declare function getFirstNonEmpty<T extends string>(...values: T[]): T;
-export interface VerseRef {
-    book: string;
-    chapter: number;
-    verse: number;
-    /**
-     * The rest of the content of the verse.
-     */
-    content?: string;
-    /**
-     * The chapter that the verse reference ends at.
-     */
-    endChapter?: number;
-    /**
-     * The verse that the verse reference ends at.
-     */
-    endVerse?: number;
-}
+/**
+ * Defines a Zod schema for all USFM book IDs.
+ */
+export declare const BookIdSchema: z.ZodEnum<{
+    GEN: "GEN";
+    EXO: "EXO";
+    LEV: "LEV";
+    NUM: "NUM";
+    DEU: "DEU";
+    JOS: "JOS";
+    JDG: "JDG";
+    RUT: "RUT";
+    "1SA": "1SA";
+    "2SA": "2SA";
+    "1KI": "1KI";
+    "2KI": "2KI";
+    "1CH": "1CH";
+    "2CH": "2CH";
+    EZR: "EZR";
+    NEH: "NEH";
+    EST: "EST";
+    JOB: "JOB";
+    PSA: "PSA";
+    PRO: "PRO";
+    ECC: "ECC";
+    SNG: "SNG";
+    ISA: "ISA";
+    JER: "JER";
+    LAM: "LAM";
+    EZK: "EZK";
+    DAN: "DAN";
+    HOS: "HOS";
+    JOL: "JOL";
+    AMO: "AMO";
+    OBA: "OBA";
+    JON: "JON";
+    MIC: "MIC";
+    NAM: "NAM";
+    HAB: "HAB";
+    ZEP: "ZEP";
+    HAG: "HAG";
+    ZEC: "ZEC";
+    MAL: "MAL";
+    MAT: "MAT";
+    MRK: "MRK";
+    LUK: "LUK";
+    JHN: "JHN";
+    ACT: "ACT";
+    ROM: "ROM";
+    "1CO": "1CO";
+    "2CO": "2CO";
+    GAL: "GAL";
+    EPH: "EPH";
+    PHP: "PHP";
+    COL: "COL";
+    "1TH": "1TH";
+    "2TH": "2TH";
+    "1TI": "1TI";
+    "2TI": "2TI";
+    TIT: "TIT";
+    PHM: "PHM";
+    HEB: "HEB";
+    JAS: "JAS";
+    "1PE": "1PE";
+    "2PE": "2PE";
+    "1JN": "1JN";
+    "2JN": "2JN";
+    "3JN": "3JN";
+    JUD: "JUD";
+    REV: "REV";
+    TOB: "TOB";
+    JDT: "JDT";
+    ESG: "ESG";
+    WIS: "WIS";
+    SIR: "SIR";
+    BAR: "BAR";
+    LJE: "LJE";
+    S3Y: "S3Y";
+    SUS: "SUS";
+    BEL: "BEL";
+    "1MA": "1MA";
+    "2MA": "2MA";
+    "3MA": "3MA";
+    "4MA": "4MA";
+    "1ES": "1ES";
+    "2ES": "2ES";
+    MAN: "MAN";
+    PS2: "PS2";
+    ODA: "ODA";
+    PSS: "PSS";
+    EZA: "EZA";
+    "5EZ": "5EZ";
+    "6EZ": "6EZ";
+    DAG: "DAG";
+    PS3: "PS3";
+    "2BA": "2BA";
+    LBA: "LBA";
+    JUB: "JUB";
+    ENO: "ENO";
+    "1MQ": "1MQ";
+    "2MQ": "2MQ";
+    "3MQ": "3MQ";
+    REP: "REP";
+    "4BA": "4BA";
+    LAO: "LAO";
+}>;
+export type BookId = z.infer<typeof BookIdSchema>;
+/**
+ * Defines a schema for validating verse references.
+ */
+export declare const VerseRefSchema: z.ZodObject<{
+    book: z.ZodEnum<{
+        GEN: "GEN";
+        EXO: "EXO";
+        LEV: "LEV";
+        NUM: "NUM";
+        DEU: "DEU";
+        JOS: "JOS";
+        JDG: "JDG";
+        RUT: "RUT";
+        "1SA": "1SA";
+        "2SA": "2SA";
+        "1KI": "1KI";
+        "2KI": "2KI";
+        "1CH": "1CH";
+        "2CH": "2CH";
+        EZR: "EZR";
+        NEH: "NEH";
+        EST: "EST";
+        JOB: "JOB";
+        PSA: "PSA";
+        PRO: "PRO";
+        ECC: "ECC";
+        SNG: "SNG";
+        ISA: "ISA";
+        JER: "JER";
+        LAM: "LAM";
+        EZK: "EZK";
+        DAN: "DAN";
+        HOS: "HOS";
+        JOL: "JOL";
+        AMO: "AMO";
+        OBA: "OBA";
+        JON: "JON";
+        MIC: "MIC";
+        NAM: "NAM";
+        HAB: "HAB";
+        ZEP: "ZEP";
+        HAG: "HAG";
+        ZEC: "ZEC";
+        MAL: "MAL";
+        MAT: "MAT";
+        MRK: "MRK";
+        LUK: "LUK";
+        JHN: "JHN";
+        ACT: "ACT";
+        ROM: "ROM";
+        "1CO": "1CO";
+        "2CO": "2CO";
+        GAL: "GAL";
+        EPH: "EPH";
+        PHP: "PHP";
+        COL: "COL";
+        "1TH": "1TH";
+        "2TH": "2TH";
+        "1TI": "1TI";
+        "2TI": "2TI";
+        TIT: "TIT";
+        PHM: "PHM";
+        HEB: "HEB";
+        JAS: "JAS";
+        "1PE": "1PE";
+        "2PE": "2PE";
+        "1JN": "1JN";
+        "2JN": "2JN";
+        "3JN": "3JN";
+        JUD: "JUD";
+        REV: "REV";
+        TOB: "TOB";
+        JDT: "JDT";
+        ESG: "ESG";
+        WIS: "WIS";
+        SIR: "SIR";
+        BAR: "BAR";
+        LJE: "LJE";
+        S3Y: "S3Y";
+        SUS: "SUS";
+        BEL: "BEL";
+        "1MA": "1MA";
+        "2MA": "2MA";
+        "3MA": "3MA";
+        "4MA": "4MA";
+        "1ES": "1ES";
+        "2ES": "2ES";
+        MAN: "MAN";
+        PS2: "PS2";
+        ODA: "ODA";
+        PSS: "PSS";
+        EZA: "EZA";
+        "5EZ": "5EZ";
+        "6EZ": "6EZ";
+        DAG: "DAG";
+        PS3: "PS3";
+        "2BA": "2BA";
+        LBA: "LBA";
+        JUB: "JUB";
+        ENO: "ENO";
+        "1MQ": "1MQ";
+        "2MQ": "2MQ";
+        "3MQ": "3MQ";
+        REP: "REP";
+        "4BA": "4BA";
+        LAO: "LAO";
+    }>;
+    chapter: z.ZodNumber;
+    verse: z.ZodNumber;
+    content: z.ZodOptional<z.ZodString>;
+    endChapter: z.ZodOptional<z.ZodNumber>;
+    endVerse: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type VerseRef = z.infer<typeof VerseRefSchema>;
 /**
  * Parses the given verse reference.
  * Formatted like "GEN 1:1".
@@ -39,7 +244,7 @@ export declare function parseVerseReference(text: string): VerseRef | null;
  * 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;
+export declare function getBookId(book: string): BookId | null;
 /**
  * A brief list of verses which may appear in some older translations
  * but are not present in more modern translations.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helloao/tools",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "A set of tools for managing HelloAO's Free Bible API",
   "main": "./dist/cjs/index.cjs",
   "module": "./dist/esm/index.js",
@@ -50,12 +50,14 @@
   "license": "MIT",
   "dependencies": {
     "lodash": "4.17.21",
-    "zod": "^3.23.8",
+    "zod": "^4.4.3",
     "papaparse": "5.4.1"
   },
   "devDependencies": {
+    "@types/jest": "^29.4.0",
     "linkedom": "0.18.4",
-    "hash.js": "1.1.7"
+    "hash.js": "1.1.7",
+    "zod-openapi": "5.4.6"
   },
   "files": [
     "/README.md",