@nest-boot/mikro-orm 7.7.1 → 7.7.2

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

@@ -1,4 +1,4 @@
-import { Configuration, IDatabaseDriver } from "@mikro-orm/core";
+import { Configuration, IDatabaseDriver, type Options } from "@mikro-orm/core";
 /** Constructor type for a MikroORM database driver. */
 export type DatabaseDriverConstructor = new (config: Configuration) => IDatabaseDriver;
 /** Database driver configuration for MikroORM. */
@@ -6,7 +6,7 @@ export interface DriverConfig {
     /** Database driver class constructor. */
     driver?: DatabaseDriverConstructor;
 }
-/** URL-based database connection configuration. */
+/** URL-based database connection configuration for explicit module options. */
 export interface UrlConfig {
     /** Database connection URL. */
     clientUrl?: string;
@@ -23,15 +23,25 @@ export interface HostConfig {
     user?: string;
     /** Database password. */
     password?: string;
+    /** Default database schema. */
+    schema?: string;
+    /** Driver connection options parsed from URL query parameters. */
+    driverOptions?: Options["driverOptions"];
 }
 /**
  * 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`.
+ * Supports `DATABASE_URL`, which is parsed into individual connection options,
+ * including structured query options. The `postgresql:` and `postgres:`
+ * protocols select PostgreSQL, `mysql:` selects MySQL, and `file:` selects
+ * SQLite. Only the URL forms documented by those databases are accepted;
+ * other protocol names and driver-specific compatibility forms are rejected.
+ * PostgreSQL supports `sslmode=disable`, `require`, `verify-ca`, and
+ * `verify-full`; MySQL supports `ssl-mode=DISABLED`, `REQUIRED`, `VERIFY_CA`,
+ * and `VERIFY_IDENTITY`. Modes that require a plaintext fallback are rejected
+ * because one structured driver configuration cannot preserve that behavior.
  *
  * @returns MikroORM options derived from environment variables
  */
-export declare function loadConfigFromEnv(): Promise<DriverConfig & (UrlConfig | HostConfig)>;
+export declare function loadConfigFromEnv(): Promise<DriverConfig & HostConfig>;

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

@@ -34,77 +34,220 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadConfigFromEnv = loadConfigFromEnv;
-const core_1 = require("@mikro-orm/core");
-const reflection_1 = require("@mikro-orm/reflection");
-async function getDriver(type) {
-    switch (type) {
-        case "mysql":
+const promises_1 = require("node:fs/promises");
+const node_url_1 = require("node:url");
+const load_default_config_util_1 = require("./load-default-config.util");
+async function getDriver(protocol) {
+    switch (protocol) {
+        case "file:":
+            return (await Promise.resolve().then(() => __importStar(require("@mikro-orm/better-sqlite")))).BetterSqliteDriver;
+        case "mysql:":
             return (await Promise.resolve().then(() => __importStar(require("@mikro-orm/mysql")))).MySqlDriver;
-        case "postgres":
-        case "postgresql":
+        case "postgres:":
+        case "postgresql:":
             return (await Promise.resolve().then(() => __importStar(require("@mikro-orm/postgresql")))).PostgreSqlDriver;
+        default:
+            throw new TypeError(`Unsupported DATABASE_URL protocol: ${protocol}`);
     }
 }
+function normalizeHostname(hostname) {
+    if (hostname.startsWith("[") && hostname.endsWith("]")) {
+        return hostname.slice(1, -1);
+    }
+    return hostname;
+}
+async function loadTlsFiles(files) {
+    const ssl = {};
+    let hasTlsFile = false;
+    for (const [path, sslKey] of files) {
+        if (typeof path === "string" && path) {
+            ssl[sslKey] = await (0, promises_1.readFile)(path, "utf8");
+            hasTlsFile = true;
+        }
+    }
+    return hasTlsFile ? ssl : undefined;
+}
+async function loadPostgreSqlTlsFiles(connection) {
+    const ssl = await loadTlsFiles([
+        [connection.sslrootcert, "ca"],
+        [connection.sslcert, "cert"],
+        [connection.sslkey, "key"],
+    ]);
+    delete connection.sslrootcert;
+    delete connection.sslcert;
+    delete connection.sslkey;
+    return ssl;
+}
+async function loadMySqlTlsConfig(connection) {
+    const supportedParameters = ["ssl-mode", "ssl-ca", "ssl-cert", "ssl-key"];
+    for (const parameter of Object.keys(connection)) {
+        if (!supportedParameters.includes(parameter)) {
+            throw new TypeError(`Unsupported MySQL DATABASE_URL parameter: ${parameter}`);
+        }
+    }
+    const sslMode = connection["ssl-mode"];
+    const tlsFiles = [
+        [connection["ssl-ca"], "ca"],
+        [connection["ssl-cert"], "cert"],
+        [connection["ssl-key"], "key"],
+    ];
+    delete connection["ssl-ca"];
+    delete connection["ssl-cert"];
+    delete connection["ssl-key"];
+    delete connection["ssl-mode"];
+    const normalizedSslMode = typeof sslMode === "string" ? sslMode.toUpperCase() : sslMode;
+    if (normalizedSslMode === "DISABLED") {
+        connection.ssl = false;
+        return;
+    }
+    if (normalizedSslMode === "PREFERRED") {
+        throw new TypeError("Unsupported MySQL ssl-mode: PREFERRED");
+    }
+    const ssl = await loadTlsFiles(tlsFiles);
+    switch (normalizedSslMode) {
+        case "REQUIRED":
+            connection.ssl = { ...ssl, rejectUnauthorized: false };
+            break;
+        case "VERIFY_CA":
+            if (!ssl?.ca) {
+                throw new TypeError("MySQL ssl-mode=VERIFY_CA requires ssl-ca");
+            }
+            connection.ssl = {
+                ...ssl,
+                rejectUnauthorized: true,
+                verifyIdentity: false,
+            };
+            break;
+        case "VERIFY_IDENTITY":
+            if (!ssl?.ca) {
+                throw new TypeError("MySQL ssl-mode=VERIFY_IDENTITY requires ssl-ca");
+            }
+            connection.ssl = {
+                ...ssl,
+                rejectUnauthorized: true,
+                verifyIdentity: true,
+            };
+            break;
+        case undefined:
+            if (ssl) {
+                connection.ssl = {
+                    ...ssl,
+                    rejectUnauthorized: true,
+                    verifyIdentity: false,
+                };
+            }
+            break;
+        default:
+            throw new TypeError(`Unsupported MySQL ssl-mode: ${String(sslMode)}`);
+    }
+}
+async function loadQueryConfig(url, protocol) {
+    const connection = Object.fromEntries(url.searchParams);
+    const schema = url.searchParams.get("schema") ?? undefined;
+    delete connection.schema;
+    if (protocol === "mysql:") {
+        await loadMySqlTlsConfig(connection);
+    }
+    if (protocol === "postgres:" || protocol === "postgresql:") {
+        if (connection.ssl !== undefined) {
+            throw new TypeError("Unsupported PostgreSQL DATABASE_URL parameter: ssl");
+        }
+        if (connection.uselibpqcompat !== undefined) {
+            throw new TypeError("Unsupported PostgreSQL DATABASE_URL parameter: uselibpqcompat");
+        }
+        const sslMode = connection.sslmode;
+        delete connection.uselibpqcompat;
+        delete connection.sslmode;
+        if (sslMode === "disable") {
+            delete connection.sslrootcert;
+            delete connection.sslcert;
+            delete connection.sslkey;
+            connection.ssl = false;
+        }
+        else if (sslMode === "allow" || sslMode === "prefer") {
+            throw new TypeError(`Unsupported PostgreSQL sslmode: ${sslMode}`);
+        }
+        else {
+            const tls = await loadPostgreSqlTlsFiles(connection);
+            if (tls) {
+                connection.ssl = tls;
+            }
+            switch (sslMode) {
+                case "require":
+                    connection.ssl = tls?.ca
+                        ? { ...tls, checkServerIdentity: () => undefined }
+                        : { ...tls, rejectUnauthorized: false };
+                    break;
+                case "verify-ca":
+                    if (!tls?.ca) {
+                        throw new TypeError("PostgreSQL sslmode=verify-ca requires sslrootcert");
+                    }
+                    connection.ssl = { ...tls, checkServerIdentity: () => undefined };
+                    break;
+                case "verify-full":
+                    connection.ssl = tls ?? {};
+                    break;
+                case undefined:
+                    break;
+                default:
+                    throw new TypeError(`Unsupported PostgreSQL sslmode: ${String(sslMode)}`);
+            }
+        }
+    }
+    return {
+        schema,
+        driverOptions: Object.keys(connection).length ? { connection } : undefined,
+    };
+}
 /**
  * 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`.
+ * Supports `DATABASE_URL`, which is parsed into individual connection options,
+ * including structured query options. The `postgresql:` and `postgres:`
+ * protocols select PostgreSQL, `mysql:` selects MySQL, and `file:` selects
+ * SQLite. Only the URL forms documented by those databases are accepted;
+ * other protocol names and driver-specific compatibility forms are rejected.
+ * PostgreSQL supports `sslmode=disable`, `require`, `verify-ca`, and
+ * `verify-full`; MySQL supports `ssl-mode=DISABLED`, `REQUIRED`, `VERIFY_CA`,
+ * and `VERIFY_IDENTITY`. Modes that require a plaintext fallback are rejected
+ * because one structured driver configuration cannot preserve that behavior.
  *
  * @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(":", "");
+    const baseConfig = (0, load_default_config_util_1.loadDefaultConfig)();
+    const databaseUrl = process.env.DATABASE_URL;
+    if (databaseUrl) {
+        const url = new URL(databaseUrl);
+        const driver = await getDriver(url.protocol);
+        if (url.protocol === "file:") {
+            return {
+                ...baseConfig,
+                driver,
+                dbName: (0, node_url_1.fileURLToPath)(url),
+            };
+        }
+        const dbName = url.pathname.slice(1);
         return {
             ...baseConfig,
-            driver: await getDriver(dbType),
-            clientUrl: dbUrl,
+            driver,
+            host: normalizeHostname(url.hostname),
+            port: +url.port,
+            dbName: dbName ? decodeURIComponent(dbName) : undefined,
+            user: decodeURIComponent(url.username),
+            password: decodeURIComponent(url.password),
+            ...(await loadQueryConfig(url, url.protocol)),
         };
     }
-    const dbType = process.env.DB_TYPE ?? process.env.DATABASE_TYPE;
-    const dbHost = process.env.DB_HOST ?? process.env.DATABASE_HOST;
-    const dbPort = process.env.DB_PORT ?? process.env.DATABASE_PORT;
-    const dbName = process.env.DB_NAME ?? process.env.DB_DATABASE ?? process.env.DATABASE_NAME;
-    const dbUsername = process.env.DB_USER ??
-        process.env.DB_USERNAME ??
-        process.env.DATABASE_USER ??
-        process.env.DATABASE_USERNAME;
-    const dbPassword = process.env.DB_PASS ??
-        process.env.DB_PASSWORD ??
-        process.env.DATABASE_PASS ??
-        process.env.DATABASE_PASSWORD;
     return {
         ...baseConfig,
-        driver: await getDriver(dbType),
-        host: dbHost,
-        port: dbPort ? +dbPort : undefined,
-        dbName,
-        user: dbUsername,
-        password: dbPassword,
+        driver: undefined,
+        host: undefined,
+        port: undefined,
+        dbName: undefined,
+        user: undefined,
+        password: undefined,
     };
 }
 //# sourceMappingURL=load-config-from-env.util.js.map

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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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"}
+{"version":3,"file":"load-config-from-env.util.js","sourceRoot":"","sources":["../../src/utils/load-config-from-env.util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4QA,8CAwCC;AApTD,+CAA4C;AAC5C,uCAAyC;AAIzC,yEAA+D;AAO/D,KAAK,UAAU,SAAS,CAAC,QAAgB;IACvC,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,OAAO;YACV,OAAO,CAAC,wDAAa,0BAA0B,GAAC,CAAC,CAAC,kBAAkB,CAAC;QACvE,KAAK,QAAQ;YACX,OAAO,CAAC,wDAAa,kBAAkB,GAAC,CAAC,CAAC,WAAW,CAAC;QACxD,KAAK,WAAW,CAAC;QACjB,KAAK,aAAa;YAChB,OAAO,CAAC,wDAAa,uBAAuB,GAAC,CAAC,CAAC,gBAAgB,CAAC;QAClE;YACE,MAAM,IAAI,SAAS,CAAC,sCAAsC,QAAQ,EAAE,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,QAAgB;IACzC,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACvD,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,KAAK,UAAU,YAAY,CACzB,KAA8C;IAE9C,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,IAAI,UAAU,GAAG,KAAK,CAAC;IAEvB,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACnC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrC,GAAG,CAAC,MAAM,CAAC,GAAG,MAAM,IAAA,mBAAQ,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC3C,UAAU,GAAG,IAAI,CAAC;QACpB,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;AACtC,CAAC;AAED,KAAK,UAAU,sBAAsB,CACnC,UAAmC;IAEnC,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC;QAC7B,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC;QAC9B,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC;QAC5B,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC;KAC3B,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC,WAAW,CAAC;IAC9B,OAAO,UAAU,CAAC,OAAO,CAAC;IAC1B,OAAO,UAAU,CAAC,MAAM,CAAC;IAEzB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,KAAK,UAAU,kBAAkB,CAC/B,UAAmC;IAEnC,MAAM,mBAAmB,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAE1E,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAChD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7C,MAAM,IAAI,SAAS,CACjB,6CAA6C,SAAS,EAAE,CACzD,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;IACvC,MAAM,QAAQ,GAAG;QACf,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;QAC5B,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAChC,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC;KACtB,CAAC;IAEX,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC5B,OAAO,UAAU,CAAC,UAAU,CAAC,CAAC;IAC9B,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC;IAC7B,OAAO,UAAU,CAAC,UAAU,CAAC,CAAC;IAE9B,MAAM,iBAAiB,GACrB,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IAEhE,IAAI,iBAAiB,KAAK,UAAU,EAAE,CAAC;QACrC,UAAU,CAAC,GAAG,GAAG,KAAK,CAAC;QACvB,OAAO;IACT,CAAC;IAED,IAAI,iBAAiB,KAAK,WAAW,EAAE,CAAC;QACtC,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;IAC/D,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC;IAEzC,QAAQ,iBAAiB,EAAE,CAAC;QAC1B,KAAK,UAAU;YACb,UAAU,CAAC,GAAG,GAAG,EAAE,GAAG,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC;YACvD,MAAM;QACR,KAAK,WAAW;YACd,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC;gBACb,MAAM,IAAI,SAAS,CAAC,0CAA0C,CAAC,CAAC;YAClE,CAAC;YACD,UAAU,CAAC,GAAG,GAAG;gBACf,GAAG,GAAG;gBACN,kBAAkB,EAAE,IAAI;gBACxB,cAAc,EAAE,KAAK;aACtB,CAAC;YACF,MAAM;QACR,KAAK,iBAAiB;YACpB,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC;gBACb,MAAM,IAAI,SAAS,CAAC,gDAAgD,CAAC,CAAC;YACxE,CAAC;YACD,UAAU,CAAC,GAAG,GAAG;gBACf,GAAG,GAAG;gBACN,kBAAkB,EAAE,IAAI;gBACxB,cAAc,EAAE,IAAI;aACrB,CAAC;YACF,MAAM;QACR,KAAK,SAAS;YACZ,IAAI,GAAG,EAAE,CAAC;gBACR,UAAU,CAAC,GAAG,GAAG;oBACf,GAAG,GAAG;oBACN,kBAAkB,EAAE,IAAI;oBACxB,cAAc,EAAE,KAAK;iBACtB,CAAC;YACJ,CAAC;YACD,MAAM;QACR;YACE,MAAM,IAAI,SAAS,CAAC,+BAA+B,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC;AAED,KAAK,UAAU,eAAe,CAC5B,GAAQ,EACR,QAAgB;IAEhB,MAAM,UAAU,GAA4B,MAAM,CAAC,WAAW,CAC5D,GAAG,CAAC,YAAY,CACjB,CAAC;IAEF,MAAM,MAAM,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,SAAS,CAAC;IAE3D,OAAO,UAAU,CAAC,MAAM,CAAC;IAEzB,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1B,MAAM,kBAAkB,CAAC,UAAU,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,QAAQ,KAAK,WAAW,IAAI,QAAQ,KAAK,aAAa,EAAE,CAAC;QAC3D,IAAI,UAAU,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,IAAI,SAAS,CAAC,oDAAoD,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,UAAU,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YAC5C,MAAM,IAAI,SAAS,CACjB,+DAA+D,CAChE,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAEnC,OAAO,UAAU,CAAC,cAAc,CAAC;QACjC,OAAO,UAAU,CAAC,OAAO,CAAC;QAE1B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,UAAU,CAAC,WAAW,CAAC;YAC9B,OAAO,UAAU,CAAC,OAAO,CAAC;YAC1B,OAAO,UAAU,CAAC,MAAM,CAAC;YACzB,UAAU,CAAC,GAAG,GAAG,KAAK,CAAC;QACzB,CAAC;aAAM,IAAI,OAAO,KAAK,OAAO,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;YACvD,MAAM,IAAI,SAAS,CAAC,mCAAmC,OAAO,EAAE,CAAC,CAAC;QACpE,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,GAAG,MAAM,sBAAsB,CAAC,UAAU,CAAC,CAAC;YAErD,IAAI,GAAG,EAAE,CAAC;gBACR,UAAU,CAAC,GAAG,GAAG,GAAG,CAAC;YACvB,CAAC;YAED,QAAQ,OAAO,EAAE,CAAC;gBAChB,KAAK,SAAS;oBACZ,UAAU,CAAC,GAAG,GAAG,GAAG,EAAE,EAAE;wBACtB,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE;wBAClD,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC;oBAC1C,MAAM;gBACR,KAAK,WAAW;oBACd,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC;wBACb,MAAM,IAAI,SAAS,CACjB,mDAAmD,CACpD,CAAC;oBACJ,CAAC;oBACD,UAAU,CAAC,GAAG,GAAG,EAAE,GAAG,GAAG,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC;oBAClE,MAAM;gBACR,KAAK,aAAa;oBAChB,UAAU,CAAC,GAAG,GAAG,GAAG,IAAI,EAAE,CAAC;oBAC3B,MAAM;gBACR,KAAK,SAAS;oBACZ,MAAM;gBACR;oBACE,MAAM,IAAI,SAAS,CACjB,mCAAmC,MAAM,CAAC,OAAO,CAAC,EAAE,CACrD,CAAC;YACN,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,MAAM;QACN,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS;KAC3E,CAAC;AACJ,CAAC;AAgCD;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,iBAAiB;IACrC,MAAM,UAAU,GAAG,IAAA,4CAAiB,GAAE,CAAC;IAEvC,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;IAE7C,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAE7C,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YAC7B,OAAO;gBACL,GAAG,UAAU;gBACb,MAAM;gBACN,MAAM,EAAE,IAAA,wBAAa,EAAC,GAAG,CAAC;aAC3B,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAErC,OAAO;YACL,GAAG,UAAU;YACb,MAAM;YACN,IAAI,EAAE,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC;YACrC,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI;YACf,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;YACvD,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC;YACtC,QAAQ,EAAE,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC1C,GAAG,CAAC,MAAM,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;SAC9C,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG,UAAU;QACb,MAAM,EAAE,SAAS;QACjB,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,SAAS;QACf,MAAM,EAAE,SAAS;QACjB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,SAAS;KACpB,CAAC;AACJ,CAAC"}

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

@@ -1,29 +1,55 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const promises_1 = require("node:fs/promises");
+const node_os_1 = require("node:os");
+const node_path_1 = require("node:path");
+const better_sqlite_1 = require("@mikro-orm/better-sqlite");
 const core_1 = require("@mikro-orm/core");
 const mysql_1 = require("@mikro-orm/mysql");
 const postgresql_1 = require("@mikro-orm/postgresql");
 const reflection_1 = require("@mikro-orm/reflection");
 const load_config_from_env_util_1 = require("./load-config-from-env.util");
 const ORIGINAL_ENV = process.env;
+async function withTlsFiles(callback) {
+    const directory = await (0, promises_1.mkdtemp)((0, node_path_1.join)((0, node_os_1.tmpdir)(), "nest-boot-mikro-orm-"));
+    const paths = {
+        clientCert: (0, node_path_1.join)(directory, "client.crt"),
+        clientKey: (0, node_path_1.join)(directory, "client.key"),
+        rootCert: (0, node_path_1.join)(directory, "root.crt"),
+    };
+    try {
+        await Promise.all([
+            (0, promises_1.writeFile)(paths.rootCert, "root certificate"),
+            (0, promises_1.writeFile)(paths.clientCert, "client certificate"),
+            (0, promises_1.writeFile)(paths.clientKey, "client key"),
+        ]);
+        await callback(paths);
+    }
+    finally {
+        await (0, promises_1.rm)(directory, { force: true, recursive: true });
+    }
+}
 describe("loadConfigFromEnv", () => {
     beforeEach(() => {
-        process.env = Object.fromEntries(Object.entries(ORIGINAL_ENV).filter(([key]) => !key.startsWith("DB_") && !key.startsWith("DATABASE_")));
+        process.env = { ...ORIGINAL_ENV };
+        delete process.env.DATABASE_URL;
     });
     afterAll(() => {
         process.env = ORIGINAL_ENV;
     });
     it("should load URL-based MySQL config", async () => {
-        process.env.DB_URL = "mysql://user:pass@localhost:3306/app";
-        process.env.DB_DEBUG = "true";
-        await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).resolves.toMatchObject({
-            clientUrl: "mysql://user:pass@localhost:3306/app",
+        process.env.DATABASE_URL =
+            "mysql://user%40example.com:p%40ss%2Fword@localhost:3306/app";
+        const config = await (0, load_config_from_env_util_1.loadConfigFromEnv)();
+        expect(config).toMatchObject({
             colors: false,
             dataloader: core_1.DataloaderType.ALL,
-            debug: true,
+            dbName: "app",
+            debug: false,
             driver: mysql_1.MySqlDriver,
             entities: ["dist/**/*.entity.js"],
             entitiesTs: ["src/**/*.entity.ts"],
+            host: "localhost",
             metadataProvider: reflection_1.TsMorphMetadataProvider,
             migrations: {
                 path: "dist/database/migrations",
@@ -35,33 +61,234 @@ describe("loadConfigFromEnv", () => {
                 path: "dist/database/seeders",
                 pathTs: "src/database/seeders",
             },
+            password: "p@ss/word",
+            port: 3306,
             timezone: "UTC",
+            user: "user@example.com",
         });
+        expect(config).not.toHaveProperty("clientUrl");
+        expect(config.seeder?.fileName?.("CustomSeeder")).toBe("CustomSeeder");
     });
     it("should load URL-based PostgreSQL config", async () => {
-        process.env.DATABASE_URL = "postgresql://user:pass@localhost:5432/app";
+        process.env.DATABASE_URL =
+            "postgresql://user:pass@[2001:db8::1]:5432/app?schema=tenant&sslmode=require&application_name=nest-boot";
         await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).resolves.toMatchObject({
-            clientUrl: "postgresql://user:pass@localhost:5432/app",
+            dbName: "app",
             driver: postgresql_1.PostgreSqlDriver,
+            driverOptions: {
+                connection: {
+                    application_name: "nest-boot",
+                    ssl: {},
+                },
+            },
+            host: "2001:db8::1",
+            password: "pass",
+            port: 5432,
+            schema: "tenant",
+            user: "user",
         });
     });
