resultar 3.0.0-alpha.3 → 3.1.0-beta.1

package/README.md

@@ -2,9 +2,27 @@
 
 Production-facing error handling for TypeScript, without a runtime.
 
-Resultar gives you typed `Result` primitives, real `Error`-based tagged failures, sync/async
-composition, and optional no-discard diagnostics. It is small enough to adopt in one module and
-strict enough to use at service, HTTP, job, queue, CLI, and integration boundaries.
+Full documentation, long-form recipes, and the complete API map live in
+[DOCUMENTATION.md](../../DOCUMENTATION.md).
+
+## New In 3.1
+
+Resultar 3.1 turns common production async policies into typed values instead of rejected promises,
+hidden timers, or helper code that throws.
+
+- `ResultAsync.timeout`, `retry`, `retryOrElse`, `race`, `raceAll`, and `withResource` cover
+  timeouts, retry policy, fallback, replica reads, and cleanup while preserving the expected error
+  type.
+- `ResultAsync.forEach` and `ResultAsync.validateAll` support sequential work, bounded
+  `{ concurrency }`, and explicit unbounded execution for batch processing and validation.
+- `AbortError` / `isAbortError` and redacted tagged-error props with `redact`, `isRedacted`, and
+  `revealRedacted` make cancellation and sensitive error metadata visible at the type boundary.
+
+## Main Functionalities
+
+Resultar gives you typed `Result` primitives, real `Error`-based tagged failures, async control
+helpers, sync/async composition, and optional no-discard diagnostics. It is small enough to adopt in
+one module and strict enough to use at service, HTTP, job, queue, CLI, and integration boundaries.
 
 ```ts
 Result<T, E>
@@ -18,12 +36,14 @@ Use it when expected failures should be impossible to miss:
 - Function signatures show both the success type and the expected error type.
 - Domain errors are real `Error` instances with stable tags, messages, `cause`, stack traces, and
   JSON output.
+- `ResultAsync` can bound concurrent work, race replicas, apply typed timeouts, retry transient
+  failures, and pair acquisition with cleanup without adding a runtime scheduler.
 - Sync and async fallible work compose without `try/catch` blocks scattered through application
   code.
 - Ignored `Result` values can be reported by a type-aware no-discard check.
 
-Resultar began as an initial fork of `neverthrow`. The v3 alpha line keeps the explicit wrapper
-model, then leans into Resultar-specific tagged errors, strict service-boundary types, TypeScript 6
+Resultar began as an initial fork of `neverthrow`. The v3 line keeps the explicit wrapper model,
+then leans into Resultar-specific tagged errors, strict service-boundary types, TypeScript 6
 support, and ESM-only packaging.
 
 ## Install
@@ -96,6 +116,9 @@ in normal TypeScript.
 | Expected failures are hidden behind `throw` | `Result<T, E>` and `ResultAsync<T, E>` in function signatures |
 | Production errors need stable names and metadata | `createTaggedError` classes with `_tag`, template props, `cause`, and `.toJSON()` |
 | Async flows turn into nested `try/catch` | `tryResultAsync`, `andThen`, `asyncAndThen`, `map`, `orElse`, `safeTry` |
+| Network calls need timeouts, retries, and fallback policy | `ResultAsync.timeout`, `retry`, `retryOrElse`, `race`, and `raceAll` |
+| Batch work needs backpressure without a framework | `ResultAsync.forEach` and mapped `validateAll` with `{ concurrency }` |
+| Resourceful work needs cleanup on every path | `ResultAsync.withResource` and native `AsyncIterable<Result<T, E>>` recipes |
 | Boundary handlers miss cases | `matchTags` for exhaustive tagged-error handling |
 | Results are easy to ignore | `resultar-lint check` and the `resultar-lint` TypeScript plugin |
 | You do not want another application runtime | A small ESM library around explicit values |
@@ -133,6 +156,62 @@ const getPosts = (
     )
 ```
 
