Bump version, update typings and refactor browser extensions

Author: jvail

README.md

@@ -146,7 +146,7 @@ options:
 
 ### `.version`() -> `VersionInfo`
 
-Returns an object with version strings for all bundled libraries: `spatialite`, `sqlite`, `geos`, `proj`, `rttopo`, `spl.js`.
+Returns an object with version strings for all bundled libraries: `spatialite`, `sqlite`, `geos`, `proj`, `rttopo`, `spl`.
 
 ### `.terminate`()
 
@@ -258,42 +258,56 @@ Free result memory. Called automatically after accessing result properties, but
 
 Sometimes you want to run code inside the WebWorker. With this API you can supply additional functions to extend the `SPL` and `DB` APIs executed inside the WebWorker.
 
+Extension functions are available via the `ex` namespace: `db.ex.myFn()` and `spl.ex.myFn()`.
+
 Example: https://jvail.github.io/spl.js/examples/extensions.html
 
+### TypeScript Types
+
+Two extension types are available:
+
+- `DbExtension` - extends the database API, functions receive `DbSync` as first argument
+- `SplExtension` - extends the SPL API, functions receive `SplSync` as first argument
+
+```ts
+import type { DbExtension, SplExtension } from 'spl.js';
+```
+
 ### Example Code
 
 ```js
-const extensions = [
-    {
-        extends: 'db',
-        fns: {
-            'tables': db => db.exec('SELECT name FROM sqlite_master WHERE type=\'table\''),
-            'master': (db, type) => db.exec('SELECT name FROM sqlite_master WHERE type=?', [type])
-        }
-    },
-    {
-        extends: 'spl',
-        fns: {
-            'spatialite_version': spl => {
-                const db = spl.db();
-                const version = db.exec('SELECT spatialite_version()').get.first;
-                db.close();
-                return version;
-            }
+/** @type {import('spl.js').DbExtension} */
+const dbExtension = {
+    extends: 'db',
+    fns: {
+        tables: db => db.exec('SELECT name FROM sqlite_master WHERE type=\'table\''),
+        master: (db, type) => db.exec('SELECT name FROM sqlite_master WHERE type=?', [type])
+    }
+};
+
+/** @type {import('spl.js').SplExtension} */
+const splExtension = {
+    extends: 'spl',
+    fns: {
+        spatialite_version: spl => {
+            const db = spl.db();
+            const version = db.exec('SELECT spatialite_version()').get.first;
+            db.close();
+            return version;
         }
     }
-];
+};
 
-const spl = await SPL({}, extensions);
+const spl = await SPL({}, [dbExtension, splExtension]);
 const db = await spl.db()
     .read(`
         CREATE TABLE hello (world);
         CREATE VIEW hello_view AS SELECT * FROM hello;
     `);
 
-console.assert(await db.tables().get.first === 'hello');
-console.assert(await db.master('view').get.first === 'hello_view');
-console.assert(await spl.spatialite_version() === '5.1.1-rc0');
+console.assert(await db.ex.tables().get.first === 'hello');
+console.assert(await db.ex.master('view').get.first === 'hello_view');
+console.assert(await spl.ex.spatialite_version() === '5.1.1-rc0');
 ```
 
 ## Building and Testing

dist/index.d.mts

@@ -69,6 +69,6 @@ export type Spl = {
      */
     fs: SplFs;
 };
-import type { SplOptions } from './typedefs.js';
-import type { ResultData } from './typedefs.js';
-import type { VersionInfo } from './typedefs.js';
+export type { SplOptions } from './typedefs.js';
+export type { ResultData } from './typedefs.js';
+export type { VersionInfo } from './typedefs.js';

dist/index.d.ts

@@ -1,91 +1,13 @@
-declare function _default(options?: SplOptions, extensions?: Extension[]): Promise<Spl>;
+declare function _default(options?: SplOptions, extensions?: (DbExtension | SplExtension)[]): Promise<Spl>;
 export default _default;
-/**
- * - A value that is both T and awaitable as T
- */
 export type Thenable<T> = T & PromiseLike<T>;
