@git-stunts/alfred 0.2.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 James Ross
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,332 @@
+# @git-stunts/alfred
+
+> *"Why do we fall, Bruce?"*
+>
+> *"So we can `retry({ backoff: 'exponential', jitter: 'decorrelated' })`."*
+
+Resilience patterns for async operations. *Tuff 'nuff for most stuff!*
+
+## Installation
+
+```bash
+npm install @git-stunts/alfred
+```
+
+## Multi-Runtime Support
+
+Alfred is designed to be platform-agnostic and is tested against:
+- **Node.js** (>= 20.0.0)
+- **Bun** (>= 1.0.0)
+- **Deno** (>= 1.35.0)
+
+It uses standard Web APIs (AbortController, AbortSignal) and provides runtime-aware clock management to ensure clean process exits (unref) on all platforms.
+
+## Quick Start
+
+```javascript
+import { retry, circuitBreaker, timeout, compose } from '@git-stunts/alfred';
+
+// Simple retry with exponential backoff
+const data = await retry(
+  () => fetch('https://api.example.com/data'),
+  { retries: 3, backoff: 'exponential', delay: 100 }
+);
+
+// Circuit breaker - fail fast when service is down
+const breaker = circuitBreaker({ threshold: 5, duration: 60000 });
+const result = await breaker.execute(() => callFlakeyService());
+
+// Compose multiple policies
+const resilient = compose(
+  timeout(5000),
+  retry({ retries: 3, backoff: 'exponential', jitter: 'full' }),
+  circuitBreaker({ threshold: 5, duration: 60000 }),
+  bulkhead({ limit: 10, queueLimit: 20 })
+);
+
+await resilient.execute(() => riskyOperation());
+```
+
+## API
+
+### `retry(fn, options)`
+
+Retries a failed operation with configurable backoff.
+
+```javascript
+import { retry } from '@git-stunts/alfred';
+
+// Basic retry
+await retry(() => mightFail(), { retries: 3 });
+
+// Exponential backoff: 100ms, 200ms, 400ms, 800ms...
+await retry(() => mightFail(), {
+  retries: 5,
+  backoff: 'exponential',
+  delay: 100,
+  maxDelay: 10000
+});
+
+// Only retry specific errors
+await retry(() => mightFail(), {
+  retries: 3,
+  shouldRetry: (err) => err.code === 'ECONNREFUSED'
+});
+
+// With jitter to prevent thundering herd
+await retry(() => mightFail(), {
+  retries: 3,
+  backoff: 'exponential',
+  delay: 100,
+  jitter: 'full' // or 'equal' or 'decorrelated'
+});
+```
+
+**Options:**
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `retries` | `number` | `3` | Maximum retry attempts |
+| `delay` | `number` | `1000` | Base delay in milliseconds |
+| `maxDelay` | `number` | `30000` | Maximum delay cap |
+| `backoff` | `'constant' \| 'linear' \| 'exponential'` | `'constant'` | Backoff strategy |
+| `jitter` | `'none' \| 'full' \| 'equal' \| 'decorrelated'` | `'none'` | Jitter strategy |
+| `shouldRetry` | `(error) => boolean` | `() => true` | Predicate to filter retryable errors |
+| `onRetry` | `(error, attempt, delay) => void` | - | Callback on each retry |
+
+### `circuitBreaker(options)`
+
+Fails fast when a service is degraded, preventing cascade failures.
+
+```javascript
+import { circuitBreaker } from '@git-stunts/alfred';
+
+const breaker = circuitBreaker({
+  threshold: 5,      // Open after 5 failures
+  duration: 60000,   // Stay open for 60 seconds
+  onOpen: () => console.log('Circuit opened!'),
+  onClose: () => console.log('Circuit closed!'),
+  onHalfOpen: () => console.log('Testing recovery...')
+});
+
+// Circuit has three states:
+// - CLOSED: Normal operation, failures counted
+// - OPEN: All calls fail immediately with CircuitOpenError
+// - HALF_OPEN: One test call allowed to check recovery
+
+try {
+  await breaker.execute(() => callService());
+} catch (err) {
+  if (err.name === 'CircuitOpenError') {
+    console.log('Service is down, failing fast');
+  }
+}
+```
+
+**Options:**
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `threshold` | `number` | required | Failures before opening |
+| `duration` | `number` | required | How long to stay open (ms) |
+| `successThreshold` | `number` | `1` | Successes to close from half-open |
+| `shouldTrip` | `(error) => boolean` | `() => true` | Which errors count as failures |
+| `onOpen` | `() => void` | - | Called when circuit opens |
+| `onClose` | `() => void` | - | Called when circuit closes |
+| `onHalfOpen` | `() => void` | - | Called when entering half-open |
+
+### `bulkhead(options)`
+
+Limits the number of concurrent executions to prevent resource exhaustion.
+
+```javascript
+import { bulkhead } from '@git-stunts/alfred';
+
+const limiter = bulkhead({
+  limit: 10,       // Max 10 concurrent executions
+  queueLimit: 20   // Max 20 pending requests in queue
+});
+
+// Returns an object with:
+// - execute(fn): Method to run the operation
+// - stats: { active, pending, available }
+try {
+  await limiter.execute(() => heavyOperation());
+} catch (err) {
+  if (err.name === 'BulkheadRejectedError') {
+    console.log('Too many concurrent requests, failing fast');
+  }
+}
+
+console.log(`Current load: ${limiter.stats.active} active tasks`);
+```
+
+**Options:**
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `limit` | `number` | required | Maximum concurrent executions |
+| `queueLimit` | `number` | `0` | Maximum pending requests in queue |
+
+### `timeout(ms, options)`
+
+Prevents operations from hanging indefinitely.
+
+```javascript
+import { timeout } from '@git-stunts/alfred';
+
+// Simple timeout
+const result = await timeout(5000, () => slowOperation());
+
+// With callback
+const result = await timeout(5000, () => slowOperation(), {
+  onTimeout: (elapsed) => console.log(`Timed out after ${elapsed}ms`)
+});
+```
+
+Throws `TimeoutError` if the operation exceeds the time limit.
+
+### `Policy` (Fluent API)
+
+Building complex policies is easy with the chainable `Policy` class.
+
+```javascript
+import { Policy, ConsoleSink } from '@git-stunts/alfred';
+
+const telemetry = new ConsoleSink();
+
+const resilient = Policy.timeout(30000)
+  .wrap(Policy.retry({ retries: 3, backoff: 'exponential', telemetry }))
+  .wrap(Policy.circuitBreaker({ threshold: 5, duration: 60000, telemetry }))
+  .wrap(Policy.bulkhead({ limit: 5, queueLimit: 10, telemetry }));
+
+await resilient.execute(() => riskyOperation());
+```
+
+### `compose(...policies)`
+
+Combines multiple policies. Policies execute from left to right (outermost to innermost).
+
+```javascript
+import { compose, retry, circuitBreaker, timeout } from '@git-stunts/alfred';
+
+const resilient = compose(
+  timeout(30000),                                    // Total timeout
+  retry({ retries: 3, backoff: 'exponential' }),     // Retry failures
+  circuitBreaker({ threshold: 5, duration: 60000 }), // Fail fast if broken
+  bulkhead({ limit: 5, queueLimit: 10 })             // Limit concurrency
+);
+
+// Execution order:
+// 1. Start 30s timeout
+// 2. Try operation (retry up to 3x on failure)
+// 3. Each attempt checks circuit breaker and bulkhead
+await resilient.execute(() => riskyOperation());
+```
+
+### Telemetry & Observability
+
+Alfred provides a composable telemetry system to monitor policy behavior.
+
+```javascript
+import {
+  Policy,
+  ConsoleSink,
+  InMemorySink,
+  MultiSink
+} from '@git-stunts/alfred';
+
+// 1. Create a sink (or multiple)
+const sink = new MultiSink([
+  new ConsoleSink(),
+  new InMemorySink()
+]);
+
+// 2. Attach to policies
+const policy = Policy.retry({
+  retries: 3,
+  telemetry: sink
+});
+
+// All policies emit events:
+// - retry: success, failure, scheduled, exhausted
+// - circuit: open, close, half-open, success, failure, reject
+// - bulkhead: execute, complete, queued, reject
+// - timeout: timeout
+await policy.execute(() => doSomething());
+```
+
+## Testing
+
+Use `TestClock` for deterministic tests without real delays:
+
+```javascript
+import { retry, TestClock } from '@git-stunts/alfred/testing';
+
+test('retries with exponential backoff', async () => {
+  const clock = new TestClock();
+  let attempts = 0;
+
+  const operation = async () => {
+    attempts++;
+    if (attempts < 3) throw new Error('fail');
+    return 'success';
+  };
+
+  const promise = retry(operation, {
+    retries: 3,
+    backoff: 'exponential',
+    delay: 1000,
+    clock
+  });
+
+  // First attempt fails immediately
+  await clock.tick(0);
+  expect(attempts).toBe(1);
+
+  // Second attempt after 1s
+  await clock.advance(1000);
+  expect(attempts).toBe(2);
+
+  // Third attempt after 2s (exponential)
+  await clock.advance(2000);
+  expect(attempts).toBe(3);
+
+  expect(await promise).toBe('success');
+});
+```
+
+## Error Types
+
+```javascript
+import {
+  RetryExhaustedError,
+  CircuitOpenError,
+  TimeoutError
+} from '@git-stunts/alfred';
+
+try {
+  await resilientOperation();
+} catch (err) {
+  if (err instanceof RetryExhaustedError) {
+    console.log(`Failed after ${err.attempts} attempts`);
+    console.log(`Last error: ${err.cause.message}`);
+  } else if (err instanceof CircuitOpenError) {
+    console.log(`Circuit open since ${err.openedAt}`);
+  } else if (err instanceof TimeoutError) {
+    console.log(`Timed out after ${err.elapsed}ms`);
+  }
+}
+```
+
+---
+
+## License
+
+Apache-2.0 © 2026 by James Ross
+
+---
+
+<p align="center">
+  <sub>Built by <a href="https://github.com/flyingrobots">FLYING•ROBOTS</a></sub>
+</p>

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@git-stunts/alfred",
+  "version": "0.2.0",
+"description": "Why do we fall, Bruce? Resilience patterns for async operations.",
+  "type": "module",
+  "main": "src/index.js",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    },
+    "./testing": {
+      "types": "./src/testing.d.ts",
+      "default": "./src/testing.js"
+    }
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint .",
+    "format": "prettier --write ."
+  },
+  "author": "James Ross <james@flyingrobots.dev>",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@eslint/js": "^9.17.0",
+    "@vitest/coverage-v8": "^2.1.8",
+    "eslint": "^9.17.0",
+    "prettier": "^3.4.2",
+    "vitest": "^2.1.8"
+  },
+  "files": [
+    "src",
+    "index.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/git-stunts/alfred.git"
+  },
+  "keywords": [
+    "resilience",
+    "retry",
+    "circuit-breaker",
+    "timeout",
+    "fault-tolerance",
+    "async",
+    "batman"
+  ]
+}