pg-env 1.0.0

package/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2025 Hyperweb <developers@hyperweb.io>
+Copyright (c) 2020-present, Interweb, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,114 @@
+# pg-env
+
+<p align="center" width="100%">
+  <img height="250" src="https://raw.githubusercontent.com/launchql/launchql/refs/heads/main/assets/outline-logo.svg" />
+</p>
+
+PostgreSQL environment configuration utilities for managing database connection settings.
+
+## Installation
+
+```bash
+npm install pg-env
+```
+
+## Features
+
+- Parse PostgreSQL environment variables (PGHOST, PGPORT, etc.)
+- Convert configuration objects to environment variables
+- Merge environment variables with configuration overrides
+- Create spawn environments with PostgreSQL settings
+
+## Usage
+
+### Basic Configuration
+
+```typescript
+import { PgConfig, getPgEnvOptions } from 'pg-env';
+
+// Get PostgreSQL config from environment with defaults
+const config = getPgEnvOptions();
+console.log(config);
+// { host: 'localhost', port: 5432, user: 'postgres', ... }
+
+// Override specific values
+const customConfig = getPgEnvOptions({
+  database: 'myapp',
+  port: 5433
+});
+```
+
+### Environment Variables
+
+```typescript
+import { getPgEnvVars, toPgEnvVars } from 'pg-env';
+
+// Read current PostgreSQL environment variables
+const envVars = getPgEnvVars();
+// Returns partial PgConfig from PGHOST, PGPORT, etc.
+
+// Convert config to environment variables
+const config: PgConfig = {
+  host: 'db.example.com',
+  port: 5432,
+  user: 'appuser',
+  password: 'secret',
+  database: 'myapp'
+};
+
+const envVars = toPgEnvVars(config);
+// { PGHOST: 'db.example.com', PGPORT: '5432', ... }
+```
+
+### Spawning Processes
+
+```typescript
+import { getSpawnEnvWithPg } from 'pg-env';
+import { spawn } from 'child_process';
+
+// Create environment for spawning processes
+const env = getSpawnEnvWithPg({
+  database: 'testdb',
+  user: 'testuser'
+});
+
+// Use with child processes
+const child = spawn('psql', [], { env });
+```
+
+## API
+
+### Types
+
+#### `PgConfig`
+
+```typescript
+interface PgConfig {
+  host: string;
+  port: number;
+  user: string;
+  password: string;
+  database: string;
+}
+```
+
+### Functions
+
+- `getPgEnvOptions(overrides?: Partial<PgConfig>): PgConfig` - Get config from environment with overrides
+- `getPgEnvVars(): Partial<PgConfig>` - Parse PostgreSQL environment variables
+- `toPgEnvVars(config: Partial<PgConfig>): Record<string, string>` - Convert config to env vars
+- `getSpawnEnvWithPg(config: Partial<PgConfig>, baseEnv?: NodeJS.ProcessEnv): NodeJS.ProcessEnv` - Create spawn environment
+
+### Constants
+
+- `defaultPgConfig: PgConfig` - Default PostgreSQL configuration
+
+## Environment Variables
+
+The package reads the following environment variables:
+
+- `PGHOST` - Database host
+- `PGPORT` - Database port (parsed as number)
+- `PGUSER` - Database user
+- `PGPASSWORD` - Database password
+- `PGDATABASE` - Database name

package/dist/README.md

