@vijaypjavvadi/bdd2pw 1.0.0

package/dist/http/schemas.d.ts

@@ -0,0 +1,167 @@
+/**
+ * Zod request/response validators for the HTTP API.
+ * See docs/SCOPE.md §8b and docs/ARCHITECTURE.md §6.
+ */
+import { z } from "zod";
+export declare const ScaffoldRequestSchema: z.ZodObject<{
+    feature: z.ZodString;
+    url: z.ZodString;
+    page: z.ZodString;
+    repo: z.ZodString;
+    options: z.ZodOptional<z.ZodObject<{
+        pages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        storageState: z.ZodOptional<z.ZodString>;
+        headed: z.ZodOptional<z.ZodBoolean>;
+        llm: z.ZodOptional<z.ZodEnum<["anthropic", "openai", "gemini"]>>;
+        governanceUrl: z.ZodOptional<z.ZodString>;
+        templates: z.ZodOptional<z.ZodString>;
+        telemetry: z.ZodOptional<z.ZodBoolean>;
+        noValidate: z.ZodOptional<z.ZodBoolean>;
+        force: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        pages?: string[] | undefined;
+        storageState?: string | undefined;
+        headed?: boolean | undefined;
+        llm?: "anthropic" | "openai" | "gemini" | undefined;
+        governanceUrl?: string | undefined;
+        templates?: string | undefined;
+        telemetry?: boolean | undefined;
+        noValidate?: boolean | undefined;
+        force?: boolean | undefined;
+    }, {
+        pages?: string[] | undefined;
+        storageState?: string | undefined;
+        headed?: boolean | undefined;
+        llm?: "anthropic" | "openai" | "gemini" | undefined;
+        governanceUrl?: string | undefined;
+        templates?: string | undefined;
+        telemetry?: boolean | undefined;
+        noValidate?: boolean | undefined;
+        force?: boolean | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+    page: string;
+    feature: string;
+    repo: string;
+    options?: {
+        pages?: string[] | undefined;
+        storageState?: string | undefined;
+        headed?: boolean | undefined;
+        llm?: "anthropic" | "openai" | "gemini" | undefined;
+        governanceUrl?: string | undefined;
+        templates?: string | undefined;
+        telemetry?: boolean | undefined;
+        noValidate?: boolean | undefined;
+        force?: boolean | undefined;
+    } | undefined;
+}, {
+    url: string;
+    page: string;
+    feature: string;
+    repo: string;
+    options?: {
+        pages?: string[] | undefined;
+        storageState?: string | undefined;
+        headed?: boolean | undefined;
+        llm?: "anthropic" | "openai" | "gemini" | undefined;
+        governanceUrl?: string | undefined;
+        templates?: string | undefined;
+        telemetry?: boolean | undefined;
+        noValidate?: boolean | undefined;
+        force?: boolean | undefined;
+    } | undefined;
+}>;
+export type ScaffoldRequest = z.infer<typeof ScaffoldRequestSchema>;
+export declare const AnalyzeRequestSchema: z.ZodObject<{
+    feature: z.ZodString;
+    url: z.ZodString;
+    options: z.ZodOptional<z.ZodObject<{
+        storageState: z.ZodOptional<z.ZodString>;
+        headed: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        storageState?: string | undefined;
+        headed?: boolean | undefined;
+    }, {
+        storageState?: string | undefined;
+        headed?: boolean | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+    feature: string;
+    options?: {
+        storageState?: string | undefined;
+        headed?: boolean | undefined;
+    } | undefined;
+}, {
+    url: string;
+    feature: string;
+    options?: {
+        storageState?: string | undefined;
+        headed?: boolean | undefined;
+    } | undefined;
+}>;
+export type AnalyzeRequest = z.infer<typeof AnalyzeRequestSchema>;
+export declare const UpdatePomRequestSchema: z.ZodObject<{
+    page: z.ZodString;
+    url: z.ZodString;
+    repo: z.ZodString;
+    options: z.ZodOptional<z.ZodObject<{
+        storageState: z.ZodOptional<z.ZodString>;
+        headed: z.ZodOptional<z.ZodBoolean>;
+        templates: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        storageState?: string | undefined;
+        headed?: boolean | undefined;
+        templates?: string | undefined;
+    }, {
+        storageState?: string | undefined;
+        headed?: boolean | undefined;
+        templates?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+    page: string;
+    repo: string;
+    options?: {
+        storageState?: string | undefined;
+        headed?: boolean | undefined;
+        templates?: string | undefined;
+    } | undefined;
+}, {
+    url: string;
+    page: string;
+    repo: string;
+    options?: {
+        storageState?: string | undefined;
+        headed?: boolean | undefined;
+        templates?: string | undefined;
+    } | undefined;
+}>;
+export type UpdatePomRequest = z.infer<typeof UpdatePomRequestSchema>;
+export declare const JobAcceptedSchema: z.ZodObject<{
+    jobId: z.ZodString;
+    links: z.ZodObject<{
+        self: z.ZodString;
+        artifact: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        self: string;
+        artifact: string;
+    }, {
+        self: string;
+        artifact: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    jobId: string;
+    links: {
+        self: string;
+        artifact: string;
+    };
+}, {
+    jobId: string;
+    links: {
+        self: string;
+        artifact: string;
+    };
+}>;
+export type JobAccepted = z.infer<typeof JobAcceptedSchema>;

package/dist/http/schemas.js

@@ -0,0 +1,57 @@
+"use strict";
+/**
+ * Zod request/response validators for the HTTP API.
+ * See docs/SCOPE.md §8b and docs/ARCHITECTURE.md §6.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobAcceptedSchema = exports.UpdatePomRequestSchema = exports.AnalyzeRequestSchema = exports.ScaffoldRequestSchema = void 0;
+const zod_1 = require("zod");
+exports.ScaffoldRequestSchema = zod_1.z.object({
+    feature: zod_1.z.string().min(1),
+    url: zod_1.z.string().url(),
+    page: zod_1.z.string().min(1),
+    repo: zod_1.z.string().min(1),
+    options: zod_1.z
+        .object({
+        pages: zod_1.z.array(zod_1.z.string()).optional(),
+        storageState: zod_1.z.string().optional(),
+        headed: zod_1.z.boolean().optional(),
+        llm: zod_1.z.enum(["anthropic", "openai", "gemini"]).optional(),
+        governanceUrl: zod_1.z.string().url().optional(),
+        templates: zod_1.z.string().optional(),
+        telemetry: zod_1.z.boolean().optional(),
+        noValidate: zod_1.z.boolean().optional(),
+        force: zod_1.z.boolean().optional(),
+    })
+        .optional(),
+});
+exports.AnalyzeRequestSchema = zod_1.z.object({
+    feature: zod_1.z.string().min(1),
+    url: zod_1.z.string().url(),
+    options: zod_1.z
+        .object({
+        storageState: zod_1.z.string().optional(),
+        headed: zod_1.z.boolean().optional(),
+    })
+        .optional(),
+});
+exports.UpdatePomRequestSchema = zod_1.z.object({
+    page: zod_1.z.string().min(1),
+    url: zod_1.z.string().url(),
+    repo: zod_1.z.string().min(1),
+    options: zod_1.z
+        .object({
+        storageState: zod_1.z.string().optional(),
+        headed: zod_1.z.boolean().optional(),
+        templates: zod_1.z.string().optional(),
+    })
+        .optional(),
+});
+exports.JobAcceptedSchema = zod_1.z.object({
+    jobId: zod_1.z.string(),
+    links: zod_1.z.object({
+        self: zod_1.z.string(),
+        artifact: zod_1.z.string(),
+    }),
+});
+//# sourceMappingURL=schemas.js.map

package/dist/http/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../src/http/schemas.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6BAAwB;AAEX,QAAA,qBAAqB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5C,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACrB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,OAAO,EAAE,OAAC;SACP,MAAM,CAAC;QACN,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;QACrC,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACnC,MAAM,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAC9B,GAAG,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE;QACzD,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QAC1C,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QACjC,UAAU,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAClC,KAAK,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;KAC9B,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CAAC;AAIU,QAAA,oBAAoB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3C,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACrB,OAAO,EAAE,OAAC;SACP,MAAM,CAAC;QACN,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACnC,MAAM,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;KAC/B,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CAAC;AAIU,QAAA,sBAAsB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC7C,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACrB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,OAAO,EAAE,OAAC;SACP,MAAM,CAAC;QACN,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACnC,MAAM,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAC9B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KACjC,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CAAC;AAIU,QAAA,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IACxC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC;QACd,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;QAChB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;KACrB,CAAC;CACH,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Public programmatic API for `@vijaypjavvadi/bdd2pw`.
+ *
+ * The CLI (`src/cli.ts`) and HTTP service (`src/server.ts`) are thin shells
+ * over these three functions. See docs/ARCHITECTURE.md §1.
+ */
+import type { AnalyzeOptions, AnalyzeResult, ScaffoldOptions, ScaffoldResult, UpdatePomOptions, UpdatePomResult } from "./types";
+export type { AnalyzeOptions, AnalyzeResult, ScaffoldOptions, ScaffoldResult, UpdatePomOptions, UpdatePomResult, FeatureIR, ScenarioIR, StepIR, ElementIR, LocatorChoice, PageObjectIR, PomMethodIR, StepBinding, ReviewItem, } from "./types";
+/**
+ * Scaffold a Playwright TS test repo from a Gherkin .feature file.
+ *
+ * Pipeline (see docs/ARCHITECTURE.md §2):
+ *   gherkin parse → repo scan → POM resolve → MCP discover →
+ *   locator pick → step match → emit → tsc validate → review report.
+ *
+ * Phase 1a: MCP page discovery uses the file-snapshot fallback. Pass
+ * `opts.snapshotFile` to bypass the (not-yet-implemented) real browser
+ * scan. Real `@playwright/mcp` integration lands in Phase 1b.
+ */
+export declare function scaffold(opts: ScaffoldOptions): Promise<ScaffoldResult>;
+/**
+ * Dry-run analyser. Parses the .feature, scans the URL (or snapshot file),
+ * picks locators, matches steps — but writes nothing.
+ */
+export declare function analyze(opts: AnalyzeOptions): Promise<AnalyzeResult>;
+/**
+ * Re-scan a URL and merge any newly-discovered locators into an existing
+ * Page Object. **Append-only by construction:**
+ *
+ *   - Never deletes any property, method, or import.
+ *   - Never renames anything.
+ *   - Never modifies any existing method body — hand-edits are preserved
+ *     byte-identical.
+ *   - Skips field-name collisions (existing field wins).
+ *   - Adds new locator fields + their constructor assignments only.
+ *   - Method synthesis is opt-in and deferred to v1.1.
+ *
+ * Implementation: AST surgery via `ts-morph`. We read the existing file,
+ * compute a diff against the freshly-scanned IR, and use `ts-morph`'s
+ * `addProperty` / `addStatements` APIs to splice new content into the
+ * existing class. Then `save()` writes back. No re-emit, no overwrite.
+ *
+ * Hard fails:
+ *   - The POM file at `pages/<name>.page.ts` does not exist.
+ *   - The class declared in the file doesn't match `--page <Name>`.
+ *
+ * See docs/ARCHITECTURE.md §4.
+ */
+export declare function updatePom(opts: UpdatePomOptions): Promise<UpdatePomResult>;