@vercel/functions 1.4.2 → 1.5.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @vercel/functions
 
+## 1.5.1
+
+### Patch Changes
+
+- [@vercel/functions] update headers doc ([#12649](https://github.com/vercel/vercel/pull/12649))
+
+## 1.5.0
+
+### Minor Changes
+
+- ipAddress: accept headers as input ([#12429](https://github.com/vercel/vercel/pull/12429))
+
 ## 1.4.2
 
 ### Patch Changes

package/README.md

@@ -1,60 +1,5 @@
-<p align="center">
-  <a href="https://vercel.com">
-    <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96">
-    <h3 align="center">Vercel</h3>
-  </a>
-  <p align="center">Develop. Preview. Ship.</p>
-</p>
+# `@vercel/functions`
 
-[Join the Vercel Community](https://vercel.community/)
+Runtime functions to be used with your Vercel Functions.
 
-## OIDC Support Functions
-
-### AWS S3 Example
-
-```ts
-import * as s3 from '@aws-sdk/client-s3';
-import { awsCredentialsProvider } from '@vercel/functions/oidc';
-
-const s3Client = new s3.S3Client({
-  credentials: awsCredentialsProvider({
-    roleArn: process.env.AWS_ROLE_ARN,
-  }),
-});
-
-export const GET = () => {
-  const result = await s3Client.send(
-    new s3.ListObjectsV2Command({
-      Bucket: process.env.BUCKET_NAME,
-    })
-  );
-  return Response.json({ objects: result.Contents });
-};
-```
-
-### Azure CosmosDB Example
-
-```ts
-import { ClientAssertionCredential } from '@azure/identity';
-import { CosmosClient } from '@azure/cosmos';
-import { getVercelOidcToken } from '@vercel/functions/oidc';
-
-const credentialsProvider = new ClientAssertionCredential(
-  process.env.AZURE_TENANT_ID,
-  process.env.AZURE_CLIENT_ID,
-  getVercelOidcToken
-);
-
-const cosmosClient = new CosmosClient({
-  endpoint: process.env.COSMOS_DB_ENDPOINT,
-  aadCredentials: credentialsProvider,
-});
-
-export const GET = () => {
-  const container = cosmosClient
-    .database(process.env.COSMOS_DB_NAME)
-    .container(process.env.COSMOS_DB_CONTAINER);
-  const items = await container.items.query('SELECT * FROM f').fetchAll();
-  return Response.json({ items: items.resources });
-};
-```
+Please [follow the documentation](https://vercel.com/docs/functions/vercel-functions-package) for examples and usage.

package/docs/interfaces/index.Geo.md

@@ -26,7 +26,7 @@ The city that the request originated from.
 
 #### Defined in
 
-[packages/functions/src/headers.ts:50](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L50)
+[packages/functions/src/headers.ts:55](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L55)
 
 ---
 
@@ -38,7 +38,7 @@ The country that the request originated from.
 
 #### Defined in
 
-[packages/functions/src/headers.ts:53](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L53)
+[packages/functions/src/headers.ts:58](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L58)
 
 ---
 
@@ -51,7 +51,7 @@ See [docs](https://vercel.com/docs/concepts/edge-network/headers#x-vercel-ip-cou
 
 #### Defined in
 
-[packages/functions/src/headers.ts:64](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L64)
+[packages/functions/src/headers.ts:69](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L69)
 
 ---
 
@@ -63,7 +63,7 @@ The flag emoji for the country the request originated from.
 
 #### Defined in
 
-[packages/functions/src/headers.ts:56](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L56)
+[packages/functions/src/headers.ts:61](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L61)
 
 ---
 
@@ -75,7 +75,7 @@ The latitude of the client.
 
 #### Defined in
 
-[packages/functions/src/headers.ts:67](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L67)
+[packages/functions/src/headers.ts:72](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L72)
 
 ---
 
@@ -87,7 +87,7 @@ The longitude of the client.
 
 #### Defined in
 
-[packages/functions/src/headers.ts:70](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L70)
+[packages/functions/src/headers.ts:75](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L75)
 
 ---
 
@@ -99,4 +99,4 @@ The [Vercel Edge Network region](https://vercel.com/docs/concepts/edge-network/r
 
 #### Defined in
 
-[packages/functions/src/headers.ts:59](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L59)
+[packages/functions/src/headers.ts:64](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L64)

package/docs/interfaces/index.Request.md

@@ -2,8 +2,7 @@
 
 [index](../modules/index.md).Request
 
-We define a new type so this function can be reused with
-the global `Request`, `node-fetch` and other types.
+We define a new type so this function can be reused with the global `Request`, `node-fetch` and other types.
 
 ## Table of contents
 
@@ -15,14 +14,10 @@ the global `Request`, `node-fetch` and other types.
 
 ### headers
 
-• **headers**: `Object`
+• **headers**: `Headers`
 
-#### Type declaration
-
-| Name  | Type                                     |
-| :---- | :--------------------------------------- |
-| `get` | (`name`: `string`) => `null` \| `string` |
+Represents the headers of a request.
 
 #### Defined in
 
-[packages/functions/src/headers.ts:40](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L40)
+[packages/functions/src/headers.ts:48](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L48)

package/docs/modules/index.md

@@ -51,7 +51,7 @@ The location information of the request, in this way:
   "country": "US",
   "flag": "🇺🇸",
   "countryRegion": "NY",
-  "region": "dev1",
+  "region": "iad1",
   "latitude": "40.7128",
   "longitude": "-74.0060"
 }
@@ -59,7 +59,7 @@ The location information of the request, in this way:
 
 #### Defined in
 
-[packages/functions/src/headers.ts:166](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L166)
+[packages/functions/src/headers.ts:172](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L172)
 
 ---
 
@@ -115,7 +115,7 @@ https://vercel.com/docs/projects/environment-variables/system-environment-variab
 
 ### ipAddress
 
-▸ **ipAddress**(`request`): `string` \| `undefined`
+▸ **ipAddress**(`input`): `string` \| `undefined`
 
 Returns the IP address of the request from the headers.
 
@@ -125,16 +125,16 @@ Returns the IP address of the request from the headers.
 import { ipAddress } from '@vercel/functions';
 
 export function GET(request) {
-  const ip = ipAddress(request)
-  return new Response('Your ip is' ${ip});
+  const ip = ipAddress(request);
+  return new Response(`Your IP is ${ip}`);
 }
 ```
 
 #### Parameters
 
-| Name      | Type                                        | Description                                       |
-| :-------- | :------------------------------------------ | :------------------------------------------------ |
-| `request` | [`Request`](../interfaces/index.Request.md) | The incoming request object which provides the IP |
+| Name    | Type                                                     | Description                             |
+| :------ | :------------------------------------------------------- | :-------------------------------------- |
+| `input` | `Headers` \| [`Request`](../interfaces/index.Request.md) | The incoming request object or headers. |
 
 #### Returns
 
@@ -144,7 +144,7 @@ The IP address of the request.
 
 #### Defined in
 
-[packages/functions/src/headers.ts:119](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L119)
+[packages/functions/src/headers.ts:124](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L124)
 
 ---
 

package/headers.d.ts

@@ -33,13 +33,19 @@ export declare const REQUEST_ID_HEADER_NAME = "x-vercel-id";
  */
 export declare const EMOJI_FLAG_UNICODE_STARTING_POSITION = 127397;
 /**
- * We define a new type so this function can be reused with
- * the global `Request`, `node-fetch` and other types.
+ * Represents the headers of a request.
+ */
+export interface Headers {
+    get(name: string): string | null;
+}
+/**
+ * We define a new type so this function can be reused with the global `Request`, `node-fetch` and other types.
  */
 export interface Request {
-    headers: {
-        get(name: string): string | null;
-    };
+    /**
+     * Represents the headers of a request.
+     */
+    headers: Headers;
 }
 /**
  * The location information of a given request.
@@ -65,7 +71,7 @@ export interface Geo {
 /**
  * Returns the IP address of the request from the headers.
  *
- * @param request The incoming request object which provides the IP
+ * @param {(Request|Headers)} input The incoming request object or headers.
  * @returns The IP address of the request.
  *
  * @example
@@ -74,13 +80,13 @@ export interface Geo {
  * import { ipAddress } from '@vercel/functions';
  *
  * export function GET(request) {
- *   const ip = ipAddress(request)
- *   return new Response('Your ip is' ${ip});
+ *   const ip = ipAddress(request);
+ *   return new Response(`Your IP is ${ip}`);
  * }
  * ```
  *
  */
-export declare function ipAddress(request: Request): string | undefined;
+export declare function ipAddress(input: Request | Headers): string | undefined;
 /**
  * Returns the location information for the incoming request.
  * @param request The incoming request object which provides the geolocation data
@@ -92,7 +98,7 @@ export declare function ipAddress(request: Request): string | undefined;
  *  "country": "US",
  *  "flag": "🇺🇸",
  *  "countryRegion": "NY",
- *  "region": "dev1",
+ *  "region": "iad1",
  *  "latitude": "40.7128",
  *  "longitude": "-74.0060"
  * }

package/headers.js

@@ -38,11 +38,11 @@ const LONGITUDE_HEADER_NAME = "x-vercel-ip-longitude";
 const REGION_HEADER_NAME = "x-vercel-ip-country-region";
 const REQUEST_ID_HEADER_NAME = "x-vercel-id";
 const EMOJI_FLAG_UNICODE_STARTING_POSITION = 127397;
-function getHeader(request, key) {
-  return request.headers.get(key) ?? void 0;
+function getHeader(headers, key) {
+  return headers.get(key) ?? void 0;
 }
 function getHeaderWithDecode(request, key) {
-  const header = getHeader(request, key);
+  const header = getHeader(request.headers, key);
   return header ? decodeURIComponent(header) : void 0;
 }
 function getFlag(countryCode) {
@@ -53,8 +53,9 @@ function getFlag(countryCode) {
     ...countryCode.split("").map((char) => EMOJI_FLAG_UNICODE_STARTING_POSITION + char.charCodeAt(0))
   );
 }
-function ipAddress(request) {
-  return getHeader(request, IP_HEADER_NAME);
+function ipAddress(input) {
+  const headers = "headers" in input ? input.headers : input;
+  return getHeader(headers, IP_HEADER_NAME);
 }
 function getRegionFromRequestId(requestId) {
   if (!requestId) {
@@ -66,12 +67,14 @@ function geolocation(request) {
   return {
     // city name may be encoded to support multi-byte characters
     city: getHeaderWithDecode(request, CITY_HEADER_NAME),
-    country: getHeader(request, COUNTRY_HEADER_NAME),
-    flag: getFlag(getHeader(request, COUNTRY_HEADER_NAME)),
-    countryRegion: getHeader(request, REGION_HEADER_NAME),
-    region: getRegionFromRequestId(getHeader(request, REQUEST_ID_HEADER_NAME)),
-    latitude: getHeader(request, LATITUDE_HEADER_NAME),
-    longitude: getHeader(request, LONGITUDE_HEADER_NAME)
+    country: getHeader(request.headers, COUNTRY_HEADER_NAME),
+    flag: getFlag(getHeader(request.headers, COUNTRY_HEADER_NAME)),
+    countryRegion: getHeader(request.headers, REGION_HEADER_NAME),
+    region: getRegionFromRequestId(
+      getHeader(request.headers, REQUEST_ID_HEADER_NAME)
+    ),
+    latitude: getHeader(request.headers, LATITUDE_HEADER_NAME),
+    longitude: getHeader(request.headers, LONGITUDE_HEADER_NAME)
   };
 }
 // Annotate the CommonJS export names for ESM import in node:

package/package.json

@@ -9,7 +9,7 @@
   ],
   "main": "./index.js",
   "types": "./index.d.ts",
-  "version": "1.4.2",
+  "version": "1.5.1",
   "repository": {
     "directory": "packages/functions",
     "type": "git",