ts-data-forge 14.5.0 → 14.6.0

package/src/functional/async-result/impl/async-result-unwrap-or.mts

@@ -0,0 +1,42 @@
+import { Result } from '../../result/index.mjs';
+import { type AsyncResult } from '../async-result.mjs';
+
+/**
+ * Unwraps an `AsyncResult`, resolving to the success value or a default value
+ * if it resolves to `Err`.
+ *
+ * @example
+ *
+ * ```ts
+ * const okValue = AsyncResult.fromPromise(
+ *   Promise.resolve(10),
+ *   () => 'failed',
+ * );
+ *
+ * const errValue = AsyncResult.fromPromise(
+ *   Promise.reject(new Error('boom')),
+ *   () => 'failed',
+ * );
+ *
+ * assert.isTrue((await AsyncResult.unwrapOr(okValue, 0)) === 10);
+ *
+ * assert.isTrue((await AsyncResult.unwrapOr(errValue, 0)) === 0);
+ * ```
+ *
+ * @template S The type of the success value.
+ * @template E The type of the error value.
+ * @template D The type of the default value.
+ * @param asyncResult The `AsyncResult` to unwrap.
+ * @param defaultValue The value to resolve to if `asyncResult` resolves to
+ *   `Err`.
+ * @returns A Promise of the success value if `Ok`, otherwise of
+ *   `defaultValue`.
+ */
+export const unwrapOr = async <S, E, D>(
+  asyncResult: AsyncResult<S, E>,
+  defaultValue: D,
+): Promise<D | S> => {
+  const result = await asyncResult;
+
+  return Result.isOk(result) ? result.value : defaultValue;
+};

package/src/functional/async-result/impl/index.mts

@@ -0,0 +1,7 @@
+export * from './async-result-flat-map.mjs';
+export * from './async-result-from-promise.mjs';
+export * from './async-result-from-throwable.mjs';
+export * from './async-result-map-err.mjs';
+export * from './async-result-map.mjs';
+export * from './async-result-unwrap-or.mjs';
+export * from './types.mjs';

package/src/functional/async-result/impl/types.mts

@@ -0,0 +1,51 @@
+import { type Err, type Ok } from '../../../types.mjs';
+import { type UnknownResult } from '../../result/index.mjs';
+import { type AsyncResult } from '../async-result.mjs';
+
+/**
+ * Base type for any `AsyncResult`, used for generic constraints. Represents
+ * an `AsyncResult` with unknown success and error types.
+ */
+export type UnknownAsyncResult = AsyncResult<unknown, unknown>;
+
+/**
+ * Extracts the success value type `S` from a `Result.Ok<S>`, or from an
+ * `AsyncResult` resolving to one. Distributes over unions, so an
+ * `Ok<S> | Err<E>` union resolves to `S`.
+ *
+ * @template R The `Result` or `AsyncResult` type to unwrap.
+ */
+export type UnwrapOk<R extends UnknownAsyncResult | UnknownResult> =
+  UnwrapOkImpl<SyncResultOf<R>>;
+
+/**
+ * Extracts the error value type `E` from a `Result.Err<E>`, or from an
+ * `AsyncResult` resolving to one. Distributes over unions, so an
+ * `Ok<S> | Err<E>` union resolves to `E`.
+ *
+ * @template R The `Result` or `AsyncResult` type to unwrap.
+ */
+export type UnwrapErr<R extends UnknownAsyncResult | UnknownResult> =
+  UnwrapErrImpl<SyncResultOf<R>>;
+
+/**
+ * @template R The `Result` or `AsyncResult` type.
+ * @internal
+ * Resolves an `AsyncResult` to its `Result`, leaving a plain `Result`
+ * unchanged. Distributive.
+ */
+type SyncResultOf<R> = R extends Promise<infer P> ? P : R;
+
+/**
+ * @template R The `Result` type to unwrap.
+ * @internal
+ * Distributive extraction of the `Ok` value type.
+ */
+type UnwrapOkImpl<R> = R extends Ok<infer S> ? S : never;
+
+/**
+ * @template R The `Result` type to unwrap.
+ * @internal
+ * Distributive extraction of the `Err` value type.
+ */
+type UnwrapErrImpl<R> = R extends Err<infer E> ? E : never;

package/src/functional/async-result/index.mts

@@ -0,0 +1 @@
+export * from './async-result.mjs';

package/src/functional/async-result.test.mts

