@vercel/oidc 3.4.1 → 3.5.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vercel/oidc
 
+## 3.5.0
+
+### Minor Changes
+
+- 5a700dc: Add conditional edge-light export to support Edge Runtime
+
 ## 3.4.1
 
 ### Patch Changes

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

@@ -0,0 +1,22 @@
+/**
+ * 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 {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/dist/get-vercel-oidc-token-sync.js

@@ -0,0 +1,37 @@
+"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 get_vercel_oidc_token_sync_exports = {};
+__export(get_vercel_oidc_token_sync_exports, {
+  getVercelOidcTokenSync: () => getVercelOidcTokenSync
+});
+module.exports = __toCommonJS(get_vercel_oidc_token_sync_exports);
+var import_get_context = require("./get-context");
+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.`
+    );
+  }
+  return token;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getVercelOidcTokenSync
+});

package/dist/{get-vercel-oidc-token.d.ts → get-vercel-oidc-token-with-refresh.d.ts}

@@ -58,25 +58,3 @@ export interface GetVercelOidcTokenOptions {
  * ```
  */
 export declare function getVercelOidcToken(options?: GetVercelOidcTokenOptions): 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.
- *
- * 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 {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/dist/{get-vercel-oidc-token.js → get-vercel-oidc-token-with-refresh.js}

@@ -26,19 +26,18 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   mod
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var get_vercel_oidc_token_exports = {};
-__export(get_vercel_oidc_token_exports, {
-  getVercelOidcToken: () => getVercelOidcToken,
-  getVercelOidcTokenSync: () => getVercelOidcTokenSync
+var get_vercel_oidc_token_with_refresh_exports = {};
+__export(get_vercel_oidc_token_with_refresh_exports, {
+  getVercelOidcToken: () => getVercelOidcToken
 });
-module.exports = __toCommonJS(get_vercel_oidc_token_exports);
-var import_get_context = require("./get-context");
+module.exports = __toCommonJS(get_vercel_oidc_token_with_refresh_exports);
+var import_get_vercel_oidc_token_sync = require("./get-vercel-oidc-token-sync");
 var import_token_error = require("./token-error");
 async function getVercelOidcToken(options) {
   let token = "";
   let err;
   try {
-    token = getVercelOidcTokenSync();
+    token = (0, import_get_vercel_oidc_token_sync.getVercelOidcTokenSync)();
   } catch (error) {
     err = error;
   }
@@ -49,7 +48,7 @@ async function getVercelOidcToken(options) {
     ]);
     if (!token || isExpired(getTokenPayload(token), options?.expirationBufferMs)) {
       await refreshToken(options);
-      token = getVercelOidcTokenSync();
+      token = (0, import_get_vercel_oidc_token_sync.getVercelOidcTokenSync)();
     }
   } catch (error) {
     let message = err instanceof Error ? err.message : "";
@@ -64,17 +63,7 @@ ${error.message}`;
   }
   return token;
 }
-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?`
-    );
-  }
-  return token;
-}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  getVercelOidcToken,
-  getVercelOidcTokenSync
+  getVercelOidcToken
 });

package/dist/{get-vercel-oidc-token.test.js → get-vercel-oidc-token-with-refresh.test.js}

@@ -27,7 +27,7 @@ var os = __toESM(require("os"));
 var path = __toESM(require("path"));
 var fs = __toESM(require("fs"));
 var import_token_io = require("./token-io");