+## Async Control Without A Runtime
+
+The 3.1 async helpers cover common production workflows while keeping plain `Promise` and
+`AbortSignal`-compatible APIs underneath. You choose the policy in the type signature instead of
+hiding it in a helper that throws.
+
+Retry transient work and fall back to cache only after the retry policy is exhausted:
+
+```ts
+const user = ResultAsync.retryOrElse(
+  (attempt, signal) => fetchUser(id, { attempt, signal }),
+  {
+    times: 2,
+    delayMs: ({ nextAttempt }) => nextAttempt * 100,
+    while: (error) => error._tag === 'RateLimitError' || error._tag === 'ServiceUnavailableError',
+    orElse: () => readCachedUser(id),
+  },
+)
+```
+
+Race a primary and replica with cooperative loser abort:
+
+```ts
+const user = ResultAsync.race(
+  (signal) => readUserFromPrimary(id, { signal }),
+  (signal) => readUserFromReplica(id, { signal }),
+)
+```
+
+Keep timeout as a typed `Err`, not a rejected promise:
+
+```ts
+const user = ResultAsync.timeout(
+  (signal) => readUserFromPrimary(id, { signal }),
+  {
+    timeoutMs: 1_500,
+    onTimeout: () => new FetchUserTimeoutError({ id, timeoutMs: 1_500 }),
+  },
+)
+```
+
+Process batches with bounded concurrency and explicit cleanup:
+
+```ts
+const imported = ResultAsync.withResource({
+  acquire: (signal) => openImportSession({ signal }),
+  use: (session, signal) =>
+    ResultAsync.forEach(
+      rows,
+      (row) => importRow(session, row, { signal }),
+      { concurrency: 8, discard: true },
+    ),
+  release: (session) => session.close(),
+})
+```
+
 ## Quick Start
 
 ```ts
@@ -325,14 +404,31 @@ new UserNotFoundError({ id: 'usr_123' })
 Use `TaggedEnum` only for lightweight tagged unions that do not need to be real errors.
 
 ```ts
+import { taggedEnum } from 'resultar'
 import type { TaggedEnum } from 'resultar'
 
 type PaymentError = TaggedEnum<{
   CardDeclined: { readonly code: string }
   InsufficientFunds: { readonly balance: number }
 }>
+
+const PaymentError = taggedEnum<{
+  CardDeclined: { readonly code: string }
+  InsufficientFunds: { readonly balance: number }
+}>()
+
+const declined = PaymentError.CardDeclined({ code: 'card_declined' })
+
+PaymentError.$is('CardDeclined', declined) // true
+PaymentError.$match(declined, {
+  CardDeclined: (error) => error.code,
+  InsufficientFunds: (error) => String(error.balance),
+})
 ```
 
+Use `redact(value, label?)` for tagged error props that must not leak through messages or JSON.
+Use `revealRedacted(value)` only at the exact boundary that is allowed to see the secret.
+
 ## Composing Results
 
 Use `map` for infallible transforms:
@@ -387,6 +483,53 @@ const draftUser = createUser('bad-email').catchTag('InvalidEmailError', (error)
 )
 ```
 
+## Reasoned Tagged Errors
+
+Use `catchReason`, `catchReasons`, and `unwrapReason` when a stable parent error has a nested tagged
+reason. This keeps the outer error useful for logs and boundaries while allowing local recovery by
+the precise reason.
+
+```ts
+import { createTaggedError, err, ok, taggedEnum } from 'resultar'
+import type { StrictResult, TaggedEnum } from 'resultar'
+
+const AiReason = taggedEnum<{
+  QuotaExceededError: { readonly limit: number }
+  RateLimitError: { readonly retryAfterMs: number }
+}>()
+
+type AiReason = TaggedEnum<{
+  QuotaExceededError: { readonly limit: number }
+  RateLimitError: { readonly retryAfterMs: number }
+}>
+
+class AiError extends createTaggedError({
+  name: 'AiError',
+  message: 'AI request failed',
+}) {
+  public readonly reason: AiReason
+
+  public constructor(props: { readonly cause?: unknown; readonly reason: AiReason }) {
+    super({ cause: props.cause })
+    this.reason = props.reason
+  }
+}
+
+const askAi = (): StrictResult<string, AiError> =>
+  err(new AiError({ reason: AiReason.RateLimitError({ retryAfterMs: 1_000 }) }))
+```
+
+```ts
+const recovered = askAi().catchReason('AiError', 'RateLimitError', (reason) =>
+  ok(`retry after ${reason.retryAfterMs}ms`),
+)
+
+const unwrapped = askAi().unwrapReason('AiError')
+```
+
+`catchReason` removes only the handled reason from the remaining error type. `unwrapReason` moves the
+reason union into the error channel when the parent tag matches.
+
 Use `match`, `matchTags`, or `matchTagsPartial` at boundaries where a result becomes a response,
 log entry, queue acknowledgement, CLI exit code, or UI state.
 
