@vercel/functions 3.9.10 → 3.10.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @vercel/functions
 
+## 3.10.0
+
+### Minor Changes
+
+- 3394701: Promote the WebSocket upgrade API to `upgradeWebSocket()` and remove its experimental label.
+
+## 3.9.12
+
+### Patch Changes
+
+- Updated dependencies [baad6f5]
+  - @vercel/oidc@5.0.0
+
+## 3.9.11
+
+### Patch Changes
+
+- Updated dependencies [ec76b68]
+  - @vercel/oidc@4.0.0
+
 ## 3.9.10
 
 ### Patch Changes

package/docs/index/README.md

@@ -23,6 +23,7 @@
 ## Variables
 
 - [~~experimental_attachDatabasePool~~](variables/experimental_attachDatabasePool.md)
+- [~~experimental_upgradeWebSocket~~](variables/experimental_upgradeWebSocket.md)
 
 ## Functions
 
@@ -30,7 +31,6 @@
 - [attachDatabasePool](functions/attachDatabasePool.md)
 - [dangerouslyDeleteBySrcImage](functions/dangerouslyDeleteBySrcImage.md)
 - [dangerouslyDeleteByTag](functions/dangerouslyDeleteByTag.md)
-- [experimental_upgradeWebSocket](functions/experimental_upgradeWebSocket.md)
 - [geolocation](functions/geolocation.md)
 - [getCache](functions/getCache.md)
 - [getDeadline](functions/getDeadline.md)
@@ -41,4 +41,5 @@
 - [metric](functions/metric.md)
 - [next](functions/next.md)
 - [rewrite](functions/rewrite.md)
+- [upgradeWebSocket](functions/upgradeWebSocket.md)
 - [waitUntil](functions/waitUntil.md)

package/docs/index/functions/{experimental_upgradeWebSocket.md → upgradeWebSocket.md}

@@ -2,9 +2,9 @@
 
 ***
 
-# Function: experimental\_upgradeWebSocket()
+# Function: upgradeWebSocket()
 
-> **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)\>
+> **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:22](https://github.com/vercel/vercel/blob/main/packages/functions/src/websocket/index.ts#L22)
 

package/docs/index/variables/experimental_upgradeWebSocket.md

@@ -0,0 +1,27 @@
+[**@vercel/functions**](../../README.md)
+
+***
+
+# ~~Variable: experimental\_upgradeWebSocket~~
+
+> `const` **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)\> = `upgradeWebSocket`
+
+Defined in: [packages/functions/src/websocket/index.ts:100](https://github.com/vercel/vercel/blob/main/packages/functions/src/websocket/index.ts#L100)
+
+## Parameters
+
+### handler
+
+(`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)\>
+
+## Deprecated
+
+Use upgradeWebSocket instead.

package/docs/oidc/functions/getVercelOidcToken.md

@@ -6,14 +6,16 @@
 
 > **getVercelOidcToken**(`options?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>
 
-Defined in: packages/oidc/dist/get-vercel-oidc-token-with-refresh.d.ts:88
+Defined in: packages/oidc/dist/get-vercel-oidc-token-with-refresh.d.ts:90
 
-Gets the current OIDC token from the request context or the environment variable.
+Gets the current OIDC token from the request context, the Vercel OIDC token
+file, or the environment variable.
 
 Do not cache this value, as it is subject to change in production!
 
-This function is used to retrieve the OIDC token from the request context or the environment variable.
-It checks for the `x-vercel-oidc-token` header in the request context and falls back to the `VERCEL_OIDC_TOKEN` environment variable if the header is not present.
+It checks for the `x-vercel-oidc-token` header in the request context, then
+reads the file named by `VERCEL_OIDC_TOKEN_FILE` when set, then falls back to
+the `VERCEL_OIDC_TOKEN` environment variable.
 
 Unlike the `getVercelOidcTokenSync` function, this function will refresh the token if it is expired in a development environment.
 
@@ -33,7 +35,7 @@ A promise that resolves to the OIDC token.
 
 ## Throws
 
-If the `x-vercel-oidc-token` header is missing from the request context and the environment variable `VERCEL_OIDC_TOKEN` is not set. If the token
+If no token source is available or the configured file cannot be read. If the token
 is expired in a development environment, will also throw an error if the token cannot be refreshed: no CLI credentials are available, CLI credentials are expired, no project configuration is available
 or the token refresh request fails.
 

package/index.d.ts

@@ -12,6 +12,6 @@ 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 { upgradeWebSocket, experimental_upgradeWebSocket } from './websocket';
 export type { UpgradeWebSocketOptions } from './websocket';
 export type { WebSocket, RawData as WebSocketData } from 'ws';

package/index.js

@@ -34,6 +34,7 @@ __export(src_exports, {
   metric: () => import_metric.metric,
   next: () => import_middleware.next,
   rewrite: () => import_middleware.rewrite,
+  upgradeWebSocket: () => import_websocket.upgradeWebSocket,
   waitUntil: () => import_wait_until.waitUntil
 });
 module.exports = __toCommonJS(src_exports);
@@ -66,5 +67,6 @@ var import_websocket = require("./websocket");
   metric,
   next,
   rewrite,
+  upgradeWebSocket,
   waitUntil
 });

package/package.json

@@ -30,7 +30,7 @@
       "require": "./middleware.js"
     }
   },
-  "version": "3.9.10",
+  "version": "3.10.0",
   "repository": {
     "directory": "packages/functions",
     "type": "git",
@@ -77,7 +77,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@vercel/oidc": "3.8.10"
+    "@vercel/oidc": "4.0.0"
   },
   "scripts": {
     "pretest": "pnpm run build:code",

package/websocket/index.d.ts

@@ -2,4 +2,8 @@ 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>;
+export declare function upgradeWebSocket(handler: (ws: WebSocket) => void | Promise<void>, options?: UpgradeWebSocketOptions): Promise<Response>;
+/**
+ * @deprecated Use upgradeWebSocket instead.
+ */
+export declare const experimental_upgradeWebSocket: typeof upgradeWebSocket;

package/websocket/index.js

@@ -28,7 +28,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var websocket_exports = {};
 __export(websocket_exports, {
-  experimental_upgradeWebSocket: () => experimental_upgradeWebSocket
+  experimental_upgradeWebSocket: () => experimental_upgradeWebSocket,
+  upgradeWebSocket: () => upgradeWebSocket
 });
 module.exports = __toCommonJS(websocket_exports);
 var import_get_context = require("../get-context");
@@ -39,15 +40,15 @@ async function loadWebSocketServer() {
     return ws.WebSocketServer;
   } catch {
     throw new Error(
-      'The "ws" package is required for experimental_upgradeWebSocket(). Install it with: npm install ws'
+      'The "ws" package is required for upgradeWebSocket(). Install it with: npm install ws'
     );
   }
 }
-async function experimental_upgradeWebSocket(handler, options = {}) {
+async function 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."
+      "upgradeWebSocket is not available in the current runtime environment. This feature requires a Vercel runtime that supports WebSocket upgrades."
     );
   }
   const WebSocketServer = await loadWebSocketServer();
@@ -95,7 +96,9 @@ async function experimental_upgradeWebSocket(handler, options = {}) {
   }
   return new Response(null, { status: 204 });
 }
+const experimental_upgradeWebSocket = upgradeWebSocket;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  experimental_upgradeWebSocket
+  experimental_upgradeWebSocket,
+  upgradeWebSocket
 });