@hpcc-js/wasm-duckdb 1.14.0 → 1.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hpcc-js/wasm-duckdb",
-  "version": "1.14.0",
+  "version": "1.15.0",
   "description": "hpcc-js - WASM DuckDB",
   "type": "module",
   "exports": {
@@ -55,5 +55,5 @@
   },
   "homepage": "https://hpcc-systems.github.io/hpcc-js-wasm/",
   "license": "Apache-2.0",
-  "gitHead": "e34abaa76d55e43967e9da38228c28d75dd4d43a"
+  "gitHead": "81504905bd26f44c1e68b31760269dee081c0cbb"
 }

package/src/duckdb.ts

@@ -91,20 +91,59 @@ const textEncoder = new TextEncoder();
  * @see [DuckDB Documentation](https://duckdb.org/docs/)
  * @see [DuckDB GitHub](https://github.com/duckdb/duckdb)
  */
-
-
-
-export class DuckDB extends MainModuleEx<MainModule> {
+export class DuckDB extends MainModuleEx<MainModule> implements Disposable {
 
     db: CPPDuckDB
 
     private constructor(_module: MainModule) {
         super(_module);
         this.db = this._module.create()!;
+        // Special home directory for web_user (needed for some extensions)
         const { FS_createPath } = this._module;
         FS_createPath("/", "home/web_user", true, true);
     }
 
+    /**
+     * Disposes of the DuckDB database instance and releases resources.
+     * 
+     * This method should be called when you're done using the database to free up
+     * memory and clean up resources. After calling dispose, the instance should not be used.
+     * 
+     * @example
+     * ```ts
+     * const duckdb = await DuckDB.load();
+     * const connection = duckdb.connect();
+     * // ... use the database ...
+     * connection.delete();
+     * duckdb.dispose();
+     * ```
+     * 
+     * @example Using statement (TypeScript 5.2+)
+     * ```ts
+     * {
+     *     using duckdb = await DuckDB.load();
+     *     const connection = duckdb.connect();
+     *     // ... use the database ...
+     *     connection.delete();
+     * } // duckdb.dispose() is called automatically
+     * ```
+     */
+    dispose(): void {
+        try {
+            this.db?.terminate();
+        } finally {
+            this.db?.delete();
+        }
+    }
+
+    /**
+     * Symbol.dispose implementation for use with `using` declarations.
+     * @internal
+     */
+    [Symbol.dispose](): void {
+        this.dispose();
+    }
+
     /**
      * Loads and initializes the DuckDB WASM module.
      * 

package/types/duckdb.d.ts

@@ -85,9 +85,40 @@ import { MainModuleEx } from "@hpcc-js/wasm-util";
  * @see [DuckDB Documentation](https://duckdb.org/docs/)
  * @see [DuckDB GitHub](https://github.com/duckdb/duckdb)
  */
-export declare class DuckDB extends MainModuleEx<MainModule> {
+export declare class DuckDB extends MainModuleEx<MainModule> implements Disposable {
     db: CPPDuckDB;
     private constructor();
+    /**
+     * Disposes of the DuckDB database instance and releases resources.
+     *
+     * This method should be called when you're done using the database to free up
+     * memory and clean up resources. After calling dispose, the instance should not be used.
+     *
+     * @example
+     * ```ts
+     * const duckdb = await DuckDB.load();
+     * const connection = duckdb.connect();
+     * // ... use the database ...
+     * connection.delete();
+     * duckdb.dispose();
+     * ```
+     *
+     * @example Using statement (TypeScript 5.2+)
+     * ```ts
+     * {
+     *     using duckdb = await DuckDB.load();
+     *     const connection = duckdb.connect();
+     *     // ... use the database ...
+     *     connection.delete();
+     * } // duckdb.dispose() is called automatically
+     * ```
+     */
+    dispose(): void;
+    /**
+     * Symbol.dispose implementation for use with `using` declarations.
+     * @internal
+     */
+    [Symbol.dispose](): void;
     /**
      * Loads and initializes the DuckDB WASM module.
      *