@automattic/vip 3.0.0 → 3.1.0

package/dist/bin/vip-import-media.js

@@ -13,6 +13,7 @@ var _tracker = require("../lib/tracker");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 // eslint-disable-next-line no-duplicate-imports
 
+const API_VERSION = 'v2';
 const appQuery = `
 	id,
 	name,
@@ -116,7 +117,8 @@ Importing Media into your App...
           environmentId: env.id,
           archiveUrl: url,
           overwriteExistingFiles,
-          importIntermediateImages
+          importIntermediateImages,
+          apiVersion: API_VERSION
         }
       }
     });

package/dist/lib/media-import/status.js

@@ -5,6 +5,7 @@ exports.default = void 0;
 exports.getGlyphForStatus = getGlyphForStatus;
 exports.mediaImportCheckStatus = mediaImportCheckStatus;
 var _chalk = _interopRequireDefault(require("chalk"));
+var _enquirer = require("enquirer");
 var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
 var _promises = require("node:fs/promises");
 var _nodePath = require("node:path");
@@ -36,6 +37,7 @@ const IMPORT_MEDIA_PROGRESS_QUERY = (0, _graphqlTag.default)`
 							fileName
 							errors
 						}
+						fileErrorsUrl
 					}
 				}
 			}
@@ -216,25 +218,83 @@ ${maybeExitPrompt}
     // Kick off the check
     void checkStatus(IMPORT_MEDIA_PROGRESS_POLL_INTERVAL);
   });
