@livestore/wa-sqlite 1.0.1-dev.0 → 1.0.1-dev.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livestore/wa-sqlite",
-  "version": "1.0.1-dev.0",
+  "version": "1.0.1-dev.10",
   "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'));

package/src/types/globals.d.ts

@@ -1,6 +1,6 @@
-declare namespace Asyncify {
-  function handleAsync(f: () => Promise<any>);
-}
+// declare namespace Asyncify {
+//   function handleAsync(f: () => Promise<any>);
+// }
 
 declare function UTF8ToString(ptr: number): string;
 declare function lengthBytesUTF8(s: string): number;

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;
 
@@ -151,14 +151,14 @@ declare interface SQLitePrepareOptions {
  * 
  * ```javascript
  * // Import an ES6 module factory function from one of the
- * // package builds, either 'wa-sqlite.mjs' (synchronous) or
- * // 'wa-sqlite-async.mjs' (asynchronous). You should only
+ * // package builds, either '@livestore/wa-sqlite.mjs' (synchronous) or
+ * // '@livestore/wa-sqlite-async.mjs' (asynchronous). You should only
  * // use the asynchronous build if you plan to use an
  * // asynchronous VFS or module.
- * import SQLiteESMFactory from 'wa-sqlite/dist/wa-sqlite.mjs';
+ * import SQLiteESMFactory from '@livestore/wa-sqlite/dist/wa-sqlite.mjs';
  * 
  * // Import the Javascript API wrappers.
- * import * as SQLite from 'wa-sqlite';
+ * import * as SQLite from '@livestore/wa-sqlite';
  * 
  * // Use an async function to simplify Promise handling.
  * (async function() {
@@ -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): ReadonlyArray<number>;
 
   /**
    * Evaluate an SQL statement
@@ -822,8 +857,13 @@ 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 'wa-sqlite/src/sqlite-constants.js' {
+declare module '@livestore/wa-sqlite/src/sqlite-constants.js' {
   export const SQLITE_OK: 0;
   export const SQLITE_ERROR: 1;
   export const SQLITE_INTERNAL: 2;
@@ -1058,8 +1098,8 @@ declare module 'wa-sqlite/src/sqlite-constants.js' {
   export const SQLITE_PREPARE_NO_VTAB: 0x04;
 }
 
-declare module 'wa-sqlite' {
-  export * from 'wa-sqlite/src/sqlite-constants.js';
+declare module '@livestore/wa-sqlite' {
+  export * from '@livestore/wa-sqlite/src/sqlite-constants.js';
 
   /**
    * @ignore
@@ -1078,22 +1118,23 @@ declare module 'wa-sqlite' {
 }
 
 /** @ignore */
-declare module 'wa-sqlite/dist/wa-sqlite.mjs' {
+declare module '@livestore/wa-sqlite/dist/wa-sqlite.mjs' {
   function ModuleFactory(config?: object): Promise<any>;
   export = ModuleFactory;
 }
 
 /** @ignore */
-declare module 'wa-sqlite/dist/wa-sqlite-async.mjs' {
+declare module '@livestore/wa-sqlite/dist/wa-sqlite-async.mjs' {
   function ModuleFactory(config?: object): Promise<any>;
   export = ModuleFactory;
 }
 
 /** @ignore */
-declare module 'wa-sqlite/src/VFS.js' {
-  export * from 'wa-sqlite/src/sqlite-constants.js';
+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 '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 'wa-sqlite/src/examples/IndexedDbVFS.js' {
-  import * as VFS from "wa-sqlite/src/VFS.js";
+declare module '@livestore/wa-sqlite/src/examples/IndexedDbVFS.js' {
+  import * as VFS from "@livestore/wa-sqlite/src/VFS.js";
   export class IndexedDbVFS extends VFS.Base {
     /**
      * @param {string} idbName Name of IndexedDB database.
@@ -1260,8 +1308,8 @@ declare module 'wa-sqlite/src/examples/IndexedDbVFS.js' {
 }
 
 /** @ignore */
-declare module 'wa-sqlite/src/examples/MemoryVFS.js' {
-  import * as VFS from "wa-sqlite/src/VFS.js";
+declare module '@livestore/wa-sqlite/src/examples/MemoryVFS.js' {
+  import * as VFS from "@livestore/wa-sqlite/src/VFS.js";
   /** @ignore */
   export class MemoryVFS extends VFS.Base {
     name: string;
@@ -1271,14 +1319,14 @@ declare module 'wa-sqlite/src/examples/MemoryVFS.js' {
 }
 
 /** @ignore */
-declare module 'wa-sqlite/src/examples/MemoryAsyncVFS.js' {
-  import { MemoryVFS } from "wa-sqlite/src/examples/MemoryVFS.js";
+declare module '@livestore/wa-sqlite/src/examples/MemoryAsyncVFS.js' {
+  import { MemoryVFS } from "@livestore/wa-sqlite/src/examples/MemoryVFS.js";
   export class MemoryAsyncVFS extends MemoryVFS {
   }
 }
 
 /** @ignore */
-declare module 'wa-sqlite/src/examples/tag.js' {
+declare module '@livestore/wa-sqlite/src/examples/tag.js' {
   /**
    * @ignore
    * Template tag builder. This function creates a tag with an API and