@hpcc-js/wasm-duckdb 1.13.0 → 1.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hpcc-js/wasm-duckdb",
-  "version": "1.13.0",
+  "version": "1.14.0",
   "description": "hpcc-js - WASM DuckDB",
   "type": "module",
   "exports": {
@@ -38,7 +38,7 @@
     "update-major": "npx -y npm-check-updates -u"
   },
   "devDependencies": {
-    "@hpcc-js/esbuild-plugins": "1.7.0",
+    "@hpcc-js/esbuild-plugins": "1.8.0",
     "@hpcc-js/wasm-util": "1.0.0"
   },
   "keywords": [
@@ -55,5 +55,5 @@
   },
   "homepage": "https://hpcc-systems.github.io/hpcc-js-wasm/",
   "license": "Apache-2.0",
-  "gitHead": "6799e024fc9186c4a4f87294862142f00628e597"
+  "gitHead": "e34abaa76d55e43967e9da38228c28d75dd4d43a"
 }

package/src/duckdb.ts

@@ -1,6 +1,6 @@
 // @ts-expect-error importing from a wasm file is resolved via a custom esbuild plugin
 import load, { reset } from "../../../build/packages/duckdb/duckdblib.wasm";
-import type { MainModule, DuckDB as CPPDuckDB } from "../../../build/packages/duckdb/duckdblib.js";
+import type { MainModule, DuckDB as CPPDuckDB } from "../types/duckdblib.js";
 import { MainModuleEx } from "@hpcc-js/wasm-util";
 
 let g_duckdb: Promise<DuckDB>;
