@helloao/cli 0.1.0 → 0.3.0

package/dist/types/prisma-gen/models.d.ts

@@ -0,0 +1,23 @@
+export type * from './models/Translation';
+export type * from './models/Commentary';
+export type * from './models/EBibleSource';
+export type * from './models/InputFile';
+export type * from './models/InputFileWarning';
+export type * from './models/Book';
+export type * from './models/CommentaryBook';
+export type * from './models/CommentaryProfile';
+export type * from './models/Chapter';
+export type * from './models/CommentaryChapter';
+export type * from './models/ChapterAudioUrl';
+export type * from './models/ChapterAudioTiming';
+export type * from './models/ChapterWords';
+export type * from './models/ChapterVerse';
+export type * from './models/CommentaryChapterVerse';
+export type * from './models/ChapterFootnote';
+export type * from './models/Dataset';
+export type * from './models/DatasetBook';
+export type * from './models/DatasetChapter';
+export type * from './models/DatasetChapterVerse';
+export type * from './models/DatasetReference';
+export type * from './commonInputTypes';
+//# sourceMappingURL=models.d.ts.map

package/dist/types/s3.d.ts

@@ -5,8 +5,10 @@ export declare class S3Uploader implements Uploader {
     private _bucketName;
     private _keyPrefix;
     get idealBatchSize(): number;
+    get retryCount(): number;
     constructor(bucketName: string, keyPrefix: string, profile: string | null | AwsCredentialIdentity | Provider<AwsCredentialIdentity>, region?: string);
     upload(file: SerializedFile, overwrite: boolean): Promise<boolean>;
+    private _upload;
 }
 /**
  * Parses the given S3 URL into its bucket name and object key.

package/dist/types/uploads.d.ts

@@ -1,7 +1,7 @@
 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 { PrismaClient } from './prisma-gen/client.js';
 import { GenerateApiOptions } from '@helloao/tools/generation/api.js';
 export interface UploadApiFromDatabaseOptions extends UploadApiOptions, GenerateApiOptions {
     /**
@@ -56,6 +56,11 @@ export interface UploadApiOptions {
      * Whether to generate audio files for the API.
      */
     generateAudioFiles?: boolean;
+    /**
+     * Whether to generate the OpenAPI document for the API.
+     * Defaults to true.
+     */
+    generateOpenApiDocument?: boolean;
     /**
      * Whether to generate pretty-printed JSON files.
      */
