@helloao/tools 0.0.18 → 0.0.19

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

@@ -0,0 +1,20 @@
+import { TranslationBookChapterAudioLinks } from './common-types.js';
+type AudioTranslationUrlGenerator = (bookId: string, chapter: number) => string;
+/**
+ * A map of translation IDs to a map of reader IDs to the URL generator for the audio file.
+ */
+export declare const KNOWN_AUDIO_TRANSLATIONS: Map<string, Map<string, AudioTranslationUrlGenerator>>;
+/**
+ * Gets the audio URLs for the given translation, book, and chapter.
+ * @param translationId The ID of the translation.
+ * @param bookId The ID of the book.
+ * @param chapter The number of the chapter.
+ */
+export declare function getAudioUrlsForChapter(translationId: string, bookId: string, chapter: number): TranslationBookChapterAudioLinks;
+/**
+ * Capitalizes the first letter of the given string.
+ * @param str The string to capitalize.
+ */
+export declare function capitalize(str: string): string;
+export {};
+//# sourceMappingURL=audio.d.ts.map

package/dist/types/generation/book-order.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Defines a map that maps the book ID of apocryphal books to the numerical order of the book.
+ */
+export declare const apocryphaBooks: Map<string, number>;
+/**
+ * Defines a map that maps the book ID to the numerical order of the book.
+ */
+export declare const bookOrderMap: Map<string, number>;
+/**
+ * Defines a map that maps the book ID to the number of chapters the book has.
+ */
+export declare const bookChapterCountMap: Map<string, number>;
+/**
+ * Defines a map that maps a locale ID to a book name map.
+ */
+export declare const bookIdMap: Map<string, Map<string, {
+    commonName: string;
+}>>;
+//# sourceMappingURL=book-order.d.ts.map

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

