@vercel/client 18.3.3 → 18.3.5

package/README.md

@@ -41,6 +41,28 @@ async function deploy() {
 }
 ```
 
+The optional second argument accepts deployment options, either as an object or
+as a `Promise<DeploymentOptions>`. Use a promise to resolve metadata concurrently
+with local file collection:
+
+```js
+const options = readDeploymentMetadata().then(gitMetadata => ({ gitMetadata }));
+
+for await (const event of createDeployment(
+  { token: process.env.TOKEN, path: '/path/to/project' },
+  options
+)) {
+  // Handle deployment progress.
+}
+```
+
+Start consuming the iterator immediately after creating the promise: the async
+generator begins running on its first iteration. File collection and the
+`hashes-calculated` event can finish before the options resolve, but uploads and
+deployment creation wait for them. If the options reject, iteration throws before
+uploading or creating the deployment. If local file collection fails first, that
+error is reported and a later options rejection is handled internally.
+
 Full list of events:
 
 ```js

package/dist/collect-deployment-files.d.ts

@@ -8,6 +8,7 @@ export interface CollectedDeploymentFiles {
     workPath: string;
     isDirectory: boolean;
     ignoreList: string[];
+    warning?: string;
 }
 export declare function assertDeploymentPath(path: VercelClientOptions['path'] | undefined, debug: Debug): asserts path is VercelClientOptions['path'];
 export declare function collectDeploymentFiles(path: VercelClientOptions['path'] | undefined, clientOptions: CollectDeploymentFilesOptions, debug: Debug): Promise<CollectedDeploymentFiles>;

package/dist/collect-deployment-files.js

@@ -66,7 +66,7 @@ async function collectDeploymentFiles(path, clientOptions, debug) {
   } else {
     debug(`Provided 'path' is a single file`);
   }
