@lp-labs/token-bucket 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Libin Prasanth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,95 @@
-# Temporary Holding Version
+# @lp-labs/token-bucket
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Fractional local token accounting with cancellable burst reservations.
+
+## Install
+
+```sh
+npm install @lp-labs/token-bucket
+```
+
+Zero runtime, peer, or sibling dependencies. Node 18+; strict TypeScript declarations and independent ESM/CommonJS builds. Version 0.1.0, MIT.
+
+## Quickstart
+
+```js
+import { TokenBucket } from '@lp-labs/token-bucket';
+let now = 0;
+const bucket = new TokenBucket({ capacity: 4, refillPerSecond: 2, clock: () => now });
+bucket.tryTake(4);
+now = 250;
+console.log(bucket.available); // 0.5
+const reservation = bucket.reserve(0.5);
+reservation?.cancel();
+```
+
+## API and contracts
+
+Construct TokenBucket with positive finite capacity, nonnegative finite refillPerSecond,
+and clock. initialTokens defaults to capacity and must be in [0, capacity].
+available refreshes accounting before returning spendable tokens. tryTake(amount = 1)
+returns false without spending when insufficient. reserve(amount = 1) returns a
+Reservation or undefined when insufficient; delayFor(amount = 1) predicts a wait.
+Amounts must be positive finite values no greater than capacity.
+
+Clock values are monotonic milliseconds, supplied by the caller (for example performance.now). Backward/nonfinite clocks and invalid numeric options throw RangeError. Refill is fractional and capped; held reservations occupy capacity until committed or cancelled. Cancellation refunds exactly once; commit spends tokens and opens refill capacity. delayFor returns milliseconds or Infinity, not a scheduling guarantee. No timers, waiting queue, global server rate guarantee, distributed coordination, or adaptive/circuit-breaker policy. O(1) operations, O(active reservations) caller storage. Do not retain unused reservations indefinitely.
+
+Arithmetic uses JavaScript floating-point precision, not fixed-point credit accounting.
+
+## Full declarations
+
+The complete public declarations below are generated from the package's strict source. All runtime exports, interfaces, options, return types and readonly state are listed here.
+
+<!-- declarations -->
+
+```ts
+export interface TokenBucketOptions {
+  capacity: number;
+  refillPerSecond: number;
+  clock: () => number;
+  initialTokens?: number;
+}
+export interface Reservation {
+  readonly amount: number;
+  readonly state: 'reserved' | 'committed' | 'cancelled';
+  commit(): boolean;
+  cancel(): boolean;
+}
+export declare class TokenBucket {
+  readonly capacity: number;
+  readonly refillPerSecond: number;
+  private tokens;
+  private last;
+  private held;
+  private readonly clock;
+  constructor(options: TokenBucketOptions);
+  private refresh;
+  private check;
+  get available(): number;
+  tryTake(amount?: number): boolean;
+  delayFor(amount?: number): number;
+  reserve(amount?: number): Reservation | undefined;
+}
+```
+
+<!-- end declarations -->
+
+## Development
+
+```sh
+npm ci --offline
+npm run build
+npm run typecheck
+npm test
+npm run format:check
+```
+
+All tests use deterministic clocks, immediate injected sleeps, or explicit promise gates rather than timing guesses. Package exports select ESM for import and CommonJS for require, with separate declaration trees. No runtime configuration files or global hooks.
+
+## Support
+
+If this library is useful to you, consider supporting its maintenance with a [donation via PayPal](https://www.paypal.me/LibinPrasanth).
+
+## Author
+
+Created by [Libin Prasanth](https://www.linkedin.com/in/libinprasanth/). Connect on LinkedIn for updates and discussion.

package/dist/cjs/index.d.ts

@@ -0,0 +1,27 @@
+export interface TokenBucketOptions {
+    capacity: number;
+    refillPerSecond: number;
+    clock: () => number;
+    initialTokens?: number;
+}
+export interface Reservation {
+    readonly amount: number;
+    readonly state: 'reserved' | 'committed' | 'cancelled';
+    commit(): boolean;
+    cancel(): boolean;
+}
+export declare class TokenBucket {
+    readonly capacity: number;
+    readonly refillPerSecond: number;
+    private tokens;
+    private last;
+    private held;
+    private readonly clock;
+    constructor(options: TokenBucketOptions);
+    private refresh;
+    private check;
+    get available(): number;
+    tryTake(amount?: number): boolean;
+    delayFor(amount?: number): number;
+    reserve(amount?: number): Reservation | undefined;
+}

package/dist/cjs/index.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenBucket = void 0;
+class TokenBucket {
+    capacity;
+    refillPerSecond;
+    tokens;
+    last;
+    held = 0;
+    clock;
+    constructor(options) {
+        const { capacity, refillPerSecond, clock, initialTokens = capacity } = options;
+        if (!Number.isFinite(capacity) ||
+            capacity <= 0 ||
+            !Number.isFinite(refillPerSecond) ||
+            refillPerSecond < 0 ||
+            !Number.isFinite(initialTokens) ||
+            initialTokens < 0 ||
+            initialTokens > capacity)
+            throw new RangeError('Invalid bucket parameters');
+        this.capacity = capacity;
+        this.refillPerSecond = refillPerSecond;
+        this.clock = clock;
+        this.tokens = initialTokens;
+        this.last = clock();
+        if (!Number.isFinite(this.last))
+            throw new RangeError('Clock must be finite');
+    }
+    refresh() {
+        const now = this.clock();
+        if (!Number.isFinite(now) || now < this.last)
+            throw new RangeError('Clock must be monotonic milliseconds');
+        const elapsed = now - this.last;
+        const seconds = Number.isFinite(elapsed) ? elapsed / 1000 : now / 1000 - this.last / 1000;
+        const refill = this.refillPerSecond === 0 ? 0 : seconds * this.refillPerSecond;
+        this.tokens = Math.min(this.capacity - this.held, this.tokens + refill);
+        this.last = now;
+    }
+    check(amount) {
+        if (!Number.isFinite(amount) || amount <= 0 || amount > this.capacity)
+            throw new RangeError('Amount must be positive and within capacity');
+    }
+    get available() {
+        this.refresh();
+        return this.tokens;
+    }
+    tryTake(amount = 1) {
+        this.check(amount);
+        this.refresh();
+        if (this.tokens < amount)
+            return false;
+        this.tokens -= amount;
+        return true;
+    }
+    delayFor(amount = 1) {
+        this.check(amount);
+        this.refresh();
+        if (this.tokens >= amount)
+            return 0;
+        if (amount > this.capacity - this.held || this.refillPerSecond === 0)
+            return Infinity;
+        return ((amount - this.tokens) / this.refillPerSecond) * 1000;
+    }
+    reserve(amount = 1) {
+        if (!this.tryTake(amount))
+            return undefined;
+        this.held += amount;
+        let state = 'reserved';
+        const finish = (cancel) => {
+            if (state !== 'reserved')
+                return false;
+            this.refresh();
+            this.held -= amount;
+            if (cancel)
+                this.tokens += amount;
+            state = cancel ? 'cancelled' : 'committed';
+            return true;
+        };
+        return Object.freeze({
+            amount,
+            get state() {
+                return state;
+            },
+            commit: () => finish(false),
+            cancel: () => finish(true),
+        });
+    }
+}
+exports.TokenBucket = TokenBucket;

package/dist/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/dist/esm/index.d.ts

@@ -0,0 +1,27 @@
+export interface TokenBucketOptions {
+    capacity: number;
+    refillPerSecond: number;
+    clock: () => number;
+    initialTokens?: number;
+}
+export interface Reservation {
+    readonly amount: number;
+    readonly state: 'reserved' | 'committed' | 'cancelled';
+    commit(): boolean;
+    cancel(): boolean;
+}
+export declare class TokenBucket {
+    readonly capacity: number;
+    readonly refillPerSecond: number;
+    private tokens;
+    private last;
+    private held;
+    private readonly clock;
+    constructor(options: TokenBucketOptions);
+    private refresh;
+    private check;
+    get available(): number;
+    tryTake(amount?: number): boolean;
+    delayFor(amount?: number): number;
+    reserve(amount?: number): Reservation | undefined;
+}

package/dist/esm/index.js

@@ -0,0 +1,85 @@
+export class TokenBucket {
+    capacity;
+    refillPerSecond;
+    tokens;
+    last;
+    held = 0;
+    clock;
+    constructor(options) {
+        const { capacity, refillPerSecond, clock, initialTokens = capacity } = options;
+        if (!Number.isFinite(capacity) ||
+            capacity <= 0 ||
+            !Number.isFinite(refillPerSecond) ||
+            refillPerSecond < 0 ||
+            !Number.isFinite(initialTokens) ||
+            initialTokens < 0 ||
+            initialTokens > capacity)
+            throw new RangeError('Invalid bucket parameters');
+        this.capacity = capacity;
+        this.refillPerSecond = refillPerSecond;
+        this.clock = clock;
+        this.tokens = initialTokens;
+        this.last = clock();
+        if (!Number.isFinite(this.last))
+            throw new RangeError('Clock must be finite');
+    }
+    refresh() {
+        const now = this.clock();
+        if (!Number.isFinite(now) || now < this.last)
+            throw new RangeError('Clock must be monotonic milliseconds');
+        const elapsed = now - this.last;
+        const seconds = Number.isFinite(elapsed) ? elapsed / 1000 : now / 1000 - this.last / 1000;
+        const refill = this.refillPerSecond === 0 ? 0 : seconds * this.refillPerSecond;
+        this.tokens = Math.min(this.capacity - this.held, this.tokens + refill);
+        this.last = now;
+    }
+    check(amount) {
+        if (!Number.isFinite(amount) || amount <= 0 || amount > this.capacity)
+            throw new RangeError('Amount must be positive and within capacity');
+    }
+    get available() {
+        this.refresh();
+        return this.tokens;
+    }
+    tryTake(amount = 1) {
+        this.check(amount);
+        this.refresh();
+        if (this.tokens < amount)
+            return false;
+        this.tokens -= amount;
+        return true;
+    }
+    delayFor(amount = 1) {
+        this.check(amount);
+        this.refresh();
+        if (this.tokens >= amount)
+            return 0;
+        if (amount > this.capacity - this.held || this.refillPerSecond === 0)
+            return Infinity;
+        return ((amount - this.tokens) / this.refillPerSecond) * 1000;
+    }
+    reserve(amount = 1) {
+        if (!this.tryTake(amount))
+            return undefined;
+        this.held += amount;
+        let state = 'reserved';
+        const finish = (cancel) => {
+            if (state !== 'reserved')
+                return false;
+            this.refresh();
+            this.held -= amount;
+            if (cancel)
+                this.tokens += amount;
+            state = cancel ? 'cancelled' : 'committed';
+            return true;
+        };
+        return Object.freeze({
+            amount,
+            get state() {
+                return state;
+            },
+            commit: () => finish(false),
+            cancel: () => finish(true),
+        });
+    }
+}

package/package.json

@@ -1,6 +1,63 @@
 {
   "name": "@lp-labs/token-bucket",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Fractional local token accounting with cancellable burst reservations.",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "node scripts/build.mjs",
+    "typecheck": "npm run build && node scripts/check-types.mjs",
+    "test": "npm run build && node --test tests/*.test.mjs",
+    "format": "prettier --write src scripts tests *.json README.md",
+    "format:check": "prettier --check src scripts tests *.json README.md",
+    "prepack": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3",
+    "prettier": "^3.6.2"
+  },
+  "prettier": {
+    "singleQuote": true,
+    "semi": true,
+    "trailingComma": "all",
+    "printWidth": 100,
+    "endOfLine": "lf"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "author": {
+    "name": "Libin Prasanth",
+    "url": "https://www.linkedin.com/in/libinprasanth/"
+  },
+  "funding": {
+    "type": "paypal",
+    "url": "https://www.paypal.me/LibinPrasanth"
+  }
+}