@nest-boot/mikro-orm 7.3.0 → 7.3.2

package/dist/types/chunk-by-id-options.type.d.ts

@@ -1,2 +1,3 @@
 import type { FindOptions, PopulatePath } from "@mikro-orm/core";
+/** Options for {@link EntityService.chunkById}, excluding offset and orderBy (managed internally). */
 export type ChunkByIdOptions<Entity, Hint extends string = never, Fields extends string = PopulatePath.ALL, Excludes extends string = never> = Omit<FindOptions<Entity, Hint, Fields, Excludes>, "offset" | "orderBy">;

package/dist/types/id-or-entity.type.d.ts

@@ -1,2 +1,3 @@
 import type { IdEntity } from "../interfaces/id-entity.interface";
+/** Accepts either an entity's ID value or the entity instance itself. */
 export type IdOrEntity<Entity extends IdEntity> = Entity["id"] | Entity;

package/dist/utils/load-config-from-env.util.d.ts

@@ -1,12 +1,37 @@
 import { Configuration, IDatabaseDriver } from "@mikro-orm/core";
-export declare function loadConfigFromEnv(): Promise<{
-    driver?: new (config: Configuration) => IDatabaseDriver;
-} & ({
+/** Constructor type for a MikroORM database driver. */
+export type DatabaseDriverConstructor = new (config: Configuration) => IDatabaseDriver;
+/** Database driver configuration for MikroORM. */
+export interface DriverConfig {
+    /** Database driver class constructor. */
+    driver?: DatabaseDriverConstructor;
+}
+/** URL-based database connection configuration. */
+export interface UrlConfig {
+    /** Database connection URL. */
     clientUrl?: string;
-} | {
+}
+/** Host-based database connection configuration. */
+export interface HostConfig {
+    /** Database host. */
     host?: string;
+    /** Database port. */
     port?: number;
+    /** Database name. */
     dbName?: string;
+    /** Database user. */
     user?: string;
+    /** Database password. */
     password?: string;
-})>;
+}
+/**
+ * Loads MikroORM configuration from environment variables.
+ *
+ * @remarks
+ * Supports both connection URL (`DB_URL` / `DATABASE_URL`) and individual
+ * host/port/dbName/user/password variables. Automatically resolves the
+ * database driver based on the URL protocol or `DB_TYPE`.
+ *
+ * @returns MikroORM options derived from environment variables
+ */
+export declare function loadConfigFromEnv(): Promise<DriverConfig & (UrlConfig | HostConfig)>;

package/dist/utils/load-config-from-env.util.js

@@ -36,26 +36,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadConfigFromEnv = loadConfigFromEnv;
 const core_1 = require("@mikro-orm/core");
 const reflection_1 = require("@mikro-orm/reflection");
