msw 2.3.0-ws.rc-1 → 2.3.0-ws.rc-3

package/lib/core/ws/utils/truncateMessage.mjs

@@ -0,0 +1,11 @@
+const MAX_LENGTH = 24;
+function truncateMessage(message) {
+  if (message.length <= MAX_LENGTH) {
+    return message;
+  }
+  return `${message.slice(0, MAX_LENGTH)}\u2026`;
+}
+export {
+  truncateMessage
+};
+//# sourceMappingURL=truncateMessage.mjs.map

package/lib/core/ws/utils/truncateMessage.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/core/ws/utils/truncateMessage.ts"],"sourcesContent":["const MAX_LENGTH = 24\n\nexport function truncateMessage(message: string): string {\n  if (message.length <= MAX_LENGTH) {\n    return message\n  }\n\n  return `${message.slice(0, MAX_LENGTH)}…`\n}\n"],"mappings":"AAAA,MAAM,aAAa;AAEZ,SAAS,gBAAgB,SAAyB;AACvD,MAAI,QAAQ,UAAU,YAAY;AAChC,WAAO;AAAA,EACT;AAEA,SAAO,GAAG,QAAQ,MAAM,GAAG,UAAU,CAAC;AACxC;","names":[]}

package/lib/core/{ws/ws.d.mts → ws.d.mts}

@@ -1,20 +1,15 @@
 import { WebSocketClientConnectionProtocol, WebSocketData } from '@mswjs/interceptors/WebSocket';
-import { WebSocketHandlerEventMap, WebSocketHandler } from '../handlers/WebSocketHandler.mjs';
-import { Path } from '../utils/matching/matchRequestUrl.mjs';
+import { WebSocketHandlerEventMap, WebSocketHandler } from './handlers/WebSocketHandler.mjs';
+import { Path } from './utils/matching/matchRequestUrl.mjs';
 import 'strict-event-emitter';
 
