@epic-web/workshop-utils 4.17.1 → 4.18.0

package/dist/esm/test.d.ts

@@ -1,5 +1,12 @@
-/// <reference types="chai" resolution-mode="require"/>
-export declare const expect: Chai.ExpectStatic;
+import * as dtl from '@testing-library/dom';
+import * as matchers from '@testing-library/jest-dom/matchers';
+import { type ExpectStatic } from '@vitest/expect';
+declare module '@vitest/expect' {
+    interface JestAssertion<T = any> extends matchers.TestingLibraryMatchers<ReturnType<typeof expect.stringContaining>, T> {
+    }
+}
+export declare const expect: ExpectStatic;
+export { dtl };
 export declare function testStep<ReturnValue>(title: string | ((result: {
     type: 'fail';
     error: Error;

package/dist/esm/test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../src/test.ts"],"names":[],"mappings":";AAWA,eAAO,MAAQ,MAAM,mBAAS,CAAA;AAW9B,wBAAsB,QAAQ,CAAC,WAAW,EACzC,KAAK,EACF,MAAM,GACN,CAAC,CAAC,MAAM,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,KAAK,MAAM,CAAC,EAC1E,GAAG,EAAE,CAAC,MAAM,WAAW,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC,GACrD,OAAO,CAAC,WAAW,CAAC,CA+BtB"}
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../src/test.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,sBAAsB,CAAA;AAC3C,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAA;AAC9D,OAAO,EAIN,KAAK,YAAY,EACjB,MAAM,gBAAgB,CAAA;AAiBvB,OAAO,QAAQ,gBAAgB,CAAC;IAC/B,UAAU,aAAa,CAAC,CAAC,GAAG,GAAG,CAC9B,SAAQ,QAAQ,CAAC,sBAAsB,CACtC,UAAU,CAAC,OAAO,MAAM,CAAC,gBAAgB,CAAC,EAC1C,CAAC,CACD;KAAG;CACL;AAOD,eAAO,MAAM,MAAM,cAA8B,CAAA;AACjD,OAAO,EAAE,GAAG,EAAE,CAAA;AAWd,wBAAsB,QAAQ,CAAC,WAAW,EACzC,KAAK,EACF,MAAM,GACN,CAAC,CAAC,MAAM,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,KAAK,MAAM,CAAC,EAC1E,GAAG,EAAE,CAAC,MAAM,WAAW,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC,GACrD,OAAO,CAAC,WAAW,CAAC,CAmCtB"}

package/dist/esm/test.js

@@ -1,12 +1,22 @@
-import { configure } from '@testing-library/dom';
+import * as dtl from '@testing-library/dom';
+import * as matchers from '@testing-library/jest-dom/matchers';
+import { JestAsymmetricMatchers, JestChaiExpect, JestExtend, } from '@vitest/expect';
 import * as chai from 'chai';
 import chaiDOM from 'chai-dom';
+// allows using expect.extend instead of chai.use to extend plugins
+chai.use(JestExtend);
+// adds all jest matchers to expect
+chai.use(JestChaiExpect);
+// adds asymmetric matchers like stringContaining, objectContaining
+chai.use(JestAsymmetricMatchers);
 chai.use(chaiDOM);
+chai.expect.extend(chai.expect, matchers);
 // in the browser logging out the element is not necessary
-configure({
+dtl.configure({
     getElementError: (message) => new Error(message ?? 'Unknown error'),
 });
-export const { expect } = chai;
+export const expect = chai.expect;
+export { dtl };
 function isError(maybeError) {
     return (maybeError &&
         typeof maybeError === 'object' &&
@@ -14,7 +24,6 @@ function isError(maybeError) {
         typeof maybeError.message === 'string');
 }
 export async function testStep(title, get) {
-    let caughtError;
     try {
         const result = await get();
         const titleString = typeof title === 'function' ? title({ type: 'pass' }) : title;
@@ -31,14 +40,17 @@ export async function testStep(title, get) {
         }
         return result;
     }
-    catch (e) {
-        caughtError = e;
+    catch (caughtError) {
+        const error = isError(caughtError)
+            ? caughtError
+            : new Error(typeof caughtError === 'string' ? caughtError : 'Unknown error', { cause: caughtError });
+        const titleString = typeof title === 'function' ? title({ type: 'fail', error }) : title;
+        if (window.parent === window) {
+            console.error(`❌ ${titleString}`);
+            console.error(error.message);
+        }
+        error.message = `${titleString}${error.message ? `\n\n${error.message}` : ''}`;
+        throw error;
     }
-    const error = isError(caughtError)
-        ? caughtError
-        : new Error(typeof caughtError === 'string' ? caughtError : 'Unknown error');
-    const titleString = typeof title === 'function' ? title({ type: 'fail', error }) : title;
-    error.message = `${titleString}${error.message ? `\n\n${error.message}` : ''}`;
-    throw error;
 }
 //# sourceMappingURL=test.js.map

package/dist/esm/test.js.map

@@ -1 +1 @@
-{"version":3,"file":"test.js","sourceRoot":"","sources":["../../src/test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAC5B,OAAO,OAAO,MAAM,UAAU,CAAA;AAE9B,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;AAEjB,0DAA0D;AAC1D,SAAS,CAAC;IACT,eAAe,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,OAAO,IAAI,eAAe,CAAC;CACnE,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;AAE9B,SAAS,OAAO,CAAC,UAAe;IAC/B,OAAO,CACN,UAAU;QACV,OAAO,UAAU,KAAK,QAAQ;QAC9B,SAAS,IAAI,UAAU;QACvB,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ,CACtC,CAAA;AACF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC7B,KAE0E,EAC1E,GAAuD;IAEvD,IAAI,WAAW,CAAA;IACf,IAAI,CAAC;QACJ,MAAM,MAAM,GAAG,MAAM,GAAG,EAAE,CAAA;QAC1B,MAAM,WAAW,GAChB,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;QAC9D,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE,CAAC,CAAA;QAChC,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,MAAM,CAAC,WAAW,CACxB;gBACC,IAAI,EAAE,2BAA2B;gBACjC,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,WAAW;gBAClB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;aACrB,EACD,GAAG,CACH,CAAA;QACF,CAAC;QACD,OAAO,MAAM,CAAA;IACd,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACrB,WAAW,GAAG,CAAC,CAAA;IAChB,CAAC;IAED,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC;QACjC,CAAC,CAAC,WAAW;QACb,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,eAAe,CAAC,CAAA;IAC7E,MAAM,WAAW,GAChB,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;IACrE,KAAK,CAAC,OAAO,GAAG,GAAG,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;IAC9E,MAAM,KAAK,CAAA;AACZ,CAAC","sourcesContent":["import { configure } from '@testing-library/dom'\nimport * as chai from 'chai'\nimport chaiDOM from 'chai-dom'\n\nchai.use(chaiDOM)\n\n// in the browser logging out the element is not necessary\nconfigure({\n\tgetElementError: (message) => new Error(message ?? 'Unknown error'),\n})\n\nexport const { expect } = chai\n\nfunction isError(maybeError: any): maybeError is Error {\n\treturn (\n\t\tmaybeError &&\n\t\ttypeof maybeError === 'object' &&\n\t\t'message' in maybeError &&\n\t\ttypeof maybeError.message === 'string'\n\t)\n}\n\nexport async function testStep<ReturnValue>(\n\ttitle:\n\t\t| string\n\t\t| ((result: { type: 'fail'; error: Error } | { type: 'pass' }) => string),\n\tget: (() => ReturnValue) | (() => Promise<ReturnValue>),\n): Promise<ReturnValue> {\n\tlet caughtError\n\ttry {\n\t\tconst result = await get()\n\t\tconst titleString =\n\t\t\ttypeof title === 'function' ? title({ type: 'pass' }) : title\n\t\tif (window.parent === window) {\n\t\t\tconsole.log(`✅ ${titleString}`)\n\t\t} else {\n\t\t\twindow.parent.postMessage(\n\t\t\t\t{\n\t\t\t\t\ttype: 'epicshop:test-step-update',\n\t\t\t\t\tstatus: 'pass',\n\t\t\t\t\ttitle: titleString,\n\t\t\t\t\ttimestamp: Date.now(),\n\t\t\t\t},\n\t\t\t\t'*',\n\t\t\t)\n\t\t}\n\t\treturn result\n\t} catch (e: unknown) {\n\t\tcaughtError = e\n\t}\n\n\tconst error = isError(caughtError)\n\t\t? caughtError\n\t\t: new Error(typeof caughtError === 'string' ? caughtError : 'Unknown error')\n\tconst titleString =\n\t\ttypeof title === 'function' ? title({ type: 'fail', error }) : title\n\terror.message = `${titleString}${error.message ? `\\n\\n${error.message}` : ''}`\n\tthrow error\n}\n"]}
+{"version":3,"file":"test.js","sourceRoot":"","sources":["../../src/test.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,sBAAsB,CAAA;AAC3C,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAA;AAC9D,OAAO,EACN,sBAAsB,EACtB,cAAc,EACd,UAAU,GAEV,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAC5B,OAAO,OAAO,MAAM,UAAU,CAAA;AAE9B,mEAAmE;AACnE,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;AACpB,mCAAmC;AACnC,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;AACxB,mEAAmE;AACnE,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;AAEhC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAKhB;AAAC,IAAI,CAAC,MAAuB,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;AAS5D,0DAA0D;AAC1D,GAAG,CAAC,SAAS,CAAC;IACb,eAAe,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,OAAO,IAAI,eAAe,CAAC;CACnE,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAsB,CAAA;AACjD,OAAO,EAAE,GAAG,EAAE,CAAA;AAEd,SAAS,OAAO,CAAC,UAAe;IAC/B,OAAO,CACN,UAAU;QACV,OAAO,UAAU,KAAK,QAAQ;QAC9B,SAAS,IAAI,UAAU;QACvB,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ,CACtC,CAAA;AACF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC7B,KAE0E,EAC1E,GAAuD;IAEvD,IAAI,CAAC;QACJ,MAAM,MAAM,GAAG,MAAM,GAAG,EAAE,CAAA;QAC1B,MAAM,WAAW,GAChB,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;QAC9D,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE,CAAC,CAAA;QAChC,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,MAAM,CAAC,WAAW,CACxB;gBACC,IAAI,EAAE,2BAA2B;gBACjC,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,WAAW;gBAClB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;aACrB,EACD,GAAG,CACH,CAAA;QACF,CAAC;QACD,OAAO,MAAM,CAAA;IACd,CAAC;IAAC,OAAO,WAAoB,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC;YACjC,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,IAAI,KAAK,CACT,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,eAAe,EAC/D,EAAE,KAAK,EAAE,WAAW,EAAE,CACtB,CAAA;QACH,MAAM,WAAW,GAChB,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;QACrE,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC9B,OAAO,CAAC,KAAK,CAAC,KAAK,WAAW,EAAE,CAAC,CAAA;YACjC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAC7B,CAAC;QACD,KAAK,CAAC,OAAO,GAAG,GAAG,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;QAC9E,MAAM,KAAK,CAAA;IACZ,CAAC;AACF,CAAC","sourcesContent":["import * as dtl from '@testing-library/dom'\nimport * as matchers from '@testing-library/jest-dom/matchers'\nimport {\n\tJestAsymmetricMatchers,\n\tJestChaiExpect,\n\tJestExtend,\n\ttype ExpectStatic,\n} from '@vitest/expect'\nimport * as chai from 'chai'\nimport chaiDOM from 'chai-dom'\n\n// allows using expect.extend instead of chai.use to extend plugins\nchai.use(JestExtend)\n// adds all jest matchers to expect\nchai.use(JestChaiExpect)\n// adds asymmetric matchers like stringContaining, objectContaining\nchai.use(JestAsymmetricMatchers)\n\nchai.use(chaiDOM)\n\n// @ts-expect-error weird typescript nonsense\n// I *think* vitest is using the extend API wrong or something 🤷‍♂️\n// this works though so...\n;(chai.expect as ExpectStatic).extend(chai.expect, matchers)\ndeclare module '@vitest/expect' {\n\tinterface JestAssertion<T = any>\n\t\textends matchers.TestingLibraryMatchers<\n\t\t\tReturnType<typeof expect.stringContaining>,\n\t\t\tT\n\t\t> {}\n}\n\n// in the browser logging out the element is not necessary\ndtl.configure({\n\tgetElementError: (message) => new Error(message ?? 'Unknown error'),\n})\n\nexport const expect = chai.expect as ExpectStatic\nexport { dtl }\n\nfunction isError(maybeError: any): maybeError is Error {\n\treturn (\n\t\tmaybeError &&\n\t\ttypeof maybeError === 'object' &&\n\t\t'message' in maybeError &&\n\t\ttypeof maybeError.message === 'string'\n\t)\n}\n\nexport async function testStep<ReturnValue>(\n\ttitle:\n\t\t| string\n\t\t| ((result: { type: 'fail'; error: Error } | { type: 'pass' }) => string),\n\tget: (() => ReturnValue) | (() => Promise<ReturnValue>),\n): Promise<ReturnValue> {\n\ttry {\n\t\tconst result = await get()\n\t\tconst titleString =\n\t\t\ttypeof title === 'function' ? title({ type: 'pass' }) : title\n\t\tif (window.parent === window) {\n\t\t\tconsole.log(`✅ ${titleString}`)\n\t\t} else {\n\t\t\twindow.parent.postMessage(\n\t\t\t\t{\n\t\t\t\t\ttype: 'epicshop:test-step-update',\n\t\t\t\t\tstatus: 'pass',\n\t\t\t\t\ttitle: titleString,\n\t\t\t\t\ttimestamp: Date.now(),\n\t\t\t\t},\n\t\t\t\t'*',\n\t\t\t)\n\t\t}\n\t\treturn result\n\t} catch (caughtError: unknown) {\n\t\tconst error = isError(caughtError)\n\t\t\t? caughtError\n\t\t\t: new Error(\n\t\t\t\t\ttypeof caughtError === 'string' ? caughtError : 'Unknown error',\n\t\t\t\t\t{ cause: caughtError },\n\t\t\t\t)\n\t\tconst titleString =\n\t\t\ttypeof title === 'function' ? title({ type: 'fail', error }) : title\n\t\tif (window.parent === window) {\n\t\t\tconsole.error(`❌ ${titleString}`)\n\t\t\tconsole.error(error.message)\n\t\t}\n\t\terror.message = `${titleString}${error.message ? `\\n\\n${error.message}` : ''}`\n\t\tthrow error\n\t}\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epic-web/workshop-utils",
-  "version": "4.17.1",
+  "version": "4.18.0",
   "publishConfig": {
     "access": "public"
   },
@@ -128,9 +128,11 @@
     "@playwright/test": "^1.44.1",
     "@remix-run/node": "^2.9.2",
     "@testing-library/dom": "^10.1.0",
+    "@testing-library/jest-dom": "^6.4.8",
     "@total-typescript/ts-reset": "^0.5.1",
     "@types/chai": "^4.3.17",
     "@types/chai-dom": "^1.11.3",
+    "@vitest/expect": "^2.0.5",
     "chai": "^5.1.1",
     "chai-dom": "^1.12.0",
     "chalk": "^5.3.0",