@helloao/tools 0.2.0 → 0.3.0

package/dist/types/generation/common-types.d.ts

@@ -360,8 +360,8 @@ export declare const CommentaryBookSchema: z.ZodObject<{
     }>;
     name: z.ZodString;
     commonName: z.ZodString;
-    introduction: z.ZodOptional<z.ZodString>;
-    introductionSummary: z.ZodOptional<z.ZodString>;
+    introduction: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodNullable<z.ZodString>, z.ZodTransform<string | undefined, string | null>>>, z.ZodOptional<z.ZodString>>;
+    introductionSummary: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodNullable<z.ZodString>, z.ZodTransform<string | undefined, string | null>>>, z.ZodOptional<z.ZodString>>;
     order: z.ZodNumber;
 }, z.core.$strip>;
 export type CommentaryBook = z.infer<typeof CommentaryBookSchema>;
@@ -1113,6 +1113,18 @@ export declare const TranslationBookChapterSchema: z.ZodObject<{
         }, z.core.$strip>>>;
     }, z.core.$strip>>;
     thisChapterAudioLinks: z.ZodLazy<z.ZodRecord<z.ZodString, z.ZodString>>;
+    thisChapterAudioTimings: z.ZodLazy<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodNumber>>>;
+    thisChapterWords: z.ZodOptional<z.ZodLazy<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodLazy<z.ZodObject<{
+        contentIndex: z.ZodNumber;
+        start: z.ZodNumber;
+        end: z.ZodNumber;
+        strongs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        lemma: z.ZodOptional<z.ZodString>;
+        morph: z.ZodOptional<z.ZodString>;
+        srcloc: z.ZodOptional<z.ZodString>;
+        occurrence: z.ZodOptional<z.ZodNumber>;
+        occurrences: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>>>>;
 }, z.core.$strip>;
 export type TranslationBookChapter = z.infer<typeof TranslationBookChapterSchema>;
 /**
@@ -1145,6 +1157,47 @@ export type CommentaryBookChapter = z.infer<typeof CommentaryBookChapterSchema>;
  */
 export declare const TranslationBookChapterAudioLinksSchema: z.ZodRecord<z.ZodString, z.ZodString>;
 export type TranslationBookChapterAudioLinks = z.infer<typeof TranslationBookChapterAudioLinksSchema>;
