@prodix/cypress 0.1.0

package/README.md

@@ -0,0 +1,50 @@
+# @prodix/cypress
+
+[Prodix](https://www.prodixsolutions.co) visual testing for Cypress — checks every snapshot across real device profiles and flags visual bugs automatically.
+
+## Setup
+
+```bash
+npm install --save-dev @prodix/cypress
+```
+
+Add your API key and project ID (from Settings → API Keys in the [Prodix dashboard](https://app.prodixsolutions.co)):
+
+```bash
+PRODIX_API_KEY=pdx_your_api_key_here
+PRODIX_PROJECT_ID=your_project_id
+```
+
+Register the plugin in `cypress.config.ts`:
+
+```ts
+import { defineConfig } from "cypress";
+import { prodixPlugin } from "@prodix/cypress";
+
+export default defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      prodixPlugin(on, config);
+    },
+  },
+});
+```
+
+Load the command in `cypress/support/e2e.ts`:
+
+```ts
+import "@prodix/cypress/support";
+```
+
+## Usage
+
+```ts
+describe("Homepage", () => {
+  it("looks correct", () => {
+    cy.visit("/");
+    cy.prodixSnapshot("Homepage");
+  });
+});
+```
+
+Each snapshot is checked across every device profile in your Prodix project — desktop, tablet, mobile, and foldables. Results upload during `cypress run` and appear in your project's Runs tab.

package/dist/plugin.d.ts

@@ -0,0 +1,12 @@
+import { type ProdixConfig } from "@prodix/sdk-core";
+/**
+ * Register in cypress.config.ts:
+ *
+ *   setupNodeEvents(on, config) {
+ *     prodixPlugin(on, config);
+ *   }
+ *
+ * Reads PRODIX_API_KEY and PRODIX_PROJECT_ID from the environment unless passed in.
+ */
+export declare function prodixPlugin(on: Cypress.PluginEvents, config: Cypress.PluginConfigOptions, options?: Partial<ProdixConfig>): void;
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAgB,KAAK,YAAY,EAAuB,MAAM,kBAAkB,CAAC;AAIxF;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC1B,EAAE,EAAE,OAAO,CAAC,YAAY,EACxB,MAAM,EAAE,OAAO,CAAC,mBAAmB,EACnC,OAAO,GAAE,OAAO,CAAC,YAAY,CAAM,GAClC,IAAI,CAuCN"}

package/dist/plugin.js

@@ -0,0 +1,50 @@
+/// <reference types="cypress" />
+import { ProdixClient } from "@prodix/sdk-core";
+const message = (err) => (err instanceof Error ? err.message : String(err));
+/**
+ * Register in cypress.config.ts:
+ *
+ *   setupNodeEvents(on, config) {
+ *     prodixPlugin(on, config);
+ *   }
+ *
+ * Reads PRODIX_API_KEY and PRODIX_PROJECT_ID from the environment unless passed in.
+ */
+export function prodixPlugin(on, config, options = {}) {
+    const apiKey = options.apiKey ?? process.env["PRODIX_API_KEY"];
+    const projectId = options.projectId ?? process.env["PRODIX_PROJECT_ID"];
+    const disable = (reason) => {
+        console.warn(`[prodix] ${reason}, so snapshots are disabled.`);
+        on("task", { prodixSnapshot: () => null });
+    };
+    if (!apiKey || !projectId)
+        return disable("PRODIX_API_KEY or PRODIX_PROJECT_ID is not set");
+    // after:run only fires in `cypress run`, so an interactive session would leave runs unsubmitted.
+    if (!config.isTextTerminal)
+        return disable("Uploads only happen during `cypress run`");
+    const client = new ProdixClient({ ...options, apiKey, projectId });
+    on("task", {
+        async prodixSnapshot(screen) {
+            try {
+                await client.snapshot(screen);
+            }
+            catch (err) {
+                // A Prodix outage should never fail the customer's test suite.
+                console.warn(`[prodix] snapshot "${screen.name}" failed: ${message(err)}`);
+            }
+            return null;
+        },
+    });
+    on("after:run", async () => {
+        try {
+            const run = await client.completeRun();
+            if (run) {
+                console.log(`[prodix] Run submitted: https://app.prodixsolutions.co/projects/${client.projectId}/runs/${run.runId}`);
+            }
+        }
+        catch (err) {
+            console.warn(`[prodix] could not submit run: ${message(err)}`);
+        }
+    });
+}
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,iCAAiC;AACjC,OAAO,EAAE,YAAY,EAA0C,MAAM,kBAAkB,CAAC;AAExF,MAAM,OAAO,GAAG,CAAC,GAAY,EAAE,EAAE,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;AAErF;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAC1B,EAAwB,EACxB,MAAmC,EACnC,UAAiC,EAAE;IAEnC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC/D,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAExE,MAAM,OAAO,GAAG,CAAC,MAAc,EAAE,EAAE;QACjC,OAAO,CAAC,IAAI,CAAC,YAAY,MAAM,8BAA8B,CAAC,CAAC;QAC/D,EAAE,CAAC,MAAM,EAAE,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEF,IAAI,CAAC,MAAM,IAAI,CAAC,SAAS;QAAE,OAAO,OAAO,CAAC,gDAAgD,CAAC,CAAC;IAC5F,iGAAiG;IACjG,IAAI,CAAC,MAAM,CAAC,cAAc;QAAE,OAAO,OAAO,CAAC,0CAA0C,CAAC,CAAC;IAEvF,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAEnE,EAAE,CAAC,MAAM,EAAE;QACT,KAAK,CAAC,cAAc,CAAC,MAAsB;YACzC,IAAI,CAAC;gBACH,MAAM,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAChC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,+DAA+D;gBAC/D,OAAO,CAAC,IAAI,CAAC,sBAAsB,MAAM,CAAC,IAAI,aAAa,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC7E,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC,CAAC;IAEH,EAAE,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;QACzB,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;YACvC,IAAI,GAAG,EAAE,CAAC;gBACR,OAAO,CAAC,GAAG,CACT,mEAAmE,MAAM,CAAC,SAAS,SAAS,GAAG,CAAC,KAAK,EAAE,CACxG,CAAC;YACJ,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,CAAC,IAAI,CAAC,kCAAkC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACjE,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/support.d.ts

@@ -0,0 +1,10 @@
+declare global {
+    namespace Cypress {
+        interface Chainable {
+            /** Captures the current page for Prodix AI visual testing across every device profile. */
+            prodixSnapshot(name: string): Chainable<void>;
+        }
+    }
+}
+export {};
+//# sourceMappingURL=support.d.ts.map

package/dist/support.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"support.d.ts","sourceRoot":"","sources":["../src/support.ts"],"names":[],"mappings":"AAiBA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,OAAO,CAAC;QAChB,UAAU,SAAS;YACjB,0FAA0F;YAC1F,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;SAC/C;KACF;CACF"}

package/dist/support.js

@@ -0,0 +1,11 @@
+/// <reference types="cypress" />
+import { serializeDom } from "@prodix/sdk-core/serialize";
+// Import once in cypress/support/e2e.ts:  import "@prodix/cypress/support";
+Cypress.Commands.add("prodixSnapshot", (name) => {
+    Cypress.log({ name: "prodixSnapshot", message: name });
+    cy.document({ log: false }).then((doc) => {
+        const win = doc.defaultView;
+        cy.task("prodixSnapshot", { name, html: serializeDom(doc), width: win?.innerWidth, height: win?.innerHeight }, { log: false });
+    });
+});
+//# sourceMappingURL=support.js.map

package/dist/support.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"support.js","sourceRoot":"","sources":["../src/support.ts"],"names":[],"mappings":"AAAA,iCAAiC;AACjC,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,4EAA4E;AAE5E,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC,IAAY,EAAE,EAAE;IACtD,OAAO,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IACvD,EAAE,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;QACvC,MAAM,GAAG,GAAG,GAAG,CAAC,WAAW,CAAC;QAC5B,EAAE,CAAC,IAAI,CACL,gBAAgB,EAChB,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,EACnF,EAAE,GAAG,EAAE,KAAK,EAAE,CACf,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@prodix/cypress",
+  "version": "0.1.0",
+  "description": "Prodix AI visual testing for Cypress",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/plugin.d.ts",
+      "import": "./dist/plugin.js"
+    },
+    "./support": {
+      "types": "./dist/support.d.ts",
+      "import": "./dist/support.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@prodix/sdk-core": "0.1.0"
+  },
+  "peerDependencies": {
+    "cypress": ">=13"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.3",
+    "cypress": "^14.3.0",
+    "typescript": "^5.8.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}