@siteimprove/alfa-cypress 0.72.2

package/CHANGELOG.md

@@ -0,0 +1,257 @@
+# @siteimprove/alfa-cypress
+
+## 0.72.2
+
+## 0.72.1
+
+## 0.72.0
+
+### Minor Changes
+
+- **Changed:** Dummy minor version to experiment with publish flow, use the previous or next minor version instead. ([`4daf29d`](https://github.com/Siteimprove/alfa-integrations/commit/4daf29d55745310b6ac845f963b306a4f0e57b08))
+
+## 0.71.2
+
+### Patch Changes
+
+- **Changed:** Update Alfa to ^0.92.0 ([#78](https://github.com/Siteimprove/alfa-integrations/pull/78))
+
+## 0.71.1
+
+## 0.71.0
+
+## 0.70.1
+
+### Patch Changes
+
+- **Changed:** Update Alfa ([#75](https://github.com/Siteimprove/alfa-integrations/pull/75))
+
+## 0.70.0
+
+### Minor Changes
+
+- **Changed:** Update Alfa ([#68](https://github.com/Siteimprove/alfa-integrations/pull/68))
+
+## 0.69.1
+
+## 0.69.0
+
+## 0.68.4
+
+## 0.68.3
+
+### Patch Changes
+
+- **Changed:** Update Alfa ([#54](https://github.com/Siteimprove/alfa-integrations/pull/54))
+
+## 0.68.2
+
+### Patch Changes
+
+- **Changed:** Update Alfa. ([#53](https://github.com/Siteimprove/alfa-integrations/pull/53))
+
+## 0.68.1
+
+### Patch Changes
+
+- **Changed:** Update Alfa ([#52](https://github.com/Siteimprove/alfa-integrations/pull/52))
+
+## 0.68.0
+
+### Minor Changes
+
+- - **Breaking:** TS resolution has been changed to `Node16`, target to `es2022`. ([#50](https://github.com/Siteimprove/alfa-integrations/pull/50))
+
+- - **Breaking:** Alfa is now distributed as ESM rather than CJS modules; projects using it must be ESM or use dynamic `import()`. ([#50](https://github.com/Siteimprove/alfa-integrations/pull/50))
+
+    ⚠️ This is the last of a series of changes on the internal structure and build process of distributed packages that was started with v0.67.0.
+
+## 0.67.0
+
+### Minor Changes
+
+- **Breaking:** The .js files are now built in the dist folder rather than in src. ([#49](https://github.com/Siteimprove/alfa-integrations/pull/49))
+
+  ⚠️ This is the first of a series of changes on the internal structure and build process of distributed packages. It is probably better to not use this version and wait until more of these internal changes have been done to jump directly to the final result. We are internally releasing these changes for validation purpose only.
+
+  This should not impact consumers, the package.json files should be set correctly to consume these files.
+
+## 0.66.3
+
+### Patch Changes
+
+- **Changed:** Update Alfa. ([#47](https://github.com/Siteimprove/alfa-integrations/pull/47))
+
+## 0.66.2
+
+### Patch Changes
+
+- **Changed:** Update Alfa ([#46](https://github.com/Siteimprove/alfa-integrations/pull/46))
+
+## 0.66.1
+
+### Patch Changes
+
+- **Changed:** Update Alfa to ^0.83.1 ([#45](https://github.com/Siteimprove/alfa-integrations/pull/45))
+
+## 0.66.0
+
+### Minor Changes
+
+- **Added:** Package dependency graphs are now included in the documentation. ([#43](https://github.com/Siteimprove/alfa-integrations/pull/43))
+
+### Patch Changes
+
+- **Changed:** Update Alfa. ([#44](https://github.com/Siteimprove/alfa-integrations/pull/44))
+
+## 0.65.2
+
+### Patch Changes
+
+- **Changed:** Update Alfa ([#42](https://github.com/Siteimprove/alfa-integrations/pull/42))
+
+## 0.65.1
+
+### Patch Changes
+
+- **Changed:** Update Alfa. ([#41](https://github.com/Siteimprove/alfa-integrations/pull/41))
+
+## 0.65.0
+
+### Minor Changes
+
+- **Breaking:** `toPage` is now `async`. ([#40](https://github.com/Siteimprove/alfa-integrations/pull/40))
+
+### Patch Changes
+
+- **Changed:** Update Alfa to ^0.79.1 ([#40](https://github.com/Siteimprove/alfa-integrations/pull/40))
+
+## 0.64.11
+
+### Patch Changes
+
+- **Changed:** Update Alfa to ^0.77.0 ([#38](https://github.com/Siteimprove/alfa-integrations/pull/38))
+
+- **Changed:** Updated Alfa. ([#39](https://github.com/Siteimprove/alfa-integrations/pull/39))
+
+## 0.64.10
+
+### Patch Changes
+
+- **Changed:** Update Alfa to ^0.76.0 ([#37](https://github.com/Siteimprove/alfa-integrations/pull/37))
+
+## 0.64.9
+
+### Patch Changes
+
+- **Changed:** Update Alfa to ^0.75.0 ([#36](https://github.com/Siteimprove/alfa-integrations/pull/36))
+
+## 0.64.8
+
+### Patch Changes
+
+- **Changed:** Update Alfa to ^0.74.0 ([#34](https://github.com/Siteimprove/alfa-integrations/pull/34))
+
+## 0.64.7
+
+### Patch Changes
+
+- **Changed:** Update Alfa ([#33](https://github.com/Siteimprove/alfa-integrations/pull/33))
+
+## 0.64.6
+
+### Patch Changes
+
+- **Changed:** Update to Alfa v0.73.0 ([#32](https://github.com/Siteimprove/alfa-integrations/pull/32))
+
+## 0.64.5
+
+### Patch Changes
+
+- **Changed:** Update Alfa to v0.72.0 ([#31](https://github.com/Siteimprove/alfa-integrations/pull/31))
+
+## 0.64.4
+
+### Patch Changes
+
+- **Changed:** Each package now has peer dependencies to the main Alfa packages it uses. ([#30](https://github.com/Siteimprove/alfa-integrations/pull/30))
+
+  This should ease problem with code downstream that tries to Ix, e.g., `Option` from different versions of the package and fail to build.
+
+- **Changed:** Update Alfa to version 0.71.0. ([#30](https://github.com/Siteimprove/alfa-integrations/pull/30))
+
+## 0.64.3
+
+### Patch Changes
+
+- **Changed:** Update Alfa. ([#29](https://github.com/Siteimprove/alfa-integrations/pull/29))
+
+## 0.64.2
+
+## 0.64.1
+
+### Patch Changes
+
+- **Changed:** Update Alfa. ([`c8699c0`](https://github.com/Siteimprove/alfa-integrations/commit/c8699c081dfa36b407dbecc51baf1e11739e2537))
+
+## 0.64.0
+
+### Patch Changes
+
+- **Changed:** Update to Alfa v0.68.0 ([#26](https://github.com/Siteimprove/alfa-integrations/pull/26))
+
+## 0.63.1
+
+### Patch Changes
+
+- **Fixed:** Set up correct permissions in the release workflow ([`c47b1c9`](https://github.com/Siteimprove/alfa-integrations/commit/c47b1c9b3eb79ded5c872f3e31d0b33c9140c039))
+
+## 0.63.0
+
+### Minor Changes
+
+- **Changed:** Update release flow to newer version ([#24](https://github.com/Siteimprove/alfa-integrations/pull/24))
+
+### Patch Changes
+
+- **Changed:** Update Alfa to version 0.67.0 ([#24](https://github.com/Siteimprove/alfa-integrations/pull/24))
+
+## 0.62.11
+
+### Patch Changes
+
+- **Changes:** Updated Alfa to v0.66.0 ([`f8c0275`](https://github.com/Siteimprove/alfa-integrations/commit/f8c0275d9eadc6e98ad9aa9f2a17bb95b12d4859))
+
+## 0.62.10
+
+### Patch Changes
+
+- **Added:** Updated Alfa to v0.65.0 ([#19](https://github.com/Siteimprove/alfa-integrations/pull/19))
+
+  Functions that are building `Element` directly now add an empty box to them.
+
+## 0.62.9
+
+### Patch Changes
+
+- **Changed:** Update Alfa to 0.64.0 ([#17](https://github.com/Siteimprove/alfa-integrations/pull/17))
+
+## 0.62.8
+
+### Patch Changes
+
+- Update Alfa to 0.63.1 ([#10](https://github.com/Siteimprove/alfa-integrations/pull/10))
+
+## 0.62.7
+
+### Patch Changes
+
+- **Updated:** Adapt to latest Alfa ([#9](https://github.com/Siteimprove/alfa-integrations/pull/9))
+
+  Replace the `Result#get`/`Result#getErr` with the new `Unsafe` versions.
+
+## 0.62.6
+
+## 0.62.5
+
+## 0.62.4

package/dist/cypress.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="cypress" preserve="true" />
+/// <reference lib="dom" preserve="true" />
+import type { Question } from "@siteimprove/alfa-act";
+import { Asserter, type Handler } from "@siteimprove/alfa-assert";
+import type { Formatter } from "@siteimprove/alfa-formatter";
+import type { Hashable } from "@siteimprove/alfa-hash";
+import type { Mapper } from "@siteimprove/alfa-mapper";
+import { Page } from "@siteimprove/alfa-web";
+import type * as act from "@siteimprove/alfa-act";
+declare global {
+    namespace Chai {
+        interface Assertion {
+            accessible(): Promise<void>;
+        }
+    }
+    namespace Cypress {
+        interface Chainer<Subject> {
+            (chainer: "be.accessible"): Chainable<Subject>;
+            (chainer: "not.be.accessible"): Chainable<Subject>;
+        }
+    }
+}
+/**
+ * @public
+ */
+export declare namespace Cypress {
+    function createPlugin<T extends Hashable, Q extends Question.Metadata = {}, S = T>(rules: Iterable<act.Rule<Page, T, Q, S>>, handlers?: Iterable<Handler<Page, T, Q, S>>, options?: Asserter.Options<Page, T, Q, S>): globalThis.Chai.ChaiPlugin;
+    type Type = globalThis.Node | globalThis.JQuery;
+    function toPage(value: Type): Promise<Page>;
+    namespace Handler {
+        /**
+         * @remarks
+         * Cypress has this rather odd model of relying on synchronously enqueued
+         * hooks and commands to provide a feeling of using a synchronous API. As
+         * the handler will run _as part of_ a command, this means that we can't
+         * register any additional commands when the handler runs; this must instead
+         * be handled beforehand. The handler therefore starts by registering an
+         * `after()` hook that will write any files collected during the test run
+         * _after_ the tests are done.
+         */
+        function persist<I, T extends Hashable, Q extends Question.Metadata, S>(output: Mapper<I, string>, format?: Formatter<I, T, Q, S>): Handler<I, T, Q, S>;
+    }
+}
+//# sourceMappingURL=cypress.d.ts.map

package/dist/cypress.js

@@ -0,0 +1,80 @@
+/// <reference lib="dom" preserve="true" />
+/// <reference types="cypress" preserve="true" />
+import { Asserter } from "@siteimprove/alfa-assert";
+import { Device } from "@siteimprove/alfa-device";
+import { Document, Node } from "@siteimprove/alfa-dom";
+import { Request, Response } from "@siteimprove/alfa-http";
+import { Page } from "@siteimprove/alfa-web";
+import * as device from "@siteimprove/alfa-device/native";
+import * as dom from "@siteimprove/alfa-dom/native";
+import earl from "@siteimprove/alfa-formatter-earl";
+/**
+ * @public
+ */
+export var Cypress;
+(function (Cypress) {
+    function createPlugin(rules, handlers = [], options = {}) {
+        const asserter = Asserter.of(rules, handlers, options);
+        return (chai) => {
+            chai.Assertion.addMethod("accessible", async function () {
+                const input = await toPage(this._obj);
+                const result = asserter
+                    .expect(input)
+                    .to.be.accessible()
+                    // Cypress has aversions towards promises and asynchronous functions.
+                    // We therefore have to synchronously unwrap the future, which it is
+                    // fortunately designed for. This _will_ panic if the value isn't
+                    // available, but this shouldn't happen in practice as the assertion
+                    // handlers can't be asynchronous either.
+                    // https://github.com/cypress-io/cypress/issues/4742
+                    .get();
+                const message = result.isOk() ? result.get() : result.getErrUnsafe();
+                this.assert(result.isOk(), `expected #{this} to be accessible${result.isErr() ? ` but ${message}` : ""}`, `expected #{this} to not be accessible${result.isOk() ? ` but ${message}` : ""}`, 
+                /* Expected */ true, 
+                /* Actual */ result.isOk(), 
+                /* Show diff */ false);
+            });
+        };
+    }
+    Cypress.createPlugin = createPlugin;
+    async function toPage(value) {
+        if ("jquery" in value) {
+            value = value.get(0);
+        }
+        const nodeJSON = await dom.Native.fromNode(value);
+        const deviceJSON = device.Native.fromWindow(window);
+        const pageDevice = Device.from(deviceJSON);
+        return Page.of(Request.empty(), Response.empty(), nodeJSON.type === "document"
+            ? Document.from(nodeJSON, pageDevice)
+            : Document.of([Node.from(nodeJSON, pageDevice)]), pageDevice);
+    }
+    Cypress.toPage = toPage;
+    let Handler;
+    (function (Handler) {
+        /**
+         * @remarks
+         * Cypress has this rather odd model of relying on synchronously enqueued
+         * hooks and commands to provide a feeling of using a synchronous API. As
+         * the handler will run _as part of_ a command, this means that we can't
+         * register any additional commands when the handler runs; this must instead
+         * be handled beforehand. The handler therefore starts by registering an
+         * `after()` hook that will write any files collected during the test run
+         * _after_ the tests are done.
+         */
+        function persist(output, format = earl()) {
+            const files = new Map();
+            after(() => {
+                for (const [file, data] of files) {
+                    cy.writeFile(file, data);
+                }
+            });
+            return (input, rules, outcomes, message) => {
+                const file = output(input);
+                files.set(file, format(input, rules, outcomes) + "\n");
+                return `${message}, see the full report at ${file}`;
+            };
+        }
+        Handler.persist = persist;
+    })(Handler = Cypress.Handler || (Cypress.Handler = {}));
+})(Cypress || (Cypress = {}));
+//# sourceMappingURL=cypress.js.map

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./cypress.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./cypress.js";
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "http://json.schemastore.org/package",
+  "name": "@siteimprove/alfa-cypress",
+  "homepage": "https://alfa.siteimprove.com",
+  "version": "0.72.2",
+  "license": "MIT",
+  "description": "Integrations and utilities for the Cypress testing framework",
+  "repository": {
+    "type": "git",
+    "url": "github:Siteimprove/alfa-integrations",
+    "directory": "packages/alfa-cypress"
+  },
+  "bugs": "https://github.com/siteimprove/alfa/issues",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "dependencies": {
+    "@siteimprove/alfa-act": "^0.92.0",
+    "@siteimprove/alfa-assert": "^0.72.2",
+    "@siteimprove/alfa-device": "^0.92.0",
+    "@siteimprove/alfa-dom": "^0.92.0",
+    "@siteimprove/alfa-formatter": "^0.72.2",
+    "@siteimprove/alfa-formatter-earl": "^0.72.2",
+    "@siteimprove/alfa-hash": "^0.92.0",
+    "@siteimprove/alfa-http": "^0.92.0",
+    "@siteimprove/alfa-mapper": "^0.92.0",
+    "@siteimprove/alfa-web": "^0.92.0",
+    "cypress": "^13.3.1"
+  },
+  "peerDependencies": {
+    "@siteimprove/alfa-act": "^0.92.0",
+    "@siteimprove/alfa-device": "^0.92.0",
+    "@siteimprove/alfa-dom": "^0.92.0",
+    "@siteimprove/alfa-hash": "^0.92.0",
+    "@siteimprove/alfa-http": "^0.92.0",
+    "@siteimprove/alfa-mapper": "^0.92.0",
+    "@siteimprove/alfa-web": "^0.92.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://npm.pkg.github.com/"
+  }
+}