-const baseConfig = {
-    colors: false,
-    debug: !!(process.env.DB_DEBUG ?? process.env.DATABASE_DEBUG),
-    dataloader: core_1.DataloaderType.ALL,
-    timezone: "UTC",
-    metadataProvider: reflection_1.TsMorphMetadataProvider,
-    entities: ["dist/**/*.entity.js"],
-    entitiesTs: ["src/**/*.entity.ts"],
-    migrations: {
-        snapshot: false,
-        path: "dist/database/migrations",
-        pathTs: "src/database/migrations",
-    },
-    seeder: {
-        path: "dist/database/seeders",
-        pathTs: "src/database/seeders",
-        defaultSeeder: "DatabaseSeeder",
-        fileName: (className) => className,
-    },
-};
 async function getDriver(type) {
     switch (type) {
         case "mysql":
@@ -65,7 +45,37 @@ async function getDriver(type) {
             return (await Promise.resolve().then(() => __importStar(require("@mikro-orm/postgresql")))).PostgreSqlDriver;
     }
 }
+/**
+ * Loads MikroORM configuration from environment variables.
+ *
+ * @remarks
+ * Supports both connection URL (`DB_URL` / `DATABASE_URL`) and individual
+ * host/port/dbName/user/password variables. Automatically resolves the
+ * database driver based on the URL protocol or `DB_TYPE`.
+ *
+ * @returns MikroORM options derived from environment variables
+ */
 async function loadConfigFromEnv() {
+    const baseConfig = {
+        colors: false,
+        debug: !!(process.env.DB_DEBUG ?? process.env.DATABASE_DEBUG),
+        dataloader: core_1.DataloaderType.ALL,
+        timezone: "UTC",
+        metadataProvider: reflection_1.TsMorphMetadataProvider,
+        entities: ["dist/**/*.entity.js"],
+        entitiesTs: ["src/**/*.entity.ts"],
+        migrations: {
+            snapshot: false,
+            path: "dist/database/migrations",
+            pathTs: "src/database/migrations",
+        },
+        seeder: {
+            path: "dist/database/seeders",
+            pathTs: "src/database/seeders",
+            defaultSeeder: "DatabaseSeeder",
+            fileName: (className) => className,
+        },
+    };
     const dbUrl = process.env.DB_URL ?? process.env.DATABASE_URL;
     if (dbUrl) {
         const dbType = new URL(dbUrl).protocol.replace(":", "");

package/dist/utils/load-config-from-env.util.js.map

@@ -1 +1 @@
-{"version":3,"file":"load-config-from-env.util.js","sourceRoot":"","sources":["../../src/utils/load-config-from-env.util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,8CAiDC;AA1FD,0CAKyB;AACzB,sDAAgE;AAEhE,MAAM,UAAU,GAAY;IAC1B,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;IAC7D,UAAU,EAAE,qBAAc,CAAC,GAAG;IAC9B,QAAQ,EAAE,KAAK;IACf,gBAAgB,EAAE,oCAAuB;IACzC,QAAQ,EAAE,CAAC,qBAAqB,CAAC;IACjC,UAAU,EAAE,CAAC,oBAAoB,CAAC;IAClC,UAAU,EAAE;QACV,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,0BAA0B;QAChC,MAAM,EAAE,yBAAyB;KAClC;IACD,MAAM,EAAE;QACN,IAAI,EAAE,uBAAuB;QAC7B,MAAM,EAAE,sBAAsB;QAC9B,aAAa,EAAE,gBAAgB;QAC/B,QAAQ,EAAE,CAAC,SAAiB,EAAE,EAAE,CAAC,SAAS;KAC3C;CACF,CAAC;AAEF,KAAK,UAAU,SAAS,CACtB,IAAa;IAEb,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,OAAO;YACV,OAAO,CAAC,wDAAa,kBAAkB,GAAC,CAAC,CAAC,WAAW,CAAC;QACxD,KAAK,UAAU,CAAC;QAChB,KAAK,YAAY;YACf,OAAO,CAAC,wDAAa,uBAAuB,GAAC,CAAC,CAAC,gBAAgB,CAAC;IACpE,CAAC;AACH,CAAC;AAEM,KAAK,UAAU,iBAAiB;IAYrC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;IAE7D,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAExD,OAAO;YACL,GAAG,UAAU;YACb,MAAM,EAAE,MAAM,SAAS,CAAC,MAAM,CAAC;YAC/B,SAAS,EAAE,KAAK;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IAChE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IAChE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IAChE,MAAM,MAAM,GACV,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IAC9E,MAAM,UAAU,GACd,OAAO,CAAC,GAAG,CAAC,OAAO;QACnB,OAAO,CAAC,GAAG,CAAC,WAAW;QACvB,OAAO,CAAC,GAAG,CAAC,aAAa;QACzB,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAChC,MAAM,UAAU,GACd,OAAO,CAAC,GAAG,CAAC,OAAO;QACnB,OAAO,CAAC,GAAG,CAAC,WAAW;QACvB,OAAO,CAAC,GAAG,CAAC,aAAa;QACzB,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAEhC,OAAO;QACL,GAAG,UAAU;QACb,MAAM,EAAE,MAAM,SAAS,CAAC,MAAM,CAAC;QAC/B,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;QAClC,MAAM;QACN,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,UAAU;KACrB,CAAC;AACJ,CAAC"}
+{"version":3,"file":"load-config-from-env.util.js","sourceRoot":"","sources":["../../src/utils/load-config-from-env.util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6DA,8CA6DC;AA1HD,0CAKyB;AACzB,sDAAgE;AAEhE,KAAK,UAAU,SAAS,CACtB,IAAa;IAEb,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,OAAO;YACV,OAAO,CAAC,wDAAa,kBAAkB,GAAC,CAAC,CAAC,WAAW,CAAC;QACxD,KAAK,UAAU,CAAC;QAChB,KAAK,YAAY;YACf,OAAO,CAAC,wDAAa,uBAAuB,GAAC,CAAC,CAAC,gBAAgB,CAAC;IACpE,CAAC;AACH,CAAC;AAiCD;;;;;;;;;GASG;AACI,KAAK,UAAU,iBAAiB;IAGrC,MAAM,UAAU,GAAY;QAC1B,MAAM,EAAE,KAAK;QACb,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;QAC7D,UAAU,EAAE,qBAAc,CAAC,GAAG;QAC9B,QAAQ,EAAE,KAAK;QACf,gBAAgB,EAAE,oCAAuB;QACzC,QAAQ,EAAE,CAAC,qBAAqB,CAAC;QACjC,UAAU,EAAE,CAAC,oBAAoB,CAAC;QAClC,UAAU,EAAE;YACV,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,0BAA0B;YAChC,MAAM,EAAE,yBAAyB;SAClC;QACD,MAAM,EAAE;YACN,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,sBAAsB;YAC9B,aAAa,EAAE,gBAAgB;YAC/B,QAAQ,EAAE,CAAC,SAAiB,EAAE,EAAE,CAAC,SAAS;SAC3C;KACF,CAAC;IAEF,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;IAE7D,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAExD,OAAO;YACL,GAAG,UAAU;YACb,MAAM,EAAE,MAAM,SAAS,CAAC,MAAM,CAAC;YAC/B,SAAS,EAAE,KAAK;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IAChE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IAChE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IAChE,MAAM,MAAM,GACV,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IAC9E,MAAM,UAAU,GACd,OAAO,CAAC,GAAG,CAAC,OAAO;QACnB,OAAO,CAAC,GAAG,CAAC,WAAW;QACvB,OAAO,CAAC,GAAG,CAAC,aAAa;QACzB,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAChC,MAAM,UAAU,GACd,OAAO,CAAC,GAAG,CAAC,OAAO;QACnB,OAAO,CAAC,GAAG,CAAC,WAAW;QACvB,OAAO,CAAC,GAAG,CAAC,aAAa;QACzB,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAEhC,OAAO;QACL,GAAG,UAAU;QACb,MAAM,EAAE,MAAM,SAAS,CAAC,MAAM,CAAC;QAC/B,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;QAClC,MAAM;QACN,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,UAAU;KACrB,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,11 @@
 {
   "name": "@nest-boot/mikro-orm",
-  "version": "7.3.0",
+  "version": "7.3.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nest-boot/nest-boot.git",
+    "directory": "packages/mikro-orm"
+  },
   "description": "",
   "author": {
     "name": "Xudong Huang",
@@ -43,16 +48,16 @@
     "rxjs": "^7.8.2",
     "ts-jest": "^29.4.4",
     "typescript": "^5.9.3",
-    "@nest-boot/eslint-config": "^7.0.2",
-    "@nest-boot/eslint-plugin": "^7.0.4",
-    "@nest-boot/request-context": "^7.4.2",
-    "@nest-boot/tsconfig": "^7.0.1"
+    "@nest-boot/eslint-config": "^7.0.3",
+    "@nest-boot/tsconfig": "^7.0.1",
+    "@nest-boot/eslint-plugin": "^7.0.5",
+    "@nest-boot/request-context": "^7.4.3"
   },
   "peerDependencies": {
     "@mikro-orm/core": "^6.0.0",
     "@mikro-orm/nestjs": "^6.0.0",
     "@mikro-orm/reflection": "^6.0.0",
-    "@nest-boot/request-context": "^7.4.2",
+    "@nest-boot/request-context": "^7.4.3",
     "@nestjs/common": "^11.0.0",
     "@nestjs/core": "^11.0.0",
     "reflect-metadata": "^0.2.2",