@seedmancer/playwright 0.1.0

package/README.md

@@ -0,0 +1,74 @@
+# @seedmancer/playwright
+
+Playwright integration for [Seedmancer](https://seedmancer.dev). Automatically seeds your database with a named scenario before each test.
+
+## Installation
+
+```sh
+npm install --save-dev @seedmancer/playwright
+```
+
+The [Seedmancer CLI](https://seedmancer.dev/docs/install) must be installed and available in `PATH`.
+
+## Usage
+
+Replace the standard Playwright `test` import with the one from this package:
+
+```ts
+import { test, expect } from "@seedmancer/playwright";
+
+test.use({
+  seedmancerScenario: "api-test",
+});
+
+test("user can open dashboard", async ({ page }) => {
+  await page.goto("/dashboard");
+  await expect(page.getByRole("heading", { name: "Dashboard" })).toBeVisible();
+});
+```
+
+Before each test, `seedmancer seed <scenario> --yes` is executed automatically. If `seedmancerScenario` is not set, the fixture is a no-op and no seeding occurs.
+
+## Options
+
+Set options via `test.use()` at the file or describe level:
+
+| Option | Type | Description |
+|---|---|---|
+| `seedmancerScenario` | `string` | Scenario name to seed. No seeding happens when omitted. |
+| `seedmancerEnv` | `string` | Target environment (`--env` flag). Defaults to the project default. |
+| `seedmancerCwd` | `string` | Working directory for the CLI. Defaults to `process.cwd()`. |
+
+## Scoping
+
+Options follow Playwright's standard scoping rules. You can apply them globally in `playwright.config.ts`, per file with `test.use()`, or per describe block:
+
+```ts
+// playwright.config.ts
+import { defineConfig } from "@playwright/test";
+
+export default defineConfig({
+  use: {
+    seedmancerScenario: "baseline",
+  },
+});
+```
+
+```ts
+// override for one describe block
+test.describe("admin flows", () => {
+  test.use({ seedmancerScenario: "admin-data" });
+
+  test("admin can manage users", async ({ page }) => {
+    // ...
+  });
+});
+```
+
+## Error handling
+
+| Situation | Error message |
+|---|---|
+| CLI not found | `Seedmancer CLI not found. Make sure it is installed and available in PATH.` |
+| Non-zero exit | `Seedmancer exited with status <N>: <stderr/stdout>` |
+| Killed by signal | `Seedmancer was terminated by signal: <signal>` |

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import { expect } from '@playwright/test';
+export type SeedmancerOptions = {
+    seedmancerScenario: string | undefined;
+    seedmancerEnv: string | undefined;
+    seedmancerCwd: string | undefined;
+};
+type SeedmancerFixtures = {
+    _seedmancerSeed: void;
+};
+export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & SeedmancerOptions & SeedmancerFixtures, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+export { expect };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAGxD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,kBAAkB,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;CACnC,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,eAAe,EAAE,IAAI,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,IAAI,sRAoDf,CAAC;AAEH,OAAO,EAAE,MAAM,EAAE,CAAC"}

package/dist/index.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expect = exports.test = void 0;
+const test_1 = require("@playwright/test");
+Object.defineProperty(exports, "expect", { enumerable: true, get: function () { return test_1.expect; } });
+const node_child_process_1 = require("node:child_process");
+exports.test = test_1.test.extend({
+    seedmancerScenario: [undefined, { option: true }],
+    seedmancerEnv: [undefined, { option: true }],
+    seedmancerCwd: [undefined, { option: true }],
+    _seedmancerSeed: [
+        async ({ seedmancerScenario, seedmancerEnv, seedmancerCwd }, use) => {
+            if (seedmancerScenario !== undefined) {
+                const args = ['seed', seedmancerScenario, '--yes'];
+                if (seedmancerEnv !== undefined) {
+                    args.push('--env', seedmancerEnv);
+                }
+                const result = (0, node_child_process_1.spawnSync)('seedmancer', args, {
+                    cwd: seedmancerCwd ?? process.cwd(),
+                    stdio: 'pipe',
+                    encoding: 'utf-8',
+                });
+                if (result.error !== undefined) {
+                    const err = result.error;
+                    if (err.code === 'ENOENT') {
+                        throw new Error('Seedmancer CLI not found. Make sure it is installed and available in PATH.\n' +
+                            'See https://seedmancer.dev/docs/install for installation instructions.');
+                    }
+                    throw result.error;
+                }
+                if (result.signal !== null) {
+                    throw new Error(`Seedmancer was terminated by signal: ${result.signal}`);
+                }
+                if (result.status !== 0) {
+                    const output = [result.stderr?.trim(), result.stdout?.trim()]
+                        .filter(Boolean)
+                        .join('\n');
+                    throw new Error(`Seedmancer exited with status ${result.status}` +
+                        (output.length > 0 ? `:\n${output}` : ''));
+                }
+            }
+            await use();
+        },
+        { auto: true },
+    ],
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,2CAAwD;AAmE/C,uFAnEc,aAAM,OAmEd;AAlEf,2DAA+C;AAYlC,QAAA,IAAI,GAAG,WAAI,CAAC,MAAM,CAAyC;IACtE,kBAAkB,EAAE,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACjD,aAAa,EAAE,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAC5C,aAAa,EAAE,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAE5C,eAAe,EAAE;QACf,KAAK,EAAE,EAAE,kBAAkB,EAAE,aAAa,EAAE,aAAa,EAAE,EAAE,GAAG,EAAE,EAAE;YAClE,IAAI,kBAAkB,KAAK,SAAS,EAAE,CAAC;gBACrC,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;gBAEnD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;oBAChC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;gBACpC,CAAC;gBAED,MAAM,MAAM,GAAG,IAAA,8BAAS,EAAC,YAAY,EAAE,IAAI,EAAE;oBAC3C,GAAG,EAAE,aAAa,IAAI,OAAO,CAAC,GAAG,EAAE;oBACnC,KAAK,EAAE,MAAM;oBACb,QAAQ,EAAE,OAAO;iBAClB,CAAC,CAAC;gBAEH,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,KAA8B,CAAC;oBAClD,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;wBAC1B,MAAM,IAAI,KAAK,CACb,8EAA8E;4BAC5E,wEAAwE,CAC3E,CAAC;oBACJ,CAAC;oBACD,MAAM,MAAM,CAAC,KAAK,CAAC;gBACrB,CAAC;gBAED,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;oBAC3B,MAAM,IAAI,KAAK,CACb,wCAAwC,MAAM,CAAC,MAAM,EAAE,CACxD,CAAC;gBACJ,CAAC;gBAED,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACxB,MAAM,MAAM,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC;yBAC1D,MAAM,CAAC,OAAO,CAAC;yBACf,IAAI,CAAC,IAAI,CAAC,CAAC;oBACd,MAAM,IAAI,KAAK,CACb,iCAAiC,MAAM,CAAC,MAAM,EAAE;wBAC9C,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAC5C,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,MAAM,GAAG,EAAE,CAAC;QACd,CAAC;QACD,EAAE,IAAI,EAAE,IAAI,EAAE;KACf;CACF,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@seedmancer/playwright",
+  "version": "0.1.0",
+  "description": "Playwright integration for Seedmancer – automatically seed your database before each test",
+  "keywords": [
+    "playwright",
+    "seedmancer",
+    "testing",
+    "seed",
+    "database",
+    "fixtures"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/KazanKK/seedmancer.git",
+    "directory": "packages/playwright"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@playwright/test": ">=1.40.0"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.50.0",
+    "@types/node": "^26.0.1",
+    "typescript": "^5.7.0"
+  }
+}