@augment-vir/test 31.54.1 → 31.54.3

package/dist/augments/test-web.d.ts

@@ -1,5 +1,5 @@
 import { RuntimeEnvError } from '@augment-vir/core';
-import { elementCases } from '../test-web/element-cases.js';
+export { type ElementCasesOptions, type ElementTestCase, type ElementTestCaseExpect, } from '../test-web/element-cases.js';
 declare function importWebTestApi(this: void): Promise<RuntimeEnvError | {
     /**
      * Cleans up all rendered test HTML by removing the actual wrapper nodes. Common use case is
@@ -46,7 +46,7 @@ declare function importWebTestApi(this: void): Promise<RuntimeEnvError | {
      */
     typeText: typeof import("../test-web/type-into-element").typeString;
     /** Create multiple test cases for element testing. */
-    elementCases: typeof elementCases;
+    elementCases: typeof import("../test-web/element-cases.js").elementCases;
 }>;
 /**
  * A suite of web test helpers. This is only accessible within a browser runtime. If accessed
@@ -57,4 +57,3 @@ declare function importWebTestApi(this: void): Promise<RuntimeEnvError | {
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
 export declare const testWeb: Exclude<Awaited<ReturnType<typeof importWebTestApi>>, Error>;
-export {};

package/dist/augments/test-web.js

@@ -1,5 +1,4 @@
 import { isRuntimeEnv, RuntimeEnv, RuntimeEnvError } from '@augment-vir/core';
-import { elementCases } from '../test-web/element-cases.js';
 async function importWebTestApi() {
     if (!isRuntimeEnv(RuntimeEnv.Web)) {
         return new RuntimeEnvError("The 'testWeb' api cannot be used outside of a browser context.");
@@ -9,6 +8,7 @@ async function importWebTestApi() {
     const { deleteAllTextInInput, typeString, typeStringIntoElement } = await import('../test-web/type-into-element');
     const { fixtureCleanup, fixture } = await import('@open-wc/testing-helpers');
     const { renderElement } = await import('../test-web/render-element');
+    const { elementCases } = await import('../test-web/element-cases.js');
     return {
         /**
          * Cleans up all rendered test HTML by removing the actual wrapper nodes. Common use case is

package/dist/test-web/element-cases.d.ts

@@ -1,11 +1,26 @@
 import { type MaybePromise, type PartialWithUndefined } from '@augment-vir/common';
+import { type AnyDuration } from '@date-vir/duration';
 import { type DeclarativeElementDefinition, type DefinedTypedEvent, type TypedEvent } from 'element-vir';
 import { type EmptyObject, type IsAny } from 'type-fest';
 import { type UniversalTestContext } from '../augments/universal-testing-suite/universal-test-context.js';
+/**
+ * Expectations for `testWeb.elementCases`.
+ *
+ * @category Test : Util
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
 export type ElementTestCaseExpect = {
     text: string | string[];
     events: Map<TypedEvent | DefinedTypedEvent<any, any>, unknown[]>;
 };
+/**
+ * Individual test case for `testWeb.elementCases`.
+ *
+ * @category Test : Util
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
 export type ElementTestCase<Definition extends Readonly<DeclarativeElementDefinition>> = {
     it: string;
 } & (IsAny<Definition> extends true ? {
@@ -20,4 +35,19 @@ export type ElementTestCase<Definition extends Readonly<DeclarativeElementDefini
     only: boolean;
     skip: boolean;
 }>;
-export declare function elementCases<const Definition extends Readonly<DeclarativeElementDefinition>>(elementDefinition: Readonly<Definition>, testCases: ReadonlyArray<Readonly<ElementTestCase<Definition>>>): void;
+/**
+ * Options for `testWeb.elementCases`.
+ *
+ * @category Test : Util
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
+export type ElementCasesOptions = {
+    /**
+     * The timeout for checking an element case's expectations.
+     *
+     * @default {seconds: 10}
+     */
+    timeout: AnyDuration;
+};
+export declare function elementCases<const Definition extends Readonly<DeclarativeElementDefinition>>(elementDefinition: Readonly<Definition>, testCases: ReadonlyArray<Readonly<ElementTestCase<Definition>>>, options?: Readonly<PartialWithUndefined<ElementCasesOptions>>): void;

package/dist/test-web/element-cases.js

@@ -1,9 +1,8 @@
-import { assert, waitUntil } from '@augment-vir/assert';
-import { ensureArray } from '@augment-vir/common';
+import { assert, check, waitUntil } from '@augment-vir/assert';
 import { itCasesWithContext, } from '../augments/universal-testing-suite/it-cases-with-context.js';
 import { renderElement } from './render-element.js';
 import { extractElementText } from './symlinked/element-text.js';
-export function elementCases(elementDefinition, testCases) {
+export function elementCases(elementDefinition, testCases, options = {}) {
     itCasesWithContext(testRenderElement, () => {
         /** All assertions are done in the test callback. */
     }, testCases.map((testCase) => {
@@ -12,12 +11,13 @@ export function elementCases(elementDefinition, testCases) {
             inputs: [
                 elementDefinition,
                 testCase,
+                options,
             ],
             throws: undefined,
         };
     }));
 }
-async function testRenderElement(testContext, elementDefinition, testCase) {
+async function testRenderElement(testContext, elementDefinition, testCase, options) {
     const eventKeys = Array.from(testCase.expect?.events?.keys() || []);
     const events = new Map(eventKeys.map((key) => {
         return [
@@ -35,8 +35,10 @@ async function testRenderElement(testContext, elementDefinition, testCase) {
     await testCase.act?.(instance);
     await waitUntil.isTrue(() => {
         const text = extractElementText(instance);
-        if (testCase.expect?.text) {
-            assert.hasValues(text, ensureArray(testCase.expect.text));
+        if (check.isArray(testCase.expect?.text)) {
+            assert.hasValues(text, testCase.expect.text);
+        }
+        else if (check.isString(testCase.expect?.text)) {
             assert.hasValue(text, testCase.expect.text);
         }
         if (testCase.expect?.events) {
@@ -51,8 +53,8 @@ async function testRenderElement(testContext, elementDefinition, testCase) {
         interval: {
             milliseconds: 100,
         },
-        timeout: {
-            minutes: 1,
+        timeout: options.timeout || {
+            seconds: 10,
         },
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/test",
-    "version": "31.54.1",
+    "version": "31.54.3",
     "description": "A universal testing suite that works with Mocha style test runners _and_ Node.js's built-in test runner.",
     "keywords": [
         "test",
@@ -44,8 +44,9 @@
         "test:web": "virmator test --no-deps web 'src/test-web/**/*.test.ts' 'src/augments/universal-testing-suite/**/*.test.ts'"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.54.1",
-        "@augment-vir/common": "^31.54.1",
+        "@augment-vir/assert": "^31.54.3",
+        "@augment-vir/common": "^31.54.3",
+        "@date-vir/duration": "^8.0.0",
         "@open-wc/testing-helpers": "^3.0.1",
         "@virmator/test": "^14.3.0",
         "type-fest": "^5.2.0"