+/**
+ * Defines a Zod schema for the audio timings for a book chapter.
+ * Maps a reader ID to the list of times (in seconds) that each verse starts, in verse order.
+ */
+export declare const TranslationBookChapterAudioTimingsSchema: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodNumber>>;
+export type TranslationBookChapterAudioTimings = z.infer<typeof TranslationBookChapterAudioTimingsSchema>;
+/**
+ * Defines a Zod schema for a word-level annotation in a chapter.
+ *
+ * The annotation is anchored to a range of characters in a single item of a
+ * verse's content, so that consumers can highlight exactly the characters that
+ * it applies to.
+ */
+export declare const ChapterWordSchema: z.ZodObject<{
+    contentIndex: z.ZodNumber;
+    start: z.ZodNumber;
+    end: z.ZodNumber;
+    strongs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    lemma: z.ZodOptional<z.ZodString>;
+    morph: z.ZodOptional<z.ZodString>;
+    srcloc: z.ZodOptional<z.ZodString>;
+    occurrence: z.ZodOptional<z.ZodNumber>;
+    occurrences: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type ChapterWord = z.infer<typeof ChapterWordSchema>;
+/**
+ * Defines a Zod schema for the word-level annotations for a book chapter.
+ * Maps a verse number to the list of annotated words in the verse, in order.
+ */
+export declare const TranslationBookChapterWordsSchema: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodLazy<z.ZodObject<{
+    contentIndex: z.ZodNumber;
+    start: z.ZodNumber;
+    end: z.ZodNumber;
+    strongs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    lemma: z.ZodOptional<z.ZodString>;
+    morph: z.ZodOptional<z.ZodString>;
+    srcloc: z.ZodOptional<z.ZodString>;
+    occurrence: z.ZodOptional<z.ZodNumber>;
+    occurrences: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>>>>;
+export type TranslationBookChapterWords = z.infer<typeof TranslationBookChapterWordsSchema>;
 /**
  * Defines a Zod schema for information about data in a chapter.
  */
@@ -1352,4 +1405,381 @@ export declare const ChapterFootnoteSchema: z.ZodObject<{
     caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
 }, z.core.$strip>;
 export type ChapterFootnote = z.infer<typeof ChapterFootnoteSchema>;
+/**
+ * A Zod schema for a range of text inside a simplified verse.
+ *
+ * Ranges are expressed as offsets into the `text` property of the verse that contains them.
+ * Offsets are measured in UTF-16 code units, which is what JavaScript's `String.prototype.length`,
+ * `String.prototype.slice()`, and `String.prototype.substring()` use.
+ */
+export declare const SimpleTextRangeSchema: z.ZodObject<{
+    start: z.ZodNumber;
+    end: z.ZodNumber;
+}, z.core.$strip>;
+export type SimpleTextRange = z.infer<typeof SimpleTextRangeSchema>;
+/**
+ * A Zod schema for a range of text inside a simplified verse that represents a line of poetry.
+ */
+export declare const SimplePoemRangeSchema: z.ZodObject<{
+    start: z.ZodNumber;
+    end: z.ZodNumber;
+    level: z.ZodNumber;
+}, z.core.$strip>;
+export type SimplePoemRange = z.infer<typeof SimplePoemRangeSchema>;
+/**
+ * A Zod schema for a footnote in a simplified verse.
+ */
+export declare const SimpleVerseFootnoteSchema: z.ZodObject<{
+    noteId: z.ZodNumber;
+    offset: z.ZodNumber;
+    text: z.ZodString;
+    caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
+}, z.core.$strip>;
+export type SimpleVerseFootnote = z.infer<typeof SimpleVerseFootnoteSchema>;
+/**
+ * A Zod schema for a heading that is embedded in a simplified verse.
+ */
+export declare const SimpleInlineHeadingSchema: z.ZodObject<{
+    offset: z.ZodNumber;
+    text: z.ZodString;
+}, z.core.$strip>;
+export type SimpleInlineHeading = z.infer<typeof SimpleInlineHeadingSchema>;
+/**
+ * A Zod schema for a verse in a simplified chapter.
+ */
+export declare const SimpleChapterVerseSchema: z.ZodObject<{
+    type: z.ZodLiteral<"verse">;
+    number: z.ZodNumber;
+    text: z.ZodString;
+    footnotes: z.ZodArray<z.ZodObject<{
+        noteId: z.ZodNumber;
+        offset: z.ZodNumber;
+        text: z.ZodString;
+        caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
+    }, z.core.$strip>>;
+    headings: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        offset: z.ZodNumber;
+        text: z.ZodString;
+    }, z.core.$strip>>>;
+    wordsOfJesus: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        start: z.ZodNumber;
+        end: z.ZodNumber;
+    }, z.core.$strip>>>;
+    poem: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        start: z.ZodNumber;
+        end: z.ZodNumber;
+        level: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type SimpleChapterVerse = z.infer<typeof SimpleChapterVerseSchema>;
+/**
+ * A Zod schema for a Hebrew Subtitle in a simplified chapter.
+ */
+export declare const SimpleChapterHebrewSubtitleSchema: z.ZodObject<{
+    text: z.ZodString;
+    poem: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        start: z.ZodNumber;
+        end: z.ZodNumber;
+        level: z.ZodNumber;
+    }, z.core.$strip>>>;
+    wordsOfJesus: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        start: z.ZodNumber;
+        end: z.ZodNumber;
+    }, z.core.$strip>>>;
+    footnotes: z.ZodArray<z.ZodObject<{
+        noteId: z.ZodNumber;
+        offset: z.ZodNumber;
+        text: z.ZodString;
+        caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
+    }, z.core.$strip>>;
+    headings: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        offset: z.ZodNumber;
+        text: z.ZodString;
+    }, z.core.$strip>>>;
+    type: z.ZodLiteral<"hebrew_subtitle">;
+}, z.core.$strip>;
+export type SimpleChapterHebrewSubtitle = z.infer<typeof SimpleChapterHebrewSubtitleSchema>;
+/**
+ * A Zod schema for a heading in a simplified chapter.
+ */
+export declare const SimpleChapterHeadingSchema: z.ZodObject<{
+    type: z.ZodLiteral<"heading">;
+    text: z.ZodString;
+}, z.core.$strip>;
+export type SimpleChapterHeading = z.infer<typeof SimpleChapterHeadingSchema>;
+/**
+ * A union type that represents a single piece of content in a simplified chapter.
+ * A piece of chapter content can be one of the following things:
+ * - A heading.
+ * - A line break.
+ * - A verse.
+ * - A Hebrew Subtitle.
+ */
+export declare const SimpleChapterContentSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"heading">;
+    text: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"line_break">;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"verse">;
+    number: z.ZodNumber;
+    text: z.ZodString;
+    footnotes: z.ZodArray<z.ZodObject<{
+        noteId: z.ZodNumber;
+        offset: z.ZodNumber;
+        text: z.ZodString;
+        caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
+    }, z.core.$strip>>;
+    headings: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        offset: z.ZodNumber;
+        text: z.ZodString;
+    }, z.core.$strip>>>;
+    wordsOfJesus: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        start: z.ZodNumber;
+        end: z.ZodNumber;
+    }, z.core.$strip>>>;
+    poem: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        start: z.ZodNumber;
+        end: z.ZodNumber;
+        level: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    text: z.ZodString;
+    poem: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        start: z.ZodNumber;
+        end: z.ZodNumber;
+        level: z.ZodNumber;
+    }, z.core.$strip>>>;
+    wordsOfJesus: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        start: z.ZodNumber;
+        end: z.ZodNumber;
+    }, z.core.$strip>>>;
+    footnotes: z.ZodArray<z.ZodObject<{
+        noteId: z.ZodNumber;
+        offset: z.ZodNumber;
+        text: z.ZodString;
+        caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
+    }, z.core.$strip>>;
+    headings: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        offset: z.ZodNumber;
+        text: z.ZodString;
+    }, z.core.$strip>>>;
+    type: z.ZodLiteral<"hebrew_subtitle">;
+}, z.core.$strip>], "type">;
+export type SimpleChapterContent = z.infer<typeof SimpleChapterContentSchema>;
+/**
+ * A Zod schema for the data in a simplified chapter.
+ */
+export declare const SimpleChapterDataSchema: z.ZodObject<{
+    number: z.ZodNumber;
+    content: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"heading">;
+        text: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"line_break">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"verse">;
+        number: z.ZodNumber;
+        text: z.ZodString;
+        footnotes: z.ZodArray<z.ZodObject<{
+            noteId: z.ZodNumber;
+            offset: z.ZodNumber;
+            text: z.ZodString;
+            caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
+        }, z.core.$strip>>;
+        headings: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            offset: z.ZodNumber;
+            text: z.ZodString;
+        }, z.core.$strip>>>;
+        wordsOfJesus: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            start: z.ZodNumber;
+            end: z.ZodNumber;
+        }, z.core.$strip>>>;
+        poem: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            start: z.ZodNumber;
+            end: z.ZodNumber;
+            level: z.ZodNumber;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        text: z.ZodString;
+        poem: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            start: z.ZodNumber;
+            end: z.ZodNumber;
+            level: z.ZodNumber;
+        }, z.core.$strip>>>;
+        wordsOfJesus: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            start: z.ZodNumber;
+            end: z.ZodNumber;
+        }, z.core.$strip>>>;
+        footnotes: z.ZodArray<z.ZodObject<{
+            noteId: z.ZodNumber;
+            offset: z.ZodNumber;
+            text: z.ZodString;
+            caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
+        }, z.core.$strip>>;
+        headings: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            offset: z.ZodNumber;
+            text: z.ZodString;
+        }, z.core.$strip>>>;
+        type: z.ZodLiteral<"hebrew_subtitle">;
+    }, z.core.$strip>], "type">>;
+    footnotes: z.ZodArray<z.ZodObject<{
+        noteId: z.ZodNumber;
+        text: z.ZodString;
+        reference: z.ZodOptional<z.ZodObject<{
+            chapter: z.ZodNumber;
+            verse: z.ZodNumber;
+        }, z.core.$strip>>;
+        caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SimpleChapterData = z.infer<typeof SimpleChapterDataSchema>;
+/**
+ * A Zod schema for the data in a simplified commentary chapter.
+ */
+export declare const SimpleCommentaryChapterDataSchema: z.ZodObject<{
+    number: z.ZodNumber;
+    introduction: z.ZodOptional<z.ZodString>;
+    content: z.ZodArray<z.ZodObject<{
+        type: z.ZodLiteral<"verse">;
+        number: z.ZodNumber;
+        text: z.ZodString;
+        footnotes: z.ZodArray<z.ZodObject<{
+            noteId: z.ZodNumber;
+            offset: z.ZodNumber;
+            text: z.ZodString;
+            caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
+        }, z.core.$strip>>;
+        headings: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            offset: z.ZodNumber;
+            text: z.ZodString;
+        }, z.core.$strip>>>;
+        wordsOfJesus: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            start: z.ZodNumber;
+            end: z.ZodNumber;
+        }, z.core.$strip>>>;
+        poem: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            start: z.ZodNumber;
+            end: z.ZodNumber;
+            level: z.ZodNumber;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SimpleCommentaryChapterData = z.infer<typeof SimpleCommentaryChapterDataSchema>;
+/**
+ * Defines a Zod schema for information about a book chapter, using the simplified
+ * chapter format.
+ */
+export declare const SimpleTranslationBookChapterSchema: z.ZodObject<{
+    thisChapterAudioLinks: z.ZodLazy<z.ZodRecord<z.ZodString, z.ZodString>>;
+    thisChapterAudioTimings: z.ZodLazy<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodNumber>>>;
+    chapter: z.ZodLazy<z.ZodObject<{
+        number: z.ZodNumber;
+        content: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"heading">;
+            text: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"line_break">;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"verse">;
+            number: z.ZodNumber;
+            text: z.ZodString;
+            footnotes: z.ZodArray<z.ZodObject<{
+                noteId: z.ZodNumber;
+                offset: z.ZodNumber;
+                text: z.ZodString;
+                caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
+            }, z.core.$strip>>;
+            headings: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                offset: z.ZodNumber;
+                text: z.ZodString;
+            }, z.core.$strip>>>;
+            wordsOfJesus: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                start: z.ZodNumber;
+                end: z.ZodNumber;
+            }, z.core.$strip>>>;
+            poem: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                start: z.ZodNumber;
+                end: z.ZodNumber;
+                level: z.ZodNumber;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>, z.ZodObject<{
+            text: z.ZodString;
+            poem: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                start: z.ZodNumber;
+                end: z.ZodNumber;
+                level: z.ZodNumber;
+            }, z.core.$strip>>>;
+            wordsOfJesus: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                start: z.ZodNumber;
+                end: z.ZodNumber;
+            }, z.core.$strip>>>;
+            footnotes: z.ZodArray<z.ZodObject<{
+                noteId: z.ZodNumber;
+                offset: z.ZodNumber;
+                text: z.ZodString;
+                caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
+            }, z.core.$strip>>;
+            headings: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                offset: z.ZodNumber;
+                text: z.ZodString;
+            }, z.core.$strip>>>;
+            type: z.ZodLiteral<"hebrew_subtitle">;
+        }, z.core.$strip>], "type">>;
+        footnotes: z.ZodArray<z.ZodObject<{
+            noteId: z.ZodNumber;
+            text: z.ZodString;
+            reference: z.ZodOptional<z.ZodObject<{
+                chapter: z.ZodNumber;
+                verse: z.ZodNumber;
+            }, z.core.$strip>>;
+            caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    thisChapterWords: z.ZodOptional<z.ZodLazy<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodLazy<z.ZodObject<{
+        start: z.ZodNumber;
+        end: z.ZodNumber;
+        strongs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        lemma: z.ZodOptional<z.ZodString>;
+        morph: z.ZodOptional<z.ZodString>;
+        srcloc: z.ZodOptional<z.ZodString>;
+        occurrence: z.ZodOptional<z.ZodNumber>;
+        occurrences: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>>>>;
+}, z.core.$strip>;
+export type SimpleTranslationBookChapter = z.infer<typeof SimpleTranslationBookChapterSchema>;
+/**
+ * A Zod schema for a word-level annotation in a simplified chapter.
+ *
+ * Unlike the regular annotations, these are anchored to a range of characters in the
+ * text of a verse, since the simplified format replaces the verse's content array with
+ * a single string.
+ */
+export declare const SimpleChapterWordSchema: z.ZodObject<{
+    start: z.ZodNumber;
+    end: z.ZodNumber;
+    strongs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    lemma: z.ZodOptional<z.ZodString>;
+    morph: z.ZodOptional<z.ZodString>;
+    srcloc: z.ZodOptional<z.ZodString>;
+    occurrence: z.ZodOptional<z.ZodNumber>;
+    occurrences: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type SimpleChapterWord = z.infer<typeof SimpleChapterWordSchema>;
+/**
+ * Defines a Zod schema for the word-level annotations for a book chapter, using the
+ * simplified format.
+ * Maps a verse number to the list of annotated words in the verse, in order.
+ */
+export declare const SimpleTranslationBookChapterWordsSchema: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodLazy<z.ZodObject<{
+    start: z.ZodNumber;
+    end: z.ZodNumber;
+    strongs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    lemma: z.ZodOptional<z.ZodString>;
+    morph: z.ZodOptional<z.ZodString>;
+    srcloc: z.ZodOptional<z.ZodString>;
+    occurrence: z.ZodOptional<z.ZodNumber>;
+    occurrences: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>>>>;
+export type SimpleTranslationBookChapterWords = z.infer<typeof SimpleTranslationBookChapterWordsSchema>;
 //# sourceMappingURL=common-types.d.ts.map

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

@@ -2,6 +2,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';
+import * as simple from './simple.js';
 export * from './common-types.js';
-export { api, audio, dataset, bookOrder };
+export { api, audio, dataset, bookOrder, simple };
 //# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,110 @@
+import { ChapterData, ChapterFootnote, ChapterHebrewSubtitle, ChapterVerse, ChapterWord, CommentaryChapterData, SimpleChapterData, SimpleChapterHebrewSubtitle, SimpleChapterVerse, SimpleChapterWord, SimpleCommentaryChapterData, SimpleInlineHeading, SimplePoemRange, SimpleTextRange, SimpleVerseFootnote, TranslationBookChapterWords, SimpleTranslationBookChapterWords } from './common-types.js';
+/**
+ * The types of content that can be contained in a verse or Hebrew Subtitle.
+ */
+type VerseContent = ChapterVerse['content'][number] | ChapterHebrewSubtitle['content'][number];
+/**
+ * The result of flattening the content of a verse into a single string.
+ */
+export interface SimplifiedVerseContent {
+    /**
+     * The text of the verse.
+     */
+    text: string;
+    /**
+     * The footnotes that occur in the verse.
+     */
+    footnotes: SimpleVerseFootnote[];
+    /**
+     * The headings that occur in the middle of the verse.
+     */
+    headings: SimpleInlineHeading[];
+    /**
+     * The ranges of text that represent the Words of Jesus.
+     */
+    wordsOfJesus: SimpleTextRange[];
+    /**
+     * The ranges of text that represent lines of poetry.
+     */
+    poem: SimplePoemRange[];
+    /**
+     * The word-level annotations for the verse, with their offsets remapped onto the text.
+     */
+    words: SimpleChapterWord[];
+}
+/**
+ * Flattens the content of a verse into a single string, recording the positions of the
+ * footnotes, headings, and formatting that occur in it.
+ *
+ * The rules used to build the text are:
+ * - Strings and formatted text are appended as-is. The source data already contains the
+ *   spacing that is needed between them.
+ * - Lines of poetry and line breaks start a new line.
+ * - Footnote and heading markers are replaced with a single space when one is needed to
+ *   keep the surrounding words apart.
+ *
+ * All of the recorded offsets are measured in UTF-16 code units, which is what
+ * `String.prototype.slice()` and `String.prototype.length` use.
+ *
+ * Word-level annotations are anchored to a range of characters in a single item of the
+ * content array. Since the simplified format replaces that array with a single string,
+ * their offsets are remapped onto the text that is built here.
+ *
+ * @param content The content of the verse.
+ * @param footnotes The footnotes for the chapter, keyed by note ID.
+ * @param usedFootnotes A set that the IDs of the referenced footnotes are added to.
+ * @param words The word-level annotations for the verse.
+ */
+export declare function simplifyVerseContent(content: readonly VerseContent[], footnotes?: Map<number, ChapterFootnote>, usedFootnotes?: Set<number>, words?: readonly ChapterWord[]): SimplifiedVerseContent;
+/**
+ * Converts the given verse into its simplified representation.
+ * @param verse The verse to convert.
+ * @param footnotes The footnotes for the chapter, keyed by note ID.
+ * @param usedFootnotes A set that the IDs of the referenced footnotes are added to.
+ * @param words The word-level annotations for the verse.
+ * @param remappedWords An array that the remapped word-level annotations are added to.
+ */
+export declare function simplifyVerse(verse: ChapterVerse, footnotes?: Map<number, ChapterFootnote>, usedFootnotes?: Set<number>, words?: readonly ChapterWord[], remappedWords?: SimpleChapterWord[]): SimpleChapterVerse;
+/**
+ * Converts the given Hebrew Subtitle into its simplified representation.
+ * @param subtitle The subtitle to convert.
+ * @param footnotes The footnotes for the chapter, keyed by note ID.
+ * @param usedFootnotes A set that the IDs of the referenced footnotes are added to.
+ */
+export declare function simplifyHebrewSubtitle(subtitle: ChapterHebrewSubtitle, footnotes?: Map<number, ChapterFootnote>, usedFootnotes?: Set<number>): SimpleChapterHebrewSubtitle;
+/**
+ * The result of converting a chapter into the simplified chapter format.
+ */
+export interface SimplifiedChapter {
+    /**
+     * The simplified chapter.
+     */
+    chapter: SimpleChapterData;
+    /**
+     * The word-level annotations for the chapter, with their offsets remapped onto the
+     * text of each simplified verse. Empty if the chapter has no annotations.
+     */
+    words: SimpleTranslationBookChapterWords;
+}
+/**
+ * Converts the given chapter into the simplified chapter format.
+ *
+ * In the simplified format, the content of each verse is a single string instead of a list
+ * of formatted content, and the footnotes are available on the verse that they occur in,
+ * along with the offset that they occur at.
+ *
+ * The word-level annotations are returned separately, since they are published in their
+ * own file. They are converted here because their offsets have to be remapped onto the
+ * text that is built for each verse.
+ *
+ * @param chapter The chapter to convert.
+ * @param words The word-level annotations for the chapter, keyed by verse number.
+ */
+export declare function simplifyChapter(chapter: ChapterData, words?: TranslationBookChapterWords): SimplifiedChapter;
+/**
+ * Converts the given commentary chapter into the simplified chapter format.
+ * @param chapter The chapter to convert.
+ */
+export declare function simplifyCommentaryChapter(chapter: CommentaryChapterData): SimpleCommentaryChapterData;
+export {};
+//# sourceMappingURL=simple.d.ts.map

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

@@ -1,4 +1,4 @@
-import { CommentaryParseTree } from './types';
+import { CommentaryParseTree } from './types.js';
 export interface CsvLine {
     book: string;
     chapter: string;

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

@@ -1,4 +1,4 @@
-import { ParseTree } from './types';
+import { ParseTree } from './types.js';
 export declare const LOCKMAN_PARSER_VERSION = 3;
 export declare class LockmanParser {
     parse(text: string): ParseTree[];

package/dist/types/parser/tyndale-xml-parser.d.ts

@@ -1,4 +1,4 @@
-import { CommentaryParseTree } from './types';
+import { CommentaryParseTree } from './types.js';
 export declare class TyndaleXmlParser {
     private _domParser;
     constructor(domParser: DOMParser);

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

@@ -49,6 +49,69 @@ export interface Chapter {
      * The list of footnotes for the chapter.
      */
     footnotes: Footnote[];
+    /**
+     * The word-level annotations for the chapter's verses.
+     * Undefined if the source didn't contain any word-level annotations.
+     */
+    words?: ChapterWords;
+}
+/**
+ * Defines the word-level annotations for a chapter, keyed by verse number.
+ */
+export type ChapterWords = {
+    [verseNumber: string]: ChapterWord[];
+};
+/**
+ * Defines an interface that represents the annotations that a source associated
+ * with a specific range of characters in a verse.
+ *
+ * The range is anchored to a single item of the verse's content array, so that
+ * consumers can highlight the exact characters that an annotation applies to.
+ */
+export interface ChapterWord {
+    /**
+     * The index of the item in the verse's content array that the annotation applies to.
+     */
+    contentIndex: number;
+    /**
+     * The index of the first character of the annotated word in the content item's text.
+     */
+    start: number;
+    /**
+     * The index after the last character of the annotated word in the content item's text.
+     * That is, `text.slice(start, end)` is the annotated word.
+     */
+    end: number;
+    /**
+     * The Strong's number(s) for the word.
+     * Undefined if the source only provided other annotations for the word.
+     */
+    strongs?: string[];
+    /**
+     * The dictionary (citation) form of the word.
+     * Taken from the `lemma` attribute.
+     */
+    lemma?: string;
+    /**
+     * The morphology parse code for the word.
+     * Taken from the `x-morph` attribute.
+     */
+    morph?: string;
+    /**
+     * The pointer to the word in the source text, in the `<sourceName>:<location>` format.
+     * Taken from the `srcloc` attribute.
+     */
+    srcloc?: string;
+    /**
+     * Which occurrence of the source word this word is. 1-based.
+     * Taken from the `x-occurrence` attribute.
+     */
+    occurrence?: number;
+    /**
+     * The total number of times that the source word occurs.
+     * Taken from the `x-occurrences` attribute.
+     */
+    occurrences?: number;
 }
 /**
  * Defines an interface that represents a hebrew subtitle.