@hpcc-js/wasm-duckdb 1.0.0

package/package.json

@@ -0,0 +1,62 @@
+{
+    "name": "@hpcc-js/wasm-duckdb",
+    "version": "1.0.0",
+    "description": "hpcc-js - WASM DuckDB",
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./types/index.d.ts",
+            "import": "./dist/index.js"
+        }
+    },
+    "types": "./types/index.d.ts",
+    "files": [
+        "dist/**/*",
+        "src/**/*",
+        "types/**/*"
+    ],
+    "scripts": {
+        "clean": "rimraf ./build ./dist ./dist-test ./types",
+        "pack-duckdb-eh-worker-node": "npx -y mkdirp build && node ./utils/sfx-wasm.js ../../node_modules/@duckdb/duckdb-wasm/dist/duckdb-node-eh.worker.cjs > ./build/duckdb-node-eh.worker.ts",
+        "pack-duckdb-eh-worker": "npx -y mkdirp build && node ./utils/sfx-wasm.js ../../node_modules/@duckdb/duckdb-wasm/dist/duckdb-browser-eh.worker.js > ./build/duckdb-browser-eh.worker.ts",
+        "pack-duckdb-eh": "npx -y mkdirp build && node ./utils/sfx-wasm.js ../../node_modules/@duckdb/duckdb-wasm/dist/duckdb-eh.wasm > ./build/duckdb-eh.wasm.ts",
+        "pack-duckdb": "run-p pack-duckdb-eh pack-duckdb-eh-worker pack-duckdb-eh-worker-node",
+        "build-types": "tsc --project tsconfig.json --emitDeclarationOnly",
+        "build-types-watch": "npm run build-types -- --watch",
+        "build-ts": "node esbuild.mjs",
+        "build-ts-dev": "npm run build-ts -- --mode=development",
+        "build-ts-watch": "npm run compile-ts-dev -- --watch",
+        "build-dev": "run-p build-types build-ts-dev",
+        "build": "npm-run-all --serial pack-duckdb --parallel build-types build-ts",
+        "lint-skypack": "npx -y @skypack/package-check",
+        "lint-eslint": "eslint src/**/*.ts",
+        "lint": "run-p lint-eslint lint-skypack",
+        "test-chrome": "karma start --single-run --browsers ChromiumHeadless karma.conf.cjs",
+        "test-firefox": "karma start --single-run --browsers Firefox karma.conf.cjs",
+        "test": "run-s test-chrome"
+    },
+    "dependencies": {
+        "yargs": "17.7.2"
+    },
+    "devDependencies": {
+        "@duckdb/duckdb-wasm": "1.28.1-dev106.0",
+        "@hpcc-js/esbuild-plugins": "1.0.0",
+        "npm-run-all": "4.1.5"
+    },
+    "keywords": [
+        "graphviz",
+        "typescript",
+        "webassembly",
+        "wasm",
+        "dot",
+        "neato",
+        "twopi"
+    ],
+    "author": "hpcc-systems",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/hpcc-systems/hpcc-js-wasm.git"
+    },
+    "homepage": "https://hpcc-systems.github.io/hpcc-js-wasm/",
+    "license": "Apache-2.0"
+}

package/src/duckdb.ts

