@helloao/tools 0.0.9 → 0.0.11

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

@@ -1,4 +1,4 @@
-import { OutputFile, Translation, TranslationBook, TranslationBookChapter, TranslationBookChapterAudioLinks } from './common-types.js';
+import { Commentary, CommentaryBook, CommentaryBookChapter, CommentaryProfile, OutputFile, Translation, TranslationBook, TranslationBookChapter, TranslationBookChapterAudioLinks } from './common-types.js';
 import { DatasetOutput } from './dataset.js';
 /**
  * Defines the output of the API generation.
@@ -27,6 +27,33 @@ export interface ApiOutput {
      * - /api/:translationId/:bookId/:chapterNumber.:reader.mp3
      */
     translationBookChapterAudio: ApiTranslationBookChapterAudio[];
+    /**
+     * The list of available commentaries.
+     * This maps to the /api/available-commentaries.json endpoint.
+     */
+    availableCommentaries: ApiAvailableCommentaries;
+    /**
+     * The list of books for each commentary.
+     * This maps to the /api/c/:commentaryId/books.json endpoint.
+     */
+    commentaryBooks: ApiCommentaryBooks[];
+    /**
+     * The list of profiles for each commentary.
+     * This maps to the /api/c/:commentaryId/profiles.json endpoint.
+     */
+    commentaryProfiles: ApiCommentaryProfiles[];
+    /**
+     * The list of chapters for each commentary book.
+     * This maps to the following endpoint:
+     * - /api/c/:commentaryId/:bookId/:chapterNumber.json
+     */
+    commentaryBookChapters: ApiCommentaryBookChapter[];
+    /**
+     * The list of individual profiles for each commentary.
+     * This maps to the following endpoint:
+     * - /api/c/:commentaryId/profiles/:profileId.json
+     */
+    commentaryProfileContents: ApiCommentaryProfileContent[];
     /**
      * The path prefix that the API should use.
      */
@@ -42,6 +69,16 @@ export interface ApiAvailableTranslations {
      */
     translations: ApiTranslation[];
 }
+/**
+ * The list of available commentaries.
+ * Maps to the /api/available-commentaries.json endpoint.
+ */
+export interface ApiAvailableCommentaries {
+    /**
+     * The list of commentaries.
+     */
+    commentaries: ApiCommentary[];
+}
 /**
  * Defines a translation that is used in the API.
  */
@@ -83,6 +120,57 @@ export interface ApiTranslation extends Translation {
      */
     languageEnglishName?: string;
 }
+/**
+ * Defines a commentary that is used in the API.
+ */
+export interface ApiCommentary extends Commentary {
+    /**
+     * The API link for the list of available books for this translation.
+     */
+    listOfBooksApiLink: string;
+    /**
+     * The API link for the list of available profiles for this commentary.
+     */
+    listOfProfilesApiLink: string;
+    /**
+     * The available list of formats.
+     */
+    availableFormats: ('json' | 'usfm')[];
+    /**
+     * The number of books that are contained in this commentary.
+     *
+     * Complete commentaries should have the same number of books as the Bible (66).
+     */
+    numberOfBooks: number;
+    /**
+     * The total number of chapters that are contained in this translation.
+     *
+     * Complete commentaries should have the same number of chapters as the Bible (1,189).
+     */
+    totalNumberOfChapters: number;
+    /**
+     * The total number of verses that are contained in this commentary.
+     *
+     * Complete commentaries should have the same number of verses as the Bible (around 31,102 - some commentaries exclude verses based on the aparent likelyhood of existing in the original source texts).
+     */
+    totalNumberOfVerses: number;
+    /**
+     * The total number of profiles that are contained in this commentary.
+     *
+     * Profiles are used to provide additional information about people and people groups that are mentioned in the Bible.
+     */
+    totalNumberOfProfiles: number;
+    /**
+     * Gets the name of the language that the commentary is in.
+     * Null or undefined if the name of the language is not known.
+     */
+    languageName?: string;
+    /**
+     * Gets the name of the language in English.
+     * Null or undefined if the language doesn't have an english name.
+     */
+    languageEnglishName?: string;
+}
 /**
  * Defines an interface that contains information about the books that are available for a translation.
  */
