clutchit 0.0.6 → 0.0.7

package/CHANGELOG.md

@@ -4,3 +4,61 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - TBD
+
+### Added
+
+#### `clutchit/unthrow`
+
+- `Result<T, E>` — synchronous typed error container with `Ok` and `Err` variants
+- `ResultAsync<T, E>` — async equivalent backed by `Promise<Result<T, E>>`, implements `PromiseLike`
+- `Result.Do` / `ResultAsync.Do` — generator-based Do notation for ergonomic sequential chaining
+- `Result.combine` / `ResultAsync.combine` — combine arrays of results, short-circuit on first error
+- `Result.combineWithAllErrors` / `ResultAsync.combineWithAllErrors` — collect all errors instead of stopping at first
+- `Result.fromThrowable` — wrap a throwing sync function into a `Result`
+- `ResultAsync.fromPromise` — lift a `Promise` into a `ResultAsync` with typed error mapping
+- `Fault.Tagged` — factory for structured, tagged error classes with `code`, `_category`, and `_transient`
+- `Fault.isDomain` / `Fault.isInfrastructure` / `Fault.isTransient` — type guard helpers
+
+#### `clutchit/schedule`
+
+- `Schedule` — composable timing primitive with `.next(input, attempt)` and `.pipe(operator)` API
+- Factories: `spaced`, `exponential`, `linear`, `constant`, `fixed`, `windowed`, `fibonacci`, `cron`, `forever`, `once`
+- Operators: `recurs`, `cappedDelay`, `jittered`, `upTo`, `andThen`, `union`, `intersect`, `whileInput`, `whileOutput`, `map`
+- `Schedule.repeat` — run a `ResultAsync`-returning function repeatedly on a schedule with abort signal support
+- `ScheduleInterruptedFault` — returned when `repeat` is cancelled via `AbortSignal`
+
+#### `clutchit/retry`
+
+- `RetryPolicy` — policy-driven retry with configurable `Schedule`, `retryOn` predicate, `onRetry` callback, and `AbortSignal`
+- Default behaviour: exponential backoff starting at 200 ms, up to 3 retries, retries transient faults automatically
+
+#### `clutchit/timeout`
+
+- `withTimeout(fn, duration)` — wrap a `ResultAsync`-returning function with a deadline
+- `createTimeout(duration)` — create a reusable timeout wrapper
+- `TimeoutFault` — transient infrastructure fault emitted on deadline exceeded; aborts the underlying operation
+
+#### `clutchit/circuit`
+
+- `Circuit.Breaker` — circuit breaker with `closed → open → half-open` state machine
+- Options: `failureThreshold`, `resetSchedule`, `halfOpenAttempts`, `isFailure`, `onStateChange`
+- `CircuitOpenFault` — emitted when calls are rejected in the open state with `remainingTimeout`
+- `breaker.state`, `breaker.failureCount`, `breaker.reset()`
+
+#### `clutchit/concurrency`
+
+- `Concurrency.Semaphore` — counting semaphore; queues callers when permits are exhausted
+- `Concurrency.Bulkhead` — bounded concurrency with optional queue; rejects overflow with `BulkheadRejectedFault`
+- `Concurrency.RateLimiter` — sliding-window rate limiter; rejects over-limit calls with `RateLimitFault`
+- `Concurrency.Ref` — atomic mutable reference serialised through an internal mutex; `get`, `set`, `update`, `modify`
+- `BulkheadRejectedFault`, `RateLimitFault` — typed rejection faults
+
+#### `clutchit/queue`
+
+- `Queue.Bounded` — bounded async queue with backpressure; `put` blocks, `offer` returns `QueueFullFault` when full
+- `Queue.Dropping` — drops newest items when full; `offer` returns `boolean`
+- `Queue.Sliding` — drops oldest items when full; `offer` always succeeds
+- Shared API: `take`, `takeBatch`, `poll`, `size`, `capacity` with `AbortSignal` support
+- `QueueFullFault`, `QueueEmptyFault` — typed queue faults