@@ -0,0 +1,83 @@
+// @ts-ignore
+import load, { reset } from "../build/duckdb-eh.wasm.js";
+// @ts-ignore
+import loadWasmWorker, { reset as resetWasmWorker } from "../build/duckdb-browser-eh.worker.js";
+import { AsyncDuckDB, ConsoleLogger } from "@duckdb/duckdb-wasm";
+
+/**
+ * DuckDB WASM library, a in-process SQL OLAP Database Management System..
+ * 
+ * See [DuckDB](https://github.com/duckdb/duckdb) for more details.
+ *
+ * ```ts
+ * import { DuckDB } from "@hpcc-js/wasm/duckdb";
+ * 
+ * let duckdb = await DuckDB.load();
+ * const c = await duckdb.db.connect();
+ * 
+ * const data = [
+ *     { "col1": 1, "col2": "foo" },
+ *     { "col1": 2, "col2": "bar" },
+ * ];
+ * await duckdb.db.registerFileText("rows.json", JSON.stringify(data));
+ * await c.insertJSONFromPath('rows.json', { name: 'rows' });
+ * 
+ * const arrowResult = await c.query("SELECT * FROM read_json_auto('rows.json')");
+ * const result = arrowResult.toArray().map((row) => row.toJSON());
+ * expect(result.length).to.equal(data.length);
+ * for (let i = 0; i < result.length; i++) {
+ *     expect(result[i].col2).to.equal(data[i].col2);
+ * }
+ * 
+ * c.close();
+ * ```
+ */
+export class DuckDB {
+
+    db: AsyncDuckDB;
+
+    private constructor(db: AsyncDuckDB, protected _version: string) {
+        this.db = db;
+    }
+
+    /**
+     * Compiles and instantiates the raw wasm.
+     * 
+     * ::: info
+     * In general WebAssembly compilation is disallowed on the main thread if the buffer size is larger than 4KB, hence forcing `load` to be asynchronous;
+     * :::
+     * 
+     * @returns A promise to an instance of the DuckDB class.
+     */
+    static load(): Promise<DuckDB> {
+        const workerUrl = URL.createObjectURL(
+            new Blob([loadWasmWorker()], { type: "text/javascript" })
+        );
+        const worker = new Worker(workerUrl);
+        URL.revokeObjectURL(workerUrl);
+        const logger = new ConsoleLogger();
+        const db = new AsyncDuckDB(logger, worker);
+        const wasmUrl = URL.createObjectURL(
+            new Blob([load()], { "type": "application/wasm" })
+        );
+        return db.instantiate(wasmUrl, null).then(async () => {
+            URL.revokeObjectURL(wasmUrl);
+            return new DuckDB(db, await db.getVersion());
+        });
+    }
+
+    /**
+     * Unloades the compiled wasm instance.
+     */
+    static unload() {
+        resetWasmWorker();
+        reset();
+    }
+
+    /**
+     * @returns The DuckDB version
+     */
+    version(): string {
+        return this._version;
+    }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./duckdb.ts";

package/types/duckdb.d.ts

@@ -0,0 +1,52 @@
+import { AsyncDuckDB } from "@duckdb/duckdb-wasm";
+/**
+ * DuckDB WASM library, a in-process SQL OLAP Database Management System..
+ *
+ * See [DuckDB](https://github.com/duckdb/duckdb) for more details.
+ *
+ * ```ts
+ * import { DuckDB } from "@hpcc-js/wasm/duckdb";
+ *
+ * let duckdb = await DuckDB.load();
+ * const c = await duckdb.db.connect();
+ *
+ * const data = [
+ *     { "col1": 1, "col2": "foo" },
+ *     { "col1": 2, "col2": "bar" },
+ * ];
+ * await duckdb.db.registerFileText("rows.json", JSON.stringify(data));
+ * await c.insertJSONFromPath('rows.json', { name: 'rows' });
+ *
+ * const arrowResult = await c.query("SELECT * FROM read_json_auto('rows.json')");
+ * const result = arrowResult.toArray().map((row) => row.toJSON());
+ * expect(result.length).to.equal(data.length);
+ * for (let i = 0; i < result.length; i++) {
+ *     expect(result[i].col2).to.equal(data[i].col2);
+ * }
+ *
+ * c.close();
+ * ```
+ */
+export declare class DuckDB {
+    protected _version: string;
+    db: AsyncDuckDB;
+    private constructor();
+    /**
+     * Compiles and instantiates the raw wasm.
+     *
+     * ::: info
+     * In general WebAssembly compilation is disallowed on the main thread if the buffer size is larger than 4KB, hence forcing `load` to be asynchronous;
+     * :::
+     *
+     * @returns A promise to an instance of the DuckDB class.
+     */
+    static load(): Promise<DuckDB>;
+    /**
+     * Unloades the compiled wasm instance.
+     */
+    static unload(): void;
+    /**
+     * @returns The DuckDB version
+     */
+    version(): string;
+}

package/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./duckdb.ts";