aria-ease 6.10.0 → 6.12.0

package/dist/src/utils/test/dsl/index.cjs

@@ -1,90 +1,141 @@
 'use strict';
 
 // src/utils/test/dsl/src/state-packs/comboboxStatePack.ts
+function hasCapabilities(ctx, requiredCaps) {
+  return requiredCaps.some((cap) => ctx.capabilities.includes(cap));
+}
+function resolveSetup(setup, ctx) {
+  if (Array.isArray(setup) && setup.length && !setup[0].when) {
+    setup = [{ when: ["keyboard"], steps: () => setup }];
+  }
+  for (const strat of setup) {
+    if (hasCapabilities(ctx, strat.when)) {
+      return strat.steps(ctx);
+    }
+  }
+  throw new Error(
+    `No setup strategy matches capabilities: ${ctx.capabilities.join(", ")}`
+  );
+}
 var COMBOBOX_STATES = {
   "listbox.open": {
-    setup: openCombobox(),
-    assertion: isComboboxOpen()
+    setup: [
+      {
+        when: ["keyboard", "textInput"],
+        steps: () => [
+          { type: "keypress", target: "input", key: "ArrowDown" }
+        ]
+      },
+      {
+        when: ["pointer"],
+        steps: () => [
+          { type: "click", target: "button" }
+        ]
+      }
+    ],
+    assertion: isComboboxOpen
   },
   "listbox.closed": {
-    setup: closeCombobox(),
-    assertion: isComboboxClosed()
+    setup: [
+      {
+        when: ["keyboard"],
+        steps: () => [
+          /* { type: "keypress", target: "input", key: "Escape" } */
+        ]
+      },
+      {
+        when: ["pointer"],
+        steps: () => [
+          /* { type: "click", target: "button" } */
+        ]
+      }
+    ],
+    assertion: isComboboxClosed
   },
   "input.focused": {
-    setup: focusInput(),
-    assertion: [
-      ...isInputFocused()
-    ]
+    setup: [
+      {
+        when: ["keyboard"],
+        steps: () => [
+          { type: "focus", target: "input" }
+        ]
+      }
+    ],
+    assertion: isInputFocused
   },
   "input.filled": {
-    setup: fillInput(),
-    assertion: [
-      ...isInputFilled()
-    ]
+    setup: [
+      {
+        when: ["keyboard", "textInput"],
+        steps: () => [
+          { type: "type", target: "input", value: "test" }
+        ]
+      }
+    ],
+    assertion: isInputFilled
   },
   "activeOption.first": {
     requires: ["listbox.open"],
     setup: [
-      { type: "keypress", target: "input", key: "ArrowDown" }
+      {
+        when: ["keyboard"],
+        steps: () => [
+          { type: "keypress", target: "input", key: "ArrowDown" }
+        ]
+      }
     ],
-    assertion: [
-      ...isActiveDescendantNotEmpty()
-    ]
+    assertion: isActiveDescendantNotEmpty
   },
   "activeOption.last": {
     requires: ["activeOption.first"],
     setup: [
-      { type: "keypress", target: "input", key: "ArrowUp" }
+      {
+        when: ["keyboard"],
+        steps: () => [
+          { type: "keypress", target: "input", key: "ArrowUp" }
+        ]
+      }
     ],
-    assertion: [
-      ...isActiveDescendantNotEmpty()
-    ]
+    assertion: isActiveDescendantNotEmpty
   },
   "selectedOption.first": {
     requires: ["listbox.open"],
     setup: [
-      { type: "click", target: "relative", relativeTarget: "first" }
+      {
+        when: ["pointer"],
+        steps: () => [
+          { type: "click", target: "relative", relativeTarget: "first" }
+        ]
+      }
     ],
-    assertion: [
-      ...isAriaSelected("first")
-    ]
+    assertion: () => isAriaSelected("first")
   },
   "selectedOption.last": {
     requires: ["listbox.open"],
     setup: [
-      { type: "click", target: "relative", relativeTarget: "last" }
+      {
+        when: ["pointer"],
+        steps: () => [
+          { type: "click", target: "relative", relativeTarget: "last" }
+        ]
+      }
     ],
-    assertion: [
-      ...isAriaSelected("first")
-    ]
+    assertion: () => isAriaSelected("last")
   }
 };
