zerobucket 0.6.1 → 0.8.0

package/dist/{client-C7xs1dlr.d.cts → client-XQ22b1l3.d.cts}

@@ -77,8 +77,30 @@ interface SqliteDatabaseLike {
     };
     exec(sql: string): unknown;
 }
-/** What `connection` accepts: a `pg` client for the Postgres backend, a `better-sqlite3` Database for SQLite. */
-type Connection = Queryable | SqliteDatabaseLike;
+/**
+ * A `mysql2/promise` connection (or pool connection): both `query()` and `execute()` resolve to
+ * `[rowsOrResultHeader, fields]`. Pass one as `connection` to make a call part of YOUR MySQL/MariaDB
+ * transaction. Declared structurally so consumers do not need `mysql2` installed to type-check.
+ */
+interface MysqlQueryable {
+    query(sql: string, values?: any): Promise<[any, any]>;
+    execute(sql: string, values?: any): Promise<[any, any]>;
+}
+/** The slice of a `mysql2/promise` pool connection that the MySQL backend uses. */
+interface MysqlPoolConnectionLike extends MysqlQueryable {
+    beginTransaction(): Promise<void>;
+    commit(): Promise<void>;
+    rollback(): Promise<void>;
+    release(): void;
+    destroy(): void;
+}
+/** The slice of a `mysql2/promise` Pool that the MySQL backend uses (bring your own via `pool`). */
+interface MysqlPoolLike {
+    getConnection(): Promise<MysqlPoolConnectionLike>;
+    end(): Promise<void>;
+}
+/** What `connection` accepts: a `pg` client for Postgres, a `better-sqlite3` Database for SQLite, a `mysql2/promise` connection for MySQL/MariaDB. */
+type Connection = Queryable | SqliteDatabaseLike | MysqlQueryable;
 /** The row shape a storage backend persists (after validation and checksumming). */
 interface PreparedRow {
     data: Buffer;
@@ -314,7 +336,17 @@ interface ZeroBucketOptions<C = unknown> {
      * package's SQLiteBackend, so both can share one `.db` file.
      */
     sqlite?: string;
-    /** Advanced: inject a custom StorageBackend instead of building one from `connectionString` / `pool` / `sqlite`. */
+    /**
+     * Use MySQL or MariaDB instead of PostgreSQL: `mysql://user:password@host:3306/database`
+     * (`mariadb://` works too). Needs `npm install mysql2`. Same schema as the Python package's
+     * MySQLBackend, so both can share one database. Classic mode only for now (`dedup` is not
+     * available for MySQL yet). `maxRetries`, `retryBaseDelayMs`, `poolMaxSize`, `poolTimeoutMs`,
+     * `autoMigrate`, `objectStorage` and `onOperation` apply to it too.
+     */
+    mysql?: string;
+    /** Bring your own `mysql2/promise` Pool for MySQL/MariaDB. It is NOT closed by close(). */
+    mysqlPool?: MysqlPoolLike;
+    /** Advanced: inject a custom StorageBackend instead of building one from `connectionString` / `pool` / `sqlite` / `mysql`. */
     backend?: StorageBackend;
     /** Max accepted size in bytes. Default 8 MiB. */
     maxBytes?: number;
@@ -470,4 +502,4 @@ declare function readInput(image: ImageInput, filename: string | undefined, maxB
     filename: string | undefined;
 }>;
 
-export { type BatchDeleteResult as B, type CallOptions as C, DEFAULT_MAX_BYTES as D, type GetOptions as G, type ImageListOptions as I, type OperationEvent as O, type PreparedRow as P, type Queryable as Q, type StorageBackend as S, type ValidatedContent as V, type WritableLike as W, ZeroBucket as Z, type ObjectStorageLike as a, type StoredRecord as b, type StoredRecordMetadata as c, type StreamOptions$1 as d, type StorageInfo as e, type ImageListEntry as f, type ContentValidator as g, type BatchGetResult as h, type BatchPutResult as i, type BeforeGetHook as j, type BeforePutHook as k, type Connection as l, type Image as m, type ImageInput as n, type ImageMetadata as o, ObjectStorage as p, type ObjectStorageOptions as q, type OptimizationResult as r, type OptimizeOptions as s, type PutManyOptions as t, type PutOptions as u, type SqliteDatabaseLike as v, type StreamOptions as w, type ZeroBucketOptions as x, optimizeImage as y, readInput as z };
+export { optimizeImage as A, type BatchDeleteResult as B, type CallOptions as C, DEFAULT_MAX_BYTES as D, readInput as E, type GetOptions as G, type ImageListOptions as I, type MysqlPoolLike as M, type OperationEvent as O, type PreparedRow as P, type Queryable as Q, type StorageBackend as S, type ValidatedContent as V, type WritableLike as W, ZeroBucket as Z, type ObjectStorageLike as a, type StoredRecord as b, type StoredRecordMetadata as c, type StreamOptions$1 as d, type StorageInfo as e, type ImageListEntry as f, type ContentValidator as g, type BatchGetResult as h, type BatchPutResult as i, type BeforeGetHook as j, type BeforePutHook as k, type Connection as l, type Image as m, type ImageInput as n, type ImageMetadata as o, type MysqlPoolConnectionLike as p, type MysqlQueryable as q, ObjectStorage as r, type ObjectStorageOptions as s, type OptimizationResult as t, type OptimizeOptions as u, type PutManyOptions as v, type PutOptions as w, type SqliteDatabaseLike as x, type StreamOptions as y, type ZeroBucketOptions as z };

package/dist/{client-C7xs1dlr.d.ts → client-XQ22b1l3.d.ts}

@@ -77,8 +77,30 @@ interface SqliteDatabaseLike {
     };
     exec(sql: string): unknown;
 }
-/** What `connection` accepts: a `pg` client for the Postgres backend, a `better-sqlite3` Database for SQLite. */
-type Connection = Queryable | SqliteDatabaseLike;
+/**
+ * A `mysql2/promise` connection (or pool connection): both `query()` and `execute()` resolve to
+ * `[rowsOrResultHeader, fields]`. Pass one as `connection` to make a call part of YOUR MySQL/MariaDB
+ * transaction. Declared structurally so consumers do not need `mysql2` installed to type-check.
+ */
+interface MysqlQueryable {
+    query(sql: string, values?: any): Promise<[any, any]>;
+    execute(sql: string, values?: any): Promise<[any, any]>;
+}
+/** The slice of a `mysql2/promise` pool connection that the MySQL backend uses. */
+interface MysqlPoolConnectionLike extends MysqlQueryable {
+    beginTransaction(): Promise<void>;
+    commit(): Promise<void>;
+    rollback(): Promise<void>;
+    release(): void;
+    destroy(): void;
+}
+/** The slice of a `mysql2/promise` Pool that the MySQL backend uses (bring your own via `pool`). */
+interface MysqlPoolLike {
+    getConnection(): Promise<MysqlPoolConnectionLike>;
+    end(): Promise<void>;
+}
+/** What `connection` accepts: a `pg` client for Postgres, a `better-sqlite3` Database for SQLite, a `mysql2/promise` connection for MySQL/MariaDB. */
+type Connection = Queryable | SqliteDatabaseLike | MysqlQueryable;
 /** The row shape a storage backend persists (after validation and checksumming). */
 interface PreparedRow {
     data: Buffer;
@@ -314,7 +336,17 @@ interface ZeroBucketOptions<C = unknown> {
      * package's SQLiteBackend, so both can share one `.db` file.
      */
     sqlite?: string;
-    /** Advanced: inject a custom StorageBackend instead of building one from `connectionString` / `pool` / `sqlite`. */
+    /**
+     * Use MySQL or MariaDB instead of PostgreSQL: `mysql://user:password@host:3306/database`
+     * (`mariadb://` works too). Needs `npm install mysql2`. Same schema as the Python package's
+     * MySQLBackend, so both can share one database. Classic mode only for now (`dedup` is not
+     * available for MySQL yet). `maxRetries`, `retryBaseDelayMs`, `poolMaxSize`, `poolTimeoutMs`,
+     * `autoMigrate`, `objectStorage` and `onOperation` apply to it too.
+     */
+    mysql?: string;
+    /** Bring your own `mysql2/promise` Pool for MySQL/MariaDB. It is NOT closed by close(). */
+    mysqlPool?: MysqlPoolLike;
+    /** Advanced: inject a custom StorageBackend instead of building one from `connectionString` / `pool` / `sqlite` / `mysql`. */
     backend?: StorageBackend;
     /** Max accepted size in bytes. Default 8 MiB. */
     maxBytes?: number;
@@ -470,4 +502,4 @@ declare function readInput(image: ImageInput, filename: string | undefined, maxB
     filename: string | undefined;
 }>;
 
-export { type BatchDeleteResult as B, type CallOptions as C, DEFAULT_MAX_BYTES as D, type GetOptions as G, type ImageListOptions as I, type OperationEvent as O, type PreparedRow as P, type Queryable as Q, type StorageBackend as S, type ValidatedContent as V, type WritableLike as W, ZeroBucket as Z, type ObjectStorageLike as a, type StoredRecord as b, type StoredRecordMetadata as c, type StreamOptions$1 as d, type StorageInfo as e, type ImageListEntry as f, type ContentValidator as g, type BatchGetResult as h, type BatchPutResult as i, type BeforeGetHook as j, type BeforePutHook as k, type Connection as l, type Image as m, type ImageInput as n, type ImageMetadata as o, ObjectStorage as p, type ObjectStorageOptions as q, type OptimizationResult as r, type OptimizeOptions as s, type PutManyOptions as t, type PutOptions as u, type SqliteDatabaseLike as v, type StreamOptions as w, type ZeroBucketOptions as x, optimizeImage as y, readInput as z };
+export { optimizeImage as A, type BatchDeleteResult as B, type CallOptions as C, DEFAULT_MAX_BYTES as D, readInput as E, type GetOptions as G, type ImageListOptions as I, type MysqlPoolLike as M, type OperationEvent as O, type PreparedRow as P, type Queryable as Q, type StorageBackend as S, type ValidatedContent as V, type WritableLike as W, ZeroBucket as Z, type ObjectStorageLike as a, type StoredRecord as b, type StoredRecordMetadata as c, type StreamOptions$1 as d, type StorageInfo as e, type ImageListEntry as f, type ContentValidator as g, type BatchGetResult as h, type BatchPutResult as i, type BeforeGetHook as j, type BeforePutHook as k, type Connection as l, type Image as m, type ImageInput as n, type ImageMetadata as o, type MysqlPoolConnectionLike as p, type MysqlQueryable as q, ObjectStorage as r, type ObjectStorageOptions as s, type OptimizationResult as t, type OptimizeOptions as u, type PutManyOptions as v, type PutOptions as w, type SqliteDatabaseLike as x, type StreamOptions as y, type ZeroBucketOptions as z };

package/dist/http.d.cts

@@ -1,5 +1,5 @@
 import { IncomingMessage, ServerResponse } from 'node:http';
-import { Z as ZeroBucket } from './client-C7xs1dlr.cjs';
+import { Z as ZeroBucket } from './client-XQ22b1l3.cjs';
 import 'pg';
 
 /**

package/dist/http.d.ts

@@ -1,5 +1,5 @@
 import { IncomingMessage, ServerResponse } from 'node:http';
-import { Z as ZeroBucket } from './client-C7xs1dlr.js';
+import { Z as ZeroBucket } from './client-XQ22b1l3.js';
 import 'pg';
 
 /**