@onrails/result 0.1.4 → 0.3.0

package/dist/railway.js

@@ -1,3 +1,10 @@
+// src/internal/dual.ts
+var dual = (arity, body) => {
+  const run = body;
+  const dispatcher = (...args) => args.length >= arity ? run(...args) : (self) => run(self, ...args);
+  return dispatcher;
+};
+
 // src/result.ts
 var ok = (value) => ({
   _tag: "Ok",
@@ -9,18 +16,18 @@ var err = (error) => ({
 });
 var isOk = (result) => result._tag === "Ok";
 var isErr = (result) => result._tag === "Err";
-var mapImpl = (result, fn) => isOk(result) ? ok(fn(result.value)) : err(result.error);
-function map(...args) {
-  if (args.length === 2) return mapImpl(args[0], args[1]);
-  const fn = args[0];
-  return (result) => mapImpl(result, fn);
-}
-var mapErrImpl = (result, fn) => isErr(result) ? err(fn(result.error)) : ok(result.value);
-function mapErr(...args) {
-  if (args.length === 2) return mapErrImpl(args[0], args[1]);
-  const fn = args[0];
-  return (result) => mapErrImpl(result, fn);
-}
+var map = dual(
+  2,
+  (result, fn) => isOk(result) ? ok(fn(result.value)) : err(result.error)
+);
+var mapErr = dual(
+  2,
+  (result, fn) => isErr(result) ? err(fn(result.error)) : ok(result.value)
+);
+var flatMap = dual(
+  2,
+  (result, fn) => isOk(result) ? fn(result.value) : err(result.error)
+);
 function trySync(fn, onThrow) {
   return (...args) => {
     try {
@@ -42,17 +49,6 @@ var UnexpectedError = class extends Error {
 };
 
 // src/async.ts
-var liftPromiseResult = async (promise, onDefect) => {
-  try {
-    const result = await promise;
-    if (isErr(result)) {
-      return result;
-    }
-    return isResultLike(result.value) ? result.value : result;
-  } catch (error) {
-    return err(onDefect(error));
-  }
-};
 var sequenceSettled = (settled) => {
   const values = [];
   for (const result of settled) {
@@ -69,9 +65,32 @@ var ResultAsync = class _ResultAsync {
   }
   run;
   promise = null;
+  /**
+   * Lifts an already-settled sync {@link Result} into a {@link ResultAsync}.
+   *
+   * @example
+   * ```ts
+   * const ra = ResultAsync.fromResult(ok(42));   // ResultAsync<number, never>
+   * ```
+   */
   static fromResult(result) {
     return new _ResultAsync(async () => result);
   }
+  /**
+   * Wraps a `PromiseLike<T>` that may reject. Rejections pass through `onReject`
+   * to become a typed `Err`; resolution becomes `Ok<T>`.
+   *
+   * @param promise - the promise to wrap
+   * @param onReject - maps a rejection reason to the `Err` channel
+   *
+   * @example
+   * ```ts
+   * const body = ResultAsync.fromPromise(
+   *   fetch(url).then((r) => r.text()),
+   *   (e): NetError => ({ kind: "net", cause: String(e) }),
+   * );
+   * ```
+   */
   static fromPromise(promise, onReject) {
     return new _ResultAsync(async () => {
       try {
@@ -81,12 +100,29 @@ var ResultAsync = class _ResultAsync {
       }
     });
   }
+  /**
+   * Wraps a `PromiseLike<T>` that is **guaranteed not to reject**, skipping the
+   * `onReject` mapper. Use only when rejection is provably impossible.
+   *
+   * @example
+   * ```ts
+   * const now = ResultAsync.fromSafePromise(Promise.resolve(Date.now()));
+   * ```
+   */
   static fromSafePromise(promise) {
     return new _ResultAsync(async () => ok(await promise));
   }
   /**
-   * Defers work until {@link resolve}. Unlike {@link fromPromise}, nothing runs
-   * until the `ResultAsync` is resolved (e.g. by `combineTuple` / `combineTupleParallel`).
+   * Defers work until {@link resolve}. Unlike {@link fromPromise}, the factory
+   * does not run until the `ResultAsync` is resolved (e.g. by `combineTuple` /
+   * `combineTupleParallel`). The factory runs at most once — `resolve` memoizes.
+   *
+   * @example
+   * ```ts
+   * const insert = ResultAsync.defer(() => db.orders.insert(row));
+   * // nothing has run yet
+   * const r = await insert;   // factory runs exactly once here
+   * ```
    */
   static defer(fn) {
     return new _ResultAsync(fn);
@@ -94,14 +130,49 @@ var ResultAsync = class _ResultAsync {
   static ok(value) {
     return new _ResultAsync(async () => ok(value));
   }
+  /**
+   * Lifts an error into an `Err` async result.
+   *
+   * @example
+   * ```ts
+   * const r = ResultAsync.err({ kind: "not_found" as const });
+   * ```
+   */
   static err(error) {
     return new _ResultAsync(async () => err(error));
   }
-  /** @see {@link fromAsync} from `@onrails/result/interop` */
+  /**
+   * Lifts an existing `Promise<Result<T, E>>` (e.g. from interop code) into a
+   * {@link ResultAsync}. A thrown defect is routed through `onDefect`,
+   * defaulting to {@link UnexpectedError}. The `Ok` value passes through
+   * verbatim — even when it happens to be Result-shaped.
+   *
+   * @param promise - a promise that already yields a `Result`
+   * @param onDefect - maps an unexpected throw to the `Err` channel
+   * @see {@link fromAsync} from `@onrails/result`
+   */
   static fromResultPromise(promise, onDefect) {
     const mapDefect = onDefect ?? ((error) => new UnexpectedError("Unexpected async defect", error));
-    return new _ResultAsync(() => liftPromiseResult(promise, mapDefect));
+    return new _ResultAsync(async () => {
+      try {
+        return await promise;
+      } catch (error) {
+        return err(mapDefect(error));
+      }
+    });
   }
+  /**
+   * Combines a homogeneous array of async results into one. Resolves
+   * **sequentially** in input order, short-circuiting on the first `Err`.
+   * For heterogeneous tuples that preserve per-index types, use
+   * {@link combineTuple}; for wall-clock overlap, {@link combineTupleParallel}.
+   *
+   * @example
+   * ```ts
+   * const all = ResultAsync.combine([loadA(), loadB(), loadC()]);
+   * // ResultAsync<Item[], LoadError>
+   * ```
+   */
   static combine(results) {
     return new _ResultAsync(async () => {
       const values = [];
@@ -115,6 +186,23 @@ var ResultAsync = class _ResultAsync {
       return ok(values);
     });
   }
+  /**
+   * Heterogeneous async tuple combine — resolves branches **sequentially**
+   * (left-to-right), returning the first `Err` in input order. Preserves each
+   * branch's `Ok` type by position, so the result destructures type-safely.
+   * This is the canonical sequential async combine (replaces the former
+   * `sequenceTupleAsync`).
+   *
+   * @example
+   * ```ts
+   * const combined = ResultAsync.combineTuple([loadCfg(), loadCatalog()] as const);
+   * // ResultAsync<readonly [Cfg, Catalog], CfgError | CatalogError>
+   * const r = await combined;
+   * if (isOk(r)) {
+   *   const [cfg, catalog] = r.value;  // typed per position
+   * }
+   * ```
+   */
   static combineTuple(results) {
     return _ResultAsync.combine(
       results
@@ -123,18 +211,55 @@ var ResultAsync = class _ResultAsync {
   /**
    * Like {@link combineTuple}, but starts every branch before awaiting (wall-clock
    * parallel for independent IO). On failure, returns the first `Err` in input order.
+   *
+   * @example
+   * ```ts
+   * // independent IO — overlap them
+   * const combined = ResultAsync.combineTupleParallel([
+   *   loadProfile(id),
+   *   loadMetrics(id),
+   * ] as const);
+   * ```
    */
   static combineTupleParallel(results) {
     return new _ResultAsync(
       async () => sequenceSettled(await Promise.all(results.map((ra) => ra.resolve())))
     );
   }
+  /**
+   * Transforms the `Ok` value, passing `Err` through unchanged.
+   *
+   * @example
+   * ```ts
+   * ResultAsync.ok(2).map((n) => n * 3);   // ResultAsync<number> → Ok 6
+   * ```
+   */
   map(fn) {
     return new _ResultAsync(async () => map(await this.resolve(), fn));
   }
+  /**
+   * Transforms the `Err` value, passing `Ok` through unchanged — useful for
+   * unifying heterogeneous failures into one app-level union.
+   *
+   * @example
+   * ```ts
+   * load(id).mapErr((e): AppError => ({ kind: "load", cause: e })); // ResultAsync<T, AppError>
+   * ```
+   */
   mapErr(fn) {
     return new _ResultAsync(async () => mapErr(await this.resolve(), fn));
   }
+  /**
+   * Canonical bind — chains a step that itself returns a `ResultAsync` or sync
+   * `Result`, short-circuiting on `Err`. Error types accumulate (`E | F`).
+   *
+   * @example
+   * ```ts
+   * authenticate(req)
+   *   .flatMap((user) => loadProfile(user.id))   // ResultAsync
+   *   .flatMap((p) => validate(p));              // sync Result also accepted
+   * ```
+   */
   flatMap(fn) {
     return new _ResultAsync(async () => {
       const first = await this.resolve();
@@ -142,25 +267,31 @@ var ResultAsync = class _ResultAsync {
         return first;
       }
       const next = fn(first.value);
-      if (next instanceof _ResultAsync) {
-        return next.resolve();
-      }
-      if (isResultLike(next)) {
-        return next;
-      }
-      return isCompatLike(next) ? next.inner : next;
+      return next instanceof _ResultAsync ? next.resolve() : next;
     });
   }
+  /**
+   * neverthrow-compat alias of {@link flatMap}. Kept as the documented compat
+   * tier; prefer {@link flatMap} in new code.
+   *
+   * @example
+   * ```ts
+   * authenticate(req).andThen((user) => loadProfile(user.id));
+   * ```
+   */
   andThen(fn) {
     return this.flatMap(fn);
   }
   /**
-   * Alias for {@link flatMap}.
-   * @deprecated Use {@link flatMap} or keep/use compat {@link andThen} instead.
+   * Error-channel bind — runs `fn` only on `Err`, swapping in a recovery
+   * `ResultAsync` or sync `Result`. `Ok` passes through. The mirror of
+   * {@link flatMap} on the error track.
+   *
+   * @example
+   * ```ts
+   * loadFromCache(id).recover(() => loadFromOrigin(id)); // ResultAsync<T, F>
+   * ```
    */
-  chain(fn) {
-    return this.flatMap(fn);
-  }
   recover(fn) {
     return new _ResultAsync(async () => {
       const first = await this.resolve();
@@ -171,9 +302,27 @@ var ResultAsync = class _ResultAsync {
       return next instanceof _ResultAsync ? next.resolve() : next;
     });
   }
+  /**
+   * neverthrow-compat alias of {@link recover}. Kept as the documented compat
+   * tier; prefer {@link recover} in new code.
+   *
+   * @example
+   * ```ts
+   * loadFromCache(id).orElse(() => loadFromOrigin(id));
+   * ```
+   */
   orElse(fn) {
     return this.recover(fn);
   }
+  /**
+   * Runs a side effect on the `Ok` value and passes the result through
+   * unchanged; a no-op on `Err`. Mirrors {@link tapErr}.
+   *
+   * @example
+   * ```ts
+   * saveUser(u).tap((saved) => analytics.track("user_saved", saved.id));
+   * ```
+   */
   tap(fn) {
     return new _ResultAsync(async () => {
       const result = await this.resolve();
@@ -183,6 +332,15 @@ var ResultAsync = class _ResultAsync {
       return result;
     });
   }
+  /**
+   * Runs a side effect on the `Err` value and passes the result through
+   * unchanged; a no-op on `Ok`. The error-track mirror of {@link tap}.
+   *
+   * @example
+   * ```ts
+   * saveUser(u).tapErr((e) => logger.warn("save failed", e));
+   * ```
+   */
   tapErr(fn) {
     return new _ResultAsync(async () => {
       const result = await this.resolve();
@@ -192,28 +350,49 @@ var ResultAsync = class _ResultAsync {
       return result;
     });
   }
-  unwrapOr(defaultValue) {
-    return this.resolve().then((result) => isErr(result) ? defaultValue : result.value);
-  }
   /**
-   * @deprecated Await the ResultAsync and narrow with {@link isOk} — this method
-   * re-executes deferred factories and cannot narrow.
+   * Settles to the `Ok` value, or `defaultValue` if `Err`. Terminal — returns a
+   * plain `Promise`, not a `ResultAsync`.
+   *
+   * @example
+   * ```ts
+   * const profile = await loadProfile(id).unwrapOr(guestProfile);
+   * ```
    */
-  isOk() {
-    return this.resolve().then((result) => !isErr(result));
+  unwrapOr(defaultValue) {
+    return this.resolve().then((result) => isErr(result) ? defaultValue : result.value);
   }
   /**
-   * @deprecated Await the ResultAsync and narrow with {@link isErr} — this method
-   * re-executes deferred factories and cannot narrow.
+   * Terminal collapse — folds both tracks into a single awaited value. Returns
+   * a plain `Promise`, settling the carrier exactly once.
+   *
+   * @param onOk - handles the `Ok` value
+   * @param onErr - handles the `Err` value
+   *
+   * @example
+   * ```ts
+   * const status = await save(row).match(
+   *   () => 200,
+   *   (e) => (e.kind === "conflict" ? 409 : 500),
+   * );
+   * ```
    */
-  isErr() {
-    return this.resolve().then((result) => isErr(result));
-  }
   match(onOk, onErr) {
     return this.resolve().then(
       (result) => isErr(result) ? onErr(result.error) : onOk(result.value)
     );
   }
+  /**
+   * Settles the carrier to a bare sync {@link Result}, memoizing so the
+   * underlying factory runs at most once. Prefer `await ra` (the thenable) or
+   * {@link match} in app code; use `resolve` when you need the tagged union back.
+   *
+   * @example
+   * ```ts
+   * const r = await load(id).resolve();   // Result<Data, LoadError>
+   * if (isOk(r)) use(r.value);
+   * ```
+   */
   resolve() {
     if (!this.promise) {
       this.promise = this.run();
@@ -233,16 +412,9 @@ var ResultAsync = class _ResultAsync {
     );
   }
 };
-function isResultLike(v) {
-  return typeof v === "object" && v !== null && "_tag" in v && (v._tag === "Ok" || v._tag === "Err");
-}
-function isCompatLike(v) {
-  return typeof v === "object" && v !== null && "inner" in v && isResultLike(v.inner);
-}
 
-// src/railway-core.ts
+// src/railway.ts
 var addField = (ctx, key, value) => ({ ...ctx, [key]: value });
-var liftResult = (result) => ResultAsync.fromResult(result);
 var Railway = class _Railway {
   constructor(state) {
     this.state = state;
@@ -256,10 +428,7 @@ var Railway = class _Railway {
   static context(context) {
     return new _Railway({ mode: "sync", result: ok(context) });
   }
-  /**
-   * Start a sync workflow with a throwing function — `onThrow` maps any
-   * exception to a typed error.
-   */
+  /** Start a sync workflow with a throwing function. */
   static fromSync(key, fn, onThrow) {
     return _Railway.empty().fromSync(key, fn, onThrow);
   }
@@ -276,156 +445,103 @@ var Railway = class _Railway {
     return _Railway.empty().fromAsync(key, fn);
   }
   /**
-   * Pure sync derivation — `fn` must not throw. Use {@link fromSync} for
-   * throwing transforms.
+   * Rebuild the workflow in its current mode after transforming the carried
+   * result. Single re-link point for the state/phantom invariant: the mode
+   * tag is preserved verbatim, so `M` still describes the new state — TS
+   * cannot narrow the phantom `M` from the runtime tag, hence the cast.
    */
-  derive(key, fn) {
-    return this.fromResult(key, (ctx) => ok(fn(ctx)));
+  step(onSync, onAsync) {
+    const next = this.state.mode === "sync" ? { mode: "sync", result: onSync(this.state.result) } : { mode: "async", result: onAsync(this.state.result) };
+    return new _Railway(next);
   }
   /**
-   * Throwing sync transform. Adds `{ [key]: T }` to context; converts any
-   * exception to `Err<F>` via `onThrow`.
+   * Project the carried result into the mode-aware output type. Counterpart
+   * of {@link Railway.step} for terminal steps: the runtime branch matches
+   * the branch `RailwayOutput` picks for `M` (state/phantom invariant), but
+   * TS cannot resolve the conditional on an unresolved `M`, hence the cast.
    */
+  out(onSync, onAsync) {
+    return this.state.mode === "sync" ? onSync(this.state.result) : onAsync(this.state.result);
+  }
+  /** Lift the carried result into `ResultAsync` for async-upgrading steps. */
+  toAsync() {
+    return this.state.mode === "sync" ? ResultAsync.fromResult(this.state.result) : this.state.result;
+  }
+  /** Pure sync derivation. */
+  derive(key, fn) {
+    return this.fromResult(key, (ctx) => ok(fn(ctx)));
+  }
+  /** Throwing sync transform. */
   fromSync(key, fn, onThrow) {
     return this.fromResult(key, (ctx) => trySync(fn, onThrow)(ctx));
   }
-  /**
-   * Sync `Result`-returning step. Adds `{ [key]: T }` to context on `Ok`;
-   * short-circuits the workflow on `Err`. Error union widens to `E | F`.
-   */
+  /** Sync `Result`-returning step. */
   fromResult(key, fn) {
-    if (this.state.mode === "sync") {
-      const current = this.state.result;
-      if (isErr(current)) {
-        return new _Railway({ mode: "sync", result: err(current.error) });
-      }
-      const next = fn(current.value);
-      if (isErr(next)) {
-        return new _Railway({ mode: "sync", result: err(next.error) });
-      }
-      return new _Railway({
-        mode: "sync",
-        result: ok(addField(current.value, key, next.value))
-      });
-    }
-    return new _Railway({
-      mode: "async",
-      result: this.state.result.flatMap(
+    return this.step(
+      (result) => flatMap(result, (ctx) => map(fn(ctx), (value) => addField(ctx, key, value))),
+      (result) => result.flatMap(
         (ctx) => ResultAsync.fromResult(fn(ctx)).map((value) => addField(ctx, key, value))
       )
-    });
+    );
   }
-  /**
-   * Promise-returning step — upgrades the workflow to async mode. Reject
-   * reasons go through `onReject` to become typed `Err<F>`.
-   */
+  /** Promise-returning step — upgrades the workflow to async mode. */
   fromPromise(key, fn, onReject) {
     return this.fromAsync(key, (ctx) => ResultAsync.fromPromise(fn(ctx), onReject));
   }
-  /**
-   * `ResultAsync`-returning step — upgrades the workflow to async mode.
-   * Already-typed error: no mapper needed.
-   */
+  /** `ResultAsync`-returning step — upgrades the workflow to async mode. */
   fromAsync(key, fn) {
-    const current = this.state.mode === "sync" ? liftResult(this.state.result) : this.state.result;
     return new _Railway({
       mode: "async",
-      result: current.flatMap((ctx) => fn(ctx).map((value) => addField(ctx, key, value)))
+      result: this.toAsync().flatMap((ctx) => fn(ctx).map((value) => addField(ctx, key, value)))
     });
   }
-  /**
-   * Narrow a nullable context field into a required non-null field. If the
-   * source field is `null` / `undefined`, the workflow short-circuits with
-   * `onMissing(ctx)`.
-   *
-   * @example
-   * ```ts
-   * .fromPromise("row", ({ id }) => db.users.findFirst({ where: eq(users.id, id) }))
-   * .require("user", "row", ({ id }) => ({ kind: "not_found" as const, id }))
-   * // user is now User (non-null), not User | null
-   * ```
-   */
+  /** Narrow a nullable context field into a required non-null field. */
   require(key, source, onMissing) {
     return this.fromResult(key, (ctx) => {
       const value = ctx[source];
       return value == null ? err(onMissing(ctx)) : ok(value);
     });
   }
-  /**
-   * Run independent `ResultAsync` branches concurrently and merge their
-   * named outputs back into context. Upgrades the workflow to async mode.
-   * On multiple failures, the first `Err` in record-iteration order wins.
-   *
-   * @example
-   * ```ts
-   * .parallel({
-   *   recent:  ({ userId }) => loadRecent(userId),
-   *   metrics: ({ userId }) => loadMetrics(userId),
-   * })
-   * // ctx now has { ..., recent, metrics }
-   * ```
-   */
+  /** Run independent `ResultAsync` branches concurrently and merge outputs. */
   parallel(branches) {
-    const current = this.state.mode === "sync" ? liftResult(this.state.result) : this.state.result;
+    const merged = this.toAsync().flatMap(
+      (ctx) => ResultAsync.combineTupleParallel(
+        Object.entries(branches).map(([, branch]) => branch(ctx))
+      ).map(
+        (values) => (
+          // Branch outputs land under exactly R's keys; Object.fromEntries
+          // erases that correspondence, so reassert the merged shape.
+          {
+            ...ctx,
+            ...Object.fromEntries(Object.keys(branches).map((key, index) => [key, values[index]]))
+          }
+        )
+      )
+    );
     return new _Railway({
       mode: "async",
-      result: current.flatMap(
-        (ctx) => ResultAsync.combineTupleParallel(
-          Object.entries(branches).map(([, branch]) => branch(ctx))
-        ).map((values) => {
-          const next = { ...ctx };
-          Object.keys(branches).forEach((key, index) => {
-            next[key] = values[index];
-          });
-          return next;
-        })
-      )
+      // BranchFn erases per-key types to `ResultAsync<unknown, unknown>`
+      // (ParallelOutput/ParallelError recover them from R), so re-assert the
+      // precise value/error union the branches actually produce.
+      result: merged
     });
   }
-  /**
-   * Project the final context into the workflow's output type. Hides the
-   * internal context shape from callers.
-   */
+  /** Project the final context into the workflow's output type. */
   select(fn) {
-    if (this.state.mode === "sync") {
-      const current = this.state.result;
-      return isErr(current) ? err(current.error) : ok(fn(current.value));
-    }
-    return this.state.result.map(fn);
+    return this.out(
+      (result) => map(result, fn),
+      (result) => result.map(fn)
+    );
   }
-  /**
-   * Return the accumulated context as-is. Use when downstream code needs
-   * every named field; prefer {@link select} when you can project to a DTO.
-   */
+  /** Return the accumulated context as-is. */
   done() {
-    return this.state.result;
+    return this.out(
+      (result) => result,
+      (result) => result
+    );
   }
 };
 
-// src/railway-steps.ts
-var parseWithParser = (parser, input) => typeof parser === "function" ? parser(input) : parser.parse(input);
-function railway(input, ...steps) {
-  return steps.reduce(
-    (current, step) => step(current),
-    Railway.context({ input })
-  );
-}
-var parseWith = (parser, onThrow) => ({
-  as: (key) => (workflow) => workflow.fromSync(key, ({ input }) => parseWithParser(parser, input), onThrow)
-});
-var parseNamed = (key, parser, onThrow) => (workflow) => workflow.fromSync(key, ({ input }) => parseWithParser(parser, input), onThrow);
-var fromSyncNamed = (key, fn, onThrow) => (workflow) => workflow.fromSync(key, fn, onThrow);
-var fromResultNamed = (key, fn) => (workflow) => workflow.fromResult(key, fn);
-var fromPromiseNamed = (key, fn, onReject) => (workflow) => workflow.fromPromise(key, fn, onReject);
-var fromAsyncNamed = (key, fn) => (workflow) => workflow.fromAsync(key, fn);
-var deriveNamed = (key, fn) => (workflow) => workflow.derive(key, fn);
-var requireNamed = (key, source, onMissing) => (workflow) => workflow.require(key, source, onMissing);
-var parallelNamed = (branches) => (workflow) => {
-  const typedBranches = branches;
-  return workflow.parallel(typedBranches);
-};
-var select = (fn) => (workflow) => workflow.select(fn);
-
-export { Railway, deriveNamed, fromAsyncNamed, fromPromiseNamed, fromResultNamed, fromSyncNamed, parallelNamed, parseNamed, parseWith, railway, requireNamed, select };
+export { Railway };
 //# sourceMappingURL=railway.js.map
 //# sourceMappingURL=railway.js.map