@@ -0,0 +1,546 @@
+import { VerseRef } from '../utils.js';
+/**
+ * Defines an interface that contains information about a input file.
+ */
+export type InputFile = InputTranslationFile | InputCommentaryFile;
+export interface InputFileBase {
+    name?: string;
+    content: string;
+    sha256?: string;
+}
+export type InputFileMetadata = InputTranslationMetadata | InputCommentaryMetadata;
+export interface InputTranslationFile extends InputFileBase {
+    fileType: 'usfm' | 'usx' | 'json';
+    metadata: InputTranslationMetadata;
+}
+export interface InputCommentaryFile extends InputFileBase {
+    fileType: 'commentary/csv' | 'commentary/tyndale-xml';
+    metadata: InputCommentaryMetadata;
+}
+export type OutputFileContent = object | ReadableStream;
+/**
+ * Defines an interface that contains information about a output file.
+ */
+export interface OutputFile {
+    /**
+     * The path that the file should be stored at.
+     */
+    path: string;
+    /**
+     * The content of the file.
+     */
+    content: OutputFileContent | (() => Promise<OutputFileContent>);
+    /**
+     * Whether the file can be merged with files of the same name but from other datasets.
+     */
+    mergable?: boolean;
+}
+export interface MetadataBase {
+    /**
+     * The name of the translation.
+     */
+    name: string;
+    /**
+     * The english name of the translation.
+     */
+    englishName: string;
+    /**
+     * The website for the translation.
+     */
+    website: string;
+    /**
+     * The URL that the license for the translation can be found.
+     */
+    licenseUrl: string;
+    /**
+     * The ISO 639 letter language tag that the translation is primarily in.
+     */
+    language: string;
+    /**
+     * The direction that the text is written in.
+     */
+    direction: 'ltr' | 'rtl';
+}
+/**
+ * The metadata for a translation that is input into the generator.
+ */
+export interface InputTranslationMetadata extends MetadataBase {
+    /**
+     * The ID of the translation.
+     */
+    id: string;
+    /**
+     * The short name for the translation.
+     */
+    shortName: string;
+}
+/**
+ * The metadata for a translation that is input into the generator.
+ */
+export interface InputCommentaryMetadata extends MetadataBase {
+    /**
+     * The ID of the commentary.
+     */
+    id: string;
+}
+/**
+ * Defines an interface that contains information about a translation.
+ */
+export interface Translation {
+    /**
+     * The ID of the translation.
+     */
+    id: string;
+    /**
+     * The name of the translation.
+     */
+    name: string;
+    /**
+     * The website for the translation.
+     */
+    website: string;
+    /**
+     * The URL that the license for the translation can be found.
+     */
+    licenseUrl: string;
+    /**
+     * The API-added notes for the license.
+     */
+    licenseNotes?: string | null;
+    /**
+     * The short name for the translation.
+     */
+    shortName?: string;
+    /**
+     * The English name for the translation.
+     */
+    englishName: string;
+    /**
+     * The ISO 639 3-letter language tag that the translation is primarily in.
+     */
+    language: string;
+    /**
+     * The direction that the language is written in.
+     * "ltr" indicates that the text is written from the left side of the page to the right.
+     * "rtl" indicates that the text is written from the right side of the page to the left.
+     */
+    textDirection: 'ltr' | 'rtl';
+}
+/**
+ * Defines an interface that contains information about a commentary.
+ */
+export interface Commentary {
+    /**
+     * The ID of the commentary.
+     */
+    id: string;
+    /**
+     * The name of the commentary.
+     */
+    name: string;
+    /**
+     * The website for the commentary.
+     */
+    website: string;
+    /**
+     * The URL that the license for the commentary can be found.
+     */
+    licenseUrl: string;
+    /**
+     * The API-added notes for the license.
+     */
+    licenseNotes?: string | null;
+    /**
+     * The english name for the commentary.
+     */
+    englishName: string;
+    /**
+     * The ISO 639 3-letter language tag that the translation is primarily in.
+     */
+    language: string;
+    /**
+     * The direction that the language is written in.
+     * "ltr" indicates that the text is written from the left side of the page to the right.
+     * "rtl" indicates that the text is written from the right side of the page to the left.
+     */
+    textDirection: 'ltr' | 'rtl';
+}
+export interface Dataset {
+    /**
+     * The ID of the dataset.
+     */
+    id: string;
+    /**
+     * The name of the dataset.
+     */
+    name: string;
+    /**
+     * The website for the dataset.
+     */
+    website: string;
+    /**
+     * The URL that the license for the dataset can be found.
+     */
+    licenseUrl: string;
+    /**
+     * The API-added notes for the license.
+     */
+    licenseNotes?: string | null;
+    /**
+     * The English name for the dataset.
+     */
+    englishName: string;
+    /**
+     * The ISO 639 3-letter language tag that the dataset is primarily in.
+     */
+    language: string;
+    /**
+     * The direction that the language is written in.
+     */
+    textDirection: 'ltr' | 'rtl';
+}
+/**
+ * Defines an interface that contains information about a book.
+ */
+export interface TranslationBook {
+    /**
+     * The ID of the book. Should match the USFM book ID.
+     */
+    id: string;
+    /**
+     * The name that the translation provided for the book.
+     */
+    name: string;
+    /**
+     * The common name for the book.
+     */
+    commonName: string;
+    /**
+     * The title of the book.
+     * This is usually a more descriptive version of the book name.
+     * If not available, then one was not provided by the translation.
+     */
+    title: string | null;
+    /**
+     * The numerical order of the book in the translation.
+     */
+    order: number;
+    /**
+     * Whether the book is an apocryphal book.
+     */
+    isApocryphal?: boolean;
+}
+/**
+ * Defines an interface that contains information about a book in a commentary.
+ */
+export interface CommentaryBook {
+    /**
+     * The ID of the book. Should match the USFM book ID.
+     */
+    id: string;
+    /**
+     * The name that the commentary provided for the book.
+     */
+    name: string;
+    /**
+     * The common name for the book.
+     */
+    commonName: string;
+    /**
+     * The commentary's introduction for the book.
+     */
+    introduction?: string;
+    /**
+     * The summary of the commentary's introduction for the book.
+     */
+    introductionSummary?: string;
+    /**
+     * The order of the book in the Bible.
+     */
+    order: number;
+}
+/**
+ * Defines an interface that contains information about a dataset book.
+ */
+export interface DatasetBook {
+    /**
+     * The ID of the book. Should match the USFM book ID.
+     */
+    id: string;
+    /**
+     * The order of the book in the Bible.
+     */
+    order: number;
+}
+/**
+ * Defines an interface that contains information about a chapter in a dataset.
+ */
+export interface DatasetBookChapter {
+    /**
+     * The data for the chapter.
+     */
+    chapter: DatasetChapterData;
+}
+export interface DatasetChapterData {
+    /**
+     * The number of the chapter.
+     */
+    number: number;
+    /**
+     * The content of the chapter.
+     */
+    content: DatasetChapterVerseContent[];
+}
+/**
+ * Defines an interface that contains information about a verse in a dataset chapter.
+ */
+export interface DatasetChapterVerseContent {
+    /**
+     * The number of the verse.
+     */
+    verse: number;
+    /**
+     * The list of references for the verse.
+     */
+    references: ScoredVerseRef[];
+}
+/**
+ * Defines an interface that contains information about a verse reference that has an arbitrary score attached to it.
+ */
+export interface ScoredVerseRef extends VerseRef {
+    /**
+     * The score of the verse reference.
+     */
+    score: number;
+}
+/**
+ * Defines an interface that contains information about a profile in a commentary.
+ */
+export interface CommentaryProfile {
+    /**
+     * The ID of the profile.
+     */
+    id: string;
+    /**
+     * The subject of the profile.
+     */
+    subject: string;
+    /**
+     * The Bible reference that the profile is associated with.
+     */
+    reference: VerseRef | null;
+}
+/**
+ * Defines an interface that contains information about a book chapter.
+ */
+export interface TranslationBookChapter {
+    /**
+     * The information for the chapter.
+     */
+    chapter: ChapterData;
+    /**
+     * The links to different audio versions for the chapter.
+     */
+    thisChapterAudioLinks: TranslationBookChapterAudioLinks;
+}
+/**
+ * Defines an interface that contains information about a book chapter in a commentary.
+ */
+export interface CommentaryBookChapter {
+    /**
+     * The information for the chapter.
+     */
+    chapter: CommentaryChapterData;
+}
+/**
+ * Defines an interface that contains the audio links for a book chapter.
+ */
+export interface TranslationBookChapterAudioLinks {
+    /**
+     * The reader for the chapter and the URL link to the audio file.
+     */
+    [reader: string]: string;
+}
+/**
+ * Defines an interface that represents data in a chapter.
+ */
+export interface ChapterData {
+    /**
+     * The number of the chapter.
+     */
+    number: number;
+    /**
+     * The content of the chapter.
+     */
+    content: ChapterContent[];
+    /**
+     * The list of footnotes for the chapter.
+     */
+    footnotes: ChapterFootnote[];
+}
+/**
+ * Defines an interface that represents data in a chapter in a commentary.
+ */
+export interface CommentaryChapterData {
+    /**
+     * The number of the chapter.
+     */
+    number: number;
+    /**
+     * The introduction that the commentary provided to the chapter.
+     * Not all commentaries provide an introduction to a chapter.
+     */
+    introduction?: string;
+    /**
+     * The content of the chapter.
+     */
+    content: ChapterVerse[];
+}
+/**
+ * A union type that represents a single piece of chapter content.
+ * A piece of chapter content can be one of the following things:
+ * - A heading.
+ * - A line break.
+ * - A verse.
+ * - A Hebrew Subtitle.
+ */
+export type ChapterContent = ChapterHeading | ChapterLineBreak | ChapterVerse | ChapterHebrewSubtitle;
+/**
+ * A heading in a chapter.
+ */
+export interface ChapterHeading {
+    /**
+     * Indicates that the content represents a heading.
+     */
+    type: 'heading';
+    /**
+     * The content for the heading.
+     * If multiple strings are included in the array, they should be concatenated with a space.
+     */
+    content: string[];
+}
+/**
+ * A line break in a chapter.
+ */
+export interface ChapterLineBreak {
+    /**
+     * Indicates that the content represents a line break.
+     */
+    type: 'line_break';
+}
+/**
+ * A Hebrew Subtitle in a chapter.
+ * These are often used included as informational content that appeared in the original manuscripts.
+ * For example, Psalms 49 has the Hebrew Subtitle "To the choirmaster. A Psalm of the Sons of Korah."
+ */
+export interface ChapterHebrewSubtitle {
+    /**
+     * Indicates that the content represents a Hebrew Subtitle.
+     */
+    type: 'hebrew_subtitle';
+    /**
+     * The list of content that is contained in the subtitle.
+     * Each element in the list could be a string, formatted text, or a footnote reference.
+     */
+    content: (string | FormattedText | VerseFootnoteReference)[];
+}
+/**
+ * A verse in a chapter.
+ */
+export interface ChapterVerse {
+    /**
+     * Indicates that the content is a verse.
+     */
+    type: 'verse';
+    /**
+     * The number of the verse.
+     */
+    number: number;
+    /**
+     * The list of content for the verse.
+     * Each element in the list could be a string, formatted text, or a footnote reference.
+     */
+    content: (string | FormattedText | InlineHeading | InlineLineBreak | VerseFootnoteReference)[];
+}
+/**
+ * Formatted text. That is, text that is formated in a particular manner.
+ */
+export interface FormattedText {
+    /**
+     * The text that is formatted.
+     */
+    text: string;
+    /**
+     * Whether the text represents a poem.
+     * The number indicates the level of indent.
+     *
+     * Common in Psalms.
+     */
+    poem?: number;
+    /**
+     * Whether the text represents the Words of Jesus.
+     */
+    wordsOfJesus?: boolean;
+}
+/**
+ * Defines an interface that represents a heading that is embedded in a verse.
+ */
+export interface InlineHeading {
+    /**
+     * The text of the heading.
+     */
+    heading: string;
+}
+/**
+ * Defines an interface that represents a line break that is embedded in a verse.
+ */
+export interface InlineLineBreak {
+    lineBreak: true;
+}
+/**
+ * A footnote reference in a verse or a Hebrew Subtitle.
+ */
+export interface VerseFootnoteReference {
+    /**
+     * The ID of the note.
+     */
+    noteId: number;
+}
+/**
+ * Information about a footnote.
+ */
+export interface ChapterFootnote {
+    /**
+     * The ID of the note that is referenced.
+     */
+    noteId: number;
+    /**
+     * The text of the footnote.
+     */
+    text: string;
+    /**
+     * The verse reference for the footnote.
+     */
+    reference?: {
+        chapter: number;
+        verse: number;
+    };
+    /**
+     * The caller that should be used for the footnote.
+     * For footnotes, a "caller" is the character that is used in the text to reference to footnote.
+     *
+     * For example, in the text:
+     * Hello (a) World
+     *
+     * ----
+     * (a) This is a footnote.
+     *
+     * The "(a)" is the caller.
+     *
+     * If "+", then the caller should be autogenerated.
+     * If null, then the caller should be empty.
+     * If a string, then the caller should be that string.
+     */
+    caller: '+' | string | null;
+}
+//# sourceMappingURL=common-types.d.ts.map

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

