@vercel/sandbox 1.1.4 → 1.1.5

package/src/utils/get-credentials.ts

@@ -1,6 +1,10 @@
 import { getVercelOidcToken } from "@vercel/oidc";
 import { decodeBase64Url } from "./decode-base64-url";
 import { z } from "zod";
+import {
+  cachedGenerateCredentials,
+  shouldPromptForCredentials,
+} from "./dev-credentials";
 
 export interface Credentials {
   /**
@@ -18,6 +22,57 @@ export interface Credentials {
   teamId: string;
 }
 
+/**
+ * Error thrown when OIDC context is not available in local development,
+ * therefore we should guide how to ensure it is set up by linking a project
+ */
+export class LocalOidcContextError extends Error {
+  name = "LocalOidcContextError";
+  constructor(cause: unknown) {
+    const message = [
+      "Could not get credentials from OIDC context.",
+      "Please link your Vercel project using `npx vercel link`.",
+      "Then, pull an initial OIDC token with `npx vercel env pull`",
+      "and retry.",
+    ].join("\n");
+    super(message, { cause });
+  }
+}
+
+/**
+ * Error thrown when OIDC context is not available in Vercel environment,
+ * therefore we should guide how to set it up.
+ */
+export class VercelOidcContextError extends Error {
+  name = "VercelOidcContextError";
+  constructor(cause: unknown) {
+    const message = [
+      "Could not get credentials from OIDC context.",
+      "Please make sure OIDC is set up for your project",
+      "Read more at https://vercel.com/docs/oidc",
+    ].join("\n");
+    super(message, { cause });
+  }
+}
+
+async function getVercelToken(opts: {
+  teamId?: string;
+  projectId?: string;
+}): Promise<Credentials> {
+  try {
+    return getCredentialsFromOIDCToken(await getVercelOidcToken());
+  } catch (error) {
+    if (!shouldPromptForCredentials()) {
+      if (process.env.VERCEL_URL) {
+        throw new VercelOidcContextError(error);
+      } else {
+        throw new LocalOidcContextError(error);
+      }
+    }
+    return await cachedGenerateCredentials(opts);
+  }
+}
+
 /**
  * Allow to get credentials to access the Vercel API. Credentials can be
  * provided in two different ways:
@@ -34,15 +89,24 @@ export async function getCredentials(params?: unknown): Promise<Credentials> {
     return credentials;
   }
 
-  const oidcToken = await getVercelOidcToken();
-  if (oidcToken) {
-    return getCredentialsFromOIDCToken(oidcToken);
-  }
+  const oidcToken = await getVercelToken({
+    teamId:
+      params &&
+      typeof params === "object" &&
+      "teamId" in params &&
+      typeof params.teamId === "string"
+        ? params.teamId
+        : undefined,
+    projectId:
+      params &&
+      typeof params === "object" &&
+      "projectId" in params &&
+      typeof params.projectId === "string"
+        ? params.projectId
+        : undefined,
+  });
 
-  throw new Error(
-    "You must provide credentials to access the Vercel API \n" +
-      "either through parameters or using OpenID Connect [https://vercel.com/docs/oidc]",
-  );
+  return oidcToken;
 }
 
 /**

package/src/utils/log.ts

@@ -0,0 +1,20 @@
+import pico from "picocolors";
+const colors = {
+  warn: pico.yellow,
+  error: pico.red,
+  success: pico.green,
+  info: pico.blue,
+};
+const logPrefix = pico.dim("[vercel/sandbox]");
+export function write(
+  level: "warn" | "error" | "info" | "success",
+  text: string | string[],
+) {
+  text = Array.isArray(text) ? text.join("\n") : text;
+  const prefixed = text.replace(/^/gm, `${logPrefix} `);
+  console.error(colors[level](prefixed));
+}
+
+export function code(text: string) {
+  return pico.italic(pico.dim("`") + text + pico.dim("`"));
+}

package/src/version.ts

@@ -1,2 +1,2 @@
 // Autogenerated by inject-version.ts
-export const VERSION = "1.1.4";
+export const VERSION = "1.1.5";

package/test-utils/mock-response.ts

@@ -0,0 +1,12 @@
+export function createNdjsonStream(
+  lines: object[],
+): ReadableStream<Uint8Array> {
+  const encoder = new TextEncoder();
+  const ndjson = lines.map((line) => JSON.stringify(line)).join("\n") + "\n";
+  return new ReadableStream({
+    start(controller) {
+      controller.enqueue(encoder.encode(ndjson));
+      controller.close();
+    },
+  });
+}

package/vitest.config.ts

@@ -2,6 +2,7 @@ import { defineConfig } from "vitest/config";
 
 export default defineConfig({
   test: {
+    env: { FORCE_COLOR: "1" },
     setupFiles: ["./vitest.setup.ts"],
     testTimeout: 60_000,
   },