-  const { fileList, ignoreList } = await (0, import_utils.buildFileTree)(
+  const { fileList, ignoreList, warning } = await (0, import_utils.buildFileTree)(
     path,
     clientOptions,
     debug
@@ -86,7 +86,7 @@ ${err.message}`;
     }
     throw err;
   }
-  return { fileList, filesMap, workPath, isDirectory, ignoreList };
+  return { fileList, filesMap, workPath, isDirectory, ignoreList, warning };
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/continue.d.ts

@@ -18,4 +18,5 @@ export declare function continueDeployment(options: {
 }): AsyncIterableIterator<{
     type: DeploymentEventType;
     payload: any;
+    code?: string;
 }>;

package/dist/continue.js

@@ -53,11 +53,19 @@ async function* continueDeployment(options) {
       })
     };
   }
-  const { fileList } = await (0, import_utils.buildFileTree)(
+  const { fileList, warning } = await (0, import_utils.buildFileTree)(
     options.path,
     { isDirectory: true, prebuilt: true, vercelOutputDir: outputDir },
     debug
   );
+  if (warning) {
+    debug("Yielding a prebuilt filePathMap ignore warning");
+    yield {
+      type: "warning",
+      payload: warning,
+      code: "PREBUILT_FILEPATHMAP_IGNORED"
+    };
+  }
   const provisionJsonPath = (0, import_path.join)(outputDir, "provision.json");
   const unbundledFiles = fileList.filter((f) => f === provisionJsonPath);
   let files;

package/dist/create-deployment.d.ts

@@ -1,5 +1,6 @@
 import { VercelClientOptions, DeploymentOptions, DeploymentEventType } from './types';
-export default function buildCreateDeployment(): (clientOptions: VercelClientOptions, deploymentOptions?: DeploymentOptions) => AsyncIterableIterator<{
+export default function buildCreateDeployment(): (clientOptions: VercelClientOptions, deploymentOptions?: DeploymentOptions | Promise<DeploymentOptions>) => AsyncIterableIterator<{
     type: DeploymentEventType;
     payload: any;
+    code?: string;
 }>;

package/dist/create-deployment.js

@@ -29,6 +29,9 @@ var import_errors = require("./errors");
 var import_collect_deployment_files = require("./collect-deployment-files");
 function buildCreateDeployment() {
   return async function* createDeployment(clientOptions, deploymentOptions = {}) {
+    const options = Promise.resolve(deploymentOptions);
+    void options.catch(() => {
+    });
     const { path } = clientOptions;
     const debug = (0, import_utils.createDebug)(clientOptions.debug);
     debug("Creating deployment...");
@@ -50,19 +53,28 @@ function buildCreateDeployment() {
           message: "The `manual` option requires `prebuilt` to be true"
         });
       }
-      deploymentOptions.build = deploymentOptions.build || {};
-      deploymentOptions.build.env = deploymentOptions.build.env || {};
-      deploymentOptions.build.env.VERCEL_MANUAL_PROVISIONING = "1";
-      deploymentOptions.version = 2;
+      const deploymentOptions2 = await options;
+      deploymentOptions2.build = deploymentOptions2.build || {};
+      deploymentOptions2.build.env = deploymentOptions2.build.env || {};
+      deploymentOptions2.build.env.VERCEL_MANUAL_PROVISIONING = "1";
+      deploymentOptions2.version = 2;
       debug("Creating deployment with manual provisioning...");
-      yield* (0, import_deploy.deploy)(/* @__PURE__ */ new Map(), clientOptions, deploymentOptions);
+      yield* (0, import_deploy.deploy)(/* @__PURE__ */ new Map(), clientOptions, deploymentOptions2);
       return;
     }
-    const { fileList, filesMap: files } = await (0, import_collect_deployment_files.collectDeploymentFiles)(
-      path,
-      clientOptions,
-      debug
-    );
+    const {
+      fileList,
+      filesMap: files,
+      warning
+    } = await (0, import_collect_deployment_files.collectDeploymentFiles)(path, clientOptions, debug);
+    if (warning) {
+      debug("Yielding a prebuilt filePathMap ignore warning");
+      yield {
+        type: "warning",
+        payload: warning,
+        code: "PREBUILT_FILEPATHMAP_IGNORED"
+      };
+    }
     if (fileList.length === 0) {
       debug("Deployment path has no files. Yielding a warning event");
       yield {
@@ -78,10 +90,11 @@ function buildCreateDeployment() {
     if (clientOptions.userAgent) {
       debug(`Using provided user agent: ${clientOptions.userAgent}`);
     }
+    const resolvedOptions = await options;
     debug(`Setting platform version to harcoded value 2`);
-    deploymentOptions.version = 2;
+    resolvedOptions.version = 2;
     debug(`Creating the deployment and starting upload...`);
-    for await (const event of (0, import_upload.upload)(files, clientOptions, deploymentOptions)) {
+    for await (const event of (0, import_upload.upload)(files, clientOptions, resolvedOptions)) {
       debug(`Yielding a '${event.type}' event`);
       yield event;
     }

package/dist/index.d.ts

@@ -2,9 +2,10 @@ export { continueDeployment } from './continue';
 export { checkDeploymentStatus } from './check-deployment-status';
 export { inspectDeploymentFiles } from './inspect-deployment-files';
 export { getVercelIgnore, buildFileTree } from './utils/index';
-export declare const createDeployment: (clientOptions: import("./types").VercelClientOptions, deploymentOptions?: import("./types").DeploymentOptions) => AsyncIterableIterator<{
+export declare const createDeployment: (clientOptions: import("./types").VercelClientOptions, deploymentOptions?: import("./types").DeploymentOptions | Promise<import("./types").DeploymentOptions>) => AsyncIterableIterator<{
     type: import("./types").DeploymentEventType;
     payload: any;
+    code?: string;
 }>;
 export * from './errors';
 export * from './types';

package/dist/inspect-deployment-files.d.ts

@@ -12,5 +12,6 @@ export interface DeploymentFileSummary {
     ignoredCount: number;
     files: DeploymentFileItem[];
     ignored: string[];
+    warning?: string;
 }
 export declare function inspectDeploymentFiles(clientOptions: Pick<VercelClientOptions, 'archive' | 'bulkRedirectsPath' | 'debug' | 'path' | 'prebuilt' | 'projectName' | 'rootDirectory' | 'vercelOutputDir'>): Promise<DeploymentFileSummary>;

package/dist/inspect-deployment-files.js

@@ -27,7 +27,7 @@ var import_utils = require("./utils");
 async function inspectDeploymentFiles(clientOptions) {
   const { path } = clientOptions;
   const debug = (0, import_utils.createDebug)(clientOptions.debug);
-  const { filesMap, workPath, isDirectory, ignoreList } = await (0, import_collect_deployment_files.collectDeploymentFiles)(path, { ...clientOptions }, debug);
+  const { filesMap, workPath, isDirectory, ignoreList, warning } = await (0, import_collect_deployment_files.collectDeploymentFiles)(path, { ...clientOptions }, debug);
   const files = [];
   let totalSize = 0;
   for (const [sha, file] of filesMap) {
@@ -54,7 +54,8 @@ async function inspectDeploymentFiles(clientOptions) {
     totalSize,
     ignoredCount: ignoreList.length,
     files,
-    ignored: ignoreList.sort()
+    ignored: ignoreList.sort(),
+    warning
   };
 }
 // Annotate the CommonJS export names for ESM import in node:

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 import type { Builder, BuilderFunctions, Images, ProjectSettings, Cron, Schedule, ExperimentalServices, ExperimentalServiceGroups, ExperimentalServicesV2, Services } from '@vercel/build-utils';
 import type { Header, Route, Redirect, Rewrite } from '@vercel/routing-utils';
-export { DeploymentEventType } from './utils';
+export type { DeploymentEventType } from './utils';
 /**
  * Minimal interface of an undici `Dispatcher` (e.g. `undici.ProxyAgent`),
  * passed to `fetch` as the non-standard `dispatcher` init option to customize

package/dist/types.js

@@ -18,17 +18,14 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var types_exports = {};
 __export(types_exports, {
-  DeploymentEventType: () => import_utils.DeploymentEventType,
   VALID_ARCHIVE_FORMATS: () => VALID_ARCHIVE_FORMATS,
   fileNameSymbol: () => fileNameSymbol
 });
 module.exports = __toCommonJS(types_exports);
-var import_utils = require("./utils");
 const VALID_ARCHIVE_FORMATS = ["tgz"];
 const fileNameSymbol = Symbol("fileName");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  DeploymentEventType,
   VALID_ARCHIVE_FORMATS,
   fileNameSymbol
 });

package/dist/utils/index.d.ts

@@ -12,6 +12,7 @@ export declare function parseVercelConfig(filePath?: string): Promise<VercelConf
 export declare function buildFileTree(path: string | string[], { isDirectory, prebuilt, vercelOutputDir, rootDirectory, projectName, bulkRedirectsPath, }: Pick<VercelClientOptions, 'isDirectory' | 'prebuilt' | 'vercelOutputDir' | 'rootDirectory' | 'projectName' | 'bulkRedirectsPath'>, debug: Debug): Promise<{
     fileList: string[];
     ignoreList: string[];
+    warning?: string;
 }>;
 export declare function getVercelIgnore(cwd: string | string[], prebuilt?: boolean, vercelOutputDir?: string): Promise<{
     ig: Ignore;

package/dist/utils/index.js

@@ -49,7 +49,6 @@ var import_build_utils = require("@vercel/build-utils");
 var import_async_sema = require("async-sema");
 var import_fs_extra = require("fs-extra");
 var import_readdir_recursive = __toESM(require("./readdir-recursive"));
-var import_utils = require("@vercel/microfrontends/microfrontends/utils");
 const semaphore = new import_async_sema.Sema(10);
 const API_FILES = "/v2/files";
 const EVENTS_ARRAY = [
@@ -118,7 +117,10 @@ async function getUserIgnore(cwd) {
   if (!ignoreFile) {
     return null;
   }
-  return (0, import_ignore.default)().add(clearRelative(ignoreFile));
+  return {
+    ig: (0, import_ignore.default)().add(clearRelative(ignoreFile)),
+    ignoreFileName: vercelignore ? ".vercelignore" : ".nowignore"
+  };
 }
 const FILEPATHMAP_VERCELIGNORE_EXCEPTIONS = [
   "node_modules",
@@ -136,6 +138,24 @@ const filePathMapVercelignoreExceptions = (0, import_ignore.default)().add(
 function isFilePathMapIgnoreException(posixRel) {
   return filePathMapVercelignoreExceptions.ignores(posixRel);
 }
+const FILEPATHMAP_IGNORE_ERROR_LIST_LIMIT = 20;
+function formatFilePathMapIgnoreWarning(entries, ignoreFileName, truncated = false) {
+  const shown = entries.slice(0, FILEPATHMAP_IGNORE_ERROR_LIST_LIMIT);
+  const lines = shown.map((path) => `  ${path}`);
+  if (truncated) {
+    lines.push("  \u2026and more");
+  }
+  const count = truncated ? `at least ${shown.length}` : String(entries.length);
+  const fileWord = !truncated && entries.length === 1 ? "file" : "files";
+  const ignoreFileLabel = ignoreFileName === ".nowignore" ? `\`${ignoreFileName}\` (deprecated)` : `\`${ignoreFileName}\``;
+  return [
+    `${ignoreFileLabel} excludes ${count} ${fileWord} the prebuilt functions need. An upcoming CLI release will fail this deploy instead of uploading without them.`,
+    "",
+    ...lines,
+    "",
+    `Remove the colliding rules from \`${ignoreFileName}\`, or exclude those paths from tracing with \`outputFileTracingExcludes\`.`
+  ].join("\n");
+}
 async function buildFileTree(path, {
   isDirectory,
   prebuilt,
@@ -146,6 +166,7 @@ async function buildFileTree(path, {
 }, debug) {
   const ignoreList = [];
   let fileList;
+  let warning;
   let { ig, ignores } = await getVercelIgnore(path, prebuilt, vercelOutputDir);
   debug(`Found ${ignores.length} rules in .vercelignore`);
   debug("Building file tree...");
@@ -165,45 +186,68 @@ async function buildFileTree(path, {
         (file) => (0, import_path.basename)(file) === ".vc-config.json"
       );
       const userIg = await getUserIgnore(path);
-      await Promise.all(
+      const ignoredFilePathMap = /* @__PURE__ */ new Set();
+      let ignoredFilePathMapTruncated = false;
+      const vcConfigs = await Promise.all(
         vcConfigFilePaths.map(async (p) => {
           const configJson = await (0, import_fs_extra.readFile)(p, "utf8");
-          const config = JSON.parse(configJson);
-          if (!config.filePathMap)
-            return;
-          for (const v of Object.values(config.filePathMap)) {
-            const absPath = (0, import_path.join)(path, v);
-            const rel = (0, import_path.relative)(path, absPath);
-            const posixRel = rel.split(import_path.sep).join("/");
-            if (rel.startsWith("..") || (0, import_path.isAbsolute)(rel)) {
+          return JSON.parse(configJson);
+        })
+      );
+      for (const config of vcConfigs) {
+        if (!config.filePathMap)
+          continue;
+        for (const v of Object.values(config.filePathMap)) {
+          const absPath = (0, import_path.join)(path, v);
+          const rel = (0, import_path.relative)(path, absPath);
+          const posixRel = rel.split(import_path.sep).join("/");
+          if (rel.startsWith("..") || (0, import_path.isAbsolute)(rel)) {
+            debug(
+              `Ignoring "filePathMap" entry "${v}": resolves outside the deployment root`
+            );
+            continue;
+          }
+          if (userIg && userIg.ig.ignores(posixRel)) {
+            if (isFilePathMapIgnoreException(posixRel)) {
               debug(
-                `Ignoring "filePathMap" entry "${v}": resolves outside the deployment root`
+                `Keeping "filePathMap" entry "${v}": matches a default-ignored dependency/output path`
               );
+            } else if (ignoredFilePathMap.has(posixRel)) {
+              continue;
+            } else if (fileList.includes(absPath)) {
+              debug(
+                `Skipping "filePathMap" entry "${v}": already in the upload set`
+              );
+              continue;
+            } else if (ignoredFilePathMap.size >= FILEPATHMAP_IGNORE_ERROR_LIST_LIMIT) {
+              ignoredFilePathMapTruncated = true;
+              continue;
+            } else {
+              ignoredFilePathMap.add(posixRel);
               continue;
             }
-            if (userIg && userIg.ignores(posixRel)) {
-              if (isFilePathMapIgnoreException(posixRel)) {
-                debug(
-                  `Keeping "filePathMap" entry "${v}": matches a default-ignored dependency/output path`
-                );
-              } else {
-                debug(
-                  `Ignoring "filePathMap" entry "${v}": matched by a rule in .vercelignore/.nowignore`
-                );
-                continue;
-              }
-            }
-            refs.add(absPath);
           }
-        })
-      );
+          refs.add(absPath);
+        }
+      }
+      if (ignoredFilePathMap.size > 0) {
+        warning = formatFilePathMapIgnoreWarning(
+          [...ignoredFilePathMap].sort((a, b) => a.localeCompare(b)),
+          userIg?.ignoreFileName || ".vercelignore",
+          ignoredFilePathMapTruncated
+        );
+      }
       try {
-        let microfrontendConfigPath = (0, import_utils.findConfig)({
+        const {
+          findConfig: findMicrofrontendsConfig,
+          inferMicrofrontendsLocation
+        } = await import("@vercel/microfrontends/microfrontends/utils");
+        let microfrontendConfigPath = findMicrofrontendsConfig({
           dir: (0, import_path.join)(path, rootDirectory || "")
         });
         if (!microfrontendConfigPath && !rootDirectory && projectName) {
-          microfrontendConfigPath = (0, import_utils.findConfig)({
-            dir: (0, import_utils.inferMicrofrontendsLocation)({
+          microfrontendConfigPath = findMicrofrontendsConfig({
+            dir: inferMicrofrontendsLocation({
               repositoryRoot: path,
               applicationName: projectName
             })
@@ -275,7 +319,7 @@ async function buildFileTree(path, {
     fileList = [path];
     debug(`Deploying the provided path as single file`);
   }
-  return { fileList, ignoreList };
+  return { fileList, ignoreList, warning };
 }
 async function getVercelIgnore(cwd, prebuilt, vercelOutputDir) {
   const ig = (0, import_ignore.default)();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/client",
-  "version": "18.3.3",
+  "version": "18.3.5",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "homepage": "https://vercel.com",
@@ -37,9 +37,9 @@
     "querystring": "^0.2.0",
     "sleep-promise": "8.0.1",
     "tar-fs": "1.16.3",
-    "@vercel/routing-utils": "6.5.0",
+    "@vercel/build-utils": "14.9.3",
     "@vercel/error-utils": "2.2.1",
-    "@vercel/build-utils": "14.9.2"
+    "@vercel/routing-utils": "6.5.0"
   },
   "scripts": {
     "build": "node ../../utils/build.mjs",