@@ -0,0 +1,114 @@
+# pg-env
+
+<p align="center" width="100%">
+  <img height="250" src="https://raw.githubusercontent.com/launchql/launchql/refs/heads/main/assets/outline-logo.svg" />
+</p>
+
+PostgreSQL environment configuration utilities for managing database connection settings.
+
+## Installation
+
+```bash
+npm install pg-env
+```
+
+## Features
+
+- Parse PostgreSQL environment variables (PGHOST, PGPORT, etc.)
+- Convert configuration objects to environment variables
+- Merge environment variables with configuration overrides
+- Create spawn environments with PostgreSQL settings
+
+## Usage
+
+### Basic Configuration
+
+```typescript
+import { PgConfig, getPgEnvOptions } from 'pg-env';
+
+// Get PostgreSQL config from environment with defaults
+const config = getPgEnvOptions();
+console.log(config);
+// { host: 'localhost', port: 5432, user: 'postgres', ... }
+
+// Override specific values
+const customConfig = getPgEnvOptions({
+  database: 'myapp',
+  port: 5433
+});
+```
+
+### Environment Variables
+
+```typescript
+import { getPgEnvVars, toPgEnvVars } from 'pg-env';
+
+// Read current PostgreSQL environment variables
+const envVars = getPgEnvVars();
+// Returns partial PgConfig from PGHOST, PGPORT, etc.
+
+// Convert config to environment variables
+const config: PgConfig = {
+  host: 'db.example.com',
+  port: 5432,
+  user: 'appuser',
+  password: 'secret',
+  database: 'myapp'
+};
+
+const envVars = toPgEnvVars(config);
+// { PGHOST: 'db.example.com', PGPORT: '5432', ... }
+```
+
+### Spawning Processes
+
+```typescript
+import { getSpawnEnvWithPg } from 'pg-env';
+import { spawn } from 'child_process';
+
+// Create environment for spawning processes
+const env = getSpawnEnvWithPg({
+  database: 'testdb',
+  user: 'testuser'
+});
+
+// Use with child processes
+const child = spawn('psql', [], { env });
+```
+
+## API
+
+### Types
+
+#### `PgConfig`
+
+```typescript
+interface PgConfig {
+  host: string;
+  port: number;
+  user: string;
+  password: string;
+  database: string;
+}
+```
+
+### Functions
+
+- `getPgEnvOptions(overrides?: Partial<PgConfig>): PgConfig` - Get config from environment with overrides
+- `getPgEnvVars(): Partial<PgConfig>` - Parse PostgreSQL environment variables
+- `toPgEnvVars(config: Partial<PgConfig>): Record<string, string>` - Convert config to env vars
+- `getSpawnEnvWithPg(config: Partial<PgConfig>, baseEnv?: NodeJS.ProcessEnv): NodeJS.ProcessEnv` - Create spawn environment
+
+### Constants
+
+- `defaultPgConfig: PgConfig` - Default PostgreSQL configuration
+
+## Environment Variables
+
+The package reads the following environment variables:
+
+- `PGHOST` - Database host
+- `PGPORT` - Database port (parsed as number)
+- `PGUSER` - Database user
+- `PGPASSWORD` - Database password
+- `PGDATABASE` - Database name

package/dist/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "pg-env",
+  "version": "1.0.0",
+  "author": "Dan Lynch <pyramation@gmail.com>",
+  "description": "PostgreSQL environment configuration utilities",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
+  "homepage": "https://github.com/launchql/launchql",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/launchql/launchql"
+  },
+  "bugs": {
+    "url": "https://github.com/launchql/launchql/issues"
+  },
+  "scripts": {
+    "copy": "copyfiles -f ../../LICENSE README.md package.json dist",
+    "clean": "rimraf dist/**",
+    "prepare": "npm run build",
+    "build": "npm run clean; tsc; tsc -p tsconfig.esm.json; npm run copy",
+    "build:dev": "npm run clean; tsc --declarationMap; tsc -p tsconfig.esm.json; npm run copy",
+    "lint": "eslint . --fix",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "keywords": [
+    "postgres",
+    "postgresql",
+    "environment",
+    "config",
+    "launchql"
+  ]
+}

package/env.d.ts

@@ -0,0 +1,5 @@
+import { PgConfig } from './pg-config';
+export declare const getPgEnvVars: () => Partial<PgConfig>;
+export declare const getPgEnvOptions: (overrides?: Partial<PgConfig>) => PgConfig;
+export declare function toPgEnvVars(config: Partial<PgConfig>): Record<string, string>;
+export declare function getSpawnEnvWithPg(config: Partial<PgConfig>, baseEnv?: NodeJS.ProcessEnv): NodeJS.ProcessEnv;