@@ -96,6 +184,45 @@ export interface ApiTranslationBooks {
      */
     books: ApiTranslationBook[];
 }
+/**
+ * Defines an interface that contains information about the books that are available for a commentary.
+ */
+export interface ApiCommentaryBooks {
+    /**
+     * The commentary information for the books.
+     */
+    commentary: ApiCommentary;
+    /**
+     * The list of books that are available for the commentary.
+     */
+    books: ApiCommentaryBook[];
+}
+/**
+ * Defines an interface that contains information about the profiles that are available for a commentary.
+ */
+export interface ApiCommentaryProfiles {
+    /**
+     * The commentary information for the books.
+     */
+    commentary: ApiCommentary;
+    /**
+     * The list of profiles that are available for the commentary.
+     */
+    profiles: ApiCommentaryProfile[];
+}
+/**
+ * Defines an interface that contains information about a profile.
+ */
+export interface ApiCommentaryProfile extends CommentaryProfile {
+    /**
+     * The link to this profile.
+     */
+    thisProfileLink: string;
+    /**
+     * The link to the chapter that this profile references in the commentary.
+     */
+    referenceChapterLink: string | null;
+}
 /**
  * Defines a translation book that is used in the API.
  */
@@ -117,6 +244,27 @@ export interface ApiTranslationBook extends TranslationBook {
      */
     totalNumberOfVerses: number;
 }
+/**
+ * Defines a commentary book that is used in the API.
+ */
+export interface ApiCommentaryBook extends CommentaryBook {
+    /**
+     * The link to the first chapter of the book.
+     */
+    firstChapterApiLink: string;
+    /**
+     * The link to the last chapter of the book.
+     */
+    lastChapterApiLink: string;
+    /**
+     * The number of chapters that the book contains.
+     */
+    numberOfChapters: number;
+    /**
+     * The number of verses that the book contains.
+     */
+    totalNumberOfVerses: number;
+}
 /**
  * Defines an interface that contains information about a book chapter.
  */
@@ -158,6 +306,37 @@ export interface ApiTranslationBookChapter extends TranslationBookChapter {
      */
     numberOfVerses: number;
 }
+/**
+ * Defines an interface that contains information about a book chapter.
+ */
+export interface ApiCommentaryBookChapter extends CommentaryBookChapter {
+    /**
+     * The commentary information for the book chapter.
+     */
+    commentary: ApiCommentary;
+    /**
+     * The book information for the book chapter.
+     */
+    book: ApiCommentaryBook;
+    /**
+     * The link to this chapter.
+     */
+    thisChapterLink: string;
+    /**
+     * The link to the next chapter.
+     * Null if this is the last chapter in the translation.
+     */
+    nextChapterApiLink: string | null;
+    /**
+     * The link to the previous chapter.
+     * Null if this is the first chapter in the translation.
+     */
+    previousChapterApiLink: string | null;
+    /**
+     * The number of verses that the chapter contains.
+     */
+    numberOfVerses: number;
+}
 export interface ApiTranslationBookChapterAudio {
     /**
      * The chapter that the audio is for.
@@ -172,6 +351,20 @@ export interface ApiTranslationBookChapterAudio {
      */
     originalUrl: string;
 }
+export interface ApiCommentaryProfileContent {
+    /**
+     * The commentary information for the profile.
+     */
+    commentary: ApiCommentary;
+    /**
+     * The information about the profile.
+     */
+    profile: ApiCommentaryProfile;
+    /**
+     * The content of the profile.
+     */
+    content: string[];
+}
 /**
  * The options for generating the API.
  */
