@zero-server/grpc 0.9.6 → 0.9.7

package/index.d.ts

@@ -1,2 +1,2 @@
-// AUTO-GENERATED by .tools/generate-package-stubs.js — edit .tools/scope-manifest.js and re-run `npm run packages:generate`.
+// AUTO-GENERATED by .tools/generate-package-stubs.js - edit .tools/scope-manifest.js and re-run `npm run packages:generate`.
 export * from './types/grpc';

package/index.js

@@ -1,4 +1,4 @@
-// AUTO-GENERATED by .tools/generate-package-stubs.js — edit .tools/scope-manifest.js and re-run `npm run packages:generate`.
+// AUTO-GENERATED by .tools/generate-package-stubs.js - edit .tools/scope-manifest.js and re-run `npm run packages:generate`.
 'use strict';
 const lib = require("./lib/grpc");
 

package/lib/debug.js

@@ -16,7 +16,7 @@
  *   log.error('failed to connect', err);
  *   log('shorthand for debug level');
  *
- *   // Set minimum level — anything below is silenced
+ *   // Set minimum level - anything below is silenced
  *   debug.level('warn');   // only warn, error, fatal
  *   debug.level('silent'); // suppress all output
  *   debug.level('trace');  // show everything
@@ -81,7 +81,7 @@ _enabledPatterns = _parsePatterns();
  */
 function _isEnabled(ns)
 {
-    if (!_enabledPatterns) return true; // No DEBUG set — enable all
+    if (!_enabledPatterns) return true; // No DEBUG set - enable all
     let enabled = false;
     for (const { neg, re } of _enabledPatterns)
     {
@@ -116,7 +116,7 @@ function _ts()
 }
 
 /**
- * Format arguments (like console.log — supports %s, %d, %j, %o).
+ * Format arguments (like console.log - supports %s, %d, %j, %o).
  * @private
  */
 function _format(args)
@@ -278,13 +278,13 @@ function debug(namespace)
  * Messages below this level are silenced.
  *
  * @param {string|number} level - Level name or number.
- *   `'trace'` (0) — all output
- *   `'debug'` (1) — debug and above
- *   `'info'` (2) — info and above
- *   `'warn'` (3) — warn and above
- *   `'error'` (4) — error and fatal only
- *   `'fatal'` (5) — fatal only
- *   `'silent'` (6) — nothing
+ *   `'trace'` (0) - all output
+ *   `'debug'` (1) - debug and above
+ *   `'info'` (2) - info and above
+ *   `'warn'` (3) - warn and above
+ *   `'error'` (4) - error and fatal only
+ *   `'fatal'` (5) - fatal only
+ *   `'silent'` (6) - nothing
  */
 debug.level = function(level)
 {

package/lib/grpc/call.js

@@ -4,10 +4,10 @@
  *              Wraps HTTP/2 streams with protobuf encode/decode, metadata,
  *              framing, deadline enforcement, and cancellation support.
  *
- *              - `UnaryCall` — single request, single response
- *              - `ServerStreamCall` — single request, stream of responses
- *              - `ClientStreamCall` — stream of requests, single response
- *              - `BidiStreamCall` — bidirectional streaming
+ *              - `UnaryCall` - single request, single response
+ *              - `ServerStreamCall` - single request, stream of responses
+ *              - `ClientStreamCall` - stream of requests, single response
+ *              - `BidiStreamCall` - bidirectional streaming
  *
  * @example | Unary handler
  *   async function GetUser(call) {
@@ -181,7 +181,7 @@ class BaseCall extends EventEmitter
 
         if (!this._headersSent)
         {
-            // Trailers-Only response — include status in initial HEADERS frame
+            // Trailers-Only response - include status in initial HEADERS frame
             this._headersSent = true;
             try
             {
@@ -199,7 +199,7 @@ class BaseCall extends EventEmitter
         }
         else
         {
-            // Headers already sent — send trailing HEADERS after final DATA
+            // Headers already sent - send trailing HEADERS after final DATA
             this.stream.on('wantTrailers', () =>
             {
                 try { this.stream.sendTrailers(trailHeaders); }
@@ -359,7 +359,7 @@ class BaseCall extends EventEmitter
 // -- Unary Call --------------------------------------------
 
 /**
- * A unary gRPC call — single request message, single response message.
+ * A unary gRPC call - single request message, single response message.
  *
  * @class
  * @extends BaseCall
@@ -391,7 +391,7 @@ class UnaryCall extends BaseCall
     }
 
     /**
-     * Initialize the call — collect the full request body and decode it.
+     * Initialize the call - collect the full request body and decode it.
      * @private
      * @returns {Promise<void>}
      */
@@ -422,7 +422,7 @@ class UnaryCall extends BaseCall
 // -- Server Streaming Call ---------------------------------
 
 /**
- * A server-streaming gRPC call — single request, multiple responses.
+ * A server-streaming gRPC call - single request, multiple responses.
  * The handler calls `call.write(msg)` for each response and `call.end()` to finish.
  *
  * @class
@@ -481,7 +481,7 @@ class ServerStreamCall extends BaseCall
 // -- Client Streaming Call ---------------------------------
 
 /**
- * A client-streaming gRPC call — multiple requests, single response.
+ * A client-streaming gRPC call - multiple requests, single response.
  * The handler iterates `for await (const msg of call)` to consume messages,
  * then returns the response object.
  *
@@ -512,7 +512,7 @@ class ClientStreamCall extends BaseCall
     }
 
     /**
-     * Initialize — set up the frame parser to enqueue decoded messages.
+     * Initialize - set up the frame parser to enqueue decoded messages.
      * @private
      */
     _init()
@@ -560,7 +560,7 @@ class ClientStreamCall extends BaseCall
     }
 
     /**
-     * Async iterator — enables `for await (const msg of call)`.
+     * Async iterator - enables `for await (const msg of call)`.
      *
      * @returns {AsyncIterator<object>}
      */
@@ -589,7 +589,7 @@ class ClientStreamCall extends BaseCall
 // -- Bidirectional Streaming Call ---------------------------
 
 /**
- * A bidirectional streaming gRPC call — multiple requests AND multiple responses.
+ * A bidirectional streaming gRPC call - multiple requests AND multiple responses.
  * The handler can `for await` incoming messages while simultaneously
  * calling `call.write()` to send responses.
  *
@@ -673,7 +673,7 @@ class BidiStreamCall extends BaseCall
     }
 
     /**
-     * Async iterator — enables `for await (const msg of call)`.
+     * Async iterator - enables `for await (const msg of call)`.
      *
      * @returns {AsyncIterator<object>}
      */

package/lib/grpc/client.js

@@ -266,7 +266,7 @@ class GrpcClient extends EventEmitter
     // -- Unary Call -----------------------------------------
 
     /**
-     * Make a unary gRPC call — send one message, receive one response.
+     * Make a unary gRPC call - send one message, receive one response.
      *
      * @param {string} methodName - RPC method name as defined in the proto service.
      * @param {object} request - Request message object.
@@ -394,7 +394,7 @@ class GrpcClient extends EventEmitter
     // -- Server Streaming ----------------------------------
 
     /**
-     * Make a server-streaming gRPC call — send one request, receive a stream of responses.
+     * Make a server-streaming gRPC call - send one request, receive a stream of responses.
      * Returns an async-iterable that yields decoded response messages.
      *
      * @param {string} methodName - RPC method name.
@@ -509,7 +509,7 @@ class GrpcClient extends EventEmitter
     // -- Client Streaming ----------------------------------
 
     /**
-     * Make a client-streaming gRPC call — send a stream of requests, receive one response.
+     * Make a client-streaming gRPC call - send a stream of requests, receive one response.
      * Returns a writable object with `write()`, `end()`, and a `response` Promise.
      *
      * @param {string} methodName - RPC method name.
@@ -608,7 +608,7 @@ class GrpcClient extends EventEmitter
     // -- Bidirectional Streaming ----------------------------
 
     /**
-     * Make a bidirectional streaming gRPC call — send and receive streams simultaneously.
+     * Make a bidirectional streaming gRPC call - send and receive streams simultaneously.
      * Returns an object that is both writable (`write`/`end`) and async-iterable.
      *
      * @param {string} methodName - RPC method name.

package/lib/grpc/codec.js

@@ -76,7 +76,7 @@ const TYPE_INFO = {
 // -- Writer ------------------------------------------------
 
 /**
- * Protobuf binary writer — encodes JavaScript objects into wire-format bytes.
+ * Protobuf binary writer - encodes JavaScript objects into wire-format bytes.
  *
  * @class
  *
@@ -397,7 +397,7 @@ class Writer
 // -- Reader ------------------------------------------------
 
 /**
- * Protobuf binary reader — decodes wire-format bytes into JavaScript values.
+ * Protobuf binary reader - decodes wire-format bytes into JavaScript values.
  *
  * @class
  *
@@ -762,7 +762,7 @@ class Reader
 function encode(obj, messageDesc, allMessages, depth = 0)
 {
     if (depth > MAX_RECURSION_DEPTH)
-        throw new Error(`Maximum encoding depth (${MAX_RECURSION_DEPTH}) exceeded — possible circular reference`);
+        throw new Error(`Maximum encoding depth (${MAX_RECURSION_DEPTH}) exceeded - possible circular reference`);
 
     if (!obj || typeof obj !== 'object')
         return Buffer.alloc(0);
@@ -809,7 +809,7 @@ function encode(obj, messageDesc, allMessages, depth = 0)
 function decode(buffer, messageDesc, allMessages, depth = 0)
 {
     if (depth > MAX_RECURSION_DEPTH)
-        throw new Error(`Maximum decoding depth (${MAX_RECURSION_DEPTH}) exceeded — possible circular reference`);
+        throw new Error(`Maximum decoding depth (${MAX_RECURSION_DEPTH}) exceeded - possible circular reference`);
 
     if (!Buffer.isBuffer(buffer) || buffer.length === 0)
         return _defaultObject(messageDesc);
@@ -830,7 +830,7 @@ function decode(buffer, messageDesc, allMessages, depth = 0)
 
         if (!field)
         {
-            // Unknown field — skip it (forward compatibility)
+            // Unknown field - skip it (forward compatibility)
             reader.skipField(wireType);
             continue;
         }
@@ -868,7 +868,7 @@ function _encodeField(writer, field, value, allMessages, depth)
 
     if (typeInfo)
     {
-        // Scalar type — skip default values in proto3
+        // Scalar type - skip default values in proto3
         if (_isDefaultValue(field.type, value)) return;
 
         writer.writeTag(field.number, typeInfo.wire);
@@ -913,7 +913,7 @@ function _encodeRepeated(writer, field, values, allMessages, depth)
     }
     else
     {
-        // Non-packable (strings, bytes, messages) — one tag per element
+        // Non-packable (strings, bytes, messages) - one tag per element
         for (const v of values) _encodeField(writer, field, v, allMessages, depth);
     }
 }

package/lib/grpc/credentials.js

@@ -5,7 +5,7 @@
  *              and metadata-based credentials. Supports certificate rotation
  *              and credential composition.
  *
- *              Uses only Node.js built-in `tls` and `fs` — no external packages.
+ *              Uses only Node.js built-in `tls` and `fs` - no external packages.
  *
  * @example | Insecure (plaintext)
  *   const { ChannelCredentials, GrpcClient } = require('@zero-server/sdk');
@@ -71,7 +71,7 @@ class ChannelCredentials
 
     /**
      * Create insecure (plaintext) credentials.
-     * No TLS — suitable for development or service-mesh environments
+     * No TLS - suitable for development or service-mesh environments
      * where transport security is handled by the infrastructure.
      *
      * @returns {ChannelCredentials}

package/lib/grpc/frame.js

@@ -23,7 +23,7 @@ const log = require('../debug')('zero:grpc');
 const FRAME_HEADER_SIZE = 5;
 
 /**
- * Maximum frame size (16 MB — matches the default gRPC max).
+ * Maximum frame size (16 MB - matches the default gRPC max).
  * @type {number}
  */
 const MAX_FRAME_SIZE = 16 * 1024 * 1024;
@@ -92,7 +92,7 @@ function _buildFrame(payload, flag)
 // -- Frame Decoder -----------------------------------------
 
 /**
- * Stateful gRPC frame parser — buffers incoming data and emits complete
+ * Stateful gRPC frame parser - buffers incoming data and emits complete
  * decompressed messages.  Designed to be fed chunks from an HTTP/2 stream.
  *
  * @class

package/lib/grpc/health.js

@@ -193,7 +193,7 @@ class HealthService
     }
 
     /**
-     * Handle a Check RPC — unary request for current health of a service.
+     * Handle a Check RPC - unary request for current health of a service.
      * @param {import('./call').UnaryCall} call
      */
     Check(call)
@@ -205,7 +205,7 @@ class HealthService
     }
 
     /**
-     * Handle a Watch RPC — server-stream that pushes status changes.
+     * Handle a Watch RPC - server-stream that pushes status changes.
      * Sends the current status immediately, then pushes on every change.
      * @param {import('./call').ServerStreamCall} call
      */
@@ -232,7 +232,7 @@ class HealthService
 
     /**
      * Get the schema object needed for server registration.
-     * Avoids requiring proto parsing — returns descriptors directly.
+     * Avoids requiring proto parsing - returns descriptors directly.
      * @returns {object} Schema compatible with GrpcServiceRegistry.addService
      */
     getSchema()

package/lib/grpc/index.js

@@ -1,6 +1,6 @@
 /**
  * @module grpc
- * @description Full gRPC support for zero-server — zero external dependencies.
+ * @description Full gRPC support for zero-server - zero external dependencies.
  *              Provides a proto3 parser, protobuf codec, gRPC framing, call objects,
  *              a service server, and a client for all four RPC patterns.
  *
@@ -14,7 +14,7 @@
  *              - Graceful shutdown with call draining
  *              - Message size limits and deadline enforcement
  *
- * @example | Quick Start — Server
+ * @example | Quick Start - Server
  *   const { createApp, parseProto } = require('@zero-server/sdk');
  *   const app = createApp();
  *   const schema = parseProto(`
@@ -35,7 +35,7 @@
  *
  *   app.listen(50051, { http2: true });
  *
- * @example | Quick Start — Client
+ * @example | Quick Start - Client
  *   const { GrpcClient, parseProto } = require('@zero-server/sdk');
  *   const schema = parseProto(fs.readFileSync('hello.proto', 'utf8'));
  *   const client = new GrpcClient('http://localhost:50051', schema, 'Greeter');

package/lib/grpc/metadata.js

@@ -1,6 +1,6 @@
 /**
  * @module grpc/metadata
- * @description gRPC metadata container — typed key-value pairs transmitted as
+ * @description gRPC metadata container - typed key-value pairs transmitted as
  *              HTTP/2 headers (initial metadata) and trailers (trailing metadata).
  *              Keys ending in `-bin` carry binary values (base64-encoded on the wire).
  *              All other keys carry ASCII string values.
@@ -44,7 +44,7 @@ const GRPC_INTERNAL = new Set([
 const MAX_KEY_LENGTH = 256;
 
 /**
- * Maximum total metadata size in bytes (soft limit — 8 KB default, configurable).
+ * Maximum total metadata size in bytes (soft limit - 8 KB default, configurable).
  * @type {number}
  */
 const DEFAULT_MAX_METADATA_SIZE = 8192;
@@ -52,7 +52,7 @@ const DEFAULT_MAX_METADATA_SIZE = 8192;
 // -- Metadata Class ----------------------------------------
 
 /**
- * gRPC metadata container — type-safe key-value pairs for headers and trailers.
+ * gRPC metadata container - type-safe key-value pairs for headers and trailers.
  *
  * @class
  *

package/lib/grpc/proto.js

@@ -1,6 +1,6 @@
 /**
  * @module grpc/proto
- * @description Zero-dependency proto3 parser — reads `.proto` file text and produces
+ * @description Zero-dependency proto3 parser - reads `.proto` file text and produces
  *              message descriptors, enum definitions, and service/RPC declarations
  *              that the codec and server use at runtime.
  *
@@ -17,9 +17,9 @@
  * @example
  *   const { parseProto } = require('./proto');
  *   const schema = parseProto(fs.readFileSync('chat.proto', 'utf8'));
- *   // schema.messages  — { MessageName: { fields: [...] } }
- *   // schema.enums     — { EnumName: { values: { ... } } }
- *   // schema.services  — { ServiceName: { methods: { ... } } }
+ *   // schema.messages  - { MessageName: { fields: [...] } }
+ *   // schema.enums     - { EnumName: { values: { ... } } }
+ *   // schema.services  - { ServiceName: { methods: { ... } } }
  */
 
 const fs = require('fs');
@@ -254,7 +254,7 @@ function parseProto(source, opts = {})
         {
             next(); expect('='); schema.syntax = next().value; expect(';');
             if (schema.syntax !== 'proto3')
-                log.warn('proto file uses syntax "%s" — only proto3 is fully supported', schema.syntax);
+                log.warn('proto file uses syntax "%s" - only proto3 is fully supported', schema.syntax);
         }
         else if (tok.value === 'package')
         {

package/lib/grpc/reflection.js

@@ -54,7 +54,7 @@ function buildFileDescriptorProto(schema, filename)
     // field 2: package (string)
     if (schema.package) w.string(2, schema.package);
 
-    // field 3: dependency (repeated string) — imported file names
+    // field 3: dependency (repeated string) - imported file names
     if (schema.imports)
     {
         for (const imp of schema.imports)
@@ -191,7 +191,7 @@ function _buildFieldDescriptorProto(field, schema)
     // field 9: oneof_index (if in a oneof)
     if (field.oneofName !== undefined)
     {
-        // Will use the index from the parent — simplified to 0 for now
+        // Will use the index from the parent - simplified to 0 for now
         w.int32(9, 0);
     }
 

package/lib/grpc/server.js

@@ -130,7 +130,7 @@ class GrpcServiceRegistry
         {
             if (!handlers[methodName])
             {
-                log.warn('no handler for %s/%s — will return UNIMPLEMENTED', serviceName, methodName);
+                log.warn('no handler for %s/%s - will return UNIMPLEMENTED', serviceName, methodName);
             }
 
             const routePath = pathPrefix + '/' + methodName;
@@ -178,7 +178,7 @@ class GrpcServiceRegistry
         const contentType = headers['content-type'] || '';
         if (!contentType.startsWith('application/grpc'))
         {
-            return false; // Not a gRPC request — let the normal HTTP pipeline handle it
+            return false; // Not a gRPC request - let the normal HTTP pipeline handle it
         }
 
         const grpcPath = headers[':path'];
@@ -290,7 +290,7 @@ class GrpcServiceRegistry
     }
 
     /**
-     * Begin draining — reject new calls and wait for active calls to finish.
+     * Begin draining - reject new calls and wait for active calls to finish.
      *
      * @param {number} [timeout=30000] - Maximum time to wait in ms.
      * @returns {Promise<void>}

package/lib/grpc/status.js

@@ -25,7 +25,7 @@ const GrpcStatus = {
     OK: 0,
     /** The operation was cancelled (typically by the caller). */
     CANCELLED: 1,
-    /** Unknown error — a catch-all for unexpected failures. */
+    /** Unknown error - a catch-all for unexpected failures. */
     UNKNOWN: 2,
     /** The client specified an invalid argument. */
     INVALID_ARGUMENT: 3,
@@ -47,7 +47,7 @@ const GrpcStatus = {
     OUT_OF_RANGE: 11,
     /** The operation is not implemented or not supported. */
     UNIMPLEMENTED: 12,
-    /** Internal error — invariants expected by the server have been broken. */
+    /** Internal error - invariants expected by the server have been broken. */
     INTERNAL: 13,
     /** The service is currently unavailable, usually a transient condition. */
     UNAVAILABLE: 14,

package/lib/grpc/watch.js

@@ -4,7 +4,7 @@
  *              Watches `.proto` files for changes using `fs.watch()` and
  *              re-parses/re-registers gRPC services automatically.
  *
- *              **Dev-only** — disabled by default when `NODE_ENV=production`.
+ *              **Dev-only** - disabled by default when `NODE_ENV=production`.
  *
  * @example
  *   const { createApp, watchProto } = require('@zero-server/sdk');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zero-server/grpc",
-  "version": "0.9.6",
+  "version": "0.9.7",
   "description": "gRPC server, client, codec, framing, status, metadata, health, reflection, balancer.",
   "keywords": [
     "zero-server",
@@ -45,7 +45,7 @@
   },
   "sideEffects": false,
   "peerDependencies": {
-    "@zero-server/sdk": ">=0.9.6"
+    "@zero-server/sdk": ">=0.9.7"
   },
   "peerDependenciesMeta": {
     "@zero-server/sdk": {

package/types/body.d.ts

@@ -1,4 +1,4 @@
-// Re-exports for @zero-server/body — body parser types
+// Re-exports for @zero-server/body - body parser types
 export {
     BodyParserOptions,
     JsonParserOptions,

package/types/cli.d.ts

@@ -1,2 +1,2 @@
-// Re-exports for @zero-server/cli — CLI runner types
+// Re-exports for @zero-server/cli - CLI runner types
 export { CLI, runCLI } from './orm';

package/types/index.d.ts

@@ -11,6 +11,18 @@ export { RouterInstance, RouteChain, RouteEntry, RouteInfo, RouteOptions, RouteH
 export { Request, RangeResult } from './request';
 export { Response, SendFileOptions, CookieOptions, PushOptions } from './response';
 export { SSEOptions, SSEStream } from './sse';
+export {
+    createWebRTC, SignalingHub, Room as WebRTCRoom, Peer as WebRTCPeer,
+    parseSdp, stringifySdp, parseCandidate, stringifyCandidate,
+    stunBinding, encodeBindingRequest, decodeMessage,
+    encodeXorMappedAddress, decodeXorMappedAddress,
+    STUN_MAGIC_COOKIE, STUN_METHOD, STUN_CLASS, STUN_ATTR,
+    issueTurnCredentials, TurnServer, SfuAdapter,
+    signJoinToken, verifyJoinToken,
+    WebRTCOptions, RoomOptions as WebRTCRoomOptions, PeerInfo, SignalingMessage,
+    IceServerConfig, TurnCredentials, IssueTurnCredentialsOptions, ClusterAdapter as WebRTCClusterAdapter,
+    WebRTCError, SignalingError, IceError, TurnError, SdpError,
+} from './webrtc';
 export { LifecycleManager, LifecycleState, LIFECYCLE_STATE } from './lifecycle';
 export { ClusterManager, ClusterOptions, cluster } from './cluster';
 export {
@@ -294,10 +306,10 @@ declare const zeroServer: {
     LIFECYCLE_STATE: typeof LIFECYCLE_STATE;
     ClusterManager: typeof ClusterManager;
     cluster: typeof clusterize;
-    // Observability — Structured Logging
+    // Observability - Structured Logging
     Logger: typeof Logger;
     structuredLogger: typeof structuredLogger;
-    // Observability — Metrics
+    // Observability - Metrics
     Counter: typeof Counter;
     Gauge: typeof Gauge;
     Histogram: typeof Histogram;
@@ -306,14 +318,14 @@ declare const zeroServer: {
     createDefaultMetrics: typeof createDefaultMetrics;
     metricsMiddleware: typeof metricsMiddleware;
     metricsEndpoint: typeof metricsEndpointHandler;
-    // Observability — Tracing
+    // Observability - Tracing
     Span: typeof Span;
     Tracer: typeof Tracer;
     parseTraceparent: typeof parseTraceparent;
     formatTraceparent: typeof formatTraceparent;
     tracingMiddleware: typeof tracingMiddleware;
     instrumentFetch: typeof instrumentFetch;
-    // Observability — Health Checks
+    // Observability - Health Checks
     healthCheck: typeof healthCheck;
     createHealthHandlers: typeof createHealthHandlers;
     memoryCheck: typeof memoryCheck;

package/types/middleware.d.ts

@@ -136,7 +136,7 @@ export interface CompressOptions {
     level?: number;
     /** Force specific encoding(s). */
     encoding?: string | string[];
-    /** Filter function — return false to skip compression. */
+    /** Filter function - return false to skip compression. */
     filter?: (req: Request, res: Response) => boolean;
 }
 

package/types/orm.d.ts

@@ -29,7 +29,7 @@ export interface SchemaColumnDef {
     enum?: string[];
     /** Allowed values (set type). */
     values?: string[];
-    /** Mass-assignment protection — exclude from bulk writes. */
+    /** Mass-assignment protection - exclude from bulk writes. */
     guarded?: boolean;
     /** Precision for decimal types. */
     precision?: number;
@@ -229,7 +229,7 @@ export class Query {
     take(n: number): Query;
     /** Alias for offset (LINQ naming). */
     skip(n: number): Query;
-    /** Alias for exec — explicitly convert to array. */
+    /** Alias for exec - explicitly convert to array. */
     toArray(): Promise<Model[]>;
     /** Shorthand for orderBy(field, 'desc'). */
     orderByDesc(field: string): Query;
@@ -260,7 +260,7 @@ export class Query {
     /** Inject a raw WHERE clause for SQL adapters (ignored by memory/mongo). */
     whereRaw(sql: string, ...params: any[]): Query;
 
-    /** Thenable support — `await query`. */
+    /** Thenable support - `await query`. */
     then<TResult1 = Model[], TResult2 = never>(
         onfulfilled?: ((value: Model[]) => TResult1 | PromiseLike<TResult1>) | null,
         onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null

package/types/request.d.ts

@@ -31,7 +31,7 @@ export interface Request {
     readonly ips: string[];
     /** `true` when the connection is over TLS (trust-proxy-aware). */
     readonly secure: boolean;
-    /** Protocol string — `'https'` or `'http'` (trust-proxy-aware). */
+    /** Protocol string - `'https'` or `'http'` (trust-proxy-aware). */
     readonly protocol: 'http' | 'https';
     /** HTTP version string (e.g. '1.1', '2.0'). */
     httpVersion: string;
@@ -49,7 +49,7 @@ export interface Request {
     id?: string;
     /** Whether the request timed out (populated by timeout middleware). */
     timedOut?: boolean;
-    /** The original URL as received — never rewritten by middleware. */
+    /** The original URL as received - never rewritten by middleware. */
     originalUrl: string;
     /** The URL path on which the current router was mounted. */
     baseUrl: string;
@@ -83,7 +83,7 @@ export interface Request {
     subdomains(offset?: number): string[];
 
     /**
-     * Content negotiation — check which types the client accepts.
+     * Content negotiation - check which types the client accepts.
      */
     accepts(...types: string[]): string | false;
 

package/types/webrtc.d.ts

@@ -0,0 +1,501 @@
+/**
+ * TypeScript surface for @zero-server/webrtc.
+ *
+ * Mirrors the runtime surface exported from `lib/webrtc/index.js` and
+ * re-exported from the top-level SDK in `index.js`.  Every entry listed
+ * in `.tools/scope-manifest.js` under the `webrtc` scope MUST have a
+ * matching declaration here - this is enforced by
+ * `test/packages/webrtc-types.test.js`.
+ */
+
+import type { EventEmitter } from 'node:events';
+import type { KeyObject } from 'node:crypto';
+
+// ---------------------------------------------------------------------------
+//  Shared option / config types
+// ---------------------------------------------------------------------------
+
+export interface IceServerConfig {
+    urls: string | string[];
+    username?: string;
+    credential?: string;
+}
+
+export interface TurnCredentials {
+    urls: string[];
+    username: string;
+    credential: string;
+    ttl: number;
+}
+
+export interface IssueTurnCredentialsOptions {
+    secret: string;
+    userId: string;
+    ttl?: string | number;
+    servers: string[];
+    realm?: string;
+}
+
+export interface SignalingHubOptions {
+    maxSdpSize?: number;
+    maxCandidatesPerOffer?: number;
+    peerMessageRate?: number;
+    maxProtocolErrors?: number;
+    ipAttachRate?: number;
+    originAllowlist?: string[];
+    joinTokenSecret?: string | Buffer;
+    autoCreateRooms?: boolean;
+}
+
+export interface WebRTCOptions extends SignalingHubOptions {
+    path?: string;
+    iceServers?: IceServerConfig[] | 'auto';
+}
+
+export interface PeerAttachInfo {
+    user?: unknown;
+    ip?: string;
+    origin?: string;
+    [extra: string]: unknown;
+}
+
+export interface PeerTransport {
+    send(data: string): void;
+    on(event: 'message' | 'close', cb: (...args: unknown[]) => void): void;
+    close(code?: number, reason?: string): void;
+}
+
+// ---------------------------------------------------------------------------
+//  SDP / ICE helpers
+// ---------------------------------------------------------------------------
+
+export interface ParsedSdpMedia {
+    type: string;
+    port: number;
+    proto: string;
+    formats: string[];
+    iceUfrag?: string;
+    icePwd?: string;
+    fingerprint?: { algorithm: string; hash: string };
+    candidates?: ParsedIceCandidate[];
+    [key: string]: unknown;
+}
+
+export interface ParsedSdp {
+    version: number;
+    origin: Record<string, unknown>;
+    sessionName: string;
+    media: ParsedSdpMedia[];
+    [key: string]: unknown;
+}
+
+export interface ParsedIceCandidate {
+    foundation: string;
+    component: number;
+    transport: string;
+    priority: number;
+    address: string;
+    port: number;
+    type: string;
+    relatedAddress?: string;
+    relatedPort?: number;
+    tcpType?: string;
+    [key: string]: unknown;
+}
+
+export declare function parseSdp(sdp: string, opts?: { maxBytes?: number }): ParsedSdp;
+export declare function stringifySdp(parsed: ParsedSdp): string;
+
+export declare function parseCandidate(line: string): ParsedIceCandidate;
+export declare function stringifyCandidate(parsed: ParsedIceCandidate): string;
+export declare function filterCandidates(
+    candidates: ParsedIceCandidate[],
+    opts?: { allowPrivate?: boolean; allowLoopback?: boolean; allowLinkLocal?: boolean; allowMdns?: boolean }
+): ParsedIceCandidate[];
+
+export declare function isPrivateIp(addr: string): boolean;
+export declare function isLoopbackIp(addr: string): boolean;
+export declare function isLinkLocalIp(addr: string): boolean;
+export declare function isMdnsHostname(addr: string): boolean;
+
+export declare const CANDIDATE_TYPES: Readonly<{ HOST: string; SRFLX: string; PRFLX: string; RELAY: string }>;
+export declare const TCP_TYPES: Readonly<{ ACTIVE: string; PASSIVE: string; SO: string }>;
+
+// ---------------------------------------------------------------------------
+//  STUN / TURN
+// ---------------------------------------------------------------------------
+
+export declare function stunBinding(opts: {
+    host: string;
+    port?: number;
+    timeoutMs?: number;
+    retries?: number;
+    socketType?: 'udp4' | 'udp6';
+}): Promise<{ family: 4 | 6; address: string; port: number }>;
+
+export declare function encodeBindingRequest(transactionId?: Buffer): { buffer: Buffer; transactionId: Buffer };
+export declare function decodeMessage(buf: Buffer): {
+    method: number;
+    class: number;
+    transactionId: Buffer;
+    attributes: Array<{ type: number; value: Buffer }>;
+};
+export declare function encodeXorMappedAddress(address: string, port: number, transactionId: Buffer): Buffer;
+export declare function decodeXorMappedAddress(value: Buffer, transactionId: Buffer): { family: 4 | 6; address: string; port: number };
+
+export declare const STUN_MAGIC_COOKIE: number;
+export declare const STUN_METHOD: Readonly<{ BINDING: number }>;
+export declare const STUN_CLASS: Readonly<{ REQUEST: number; INDICATION: number; SUCCESS: number; ERROR: number }>;
+export declare const STUN_ATTR: Readonly<{ MAPPED_ADDRESS: number; XOR_MAPPED_ADDRESS: number; ERROR_CODE: number; SOFTWARE: number }>;
+
+export declare function issueTurnCredentials(opts: IssueTurnCredentialsOptions): TurnCredentials;
+
+export declare class TurnServer {
+    constructor(opts: {
+        secret: string;
+        realm?: string;
+        listeners: Array<{ proto: 'udp' | 'tcp' | 'tls'; port: number; host?: string; tls?: { cert: Buffer; key: Buffer } }>;
+        quotas?: { maxAllocationsPerUser?: number; maxBytesPerMinute?: number };
+        defaultLifetime?: number;
+        maxLifetime?: number;
+        relayHost?: string;
+    });
+    readonly realm: string;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    address(): { address: string; port: number } | null;
+    on(event: 'allocation', listener: (ev: { userId: string; relay: { address: string; port: number }; client: { address: string; port: number } }) => void): this;
+    on(event: 'deallocation', listener: (ev: { userId: string; client: { address: string; port: number }; reason?: string }) => void): this;
+    on(event: 'error', listener: (err: Error) => void): this;
+    on(event: string, listener: (...args: unknown[]) => void): this;
+}
+
+// ---------------------------------------------------------------------------
+//  Signaling core
+// ---------------------------------------------------------------------------
+
+export type PeerState = 'stable' | 'have-local-offer' | 'have-remote-offer';
+
+export declare const PEER_STATE: Readonly<{
+    STABLE: 'stable';
+    HAVE_LOCAL_OFFER: 'have-local-offer';
+    HAVE_REMOTE_OFFER: 'have-remote-offer';
+}>;
+
+export declare class Peer {
+    readonly id: string;
+    readonly user: unknown;
+    readonly ip: string | null;
+    readonly transport: PeerTransport;
+    state: PeerState;
+    room: Room | null;
+    errors: number;
+    readonly connectedAt: number;
+    closed: boolean;
+    e2ee?: E2eeChannel;
+    constructor(transport: PeerTransport, info?: PeerAttachInfo);
+    send(type: string, payload?: object): void;
+    sendError(code: string, message: string): void;
+    close(code?: number, reason?: string): void;
+}
+
+export declare class Room {
+    readonly name: string;
+    readonly hub: SignalingHub | null;
+    isOpen: boolean;
+    constructor(name: string, opts?: { hub?: SignalingHub });
+    open(): this;
+    require(fn: (peer: Peer) => boolean | Promise<boolean>): this;
+    canPublish(fn: (peer: Peer) => boolean): this;
+    canSubscribe(fn: (peer: Peer) => boolean): this;
+    readonly size: number;
+    peers(): Peer[];
+    canJoin(peer: Peer): boolean | Promise<boolean>;
+    broadcast(type: string, payload?: object, exceptPeerId?: string): void;
+    close(reason?: string): void;
+}
+
+export interface SignalingHubEvents {
+    join:            (ev: { peer: Peer; room: Room }) => void;
+    leave:           (ev: { peer: Peer; room: Room }) => void;
+    offer:           (ev: { peer: Peer; target: Peer | null; room: Room; sdp: string }) => void;
+    answer:          (ev: { peer: Peer; target: Peer | null; room: Room; sdp: string }) => void;
+    signal:          (ev: { peer: Peer; type: string }) => void;
+    joinFailed:      (ev: { peer: Peer; reason: string; room?: string }) => void;
+    publishFailed:   (ev: { peer: Peer; reason: string; room: string }) => void;
+    subscribeFailed: (ev: { peer: Peer; reason: string; room: string }) => void;
+    wireError:       (ev: { peer: Peer; code: string }) => void;
+    e2eeKey:         (ev: { peer: Peer; room: Room; epoch: number; key: string }) => void;
+    clusterError:    (err: Error) => void;
+}
+
+export declare class SignalingHub extends EventEmitter {
+    constructor(opts?: SignalingHubOptions);
+    readonly size: number;
+    room(name: string): Room;
+    rooms(): Room[];
+    attach(transport: PeerTransport, info?: PeerAttachInfo): Peer;
+    close(): void;
+    on<E extends keyof SignalingHubEvents>(event: E, listener: SignalingHubEvents[E]): this;
+    on(event: string, listener: (...args: unknown[]) => void): this;
+    off<E extends keyof SignalingHubEvents>(event: E, listener: SignalingHubEvents[E]): this;
+    off(event: string, listener: (...args: unknown[]) => void): this;
+    emit<E extends keyof SignalingHubEvents>(event: E, ...args: Parameters<SignalingHubEvents[E]>): boolean;
+    emit(event: string, ...args: unknown[]): boolean;
+}
+
+export declare function createWebRTC(app: unknown, opts?: WebRTCOptions): SignalingHub;
+
+// ---------------------------------------------------------------------------
+//  Join tokens
+// ---------------------------------------------------------------------------
+
+export interface SignJoinTokenOptions {
+    secret: string | Buffer;
+    user: string | { id?: string; userId?: string; sub?: string; [k: string]: unknown };
+    room: string;
+    ttl?: number;
+    claims?: Record<string, unknown>;
+    algorithm?: string;
+    audience?: string;
+}
+
+export interface VerifyJoinTokenOptions {
+    secret: string | Buffer;
+    room?: string;
+    audience?: string | string[];
+    algorithms?: string | string[];
+    clockTolerance?: number;
+}
+
+export declare function signJoinToken(opts: SignJoinTokenOptions): string;
+
+export declare function verifyJoinToken(
+    token: string,
+    opts: VerifyJoinTokenOptions
+): { room: string; user: unknown; sub?: string; aud?: string; [k: string]: unknown };
+
+// ---------------------------------------------------------------------------
+//  Observability
+// ---------------------------------------------------------------------------
+
+export interface ObservabilityBindOptions {
+    metrics?: unknown;
+    tracer?: unknown;
+    prefix?: string;
+}
+
+export declare function bindObservability(
+    hub: SignalingHub,
+    opts?: ObservabilityBindOptions
+): () => void;
+
+// ---------------------------------------------------------------------------
+//  E2EE key relay
+// ---------------------------------------------------------------------------
+
+export interface E2eeKeyEvent {
+    from: string;
+    epoch: number;
+    key: Buffer;
+}
+
+export declare class E2eeChannel {
+    readonly peer: Peer;
+    readonly hub: SignalingHub;
+    epoch: number;
+    constructor(peer: Peer, hub: SignalingHub);
+    publish(epoch: number | null, key: Buffer | Uint8Array | string): number;
+    subscribe(fn: (ev: E2eeKeyEvent) => void): () => void;
+}
+
+export declare function attachE2ee(peer: Peer, hub: SignalingHub): E2eeChannel;
+export declare function generateE2eeKeyPair(): { publicKey: KeyObject; privateKey: KeyObject };
+export declare function sealKey(plaintext: Buffer | Uint8Array, recipientPubKey: KeyObject | Buffer): Buffer;
+export declare function openSealedKey(sealed: Buffer | Uint8Array, recipientPrivKey: KeyObject | Buffer): Buffer;
+
+// ---------------------------------------------------------------------------
+//  Cluster adapter
+// ---------------------------------------------------------------------------
+
+export interface ClusterAdapter {
+    publish(channel: string, message: unknown): void | Promise<void>;
+    subscribe(channel: string, handler: (message: unknown) => void): (() => void) | void;
+}
+
+export interface UseClusterOptions {
+    nodeId?: string;
+}
+
+export declare class ClusterCoordinator {
+    readonly hub: SignalingHub;
+    readonly adapter: ClusterAdapter;
+    readonly nodeId: string;
+    constructor(hub: SignalingHub, adapter: ClusterAdapter, opts?: UseClusterOptions);
+    locate(peerId: string): { nodeId: string; room: string } | null;
+    routeDirect(toPeerId: string, type: string, payload: object): boolean;
+    fanoutRoom(roomName: string, type: string, payload: object, excludeId?: string): void;
+    close(): void;
+}
+
+export declare function useCluster(
+    hub: SignalingHub,
+    adapter: ClusterAdapter,
+    opts?: UseClusterOptions
+): ClusterCoordinator;
+
+export declare class MemoryClusterAdapter implements ClusterAdapter {
+    publish(channel: string, message: unknown): void;
+    subscribe(channel: string, handler: (message: unknown) => void): () => void;
+}
+
+// ---------------------------------------------------------------------------
+//  CLI
+// ---------------------------------------------------------------------------
+
+export interface WebRTCCommandDeps {
+    out?: (line: string) => void;
+    err?: (line: string) => void;
+    setExit?: (code: number) => void;
+    stunBinding?: typeof stunBinding;
+}
+
+export declare function runWebRTCCommand(
+    subcmd: 'stun' | 'turn-creds' | 'join-token' | 'verify-token' | 'help' | string,
+    flags?: Map<string, string>,
+    deps?: WebRTCCommandDeps
+): Promise<number>;
+
+// ---------------------------------------------------------------------------
+//  SFU adapter (interface only - real implementations land in later PRs)
+// ---------------------------------------------------------------------------
+
+export interface SfuPeerInfo {
+    id: string;
+    user?: unknown;
+    room: string;
+    joinedAt: number;
+}
+
+export interface SfuRouter { id: string; routerId: string; }
+export interface SfuTransport {
+    id: string;
+    transportId: string;
+    routerId: string;
+    peer: SfuPeerInfo | null;
+    iceParameters: unknown;
+    dtlsParameters: unknown;
+}
+export interface SfuProducer {
+    id: string;
+    producerId: string;
+    transportId: string;
+    kind: 'audio' | 'video';
+    rtpParams: unknown;
+    paused: boolean;
+}
+export interface SfuConsumer {
+    id: string;
+    consumerId: string;
+    transportId: string;
+    producerId: string;
+    kind: 'audio' | 'video';
+    rtpParams: unknown;
+    rtpCaps: unknown;
+}
+export interface SfuStats {
+    kind: 'global' | 'router' | 'transport';
+    [key: string]: unknown;
+}
+
+export type SfuEventHandler = (event: string, payload: unknown) => void;
+
+export declare class SfuAdapter {
+    constructor();
+    createRouter(opts?: unknown): Promise<SfuRouter>;
+    createTransport(router: SfuRouter, peer: SfuPeerInfo): Promise<SfuTransport>;
+    produce(transport: SfuTransport, kind: 'audio' | 'video', rtpParams: unknown): Promise<SfuProducer>;
+    consume(transport: SfuTransport, producerId: string, rtpCaps: unknown): Promise<SfuConsumer>;
+    pauseProducer(producerId: string): Promise<void>;
+    resumeProducer(producerId: string): Promise<void>;
+    closeRouter(routerId: string): Promise<void>;
+    stats(scope?: string): Promise<SfuStats>;
+    onEvent(handler: SfuEventHandler): () => void;
+}
+
+export declare class MemorySfuAdapter extends SfuAdapter {
+    constructor(opts?: Record<string, unknown>);
+}
+
+export interface MediasoupAdapterOptions {
+    mediasoup?: unknown;
+    worker?: unknown;
+    workerSettings?: Record<string, unknown>;
+    mediaCodecs?: Array<Record<string, unknown>>;
+    webRtcTransportOptions?: Record<string, unknown>;
+}
+
+export declare class MediasoupSfuAdapter extends SfuAdapter {
+    constructor(opts?: MediasoupAdapterOptions);
+    close(): Promise<void>;
+}
+
+export interface LiveKitAdapterOptions {
+    url: string;
+    apiKey: string;
+    apiSecret: string;
+    livekit?: unknown;
+    client?: unknown;
+    defaultRoomOpts?: Record<string, unknown>;
+    defaultGrants?: Record<string, unknown>;
+    tokenTtl?: string | number;
+}
+
+export declare class LiveKitSfuAdapter extends SfuAdapter {
+    constructor(opts: LiveKitAdapterOptions);
+}
+
+export declare function loadSfuAdapter(
+    spec: SfuAdapter | 'memory' | 'mediasoup' | 'livekit' | string,
+    opts?: Record<string, unknown>,
+): SfuAdapter;
+
+// ---------------------------------------------------------------------------
+//  Server-side bot peer (wrtc)
+// ---------------------------------------------------------------------------
+
+export interface BotPeerOptions {
+    hub:            SignalingHub;
+    room:           string;
+    user?:          unknown;
+    ip?:            string;
+    joinToken?:     string;
+    iceServers?:    Array<Record<string, unknown>>;
+    rtcConfig?:     Record<string, unknown>;
+    wrtc?:          unknown;
+    onTrack?:       (track: unknown, streams: unknown[], fromPeerId: string) => void;
+    onDataChannel?: (channel: unknown, fromPeerId: string) => void;
+    onPeerJoin?:    (remotePeerId: string) => void;
+    onPeerLeave?:   (remotePeerId: string) => void;
+    onError?:       (err: Error) => void;
+}
+
+export interface BotPeerHandle {
+    peer:               Peer;
+    peerConnections:    Map<string, unknown>;
+    getPeerConnection:  (remotePeerId: string) => unknown | undefined;
+    ready:              Promise<{ peerId: string }>;
+    close:              () => void;
+}
+
+export declare function spawnBotPeer(opts: BotPeerOptions): BotPeerHandle;
+
+// ---------------------------------------------------------------------------
+//  Errors
+// ---------------------------------------------------------------------------
+
+export declare class WebRTCError extends Error { readonly code: string; }
+export declare class SignalingError extends WebRTCError {}
+export declare class IceError extends WebRTCError {}
+export declare class TurnError extends WebRTCError {}
+export declare class SdpError extends WebRTCError {}