-function openCombobox() {
-  return [
-    { type: "keypress", target: "input", key: "ArrowDown" }
-  ];
-}
-function closeCombobox() {
-  return [
-    { type: "keypress", target: "input", key: "Escape" }
-  ];
-}
-function focusInput() {
-  return [
-    { type: "focus", target: "input" }
-  ];
-}
-function fillInput() {
-  return [
-    { type: "type", target: "input", value: "test" }
-  ];
-}
 function isComboboxOpen() {
   return [
     {
       target: "listbox",
       assertion: "toBeVisible",
       failureMessage: "Expected listbox to be visible"
+    },
+    {
+      target: "input",
+      assertion: "toHaveAttribute",
+      attribute: "aria-expanded",
+      expectedValue: "true",
+      failureMessage: "Expect combobox input to have aria-expanded='true'"
     }
   ];
 }
@@ -94,6 +145,13 @@ function isComboboxClosed() {
       target: "listbox",
       assertion: "notToBeVisible",
       failureMessage: "Expected listbox to be closed"
+    },
+    {
+      target: "input",
+      assertion: "toHaveAttribute",
+      attribute: "aria-expanded",
+      expectedValue: "false",
+      failureMessage: "Expect combobox input to have aria-expanded='false'"
     }
   ];
 }
@@ -116,7 +174,7 @@ function isAriaSelected(index) {
       assertion: "toHaveAttribute",
       attribute: "aria-selected",
       expectedValue: "true",
-      failureMessage: `Expected aria-selected on ${index} option to be true`
+      failureMessage: `Expected ${index} option to have aria-selected='true'`
     }
   ];
 }
