@automattic/vip 3.20.3 → 3.21.0

package/dist/bin/vip-dev-env-sync-sql.js

@@ -20,11 +20,11 @@ const examples = [{
   usage: `vip @example-app.develop dev-env sync sql --slug=example-site --table=wp_posts,wp_comments`,
   description: 'Sync only the wp_posts and wp_comments tables using comma-separated syntax from the database of the develop environment in the "example-app" application to a local environment named "example-site".'
 }, {
-  usage: `vip @example-app.develop dev-env sync sql --slug=example-site --subsite-id=2 --subsite-id=3`,
-  description: 'Sync only the tables for the subsites with IDs 2 and 3 from the database of the develop environment in the "example-app" application to a local environment named "example-site".'
+  usage: `vip @example-app.develop dev-env sync sql --slug=example-site --site-id=2 --site-id=3`,
+  description: 'Sync only the tables for the network sites with IDs 2 and 3 from the database of the develop environment in the "example-app" application to a local environment named "example-site".'
 }, {
-  usage: `vip @example-app.develop dev-env sync sql --slug=example-site --subsite-id=2,3`,
-  description: 'Sync only the tables for the subsites with IDs 2 and 3 using comma-separated syntax from the database of the develop environment in the "example-app" application to a local environment named "example-site".'
+  usage: `vip @example-app.develop dev-env sync sql --slug=example-site --site-id=2,3`,
+  description: 'Sync only the tables for the network sites with IDs 2 and 3 using comma-separated syntax from the database of the develop environment in the "example-app" application to a local environment named "example-site".'
 }, {
   usage: `vip @example-app.develop dev-env sync sql --slug=example-site --config-file=~/dev-env-sync-config.json`,
   description: 'Use the specified config file to determine what to sync from the database of the develop environment in the "example-app" application to a local environment named "example-site".'
@@ -58,17 +58,17 @@ const appQuery = `
   requiredArgs: 0,
   module: 'dev-env-sync-sql',
   usage
-}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).option('table', 'A table to sync from the remote environment to the local environment. Multiple tables can be specified with multiple --table flags or as a comma-separated list.').option('subsite-id', 'The ID of a subsite/network site to sync from the remote environment to the local environment. Multiple subsite IDs can be specified with multiple --subsite-id flags or as a comma-separated list.').option('wpcli-command', 'The WP-CLI command to run on the remote environment to retrieve the database export configuration.').option('config-file', 'The backup copy config file to use for the sync.', undefined).option('force', 'Skip validations.', undefined, _devEnvironmentCli.processBooleanOption).examples(examples).argv(process.argv, async (arg, opt) => {
+}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).option('table', 'A table to sync from the remote environment to the local environment. Multiple tables can be specified with multiple --table flags or as a comma-separated list.').option('site-id', 'The ID of a network site to sync from the remote environment to the local environment. Multiple site IDs can be specified with multiple --site-id flags or as a comma-separated list.').option('wpcli-command', 'The WP-CLI command to run on the remote environment to retrieve the database export configuration.').option('config-file', 'The backup copy config file to use for the sync.', undefined).option('force', 'Skip validations.', undefined, _devEnvironmentCli.processBooleanOption).examples(examples).argv(process.argv, async (arg, opt) => {
   const {
     app,
     env,
     configFile,
     table,
-    subsiteId,
+    siteId,
     wpcliCommand,
     ...optRest
   } = opt;
-  const liveBackupCopyCLIOptions = (0, _liveBackupCopy.parseLiveBackupCopyCLIOptions)(configFile, table, subsiteId, wpcliCommand);
+  const liveBackupCopyCLIOptions = (0, _liveBackupCopy.parseLiveBackupCopyCLIOptions)(configFile, table, siteId, wpcliCommand);
   const slug = await (0, _devEnvironmentCli.getEnvironmentName)(optRest);
   const trackerFn = (0, _tracker.makeCommandTracker)('dev_env_sync_sql', {
     app: app.id,

package/dist/bin/vip-export-sql.js

@@ -22,11 +22,11 @@ const examples = [{
   usage: 'vip @example-app.develop export sql --table=wp_posts,wp_comments',
   description: 'Generate a database backup including only the wp_posts and wp_comments tables using comma-separated syntax, and download a copy of that backup.'
 }, {
-  usage: 'vip @example-app.develop export sql --subsite-id=2 --subsite-id=3',
-  description: 'Generate a database backup including only the tables related to the subsites with IDs 2 and 3, and download a copy of that backup.'
+  usage: 'vip @example-app.develop export sql --site-id=2 --site-id=3',
+  description: 'Generate a database backup including only the tables related to the network sites with IDs 2 and 3, and download a copy of that backup.'
 }, {
-  usage: 'vip @example-app.develop export sql --subsite-id=2,3',
-  description: 'Generate a database backup including only the tables related to the subsites with IDs 2 and 3 using comma-separated syntax, and download a copy of that backup.'
+  usage: 'vip @example-app.develop export sql --site-id=2,3',
+  description: 'Generate a database backup including only the tables related to the network sites with IDs 2 and 3 using comma-separated syntax, and download a copy of that backup.'
 }, {
   usage: 'vip @example-app.develop export sql --config-file=~/db-export-config.json',
   description: 'Generate a database backup using the specified config file, and download a copy of that backup.'
@@ -52,17 +52,17 @@ const appQuery = `
   module: 'export-sql',
   requiredArgs: 0,
   usage: 'vip export sql'
-}).option('output', 'Download the file to a specific local directory path with a custom file name.').option('table', 'A table to export from the remote environment. Multiple tables can be specified with multiple --table flags or as a comma-separated list.').option('subsite-id', 'The ID of a subsite/network site to export from the remote environment. Multiple subsite IDs can be specified with multiple --subsite-id flags or as a comma-separated list.').option('wpcli-command', 'The WP-CLI command to run on the remote environment to retrieve the database export configuration.').option('config-file', 'The backup copy config file to use for the export.', undefined).option('generate-backup', 'Generate a fresh database backup and export a copy of that backup.').examples(examples).argv(process.argv, async (arg, {
+}).option('output', 'Download the file to a specific local directory path with a custom file name.').option('table', 'A table to export from the remote environment. Multiple tables can be specified with multiple --table flags or as a comma-separated list.').option('site-id', 'The ID of a network site to export from the remote environment. Multiple site IDs can be specified with multiple --site-id flags or as a comma-separated list.').option('wpcli-command', 'The WP-CLI command to run on the remote environment to retrieve the database export configuration.').option('config-file', 'The backup copy config file to use for the export.', undefined).option('generate-backup', 'Generate a fresh database backup and export a copy of that backup.').examples(examples).argv(process.argv, async (arg, {
   app,
   env,
   output,
   configFile,
   table,
-  subsiteId,
+  siteId,
   wpcliCommand,
   generateBackup
 }) => {
-  const liveBackupCopyCLIOptions = (0, _liveBackupCopy.parseLiveBackupCopyCLIOptions)(configFile, table, subsiteId, wpcliCommand);
+  const liveBackupCopyCLIOptions = (0, _liveBackupCopy.parseLiveBackupCopyCLIOptions)(configFile, table, siteId, wpcliCommand);
   const trackerFn = (0, _tracker.makeCommandTracker)('export_sql', {
     app: app.id,
     env: env.uniqueLabel,

package/dist/bin/vip.js

@@ -1,24 +1,16 @@
 #!/usr/bin/env node
 "use strict";
 
+require("../lib/node-version-check");
 var _chalk = _interopRequireDefault(require("chalk"));
 var _debug = _interopRequireDefault(require("debug"));
 var _enquirer = require("enquirer");
-var _semver = require("semver");
 var _command = _interopRequireWildcard(require("../lib/cli/command"));
 var _config = _interopRequireDefault(require("../lib/cli/config"));
 var _token = _interopRequireDefault(require("../lib/token"));
 var _tracker = require("../lib/tracker");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const {
-  name,
-  engines
-} = require('../../package.json');
-const version = engines.node;
-if (version && !(0, _semver.satisfies)(process.version, version)) {
-  console.warn(`${_chalk.default.bgYellow('WARNING:')} The current version of Node (${process.version}) does not meet the minimum requirements; ` + `${name} requires Node version ${version}.\n\n` + 'Please follow the installation instructions at https://nodejs.org/en/download/ to upgrade.');
-}
 const debug = (0, _debug.default)('@automattic/vip:bin:vip');
 if (_config.default && _config.default.environment !== 'production') {
   debug(`${_chalk.default.bgYellow('WARNING:')} RUNNING DEV VERSION OF @automattic/vip`);

package/dist/commands/export-sql.js

@@ -484,13 +484,13 @@ class ExportSQLCommand {
     }
     let type = _liveBackupCopy.BackupLiveCopyType.TABLES;
     let tables;
-    let subsiteIds;
+    let siteIds;
     if (this.liveBackupCopyCLIOptions?.tables) {
       tables = Object.fromEntries(this.liveBackupCopyCLIOptions?.tables.map(key => [key, {}]));
     }
-    if (this.liveBackupCopyCLIOptions?.subsiteIds) {
-      type = _liveBackupCopy.BackupLiveCopyType.SUBSITE_IDS;
-      subsiteIds = this.liveBackupCopyCLIOptions?.subsiteIds.map(id => Number(id));
+    if (this.liveBackupCopyCLIOptions?.siteIds) {
+      type = _liveBackupCopy.BackupLiveCopyType.SITE_IDS;
+      siteIds = this.liveBackupCopyCLIOptions?.siteIds.map(id => Number(id));
     }
     if (this.liveBackupCopyCLIOptions?.wpcliCommand) {
       type = _liveBackupCopy.BackupLiveCopyType.WP_CLI_COMMAND;
@@ -498,7 +498,7 @@ class ExportSQLCommand {
     return {
       type,
       tables,
-      subsite_ids: subsiteIds,
+      site_ids: siteIds,
       wpcli_command: this.liveBackupCopyCLIOptions?.wpcliCommand
     };
   }

package/dist/lib/live-backup-copy.js

@@ -10,13 +10,13 @@ var _userError = _interopRequireDefault(require("./user-error"));
 var _utils = require("./utils");
 var _api = _interopRequireDefault(require("../lib/api"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function parseLiveBackupCopyCLIOptions(configFile, table, subsiteId, wpcliCommand) {
+function parseLiveBackupCopyCLIOptions(configFile, table, siteId, wpcliCommand) {
   const options = {};
-  if (configFile && (table || subsiteId || wpcliCommand)) {
-    throw new _userError.default('The --config-file option cannot be used with the --table, --subsite-id, or --wpcli-command options. Please use only one of these options at a time.');
+  if (configFile && (table || siteId || wpcliCommand)) {
+    throw new _userError.default('The --config-file option cannot be used with the --table, --site-id, or --wpcli-command options. Please use only one of these options at a time.');
   }
-  if (wpcliCommand && (table || subsiteId)) {
-    throw new _userError.default('The --wpcli-command option cannot be used with the --table or --subsite-id options. Please use only one of these options at a time.');
+  if (wpcliCommand && (table || siteId)) {
+    throw new _userError.default('The --wpcli-command option cannot be used with the --table or --site-id options. Please use only one of these options at a time.');
   }
   let useLiveBackupCopy = false;
   if (table) {
@@ -27,11 +27,11 @@ function parseLiveBackupCopyCLIOptions(configFile, table, subsiteId, wpcliComman
     }
     useLiveBackupCopy = true;
   }
-  if (subsiteId) {
-    if (Array.isArray(subsiteId)) {
-      options.subsiteIds = subsiteId.flatMap(id => String(id).split(',').map(idStr => Number(idStr.trim())));
+  if (siteId) {
+    if (Array.isArray(siteId)) {
+      options.siteIds = siteId.flatMap(id => String(id).split(',').map(idStr => Number(idStr.trim())));
     } else {
-      options.subsiteIds = String(subsiteId).split(',').map(idStr => Number(idStr.trim()));
+      options.siteIds = String(siteId).split(',').map(idStr => Number(idStr.trim()));
     }
     useLiveBackupCopy = true;
   }
@@ -73,7 +73,7 @@ const GENERATE_LIVE_BACKUP_DOWNLOAD_URL_MUTATION = exports.GENERATE_LIVE_BACKUP_
 let BackupLiveCopyType = exports.BackupLiveCopyType = /*#__PURE__*/function (BackupLiveCopyType) {
   BackupLiveCopyType["FULL"] = "full";
   BackupLiveCopyType["TABLES"] = "tables";
-  BackupLiveCopyType["SUBSITE_IDS"] = "subsite_ids";
+  BackupLiveCopyType["SITE_IDS"] = "site_ids";
   BackupLiveCopyType["WP_CLI_COMMAND"] = "wpcli_command";
   return BackupLiveCopyType;
 }({});
@@ -104,7 +104,7 @@ async function startLiveBackupCopy({
   // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
   if (!result.data?.startLiveBackupCopy.copyId) {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-    throw new Error(`Failed to start live backup copy: ${result.data?.startLiveBackupCopy?.message ? result.data?.startLiveBackupCopy?.message : 'Unknown error'}`);
+    throw new Error(`Failed to start partial database export: ${result.data?.startLiveBackupCopy?.message ? result.data?.startLiveBackupCopy?.message : 'Unknown error'}`);
   }
   return result.data?.startLiveBackupCopy.copyId;
 }

package/dist/lib/node-version-check.js

@@ -0,0 +1,20 @@
+"use strict";
+
+var _nodeFs = require("node:fs");
+var _nodePath = require("node:path");
+var _semver = require("semver");
+const boldRed = process.stdout.isTTY ? '\x1b[1;31m' : '';
+const reset = process.stdout.isTTY ? '\x1b[0m' : '';
+try {
+  const json = (0, _nodeFs.readFileSync)((0, _nodePath.join)(__dirname, '..', '..', 'package.json'), 'utf8');
+  const {
+    name,
+    engines
+  } = JSON.parse(json);
+  const version = engines.node;
+  if (version && !(0, _semver.satisfies)(process.version, version)) {
+    console.warn(`${boldRed}WARNING: The current version of Node (${process.version}) does not meet the minimum requirements; ` + `${name} requires Node version ${version}.\n\n` + `Please follow the installation instructions at https://nodejs.org/en/download/ to upgrade.${reset}\n`);
+  }
+} catch {
+  // Do nothing
+}