@venturekit/testing 0.0.20 → 0.0.21

package/dist/stage-db.js

@@ -0,0 +1,96 @@
+/**
+ * Stage database naming + creation.
+ *
+ * `vk dev --stage <s>` and `vk migrate --env <s>` both derive their local
+ * Postgres database from the *declared database intent*, not from the
+ * environment: `<databases[].name ?? id>_<stage>`, with dashes folded to
+ * underscores so the result is a valid unquoted identifier. An inherited
+ * `DATABASE_URL` does **not** override that choice.
+ *
+ * Two consequences bite every test harness, and both are silent:
+ *
+ *  1. Point `vk migrate` at a name you picked yourself and the API will
+ *     happily serve a *different*, unmigrated database — the suite fails
+ *     with `relation "…" does not exist` rather than a connection error.
+ *  2. Nothing creates the database. `vk migrate` connects to it and fails
+ *     with `database "…" does not exist` on any cold machine or CI runner.
+ *
+ * `stageDatabaseName` mirrors the CLI's derivation so a harness never has
+ * to hardcode the name; `ensureStageDatabase` (./ensure-database.ts) closes
+ * the creation gap.
+ *
+ * Everything here is pure so it can be unit-tested — the one piece that
+ * talks to Postgres lives in its own module.
+ */
+/** Local Postgres defaults used by `vk dev`'s generated docker-compose stack. */
+export const LOCAL_PG = {
+    host: 'localhost',
+    port: 5432,
+    user: 'postgres',
+    password: 'postgres',
+    /** Maintenance database — `CREATE DATABASE` cannot run inside the target. */
+    maintenanceDatabase: 'postgres',
+};
+/**
+ * Derive the local Postgres database name for a declared database + stage.
+ *
+ * Mirrors the CLI's `pgName()` exactly — keep the two in step.
+ */
+export function stageDatabaseName(database, stage) {
+    return `${database.replace(/-/g, '_')}_${stage.replace(/-/g, '_')}`;
+}
+/**
+ * True when `name` is a safe unquoted Postgres identifier. Database names
+ * reach `CREATE DATABASE` as literal DDL (they cannot be parameterized), so
+ * anything else is refused rather than escaped.
+ */
+export function isSafeDatabaseName(name) {
+    return /^[A-Za-z0-9_]+$/.test(name);
+}
+/** Build a Postgres URL for an arbitrary database, filling in local defaults. */
+export function pgConnectionString(conn, database) {
+    const host = conn.host ?? LOCAL_PG.host;
+    const port = conn.port ?? LOCAL_PG.port;
+    const user = conn.user ?? LOCAL_PG.user;
+    const password = conn.password ?? LOCAL_PG.password;
+    return `postgresql://${user}:${password}@${host}:${port}/${database}`;
+}
+/**
+ * Connection string for the stage database — the one `vk dev` will serve.
+ * Point `vk migrate` and any harness-side pool at this exact URL.
+ */
+export function stageDatabaseUrl(target) {
+    return pgConnectionString(target, stageDatabaseName(target.database, target.stage));
+}
+/**
+ * Connection string for the maintenance database, used to issue
+ * `CREATE DATABASE`.
+ */
+export function adminDatabaseUrl(conn = {}) {
+    return pgConnectionString(conn, LOCAL_PG.maintenanceDatabase);
+}
+/** Hide the password before a connection string reaches a log. */
+export function redactUrl(url) {
+    return url.replace(/\/\/([^:/@]+):[^@]*@/, '//$1:***@');
+}
+/**
+ * Resolve the database name from either an explicit `name` or a
+ * `database` + `stage` pair, and refuse anything unsafe as DDL.
+ *
+ * Shared by `ensureStageDatabase` so its validation is unit-testable
+ * without a live Postgres.
+ */
+export function resolveStageDatabaseName(options) {
+    const name = options.name ??
+        (options.database && options.stage
+            ? stageDatabaseName(options.database, options.stage)
+            : undefined);
+    if (!name) {
+        throw new Error('@venturekit/testing: needs either `name`, or both `database` and `stage`, to resolve the stage database.');
+    }
+    if (!isSafeDatabaseName(name)) {
+        throw new Error(`@venturekit/testing: refusing to use an unsafe database name: ${name}`);
+    }
+    return name;
+}
+//# sourceMappingURL=stage-db.js.map

package/dist/stage-db.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-db.js","sourceRoot":"","sources":["../src/stage-db.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,iFAAiF;AACjF,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,IAAI;IACV,IAAI,EAAE,UAAU;IAChB,QAAQ,EAAE,UAAU;IACpB,6EAA6E;IAC7E,mBAAmB,EAAE,UAAU;CACvB,CAAC;AAoBX;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAgB,EAAE,KAAa;IAC/D,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;AACtE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,OAAO,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACtC,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,kBAAkB,CAAC,IAAkB,EAAE,QAAgB;IACrE,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC;IACxC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC;IACxC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC;IACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;IACpD,OAAO,gBAAgB,IAAI,IAAI,QAAQ,IAAI,IAAI,IAAI,IAAI,IAAI,QAAQ,EAAE,CAAC;AACxE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAA0C;IACzE,OAAO,kBAAkB,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AACtF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAqB,EAAE;IACtD,OAAO,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AAChE,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,OAAO,GAAG,CAAC,OAAO,CAAC,sBAAsB,EAAE,WAAW,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAIxC;IACC,MAAM,IAAI,GACR,OAAO,CAAC,IAAI;QACZ,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,KAAK;YAChC,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC;YACpD,CAAC,CAAC,SAAS,CAAC,CAAC;IAEjB,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CACb,0GAA0G,CAC3G,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,iEAAiE,IAAI,EAAE,CAAC,CAAC;IAC3F,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "@venturekit/testing",
-  "version": "0.0.20",
+  "version": "0.0.21",
   "description": "Integration & end-to-end test harness for VentureKit apps — launch the local API stack, mint cognito-local users, reset the database, and drive a typed API client.",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "bin"
   ],
+  "bin": {
+    "vk-ensure-db": "./bin/ensure-db.mjs"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/venturekit-dev/venturekit.private.git",
@@ -22,6 +26,10 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
+    },
+    "./playwright": {
+      "types": "./dist/playwright/index.d.ts",
+      "import": "./dist/playwright/index.js"
     }
   },
   "keywords": [
@@ -33,8 +41,10 @@
   ],
   "dependencies": {},
   "peerDependencies": {
-    "@venturekit/data": "0.0.20",
-    "@aws-sdk/client-cognito-identity-provider": "^3.1091.0"
+    "@venturekit/data": "0.0.21",
+    "@aws-sdk/client-cognito-identity-provider": "^3.1091.0",
+    "@playwright/test": ">=1.40.0",
+    "pg": "^8.11.0"
   },
   "peerDependenciesMeta": {
     "@venturekit/data": {
@@ -42,12 +52,21 @@
     },
     "@aws-sdk/client-cognito-identity-provider": {
       "optional": true
+    },
+    "@playwright/test": {
+      "optional": true
+    },
+    "pg": {
+      "optional": true
     }
   },
   "devDependencies": {
-    "@venturekit/data": "0.0.20",
+    "@venturekit/data": "0.0.21",
     "@aws-sdk/client-cognito-identity-provider": "^3.1091.0",
-    "@types/node": "^26.1.0",
+    "@playwright/test": "^1.49.0",
+    "pg": "^8.13.0",
+    "@types/pg": "^8.11.10",
+    "@types/node": "^26.1.2",
     "typescript": "^5.3.0"
   },
   "scripts": {