@vercel/functions 2.0.3 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @vercel/functions
 
+## 2.2.0
+
+### Minor Changes
+
+- Introduce `getVercelOidcTokenSync` ([#13429](https://github.com/vercel/vercel/pull/13429))
+
+## 2.1.0
+
+### Minor Changes
+
+- Change the load order of the OIDC token ([#13337](https://github.com/vercel/vercel/pull/13337))
+
+### Patch Changes
+
+- Rename getRuntimeCache to getCache ([#13325](https://github.com/vercel/vercel/pull/13325))
+
 ## 2.0.3
 
 ### Patch Changes

package/cache/index.d.ts

@@ -13,4 +13,4 @@ import { CacheOptions, RuntimeCache } from './types';
  * @returns An instance of the Vercel Runtime Cache.
  * @throws {Error} If no cache is available in the context and `InMemoryCache` cannot be created.
  */
-export declare const getRuntimeCache: (cacheOptions?: CacheOptions) => RuntimeCache;
+export declare const getCache: (cacheOptions?: CacheOptions) => RuntimeCache;

package/cache/index.js

@@ -18,7 +18,7 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var cache_exports = {};
 __export(cache_exports, {
-  getRuntimeCache: () => getRuntimeCache
+  getCache: () => getCache
 });
 module.exports = __toCommonJS(cache_exports);
 var import_get_context = require("../get-context");
@@ -32,7 +32,7 @@ const defaultKeyHashFunction = (key) => {
 };
 const defaultNamespaceSeparator = "$";
 let inMemoryCacheInstance = null;
-const getRuntimeCache = (cacheOptions) => {
+const getCache = (cacheOptions) => {
   let cache;
   if ((0, import_get_context.getContext)().cache) {
     cache = (0, import_get_context.getContext)().cache;
@@ -68,5 +68,5 @@ const getRuntimeCache = (cacheOptions) => {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  getRuntimeCache
+  getCache
 });

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.803.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.806.0/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.803.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.806.0/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.803.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.806.0/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.803.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.806.0/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:123

package/docs/modules/index.md

@@ -11,8 +11,8 @@
 ### Functions
 
 - [geolocation](index.md#geolocation)
+- [getCache](index.md#getcache)
 - [getEnv](index.md#getenv)
-- [getRuntimeCache](index.md#getruntimecache)
 - [ipAddress](index.md#ipaddress)
 - [next](index.md#next)
 - [rewrite](index.md#rewrite)
@@ -68,6 +68,41 @@ The location information of the request, in this way:
 
 ---
 
+### getCache
+
+▸ **getCache**(`cacheOptions?`): [`RuntimeCache`](../interfaces/index.RuntimeCache.md)
+
+Retrieves the Vercel Runtime Cache.
+
+Keys are hashed to ensure they are unique and consistent. The hashing function can be overridden by providing a custom
+`keyHashFunction` in the `cacheOptions` parameter.
+
+To specify a namespace for the cache keys, you can pass a `namespace` option in the `cacheOptions` parameter. If
+a namespace is provided, the cache keys will be prefixed with the namespace followed by a separator (default is `$`). The
+namespaceSeparator can also be customized using the `namespaceSeparator` option.
+
+**`Throws`**
+
+If no cache is available in the context and `InMemoryCache` cannot be created.
+
+#### Parameters
+
+| Name            | Type           | Description                           |
+| :-------------- | :------------- | :------------------------------------ |
+| `cacheOptions?` | `CacheOptions` | Optional configuration for the cache. |
+
+#### Returns
+
+[`RuntimeCache`](../interfaces/index.RuntimeCache.md)
+
+An instance of the Vercel Runtime Cache.
+
+#### Defined in
+
+[packages/functions/src/cache/index.ts:32](https://github.com/vercel/vercel/blob/main/packages/functions/src/cache/index.ts#L32)
+
+---
+
 ### getEnv
 
 ▸ **getEnv**(`env?`): `Object`
@@ -118,41 +153,6 @@ https://vercel.com/docs/projects/environment-variables/system-environment-variab
 
 ---
 
-### getRuntimeCache
-
-▸ **getRuntimeCache**(`cacheOptions?`): [`RuntimeCache`](../interfaces/index.RuntimeCache.md)
-
-Retrieves the Vercel Runtime Cache.
-
-Keys are hashed to ensure they are unique and consistent. The hashing function can be overridden by providing a custom
-`keyHashFunction` in the `cacheOptions` parameter.
-
-To specify a namespace for the cache keys, you can pass a `namespace` option in the `cacheOptions` parameter. If
-a namespace is provided, the cache keys will be prefixed with the namespace followed by a separator (default is `$`). The
-namespaceSeparator can also be customized using the `namespaceSeparator` option.
-
-**`Throws`**
-
-If no cache is available in the context and `InMemoryCache` cannot be created.
-
-#### Parameters
-
-| Name            | Type           | Description                           |
-| :-------------- | :------------- | :------------------------------------ |
-| `cacheOptions?` | `CacheOptions` | Optional configuration for the cache. |
-
-#### Returns
-
-[`RuntimeCache`](../interfaces/index.RuntimeCache.md)
-
-An instance of the Vercel Runtime Cache.
-
-#### Defined in
-
-[packages/functions/src/cache/index.ts:32](https://github.com/vercel/vercel/blob/main/packages/functions/src/cache/index.ts#L32)
-
----
-
 ### ipAddress
 
 ▸ **ipAddress**(`input`): `string` \| `undefined`

package/docs/modules/oidc.md

@@ -10,6 +10,7 @@
 
 - [awsCredentialsProvider](oidc.md#awscredentialsprovider)
 - [getVercelOidcToken](oidc.md#getverceloidctoken)
+- [getVercelOidcTokenSync](oidc.md#getverceloidctokensync)
 
 ## Functions
 
@@ -64,11 +65,12 @@ A function that provides AWS credentials.
 
 ▸ **getVercelOidcToken**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`string`\>
 
-Returns the OIDC token from the request context or the environment variable.
+Gets the current OIDC token from the request context or the environment variable.
 
-This function first checks if the OIDC token is available in the environment variable
-`VERCEL_OIDC_TOKEN`. If it is not found there, it retrieves the token from the request
-context headers.
+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.
 
 **`Throws`**
 
@@ -95,4 +97,39 @@ A promise that resolves to the OIDC token.
 
 #### Defined in
 
-[packages/functions/src/oidc/get-vercel-oidc-token.ts:24](https://github.com/vercel/vercel/blob/main/packages/functions/src/oidc/get-vercel-oidc-token.ts#L24)
+[packages/functions/src/oidc/get-vercel-oidc-token.ts:25](https://github.com/vercel/vercel/blob/main/packages/functions/src/oidc/get-vercel-oidc-token.ts#L25)
+
+---
+
+### getVercelOidcTokenSync
+
+▸ **getVercelOidcTokenSync**(): `string`
+
+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.
+
+**`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);
+```
+
+#### Returns
+
+`string`
+
+The OIDC token.
+
+#### Defined in
+
+[packages/functions/src/oidc/get-vercel-oidc-token.ts:48](https://github.com/vercel/vercel/blob/main/packages/functions/src/oidc/get-vercel-oidc-token.ts#L48)

package/index.d.ts

@@ -3,5 +3,5 @@ export { geolocation, ipAddress } from './headers';
 export { getEnv } from './get-env';
 export { waitUntil } from './wait-until';
 export { rewrite, next } from './middleware';
-export { getRuntimeCache } from './cache';
+export { getCache } from './cache';
 export type { RuntimeCache } from './cache/types';

package/index.js

@@ -19,8 +19,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   geolocation: () => import_headers.geolocation,
+  getCache: () => import_cache.getCache,
   getEnv: () => import_get_env.getEnv,
-  getRuntimeCache: () => import_cache.getRuntimeCache,
   ipAddress: () => import_headers.ipAddress,
   next: () => import_middleware.next,
   rewrite: () => import_middleware.rewrite,
@@ -35,8 +35,8 @@ var import_cache = require("./cache");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   geolocation,
+  getCache,
   getEnv,
-  getRuntimeCache,
   ipAddress,
   next,
   rewrite,

package/oidc/aws-credentials-provider.js

@@ -37,7 +37,7 @@ function awsCredentialsProvider(init) {
     const { fromWebToken } = await import("@aws-sdk/credential-provider-web-identity");
     return fromWebToken({
       ...init,
-      webIdentityToken: await (0, import_get_vercel_oidc_token.getVercelOidcToken)()
+      webIdentityToken: (0, import_get_vercel_oidc_token.getVercelOidcTokenSync)()
     })();
   };
 }

package/oidc/get-vercel-oidc-token.d.ts

@@ -1,9 +1,10 @@
 /**
- * Returns the OIDC token from the request context or the environment variable.
+ * Gets the current OIDC token from the request context or the environment variable.
  *
- * This function first checks if the OIDC token is available in the environment variable
- * `VERCEL_OIDC_TOKEN`. If it is not found there, it retrieves the token from the request
- * context headers.
+ * 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.
  *
  * @returns {Promise<string>} A promise that resolves to the OIDC token.
  * @throws {Error} If the `x-vercel-oidc-token` header is missing from the request context and the environment variable `VERCEL_OIDC_TOKEN` is not set.
@@ -20,3 +21,23 @@
  * ```
  */
 export declare function getVercelOidcToken(): Promise<string>;
+/**
+ * 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.
+ *
+ * @returns {string} The OIDC token.
+ * @throws {Error} 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);
+ * ```
+ */
+export declare function getVercelOidcTokenSync(): string;

package/oidc/get-vercel-oidc-token.js

@@ -18,14 +18,16 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var get_vercel_oidc_token_exports = {};
 __export(get_vercel_oidc_token_exports, {
-  getVercelOidcToken: () => getVercelOidcToken
+  getVercelOidcToken: () => getVercelOidcToken,
+  getVercelOidcTokenSync: () => getVercelOidcTokenSync
 });
 module.exports = __toCommonJS(get_vercel_oidc_token_exports);
 var import_get_context = require("../get-context");
 async function getVercelOidcToken() {
-  if (process.env.VERCEL_OIDC_TOKEN)
-    return process.env.VERCEL_OIDC_TOKEN;
-  const token = (0, import_get_context.getContext)().headers?.["x-vercel-oidc-token"];
+  return getVercelOidcTokenSync();
+}
+function getVercelOidcTokenSync() {
+  const token = (0, import_get_context.getContext)().headers?.["x-vercel-oidc-token"] ?? process.env.VERCEL_OIDC_TOKEN;
   if (!token) {
     throw new Error(
       `The 'x-vercel-oidc-token' header is missing from the request. Do you have the OIDC option enabled in the Vercel project settings?`
@@ -35,5 +37,6 @@ async function getVercelOidcToken() {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  getVercelOidcToken
+  getVercelOidcToken,
+  getVercelOidcTokenSync
 });

package/oidc/index.d.ts

@@ -1,3 +1,3 @@
 export type { AwsCredentialsProviderInit } from './aws-credentials-provider';
 export { awsCredentialsProvider } from './aws-credentials-provider';
-export { getVercelOidcToken } from './get-vercel-oidc-token';
+export { getVercelOidcToken, getVercelOidcTokenSync, } from './get-vercel-oidc-token';

package/oidc/index.js

@@ -19,7 +19,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var oidc_exports = {};
 __export(oidc_exports, {
   awsCredentialsProvider: () => import_aws_credentials_provider.awsCredentialsProvider,
-  getVercelOidcToken: () => import_get_vercel_oidc_token.getVercelOidcToken
+  getVercelOidcToken: () => import_get_vercel_oidc_token.getVercelOidcToken,
+  getVercelOidcTokenSync: () => import_get_vercel_oidc_token.getVercelOidcTokenSync
 });
 module.exports = __toCommonJS(oidc_exports);
 var import_aws_credentials_provider = require("./aws-credentials-provider");
@@ -27,5 +28,6 @@ var import_get_vercel_oidc_token = require("./get-vercel-oidc-token");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   awsCredentialsProvider,
-  getVercelOidcToken
+  getVercelOidcToken,
+  getVercelOidcTokenSync
 });

package/package.json

@@ -26,7 +26,7 @@
       "require": "./middleware.js"
     }
   },
-  "version": "2.0.3",
+  "version": "2.2.0",
   "repository": {
     "directory": "packages/functions",
     "type": "git",