@helloao/cli 0.0.12 → 0.0.14

package/dist/types/actions.d.ts

@@ -41,6 +41,41 @@ export interface InitDbOptions {
      */
     language?: string[];
 }
+export interface ConvertToUsx3Options {
+    /**
+     * Whether to overwrite existing files in output directory.
+     */
+    overwrite?: boolean;
+}
+export interface SourceTranslationsOptions {
+    /**
+     * Whether to convert USFM files to USX3 format after download.
+     */
+    convertToUsx3?: boolean;
+    /**
+     * Options for USX3 conversion.
+     */
+    conversionOptions?: ConvertToUsx3Options;
+    /**
+     * Whether to track downloads in database.
+     */
+    useDatabase?: boolean;
+    /**
+     * Path to BibleMultiConverter.jar file. If not provided, will search common locations.
+     */
+    bibleMultiConverterPath?: string;
+    /**
+     * Whether to overwrite existing files in output directory.
+     *
+     * If database tracking is enabled, this will prevent overwriting files that were not tracked in the database.
+     */
+    overwrite?: boolean;
+    /**
+     * The database to use for tracking downloads.
+     */
+    db?: string | null;
+}
+export declare function getMetaPath(): Promise<string | null>;
 /**
  * Initializes a new Bible API DB.
  * @param dbPath The path to the database. If null or empty, then the "bible-api.db" will be used from the current working directory.
@@ -52,6 +87,10 @@ export interface ImportTranslationOptions {
      * Whether to forcibly import the translations, even if they have already been imported.
      */
     overwrite?: boolean;
+    /**
+     * The database to import the translations into.
+     */
+    db?: string | null;
 }
 /**
  * Imports a translation from the given directory into the database in the current working directory.
@@ -85,13 +124,6 @@ export interface FetchTranslationsOptions {
      */
     all?: boolean;
 }
-/**
- * Fetches the specified translations from fetch.bible and places them in the given directory.
- * @param dir The directory that the translations should be placed in.
- * @param translations The translations that should be downloaded. If not specified, then all translations will be downloaded.
- * @param options The options.
- */
-export declare function fetchTranslations(dir: string, translations?: string[], options?: FetchTranslationsOptions): Promise<void>;
 /**
  * Fetches the specified audio translations and places them in the given directory.
  * Translations should be in the format "translationId/audioId". e.g. "BSB/gilbert"
@@ -107,6 +139,28 @@ export declare function fetchAudio(dir: string, translations: string[], options?
  * @param options The options for the generation.
  */
 export declare function generateTranslationsFiles(input: string, dest: string, options: UploadApiFromDatabaseOptions): Promise<void>;
+/**
+ * Instructions for manual USFM to USX3 conversion using BibleMultiConverter
+ */
+export declare const CONVERSION_INSTRUCTIONS: {
+    downloadUrl: string;
+    javaRequirement: string;
+    getConversionCommand: (inputDir: string, outputDir: string, filenamePattern?: string) => string;
+    examples: {
+        windows: string;
+        unix: string;
+    };
+};
+/**
+ * Prints conversion instructions for the user
+ */
+export declare function printConversionInstructions(): void;
+/**
+ * Downloads and processes USFM files from eBible.org.
+ * Can optionally convert to USX3 format and/or track in database.
+ */
+export declare function sourceTranslations(outputDir: string, translations?: string[], options?: SourceTranslationsOptions): Promise<void>;
+export declare function listEBibleTranslations(searchTerm?: string): Promise<void>;
 /**
  * Generates the translation files directly from the translation stored in the given input directory.
  * @param input The input directory that the translation is stored in.

package/dist/types/conversion.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Finds BibleMultiConverter.jar automatically in common locations
+ */
+export declare function findBibleMultiConverterJar(providedPath?: string): Promise<string | null>;
+/**
+ * Prompts user for BibleMultiConverter.jar location
+ */
+export declare function promptForBibleMultiConverter(): Promise<string | null>;
+/**
+ * Converts USFM directory to USX3 using BibleMultiConverter
+ */
+export declare function convertUsfmToUsx3(inputDir: string, outputDir: string, jarPath: string): Promise<boolean>;
+//# sourceMappingURL=conversion.d.ts.map

package/dist/types/db.d.ts

