@vercel/functions 3.5.0 → 3.6.0

package/docs/oidc/functions/getVercelOidcToken.md

@@ -0,0 +1,58 @@
+[**@vercel/functions**](../../README.md)
+
+***
+
+# ~~Function: getVercelOidcToken()~~
+
+> **getVercelOidcToken**(`options?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>
+
+Defined in: packages/oidc/dist/get-vercel-oidc-token.d.ts:60
+
+Gets the current OIDC token from the request context 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.
+
+Unlike the `getVercelOidcTokenSync` function, this function will refresh the token if it is expired in a development environment.
+
+## Parameters
+
+### options?
+
+`GetVercelOidcTokenOptions`
+
+Optional configuration for token retrieval.
+
+## Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>
+
+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
+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.
+
+## Examples
+
+```js
+// Using the OIDC token
+getVercelOidcToken().then((token) => {
+  console.log('OIDC Token:', token);
+}).catch((error) => {
+  console.error('Error:', error.message);
+});
+```
+
+```js
+// Using the OIDC token with explicit team and project (supports IDs and slugs)
+getVercelOidcToken({ team: 'my-team', project: 'my-project' }).then((token) => {
+  console.log('OIDC Token:', token);
+}).catch((error) => {
+  console.error('Error:', error.message);
+});
+```

package/docs/oidc/functions/getVercelOidcTokenSync.md

@@ -0,0 +1,36 @@
+[**@vercel/functions**](../../README.md)
+
+***
+
+# ~~Function: getVercelOidcTokenSync()~~
+
+> **getVercelOidcTokenSync**(): `string`
+
+Defined in: packages/oidc/dist/get-vercel-oidc-token.d.ts:82
+
+Gets the current OIDC token from the request context 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.
+
+This function will not refresh the token if it is expired. For refreshing the token, use the @{link getVercelOidcToken} function.
+
+## Returns
+
+`string`
+
+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.
+
+## Example
+
+```js
+// Using the OIDC token
+const token = getVercelOidcTokenSync();
+console.log('OIDC Token:', token);
+```

package/docs/oidc/interfaces/AwsCredentialsProviderInit.md

@@ -0,0 +1,195 @@
+[**@vercel/functions**](../../README.md)
+
+***
+
+# Interface: AwsCredentialsProviderInit
+
+Defined in: [packages/functions/src/oidc/aws-credentials-provider.ts:20](https://github.com/vercel/vercel/blob/main/packages/functions/src/oidc/aws-credentials-provider.ts#L20)
+
+The init object for the `awsCredentialsProvider` function.
+
+## Extends
+
+- [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<`FromWebTokenInit`, `"webIdentityToken"`\>
+
+## Properties
+
+### clientConfig?
+
+> `optional` **clientConfig?**: `any`
+
+Defined in: node\_modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0\_@aws-sdk+client-sts@3.806.0/node\_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:135
+
+Custom STS client configurations overriding the default ones.
+
+#### Inherited from
+
+`Omit.clientConfig`
+
+***
+
+### clientPlugins?
+
+> `optional` **clientPlugins?**: `Pluggable`\<`any`, `any`\>[]
+
+Defined in: node\_modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0\_@aws-sdk+client-sts@3.806.0/node\_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:139
+
+Custom STS client middleware plugin to modify the client default behavior.
+
+#### Inherited from
+
+`Omit.clientPlugins`
+
+***
+
+### durationSeconds?
+
+> `optional` **durationSeconds?**: `number`
+
+The duration, in seconds, of the role session. Defaults to 3600 seconds.
+
+#### Inherited from
+
+`Omit.durationSeconds`
+
+***
+
+### logger?
+
+> `optional` **logger?**: `Logger`
+
+Defined in: node\_modules/.pnpm/@aws-sdk+types@3.609.0/node\_modules/@aws-sdk/types/dist-types/credentials.d.ts:31
+
+This logger is only used to provide information
+on what credential providers were used during resolution.
+
+It does not log credentials.
+
+#### Inherited from
+
+`Omit.logger`
+
+***
+
+### ~~parentClientConfig?~~
+
+> `optional` **parentClientConfig?**: `object`
+
+Defined in: node\_modules/.pnpm/@aws-sdk+types@3.609.0/node\_modules/@aws-sdk/types/dist-types/credentials.d.ts:45
+
+**`Internal`**
+
+Present if the credential provider was created by calling
+the defaultCredentialProvider in a client's middleware, having
+access to the client's config.
+
+The region of that parent or outer client is important because
+an inner client used by the credential provider may need
+to match its default partition or region with that of
+the outer client.
+
+#### Index Signature
+
+\[`key`: `string`\]: `unknown`
+
+#### ~~region?~~
+
+> `optional` **region?**: `string` \| `Provider`\<`string`\>
+
+#### Deprecated
+
+- not truly deprecated, marked as a warning to not use this.
+
+#### Inherited from
+
+`Omit.parentClientConfig`
+
+***
+
+### policy?
+
+> `optional` **policy?**: `string`
+
+An IAM policy in JSON format that you want to use as an inline session policy.
+
+#### Inherited from
+
+`Omit.policy`
+
+***
+
+### policyArns?
+
+> `optional` **policyArns?**: `object`[]
+
+ARNs of the IAM managed policies that you want to use as managed session policies.
+
+#### arn?
+
+> `optional` **arn?**: `string`
+
+#### Inherited from
+
+`Omit.policyArns`
+
+***
+
+### providerId?
+
+> `optional` **providerId?**: `string`
+
+The fully qualified host component of the domain name of the identity provider.
+
+#### Inherited from
+
+`Omit.providerId`
+
+***
+
+### roleArn
+
+> **roleArn**: `string`
+
+ARN of the role that the caller is assuming.
+
+#### Inherited from
+
+`Omit.roleArn`
+
+***
+
+### roleAssumerWithWebIdentity?
+
+> `optional` **roleAssumerWithWebIdentity?**: (`params`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`AwsCredentialIdentity`\>
+
+Defined in: node\_modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0\_@aws-sdk+client-sts@3.806.0/node\_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:130
+
+A function that assumes a role with web identity and returns a promise fulfilled with credentials for the assumed role.
+
+#### Parameters
+
+##### params
+
+`AssumeRoleWithWebIdentityParams`
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`AwsCredentialIdentity`\>
+
+#### Inherited from
+
+`Omit.roleAssumerWithWebIdentity`
+
+***
+
+### roleSessionName?
+
+> `optional` **roleSessionName?**: `string`
+
+Defined in: node\_modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0\_@aws-sdk+client-sts@3.806.0/node\_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:123
+
+An identifier for the assumed role session.
+
+#### Inherited from
+
+`Omit.roleSessionName`

package/package.json

@@ -30,7 +30,7 @@
       "require": "./middleware.js"
     }
   },
-  "version": "3.5.0",
+  "version": "3.6.0",
   "repository": {
     "directory": "packages/functions",
     "type": "git",
@@ -51,9 +51,9 @@
     "mysql2": "3.14.2",
     "prettier": "3.8.3",
     "tinyspawn": "1.3.1",
-    "typedoc": "0.24.6",
-    "typedoc-plugin-markdown": "3.15.2",
-    "typedoc-plugin-mdn-links": "3.0.3",
+    "typedoc": "0.28.19",
+    "typedoc-plugin-markdown": "4.11.0",
+    "typedoc-plugin-mdn-links": "5.1.1",
     "vitest": "2.0.1"
   },
   "peerDependencies": {
@@ -72,7 +72,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@vercel/oidc": "3.4.0"
+    "@vercel/oidc": "3.4.1"
   },
   "scripts": {
     "pretest": "pnpm run build:code",

package/docs/interfaces/index.DangerouslyDeleteOptions.md

@@ -1,22 +0,0 @@
-# Interface: DangerouslyDeleteOptions
-
-[index](../modules/index.md).DangerouslyDeleteOptions
-
-## Table of contents
-
-### Properties
-
-- [revalidationDeadlineSeconds](index.DangerouslyDeleteOptions.md#revalidationdeadlineseconds)
-
-## Properties
-
-### revalidationDeadlineSeconds
-
-• `Optional` **revalidationDeadlineSeconds**: `number`
-
-The time in seconds for how long the stale content can be served while revalidating the new content in the background.
-If none is provided, the default is 0 and the content will be deleted immediately.
-
-#### Defined in
-
-[packages/functions/src/purge/types.ts:6](https://github.com/vercel/vercel/blob/main/packages/functions/src/purge/types.ts#L6)

package/docs/interfaces/index.Geo.md

@@ -1,115 +0,0 @@
-# Interface: Geo
-
-[index](../modules/index.md).Geo
-
-The location information of a given request.
-
-## Table of contents
-
-### Properties
-
-- [city](index.Geo.md#city)
-- [country](index.Geo.md#country)
-- [countryRegion](index.Geo.md#countryregion)
-- [flag](index.Geo.md#flag)
-- [latitude](index.Geo.md#latitude)
-- [longitude](index.Geo.md#longitude)
-- [postalCode](index.Geo.md#postalcode)
-- [region](index.Geo.md#region)
-
-## Properties
-
-### city
-
-• `Optional` **city**: `string`
-
-The city that the request originated from.
-
-#### Defined in
-
-[packages/functions/src/headers.ts:59](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L59)
-
----
-
-### country
-
-• `Optional` **country**: `string`
-
-The country that the request originated from.
-
-#### Defined in
-
-[packages/functions/src/headers.ts:62](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L62)
-
----
-
-### countryRegion
-
-• `Optional` **countryRegion**: `string`
-
-The region part of the ISO 3166-2 code of the client IP.
-See [docs](https://vercel.com/docs/concepts/edge-network/headers#x-vercel-ip-country-region).
-
-#### Defined in
-
-[packages/functions/src/headers.ts:73](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L73)
-
----
-
-### flag
-
-• `Optional` **flag**: `string`
-
-The flag emoji for the country the request originated from.
-
-#### Defined in
-
-[packages/functions/src/headers.ts:65](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L65)
-
----
-
-### latitude
-
-• `Optional` **latitude**: `string`
-
-The latitude of the client.
-
-#### Defined in
-
-[packages/functions/src/headers.ts:76](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L76)
-
----
-
-### longitude
-
-• `Optional` **longitude**: `string`
-
-The longitude of the client.
-
-#### Defined in
-
-[packages/functions/src/headers.ts:79](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L79)
-
----
-
-### postalCode
-
-• `Optional` **postalCode**: `string`
-
-The postal code of the client
-
-#### Defined in
-
-[packages/functions/src/headers.ts:82](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L82)
-
----
-
-### region
-
-• `Optional` **region**: `string`
-
-The [Vercel Edge Network region](https://vercel.com/docs/concepts/edge-network/regions) that received the request.
-
-#### Defined in
-
-[packages/functions/src/headers.ts:68](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L68)

package/docs/interfaces/index.PurgeApi.md

@@ -1,134 +0,0 @@
-# Interface: PurgeApi
-
-[index](../modules/index.md).PurgeApi
-
-Vercel Cache Purge APIs.
-
-## Table of contents
-
-### Properties
-
-- [dangerouslyDeleteBySrcImage](index.PurgeApi.md#dangerouslydeletebysrcimage)
-- [dangerouslyDeleteByTag](index.PurgeApi.md#dangerouslydeletebytag)
-- [invalidateBySrcImage](index.PurgeApi.md#invalidatebysrcimage)
-- [invalidateByTag](index.PurgeApi.md#invalidatebytag)
-
-## Properties
-
-### dangerouslyDeleteBySrcImage
-
-• **dangerouslyDeleteBySrcImage**: (`src`: `string` \| `string`[], `options?`: [`DangerouslyDeleteOptions`](index.DangerouslyDeleteOptions.md)) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-#### Type declaration
-
-▸ (`src`, `options?`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-Given a source image, delete all of its transformed images after a specified revalidation deadline.
-If accessed prior to the revalidation deadline, the stale transformed image will be served and a background task will be triggered. After the revalidation deadline is reached, the transformed image will be deleted.
-The default revalidation deadline is 0 and the content will be deleted immediately.
-
-##### Parameters
-
-| Name       | Type                                                            | Description                                                        |
-| :--------- | :-------------------------------------------------------------- | :----------------------------------------------------------------- |
-| `src`      | `string` \| `string`[]                                          | The source image to delete.                                        |
-| `options?` | [`DangerouslyDeleteOptions`](index.DangerouslyDeleteOptions.md) | The options for the delete that specify the revalidation deadline. |
-
-##### Returns
-
-[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-A promise that resolves when the delete is complete.
-
-#### Defined in
-
-[packages/functions/src/purge/types.ts:54](https://github.com/vercel/vercel/blob/main/packages/functions/src/purge/types.ts#L54)
-
----
-
-### dangerouslyDeleteByTag
-
-• **dangerouslyDeleteByTag**: (`tag`: `string` \| `string`[], `options?`: [`DangerouslyDeleteOptions`](index.DangerouslyDeleteOptions.md)) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-#### Type declaration
-
-▸ (`tag`, `options?`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-Delete all content associated with a tag or tags after a specified revalidation deadline.
-If accessed prior to the revalidation deadline, the stale content will be served and a background revalidation will be triggered. After the revalidation deadline is reached, the content will be deleted.
-The default revalidation deadline is 0 and the content will be deleted immediately.
-
-##### Parameters
-
-| Name       | Type                                                            | Description                                                        |
-| :--------- | :-------------------------------------------------------------- | :----------------------------------------------------------------- |
-| `tag`      | `string` \| `string`[]                                          | The tag or tags to delete.                                         |
-| `options?` | [`DangerouslyDeleteOptions`](index.DangerouslyDeleteOptions.md) | The options for the delete that specify the revalidation deadline. |
-
-##### Returns
-
-[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-A promise that resolves when the delete is complete.
-
-#### Defined in
-
-[packages/functions/src/purge/types.ts:31](https://github.com/vercel/vercel/blob/main/packages/functions/src/purge/types.ts#L31)
-
----
-
-### invalidateBySrcImage
-
-• **invalidateBySrcImage**: (`src`: `string` \| `string`[]) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-#### Type declaration
-
-▸ (`src`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-Given a source image, invalidate all of its transformed images by marking them as stale.
-On the next access, the stale transformed image will be served and a background task will transform the source image.
-
-##### Parameters
-
-| Name  | Type                   | Description                     |
-| :---- | :--------------------- | :------------------------------ |
-| `src` | `string` \| `string`[] | The source image to invalidate. |
-
-##### Returns
-
-[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-A promise that resolves when the invalidate is complete.
-
-#### Defined in
-
-[packages/functions/src/purge/types.ts:43](https://github.com/vercel/vercel/blob/main/packages/functions/src/purge/types.ts#L43)
-
----
-
-### invalidateByTag
-
-• **invalidateByTag**: (`tag`: `string` \| `string`[]) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-#### Type declaration
-
-▸ (`tag`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-Invalidate all content associated with a tag or tags by marking them as stale.
-On the next access to content associated with any of the tags, the stale content will be served and a background revalidation will be triggered.
-
-##### Parameters
-
-| Name  | Type                   | Description                    |
-| :---- | :--------------------- | :----------------------------- |
-| `tag` | `string` \| `string`[] | The tag or tags to invalidate. |
-
-##### Returns
-
-[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-A promise that resolves when the invalidate is complete.
-
-#### Defined in
-
-[packages/functions/src/purge/types.ts:20](https://github.com/vercel/vercel/blob/main/packages/functions/src/purge/types.ts#L20)

package/docs/interfaces/index.Request.md

@@ -1,23 +0,0 @@
-# Interface: Request
-
-[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.
-
-## Table of contents
-
-### Properties
-
-- [headers](index.Request.md#headers)
-
-## Properties
-
-### headers
-
-• **headers**: `Headers`
-
-Represents the headers of a request.
-
-#### Defined in
-
-[packages/functions/src/headers.ts:52](https://github.com/vercel/vercel/blob/main/packages/functions/src/headers.ts#L52)