@vercel/functions 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vercel/functions
 
+## 2.2.0
+
+### Minor Changes
+
+- Introduce `getVercelOidcTokenSync` ([#13429](https://github.com/vercel/vercel/pull/13429))
+
 ## 2.1.0
 
 ### Minor Changes

package/docs/modules/oidc.md

@@ -10,6 +10,7 @@
 
 - [awsCredentialsProvider](oidc.md#awscredentialsprovider)
 - [getVercelOidcToken](oidc.md#getverceloidctoken)
+- [getVercelOidcTokenSync](oidc.md#getverceloidctokensync)
 
 ## Functions
 
@@ -64,13 +65,13 @@ 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.
+
+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.
 
-context headers.
-
 **`Throws`**
 
 If the `x-vercel-oidc-token` header is missing from the request context and the environment variable `VERCEL_OIDC_TOKEN` is not set.
@@ -97,3 +98,38 @@ A promise that resolves to the OIDC token.
 #### Defined in
 
 [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/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,11 +1,11 @@
 /**
- * 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.
+ *
+ * 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.
  *
- * context headers.
- *
  * @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.
  *
@@ -21,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,11 +18,15 @@ 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() {
+  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(
@@ -33,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.1.0",
+  "version": "2.2.0",
   "repository": {
     "directory": "packages/functions",
     "type": "git",