@orkestrel/database 0.0.5 → 0.0.6

package/dist/src/server/index.js

@@ -1,28 +1,10 @@
+import { DatabaseError, MemoryDriver, applyCriteria, computeAggregate, extractKey, filterRows, isDriverMeta, matchesCriteria } from "../core/index.js";
 import { isBoolean, isFiniteNumber, isRecord, isString } from "@orkestrel/contract";
 import { randomUUID } from "node:crypto";
-import { DatabaseError, MemoryDriver, applyCriteria, computeAggregate, extractKey, filterRows, isDriverMeta, matchesCriteria } from "../core/index.js";
 import { mkdir, readFile, rename, rm, writeFile } from "node:fs/promises";
 import { dirname } from "node:path";
 import { createSQLiteDatabase, isSQLiteError } from "@orkestrel/sqlite";
-//#region src/server/helpers.ts
-/**
-* Generate a fresh unique key — a v4 UUID string, backed by `node:crypto`.
-*
-* @remarks
-* Supply this as {@link import('@orkestrel/database').DatabaseOptions.key} so a table mints
-* a key when a written row lacks its primary-key value. Strings work as keys on
-* every backend; supply your own key values directly to use numeric keys instead.
-*
-* @returns A new UUID string
-*
-* @example
-* ```ts
-* const db = createDatabase({ driver, tables, key: generateKey })
-* ```
-*/
-function generateKey() {
-	return randomUUID();
-}
+//#region src/server/constants.ts
 /**
 * The declared {@link ColumnType}s whose SQL EQUALITY comparisons (`equals` /
 * `not` / `any` / `none`) and `starts` / `ends` compiles are provably
@@ -45,12 +27,12 @@ function generateKey() {
 * values are BMP-only, or a custom SQLite collation matching `compareValues`
 * is registered) could restore native text ranges/ordering.
 */
-var EXACT_COLUMN_TYPES = [
+var EXACT_COLUMN_TYPES = Object.freeze([
 	"text",
 	"integer",
 	"real",
 	"boolean"
-];
+]);
 /**
 * The declared {@link ColumnType}s whose SQL RANGE comparisons
 * (`above` / `below` / `from` / `to` / `between`) and `ORDER BY` compiles are
@@ -59,11 +41,41 @@ var EXACT_COLUMN_TYPES = [
 * (code-point) vs. JS `<` (code-unit) divergence on supplementary-plane
 * characters.
 */
