@leaflink/dom-testing-utils 1.2.1 → 2.0.0

package/README.md

@@ -13,12 +13,15 @@
 
 - [Installation](#installation)
 - [Usage](#usage)
-  - [Global setup](#global-setup)
   - [Setup file](#setup-file)
+  - [Global setup](#global-setup)
+- [Utilities](#utilities)
   - [`cleanupNoty`](#cleanupnoty)
   - [`waitForLoadingToFinish`](#waitforloadingtofinish)
   - [`cleanupDropdowns`](#cleanupdropdowns)
   - [`assertAndDismissNoty`](#assertanddismissnoty)
+  - [`getByDescriptionTerm`](#getbydescriptionterm)
+  - [`getAllByDescriptionTerm`](#getallbydescriptionterm)
   - [`createFixtureGenerator`](#createfixturegenerator)
   - [Mocking API Endpoints](#mocking-api-endpoints)
 
@@ -32,7 +35,7 @@ npm install --save-dev @leaflink/dom-testing-utils
 
 ## Usage
 
-In your `*.spec.(ts|js)` files you can import utility functions.
+In your test files you can import utility functions.
 
 ```ts
 import {
@@ -48,27 +51,41 @@ it('...', () => {
 });
 ```
 
-There's also shared setup files you can extend from.
+### Setup file
 
-### Global setup
+Import `@leaflink/dom-testing-utils/setup-env` once (for instance in your tests setup file) and you're good to go:
 
-Add the following line to your `vite.config.js`:
+> **Note:** `@testing-library/jest-dom` is auto-imported from `@leaflink/dom-testing-utils` so you don't have to.
 
-```js
-globalSetup: 'node_modules/@leaflink/dom-testing-utils/dist/global-setup.js',
+```ts
+// In your own setup-env.ts (or any other name)
+import '@leaflink/dom-testing-utils/setup-env'
+// DON'T import `@testing-library/jest-dom` is auto imported from dom-testing-utils
+
+// In vite.config.ts add (if you haven't already)
+setupFiles: ['tests/setup-env.js'],
+
+// In jest.config.js add (if you haven't already)
+setupFilesAfterEnv: ['<rootDir>/tests/setup-env.js']
 ```
 
-This will run once *before everything*. See <https://vitest.dev/config/#globalsetup>.
+This will be run once before *each* test file. See <https://vitest.dev/config/#setupfiles>.
 
-### Setup file
+### Global setup
 
-Add the following line to your `vite.config.js`:
+Add the following import to your test config:
 
 ```js
-setupFiles: ['node_modules/@leaflink/dom-testing-utils/dist/setup-env.js'],
+// In vite.config.ts add
+globalSetup: ['node_modules/@leaflink/dom-testing-utils/dist/global-setup.js'],
+
+// In jest.config.js add
+globalSetup: ['<rootDir>/node_modules/@leaflink/dom-testing-utils/dist/global-setup.js']
 ```
 
-This will be run once before *each* test file. See <https://vitest.dev/config/#setupfiles>.
+This will run once *before everything*. See <https://vitest.dev/config/#globalsetup>.
+
+## Utilities
 
 ### `cleanupNoty`
 
@@ -108,6 +125,27 @@ Helper to assert and manually dismiss a notification.  This is useful in scenari
 
 **Returns**: `void`
 
+### `getByDescriptionTerm`
+
+Finds the first HTML element with the role "definition" (DD) that matches the specified text for the description term.
+
+| **Parameters** | **Type** | **Default** | **Summary** |
+| ----------- | ----------- | ----------- |----------- |
+| text | `string \| RegExp` | *Required* | Expected description term text or regex |
+
+**Returns**: `HTMLElement | undefined` - The first matching description detail element or undefined if no match is found.
+
+
+### `getAllByDescriptionTerm`
+
+Queries and returns an array of HTML elements with the role "definition" (DD) that matches the specified text of a description term.
+
+| **Parameters** | **Type** | **Default** | **Summary** |
+| ----------- | ----------- | ----------- |----------- |
+| textMatch | `string \| RegExp` | *Required* | The text to match within the HTML elements. It can be a string or a regular expression. |
+
+**Returns**: `HTMLElement[]` - An array of HTML description detail elements that match the given text.
+
 ### `createFixtureGenerator`
 
 Higher order function that takes a method whose responsibility is to create a **single** data fixture object and returns a new generator function that allows you to create 1 or more of those fixtures. Fixture generator function that's returned supports passing optional `num` and `overrides` params.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { createMockApiUtils, RestMethod } from "./api/mockEndpoints.js";
+import { createMockApiUtils, RestMethod } from './api/mockEndpoints.js';
 /**
  * Utility to wait for loading to complete. Need to add a `data-test` to any
  * loading elements. Defaults to `ll-loading` OR `loading-spinner` if test ID is not specified.
@@ -14,6 +14,21 @@ export declare function waitForLoadingToFinish(textMatch?: RegExp): Promise<void
  */
 export declare function cleanupNoty(): void;
 export declare function cleanupDropdowns(): void;
+/**
+ * Queries and returns an array of HTML elements with the role "definition" (DD)
+ * that matches the specified text.
+ *
+ * @param textMatch - The text to match within the HTML elements. It can be a string or a regular expression.
+ * @returns An array of HTML elements that match the given text.
+ */
+export declare function getAllByDescriptionTerm(textMatch: string | RegExp): HTMLElement[];
+/**
+ * Finds the first HTML element with the role "definition" (DD) that matches the specified text.
+ *
+ * @param textMatch - The text to match within the HTML elements. It can be a string or a regular expression.
+ * @returns The matched element, or undefined if no match is found.
+ */
+export declare function getByDescriptionTerm(textMatch: string | RegExp): HTMLElement | undefined;
 /**
  * Helper to assert and manually dismiss a notification.  This is useful in scenarios where
  * cleanupNoty() does not work as expected, such as when validating error messages in test suites
@@ -41,11 +56,13 @@ export declare function assertAndDismissNoty(text: string): Promise<void>;
  *    generateInvoices(10)                  // => Array of 10 invoice objects
  *    generateInvoices(10, { foo: 'bar' })  // => Array of 10 invoice objects, override `foo` to equal `'bar'` in each
  *
- * @param {function} fixtureFn - Method that generates a JSON data fixture.
- * @returns {function}
- * @returns {array|object} - Array of fixture objects or single object if n = 1.
+ * @param fixtureFn - Method that generates a JSON data fixture.
+ * @returns A fixture generator that return an array of fixture objects or single object if n = 1.
  */
-export declare function createFixtureGenerator(fixtureFn: any): (num?: number | {
-    [key: string]: any;
-}, overrides?: {}) => any;
+export declare function createFixtureGenerator<T>(fixtureFn: (overrides?: Partial<T>) => T): {
+    (): T;
+    <TNum extends 1>(num: TNum, overrides?: Partial<T>): T;
+    (num: Partial<T>): T;
+    <TNum_1 extends number>(num: TNum_1, overrides?: Partial<T>): T[];
+};
 export { createMockApiUtils, RestMethod };

package/dist/index.js

@@ -1,6 +1,6 @@
-import { screen, waitForElementToBeRemoved } from '@testing-library/vue';
-import { default as userEvent } from '@testing-library/user-event';
-import { createMockApiUtils } from "./api/mockEndpoints.js";
+import userEvent from '@testing-library/user-event';
+import { getNodeText, screen, waitForElementToBeRemoved, } from '@testing-library/vue';
+import { createMockApiUtils } from './api/mockEndpoints.js';
 /**
  * Utility to wait for loading to complete. Need to add a `data-test` to any
  * loading elements. Defaults to `ll-loading` OR `loading-spinner` if test ID is not specified.
@@ -8,7 +8,7 @@ import { createMockApiUtils } from "./api/mockEndpoints.js";
  * @param {string} testId - The data test ID to target
  * @returns {Promise<boolean>} - Will resolve or throw if the loaders stay in the DOM.
  */
-export function waitForLoadingToFinish(textMatch = /ll\-loading|loading\-spinner/) {
+export function waitForLoadingToFinish(textMatch = /ll-loading|loading-spinner/) {
     return waitForElementToBeRemoved(() => [...screen.queryAllByTestId(textMatch)], { timeout: 2000 });
 }
 /**
@@ -26,6 +26,56 @@ export function cleanupDropdowns() {
         .querySelectorAll('.mount-point-container')
         .forEach((elem) => elem.parentNode?.removeChild(elem));
 }
+/**
+ * Type guard function to check if the provided value is an instance of HTMLElement.
+ *
+ * @param element - The value to check if it is an HTMLElement.
+ * @returns Returns true if the value is an HTMLElement, otherwise false.
+ */
+function isHTMLElement(element) {
+    return element instanceof HTMLElement;
+}
+/**
+ * Checks if the given HTML element contains the specified text or matches the regular expression.
+ *
+ * @param node - The HTML element to check for the presence of text.
+ * @param textMatch - The text or regular expression to match within the HTML element.
+ * @returns Returns one of the following:
+ *   - true, if the element contains the exact text match;
+ *   - RegExpMatchArray, if the element's text matches the regular expression;
+ *   - null, if there is no match.
+ */
+function hasText(node, textMatch) {
+    const nodeText = getNodeText(node);
+    return nodeText === textMatch || nodeText.match(textMatch);
+}
+/**
+ * Queries and returns an array of HTML elements with the role "definition" (DD)
+ * that matches the specified text.
+ *
+ * @param textMatch - The text to match within the HTML elements. It can be a string or a regular expression.
+ * @returns An array of HTML elements that match the given text.
+ */
+export function getAllByDescriptionTerm(textMatch) {
+    return screen
+        .getAllByRole('definition')
+        .filter((term) => term.tagName === 'DD' &&
+        isHTMLElement(term.previousElementSibling) &&
+        hasText(term?.previousElementSibling, textMatch));
+}
+/**
+ * Finds the first HTML element with the role "definition" (DD) that matches the specified text.
+ *
+ * @param textMatch - The text to match within the HTML elements. It can be a string or a regular expression.
+ * @returns The matched element, or undefined if no match is found.
+ */
+export function getByDescriptionTerm(textMatch) {
+    return screen
+        .getAllByRole('definition')
+        .find((term) => term.tagName === 'DD' &&
+        isHTMLElement(term.previousElementSibling) &&
+        hasText(term?.previousElementSibling, textMatch));
+}
 /**
  * Helper to assert and manually dismiss a notification.  This is useful in scenarios where
  * cleanupNoty() does not work as expected, such as when validating error messages in test suites
@@ -57,20 +107,26 @@ export async function assertAndDismissNoty(text) {
  *    generateInvoices(10)                  // => Array of 10 invoice objects
  *    generateInvoices(10, { foo: 'bar' })  // => Array of 10 invoice objects, override `foo` to equal `'bar'` in each
  *
- * @param {function} fixtureFn - Method that generates a JSON data fixture.
- * @returns {function}
- * @returns {array|object} - Array of fixture objects or single object if n = 1.
+ * @param fixtureFn - Method that generates a JSON data fixture.
+ * @returns A fixture generator that return an array of fixture objects or single object if n = 1.
  */
 export function createFixtureGenerator(fixtureFn) {
-    return (num = 1, overrides = {}) => {
-        // if passed a number of 1 or an object, we're only going to generate a
-        // single data object and treat `num` as the overrides.
-        if (typeof num !== 'number' || num === 1) {
+    function _generator(num = 1, overrides = {}) {
+        // if the first param is not a number, it must be the overrides
+        if (typeof num !== 'number') {
             return fixtureFn(num);
         }
-        // Otherwise, let's generate however many requested data objects
-        return Array.apply(null, Array(num)).map(() => fixtureFn(overrides));
-    };
+        else if (num === 1) {
+            // If num is 1, then we don't want to return an array, so just generate one with any potential overrides
+            return fixtureFn(overrides);
+        }
+        else {
+            // Otherwise, let's generate however many requested data objects
+            // eslint-disable-next-line prefer-spread
+            return Array.apply(null, Array(num)).map(() => fixtureFn(overrides));
+        }
+    }
+    return _generator;
 }
 export { createMockApiUtils };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"src/","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAa,MAAM,wBAAwB,CAAC;AACvE;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CACpC,SAAS,GAAG,8BAA8B;IAE1C,OAAO,yBAAyB,CAC9B,GAAG,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,EAC7C,EAAE,OAAO,EAAE,IAAI,EAAE,CAClB,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW;IACzB,QAAQ;SACL,gBAAgB,CAAC,WAAW,CAAC;SAC7B,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,QAAQ;SACL,gBAAgB,CAAC,wBAAwB,CAAC;SAC1C,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,IAAY;IACrD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC3C,MAAM,CAAC,IAAI,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAEjC,MAAM,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,sBAAsB,CAAC,SAAS;IAC9C,OAAO,CAAC,MAAqC,CAAC,EAAE,SAAS,GAAG,EAAE,EAAE,EAAE;QAChE,uEAAuE;QACvE,uDAAuD;QACvD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,CAAC,EAAE;YACxC,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;SACvB;QAED,gEAAgE;QAChE,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IACvE,CAAC,CAAC;AACJ,CAAC;AAED,OAAO,EAAE,kBAAkB,EAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,6BAA6B,CAAC;AACpD,OAAO,EACL,WAAW,EACX,MAAM,EACN,yBAAyB,GAC1B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,kBAAkB,EAAc,MAAM,wBAAwB,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CACpC,SAAS,GAAG,4BAA4B;IAExC,OAAO,yBAAyB,CAC9B,GAAG,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,EAC7C,EAAE,OAAO,EAAE,IAAI,EAAE,CAClB,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW;IACzB,QAAQ;SACL,gBAAgB,CAAC,WAAW,CAAC;SAC7B,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,QAAQ;SACL,gBAAgB,CAAC,wBAAwB,CAAC;SAC1C,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,OAAY;IACjC,OAAO,OAAO,YAAY,WAAW,CAAC;AACxC,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,OAAO,CACd,IAAiB,EACjB,SAA0B;IAE1B,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACnC,OAAO,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CACrC,SAA0B;IAE1B,OAAO,MAAM;SACV,YAAY,CAAC,YAAY,CAAC;SAC1B,MAAM,CACL,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,OAAO,KAAK,IAAI;QACrB,aAAa,CAAC,IAAI,CAAC,sBAAsB,CAAC;QAC1C,OAAO,CAAC,IAAI,EAAE,sBAAsB,EAAE,SAAS,CAAC,CACnD,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAClC,SAA0B;IAE1B,OAAO,MAAM;SACV,YAAY,CAAC,YAAY,CAAC;SAC1B,IAAI,CACH,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,OAAO,KAAK,IAAI;QACrB,aAAa,CAAC,IAAI,CAAC,sBAAsB,CAAC;QAC1C,OAAO,CAAC,IAAI,EAAE,sBAAsB,EAAE,SAAS,CAAC,CACnD,CAAC;AACN,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,IAAY;IACrD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC3C,MAAM,CAAC,IAAI,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAEjC,MAAM,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,sBAAsB,CACpC,SAAwC;IASxC,SAAS,UAAU,CAAC,MAA2B,CAAC,EAAE,SAAS,GAAG,EAAE;QAC9D,+DAA+D;QAC/D,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC3B,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;SACvB;aAAM,IAAI,GAAG,KAAK,CAAC,EAAE;YACpB,wGAAwG;YACxG,OAAO,SAAS,CAAC,SAAS,CAAC,CAAC;SAC7B;aAAM;YACL,gEAAgE;YAChE,yCAAyC;YACzC,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;SACtE;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,OAAO,EAAE,kBAAkB,EAAc,CAAC"}

package/dist/index.spec.js

@@ -1,4 +1,5 @@
-import { createFixtureGenerator } from "./index";
+import { render } from '@testing-library/vue';
+import { createFixtureGenerator, getAllByDescriptionTerm, getByDescriptionTerm, } from './index';
 describe('createFixtureGenerator()', () => {
     it('returns a function that can generate an array of data objects', () => {
         const generator = (overrides) => ({
@@ -25,8 +26,41 @@ describe('createFixtureGenerator()', () => {
             bar: 'baz',
             ...overrides,
         });
-        expect(createFixtureGenerator(generator)()).toEqual({ foo: 'bar', bar: 'baz' });
-        expect(createFixtureGenerator(generator)({ bar: 'yak' })).toEqual({ foo: 'bar', bar: 'yak' });
+        expect(createFixtureGenerator(generator)()).toEqual({
+            foo: 'bar',
+            bar: 'baz',
+        });
+        expect(createFixtureGenerator(generator)({ bar: 'yak' })).toEqual({
+            foo: 'bar',
+            bar: 'yak',
+        });
+    });
+});
+describe('getByDescriptionTerm', () => {
+    it.each `
+    term                      | type
+    ${'foo'}                  | ${'string'}
+    ${/foo/i}                 | ${'regex'}
+    ${new RegExp('foo', 'i')} | ${'RegExp'}
+  `('should return the description detail for a given $type term', ({ term }) => {
+        render({ template: `<dl><dt>foo</dt><dd>bar</dd></dl>` });
+        expect(getByDescriptionTerm(term)).toHaveTextContent('bar');
+    });
+});
+describe('getAllByDescriptionTerm', () => {
+    it.each `
+    term                      | type
+    ${'foo'}                  | ${'string'}
+    ${/foo/i}                 | ${'regex'}
+    ${new RegExp('foo', 'i')} | ${'RegExp'}
+  `('should return the description details for a given $type term', ({ term }) => {
+        render({
+            template: `<dl><dt>foo</dt><dd>bar1</dd></dl><dl><dt>foo</dt><dd>bar2</dd></dl>`,
+        });
+        const details = getAllByDescriptionTerm(term);
+        expect(details).toHaveLength(2);
+        expect(details[0]).toHaveTextContent('bar1');
+        expect(details[1]).toHaveTextContent('bar2');
     });
 });
 //# sourceMappingURL=index.spec.js.map

package/dist/index.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.spec.js","sourceRoot":"src/","sources":["index.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAEjD,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAChC,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;YACV,GAAG,SAAS;SACb,CAAC,CAAC;QAEH,MAAM,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACnD,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;YAC1B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;YAC1B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;YAC1B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;YAC1B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;SAC3B,CAAC,CAAA;QAEF,MAAM,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YAClE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;YAC1B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;YAC1B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;SAC3B,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAChC,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;YACV,GAAG,SAAS;SACb,CAAC,CAAC;QAEH,MAAM,CAAC,sBAAsB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;QAEhF,MAAM,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/F,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
+{"version":3,"file":"index.spec.js","sourceRoot":"src/","sources":["index.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAE9C,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,GACrB,MAAM,SAAS,CAAC;AAEjB,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAChC,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;YACV,GAAG,SAAS;SACb,CAAC,CAAC;QAEH,MAAM,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACnD,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;YAC1B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;YAC1B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;YAC1B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;YAC1B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;SAC3B,CAAC,CAAC;QAEH,MAAM,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YACnE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;YAC1B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;YAC1B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;SAC3B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAChC,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;YACV,GAAG,SAAS;SACb,CAAC,CAAC;QAEH,MAAM,CAAC,sBAAsB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC;YAClD,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;SACX,CAAC,CAAC;QAEH,MAAM,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YAChE,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;SACX,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,EAAE,CAAC,IAAI,CAAA;;MAEH,KAAK,uBAAuB,QAAQ;MACpC,MAAM,sBAAsB,OAAO;MACnC,IAAI,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,QAAQ;GACvC,CACC,6DAA6D,EAC7D,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;QACX,MAAM,CAAC,EAAE,QAAQ,EAAE,mCAAmC,EAAE,CAAC,CAAC;QAE1D,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC,CACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACvC,EAAE,CAAC,IAAI,CAAA;;MAEH,KAAK,uBAAuB,QAAQ;MACpC,MAAM,sBAAsB,OAAO;MACnC,IAAI,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,QAAQ;GACvC,CACC,8DAA8D,EAC9D,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;QACX,MAAM,CAAC;YACL,QAAQ,EAAE,sEAAsE;SACjF,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC,CACF,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/setup-env.js

@@ -1,12 +1,12 @@
-import { vi } from 'vitest';
-import { config } from '@vue/test-utils';
 import '@testing-library/jest-dom';
+import { config } from '@vue/test-utils';
+import { vi } from 'vitest';
 config.global.mocks['$t'] = (msg) => msg;
 const oldWindowLocation = global.window.location;
 beforeAll(() => {
-    // @ts-expect-error
+    // @ts-expect-error - dunno
     delete global.window.location;
-    // @ts-expect-error
+    // @ts-expect-error - dunno
     global.window.location = Object.defineProperties({}, {
         ...Object.getOwnPropertyDescriptors(oldWindowLocation),
         assign: {

package/dist/setup-env.js.map

@@ -1 +1 @@
-{"version":3,"file":"setup-env.js","sourceRoot":"src/","sources":["setup-env.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,2BAA2B,CAAC;AAEnC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC;AAEzC,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;AAEjD,SAAS,CAAC,GAAG,EAAE;IACb,mBAAmB;IACnB,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;IAE9B,mBAAmB;IACnB,MAAM,CAAC,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,gBAAgB,CAC9C,EAAE,EACF;QACE,GAAG,MAAM,CAAC,yBAAyB,CAAC,iBAAiB,CAAC;QACtD,MAAM,EAAE;YACN,YAAY,EAAE,IAAI;YAClB,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE;SACf;QACD,IAAI,EAAE;YACJ,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE;gBACL,OAAO,EAAE,EAAE,CAAC,EAAE,EAAE;aACjB;SACF;KACF,CACF,CAAC;IAEF,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;IAEtB,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,GAAG,EAAE;QACjC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,GAAG,EAAE;IACZ,MAAM,CAAC,MAAM,CAAC,QAAQ,GAAG,iBAAiB,CAAC;AAC7C,CAAC,CAAC,CAAC;AAEH,MAAM,wBAAwB,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;IAC5C,IAAI,IAAI;QACN,OAAO;IACT,CAAC;IACD,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE;IACnB,OAAO,EAAE,EAAE,CAAC,EAAE,EAAE;IAChB,WAAW,EAAE,EAAE,CAAC,EAAE,EAAE;IACpB,SAAS,EAAE,EAAE,CAAC,EAAE,EAAE;CACnB,CAAC,CAAC,CAAC;AAEJ,EAAE,CAAC,UAAU,CAAC,sBAAsB,EAAE,wBAAwB,CAAC,CAAC;AAEhE,EAAE,CAAC,UAAU,CACX,OAAO,EACP,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC,EAAE,CAAC,CACnE,CAAC;AAEF,6CAA6C;AAC7C,OAAO,CAAC,SAAS,CAAC,cAAc,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC"}
+{"version":3,"file":"setup-env.js","sourceRoot":"src/","sources":["setup-env.ts"],"names":[],"mappings":"AAAA,OAAO,2BAA2B,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE5B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC;AAEzC,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;AAEjD,SAAS,CAAC,GAAG,EAAE;IACb,2BAA2B;IAC3B,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;IAE9B,2BAA2B;IAC3B,MAAM,CAAC,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,gBAAgB,CAC9C,EAAE,EACF;QACE,GAAG,MAAM,CAAC,yBAAyB,CAAC,iBAAiB,CAAC;QACtD,MAAM,EAAE;YACN,YAAY,EAAE,IAAI;YAClB,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE;SACf;QACD,IAAI,EAAE;YACJ,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE;gBACL,OAAO,EAAE,EAAE,CAAC,EAAE,EAAE;aACjB;SACF;KACF,CACF,CAAC;IAEF,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;IAEtB,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,GAAG,EAAE;QACjC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,GAAG,EAAE;IACZ,MAAM,CAAC,MAAM,CAAC,QAAQ,GAAG,iBAAiB,CAAC;AAC7C,CAAC,CAAC,CAAC;AAEH,MAAM,wBAAwB,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;IAC5C,IAAI,IAAI;QACN,OAAO;IACT,CAAC;IACD,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE;IACnB,OAAO,EAAE,EAAE,CAAC,EAAE,EAAE;IAChB,WAAW,EAAE,EAAE,CAAC,EAAE,EAAE;IACpB,SAAS,EAAE,EAAE,CAAC,EAAE,EAAE;CACnB,CAAC,CAAC,CAAC;AAEJ,EAAE,CAAC,UAAU,CAAC,sBAAsB,EAAE,wBAAwB,CAAC,CAAC;AAEhE,EAAE,CAAC,UAAU,CACX,OAAO,EACP,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC,EAAE,CAAC,CACnE,CAAC;AAEF,6CAA6C;AAC7C,OAAO,CAAC,SAAS,CAAC,cAAc,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC"}

package/package.json

@@ -1,13 +1,27 @@
 {
   "name": "@leaflink/dom-testing-utils",
-  "version": "1.2.1",
+  "version": "2.0.0",
   "description": "Frontend DOM testing utilities",
   "engines": {
     "node": ">=16",
     "npm": ">=8"
   },
   "exports": {
-    ".": "./dist/index.js"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./setup-env": {
+      "types": "./dist/setup-env.d.ts",
+      "import": "./dist/setup-env.js",
+      "default": "./dist/setup-env.js"
+    },
+    "./global-env": {
+      "types": "./dist/global-env.d.ts",
+      "import": "./dist/global-env.js",
+      "default": "./dist/global-env.js"
+    }
   },
   "type": "module",
   "types": "./dist/index.d.ts",
@@ -19,32 +33,12 @@
   ],
   "scripts": {
     "build": "tsc",
+    "fix": "npm run lint -- --fix",
+    "lint": "eslint .",
     "lint:commits": "commitlint",
     "test": "vitest --reporter verbose"
   },
   "license": "MIT",
-  "devDependencies": {
-    "@commitlint/cli": "^17.4.4",
-    "@commitlint/config-conventional": "^17.4.4",
-    "@vitest/coverage-c8": "^0.29.2",
-    "jsdom": "^21.1.1",
-    "typescript": "^4.9.5",
-    "vite": "^4.1.4",
-    "vitest": "^0.29.3"
-  },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ],
-    "rules": {
-      "scope-case": [
-        0
-      ],
-      "body-max-line-length": [
-        0
-      ]
-    }
-  },
   "dependencies": {
     "@testing-library/cypress": "^9.0.0",
     "@testing-library/jest-dom": "^5.16.5",
@@ -53,5 +47,23 @@
     "@types/segment-analytics": "^0.0.34",
     "eslint-plugin-testing-library": "^5.10.2",
     "msw": "^0.27.2"
+  },
+  "devDependencies": {
+    "@vitest/coverage-c8": "^0.29.2",
+    "eslint": "^8.49.0",
+    "eslint-config-leaflink": "^1.17.0",
+    "jsdom": "^21.1.1",
+    "postcss-html": "^1.5.0",
+    "stylelint": "^15.10.3",
+    "stylelint-config-standard-scss": "^10.0.0",
+    "stylelint-config-standard-vue": "^1.0.0",
+    "typescript": "^4.9.5",
+    "vite": "^4.1.4",
+    "vitest": "^0.29.3"
+  },
+  "eslintConfig": {
+    "extends": [
+      "leaflink"
+    ]
   }
 }