@helloao/cli 0.0.18 → 0.0.19

package/dist/types/uploads.d.ts

@@ -0,0 +1,96 @@
+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.
+     */
+    batchSize: string | number;
+}
+export interface UploadApiOptions {
+    /**
+     * Whether to overwrite existing files.
+     */
+    overwrite?: boolean;
+    /**
+     * Whether to only overwrite common files.
+     * "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.
+     */
+    filePattern?: string;
+    /**
+     * The translations to generate API files for.
+     */
+    translations?: string[];
+    /**
+     * The AWS profile to use for uploading to S3.
+     */
+    profile?: string;
+    /**
+     * The AWS access key ID to use for uploading to S3.
+     */
+    accessKeyId?: string;
+    /**
+     * The AWS secret access key to use for uploading to S3.
+     */
+    secretAccessKey?: string;
+    /**
+     * The AWS region to use for uploading to S3.
+     */
+    s3Region?: string;
+    /**
+     * Whether to generate API files that use the common name instead of book IDs.
+     */
+    useCommonName?: boolean;
+    /**
+     * Whether to generate audio files for the API.
+     */
+    generateAudioFiles?: boolean;
+    /**
+     * 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.
+ * @param db The database that the datasets should be loaded from.
+ * @param dest The destination to upload the API files to. Supported destinations are S3, zip files, and local directories.
+ * @param options The options to use for the upload.
+ */
+export declare function uploadApiFilesFromDatabase(db: PrismaClient, 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.
+ * @param options The options to use for the upload.
+ * @param datasets The datasets to generate the API files from.
+ */
+export declare function serializeAndUploadDatasets(dest: string, datasets: AsyncIterable<DatasetOutput>, options?: UploadApiOptions & GenerateApiOptions): Promise<void>;
+/**
+ * Uploads the given serialized files to the specified destination.
+ * @param dest The destination to upload the API files to. Supported destinations are S3, zip files, and local directories.
+ * @param options The options to use for the upload.
+ * @param datasets The datasets to generate the API files from.
+ */
+export declare function uploadFiles(dest: string, options: UploadApiOptions, serializedFiles: AsyncIterable<SerializedFile[]>): Promise<void>;
+/**
+ * Uploads the given serialized files using the given uploader.
+ * @param uploader The uploader to use.
+ * @param options The options to use for the upload.
+ * @param datasets The datasets to generate the API files from.
+ */
+export declare function uploadFilesUsingUploader(uploader: Uploader, options: UploadApiOptions, serializedFiles: AsyncIterable<SerializedFile[]>): Promise<void>;
+//# sourceMappingURL=uploads.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helloao/cli",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "description": "A CLI and related tools for managing HelloAO's Free Bible API",
   "main": "./dist/cjs/index.cjs",
   "module": "./dist/esm/index.js",
@@ -43,7 +43,7 @@
     "all-iso-language-codes": "1.0.17",
     "papaparse": "5.4.1",
     "luxon": "3.5.0",
-    "@helloao/tools": "0.0.18"
+    "@helloao/tools": "0.0.19"
   },
   "files": [
     "/README.md",