@relaybus/testing 0.0.0-stage → 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Berkcan Şavur
+
+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,48 @@
-# Temporary Holding Version
+# @relaybus/testing
 
-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.
+Test utilities for relaybus.
+
+```sh
+pnpm add -D @relaybus/testing vitest
+```
+
+## Store contract suite
+
+Every `EventStore` must pass it unchanged against a real database:
+
+```ts
+import { eventStoreContract } from '@relaybus/testing';
+
+eventStoreContract('MyEventStore', {
+  createStore: async () => {
+    const store = new MyEventStore(await connect());
+    await store.setup();
+    return store;
+  },
+  destroyStore: async (store) => store.close(),
+  // a second instance on the same database with its own connections
+  createPeerStore: async () => new MyEventStore(await connect()),
+});
+```
+
+It covers transactional visibility, idempotent appends, leasing and fencing,
+retries and dead letters, release, per-key ordering in commit order, starvation,
+purge, statistics, data fidelity and cross-instance claim races.
+
+## FakeClock
+
+```ts
+const clock = new FakeClock('2026-01-01T00:00:00Z');
+const bus = new RelayBus({ store, clock });
+clock.advance(60_000); // make retries due
+await bus.drain();
+```
+
+## InMemoryTransport
+
+Records publishes, simulates outages with `failNextPublishes(n)` and delivers
+JSON copies to subscribers with `deliver(destination, envelope, maxRedeliveries)`.
+
+## License
+
+MIT