@leaflink/dom-testing-utils 2.3.0 → 3.0.1

package/README.md

@@ -17,7 +17,7 @@
   - [Global setup](#global-setup)
 - [Utilities](#utilities)
   - [`cleanupNoty`](#cleanupnoty)
-  - [`waitForLoadingToFinish`](#waitforloadingtofinish)
+  - [`waitForLoading`](#waitforloading)
   - [`cleanupDropdowns`](#cleanupdropdowns)
   - [`assertAndDismissNoty`](#assertanddismissnoty)
   - [`getByDescriptionTerm`](#getbydescriptionterm)
@@ -39,7 +39,7 @@ In your test files you can import utility functions.
 
 ```ts
 import {
-  waitForLoadingToFinish,
+  waitForLoading,
   cleanupDropdowns,
   assertAndDismissNoty,
   cleanupNoty,
@@ -95,17 +95,21 @@ Helper method to remove all noty alerts from the DOM.
 
 **Returns**: `void`
 
-### `waitForLoadingToFinish`
+### `waitForLoading`
 
-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.
+Utility that waits for all loading elements to be removed from the DOM. The `data-test` argument 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. |
+| timeout | number | 2000 | How long to wait for loading elements to be removed |
+| failIfNull | boolean | false | Throws an error if no loading elements are found |
 
-**Returns**: `Promise<boolean>`
+**Returns**: `Promise<void>`
 
-Will resolve or throw if the loaders stay in the DOM.
+Will resolve if the loaders get removed before the timeout. Otherwise, will throw an error if the loaders are still in the DOM by the end of the timeout.
+
+Setting `failIfNull` to `true` will cause an error to be thrown if no loading spinners are initially found in the DOM.
 
 ### `cleanupDropdowns`
 

package/dist/index.d.ts

@@ -10,4 +10,4 @@ export { default as hasText } from './utils/hasText.js';
 export { default as isHTMLElement } from './utils/isHTMLElement.js';
 export { default as createMockApiUtils, RestMethod } from './utils/mockEndpoints.js';
 export { default as mockEndpoints } from './utils/mockEndpoints.js';
-export { default as waitForLoadingToFinish } from './utils/waitForLoadingToFinish.js';
+export { default as waitForLoading } from './utils/waitForLoading.js';

package/dist/index.js

@@ -10,5 +10,5 @@ export { default as hasText } from './utils/hasText.js';
 export { default as isHTMLElement } from './utils/isHTMLElement.js';
 export { default as createMockApiUtils } from './utils/mockEndpoints.js';
 export { default as mockEndpoints } from './utils/mockEndpoints.js';
-export { default as waitForLoadingToFinish } from './utils/waitForLoadingToFinish.js';
+export { default as waitForLoading } from './utils/waitForLoading.js';
 //# 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,OAAO,IAAI,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAClF,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AACtF,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AACxF,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAClF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAc,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,mCAAmC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAClF,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AACtF,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AACxF,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAClF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAc,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/utils/createFixtureGenerator.js.map

@@ -1 +1 @@
-{"version":3,"file":"createFixtureGenerator.js","sourceRoot":"src/","sources":["utils/createFixtureGenerator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAI,SAAwC;IAKxF,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"}
+{"version":3,"file":"createFixtureGenerator.js","sourceRoot":"src/","sources":["utils/createFixtureGenerator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAI,SAAwC;IAKxF,SAAS,UAAU,CAAC,MAA2B,CAAC,EAAE,SAAS,GAAG,EAAE;QAC9D,+DAA+D;QAC/D,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;aAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;YACrB,wGAAwG;YACxG,OAAO,SAAS,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC;aAAM,CAAC;YACN,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;QACvE,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/utils/waitForLoading.d.ts

@@ -0,0 +1,16 @@
+export interface WaitForLoadingArgs {
+    /**
+     * The value of the `data-test-id` attribute for the loading element(s).
+     */
+    testId?: string | RegExp;
+    timeout?: number;
+    /**
+     * If true, will fail the test if no loading elements are found.
+     */
+    failIfNull?: boolean;
+}
+/**
+ * Utility to wait for one or more loading elements to be removed from the DOM.
+ */
+declare function waitForLoading({ testId, timeout, failIfNull, }?: WaitForLoadingArgs): Promise<void>;
+export default waitForLoading;

package/dist/utils/waitForLoading.js

@@ -0,0 +1,14 @@
+import { screen, waitForElementToBeRemoved } from '@testing-library/vue';
+import { nextTick } from 'vue';
+/**
+ * Utility to wait for one or more loading elements to be removed from the DOM.
+ */
+async function waitForLoading({ testId = /stash-loading|ll-loading|loading-spinner/, timeout = 2000, failIfNull = false, } = {}) {
+    await nextTick(); // wait for loading spinner(s) to be rendered
+    if (!failIfNull && screen.queryAllByTestId(testId).length > 0) {
+        return waitForElementToBeRemoved(() => [...screen.queryAllByTestId(testId)], { timeout });
+    }
+    return Promise.resolve();
+}
+export default waitForLoading;
+//# sourceMappingURL=waitForLoading.js.map

package/dist/utils/waitForLoading.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waitForLoading.js","sourceRoot":"src/","sources":["utils/waitForLoading.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC;AAgB/B;;GAEG;AACH,KAAK,UAAU,cAAc,CAAC,EAC5B,MAAM,GAAG,0CAA0C,EACnD,OAAO,GAAG,IAAI,EACd,UAAU,GAAG,KAAK,MACI,EAAE;IACxB,MAAM,QAAQ,EAAE,CAAC,CAAC,6CAA6C;IAE/D,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9D,OAAO,yBAAyB,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;AAC3B,CAAC;AAED,eAAe,cAAc,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leaflink/dom-testing-utils",
-  "version": "2.3.0",
+  "version": "3.0.1",
   "description": "Frontend DOM testing utilities",
   "engines": {
     "node": ">=16",

package/dist/utils/waitForLoadingToFinish.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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 default function waitForLoadingToFinish(textMatch?: RegExp): Promise<void>;

package/dist/utils/waitForLoadingToFinish.js

@@ -1,12 +0,0 @@
-import { screen, waitForElementToBeRemoved } from '@testing-library/vue';
-/**
- * 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 default function waitForLoadingToFinish(textMatch = /ll-loading|loading-spinner/) {
-    return waitForElementToBeRemoved(() => [...screen.queryAllByTestId(textMatch)], { timeout: 2000 });
-}
-//# sourceMappingURL=waitForLoadingToFinish.js.map

package/dist/utils/waitForLoadingToFinish.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"waitForLoadingToFinish.js","sourceRoot":"src/","sources":["utils/waitForLoadingToFinish.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAEzE;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,SAAS,GAAG,4BAA4B;IACrF,OAAO,yBAAyB,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;AACrG,CAAC"}