@monlite/core 1.2.0 → 1.3.0

package/dist/index.d.cts

@@ -140,6 +140,48 @@ interface MonlitePlugin {
     collectionMethods?: Record<string, (collection: Collection<any>, ...args: any[]) => any>;
 }
 
+/**
+ * The minimal SQLite driver surface monlite needs. Implemented by both the
+ * better-sqlite3 and the built-in node:sqlite backends so the rest of the
+ * codebase is engine-agnostic.
+ */
+interface RunResult {
+    changes: number;
+    lastInsertRowid: number | bigint;
+}
+interface PreparedStatement {
+    run(...params: any[]): RunResult;
+    get(...params: any[]): any;
+    all(...params: any[]): any[];
+}
+interface Driver {
+    /** Backend identifier, e.g. "better-sqlite3" or "node:sqlite". */
+    readonly name: string;
+    exec(sql: string): void;
+    prepare(sql: string): PreparedStatement;
+    /** Run `fn` inside a transaction; rolls back and rethrows if it throws. */
+    transaction<T>(fn: () => T): T;
+    close(): void;
+    /** Rotate the encryption key (encrypted backends only). */
+    rekey?(key: string, cipher?: string): void;
+    /** The underlying native handle (better-sqlite3 Database / node:sqlite DatabaseSync). */
+    readonly raw: any;
+}
+interface DriverOpenOptions {
+    readonly?: boolean;
+    wal?: boolean;
+    /** Milliseconds to wait on a locked database before erroring. Default 5000. */
+    busyTimeout?: number;
+    /** Allow loading SQLite extensions (needed by `@monlite/vector`). Default false. */
+    allowExtensions?: boolean;
+    /** Encrypt the database at rest (better-sqlite3-multiple-ciphers only). */
+    encryption?: {
+        key: string;
+        cipher?: string;
+    };
+    verbose?: (sql: string) => void;
+}
+
 /**
  * Public type surface for monlite.
  *
@@ -396,8 +438,10 @@ interface MonliteOptions {
     /**
      * Which SQLite backend to use. `"auto"` (default) prefers `better-sqlite3`
      * when installed, otherwise the built-in `node:sqlite` (Node >= 22.5).
+     * You can also pass a custom {@link Driver} instance (e.g. `@monlite/wasm`
+     * for the browser).
      */
-    driver?: DriverName;
+    driver?: DriverName | Driver;
     /**
      * Encrypt the database at rest. Requires the `better-sqlite3-multiple-ciphers`
      * package (a drop-in for `better-sqlite3`); not supported on `node:sqlite`.
@@ -433,34 +477,6 @@ interface MonliteOptions {
     verbose?: (sql: string) => void;
 }
 
-/**
- * The minimal SQLite driver surface monlite needs. Implemented by both the
- * better-sqlite3 and the built-in node:sqlite backends so the rest of the
- * codebase is engine-agnostic.
- */
-interface RunResult {
-    changes: number;
-    lastInsertRowid: number | bigint;
-}
-interface PreparedStatement {
-    run(...params: any[]): RunResult;
-    get(...params: any[]): any;
-    all(...params: any[]): any[];
-}
-interface Driver {
-    /** Backend identifier, e.g. "better-sqlite3" or "node:sqlite". */
-    readonly name: string;
-    exec(sql: string): void;
-    prepare(sql: string): PreparedStatement;
-    /** Run `fn` inside a transaction; rolls back and rethrows if it throws. */
-    transaction<T>(fn: () => T): T;
-    close(): void;
-    /** Rotate the encryption key (encrypted backends only). */
-    rekey?(key: string, cipher?: string): void;
-    /** The underlying native handle (better-sqlite3 Database / node:sqlite DatabaseSync). */
-    readonly raw: any;
-}
-
 /**
  * Tracks which JSON paths are queried per collection and silently creates a
  * SQLite expression index once a path crosses the configured threshold.
@@ -772,4 +788,4 @@ declare function objectId(): string;
 /** True when a value looks like a monlite/ObjectId id (24 hex chars). */
 declare function isObjectId(value: unknown): value is string;
 
