@mikro-orm/sql 7.0.14-dev.7 → 7.0.14-dev.8

package/SqlMikroORM.d.ts

@@ -0,0 +1,23 @@
+import { type AnyEntity, type EntityClass, type EntityManager, type EntityManagerType, type EntitySchema, type IDatabaseDriver, MikroORM, type Options } from '@mikro-orm/core';
+import type { AbstractSqlDriver } from './AbstractSqlDriver.js';
+import type { SqlEntityManager } from './SqlEntityManager.js';
+/** Configuration options shared by all SQL drivers. */
+export type SqlOptions<D extends AbstractSqlDriver = AbstractSqlDriver, EM extends SqlEntityManager<D> = SqlEntityManager<D>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> = Partial<Options<D, EM, Entities>>;
+/**
+ * Creates a type-safe configuration object for any SQL driver. The driver class
+ * must be passed via `options.driver` (e.g. `SqliteDriver`, `MySqlDriver`, …).
+ */
+export declare function defineSqlConfig<D extends AbstractSqlDriver = AbstractSqlDriver, EM extends SqlEntityManager<D> = SqlEntityManager<D>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<D, EM, Entities>>): Partial<Options<D, EM, Entities>>;
+/**
+ * Generic entry point for SQL drivers. Use this when consuming `@mikro-orm/sql`
+ * directly with a Kysely dialect; for the bundled driver packages prefer
+ * `@mikro-orm/sqlite`, `@mikro-orm/postgresql`, etc.
+ *
+ * @inheritDoc
+ */
+export declare class SqlMikroORM<D extends AbstractSqlDriver = AbstractSqlDriver, EM extends SqlEntityManager<D> = SqlEntityManager<D>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> extends MikroORM<D, EM, Entities> {
+    /**
+     * @inheritDoc
+     */
+    static init<D extends IDatabaseDriver = AbstractSqlDriver, 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>>;
+}

package/SqlMikroORM.js

@@ -0,0 +1,23 @@
+import { defineConfig, MikroORM, } from '@mikro-orm/core';
+/**
+ * Creates a type-safe configuration object for any SQL driver. The driver class
+ * must be passed via `options.driver` (e.g. `SqliteDriver`, `MySqlDriver`, …).
+ */
+export function defineSqlConfig(options) {
+    return defineConfig(options);
+}
+/**
+ * Generic entry point for SQL drivers. Use this when consuming `@mikro-orm/sql`
+ * directly with a Kysely dialect; for the bundled driver packages prefer
+ * `@mikro-orm/sqlite`, `@mikro-orm/postgresql`, etc.
+ *
+ * @inheritDoc
+ */
+export class SqlMikroORM extends MikroORM {
+    /**
+     * @inheritDoc
+     */
+    static async init(options) {
+        return super.init(options);
+    }
+}

package/index.d.ts

@@ -17,3 +17,5 @@ export type * from './typings.js';
 export * from './plugin/index.js';
 export { SqlEntityManager as EntityManager } from './SqlEntityManager.js';
 export { SqlEntityRepository as EntityRepository } from './SqlEntityRepository.js';
+export * from './SqlMikroORM.js';
+export { SqlMikroORM as MikroORM, type SqlOptions as Options, defineSqlConfig as defineConfig } from './SqlMikroORM.js';

package/index.js

@@ -16,3 +16,5 @@ export * from './dialects/index.js';
 export * from './plugin/index.js';
 export { SqlEntityManager as EntityManager } from './SqlEntityManager.js';
 export { SqlEntityRepository as EntityRepository } from './SqlEntityRepository.js';
+export * from './SqlMikroORM.js';
+export { SqlMikroORM as MikroORM, defineSqlConfig as defineConfig } from './SqlMikroORM.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/sql",
-  "version": "7.0.14-dev.7",
+  "version": "7.0.14-dev.8",
   "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",
@@ -53,7 +53,7 @@
     "@mikro-orm/core": "^7.0.13"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.14-dev.7"
+    "@mikro-orm/core": "7.0.14-dev.8"
   },
   "engines": {
     "node": ">= 22.17.0"