@genesislcap/foundation-testing 14.68.2 → 14.68.3-alpha-43b6152.0

package/dist/dts/utils/index.d.ts

@@ -1,4 +1,5 @@
 export * from './logger';
 export * from './harness';
+export * from './promise';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/dts/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC"}

package/dist/dts/utils/promise.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Delayed resolve utility.
+ *
+ * @example
+ * ```ts
+ * test('delayed resolve', async () => {
+ *   const mockAPI = delayedResolve({ foo: 'bar' }, 2_000);
+ *   const result = await mockAPI();
+ * });
+ * ```
+ * @param result - The result of the promise.
+ * @param duration - An optional duration in milliseconds. Defaults to 500.
+ * @public
+ */
+export declare const delayedResolve: (result: unknown, duration?: number) => () => Promise<unknown>;
+//# sourceMappingURL=promise.d.ts.map

package/dist/dts/utils/promise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise.d.ts","sourceRoot":"","sources":["../../../src/utils/promise.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc,WAChB,OAAO,aAAY,MAAM,2BAMjC,CAAC"}

package/dist/dts/uvu/uvu.d.ts

@@ -1,8 +1,39 @@
 import { suite, test, uvu } from 'uvu';
 import * as assert from 'uvu/assert';
+/**
+ * Timeout utility.
+ *
+ * @example A promise that never ends.
+ * ```ts
+ * test(
+ *   'should fail',
+ *   timeout(async () => {
+ *     await new Promise(() => {});
+ *     assert.ok(true);
+ *   }, 5_000),
+ * );
+ * ```
+ *
+ * @example A slow API.
+ * ```ts
+ * test(
+ *   'should fail',
+ *   timeout(async () => {
+ *     const slowMockAPI = delayedResolve({ foo: 'bar' }, 4_000);
+ *     await slowMockAPI();
+ *     assert.unreachable('should have timed out');
+ *   }, 2_000),
+ * );
+ * ```
+ *
+ * @param callback - The async test function.
+ * @param duration - An optional duration in milliseconds. Defaults to 5_000.
+ * @public
+ */
+declare const timeout: (callback: (context: any) => Promise<any>, duration?: number) => (context: any) => Promise<any>;
 /**
  * UVU assert, suite, test and uvu itself
  * @public
  */
-export { assert, suite, test, uvu };
+export { assert, suite, test, uvu, timeout };
 //# sourceMappingURL=uvu.d.ts.map

package/dist/dts/uvu/uvu.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uvu.d.ts","sourceRoot":"","sources":["../../../src/uvu/uvu.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AACvC,OAAO,KAAK,MAAM,MAAM,YAAY,CAAC;AAErC;;;GAGG;AACH,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC"}
+{"version":3,"file":"uvu.d.ts","sourceRoot":"","sources":["../../../src/uvu/uvu.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AACvC,OAAO,KAAK,MAAM,MAAM,YAAY,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,QAAA,MAAM,OAAO,uBAAwB,GAAG,KAAK,QAAQ,GAAG,CAAC,aAAY,MAAM,mCAY1E,CAAC;AAEF;;;GAGG;AACH,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC"}

package/dist/esm/utils/index.js

@@ -1,3 +1,4 @@
 export * from './logger';
 export * from './harness';
+export * from './promise';
 export * from './types';

package/dist/esm/utils/promise.js

@@ -0,0 +1,21 @@
+import { __awaiter } from "tslib";
+/**
+ * Delayed resolve utility.
+ *
+ * @example
+ * ```ts
+ * test('delayed resolve', async () => {
+ *   const mockAPI = delayedResolve({ foo: 'bar' }, 2_000);
+ *   const result = await mockAPI();
+ * });
+ * ```
+ * @param result - The result of the promise.
+ * @param duration - An optional duration in milliseconds. Defaults to 500.
+ * @public
+ */
+export const delayedResolve = (result, duration = 500) => () => __awaiter(void 0, void 0, void 0, function* () {
+    yield new Promise((resolve) => {
+        setTimeout(resolve, duration);
+    });
+    return result;
+});

package/dist/esm/uvu/uvu.js

@@ -1,7 +1,50 @@
 import { suite, test } from 'uvu';
 import * as assert from 'uvu/assert';
+/**
+ * Timeout utility.
+ *
+ * @example A promise that never ends.
+ * ```ts
+ * test(
+ *   'should fail',
+ *   timeout(async () => {
+ *     await new Promise(() => {});
+ *     assert.ok(true);
+ *   }, 5_000),
+ * );
+ * ```
+ *
+ * @example A slow API.
+ * ```ts
+ * test(
+ *   'should fail',
+ *   timeout(async () => {
+ *     const slowMockAPI = delayedResolve({ foo: 'bar' }, 4_000);
+ *     await slowMockAPI();
+ *     assert.unreachable('should have timed out');
+ *   }, 2_000),
+ * );
+ * ```
+ *
+ * @param callback - The async test function.
+ * @param duration - An optional duration in milliseconds. Defaults to 5_000.
+ * @public
+ */
+const timeout = (callback, duration = 5000) => {
+    return (context) => {
+        let timer;
+        return Promise.race([
+            callback(context),
+            new Promise((resolve, reject) => {
+                timer = setTimeout(() => reject(new Error('timed out')), duration);
+            }),
+        ]).finally(() => {
+            clearTimeout(timer);
+        });
+    };
+};
 /**
  * UVU assert, suite, test and uvu itself
  * @public
  */
-export { assert, suite, test };
+export { assert, suite, test, timeout };