-export { type AggregateArgs, type AggregateResult, type ApplyResult, Collection, type CollectionMode, type CollectionOptions, type CollectionSchema, type ColumnDef, type ColumnInfo, type ColumnType, type ConflictResolver, type ConflictRow, type CountArgs, type CreateArgs, type CreateManyArgs, Monlite as Db, type DeleteArgs, type Doc, type Driver, type DriverName, type EncryptionOptions, type ExplainResult, type FieldFilter, type FieldSelection, type FilterInput, type FindFirstArgs, type FindManyArgs, type GroupByArgs, type GroupByResult, type HavingComparison, type HavingInput, type LiveEvent, type LocalChange, type MigrateOptions, Monlite, MonliteConstraintError, MonliteEncryptionError, MonliteError, MonliteForeignKeyError, MonliteNotNullError, type MonliteOptions, type MonlitePlugin, MonliteQueryError, MonliteUniqueConstraintError, type OrderBy, type PluginChange, type PreparedStatement, type RemoteChange, type Select, type SortOrder, type SyncOp, type SyncStateRow, SyncStore, type SystemFields, type UpdateArgs, type UpdateData, type UpdateOperators, type UpsertArgs, type Version, type WatchHandle, type WhereInput as WhereClause, type WhereInput, type WithId, compareVersions, createDb, isObjectId, makeVersion, normalizeDriverError, objectId, versionTs };
+export { type AggregateArgs, type AggregateResult, type ApplyResult, Collection, type CollectionMode, type CollectionOptions, type CollectionSchema, type ColumnDef, type ColumnInfo, type ColumnType, type ConflictResolver, type ConflictRow, type CountArgs, type CreateArgs, type CreateManyArgs, Monlite as Db, type DeleteArgs, type Doc, type Driver, type DriverName, type DriverOpenOptions, type EncryptionOptions, type ExplainResult, type FieldFilter, type FieldSelection, type FilterInput, type FindFirstArgs, type FindManyArgs, type GroupByArgs, type GroupByResult, type HavingComparison, type HavingInput, type LiveEvent, type LocalChange, type MigrateOptions, Monlite, MonliteConstraintError, MonliteEncryptionError, MonliteError, MonliteForeignKeyError, MonliteNotNullError, type MonliteOptions, type MonlitePlugin, MonliteQueryError, MonliteUniqueConstraintError, type OrderBy, type PluginChange, type PreparedStatement, type RemoteChange, type RunResult, type Select, type SortOrder, type SyncOp, type SyncStateRow, SyncStore, type SystemFields, type UpdateArgs, type UpdateData, type UpdateOperators, type UpsertArgs, type Version, type WatchHandle, type WhereInput as WhereClause, type WhereInput, type WithId, compareVersions, createDb, isObjectId, makeVersion, normalizeDriverError, objectId, versionTs };

package/dist/index.d.ts

@@ -140,6 +140,48 @@ interface MonlitePlugin {
     collectionMethods?: Record<string, (collection: Collection<any>, ...args: any[]) => any>;
 }
 
+/**
+ * The minimal SQLite driver surface monlite needs. Implemented by both the
+ * better-sqlite3 and the built-in node:sqlite backends so the rest of the
+ * codebase is engine-agnostic.
+ */
+interface RunResult {
+    changes: number;
+    lastInsertRowid: number | bigint;
+}
+interface PreparedStatement {
+    run(...params: any[]): RunResult;
+    get(...params: any[]): any;
+    all(...params: any[]): any[];
+}
+interface Driver {
+    /** Backend identifier, e.g. "better-sqlite3" or "node:sqlite". */
+    readonly name: string;
+    exec(sql: string): void;
+    prepare(sql: string): PreparedStatement;
+    /** Run `fn` inside a transaction; rolls back and rethrows if it throws. */
+    transaction<T>(fn: () => T): T;
+    close(): void;
+    /** Rotate the encryption key (encrypted backends only). */
+    rekey?(key: string, cipher?: string): void;
+    /** The underlying native handle (better-sqlite3 Database / node:sqlite DatabaseSync). */
+    readonly raw: any;
+}
+interface DriverOpenOptions {
+    readonly?: boolean;
+    wal?: boolean;
+    /** Milliseconds to wait on a locked database before erroring. Default 5000. */
+    busyTimeout?: number;
+    /** Allow loading SQLite extensions (needed by `@monlite/vector`). Default false. */
+    allowExtensions?: boolean;
+    /** Encrypt the database at rest (better-sqlite3-multiple-ciphers only). */
+    encryption?: {
+        key: string;
+        cipher?: string;
+    };
+    verbose?: (sql: string) => void;
+}
+
 /**
  * Public type surface for monlite.
  *
@@ -396,8 +438,10 @@ interface MonliteOptions {
     /**
      * Which SQLite backend to use. `"auto"` (default) prefers `better-sqlite3`
      * when installed, otherwise the built-in `node:sqlite` (Node >= 22.5).
+     * You can also pass a custom {@link Driver} instance (e.g. `@monlite/wasm`
+     * for the browser).
      */
