@helloao/cli 0.0.6 → 0.0.8

package/README.md

@@ -1,125 +1,132 @@
-## Hello AO CLI
-
-A Command Line Interface (CLI) that makes it easy to generate and manage your own [Free Use Bible API](https://bible.helloao.org/).
-
-Additionally, it includes many functions and utilities that can make working with commonly formatted Bible data much easier.
-
-### Features
-
--   Supports [USFM](https://ubsicap.github.io/usfm/), [USX](https://ubsicap.github.io/usx/), and Codex (A JSON format).
--   Download over 1000 Bible translations from [fetch.bible](https://fetch.bible/).
--   Import Bible translations into a SQLite database.
--   Upload to S3, a zip file, or a local directory.
-
-### Usage
-
-```
-Usage: helloao [options] [command]
-
-A CLI for managing a Free Use Bible API.
-
-Options:
-  -V, --version                                         output the version number
-  -h, --help                                            display help for command
-
-Commands:
-  init [options] [path]                                 Initialize a new Bible API DB.
-  import-translation [options] <dir> [dirs...]          Imports a translation from the given directory into the database.
-  import-translations [options] <dir>                   Imports all translations from the given directory into the database.
-  generate-translation-files [options] <input> <dir>    Generates API files from the given input translation.
-  generate-translations-files [options] <input> <dir>   Generates API files from the given input translations.
-  upload-api-files [options] <dest>                     Uploads API files to the specified destination. For S3, use the format s3://bucket-name/path/to/folder.
-  fetch-translations [options] <dir> [translations...]  Fetches the specified translations from fetch.bible and places them in the given directory.
-  fetch-audio [options] <dir> [translations...]         Fetches the specified audio translations and places them in the given directory.
-                                                        Translations should be in the format "translationId/audioId". e.g. "BSB/gilbert"
-  fetch-bible-metadata <dir>                            Fetches the Theographic bible metadata and places it in the given directory.
-  help [command]                                        display help for command
-```
-
-The `@helloao/cli` package can also be used as a library.
-
-The library exports a variety of actions, utilities, and supporting classes designed to assist with generating and managing a Free Use Bible API.
-
-There are 6 main exports:
-
--   `actions` - This export contains function versions of the CLI commands. They make it easy to call a CLI command from a script.
--   `db` - This export contains functions that make working with a database easier. It supports operations like importing translations into a database, inserting chapters, verses, etc. and getting an updated database instance from a path.
--   `downloads` - This export contains functions that make downloading files easier.
--   `files` - This export contains functions that make working with files easier. It has functions to load files from a translation, discover translation metadata from the filesystem, and classes that support uploading API files to the local file system or to a zip archive.
--   `uploads` - This export contains functions that make it easy to upload an API to a destination like S3, the local filesystem, or a zip archive.
--   `s3` - This export contains a class that can upload files to S3.
-
-Here are some common operations that you might want to perform:
-
-#### Get a SQL Database
-
-```typescript
-import { db } from '@helloao/cli';
-
-const pathToDb = './bible-database.db';
-const database = await db.getDb(pathToDb);
-
-// do work on the database
-
-// Close it when you are done.
-database.close();
-```
-
-#### Import a translation into a database from a directory
-
-```typescript
-import { db } from '@helloao/cli';
-
-const pathToDb = './bible-database.db';
-const database = await db.getDb(pathToDb);
-
-// Get a DOMParser for parsing USX.
-// On Node.js, you may have to import jsdom or linkedom.
-const parser = new DOMParser();
-
-const pathToTranslation = './path/to/translation';
-
-// Whether to overwrite files that already exist in the database.
-// The system will automatically determine the hashes of the input files and overwrite changed files if needed, so this is only needed
-// when you know that they need to be overwritten.
-const overwrite = false;
-await db.importTranslations(database, pathToTranslation, parser, overwrite);
-```
-
-#### Generate an API from a translation
-
-```typescript
-import { files, uploads } from '@helloao/cli';
-import { generation } from '@helloao/tools';
-import { toAsyncIterable } from '@helloao/tools/parser/iterators';
-
-const translationPath = './path/to/translation';
-const translationFiles = await files.loadTranslationFiles(translationPath);
-
-// Used to parse XML
-const domParser = new DOMParser();
-
-// Generate a dataset from the files
-// Datasets organize all the files and their content
-// by translation, book, chapter, and verse
-const dataset = generation.dataset.generateDataset(files, parser);
-
-// You can optionally specifiy a prefix that should be added to all API
-// links
-const pathPrefix = '';
-
-// Generate an API representation from the files
-// This adds links between chapters and additional metadata.
-const api = generation.api.generateApiForDataset(dataset, {
-    pathPrefix,
-});
-
-// Generate output files from the API representation.
-// This will give us a list of files and file paths that represent
-// the entire API.
-const outputFiles = generation.api.generateFilesForApi(api);
-
-// Optionally upload files by using:
-// const dest = 's3://my-bucket';
-// await uploads.serializeAndUploadDatasets(dest, toAsyncIterable(outputFiles));
-```
+## Hello AO CLI
+
+A Command Line Interface (CLI) that makes it easy to generate and manage your own [Free Use Bible API](https://bible.helloao.org/).
+
+Additionally, it includes many functions and utilities that can make working with commonly formatted Bible data much easier.
+
+### Features
+
+-   Supports [USFM](https://ubsicap.github.io/usfm/), [USX](https://ubsicap.github.io/usx/), and Codex (A JSON format).
+-   Download over 1000 Bible translations from [fetch.bible](https://fetch.bible/).
+-   Import Bible translations into a SQLite database.
+-   Upload to S3, a zip file, or a local directory.
+
+### Usage
+
+```
+Usage: helloao [options] [command]
+
+A CLI for managing a Free Use Bible API.
+
+Options:
+  -V, --version                                         output the version number
+  -h, --help                                            display help for command
+
+Commands:
+  init [options] [path]                                 Initialize a new Bible API DB.
+  generate-translation-metadata                         Generates a metadata file for a translation.
+  import-translation [options] <dir> [dirs...]          Imports a translation from the given directory into the database.
+  import-translations [options] <dir>                   Imports all translations from the given directory into the database.
+  upload-test-translation [options] <input>             Uploads a translation to the HelloAO Free Bible API test S3 bucket.
+                                                        Requires access to the HelloAO Free Bible API test S3 bucket.
+                                                        For inquiries, please contact hello@helloao.org.
+  upload-test-translations [options] <input>            Uploads all the translations in the given input directory to the HelloAO Free Bible API test S3 bucket.
+                                                        Requires access to the HelloAO Free Bible API test S3 bucket.
+                                                        For inquiries, please contact hello@helloao.org.
+  generate-translation-files [options] <input> <dir>    Generates API files from the given input translation.
+  generate-translations-files [options] <input> <dir>   Generates API files from the given input translations.
+  upload-api-files [options] <dest>                     Uploads API files to the specified destination. For S3, use the format s3://bucket-name/path/to/folder.
+  fetch-translations [options] <dir> [translations...]  Fetches the specified translations from fetch.bible and places them in the given directory.
+  fetch-audio [options] <dir> [translations...]         Fetches the specified audio translations and places them in the given directory.
+                                                        Translations should be in the format "translationId/audioId". e.g. "BSB/gilbert"
+  fetch-bible-metadata <dir>                            Fetches the Theographic bible metadata and places it in the given directory.
+  help [command]                                        display help for command
+```
+
+The `@helloao/cli` package can also be used as a library.
+
+The library exports a variety of actions, utilities, and supporting classes designed to assist with generating and managing a Free Use Bible API.
+
+There are 6 main exports:
+
+-   `actions` - This export contains function versions of the CLI commands. They make it easy to call a CLI command from a script.
+-   `db` - This export contains functions that make working with a database easier. It supports operations like importing translations into a database, inserting chapters, verses, etc. and getting an updated database instance from a path.
+-   `downloads` - This export contains functions that make downloading files easier.
+-   `files` - This export contains functions that make working with files easier. It has functions to load files from a translation, discover translation metadata from the filesystem, and classes that support uploading API files to the local file system or to a zip archive.
+-   `uploads` - This export contains functions that make it easy to upload an API to a destination like S3, the local filesystem, or a zip archive.
+-   `s3` - This export contains a class that can upload files to S3.
+
+Here are some common operations that you might want to perform:
+
+#### Get a SQL Database
+
+```typescript
+import { db } from '@helloao/cli';
+
+const pathToDb = './bible-database.db';
+const database = await db.getDb(pathToDb);
+
+// do work on the database
+
+// Close it when you are done.
+database.close();
+```
+
+#### Import a translation into a database from a directory
+
+```typescript
+import { db } from '@helloao/cli';
+
+const pathToDb = './bible-database.db';
+const database = await db.getDb(pathToDb);
+
+// Get a DOMParser for parsing USX.
+// On Node.js, you may have to import jsdom or linkedom.
+const parser = new DOMParser();
+
+const pathToTranslation = './path/to/translation';
+
+// Whether to overwrite files that already exist in the database.
+// The system will automatically determine the hashes of the input files and overwrite changed files if needed, so this is only needed
+// when you know that they need to be overwritten.
+const overwrite = false;
+await db.importTranslations(database, pathToTranslation, parser, overwrite);
+```
+
+#### Generate an API from a translation
+
+```typescript
+import { files, uploads } from '@helloao/cli';
+import { generation } from '@helloao/tools';
+import { toAsyncIterable } from '@helloao/tools/parser/iterators';
+
+const translationPath = './path/to/translation';
+const translationFiles = await files.loadTranslationFiles(translationPath);
+
+// Used to parse XML
+const domParser = new DOMParser();
+
+// Generate a dataset from the files
+// Datasets organize all the files and their content
+// by translation, book, chapter, and verse
+const dataset = generation.dataset.generateDataset(files, parser);
+
+// You can optionally specifiy a prefix that should be added to all API
+// links
+const pathPrefix = '';
+
+// Generate an API representation from the files
+// This adds links between chapters and additional metadata.
+const api = generation.api.generateApiForDataset(dataset, {
+    pathPrefix,
+});
+
+// Generate output files from the API representation.
+// This will give us a list of files and file paths that represent
+// the entire API.
+const outputFiles = generation.api.generateFilesForApi(api);
+
+// Optionally upload files by using:
+// const dest = 's3://my-bucket';
+// await uploads.serializeAndUploadDatasets(dest, toAsyncIterable(outputFiles));
+```

package/actions.d.ts

@@ -1,3 +1,4 @@
+import { InputTranslationMetadata } from '@helloao/tools/generation';
 import { UploadApiFromDatabaseOptions, UploadApiOptions } from './uploads';
 export interface InitDbOptions {
     /**
@@ -117,5 +118,9 @@ export declare function uploadTestTranslations(input: string, options: UploadTes
  * @param input The input directory that the translations are stored in.
  * @param options The options to use for the upload.
  */
-export declare function uploadTestTranslation(input: string, options: UploadTestTranslationOptions): Promise<UploadTestTranslationResult>;
+export declare function uploadTestTranslation(input: string, options: UploadTestTranslationOptions): Promise<UploadTestTranslationResult | undefined>;
+/**
+ * Asks the user for the metadata for the translation.
+ */
+export declare function askForMetadata(defaultId?: string): Promise<InputTranslationMetadata>;
 //# sourceMappingURL=actions.d.ts.map

package/actions.js

@@ -35,6 +35,7 @@ exports.generateTranslationsFiles = generateTranslationsFiles;
 exports.generateTranslationFiles = generateTranslationFiles;
 exports.uploadTestTranslations = uploadTestTranslations;
 exports.uploadTestTranslation = uploadTestTranslation;
+exports.askForMetadata = askForMetadata;
 const node_path_1 = __importStar(require("node:path"));
 const database = __importStar(require("./db"));
 const better_sqlite3_1 = __importDefault(require("better-sqlite3"));
@@ -51,6 +52,8 @@ const files_1 = require("./files");
 const dataset_1 = require("@helloao/tools/generation/dataset");
 const uploads_1 = require("./uploads");
 const s3_1 = require("./s3");
+const prompts_1 = require("@inquirer/prompts");
+const all_iso_language_codes_1 = require("all-iso-language-codes");
 /**
  * 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.
@@ -68,46 +71,46 @@ async function initDb(dbPath, options) {
                 const languages = `(${options.language
                     .map((l) => `'${l}'`)
                     .join(', ')})`;
-                db.exec(`
-                    ATTACH DATABASE "${sourcePath}" AS source;
-
-                    CREATE TABLE "_prisma_migrations" AS SELECT * FROM source._prisma_migrations;
-                    
-                    CREATE TABLE "Translation" AS SELECT * FROM source.Translation
-                    WHERE language IN ${languages};
-
-                    CREATE TABLE "Book" AS SELECT * FROM source.Book
-                    INNER JOIN source.Translation ON source.Translation.id = source.Book.translationId
-                    WHERE source.Translation.language IN ${languages};
-
-                    CREATE TABLE "Chapter" AS SELECT * FROM source.Chapter
-                    INNER JOIN source.Translation ON source.Translation.id = source.Chapter.translationId
-                    WHERE source.Translation.language IN ${languages};
-
-                    CREATE TABLE "ChapterVerse" AS SELECT * FROM source.ChapterVerse
-                    INNER JOIN source.Translation ON source.Translation.id = source.ChapterVerse.translationId
-                    WHERE source.Translation.language IN ${languages};
-
-                    CREATE TABLE "ChapterFootnote" AS SELECT * FROM source.ChapterFootnote
-                    INNER JOIN source.Translation ON source.Translation.id = source.ChapterFootnote.translationId
-                    WHERE source.Translation.language IN ${languages};
-
-                    CREATE TABLE "ChapterAudioUrl" AS SELECT * FROM source.ChapterAudioUrl
-                    INNER JOIN source.Translation ON source.Translation.id = source.ChapterAudioUrl.translationId
-                    WHERE source.Translation.language IN ${languages};
+                db.exec(`
+                    ATTACH DATABASE "${sourcePath}" AS source;
+
+                    CREATE TABLE "_prisma_migrations" AS SELECT * FROM source._prisma_migrations;
+                    
+                    CREATE TABLE "Translation" AS SELECT * FROM source.Translation
+                    WHERE language IN ${languages};
+
+                    CREATE TABLE "Book" AS SELECT * FROM source.Book
+                    INNER JOIN source.Translation ON source.Translation.id = source.Book.translationId
+                    WHERE source.Translation.language IN ${languages};
+
+                    CREATE TABLE "Chapter" AS SELECT * FROM source.Chapter
+                    INNER JOIN source.Translation ON source.Translation.id = source.Chapter.translationId
+                    WHERE source.Translation.language IN ${languages};
+
+                    CREATE TABLE "ChapterVerse" AS SELECT * FROM source.ChapterVerse
+                    INNER JOIN source.Translation ON source.Translation.id = source.ChapterVerse.translationId
+                    WHERE source.Translation.language IN ${languages};
+
+                    CREATE TABLE "ChapterFootnote" AS SELECT * FROM source.ChapterFootnote
+                    INNER JOIN source.Translation ON source.Translation.id = source.ChapterFootnote.translationId
+                    WHERE source.Translation.language IN ${languages};
+
+                    CREATE TABLE "ChapterAudioUrl" AS SELECT * FROM source.ChapterAudioUrl
+                    INNER JOIN source.Translation ON source.Translation.id = source.ChapterAudioUrl.translationId
+                    WHERE source.Translation.language IN ${languages};
                 `);
             }
             else {
-                db.exec(`
-                    ATTACH DATABASE "${sourcePath}" AS source;
-
-                    CREATE TABLE "_prisma_migrations" AS SELECT * FROM source._prisma_migrations;
-                    CREATE TABLE "Translation" AS SELECT * FROM source.Translation;
-                    CREATE TABLE "Book" AS SELECT * FROM source.Book;
-                    CREATE TABLE "Chapter" AS SELECT * FROM source.Chapter;
-                    CREATE TABLE "ChapterVerse" AS SELECT * FROM source.ChapterVerse;
-                    CREATE TABLE "ChapterFootnote" AS SELECT * FROM source.ChapterFootnote;
-                    CREATE TABLE "ChapterAudioUrl" AS SELECT * FROM source.ChapterAudioUrl;
+                db.exec(`
+                    ATTACH DATABASE "${sourcePath}" AS source;
+
+                    CREATE TABLE "_prisma_migrations" AS SELECT * FROM source._prisma_migrations;
+                    CREATE TABLE "Translation" AS SELECT * FROM source.Translation;
+                    CREATE TABLE "Book" AS SELECT * FROM source.Book;
+                    CREATE TABLE "Chapter" AS SELECT * FROM source.Chapter;
+                    CREATE TABLE "ChapterVerse" AS SELECT * FROM source.ChapterVerse;
+                    CREATE TABLE "ChapterFootnote" AS SELECT * FROM source.ChapterFootnote;
+                    CREATE TABLE "ChapterAudioUrl" AS SELECT * FROM source.ChapterAudioUrl;
                 `);
             }
             console.log('Done.');
@@ -306,7 +309,11 @@ async function generateTranslationFiles(input, dest, options) {
     globalThis.DOMParser = linkedom_1.DOMParser;
     globalThis.Element = linkedom_1.Element;
     globalThis.Node = linkedom_1.Node;
-    const files = await (0, files_1.loadTranslationFiles)(node_path_1.default.resolve(input));
+    const files = await loadTranslationFilesOrAskForMetadata(node_path_1.default.resolve(input));
+    if (!files) {
+        console.log('No translation files found.');
+        return;
+    }
     const dataset = (0, dataset_1.generateDataset)(files, parser);
     await (0, uploads_1.serializeAndUploadDatasets)(dest, (0, iterators_1.toAsyncIterable)([dataset]), options);
 }
@@ -354,7 +361,12 @@ async function uploadTestTranslation(input, options) {
     globalThis.DOMParser = linkedom_1.DOMParser;
     globalThis.Element = linkedom_1.Element;
     globalThis.Node = linkedom_1.Node;
-    const files = await (0, files_1.loadTranslationFiles)(node_path_1.default.resolve(input));
+    const inputPath = node_path_1.default.resolve(input);
+    const files = await loadTranslationFilesOrAskForMetadata(inputPath);
+    if (!files || files.length <= 0) {
+        console.log('No translation files found.');
+        return;
+    }
     const hash = (0, files_1.hashInputFiles)(files);
     const dataset = (0, dataset_1.generateDataset)(files, parser);
     const url = options.s3Url || 's3://ao-bible-api-public-uploads';
@@ -376,3 +388,81 @@ function getUrls(dest) {
         url: url,
     };
 }
+async function loadTranslationFilesOrAskForMetadata(dir) {
+    let files = await (0, files_1.loadTranslationFiles)(dir);
+    if (!files) {
+        console.log(`No metadata found for the translation in ${dir}`);
+        const enterMetadata = await (0, prompts_1.confirm)({
+            message: 'Do you want to enter the metadata for the translation?',
+        });
+        if (!enterMetadata) {
+            return null;
+        }
+        const defaultId = (0, node_path_1.basename)(dir);
+        const metadata = await askForMetadata(defaultId);
+        const saveMetadata = await (0, prompts_1.confirm)({
+            message: 'Do you want to save this metadata?',
+        });
+        if (saveMetadata) {
+            await (0, promises_1.writeFile)(node_path_1.default.resolve(dir, 'metadata.json'), JSON.stringify(metadata, null, 2));
+        }
+        files = await (0, files_1.loadTranslationFiles)(dir);
+    }
+    return files;
+}
+/**
+ * Asks the user for the metadata for the translation.
+ */
+async function askForMetadata(defaultId) {
+    const id = await (0, prompts_1.input)({
+        message: 'Enter the translation ID',
+        default: defaultId,
+    });
+    const language = await (0, prompts_1.input)({
+        message: 'Enter the ISO 639 translation language',
+        validate: (input) => {
+            return (0, all_iso_language_codes_1.isValid)(input) ? true : 'Invalid language code.';
+        },
+        required: true,
+    });
+    const direction = await (0, prompts_1.select)({
+        message: 'Enter the text direction of the language',
+        choices: [
+            { name: 'Left-to-right', value: 'ltr' },
+            { name: 'Right-to-left', value: 'rtl' },
+        ],
+        default: 'ltr',
+    });
+    const shortName = await (0, prompts_1.input)({
+        message: 'Enter the short name of the translation',
+        default: id,
+        required: false,
+    });
+    const name = await (0, prompts_1.input)({
+        message: 'Enter the name of the translation',
+        required: true,
+    });
+    const englishName = await (0, prompts_1.input)({
+        message: 'Enter the English name of the translation',
+        default: name,
+    });
+    const licenseUrl = await (0, prompts_1.input)({
+        message: 'Enter the license URL for the translation',
+        required: true,
+    });
+    const website = await (0, prompts_1.input)({
+        message: 'Enter the website URL for the translation',
+        required: true,
+        default: licenseUrl,
+    });
+    return {
+        id,
+        language,
+        direction: direction,
+        shortName,
+        name,
+        englishName,
+        licenseUrl,
+        website,
+    };
+}

package/cli.js

@@ -1,11 +1,31 @@
 #!/usr/bin/env node
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
-const path_1 = __importDefault(require("path"));
+const path_1 = __importStar(require("path"));
 const promises_1 = require("fs/promises");
 const linkedom_1 = require("linkedom");
 const downloads_1 = require("./downloads");
@@ -31,6 +51,32 @@ async function start() {
         .action(async (dbPath, options) => {
         await (0, actions_1.initDb)(dbPath, options);
     });
+    program
+        .command('generate-translation-metadata')
+        .description('Generates a metadata file for a translation.')
+        .action(async () => {
+        const meta = await (0, actions_1.askForMetadata)();
+        console.log('Your metadata:', meta);
+        const save = await (0, prompts_1.confirm)({
+            message: 'Do you want to save this metadata?',
+        });
+        if (save) {
+            let location = await (0, prompts_1.input)({
+                message: 'Where would you like to save the metadata?',
+            });
+            const ext = (0, path_1.extname)(location);
+            if (!ext) {
+                if (!location.endsWith('/')) {
+                    location += '/';
+                }
+                location += 'metadata.json';
+            }
+            console.log('Saving metadata to:', location);
+            const dir = path_1.default.dirname(location);
+            await (0, promises_1.mkdir)(dir, { recursive: true });
+            await (0, promises_1.writeFile)(location, JSON.stringify(meta, null, 2));
+        }
+    });
     program
         .command('import-translation <dir> [dirs...]')
         .description('Imports a translation from the given directory into the database.')
@@ -69,11 +115,13 @@ async function start() {
             return;
         }
         const result = await (0, actions_1.uploadTestTranslation)(input, options);
-        console.log('\n');
-        console.log('Version:               ', result.version);
-        console.log('Uploaded to:           ', result.uploadS3Url);
-        console.log('URL:                   ', result.url);
-        console.log('Available Translations:', result.availableTranslationsUrl);
+        if (result) {
+            console.log('\n');
+            console.log('Version:               ', result.version);
+            console.log('Uploaded to:           ', result.uploadS3Url);
+            console.log('URL:                   ', result.url);
+            console.log('Available Translations:', result.availableTranslationsUrl);
+        }
     });
     program
         .command('upload-test-translations <input>')

package/db.js

@@ -83,7 +83,7 @@ async function importTranslationBatch(db, dirs, parser, overwrite) {
     const promises = [];
     for (let dir of dirs) {
         const fullPath = path_1.default.resolve(dir);
-        promises.push((0, files_1.loadTranslationFiles)(fullPath));
+        promises.push((0, files_1.loadTranslationFiles)(fullPath).then((files) => files ?? []));
     }
     const allFiles = await Promise.all(promises);
     const files = allFiles.flat();
@@ -130,22 +130,22 @@ function getChangedOrNewInputFiles(db, files) {
     });
 }
 function insertFileMetadata(db, files) {
-    const fileUpsert = db.prepare(`INSERT INTO InputFile(
-        translationId,
-        name,
-        format,
-        sha256,
-        sizeInBytes
-    ) VALUES (
-        @translationId,
-        @name,
-        @format,
-        @sha256,
-        @sizeInBytes
-    ) ON CONFLICT(translationId, name) DO 
-        UPDATE SET
-            format=excluded.format,
-            sha256=excluded.sha256,
+    const fileUpsert = db.prepare(`INSERT INTO InputFile(
+        translationId,
+        name,
+        format,
+        sha256,
+        sizeInBytes
+    ) VALUES (
+        @translationId,
+        @name,
+        @format,
+        @sha256,
+        @sizeInBytes
+    ) ON CONFLICT(translationId, name) DO 
+        UPDATE SET
+            format=excluded.format,
+            sha256=excluded.sha256,
             sizeInBytes=excluded.sizeInBytes;`);
     const insertManyFiles = db.transaction((files) => {
         for (let file of files) {
@@ -161,32 +161,32 @@ function insertFileMetadata(db, files) {
     insertManyFiles(files);
 }
 function insertTranslations(db, translations) {
-    const translationUpsert = db.prepare(`INSERT INTO Translation(
-        id,
-        name,
-        language,
-        shortName,
-        textDirection,
-        licenseUrl,
-        website,
-        englishName
-    ) VALUES (
-        @id,
-        @name,
-        @language,
-        @shortName,
-        @textDirection,
-        @licenseUrl,
-        @website,
-        @englishName
-    ) ON CONFLICT(id) DO 
-        UPDATE SET
-            name=excluded.name,
-            language=excluded.language,
-            shortName=excluded.shortName,
-            textDirection=excluded.textDirection,
-            licenseUrl=excluded.licenseUrl,
-            website=excluded.website,
+    const translationUpsert = db.prepare(`INSERT INTO Translation(
+        id,
+        name,
+        language,
+        shortName,
+        textDirection,
+        licenseUrl,
+        website,
+        englishName
+    ) VALUES (
+        @id,
+        @name,
+        @language,
+        @shortName,
+        @textDirection,
+        @licenseUrl,
+        @website,
+        @englishName
+    ) ON CONFLICT(id) DO 
+        UPDATE SET
+            name=excluded.name,
+            language=excluded.language,
+            shortName=excluded.shortName,
+            textDirection=excluded.textDirection,
+            licenseUrl=excluded.licenseUrl,
+            website=excluded.website,
             englishName=excluded.englishName;`);
     const insertManyTranslations = db.transaction((translations) => {
         for (let translation of translations) {
@@ -208,27 +208,27 @@ function insertTranslations(db, translations) {
     }
 }
 function insertTranslationBooks(db, translation, translationBooks) {
-    const bookUpsert = db.prepare(`INSERT INTO Book(
-        id,
-        translationId,
-        title,
-        name,
-        commonName,
-        numberOfChapters,
-        \`order\`
-    ) VALUES (
-        @id,
-        @translationId,
-        @title,
-        @name,
-        @commonName,
-        @numberOfChapters,
-        @bookOrder
-    ) ON CONFLICT(id,translationId) DO 
-        UPDATE SET
-            title=excluded.title,
-            name=excluded.name,
-            commonName=excluded.commonName,
+    const bookUpsert = db.prepare(`INSERT INTO Book(
+        id,
+        translationId,
+        title,
+        name,
+        commonName,
+        numberOfChapters,
+        \`order\`
+    ) VALUES (
+        @id,
+        @translationId,
+        @title,
+        @name,
+        @commonName,
+        @numberOfChapters,
+        @bookOrder
+    ) ON CONFLICT(id,translationId) DO 
+        UPDATE SET
+            title=excluded.title,
+            name=excluded.name,
+            commonName=excluded.commonName,
             numberOfChapters=excluded.numberOfChapters;`);
     const insertMany = db.transaction((books) => {
         for (let book of books) {
@@ -252,69 +252,69 @@ function insertTranslationBooks(db, translation, translationBooks) {
     }
 }
 function insertTranslationContent(db, translation, book, chapters) {
-    const chapterUpsert = db.prepare(`INSERT INTO Chapter(
-        translationId,
-        bookId,
-        number,
-        json
-    ) VALUES (
-        @translationId,
-        @bookId,
-        @number,
-        @json
-    ) ON CONFLICT(translationId,bookId,number) DO 
-        UPDATE SET
+    const chapterUpsert = db.prepare(`INSERT INTO Chapter(
+        translationId,
+        bookId,
+        number,
+        json
+    ) VALUES (
+        @translationId,
+        @bookId,
+        @number,
+        @json
+    ) ON CONFLICT(translationId,bookId,number) DO 
+        UPDATE SET
             json=excluded.json;`);
-    const verseUpsert = db.prepare(`INSERT INTO ChapterVerse(
-        translationId,
-        bookId,
-        chapterNumber,
-        number,
-        text,
-        contentJson
-    ) VALUES (
-        @translationId,
-        @bookId,
-        @chapterNumber,
-        @number,
-        @text,
-        @contentJson
-    ) ON CONFLICT(translationId,bookId,chapterNumber,number) DO 
-        UPDATE SET
-            text=excluded.text,
+    const verseUpsert = db.prepare(`INSERT INTO ChapterVerse(
+        translationId,
+        bookId,
+        chapterNumber,
+        number,
+        text,
+        contentJson
+    ) VALUES (
+        @translationId,
+        @bookId,
+        @chapterNumber,
+        @number,
+        @text,
+        @contentJson
+    ) ON CONFLICT(translationId,bookId,chapterNumber,number) DO 
+        UPDATE SET
+            text=excluded.text,
             contentJson=excluded.contentJson;`);
-    const footnoteUpsert = db.prepare(`INSERT INTO ChapterFootnote(
-        translationId,
-        bookId,
-        chapterNumber,
-        id,
-        verseNumber,
-        text
-    ) VALUES (
-        @translationId,
-        @bookId,
-        @chapterNumber,
-        @id,
-        @verseNumber,
-        @text
-    ) ON CONFLICT(translationId,bookId,chapterNumber,id) DO 
-        UPDATE SET
-            verseNumber=excluded.verseNumber,
+    const footnoteUpsert = db.prepare(`INSERT INTO ChapterFootnote(
+        translationId,
+        bookId,
+        chapterNumber,
+        id,
+        verseNumber,
+        text
+    ) VALUES (
+        @translationId,
+        @bookId,
+        @chapterNumber,
+        @id,
+        @verseNumber,
+        @text
+    ) ON CONFLICT(translationId,bookId,chapterNumber,id) DO 
+        UPDATE SET
+            verseNumber=excluded.verseNumber,
             text=excluded.text;`);
-    const chapterAudioUpsert = db.prepare(`INSERT INTO ChapterAudioUrl(
-        translationId,
-        bookId,
-        number,
-        reader,
-        url
-    ) VALUES (
-        @translationId,
-        @bookId,
-        @number,
-        @reader,
-        @url
-    ) ON CONFLICT(translationId,bookId,number,reader) DO
-        UPDATE SET
+    const chapterAudioUpsert = db.prepare(`INSERT INTO ChapterAudioUrl(
+        translationId,
+        bookId,
+        number,
+        reader,
+        url
+    ) VALUES (
+        @translationId,
+        @bookId,
+        @number,
+        @reader,
+        @url
+    ) ON CONFLICT(translationId,bookId,number,reader) DO
+        UPDATE SET
             url=excluded.url;`);
     const insertChaptersAndVerses = db.transaction(() => {
         for (let chapter of chapters) {
@@ -516,15 +516,15 @@ async function getDbFromDir(dir) {
 }
 async function getDb(dbPath) {
     const db = new better_sqlite3_1.default(dbPath, {});
-    db.exec(`CREATE TABLE IF NOT EXISTS "_prisma_migrations" (
-        "id"                    TEXT PRIMARY KEY NOT NULL,
-        "checksum"              TEXT NOT NULL,
-        "finished_at"           DATETIME,
-        "migration_name"        TEXT NOT NULL,
-        "logs"                  TEXT,
-        "rolled_back_at"        DATETIME,
-        "started_at"            DATETIME NOT NULL DEFAULT current_timestamp,
-        "applied_steps_count"   INTEGER UNSIGNED NOT NULL DEFAULT 0
+    db.exec(`CREATE TABLE IF NOT EXISTS "_prisma_migrations" (
+        "id"                    TEXT PRIMARY KEY NOT NULL,
+        "checksum"              TEXT NOT NULL,
+        "finished_at"           DATETIME,
+        "migration_name"        TEXT NOT NULL,
+        "logs"                  TEXT,
+        "rolled_back_at"        DATETIME,
+        "started_at"            DATETIME NOT NULL DEFAULT current_timestamp,
+        "applied_steps_count"   INTEGER UNSIGNED NOT NULL DEFAULT 0
     );`);
     const migrations = await (0, fs_extra_1.readdir)(migrationsPath);
     const appliedMigrations = db

package/files.d.ts

@@ -65,9 +65,9 @@ export declare function loadTranslationsFiles(dirs: string[]): Promise<InputFile
 /**
  * Loads the files for the given translation.
  * @param translation The directory that the translation exists in.
- * @returns
+ * @returns The list of files that were loaded, or null if the translation has no metadata.
  */
-export declare function loadTranslationFiles(translation: string): Promise<InputFile[]>;
+export declare function loadTranslationFiles(translation: string): Promise<InputFile[] | null>;
 export interface CollectionTranslationMetadata {
     name: {
         local: string;

package/files.js

@@ -152,7 +152,7 @@ async function loadTranslationsFiles(dirs) {
     const promises = [];
     for (let dir of dirs) {
         const fullPath = path.resolve(dir);
-        promises.push(loadTranslationFiles(fullPath));
+        promises.push(loadTranslationFiles(fullPath).then((files) => files ?? []));
     }
     const allFiles = await Promise.all(promises);
     const files = allFiles.flat();
@@ -161,13 +161,13 @@ async function loadTranslationsFiles(dirs) {
 /**
  * Loads the files for the given translation.
  * @param translation The directory that the translation exists in.
- * @returns
+ * @returns The list of files that were loaded, or null if the translation has no metadata.
  */
 async function loadTranslationFiles(translation) {
     const metadata = await loadTranslationMetadata(translation);
     if (!metadata) {
         console.error('Could not load metadata for translation!', translation);
-        return [];
+        return null;
     }
     let files = await (0, promises_1.readdir)(translation);
     let usfmFiles = files.filter((f) => (0, path_1.extname)(f) === '.usfm' ||

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helloao/cli",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "A CLI and related tools for managing HelloAO's Free Bible API",
   "module": "index.js",
   "types": "index.d.ts",