-/**
- * Intercepts outgoing WebSocket connections to the given URL.
- *
- * @example
- * const chat = ws.link('wss://chat.example.com')
- * chat.on('connection', ({ client }) => {
- *   client.send('hello from server!')
- * })
- */
-declare function createWebSocketLinkHandler(url: Path): {
+type WebSocketLink = {
+    /**
+     * A set of all WebSocket clients connected
+     * to this link.
+     */
     clients: Set<WebSocketClientConnectionProtocol>;
-    on<K extends "connection">(event: K, listener: (...args: WebSocketHandlerEventMap[K]) => void): WebSocketHandler;
+    on<EventType extends keyof WebSocketHandlerEventMap>(event: EventType, listener: (...args: WebSocketHandlerEventMap[EventType]) => void): WebSocketHandler;
     /**
      * Broadcasts the given data to all WebSocket clients.
      *
@@ -37,8 +32,18 @@ declare function createWebSocketLinkHandler(url: Path): {
      */
     broadcastExcept(clients: WebSocketClientConnectionProtocol | Array<WebSocketClientConnectionProtocol>, data: WebSocketData): void;
 };
+/**
+ * Intercepts outgoing WebSocket connections to the given URL.
+ *
+ * @example
+ * const chat = ws.link('wss://chat.example.com')
+ * chat.on('connection', ({ client }) => {
+ *   client.send('hello from server!')
+ * })
+ */
+declare function createWebSocketLinkHandler(url: Path): WebSocketLink;
 declare const ws: {
     link: typeof createWebSocketLinkHandler;
 };
 
-export { ws };
+export { type WebSocketLink, ws };

package/lib/core/{ws/ws.d.ts → ws.d.ts}

@@ -1,20 +1,15 @@
 import { WebSocketClientConnectionProtocol, WebSocketData } from '@mswjs/interceptors/WebSocket';
-import { WebSocketHandlerEventMap, WebSocketHandler } from '../handlers/WebSocketHandler.js';
-import { Path } from '../utils/matching/matchRequestUrl.js';
+import { WebSocketHandlerEventMap, WebSocketHandler } from './handlers/WebSocketHandler.js';
+import { Path } from './utils/matching/matchRequestUrl.js';
 import 'strict-event-emitter';
 
-/**
- * Intercepts outgoing WebSocket connections to the given URL.
- *
- * @example
- * const chat = ws.link('wss://chat.example.com')
- * chat.on('connection', ({ client }) => {
- *   client.send('hello from server!')
- * })
- */
-declare function createWebSocketLinkHandler(url: Path): {
+type WebSocketLink = {
+    /**
+     * A set of all WebSocket clients connected
+     * to this link.
+     */
     clients: Set<WebSocketClientConnectionProtocol>;
-    on<K extends "connection">(event: K, listener: (...args: WebSocketHandlerEventMap[K]) => void): WebSocketHandler;
+    on<EventType extends keyof WebSocketHandlerEventMap>(event: EventType, listener: (...args: WebSocketHandlerEventMap[EventType]) => void): WebSocketHandler;
     /**
      * Broadcasts the given data to all WebSocket clients.
      *
@@ -37,8 +32,18 @@ declare function createWebSocketLinkHandler(url: Path): {
      */
     broadcastExcept(clients: WebSocketClientConnectionProtocol | Array<WebSocketClientConnectionProtocol>, data: WebSocketData): void;
 };
+/**
+ * Intercepts outgoing WebSocket connections to the given URL.
+ *
+ * @example
+ * const chat = ws.link('wss://chat.example.com')
+ * chat.on('connection', ({ client }) => {
+ *   client.send('hello from server!')
+ * })
+ */
+declare function createWebSocketLinkHandler(url: Path): WebSocketLink;
 declare const ws: {
     link: typeof createWebSocketLinkHandler;
 };
 
-export { ws };
+export { type WebSocketLink, ws };

package/lib/core/{ws/ws.js → ws.js}

@@ -22,15 +22,15 @@ __export(ws_exports, {
 });
 module.exports = __toCommonJS(ws_exports);
 var import_outvariant = require("outvariant");
-var import_WebSocketHandler = require("../handlers/WebSocketHandler.js");
-var import_matchRequestUrl = require("../utils/matching/matchRequestUrl.js");
-var import_WebSocketClientManager = require("./WebSocketClientManager.js");
+var import_WebSocketHandler = require("./handlers/WebSocketHandler.js");
+var import_matchRequestUrl = require("./utils/matching/matchRequestUrl.js");
+var import_WebSocketClientManager = require("./ws/WebSocketClientManager.js");
 const wsBroadcastChannel = new BroadcastChannel("msw:ws-client-manager");
 function createWebSocketLinkHandler(url) {
   (0, import_outvariant.invariant)(url, "Expected a WebSocket server URL but got undefined");
   (0, import_outvariant.invariant)(
     (0, import_matchRequestUrl.isPath)(url),
-    "Expected a WebSocket server URL but got %s",
+    "Expected a WebSocket server URL to be a valid path but got %s",
     typeof url
   );
   const clientManager = new import_WebSocketClientManager.WebSocketClientManager(wsBroadcastChannel);
@@ -44,28 +44,9 @@ function createWebSocketLinkHandler(url) {
       handler[import_WebSocketHandler.kEmitter].on(event, listener);
       return handler;
     },
-    /**
-     * Broadcasts the given data to all WebSocket clients.
-     *
-     * @example
-     * const service = ws.link('wss://example.com')
-     * service.on('connection', () => {
-     *   service.broadcast('hello, everyone!')
-     * })
-     */
     broadcast(data) {
       this.broadcastExcept([], data);
     },
-    /**
-     * Broadcasts the given data to all WebSocket clients
-     * except the ones provided in the `clients` argument.
-     *
-     * @example
-     * const service = ws.link('wss://example.com')
-     * service.on('connection', ({ client }) => {
-     *   service.broadcastExcept(client, 'hi, the rest of you!')
-     * })
-     */
     broadcastExcept(clients, data) {
       const ignoreClients = Array.prototype.concat(clients).map((client) => client.id);
       clientManager.clients.forEach((otherClient) => {

package/lib/core/ws.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/core/ws.ts"],"sourcesContent":["import { invariant } from 'outvariant'\nimport type {\n  WebSocketClientConnectionProtocol,\n  WebSocketData,\n} from '@mswjs/interceptors/WebSocket'\nimport {\n  WebSocketHandler,\n  kEmitter,\n  type WebSocketHandlerEventMap,\n} from './handlers/WebSocketHandler'\nimport { Path, isPath } from './utils/matching/matchRequestUrl'\nimport { WebSocketClientManager } from './ws/WebSocketClientManager'\n\nconst wsBroadcastChannel = new BroadcastChannel('msw:ws-client-manager')\n\nexport type WebSocketLink = {\n  /**\n   * A set of all WebSocket clients connected\n   * to this link.\n   */\n  clients: Set<WebSocketClientConnectionProtocol>\n\n  on<EventType extends keyof WebSocketHandlerEventMap>(\n    event: EventType,\n    listener: (...args: WebSocketHandlerEventMap[EventType]) => void,\n  ): WebSocketHandler\n\n  /**\n   * Broadcasts the given data to all WebSocket clients.\n   *\n   * @example\n   * const service = ws.link('wss://example.com')\n   * service.on('connection', () => {\n   *   service.broadcast('hello, everyone!')\n   * })\n   */\n  broadcast(data: WebSocketData): void\n\n  /**\n   * Broadcasts the given data to all WebSocket clients\n   * except the ones provided in the `clients` argument.\n   *\n   * @example\n   * const service = ws.link('wss://example.com')\n   * service.on('connection', ({ client }) => {\n   *   service.broadcastExcept(client, 'hi, the rest of you!')\n   * })\n   */\n  broadcastExcept(\n    clients:\n      | WebSocketClientConnectionProtocol\n      | Array<WebSocketClientConnectionProtocol>,\n    data: WebSocketData,\n  ): void\n}\n\n/**\n * Intercepts outgoing WebSocket connections to the given URL.\n *\n * @example\n * const chat = ws.link('wss://chat.example.com')\n * chat.on('connection', ({ client }) => {\n *   client.send('hello from server!')\n * })\n */\nfunction createWebSocketLinkHandler(url: Path): WebSocketLink {\n  invariant(url, 'Expected a WebSocket server URL but got undefined')\n\n  invariant(\n    isPath(url),\n    'Expected a WebSocket server URL to be a valid path but got %s',\n    typeof url,\n  )\n\n  const clientManager = new WebSocketClientManager(wsBroadcastChannel)\n\n  return {\n    clients: clientManager.clients,\n    on(event, listener) {\n      const handler = new WebSocketHandler(url)\n\n      // Add the connection event listener for when the\n      // handler matches and emits a connection event.\n      // When that happens, store that connection in the\n      // set of all connections for reference.\n      handler[kEmitter].on('connection', ({ client }) => {\n        clientManager.addConnection(client)\n      })\n\n      // The \"handleWebSocketEvent\" function will invoke\n      // the \"run()\" method on the WebSocketHandler.\n      // If the handler matches, it will emit the \"connection\"\n      // event. Attach the user-defined listener to that event.\n      handler[kEmitter].on(event, listener)\n\n      return handler\n    },\n\n    broadcast(data) {\n      // This will invoke \"send()\" on the immediate clients\n      // in this runtime and post a message to the broadcast channel\n      // to trigger send for the clients in other runtimes.\n      this.broadcastExcept([], data)\n    },\n\n    broadcastExcept(clients, data) {\n      const ignoreClients = Array.prototype\n        .concat(clients)\n        .map((client) => client.id)\n\n      clientManager.clients.forEach((otherClient) => {\n        if (!ignoreClients.includes(otherClient.id)) {\n          otherClient.send(data)\n        }\n      })\n    },\n  }\n}\n\nexport const ws = {\n  link: createWebSocketLinkHandler,\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAA0B;AAK1B,8BAIO;AACP,6BAA6B;AAC7B,oCAAuC;AAEvC,MAAM,qBAAqB,IAAI,iBAAiB,uBAAuB;AAoDvE,SAAS,2BAA2B,KAA0B;AAC5D,mCAAU,KAAK,mDAAmD;AAElE;AAAA,QACE,+BAAO,GAAG;AAAA,IACV;AAAA,IACA,OAAO;AAAA,EACT;AAEA,QAAM,gBAAgB,IAAI,qDAAuB,kBAAkB;AAEnE,SAAO;AAAA,IACL,SAAS,cAAc;AAAA,IACvB,GAAG,OAAO,UAAU;AAClB,YAAM,UAAU,IAAI,yCAAiB,GAAG;AAMxC,cAAQ,gCAAQ,EAAE,GAAG,cAAc,CAAC,EAAE,OAAO,MAAM;AACjD,sBAAc,cAAc,MAAM;AAAA,MACpC,CAAC;AAMD,cAAQ,gCAAQ,EAAE,GAAG,OAAO,QAAQ;AAEpC,aAAO;AAAA,IACT;AAAA,IAEA,UAAU,MAAM;AAId,WAAK,gBAAgB,CAAC,GAAG,IAAI;AAAA,IAC/B;AAAA,IAEA,gBAAgB,SAAS,MAAM;AAC7B,YAAM,gBAAgB,MAAM,UACzB,OAAO,OAAO,EACd,IAAI,CAAC,WAAW,OAAO,EAAE;AAE5B,oBAAc,QAAQ,QAAQ,CAAC,gBAAgB;AAC7C,YAAI,CAAC,cAAc,SAAS,YAAY,EAAE,GAAG;AAC3C,sBAAY,KAAK,IAAI;AAAA,QACvB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAEO,MAAM,KAAK;AAAA,EAChB,MAAM;AACR;","names":[]}

package/lib/core/{ws/ws.mjs → ws.mjs}

@@ -2,15 +2,15 @@ import { invariant } from "outvariant";
 import {
   WebSocketHandler,
   kEmitter
-} from '../handlers/WebSocketHandler.mjs';
-import { isPath } from '../utils/matching/matchRequestUrl.mjs';
-import { WebSocketClientManager } from './WebSocketClientManager.mjs';
+} from './handlers/WebSocketHandler.mjs';
+import { isPath } from './utils/matching/matchRequestUrl.mjs';
+import { WebSocketClientManager } from './ws/WebSocketClientManager.mjs';
 const wsBroadcastChannel = new BroadcastChannel("msw:ws-client-manager");
 function createWebSocketLinkHandler(url) {
   invariant(url, "Expected a WebSocket server URL but got undefined");
   invariant(
     isPath(url),
-    "Expected a WebSocket server URL but got %s",
+    "Expected a WebSocket server URL to be a valid path but got %s",
     typeof url
   );
   const clientManager = new WebSocketClientManager(wsBroadcastChannel);
@@ -24,28 +24,9 @@ function createWebSocketLinkHandler(url) {
       handler[kEmitter].on(event, listener);
       return handler;
     },
-    /**
-     * Broadcasts the given data to all WebSocket clients.
-     *
-     * @example
-     * const service = ws.link('wss://example.com')
-     * service.on('connection', () => {
-     *   service.broadcast('hello, everyone!')
-     * })
-     */
     broadcast(data) {
       this.broadcastExcept([], data);
     },
-    /**
-     * Broadcasts the given data to all WebSocket clients
-     * except the ones provided in the `clients` argument.
-     *
-     * @example
-     * const service = ws.link('wss://example.com')
-     * service.on('connection', ({ client }) => {
-     *   service.broadcastExcept(client, 'hi, the rest of you!')
-     * })
-     */
     broadcastExcept(clients, data) {
       const ignoreClients = Array.prototype.concat(clients).map((client) => client.id);
       clientManager.clients.forEach((otherClient) => {

package/lib/core/ws.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/core/ws.ts"],"sourcesContent":["import { invariant } from 'outvariant'\nimport type {\n  WebSocketClientConnectionProtocol,\n  WebSocketData,\n} from '@mswjs/interceptors/WebSocket'\nimport {\n  WebSocketHandler,\n  kEmitter,\n  type WebSocketHandlerEventMap,\n} from './handlers/WebSocketHandler'\nimport { Path, isPath } from './utils/matching/matchRequestUrl'\nimport { WebSocketClientManager } from './ws/WebSocketClientManager'\n\nconst wsBroadcastChannel = new BroadcastChannel('msw:ws-client-manager')\n\nexport type WebSocketLink = {\n  /**\n   * A set of all WebSocket clients connected\n   * to this link.\n   */\n  clients: Set<WebSocketClientConnectionProtocol>\n\n  on<EventType extends keyof WebSocketHandlerEventMap>(\n    event: EventType,\n    listener: (...args: WebSocketHandlerEventMap[EventType]) => void,\n  ): WebSocketHandler\n\n  /**\n   * Broadcasts the given data to all WebSocket clients.\n   *\n   * @example\n   * const service = ws.link('wss://example.com')\n   * service.on('connection', () => {\n   *   service.broadcast('hello, everyone!')\n   * })\n   */\n  broadcast(data: WebSocketData): void\n\n  /**\n   * Broadcasts the given data to all WebSocket clients\n   * except the ones provided in the `clients` argument.\n   *\n   * @example\n   * const service = ws.link('wss://example.com')\n   * service.on('connection', ({ client }) => {\n   *   service.broadcastExcept(client, 'hi, the rest of you!')\n   * })\n   */\n  broadcastExcept(\n    clients:\n      | WebSocketClientConnectionProtocol\n      | Array<WebSocketClientConnectionProtocol>,\n    data: WebSocketData,\n  ): void\n}\n\n/**\n * Intercepts outgoing WebSocket connections to the given URL.\n *\n * @example\n * const chat = ws.link('wss://chat.example.com')\n * chat.on('connection', ({ client }) => {\n *   client.send('hello from server!')\n * })\n */\nfunction createWebSocketLinkHandler(url: Path): WebSocketLink {\n  invariant(url, 'Expected a WebSocket server URL but got undefined')\n\n  invariant(\n    isPath(url),\n    'Expected a WebSocket server URL to be a valid path but got %s',\n    typeof url,\n  )\n\n  const clientManager = new WebSocketClientManager(wsBroadcastChannel)\n\n  return {\n    clients: clientManager.clients,\n    on(event, listener) {\n      const handler = new WebSocketHandler(url)\n\n      // Add the connection event listener for when the\n      // handler matches and emits a connection event.\n      // When that happens, store that connection in the\n      // set of all connections for reference.\n      handler[kEmitter].on('connection', ({ client }) => {\n        clientManager.addConnection(client)\n      })\n\n      // The \"handleWebSocketEvent\" function will invoke\n      // the \"run()\" method on the WebSocketHandler.\n      // If the handler matches, it will emit the \"connection\"\n      // event. Attach the user-defined listener to that event.\n      handler[kEmitter].on(event, listener)\n\n      return handler\n    },\n\n    broadcast(data) {\n      // This will invoke \"send()\" on the immediate clients\n      // in this runtime and post a message to the broadcast channel\n      // to trigger send for the clients in other runtimes.\n      this.broadcastExcept([], data)\n    },\n\n    broadcastExcept(clients, data) {\n      const ignoreClients = Array.prototype\n        .concat(clients)\n        .map((client) => client.id)\n\n      clientManager.clients.forEach((otherClient) => {\n        if (!ignoreClients.includes(otherClient.id)) {\n          otherClient.send(data)\n        }\n      })\n    },\n  }\n}\n\nexport const ws = {\n  link: createWebSocketLinkHandler,\n}\n"],"mappings":"AAAA,SAAS,iBAAiB;AAK1B;AAAA,EACE;AAAA,EACA;AAAA,OAEK;AACP,SAAe,cAAc;AAC7B,SAAS,8BAA8B;AAEvC,MAAM,qBAAqB,IAAI,iBAAiB,uBAAuB;AAoDvE,SAAS,2BAA2B,KAA0B;AAC5D,YAAU,KAAK,mDAAmD;AAElE;AAAA,IACE,OAAO,GAAG;AAAA,IACV;AAAA,IACA,OAAO;AAAA,EACT;AAEA,QAAM,gBAAgB,IAAI,uBAAuB,kBAAkB;AAEnE,SAAO;AAAA,IACL,SAAS,cAAc;AAAA,IACvB,GAAG,OAAO,UAAU;AAClB,YAAM,UAAU,IAAI,iBAAiB,GAAG;AAMxC,cAAQ,QAAQ,EAAE,GAAG,cAAc,CAAC,EAAE,OAAO,MAAM;AACjD,sBAAc,cAAc,MAAM;AAAA,MACpC,CAAC;AAMD,cAAQ,QAAQ,EAAE,GAAG,OAAO,QAAQ;AAEpC,aAAO;AAAA,IACT;AAAA,IAEA,UAAU,MAAM;AAId,WAAK,gBAAgB,CAAC,GAAG,IAAI;AAAA,IAC/B;AAAA,IAEA,gBAAgB,SAAS,MAAM;AAC7B,YAAM,gBAAgB,MAAM,UACzB,OAAO,OAAO,EACd,IAAI,CAAC,WAAW,OAAO,EAAE;AAE5B,oBAAc,QAAQ,QAAQ,CAAC,gBAAgB;AAC7C,YAAI,CAAC,cAAc,SAAS,YAAY,EAAE,GAAG;AAC3C,sBAAY,KAAK,IAAI;AAAA,QACvB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAEO,MAAM,KAAK;AAAA,EAChB,MAAM;AACR;","names":[]}