@helloao/tools 0.0.14 → 0.0.15

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

@@ -1,4 +1,4 @@
-import { Commentary, CommentaryBook, CommentaryBookChapter, CommentaryProfile, OutputFile, Translation, TranslationBook, TranslationBookChapter, TranslationBookChapterAudioLinks } from './common-types.js';
+import { Commentary, CommentaryBook, CommentaryBookChapter, CommentaryProfile, Dataset, DatasetBook, DatasetBookChapter, OutputFile, Translation, TranslationBook, TranslationBookChapter, TranslationBookChapterAudioLinks } from './common-types.js';
 import { DatasetOutput } from './dataset.js';
 /**
  * Defines the output of the API generation.
@@ -54,6 +54,22 @@ export interface ApiOutput {
      * - /api/c/:commentaryId/profiles/:profileId.json
      */
     commentaryProfileContents: ApiCommentaryProfileContent[];
+    /**
+     * The list of available datasets.
+     * This maps to the /api/available-datasets.json endpoint.
+     */
+    availableDatasets?: ApiAvailableDatasets;
+    /**
+     * The list of books for each dataset.
+     * This maps to the /api/d/:datasetId/books.json endpoint.
+     */
+    datasetBooks?: ApiDatasetBooks[];
+    /**
+     * The list of chapters for each dataset book.
+     * This maps to the following endpoint:
+     * - /api/d/:datasetId/:bookId/:chapterNumber.json
+     */
+    datasetBookChapters?: ApiDatasetBookChapter[];
     /**
      * The path prefix that the API should use.
      */
@@ -79,6 +95,52 @@ export interface ApiAvailableCommentaries {
      */
     commentaries: ApiCommentary[];
 }
+/**
+ * The list of available datasets.
+ * Maps to the /api/available-datasets.json endpoint.
+ */
+export interface ApiAvailableDatasets {
+    datasets: ApiDataset[];
+}
+/**
+ * Defines a dataset that is used in the API.
+ */
+export interface ApiDataset extends Dataset {
+    /**
+     * The API link for the list of books for this dataset.
+     */
+    listOfBooksApiLink: string;
+    /**
+     * The available list of formats.
+     */
+    availableFormats: 'json'[];
+    /**
+     * The number of books that are contained in this dataset.
+     */
+    numberOfBooks: number;
+    /**
+     * The total number of chapters that are contained in this dataset.
+     */
+    totalNumberOfChapters: number;
+    /**
+     * The total number of verses that are contained in this dataset.
+     */
+    totalNumberOfVerses: number;
+    /**
+     * The total number of references that are contained in this dataset.
+     */
+    totalNumberOfReferences: 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 a translation that is used in the API.
  */
@@ -209,6 +271,19 @@ export interface ApiCommentaryBooks {
      */
     books: ApiCommentaryBook[];
 }
+/**
+ * Defines an interface that contains information about the books that are available for a dataset.
+ */
+export interface ApiDatasetBooks {
+    /**
+     * The dataset information for the books.
+     */
+    dataset: ApiDataset;
+    /**
+     * The list of books that are available for the dataset.
+     */
+    books: ApiDatasetBook[];
+}
 /**
  * Defines an interface that contains information about the profiles that are available for a commentary.
  */
@@ -301,6 +376,39 @@ export interface ApiCommentaryBook extends CommentaryBook {
      */
     totalNumberOfVerses: number;
 }
+/**
+ * Defines an interface that contains information about a book in a dataset.
+ */
+export interface ApiDatasetBook extends DatasetBook {
+    /**
+     * The number of the first chapter in the book.
+     */
+    firstChapterNumber: number;
+    /**
+     * The link to the first chapter of the book.
+     */
+    firstChapterApiLink: string;
+    /**
+     * The number of the last chapter in the book.
+     */
+    lastChapterNumber: number;
+    /**
+     * 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;
+    /**
+     * The number of references that the book contains.
+     */
+    totalNumberOfReferences: number;
+}
 /**
  * Defines an interface that contains information about a book chapter.
  */
@@ -373,6 +481,41 @@ export interface ApiCommentaryBookChapter extends CommentaryBookChapter {
      */
     numberOfVerses: number;
 }
+/**
+ * Defines an interface that contains information about a book chapter.
+ */
+export interface ApiDatasetBookChapter extends DatasetBookChapter {
+    /**
+     * The dataset information for the book chapter.
+     */
+    dataset: ApiDataset;
+    /**
+     * The book information for the book chapter.
+     */
+    book: ApiDatasetBook;
+    /**
+     * 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;
+    /**
+     * The number of references that the chapter contains.
+     */
+    numberOfReferences: number;
+}
 export interface ApiTranslationBookChapterAudio {
     /**
      * The chapter that the audio is for.
@@ -464,6 +607,12 @@ export declare function listOfBooksApiLink(translationId: string, prefix?: strin
  * @returns
  */
 export declare function listOfCommentaryBooksApiLink(commentaryId: string, prefix?: string): string;
+/**
+ * Gets the API Link for the list of books endpoint for a dataset.
+ * @param datasetId The ID of the dataset.
+ * @returns
+ */
+export declare function listOfDatasetBooksApiLink(datasetId: string, prefix?: string): string;
 /**
  * Getes the API link for a book chapter.
  * @param translationId The ID of the translation.
@@ -481,6 +630,14 @@ export declare function bookChapterApiLink(translationId: string, commonName: st
  */
 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;
+/**
+ * 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 bookDatasetChapterApiLink(translationId: string, commonName: string, chapterNumber: number, extension: string, prefix?: string): string;
 /**
  * Gets the API link for a profile.
  * @param translationId The ID of the translation.

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

@@ -165,6 +165,40 @@ export interface Commentary {
      */
     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.
  */
@@ -225,6 +259,60 @@ export interface CommentaryBook {
      */
     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.
  */

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

@@ -1,4 +1,4 @@
-import { Commentary, CommentaryBook, CommentaryBookChapter, CommentaryProfile, InputFile, Translation, TranslationBook, TranslationBookChapter } from './common-types.js';
+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.
@@ -12,6 +12,10 @@ export interface DatasetOutput {
      * 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[];
     };
@@ -62,6 +66,12 @@ export interface DatasetCommentaryProfile extends CommentaryProfile {
      */
     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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helloao/tools",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "description": "A set of tools for managing HelloAO's Free Bible API",
   "main": "./dist/cjs/index.cjs",
   "module": "./dist/esm/index.js",