@afterrealism/dendri-client 2.4.0 → 2.5.0

package/README.md

@@ -10,30 +10,26 @@ npm install @afterrealism/dendri-client
 
 ## Connect To Your Server
 
-Dendri is self-host-first. You must provide the signaling server that your app should use:
+Pass the signaling server your app should use as a single URL:
 
 ```ts
 import { Dendri } from "@afterrealism/dendri-client";
 
 const peer = new Dendri({
-	host: "signal.example.com",
-	port: 443,
-	secure: true,
-	path: "/",
+	url: "wss://signal.example.com",
+	apiKey: "your-api-key", // only needed for hosted / multi-tenant deployments
 });
 ```
 
+`url` is shorthand for `host`/`port`/`secure`/`path` — pass those individually if you
+prefer; explicitly passed fields win over url-derived ones.
+
 You can also pass an explicit peer id as the first argument: `new Dendri("my-peer-id", { ... })`.
 
 Local development usually looks like:
 
 ```ts
-const peer = new Dendri({
-	host: "localhost",
-	port: 9876,
-	secure: false,
-	path: "/",
-});
+const peer = new Dendri({ url: "ws://localhost:9876" });
 ```
 
 ## Quick Start
@@ -65,12 +61,7 @@ Use `createDendriStore()` when integrating with UI frameworks:
 ```ts
 import { createDendriStore } from "@afterrealism/dendri-client";
 
-const store = createDendriStore({
-	host: "signal.example.com",
-	port: 443,
-	secure: true,
-	path: "/",
-});
+const store = createDendriStore({ url: "wss://signal.example.com" });
 
 const unsubscribe = store.subscribe(() => {
 	console.log(store.connectionState, store.peers);

package/dist/{chunk-MBMSG4EC.js → chunk-3CE674DE.js}

@@ -3529,7 +3529,7 @@ var Util = class extends BinaryPackChunker {
 var util = new Util();
 
 // src/api.ts
-var version = "2.4.0";
+var version = "2.5.0";
 var API = class _API {
   constructor(_options) {
     this._options = _options;
@@ -3542,6 +3542,7 @@ var API = class _API {
     const url = new URL(`${protocol}://${host}:${port}${path}${key}/${method}`);
     url.searchParams.set("ts", `${Date.now()}${Math.random()}`);
     url.searchParams.set("version", version);