@@ -142,7 +200,7 @@ function isInputFilled() {
 
 // src/utils/test/dsl/src/contractBuilder.ts
 var STATE_PACKS = {
-  "combobox.listbox": COMBOBOX_STATES
+  "combobox": COMBOBOX_STATES
   // Add more mappings as needed
 };
 var FluentContract = class {
@@ -176,11 +234,13 @@ var ContractBuilder = class {
     const api = {
       ariaReference: (from, attribute, to) => ({
         required: () => this.relationshipInvariants.push({ type: "aria-reference", from, attribute, to, level: "required" }),
-        optional: () => this.relationshipInvariants.push({ type: "aria-reference", from, attribute, to, level: "optional" })
+        optional: () => this.relationshipInvariants.push({ type: "aria-reference", from, attribute, to, level: "optional" }),
+        recommended: () => this.relationshipInvariants.push({ type: "aria-reference", from, attribute, to, level: "recommended" })
       }),
       contains: (parent, child) => ({
         required: () => this.relationshipInvariants.push({ type: "contains", parent, child, level: "required" }),
-        optional: () => this.relationshipInvariants.push({ type: "contains", parent, child, level: "optional" })
+        optional: () => this.relationshipInvariants.push({ type: "contains", parent, child, level: "optional" }),
+        recommended: () => this.relationshipInvariants.push({ type: "contains", parent, child, level: "recommended" })
       })
     };
     fn(api);
@@ -191,7 +251,8 @@ var ContractBuilder = class {
       target: (target) => ({
         has: (attribute, expectedValue) => ({
           required: () => this.staticAssertions.push({ target, attribute, expectedValue, failureMessage: "", level: "required" }),
-          optional: () => this.staticAssertions.push({ target, attribute, expectedValue, failureMessage: "", level: "optional" })
+          optional: () => this.staticAssertions.push({ target, attribute, expectedValue, failureMessage: "", level: "optional" }),
+          recommended: () => this.staticAssertions.push({ target, attribute, expectedValue, failureMessage: "", level: "recommended" })
         })
       })
     };
@@ -262,7 +323,17 @@ var DynamicTestBuilder = class {
     return this.parent;
   }
   _finalize() {
-    const resolveSetup = (stateName, visited = /* @__PURE__ */ new Set()) => {
+    const capabilityMap = {
+      keypress: "keyboard",
+      click: "pointer",
+      type: "textInput",
+      focus: "keyboard",
+      hover: "pointer"
+      // add more mappings as needed
+    };
+    const capability = capabilityMap[this._as || "keyboard"] || (this._as || "keyboard");
+    const ctx = { capabilities: [capability] };
+    const resolveAllSetups = (stateName, visited = /* @__PURE__ */ new Set()) => {
       if (visited.has(stateName)) return [];
       visited.add(stateName);
       const s = this.statePack[stateName];
@@ -270,22 +341,30 @@ var DynamicTestBuilder = class {
       let actions = [];
       if (Array.isArray(s.requires)) {
         for (const req of s.requires) {
-          actions = actions.concat(resolveSetup(req, visited));
+          actions = actions.concat(resolveAllSetups(req, visited));
         }
       }
-      if (s.setup) actions = actions.concat(s.setup);
+      if (s.setup) actions = actions.concat(resolveSetup(s.setup, ctx));
       return actions;
     };
     const setup = [];
     for (const state of this._given) {
-      setup.push(...resolveSetup(state));
+      setup.push(...resolveAllSetups(state));
     }
     const assertions = [];
     for (const state of this._then) {
       const s = this.statePack[state];
-      if (s && s.assertion) {
-        if (Array.isArray(s.assertion)) assertions.push(...s.assertion);
-        else assertions.push(s.assertion);
+      if (s && s.assertion !== void 0) {
+        let value = s.assertion;
+        if (typeof value === "function") {
+          try {
+            value = value();
+          } catch (e) {
+            throw new Error(`Error calling assertion function for state '${state}': ${e.message}`);
+          }
+        }
+        if (Array.isArray(value)) assertions.push(...value);
+        else assertions.push(value);
       }
     }
     const action = [

package/dist/src/utils/test/dsl/index.d.cts

@@ -92,10 +92,12 @@ declare class ContractBuilder {
         ariaReference: (from: string, attribute: string, to: string) => {
             required: () => void;
             optional: () => void;
+            recommended: () => void;
         };
         contains: (parent: string, child: string) => {
             required: () => void;
             optional: () => void;
+            recommended: () => void;
         };
     }) => void): this;
     static(fn: (s: {
@@ -103,6 +105,7 @@ declare class ContractBuilder {
             has: (attribute: string, expectedValue: string) => {
                 required: () => void;
                 optional: () => void;
+                recommended: () => void;
             };
         };
     }) => void): this;

package/dist/src/utils/test/dsl/index.d.ts

@@ -92,10 +92,12 @@ declare class ContractBuilder {
         ariaReference: (from: string, attribute: string, to: string) => {
             required: () => void;
             optional: () => void;
+            recommended: () => void;
         };
         contains: (parent: string, child: string) => {
             required: () => void;
             optional: () => void;
+            recommended: () => void;
         };
     }) => void): this;
     static(fn: (s: {
@@ -103,6 +105,7 @@ declare class ContractBuilder {
             has: (attribute: string, expectedValue: string) => {
                 required: () => void;
                 optional: () => void;
+                recommended: () => void;
             };
         };
     }) => void): this;

package/dist/src/utils/test/dsl/index.js

@@ -1,88 +1,139 @@
 // src/utils/test/dsl/src/state-packs/comboboxStatePack.ts
+function hasCapabilities(ctx, requiredCaps) {
+  return requiredCaps.some((cap) => ctx.capabilities.includes(cap));
+}
+function resolveSetup(setup, ctx) {
+  if (Array.isArray(setup) && setup.length && !setup[0].when) {
+    setup = [{ when: ["keyboard"], steps: () => setup }];
+  }
+  for (const strat of setup) {
+    if (hasCapabilities(ctx, strat.when)) {
+      return strat.steps(ctx);
+    }
+  }
+  throw new Error(
+    `No setup strategy matches capabilities: ${ctx.capabilities.join(", ")}`
+  );
+}
 var COMBOBOX_STATES = {
   "listbox.open": {
-    setup: openCombobox(),
-    assertion: isComboboxOpen()
+    setup: [
+      {
+        when: ["keyboard", "textInput"],
+        steps: () => [
+          { type: "keypress", target: "input", key: "ArrowDown" }
+        ]
+      },
+      {
+        when: ["pointer"],
+        steps: () => [
+          { type: "click", target: "button" }
+        ]
+      }
+    ],
+    assertion: isComboboxOpen
   },
   "listbox.closed": {
-    setup: closeCombobox(),
-    assertion: isComboboxClosed()
+    setup: [
+      {
+        when: ["keyboard"],
+        steps: () => [
+          /* { type: "keypress", target: "input", key: "Escape" } */
+        ]
+      },
+      {
+        when: ["pointer"],
+        steps: () => [
+          /* { type: "click", target: "button" } */
+        ]
+      }
+    ],
+    assertion: isComboboxClosed
   },
   "input.focused": {
-    setup: focusInput(),
-    assertion: [
-      ...isInputFocused()
-    ]
+    setup: [
+      {
+        when: ["keyboard"],
+        steps: () => [
+          { type: "focus", target: "input" }
+        ]
+      }
+    ],
+    assertion: isInputFocused
   },
   "input.filled": {
-    setup: fillInput(),
-    assertion: [
-      ...isInputFilled()
-    ]
+    setup: [
+      {
+        when: ["keyboard", "textInput"],
+        steps: () => [
+          { type: "type", target: "input", value: "test" }
+        ]
+      }
+    ],
+    assertion: isInputFilled
   },
   "activeOption.first": {
     requires: ["listbox.open"],
     setup: [
-      { type: "keypress", target: "input", key: "ArrowDown" }
+      {
+        when: ["keyboard"],
+        steps: () => [
+          { type: "keypress", target: "input", key: "ArrowDown" }
+        ]
+      }
     ],
-    assertion: [
-      ...isActiveDescendantNotEmpty()
-    ]
+    assertion: isActiveDescendantNotEmpty
   },
   "activeOption.last": {
     requires: ["activeOption.first"],
     setup: [
-      { type: "keypress", target: "input", key: "ArrowUp" }
+      {
+        when: ["keyboard"],
+        steps: () => [
+          { type: "keypress", target: "input", key: "ArrowUp" }
+        ]
+      }
     ],
-    assertion: [
-      ...isActiveDescendantNotEmpty()
-    ]
+    assertion: isActiveDescendantNotEmpty
   },
   "selectedOption.first": {
     requires: ["listbox.open"],
     setup: [
-      { type: "click", target: "relative", relativeTarget: "first" }
+      {
+        when: ["pointer"],
+        steps: () => [
+          { type: "click", target: "relative", relativeTarget: "first" }
+        ]
+      }
     ],
-    assertion: [
-      ...isAriaSelected("first")
-    ]
+    assertion: () => isAriaSelected("first")
   },
   "selectedOption.last": {
     requires: ["listbox.open"],
     setup: [
-      { type: "click", target: "relative", relativeTarget: "last" }
+      {
+        when: ["pointer"],
+        steps: () => [
+          { type: "click", target: "relative", relativeTarget: "last" }
+        ]
+      }
     ],
-    assertion: [
-      ...isAriaSelected("first")
-    ]
+    assertion: () => isAriaSelected("last")
   }
 };
-function openCombobox() {
-  return [
-    { type: "keypress", target: "input", key: "ArrowDown" }
-  ];
-}
-function closeCombobox() {
-  return [
-    { type: "keypress", target: "input", key: "Escape" }
-  ];
-}
-function focusInput() {
-  return [
-    { type: "focus", target: "input" }
-  ];
-}
-function fillInput() {
-  return [
-    { type: "type", target: "input", value: "test" }
-  ];
-}
 function isComboboxOpen() {
   return [
     {
       target: "listbox",
       assertion: "toBeVisible",
       failureMessage: "Expected listbox to be visible"
+    },
+    {
+      target: "input",
+      assertion: "toHaveAttribute",
+      attribute: "aria-expanded",
+      expectedValue: "true",
+      failureMessage: "Expect combobox input to have aria-expanded='true'"
     }
   ];
 }
@@ -92,6 +143,13 @@ function isComboboxClosed() {
       target: "listbox",
       assertion: "notToBeVisible",
       failureMessage: "Expected listbox to be closed"
+    },
+    {
+      target: "input",
+      assertion: "toHaveAttribute",
+      attribute: "aria-expanded",
+      expectedValue: "false",
+      failureMessage: "Expect combobox input to have aria-expanded='false'"
     }
   ];
 }
@@ -114,7 +172,7 @@ function isAriaSelected(index) {
       assertion: "toHaveAttribute",
       attribute: "aria-selected",
       expectedValue: "true",
-      failureMessage: `Expected aria-selected on ${index} option to be true`
+      failureMessage: `Expected ${index} option to have aria-selected='true'`
     }
   ];
 }