-var EXACT_RANGE_COLUMN_TYPES = [
+var EXACT_RANGE_COLUMN_TYPES = Object.freeze([
 	"integer",
 	"real",
 	"boolean"
-];
+]);
+/**
+* The reserved metadata table the {@link SQLiteDriver} creates on `open` to
+* persist its stamped `DriverMeta` (`version` + declared schema JSON) — the
+* SQLite realization of the `meta` / `stamp` driver hooks.
+*
+* @remarks
+* A single-row table (`id = 1`). A user table named `_meta` collides with the
+* reservation — the caller's concern to avoid, documented on the driver class.
+*/
+var META_TABLE = "_meta";
+//#endregion
+//#region src/server/helpers.ts
+/**
+* Generate a fresh unique key — a v4 UUID string, backed by `node:crypto`.
+*
+* @remarks
+* Supply this as {@link import('@orkestrel/database').DatabaseOptions.key} so a table mints
+* a key when a written row lacks its primary-key value. Strings work as keys on
+* every backend; supply your own key values directly to use numeric keys instead.
+*
+* @returns A new UUID string
+*
+* @example
+* ```ts
+* const db = createDatabase({ driver, tables, key: generateKey })
+* ```
+*/
+function generateKey() {
+	return randomUUID();
+}
 /**
 * Whether a value's runtime type matches a column's declared exact type —
 * the operand side of the declared-type-trust proof.
@@ -253,8 +265,10 @@ function quote(identifier) {
 */
 function fieldColumn(path) {
 	if (isString(path)) return quote(path);
-	const rest = path.slice(1).map((key) => "." + key.replaceAll("'", "''")).join("");
-	return "json_extract(" + quote(path[0]) + ", '$" + rest + "')";
+	const [column, ...nested] = path;
+	if (column === void 0) throw new DatabaseError("VALIDATION", "A field path must contain at least one column");
+	const rest = nested.map((key) => "." + key.replaceAll("'", "''")).join("");
+	return "json_extract(" + quote(column) + ", '$" + rest + "')";
 }
 /**
 * Compile an {@link AggregateFunction} over a {@link FieldPath} to its SQL
@@ -372,6 +386,37 @@ function encodeRow(row, schema) {
 	return result;
 }
 /**
+* Extract a stored row's values in a declared positional order.
+*
+* @remarks
+* SQLite statements bind arrays positionally. Every requested column must be
+* present in `row`; an incomplete backend row is a typed `DRIVER` fault carrying
+* the table and missing column in its context.
+*
+* @param row - The stored SQLite row
+* @param names - The column names in binding order
+* @param table - The owning table name for fault context
+* @returns The row values in the same order as `names`
+* @throws A `DRIVER` {@link DatabaseError} when a requested column is missing
+*
+* @example
+* ```ts
+* extractValues({ id: 'u1', age: 36 }, ['age', 'id'], 'users') // [36, 'u1']
+* ```
+*/
+function extractValues(row, names, table) {
+	const values = [];
+	for (const name of names) {
+		const value = row[name];
+		if (value === void 0) throw new DatabaseError("DRIVER", "SQLite row is missing a declared column", {
+			table,
+			column: name
+		});
+		values.push(value);
+	}
+	return values;
+}
+/**
 * Decode a stored {@link SQLiteRow} back to a {@link Row} by its table's schema.
 *
 * @remarks
@@ -394,7 +439,9 @@ function encodeRow(row, schema) {
 function decodeRow(row, schema) {
 	const result = {};
 	for (const column of schema.columns) {
-		const decoded = decodeValue(row[column.name], column.type);
+		const value = row[column.name];
+		if (value === void 0) continue;
+		const decoded = decodeValue(value, column.type);
 		if (decoded !== void 0) result[column.name] = decoded;
 	}
 	return result;
@@ -567,8 +614,10 @@ function stepToSchema(schema, step) {
 * ```
 */
 function jsonTypeColumn(path) {
-	const rest = path.slice(1).map((key) => "." + key.replaceAll("'", "''")).join("");
-	return "json_type(" + quote(path[0]) + ", '$" + rest + "')";
+	const [column, ...nested] = path;
+	if (column === void 0) throw new DatabaseError("VALIDATION", "A field path must contain at least one column");
+	const rest = nested.map((key) => "." + key.replaceAll("'", "''")).join("");
+	return "json_type(" + quote(column) + ", '$" + rest + "')";
 }
 /**
 * Escape `\`, `%`, and `_` (each with a leading `\`) so a `starts` / `ends`
@@ -703,21 +752,21 @@ function fragment(condition, schema) {
 	const column = fieldColumn(condition.column);
 	const nested = !isString(condition.column);
 	const declared = isString(condition.column) ? declaredType(condition.column, schema) : void 0;
-	const encode = (value) => encodeValue(value, nested ? valueType(value) : declared ?? "json");
 	const first = condition.values[0];
 	const second = condition.values[1];
 	const nullOperand = first === null || first === void 0;
 	const jsonType = !isString(condition.column) ? jsonTypeColumn(condition.column) : "";
+	let sql;
+	let values;
 	switch (condition.operator) {
 		case "equals":
 			if (nullOperand && nested) return {
 				sql: jsonType + " = 'null'",
 				params: []
 			};
-			return {
-				sql: column + " = ?",
-				params: [encode(first)]
-			};
+			sql = column + " = ?";
+			values = [first];
+			break;
 		case "not":
 			if (nullOperand) {
 				if (nested) return {
@@ -729,38 +778,37 @@ function fragment(condition, schema) {
 					params: []
 				};
 			}
-			return {
-				sql: "(" + column + " != ? OR " + column + " IS NULL)",
-				params: [encode(first)]
-			};
-		case "above": return {
-			sql: column + " > ?",
-			params: [encode(first)]
-		};
-		case "below": return {
-			sql: "(" + column + " < ? OR " + column + " IS NULL)",
-			params: [encode(first)]
-		};
-		case "from": return {
-			sql: column + " >= ?",
-			params: [encode(first)]
-		};
-		case "to": return {
-			sql: "(" + column + " <= ? OR " + column + " IS NULL)",
-			params: [encode(first)]
-		};
-		case "between": return {
-			sql: column + " BETWEEN ? AND ?",
-			params: [encode(first), encode(second)]
-		};
-		case "like": return {
-			sql: column + " LIKE ?",
-			params: [encode(first)]
-		};
-		case "glob": return {
-			sql: column + " GLOB ?",
-			params: [encode(first)]
-		};
+			sql = "(" + column + " != ? OR " + column + " IS NULL)";
+			values = [first];
+			break;
+		case "above":
+			sql = column + " > ?";
+			values = [first];
+			break;
+		case "below":
+			sql = "(" + column + " < ? OR " + column + " IS NULL)";
+			values = [first];
+			break;
+		case "from":
+			sql = column + " >= ?";
+			values = [first];
+			break;
+		case "to":
+			sql = "(" + column + " <= ? OR " + column + " IS NULL)";
+			values = [first];
+			break;
+		case "between":
+			sql = column + " BETWEEN ? AND ?";
+			values = [first, second];
+			break;
+		case "like":
+			sql = column + " LIKE ?";
+			values = [first];
+			break;
+		case "glob":
+			sql = column + " GLOB ?";
+			values = [first];
+			break;
 		case "starts": {
 			const text = isString(first) ? first : "";
 			if (text === "") return {
@@ -768,10 +816,9 @@ function fragment(condition, schema) {
 				params: []
 			};
 			const length = Array.from(text).length;
-			return {
-				sql: "(typeof(" + column + ") = 'text' AND substr(" + column + ", 1, " + length + ") = ?)",
-				params: [encode(first)]
-			};
+			sql = "(typeof(" + column + ") = 'text' AND substr(" + column + ", 1, " + length + ") = ?)";
+			values = [first];
+			break;
 		}
 		case "ends": {
 			const text = isString(first) ? first : "";
@@ -780,29 +827,26 @@ function fragment(condition, schema) {
 				params: []
 			};
 			const length = Array.from(text).length;
-			return {
-				sql: "(typeof(" + column + ") = 'text' AND substr(" + column + ", -" + length + ") = ?)",
-				params: [encode(first)]
-			};
+			sql = "(typeof(" + column + ") = 'text' AND substr(" + column + ", -" + length + ") = ?)";
+			values = [first];
+			break;
 		}
 		case "any":
 			if (condition.values.length === 0) return {
 				sql: "0",
 				params: []
 			};
-			return {
-				sql: column + " IN (" + condition.values.map(() => "?").join(", ") + ")",
-				params: condition.values.map(encode)
-			};
+			sql = column + " IN (" + condition.values.map(() => "?").join(", ") + ")";
+			values = condition.values;
+			break;
 		case "none":
 			if (condition.values.length === 0) return {
 				sql: "1",
 				params: []
 			};
-			return {
-				sql: "(" + column + " NOT IN (" + condition.values.map(() => "?").join(", ") + ") OR " + column + " IS NULL)",
-				params: condition.values.map(encode)
-			};
+			sql = "(" + column + " NOT IN (" + condition.values.map(() => "?").join(", ") + ") OR " + column + " IS NULL)";
+			values = condition.values;
+			break;
 		case "absent": return {
 			sql: column + " IS NULL",
 			params: []
@@ -812,6 +856,10 @@ function fragment(condition, schema) {
 			params: []
 		};
 	}
+	return {
+		sql,
+		params: values.map((value) => encodeValue(value, nested ? valueType(value) : declared ?? "json"))
+	};
 }
 /**
 * Fold the conditions into one WHERE clause, parenthesizing progressively
@@ -835,16 +883,17 @@ function fragment(condition, schema) {
 * ```
 */
 function compileWhere(conditions, schema) {
-	if (conditions.length === 0) return {
+	const [first, ...remaining] = conditions;
+	if (first === void 0) return {
 		sql: "",
 		params: []
 	};
-	const head = fragment(conditions[0], schema);
+	const head = fragment(first, schema);
 	let clause = head.sql;
 	const params = [...head.params];
-	for (let index = 1; index < conditions.length; index += 1) {
-		const next = fragment(conditions[index], schema);
-		const operator = conditions[index].connector === "or" ? "OR" : "AND";
+	for (const condition of remaining) {
+		const next = fragment(condition, schema);
+		const operator = condition.connector === "or" ? "OR" : "AND";
 		clause = "(" + clause + " " + operator + " " + next.sql + ")";
 		params.push(...next.params);
 	}
@@ -961,18 +1010,6 @@ function compileCriteria(criteria, schema) {
 	};
 }
 //#endregion
-//#region src/server/constants.ts
-/**
-* The reserved metadata table the {@link SQLiteDriver} creates on `open` to
-* persist its stamped `DriverMeta` (`version` + declared schema JSON) — the
-* SQLite realization of the `meta` / `stamp` driver hooks.
-*
-* @remarks
-* A single-row table (`id = 1`). A user table named `_meta` collides with the
-* reservation — the caller's concern to avoid, documented on the driver class.
-*/
-var META_TABLE = "_meta";
-//#endregion
 //#region src/server/drivers/JSONDriver.ts
 /**
 * A persistent {@link DriverInterface} backed by a single JSON file — the
@@ -1012,6 +1049,7 @@ var JSONDriver = class {
 	#flushCount = 0;
 	#chain = Promise.resolve();
 	#deferring = false;
+	#transaction;
 	constructor(path) {
 		this.#path = path;
 	}
@@ -1080,22 +1118,12 @@ var JSONDriver = class {
 	async transaction() {
 		if (this.#deferring) throw new DatabaseError("CONFLICT", "A transaction is already active on this driver", {});
 		const rollback = await this.#memory.snapshot();
+		const token = {};
 		this.#deferring = true;
-		let settled = false;
+		this.#transaction = token;
 		return {
-			commit: async () => {
-				if (settled) throw new DatabaseError("CONFLICT", "Transaction already settled", {});
-				settled = true;
-				this.#deferring = false;
-				await this.#flush();
-			},
-			rollback: async () => {
-				if (settled) throw new DatabaseError("CONFLICT", "Transaction already settled", {});
-				settled = true;
-				await rollback();
-				this.#deferring = false;
-				await this.#flush();
-			}
+			commit: this.#commit.bind(this, token),
+			rollback: this.#rollback.bind(this, token, rollback)
 		};
 	}
 	async snapshot(tables) {
@@ -1148,6 +1176,19 @@ var JSONDriver = class {
 		this.#schema = schema;
 		await this.#flush();
 	}
+	async #commit(token) {
+		if (this.#transaction !== token) throw new DatabaseError("CONFLICT", "Transaction already settled", {});
+		this.#transaction = void 0;
+		this.#deferring = false;
+		await this.#flush();
+	}
+	async #rollback(token, rollback) {
+		if (this.#transaction !== token) throw new DatabaseError("CONFLICT", "Transaction already settled", {});
+		this.#transaction = void 0;
+		await rollback();
+		this.#deferring = false;
+		await this.#flush();
+	}
 	async #load() {
 		let raw;
 		try {
@@ -1260,7 +1301,7 @@ var SQLiteDriver = class {
 	#options;
 	#database;
 	#schema = /* @__PURE__ */ new Map();
-	#transacting = false;
+	#transaction;
 	constructor(path, options) {
 		this.#path = path;
 		this.#options = options ?? {};
@@ -1271,9 +1312,9 @@ var SQLiteDriver = class {
 			this.#database?.close();
 			const database = createSQLiteDatabase({
 				path: this.#path,
-				readonly: this.#options.readonly,
-				timeout: this.#options.timeout,
-				foreignKeys: this.#options.foreignKeys
+				...this.#options.readonly !== void 0 ? { readonly: this.#options.readonly } : {},
+				...this.#options.timeout !== void 0 ? { timeout: this.#options.timeout } : {},
+				...this.#options.foreignKeys !== void 0 ? { foreignKeys: this.#options.foreignKeys } : {}
 			});
 			database.connect();
 			for (const [name, value] of Object.entries(this.#options.pragmas ?? {})) database.pragma(name, value);
@@ -1307,7 +1348,7 @@ var SQLiteDriver = class {
 				[schema.primary]: key
 			}, schema);
 			const names = schema.columns.map((column) => column.name);
-			const values = names.map((name) => encoded[name]);
+			const values = extractValues(encoded, names, table);
 			this.#require().prepare("INSERT OR REPLACE INTO " + quote(table) + " (" + names.map(quote).join(", ") + ") VALUES (" + names.map(() => "?").join(", ") + ")").run(values);
 		});
 	}
@@ -1387,8 +1428,8 @@ var SQLiteDriver = class {
 		if (conditions.every((condition) => isExactCondition(condition, schema))) {
 			const compiled = compileCriteria({
 				conditions,
-				limit: criteria.limit,
-				offset: criteria.offset
+				...criteria.limit !== void 0 ? { limit: criteria.limit } : {},
+				...criteria.offset !== void 0 ? { offset: criteria.offset } : {}
 			}, schema);
 			for (const row of this.#require().prepare("SELECT * FROM " + quote(table) + (compiled.sql === "" ? "" : " " + compiled.sql)).iterate(compiled.params)) yield decodeRow(row, schema);
 			return;
@@ -1420,21 +1461,11 @@ var SQLiteDriver = class {
 	async transaction() {
 		const database = this.#require();
 		this.#guard(() => database.exec("BEGIN"));
-		let settled = false;
-		this.#transacting = true;
+		const token = {};
+		this.#transaction = token;
 		return {
-			commit: async () => {
-				if (settled) throw new DatabaseError("CONFLICT", "Transaction already settled", {});
-				settled = true;
-				this.#transacting = false;
-				this.#guard(() => database.exec("COMMIT"));
-			},
-			rollback: async () => {
-				if (settled) throw new DatabaseError("CONFLICT", "Transaction already settled", {});
-				settled = true;
-				this.#transacting = false;
-				this.#guard(() => database.exec("ROLLBACK"));
-			}
+			commit: this.#commit.bind(this, token, database),
+			rollback: this.#rollback.bind(this, token, database)
 		};
 	}
 	/**
@@ -1464,7 +1495,7 @@ var SQLiteDriver = class {
 		const database = this.#require();
 		const schema = new Map(this.#schema);
 		this.#guard(() => {
-			if (this.#transacting) this.#applyPlan(database, plan, schema);
+			if (this.#transaction !== void 0) this.#applyPlan(database, plan, schema);
 			else database.transaction(() => this.#applyPlan(database, plan, schema));
 		});
 		this.#schema = schema;
@@ -1524,11 +1555,21 @@ var SQLiteDriver = class {
 				for (const [name, snapshot] of captured) {
 					current.exec("DELETE FROM " + quote(name));
 					const statement = current.prepare("INSERT OR REPLACE INTO " + quote(name) + " (" + snapshot.names.map(quote).join(", ") + ") VALUES (" + snapshot.names.map(() => "?").join(", ") + ")");
-					for (const row of snapshot.rows) statement.run(snapshot.names.map((column) => row[column]));
+					for (const row of snapshot.rows) statement.run(extractValues(row, snapshot.names, name));
 				}
 			});
 		};
 	}
+	async #commit(token, database) {
+		if (this.#transaction !== token) throw new DatabaseError("CONFLICT", "Transaction already settled", {});
+		this.#transaction = void 0;
+		this.#guard(() => database.exec("COMMIT"));
+	}
+	async #rollback(token, database) {
+		if (this.#transaction !== token) throw new DatabaseError("CONFLICT", "Transaction already settled", {});
+		this.#transaction = void 0;
+		this.#guard(() => database.exec("ROLLBACK"));
+	}
 	#guard(run) {
 		try {
 			return run();
@@ -1658,6 +1699,6 @@ function createSQLiteDriver(options = ":memory:") {
 	return new SQLiteDriver(resolved.path ?? ":memory:", resolved);
 }
 //#endregion
-export { EXACT_COLUMN_TYPES, EXACT_RANGE_COLUMN_TYPES, JSONDriver, META_TABLE, SQLiteDriver, aggregateSQL, columnSQL, compileCriteria, compileOrder, compilePage, compileWhere, createJSONDriver, createSQLiteDriver, declaredType, decodeRow, decodeValue, encodeRow, encodeValue, escapeLike, fieldColumn, fragment, generateKey, indexName, isExactCondition, isExactCriteria, isExactOrder, jsonTypeColumn, matchesDeclaredType, quote, schemaToIndexes, schemaToTable, stepToSQL, stepToSchema, valueType };
+export { EXACT_COLUMN_TYPES, EXACT_RANGE_COLUMN_TYPES, JSONDriver, META_TABLE, SQLiteDriver, aggregateSQL, columnSQL, compileCriteria, compileOrder, compilePage, compileWhere, createJSONDriver, createSQLiteDriver, declaredType, decodeRow, decodeValue, encodeRow, encodeValue, escapeLike, extractValues, fieldColumn, fragment, generateKey, indexName, isExactCondition, isExactCriteria, isExactOrder, jsonTypeColumn, matchesDeclaredType, quote, schemaToIndexes, schemaToTable, stepToSQL, stepToSchema, valueType };
 
 //# sourceMappingURL=index.js.map