joist-utils 1.0.688 → 1.0.692

package/build/connection.d.ts

@@ -1,20 +1,26 @@
 import { ConnectionConfig } from "pg";
-export interface ConnectionInfo {
-    dbname: string;
-    username: string;
-    password: string;
-    host: string;
-    port: number;
-}
+declare type DatabaseUrl = {
+    DATABASE_URL: string;
+};
+declare type DbSettings = {
+    DB_USER: string;
+    DB_PASSWORD: string;
+    DB_HOST: string;
+    DB_DATABASE: string;
+    DB_PORT: string;
+};
+export declare type ConnectionEnv = DatabaseUrl | DbSettings;
 /**
  * Returns the `ConnectionConfig` that joist will use to connect to pg.
  *
- * This is currently hard-coded to read the `DATABASE_CONNECTION_INFO` env variable.
+ * This reads environment variables, and can be either:
  *
+ * - A single `DATABASE_URL` variable
+ * - Multiple `DB_USER`, `DB_PASSWORD`, `DB_DATABASE`, `DB_HOST`, `DB_PORT` variables
  * The value can be either:
  *
- * - RDS-style JSON like `{"dbname":"...","host":"...",...}`
- * - connection-string-style like `postgres://host?...` as read by the `pg-connection-string` `parse` method
+ * Note that users using a library for typed / validated environment variables, i.e.
+ * ts-app-env, you can pass in a specific `env` variable.
  */
-export declare function newPgConnectionConfig(): ConnectionConfig;
-export declare function parsePgConnectionConfig(envVariable: string): ConnectionConfig;
+export declare function newPgConnectionConfig(env?: ConnectionEnv): ConnectionConfig;
+export {};

package/build/connection.js

@@ -1,52 +1,46 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parsePgConnectionConfig = exports.newPgConnectionConfig = void 0;
+exports.newPgConnectionConfig = void 0;
 const pg_connection_string_1 = require("pg-connection-string");
-const index_1 = require("./index");
-function readEnvVariable() {
-    return process.env.DATABASE_CONNECTION_INFO || (0, index_1.fail)("DATABASE_CONNECTION_INFO environment variable is not set");
-}
-/** Reads the RDS-style connection information from `process.env`. */
-function parseAsRdsConnectionInfo(envVariable) {
-    if (envVariable.startsWith("{")) {
-        const { dbname: database, username: user, password, host, port } = JSON.parse(envVariable);
-        return { database, user, password, host, port };
-    }
-    return undefined;
-}
 /**
  * Returns the `ConnectionConfig` that joist will use to connect to pg.
  *
- * This is currently hard-coded to read the `DATABASE_CONNECTION_INFO` env variable.
+ * This reads environment variables, and can be either:
  *
+ * - A single `DATABASE_URL` variable
+ * - Multiple `DB_USER`, `DB_PASSWORD`, `DB_DATABASE`, `DB_HOST`, `DB_PORT` variables
  * The value can be either:
  *
- * - RDS-style JSON like `{"dbname":"...","host":"...",...}`
- * - connection-string-style like `postgres://host?...` as read by the `pg-connection-string` `parse` method
+ * Note that users using a library for typed / validated environment variables, i.e.
+ * ts-app-env, you can pass in a specific `env` variable.
  */
