@augment-vir/assert 30.0.0

package/dist/guard-types/wait-until-function.js

@@ -0,0 +1,95 @@
+import { ensureError, ensureErrorAndPrependMessage, wait, } from '@augment-vir/core';
+import { convertDuration, DurationUnit } from '@date-vir/duration';
+import { pickOverride } from './guard-override.js';
+export const defaultWaitUntilOptions = {
+    interval: {
+        milliseconds: 100,
+    },
+    timeout: {
+        seconds: 10,
+    },
+};
+const notSetSymbol = Symbol('not set');
+async function executeWaitUntil(assert, rawArgs, requireSynchronousResult) {
+    const { callback, extraAssertionArgs, failureMessage, options } = parseWaitUntilArgs(rawArgs);
+    const timeout = convertDuration(options.timeout, DurationUnit.Milliseconds).milliseconds;
+    const interval = convertDuration(options.interval, DurationUnit.Milliseconds);
+    let lastCallbackOutput = notSetSymbol;
+    let lastError = undefined;
+    async function checkCondition() {
+        try {
+            lastCallbackOutput = requireSynchronousResult ? callback() : await callback();
+            assert(lastCallbackOutput, ...extraAssertionArgs);
+        }
+        catch (error) {
+            lastCallbackOutput = notSetSymbol;
+            lastError = ensureError(error);
+        }
+    }
+    const startTime = Date.now();
+    while (lastCallbackOutput === notSetSymbol) {
+        await checkCondition();
+        await wait(interval);
+        if (Date.now() - startTime >= timeout) {
+            const message = failureMessage ? `${failureMessage}: ` : '';
+            const preMessage = `${message}Timeout of '${timeout}' milliseconds exceeded waiting for callback value to match expectations`;
+            throw ensureErrorAndPrependMessage(lastError, preMessage);
+        }
+    }
+    return lastCallbackOutput;
+}
+export function createWaitUntilGroup(asserts, waitUntilOverrides) {
+    const waitUntilGroup = Object.entries(asserts).reduce((accum, [name, assert,]) => {
+        accum[name] = pickOverride(waitUntilOverrides, name, () => createWaitUntil(assert));
+        return accum;
+    }, {});
+    return waitUntilGroup;
+}
+export function createWaitUntil(assert, requireSynchronousResult = false) {
+    return ((...rawArgs) => {
+        return executeWaitUntil(assert, rawArgs, requireSynchronousResult);
+    });
+}
+export function parseWaitUntilArgs(rawArgs) {
+    const args = {
+        extraAssertionArgs: [],
+        options: undefined,
+        failureMessage: undefined,
+    };
+    rawArgs.toReversed().forEach((arg) => {
+        if (args.callback) {
+            args.extraAssertionArgs.push(arg);
+        }
+        else if (typeof arg === 'function') {
+            args.callback = arg;
+        }
+        else if (typeof arg === 'string') {
+            args.failureMessage = arg;
+        }
+        else if (typeof arg === 'object') {
+            args.options = arg;
+        }
+        else if (arg === undefined) {
+            /** Skip an undefined arg. */
+            return;
+        }
+        else {
+            throw new TypeError(`Unexpected waitUntil arg: ${JSON.stringify(arg)}`);
+        }
+    });
+    if (!args.callback) {
+        throw new TypeError('Missing waitUntil callback.');
+    }
+    return {
+        callback: args.callback,
+        options: parseWaitUntilOptions(args.options),
+        extraAssertionArgs: args.extraAssertionArgs.toReversed(),
+        failureMessage: args.failureMessage,
+    };
+}
+export function parseWaitUntilOptions(rawOptions) {
+    return {
+        interval: rawOptions?.interval || defaultWaitUntilOptions.interval,
+        timeout: rawOptions?.timeout || defaultWaitUntilOptions.timeout,
+    };
+}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export * from './augments/assertion-exports.js';
+export * from './augments/assertion.error.js';
+export * from './augments/guards/assert-wrap.js';
+export * from './augments/guards/assert.js';
+export * from './augments/guards/check-wrap.js';
+export * from './augments/guards/check.js';
+export * from './augments/guards/wait-until.js';
+export * from './augments/if-equals.js';
+export type { WaitUntilOptions } from './guard-types/wait-until-function.js';

package/dist/index.js

@@ -0,0 +1,8 @@
+export * from './augments/assertion-exports.js';
+export * from './augments/assertion.error.js';
+export * from './augments/guards/assert-wrap.js';
+export * from './augments/guards/assert.js';
+export * from './augments/guards/check-wrap.js';
+export * from './augments/guards/check.js';
+export * from './augments/guards/wait-until.js';
+export * from './augments/if-equals.js';

package/dist/test-timeout.mock.d.ts

@@ -0,0 +1,3 @@
+import { RequiredAndNotNull } from '@augment-vir/core';
+import type { WaitUntilOptions } from './guard-types/wait-until-function.js';
+export declare const waitUntilTestOptions: RequiredAndNotNull<WaitUntilOptions>;

package/dist/test-timeout.mock.js

@@ -0,0 +1,8 @@
+export const waitUntilTestOptions = {
+    interval: {
+        milliseconds: 1,
+    },
+    timeout: {
+        seconds: 1,
+    },
+};

package/package.json

@@ -0,0 +1,54 @@
+{
+    "name": "@augment-vir/assert",
+    "version": "30.0.0",
+    "homepage": "https://github.com/electrovir/augment-vir",
+    "bugs": {
+        "url": "https://github.com/electrovir/augment-vir/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/electrovir/augment-vir.git"
+    },
+    "license": "(MIT or CC0 1.0)",
+    "author": {
+        "name": "electrovir",
+        "url": "https://github.com/electrovir"
+    },
+    "type": "module",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "compile": "virmator compile",
+        "docs": "virmator docs",
+        "start": "tsx src/index.ts",
+        "test": "virmator test node --no-deps",
+        "test:coverage": "npm run test coverage",
+        "test:docs": "virmator docs check",
+        "test:update": "npm test"
+    },
+    "dependencies": {
+        "@augment-vir/core": "^30.0.0",
+        "@date-vir/duration": "^6.0.0",
+        "deep-eql": "^5.0.2",
+        "expect-type": "^0.20.0",
+        "type-fest": "^4.25.0"
+    },
+    "devDependencies": {
+        "@types/deep-eql": "^4.0.2",
+        "@web/dev-server-esbuild": "^1.0.2",
+        "@web/test-runner": "^0.18.3",
+        "@web/test-runner-commands": "^0.9.0",
+        "@web/test-runner-playwright": "^0.11.0",
+        "@web/test-runner-visual-regression": "^0.9.0",
+        "c8": "^10.1.2",
+        "istanbul-smart-text-reporter": "^1.1.4",
+        "typescript": "^5.5.4"
+    },
+    "engines": {
+        "node": ">=22"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}