@@ -229,13 +229,61 @@ export class DuckDB extends MainModuleEx<MainModule> {
     registerFile(path: string, content: Uint8Array): void {
         const normalizedPath = path.startsWith("/") ? path.slice(1) : path;
         const split = normalizedPath.lastIndexOf("/");
-        const dir = split > 0 ? normalizedPath.substring(0, split) : "/";
-        if (dir.length > 1 && this._module.FS_createPath) {
-            this._module.FS_createPath(dir, true, true);
+        if (split > 0) {
+            const dir = normalizedPath.substring(0, split);
+            const parts = dir.split("/");
+            let currentPath = "/";
+            for (const part of parts) {
+                if (part && this._module.FS_createPath) {
+                    this._module.FS_createPath(currentPath, part, true, true);
+                    currentPath = currentPath === "/" ? "/" + part : currentPath + "/" + part;
+                }
+            }
         }
         this._module.FS_createDataFile(normalizedPath, undefined, content, true, true, true);
     }
 
+    /**
+     * Unregisters and removes a file from the virtual file system.
+     * 
+     * This removes a file that was previously registered using {@link registerFile} or
+     * {@link registerFileString}. Once unregistered, the file will no longer be accessible
+     * to DuckDB queries.
+     * 
+     * The path is normalized to remove leading slashes before removal.
+     * 
+     * @param path - The path of the file to remove (e.g., "data/users.csv")
+     * 
+     * @example
+     * ```ts
+     * const duckdb = await DuckDB.load();
+     * 
+     * // Register a file
+     * duckdb.registerFileString("temp.csv", "id,name\n1,Alice");
+     * 
+     * const connection = duckdb.connect();
+     * let result = connection.query("SELECT * FROM read_csv_auto('temp.csv')");
+     * console.log(result.rowCount()); // 1
+     * result.delete();
+     * 
+     * // Unregister the file
+     * duckdb.unregisterFile("temp.csv");
+     * 
+     * // File is no longer accessible
+     * try {
+     *     result = connection.query("SELECT * FROM read_csv_auto('temp.csv')");
+     * } catch (error) {
+     *     console.error("File not found"); // Error: file not accessible
+     * }
+     * 
+     * connection.delete();
+     * ```
+     */
+    unregisterFile(path: string): void {
+        const normalizedPath = path.startsWith("/") ? path.slice(1) : path;
+        this._module.FS_unlink(normalizedPath);
+    }
+
     /**
      * Registers a text file in the virtual file system.
      * 

package/types/duckdb.d.ts

@@ -1,4 +1,4 @@
-import type { MainModule, DuckDB as CPPDuckDB } from "../../../build/packages/duckdb/duckdblib.js";
+import type { MainModule, DuckDB as CPPDuckDB } from "../types/duckdblib.js";
 import { MainModuleEx } from "@hpcc-js/wasm-util";
 /**
  * DuckDB WASM library - an in-process SQL OLAP Database Management System.
@@ -151,7 +151,7 @@ export declare class DuckDB extends MainModuleEx<MainModule> {
      * connection.delete(); // Important: clean up!
      * ```
      */
-    connect(): import("../../../build/packages/duckdb/duckdblib.js").Connection;
+    connect(): import("../types/duckdblib.js").Connection;
     /**
      * Returns the number of threads available to DuckDB.
      *
@@ -190,6 +190,43 @@ export declare class DuckDB extends MainModuleEx<MainModule> {
      * ```
      */
     registerFile(path: string, content: Uint8Array): void;
+    /**
+     * Unregisters and removes a file from the virtual file system.
+     *
+     * This removes a file that was previously registered using {@link registerFile} or
+     * {@link registerFileString}. Once unregistered, the file will no longer be accessible
+     * to DuckDB queries.
+     *
+     * The path is normalized to remove leading slashes before removal.
+     *
+     * @param path - The path of the file to remove (e.g., "data/users.csv")
+     *
+     * @example
+     * ```ts
+     * const duckdb = await DuckDB.load();
+     *
+     * // Register a file
+     * duckdb.registerFileString("temp.csv", "id,name\n1,Alice");
+     *
+     * const connection = duckdb.connect();
+     * let result = connection.query("SELECT * FROM read_csv_auto('temp.csv')");
+     * console.log(result.rowCount()); // 1
+     * result.delete();
+     *
+     * // Unregister the file
+     * duckdb.unregisterFile("temp.csv");
+     *
+     * // File is no longer accessible
+     * try {
+     *     result = connection.query("SELECT * FROM read_csv_auto('temp.csv')");
+     * } catch (error) {
+     *     console.error("File not found"); // Error: file not accessible
+     * }
+     *
+     * connection.delete();
+     * ```
+     */
+    unregisterFile(path: string): void;
     /**
      * Registers a text file in the virtual file system.
      *

package/types/duckdblib.d.ts

@@ -0,0 +1,171 @@
+// TypeScript bindings for emscripten-generated code.  Automatically generated at compile time.
+declare namespace RuntimeExports {
+    /**
+     * Given a pointer 'ptr' to a null-terminated UTF8-encoded string in the
+     * emscripten HEAP, returns a copy of that string as a Javascript String object.
+     *
+     * @param {number} ptr
+     * @param {number=} maxBytesToRead - An optional length that specifies the
+     *   maximum number of bytes to read. You can omit this parameter to scan the
+     *   string until the first 0 byte. If maxBytesToRead is passed, and the string
+     *   at [ptr, ptr+maxBytesToReadr[ contains a null byte in the middle, then the
+     *   string will cut short at that byte index.
+     * @param {boolean=} ignoreNul - If true, the function will not stop on a NUL character.
+     * @return {string}
+     */
+    function UTF8ToString(ptr: number, maxBytesToRead?: number | undefined, ignoreNul?: boolean | undefined): string;
+    function lengthBytesUTF8(str: any): number;
+    function stringToUTF8(str: any, outPtr: any, maxBytesToWrite: any): any;
+    let HEAPU8: any;
+    let FS_createPath: any;
+    function FS_createDataFile(parent: any, name: any, fileData: any, canRead: any, canWrite: any, canOwn: any): void;
+    function FS_preloadFile(parent: any, name: any, url: any, canRead: any, canWrite: any, dontCreateFile: any, canOwn: any, preFinish: any): Promise<void>;
+    function FS_unlink(path: any): any;
+    function addRunDependency(id: any): void;
+    function removeRunDependency(id: any): void;
+}
+interface WasmModule {
+  _malloc(_0: number): number;
+  _free(_0: number): void;
+}
+
+type EmbindString = ArrayBuffer|Uint8Array|Uint8ClampedArray|Int8Array|string;
+export interface ClassHandle {
+  isAliasOf(other: ClassHandle): boolean;
+  delete(): void;
+  deleteLater(): this;
+  isDeleted(): boolean;
+  // @ts-ignore - If targeting lower than ESNext, this symbol might not exist.
+  [Symbol.dispose](): void;
+  clone(): this;
+}
+export interface LogicalType extends ClassHandle {
+  isIntegral(): boolean;
+  isFloating(): boolean;
+  isNumeric(): boolean;
+  isTemporal(): boolean;
+  isValid(): boolean;
+  isComplete(): boolean;
+  isSigned(): boolean;
+  isUnsigned(): boolean;
+  hasAlias(): boolean;
+  id(): number;
+  physicalType(): number;
+  stringify(): string;
+  setAlias(_0: EmbindString): void;
+  getAlias(): string;
+}
+
+export interface Value extends ClassHandle {
+  type(): LogicalType;
+  copy(): Value;
+  isNull(): boolean;
+  getBoolean(): boolean;
+  getInt32(): number;
+  getFloat(): number;
+  getDouble(): number;
+  stringify(): string;
+  toSQLString(): string;
+  getString(): string;
+}
+
+export interface ErrorData extends ClassHandle {
+  hasError(): boolean;
+  message(): string;
+  rawMessage(): string;
+}
+
+export interface BaseQueryResult extends ClassHandle {
+  setError(_0: ErrorData): void;
+  hasError(): boolean;
+  resultType(): number;
+  statementType(): number;
+  columnCount(): bigint;
+  columnCount(): bigint;
+  throwError(_0: EmbindString): void;
+  getError(): string;
+  columnNames(): any;
+  columnTypes(): any;
+}
+
+export interface QueryResult extends BaseQueryResult {
+  print(): void;
+  stringify(): string;
+  columnName(_0: bigint): string;
+}
+
+export interface ColumnDataCollection extends ClassHandle {
+  count(): bigint;
+  columnCount(): bigint;
+}
+
+export interface MaterializedQueryResult extends QueryResult {
+  collection(): ColumnDataCollection;
+  rowCount(): bigint;
+  toJSON(): string;
+  getValue(_0: number, _1: number): any;
+}
+
+export interface PreparedStatement extends ClassHandle {
+  hasError(): boolean;
+  statementType(): number;
+  columnCount(): bigint;
+  getError(): string;
+  execute(_0: any): QueryResult | null;
+  names(): any;
+  types(): any;
+}
+
+export interface Connection extends ClassHandle {
+  interrupt(): void;
+  beginTransaction(): void;
+  commit(): void;
+  rollback(): void;
+  setAutoCommit(_0: boolean): void;
+  isAutoCommit(): boolean;
+  hasActiveTransaction(): boolean;
+  getQueryProgress(): number;
+  prepare(_0: EmbindString): PreparedStatement | null;
+  query(_0: EmbindString): MaterializedQueryResult | null;
+  queryToJSON(_0: EmbindString): string;
+}
+
+export interface DuckDB extends ClassHandle {
+  connect(): Connection | null;
+  terminate(): void;
+  numberOfThreads(): bigint;
+}
+
+interface EmbindModule {
+  LogicalType: {
+    new(): LogicalType;
+  };
+  Value: {
+    new(): Value;
+  };
+  ErrorData: {
+    new(): ErrorData;
+  };
+  BaseQueryResult: {};
+  QueryResult: {};
+  ColumnDataCollection: {};
+  MaterializedQueryResult: {};
+  PreparedStatement: {};
+  Connection: {};
+  DuckDB: {
+    standardVectorSize(): number;
+    sourceID(): string;
+    libraryVersion(): string;
+    releaseCodename(): string;
+    platform(): string;
+  };
+  create(): DuckDB | null;
+  standardVectorSize(): number;
+  libraryVersion(): string;
+  sourceID(): string;
+  releaseCodename(): string;
+  platform(): string;
+}
+
+export type MainModule = WasmModule & typeof RuntimeExports & EmbindModule;
+export default function MainModuleFactory (options?: unknown): Promise<MainModule>;