-    driver?: DriverName;
+    driver?: DriverName | Driver;
     /**
      * Encrypt the database at rest. Requires the `better-sqlite3-multiple-ciphers`
      * package (a drop-in for `better-sqlite3`); not supported on `node:sqlite`.
@@ -433,34 +477,6 @@ interface MonliteOptions {
     verbose?: (sql: string) => void;
 }
 
-/**
- * The minimal SQLite driver surface monlite needs. Implemented by both the
- * better-sqlite3 and the built-in node:sqlite backends so the rest of the
- * codebase is engine-agnostic.
- */
-interface RunResult {
-    changes: number;
-    lastInsertRowid: number | bigint;
-}
-interface PreparedStatement {
-    run(...params: any[]): RunResult;
-    get(...params: any[]): any;
-    all(...params: any[]): any[];
-}
-interface Driver {
-    /** Backend identifier, e.g. "better-sqlite3" or "node:sqlite". */
-    readonly name: string;
-    exec(sql: string): void;
-    prepare(sql: string): PreparedStatement;
-    /** Run `fn` inside a transaction; rolls back and rethrows if it throws. */
-    transaction<T>(fn: () => T): T;
-    close(): void;
-    /** Rotate the encryption key (encrypted backends only). */
-    rekey?(key: string, cipher?: string): void;
-    /** The underlying native handle (better-sqlite3 Database / node:sqlite DatabaseSync). */
-    readonly raw: any;
-}
-
 /**
  * Tracks which JSON paths are queried per collection and silently creates a
  * SQLite expression index once a path crosses the configured threshold.
@@ -772,4 +788,4 @@ declare function objectId(): string;
 /** True when a value looks like a monlite/ObjectId id (24 hex chars). */
 declare function isObjectId(value: unknown): value is string;
 
-export { type AggregateArgs, type AggregateResult, type ApplyResult, Collection, type CollectionMode, type CollectionOptions, type CollectionSchema, type ColumnDef, type ColumnInfo, type ColumnType, type ConflictResolver, type ConflictRow, type CountArgs, type CreateArgs, type CreateManyArgs, Monlite as Db, type DeleteArgs, type Doc, type Driver, type DriverName, type EncryptionOptions, type ExplainResult, type FieldFilter, type FieldSelection, type FilterInput, type FindFirstArgs, type FindManyArgs, type GroupByArgs, type GroupByResult, type HavingComparison, type HavingInput, type LiveEvent, type LocalChange, type MigrateOptions, Monlite, MonliteConstraintError, MonliteEncryptionError, MonliteError, MonliteForeignKeyError, MonliteNotNullError, type MonliteOptions, type MonlitePlugin, MonliteQueryError, MonliteUniqueConstraintError, type OrderBy, type PluginChange, type PreparedStatement, type RemoteChange, type Select, type SortOrder, type SyncOp, type SyncStateRow, SyncStore, type SystemFields, type UpdateArgs, type UpdateData, type UpdateOperators, type UpsertArgs, type Version, type WatchHandle, type WhereInput as WhereClause, type WhereInput, type WithId, compareVersions, createDb, isObjectId, makeVersion, normalizeDriverError, objectId, versionTs };
+export { type AggregateArgs, type AggregateResult, type ApplyResult, Collection, type CollectionMode, type CollectionOptions, type CollectionSchema, type ColumnDef, type ColumnInfo, type ColumnType, type ConflictResolver, type ConflictRow, type CountArgs, type CreateArgs, type CreateManyArgs, Monlite as Db, type DeleteArgs, type Doc, type Driver, type DriverName, type DriverOpenOptions, type EncryptionOptions, type ExplainResult, type FieldFilter, type FieldSelection, type FilterInput, type FindFirstArgs, type FindManyArgs, type GroupByArgs, type GroupByResult, type HavingComparison, type HavingInput, type LiveEvent, type LocalChange, type MigrateOptions, Monlite, MonliteConstraintError, MonliteEncryptionError, MonliteError, MonliteForeignKeyError, MonliteNotNullError, type MonliteOptions, type MonlitePlugin, MonliteQueryError, MonliteUniqueConstraintError, type OrderBy, type PluginChange, type PreparedStatement, type RemoteChange, type RunResult, type Select, type SortOrder, type SyncOp, type SyncStateRow, SyncStore, type SystemFields, type UpdateArgs, type UpdateData, type UpdateOperators, type UpsertArgs, type Version, type WatchHandle, type WhereInput as WhereClause, type WhereInput, type WithId, compareVersions, createDb, isObjectId, makeVersion, normalizeDriverError, objectId, versionTs };

package/dist/index.js

@@ -1612,7 +1612,11 @@ function loadNodeSqlite() {
     return null;
   }
 }
+function isDriverInstance(d) {
+  return typeof d === "object" && d !== null && typeof d.prepare === "function" && typeof d.exec === "function";
+}
 function createDriver(filename, options = {}) {
+  if (isDriverInstance(options.driver)) return options.driver;
   const choice = options.driver ?? "auto";
   if (options.encryption) {
     if (choice === "node:sqlite") {