@livestore/wa-sqlite 1.0.1-dev.1 → 1.0.1-dev.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livestore/wa-sqlite",
-  "version": "1.0.1-dev.1",
+  "version": "1.0.1-dev.11",
   "type": "module",
   "main": "src/sqlite-api.js",
   "types": "src/types/index.d.ts",

package/src/sqlite-api.js

@@ -237,6 +237,31 @@ export function Factory(Module) {
     };
   })();
 
+  sqlite3.deserialize = (function() {
+    const fname = 'sqlite3_deserialize';
+    const f = Module.cwrap(fname, ...decl('nnnnnn:n'));
+    return function(db, schema, data, szDb, szBuf, flags) {
+      verifyDatabase(db);
+      const ptr = Module._sqlite3_malloc(szDb);
+      Module.HEAPU8.subarray(ptr).set(data);
+      const result = f(db, schema, ptr, szDb, szBuf, flags);
+      return result;
+    };
+  })();
+
+  sqlite3.serialize = (function() {
+    const fname = 'sqlite3_serialize';
+    const f = Module.cwrap(fname, ...decl('nsnn:n'));
+    return function(db, schema, piSize, flags) {
+      verifyDatabase(db);
+      // TODO alloc + free memory for result?
+      const address = f(db, schema, piSize, flags);
+      const result = Module.HEAPU8.subarray(address, address + piSize);
+
+      return result;
+    };
+  })();
+
   sqlite3.clear_bindings = (function() {
     const fname = 'sqlite3_clear_bindings';
     const f = Module.cwrap(fname, ...decl('n:n'));
@@ -433,7 +458,8 @@ export function Factory(Module) {
   //   return SQLite.SQLITE_OK;
   // };
   sqlite3.exec = function(db, sql, callback) {
-    for (const stmt of sqlite3.statements(db, sql)) {
+    const { stmts, finalize } = sqlite3.statements(db, sql);
+    for (const stmt of stmts) {
       let columns;
       while (sqlite3.step(stmt) === SQLite.SQLITE_ROW) {
         if (callback) {
@@ -443,6 +469,7 @@ export function Factory(Module) {
         }
       }
     }
+    finalize();
     return SQLite.SQLITE_OK;
   };
 
@@ -677,10 +704,10 @@ export function Factory(Module) {
       // { async: true });
       { async: false });
 
-      const results = [];
+      const stmts = [];
 
       const onFinally = [];
-      try {
+      // try {
         // Encode SQL string to UTF-8.
         const utf8 = new TextEncoder().encode(sql);
 
@@ -742,16 +769,22 @@ export function Factory(Module) {
           if (stmt) {
             mapStmtToDB.set(stmt, db);
             // yield stmt;
-            results.push(stmt);
+            stmts.push(stmt);
           }
         } while (stmt);
-      } finally {
+      // } finally {
+      //   while (onFinally.length) {
+      //     onFinally.pop()();
+      //   }
+      // }
+
+      const finalize = () => {
         while (onFinally.length) {
           onFinally.pop()();
         }
       }
 
-      return results;
+      return { stmts, finalize };
   };
 
   sqlite3.step = (function() {

package/src/types/index.d.ts

@@ -33,7 +33,7 @@ type SQLiteCompatibleType = number|string|Uint8Array|Array<number>|bigint|null;
  * @see https://sqlite.org/vfs.html
  * @see https://sqlite.org/c3ref/io_methods.html
  */
-declare interface SQLiteVFS {
+interface SQLiteVFS {
   /** Maximum length of a file path in UTF-8 bytes (default 64) */
   mxPathName?: number;
 
@@ -117,11 +117,11 @@ declare interface SQLiteVFS {
 }
 
 /**
- * Options object argument for {@link SQLiteAPI.statements}
+ * Options object argument for {@link SQLiteAPI['statements']}
  */
 declare interface SQLitePrepareOptions {
   /**
-   * Statement handles prepared and yielded by {@link SQLiteAPI.statements}
+   * Statement handles prepared and yielded by {@link SQLiteAPI['statements']}
    * are normally valid only within the scope of an iteration.
    * Set `unscoped` to `true` to give iterated statements an arbitrary
    * lifetime.
@@ -178,7 +178,7 @@ declare interface SQLitePrepareOptions {
  * 
  * @see https://sqlite.org/c3ref/funclist.html
  */
-declare interface SQLiteAPI {
+interface SQLiteAPI {
   /**
    * Bind a collection of values to a statement
    * 
@@ -330,6 +330,41 @@ declare interface SQLiteAPI {
    */
   changes(db): number;
 
+  /**
+   * https://www.sqlite.org/c3ref/deserialize.html
+   * int sqlite3_deserialize(
+   *   sqlite3 *db,            The database connection
+   *   const char *zSchema,    Which DB to reopen with the deserialization
+   *   unsigned char *pData,   The serialized database content
+   *   sqlite3_int64 szDb,     Number bytes in the deserialization
+   *   sqlite3_int64 szBuf,    Total size of buffer pData[]
+   *   unsigned mFlags         Zero or more SQLITE_DESERIALIZE_* flags
+   * );
+   */
+  deserialize(
+    db: number,
+    zSchema: string,
+    pData: Uint8Array,
+    szDb: number,
+    szBuf: number,
+    mFlags: number
+  ): number;
+
+  /**
+   * unsigned char *sqlite3_serialize(
+   *  sqlite3 *db,           The database connection
+   *  const char *zSchema,   Which DB to serialize. ex: "main", "temp", ...
+   *  sqlite3_int64 *piSize, Write size of the DB here, if not NULL
+   *  unsigned int mFlags    Zero or more SQLITE_SERIALIZE_* flags
+   * );
+   */
+  serialize(
+    db: number,
+    zSchema: string,
+    piSize: number,
+    mFlags: number
+  ): Uint8Array;
+
   /**
    * Reset all bindings on a prepared statement.
    * @see https://www.sqlite.org/c3ref/clear_bindings.html
@@ -576,7 +611,7 @@ declare interface SQLiteAPI {
     zFilename: string,
     iFlags?: number,
     zVfs?: string    
-  ): Promise<number>;
+  ): number;
 
   /**
    * Specify callback to be invoked between long-running queries
@@ -596,9 +631,9 @@ declare interface SQLiteAPI {
    * Reset a prepared statement object
    * @see https://www.sqlite.org/c3ref/reset.html
    * @param stmt prepared statement pointer
-   * @returns Promise-wrapped `SQLITE_OK` (rejects on error)
+   * @returns `SQLITE_OK` (rejects on error)
    */
-  reset(stmt: number): Promise<number>;
+  reset(stmt: number): number;
 
   /**
    * Convenience function to call `result_*` based of the type of `value`
@@ -725,7 +760,7 @@ declare interface SQLiteAPI {
    * @param options
    */
   // statements(db: number, sql: string, options?: SQLitePrepareOptions): AsyncIterable<number>;
-  statements(db: number, sql: string, options?: SQLitePrepareOptions): Iterable<number>;
+  statements(db: number, sql: string, options?: SQLitePrepareOptions): { stmts: ReadonlyArray<number>; finalize: () => void; };
 
   /**
    * Evaluate an SQL statement
@@ -822,6 +857,11 @@ declare interface SQLiteAPI {
   vfs_register(vfs: SQLiteVFS, makeDefault?: boolean): number;
 }
 
+declare module '@livestore/wa-sqlite' {
+  export type SQLiteAPI_ = SQLiteAPI;
+  export type SQLiteVFS_ = SQLiteVFS;
+}
+
 /** @ignore */
 declare module '@livestore/wa-sqlite/src/sqlite-constants.js' {
   export const SQLITE_OK: 0;
@@ -1094,6 +1134,7 @@ declare module '@livestore/wa-sqlite/src/VFS.js' {
   export * from '@livestore/wa-sqlite/src/sqlite-constants.js';
 
   export class Base {
+    name: string;
     mxPathName: number;
     /**
      * @param {number} fileId
@@ -1205,9 +1246,16 @@ declare module '@livestore/wa-sqlite/src/VFS.js' {
   }
 }
 
+declare module '@livestore/wa-sqlite/src/examples/AccessHandlePoolVFS.js' {
+  import * as VFS from "@livestore/wa-sqlite/src/VFS.js";
+  export class AccessHandlePoolVFS extends VFS.Base {
+    constructor(name: string, module: any)
+  }
+}
+
 /** @ignore */
 declare module '@livestore/wa-sqlite/src/examples/IndexedDbVFS.js' {
-  import * as VFS from "wa-sqlite/src/VFS.js";
+  import * as VFS from "@livestore/wa-sqlite/src/VFS.js";
   export class IndexedDbVFS extends VFS.Base {
     /**
      * @param {string} idbName Name of IndexedDB database.
@@ -1261,7 +1309,7 @@ declare module '@livestore/wa-sqlite/src/examples/IndexedDbVFS.js' {
 
 /** @ignore */
 declare module '@livestore/wa-sqlite/src/examples/MemoryVFS.js' {
-  import * as VFS from "wa-sqlite/src/VFS.js";
+  import * as VFS from "@livestore/wa-sqlite/src/VFS.js";
   /** @ignore */
   export class MemoryVFS extends VFS.Base {
     name: string;
@@ -1272,7 +1320,7 @@ declare module '@livestore/wa-sqlite/src/examples/MemoryVFS.js' {
 
 /** @ignore */
 declare module '@livestore/wa-sqlite/src/examples/MemoryAsyncVFS.js' {
-  import { MemoryVFS } from "wa-sqlite/src/examples/MemoryVFS.js";
+  import { MemoryVFS } from "@livestore/wa-sqlite/src/examples/MemoryVFS.js";
   export class MemoryAsyncVFS extends MemoryVFS {
   }
 }