@rljson/server 0.0.6 → 0.0.8

package/README.architecture.md

@@ -134,6 +134,8 @@ The `Server` class acts as a central coordination point that:
 - Broadcasts notifications between clients
 - Provides read access to its own local storage
 
+**Relay mode (`disableLocalCache: true`):** When the `disableLocalCache` option is set, the server omits the local IoMem/BsMem from its IoMulti/BsMulti stacks. In this mode the server reads all data exclusively from connected client peers, acting as a pure relay without caching any data locally. This is useful for memory-constrained deployments where the server should not retain copies of client data.
+
 **Data Flow Architecture:**
 
 ```text

package/README.public.md

@@ -176,6 +176,7 @@ This is implemented with `IoMulti` and `BsMulti` internally, but the public API
 - `bs` – Bs interface used by server
 - `clients` – `Map` of connected clients (keyed by internal clientId)
 - `isTornDown` – whether the server has been shut down
+- `isLocalCacheDisabled` – whether local caching is disabled (pure relay mode)
 - `logger` – the `ServerLogger` instance (defaults to `noopLogger`)
 
 ## Example
@@ -306,17 +307,19 @@ const server = new Server(route, io, bs, {
   logger: new ConsoleLogger(),     // Structured logging (default: NoopLogger)
   refEvictionIntervalMs: 60_000,   // Ref dedup sweep interval (default: 60 s, 0 = disable)
   peerInitTimeoutMs: 30_000,       // Peer handshake timeout (default: 30 s, 0 = disable)
+  disableLocalCache: true,         // Pure relay mode — no local Io/Bs cache (default: false)
 });
 ```
 
-| Option                  | Default    | Description                                                                                                                             |
-| ----------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
-| `logger`                | NoopLogger | Structured logger for lifecycle, traffic, and error events.                                                                             |
-| `refEvictionIntervalMs` | 60 000     | Two-generation sweep interval for multicast ref dedup. Refs older than two intervals are forgotten, preventing unbounded memory growth. |
-| `peerInitTimeoutMs`     | 30 000     | Maximum time `addSocket()` waits for a peer to initialize. Prevents hanging on unresponsive clients.                                    |
-| `syncConfig`            | undefined  | Sync protocol configuration (see below). Enables ACK aggregation, gap-fill, and enriched payloads.                                      |
-| `refLogSize`            | 1 000      | Maximum number of recent payloads retained in the ref log for gap-fill responses.                                                       |
-| `ackTimeoutMs`          | 10 000     | Timeout for collecting individual client ACKs before emitting the aggregated ACK. Falls back to `syncConfig.ackTimeoutMs`.              |
+| Option                  | Default    | Description                                                                                                                                                                               |
+| ----------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `logger`                | NoopLogger | Structured logger for lifecycle, traffic, and error events.                                                                                                                               |
+| `refEvictionIntervalMs` | 60 000     | Two-generation sweep interval for multicast ref dedup. Refs older than two intervals are forgotten, preventing unbounded memory growth.                                                   |
+| `peerInitTimeoutMs`     | 30 000     | Maximum time `addSocket()` waits for a peer to initialize. Prevents hanging on unresponsive clients.                                                                                      |
+| `syncConfig`            | undefined  | Sync protocol configuration (see below). Enables ACK aggregation, gap-fill, and enriched payloads.                                                                                        |
+| `refLogSize`            | 1 000      | Maximum number of recent payloads retained in the ref log for gap-fill responses.                                                                                                         |
+| `ackTimeoutMs`          | 10 000     | Timeout for collecting individual client ACKs before emitting the aggregated ACK. Falls back to `syncConfig.ackTimeoutMs`.                                                                |
+| `disableLocalCache`     | false      | When true, the server skips creating local IoMem/BsMem caches. The server acts as a pure relay, reading data only from connected client peers. Useful for memory-constrained deployments. |
 
 ## Client options
 

package/dist/README.architecture.md

@@ -134,6 +134,8 @@ The `Server` class acts as a central coordination point that:
 - Broadcasts notifications between clients
 - Provides read access to its own local storage
 
