partysocket - npm Package Compare versions

Comparing version 0.0.0-7fc2814 to 0.0.0-7feb26e

dist/index.js

@@ -23,2 +23,3 @@ "use strict";
 __export(src_exports, {
+  PartySocket: () => PartySocket,
   WebSocket: () => ReconnectingWebSocket,
@@ -74,15 +75,21 @@ default: () => PartySocket
 function cloneEventNode(e) {
-  const evt = new Event(e.type, e);
   if ("data" in e) {
-    evt.data = e.data;
+    const evt2 = new MessageEvent(e.type, e);
+    return evt2;
   }
-  if ("code" in e) {
-    evt.code = e.code;
+  if ("code" in e || "reason" in e) {
+    const evt2 = new CloseEvent(
+      // @ts-expect-error we need to fix event/listener types
+      e.code || 1999,
+      // @ts-expect-error we need to fix event/listener types
+      e.reason || "unknown reason",
+      e
+    );
+    return evt2;
   }
-  if ("reason" in e) {
-    evt.reason = e.reason;
-  }
   if ("error" in e) {
-    evt.error = e.error;
+    const evt2 = new ErrorEvent(e.error, e);
+    return evt2;
   }
+  const evt = new Event(e.type, e);
   return evt;
@@ -103,2 +110,3 @@ }
 };
+var didWarnAboutMissingWebSocket = false;
 var ReconnectingWebSocket = class _ReconnectingWebSocket extends EventTarget {
@@ -114,2 +122,3 @@ _ws;
   _messageQueue = [];
+  _debugLogger = console.log.bind(console);
   _url;
@@ -126,2 +135,5 @@ _protocols;
     }
+    if (this._options.debugLogger) {
+      this._debugLogger = this._options.debugLogger;
+    }
     this._connect();
@@ -290,3 +302,3 @@ }
     if (this._options.debug) {
-      console.log.apply(console, ["RWS>", ...args]);
+      this._debugLogger("RWS>", ...args);
     }
@@ -316,4 +328,3 @@ }
   _getNextProtocols(protocolsProvider) {
-    if (!protocolsProvider)
-      return Promise.resolve(null);
+    if (!protocolsProvider) return Promise.resolve(null);
     if (typeof protocolsProvider === "string" || Array.isArray(protocolsProvider)) {
@@ -324,4 +335,3 @@ return Promise.resolve(protocolsProvider);
       const protocols = protocolsProvider();
-      if (!protocols)
-        return Promise.resolve(null);
+      if (!protocols) return Promise.resolve(null);
       if (typeof protocols === "string" || Array.isArray(protocols)) {
@@ -377,2 +387,19 @@ return Promise.resolve(protocols);
       }
+      if (!this._options.WebSocket && typeof WebSocket === "undefined" && !didWarnAboutMissingWebSocket) {
+        console.error(`\u203C\uFE0F No WebSocket implementation available. You should define options.WebSocket. 
+
+For example, if you're using node.js, run \`npm install ws\`, and then in your code:
+
+import PartySocket from 'partysocket';
+import WS from 'ws';
+
+const partysocket = new PartySocket({
+  host: "127.0.0.1:1999",
+  room: "test-room",
+  WebSocket: WS
+});
+
+`);
+        didWarnAboutMissingWebSocket = true;
+      }
       const WS = this._options.WebSocket || WebSocket;
@@ -511,2 +538,3 @@ this._debug("connect", { url, protocols });
     party,
+    prefix,
     query
@@ -530,3 +558,3 @@ } = partySocketOptions;
   ));