-var import_get_vercel_oidc_token = require("./get-vercel-oidc-token");
+var import_get_vercel_oidc_token_with_refresh = require("./get-vercel-oidc-token-with-refresh");
 var tokenUtil = __toESM(require("./token-util"));
 import_vitest.vi.mock("./token-io");
 import_vitest.vi.mock("./get-context", () => ({
@@ -69,7 +69,7 @@ import_vitest.vi.mock("./get-context", () => ({
       JSON.stringify({ projectId, orgId: teamId })
     );
     process.env.VERCEL_OIDC_TOKEN = createExpiredToken();
-    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token.getVercelOidcToken)()).rejects.toThrow(
+    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).rejects.toThrow(
       /No authentication found/
     );
   });
@@ -79,14 +79,14 @@ import_vitest.vi.mock("./get-context", () => ({
       JSON.stringify({ token: "test-auth-token" })
     );
     process.env.VERCEL_OIDC_TOKEN = createExpiredToken();
-    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token.getVercelOidcToken)()).rejects.toThrow(
+    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).rejects.toThrow(
       /project\.json not found, have you linked your project with `vc link\?`/
     );
   });
   (0, import_vitest.test)("should throw helpful error when root directory cannot be found", async () => {
     import_vitest.vi.mocked(import_token_io.findRootDir).mockReturnValue(null);
     process.env.VERCEL_OIDC_TOKEN = createExpiredToken();
-    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token.getVercelOidcToken)()).rejects.toThrow(
+    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).rejects.toThrow(
       /Unable to find project root directory\. Have you linked your project with `vc link\?`/
     );
   });
@@ -97,7 +97,7 @@ import_vitest.vi.mock("./get-context", () => ({
     );
     import_vitest.vi.mocked(import_token_io.getUserDataDir).mockReturnValue(null);
     process.env.VERCEL_OIDC_TOKEN = createExpiredToken();
-    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token.getVercelOidcToken)()).rejects.toThrow(
+    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).rejects.toThrow(
       /Unable to find user data directory\. Please reach out to Vercel support\./
     );
   });
@@ -114,7 +114,7 @@ import_vitest.vi.mock("./get-context", () => ({
       new Error("Failed to refresh OIDC token: Unauthorized")
     );
     process.env.VERCEL_OIDC_TOKEN = createExpiredToken();
-    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token.getVercelOidcToken)()).rejects.toThrow(
+    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).rejects.toThrow(
       /Failed to refresh OIDC token: Unauthorized/
     );
   });
@@ -133,7 +133,7 @@ import_vitest.vi.mock("./get-context", () => ({
       )
     );
     process.env.VERCEL_OIDC_TOKEN = createExpiredToken();
-    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token.getVercelOidcToken)()).rejects.toThrow(
+    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).rejects.toThrow(
       /Vercel OIDC token is malformed\. Expected a string-valued token property\. Please run `vc env pull` and try again/
     );
   });