+    if (this._options.apiKey) url.searchParams.set("api_key", this._options.apiKey);
     const controller = new AbortController();
     const timeoutId = setTimeout(() => controller.abort(), _API.FETCH_TIMEOUT);
     return fetch(url.href, {
@@ -3570,11 +3571,12 @@ var API = class _API {
   async getTurnCredentials() {
     const protocol = this._options.secure ? "https" : "http";
     const { host, port, path, key } = this._options;
-    const url = `${protocol}://${host}:${port}${path}${key}/turn-credentials`;
+    const url = new URL(`${protocol}://${host}:${port}${path}${key}/turn-credentials`);
+    if (this._options.apiKey) url.searchParams.set("api_key", this._options.apiKey);
     try {
       const controller = new AbortController();
       const timeoutId = setTimeout(() => controller.abort(), _API.FETCH_TIMEOUT);
-      const response = await fetch(url, {
+      const response = await fetch(url.href, {
         referrerPolicy: this._options.referrerPolicy,
         signal: controller.signal
       }).finally(() => clearTimeout(timeoutId));
@@ -5401,17 +5403,29 @@ var PollingTransport = class _PollingTransport extends SignalingTransport {
   _heartbeatTimer;
   _lastSeq = 0;
   _baseUrl;
+  _key;
+  _jwt;
+  _apiKey;
   _pingInterval;
   _abortController;
   /** Backoff schedule base delays in milliseconds. */
   static BACKOFF_SCHEDULE = [0, 1e3, 2e3, 4e3, 8e3, 16e3, 3e4];
   /** Random jitter range in milliseconds (applied as +/-). */
   static BACKOFF_JITTER = 500;
-  constructor(secure, host, port, path, _key, pingInterval = 5e3, _jwt) {
+  constructor(secure, host, port, path, key, pingInterval = 5e3, jwt, apiKey) {
     super();
     const protocol = secure ? "https://" : "http://";
     this._baseUrl = `${protocol + host}:${port}${path}`;
     this._pingInterval = pingInterval;
+    this._key = key;
+    this._jwt = jwt;
+    this._apiKey = apiKey;
+  }
+  /** Append the shared auth params (key, jwt, api_key) so every HTTP call authenticates like the WS transport. */
+  _applyAuthParams(params) {
+    params.set("key", this._key);
+    if (this._jwt) params.set("jwt", this._jwt);
+    if (this._apiKey) params.set("api_key", this._apiKey);
   }
   get reconnectAttempt() {
     return this._reconnectAttempt;
@@ -5439,6 +5453,7 @@ var PollingTransport = class _PollingTransport extends SignalingTransport {
           id: this._id,
           token: this._token
         });
+        this._applyAuthParams(params);
         if (this._lastSeq > 0) params.set("last_seq", String(this._lastSeq));
         const response = await fetch(`${this._baseUrl}http/poll?${params}`, {
           signal: this._abortController.signal
@@ -5477,6 +5492,7 @@ var PollingTransport = class _PollingTransport extends SignalingTransport {
       id: this._id,
       token: this._token
     });
+    this._applyAuthParams(params);
     try {
       await fetch(`${this._baseUrl}http/send?${params}`, {
         method: "POST",
@@ -5541,13 +5557,16 @@ var PollingTransport = class _PollingTransport extends SignalingTransport {
 };
 
 // src/socket.ts
-var version2 = "2.4.0";
+var version2 = "2.5.0";
 var Socket = class _Socket extends SignalingTransport {
-  constructor(secure, host, port, path, key, pingInterval = 5e3, jwt) {
+  constructor(secure, host, port, path, key, pingInterval = 5e3, jwt, apiKey) {
     super();
     this.pingInterval = pingInterval;
     const wsProtocol = secure ? "wss://" : "ws://";
     this._baseUrl = `${wsProtocol + host}:${port}${path}dendri?key=${key}`;
+    if (apiKey) {
+      this._baseUrl += `&api_key=${encodeURIComponent(apiKey)}`;
+    }
     this._jwt = jwt;
   }
   pingInterval;
@@ -5853,18 +5872,28 @@ var SSETransport = class _SSETransport extends SignalingTransport {
   _heartbeatTimer;
   _lastSeq = 0;
   _baseUrl;
+  _key;
   _jwt;
+  _apiKey;
   _pingInterval;
   /** Backoff schedule base delays in milliseconds. */
   static BACKOFF_SCHEDULE = [0, 1e3, 2e3, 4e3, 8e3, 16e3, 3e4];
   /** Random jitter range in milliseconds (applied as +/-). */
   static BACKOFF_JITTER = 500;
-  constructor(secure, host, port, path, _key, pingInterval = 5e3, jwt) {
+  constructor(secure, host, port, path, key, pingInterval = 5e3, jwt, apiKey) {
     super();
     const protocol = secure ? "https://" : "http://";
     this._baseUrl = `${protocol + host}:${port}${path}`;
     this._pingInterval = pingInterval;
+    this._key = key;
     this._jwt = jwt;
+    this._apiKey = apiKey;
+  }
+  /** Append the shared auth params (key, jwt, api_key) so every HTTP call authenticates like the WS transport. */
+  _applyAuthParams(params) {
+    params.set("key", this._key);
+    if (this._jwt) params.set("jwt", this._jwt);
+    if (this._apiKey) params.set("api_key", this._apiKey);
   }
   get reconnectAttempt() {
     return this._reconnectAttempt;
@@ -5882,10 +5911,9 @@ var SSETransport = class _SSETransport extends SignalingTransport {
     if (this._disconnected) return;
     const params = new URLSearchParams({
       id: this._id,
-      token: this._token,
-      key: "dendri"
+      token: this._token
     });
-    if (this._jwt) params.set("jwt", this._jwt);
+    this._applyAuthParams(params);
     if (this._lastSeq > 0) params.set("last_seq", String(this._lastSeq));
     const url = `${this._baseUrl}http/sse?${params}`;
     try {
@@ -5959,6 +5987,7 @@ var SSETransport = class _SSETransport extends SignalingTransport {
       id: this._id,
       token: this._token
     });
+    this._applyAuthParams(params);
     try {
       await fetch(`${this._baseUrl}http/send?${params}`, {
         method: "POST",
@@ -6031,6 +6060,28 @@ var SSETransport = class _SSETransport extends SignalingTransport {
 };
 
 // src/dendri.ts
+function parseServerUrl(url) {
+  let parsed;
+  try {
+    parsed = new URL(url);
+  } catch {
+    throw new Error(
+      `Invalid Dendri "url" option: "${url}". Expected a full URL like "wss://signal.example.com".`
+    );
+  }
+  const secure = parsed.protocol === "wss:" || parsed.protocol === "https:";
+  if (!secure && parsed.protocol !== "ws:" && parsed.protocol !== "http:") {
+    throw new Error(
+      `Invalid Dendri "url" protocol: "${parsed.protocol}". Use wss://, ws://, https://, or http://.`
+    );
+  }
+  return {
+    host: parsed.hostname,
+    port: parsed.port ? Number(parsed.port) : secure ? 443 : 80,
+    secure,
+    path: parsed.pathname || "/"
+  };
+}
 var Dendri = class _Dendri extends EventEmitterWithError {
   static DEFAULT_KEY = "dendri";
   _serializers = {
@@ -6121,6 +6172,9 @@ var Dendri = class _Dendri extends EventEmitterWithError {
     } else if (id) {
       userId = id.toString();
     }
+    if (providedOptions?.url) {
+      providedOptions = { ...parseServerUrl(providedOptions.url), ...providedOptions };
+    }
     const normalizedOptions = {
       debug: 0,
       // 1: Errors, 2: Warnings, 3: All logs
@@ -6239,7 +6293,8 @@ var Dendri = class _Dendri extends EventEmitterWithError {
       this._options.path,
       this._options.key,
       this._options.pingInterval,
-      this._options.jwt
+      this._options.jwt,
+      this._options.apiKey
     ) : transport === "polling" ? new PollingTransport(
       this._options.secure ?? false,
       this._options.host,
@@ -6247,7 +6302,8 @@ var Dendri = class _Dendri extends EventEmitterWithError {
       this._options.path,
       this._options.key,
       this._options.pingInterval,
-      this._options.jwt
+      this._options.jwt,
+      this._options.apiKey
     ) : new Socket(
       this._options.secure ?? false,
       this._options.host,
@@ -6255,7 +6311,8 @@ var Dendri = class _Dendri extends EventEmitterWithError {
       this._options.path,
       this._options.key,
       this._options.pingInterval,
-      this._options.jwt
+      this._options.jwt,
+      this._options.apiKey
     );
     socket.on("message" /* Message */, (data) => {
       this._handleMessage(data);
@@ -7967,5 +8024,5 @@ function createDendriStore(input) {
 }
 
 export { AckManager, BaseConnectionErrorType, BufferedConnection, ConnectionQuality, ConnectionState, ConnectionType, DataConnection, DataConnectionErrorType, Dendri, DendriError, DendriErrorType, HybridConnection, PollingTransport, PresenceManager, RelayEncryption, Room, RpcError, RpcErrorCode, RpcManager, SSETransport, SerializationType, ServerMessageType, SignalingTransport, SocketEventType, TopicClass, TopicManager, TransportMode, createDendriStore, electNewHost, isRpcRequest, isRpcResponse, isTopicEnvelope, logger_default, util };
-//# sourceMappingURL=chunk-MBMSG4EC.js.map
-//# sourceMappingURL=chunk-MBMSG4EC.js.map
+//# sourceMappingURL=chunk-3CE674DE.js.map
+//# sourceMappingURL=chunk-3CE674DE.js.map