-  const baseUrl = `${protocol}://${host}/${party ? `parties/${party}` : "party"}/${room}${path}`;
+  const baseUrl = `${protocol}://${host}/${prefix || `parties/${name}/${room}`}${path}`;
   const makeUrl = (query2 = {}) => `${baseUrl}?${new URLSearchParams([
@@ -562,2 +590,3 @@ ...Object.entries(defaultParams),
     const wsOptions = getWSOptions({
+      ...this.partySocketOptions,
       ...partySocketOptions,
@@ -636,2 +665,3 @@ host: partySocketOptions.host ?? this.host,
 0 && (module.exports = {
+  PartySocket,
   WebSocket
@@ -638,0 +668,0 @@ });

dist/react.js

@@ -74,15 +74,21 @@ "use strict";
 function cloneEventNode(e) {
-  const evt = new Event(e.type, e);
   if ("data" in e) {
-    evt.data = e.data;
+    const evt2 = new MessageEvent(e.type, e);
+    return evt2;
   }
-  if ("code" in e) {
-    evt.code = e.code;
+  if ("code" in e || "reason" in e) {
+    const evt2 = new CloseEvent(
+      // @ts-expect-error we need to fix event/listener types
+      e.code || 1999,
+      // @ts-expect-error we need to fix event/listener types
+      e.reason || "unknown reason",
+      e
+    );
+    return evt2;
   }
-  if ("reason" in e) {
-    evt.reason = e.reason;
-  }
   if ("error" in e) {
-    evt.error = e.error;
+    const evt2 = new ErrorEvent(e.error, e);
+    return evt2;
   }
+  const evt = new Event(e.type, e);
   return evt;
@@ -103,2 +109,3 @@ }
 };
+var didWarnAboutMissingWebSocket = false;
 var ReconnectingWebSocket = class _ReconnectingWebSocket extends EventTarget {
@@ -114,2 +121,3 @@ _ws;
   _messageQueue = [];
+  _debugLogger = console.log.bind(console);
   _url;
@@ -126,2 +134,5 @@ _protocols;
     }
+    if (this._options.debugLogger) {
+      this._debugLogger = this._options.debugLogger;
+    }
     this._connect();
@@ -290,3 +301,3 @@ }
     if (this._options.debug) {
-      console.log.apply(console, ["RWS>", ...args]);
+      this._debugLogger("RWS>", ...args);
     }
@@ -316,4 +327,3 @@ }
   _getNextProtocols(protocolsProvider) {
-    if (!protocolsProvider)
-      return Promise.resolve(null);
+    if (!protocolsProvider) return Promise.resolve(null);
     if (typeof protocolsProvider === "string" || Array.isArray(protocolsProvider)) {
@@ -324,4 +334,3 @@ return Promise.resolve(protocolsProvider);
       const protocols = protocolsProvider();
-      if (!protocols)
-        return Promise.resolve(null);
+      if (!protocols) return Promise.resolve(null);
       if (typeof protocols === "string" || Array.isArray(protocols)) {
@@ -377,2 +386,19 @@ return Promise.resolve(protocols);
       }
+      if (!this._options.WebSocket && typeof WebSocket === "undefined" && !didWarnAboutMissingWebSocket) {
+        console.error(`\u203C\uFE0F No WebSocket implementation available. You should define options.WebSocket. 
+
+For example, if you're using node.js, run \`npm install ws\`, and then in your code:
+
+import PartySocket from 'partysocket';
+import WS from 'ws';
+
+const partysocket = new PartySocket({
+  host: "127.0.0.1:1999",
+  room: "test-room",
+  WebSocket: WS
+});
+
+`);
+        didWarnAboutMissingWebSocket = true;
+      }
       const WS = this._options.WebSocket || WebSocket;
@@ -511,2 +537,3 @@ this._debug("connect", { url, protocols });
     party,
+    prefix,
     query
@@ -530,3 +557,3 @@ } = partySocketOptions;
   ));
-  const baseUrl = `${protocol}://${host}/${party ? `parties/${party}` : "party"}/${room}${path}`;
+  const baseUrl = `${protocol}://${host}/${prefix || `parties/${name}/${room}`}${path}`;
   const makeUrl = (query2 = {}) => `${baseUrl}?${new URLSearchParams([
@@ -562,2 +589,3 @@ ...Object.entries(defaultParams),
     const wsOptions = getWSOptions({
+      ...this.partySocketOptions,
       ...partySocketOptions,
@@ -635,4 +663,27 @@ host: partySocketOptions.host ?? this.host,
 
+// src/use-handlers.ts
+var import_react = require("react");
+var useAttachWebSocketEventHandlers = (socket, options) => {
+  const handlersRef = (0, import_react.useRef)(options);
+  handlersRef.current = options;
+  (0, import_react.useEffect)(() => {
+    const onOpen = (event) => handlersRef.current?.onOpen?.(event);
+    const onMessage = (event) => handlersRef.current?.onMessage?.(event);
+    const onClose = (event) => handlersRef.current?.onClose?.(event);
+    const onError = (event) => handlersRef.current?.onError?.(event);
+    socket.addEventListener("open", onOpen);
+    socket.addEventListener("close", onClose);
+    socket.addEventListener("error", onError);
+    socket.addEventListener("message", onMessage);
+    return () => {
+      socket.removeEventListener("open", onOpen);
+      socket.removeEventListener("close", onClose);
+      socket.removeEventListener("error", onError);
+      socket.removeEventListener("message", onMessage);
+    };
+  }, [socket]);
+};
+
 // src/use-socket.ts
-var import_react = require("react");
+var import_react2 = require("react");
 var getOptionsThatShouldCauseRestartWhenChanged = (options) => [
@@ -655,6 +706,6 @@ options.startClosed,
   const shouldReconnect = createOptionsMemoKey(options);
-  const socketOptions = (0, import_react.useMemo)(() => {
+  const socketOptions = (0, import_react2.useMemo)(() => {
     return options;
   }, [shouldReconnect]);
-  const [socket, setSocket] = (0, import_react.useState)(
+  const [socket, setSocket] = (0, import_react2.useState)(
     () => (
@@ -665,6 +716,6 @@ // only connect on first mount
   );
-  const socketInitializedRef = (0, import_react.useRef)(null);
-  const createSocketRef = (0, import_react.useRef)(createSocket);
+  const socketInitializedRef = (0, import_react2.useRef)(null);
+  const createSocketRef = (0, import_react2.useRef)(createSocket);
   createSocketRef.current = createSocket;
-  (0, import_react.useEffect)(() => {
+  (0, import_react2.useEffect)(() => {
     if (socketInitializedRef.current === socket) {
@@ -691,25 +742,2 @@ const newSocket = createSocketRef.current({
 
-// src/use-handlers.ts
-var import_react2 = require("react");
-var useAttachWebSocketEventHandlers = (socket, options) => {
-  const handlersRef = (0, import_react2.useRef)(options);
-  handlersRef.current = options;
-  (0, import_react2.useEffect)(() => {
-    const onOpen = (event) => handlersRef.current?.onOpen?.(event);
-    const onMessage = (event) => handlersRef.current?.onMessage?.(event);
-    const onClose = (event) => handlersRef.current?.onClose?.(event);
-    const onError = (event) => handlersRef.current?.onError?.(event);
-    socket.addEventListener("open", onOpen);
-    socket.addEventListener("close", onClose);
-    socket.addEventListener("error", onError);
-    socket.addEventListener("message", onMessage);
-    return () => {
-      socket.removeEventListener("open", onOpen);
-      socket.removeEventListener("close", onClose);
-      socket.removeEventListener("error", onError);
-      socket.removeEventListener("message", onMessage);
-    };
-  }, [socket]);
-};
-
 // src/use-ws.ts
@@ -734,4 +762,8 @@ function useWebSocket(url, protocols, options = {}) {
 function usePartySocket(options) {
+  const { host, ...otherOptions } = options;
   const socket = useStableSocket({
-    options,
+    options: {
+      host: host || (typeof window !== "undefined" ? window.location.host : "dummy-domain.com"),
+      ...otherOptions
+    },
     createSocket: (options2) => new PartySocket(options2),
@@ -738,0 +770,0 @@ createSocketMemoKey: (options2) => JSON.stringify([

dist/use-ws.js

@@ -27,2 +27,78 @@ "use strict";
 
+// src/use-handlers.ts
+var import_react = require("react");
+var useAttachWebSocketEventHandlers = (socket, options) => {
+  const handlersRef = (0, import_react.useRef)(options);
+  handlersRef.current = options;
+  (0, import_react.useEffect)(() => {
+    const onOpen = (event) => handlersRef.current?.onOpen?.(event);
+    const onMessage = (event) => handlersRef.current?.onMessage?.(event);
+    const onClose = (event) => handlersRef.current?.onClose?.(event);
+    const onError = (event) => handlersRef.current?.onError?.(event);
+    socket.addEventListener("open", onOpen);
+    socket.addEventListener("close", onClose);
+    socket.addEventListener("error", onError);
+    socket.addEventListener("message", onMessage);
+    return () => {
+      socket.removeEventListener("open", onOpen);
+      socket.removeEventListener("close", onClose);
+      socket.removeEventListener("error", onError);
+      socket.removeEventListener("message", onMessage);
+    };
+  }, [socket]);
+};
+
+// src/use-socket.ts
+var import_react2 = require("react");
+var getOptionsThatShouldCauseRestartWhenChanged = (options) => [
+  options.startClosed,
+  options.minUptime,
+  options.maxRetries,
+  options.connectionTimeout,
+  options.maxEnqueuedMessages,
+  options.maxReconnectionDelay,
+  options.minReconnectionDelay,
+  options.reconnectionDelayGrowFactor,
+  options.debug
+];
+function useStableSocket({
+  options,
+  createSocket,
+  createSocketMemoKey: createOptionsMemoKey
+}) {
+  const shouldReconnect = createOptionsMemoKey(options);
+  const socketOptions = (0, import_react2.useMemo)(() => {
+    return options;
+  }, [shouldReconnect]);
+  const [socket, setSocket] = (0, import_react2.useState)(
+    () => (
+      // only connect on first mount
+      createSocket({ ...socketOptions, startClosed: true })
+    )
+  );
+  const socketInitializedRef = (0, import_react2.useRef)(null);
+  const createSocketRef = (0, import_react2.useRef)(createSocket);
+  createSocketRef.current = createSocket;
+  (0, import_react2.useEffect)(() => {
+    if (socketInitializedRef.current === socket) {
+      const newSocket = createSocketRef.current({
+        ...socketOptions,
+        // when reconnecting because of options change, we always reconnect
+        // (startClosed only applies to initial mount)
+        startClosed: false
+      });
+      setSocket(newSocket);
+    } else {
+      if (!socketInitializedRef.current && socketOptions.startClosed !== true) {
+        socket.reconnect();
+      }
+      socketInitializedRef.current = socket;
+      return () => {
+        socket.close();
+      };
+    }
+  }, [socket, socketOptions]);
+  return socket;
+}
+
 // src/ws.ts
@@ -73,15 +149,21 @@ if (!globalThis.EventTarget || !globalThis.Event) {
 function cloneEventNode(e) {
-  const evt = new Event(e.type, e);
   if ("data" in e) {
-    evt.data = e.data;
+    const evt2 = new MessageEvent(e.type, e);
+    return evt2;
   }
-  if ("code" in e) {
-    evt.code = e.code;
+  if ("code" in e || "reason" in e) {
+    const evt2 = new CloseEvent(
+      // @ts-expect-error we need to fix event/listener types
+      e.code || 1999,
+      // @ts-expect-error we need to fix event/listener types
+      e.reason || "unknown reason",
+      e
+    );
+    return evt2;
   }
-  if ("reason" in e) {
-    evt.reason = e.reason;
-  }
   if ("error" in e) {
-    evt.error = e.error;
+    const evt2 = new ErrorEvent(e.error, e);
+    return evt2;
   }
+  const evt = new Event(e.type, e);
   return evt;
@@ -102,2 +184,3 @@ }
 };
+var didWarnAboutMissingWebSocket = false;
 var ReconnectingWebSocket = class _ReconnectingWebSocket extends EventTarget {
@@ -113,2 +196,3 @@ _ws;
   _messageQueue = [];
+  _debugLogger = console.log.bind(console);
   _url;
@@ -125,2 +209,5 @@ _protocols;
     }
+    if (this._options.debugLogger) {
+      this._debugLogger = this._options.debugLogger;
+    }
     this._connect();
@@ -289,3 +376,3 @@ }
     if (this._options.debug) {
-      console.log.apply(console, ["RWS>", ...args]);
+      this._debugLogger("RWS>", ...args);
     }
@@ -315,4 +402,3 @@ }
   _getNextProtocols(protocolsProvider) {
-    if (!protocolsProvider)
-      return Promise.resolve(null);
+    if (!protocolsProvider) return Promise.resolve(null);
     if (typeof protocolsProvider === "string" || Array.isArray(protocolsProvider)) {
@@ -323,4 +409,3 @@ return Promise.resolve(protocolsProvider);
       const protocols = protocolsProvider();
-      if (!protocols)
-        return Promise.resolve(null);
+      if (!protocols) return Promise.resolve(null);
       if (typeof protocols === "string" || Array.isArray(protocols)) {
@@ -376,2 +461,19 @@ return Promise.resolve(protocols);
       }
+      if (!this._options.WebSocket && typeof WebSocket === "undefined" && !didWarnAboutMissingWebSocket) {
+        console.error(`\u203C\uFE0F No WebSocket implementation available. You should define options.WebSocket. 
+
+For example, if you're using node.js, run \`npm install ws\`, and then in your code:
+
+import PartySocket from 'partysocket';
+import WS from 'ws';
+
+const partysocket = new PartySocket({
+  host: "127.0.0.1:1999",
+  room: "test-room",
+  WebSocket: WS
+});
+
+`);
+        didWarnAboutMissingWebSocket = true;
+      }
       const WS = this._options.WebSocket || WebSocket;
@@ -483,78 +585,2 @@ this._debug("connect", { url, protocols });
 
-// src/use-handlers.ts
-var import_react = require("react");
-var useAttachWebSocketEventHandlers = (socket, options) => {
-  const handlersRef = (0, import_react.useRef)(options);
-  handlersRef.current = options;
-  (0, import_react.useEffect)(() => {
-    const onOpen = (event) => handlersRef.current?.onOpen?.(event);
-    const onMessage = (event) => handlersRef.current?.onMessage?.(event);
-    const onClose = (event) => handlersRef.current?.onClose?.(event);
-    const onError = (event) => handlersRef.current?.onError?.(event);
-    socket.addEventListener("open", onOpen);
-    socket.addEventListener("close", onClose);
-    socket.addEventListener("error", onError);
-    socket.addEventListener("message", onMessage);
-    return () => {
-      socket.removeEventListener("open", onOpen);
-      socket.removeEventListener("close", onClose);
-      socket.removeEventListener("error", onError);
-      socket.removeEventListener("message", onMessage);
-    };
-  }, [socket]);
-};
-
-// src/use-socket.ts
-var import_react2 = require("react");
-var getOptionsThatShouldCauseRestartWhenChanged = (options) => [
-  options.startClosed,
-  options.minUptime,
-  options.maxRetries,
-  options.connectionTimeout,
-  options.maxEnqueuedMessages,
-  options.maxReconnectionDelay,
-  options.minReconnectionDelay,
-  options.reconnectionDelayGrowFactor,
-  options.debug
-];
-function useStableSocket({
-  options,
-  createSocket,
-  createSocketMemoKey: createOptionsMemoKey
-}) {
-  const shouldReconnect = createOptionsMemoKey(options);
-  const socketOptions = (0, import_react2.useMemo)(() => {
-    return options;
-  }, [shouldReconnect]);
-  const [socket, setSocket] = (0, import_react2.useState)(
-    () => (
-      // only connect on first mount
-      createSocket({ ...socketOptions, startClosed: true })
-    )
-  );
-  const socketInitializedRef = (0, import_react2.useRef)(null);
-  const createSocketRef = (0, import_react2.useRef)(createSocket);
-  createSocketRef.current = createSocket;
-  (0, import_react2.useEffect)(() => {
-    if (socketInitializedRef.current === socket) {
-      const newSocket = createSocketRef.current({
-        ...socketOptions,
-        // when reconnecting because of options change, we always reconnect
-        // (startClosed only applies to initial mount)
-        startClosed: false
-      });
-      setSocket(newSocket);
-    } else {
-      if (!socketInitializedRef.current && socketOptions.startClosed !== true) {
-        socket.reconnect();
-      }
-      socketInitializedRef.current = socket;
-      return () => {
-        socket.close();
-      };
-    }
-  }, [socket, socketOptions]);
-  return socket;
-}
-
 // src/use-ws.ts
@@ -561,0 +587,0 @@ function useWebSocket(url, protocols, options = {}) {

dist/ws.js

@@ -72,15 +72,21 @@ "use strict";
 function cloneEventNode(e) {
-  const evt = new Event(e.type, e);
   if ("data" in e) {
-    evt.data = e.data;
+    const evt2 = new MessageEvent(e.type, e);
+    return evt2;
   }
-  if ("code" in e) {
-    evt.code = e.code;
+  if ("code" in e || "reason" in e) {
+    const evt2 = new CloseEvent(
+      // @ts-expect-error we need to fix event/listener types
+      e.code || 1999,
+      // @ts-expect-error we need to fix event/listener types
+      e.reason || "unknown reason",
+      e
+    );
+    return evt2;
   }
-  if ("reason" in e) {
-    evt.reason = e.reason;
-  }
   if ("error" in e) {
-    evt.error = e.error;
+    const evt2 = new ErrorEvent(e.error, e);
+    return evt2;
   }
+  const evt = new Event(e.type, e);
   return evt;
@@ -101,2 +107,3 @@ }
 };
+var didWarnAboutMissingWebSocket = false;
 var ReconnectingWebSocket = class _ReconnectingWebSocket extends EventTarget {
@@ -112,2 +119,3 @@ _ws;
   _messageQueue = [];
+  _debugLogger = console.log.bind(console);
   _url;
@@ -124,2 +132,5 @@ _protocols;
     }
+    if (this._options.debugLogger) {
+      this._debugLogger = this._options.debugLogger;
+    }
     this._connect();
@@ -288,3 +299,3 @@ }
     if (this._options.debug) {
-      console.log.apply(console, ["RWS>", ...args]);
+      this._debugLogger("RWS>", ...args);
     }
@@ -314,4 +325,3 @@ }
   _getNextProtocols(protocolsProvider) {
-    if (!protocolsProvider)
-      return Promise.resolve(null);
+    if (!protocolsProvider) return Promise.resolve(null);
     if (typeof protocolsProvider === "string" || Array.isArray(protocolsProvider)) {
@@ -322,4 +332,3 @@ return Promise.resolve(protocolsProvider);
       const protocols = protocolsProvider();
-      if (!protocols)
-        return Promise.resolve(null);
+      if (!protocols) return Promise.resolve(null);
       if (typeof protocols === "string" || Array.isArray(protocols)) {
@@ -375,2 +384,19 @@ return Promise.resolve(protocols);
       }
+      if (!this._options.WebSocket && typeof WebSocket === "undefined" && !didWarnAboutMissingWebSocket) {
+        console.error(`\u203C\uFE0F No WebSocket implementation available. You should define options.WebSocket. 
+
+For example, if you're using node.js, run \`npm install ws\`, and then in your code:
+
+import PartySocket from 'partysocket';
+import WS from 'ws';
+
+const partysocket = new PartySocket({
+  host: "127.0.0.1:1999",
+  room: "test-room",
+  WebSocket: WS
+});
+
+`);
+        didWarnAboutMissingWebSocket = true;
+      }
       const WS = this._options.WebSocket || WebSocket;
@@ -377,0 +403,0 @@ this._debug("connect", { url, protocols });

index.d.ts

@@ -10,2 +10,3 @@ import ReconnectingWebSocket, { Options } from './ws.js';
     party?: string;
+    prefix?: string;
     protocol?: "ws" | "wss";
@@ -20,2 +21,3 @@ protocols?: string[];
     party?: string;
+    prefix?: string;
     path?: string;
@@ -47,2 +49,2 @@ protocol?: "http" | "https";
 
-export { type PartyFetchOptions, type PartySocketOptions, ReconnectingWebSocket as WebSocket, PartySocket as default };
+export { type PartyFetchOptions, PartySocket, type PartySocketOptions, ReconnectingWebSocket as WebSocket, PartySocket as default };

package.json

 {
 	"name": "partysocket",
-	"version": "0.0.0-7fc2814",
-	"description": "party hotline",
+	"version": "0.0.0-7feb26e",
+	"description": "A better WebSocket that Just Works™",
+	"homepage": "https://docs.partykit.io/reference/partysocket-api",
+	"bugs": "https://github.com/partykit/partykit/issues",
 	"main": "./dist/index.js",
@@ -59,3 +61,18 @@ "module": "./dist/index.mjs",
 	],
-	"keywords": [],
+	"keywords": [
+		"websocket",
+		"client",
+		"reconnecting",
+		"reconnection",
+		"reconnect",
+		"forever",
+		"persistent",
+		"forever",
+		"automatic"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/partykit/partykit.git",
+		"directory": "packages/partykit"
+	},
 	"author": "",
@@ -62,0 +79,0 @@ "license": "ISC",

react.d.ts

@@ -1,9 +0,11 @@
-import PartySocket, { PartySocketOptions } from './index.js';
-import { E as EventHandlerOptions } from './use-ws-YFPmbpmh.js';
-export { u as useWebSocket } from './use-ws-YFPmbpmh.js';
+import { PartySocket, PartySocketOptions } from './index.js';
+import { E as EventHandlerOptions } from './use-ws-CnrrNZS2.js';
+export { u as useWebSocket } from './use-ws-CnrrNZS2.js';
 import './ws.js';
 
-type UsePartySocketOptions = PartySocketOptions & EventHandlerOptions;
+type UsePartySocketOptions = Omit<PartySocketOptions, "host"> & EventHandlerOptions & {
+    host?: string | undefined;
+};
 declare function usePartySocket(options: UsePartySocketOptions): PartySocket;
 
 export { usePartySocket as default, usePartySocket };

README.md

@@ -49,2 +49,5 @@ # PartySocket
 
+// optional: only needed if creating using inside node.js. Run `npm install ws`, and then add:
+// import WS from "ws";
+
 const ws = new PartySocket({
@@ -55,3 +58,5 @@ host: "project.name.partykit.dev", // or localhost:1999 in dev
   // if not provided, a random id will be generated
-  id: "some-connection-id",
+  id: "some-connection-id"
+  // optional: if used from node.js, you need to pass the WebSocket polyfill imported from `ws`
+  // WebSocket: WS
 });
@@ -63,3 +68,3 @@
   host: "another-project.username.partykit.dev",
-  room: "my-new-room",
+  room: "my-new-room"
 });
@@ -84,3 +89,3 @@
   "wss://your.site.com",
-  "wss://their.site.com",
+  "wss://their.site.com"
 ];
@@ -119,2 +124,3 @@ let urlIndex = 0;
 import { WebSocket } from "partysocket";
+
 const ws = new WebSocket("wss://your.site.com", "your protocol");
@@ -146,3 +152,3 @@ ```
   connectionTimeout: 1000,
-  maxRetries: 10,
+  maxRetries: 10
 };
@@ -149,0 +155,0 @@ const ws = new WebSocket("wss://my.site.com", [], options);

use-ws.d.ts

 import './ws.js';
-export { u as default } from './use-ws-YFPmbpmh.js';
+export { u as default } from './use-ws-CnrrNZS2.js';

ws.d.ts

@@ -46,2 +46,3 @@ type TypedEventTarget<EventMap extends object> = {
     debug?: boolean;
+    debugLogger?: (...args: any[]) => void;
 };
@@ -62,2 +63,3 @@ type UrlProvider = string | (() => string) | (() => Promise<string>);
     private _messageQueue;
+    private _debugLogger;
     protected _url: UrlProvider;
@@ -64,0 +66,0 @@ protected _protocols?: ProtocolsProvider;

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

116067

increased by5.55%

Lines of code

3557

increased by3.88%

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

230

increased by2.68%

Number of low supply chain risk alerts

0

decreased by-100%

No dependency changes