-/**
- * Query result accessor (async)
- */
-export type Result = {
-    /**
-     * - First value of first row
-     */
-    first: Promise<any>;
-    /**
-     * - Flat array of all values
-     */
-    flat: Promise<any[]>;
-    /**
-     * - Array of row arrays
-     */
-    rows: Promise<any[][]>;
-    /**
-     * - Column names
-     */
-    cols: Promise<string[]>;
-    /**
-     * - Array of row objects
-     */
-    objs: Promise<any[]>;
-    /**
-     * - Synchronous result (transfers ArrayBuffers)
-     */
-    sync: Promise<ResultData>;
-    /**
-     * - Free result memory
-     */
-    free: () => Promise<void>;
-};
-/**
- * Database instance
- */
-export type Db = {
-    /**
-     * - Attach another database
-     */
-    attach: (db: string, schema: string) => Thenable<Db>;
-    /**
-     * - Detach a database
-     */
-    detach: (schema: string) => Thenable<Db>;
-    /**
-     * - Execute SQL
-     */
-    exec: (sql: string, parameters?: any[] | {
-        [name: string]: any;
-    }) => Thenable<Db>;
-    /**
-     * - Read and execute a SQL script
-     */
-    read: (sql: string) => Thenable<Db>;
-    /**
-     * - Load database from path
-     */
-    load: (src: string) => Thenable<Db>;
-    /**
-     * - Save database to ArrayBuffer
-     */
-    save: () => Thenable<Db>;
-    /**
-     * - Close the database
-     */
-    close: () => Thenable<Spl>;
-    /**
-     * - Get query results
-     */
-    get: Result;
-};
-/**
- * Filesystem operations (Browser)
- */
 export type SplFs = {
     /**
-     * - Mount files to virtual filesystem
+     * - Mount files
      */
     mount: (path: string, options?: MountOption[]) => Thenable<Spl>;
     /**
-     * - Unmount from virtual filesystem
+     * - Unmount files
      */
     unmount: (path: string) => Thenable<Spl>;
     /**
@@ -105,18 +27,15 @@ export type SplFs = {
      */
     mkdir: (path: string) => Thenable<Spl>;
 };
-/**
- * SPL instance
- */
 export type Spl = {
     /**
      * - Open a database
      */
-    db: (path?: string | ArrayBuffer) => Thenable<Db>;
+    db: (path?: string | ArrayBuffer) => Db;
     /**
      * - Get version info
      */
-    version: () => Thenable<Spl>;
+    version: () => Thenable<VersionInfo>;
     /**
      * - Terminate the WebWorker
      */
@@ -125,8 +44,41 @@ export type Spl = {
      * - Filesystem operations
      */
     fs: SplFs;
+    /**
+     * - User-defined extension functions
+     */
+    ex: {
+        [x: string]: Function;
+    };
+};
+export type Db = {
+    attach: (db: string, schema: string) => Thenable<Db>;
+    detach: (schema: string) => Thenable<Db>;
+    exec: (sql: string, par?: any) => Thenable<Db>;
+    read: (sql: string) => Thenable<Db>;
+    load: (src: string) => Thenable<Db>;
+    save: () => Thenable<Db>;
+    close: () => Thenable<Spl>;
+    get: Result;
+    /**
+     * - User-defined extension functions
+     */
+    ex: {
+        [x: string]: Function;
+    };
+};
+export type Result = {
+    first: Promise<any>;
+    flat: Promise<any[]>;
+    rows: Promise<any[][]>;
+    cols: Promise<string[]>;
+    objs: Promise<any[]>;
+    sync: Promise<ResultData>;
+    free: () => Promise<void>;
 };
-import type { SplOptions } from './typedefs.js';
-import type { Extension } from './typedefs.js';
-import type { ResultData } from './typedefs.js';
-import type { MountOption } from './typedefs.js';
+export type { SplOptions } from './typedefs.js';
+export type { DbExtension } from './typedefs.js';
+export type { SplExtension } from './typedefs.js';
+export type { MountOption } from './typedefs.js';
+export type { VersionInfo } from './typedefs.js';
+export type { ResultData } from './typedefs.js';