@@ -72,6 +77,7 @@ export interface UploadApiOptions {
  * @param options The options to use for the upload.
  */
 export declare function uploadApiFilesFromDatabase(db: PrismaClient, dest: string, options: UploadApiFromDatabaseOptions): Promise<void>;
+export declare function uploadOpenApiDocument(dest: string, options: UploadApiFromDatabaseOptions): Promise<void>;
 /**
  * Generates the API files from the given datasets and uploads them to the specified destination.
  * @param dest The destination to upload the API files to. Supported destinations are S3, zip files, and local directories.

package/migrations/20260217200934_add_license_notice/migration.sql

@@ -0,0 +1,5 @@
+-- AlterTable
+ALTER TABLE "Commentary" ADD COLUMN "licenseNotice" TEXT;
+
+-- AlterTable
+ALTER TABLE "Translation" ADD COLUMN "licenseNotice" TEXT;

package/migrations/20260703000000_add_chapter_audio_timing/migration.sql

@@ -0,0 +1,13 @@
+-- CreateTable
+CREATE TABLE "ChapterAudioTiming" (
+    "number" INTEGER NOT NULL,
+    "bookId" TEXT NOT NULL,
+    "translationId" TEXT NOT NULL,
+    "reader" TEXT NOT NULL,
+    "timingsJson" TEXT NOT NULL,
+
+    PRIMARY KEY ("translationId", "bookId", "number", "reader"),
+    CONSTRAINT "ChapterAudioTiming_translationId_bookId_fkey" FOREIGN KEY ("translationId", "bookId") REFERENCES "Book" ("translationId", "id") ON DELETE RESTRICT ON UPDATE CASCADE,
+    CONSTRAINT "ChapterAudioTiming_translationId_fkey" FOREIGN KEY ("translationId") REFERENCES "Translation" ("id") ON DELETE RESTRICT ON UPDATE CASCADE,
+    CONSTRAINT "ChapterAudioTiming_translationId_bookId_number_fkey" FOREIGN KEY ("translationId", "bookId", "number") REFERENCES "Chapter" ("translationId", "bookId", "number") ON DELETE RESTRICT ON UPDATE CASCADE
+);

package/migrations/20260809000000_add_chapter_words/migration.sql

@@ -0,0 +1,12 @@
+-- CreateTable
+CREATE TABLE "ChapterWords" (
+    "number" INTEGER NOT NULL,
+    "bookId" TEXT NOT NULL,
+    "translationId" TEXT NOT NULL,
+    "wordsJson" TEXT NOT NULL,
+
+    PRIMARY KEY ("translationId", "bookId", "number"),
+    CONSTRAINT "ChapterWords_translationId_bookId_fkey" FOREIGN KEY ("translationId", "bookId") REFERENCES "Book" ("translationId", "id") ON DELETE RESTRICT ON UPDATE CASCADE,
+    CONSTRAINT "ChapterWords_translationId_fkey" FOREIGN KEY ("translationId") REFERENCES "Translation" ("id") ON DELETE RESTRICT ON UPDATE CASCADE,
+    CONSTRAINT "ChapterWords_translationId_bookId_number_fkey" FOREIGN KEY ("translationId", "bookId", "number") REFERENCES "Chapter" ("translationId", "bookId", "number") ON DELETE RESTRICT ON UPDATE CASCADE
+);

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@helloao/cli",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "A CLI and related tools for managing HelloAO's Free Bible API",
+  "type": "module",
   "main": "./dist/cjs/index.cjs",
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
@@ -23,27 +24,32 @@
   "author": "Kallyn Gowdy <kal@helloao.org>",
   "license": "MIT",
   "dependencies": {
-    "commander": "12.1.0",
-    "@gracious.tech/fetch-client": "^0.7.0",
-    "prisma": "^5.12.1",
-    "@prisma/client": "^5.12.1",
-    "better-sqlite3": "^9.5.0",
-    "fs-extra": "^11.2.0",
-    "lodash": "4.17.21",
-    "linkedom": "0.18.4",
-    "base64-js": "1.5.1",
-    "hash.js": "1.1.7",
-    "@zip.js/zip.js": "^2.6.40",
     "@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",
+    "@gracious.tech/fetch-client": "^0.7.0",
+    "@hey-api/openapi-ts": "^0.97.1",
     "@inquirer/prompts": "5.3.8",
+    "@prisma/client": "^7.8.0",
+    "@prisma/adapter-better-sqlite3": "^7.8.0",
+    "@smithy/config-resolver": "^3.0.10",
+    "@smithy/node-config-provider": "^3.1.9",
+    "@smithy/types": "^3.3.0",
+    "@zip.js/zip.js": "^2.6.40",
     "all-iso-language-codes": "1.0.17",
-    "papaparse": "5.4.1",
+    "base64-js": "1.5.1",
+    "better-sqlite3": "^13.0.3",
+    "commander": "12.1.0",
+    "fs-extra": "^11.2.0",
+    "hash.js": "1.1.7",
+    "linkedom": "0.18.4",
+    "es-toolkit": "1.46.1",
     "luxon": "3.5.0",
-    "@helloao/tools": "0.1.0"
+    "papaparse": "5.4.1",
+    "prisma": "^7.8.0",
+    "typesense": "3.0.5",
+    "zod": "^4.4.3",
+    "zod-openapi": "5.4.6",
+    "@helloao/tools": "0.3.0"
   },
   "files": [
     "/README.md",

package/schema.prisma

@@ -1,10 +1,9 @@
 datasource db {
     provider = "sqlite"
-    url      = "file:../../bible-api.dev.db"
 }
 
 generator client {
-    provider = "prisma-client-js"
+    provider = "prisma-client"
     output   = "./prisma-gen"
 }
 
@@ -14,6 +13,7 @@ model Translation {
     website       String
     licenseUrl    String
     licenseNotes  String?
+    licenseNotice String?
     shortName     String?
     englishName   String
     language      String
@@ -28,6 +28,8 @@ model Translation {
     verses       ChapterVerse[]
     footnotes    ChapterFootnote[]
     audioUrls    ChapterAudioUrl[]
+    audioTimings ChapterAudioTiming[]
+    words        ChapterWords[]
 }
 
 model Commentary {
@@ -36,6 +38,7 @@ model Commentary {
     website       String
     licenseUrl    String
     licenseNotes  String?
+    licenseNotice String?
     englishName   String
     language      String
     textDirection String
@@ -148,6 +151,8 @@ model Book {
     verses ChapterVerse[]
     footnotes ChapterFootnote[]
     audioUrls ChapterAudioUrl[]
+    audioTimings ChapterAudioTiming[]
+    words ChapterWords[]
 
     @@id([translationId, id])
 }
@@ -215,6 +220,8 @@ model Chapter {
     verses ChapterVerse[]
     footnotes ChapterFootnote[]
     audioUrls ChapterAudioUrl[]
+    audioTimings ChapterAudioTiming[]
+    words ChapterWords[]
 
     @@id([translationId, bookId, number])
 }
@@ -255,6 +262,40 @@ model ChapterAudioUrl {
     @@id([translationId, bookId, number, reader])
 }
 
+model ChapterAudioTiming {
+    number Int
+    bookId String
+    book Book @relation(fields: [translationId, bookId], references: [translationId, id])
+
+    translationId String
+    translation Translation @relation(fields: [translationId], references: [id])
+
+    chapter Chapter @relation(fields: [translationId, bookId, number], references: [translationId, bookId, number])
+
+    reader String
+
+    // JSON array of numbers: the time (in seconds) that each verse starts, in verse order.
+    timingsJson String
+
+    @@id([translationId, bookId, number, reader])
+}
+
+model ChapterWords {
+    number Int
+    bookId String
+    book Book @relation(fields: [translationId, bookId], references: [translationId, id])
+
+    translationId String
+    translation Translation @relation(fields: [translationId], references: [id])
+
+    chapter Chapter @relation(fields: [translationId, bookId, number], references: [translationId, bookId, number])
+
+    // JSON object that maps a verse number to the list of annotated words in the verse.
+    wordsJson String
+
+    @@id([translationId, bookId, number])
+}
+
 model ChapterVerse {
     number Int
 

package/prisma-gen/client.d.ts

@@ -1 +0,0 @@
-export * from "./index"

package/prisma-gen/client.js

@@ -1,4 +0,0 @@
-
-/* !!! This is code generated by Prisma. Do not edit directly. !!!
-/* eslint-disable */
-module.exports = { ...require('.') }

package/prisma-gen/default.d.ts

@@ -1 +0,0 @@
-export * from "./index"

package/prisma-gen/default.js

@@ -1 +0,0 @@
-module.exports = { ...require('.') }

package/prisma-gen/edge.d.ts

@@ -1 +0,0 @@
-export * from "./default"