@@ -410,9 +553,9 @@ const response = createUser(input.email).matchTagsPartial(
 
 Use fallback APIs when an expected failure has a useful recovery path.
 
-| Effect fallback idea | Resultar equivalent |
+| Fallback idea | Resultar API |
 | --- | --- |
-| try another effect | `result.orElse(() => fallbackResult)` |
+| try another branch | `result.orElse(() => fallbackResult)` |
 | replace the failure | `mapErr(...)` or `orElse(() => err(newError))` |
 | replace the failure with success | `orElse(() => ok(defaultValue))` inside a pipeline |
 | default at the edge | `unwrapOr(defaultValue)` |
@@ -453,10 +596,147 @@ const user = ResultAsync.firstSuccessOf([
 ])
 ```
 
+Use `combine` with records when independent results should keep names:
+
+```ts
+const context = Result.combine({
+  org: readOrg(orgId),
+  user: readUser(userId),
+})
+
+const validated = Result.combineWithAllErrors({
+  email: validateEmail(input.email),
+  name: validateName(input.name),
+})
+```
+
+For lazy async traversal, `ResultAsync.forEach` and mapped `ResultAsync.validateAll` run
+sequentially by default. Pass `{ concurrency: n }` for bounded concurrency or
+`{ concurrency: "unbounded" }` to start every mapped task immediately. See
+[DOCUMENTATION.md](../../DOCUMENTATION.md#async-concurrency-mapping) for async concurrency details
+and the runtime features Resultar intentionally keeps out of core.
+
+For concurrent async races, use lazy signal-aware tasks. `race` and `raceAll` return the first
+success. `raceFirst` returns the first completed result, success or failure. `timeout` is a
+`raceFirst` convenience.
+
+```ts
+const user = ResultAsync.timeout(
+  (signal) => fetchUser(id, { signal }),
+  {
+    timeoutMs: 2_000,
+    onTimeout: () => new FetchUserTimeoutError({ id }),
+  },
+)
+```
+
+For transient async failures, use lazy retry tasks. The task receives a zero-based attempt number and
+a `ResultAsyncAbortSignal`-compatible signal; `times` is the number of retries after the first
+attempt.
+
+```ts
+const user = ResultAsync.retry(
+  (attempt, signal) => fetchUser(id, { attempt, signal }),
+  {
+    times: 2,
+    delayMs: ({ nextAttempt }) => nextAttempt * 100,
+    while: (error) => error._tag === 'RateLimitError',
+  },
+)
+
+const withFallback = ResultAsync.retryOrElse(
+  (attempt, signal) => fetchUser(id, { attempt, signal }),
+  {
+    times: 2,
+    orElse: () => readCachedUser(id),
+  },
+)
+```
+
+For resourceful async work, use `ResultAsync.withResource` when acquisition and cleanup must stay
+paired. Cleanup is best-effort and always runs after successful acquisition, including when the use
+step returns `Err` or rejects.
+
+```ts
+const lines = ResultAsync.withResource({
+  acquire: (signal) => openFile(path, { signal }),
+  use: (file, signal) => readLines(file, { signal }),
+  release: (file) => file.close(),
+})
+```
+
+For pull-based streams, keep the runtime native: expose an `AsyncIterable<Result<T, E>>` and close
+resources in `finally`. See
+[DOCUMENTATION.md](../../DOCUMENTATION.md#resourceful-async-iterables) for the full recipe.
+
 Use `catchTag` / `catchTags` when recovery depends on a specific tagged error. Use
 `matchTagsPartial` when only a boundary needs fallback mapping. Use `unwrapOr` only at final edges
 where defaulting is intentional.
 
+## Catching Errors
+
+Resultar has different catch APIs for different error sources. Use the smallest API that matches
+where the failure appears.
+
+| Need | Use |
+| --- | --- |
+| Catch thrown sync code now | `tryResult(fn, toError?)` |
+| Wrap a throwing sync function for later | `fromThrowable(fn, toError?)` |
+| Catch an existing rejecting promise | `fromPromise(promise, toError)` |
+| Catch a promise or async factory | `tryResultAsync(promiseOrFactory, toError?)` |
+| Wrap an async function for later | `fromThrowableAsync(fn, toError?)` |
+| Turn one error into another | `mapErr(fn)` |
+| Recover with another result | `orElse(fn)` |
+| Recover specific tagged errors | `catchTag(tag, fn)` or `catchTags(handlers)` |
+| Recover nested tagged reasons | `catchReason(parentTag, reasonTag, fn)` or `catchReasons(parentTag, handlers)` |
+| Convert a result at a boundary | `match`, `matchTags`, or `matchTagsPartial` |
+| Handle an existing `Error` value | `matchError` or `matchErrorPartial` |
+| Map thrown errors in linear code | `safeTry({ try, catch })` |
+| Recover after retry exhaustion | `ResultAsync.retryOrElse(task, options)` |
+
+Catch uncontrolled code at the edge:
+
+```ts
+const parsed: StrictResult<Config, ParseConfigError> = tryResult(
+  () => JSON.parse(input) as Config,
+  (cause) => new ParseConfigError({ cause }),
+)
+
+const response: StrictResultAsync<Response, FetchPayloadError> = tryResultAsync(
+  () => fetch(url),
+  (cause) => new FetchPayloadError({ cause, url }),
+)
+```
+
+Thrown or rejected values are `unknown` at the boundary. The mapper decides the documented error
+type: `ParseConfigError` for parsing and `FetchPayloadError` for fetching.
+
+Recover inside the pipeline:
+
+```ts
+const user: StrictResultAsync<User, ReadUserError> = readUserFromCache(id)
+  .orElse(() => readUserFromDatabase(id))
+  .mapErr((cause) => new ReadUserError({ cause, id }))
+```
+
+The cache/database error union is normalized into one public `ReadUserError` while preserving the
+original error as `cause`.
+
+Handle tagged errors at the boundary:
+
+```ts
+const response: HttpResponse = createUser(input).matchTagsPartial(
+  (user) => ({ body: user, statusCode: 201 }),
+  {
+    InvalidEmailError: (error) => ({ body: { code: error._tag }, statusCode: 400 }),
+  },
+  (error) => ({ body: { code: error._tag }, statusCode: 500 }),
+)
+```
+
+For the full decision map, see
+[Catching And Recovering Errors](../../DOCUMENTATION.md#catching-and-recovering-errors).
+
 ## Wrapping Throwing Code
 
 Use `tryResult` and `tryResultAsync` at the edge of uncontrolled code:
@@ -486,6 +766,41 @@ const user = fromPromise(loadUserFromRemote(id), (cause) => new FetchUserError({
 After that edge conversion, keep your own domain functions returning `Result` values instead of
 throwing expected failures.
 
+## Validation Errors
+
+Keep validation failures as normal tagged errors. Map external validators into a small issue shape
+at the adapter boundary.
+
+```ts
+type ValidationIssue = {
+  readonly message: string
+  readonly path: string
+}
+
+class ValidationError extends createTaggedError({
+  name: 'ValidationError',
+  message: 'Invalid input',
+}) {
+  public readonly issues: readonly ValidationIssue[]
+
+  public constructor(props: {
+    readonly cause?: unknown
+    readonly issues: readonly ValidationIssue[]
+  }) {
+    super({ cause: props.cause })
+    this.issues = props.issues
+  }
+}
+
+const issueFromPath = (path: readonly (number | string)[], message: string): ValidationIssue => ({
+  message,
+  path: path.join('.'),
+})
+```
+
+For Zod, Standard Schema, or any other validator, decode at the edge and map the library-specific
+issue format into `ValidationIssue[]`. Resultar does not depend on any validator package.
+
 ## Unexpected Errors
 
 Expected application failures belong in `Err`. Bugs, impossible states, and unrecoverable conditions
@@ -579,20 +894,25 @@ Add a lint-like script:
 }
 ```
 
-This fails:
+These fail in the default `must-use` mode:
 
 ```ts
 saveUser(input)
+const result = saveUser(input)
 ```
 
 These are intentional:
 
 ```ts
-const result = saveUser(input)
 return saveUser(input)
 void saveUser(input)
+saveUser(input).match(handleSaved, handleError)
 ```
 
+The default mode is neverthrow-style `must-use`: it also reports assigned `Result` values that are
+only passed around and never consumed with `match`, `unwrapOr`, `_unsafeUnwrap`, `isOk`, `isErr`,
+returned, or explicitly discarded. Use `--mode direct` for the lower-noise expression-only check.
+
 For editor diagnostics, enable the TypeScript language-service plugin:
 
 ```json
@@ -613,7 +933,7 @@ pnpm exec resultar-lint unpatch
 ```
 
 For TypeScript 7 native-preview projects, `resultar-tsgo` exposes a `tsgo` wrapper that runs native
-TypeScript and then Resultar no-discard validation.
+TypeScript and then Resultar lint validation.
 
 ## API Decision Guide
 
@@ -632,6 +952,8 @@ TypeScript and then Resultar no-discard validation.
 | Transform error | `mapErr` |
 | Continue with fallible work | `andThen` or `asyncAndThen` |
 | Recover from failure | `orElse`, `catchTag`, or `catchTags` |
+| Recover from a nested tagged reason | `catchReason` or `catchReasons` |
+| Move a parent error reason into the error channel | `unwrapReason` |
 | Replace failure with another failure | `mapErr` or `orElse(() => err(newError))` |
 | Replace failure with success | `orElse(() => ok(defaultValue))` |
 | Handle a boundary | `match`, `matchTags`, or `matchTagsPartial` |
@@ -640,14 +962,29 @@ TypeScript and then Resultar no-discard validation.
 | Combine many independent results | `Result.combine` or `ResultAsync.combine` |
 | Collect all validation failures | `validateAll` or `combineWithAllErrors` |
 | Try fallback candidates | `firstSuccessOf` |
+| Bound lazy async traversal | `ResultAsync.forEach` or mapped `ResultAsync.validateAll` with `{ concurrency }` |
+| Race concurrent tasks | `ResultAsync.race`, `raceAll`, `raceFirst`, or `raceWith` |
+| Apply a cooperative timeout | `ResultAsync.timeout` |
+| Retry transient async work | `ResultAsync.retry` or `ResultAsync.retryOrElse` |
+| Pair async acquisition with cleanup | `ResultAsync.withResource` |
 | Process collections sequentially | `loop`, `iterate`, or `forEach` |
 | Observe without changing outcome | `tap`, `tapError`, or `log` |
 | Throw intentionally at a final edge | `unwrapOrThrow()` |
 | Default intentionally at a final edge | `unwrapOr(defaultValue)` |
 
-## Version 3 Alpha Notes
+## What Stays Out Of Core
+
+Resultar keeps the scope narrow: explicit error values, typed expected failures, and composable
+recovery.
+
+- No generator-based runtime DSL.
+- No schedule engine in core.
+- No config, cache, request resolver, resource, fiber, or service runtime.
+- No raw `Error | T` conversion API.
+
+## Version 3 Notes
 
-`3.0.0-alpha.1` is a semver-major prerelease:
+`3.0.0` is a semver-major release:
 
 - `no-discard` tooling moved out of the runtime package and into dedicated packages.
 - TypeScript peer support is now `>=6.0.0`.
@@ -667,27 +1004,29 @@ and `tryResultAsync` in new code and docs.
 
 ## Documentation
 
-This README is the project entry point. For a full guide with larger examples and the complete API
-map, see [DOCUMENTATION.md](DOCUMENTATION.md).
+This README is the runtime package entry point. For a full guide with larger examples and the
+complete API map, see the repository documentation.
 
 More focused material:
 
-- [Type-safe error handling article, English](articles/en/type-safe.md)
-- [Artigo sobre tratamento de erros type-safe, Portuguese](articles/pt/type-safe.md)
-- [resultar-lint package guide](packages/resultar-lint/README.md)
-- [resultar-tsgo package guide](packages/resultar-tsgo/README.md)
+- [Full guide](https://github.com/inaiat/resultar/blob/main/DOCUMENTATION.md)
+- [Type-safe error handling article, English](https://github.com/inaiat/resultar/blob/main/articles/en/type-safe.md)
+- [Artigo sobre tratamento de erros type-safe, Portuguese](https://github.com/inaiat/resultar/blob/main/articles/pt/type-safe.md)
+- [resultar-lint package guide](https://github.com/inaiat/resultar/blob/main/packages/resultar-lint/README.md)
+- [resultar-tsgo package guide](https://github.com/inaiat/resultar/blob/main/packages/resultar-tsgo/README.md)
 
-## Workspace
+## Repository
 
 This repository is a pnpm workspace:
 
 - `packages/resultar`: Resultar runtime package.
 - `packages/resultar-lint`: TypeScript language-service diagnostics and no-discard CLI.
-- `packages/resultar-tsgo`: TypeScript 7 native-preview `tsgo` wrapper plus Resultar no-discard
+- `packages/resultar-tsgo`: TypeScript 7 native-preview `tsgo` wrapper plus Resultar lint
   validation.
 - `benchmarks`: benchmark package.
-- `examples/resultar-lint`: TypeScript 6 no-discard smoke example.
-- `examples/tsgo`: TypeScript 7 native-preview smoke example.
+- `examples/resultar`: runnable core Resultar cookbook.
+- `examples/lint`: TypeScript 6 Resultar lint, patched `tsc`, and Vite+ / Oxlint smoke example.
+- `examples/tsgo-lint`: TypeScript 7 native-preview Resultar lint smoke example.
 
 Common commands:
 
@@ -699,7 +1038,7 @@ pnpm test
 pnpm run test:cov
 pnpm run build
 pnpm run check:full
-pnpm run test:language-service
+pnpm run test:examples
 pnpm run bench
 ```