-    it("should load host-based config from aliases", async () => {
-        process.env.DATABASE_TYPE = "postgres";
-        process.env.DATABASE_HOST = "localhost";
-        process.env.DATABASE_PORT = "5432";
-        process.env.DATABASE_NAME = "app";
-        process.env.DATABASE_USERNAME = "user";
-        process.env.DATABASE_PASSWORD = "pass";
+    it("should load the postgres PostgreSQL URI form", async () => {
+        process.env.DATABASE_URL = "postgres://user:pass@localhost/app";
         await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).resolves.toMatchObject({
             dbName: "app",
             driver: postgresql_1.PostgreSqlDriver,
             host: "localhost",
             password: "pass",
-            port: 5432,
             user: "user",
         });
     });
-    it("should return undefined driver and port when env vars are absent", async () => {
+    it("should load a file URL as SQLite config", async () => {
+        process.env.DATABASE_URL = "file:///var/lib/nest-boot/app%20data.db";
+        await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).resolves.toMatchObject({
+            dbName: "/var/lib/nest-boot/app data.db",
+            driver: better_sqlite_1.BetterSqliteDriver,
+        });
+    });
+    it.each([
+        ["mysql", "ssl-mode=DISABLED", { ssl: false }],
+        ["mysql", "ssl-mode=REQUIRED", { ssl: { rejectUnauthorized: false } }],
+        ["postgresql", "sslmode=disable", { ssl: false }],
+        ["postgresql", "sslmode=require", { ssl: { rejectUnauthorized: false } }],
+        ["postgresql", "sslmode=verify-full", { ssl: {} }],
+    ])("should parse %s driver query option %s", async (protocol, query, expected) => {
+        process.env.DATABASE_URL = `${protocol}://user:pass@localhost/app?${query}`;
+        await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).resolves.toMatchObject({
+            driverOptions: {
+                connection: expected,
+            },
+        });
+    });
+    it("should preserve omitted URL credentials and port", async () => {
+        process.env.DATABASE_URL = "postgresql://db.internal";
+        const config = await (0, load_config_from_env_util_1.loadConfigFromEnv)();
+        expect(config).toMatchObject({
+            dbName: undefined,
+            host: "db.internal",
+            password: "",
+            port: 0,
+            user: "",
+        });
+        const mikroOrmConfig = new core_1.Configuration(config, false);
+        expect(mikroOrmConfig.getDriver().getConnection().getConnectionOptions()).toMatchObject({
+            host: "db.internal",
+            password: "",
+            port: 0,
+            user: "",
+        });
+    });
+    it("should load PostgreSQL TLS files into structured SSL options", async () => {
+        await withTlsFiles(async ({ clientCert, clientKey, rootCert }) => {
+            const databaseUrl = new URL("postgresql://user:pass@localhost/app");
+            databaseUrl.searchParams.set("sslmode", "verify-full");
+            databaseUrl.searchParams.set("sslrootcert", rootCert);
+            databaseUrl.searchParams.set("sslcert", clientCert);
+            databaseUrl.searchParams.set("sslkey", clientKey);
+            process.env.DATABASE_URL = databaseUrl.href;
+            await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).resolves.toMatchObject({
+                driverOptions: {
+                    connection: {
+                        ssl: {
+                            ca: "root certificate",
+                            cert: "client certificate",
+                            key: "client key",
+                        },
+                    },
+                },
+            });
+        });
+    });
+    it.each(["require", "verify-ca"])("should map PostgreSQL sslmode=%s with a root certificate", async (sslMode) => {
+        await withTlsFiles(async ({ rootCert }) => {
+            const databaseUrl = new URL("postgresql://user:pass@localhost/app");
+            databaseUrl.searchParams.set("sslmode", sslMode);
+            databaseUrl.searchParams.set("sslrootcert", rootCert);
+            process.env.DATABASE_URL = databaseUrl.href;
+            const config = await (0, load_config_from_env_util_1.loadConfigFromEnv)();
+            const connection = config.driverOptions?.connection;
+            const ssl = connection.ssl;
+            expect(ssl).toMatchObject({
+                ca: "root certificate",
+                checkServerIdentity: expect.any(Function),
+            });
+            const checkServerIdentity = ssl.checkServerIdentity;
+            checkServerIdentity();
+        });
+    });
+    it("should load MySQL TLS files into structured SSL options", async () => {
+        await withTlsFiles(async ({ clientCert, clientKey, rootCert }) => {
+            const databaseUrl = new URL("mysql://user:pass@localhost/app");
+            databaseUrl.searchParams.set("ssl-ca", rootCert);
+            databaseUrl.searchParams.set("ssl-cert", clientCert);
+            databaseUrl.searchParams.set("ssl-key", clientKey);
+            process.env.DATABASE_URL = databaseUrl.href;
+            const config = await (0, load_config_from_env_util_1.loadConfigFromEnv)();
+            expect(config.driverOptions).toEqual({
+                connection: {
+                    ssl: {
+                        ca: "root certificate",
+                        cert: "client certificate",
+                        key: "client key",
+                        rejectUnauthorized: true,
+                        verifyIdentity: false,
+                    },
+                },
+            });
+        });
+    });
+    it.each([
+        ["VERIFY_CA", false],
+        ["VERIFY_IDENTITY", true],
+    ])("should map MySQL ssl-mode=%s with a CA certificate", async (sslMode, verifyIdentity) => {
+        await withTlsFiles(async ({ rootCert }) => {
+            const databaseUrl = new URL("mysql://user:pass@localhost/app");
+            databaseUrl.searchParams.set("ssl-mode", sslMode);
+            databaseUrl.searchParams.set("ssl-ca", rootCert);
+            process.env.DATABASE_URL = databaseUrl.href;
+            await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).resolves.toMatchObject({
+                driverOptions: {
+                    connection: {
+                        ssl: {
+                            ca: "root certificate",
+                            rejectUnauthorized: true,
+                            verifyIdentity,
+                        },
+                    },
+                },
+            });
+        });
+    });
+    it("should not read MySQL TLS files when SSL is disabled", async () => {
+        process.env.DATABASE_URL =
+            "mysql://user:pass@localhost/app?ssl-mode=DISABLED&ssl-ca=/missing/ca.pem";
+        await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).resolves.toMatchObject({
+            driverOptions: {
+                connection: {
+                    ssl: false,
+                },
+            },
+        });
+    });
+    it("should reject unsupported MySQL SSL modes", async () => {
+        process.env.DATABASE_URL =
+            "mysql://user:pass@localhost/app?ssl-mode=VERIFY_HOSTNAME";
+        await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).rejects.toThrow("Unsupported MySQL ssl-mode: VERIFY_HOSTNAME");
+    });
+    it.each([
+        ["mysql://user:pass@localhost/app?ssl-mode=PREFERRED", "PREFERRED"],
+        ["postgresql://user:pass@localhost/app?sslmode=allow", "allow"],
+        ["postgresql://user:pass@localhost/app?sslmode=prefer", "prefer"],
+    ])("should reject SSL fallback mode %s that structured options cannot express", async (databaseUrl, sslMode) => {
+        process.env.DATABASE_URL = databaseUrl;
+        await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).rejects.toThrow(`Unsupported ${databaseUrl.startsWith("mysql:") ? "MySQL ssl-mode" : "PostgreSQL sslmode"}: ${sslMode}`);
+    });
+    it.each(["VERIFY_CA", "VERIFY_IDENTITY"])("should require ssl-ca for MySQL ssl-mode=%s", async (sslMode) => {
+        process.env.DATABASE_URL = `mysql://user:pass@localhost/app?ssl-mode=${sslMode}`;
+        await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).rejects.toThrow(`MySQL ssl-mode=${sslMode} requires ssl-ca`);
+    });
+    it("should require sslrootcert for PostgreSQL verify-ca", async () => {
+        process.env.DATABASE_URL =
+            "postgresql://user:pass@localhost/app?sslmode=verify-ca";
+        await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).rejects.toThrow("PostgreSQL sslmode=verify-ca requires sslrootcert");
+    });
+    it.each([
+        [
+            "mysql://user:pass@localhost/app?ssl=true",
+            "Unsupported MySQL DATABASE_URL parameter: ssl",
+        ],
+        [
+            "mysql://user:pass@localhost/app?multipleStatements=false",
+            "Unsupported MySQL DATABASE_URL parameter: multipleStatements",
+        ],
+        [
+            "postgresql://user:pass@localhost/app?ssl=true",
+            "Unsupported PostgreSQL DATABASE_URL parameter: ssl",
+        ],
+        [
+            "postgresql://user:pass@localhost/app?ssl=1",
+            "Unsupported PostgreSQL DATABASE_URL parameter: ssl",
+        ],
+        [
+            "postgresql://user:pass@localhost/app?uselibpqcompat=true",
+            "Unsupported PostgreSQL DATABASE_URL parameter: uselibpqcompat",
+        ],
+        [
+            "postgresql://user:pass@localhost/app?sslmode=no-verify",
+            "Unsupported PostgreSQL sslmode: no-verify",
+        ],
+    ])("should reject non-standard database URL options", async (url, error) => {
+        process.env.DATABASE_URL = url;
+        await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).rejects.toThrow(error);
+    });
+    it.each(["mysql2://localhost/app", "sqlite:///var/lib/app.db"])("should reject non-standard database URL %s", async (databaseUrl) => {
+        process.env.DATABASE_URL = databaseUrl;
+        await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).rejects.toThrow(`Unsupported DATABASE_URL protocol: ${new URL(databaseUrl).protocol}`);
+    });
+    it("should reject unsupported database URL protocols", async () => {
+        process.env.DATABASE_URL = "mongodb://localhost/app";
+        await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).rejects.toThrow("Unsupported DATABASE_URL protocol: mongodb:");
+    });
+    it("should return undefined connection fields when DATABASE_URL is absent", async () => {
         await expect((0, load_config_from_env_util_1.loadConfigFromEnv)()).resolves.toMatchObject({
             dbName: undefined,
             driver: undefined,