package/env.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPgEnvOptions = exports.getPgEnvVars = void 0;
+exports.toPgEnvVars = toPgEnvVars;
+exports.getSpawnEnvWithPg = getSpawnEnvWithPg;
+const pg_config_1 = require("./pg-config");
+const parseEnvNumber = (val) => {
+    const num = Number(val);
+    return !isNaN(num) ? num : undefined;
+};
+const getPgEnvVars = () => {
+    const { PGHOST, PGPORT, PGUSER, PGPASSWORD, PGDATABASE } = process.env;
+    return {
+        ...(PGHOST && { host: PGHOST }),
+        ...(PGPORT && { port: parseEnvNumber(PGPORT) }),
+        ...(PGUSER && { user: PGUSER }),
+        ...(PGPASSWORD && { password: PGPASSWORD }),
+        ...(PGDATABASE && { database: PGDATABASE }),
+    };
+};
+exports.getPgEnvVars = getPgEnvVars;
+const getPgEnvOptions = (overrides = {}) => {
+    const envOpts = (0, exports.getPgEnvVars)();
+    const merged = { ...pg_config_1.defaultPgConfig, ...envOpts, ...overrides };
+    return merged;
+};
+exports.getPgEnvOptions = getPgEnvOptions;
+function toPgEnvVars(config) {
+    const opts = { ...pg_config_1.defaultPgConfig, ...config };
+    return {
+        ...(opts.host && { PGHOST: opts.host }),
+        ...(opts.port && { PGPORT: String(opts.port) }),
+        ...(opts.user && { PGUSER: opts.user }),
+        ...(opts.password && { PGPASSWORD: opts.password }),
+        ...(opts.database && { PGDATABASE: opts.database }),
+    };
+}
+function getSpawnEnvWithPg(config, baseEnv = process.env) {
+    return {
+        ...baseEnv,
+        ...toPgEnvVars(config)
+    };
+}

package/esm/env.d.ts

@@ -0,0 +1,5 @@
+import { PgConfig } from './pg-config';
+export declare const getPgEnvVars: () => Partial<PgConfig>;
+export declare const getPgEnvOptions: (overrides?: Partial<PgConfig>) => PgConfig;
+export declare function toPgEnvVars(config: Partial<PgConfig>): Record<string, string>;
+export declare function getSpawnEnvWithPg(config: Partial<PgConfig>, baseEnv?: NodeJS.ProcessEnv): NodeJS.ProcessEnv;

package/esm/env.js

@@ -0,0 +1,36 @@
+import { defaultPgConfig } from './pg-config';
+const parseEnvNumber = (val) => {
+    const num = Number(val);
+    return !isNaN(num) ? num : undefined;
+};
+export const getPgEnvVars = () => {
+    const { PGHOST, PGPORT, PGUSER, PGPASSWORD, PGDATABASE } = process.env;
+    return {
+        ...(PGHOST && { host: PGHOST }),
+        ...(PGPORT && { port: parseEnvNumber(PGPORT) }),
+        ...(PGUSER && { user: PGUSER }),
+        ...(PGPASSWORD && { password: PGPASSWORD }),
+        ...(PGDATABASE && { database: PGDATABASE }),
+    };
+};
+export const getPgEnvOptions = (overrides = {}) => {
+    const envOpts = getPgEnvVars();
+    const merged = { ...defaultPgConfig, ...envOpts, ...overrides };
+    return merged;
+};
+export function toPgEnvVars(config) {
+    const opts = { ...defaultPgConfig, ...config };
+    return {
+        ...(opts.host && { PGHOST: opts.host }),
+        ...(opts.port && { PGPORT: String(opts.port) }),
+        ...(opts.user && { PGUSER: opts.user }),
+        ...(opts.password && { PGPASSWORD: opts.password }),
+        ...(opts.database && { PGDATABASE: opts.database }),
+    };
+}
+export function getSpawnEnvWithPg(config, baseEnv = process.env) {
+    return {
+        ...baseEnv,
+        ...toPgEnvVars(config)
+    };
+}

