@tursodatabase/database 0.1.5-pre.3 → 0.1.5

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <h1 align="center">Turso Database for JavaScript</h1>
+  <h1 align="center">Turso Database for JavaScript in Node</h1>
 </p>
 
 <p align="center">
@@ -14,7 +14,7 @@
 
 ## About
 
-This package is the Turso in-memory database library for JavaScript.
+This package is the Turso embedded database library for JavaScript in Node.
 
 > **⚠️ Warning:** This software is ALPHA, only use for development, testing, and experimentation. We are working to make it production ready, but do not use it for critical data right now.
 
@@ -23,7 +23,7 @@ This package is the Turso in-memory database library for JavaScript.
 - **SQLite compatible:** SQLite query language and file format support ([status](https://github.com/tursodatabase/turso/blob/main/COMPAT.md)).
 - **In-process**: No network overhead, runs directly in your Node.js process
 - **TypeScript support**: Full TypeScript definitions included
-- **Cross-platform**: Supports Linux (x86 and arm64), macOS, Windows and browsers (through WebAssembly)
+- **Cross-platform**: Supports Linux (x86 and arm64), macOS, Windows (browser is supported in the separate package `@tursodatabase/database-browser` package)
 
 ## Installation
 
@@ -42,15 +42,15 @@ import { connect } from '@tursodatabase/database';
 const db = await connect(':memory:');
 
 // Create a table
-db.exec('CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)');
+await db.exec('CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)');
 
 // Insert data
 const insert = db.prepare('INSERT INTO users (name, email) VALUES (?, ?)');
-insert.run('Alice', 'alice@example.com');
-insert.run('Bob', 'bob@example.com');
+await insert.run('Alice', 'alice@example.com');
+await insert.run('Bob', 'bob@example.com');
 
 // Query data
-const users = db.prepare('SELECT * FROM users').all();
+const users = await db.prepare('SELECT * FROM users').all();
 console.log(users);
 // Output: [
 //   { id: 1, name: 'Alice', email: 'alice@example.com' },
@@ -67,7 +67,7 @@ import { connect } from '@tursodatabase/database';
 const db = await connect('my-database.db');
 
 // Create a table
-db.exec(`
+await db.exec(`
   CREATE TABLE IF NOT EXISTS posts (
     id INTEGER PRIMARY KEY AUTOINCREMENT,
     title TEXT NOT NULL,
@@ -78,7 +78,7 @@ db.exec(`
 
 // Insert a post
 const insertPost = db.prepare('INSERT INTO posts (title, content) VALUES (?, ?)');
-const result = insertPost.run('Hello World', 'This is my first blog post!');
+const result = await insertPost.run('Hello World', 'This is my first blog post!');
 
 console.log(`Inserted post with ID: ${result.lastInsertRowid}`);
 ```
@@ -91,27 +91,23 @@ import { connect } from '@tursodatabase/database';
 const db = await connect('transactions.db');
 
 // Using transactions for atomic operations
-const transaction = db.transaction((users) => {
+const transaction = db.transaction(async (users) => {
   const insert = db.prepare('INSERT INTO users (name, email) VALUES (?, ?)');
   for (const user of users) {
-    insert.run(user.name, user.email);
+    await insert.run(user.name, user.email);
   }
 });
 
 // Execute transaction
-transaction([
+await transaction([
   { name: 'Alice', email: 'alice@example.com' },
   { name: 'Bob', email: 'bob@example.com' }
 ]);
 ```
 
-### WebAssembly Support
-
-Turso Database can run in browsers using WebAssembly. Check the `browser.js` and WASM artifacts for browser usage.
-
 ## API Reference
 
-For complete API documentation, see [JavaScript API Reference](../../docs/javascript-api-reference.md).
+For complete API documentation, see [JavaScript API Reference](../../../../docs/javascript-api-reference.md).
 
 ## Related Packages
 
@@ -126,4 +122,4 @@ This project is licensed under the [MIT license](../../LICENSE.md).
 
 - [GitHub Issues](https://github.com/tursodatabase/turso/issues)
 - [Documentation](https://docs.turso.tech)
-- [Discord Community](https://tur.so/discord)
+- [Discord Community](https://tur.so/discord)

package/dist/compat.d.ts

@@ -0,0 +1,6 @@
+import { DatabaseCompat, SqliteError, DatabaseOpts } from "@tursodatabase/database-common";
+declare class Database extends DatabaseCompat {
+    constructor(path: string, opts?: DatabaseOpts);
+}
+export { Database, SqliteError };
+//# sourceMappingURL=compat.d.ts.map

package/dist/compat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compat.d.ts","sourceRoot":"","sources":["../compat.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAkB,WAAW,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAA;AAG1G,cAAM,QAAS,SAAQ,cAAc;gBACrB,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,YAAiB;CAGpD;AAED,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAA"}

package/dist/compat.js

@@ -1,367 +1,8 @@
-import { Database as NativeDB } from "#entry-point";
-import { bindParams } from "./bind.js";
-import { SqliteError } from "./sqlite-error.js";
-// Step result constants
-const STEP_ROW = 1;
-const STEP_DONE = 2;
-const STEP_IO = 3;
-const convertibleErrorTypes = { TypeError };
-const CONVERTIBLE_ERROR_PREFIX = "[TURSO_CONVERT_TYPE]";
-function convertError(err) {
-    if ((err.code ?? "").startsWith(CONVERTIBLE_ERROR_PREFIX)) {
-        return createErrorByName(err.code.substring(CONVERTIBLE_ERROR_PREFIX.length), err.message);
-    }
-    return new SqliteError(err.message, err.code, err.rawCode);
-}
-function createErrorByName(name, message) {
-    const ErrorConstructor = convertibleErrorTypes[name];
-    if (!ErrorConstructor) {
-        throw new Error(`unknown error type ${name} from Turso`);
-    }
-    return new ErrorConstructor(message);
-}
-/**
- * Database represents a connection that can prepare and execute SQL statements.
- */
-class Database {
-    db;
-    memory;
-    open;
-    _inTransaction = false;
-    /**
-     * Creates a new database connection. If the database file pointed to by `path` does not exists, it will be created.
-     *
-     * @constructor
-     * @param {string} path - Path to the database file.
-     * @param {Object} opts - Options for database behavior.
-     * @param {boolean} [opts.readonly=false] - Open the database in read-only mode.
-     * @param {boolean} [opts.fileMustExist=false] - If true, throws if database file does not exist.
-     * @param {number} [opts.timeout=0] - Timeout duration in milliseconds for database operations. Defaults to 0 (no timeout).
-     */
+import { DatabaseCompat, SqliteError } from "@tursodatabase/database-common";
+import { Database as NativeDB } from "#index";
+class Database extends DatabaseCompat {
     constructor(path, opts = {}) {
-        opts.readonly = opts.readonly === undefined ? false : opts.readonly;
-        opts.fileMustExist =
-            opts.fileMustExist === undefined ? false : opts.fileMustExist;
-        opts.timeout = opts.timeout === undefined ? 0 : opts.timeout;
-        this.db = new NativeDB(path);
-        this.memory = this.db.memory;
-        const db = this.db;
-        Object.defineProperties(this, {
-            inTransaction: {
-                get: () => this._inTransaction,
-            },
-            name: {
-                get() {
-                    return path;
-                },
-            },
-            readonly: {
-                get() {
-                    return opts.readonly;
-                },
-            },
-            open: {
-                get() {
-                    return this.db.open;
-                },
-            },
-        });
-    }
-    /**
-     * Prepares a SQL statement for execution.
-     *
-     * @param {string} sql - The SQL statement string to prepare.
-     */
-    prepare(sql) {
-        if (!this.open) {
-            throw new TypeError("The database connection is not open");
-        }
-        if (!sql) {
-            throw new RangeError("The supplied SQL string contains no statements");
-        }
-        try {
-            return new Statement(this.db.prepare(sql), this);
-        }
-        catch (err) {
-            throw convertError(err);
-        }
-    }
-    /**
-     * Returns a function that executes the given function in a transaction.
-     *
-     * @param {function} fn - The function to wrap in a transaction.
-     */
-    transaction(fn) {
-        if (typeof fn !== "function")
-            throw new TypeError("Expected first argument to be a function");
-        const db = this;
-        const wrapTxn = (mode) => {
-            return (...bindParameters) => {
-                db.exec("BEGIN " + mode);
-                db._inTransaction = true;
-                try {
-                    const result = fn(...bindParameters);
-                    db.exec("COMMIT");
-                    db._inTransaction = false;
-                    return result;
-                }
-                catch (err) {
-                    db.exec("ROLLBACK");
-                    db._inTransaction = false;
-                    throw err;
-                }
-            };
-        };
-        const properties = {
-            default: { value: wrapTxn("") },
-            deferred: { value: wrapTxn("DEFERRED") },
-            immediate: { value: wrapTxn("IMMEDIATE") },
-            exclusive: { value: wrapTxn("EXCLUSIVE") },
-            database: { value: this, enumerable: true },
-        };
-        Object.defineProperties(properties.default.value, properties);
-        Object.defineProperties(properties.deferred.value, properties);
-        Object.defineProperties(properties.immediate.value, properties);
-        Object.defineProperties(properties.exclusive.value, properties);
-        return properties.default.value;
-    }
-    pragma(source, options) {
-        if (options == null)
-            options = {};
-        if (typeof source !== "string")
-            throw new TypeError("Expected first argument to be a string");
-        if (typeof options !== "object")
-            throw new TypeError("Expected second argument to be an options object");
-        const pragma = `PRAGMA ${source}`;
-        const stmt = this.prepare(pragma);
-        const results = stmt.all();
-        return results;
-    }
-    backup(filename, options) {
-        throw new Error("not implemented");
-    }
-    serialize(options) {
-        throw new Error("not implemented");
-    }
-    function(name, options, fn) {
-        throw new Error("not implemented");
-    }
-    aggregate(name, options) {
-        throw new Error("not implemented");
-    }
-    table(name, factory) {
-        throw new Error("not implemented");
-    }
-    loadExtension(path) {
-        throw new Error("not implemented");
-    }
-    maxWriteReplicationIndex() {
-        throw new Error("not implemented");
-    }
-    /**
-     * Executes a SQL statement.
-     *
-     * @param {string} sql - The SQL statement string to execute.
-     */
-    exec(sql) {
-        if (!this.open) {
-            throw new TypeError("The database connection is not open");
-        }
-        try {
-            this.db.batch(sql);
-        }
-        catch (err) {
-            throw convertError(err);
-        }
-    }
-    /**
-     * Interrupts the database connection.
-     */
-    interrupt() {
-        throw new Error("not implemented");
-    }
-    /**
-     * Sets the default safe integers mode for all statements from this database.
-     *
-     * @param {boolean} [toggle] - Whether to use safe integers by default.
-     */
-    defaultSafeIntegers(toggle) {
-        this.db.defaultSafeIntegers(toggle);
-    }
-    /**
-     * Closes the database connection.
-     */
-    close() {
-        this.db.close();
-    }
-}
-/**
- * Statement represents a prepared SQL statement that can be executed.
- */
-class Statement {
-    stmt;
-    db;
-    constructor(stmt, database) {
-        this.stmt = stmt;
-        this.db = database;
-    }
-    /**
-     * Toggle raw mode.
-     *
-     * @param raw Enable or disable raw mode. If you don't pass the parameter, raw mode is enabled.
-     */
-    raw(raw) {
-        this.stmt.raw(raw);
-        return this;
-    }
-    /**
-     * Toggle pluck mode.
-     *
-     * @param pluckMode Enable or disable pluck mode. If you don't pass the parameter, pluck mode is enabled.
-     */
-    pluck(pluckMode) {
-        this.stmt.pluck(pluckMode);
-        return this;
-    }
-    /**
-     * Sets safe integers mode for this statement.
-     *
-     * @param {boolean} [toggle] - Whether to use safe integers.
-     */
-    safeIntegers(toggle) {
-        this.stmt.safeIntegers(toggle);
-        return this;
-    }
-    /**
-     * Get column information for the statement.
-     *
-     * @returns {Array} An array of column objects with name, column, table, database, and type properties.
-     */
-    columns() {
-        return this.stmt.columns();
-    }
-    get source() {
-        throw new Error("not implemented");
-    }
-    get reader() {
-        throw new Error("not implemented");
-    }
-    get database() {
-        return this.db;
-    }
-    /**
-     * Executes the SQL statement and returns an info object.
-     */
-    run(...bindParameters) {
-        const totalChangesBefore = this.db.db.totalChanges();
-        this.stmt.reset();
-        bindParams(this.stmt, bindParameters);
-        for (;;) {
-            const stepResult = this.stmt.step();
-            if (stepResult === STEP_IO) {
-                this.db.db.ioLoopSync();
-                continue;
-            }
-            if (stepResult === STEP_DONE) {
-                break;
-            }
-            if (stepResult === STEP_ROW) {
-                // For run(), we don't need the row data, just continue
-                continue;
-            }
-        }
-        const lastInsertRowid = this.db.db.lastInsertRowid();
-        const changes = this.db.db.totalChanges() === totalChangesBefore ? 0 : this.db.db.changes();
-        return { changes, lastInsertRowid };
-    }
-    /**
-     * Executes the SQL statement and returns the first row.
-     *
-     * @param bindParameters - The bind parameters for executing the statement.
-     */
-    get(...bindParameters) {
-        this.stmt.reset();
-        bindParams(this.stmt, bindParameters);
-        for (;;) {
-            const stepResult = this.stmt.step();
-            if (stepResult === STEP_IO) {
-                this.db.db.ioLoopSync();
-                continue;
-            }
-            if (stepResult === STEP_DONE) {
-                return undefined;
-            }
-            if (stepResult === STEP_ROW) {
-                return this.stmt.row();
-            }
-        }
-    }
-    /**
-     * Executes the SQL statement and returns an iterator to the resulting rows.
-     *
-     * @param bindParameters - The bind parameters for executing the statement.
-     */
-    *iterate(...bindParameters) {
-        this.stmt.reset();
-        bindParams(this.stmt, bindParameters);
-        while (true) {
-            const stepResult = this.stmt.step();
-            if (stepResult === STEP_IO) {
-                this.db.db.ioLoopSync();
-                continue;
-            }
-            if (stepResult === STEP_DONE) {
-                break;
-            }
-            if (stepResult === STEP_ROW) {
-                yield this.stmt.row();
-            }
-        }
-    }
-    /**
-     * Executes the SQL statement and returns an array of the resulting rows.
-     *
-     * @param bindParameters - The bind parameters for executing the statement.
-     */
-    all(...bindParameters) {
-        this.stmt.reset();
-        bindParams(this.stmt, bindParameters);
-        const rows = [];
-        for (;;) {
-            const stepResult = this.stmt.step();
-            if (stepResult === STEP_IO) {
-                this.db.db.ioLoopSync();
-                continue;
-            }
-            if (stepResult === STEP_DONE) {
-                break;
-            }
-            if (stepResult === STEP_ROW) {
-                rows.push(this.stmt.row());
-            }
-        }
-        return rows;
-    }
-    /**
-     * Interrupts the statement.
-     */
-    interrupt() {
-        throw new Error("not implemented");
-    }
-    /**
-     * Binds the given parameters to the statement _permanently_
-     *
-     * @param bindParameters - The bind parameters for binding the statement.
-     * @returns this - Statement with binded parameters
-     */
-    bind(...bindParameters) {
-        try {
-            bindParams(this.stmt, bindParameters);
-            return this;
-        }
-        catch (err) {
-            throw convertError(err);
-        }
+        super(new NativeDB(path, { tracing: opts.tracing }), opts);
     }
 }
 export { Database, SqliteError };

package/dist/compat.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=compat.test.d.ts.map

package/dist/compat.test.d.ts.map

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

package/dist/compat.test.js

@@ -0,0 +1,62 @@
+import { unlinkSync } from "node:fs";
+import { expect, test } from 'vitest';
+import { Database } from './compat.js';
+test('in-memory db', () => {
+    const db = new Database(":memory:");
+    db.exec("CREATE TABLE t(x)");
+    db.exec("INSERT INTO t VALUES (1), (2), (3)");
+    const stmt = db.prepare("SELECT * FROM t WHERE x % 2 = ?");
+    const rows = stmt.all([1]);
+    expect(rows).toEqual([{ x: 1 }, { x: 3 }]);
+});
+test('on-disk db', () => {
+    const path = `test-${(Math.random() * 10000) | 0}.db`;
+    try {
+        const db1 = new Database(path);
+        db1.exec("CREATE TABLE t(x)");
+        db1.exec("INSERT INTO t VALUES (1), (2), (3)");
+        const stmt1 = db1.prepare("SELECT * FROM t WHERE x % 2 = ?");
+        expect(stmt1.columns()).toEqual([{ name: "x", column: null, database: null, table: null, type: null }]);
+        const rows1 = stmt1.all([1]);
+        expect(rows1).toEqual([{ x: 1 }, { x: 3 }]);
+        db1.close();
+        const db2 = new Database(path);
+        const stmt2 = db2.prepare("SELECT * FROM t WHERE x % 2 = ?");
+        expect(stmt2.columns()).toEqual([{ name: "x", column: null, database: null, table: null, type: null }]);
+        const rows2 = stmt2.all([1]);
+        expect(rows2).toEqual([{ x: 1 }, { x: 3 }]);
+        db2.close();
+    }
+    finally {
+        unlinkSync(path);
+        unlinkSync(`${path}-wal`);
+    }
+});
+test('attach', () => {
+    const path1 = `test-${(Math.random() * 10000) | 0}.db`;
+    const path2 = `test-${(Math.random() * 10000) | 0}.db`;
+    try {
+        const db1 = new Database(path1);
+        db1.exec("CREATE TABLE t(x)");
+        db1.exec("INSERT INTO t VALUES (1), (2), (3)");
+        const db2 = new Database(path2);
+        db2.exec("CREATE TABLE q(x)");
+        db2.exec("INSERT INTO q VALUES (4), (5), (6)");
+        db1.exec(`ATTACH '${path2}' as secondary`);
+        const stmt = db1.prepare("SELECT * FROM t UNION ALL SELECT * FROM secondary.q");
+        expect(stmt.columns()).toEqual([{ name: "x", column: null, database: null, table: null, type: null }]);
+        const rows = stmt.all([1]);
+        expect(rows).toEqual([{ x: 1 }, { x: 2 }, { x: 3 }, { x: 4 }, { x: 5 }, { x: 6 }]);
+    }
+    finally {
+        unlinkSync(path1);
+        unlinkSync(`${path1}-wal`);
+        unlinkSync(path2);
+        unlinkSync(`${path2}-wal`);
+    }
+});
+test('blobs', () => {
+    const db = new Database(":memory:");
+    const rows = db.prepare("SELECT x'1020' as x").all();
+    expect(rows).toEqual([{ x: Buffer.from([16, 32]) }]);
+});

package/dist/promise.d.ts

@@ -0,0 +1,14 @@
+import { DatabasePromise, SqliteError, DatabaseOpts } from "@tursodatabase/database-common";
+declare class Database extends DatabasePromise {
+    constructor(path: string, opts?: DatabaseOpts);
+}
+/**
+ * Creates a new database connection asynchronously.
+ *
+ * @param {string} path - Path to the database file.
+ * @param {Object} opts - Options for database behavior.
+ * @returns {Promise<Database>} - A promise that resolves to a Database instance.
+ */
+declare function connect(path: string, opts?: any): Promise<Database>;
+export { connect, Database, SqliteError };
+//# sourceMappingURL=promise.d.ts.map

package/dist/promise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise.d.ts","sourceRoot":"","sources":["../promise.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAkB,WAAW,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAA;AAG3G,cAAM,QAAS,SAAQ,eAAe;gBACtB,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,YAAiB;CAGpD;AAED;;;;;;GAMG;AACH,iBAAe,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAEtE;AAED,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAA"}