+**Relay mode (`disableLocalCache: true`):** When the `disableLocalCache` option is set, the server omits the local IoMem/BsMem from its IoMulti/BsMulti stacks. In this mode the server reads all data exclusively from connected client peers, acting as a pure relay without caching any data locally. This is useful for memory-constrained deployments where the server should not retain copies of client data.
+
 **Data Flow Architecture:**
 
 ```text

package/dist/README.public.md

@@ -176,6 +176,7 @@ This is implemented with `IoMulti` and `BsMulti` internally, but the public API
 - `bs` – Bs interface used by server
 - `clients` – `Map` of connected clients (keyed by internal clientId)
 - `isTornDown` – whether the server has been shut down
+- `isLocalCacheDisabled` – whether local caching is disabled (pure relay mode)
 - `logger` – the `ServerLogger` instance (defaults to `noopLogger`)
 
 ## Example
@@ -306,17 +307,19 @@ const server = new Server(route, io, bs, {
   logger: new ConsoleLogger(),     // Structured logging (default: NoopLogger)
   refEvictionIntervalMs: 60_000,   // Ref dedup sweep interval (default: 60 s, 0 = disable)
   peerInitTimeoutMs: 30_000,       // Peer handshake timeout (default: 30 s, 0 = disable)
+  disableLocalCache: true,         // Pure relay mode — no local Io/Bs cache (default: false)
 });
 ```
 
-| Option                  | Default    | Description                                                                                                                             |
-| ----------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
-| `logger`                | NoopLogger | Structured logger for lifecycle, traffic, and error events.                                                                             |
-| `refEvictionIntervalMs` | 60 000     | Two-generation sweep interval for multicast ref dedup. Refs older than two intervals are forgotten, preventing unbounded memory growth. |
-| `peerInitTimeoutMs`     | 30 000     | Maximum time `addSocket()` waits for a peer to initialize. Prevents hanging on unresponsive clients.                                    |
-| `syncConfig`            | undefined  | Sync protocol configuration (see below). Enables ACK aggregation, gap-fill, and enriched payloads.                                      |
-| `refLogSize`            | 1 000      | Maximum number of recent payloads retained in the ref log for gap-fill responses.                                                       |
-| `ackTimeoutMs`          | 10 000     | Timeout for collecting individual client ACKs before emitting the aggregated ACK. Falls back to `syncConfig.ackTimeoutMs`.              |
+| Option                  | Default    | Description                                                                                                                                                                               |
+| ----------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `logger`                | NoopLogger | Structured logger for lifecycle, traffic, and error events.                                                                                                                               |
+| `refEvictionIntervalMs` | 60 000     | Two-generation sweep interval for multicast ref dedup. Refs older than two intervals are forgotten, preventing unbounded memory growth.                                                   |
+| `peerInitTimeoutMs`     | 30 000     | Maximum time `addSocket()` waits for a peer to initialize. Prevents hanging on unresponsive clients.                                                                                      |
+| `syncConfig`            | undefined  | Sync protocol configuration (see below). Enables ACK aggregation, gap-fill, and enriched payloads.                                                                                        |
+| `refLogSize`            | 1 000      | Maximum number of recent payloads retained in the ref log for gap-fill responses.                                                                                                         |
+| `ackTimeoutMs`          | 10 000     | Timeout for collecting individual client ACKs before emitting the aggregated ACK. Falls back to `syncConfig.ackTimeoutMs`.                                                                |
+| `disableLocalCache`     | false      | When true, the server skips creating local IoMem/BsMem caches. The server acts as a pure relay, reading data only from connected client peers. Useful for memory-constrained deployments. |
 
 ## Client options
 

package/dist/server.d.ts