@@ -142,19 +142,19 @@ import_vitest.vi.mock("./get-context", () => ({
     import_vitest.vi.spyOn(tokenUtil, "getTokenPayload").mockImplementation(() => {
       throw new Error("Invalid token. Please run `vc env pull` and try again");
     });
-    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token.getVercelOidcToken)()).rejects.toThrow(
+    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).rejects.toThrow(
       /Invalid token\. Please run `vc env pull` and try again/
     );
   });
   (0, import_vitest.test)("should throw error when token expiry check fails", async () => {
     process.env.VERCEL_OIDC_TOKEN = "not-a-jwt-token";
-    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token.getVercelOidcToken)()).rejects.toThrow(
+    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).rejects.toThrow(
       /Invalid token\. Please run `vc env pull` and try again/
     );
   });
   (0, import_vitest.test)("should fail when no token exists and no CLI credentials available", async () => {
     process.env.VERCEL_OIDC_TOKEN = void 0;
-    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token.getVercelOidcToken)()).rejects.toThrow(/Invalid token/);
+    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).rejects.toThrow(/Invalid token/);
   });
   (0, import_vitest.test)("should propagate filesystem errors when saving token fails", async () => {
     fs.writeFileSync(
@@ -177,7 +177,7 @@ import_vitest.vi.mock("./get-context", () => ({
       throw new Error("EACCES: permission denied");
     });
     process.env.VERCEL_OIDC_TOKEN = createExpiredToken();
-    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token.getVercelOidcToken)()).rejects.toThrow(/EACCES|permission/i);
+    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).rejects.toThrow(/EACCES|permission/i);
   });
   (0, import_vitest.test)("should succeed when valid token exists in env", async () => {
     const validToken = createValidToken();
@@ -187,7 +187,7 @@ import_vitest.vi.mock("./get-context", () => ({
       name: "test-name",
       exp: Date.now() / 1e3 + 43200
     });
-    const token = await (0, import_get_vercel_oidc_token.getVercelOidcToken)();
+    const token = await (0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)();
     (0, import_vitest.expect)(token).toBe(validToken);
   });
   (0, import_vitest.test)("should refresh when token is expired but all configs are valid", async () => {
@@ -213,7 +213,7 @@ import_vitest.vi.mock("./get-context", () => ({
       exp: Date.now() / 1e3 + 43200
     });
     process.env.VERCEL_OIDC_TOKEN = createExpiredToken();
-    const token = await (0, import_get_vercel_oidc_token.getVercelOidcToken)();
+    const token = await (0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)();
     (0, import_vitest.expect)(token).toBe(newToken);
   });
   (0, import_vitest.test)("should use provided team and project for refresh instead of reading project.json", async () => {
@@ -237,7 +237,7 @@ import_vitest.vi.mock("./get-context", () => ({
       exp: Date.now() / 1e3 + 43200
     });
     process.env.VERCEL_OIDC_TOKEN = createExpiredToken();
-    const token = await (0, import_get_vercel_oidc_token.getVercelOidcToken)({
+    const token = await (0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)({
       team: customTeamId,
       project: customProjectId
     });
@@ -272,7 +272,7 @@ import_vitest.vi.mock("./get-context", () => ({
       exp: Date.now() / 1e3 + 43200
     });
     process.env.VERCEL_OIDC_TOKEN = createExpiredToken();
-    const token = await (0, import_get_vercel_oidc_token.getVercelOidcToken)({
+    const token = await (0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)({
       project: customProjectId
     });
     (0, import_vitest.expect)(token).toBe(newToken);
@@ -306,7 +306,7 @@ import_vitest.vi.mock("./get-context", () => ({
       exp: Date.now() / 1e3 + 43200
     });
     process.env.VERCEL_OIDC_TOKEN = createExpiredToken();
-    const token = await (0, import_get_vercel_oidc_token.getVercelOidcToken)({
+    const token = await (0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)({
       team: customTeamId
     });
     (0, import_vitest.expect)(token).toBe(newToken);
@@ -327,7 +327,7 @@ import_vitest.vi.mock("./get-context", () => ({
       name: "test-name",
       exp: Date.now() / 1e3 + 43200
     });
-    const token = await (0, import_get_vercel_oidc_token.getVercelOidcToken)({
+    const token = await (0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)({
       team: "custom-team",
       project: "custom-project"
     });

package/dist/index-edge-light.d.ts

@@ -0,0 +1,11 @@
+export { getContext } from './get-context';
+export { AccessTokenMissingError, RefreshAccessTokenFailedError, } from './auth-errors';
+export { getVercelOidcTokenSync } from './get-vercel-oidc-token-sync';
+/**
+ * Gets the current OIDC token in Edge Runtime.
+ *
+ * Edge Runtime does not support automatic token refresh, so this returns the
+ * request-scoped token without checking expiration.
+ */
+export declare function getVercelOidcToken(): Promise<string>;
+export declare function getVercelToken(): Promise<string>;

package/dist/index-edge-light.js

@@ -0,0 +1,47 @@
+"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 index_edge_light_exports = {};
+__export(index_edge_light_exports, {
+  AccessTokenMissingError: () => import_auth_errors.AccessTokenMissingError,
+  RefreshAccessTokenFailedError: () => import_auth_errors.RefreshAccessTokenFailedError,
+  getContext: () => import_get_context.getContext,
+  getVercelOidcToken: () => getVercelOidcToken,
+  getVercelOidcTokenSync: () => import_get_vercel_oidc_token_sync2.getVercelOidcTokenSync,
+  getVercelToken: () => getVercelToken
+});
+module.exports = __toCommonJS(index_edge_light_exports);
+var import_get_vercel_oidc_token_sync = require("./get-vercel-oidc-token-sync");
+var import_get_context = require("./get-context");
+var import_auth_errors = require("./auth-errors");
+var import_get_vercel_oidc_token_sync2 = require("./get-vercel-oidc-token-sync");
+async function getVercelOidcToken() {
+  return (0, import_get_vercel_oidc_token_sync.getVercelOidcTokenSync)();
+}
+async function getVercelToken() {
+  throw new Error("getVercelToken is not supported in Edge Runtime");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AccessTokenMissingError,
+  RefreshAccessTokenFailedError,
+  getContext,
+  getVercelOidcToken,
+  getVercelOidcTokenSync,
+  getVercelToken
+});

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-export { getVercelOidcToken, getVercelOidcTokenSync, } from './get-vercel-oidc-token';
+export { getVercelOidcToken } from './get-vercel-oidc-token-with-refresh';
+export { getVercelOidcTokenSync } from './get-vercel-oidc-token-sync';
 export { getContext } from './get-context';
 export { AccessTokenMissingError, RefreshAccessTokenFailedError, } from './auth-errors';
 export { getVercelToken } from './token-util';

package/dist/index.js

@@ -21,12 +21,13 @@ __export(src_exports, {
   AccessTokenMissingError: () => import_auth_errors.AccessTokenMissingError,
   RefreshAccessTokenFailedError: () => import_auth_errors.RefreshAccessTokenFailedError,
   getContext: () => import_get_context.getContext,
-  getVercelOidcToken: () => import_get_vercel_oidc_token.getVercelOidcToken,
-  getVercelOidcTokenSync: () => import_get_vercel_oidc_token.getVercelOidcTokenSync,
+  getVercelOidcToken: () => import_get_vercel_oidc_token_with_refresh.getVercelOidcToken,
+  getVercelOidcTokenSync: () => import_get_vercel_oidc_token_sync.getVercelOidcTokenSync,
   getVercelToken: () => import_token_util.getVercelToken
 });
 module.exports = __toCommonJS(src_exports);
-var import_get_vercel_oidc_token = require("./get-vercel-oidc-token");
+var import_get_vercel_oidc_token_with_refresh = require("./get-vercel-oidc-token-with-refresh");
+var import_get_vercel_oidc_token_sync = require("./get-vercel-oidc-token-sync");
 var import_get_context = require("./get-context");
 var import_auth_errors = require("./auth-errors");
 var import_token_util = require("./token-util");

package/docs/functions/getVercelOidcToken.md

@@ -6,7 +6,7 @@
 
 > **getVercelOidcToken**(`options?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>
 
-Defined in: [packages/oidc/src/get-vercel-oidc-token.ts:64](https://github.com/vercel/vercel/blob/main/packages/oidc/src/get-vercel-oidc-token.ts#L64)
+Defined in: [packages/oidc/src/get-vercel-oidc-token-with-refresh.ts:64](https://github.com/vercel/vercel/blob/main/packages/oidc/src/get-vercel-oidc-token-with-refresh.ts#L64)
 
 Gets the current OIDC token from the request context or the environment variable.
 

package/docs/functions/getVercelOidcTokenSync.md

@@ -6,7 +6,7 @@
 
 > **getVercelOidcTokenSync**(): `string`
 
-Defined in: [packages/oidc/src/get-vercel-oidc-token.ts:124](https://github.com/vercel/vercel/blob/main/packages/oidc/src/get-vercel-oidc-token.ts#L124)
+Defined in: [packages/oidc/src/get-vercel-oidc-token-sync.ts:24](https://github.com/vercel/vercel/blob/main/packages/oidc/src/get-vercel-oidc-token-sync.ts#L24)
 
 Gets the current OIDC token from the request context or the environment variable.
 

package/package.json

@@ -10,6 +10,7 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "edge-light": "./dist/index-edge-light.js",
       "browser": "./dist/index-browser.js",
       "react-native": "./dist/index-browser.js",
       "workflow": "./dist/index-browser.js",
@@ -17,7 +18,7 @@
       "require": "./dist/index.js"
     }
   },
-  "version": "3.4.1",
+  "version": "3.5.0",
   "repository": {
     "directory": "packages/oidc",
     "type": "git",