web-sqlite-js 1.0.10 → 1.1.0

package/README.md

@@ -66,7 +66,7 @@ For quick demos or plain HTML pages you can load the prebuilt module directly:
 
 ```html
 <script type="module">
-    import openDB from "https://cdn.jsdelivr.net/npm/web-sqlite-js@1.0.10/dist/index.js";
+    import openDB from "https://cdn.jsdelivr.net/npm/web-sqlite-js@1.0.9/dist/index.js";
     // ...
 </script>
 ```

package/dist/index.d.ts

@@ -21,8 +21,21 @@ declare interface DBInterface {
     transaction<T>(fn: transactionCallback<T>): Promise<T>;
     /** Close the database and release resources. */
     close(): Promise<void>;
+    /** Dev tooling APIs for release testing. */
+    devTool: DevTool;
 }
 
+declare type DevTool = {
+    /**
+     * Create a new dev version using migration and seed SQL.
+     */
+    release(input: ReleaseConfig): Promise<void>;
+    /**
+     * Roll back to a target version and remove dev versions above it.
+     */
+    rollback(version: string): Promise<void>;
+};
+
 /**
  * Metadata returned for non-query statements.
  * @property changes Number of rows changed by last operation (may be bigint on some builds).
@@ -34,14 +47,41 @@ declare type ExecResult = {
 };
 
 /**
- * PUBLIC API (Client End)
- * Opens a SQLite database connection.
+ * Opens a SQLite database connection with release-versioning support.
+ *
+ * @param filename - The base database name (directory is created in OPFS).
+ * @param options - Optional release configuration and debug flag.
+ * @returns A DBInterface for the latest active version.
+ *
+ * @throws Error if the filename is invalid, release config is invalid,
+ * or an archived release hash does not match.
  */
-declare const openDB: (filename: string, options?: WorkerOpenDBOptions) => Promise<DBInterface>;
+declare const openDB: (filename: string, options?: OpenDBOptions) => Promise<DBInterface>;
 export default openDB;
-export { openDB as open }
 export { openDB }
 
+/**
+ * Options for opening a database.
+ */
+declare type OpenDBOptions = {
+    /** Immutable release history configuration. */
+    releases?: ReleaseConfig[];
+    /** Enable SQL timing logs in the worker. */
+    debug?: boolean;
+};
+
+/**
+ * Release configuration entry for versioned migrations.
+ */
+declare type ReleaseConfig = {
+    /** Semantic version string "x.x.x" (no leading zeros). */
+    version: string;
+    /** Migration SQL to apply for this version. */
+    migrationSQL: string;
+    /** Optional seed SQL to apply after migration. */
+    seedSQL?: string | null;
+};
+
 /** A bindable parameter collection: positional or named. */
 declare type SQLParams = SqlValue[] | Record<string, SqlValue>;
 
@@ -52,8 +92,4 @@ declare type SqlValue = null | number | string | boolean | bigint | Uint8Array |
 
 declare type transactionCallback<T> = (db: Pick<DBInterface, "exec" | "query">) => Promise<T>;
 
-declare type WorkerOpenDBOptions = {
-    debug?: boolean;
-};
-
 export { }