@mikro-orm/sqlite 7.0.17 → 7.0.18-dev.1

package/README.md

@@ -2,7 +2,7 @@
   <a href="https://mikro-orm.io"><img src="https://raw.githubusercontent.com/mikro-orm/mikro-orm/master/docs/static/img/logo-readme.svg?sanitize=true" alt="MikroORM" /></a>
 </h1>
 
-TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-orm.io/docs/unit-of-work/) and [Identity Map](https://mikro-orm.io/docs/identity-map/) patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL, SQLite (including libSQL), MSSQL and Oracle databases.
+TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-orm.io/docs/unit-of-work/) and [Identity Map](https://mikro-orm.io/docs/identity-map/) patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL (including CockroachDB and PGlite), SQLite (including libSQL), MSSQL and Oracle databases.
 
 > Heavily inspired by [Doctrine](https://www.doctrine-project.org/) and [Hibernate](https://hibernate.org/).
 
@@ -19,6 +19,7 @@ Install a driver package for your database:
 
 ```sh
 npm install @mikro-orm/postgresql   # PostgreSQL
+npm install @mikro-orm/pglite       # PGlite (embedded PostgreSQL in WASM)
 npm install @mikro-orm/mysql        # MySQL
 npm install @mikro-orm/mariadb      # MariaDB
 npm install @mikro-orm/sqlite       # SQLite

package/SqliteConnection.d.ts

@@ -1,9 +1,13 @@
 import { BaseSqliteConnection, type Dictionary } from '@mikro-orm/sql';
 import { type Dialect } from 'kysely';
+import { type Routine, type Transaction } from '@mikro-orm/core';
 /** SQLite database connection using the `better-sqlite3` driver. */
 export declare class SqliteConnection extends BaseSqliteConnection {
+    #private;
     private database;
     createKyselyDialect(options: Dictionary): Dialect;
     /** @inheritDoc */
     executeDump(dump: string): Promise<void>;
+    /** SQLite has no procedures; functions bridge via `bodyJs` registered as a UDF. */
+    callRoutine<T>(routine: Routine, args?: Record<string, unknown>, ctx?: Transaction): Promise<T>;
 }

package/SqliteConnection.js

@@ -4,9 +4,13 @@ import Database from 'better-sqlite3';
 /** SQLite database connection using the `better-sqlite3` driver. */
 export class SqliteConnection extends BaseSqliteConnection {
     database;
+    // Routine name → registered `bodyJs` ref. Reference compare to detect HMR swaps and re-register.
+    #registeredRoutines = new Map();
     createKyselyDialect(options) {
         const dbName = options.dbName ?? this.config.get('dbName');
         this.database = new Database(dbName, options);
+        // Fresh Database = fresh process-side function table; clear cached registrations.
+        this.#registeredRoutines.clear();
         return new SqliteDialect({
             database: this.database,
             onCreateConnection: this.options.onCreateConnection ?? this.config.get('onCreateConnection'),
@@ -17,4 +21,27 @@ export class SqliteConnection extends BaseSqliteConnection {
         await this.ensureConnection();
         this.database.exec(dump);
     }
+    /** SQLite has no procedures; functions bridge via `bodyJs` registered as a UDF. */
+    async callRoutine(routine, args = {}, ctx) {
+        if (routine.type === 'procedure') {
+            throw new Error(`Stored procedures are not supported on SQLite. Routine ${routine.name} cannot be invoked here — define a separate code path for SQLite or call it only against a server-side database.`);
+        }
+        if (!routine.bodyJs) {
+            throw new Error(`Function ${routine.name} cannot be invoked on SQLite without a 'bodyJs' fallback. Add a JS implementation to the Routine declaration to enable cross-DB testing.`);
+        }
+        await this.ensureConnection();
+        const fn = routine.bodyJs;
+        // Re-register on reference mismatch (HMR or a re-bound closure); better-sqlite3 replaces silently.
+        if (this.#registeredRoutines.get(routine.name) !== fn) {
+            this.database.function(routine.name, { deterministic: routine.deterministic ?? false, varargs: true }, (...positional) => {
+                const named = {};
+                routine.params.forEach((p, i) => {
+                    named[p.name] = positional[i];
+                });
+                return fn(named);
+            });
+            this.#registeredRoutines.set(routine.name, fn);
+        }
+        return this.callRoutineFunction(routine, args, ctx);
+    }
 }

package/SqliteMikroORM.d.ts

@@ -2,17 +2,17 @@ import { type AnyEntity, type EntityClass, type EntitySchema, type MikroORM, typ
 import { SqlMikroORM, type SqlEntityManager } from '@mikro-orm/sql';
 import { SqliteDriver } from './SqliteDriver.js';
 /** Configuration options for the SQLite driver. */
-export type SqliteOptions<EM extends SqlEntityManager<SqliteDriver> = SqlEntityManager<SqliteDriver>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> = Partial<Options<SqliteDriver, EM, Entities>>;
+export type SqliteOptions<EM extends SqlEntityManager<SqliteDriver> = SqlEntityManager<SqliteDriver>, Entities extends readonly (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> = Partial<Options<SqliteDriver, EM, Entities>>;
 /** Creates a type-safe configuration object for the SQLite driver. */
-export declare function defineSqliteConfig<EM extends SqlEntityManager<SqliteDriver> = SqlEntityManager<SqliteDriver>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<SqliteDriver, EM, Entities>>): Partial<Options<SqliteDriver, EM, Entities>>;
+export declare function defineSqliteConfig<EM extends SqlEntityManager<SqliteDriver> = SqlEntityManager<SqliteDriver>, Entities extends readonly (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<SqliteDriver, EM, Entities>>): Partial<Options<SqliteDriver, EM, Entities>>;
 /**
  * @inheritDoc
  */
-export declare class SqliteMikroORM<EM extends SqlEntityManager<SqliteDriver> = SqlEntityManager<SqliteDriver>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> extends SqlMikroORM<SqliteDriver, EM, Entities> {
+export declare class SqliteMikroORM<EM extends SqlEntityManager<SqliteDriver> = SqlEntityManager<SqliteDriver>, Entities extends readonly (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> extends SqlMikroORM<SqliteDriver, EM, Entities> {
     /**
      * @inheritDoc
      */
-    static init<D extends IDatabaseDriver = SqliteDriver, EM extends EntityManager<D> = D[typeof EntityManagerType] & EntityManager<D>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<D, EM, Entities>>): Promise<MikroORM<D, EM, Entities>>;
+    static init<D extends IDatabaseDriver = SqliteDriver, EM extends EntityManager<D> = D[typeof EntityManagerType] & EntityManager<D>, Entities extends readonly (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<D, EM, Entities>>): Promise<MikroORM<D, EM, Entities>>;
     /**
      * @inheritDoc
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/sqlite",
-  "version": "7.0.17",
+  "version": "7.0.18-dev.1",
   "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,7 +47,7 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "@mikro-orm/sql": "7.0.17",
+    "@mikro-orm/sql": "7.0.18-dev.1",
     "better-sqlite3": "12.10.0",
     "kysely": "0.29.2"
   },
@@ -55,7 +55,7 @@
     "@mikro-orm/core": "^7.0.17"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.17"
+    "@mikro-orm/core": "7.0.18-dev.1"
   },
   "engines": {
     "node": ">= 22.17.0"