@vercel/functions 3.6.3 → 3.7.0

package/docs/index/type-aliases/WebSocket.md

@@ -0,0 +1,9 @@
+[**@vercel/functions**](../../README.md)
+
+***
+
+# Type Alias: WebSocket
+
+> **WebSocket** = *typeof* `WebSocket`
+
+Defined in: node\_modules/.pnpm/@types+ws@8.18.1/node\_modules/@types/ws/index.d.ts:438

package/docs/index/type-aliases/WebSocketData.md

@@ -0,0 +1,11 @@
+[**@vercel/functions**](../../README.md)
+
+***
+
+# Type Alias: WebSocketData
+
+> **WebSocketData** = `Buffer` \| [`ArrayBuffer`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) \| `Buffer`[]
+
+Defined in: node\_modules/.pnpm/@types+ws@8.18.1/node\_modules/@types/ws/index.d.ts:205
+
+Data represents the raw message payload received over the WebSocket.

package/get-context.d.ts

@@ -1,3 +1,5 @@
+import type { IncomingMessage } from 'http';
+import type { Socket } from 'net';
 import { RuntimeCache } from './cache/types';
 import { PurgeApi } from './purge/types';
 import { AddCacheTagApi } from './addcachetag/types';
@@ -7,6 +9,17 @@ type Context = {
     purge?: PurgeApi;
     addCacheTag?: AddCacheTagApi;
     headers?: Record<string, string>;
+    /**
+     * Low-level WebSocket upgrade provided by the runtime bridge.
+     * Writes a 101 response on the underlying socket, detaches it
+     * from the ServerResponse, and returns the raw req/socket/head
+     * tuple for use with libraries like `ws`.
+     */
+    upgradeWebSocket?: () => {
+        req: IncomingMessage;
+        socket: Socket;
+        head: Buffer;
+    };
 };
 export declare const SYMBOL_FOR_REQ_CONTEXT: unique symbol;
 export declare function getContext(): Context;

package/index.d.ts

@@ -10,3 +10,5 @@ export { invalidateByTag, dangerouslyDeleteByTag, invalidateBySrcImage, dangerou
 export type { PurgeApi, DangerouslyDeleteOptions } from './purge/types';
 export { addCacheTag } from './addcachetag';
 export type { AddCacheTagApi } from './addcachetag/types';
+export { experimental_upgradeWebSocket } from './websocket';
+export type { WebSocket, RawData as WebSocketData } from 'ws';

package/index.js

@@ -23,6 +23,7 @@ __export(src_exports, {
   dangerouslyDeleteBySrcImage: () => import_purge.dangerouslyDeleteBySrcImage,
   dangerouslyDeleteByTag: () => import_purge.dangerouslyDeleteByTag,
   experimental_attachDatabasePool: () => import_db_connections.experimental_attachDatabasePool,
+  experimental_upgradeWebSocket: () => import_websocket.experimental_upgradeWebSocket,
   geolocation: () => import_headers.geolocation,
   getCache: () => import_cache.getCache,
   getEnv: () => import_get_env.getEnv,
@@ -42,6 +43,7 @@ var import_cache = require("./cache");
 var import_db_connections = require("./db-connections");
 var import_purge = require("./purge");
 var import_addcachetag = require("./addcachetag");
+var import_websocket = require("./websocket");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   addCacheTag,
@@ -49,6 +51,7 @@ var import_addcachetag = require("./addcachetag");
   dangerouslyDeleteBySrcImage,
   dangerouslyDeleteByTag,
   experimental_attachDatabasePool,
+  experimental_upgradeWebSocket,
   geolocation,
   getCache,
   getEnv,

package/package.json

@@ -30,7 +30,7 @@
       "require": "./middleware.js"
     }
   },
-  "version": "3.6.3",
+  "version": "3.7.0",
   "repository": {
     "directory": "packages/functions",
     "type": "git",
@@ -44,6 +44,7 @@
     "@aws-sdk/credential-provider-web-identity": "3.609.0",
     "@smithy/types": "3.3.0",
     "@types/pg": "8.15.5",
+    "@types/ws": "8.18.1",
     "cassandra-driver": "4.8.0",
     "ioredis": "5.6.1",
     "mariadb": "3.4.5",
@@ -72,6 +73,7 @@
     "access": "public"
   },
   "dependencies": {
+    "ws": "8.20.0",
     "@vercel/oidc": "3.6.1"
   },
   "scripts": {

package/websocket/index.d.ts

@@ -0,0 +1,2 @@
+import { type WebSocket } from 'ws';
+export declare function experimental_upgradeWebSocket(handler: (ws: WebSocket) => void | Promise<void>): Promise<Response>;

package/websocket/index.js

@@ -0,0 +1,77 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+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 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 { req, socket, head } = ctx.upgradeWebSocket();
+  const wss = new import_ws.WebSocketServer({ noServer: true });
+  const ws = await new Promise((resolve, reject) => {
+    const cleanup = () => {
+      socket.removeListener("error", onError);
+      socket.removeListener("close", onClose);
+    };
+    const rejectUpgrade = (err) => {
+      cleanup();
+      if (err instanceof Error) {
+        reject(err);
+        return;
+      }
+      const error = new Error("WebSocket upgrade failed");
+      error.cause = err;
+      reject(error);
+    };
+    const resolveUpgrade = (ws2) => {
+      cleanup();
+      resolve(ws2);
+    };
+    const onError = (err) => rejectUpgrade(err);
+    const onClose = () => rejectUpgrade(
+      new Error("socket closed before the WebSocket upgrade completed")
+    );
+    socket.once("error", onError);
+    socket.once("close", onClose);
+    try {
+      wss.handleUpgrade(req, socket, head, resolveUpgrade);
+    } catch (err) {
+      rejectUpgrade(err);
+    }
+  });
+  try {
+    await handler(ws);
+  } catch (err) {
+    ws.close(1011, "WebSocket handler failed");
+    throw err;
+  }
+  return new Response(null, { status: 204 });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  experimental_upgradeWebSocket
+});