package/esm/index.d.ts

@@ -0,0 +1,2 @@
+export { PgConfig, defaultPgConfig } from './pg-config';
+export { getPgEnvVars, getPgEnvOptions, toPgEnvVars, getSpawnEnvWithPg } from './env';

package/esm/index.js

@@ -0,0 +1,2 @@
+export { defaultPgConfig } from './pg-config';
+export { getPgEnvVars, getPgEnvOptions, toPgEnvVars, getSpawnEnvWithPg } from './env';

package/esm/pg-config.d.ts

@@ -0,0 +1,8 @@
+export interface PgConfig {
+    host: string;
+    port: number;
+    user: string;
+    password: string;
+    database: string;
+}
+export declare const defaultPgConfig: PgConfig;

package/esm/pg-config.js

@@ -0,0 +1,7 @@
+export const defaultPgConfig = {
+    host: 'localhost',
+    port: 5432,
+    user: 'postgres',
+    password: 'password',
+    database: 'postgres'
+};

package/index.d.ts

@@ -0,0 +1,2 @@
+export { PgConfig, defaultPgConfig } from './pg-config';
+export { getPgEnvVars, getPgEnvOptions, toPgEnvVars, getSpawnEnvWithPg } from './env';

package/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSpawnEnvWithPg = exports.toPgEnvVars = exports.getPgEnvOptions = exports.getPgEnvVars = exports.defaultPgConfig = void 0;
+var pg_config_1 = require("./pg-config");
+Object.defineProperty(exports, "defaultPgConfig", { enumerable: true, get: function () { return pg_config_1.defaultPgConfig; } });
+var env_1 = require("./env");
+Object.defineProperty(exports, "getPgEnvVars", { enumerable: true, get: function () { return env_1.getPgEnvVars; } });
+Object.defineProperty(exports, "getPgEnvOptions", { enumerable: true, get: function () { return env_1.getPgEnvOptions; } });
+Object.defineProperty(exports, "toPgEnvVars", { enumerable: true, get: function () { return env_1.toPgEnvVars; } });
+Object.defineProperty(exports, "getSpawnEnvWithPg", { enumerable: true, get: function () { return env_1.getSpawnEnvWithPg; } });

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "pg-env",
+  "version": "1.0.0",
+  "author": "Dan Lynch <pyramation@gmail.com>",
+  "description": "PostgreSQL environment configuration utilities",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
+  "homepage": "https://github.com/launchql/launchql",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/launchql/launchql"
+  },
+  "bugs": {
+    "url": "https://github.com/launchql/launchql/issues"
+  },
+  "scripts": {
+    "copy": "copyfiles -f ../../LICENSE README.md package.json dist",
+    "clean": "rimraf dist/**",
+    "prepare": "npm run build",
+    "build": "npm run clean; tsc; tsc -p tsconfig.esm.json; npm run copy",
+    "build:dev": "npm run clean; tsc --declarationMap; tsc -p tsconfig.esm.json; npm run copy",
+    "lint": "eslint . --fix",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "keywords": [
+    "postgres",
+    "postgresql",
+    "environment",
+    "config",
+    "launchql"
+  ]
+}

package/pg-config.d.ts

@@ -0,0 +1,8 @@
+export interface PgConfig {
+    host: string;
+    port: number;
+    user: string;
+    password: string;
+    database: string;
+}
+export declare const defaultPgConfig: PgConfig;

package/pg-config.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultPgConfig = void 0;
+exports.defaultPgConfig = {
+    host: 'localhost',
+    port: 5432,
+    user: 'postgres',
+    password: 'password',
+    database: 'postgres'
+};