@@ -71,16 +71,20 @@ export declare function insertCommentaryBooks(db: Database, commentary: DatasetC
 export declare function insertCommentaryProfiles(db: Database, commentary: DatasetCommentary, commentaryProfiles: DatasetCommentaryProfile[]): 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<{
+export declare function getDbPath(p?: string | null): string;
+export declare function getPrismaDb(path?: string | null): PrismaClient<{
     datasources: {
         db: {
             url: string;
         };
     };
 }, never, import("prisma-gen/runtime/library.js").DefaultArgs>;
-export declare function getDbFromDir(dir: string): Promise<Database>;
-export declare function getDb(dbPath: string): Promise<Database>;
+/**
+ * Gets the database from the given path. If no path is provided, the current working directory is used.
+ * @param path The path to the database. If not provided, the current working directory is used.
+ * @returns
+ */
+export declare function getDb(path?: string | null): Promise<Database>;
 export interface SerializedFile {
     path: string;
     content: string | Readable;

package/dist/types/downloads.d.ts

@@ -1,2 +1,14 @@
+import { Entry, ZipReader } from '@zip.js/zip.js';
 export declare function downloadFile(url: string, path: string, onProgress?: (progress: number) => void): Promise<void>;
+export declare function downloadResponse(response: Response, path: string, onProgress?: (progress: number) => void): Promise<void>;
+/**
+ * Unzips a ZipReader to a specified directory.
+ * @param zip The ZipReader instance to read from.
+ * @param directory The directory to unzip files into.
+ * @param overwrite Wether to overwrite existing files.
+ * @param entryFilter A filter function to determine which entries to unzip.
+ * @param closeWhenDone Whether to close the ZipReader when done.
+ * @returns The number of files that matched the entry filter.
+ */
+export declare function unzipToDirectory(zip: ZipReader<unknown>, directory: string, overwrite: boolean, entryFilter?: (entry: Entry) => boolean, closeWhenDone?: boolean): Promise<number>;
 //# sourceMappingURL=downloads.d.ts.map

package/dist/types/ebible.d.ts

@@ -0,0 +1,6 @@
+import { EBibleSource } from 'prisma-gen/index.js';
+/**
+ * Fetches eBible translation metadata and returns EBibleSource objects.
+ */
+export declare function fetchEBibleMetadata(): Promise<EBibleSource[]>;
+//# sourceMappingURL=ebible.d.ts.map

package/meta/ARBNAV.json

@@ -0,0 +1,10 @@
+{
+    "id": "ARBNAV",
+    "name": "كتاب الحياة",
+    "direction": "rtl",
+    "englishName": "New Arabic Version (Book of Life)",
+    "language": "arb",
+    "licenseUrl": "https://ebible.org/Scriptures/details.php?id=arbnav",
+    "shortName": "NAV",
+    "website": "https://ebible.org/Scriptures/details.php?id=arbnav"
+}

package/meta/BSB.json

@@ -0,0 +1,10 @@
+{
+    "id": "BSB",
+    "name": "Berean Standard Bible",
+    "direction": "ltr",
+    "englishName": "Berean Standard Bible",
+    "language": "eng",
+    "licenseUrl": "https://berean.bible/",
+    "shortName": "BSB",
+    "website": "https://berean.bible/"
+}

package/meta/HBOMAS.json

@@ -0,0 +1,10 @@
+{
+    "id": "HBOMAS",
+    "name": "כתבי הקודש",
+    "direction": "rtl",
+    "englishName": "Hebrew Masoretic OT",
+    "language": "hbo",
+    "licenseUrl": "https://ebible.org/Scriptures/details.php?id=hbo",
+    "shortName": "MAS",
+    "website": "https://ebible.org/Scriptures/details.php?id=hbo"
+}

package/meta/HINIRV.json

@@ -0,0 +1,10 @@
+{
+    "id": "HINIRV",
+    "name": "इंडियन रिवाइज्ड वर्जन",
+    "direction": "ltr",
+    "englishName": "Hindi Indian Revised Version Bible",
+    "language": "hin",
+    "licenseUrl": "https://ebible.org/Scriptures/details.php?id=hin2017",
+    "shortName": "IRV",
+    "website": "https://ebible.org/Scriptures/details.php?id=hin2017"
+}

package/meta/eng_dra.json

@@ -0,0 +1,10 @@
+{
+    "id": "eng_dra",
+    "name": "Douay-Rheims 1899",
+    "direction": "ltr",
+    "englishName": "Douay-Rheims 1899",
+    "language": "eng",
+    "licenseUrl": "https://ebible.org/Scriptures/details.php?id=engDRA",
+    "shortName": "DRA",
+    "website": "https://ebible.org/Scriptures/details.php?id=engDRA"
+}

package/migrations/20250212175023_add_ebible_sources/migration.sql

@@ -0,0 +1,24 @@
+-- CreateTable
+CREATE TABLE "EBibleSource" (
+    "id" TEXT NOT NULL PRIMARY KEY,
+    "usfmZipUrl" TEXT,
+    "usfmZipEtag" TEXT,
+    "languageCode" TEXT NOT NULL,
+    "title" TEXT NOT NULL,
+    "redistributable" BOOLEAN NOT NULL,
+    "description" TEXT NOT NULL,
+    "copyright" TEXT NOT NULL,
+    "updateDate" DATETIME NOT NULL,
+    "sourceDate" DATETIME NOT NULL,
+    "oldTestamentBooks" INTEGER NOT NULL,
+    "oldTestamentChapters" INTEGER NOT NULL,
+    "oldTestamentVerses" INTEGER NOT NULL,
+    "newTestamentBooks" INTEGER NOT NULL,
+    "newTestamentChapters" INTEGER NOT NULL,
+    "newTestamentVerses" INTEGER NOT NULL,
+    "apocryphaBooks" INTEGER NOT NULL,
+    "apocryphaChapters" INTEGER NOT NULL,
+    "apocryphaVerses" INTEGER NOT NULL,
+    "translationId" TEXT NOT NULL,
+    "sha256" TEXT
+);

package/migrations/20250212183533_add_usfm_download_date/migration.sql

@@ -0,0 +1,39 @@
+/*
+  Warnings:
+
+  - Added the required column `FCBHID` to the `EBibleSource` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- RedefineTables
+PRAGMA defer_foreign_keys=ON;
+PRAGMA foreign_keys=OFF;
+CREATE TABLE "new_EBibleSource" (
+    "id" TEXT NOT NULL PRIMARY KEY,
+    "usfmZipUrl" TEXT,
+    "usfmZipEtag" TEXT,
+    "languageCode" TEXT NOT NULL,
+    "title" TEXT NOT NULL,
+    "redistributable" BOOLEAN NOT NULL,
+    "description" TEXT NOT NULL,
+    "copyright" TEXT NOT NULL,
+    "FCBHID" TEXT NOT NULL,
+    "updateDate" DATETIME NOT NULL,
+    "sourceDate" DATETIME NOT NULL,
+    "oldTestamentBooks" INTEGER NOT NULL,
+    "oldTestamentChapters" INTEGER NOT NULL,
+    "oldTestamentVerses" INTEGER NOT NULL,
+    "newTestamentBooks" INTEGER NOT NULL,
+    "newTestamentChapters" INTEGER NOT NULL,
+    "newTestamentVerses" INTEGER NOT NULL,
+    "apocryphaBooks" INTEGER NOT NULL,
+    "apocryphaChapters" INTEGER NOT NULL,
+    "apocryphaVerses" INTEGER NOT NULL,
+    "translationId" TEXT NOT NULL,
+    "usfmDownloadDate" DATETIME,
+    "sha256" TEXT
+);
+INSERT INTO "new_EBibleSource" ("apocryphaBooks", "apocryphaChapters", "apocryphaVerses", "copyright", "description", "id", "languageCode", "newTestamentBooks", "newTestamentChapters", "newTestamentVerses", "oldTestamentBooks", "oldTestamentChapters", "oldTestamentVerses", "redistributable", "sha256", "sourceDate", "title", "translationId", "updateDate", "usfmZipEtag", "usfmZipUrl") SELECT "apocryphaBooks", "apocryphaChapters", "apocryphaVerses", "copyright", "description", "id", "languageCode", "newTestamentBooks", "newTestamentChapters", "newTestamentVerses", "oldTestamentBooks", "oldTestamentChapters", "oldTestamentVerses", "redistributable", "sha256", "sourceDate", "title", "translationId", "updateDate", "usfmZipEtag", "usfmZipUrl" FROM "EBibleSource";
+DROP TABLE "EBibleSource";
+ALTER TABLE "new_EBibleSource" RENAME TO "EBibleSource";
+PRAGMA foreign_keys=ON;
+PRAGMA defer_foreign_keys=OFF;

package/migrations/20250212193627_add_usfm_download_path/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "EBibleSource" ADD COLUMN "usfmDownloadPath" TEXT;

package/migrations/20250625201152_add_extra_ebible_metadata/migration.sql

@@ -0,0 +1,3 @@
+-- AlterTable
+ALTER TABLE "EBibleSource" ADD COLUMN "shortTitle" TEXT;
+ALTER TABLE "EBibleSource" ADD COLUMN "textDirection" TEXT;

package/migrations/20250630200532_add_apocryhpa_flag/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "Book" ADD COLUMN "isApocryphal" BOOLEAN;

package/migrations/20250701195337_add_file_warnings/migration.sql

@@ -0,0 +1,8 @@
+-- CreateTable
+CREATE TABLE "InputFileWarning" (
+    "name" TEXT NOT NULL,
+    "type" TEXT NOT NULL,
+    "message" TEXT NOT NULL,
+
+    PRIMARY KEY ("name", "type", "message")
+);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helloao/cli",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "A CLI and related tools for managing HelloAO's Free Bible API",
   "main": "./dist/cjs/index.cjs",
   "module": "./dist/esm/index.js",
@@ -41,7 +41,9 @@
     "@smithy/config-resolver": "^3.0.10",
     "@inquirer/prompts": "5.3.8",
     "all-iso-language-codes": "1.0.17",
-    "@helloao/tools": "0.0.12"
+    "papaparse": "5.4.1",
+    "luxon": "3.5.0",
+    "@helloao/tools": "0.0.14"
   },
   "files": [
     "/README.md",
@@ -50,7 +52,8 @@
     "**/*.js.map",
     "**/*.d.ts",
     "/migrations/**/*.sql",
-    "./schema.prisma"
+    "./schema.prisma",
+    "/meta/*.json"
   ],
   "prisma": {
     "schema": "./schema.prisma"