@vercel/functions 1.5.2 → 1.6.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vercel/functions
 
+## 1.6.0
+
+### Minor Changes
+
+- Add middleware-related helper functions ([#12938](https://github.com/vercel/vercel/pull/12938))
+
 ## 1.5.2
 
 ### Patch Changes

package/docs/interfaces/oidc.AwsCredentialsProviderInit.md

@@ -40,7 +40,7 @@ Omit.clientConfig
 
 #### Defined in
 
-node*modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0*@aws-sdk+client-sts@3.609.0/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:135
+node*modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0*@aws-sdk+client-sts@3.731.1/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:135
 
 ---
 
@@ -56,7 +56,7 @@ Omit.clientPlugins
 
 #### Defined in
 
-node*modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0*@aws-sdk+client-sts@3.609.0/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:139
+node*modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0*@aws-sdk+client-sts@3.731.1/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:139
 
 ---
 
@@ -202,7 +202,7 @@ Omit.roleAssumerWithWebIdentity
 
 #### Defined in
 
-node*modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0*@aws-sdk+client-sts@3.609.0/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:130
+node*modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0*@aws-sdk+client-sts@3.731.1/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:130
 
 ---
 
@@ -218,4 +218,4 @@ Omit.roleSessionName
 
 #### Defined in
 
-node*modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0*@aws-sdk+client-sts@3.609.0/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:123
+node*modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0*@aws-sdk+client-sts@3.731.1/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:123

package/docs/modules/index.md

@@ -12,6 +12,8 @@
 - [geolocation](index.md#geolocation)
 - [getEnv](index.md#getenv)
 - [ipAddress](index.md#ipaddress)
+- [next](index.md#next)
+- [rewrite](index.md#rewrite)
 - [waitUntil](index.md#waituntil)
 
 ## Functions
@@ -149,6 +151,116 @@ The IP address of the request.
 
 ---
 
+### next
+
+▸ **next**(`init?`): [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+
+Returns a Response that instructs the system to continue processing the request.
+
+**`Example`**
+
+<caption>No-op middleware</caption>
+
+```ts
+import { next } from '@vercel/edge';
+
+export default function middleware(_req: Request) {
+  return next();
+}
+```
+
+**`Example`**
+
+<caption>Add response headers to all requests</caption>
+
+```ts
+import { next } from '@vercel/edge';
+
+export default function middleware(_req: Request) {
+  return next({
+    headers: { 'x-from-middleware': 'true' },
+  });
+}
+```
+
+#### Parameters
+
+| Name    | Type                | Description                         |
+| :------ | :------------------ | :---------------------------------- |
+| `init?` | `ExtraResponseInit` | Additional options for the response |
+
+#### Returns
+
+[`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+
+#### Defined in
+
+[packages/functions/src/middleware.ts:145](https://github.com/vercel/vercel/blob/main/packages/functions/src/middleware.ts#L145)
+
+---
+
+### rewrite
+
+▸ **rewrite**(`destination`, `init?`): [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+
+Returns a response that rewrites the request to a different URL.
+
+**`Example`**
+
+<caption>Rewrite all feature-flagged requests from `/:path*` to `/experimental/:path*`</caption>
+
+```ts
+import { rewrite, next } from '@vercel/edge';
+
+export default async function middleware(req: Request) {
+  const flagged = await getFlag(req, 'isExperimental');
+  if (flagged) {
+    const url = new URL(req.url);
+    url.pathname = `/experimental{url.pathname}`;
+    return rewrite(url);
+  }
+
+  return next();
+}
+```
+
+**`Example`**
+
+<caption>JWT authentication for `/api/:path*` requests</caption>
+
+```ts
+import { rewrite, next } from '@vercel/edge';
+
+export default function middleware(req: Request) {
+  const auth = checkJwt(req.headers.get('Authorization'));
+  if (!checkJwt) {
+    return rewrite(new URL('/api/error-unauthorized', req.url));
+  }
+  const url = new URL(req.url);
+  url.searchParams.set('_userId', auth.userId);
+  return rewrite(url);
+}
+
+export const config = { matcher: '/api/users/:path*' };
+```
+
+#### Parameters
+
+| Name          | Type                                                                      | Description                         |
+| :------------ | :------------------------------------------------------------------------ | :---------------------------------- |
+| `destination` | `string` \| [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) | new URL to rewrite the request to   |
+| `init?`       | `ExtraResponseInit`                                                       | Additional options for the response |
+
+#### Returns
+
+[`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+
+#### Defined in
+
+[packages/functions/src/middleware.ts:101](https://github.com/vercel/vercel/blob/main/packages/functions/src/middleware.ts#L101)
+
+---
+
 ### waitUntil
 
 ▸ **waitUntil**(`promise`): `undefined` \| `void`

package/index.d.ts

@@ -2,3 +2,4 @@ export type { Request, Geo } from './headers';
 export { geolocation, ipAddress } from './headers';
 export { getEnv } from './get-env';
 export { waitUntil } from './wait-until';
+export { rewrite, next } from './middleware';

package/index.js

@@ -21,16 +21,21 @@ __export(src_exports, {
   geolocation: () => import_headers.geolocation,
   getEnv: () => import_get_env.getEnv,
   ipAddress: () => import_headers.ipAddress,
+  next: () => import_middleware.next,
+  rewrite: () => import_middleware.rewrite,
   waitUntil: () => import_wait_until.waitUntil
 });
 module.exports = __toCommonJS(src_exports);
 var import_headers = require("./headers");
 var import_get_env = require("./get-env");
 var import_wait_until = require("./wait-until");
+var import_middleware = require("./middleware");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   geolocation,
   getEnv,
   ipAddress,
+  next,
+  rewrite,
   waitUntil
 });

package/middleware.d.ts

@@ -0,0 +1,110 @@
+export interface ModifiedRequest {
+    /**
+     * If set, overwrites the incoming headers to the origin request.
+     *
+     * This is useful when you want to pass data between a Middleware and a
+     * Serverless or Edge Function.
+     *
+     * @example
+     * <caption>Add a `x-user-id` header and remove the `Authorization` header</caption>
+     *
+     * ```ts
+     * import { rewrite } from '@vercel/edge';
+     * export default async function middleware(request: Request): Promise<Response> {
+     *   const newHeaders = new Headers(request.headers);
+     *   newHeaders.set('x-user-id', 'user_123');
+     *   newHeaders.delete('authorization');
+     *   return rewrite(request.url, {
+     *     request: { headers: newHeaders }
+     *   })
+     * }
+     * ```
+     */
+    headers?: Headers;
+}
+export interface ExtraResponseInit extends Omit<ResponseInit, 'headers'> {
+    /**
+     * These headers will be sent to the user response
+     * along with the response headers from the origin.
+     */
+    headers?: HeadersInit;
+    /**
+     * Fields to rewrite for the upstream request.
+     */
+    request?: ModifiedRequest;
+}
+/**
+ * Returns a response that rewrites the request to a different URL.
+ *
+ * @param destination new URL to rewrite the request to
+ * @param init Additional options for the response
+ *
+ *
+ * @example
+ * <caption>Rewrite all feature-flagged requests from `/:path*` to `/experimental/:path*`</caption>
+ *
+ * ```ts
+ * import { rewrite, next } from '@vercel/edge';
+ *
+ * export default async function middleware(req: Request) {
+ *   const flagged = await getFlag(req, 'isExperimental');
+ *   if (flagged) {
+ *     const url = new URL(req.url);
+ *     url.pathname = `/experimental{url.pathname}`;
+ *     return rewrite(url);
+ *   }
+ *
+ *   return next();
+ * }
+ * ```
+ *
+ * @example
+ * <caption>JWT authentication for `/api/:path*` requests</caption>
+ *
+ * ```ts
+ * import { rewrite, next } from '@vercel/edge';
+ *
+ * export default function middleware(req: Request) {
+ *   const auth = checkJwt(req.headers.get('Authorization'));
+ *   if (!checkJwt) {
+ *     return rewrite(new URL('/api/error-unauthorized', req.url));
+ *   }
+ *   const url = new URL(req.url);
+ *   url.searchParams.set('_userId', auth.userId);
+ *   return rewrite(url);
+ * }
+ *
+ * export const config = { matcher: '/api/users/:path*' };
+ * ```
+ */
+export declare function rewrite(destination: string | URL, init?: ExtraResponseInit): Response;
+/**
+ * Returns a Response that instructs the system to continue processing the request.
+ *
+ * @param init Additional options for the response
+ *
+ * @example
+ * <caption>No-op middleware</caption>
+ *
+ * ```ts
+ * import { next } from '@vercel/edge';
+ *
+ * export default function middleware(_req: Request) {
+ *   return next();
+ * }
+ * ```
+ *
+ * @example
+ * <caption>Add response headers to all requests</caption>
+ *
+ * ```ts
+ * import { next } from '@vercel/edge';
+ *
+ * export default function middleware(_req: Request) {
+ *   return next({
+ *     headers: { 'x-from-middleware': 'true' },
+ *   })
+ * }
+ * ```
+ */
+export declare function next(init?: ExtraResponseInit): Response;

package/middleware.js

@@ -0,0 +1,60 @@
+"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 middleware_exports = {};
+__export(middleware_exports, {
+  next: () => next,
+  rewrite: () => rewrite
+});
+module.exports = __toCommonJS(middleware_exports);
+function handleMiddlewareField(init, headers) {
+  if (init?.request?.headers) {
+    if (!(init.request.headers instanceof Headers)) {
+      throw new Error("request.headers must be an instance of Headers");
+    }
+    const keys = [];
+    for (const [key, value] of init.request.headers) {
+      headers.set("x-middleware-request-" + key, value);
+      keys.push(key);
+    }
+    headers.set("x-middleware-override-headers", keys.join(","));
+  }
+}
+function rewrite(destination, init) {
+  const headers = new Headers(init?.headers ?? {});
+  headers.set("x-middleware-rewrite", String(destination));
+  handleMiddlewareField(init, headers);
+  return new Response(null, {
+    ...init,
+    headers
+  });
+}
+function next(init) {
+  const headers = new Headers(init?.headers ?? {});
+  headers.set("x-middleware-next", "1");
+  handleMiddlewareField(init, headers);
+  return new Response(null, {
+    ...init,
+    headers
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  next,
+  rewrite
+});

package/package.json

@@ -7,9 +7,26 @@
     "**/*.d.ts",
     "**/*.md"
   ],
-  "main": "./index.js",
   "types": "./index.d.ts",
-  "version": "1.5.2",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.js"
+    },
+    "./headers": {
+      "import": "./headers.js",
+      "require": "./headers.js"
+    },
+    "./oidc": {
+      "import": "./oidc/index.js",
+      "require": "./oidc/index.js"
+    },
+    "./middleware": {
+      "import": "./middleware.js",
+      "require": "./middleware.js"
+    }
+  },
+  "version": "1.6.0",
   "repository": {
     "directory": "packages/functions",
     "type": "git",