@@ -140,7 +198,7 @@ function isInputFilled() {
 
 // src/utils/test/dsl/src/contractBuilder.ts
 var STATE_PACKS = {
-  "combobox.listbox": COMBOBOX_STATES
+  "combobox": COMBOBOX_STATES
   // Add more mappings as needed
 };
 var FluentContract = class {
@@ -174,11 +232,13 @@ var ContractBuilder = class {
     const api = {
       ariaReference: (from, attribute, to) => ({
         required: () => this.relationshipInvariants.push({ type: "aria-reference", from, attribute, to, level: "required" }),
-        optional: () => this.relationshipInvariants.push({ type: "aria-reference", from, attribute, to, level: "optional" })
+        optional: () => this.relationshipInvariants.push({ type: "aria-reference", from, attribute, to, level: "optional" }),
+        recommended: () => this.relationshipInvariants.push({ type: "aria-reference", from, attribute, to, level: "recommended" })
       }),
       contains: (parent, child) => ({
         required: () => this.relationshipInvariants.push({ type: "contains", parent, child, level: "required" }),
-        optional: () => this.relationshipInvariants.push({ type: "contains", parent, child, level: "optional" })
+        optional: () => this.relationshipInvariants.push({ type: "contains", parent, child, level: "optional" }),
+        recommended: () => this.relationshipInvariants.push({ type: "contains", parent, child, level: "recommended" })
       })
     };
     fn(api);
@@ -189,7 +249,8 @@ var ContractBuilder = class {
       target: (target) => ({
         has: (attribute, expectedValue) => ({
           required: () => this.staticAssertions.push({ target, attribute, expectedValue, failureMessage: "", level: "required" }),
-          optional: () => this.staticAssertions.push({ target, attribute, expectedValue, failureMessage: "", level: "optional" })
+          optional: () => this.staticAssertions.push({ target, attribute, expectedValue, failureMessage: "", level: "optional" }),
+          recommended: () => this.staticAssertions.push({ target, attribute, expectedValue, failureMessage: "", level: "recommended" })
         })
       })
     };
@@ -260,7 +321,17 @@ var DynamicTestBuilder = class {
     return this.parent;
   }
   _finalize() {
-    const resolveSetup = (stateName, visited = /* @__PURE__ */ new Set()) => {
+    const capabilityMap = {
+      keypress: "keyboard",
+      click: "pointer",
+      type: "textInput",
+      focus: "keyboard",
+      hover: "pointer"
+      // add more mappings as needed
+    };
+    const capability = capabilityMap[this._as || "keyboard"] || (this._as || "keyboard");
+    const ctx = { capabilities: [capability] };
+    const resolveAllSetups = (stateName, visited = /* @__PURE__ */ new Set()) => {
       if (visited.has(stateName)) return [];
       visited.add(stateName);
       const s = this.statePack[stateName];
@@ -268,22 +339,30 @@ var DynamicTestBuilder = class {
       let actions = [];
       if (Array.isArray(s.requires)) {
         for (const req of s.requires) {
-          actions = actions.concat(resolveSetup(req, visited));
+          actions = actions.concat(resolveAllSetups(req, visited));
         }
       }
-      if (s.setup) actions = actions.concat(s.setup);
+      if (s.setup) actions = actions.concat(resolveSetup(s.setup, ctx));
       return actions;
     };
     const setup = [];
     for (const state of this._given) {
-      setup.push(...resolveSetup(state));
+      setup.push(...resolveAllSetups(state));
     }
     const assertions = [];
     for (const state of this._then) {
       const s = this.statePack[state];
-      if (s && s.assertion) {
-        if (Array.isArray(s.assertion)) assertions.push(...s.assertion);
-        else assertions.push(s.assertion);
+      if (s && s.assertion !== void 0) {
+        let value = s.assertion;
+        if (typeof value === "function") {
+          try {
+            value = value();
+          } catch (e) {
+            throw new Error(`Error calling assertion function for state '${state}': ${e.message}`);
+          }
+        }
+        if (Array.isArray(value)) assertions.push(...value);
+        else assertions.push(value);
       }
     }
     const action = [