+  async function exportFailureDetails(fileErrors) {
+    const formattedData = buildFileErrors(fileErrors, exportFileErrorsToJson);
+    const errorsFile = `media-import-${app.name ?? ''}-${Date.now()}${exportFileErrorsToJson ? '.json' : '.txt'}`;
+    try {
+      await (0, _promises.writeFile)(errorsFile, formattedData);
+      progressTracker.suffix += `${_chalk.default.yellow(`⚠️  All errors have been exported to ${_chalk.default.bold((0, _nodePath.resolve)(errorsFile))}\n`)}`;
+    } catch (writeFileErr) {
+      progressTracker.suffix += `${_chalk.default.red(`Could not export errors to file\n${writeFileErr.message}`)}`;
+    }
+  }
+  async function fetchFailureDetails(fileErrorsUrl) {
+    progressTracker.suffix += `
+=============================================================
+Downloading errors details from ${fileErrorsUrl}
+\n`;
+    progressTracker.print({
+      clearAfter: true
+    });
+    try {
+      const response = await fetch(fileErrorsUrl);
+      return await response.json();
+    } catch (err) {
+      progressTracker.suffix += `${_chalk.default.red(`Could not download import errors report\n${err.message}`)}`;
+      throw err;
+    }
+  }
+  async function promptFailureDetailsDownload(fileErrorsUrl) {
+    const failureDetails = await (0, _enquirer.prompt)({
+      type: 'confirm',
+      name: 'download',
+      message: 'Download import errors report now? (Report will be downloadable for up to 7 days from the completion of the import)'
+    });
+    if (!failureDetails.download) {
+      progressTracker.suffix += `${_chalk.default.yellow(`⚠️  An error report file has been generated for this media import. Access it within the next 15 minutes by clicking on the URL below.`)}`;
+      progressTracker.suffix += `\n${_chalk.default.yellow(`Or, generate a new URL by running the ${_chalk.default.bgYellow('vip import media status')} command.`)} `;
+      progressTracker.suffix += `\n${_chalk.default.yellow('The report will be downloadable for up to 7 days after the completion of the import or until a new media import is performed.')}`;
+      progressTracker.suffix += `\n\n${_chalk.default.underline(fileErrorsUrl)}\n`;
+      progressTracker.print({
+        clearAfter: true
+      });
+      return;
+    }
+    const failureDetailsErrors = await fetchFailureDetails(fileErrorsUrl);
+    await exportFailureDetails(failureDetailsErrors);
+  }
+  function printFileErrorsReportLinkExpiredError(results) {
+    if (results.filesTotal && results.filesProcessed && results.filesTotal !== results.filesProcessed) {
+      const errorsFound = results.filesTotal - results.filesProcessed;
+      progressTracker.suffix += `${_chalk.default.yellow(`⚠️  ${errorsFound} error(s) were found. File import errors report link expired.`)}`;
+    }
+  }
+  async function printFailureDetails(fileErrors, results) {
+    progressTracker.suffix += `${_chalk.default.yellow(`⚠️  ${fileErrors.length} file import error(s) were found`)}`;
+    if ((results.filesTotal ?? 0) - (results.filesProcessed ?? 0) !== fileErrors.length) {
+      progressTracker.suffix += `. ${_chalk.default.italic.yellow('File import errors report size threshold reached.')}`;
+    }
+    await exportFailureDetails(fileErrors);
+  }
   try {
     const results = await getResults();
     overallStatus = results.status ?? 'unknown';
     progressTracker.stopPrinting();
     setProgressTrackerSuffix();
     progressTracker.print();
-    const fileErrors = results.failureDetails?.fileErrors ?? [];
-    if (fileErrors.length > 0) {
-      progressTracker.suffix += `${_chalk.default.yellow(`⚠️  ${fileErrors.length} file error(s) have been extracted`)}`;
-      if ((results.filesTotal ?? 0) - (results.filesProcessed ?? 0) !== fileErrors.length) {
-        progressTracker.suffix += `. ${_chalk.default.italic.yellow('File-errors report size threshold reached.')}`;
-      }
-      const formattedData = buildFileErrors(fileErrors, exportFileErrorsToJson);
-      const errorsFile = `media-import-${app.name ?? ''}-${Date.now()}${exportFileErrorsToJson ? '.json' : '.txt'}`;
-      try {
-        await (0, _promises.writeFile)(errorsFile, formattedData);
-        progressTracker.suffix += `\n\n${_chalk.default.yellow(`All errors have been exported to ${_chalk.default.bold((0, _nodePath.resolve)(errorsFile))}`)}\n\n`;
-      } catch (writeFileErr) {
-        progressTracker.suffix += `\n\n${_chalk.default.red(`Could not export errors to file\n${writeFileErr.message}`)}\n\n`;
+    if (results.failureDetails?.fileErrorsUrl) {
+      await promptFailureDetailsDownload(results.failureDetails.fileErrorsUrl);
+    } else {
+      const fileErrors = results.failureDetails?.fileErrors ?? [];
+      if (fileErrors.length > 0) {
+        // Errors were observed and are present in the dto
+        // Fall back to exporting errors to local file
+        await printFailureDetails(fileErrors, results);
+      } else if ('ABORTED' !== overallStatus) {
+        // Errors are not present in the dto
+        // And file error details report link is not available
+        // do not print this message if the import was aborted
+        printFileErrorsReportLinkExpiredError(results);
       }
     }
 

package/docs/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## Changelog
 
+### 3.0.0
+
+* fix(dev-env): demo code is displayed as `[demo-image]`
+* build(deps-dev): bump @types/node from 18.19.33 to 18.19.34
+* build(deps): bump debug from 4.3.4 to 4.3.5
+* ci: remove duplicate check
+* Update the dev-env commands to follow the VIP-CLI style guide
+* build(deps-dev): bump the babel group with 4 updates
+* ci: add publish prerelease workflow
+* build(deps): bump step-security/harden-runner from 2.7.1 to 2.8.0
+* build(deps): bump ini from 4.1.2 to 4.1.3
+* Integrate media import v2 flow and expand on media import error report messaging
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/2.39.7...3.0.0
+
 ### 2.39.7
 
 * Fix promptForBoolean to display the default initial value capitalized

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@automattic/vip",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@automattic/vip",
-      "version": "3.0.0",
+      "version": "3.1.0",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "The VIP Javascript library & CLI",
   "main": "index.js",
   "bin": {