embedded-postgres-node 0.0.0-stage → 0.1.0

package/examples/scoped.mjs

@@ -0,0 +1,21 @@
+import assert from 'node:assert/strict';
+import pg from 'pg';
+import { startPostgres, withPostgres } from 'embedded-postgres-node';
+import { options } from './options.mjs';
+
+// Explicit ownership works in every supported Node version.
+const database = await startPostgres(options);
+try {
+  const client = new pg.Client({ connectionString: database.connectionUrl });
+  try {
+    await client.connect();
+    assert.equal((await client.query('SELECT 42 AS answer')).rows[0].answer, 42);
+  } finally { await client.end(); }
+} finally { await database.stop(); }
+
+// Return values and errors pass through; PostgreSQL is always stopped.
+await withPostgres(options, async database => {
+  const pool = new pg.Pool({ connectionString: database.connectionUrl });
+  try { assert.equal((await pool.query('SELECT 7 AS answer')).rows[0].answer, 7); }
+  finally { await pool.end(); }
+});

package/examples/vitest.config.mjs

@@ -0,0 +1,2 @@
+import { defineConfig } from 'vitest/config';
+export default defineConfig({ test: { include: ['examples/vitest.test.mjs'] } });

package/examples/vitest.test.mjs

@@ -0,0 +1,21 @@
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+import pg from 'pg';
+import { startPostgres } from 'embedded-postgres-node';
+import { options } from './options.mjs';
+
+describe('repository (one database per suite)', () => {
+  let database;
+  let pool;
+  beforeAll(async () => {
+    database = await startPostgres(options);
+    pool = new pg.Pool({ connectionString: database.connectionUrl });
+    await pool.query('CREATE TABLE widgets (id integer PRIMARY KEY)');
+  }, 180000);
+  afterAll(async () => {
+    try { await pool?.end(); }
+    finally { await database?.stop(); }
+  }, 20000);
+  it('queries the database', async () => {
+    expect((await pool.query('SELECT 42 AS answer')).rows[0].answer).toBe(42);
+  });
+});

package/package.json

@@ -1,6 +1,75 @@
 {
   "name": "embedded-postgres-node",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Supervised, disposable PostgreSQL for Node.js tests using the embedded-postgres v2 CLI",
+  "license": "MIT",
+  "author": "Fergus Strange",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fergusstrange/embedded-postgres-node.git"
+  },
+  "homepage": "https://github.com/fergusstrange/embedded-postgres-node#readme",
+  "bugs": {
+    "url": "https://github.com/fergusstrange/embedded-postgres-node/issues"
+  },
+  "type": "module",
+  "engines": {
+    "node": "^22.0.0 || ^24.0.0"
+  },
+  "main": "./dist/cjs/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE",
+    "docs/",
+    "examples/"
+  ],
+  "keywords": [
+    "postgres",
+    "postgresql",
+    "testing",
+    "embedded",
+    "vitest",
+    "jest"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "build": "node scripts/build.mjs",
+    "test": "npm run build && node --test test/*.test.mjs",
+    "test:coverage": "npm run build && c8 --all --include \"dist/esm/**/*.js\" --exclude \"dist/esm/index.js\" --reporter=text --reporter=json-summary --reporter=lcov --check-coverage --per-file --lines 90 --functions 90 --branches 90 --statements 90 node --test test/*.test.mjs",
+    "test:integration": "npm run build && node --test test/integration/*.test.mjs",
+    "test:examples": "node scripts/test-examples.mjs",
+    "check:package": "node scripts/check-package.mjs",
+    "check:release": "node scripts/check-package.mjs --real",
+    "prepack": "npm run build",
+    "check": "npm run test:coverage && npm run check:package"
+  },
+  "devDependencies": {
+    "@types/node": "22.20.5",
+    "c8": "12.0.0",
+    "jest": "30.5.2",
+    "pg": "8.23.1",
+    "typescript": "7.0.2",
+    "vitest": "5.0.3"
+  }
+}