@afterrealism/dendri-client 2.3.7 → 2.5.0

package/dist/{store-RTivRmUW.d.cts → store-C3Nwl62R.d.cts}

@@ -133,7 +133,10 @@ declare enum ServerMessageType {
     RoomPeers = "ROOM-PEERS",// List of peers in a room.
     HostMigrate = "HOST-MIGRATE",// Host migration notification.
     PresenceUpdate = "PRESENCE-UPDATE",// Presence data broadcast.
-    KeyExchange = "KEY-EXCHANGE"
+    KeyExchange = "KEY-EXCHANGE",// E2E encryption key exchange for relay.
+    ConnectRequest = "CONNECT-REQUEST",// Address exchange for Connection Reversal (H1)
+    DcutrConnect = "DCUTR-CONNECT",// DCUtR hole punch address exchange (H2)
+    DcutrSync = "DCUTR-SYNC"
 }
 declare enum TransportMode {
     WebRTC = "webrtc",
@@ -162,6 +165,12 @@ declare enum ConnectionQuality {
     Poor = "poor",
     Unknown = "unknown"
 }
+declare enum TopicClass {
+    /** Reliable, persisted, replayed — data integrity critical (Yjs updates, RPC) */
+    Persistent = "persistent",
+    /** Best-effort, not replayed — ephemeral UX state (cursor, scroll, typing indicators) */
+    Ephemeral = "ephemeral"
+}
 
 interface ServerMessage {
     type: ServerMessageType;
@@ -262,6 +271,7 @@ declare abstract class DataConnection extends BaseConnection<DataConnectionEvent
     constructor(peerId: string, provider: Dendri, options: any);
     /** Called by the Negotiator when the DataChannel is ready. */
     _initializeDataChannel(dc: RTCDataChannel): void;
+    private _applyAdaptiveBuffer;
     /**
      * Exposed functionality for users.
      */
@@ -317,6 +327,13 @@ interface AnswerOption {
 }
 interface DendriOption {
     key?: string;
+    /**
+     * Full server URL, e.g. `"wss://signal.example.com"` or `"http://127.0.0.1:9876"`.
+     * Shorthand for host/port/secure/path; any of those passed explicitly win.
+     */
+    url?: string;
+    /** API key for hosted / multi-tenant Dendri deployments. Sent with every signaling and REST request. */
+    apiKey?: string;
     host?: string;
     port?: number;
     path?: string;
@@ -325,7 +342,7 @@ interface DendriOption {
     config?: RTCConfiguration;
     debug?: number;
     referrerPolicy?: ReferrerPolicy;
-    /** Auto-fetch TURN credentials from the signaling server's GET /turn endpoint. */
+    /** Auto-fetch TURN credentials from the signaling server's GET /{key}/turn-credentials endpoint. */
     fetchTurnCredentials?: boolean;
     /** Optional JWT for authenticated connections. */
     jwt?: string;
@@ -515,6 +532,9 @@ declare class HybridConnection extends EventEmitter<HybridConnectionEvents> {
      * Respects `autoUpgrade`, `upgradeInterval`, and `maxUpgradeAttempts` options.
      */
     private _scheduleUpgrade;
+    private _tryConnectionReversal;
+    private _gatherSrflxCandidates;
+    _dcutrHolePunch(): Promise<boolean>;
 }
 
 declare enum LogLevel {
@@ -622,6 +642,13 @@ declare class DendriOptions implements DendriOption {
      * Prints log messages depending on the debug level passed in.
      */
     debug?: LogLevel;
+    /**
+     * Full server URL, e.g. `"wss://signal.example.com"` or `"http://127.0.0.1:9876"`.
+     * Shorthand for host/port/secure/path; any of those passed explicitly win.
+     */
+    url?: string;
+    /** API key for hosted / multi-tenant Dendri deployments. Sent with every signaling and REST request. */
+    apiKey?: string;
     /**
      * Server host for your Dendri signaling server.
      * Also accepts `'/'` to signify relative hostname.
@@ -648,7 +675,7 @@ declare class DendriOptions implements DendriOption {
      *
      * Defaults to {@apilink util.defaultConfig}
      */
-    config?: any;
+    config?: RTCConfiguration;
     /**
      * Set to true `true` if you're using TLS.
      * :::danger
@@ -658,7 +685,7 @@ declare class DendriOptions implements DendriOption {
     secure?: boolean;
     pingInterval?: number;
     referrerPolicy?: ReferrerPolicy;
-    logFunction?: (logLevel: LogLevel, ...rest: any[]) => void;
+    logFunction?: (logLevel: LogLevel, ...rest: unknown[]) => void;
     serializers?: SerializerMapping;
     /** Auto-fetch TURN credentials from the signaling server's GET /turn endpoint. */
     fetchTurnCredentials?: boolean;
@@ -670,6 +697,12 @@ declare class DendriOptions implements DendriOption {
     validateMetadata?: (metadata: unknown) => boolean;
     /** Signaling transport: 'websocket' (default), 'sse', 'polling', or 'auto' (tries WS then SSE then polling) */
     signalingTransport?: "websocket" | "sse" | "polling" | "auto";
+    /**
+     * ICE candidate privacy policy.
+     * - 'all': RFC 8828 mode 1 — all candidates including host IPs (default)
+     * - 'public': RFC 8828 mode 3 — only STUN/TURN (srflx + relay) candidates
+     */
+    ipPolicy?: "all" | "public";
 }
 
 interface SerializerMapping {
@@ -1375,4 +1408,4 @@ interface DendriStore {
  */
 declare function createDendriStore(input?: CreateDendriStoreInput): DendriStore;
 
-export { AckManager as A, BaseConnectionErrorType as B, type CallOption as C, Dendri as D, type RpcResponse as E, SerializationType as F, ServerMessageType as G, HybridConnection as H, SocketEventType as I, type StoreListener as J, TransportMode as K, LogLevel as L, MediaConnection as M, createDendriStore as N, isRpcRequest as O, type PresenceEvents as P, isRpcResponse as Q, Room as R, type SerializerMapping as S, type TransportEvents as T, type CreateDendriStoreInput as U, DataConnection as a, SignalingTransport as b, type AnswerOption as c, ConnectionQuality as d, ConnectionState as e, ConnectionType as f, DataConnectionErrorType as g, type DendriConnectOption as h, DendriError as i, DendriErrorType as j, type DendriEvents as k, type DendriOption as l, DendriOptions as m, type DendriStore as n, type DendriStoreOptions as o, type DendriStoreSnapshot as p, type HybridConnectionOption as q, type HybridSendOptions as r, PresenceManager as s, type RoomEvents as t, type RoomOptions as u, RpcError as v, RpcErrorCode as w, type RpcHandler as x, RpcManager as y, type RpcRequest as z };
+export { AckManager as A, BaseConnectionErrorType as B, type CallOption as C, Dendri as D, type RpcResponse as E, SerializationType as F, ServerMessageType as G, HybridConnection as H, SocketEventType as I, type StoreListener as J, type TransportEvents as K, LogLevel as L, MediaConnection as M, TransportMode as N, createDendriStore as O, type PresenceEvents as P, isRpcRequest as Q, Room as R, type SerializerMapping as S, TopicClass as T, isRpcResponse as U, type CreateDendriStoreInput as V, DataConnection as a, SignalingTransport as b, type AnswerOption as c, ConnectionQuality as d, ConnectionState as e, ConnectionType as f, DataConnectionErrorType as g, type DendriConnectOption as h, DendriError as i, DendriErrorType as j, type DendriEvents as k, type DendriOption as l, DendriOptions as m, type DendriStore as n, type DendriStoreOptions as o, type DendriStoreSnapshot as p, type HybridConnectionOption as q, type HybridSendOptions as r, PresenceManager as s, type RoomEvents as t, type RoomOptions as u, RpcError as v, RpcErrorCode as w, type RpcHandler as x, RpcManager as y, type RpcRequest as z };

package/dist/{store-RTivRmUW.d.ts → store-C3Nwl62R.d.ts}

@@ -133,7 +133,10 @@ declare enum ServerMessageType {
     RoomPeers = "ROOM-PEERS",// List of peers in a room.
     HostMigrate = "HOST-MIGRATE",// Host migration notification.
     PresenceUpdate = "PRESENCE-UPDATE",// Presence data broadcast.
-    KeyExchange = "KEY-EXCHANGE"
+    KeyExchange = "KEY-EXCHANGE",// E2E encryption key exchange for relay.
+    ConnectRequest = "CONNECT-REQUEST",// Address exchange for Connection Reversal (H1)
+    DcutrConnect = "DCUTR-CONNECT",// DCUtR hole punch address exchange (H2)
+    DcutrSync = "DCUTR-SYNC"
 }
 declare enum TransportMode {
     WebRTC = "webrtc",
@@ -162,6 +165,12 @@ declare enum ConnectionQuality {
     Poor = "poor",
     Unknown = "unknown"
 }
+declare enum TopicClass {
+    /** Reliable, persisted, replayed — data integrity critical (Yjs updates, RPC) */
+    Persistent = "persistent",
+    /** Best-effort, not replayed — ephemeral UX state (cursor, scroll, typing indicators) */
+    Ephemeral = "ephemeral"
+}
 
 interface ServerMessage {
     type: ServerMessageType;
@@ -262,6 +271,7 @@ declare abstract class DataConnection extends BaseConnection<DataConnectionEvent
     constructor(peerId: string, provider: Dendri, options: any);
     /** Called by the Negotiator when the DataChannel is ready. */
     _initializeDataChannel(dc: RTCDataChannel): void;
+    private _applyAdaptiveBuffer;
     /**
      * Exposed functionality for users.
      */
@@ -317,6 +327,13 @@ interface AnswerOption {
 }
 interface DendriOption {
     key?: string;
+    /**
+     * Full server URL, e.g. `"wss://signal.example.com"` or `"http://127.0.0.1:9876"`.
+     * Shorthand for host/port/secure/path; any of those passed explicitly win.
+     */
+    url?: string;
+    /** API key for hosted / multi-tenant Dendri deployments. Sent with every signaling and REST request. */
+    apiKey?: string;
     host?: string;
     port?: number;
     path?: string;
@@ -325,7 +342,7 @@ interface DendriOption {
     config?: RTCConfiguration;
     debug?: number;
     referrerPolicy?: ReferrerPolicy;
-    /** Auto-fetch TURN credentials from the signaling server's GET /turn endpoint. */
+    /** Auto-fetch TURN credentials from the signaling server's GET /{key}/turn-credentials endpoint. */
     fetchTurnCredentials?: boolean;
     /** Optional JWT for authenticated connections. */
     jwt?: string;
@@ -515,6 +532,9 @@ declare class HybridConnection extends EventEmitter<HybridConnectionEvents> {
      * Respects `autoUpgrade`, `upgradeInterval`, and `maxUpgradeAttempts` options.
      */
     private _scheduleUpgrade;
+    private _tryConnectionReversal;
+    private _gatherSrflxCandidates;
+    _dcutrHolePunch(): Promise<boolean>;
 }
 
 declare enum LogLevel {
@@ -622,6 +642,13 @@ declare class DendriOptions implements DendriOption {
      * Prints log messages depending on the debug level passed in.
      */
     debug?: LogLevel;
+    /**
+     * Full server URL, e.g. `"wss://signal.example.com"` or `"http://127.0.0.1:9876"`.
+     * Shorthand for host/port/secure/path; any of those passed explicitly win.
+     */
+    url?: string;
+    /** API key for hosted / multi-tenant Dendri deployments. Sent with every signaling and REST request. */
+    apiKey?: string;
     /**
      * Server host for your Dendri signaling server.
      * Also accepts `'/'` to signify relative hostname.
@@ -648,7 +675,7 @@ declare class DendriOptions implements DendriOption {
      *
      * Defaults to {@apilink util.defaultConfig}
      */
-    config?: any;
+    config?: RTCConfiguration;
     /**
      * Set to true `true` if you're using TLS.
      * :::danger
@@ -658,7 +685,7 @@ declare class DendriOptions implements DendriOption {
     secure?: boolean;
     pingInterval?: number;
     referrerPolicy?: ReferrerPolicy;
-    logFunction?: (logLevel: LogLevel, ...rest: any[]) => void;
+    logFunction?: (logLevel: LogLevel, ...rest: unknown[]) => void;
     serializers?: SerializerMapping;
     /** Auto-fetch TURN credentials from the signaling server's GET /turn endpoint. */
     fetchTurnCredentials?: boolean;
@@ -670,6 +697,12 @@ declare class DendriOptions implements DendriOption {
     validateMetadata?: (metadata: unknown) => boolean;
     /** Signaling transport: 'websocket' (default), 'sse', 'polling', or 'auto' (tries WS then SSE then polling) */
     signalingTransport?: "websocket" | "sse" | "polling" | "auto";
+    /**
+     * ICE candidate privacy policy.
+     * - 'all': RFC 8828 mode 1 — all candidates including host IPs (default)
+     * - 'public': RFC 8828 mode 3 — only STUN/TURN (srflx + relay) candidates
+     */
+    ipPolicy?: "all" | "public";
 }
 
 interface SerializerMapping {
@@ -1375,4 +1408,4 @@ interface DendriStore {
  */
 declare function createDendriStore(input?: CreateDendriStoreInput): DendriStore;
 
-export { AckManager as A, BaseConnectionErrorType as B, type CallOption as C, Dendri as D, type RpcResponse as E, SerializationType as F, ServerMessageType as G, HybridConnection as H, SocketEventType as I, type StoreListener as J, TransportMode as K, LogLevel as L, MediaConnection as M, createDendriStore as N, isRpcRequest as O, type PresenceEvents as P, isRpcResponse as Q, Room as R, type SerializerMapping as S, type TransportEvents as T, type CreateDendriStoreInput as U, DataConnection as a, SignalingTransport as b, type AnswerOption as c, ConnectionQuality as d, ConnectionState as e, ConnectionType as f, DataConnectionErrorType as g, type DendriConnectOption as h, DendriError as i, DendriErrorType as j, type DendriEvents as k, type DendriOption as l, DendriOptions as m, type DendriStore as n, type DendriStoreOptions as o, type DendriStoreSnapshot as p, type HybridConnectionOption as q, type HybridSendOptions as r, PresenceManager as s, type RoomEvents as t, type RoomOptions as u, RpcError as v, RpcErrorCode as w, type RpcHandler as x, RpcManager as y, type RpcRequest as z };
+export { AckManager as A, BaseConnectionErrorType as B, type CallOption as C, Dendri as D, type RpcResponse as E, SerializationType as F, ServerMessageType as G, HybridConnection as H, SocketEventType as I, type StoreListener as J, type TransportEvents as K, LogLevel as L, MediaConnection as M, TransportMode as N, createDendriStore as O, type PresenceEvents as P, isRpcRequest as Q, Room as R, type SerializerMapping as S, TopicClass as T, isRpcResponse as U, type CreateDendriStoreInput as V, DataConnection as a, SignalingTransport as b, type AnswerOption as c, ConnectionQuality as d, ConnectionState as e, ConnectionType as f, DataConnectionErrorType as g, type DendriConnectOption as h, DendriError as i, DendriErrorType as j, type DendriEvents as k, type DendriOption as l, DendriOptions as m, type DendriStore as n, type DendriStoreOptions as o, type DendriStoreSnapshot as p, type HybridConnectionOption as q, type HybridSendOptions as r, PresenceManager as s, type RoomEvents as t, type RoomOptions as u, RpcError as v, RpcErrorCode as w, type RpcHandler as x, RpcManager as y, type RpcRequest as z };