@harnessed-ts/chai 0.0.0-stage → 0.6.0

package/CHANGELOG.md

@@ -0,0 +1,32 @@
+# @harnessed-ts/chai
+
+## 0.6.0
+
+### Patch Changes
+
+- Updated dependencies [e324e94]
+  - @harnessed-ts/core@0.6.0
+
+## 0.5.0
+
+### Patch Changes
+
+- @harnessed-ts/core@0.5.0
+
+## 0.4.0
+
+### Minor Changes
+
+- 9666a3d: Two new assertion packages, both backed by core's one matcher implementation so the messages read the same under every runner:
+
+  - `@harnessed-ts/qunit`: `install(QUnit)` adds `assert.harness(x)` with `isAbsent`/`isPresent`, `isSelected`/`isNotSelected`, and `readsAs`/`doesNotReadAs`, reported through `pushResult`. For ember-qunit and any QUnit suite.
+  - `@harnessed-ts/chai`: `chai.use(harnessedChai)` adds `absent`, `selected`, and `readAs`, awaitable and negatable. For Mocha, ember-mocha, Cypress, and WebdriverIO under Mocha.
+
+  `harnessMatchers` results now carry `observed: { actual, expected }`, which the QUnit and Chai adapters report so their runners can show what was read.
+
+### Patch Changes
+
+- Updated dependencies [9666a3d]
+- Updated dependencies [9666a3d]
+- Updated dependencies [1823546]
+  - @harnessed-ts/core@0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Joe Gaudet, Jay Seo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,28 @@
-# Temporary Holding Version
+# @harnessed-ts/chai
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Chai assertions for [harnessed](https://github.com/joegaudet/harnessed#readme)
+harnesses: Mocha, Cypress, WebdriverIO under Mocha — anything that
+asserts through Chai.
+
+```ts
+import * as chai from 'chai'
+import { harnessedChai } from '@harnessed-ts/chai'
+chai.use(harnessedChai)
+```
+
+```ts
+await expect(banner).to.be.absent
+await expect(card).not.to.be.selected
+await expect(price).to.readAs(/^\$/)
+```
+
+`absent`, `selected` and `readAs` take a target or a harness and return a
+promise: reading the page goes through a driver, so **await every one** — an
+un-awaited assertion cannot fail the test. `@typescript-eslint/no-floating-promises`
+catches a missing `await`. `.not` negates as usual. The failure
+messages are the same ones the Vitest, Playwright and QUnit assertions use.
+
+Tested against Chai 6; it uses only the plugin API Chai has kept since 4.
+A failure carries `actual` and `expected`, so Mocha and Cypress show a diff.
+
+MIT © Joe Gaudet, Jay Seo

package/dist/index.cjs

@@ -0,0 +1,31 @@
+'use strict';
+
+var core = require('@harnessed-ts/core');
+
+// src/index.ts
+function harnessedChai(chai, utils) {
+  const settle = async (assertion, run) => {
+    const negated = utils.flag(assertion, "negate") === true;
+    const result = await run(assertion._obj);
+    if (result.pass === negated) {
+      throw new chai.AssertionError(result.message(), {
+        actual: result.observed.actual,
+        expected: result.observed.expected,
+        showDiff: !negated
+      });
+    }
+  };
+  chai.Assertion.addProperty("absent", function() {
+    return settle(this, (subject) => core.harnessMatchers.toBeAbsent(subject));
+  });
+  chai.Assertion.addProperty("selected", function() {
+    return settle(this, (subject) => core.harnessMatchers.toBeSelected(subject));
+  });
+  chai.Assertion.addMethod("readAs", function(expected) {
+    return settle(this, (subject) => core.harnessMatchers.toReadAs(subject, expected));
+  });
+}
+
+exports.harnessedChai = harnessedChai;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":["harnessMatchers"],"mappings":";;;;;AA4CO,SAAS,aAAA,CAAc,MAAkB,KAAA,EAAwB;AACtE,EAAA,MAAM,MAAA,GAAS,OACb,SAAA,EACA,GAAA,KACkB;AAClB,IAAA,MAAM,OAAA,GAAU,KAAA,CAAM,IAAA,CAAK,SAAA,EAAW,QAAQ,CAAA,KAAM,IAAA;AACpD,IAAA,MAAM,MAAA,GAAS,MAAM,GAAA,CAAI,SAAA,CAAU,IAAkB,CAAA;AAGrD,IAAA,IAAI,MAAA,CAAO,SAAS,OAAA,EAAS;AAG3B,MAAA,MAAM,IAAI,IAAA,CAAK,cAAA,CAAe,MAAA,CAAO,SAAQ,EAAG;AAAA,QAC9C,MAAA,EAAQ,OAAO,QAAA,CAAS,MAAA;AAAA,QACxB,QAAA,EAAU,OAAO,QAAA,CAAS,QAAA;AAAA,QAC1B,UAAU,CAAC;AAAA,OACZ,CAAA;AAAA,IACH;AAAA,EACF,CAAA;AAEA,EAAA,IAAA,CAAK,SAAA,CAAU,WAAA,CAAY,QAAA,EAAU,WAAY;AAC/C,IAAA,OAAO,OAAO,IAAA,EAAM,CAAA,OAAA,KAAWA,oBAAA,CAAgB,UAAA,CAAW,OAAO,CAAC,CAAA;AAAA,EACpE,CAAC,CAAA;AAED,EAAA,IAAA,CAAK,SAAA,CAAU,WAAA,CAAY,UAAA,EAAY,WAAY;AACjD,IAAA,OAAO,OAAO,IAAA,EAAM,CAAA,OAAA,KAAWA,oBAAA,CAAgB,YAAA,CAAa,OAAO,CAAC,CAAA;AAAA,EACtE,CAAC,CAAA;AAED,EAAA,IAAA,CAAK,SAAA,CAAU,SAAA,CAAU,QAAA,EAAU,SAAU,QAAA,EAA2B;AACtE,IAAA,OAAO,OAAO,IAAA,EAAM,CAAA,OAAA,KAAWA,qBAAgB,QAAA,CAAS,OAAA,EAAS,QAAQ,CAAC,CAAA;AAAA,EAC5E,CAAC,CAAA;AACH","file":"index.cjs","sourcesContent":["import { harnessMatchers } from '@harnessed-ts/core'\nimport type { Assertable, MatcherResult } from '@harnessed-ts/core'\n\n/**\n * The structural slice of Chai a plugin is handed, so this package needs\n * neither Chai's runtime nor its types at build time — and works with Chai 4,\n * 5 and 6 alike.\n */\ninterface ChaiAssertionContext {\n  _obj: unknown\n}\n\ninterface ChaiUtils {\n  flag(assertion: ChaiAssertionContext, name: string): unknown\n}\n\ninterface ChaiStatic {\n  Assertion: {\n    addProperty(name: string, getter: (this: ChaiAssertionContext) => unknown): void\n    addMethod(\n      name: string,\n      method: (this: ChaiAssertionContext, expected: string | RegExp) => unknown,\n    ): void\n  }\n  AssertionError: new (message: string, props?: Record<string, unknown>) => Error\n}\n\n/**\n * Registers `absent`, `selected` and `readAs`:\n *\n * ```ts\n * import * as chai from 'chai'\n * import { harnessedChai } from '@harnessed-ts/chai'\n * chai.use(harnessedChai)\n *\n * await expect(banner).to.be.absent\n * await expect(card).not.to.be.selected\n * await expect(price).to.readAs(/^\\$/)\n * ```\n *\n * Each takes a target or a harness and returns a promise: reading the page goes\n * through a driver, so every one of them must be awaited. The failure messages\n * are core's, shared with the Vitest and Playwright matchers.\n */\nexport function harnessedChai(chai: ChaiStatic, utils: ChaiUtils): void {\n  const settle = async (\n    assertion: ChaiAssertionContext,\n    run: (subject: Assertable) => Promise<MatcherResult>,\n  ): Promise<void> => {\n    const negated = utils.flag(assertion, 'negate') === true\n    const result = await run(assertion._obj as Assertable)\n    // A matcher's message already describes whichever way it went, so a\n    // negated assertion that fails reads \"expected … not to …\" on its own.\n    if (result.pass === negated) {\n      // actual/expected let Mocha and Cypress show a diff. A failed negation has\n      // nothing to diff — the values agreed, which was the problem.\n      throw new chai.AssertionError(result.message(), {\n        actual: result.observed.actual,\n        expected: result.observed.expected,\n        showDiff: !negated,\n      })\n    }\n  }\n\n  chai.Assertion.addProperty('absent', function () {\n    return settle(this, subject => harnessMatchers.toBeAbsent(subject))\n  })\n\n  chai.Assertion.addProperty('selected', function () {\n    return settle(this, subject => harnessMatchers.toBeSelected(subject))\n  })\n\n  chai.Assertion.addMethod('readAs', function (expected: string | RegExp) {\n    return settle(this, subject => harnessMatchers.toReadAs(subject, expected))\n  })\n}\n\ndeclare global {\n  // Chai's augmentation point is this global namespace.\n  namespace Chai {\n    interface Assertion {\n      /** Nothing matches. Await it. */\n      readonly absent: Promise<void>\n      /** `aria-pressed=\"true\"`. Await it. */\n      readonly selected: Promise<void>\n      /** The text equals a string or matches a pattern. Await it. */\n      readAs(expected: string | RegExp): Promise<void>\n    }\n  }\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,50 @@
+/**
+ * The structural slice of Chai a plugin is handed, so this package needs
+ * neither Chai's runtime nor its types at build time — and works with Chai 4,
+ * 5 and 6 alike.
+ */
+interface ChaiAssertionContext {
+    _obj: unknown;
+}
+interface ChaiUtils {
+    flag(assertion: ChaiAssertionContext, name: string): unknown;
+}
+interface ChaiStatic {
+    Assertion: {
+        addProperty(name: string, getter: (this: ChaiAssertionContext) => unknown): void;
+        addMethod(name: string, method: (this: ChaiAssertionContext, expected: string | RegExp) => unknown): void;
+    };
+    AssertionError: new (message: string, props?: Record<string, unknown>) => Error;
+}
+/**
+ * Registers `absent`, `selected` and `readAs`:
+ *
+ * ```ts
+ * import * as chai from 'chai'
+ * import { harnessedChai } from '@harnessed-ts/chai'
+ * chai.use(harnessedChai)
+ *
+ * await expect(banner).to.be.absent
+ * await expect(card).not.to.be.selected
+ * await expect(price).to.readAs(/^\$/)
+ * ```
+ *
+ * Each takes a target or a harness and returns a promise: reading the page goes
+ * through a driver, so every one of them must be awaited. The failure messages
+ * are core's, shared with the Vitest and Playwright matchers.
+ */
+export declare function harnessedChai(chai: ChaiStatic, utils: ChaiUtils): void;
+declare global {
+    namespace Chai {
+        interface Assertion {
+            /** Nothing matches. Await it. */
+            readonly absent: Promise<void>;
+            /** `aria-pressed="true"`. Await it. */
+            readonly selected: Promise<void>;
+            /** The text equals a string or matches a pattern. Await it. */
+            readAs(expected: string | RegExp): Promise<void>;
+        }
+    }
+}
+export {};
+//# 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":"AAGA;;;;GAIG;AACH,UAAU,oBAAoB;IAC5B,IAAI,EAAE,OAAO,CAAA;CACd;AAED,UAAU,SAAS;IACjB,IAAI,CAAC,SAAS,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;CAC7D;AAED,UAAU,UAAU;IAClB,SAAS,EAAE;QACT,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,OAAO,GAAG,IAAI,CAAA;QAChF,SAAS,CACP,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,CAAC,IAAI,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,KAAK,OAAO,GACzE,IAAI,CAAA;KACR,CAAA;IACD,cAAc,EAAE,KAAK,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,KAAK,CAAA;CAChF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,GAAG,IAAI,CA+BtE;AAED,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,IAAI,CAAC;QACb,UAAU,SAAS;YACjB,iCAAiC;YACjC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;YAC9B,uCAAuC;YACvC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;YAChC,+DAA+D;YAC/D,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;SACjD;KACF;CACF"}

package/dist/index.js

@@ -0,0 +1,29 @@
+import { harnessMatchers } from '@harnessed-ts/core';
+
+// src/index.ts
+function harnessedChai(chai, utils) {
+  const settle = async (assertion, run) => {
+    const negated = utils.flag(assertion, "negate") === true;
+    const result = await run(assertion._obj);
+    if (result.pass === negated) {
+      throw new chai.AssertionError(result.message(), {
+        actual: result.observed.actual,
+        expected: result.observed.expected,
+        showDiff: !negated
+      });
+    }
+  };
+  chai.Assertion.addProperty("absent", function() {
+    return settle(this, (subject) => harnessMatchers.toBeAbsent(subject));
+  });
+  chai.Assertion.addProperty("selected", function() {
+    return settle(this, (subject) => harnessMatchers.toBeSelected(subject));
+  });
+  chai.Assertion.addMethod("readAs", function(expected) {
+    return settle(this, (subject) => harnessMatchers.toReadAs(subject, expected));
+  });
+}
+
+export { harnessedChai };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;AA4CO,SAAS,aAAA,CAAc,MAAkB,KAAA,EAAwB;AACtE,EAAA,MAAM,MAAA,GAAS,OACb,SAAA,EACA,GAAA,KACkB;AAClB,IAAA,MAAM,OAAA,GAAU,KAAA,CAAM,IAAA,CAAK,SAAA,EAAW,QAAQ,CAAA,KAAM,IAAA;AACpD,IAAA,MAAM,MAAA,GAAS,MAAM,GAAA,CAAI,SAAA,CAAU,IAAkB,CAAA;AAGrD,IAAA,IAAI,MAAA,CAAO,SAAS,OAAA,EAAS;AAG3B,MAAA,MAAM,IAAI,IAAA,CAAK,cAAA,CAAe,MAAA,CAAO,SAAQ,EAAG;AAAA,QAC9C,MAAA,EAAQ,OAAO,QAAA,CAAS,MAAA;AAAA,QACxB,QAAA,EAAU,OAAO,QAAA,CAAS,QAAA;AAAA,QAC1B,UAAU,CAAC;AAAA,OACZ,CAAA;AAAA,IACH;AAAA,EACF,CAAA;AAEA,EAAA,IAAA,CAAK,SAAA,CAAU,WAAA,CAAY,QAAA,EAAU,WAAY;AAC/C,IAAA,OAAO,OAAO,IAAA,EAAM,CAAA,OAAA,KAAW,eAAA,CAAgB,UAAA,CAAW,OAAO,CAAC,CAAA;AAAA,EACpE,CAAC,CAAA;AAED,EAAA,IAAA,CAAK,SAAA,CAAU,WAAA,CAAY,UAAA,EAAY,WAAY;AACjD,IAAA,OAAO,OAAO,IAAA,EAAM,CAAA,OAAA,KAAW,eAAA,CAAgB,YAAA,CAAa,OAAO,CAAC,CAAA;AAAA,EACtE,CAAC,CAAA;AAED,EAAA,IAAA,CAAK,SAAA,CAAU,SAAA,CAAU,QAAA,EAAU,SAAU,QAAA,EAA2B;AACtE,IAAA,OAAO,OAAO,IAAA,EAAM,CAAA,OAAA,KAAW,gBAAgB,QAAA,CAAS,OAAA,EAAS,QAAQ,CAAC,CAAA;AAAA,EAC5E,CAAC,CAAA;AACH","file":"index.js","sourcesContent":["import { harnessMatchers } from '@harnessed-ts/core'\nimport type { Assertable, MatcherResult } from '@harnessed-ts/core'\n\n/**\n * The structural slice of Chai a plugin is handed, so this package needs\n * neither Chai's runtime nor its types at build time — and works with Chai 4,\n * 5 and 6 alike.\n */\ninterface ChaiAssertionContext {\n  _obj: unknown\n}\n\ninterface ChaiUtils {\n  flag(assertion: ChaiAssertionContext, name: string): unknown\n}\n\ninterface ChaiStatic {\n  Assertion: {\n    addProperty(name: string, getter: (this: ChaiAssertionContext) => unknown): void\n    addMethod(\n      name: string,\n      method: (this: ChaiAssertionContext, expected: string | RegExp) => unknown,\n    ): void\n  }\n  AssertionError: new (message: string, props?: Record<string, unknown>) => Error\n}\n\n/**\n * Registers `absent`, `selected` and `readAs`:\n *\n * ```ts\n * import * as chai from 'chai'\n * import { harnessedChai } from '@harnessed-ts/chai'\n * chai.use(harnessedChai)\n *\n * await expect(banner).to.be.absent\n * await expect(card).not.to.be.selected\n * await expect(price).to.readAs(/^\\$/)\n * ```\n *\n * Each takes a target or a harness and returns a promise: reading the page goes\n * through a driver, so every one of them must be awaited. The failure messages\n * are core's, shared with the Vitest and Playwright matchers.\n */\nexport function harnessedChai(chai: ChaiStatic, utils: ChaiUtils): void {\n  const settle = async (\n    assertion: ChaiAssertionContext,\n    run: (subject: Assertable) => Promise<MatcherResult>,\n  ): Promise<void> => {\n    const negated = utils.flag(assertion, 'negate') === true\n    const result = await run(assertion._obj as Assertable)\n    // A matcher's message already describes whichever way it went, so a\n    // negated assertion that fails reads \"expected … not to …\" on its own.\n    if (result.pass === negated) {\n      // actual/expected let Mocha and Cypress show a diff. A failed negation has\n      // nothing to diff — the values agreed, which was the problem.\n      throw new chai.AssertionError(result.message(), {\n        actual: result.observed.actual,\n        expected: result.observed.expected,\n        showDiff: !negated,\n      })\n    }\n  }\n\n  chai.Assertion.addProperty('absent', function () {\n    return settle(this, subject => harnessMatchers.toBeAbsent(subject))\n  })\n\n  chai.Assertion.addProperty('selected', function () {\n    return settle(this, subject => harnessMatchers.toBeSelected(subject))\n  })\n\n  chai.Assertion.addMethod('readAs', function (expected: string | RegExp) {\n    return settle(this, subject => harnessMatchers.toReadAs(subject, expected))\n  })\n}\n\ndeclare global {\n  // Chai's augmentation point is this global namespace.\n  namespace Chai {\n    interface Assertion {\n      /** Nothing matches. Await it. */\n      readonly absent: Promise<void>\n      /** `aria-pressed=\"true\"`. Await it. */\n      readonly selected: Promise<void>\n      /** The text equals a string or matches a pattern. Await it. */\n      readAs(expected: string | RegExp): Promise<void>\n    }\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,74 @@
 {
   "name": "@harnessed-ts/chai",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.6.0",
+  "description": "Chai assertions for harnesses: `await expect(banner).to.be.absent` under Mocha, WebdriverIO or Cypress.",
+  "keywords": [
+    "testing",
+    "harness",
+    "chai",
+    "mocha",
+    "bdd"
+  ],
+  "license": "MIT",
+  "contributors": [
+    {
+      "name": "Joe Gaudet",
+      "url": "https://github.com/joegaudet"
+    },
+    {
+      "name": "Jay Seo",
+      "url": "https://github.com/jayseo5953"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/joegaudet/harnessed.git",
+    "directory": "packages/chai"
+  },
+  "homepage": "https://github.com/joegaudet/harnessed#readme",
+  "bugs": "https://github.com/joegaudet/harnessed/issues",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "dependencies": {
+    "@harnessed-ts/core": "^0.6.0"
+  },
+  "peerDependencies": {
+    "chai": ">=4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@harnessed-ts/dom": "^0.6.0",
+    "@testing-library/dom": "^10.4.2",
+    "@testing-library/user-event": "^14.6.7",
+    "@types/chai": "^5.2.3",
+    "chai": "^6.3.0",
+    "jsdom": "^30.1.1",
+    "vitest": "^5.0.3"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist *.tsbuildinfo",
+    "test": "vitest run"
+  }
 }