@tursodatabase/database 0.1.4-pre.10

package/README.md

@@ -0,0 +1,129 @@
+<p align="center">
+  <h1 align="center">Turso Database for JavaScript</h1>
+</p>
+
+<p align="center">
+  <a title="JavaScript" target="_blank" href="https://www.npmjs.com/package/@tursodatabase/database"><img alt="npm" src="https://img.shields.io/npm/v/@tursodatabase/database"></a>
+  <a title="MIT" target="_blank" href="https://github.com/tursodatabase/turso/blob/main/LICENSE.md"><img src="http://img.shields.io/badge/license-MIT-orange.svg?style=flat-square"></a>
+</p>
+<p align="center">
+  <a title="Users Discord" target="_blank" href="https://tur.so/discord"><img alt="Chat with other users of Turso on Discord" src="https://img.shields.io/discord/933071162680958986?label=Discord&logo=Discord&style=social"></a>
+</p>
+
+---
+
+## About
+
+This package is the Turso in-memory database library for JavaScript.
+
+> **⚠️ 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.
+
+## Features
+
+- **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, macOS, Windows and browsers (through WebAssembly)
+
+## Installation
+
+```bash
+npm install @tursodatabase/database
+```
+
+## Getting Started
+
+### In-Memory Database
+
+```javascript
+import { connect } from '@tursodatabase/database';
+
+// Create an in-memory database
+const db = await connect(':memory:');
+
+// Create a table
+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');
+
+// Query data
+const users = db.prepare('SELECT * FROM users').all();
+console.log(users);
+// Output: [
+//   { id: 1, name: 'Alice', email: 'alice@example.com' },
+//   { id: 2, name: 'Bob', email: 'bob@example.com' }
+// ]
+```
+
+### File-Based Database
+
+```javascript
+import { connect } from '@tursodatabase/database';
+
+// Create or open a database file
+const db = await connect('my-database.db');
+
+// Create a table
+db.exec(`
+  CREATE TABLE IF NOT EXISTS posts (
+    id INTEGER PRIMARY KEY AUTOINCREMENT,
+    title TEXT NOT NULL,
+    content TEXT,
+    created_at DATETIME DEFAULT CURRENT_TIMESTAMP
+  )
+`);
+
+// 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!');
+
+console.log(`Inserted post with ID: ${result.lastInsertRowid}`);
+```
+
+### Transactions
+
+```javascript
+import { connect } from '@tursodatabase/database';
+
+const db = await connect('transactions.db');
+
+// Using transactions for atomic operations
+const transaction = db.transaction((users) => {
+  const insert = db.prepare('INSERT INTO users (name, email) VALUES (?, ?)');
+  for (const user of users) {
+    insert.run(user.name, user.email);
+  }
+});
+
+// Execute transaction
+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).
+
+## Related Packages
+
+* The [@tursodatabase/serverless](https://www.npmjs.com/package/@tursodatabase/serverless) package provides a serverless driver with the same API.
+* The [@tursodatabase/sync](https://www.npmjs.com/package/@tursodatabase/sync) package provides bidirectional sync between a local Turso database and Turso Cloud. 
+
+## License
+
+This project is licensed under the [MIT license](../../LICENSE.md).
+
+## Support
+
+- [GitHub Issues](https://github.com/tursodatabase/turso/issues)
+- [Documentation](https://docs.turso.tech)
+- [Discord Community](https://tur.so/discord)

package/browser.js

@@ -0,0 +1 @@
+export * from '@tursodatabase/database-wasm32-wasi'

package/dist/bind.js

@@ -0,0 +1,64 @@
+// Bind parameters to a statement.
+//
+// This function is used to bind parameters to a statement. It supports both
+// named and positional parameters, and nested arrays.
+//
+// The `stmt` parameter is a statement object.
+// The `params` parameter is an array of parameters.
+//
+// The function returns void.
+export function bindParams(stmt, params) {
+    const len = params?.length;
+    if (len === 0) {
+        return;
+    }
+    if (len === 1) {
+        const param = params[0];
+        if (isPlainObject(param)) {
+            bindNamedParams(stmt, param);
+            return;
+        }
+        bindValue(stmt, 1, param);
+        return;
+    }
+    bindPositionalParams(stmt, params);
+}
+// Check if object is plain (no prototype chain)
+function isPlainObject(obj) {
+    if (!obj || typeof obj !== 'object')
+        return false;
+    const proto = Object.getPrototypeOf(obj);
+    return proto === Object.prototype || proto === null;
+}
+// Handle named parameters
+function bindNamedParams(stmt, paramObj) {
+    const paramCount = stmt.parameterCount();
+    for (let i = 1; i <= paramCount; i++) {
+        const paramName = stmt.parameterName(i);
+        if (paramName) {
+            const key = paramName.substring(1); // Remove ':' or '$' prefix
+            const value = paramObj[key];
+            if (value !== undefined) {
+                bindValue(stmt, i, value);
+            }
+        }
+    }
+}
+// Handle positional parameters (including nested arrays)
+function bindPositionalParams(stmt, params) {
+    let bindIndex = 1;
+    for (let i = 0; i < params.length; i++) {
+        const param = params[i];
+        if (Array.isArray(param)) {
+            for (let j = 0; j < param.length; j++) {
+                bindValue(stmt, bindIndex++, param[j]);
+            }
+        }
+        else {
+            bindValue(stmt, bindIndex++, param);
+        }
+    }
+}
+function bindValue(stmt, index, value) {
+    stmt.bindAt(index, value);
+}

package/dist/compat.js

@@ -0,0 +1,367 @@
+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).
+     */
+    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);
+        }
+    }
+}
+export { Database, SqliteError };