@@ -41,6 +41,14 @@ export interface ServerOptions {
      * Defaults to the SyncConfig's ackTimeoutMs (or 10 000 ms).
      */
     ackTimeoutMs?: number;
+    /**
+     * When true, the server's IoMulti and BsMulti will NOT include a local
+     * in-memory cache (IoMem / BsMem). The server will only read data from
+     * connected client peers. Useful when the server should act as a pure
+     * relay without caching any data locally.
+     * Defaults to false (local cache enabled).
+     */
+    disableLocalCache?: boolean;
 }
 export declare class Server extends BaseNode {
     private _route;
@@ -66,6 +74,7 @@ export declare class Server extends BaseNode {
     private _refLog;
     private _refLogSize;
     private _ackTimeoutMs;
+    private _disableLocalCache;
     private _latestRef;
     private _bootstrapHeartbeatTimer?;
     private _tornDown;
@@ -126,10 +135,18 @@ export declare class Server extends BaseNode {
      * Returns the typed sync event names.
      */
     get events(): SyncEventNames;
+    /**
+     * Returns the configured maximum ref log size.
+     */
+    get refLogSize(): number;
     /**
      * Returns the current ref log contents (for diagnostics / testing).
      */
     get refLog(): readonly ConnectorPayload[];
+    /**
+     * Returns whether the local cache is disabled.
+     */
+    get isLocalCacheDisabled(): boolean;
     /**
      * Returns the latest ref tracked by the server (for bootstrap / diagnostics).
      */

package/dist/server.js

@@ -1407,6 +1407,7 @@ class Server extends BaseNode {
     this._localBs = _localBs;
     this._logger = options?.logger ?? noopLogger;
     this._peerInitTimeoutMs = options?.peerInitTimeoutMs ?? 3e4;
+    this._disableLocalCache = options?.disableLocalCache ?? false;
     this._syncConfig = options?.syncConfig;
     this._refLogSize = options?.refLogSize ?? 1e3;
     this._ackTimeoutMs = options?.ackTimeoutMs ?? options?.syncConfig?.ackTimeoutMs ?? 1e4;
@@ -1422,23 +1423,27 @@ class Server extends BaseNode {
       }, evictionMs);
       this._refEvictionTimer.unref();
     }
-    const ioMultiIoLocal = {
-      io: this._localIo,
-      dump: true,
-      read: true,
-      write: true,
-      priority: 1
-    };
-    this._ios.push(ioMultiIoLocal);
+    if (!this._disableLocalCache) {
+      const ioMultiIoLocal = {
+        io: this._localIo,
+        dump: true,
+        read: true,
+        write: true,
+        priority: 1
+      };
+      this._ios.push(ioMultiIoLocal);
+    }
     this._ioMulti = new IoMulti(this._ios);
     this._ioServer = new IoServer(this._ioMulti);
-    const bsMultiBsLocal = {
-      bs: this._localBs,
-      read: true,
-      write: true,
-      priority: 1
-    };
-    this._bss.push(bsMultiBsLocal);
+    if (!this._disableLocalCache) {
+      const bsMultiBsLocal = {
+        bs: this._localBs,
+        read: true,
+        write: true,
+        priority: 1
+      };
+      this._bss.push(bsMultiBsLocal);
+    }
     this._bsMulti = new BsMulti(this._bss);
     this._bsServer = new BsServer(this._bsMulti);
   }
@@ -1471,6 +1476,8 @@ class Server extends BaseNode {
   _refLog = [];
   _refLogSize;
   _ackTimeoutMs;
+  // Local cache toggle
+  _disableLocalCache;
   // Bootstrap state
   _latestRef;
   _bootstrapHeartbeatTimer;
@@ -1660,12 +1667,24 @@ class Server extends BaseNode {
   get events() {
     return this._events;
   }
+  /**
+   * Returns the configured maximum ref log size.
+   */
+  get refLogSize() {
+    return this._refLogSize;
+  }
   /**
    * Returns the current ref log contents (for diagnostics / testing).
    */
   get refLog() {
     return this._refLog;
   }
+  /**
+   * Returns whether the local cache is disabled.
+   */
+  get isLocalCacheDisabled() {
+    return this._disableLocalCache;
+  }
   /**
    * Returns the latest ref tracked by the server (for bootstrap / diagnostics).
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rljson/server",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Rljson server description",
   "homepage": "https://github.com/rljson/server",
   "bugs": "https://github.com/rljson/server/issues",