@uwdata/mosaic-duckdb 0.17.0 → 0.19.0

package/LICENSE

@@ -0,0 +1,47 @@
+BSD 3-Clause License
+
+Copyright (c) 2023-2025, UW Interactive Data Lab
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+---
+
+Portions of this software are derived from Observable Plot, which is released
+under the ISC license.
+
+Copyright 2020-2023 Observable, Inc.
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

package/README.md

@@ -4,6 +4,6 @@
 
 A Promise-based Node.js API to DuckDB, along with a data server that supports transfer of [Apache Arrow](https://arrow.apache.org/) and JSON data over either Web Sockets or HTTP.
 
-_Warning_: Due to persistent quality issues involving the Node.js DuckDB client and Arrow extension, we recommend using the Python-based [`duckdb-server`](https://github.com/uwdata/mosaic/tree/main/packages/duckdb-server) package instead. However, we retain this package for both backwards compatibility and potential future use as quality issues improve.
+_Warning_: Due to persistent quality issues involving the Node.js DuckDB client and Arrow extension, we recommend using the Python-based [`duckdb-server`](https://github.com/uwdata/mosaic/tree/main/packages/server/duckdb-server) package instead. However, we retain this package for both backwards compatibility and potential future use as quality issues improve.
 
-_Note:_ This package provides a local DuckDB server for Node.js. To instead use DuckDB-WASM in the browser, use the `wasmConnector` in the [`mosaic-core`](https://github.com/uwdata/mosaic/tree/main/packages/mosaic-core) package.
+_Note:_ This package provides a local DuckDB server for Node.js. To instead use DuckDB-WASM in the browser, use the `wasmConnector` in the [`mosaic-core`](https://github.com/uwdata/mosaic/tree/main/packages/mosaic/mosaic-core) package.

package/dist/src/Cache.d.ts

@@ -0,0 +1,22 @@
+export function cacheKey(hashable: any, type: any): string;
+export class Cache {
+    constructor({ max, dir, ttl }: {
+        max?: number;
+        dir?: string;
+        ttl?: number;
+    });
+    cache: Map<any, any>;
+    max: number;
+    dir: string;
+    ttl: number;
+    has(key: any): boolean;
+    delete(key: any): boolean;
+    get(key: any): any;
+    set(key: any, data: any, { persist, ttl }?: {
+        persist?: boolean;
+        ttl?: number;
+    }): this;
+    shouldEvict(): boolean;
+    evict(): void;
+}
+//# sourceMappingURL=Cache.d.ts.map

package/dist/src/Cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cache.d.ts","sourceRoot":"","sources":["../../src/Cache.js"],"names":[],"mappings":"AAOA,2DAEC;AAaD;IACE;;;;OAUC;IALC,qBAAoB;IACpB,YAAc;IACd,YAAc;IACd,YAAc;IAIhB,uBAEC;IAED,0BAMC;IAED,mBAEC;IAED;;;aAMC;IAED,uBAEC;IAED,cAyBC;CACF"}

package/dist/src/DuckDB.d.ts

@@ -0,0 +1,22 @@
+export class DuckDB {
+    constructor(path?: string, config?: {}, initStatements?: string);
+    db: duckdb.Database;
+    con: duckdb.Connection;
+    _init: Promise<any>;
+    close(): Promise<any>;
+    prepare(sql: any): DuckDBStatement;
+    exec(sql: any): Promise<any>;
+    query(sql: any): Promise<any>;
+    arrowBuffer(sql: any): Promise<any>;
+}
+export class DuckDBStatement {
+    constructor(statement: any);
+    statement: any;
+    finalize(): void;
+    run(params: any): void;
+    exec(params: any): Promise<any>;
+    query(params: any): Promise<any>;
+    arrowBuffer(params: any): Promise<any>;
+}
+import duckdb from 'duckdb';
+//# sourceMappingURL=DuckDB.d.ts.map

package/dist/src/DuckDB.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DuckDB.d.ts","sourceRoot":"","sources":["../../src/DuckDB.js"],"names":[],"mappings":"AAaA;IACE,iEASC;IAJC,oBAA2C;IAC3C,uBAA4B;IAE5B,oBAAsC;IAGxC,sBAUC;IAED,mCAEC;IAED,6BAUC;IAED,8BAUC;IAED,oCAUC;CACF;AAED;IACE,4BAEC;IADC,eAA0B;IAG5B,iBAEC;IAED,uBAEC;IAED,gCAUC;IAED,iCAUC;IAED,uCAUC;CACF;mBA9HkB,QAAQ"}

package/dist/src/data-server.d.ts

@@ -0,0 +1,15 @@
+export function dataServer(db: any, { cache, rest, socket, port }?: {
+    cache?: boolean;
+    rest?: boolean;
+    socket?: boolean;
+    port?: number;
+}): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
+export function queryHandler(db: any, queryCache: any): (res: any, data: any) => Promise<void>;
+export function socketResponse(ws: any): {
+    arrow(data: any): void;
+    json(data: any): void;
+    done(): void;
+    error(err: any): void;
+};
+import http from 'node:http';
+//# sourceMappingURL=data-server.d.ts.map

package/dist/src/data-server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-server.d.ts","sourceRoot":"","sources":["../../src/data-server.js"],"names":[],"mappings":"AAOA;;;;;yEAgBC;AA6CD,yDAqBgB,QAAG,EAAE,SAAI,mBAwCxB;AAwBD;;;;;EAmBC;iBA5KgB,WAAW"}

package/dist/src/index.d.ts

@@ -0,0 +1,8 @@
+export { DuckDB } from "./DuckDB.js";
+export { Cache } from "./Cache.js";
+export { loadArrow } from "./load/arrow.js";
+export { loadCSV } from "./load/csv.js";
+export { loadJSON } from "./load/json.js";
+export { loadParquet } from "./load/parquet.js";
+export { dataServer, queryHandler, socketResponse } from "./data-server.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":""}

package/dist/src/load/arrow.d.ts

@@ -0,0 +1,2 @@
+export function loadArrow(db: any, tableName: any, buffer: any): Promise<any>;
+//# sourceMappingURL=arrow.d.ts.map

package/dist/src/load/arrow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrow.d.ts","sourceRoot":"","sources":["../../../src/load/arrow.js"],"names":[],"mappings":"AAEA,8EAWC"}

package/dist/src/load/csv.d.ts

@@ -0,0 +1,2 @@
+export function loadCSV(db: any, tableName: any, fileName: any, options?: {}): any;
+//# sourceMappingURL=csv.d.ts.map

package/dist/src/load/csv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"csv.d.ts","sourceRoot":"","sources":["../../../src/load/csv.js"],"names":[],"mappings":"AAEA,mFAEC"}

package/dist/src/load/json.d.ts

@@ -0,0 +1,2 @@
+export function loadJSON(db: any, tableName: any, fileName: any, options?: {}): any;
+//# sourceMappingURL=json.d.ts.map

package/dist/src/load/json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../../src/load/json.js"],"names":[],"mappings":"AAEA,oFAEC"}

package/dist/src/load/parquet.d.ts

@@ -0,0 +1,2 @@
+export function loadParquet(db: any, tableName: any, fileName: any, options?: {}): any;
+//# sourceMappingURL=parquet.d.ts.map

package/dist/src/load/parquet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parquet.d.ts","sourceRoot":"","sources":["../../../src/load/parquet.js"],"names":[],"mappings":"AAEA,uFAEC"}

package/dist/src/merge-buffers.d.ts

@@ -0,0 +1,2 @@
+export function mergeBuffers(buffers: any): Uint8Array<any>;
+//# sourceMappingURL=merge-buffers.d.ts.map

package/dist/src/merge-buffers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge-buffers.d.ts","sourceRoot":"","sources":["../../src/merge-buffers.js"],"names":[],"mappings":"AAAA,4DAYC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uwdata/mosaic-duckdb",
-  "version": "0.17.0",
+  "version": "0.19.0",
   "description": "A Promise-based DuckDB API and Node.js data server.",
   "keywords": [
     "duckdb",
@@ -13,8 +13,15 @@
   "author": "Jeffrey Heer (https://idl.uw.edu)",
   "type": "module",
   "exports": {
+    "types": "./dist/src/index.d.ts",
     "default": "./src/index.js"
   },
+  "files": [
+    "bin",
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "src"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/uwdata/mosaic.git"
@@ -25,15 +32,16 @@
     "to-parquet": "./bin/to-parquet.js"
   },
   "scripts": {
-    "prebuild": "rimraf dist && mkdir dist",
+    "clean": "rimraf dist && mkdir dist",
     "lint": "eslint src test",
     "server": "node bin/run-server.js",
-    "test": "vitest run && tsc",
-    "prepublishOnly": "npm run test && npm run lint"
+    "test": "vitest run",
+    "prepublishOnly": "npm run test && npm run lint && tsc --build"
   },
   "dependencies": {
-    "@uwdata/mosaic-sql": "^0.17.0",
-    "duckdb": "~1.2.1",
-    "ws": "^8.18.2"
-  }
+    "@uwdata/mosaic-sql": "^0.19.0",
+    "duckdb": "~1.3.4",
+    "ws": "^8.18.3"
+  },
+  "gitHead": "0ba4f2d710ca2fa53da7ff02a370e39a32dc2ce4"
 }

package/src/Cache.js

@@ -93,7 +93,7 @@ async function readEntries(dir, cache) {
   let files;
   try {
     files = await fs.readdir(dir);
-  } catch (err) { // eslint-disable-line no-unused-vars
+  } catch (err) {
     return; // dir does not exist, nothing to do
   }
   await Promise.allSettled(files.map(async file => {

package/src/DuckDB.js

@@ -5,9 +5,9 @@ const TEMP_DIR = '.duckdb';
 
 const DEFAULT_INIT_STATEMENTS = [
   `PRAGMA temp_directory='${TEMP_DIR}'`,
-  `INSTALL arrow`,
+  `INSTALL nanoarrow FROM community`,
   `INSTALL httpfs`,
-  `LOAD arrow`,
+  `LOAD nanoarrow`,
   `LOAD httpfs`
 ].join(';\n');
 
@@ -19,7 +19,8 @@ export class DuckDB {
   ) {
     this.db = new duckdb.Database(path, config);
     this.con = this.db.connect();
-    this.exec(initStatements);
+    // store initialization promise so that we can wait for it
+    this._init = this.exec(initStatements);
   }
 
   close() {

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "include": ["src/**/*"],
-  "compilerOptions": {
-    "noEmit": true
-  },
-  "references": [{ "path": "../sql" }]
-}

package/vitest.config.ts

@@ -1,3 +0,0 @@
-import { defineConfig } from 'vite';
-
-export default defineConfig({});