@lp-labs/async-barrier 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,76 @@
-# Temporary Holding Version
+# @lp-labs/async-barrier
 
-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.
+Cyclic fixed-party rendezvous with explicit broken generations.
+
+## Install
+
+```sh
+npm install @lp-labs/async-barrier
+```
+
+Zero runtime, peer, or sibling dependencies. Node 18+; strict TypeScript declarations and independent ESM/CommonJS builds. Version 0.1.0, MIT.
+
+## Quickstart
+
+```js
+import { AsyncBarrier } from '@lp-labs/async-barrier';
+const barrier = new AsyncBarrier(2);
+const passes = await Promise.all([barrier.wait(), barrier.wait()]);
+console.log(passes.map((pass) => pass.generation)); // [0, 0]
+```
+
+## API and contracts
+
+Each wait is one arrival; callers must ensure one arrival per logical party per generation. The final arrival resolves all with zero-based arrival index and generation, then automatically advances generation. Abort breaks the entire current generation, not merely its ticket. BarrierBrokenError retains cause (including undefined) and generation; break is idempotent and subsequent wait rejects until reset. reset rejects pending old arrivals and advances even an empty/broken generation. Abort after a successful pass cannot affect the next generation. parties is a positive safe integer or RangeError. No worker identity tracking, timeout scheduler, or task execution. O(parties) memory and release work; no timers.
+
+## 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 BarrierPass {
+  readonly generation: number;
+  readonly index: number;
+}
+export declare class BarrierBrokenError extends Error {
+  readonly generation: number;
+  constructor(generation: number, reason: unknown);
+}
+export declare class AsyncBarrier {
+  readonly parties: number;
+  private current;
+  private arrivals;
+  private failure;
+  constructor(parties: number);
+  get generation(): number;
+  get waiting(): number;
+  get broken(): boolean;
+  break(reason?: unknown): void;
+  reset(reason?: unknown): void;
+  wait(signal?: AbortSignal): Promise<BarrierPass>;
+}
+```
+
+<!-- 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,21 @@
+export interface BarrierPass {
+    readonly generation: number;
+    readonly index: number;
+}
+export declare class BarrierBrokenError extends Error {
+    readonly generation: number;
+    constructor(generation: number, reason: unknown);
+}
+export declare class AsyncBarrier {
+    readonly parties: number;
+    private current;
+    private arrivals;
+    private failure;
+    constructor(parties: number);
+    get generation(): number;
+    get waiting(): number;
+    get broken(): boolean;
+    break(reason?: unknown): void;
+    reset(reason?: unknown): void;
+    wait(signal?: AbortSignal): Promise<BarrierPass>;
+}

package/dist/cjs/index.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AsyncBarrier = exports.BarrierBrokenError = void 0;
+class BarrierBrokenError extends Error {
+    generation;
+    constructor(generation, reason) {
+        super('Barrier generation is broken', { cause: reason });
+        this.name = 'BarrierBrokenError';
+        this.generation = generation;
+    }
+}
+exports.BarrierBrokenError = BarrierBrokenError;
+class AsyncBarrier {
+    parties;
+    current = 0;
+    arrivals = [];
+    failure;
+    constructor(parties) {
+        if (!Number.isSafeInteger(parties) || parties < 1)
+            throw new RangeError('parties must be a positive safe integer');
+        this.parties = parties;
+    }
+    get generation() {
+        return this.current;
+    }
+    get waiting() {
+        return this.arrivals.length;
+    }
+    get broken() {
+        return this.failure !== undefined;
+    }
+    break(reason) {
+        if (this.failure)
+            return;
+        this.failure = new BarrierBrokenError(this.current, reason);
+        const arrivals = this.arrivals;
+        this.arrivals = [];
+        for (const arrival of arrivals) {
+            arrival.cleanup();
+            arrival.reject(this.failure);
+        }
+    }
+    reset(reason) {
+        this.break(reason);
+        this.failure = undefined;
+        this.current++;
+    }
+    wait(signal) {
+        if (this.failure)
+            return Promise.reject(this.failure);
+        if (signal?.aborted) {
+            this.break(signal.reason);
+            return Promise.reject(this.failure);
+        }
+        return new Promise((resolve, reject) => {
+            const generation = this.current;
+            const abort = () => {
+                if (this.current === generation)
+                    this.break(signal?.reason);
+            };
+            this.arrivals.push({
+                resolve,
+                reject,
+                cleanup: () => signal?.removeEventListener('abort', abort),
+            });
+            signal?.addEventListener('abort', abort, { once: true });
+            if (this.arrivals.length === this.parties) {
+                const arrivals = this.arrivals;
+                this.arrivals = [];
+                this.current++;
+                arrivals.forEach((arrival, position) => {
+                    arrival.cleanup();
+                    arrival.resolve(Object.freeze({ generation, index: position }));
+                });
+            }
+        });
+    }
+}
+exports.AsyncBarrier = AsyncBarrier;

package/dist/cjs/package.json

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

package/dist/esm/index.d.ts

@@ -0,0 +1,21 @@
+export interface BarrierPass {
+    readonly generation: number;
+    readonly index: number;
+}
+export declare class BarrierBrokenError extends Error {
+    readonly generation: number;
+    constructor(generation: number, reason: unknown);
+}
+export declare class AsyncBarrier {
+    readonly parties: number;
+    private current;
+    private arrivals;
+    private failure;
+    constructor(parties: number);
+    get generation(): number;
+    get waiting(): number;
+    get broken(): boolean;
+    break(reason?: unknown): void;
+    reset(reason?: unknown): void;
+    wait(signal?: AbortSignal): Promise<BarrierPass>;
+}

package/dist/esm/index.js

@@ -0,0 +1,74 @@
+export class BarrierBrokenError extends Error {
+    generation;
+    constructor(generation, reason) {
+        super('Barrier generation is broken', { cause: reason });
+        this.name = 'BarrierBrokenError';
+        this.generation = generation;
+    }
+}
+export class AsyncBarrier {
+    parties;
+    current = 0;
+    arrivals = [];
+    failure;
+    constructor(parties) {
+        if (!Number.isSafeInteger(parties) || parties < 1)
+            throw new RangeError('parties must be a positive safe integer');
+        this.parties = parties;
+    }
+    get generation() {
+        return this.current;
+    }
+    get waiting() {
+        return this.arrivals.length;
+    }
+    get broken() {
+        return this.failure !== undefined;
+    }
+    break(reason) {
+        if (this.failure)
+            return;
+        this.failure = new BarrierBrokenError(this.current, reason);
+        const arrivals = this.arrivals;
+        this.arrivals = [];
+        for (const arrival of arrivals) {
+            arrival.cleanup();
+            arrival.reject(this.failure);
+        }
+    }
+    reset(reason) {
+        this.break(reason);
+        this.failure = undefined;
+        this.current++;
+    }
+    wait(signal) {
+        if (this.failure)
+            return Promise.reject(this.failure);
+        if (signal?.aborted) {
+            this.break(signal.reason);
+            return Promise.reject(this.failure);
+        }
+        return new Promise((resolve, reject) => {
+            const generation = this.current;
+            const abort = () => {
+                if (this.current === generation)
+                    this.break(signal?.reason);
+            };
+            this.arrivals.push({
+                resolve,
+                reject,
+                cleanup: () => signal?.removeEventListener('abort', abort),
+            });
+            signal?.addEventListener('abort', abort, { once: true });
+            if (this.arrivals.length === this.parties) {
+                const arrivals = this.arrivals;
+                this.arrivals = [];
+                this.current++;
+                arrivals.forEach((arrival, position) => {
+                    arrival.cleanup();
+                    arrival.resolve(Object.freeze({ generation, index: position }));
+                });
+            }
+        });
+    }
+}

package/package.json

@@ -1,6 +1,63 @@
 {
   "name": "@lp-labs/async-barrier",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Cyclic fixed-party rendezvous with explicit broken generations.",
+  "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"
+  }
+}