@vercel/functions 3.7.0 → 3.7.2

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @vercel/functions
 
+## 3.7.2
+
+### Patch Changes
+
+- 071569d: Add a `maxPayload` option to `experimental_upgradeWebSocket()`, defaulting to 256 KiB.
+  - @vercel/oidc@3.6.2
+
+## 3.7.1
+
+### Patch Changes
+
+- a7f1f7c: Make `ws` an optional peer dependency
+
 ## 3.7.0
 
 ### Minor Changes

package/docs/index/README.md

@@ -11,6 +11,7 @@
 - [PurgeApi](interfaces/PurgeApi.md)
 - [Request](interfaces/Request.md)
 - [RuntimeCache](interfaces/RuntimeCache.md)
+- [UpgradeWebSocketOptions](interfaces/UpgradeWebSocketOptions.md)
 - [WebSocket](interfaces/WebSocket.md)
 
 ## Type Aliases

package/docs/index/functions/experimental_upgradeWebSocket.md

@@ -4,9 +4,9 @@
 
 # Function: experimental\_upgradeWebSocket()
 
-> **experimental\_upgradeWebSocket**(`handler`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)\>
+> **experimental\_upgradeWebSocket**(`handler`, `options?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)\>
 
-Defined in: [packages/functions/src/websocket/index.ts:4](https://github.com/vercel/vercel/blob/main/packages/functions/src/websocket/index.ts#L4)
+Defined in: [packages/functions/src/websocket/index.ts:22](https://github.com/vercel/vercel/blob/main/packages/functions/src/websocket/index.ts#L22)
 
 ## Parameters
 
@@ -14,6 +14,10 @@ Defined in: [packages/functions/src/websocket/index.ts:4](https://github.com/ver
 
 (`ws`) => `void` \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
 
+### options?
+
+[`UpgradeWebSocketOptions`](../interfaces/UpgradeWebSocketOptions.md) = `{}`
+
 ## Returns
 
 [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)\>

package/docs/index/interfaces/UpgradeWebSocketOptions.md

@@ -0,0 +1,15 @@
+[**@vercel/functions**](../../README.md)
+
+***
+
+# Interface: UpgradeWebSocketOptions
+
+Defined in: [packages/functions/src/websocket/index.ts:6](https://github.com/vercel/vercel/blob/main/packages/functions/src/websocket/index.ts#L6)
+
+## Properties
+
+### maxPayload?
+
+> `optional` **maxPayload?**: `number`
+
+Defined in: [packages/functions/src/websocket/index.ts:7](https://github.com/vercel/vercel/blob/main/packages/functions/src/websocket/index.ts#L7)

package/index.d.ts

@@ -11,4 +11,5 @@ export type { PurgeApi, DangerouslyDeleteOptions } from './purge/types';
 export { addCacheTag } from './addcachetag';
 export type { AddCacheTagApi } from './addcachetag/types';
 export { experimental_upgradeWebSocket } from './websocket';
+export type { UpgradeWebSocketOptions } from './websocket';
 export type { WebSocket, RawData as WebSocketData } from 'ws';

package/package.json

@@ -30,7 +30,7 @@
       "require": "./middleware.js"
     }
   },
-  "version": "3.7.0",
+  "version": "3.7.2",
   "repository": {
     "directory": "packages/functions",
     "type": "git",
@@ -58,11 +58,15 @@
     "vitest": "2.0.1"
   },
   "peerDependencies": {
-    "@aws-sdk/credential-provider-web-identity": "*"
+    "@aws-sdk/credential-provider-web-identity": "*",
+    "ws": ">=8"
   },
   "peerDependenciesMeta": {
     "@aws-sdk/credential-provider-web-identity": {
       "optional": true
+    },
+    "ws": {
+      "optional": true
     }
   },
   "engines": {
@@ -73,8 +77,7 @@
     "access": "public"
   },
   "dependencies": {
-    "ws": "8.20.0",
-    "@vercel/oidc": "3.6.1"
+    "@vercel/oidc": "3.6.2"
   },
   "scripts": {
     "pretest": "pnpm run build:code",

package/websocket/index.d.ts

@@ -1,2 +1,5 @@
-import { type WebSocket } from 'ws';
-export declare function experimental_upgradeWebSocket(handler: (ws: WebSocket) => void | Promise<void>): Promise<Response>;
+import type { WebSocket } from 'ws';
+export interface UpgradeWebSocketOptions {
+    maxPayload?: number;
+}
+export declare function experimental_upgradeWebSocket(handler: (ws: WebSocket) => void | Promise<void>, options?: UpgradeWebSocketOptions): Promise<Response>;

package/websocket/index.js

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,23 +17,45 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var websocket_exports = {};
 __export(websocket_exports, {
   experimental_upgradeWebSocket: () => experimental_upgradeWebSocket
 });
 module.exports = __toCommonJS(websocket_exports);
-var import_ws = require("ws");
 var import_get_context = require("../get-context");
-async function experimental_upgradeWebSocket(handler) {
+const DEFAULT_MAX_PAYLOAD = 256 * 1024;
+async function loadWebSocketServer() {
+  try {
+    const ws = await import("ws");
+    return ws.WebSocketServer;
+  } catch {
+    throw new Error(
+      'The "ws" package is required for experimental_upgradeWebSocket(). Install it with: npm install ws'
+    );
+  }
+}
+async function experimental_upgradeWebSocket(handler, options = {}) {
   const ctx = (0, import_get_context.getContext)();
   if (typeof ctx.upgradeWebSocket !== "function") {
     throw new Error(
       "experimental_upgradeWebSocket is not available in the current runtime environment. This feature requires a Vercel runtime that supports WebSocket upgrades."
     );
   }
+  const WebSocketServer = await loadWebSocketServer();
   const { req, socket, head } = ctx.upgradeWebSocket();
-  const wss = new import_ws.WebSocketServer({ noServer: true });
+  const wss = new WebSocketServer({
+    noServer: true,
+    maxPayload: options.maxPayload ?? DEFAULT_MAX_PAYLOAD
+  });
   const ws = await new Promise((resolve, reject) => {
     const cleanup = () => {
       socket.removeListener("error", onError);