@helloao/cli 0.0.8 → 0.0.10

package/{actions.d.ts → dist/types/actions.d.ts}

@@ -1,10 +1,41 @@
-import { InputTranslationMetadata } from '@helloao/tools/generation';
-import { UploadApiFromDatabaseOptions, UploadApiOptions } from './uploads';
+import { InputTranslationMetadata } from '@helloao/tools/generation/index.js';
+import { UploadApiFromDatabaseOptions, UploadApiOptions } from './uploads.js';
+export interface GetTranslationsItem {
+    id: string;
+    language: string;
+    direction: 'ltr' | 'rtl';
+    year: number;
+    name_local: string;
+    name_english: string;
+    name_abbrev: string;
+    attribution: string;
+    attribution_url: string;
+    licenses: RuntimeLicense[];
+}
+export interface RuntimeLicense {
+    id: string | null;
+    name: string;
+    restrictions: MetaRestrictions;
+    url: string;
+}
+export interface MetaRestrictions {
+    limit_verses: number | null;
+    limit_book_ratio: number | null;
+    limit_content_ratio: number | null;
+    forbid_commercial: boolean;
+    forbid_derivatives: boolean | 'same-license';
+    forbid_attributionless: boolean;
+    forbid_other: boolean;
+}
 export interface InitDbOptions {
     /**
      * The path to the source database to copy the schema from.
      */
     source?: string;
+    /**
+     * Whether to overwrite the existing database.
+     */
+    overwrite?: boolean;
     /**
      * The languages to copy from the source database. If not specified, then all languages will be copied.
      */
@@ -35,6 +66,19 @@ export declare function importTranslation(dir: string, dirs: string[], options:
  * @param options The options.
  */
 export declare function importTranslations(dir: string, options: ImportTranslationOptions): Promise<void>;
+/**
+ * Imports a commentary from the given directory into the database in the current working directory.
+ * @param dir The directory that the commentary is located in.
+ * @param dirs Any extra directories that should be imported.
+ * @param options The options for the import.
+ */
+export declare function importCommentary(dir: string, dirs: string[], options: ImportTranslationOptions): Promise<void>;
+/**
+ * Imports all the commentaries from the given directory into the database in the current working directory.
+ * @param dir The directory that the commentaries are located in.
+ * @param options The options.
+ */
+export declare function importCommentaries(dir: string, options: ImportTranslationOptions): Promise<void>;
 export interface FetchTranslationsOptions {
     /**
      * Fetch all translations. If omitted, only undownloaded translations will be fetched.

package/{db.d.ts → dist/types/db.d.ts}

@@ -1,10 +1,11 @@
-import { PrismaClient } from './prisma-gen';
+import { PrismaClient } from './prisma-gen/index.js';
 import { Database } from 'better-sqlite3';
-import { DatasetOutput, DatasetTranslation, DatasetTranslationBook } from '@helloao/tools/generation/dataset';
-import { InputFile, TranslationBookChapter } from '@helloao/tools/generation';
-import { GenerateApiOptions } from '@helloao/tools/generation/api';
-import { DOMParser } from 'linkedom';
+import { DatasetCommentary, DatasetCommentaryBook, DatasetOutput, DatasetTranslation, DatasetTranslationBook } from '@helloao/tools/generation/dataset.js';
+import { InputFile, TranslationBookChapter, CommentaryBookChapter } from '@helloao/tools/generation/index.js';
+import { GenerateApiOptions } from '@helloao/tools/generation/api.js';
+import type { DOMParser } from 'linkedom';
 import { Readable } from 'stream';
+export declare function getMigrationsPath(): Promise<string | null>;
 /**
  * Imports the translations from the given directories into the database.
  * @param db The database to import the translations into.
@@ -12,7 +13,24 @@ import { Readable } from 'stream';
  * @param parser The DOM parser that should be used for USX files.
  * @param overwrite Whether to force a reload of the translations.
  */
-export declare function importTranslations(db: Database, dirs: string[], parser: DOMParser, overwrite: boolean): Promise<void>;
+export declare const importTranslations: (db: Database, dirs: string[], parser: DOMParser, overwrite: boolean) => Promise<void>;
+/**
+ * Imports the commentaries from the given directories into the database.
+ * @param db The database to import the commentaries into.
+ * @param dirs The directories to import the commentaries from.
+ * @param parser The DOM parser that should be used for USX files.
+ * @param overwrite Whether to force a reload of the commentaries.
+ */
+export declare const importCommentaries: (db: Database, dirs: string[], parser: DOMParser, overwrite: boolean) => Promise<void>;
+/**
+ * Imports the files from the given directories into the database.
+ * @param loadFilesFromDir The function that should be used to load the files from the given directory.
+ * @param db The database to import the files into.
+ * @param dirs The directories to import the files from.
+ * @param parser The DOM parser that should be used for USX files.
+ * @param overwrite Whether to force a reload of the files.
+ */
+export declare function importFiles(loadFilesFromDir: (path: string) => Promise<InputFile[] | null>, db: Database, dirs: string[], parser: DOMParser, overwrite: boolean): Promise<void>;
 /**
  * Imports a batch of translations from the given directories into the database.
  * @param db The database to import the translations into.
@@ -20,7 +38,16 @@ export declare function importTranslations(db: Database, dirs: string[], parser:
  * @param parser The DOM parser that should be used for USX files.
  * @param overwrite Whether to force a reload of the translations.
  */
-export declare function importTranslationBatch(db: Database, dirs: string[], parser: DOMParser, overwrite: boolean): Promise<void>;
+export declare const importTranslationBatch: (db: Database, dirs: string[], parser: DOMParser, overwrite: boolean) => Promise<void>;
+/**
+ * Imports a batch of files from the given directories into the database.
+ * @param loadFilesFromDir The function that should be used to load the files from the given directory.
+ * @param db The database to import the files into.
+ * @param dirs The directories that contain the files.
+ * @param parser The DOM parser that should be used for USX files.
+ * @param overwrite Whether to force a reload of the files.
+ */
+export declare function loadAndImportBatch(loadFilesFromDir: (path: string) => Promise<InputFile[] | null>, db: Database, dirs: string[], parser: DOMParser, overwrite: boolean): Promise<void>;
 /**
  * Parses and imports the given files into the database.
  * @param db The database to import the files into.
@@ -28,7 +55,7 @@ export declare function importTranslationBatch(db: Database, dirs: string[], par
  * @param parser The DOM parser that should be used for USX files.
  * @param overwrite Whether to force a reload of the translations.
  */
-export declare function importTranslationFileBatch(db: Database, files: InputFile[], parser: DOMParser, overwrite: boolean): Promise<void>;
+export declare function importFileBatch(db: Database, files: InputFile[], parser: DOMParser, overwrite: boolean): Promise<void>;
 /**
  * Filters the given input files to only include those that have changed.
  * @param db The database to check for changes.
@@ -39,6 +66,9 @@ export declare function insertFileMetadata(db: Database, files: InputFile[]): vo
 export declare function insertTranslations(db: Database, translations: DatasetTranslation[]): void;
 export declare function insertTranslationBooks(db: Database, translation: DatasetTranslation, translationBooks: DatasetTranslationBook[]): void;
 export declare function insertTranslationContent(db: Database, translation: DatasetTranslation, book: DatasetTranslationBook, chapters: TranslationBookChapter[]): void;
+export declare function insertCommentaries(db: Database, commentaries: DatasetCommentary[]): void;
+export declare function insertCommentaryBooks(db: Database, commentary: DatasetCommentary, commentaryBooks: DatasetCommentaryBook[]): void;
+export declare function insertCommentaryContent(db: Database, commentary: DatasetCommentary, book: DatasetCommentaryBook, chapters: CommentaryBookChapter[]): void;
 export declare function getDbPathFromDir(dir: string): string;
 export declare function getDbPath(p: string | null): string;
 export declare function getPrismaDbFromDir(dir: string): PrismaClient<{
@@ -47,7 +77,7 @@ export declare function getPrismaDbFromDir(dir: string): PrismaClient<{
             url: string;
         };
     };
-}, never, import("prisma-gen/runtime/library").DefaultArgs>;
+}, never, import("prisma-gen/runtime/library.js").DefaultArgs>;
 export declare function getDbFromDir(dir: string): Promise<Database>;
 export declare function getDb(dbPath: string): Promise<Database>;
 export interface SerializedFile {
@@ -61,10 +91,24 @@ export interface SerializedFile {
 /**
  * Loads the datasets from the database in a series of batches.
  * @param db The database.
+ * @param perBatch The number of translations to load per batch.
+ * @param translationsToLoad The list of translations/commentaries to load. If not provided, all translations will be loaded.
+ */
+export declare function loadDatasets(db: PrismaClient, perBatch?: number, translationsToLoad?: string[]): AsyncGenerator<DatasetOutput>;
+/**
+ * Loads the translations from the database as a dataset.
+ * @param db The database.
  * @param translationsPerBatch The number of translations to load per batch.
  * @param translationsToLoad The list of translations to load. If not provided, all translations will be loaded.
  */
-export declare function loadDatasets(db: PrismaClient, translationsPerBatch?: number, translationsToLoad?: string[]): AsyncGenerator<DatasetOutput>;
+export declare function loadTranslationDatasets(db: PrismaClient, translationsPerBatch?: number, translationsToLoad?: string[]): AsyncGenerator<DatasetOutput, void, unknown>;
+/**
+ * Loads the commentaries from the database as a dataset.
+ * @param db The database.
+ * @param perBatch The number of translations to load per batch.
+ * @param commentariesToLoad The list of commentaries to load. If not provided, all commentaries will be loaded.
+ */
+export declare function loadCommentaryDatasets(db: PrismaClient, perBatch?: number, commentariesToLoad?: string[]): AsyncGenerator<DatasetOutput, void, unknown>;
 export interface SerializeApiOptions extends GenerateApiOptions {
     /**
      * Whether the output should be pretty-printed.

package/dist/types/downloads.d.ts

@@ -0,0 +1,2 @@
+export declare function downloadFile(url: string, path: string, onProgress?: (progress: number) => void): Promise<void>;
+//# sourceMappingURL=downloads.d.ts.map

package/{files.d.ts → dist/types/files.d.ts}

@@ -1,4 +1,4 @@
-import { InputFile, OutputFile } from '@helloao/tools/generation/common-types';
+import { InputFile, OutputFile } from '@helloao/tools/generation/common-types.js';
 import { Readable } from 'stream';
 /**
  * Defines an interface that contains information about a serialized file.
@@ -68,6 +68,17 @@ export declare function loadTranslationsFiles(dirs: string[]): Promise<InputFile
  * @returns The list of files that were loaded, or null if the translation has no metadata.
  */
 export declare function loadTranslationFiles(translation: string): Promise<InputFile[] | null>;
+/**
+ * Loads the files for the given commentaries.
+ * @param dir The directory that the commentaries exist in.
+ */
+export declare function loadCommentariesFiles(dirs: string[]): Promise<InputFile[]>;
+/**
+ * Loads the files for the given commentary.
+ * @param commentary The directory that the commentary exists in.
+ * @returns The list of files that were loaded, or null if the commentary has no metadata.
+ */
+export declare function loadCommentaryFiles(commentary: string): Promise<InputFile[] | null>;
 export interface CollectionTranslationMetadata {
     name: {
         local: string;

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+import * as db from './db.js';
+import * as downloads from './downloads.js';
+import * as uploads from './uploads.js';
+import * as actions from './actions.js';
+import * as files from './files.js';
+import * as s3 from './s3.js';
+export { db, downloads, uploads, actions, files, s3 };
+//# sourceMappingURL=index.d.ts.map

package/{s3.d.ts → dist/types/s3.d.ts}

@@ -1,4 +1,4 @@
-import { SerializedFile, Uploader } from './files';
+import { SerializedFile, Uploader } from './files.js';
 import { AwsCredentialIdentity, Provider } from '@smithy/types';
 export declare class S3Uploader implements Uploader {
     private _client;

package/{uploads.d.ts → dist/types/uploads.d.ts}

@@ -1,8 +1,8 @@
-import { SerializedFile } from './db';
-import { Uploader } from './files';
-import { DatasetOutput } from '@helloao/tools/generation/dataset';
-import { PrismaClient } from './prisma-gen';
-import { GenerateApiOptions } from '@helloao/tools/generation/api';
+import { SerializedFile } from './db.js';
+import { Uploader } from './files.js';
+import { DatasetOutput } from '@helloao/tools/generation/dataset.js';
+import { PrismaClient } from './prisma-gen/index.js';
+import { GenerateApiOptions } from '@helloao/tools/generation/api.js';
 export interface UploadApiFromDatabaseOptions extends UploadApiOptions, GenerateApiOptions {
     /**
      * The number of files to upload in each batch.
@@ -19,6 +19,11 @@ export interface UploadApiOptions {
      * "Common files" are files that are similar between translations, like the books.json endpoint, or individual chapter endpoints.
      */
     overwriteCommonFiles?: boolean;
+    /**
+     * Whether to only overwrite merged files.
+     * "Merged files" are files that are generated from multiple translations, like the available_translations.json endpoint.
+     */
+    overwriteMergedFiles?: boolean;
     /**
      * The file pattern regex that should be used to filter the files that are uploaded.
      */
@@ -51,6 +56,10 @@ export interface UploadApiOptions {
      * Whether to generate pretty-printed JSON files.
      */
     pretty?: boolean;
+    /**
+     * Whether to output verbose log information.
+     */
+    verbose?: boolean;
 }
 /**
  * Loads and generates the API files from the database and uploads them to the specified destination.

package/migrations/20241113173937_add_commentaries/migration.sql

@@ -0,0 +1,56 @@
+-- CreateTable
+CREATE TABLE "Commentary" (
+    "id" TEXT NOT NULL PRIMARY KEY,
+    "name" TEXT NOT NULL,
+    "website" TEXT NOT NULL,
+    "licenseUrl" TEXT NOT NULL,
+    "englishName" TEXT NOT NULL,
+    "language" TEXT NOT NULL,
+    "textDirection" TEXT NOT NULL,
+    "sha256" TEXT
+);
+
+-- CreateTable
+CREATE TABLE "CommentaryBook" (
+    "id" TEXT NOT NULL,
+    "commentaryId" TEXT NOT NULL,
+    "name" TEXT NOT NULL,
+    "commonName" TEXT NOT NULL,
+    "introduction" TEXT,
+    "order" INTEGER NOT NULL,
+    "numberOfChapters" INTEGER NOT NULL,
+    "sha256" TEXT,
+
+    PRIMARY KEY ("commentaryId", "id"),
+    CONSTRAINT "CommentaryBook_commentaryId_fkey" FOREIGN KEY ("commentaryId") REFERENCES "Commentary" ("id") ON DELETE RESTRICT ON UPDATE CASCADE
+);
+
+-- CreateTable
+CREATE TABLE "CommentaryChapter" (
+    "number" INTEGER NOT NULL,
+    "bookId" TEXT NOT NULL,
+    "commentaryId" TEXT NOT NULL,
+    "introduction" TEXT,
+    "json" TEXT NOT NULL,
+    "sha256" TEXT,
+
+    PRIMARY KEY ("commentaryId", "bookId", "number"),
+    CONSTRAINT "CommentaryChapter_commentaryId_bookId_fkey" FOREIGN KEY ("commentaryId", "bookId") REFERENCES "CommentaryBook" ("commentaryId", "id") ON DELETE RESTRICT ON UPDATE CASCADE,
+    CONSTRAINT "CommentaryChapter_commentaryId_fkey" FOREIGN KEY ("commentaryId") REFERENCES "Commentary" ("id") ON DELETE RESTRICT ON UPDATE CASCADE
+);
+
+-- CreateTable
+CREATE TABLE "CommentaryChapterVerse" (
+    "number" INTEGER NOT NULL,
+    "chapterNumber" INTEGER NOT NULL,
+    "bookId" TEXT NOT NULL,
+    "commentaryId" TEXT NOT NULL,
+    "text" TEXT NOT NULL,
+    "contentJson" TEXT NOT NULL,
+    "sha256" TEXT,
+
+    PRIMARY KEY ("commentaryId", "bookId", "chapterNumber", "number"),
+    CONSTRAINT "CommentaryChapterVerse_commentaryId_bookId_chapterNumber_fkey" FOREIGN KEY ("commentaryId", "bookId", "chapterNumber") REFERENCES "CommentaryChapter" ("commentaryId", "bookId", "number") ON DELETE RESTRICT ON UPDATE CASCADE,
+    CONSTRAINT "CommentaryChapterVerse_commentaryId_bookId_fkey" FOREIGN KEY ("commentaryId", "bookId") REFERENCES "CommentaryBook" ("commentaryId", "id") ON DELETE RESTRICT ON UPDATE CASCADE,
+    CONSTRAINT "CommentaryChapterVerse_commentaryId_fkey" FOREIGN KEY ("commentaryId") REFERENCES "Commentary" ("id") ON DELETE RESTRICT ON UPDATE CASCADE
+);

package/package.json

@@ -1,16 +1,21 @@
 {
   "name": "@helloao/cli",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "description": "A CLI and related tools for managing HelloAO's Free Bible API",
-  "module": "index.js",
-  "types": "index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "require": "./dist/cjs/index.cjs"
+    }
+  },
   "bin": {
-    "helloao": "./cli.js"
+    "helloao": "./dist/cjs/cli.cjs"
   },
   "author": "Kallyn Gowdy <kal@helloao.org>",
   "license": "MIT",
   "dependencies": {
-    "@helloao/tools": "^0.0.5",
+    "@helloao/tools": "^0.0.10",
     "commander": "12.1.0",
     "@gracious.tech/fetch-client": "^0.7.0",
     "prisma": "^5.12.1",
@@ -25,6 +30,8 @@
     "@aws-sdk/client-s3": "^3.609.0",
     "@aws-sdk/credential-providers": "^3.609.0",
     "@smithy/types": "^3.3.0",
+    "@smithy/node-config-provider": "^3.1.9",
+    "@smithy/config-resolver": "^3.0.10",
     "@inquirer/prompts": "5.3.8",
     "all-iso-language-codes": "1.0.17"
   },