@mikro-orm/libsql 7.2.0-dev.0 → 7.2.0-dev.10

package/LibSqlConnection.d.ts

@@ -1,5 +1,5 @@
 import { BaseSqliteConnection, type Dictionary } from '@mikro-orm/sql';
-import { type Options } from 'libsql';
+import Database, { type Options } from 'libsql';
 import type { Routine, Transaction } from '@mikro-orm/core';
 import { LibSqlDialect } from './LibSqlDialect.js';
 /** libSQL database connection supporting both local and remote databases. */
@@ -9,9 +9,16 @@ export declare class LibSqlConnection extends BaseSqliteConnection {
         skipOnConnect?: boolean;
     }): Promise<void>;
     createKyselyDialect(options: Dictionary & Options): LibSqlDialect;
+    /** Restores the state a recycled connection was replaced with, run on the raw handle to skip the held mutex. */
+    protected replayConnectionSetup(): Promise<void>;
     /** libsql's `Database.function()` is declared but throws "not implemented"; better-sqlite3 has the UDF bridge. */
     callRoutine<T>(routine: Routine, _args?: Record<string, unknown>, _ctx?: Transaction): Promise<T>;
     /** @inheritDoc */
     executeDump(source: string): Promise<void>;
+    /**
+     * Returns the `libsql` database backing this connection. Remote/replica connections are
+     * recycled, so re-read it rather than holding on to the returned handle.
+     */
+    getNativeClient(): Promise<Database.Database>;
     private validateAttachSupport;
 }

package/LibSqlConnection.js

@@ -1,6 +1,7 @@
 import { BaseSqliteConnection } from '@mikro-orm/sql';
 import Database from 'libsql';
 import { LibSqlDialect } from './LibSqlDialect.js';
+const REMOTE_URL = /^(https?|libsql):\/\//;
 /** libSQL database connection supporting both local and remote databases. */
 export class LibSqlConnection extends BaseSqliteConnection {
     database;
@@ -16,8 +17,16 @@ export class LibSqlConnection extends BaseSqliteConnection {
                 return (this.database = new Database(dbName, options));
             },
             onCreateConnection: this.options.onCreateConnection ?? this.config.get('onCreateConnection'),
+            recycleConnection: !!options.syncUrl || REMOTE_URL.test(dbName),
+            onRecycleConnection: this.replayConnectionSetup.bind(this),
         });
     }
+    /** Restores the state a recycled connection was replaced with, run on the raw handle to skip the held mutex. */
+    async replayConnectionSetup() {
+        for (const sql of await this.getConnectionSetupSql()) {
+            this.database.exec(sql);
+        }
+    }
     /** libsql's `Database.function()` is declared but throws "not implemented"; better-sqlite3 has the UDF bridge. */
     async callRoutine(routine, _args = {}, _ctx) {
         throw new Error(`Stored routines are not supported on libSQL. The libsql client does not implement user-defined-function registration; calling routine ${routine.name} would fail at runtime. Use the better-sqlite3 driver for cross-DB testing, or call against a server-side database.`);
@@ -27,13 +36,21 @@ export class LibSqlConnection extends BaseSqliteConnection {
         await this.ensureConnection();
         this.database.exec(source);
     }
+    /**
+     * Returns the `libsql` database backing this connection. Remote/replica connections are
+     * recycled, so re-read it rather than holding on to the returned handle.
+     */
+    async getNativeClient() {
+        await this.ensureConnection();
+        return this.requireNativeClient(this.database);
+    }
     validateAttachSupport() {
         const attachDatabases = this.config.get('attachDatabases');
         if (!attachDatabases?.length) {
             return;
         }
         const dbName = this.config.get('dbName');
-        if (/^(https?|libsql):\/\//.exec(dbName)) {
+        if (REMOTE_URL.test(dbName)) {
             throw new Error('ATTACH DATABASE is not supported for remote libSQL connections. ' + 'Use local file-based databases only.');
         }
     }

package/LibSqlDialect.d.ts

@@ -1,7 +1,18 @@
 import { SqliteDialect, type SqliteDialectConfig, SqliteDriver } from 'kysely';
+/** Kysely SQLite dialect config extended with the connection recycling libSQL needs for embedded replicas. */
+export interface LibSqlDialectConfig extends SqliteDialectConfig {
+    /**
+     * Recreates the underlying connection once it gets stale. Embedded replicas swap the local file out when
+     * syncing, so a long lived handle would keep serving the pre-sync data. A plain local database never goes
+     * stale, and recycling it would silently drop per-connection state like pragmas and attached databases.
+     */
+    recycleConnection?: boolean;
+    /** Re-applies the per-connection state after a stale connection was replaced. */
+    onRecycleConnection?: () => Promise<void>;
+}
 /** Kysely dialect adapter for libSQL. */
 export declare class LibSqlDialect extends SqliteDialect {
     #private;
-    constructor(config: SqliteDialectConfig);
+    constructor(config: LibSqlDialectConfig);
     createDriver(): SqliteDriver;
 }

package/LibSqlDialect.js

@@ -25,7 +25,7 @@ class LibSqlConnection {
         this.#db = db;
     }
     isValid() {
-        return this.memory || this.#created > Date.now() - CONNECTION_TIMEOUT;
+        return this.#created > Date.now() - CONNECTION_TIMEOUT;
     }
     async executeQuery(compiledQuery) {
         const { sql, parameters } = compiledQuery;
@@ -83,10 +83,10 @@ class LibSqlKyselyDriver extends SqliteDriver {
     }
     async acquireConnection() {
         await this.#connectionMutex.lock();
-        /* v8 ignore next */
-        if (!this.#connection.isValid()) {
+        if (this.#config.recycleConnection && !this.#connection.isValid()) {
             await this.destroy();
             await this.init();
+            await this.#config.onRecycleConnection?.();
         }
         return this.#connection;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/libsql",
-  "version": "7.2.0-dev.0",
+  "version": "7.2.0-dev.10",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "keywords": [
     "data-mapper",
@@ -47,15 +47,15 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "@mikro-orm/sql": "7.2.0-dev.0",
-    "kysely": "0.29.3",
+    "@mikro-orm/sql": "7.2.0-dev.10",
+    "kysely": "0.29.5",
     "libsql": "0.5.29"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^7.1.6"
+    "@mikro-orm/core": "^7.1.11"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.2.0-dev.0"
+    "@mikro-orm/core": "7.2.0-dev.10"
   },
   "engines": {
     "node": ">= 22.17.0"