@russ-b/nestjs-common-tools 2.1.0 → 2.1.1

package/README.md

@@ -598,6 +598,32 @@ export class AppModule {}
 
 PostgreSQL support is also exposed directly as `createPostgresTypeormOptions`. Its `schema` option is applied both as TypeORM's schema and as `search_path`, and pool options are passed through the `pg` driver via TypeORM's `extra` config.
 
+For managed PostgreSQL providers that require SSL with a CA certificate, you can pass atomic connection fields and `sslCa`. This avoids `pg` overwriting the explicit `ssl` object when `sslmode` or `sslrootcert` exists in the connection string.
+
+```typescript
+TypeOrmModule.forRootAsync({
+  imports: [ConfigModule],
+  inject: [ConfigService],
+  useFactory: (config: ConfigService) =>
+    createTypeOrmOptions({
+      type: 'postgres',
+      database: {
+        host: config.getOrThrow<string>('DB_HOST'),
+        port: config.get<number>('DB_PORT'),
+        username: config.getOrThrow<string>('DB_USER'),
+        password: config.getOrThrow<string>('DB_PASSWORD'),
+        database: config.getOrThrow<string>('DB_NAME'),
+      },
+      sslCa: config.get<string>('DB_CA_CERT'),
+      sync: config.get<string>('TYPEORM_SYNC'),
+      logging: config.get<string>('TYPEORM_LOGGING'),
+      isProduction: config.get<string>('NODE_ENV') === 'production',
+    }),
+});
+```
+
+When `sslCa` is used together with `databaseUrl`, SSL-related query params such as `sslmode` and `sslrootcert` are removed from the URL before TypeORM passes the config to `pg`.
+
 For MySQL, use `type: 'mysql'` or call `createMysqlTypeormOptions` directly:
 
 ```typescript

package/dist/typeorm/config/postgres-typeorm-options.factory.d.ts

@@ -1,9 +1,19 @@
 import type { TypeOrmModuleOptions } from '@nestjs/typeorm';
 import { CommonTypeormConfigOptions } from './typeorm-options.util';
-export interface PostgresTypeormConfigOptions extends CommonTypeormConfigOptions {
+export interface PostgresTypeormDatabaseConnectionOptions {
+    host: string;
+    port?: number;
+    username: string;
+    password: string;
+    database: string;
+}
+export interface PostgresTypeormConfigOptions extends Omit<CommonTypeormConfigOptions, 'databaseUrl'> {
     type?: 'postgres';
-    appName: string;
+    databaseUrl?: string;
+    database?: PostgresTypeormDatabaseConnectionOptions;
+    appName?: string;
     schema?: string;
+    sslCa?: string;
     queryTimeout?: number;
 }
 export declare function createPostgresTypeormOptions(options: PostgresTypeormConfigOptions): TypeOrmModuleOptions;

package/dist/typeorm/config/postgres-typeorm-options.factory.js

@@ -10,9 +10,12 @@ function createPostgresTypeormOptions(options) {
         queryTimeout: 30_000,
         ...options,
     };
+    const connectionOptions = createConnectionOptions(resolvedOptions);
+    const ssl = createSslOptions(resolvedOptions.sslCa);
     return {
         type: 'postgres',
-        url: encodeURI(resolvedOptions.databaseUrl),
+        ...connectionOptions,
+        ...(ssl ? { ssl } : {}),
         autoLoadEntities: true,
         schema: resolvedOptions.schema,
         maxQueryExecutionTime: resolvedOptions.maxQueryExecutionTime,
@@ -28,9 +31,41 @@ function createPostgresTypeormOptions(options) {
             connectionTimeoutMillis: 5000,
             maxUses: 10000,
             keepAlive: true,
-            application_name: resolvedOptions.appName,
+            ...(resolvedOptions.appName
+                ? { application_name: resolvedOptions.appName }
+                : {}),
             query_timeout: resolvedOptions.queryTimeout,
         },
     };
 }
+function createConnectionOptions(options) {
+    if (options.database) {
+        return options.database;
+    }
+    if (!options.databaseUrl) {
+        throw new Error('databaseUrl or database connection options must be configured.');
+    }
+    const databaseUrl = encodeURI(options.databaseUrl);
+    return {
+        url: options.sslCa
+            ? removeConnectionStringSslParams(databaseUrl)
+            : databaseUrl,
+    };
+}
+function createSslOptions(sslCa) {
+    if (!sslCa) {
+        return undefined;
+    }
+    return {
+        ca: sslCa.replace(/\\n/g, '\n'),
+        rejectUnauthorized: true,
+    };
+}
+function removeConnectionStringSslParams(databaseUrl) {
+    const parsedUrl = new URL(databaseUrl);
+    for (const param of ['ssl', 'sslcert', 'sslkey', 'sslmode', 'sslrootcert']) {
+        parsedUrl.searchParams.delete(param);
+    }
+    return parsedUrl.toString();
+}
 //# sourceMappingURL=postgres-typeorm-options.factory.js.map

package/dist/typeorm/config/postgres-typeorm-options.factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"postgres-typeorm-options.factory.js","sourceRoot":"","sources":["../../../src/typeorm/config/postgres-typeorm-options.factory.ts"],"names":[],"mappings":";;AA2BA,oEA+BC;AA1DD,2CAAwC;AAExC,iEAMgC;AAiBhC,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC,uBAAuB,CAAC,CAAC;AAEnD,SAAgB,4BAA4B,CAC1C,OAAqC;IAErC,MAAM,eAAe,GAAyC;QAC5D,GAAG,8CAAuB;QAC1B,YAAY,EAAE,MAAM;QACpB,GAAG,OAAO;KACX,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,GAAG,EAAE,SAAS,CAAC,eAAe,CAAC,WAAW,CAAC;QAC3C,gBAAgB,EAAE,IAAI;QACtB,MAAM,EAAE,eAAe,CAAC,MAAM;QAC9B,qBAAqB,EAAE,eAAe,CAAC,qBAAqB;QAC5D,WAAW,EAAE,IAAA,qCAAc,EAAC,eAAe,EAAE,MAAM,CAAC;QACpD,OAAO,EAAE,IAAA,iCAAU,EAAC,eAAe,CAAC,OAAO,CAAC;QAC5C,aAAa,EAAE,CAAC;QAChB,KAAK,EAAE;YACL,OAAO,EAAE,eAAe,CAAC,MAAM;gBAC7B,CAAC,CAAC,kBAAkB,eAAe,CAAC,MAAM,SAAS;gBACnD,CAAC,CAAC,SAAS;YACb,GAAG,EAAE,eAAe,CAAC,cAAc;YACnC,iBAAiB,EAAE,KAAK;YACxB,uBAAuB,EAAE,IAAI;YAC7B,OAAO,EAAE,KAAK;YACd,SAAS,EAAE,IAAI;YACf,gBAAgB,EAAE,eAAe,CAAC,OAAO;YACzC,aAAa,EAAE,eAAe,CAAC,YAAY;SAC5C;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"postgres-typeorm-options.factory.js","sourceRoot":"","sources":["../../../src/typeorm/config/postgres-typeorm-options.factory.ts"],"names":[],"mappings":";;AAuDA,oEAoCC;AA3FD,2CAAwC;AAGxC,iEAKgC;AA6ChC,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC,uBAAuB,CAAC,CAAC;AAEnD,SAAgB,4BAA4B,CAC1C,OAAqC;IAErC,MAAM,eAAe,GAAyC;QAC5D,GAAG,8CAAuB;QAC1B,YAAY,EAAE,MAAM;QACpB,GAAG,OAAO;KACX,CAAC;IACF,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,eAAe,CAAC,CAAC;IACnE,MAAM,GAAG,GAAG,gBAAgB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IAEpD,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,GAAG,iBAAiB;QACpB,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvB,gBAAgB,EAAE,IAAI;QACtB,MAAM,EAAE,eAAe,CAAC,MAAM;QAC9B,qBAAqB,EAAE,eAAe,CAAC,qBAAqB;QAC5D,WAAW,EAAE,IAAA,qCAAc,EAAC,eAAe,EAAE,MAAM,CAAC;QACpD,OAAO,EAAE,IAAA,iCAAU,EAAC,eAAe,CAAC,OAAO,CAAC;QAC5C,aAAa,EAAE,CAAC;QAChB,KAAK,EAAE;YACL,OAAO,EAAE,eAAe,CAAC,MAAM;gBAC7B,CAAC,CAAC,kBAAkB,eAAe,CAAC,MAAM,SAAS;gBACnD,CAAC,CAAC,SAAS;YACb,GAAG,EAAE,eAAe,CAAC,cAAc;YACnC,iBAAiB,EAAE,KAAK;YACxB,uBAAuB,EAAE,IAAI;YAC7B,OAAO,EAAE,KAAK;YACd,SAAS,EAAE,IAAI;YACf,GAAG,CAAC,eAAe,CAAC,OAAO;gBACzB,CAAC,CAAC,EAAE,gBAAgB,EAAE,eAAe,CAAC,OAAO,EAAE;gBAC/C,CAAC,CAAC,EAAE,CAAC;YACP,aAAa,EAAE,eAAe,CAAC,YAAY;SAC5C;KACF,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAC9B,OAGC;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,OAAO,OAAO,CAAC,QAAQ,CAAC;IAC1B,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAEnD,OAAO;QACL,GAAG,EAAE,OAAO,CAAC,KAAK;YAChB,CAAC,CAAC,+BAA+B,CAAC,WAAW,CAAC;YAC9C,CAAC,CAAC,WAAW;KAChB,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO;QACL,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC;QAC/B,kBAAkB,EAAE,IAAI;KACzB,CAAC;AACJ,CAAC;AAED,SAAS,+BAA+B,CAAC,WAAmB;IAC1D,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;IAEvC,KAAK,MAAM,KAAK,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,CAAC,EAAE,CAAC;QAC3E,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;IAED,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;AAC9B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@russ-b/nestjs-common-tools",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "NestJS utility tools",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",