@leaflink/dom-testing-utils 0.0.0-PR-14--3ff9079

package/README.md

@@ -0,0 +1,219 @@
+# @leaflink/dom-testing-utils
+
+> Leaflink repository to manage test utilities to be shared across front-end applications.
+
+[![version](https://img.shields.io/npm/v/@leaflink/dom-testing-utils.svg)](http://npm.im/@leaflink/dom-testing-utils)
+[![downloads](https://img.shields.io/npm/dm/@leaflink/dom-testing-utils.svg)](http://npm-stat.com/charts.html?package=@leaflink/dom-testing-utils&from=2015-08-01)
+[![MIT License](https://img.shields.io/npm/l/@leaflink/dom-testing-utils.svg)](http://opensource.org/licenses/MIT)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Global setup](#global-setup)
+  - [Setup file](#setup-file)
+  - [`cleanupNoty`](#cleanupnoty)
+  - [`waitForLoadingToFinish`](#waitforloadingtofinish)
+  - [`cleanupDropdowns`](#cleanupdropdowns)
+  - [`assertAndDismissNoty`](#assertanddismissnoty)
+  - [`createFixtureGenerator`](#createfixturegenerator)
+  - [Mocking API Endpoints](#mocking-api-endpoints)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Installation
+
+```sh
+npm install --save-dev @leaflink/dom-testing-utils
+```
+
+## Usage
+
+In your `*.spec.(ts|js)` files you can import utility functions.
+
+```ts
+import {
+  waitForLoadingToFinish,
+  cleanupDropdowns,
+  assertAndDismissNoty,
+  cleanupNoty,
+  createFixtureGenerator,
+} from '@leaflink/dom-testing-utils';
+
+it('...', () => {
+  cleanupNoty();
+});
+```
+
+There's also shared setup files you can extend from.
+
+### Global setup
+
+Add the following line to your `vite.config.js`:
+
+```js
+globalSetup: 'node_modules/@leaflink/dom-testing-utils/dist/global-setup.js',
+```
+
+This will run once *before everything*. See <https://vitest.dev/config/#globalsetup>.
+
+### Setup file
+
+Add the following line to your `vite.config.js`:
+
+```js
+setupFiles: ['node_modules/@leaflink/dom-testing-utils/dist/setup-env.js'],
+```
+
+This will be run once before *each* test file. See <https://vitest.dev/config/#setupfiles>.
+
+### `cleanupNoty`
+
+Helper method to remove all noty alerts from the DOM.
+
+**Parameters**: None
+
+**Returns**: `void`
+
+### `waitForLoadingToFinish`
+
+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 `testId` is not specified.
+
+| **Parameters** | **Type** | **Default** | **Summary** |
+| ----------- | ----------- | ----------- |----------- |
+| testId | `string` | `ll-loading` && `loading-spinner` |The data test ID to target. |
+
+**Returns**: `Promise<boolean>`
+
+Will resolve or throw if the loaders stay in the DOM.
+
+### `cleanupDropdowns`
+
+Helper method to remove all floating Stash Dropdown elements from the DOM.
+
+**Parameters**: None
+
+**Returns**: `void`
+
+### `assertAndDismissNoty`
+
+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.
+
+| **Parameters** | **Type** | **Default** | **Summary** |
+| ----------- | ----------- | ----------- |----------- |
+| text | `string` | *Required* | Expected notification text. |
+
+**Returns**: `void`
+
+### `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.
+
+| **Parameters** | **Type** | **Default** | **Summary** |
+| ----------- | ----------- | ----------- |----------- |
+| `fixtureFn` | `function` | *Required* | Method that generates and returns a single data object. |
+
+**Returns**
+
+```ts
+(num?, overrides?) => Array<{[key: string]: any}> | {[key: string]: any}
+// OR
+(overrides?) => {[key: string]: any}
+```
+
+A new generator function that accepts a number & overrides where:
+
+- `num` = The number of fake data objects to generate. Defaults to 1
+- `overrides` = Specific attributes you want to override in each data fixture object.
+
+When calling the returned function, you'll get an array OR object of fixture data (It will be a ** single object** if `num = 1`).
+
+**Examples**
+
+Quick example:
+
+```ts
+const generateInvoice = (overrides) => ({ id: uuid(), balance: 15799, classification: "Adult Use", ...overrides});
+const generateInvoices = createFixtureGenerator(generateInvoice);
+
+generateInvoices()
+// => Single invoice object
+
+generateInvoices(1)
+// => Single invoice object
+
+generateInvoices(1, { foo: 'bar' })
+// => Single invoice object, override `foo` to equal `'bar'`
+
+generateInvoices({ foo: 'bar' })
+// => Single invoice object, override `foo` to equal `'bar'`
+
+generateInvoices(10)
+// => Array of 10 invoice objects
+
+generateInvoices(10, { foo: 'bar' })
+// => Array of 10 invoice objects, override `foo` to equal `'bar'` in each
+```
+
+Full example:
+
+```ts
+// tests/fixtures/products.ts
+import { faker } from '@faker-js/faker';
+import { createFixtureGenerator } from '@leaflink/dom-testing-utils';
+
+export const generateProduct = (overrides = {}) => ({
+  sku: git.commitSha(),
+  name: faker.commerce.productName(),
+  quantity: faker.random.number(100),
+  cases: faker.random.number(10),
+  ...overrides,
+});
+
+export default createFixtureGenerator(generateProduct);
+
+// services/api/products.ts
+import generateProducts from '@/tests/fixtures/products';
+
+// ...
+const mockProducts = generateProducts(10, { cases: 25 })
+// ...
+```
+
+### Mocking API Endpoints
+
+In order to mock API endpoints that your tests interact with, you can get a set of mocking functions from `createMockApiUtils`.
+
+```ts
+import { createMockApiUtils } from '@leaflink/dom-testing-utils';
+import yourServer from './server.ts';
+
+const {
+  mockGetData,
+  mockGetEndpoint,
+  mockPatchData,
+  // etc.
+} = createMockApiUtils(yourServer);
+```
+
+There are two flavors of mocking utility functions:
+1. mock{VERB}Data - mocks response with a singular data object
+2. mock{VERB}Endpoint - mocks a response endpoint with a function like msw's [Response Resolver](https://mswjs.io/docs/getting-started/mocks/rest-api#response-resolver)
+
+To mock an endpoint with simple return data
+```ts
+  mockGetData('/relative-url', myMockObj);
+```
+or you can customize the response
+```ts
+  mockGetEndpoint('/relative-url', (req, res, ctx) => {
+    if (someConditional()) {
+      res(ctx.json(true));
+    } else {
+      res(ctx.json(false));
+    }
+  });
+```

package/dist/api/index.d.ts

@@ -0,0 +1 @@
+export * from './mockEndpoints';

package/dist/api/index.js

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

package/dist/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["api/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC"}

package/dist/api/mockEndpoints.d.ts

@@ -0,0 +1,17 @@
+import { DefaultRequestBody, RequestParams, ResponseResolver, rest, RestContext, RestRequest } from 'msw';
+import { SetupServerApi } from 'msw/node';
+export type RestMethod = keyof typeof rest;
+export declare const createMockApiUtils: (server: SetupServerApi) => {
+    mockEndpointData: <ResponseBody extends DefaultRequestBody = any>(relativeUrl: string, responseData: ResponseBody, method: RestMethod) => void;
+    mockEndpoint: <RequestBodyType extends DefaultRequestBody = DefaultRequestBody, ResponseBody_1 extends DefaultRequestBody = any, Params extends RequestParams = RequestParams>(relativeUrl: string, responseCallback: ResponseResolver<RestRequest<RequestBodyType, Params>, RestContext, ResponseBody_1>, method: RestMethod) => void;
+    mockGetData: <ResponseBody_2 extends DefaultRequestBody = any>(relativeUrl: string, responseData: ResponseBody_2) => void;
+    mockPostData: <ResponseBody_2 extends DefaultRequestBody = any>(relativeUrl: string, responseData: ResponseBody_2) => void;
+    mockPutData: <ResponseBody_2 extends DefaultRequestBody = any>(relativeUrl: string, responseData: ResponseBody_2) => void;
+    mockDeleteData: <ResponseBody_2 extends DefaultRequestBody = any>(relativeUrl: string, responseData: ResponseBody_2) => void;
+    mockPatchData: <ResponseBody_2 extends DefaultRequestBody = any>(relativeUrl: string, responseData: ResponseBody_2) => void;
+    mockGetEndpoint: <RequestBodyType_1 extends DefaultRequestBody = DefaultRequestBody, ResponseBody_3 extends DefaultRequestBody = any, Params_1 extends RequestParams = RequestParams>(relativeUrl: string, responseCallback: ResponseResolver<RestRequest<RequestBodyType_1, Params_1>, RestContext, ResponseBody_3>) => void;
+    mockPostEndpoint: <RequestBodyType_1 extends DefaultRequestBody = DefaultRequestBody, ResponseBody_3 extends DefaultRequestBody = any, Params_1 extends RequestParams = RequestParams>(relativeUrl: string, responseCallback: ResponseResolver<RestRequest<RequestBodyType_1, Params_1>, RestContext, ResponseBody_3>) => void;
+    mockPutEndpoint: <RequestBodyType_1 extends DefaultRequestBody = DefaultRequestBody, ResponseBody_3 extends DefaultRequestBody = any, Params_1 extends RequestParams = RequestParams>(relativeUrl: string, responseCallback: ResponseResolver<RestRequest<RequestBodyType_1, Params_1>, RestContext, ResponseBody_3>) => void;
+    mockDeleteEndpoint: <RequestBodyType_1 extends DefaultRequestBody = DefaultRequestBody, ResponseBody_3 extends DefaultRequestBody = any, Params_1 extends RequestParams = RequestParams>(relativeUrl: string, responseCallback: ResponseResolver<RestRequest<RequestBodyType_1, Params_1>, RestContext, ResponseBody_3>) => void;
+    mockPatchEndpoint: <RequestBodyType_1 extends DefaultRequestBody = DefaultRequestBody, ResponseBody_3 extends DefaultRequestBody = any, Params_1 extends RequestParams = RequestParams>(relativeUrl: string, responseCallback: ResponseResolver<RestRequest<RequestBodyType_1, Params_1>, RestContext, ResponseBody_3>) => void;
+};

package/dist/api/mockEndpoints.js

@@ -0,0 +1,58 @@
+import { rest, } from 'msw';
+export const createMockApiUtils = (server) => {
+    /**
+     * Mock endpoint with data
+     */
+    const mockEndpointData = (relativeUrl, responseData, method) => {
+        server.use(rest[method](relativeUrl, (_req, res, ctx) => {
+            return res(ctx.json(responseData));
+        }));
+    };
+    /**
+     * Mock endpoint with a callback function
+     */
+    const mockEndpoint = (relativeUrl, responseCallback, method) => {
+        server.use(rest[method](relativeUrl, responseCallback));
+    };
+    /**
+     * Creates a function to mock an endpoint with data for a particular HTTP verb
+     * @param method - the verb to target this endpoint for
+     */
+    const createDataHelper = (method) => (relativeUrl, responseData) => {
+        return mockEndpointData(relativeUrl, responseData, method);
+    };
+    /**
+     * Creates a function to mock an endpoint with a callback function for a particular HTTP verb
+     * @param method - the verb to target this endpoint for
+     */
+    const createEndpointHelper = (method) => (relativeUrl, responseCallback) => {
+        return mockEndpoint(relativeUrl, responseCallback, method);
+    };
+    // #region Shortcut Functions
+    const mockGetData = createDataHelper('get');
+    const mockPostData = createDataHelper('post');
+    const mockPutData = createDataHelper('put');
+    const mockDeleteData = createDataHelper('delete');
+    const mockPatchData = createDataHelper('patch');
+    const mockGetEndpoint = createEndpointHelper('get');
+    const mockPostEndpoint = createEndpointHelper('post');
+    const mockPutEndpoint = createEndpointHelper('put');
+    const mockDeleteEndpoint = createEndpointHelper('delete');
+    const mockPatchEndpoint = createEndpointHelper('patch');
+    // #endregion
+    return {
+        mockEndpointData,
+        mockEndpoint,
+        mockGetData,
+        mockPostData,
+        mockPutData,
+        mockDeleteData,
+        mockPatchData,
+        mockGetEndpoint,
+        mockPostEndpoint,
+        mockPutEndpoint,
+        mockDeleteEndpoint,
+        mockPatchEndpoint,
+    };
+};
+//# sourceMappingURL=mockEndpoints.js.map

package/dist/api/mockEndpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockEndpoints.js","sourceRoot":"src/","sources":["api/mockEndpoints.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,IAAI,GAGL,MAAM,KAAK,CAAC;AAKb,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,MAAsB,EAAE,EAAE;IAC3D;;OAEG;IACH,MAAM,gBAAgB,GAAG,CACvB,WAAmB,EACnB,YAA0B,EAC1B,MAAkB,EAClB,EAAE;QACF,MAAM,CAAC,GAAG,CACR,IAAI,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;YAC3C,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QACrC,CAAC,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,YAAY,GAAG,CAKnB,WAAmB,EACnB,gBAIC,EACD,MAAkB,EAClB,EAAE;QACF,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAC1D,CAAC,CAAC;IAEF;;;OAGG;IACH,MAAM,gBAAgB,GACpB,CAAC,MAAkB,EAAE,EAAE,CACvB,CACE,WAAmB,EACnB,YAA0B,EAC1B,EAAE;QACF,OAAO,gBAAgB,CAAC,WAAW,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC,CAAC;IAEJ;;;OAGG;IACH,MAAM,oBAAoB,GACxB,CAAC,MAAkB,EAAE,EAAE,CACvB,CAKE,WAAmB,EACnB,gBAIC,EACD,EAAE;QACF,OAAO,YAAY,CAAC,WAAW,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC,CAAC;IAEJ,6BAA6B;IAC7B,MAAM,WAAW,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC5C,MAAM,YAAY,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC9C,MAAM,WAAW,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC5C,MAAM,cAAc,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAClD,MAAM,aAAa,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAEhD,MAAM,eAAe,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACtD,MAAM,eAAe,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IAC1D,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACxD,aAAa;IAEb,OAAO;QACL,gBAAgB;QAChB,YAAY;QACZ,WAAW;QACX,YAAY;QACZ,WAAW;QACX,cAAc;QACd,aAAa;QACb,eAAe;QACf,gBAAgB;QAChB,eAAe;QACf,kBAAkB;QAClB,iBAAiB;KAClB,CAAC;AACJ,CAAC,CAAC"}

package/dist/global-setup.d.ts

@@ -0,0 +1 @@
+export default function (): void;

package/dist/global-setup.js

@@ -0,0 +1,4 @@
+export default function () {
+    process.env.TZ = 'UTC';
+}
+//# sourceMappingURL=global-setup.js.map

package/dist/global-setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-setup.js","sourceRoot":"src/","sources":["global-setup.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO;IACZ,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC;AACzB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ *
+ * @param {string} testId - The data test ID to target
+ * @returns {Promise<boolean>} - Will resolve or throw if the loaders stay in the DOM.
+ */
+export declare function waitForLoadingToFinish(textMatch?: RegExp): Promise<void>;
+/**
+ * Helper method to remove all noty alerts from the DOM.
+ *
+ * @returns void
+ */
+export declare function cleanupNoty(): void;
+export declare function cleanupDropdowns(): void;
+/**
+ * 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
+ *
+ * @param {string | RegExp} text - expected notification text
+ *
+ * @returns void
+ */
+export declare function assertAndDismissNoty(text: string): Promise<void>;
+/**
+ * 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 many of those fixtures. Fixture generator function
+ * that's returned supports passing optional `num` and `overrides` params.
+ *
+ * @example
+ *
+ *    const generateInvoice = (overrides) => ({ id: uuid(), balance: 15799, classification: "Adult Use", ...overrides});
+ *    const generateInvoices = createFixtureGenerator(generateInvoice);
+ *
+ *    generateInvoices()                    // => Single invoice object
+ *    generateInvoices(1)                   // => Single invoice object
+ *    generateInvoices(1, { foo: 'bar' })   // => Single invoice object, override `foo` to equal `'bar'`
+ *    generateInvoices({ foo: 'bar' })      // => Single invoice object, override `foo` to equal `'bar'`
+ *    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.
+ */
+export declare function createFixtureGenerator(fixtureFn: any): (num?: number | {
+    [key: string]: any;
+}, overrides?: {}) => any;
+export * from './api';

package/dist/index.js

@@ -0,0 +1,75 @@
+import { screen, waitForElementToBeRemoved } from '@testing-library/vue';
+import { default as userEvent } from '@testing-library/user-event';
+/**
+ * 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.
+ *
+ * @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/) {
+    return waitForElementToBeRemoved(() => [...screen.queryAllByTestId(textMatch)], { timeout: 2000 });
+}
+/**
+ * Helper method to remove all noty alerts from the DOM.
+ *
+ * @returns void
+ */
+export function cleanupNoty() {
+    document
+        .querySelectorAll('.noty_bar')
+        .forEach((elem) => elem.parentNode?.removeChild(elem));
+}
+export function cleanupDropdowns() {
+    document
+        .querySelectorAll('.mount-point-container')
+        .forEach((elem) => elem.parentNode?.removeChild(elem));
+}
+/**
+ * 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
+ *
+ * @param {string | RegExp} text - expected notification text
+ *
+ * @returns void
+ */
+export async function assertAndDismissNoty(text) {
+    const noty = await screen.findByText(text);
+    expect(noty).toBeInTheDocument();
+    await userEvent.click(noty);
+}
+/**
+ * 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 many of those fixtures. Fixture generator function
+ * that's returned supports passing optional `num` and `overrides` params.
+ *
+ * @example
+ *
+ *    const generateInvoice = (overrides) => ({ id: uuid(), balance: 15799, classification: "Adult Use", ...overrides});
+ *    const generateInvoices = createFixtureGenerator(generateInvoice);
+ *
+ *    generateInvoices()                    // => Single invoice object
+ *    generateInvoices(1)                   // => Single invoice object
+ *    generateInvoices(1, { foo: 'bar' })   // => Single invoice object, override `foo` to equal `'bar'`
+ *    generateInvoices({ foo: 'bar' })      // => Single invoice object, override `foo` to equal `'bar'`
+ *    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.
+ */
+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) {
+            return fixtureFn(num);
+        }
+        // Otherwise, let's generate however many requested data objects
+        return Array.apply(null, Array(num)).map(() => fixtureFn(overrides));
+    };
+}
+export * from './api';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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;AAEnE;;;;;;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,cAAc,OAAO,CAAC"}

package/dist/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.spec.js

@@ -0,0 +1,32 @@
+import { createFixtureGenerator } from "./index";
+describe('createFixtureGenerator()', () => {
+    it('returns a function that can generate an array of data objects', () => {
+        const generator = (overrides) => ({
+            foo: 'bar',
+            bar: 'baz',
+            ...overrides,
+        });
+        expect(createFixtureGenerator(generator)(5)).toEqual([
+            { foo: 'bar', bar: 'baz' },
+            { foo: 'bar', bar: 'baz' },
+            { foo: 'bar', bar: 'baz' },
+            { foo: 'bar', bar: 'baz' },
+            { foo: 'bar', bar: 'baz' },
+        ]);
+        expect(createFixtureGenerator(generator)(3, { bar: 'yak' })).toEqual([
+            { foo: 'bar', bar: 'yak' },
+            { foo: 'bar', bar: 'yak' },
+            { foo: 'bar', bar: 'yak' },
+        ]);
+    });
+    it('returns a function that can generate a single data object', () => {
+        const generator = (overrides) => ({
+            foo: 'bar',
+            bar: 'baz',
+            ...overrides,
+        });
+        expect(createFixtureGenerator(generator)()).toEqual({ foo: 'bar', bar: 'baz' });
+        expect(createFixtureGenerator(generator)({ bar: 'yak' })).toEqual({ foo: 'bar', bar: 'yak' });
+    });
+});
+//# sourceMappingURL=index.spec.js.map

package/dist/index.spec.js.map

@@ -0,0 +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"}

package/dist/setup-env.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/dist/setup-env.js

@@ -0,0 +1,43 @@
+import { vi } from 'vitest';
+import { config } from '@vue/test-utils';
+import '@testing-library/jest-dom';
+config.global.mocks['$t'] = (msg) => msg;
+const oldWindowLocation = global.window.location;
+beforeAll(() => {
+    // @ts-expect-error
+    delete global.window.location;
+    // @ts-expect-error
+    global.window.location = Object.defineProperties({}, {
+        ...Object.getOwnPropertyDescriptors(oldWindowLocation),
+        assign: {
+            configurable: true,
+            value: vi.fn(),
+        },
+        href: {
+            configurable: true,
+            writable: true,
+            value: {
+                replace: vi.fn(),
+            },
+        },
+    });
+    window.open = vi.fn();
+    vi.mock('lodash-es/debounce', () => {
+        return { default: vi.fn((fn) => fn) };
+    });
+});
+afterAll(() => {
+    global.window.location = oldWindowLocation;
+});
+const IntersectionObserverMock = vi.fn(() => ({
+    get root() {
+        return;
+    },
+    disconnect: vi.fn(),
+    observe: vi.fn(),
+    takeRecords: vi.fn(),
+    unobserve: vi.fn(),
+}));
+vi.stubGlobal('IntersectionObserver', IntersectionObserverMock);
+vi.stubGlobal('fetch', vi.fn().mockResolvedValue({ json: vi.fn().mockResolvedValue({}) }));
+//# sourceMappingURL=setup-env.js.map

package/dist/setup-env.js.map

@@ -0,0 +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"}

package/dist/setup-env.spec.js

@@ -0,0 +1,22 @@
+"use strict";
+it('should stub window open method', () => {
+    const url = 'my-url';
+    const openSpy = vi.spyOn(window, 'open');
+    expect(openSpy).not.toHaveBeenCalled();
+    window.open(url);
+    expect(openSpy).toHaveBeenCalledWith(url);
+});
+it('should stub fetch method', async () => {
+    const url = 'my-url';
+    const fetchSpy = vi.spyOn(globalThis, 'fetch');
+    expect(fetchSpy).not.toHaveBeenCalled();
+    await fetch(url);
+    expect(fetchSpy).toHaveBeenCalledWith(url);
+});
+it.each([['disconnect'], ['observe'], ['takeRecords'], ['unobserve']])('should stub intersection observer %s method', (method) => {
+    const observer = new globalThis.IntersectionObserver(() => ({}), {});
+    const methodSpy = vi.spyOn(observer, method);
+    observer[method]();
+    expect(methodSpy).toHaveBeenCalled();
+});
+//# sourceMappingURL=setup-env.spec.js.map

package/dist/setup-env.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-env.spec.js","sourceRoot":"src/","sources":["setup-env.spec.ts"],"names":[],"mappings":";AAAA,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;IACxC,MAAM,GAAG,GAAG,QAAQ,CAAC;IAErB,MAAM,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEzC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IAEvC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEjB,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;AAC5C,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;IACxC,MAAM,GAAG,GAAG,QAAQ,CAAC;IAErB,MAAM,QAAQ,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAE/C,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IAExC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;IAEjB,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;AAC7C,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CACpE,6CAA6C,EAC7C,CAAC,MAAW,EAAE,EAAE;IACd,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,oBAAoB,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAErE,MAAM,SAAS,GAAG,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAE7C,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;IAEnB,MAAM,CAAC,SAAS,CAAC,CAAC,gBAAgB,EAAE,CAAC;AACvC,CAAC,CACF,CAAC"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@leaflink/dom-testing-utils",
+  "version": "0.0.0-PR-14--3ff9079",
+  "description": "Frontend DOM testing utilities",
+  "engines": {
+    "node": ">=16",
+    "npm": ">=8"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "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",
+    "@testing-library/user-event": "^14.4.3",
+    "@testing-library/vue": "^7.0.0",
+    "@types/segment-analytics": "^0.0.34",
+    "eslint-plugin-testing-library": "^5.10.2",
+    "msw": "^0.27.2"
+  }
+}