@@ -0,0 +1,84 @@
+import { Commentary, CommentaryBook, CommentaryBookChapter, CommentaryProfile, InputFile, Translation, TranslationBook, TranslationBookChapter, Dataset as CommonDataset, DatasetBook, DatasetBookChapter } from './common-types.js';
+import { ParseMessage } from '../parser/types.js';
+/**
+ * Defines an interface that contains generated dataset info.
+ */
+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[];
+    /**
+     * The list of datasets that are available in the dataset.
+     */
+    datasets?: DatasetDataset[];
+    parseMessages?: {
+        [key: string]: ParseMessage[];
+    };
+}
+/**
+ * Defines a translation that is used in the dataset.
+ */
+export interface DatasetTranslation extends Translation {
+    /**
+     * The list of books that are available for the 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 commentary.
+     */
+    books: DatasetCommentaryBook[];
+    /**
+     * The list of profiles that  are available for the commentary.
+     */
+    profiles: DatasetCommentaryProfile[];
+}
+/**
+ * Defines a translation book that is used in the dataset.
+ */
+export interface DatasetTranslationBook extends TranslationBook {
+    /**
+     * The list of chapters that are available for the book.
+     */
+    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[];
+}
+export interface DatasetCommentaryProfile extends CommentaryProfile {
+    /**
+     * The contents of the profile.
+     */
+    content: string[];
+}
+export interface DatasetDataset extends CommonDataset {
+    books: DatasetDatasetBook[];
+}
+export interface DatasetDatasetBook extends DatasetBook {
+    chapters: DatasetBookChapter[];
+}
+/**
+ * Generates a list of output files from the given list of input files.
+ * @param file The list of files.
+ * @param parser The parser to use for parsing the files.
+ * @param bookMap The map of book IDs to names. If undefined, then a default map will be used.
+ */
+export declare function generateDataset(files: InputFile[], parser?: DOMParser, bookMap?: Map<string, {
+    commonName: string;
+}> | undefined): DatasetOutput;
+//# sourceMappingURL=dataset.d.ts.map

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,6 @@
+import * as utils from './utils.js';
+import * as generation from './generation/index.js';
+import * as parser from './parser/index.js';
+import * as log from './log.js';
+export { utils, generation, parser, log };
+//# sourceMappingURL=index.d.ts.map

package/dist/types/log.d.ts

@@ -0,0 +1,23 @@
+/**
+ * A simple logging interface that can be used to log messages.
+ */
+export interface Logger {
+    log: (message: any, ...args: any[]) => void;
+    warn: (message: string, ...args: any[]) => void;
+    error: (message: string, ...args: any[]) => void;
+}
+/**
+ * A logger that logs messages to the console.
+ */
+export declare const consoleLogger: Logger;
+/**
+ * Gets the logger that is currently being used for logging messages.
+ * @returns The logger that is currently being used.
+ */
+export declare function getLogger(): Logger;
+/**
+ * Sets the logger to use for logging messages.
+ * @param newLogger The new logger to use.
+ */
+export declare function setLogger(newLogger: Logger): void;
+//# sourceMappingURL=log.d.ts.map