@@ -0,0 +1,290 @@
+import { isError } from '@sindresorhus/is';
+import { AsyncResult as AsyncResultFromEntryPoint } from '../entry-point.mjs';
+import { expectType } from '../expect-type.mjs';
+import { AsyncResult } from './async-result/index.mjs';
+import { Result } from './result/index.mjs';
+
+// Fixtures are created through functions so that the success/error types stay
+// unions instead of being narrowed to literal types by const inference.
+const okFixture = (value: number): AsyncResult<number, string> =>
+  Promise.resolve(Result.ok(value));
+
+const errFixture = (message: string): AsyncResult<number, string> =>
+  Promise.resolve(Result.err(message));
+
+describe('AsyncResult test', () => {
+  describe('fromPromise', () => {
+    test('resolved promise becomes Ok', async () => {
+      const result = await AsyncResult.fromPromise(
+        Promise.resolve(42),
+        (error) => `mapped: ${String(error)}`,
+      );
+
+      assert.isTrue(Result.isOk(result));
+
+      assert.deepStrictEqual(result, Result.ok(42));
+    });
+
+    test('rejected promise becomes Err with mapError applied', async () => {
+      const result = await AsyncResult.fromPromise(
+        Promise.reject(new Error('boom')),
+        (error) => (isError(error) ? error.message : 'unknown'),
+      );
+
+      assert.isTrue(Result.isErr(result));
+
+      assert.deepStrictEqual(result, Result.err('boom'));
+    });
+
+    test('resolved promise becomes Ok when mapError is omitted', async () => {
+      const result = await AsyncResult.fromPromise(Promise.resolve(42));
+
+      assert.deepStrictEqual(result, Result.ok(42));
+
+      expectType<typeof result, Result<number, unknown>>('=');
+    });
+
+    test('rejection reason is carried as-is when mapError is omitted', async () => {
+      const error = new Error('boom');
+
+      const result = await AsyncResult.fromPromise(
+        Promise.reject(error).then(() => 42),
+      );
+
+      assert.isTrue(Result.isErr(result));
+
+      assert.deepStrictEqual(result, Result.err(error));
+    });
+  });
+
+  describe('fromThrowable', () => {
+    test('resolved async function becomes Ok', async () => {
+      const result = await AsyncResult.fromThrowable(
+        () => Promise.resolve('data'),
+        (error) => `mapped: ${String(error)}`,
+      );
+
+      assert.isTrue(Result.isOk(result));
+
+      assert.deepStrictEqual(result, Result.ok('data'));
+    });
+
+    test('synchronous throw becomes Err with mapError applied', async () => {
+      const result = await AsyncResult.fromThrowable(
+        (): Promise<number> => {
+          throw new Error('sync failure');
+        },
+        (error) => (isError(error) ? error.message : 'unknown'),
+      );
+
+      assert.isTrue(Result.isErr(result));
+
+      assert.deepStrictEqual(result, Result.err('sync failure'));
+    });
+
+    test('async rejection becomes Err with mapError applied', async () => {
+      const result = await AsyncResult.fromThrowable(
+        () => Promise.reject(new Error('async failure')),
+        (error) => (isError(error) ? error.message : 'unknown'),
+      );
+
+      assert.isTrue(Result.isErr(result));
+
+      assert.deepStrictEqual(result, Result.err('async failure'));
+    });
+
+    test('synchronous throw is carried as-is when mapError is omitted', async () => {
+      const error = new Error('sync failure');
+
+      const result = await AsyncResult.fromThrowable((): Promise<number> => {
+        throw error;
+      });
+
+      assert.deepStrictEqual(result, Result.err(error));
+
+      expectType<typeof result, Result<number, unknown>>('=');
+    });
+
+    test('async rejection is carried as-is when mapError is omitted', async () => {
+      const error = new Error('async failure');
+
+      const result = await AsyncResult.fromThrowable(() =>
+        Promise.reject(error).then(() => 42),
+      );
+
+      assert.deepStrictEqual(result, Result.err(error));
+    });
+  });
+
+  describe('map', () => {
+    test('maps Ok value with a synchronous function', async () => {
+      const result = await AsyncResult.map(okFixture(5), (value) => value * 2);
+
+      assert.deepStrictEqual(result, Result.ok(10));
+    });
+
+    test('maps Ok value with an asynchronous function', async () => {
+      const result = await AsyncResult.map(okFixture(5), (value) =>
+        Promise.resolve(value * 3),
+      );
+
+      assert.deepStrictEqual(result, Result.ok(15));
+    });
+
+    test('passes Err through unchanged', async () => {
+      let mut_called = false;
+
+      const result = await AsyncResult.map(errFixture('failure'), (value) => {
+        mut_called = true;
+
+        return value * 2;
+      });
+
+      assert.deepStrictEqual(result, Result.err('failure'));
+
+      assert.isFalse(mut_called);
+    });
+
+    test('curried version maps Ok value', async () => {
+      const double = AsyncResult.map((value: number) => value * 2);
+
+      const result = await double(okFixture(21));
+
+      assert.deepStrictEqual(result, Result.ok(42));
+    });
+
+    test('curried version passes Err through unchanged', async () => {
+      const double = AsyncResult.map((value: number) => value * 2);
+
+      const result = await double(errFixture('failure'));
+
+      assert.deepStrictEqual(result, Result.err('failure'));
+    });
+  });
+
+  describe('mapErr', () => {
+    test('maps Err value with a synchronous function', async () => {
+      const result = await AsyncResult.mapErr(errFixture('failure'), (error) =>
+        error.toUpperCase(),
+      );
+
+      assert.deepStrictEqual(result, Result.err('FAILURE'));
+    });
+
+    test('maps Err value with an asynchronous function', async () => {
+      const result = await AsyncResult.mapErr(
+        errFixture('failure'),
+        (message) => Promise.resolve(message.length),
+      );
+
+      assert.deepStrictEqual(result, Result.err(7));
+    });
+
+    test('passes Ok through unchanged', async () => {
+      let mut_called = false;
+
+      const result = await AsyncResult.mapErr(okFixture(1), (error) => {
+        mut_called = true;
+
+        return error.toUpperCase();
+      });
+
+      assert.deepStrictEqual(result, Result.ok(1));
+
+      assert.isFalse(mut_called);
+    });
+
+    test('curried version maps Err value', async () => {
+      const upper = AsyncResult.mapErr((error: string) => error.toUpperCase());
+
+      const result = await upper(errFixture('failure'));
+
+      assert.deepStrictEqual(result, Result.err('FAILURE'));
+    });
+  });
+
+  describe('flatMap', () => {
+    test('chains with a function returning a Result', async () => {
+      const result = await AsyncResult.flatMap(okFixture(4), (value) =>
+        value > 0 ? Result.ok(value * 10) : Result.err('non-positive'),
+      );
+
+      assert.deepStrictEqual(result, Result.ok(40));
+    });
+
+    test('chains with a function returning an AsyncResult', async () => {
+      const result = await AsyncResult.flatMap(okFixture(4), (value) =>
+        AsyncResult.fromPromise(Promise.resolve(value + 1), () => 'failed'),
+      );
+
+      assert.deepStrictEqual(result, Result.ok(5));
+    });
+
+    test('chains into Err returned by the function', async () => {
+      const result = await AsyncResult.flatMap(
+        okFixture(-1),
+        (value): Result<number, string> =>
+          value > 0 ? Result.ok(value * 10) : Result.err('non-positive'),
+      );
+
+      assert.deepStrictEqual(result, Result.err('non-positive'));
+    });
+
+    test('short-circuits on Err without calling the function', async () => {
+      let mut_called = false;
+
+      const result = await AsyncResult.flatMap(
+        errFixture('failure'),
+        (value) => {
+          mut_called = true;
+
+          return Result.ok(value * 2);
+        },
+      );
+
+      assert.deepStrictEqual(result, Result.err('failure'));
+
+      assert.isFalse(mut_called);
+    });
+
+    test('curried version chains with a function returning a Result', async () => {
+      const validate = AsyncResult.flatMap(
+        (value: number): Result<number, string> =>
+          value > 0 ? Result.ok(value) : Result.err('non-positive'),
+      );
+
+      const passed = await validate(okFixture(7));
+
+      const failed = await validate(okFixture(-7));
+
+      assert.deepStrictEqual(passed, Result.ok(7));
+
+      assert.deepStrictEqual(failed, Result.err('non-positive'));
+    });
+  });
+
+  describe('unwrapOr', () => {
+    test('returns the success value for Ok', async () => {
+      const value = await AsyncResult.unwrapOr(okFixture(10), 0);
+
+      expect(value).toBe(10);
+    });
+
+    test('returns the default value for Err', async () => {
+      const value = await AsyncResult.unwrapOr(errFixture('failure'), 0);
+
+      expect(value).toBe(0);
+    });
+  });
+
+  describe('entry point', () => {
+    test('AsyncResult is exported from the package entry point', async () => {
+      const result = await AsyncResultFromEntryPoint.fromPromise(
+        Promise.resolve(1),
+        () => 'failed',
+      );
+
+      assert.deepStrictEqual(result, Result.ok(1));
+    });
+  });
+});

package/src/functional/index.mts

@@ -1,3 +1,4 @@
+export * from './async-result/index.mjs';
 export * from './match.mjs';
 export * from './optional/index.mjs';
 export * from './pipe.mjs';

package/src/functional/result/impl/result-from-promise.mts

@@ -17,6 +17,11 @@ type UnwrapPromise<P extends Promise<unknown>> =
  * input Promise rejects, the `Result` will be `Err` with the rejection
  * reason.
  *
+ * The error channel is `unknown`, since the rejection reason is carried
+ * through untouched. For a concrete error type, use `AsyncResult.fromPromise`
+ * with a `mapError` function; called without one it behaves exactly as this
+ * function does.
+ *
  * @example
  *
  * ```ts