@@ -229,6 +422,12 @@ export declare function generateOutputFilesFromDatasets(datasets: AsyncIterable<
  * @returns
  */
 export declare function listOfBooksApiLink(translationId: string, prefix?: string): string;
+/**
+ * Gets the API Link for the list of books endpoint for a commentary.
+ * @param commentaryId The ID of the commentary.
+ * @returns
+ */
+export declare function listOfCommentaryBooksApiLink(commentaryId: string, prefix?: string): string;
 /**
  * Getes the API link for a book chapter.
  * @param translationId The ID of the translation.
@@ -237,7 +436,29 @@ export declare function listOfBooksApiLink(translationId: string, prefix?: strin
  * @param extension The extension of the file.
  */
 export declare function bookChapterApiLink(translationId: string, commonName: string, chapterNumber: number, extension: string, prefix?: string): string;
+/**
+ * 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.
+ */
+export declare function bookCommentaryChapterApiLink(translationId: string, commonName: string, chapterNumber: number, extension: string, prefix?: string): string;
 export declare function bookChapterAudioApiLink(translationId: string, bookId: string, chapterNumber: number, reader: string, prefix?: string): string;
+/**
+ * Gets the API link for a profile.
+ * @param translationId The ID of the translation.
+ * @param profileId The ID of the profile.
+ * @param extension The extension of the file.
+ */
+export declare function profilesCommentaryApiLink(translationId: string, extension: string, prefix?: string): string;
+/**
+ * Gets the API link for a profile.
+ * @param translationId The ID of the translation.
+ * @param profileId The ID of the profile.
+ * @param extension The extension of the file.
+ */
+export declare function profileCommentaryApiLink(translationId: string, profileId: string, extension: string, prefix?: string): string;
 export declare function jsonFile(path: string, content: any, mergable?: boolean): OutputFile;
 export declare function downloadedFile(path: string, url: string): OutputFile;
 export declare function replaceSpacesWithUnderscores(str: string): string;

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

@@ -1,12 +1,21 @@
+import { VerseRef } from '../utils.js';
 /**
  * Defines an interface that contains information about a input file.
  */
-export interface InputFile {
+export type InputFile = InputTranslationFile | InputCommentaryFile;
+export interface InputFileBase {
     name?: string;
-    metadata: ParseTreeMetadata;
     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;
 /**
@@ -26,23 +35,7 @@ export interface OutputFile {
      */
     mergable?: boolean;
 }
-/**
- * Defines an interface that contains metadata for a parse tree.
- */
-export interface ParseTreeMetadata {
-    /**
-     * Information about the translation.
-     */
-    translation: InputTranslationMetadata;
-}
-/**
- * The metadata for a translation that is input into the generator.
- */
-export interface InputTranslationMetadata {
-    /**
-     * The ID of the translation.
-     */
-    id: string;
+export interface MetadataBase {
     /**
      * The name of the translation.
      */
@@ -59,10 +52,6 @@ export interface InputTranslationMetadata {
      * The URL that the license for the translation can be found.
      */
     licenseUrl: string;
-    /**
-     * The short name for the translation.
-     */
-    shortName?: string;
     /**
      * The ISO 639 letter language tag that the translation is primarily in.
      */
@@ -72,6 +61,28 @@ export interface InputTranslationMetadata {
      */
     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.
  */
@@ -92,6 +103,10 @@ export interface Translation {
      * 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.
      */
@@ -111,12 +126,51 @@ export interface Translation {
      */
     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';
+}
 /**
  * Defines an interface that contains information about a book.
  */
 export interface TranslationBook {
     /**
-     * The ID of the book.
+     * The ID of the book. Should match the USFM book ID.
      */
     id: string;
     /**
@@ -138,6 +192,52 @@ export interface TranslationBook {
      */
     order: number;
 }
+/**
+ * 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 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.
  */
@@ -151,6 +251,15 @@ export interface TranslationBookChapter {
      */
     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.
  */
@@ -177,6 +286,24 @@ export interface ChapterData {
      */
     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:

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

@@ -1,4 +1,4 @@
-import { InputFile, Translation, TranslationBook, TranslationBookChapter } from './common-types.js';
+import { Commentary, CommentaryBook, CommentaryBookChapter, CommentaryProfile, 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,19 @@ 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 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.
  */
@@ -26,9 +43,28 @@ 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[];
+}
+export interface DatasetCommentaryProfile extends CommentaryProfile {
+    /**
+     * The contents of the profile.
+     */
+    content: string[];
+}
 /**
  * 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): DatasetOutput;
+export declare function generateDataset(files: InputFile[], parser?: DOMParser, bookMap?: Map<string, {
+    commonName: string;
+}> | undefined): DatasetOutput;
 //# sourceMappingURL=dataset.d.ts.map

package/dist/types/index.d.ts

@@ -1,5 +1,6 @@
 import * as utils from './utils.js';
 import * as generation from './generation/index.js';
 import * as parser from './parser/index.js';
-export { utils, generation, parser };
+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