-function newPgConnectionConfig() {
-    return parsePgConnectionConfig(readEnvVariable());
-}
-exports.newPgConnectionConfig = newPgConnectionConfig;
-// exported for testing
-function parsePgConnectionConfig(envVariable) {
-    const rdsConfig = parseAsRdsConnectionInfo(envVariable);
-    if (rdsConfig) {
-        return rdsConfig;
+function newPgConnectionConfig(env) {
+    if (process.env.DATABASE_URL || (env && "DATABASE_URL" in env)) {
+        const url = process.env.DATABASE_URL ?? env.DATABASE_URL;
+        // It'd be great if `parse` returned ConnectionConfig directly
+        const options = (0, pg_connection_string_1.parse)(url);
+        const { database, port, host, user, password } = options;
+        return {
+            user,
+            password,
+            database: database ?? undefined,
+            host: host ?? undefined,
+            port: port ? Number(port) : undefined,
+        };
+    }
+    else if (process.env.DB_DATABASE || (env && "DB_DATABASE" in env)) {
+        const e = process.env.DB_DATABASE ? process.env : env;
+        return {
+            user: e.DB_USER,
+            password: e.DB_PASSWORD,
+            database: e.DB_DATABASE,
+            host: e.DB_HOST,
+            port: e.DB_PORT ? Number(e.DB_PORT) : undefined,
+        };
+    }
+    else {
+        throw new Error("No DATABASE_URL or DB_DATABASE/etc. environment variable found");
     }
-    const opts = (0, pg_connection_string_1.parse)(envVariable);
-    return {
-        ...opts,
-        // Drop `| null` from the parse return type
-        database: opts.database || undefined,
-        host: opts.host || undefined,
-        port: opts.port !== undefined && opts.port !== null ? Number(opts.port) : undefined,
-        ssl: typeof opts.ssl === "boolean"
-            ? opts.ssl
-            : typeof opts.ssl === "string"
-                ? (0, index_1.fail)("parsing string ssl not implemented")
-                : undefined,
-    };
 }
-exports.parsePgConnectionConfig = parsePgConnectionConfig;
+exports.newPgConnectionConfig = newPgConnectionConfig;
 //# sourceMappingURL=connection.js.map

package/build/connection.js.map

@@ -1 +1 @@
-{"version":3,"file":"connection.js","sourceRoot":"","sources":["../src/connection.ts"],"names":[],"mappings":";;;AACA,+DAA6C;AAC7C,mCAA+B;AAW/B,SAAS,eAAe;IACtB,OAAO,OAAO,CAAC,GAAG,CAAC,wBAAwB,IAAI,IAAA,YAAI,EAAC,0DAA0D,CAAC,CAAC;AAClH,CAAC;AAED,qEAAqE;AACrE,SAAS,wBAAwB,CAAC,WAAmB;IACnD,IAAI,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QAC/B,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAmB,CAAC;QAC7G,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;KACjD;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,qBAAqB;IACnC,OAAO,uBAAuB,CAAC,eAAe,EAAE,CAAC,CAAC;AACpD,CAAC;AAFD,sDAEC;AAED,uBAAuB;AACvB,SAAgB,uBAAuB,CAAC,WAAmB;IACzD,MAAM,SAAS,GAAG,wBAAwB,CAAC,WAAW,CAAC,CAAC;IACxD,IAAI,SAAS,EAAE;QACb,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,IAAI,GAAG,IAAA,4BAAK,EAAC,WAAW,CAAC,CAAC;IAChC,OAAO;QACL,GAAG,IAAI;QACP,2CAA2C;QAC3C,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,SAAS;QACpC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,SAAS;QAC5B,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;QACnF,GAAG,EACD,OAAO,IAAI,CAAC,GAAG,KAAK,SAAS;YAC3B,CAAC,CAAC,IAAI,CAAC,GAAG;YACV,CAAC,CAAC,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ;gBAC9B,CAAC,CAAC,IAAA,YAAI,EAAC,oCAAoC,CAAC;gBAC5C,CAAC,CAAC,SAAS;KAChB,CAAC;AACJ,CAAC;AAnBD,0DAmBC"}
+{"version":3,"file":"connection.js","sourceRoot":"","sources":["../src/connection.ts"],"names":[],"mappings":";;;AACA,+DAA6C;AAO7C;;;;;;;;;;;GAWG;AACH,SAAgB,qBAAqB,CAAC,GAAmB;IACvD,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,CAAC,GAAG,IAAI,cAAc,IAAI,GAAG,CAAC,EAAE;QAC9D,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,IAAK,GAAmB,CAAC,YAAY,CAAC;QAC1E,8DAA8D;QAC9D,MAAM,OAAO,GAAG,IAAA,4BAAK,EAAC,GAAG,CAAC,CAAC;QAC3B,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QACzD,OAAO;YACL,IAAI;YACJ,QAAQ;YACR,QAAQ,EAAE,QAAQ,IAAI,SAAS;YAC/B,IAAI,EAAE,IAAI,IAAI,SAAS;YACvB,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;SACtC,CAAC;KACH;SAAM,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,CAAC,GAAG,IAAI,aAAa,IAAI,GAAG,CAAC,EAAE;QACnE,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAE,GAAkB,CAAC;QACtE,OAAO;YACL,IAAI,EAAE,CAAC,CAAC,OAAO;YACf,QAAQ,EAAE,CAAC,CAAC,WAAW;YACvB,QAAQ,EAAE,CAAC,CAAC,WAAW;YACvB,IAAI,EAAE,CAAC,CAAC,OAAO;YACf,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;SAChD,CAAC;KACH;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;KACnF;AACH,CAAC;AAzBD,sDAyBC"}

package/build/connection.test.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const connection_1 = require("./connection");
 describe("connection", () => {
-    it("should parse RDS-style json", () => {
-        const info = (0, connection_1.parsePgConnectionConfig)(`{"host":"db","port":5432,"username":"joist","password":"local","dbname":"joist"}`);
+    it("should parse single DATABASE_URL", () => {
+        const info = (0, connection_1.newPgConnectionConfig)({ DATABASE_URL: "postgres://joist:local@db:5432/joist" });
         expect(info).toEqual({
             database: "joist",
             host: "db",
@@ -12,8 +12,14 @@ describe("connection", () => {
             user: "joist",
         });
     });
-    it("should parse connection-string-style", () => {
-        const info = (0, connection_1.parsePgConnectionConfig)("postgres://joist:local@db:5432/joist");
+    it("should parse multiple DB variables", () => {
+        const info = (0, connection_1.newPgConnectionConfig)({
+            DB_USER: "joist",
+            DB_PASSWORD: "local",
+            DB_DATABASE: "joist",
+            DB_HOST: "db",
+            DB_PORT: "5432",
+        });
         expect(info).toEqual({
             database: "joist",
             host: "db",

package/build/connection.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"connection.test.js","sourceRoot":"","sources":["../src/connection.test.ts"],"names":[],"mappings":";;AAAA,6CAAuD;AAEvD,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,MAAM,IAAI,GAAG,IAAA,oCAAuB,EAClC,kFAAkF,CACnF,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YACnB,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,OAAO;SACd,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,IAAI,GAAG,IAAA,oCAAuB,EAAC,sCAAsC,CAAC,CAAC;QAC7E,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YACnB,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,IAAI;YACV,GAAG,EAAE,SAAS;YACd,IAAI,EAAE,OAAO;SACd,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"connection.test.js","sourceRoot":"","sources":["../src/connection.test.ts"],"names":[],"mappings":";;AAAA,6CAAqD;AAErD,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,IAAI,GAAG,IAAA,kCAAqB,EAAC,EAAE,YAAY,EAAE,sCAAsC,EAAE,CAAC,CAAC;QAC7F,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YACnB,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,OAAO;SACd,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,IAAI,GAAG,IAAA,kCAAqB,EAAC;YACjC,OAAO,EAAE,OAAO;YAChB,WAAW,EAAE,OAAO;YACpB,WAAW,EAAE,OAAO;YACpB,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,MAAM;SAChB,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YACnB,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,IAAI;YACV,GAAG,EAAE,SAAS;YACd,IAAI,EAAE,OAAO;SACd,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joist-utils",
-  "version": "1.0.688",
+  "version": "1.0.692",
   "license": "MIT",
   "main": "build/index.js",
   "types": "build/index.d.ts",