@automattic/vip 2.35.0 → 2.36.0-dev.0

package/dist/bin/vip-search-replace.js

@@ -1,10 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */

package/dist/bin/vip-slowlogs.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+
 /**
  * External dependencies
  */

package/dist/bin/vip-sync.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+
 /**
  * External dependencies
  */
@@ -33,7 +34,6 @@ const appQuery = `id,name,environments{
   await (0, _tracker.trackEvent)('sync_command_execute');
   try {
     await api.mutate({
-      // $FlowFixMe: gql template is not supported by flow
       mutation: (0, _graphqlTag.default)`
 				mutation SyncEnvironmentMutation($input: AppEnvironmentSyncInput) {
 					syncEnvironment(input: $input) {
@@ -105,7 +105,6 @@ const appQuery = `id,name,environments{
       // Query the API 1/10 of the time (every 1s)
       // The rest of the iterations are just for moving the spinner
       api.query({
-        // $FlowFixMe: gql template is not supported by flow
         query: (0, _graphqlTag.default)`
 						query App($id: Int, $sync: Int) {
 							app(id: $id) {

package/dist/bin/vip-validate-preflight.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+
 /**
  * External dependencies
  */
@@ -53,6 +54,10 @@ exports.appQuery = appQuery;
 let suppressOutput = false;
 let outputJson = false;
 let harmoniaArgs = [];
+
+/**
+ * @param {string[]} messages
+ */
 function logToConsole(...messages) {
   if (suppressOutput) {
     return;
@@ -110,6 +115,10 @@ async function getBuildConfiguration(application, environment) {
     }
   }
 }
+
+/**
+ * @param {string} argv
+ */
 async function vipValidatePreflightCommand(arg, opt) {
   var _opt$env, _opt$env2, _opt$app, _opt$env3;
   harmoniaArgs = await validateArgs(opt);
@@ -210,6 +219,10 @@ async function vipValidatePreflightCommand(arg, opt) {
   setupEvents(harmonia);
   runHarmonia(harmonia);
 }
+
+/**
+ * @param {Harmonia} harmonia
+ */
 function setupEvents(harmonia) {
   // Register some events handlers
   harmonia.on('ready', () => {

package/dist/bin/vip-wp.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+
 /**
  * External dependencies
  */
@@ -98,7 +99,6 @@ const bindStreamEvents = ({
 const getTokenForCommand = async (appId, envId, command) => {
   const api = await (0, _api.default)();
   return api.mutate({
-    // $FlowFixMe: gql template is not supported by flow
     mutation: (0, _graphqlTag.default)`
 			mutation TriggerWPCLICommandMutation($input: AppEnvironmentTriggerWPCLICommandInput) {
 				triggerWPCLICommandOnAppEnvironment(input: $input) {
@@ -123,7 +123,6 @@ const getTokenForCommand = async (appId, envId, command) => {
 const cancelCommand = async guid => {
   const api = await (0, _api.default)();
   return api.mutate({
-    // $FlowFixMe: gql template is not supported by flow
     mutation: (0, _graphqlTag.default)`
 			mutation cancelWPCLICommand($input: CancelWPCLICommandInput) {
 				cancelWPCLICommand(input: $input) {

package/dist/bin/vip.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+
 /**
  * External dependencies
  */
@@ -28,9 +29,15 @@ if (_config.default && _config.default.environment !== 'production') {
 const tokenURL = 'https://dashboard.wpvip.com/me/cli/token';
 const runCmd = async function () {
   const cmd = (0, _command.default)();
-  cmd.command('logout', 'Logout from your current session').command('app', 'List and modify your VIP applications').command('backup', 'Generate a backup for VIP applications').command('cache', 'Manage page cache for your VIP applications').command('config', 'Set configuration for your VIP applications').command('dev-env', 'Use local dev-environment').command('export', 'Export data from your VIP application').command('import', 'Import media or SQL files into your VIP applications').command('logs', 'Get logs from your VIP applications').command('search-replace', 'Perform search and replace tasks on files').command('slowlogs', 'Get slowlogs from your VIP applications').command('sync', 'Sync production to a development environment').command('whoami', 'Display details about the currently logged-in user').command('validate', 'Validate your VIP application and environment').command('wp', 'Run WP CLI commands against an environment');
+  cmd.command('logout', 'Logout from your current session').command('app', 'List and modify your VIP applications').command('backup', 'Generate a backup for VIP applications').command('cache', 'Manage page cache for your VIP applications').command('config', 'Set configuration for your VIP applications').command('dev-env', 'Use local dev-environment').command('export', 'Export data from your VIP application').command('import', 'Import media or SQL files into your VIP applications').command('logs', 'Get logs from your VIP applications').command('search-replace', 'Perform search and replace tasks on files').command('slowlogs', 'Get slowlogs from your VIP applications').command('phpmyadmin', 'Open PHPMyAdmin console for your VIP application database').command('sync', 'Sync production to a development environment').command('whoami', 'Display details about the currently logged-in user').command('validate', 'Validate your VIP application and environment').command('wp', 'Run WP CLI commands against an environment');
   cmd.argv(process.argv);
 };
+
+/**
+ * @param {any[]} argv
+ * @param {any[]} params
+ * @returns {boolean}
+ */
 function doesArgvHaveAtLeastOneParam(argv, params) {
   return argv.some(arg => params.includes(arg));
 }

package/dist/commands/backup-db.js

@@ -14,11 +14,6 @@ var _format = require("../lib/cli/format");
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */
@@ -99,10 +94,19 @@ async function createBackupJob(appId, envId) {
 
 // Library for a possible command in the future: vip backup db @app.env
 class BackupDBCommand {
+  app;
+  env;
+  job;
+  jobStatus;
+  jobAge;
+  backupName;
+  silent;
   steps = {
     PREPARE: 'prepare',
     GENERATE: 'generate'
   };
+  track;
+  progressTracker;
   constructor(app, env, trackerFn = async () => {}) {
     this.app = app;
     this.env = env;

package/dist/commands/dev-env-import-sql.js

@@ -12,11 +12,6 @@ var _devEnvironmentLando = require("../lib/dev-environment/dev-environment-lando
 var _userError = _interopRequireDefault(require("../lib/user-error"));
 var _sql = require("../lib/validations/sql");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */
@@ -26,6 +21,10 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 
 class DevEnvImportSQLCommand {
+  fileName;
+  options;
+  slug;
+  trackingInfo;
   constructor(fileName, options, slug) {
     this.fileName = fileName;
     this.options = options;

package/dist/commands/dev-env-sync-sql.js

@@ -1,10 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */
@@ -69,6 +64,14 @@ async function extractSiteUrls(sqlFile) {
   });
 }
 class DevEnvSyncSQLCommand {
+  app;
+  env;
+  slug;
+  tmpDir;
+  siteUrls;
+  searchReplaceMap;
+  track;
+
   /**
    * Creates a new instance of the command
    *

package/dist/commands/export-sql.js

@@ -19,11 +19,6 @@ var _backupStorageAvailability = require("../lib/backup-storage-availability/bac
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */
@@ -187,6 +182,13 @@ async function createExportJob(appId, envId, backupId) {
  * Class representing an export command workflow
  */
 class ExportSQLCommand {
+  app;
+  env;
+  downloadLink;
+  progressTracker;
+  outputFile;
+  generateBackup;
+  confirmEnoughStorageHook;
   steps = {
     PREPARE: 'prepare',
     CREATE: 'create',
@@ -194,6 +196,8 @@ class ExportSQLCommand {
     CONFIRM_ENOUGH_STORAGE: 'confirmEnoughStorage',
     DOWNLOAD: 'download'
   };
+  track;
+
   /**
    * Creates an instance of SQLExportCommand
    *

package/dist/commands/phpmyadmin.js

@@ -0,0 +1,91 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.PhpMyAdminCommand = exports.GENERATE_PHP_MY_ADMIN_URL_MUTATION = void 0;
+var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
+var _opn = _interopRequireDefault(require("opn"));
+var _api = _interopRequireWildcard(require("../lib/api"));
+var exit = _interopRequireWildcard(require("../lib/cli/exit"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+
+const GENERATE_PHP_MY_ADMIN_URL_MUTATION = (0, _graphqlTag.default)`
+	mutation GeneratePhpMyAdminAccess($input: GeneratePhpMyAdminAccessInput) {
+		generatePHPMyAdminAccess(input: $input) {
+			expiresAt
+			url
+		}
+	}
+`;
+exports.GENERATE_PHP_MY_ADMIN_URL_MUTATION = GENERATE_PHP_MY_ADMIN_URL_MUTATION;
+async function generatePhpMyAdminAccess(envId) {
+  var _resp$data;
+  // Disable global error handling so that we can handle errors ourselves
+  (0, _api.disableGlobalGraphQLErrorHandling)();
+  const api = await (0, _api.default)();
+  const resp = await api.mutate({
+    mutation: GENERATE_PHP_MY_ADMIN_URL_MUTATION,
+    variables: {
+      input: {
+        environmentId: envId
+      }
+    }
+  });
+
+  // Re-enable global error handling
+  (0, _api.enableGlobalGraphQLErrorHandling)();
+
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+  return resp === null || resp === void 0 || (_resp$data = resp.data) === null || _resp$data === void 0 || (_resp$data = _resp$data.generatePHPMyAdminAccess) === null || _resp$data === void 0 ? void 0 : _resp$data.url;
+}
+class PhpMyAdminCommand {
+  app;
+  env;
+  silent;
+  track;
+  constructor(app, env, trackerFn = async () => {}) {
+    this.app = app;
+    this.env = env;
+    this.track = trackerFn;
+  }
+  log(msg) {
+    if (this.silent) {
+      return;
+    }
+    console.log(msg);
+  }
+  async run(silent = false) {
+    this.silent = silent;
+    if (!this.env.id) {
+      exit.withError('No environment was specified');
+    }
+    this.log('Generating PhpMyAdmin URL...');
+    let url;
+    try {
+      url = await generatePhpMyAdminAccess(this.env.id);
+    } catch (err) {
+      const error = err;
+      void this.track('error', {
+        error_type: 'generate_pma_url',
+        error_message: error.message,
+        stack: error.stack
+      });
+      exit.withError(`Failed to generate PhpMyAdmin URL: ${error.message}`);
+    }
+    void (0, _opn.default)(url, {
+      wait: false
+    });
+    this.log('PhpMyAdmin is opened in your default browser.');
+  }
+}
+exports.PhpMyAdminCommand = PhpMyAdminCommand;

package/dist/lib/analytics/clients/pendo.js

@@ -20,6 +20,10 @@ const debug = (0, _debug.default)('@automattic/vip:analytics:clients:pendo');
  * Pendo analytics client.
  */
 class Pendo {
+  eventPrefix;
+  userAgent;
+  userId;
+  context;
   static ENDPOINT = '/pendo';
   constructor(options) {
     this.eventPrefix = options.eventPrefix;

package/dist/lib/analytics/clients/tracks.js

@@ -28,6 +28,9 @@ const validEventOrPropNamePattern = /^[a-z_][a-z0-9_]*$/;
 // TODO: add batch support (can include multiples in `events` array)
 
 class Tracks {
+  eventPrefix;
+  userAgent;
+  baseParams;
   static ENDPOINT = 'https://public-api.wordpress.com/rest/v1.1/tracks/record';
   constructor(userId, userType, eventPrefix, env) {
     this.eventPrefix = eventPrefix;

package/dist/lib/analytics/index.js

@@ -27,6 +27,7 @@ const client_info = {
 /* eslint-enable camelcase */
 
 class Analytics {
+  clients;
   constructor(clients) {
     this.clients = clients;
   }

package/dist/lib/backup-storage-availability/backup-storage-availability.js

@@ -15,6 +15,7 @@ var _dockerMachineNotFoundError = require("./docker-machine-not-found-error");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const oneGiBInBytes = 1024 * 1024 * 1024;
 class BackupStorageAvailability {
+  archiveSize;
   constructor(archiveSize) {
     this.archiveSize = archiveSize;
   }

package/dist/lib/cli/command.js

@@ -27,9 +27,11 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * External dependencies
  */
+
 /**
  * Internal dependencies
  */
+
 function uncaughtError(err) {
   // Error raised when trying to write to an already closed stream
   if (err.code === 'EPIPE') {
@@ -166,7 +168,6 @@ _args.default.argv = async function (argv, cb) {
       await (0, _tracker.trackEvent)('command_appcontext_list_fetch');
       try {
         res = await api.query({
-          // $FlowFixMe: gql template is not supported by flow
           query: (0, _graphqlTag.default)`query Apps( $first: Int, $after: String ) {
 							apps( first: $first, after: $after ) {
 								total
@@ -301,6 +302,7 @@ _args.default.argv = async function (argv, cb) {
 
   // Prompt for confirmation if necessary
   if (_opts.requireConfirm && !options.force) {
+    /** @type {Tuple[]} */
     const info = [];
     if (options.app) {
       info.push({
@@ -467,6 +469,10 @@ _args.default.argv = async function (argv, cb) {
   }
   return options;
 };
+
+/**
+ * @returns {Error|undefined}
+ */
 function validateOpts(opts) {
   if (opts.app) {
     if (typeof opts.app !== 'string' && typeof opts.app !== 'number') {
@@ -485,6 +491,10 @@ function validateOpts(opts) {
     }
   }
 }
+
+/**
+ * @returns {args}
+ */
 function _default(opts) {
   _opts = Object.assign({
     appContext: false,

package/dist/lib/cli/format.js

@@ -141,6 +141,7 @@ function capitalize(str) {
 const RUNNING_SPRITE_GLYPHS = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
 exports.RUNNING_SPRITE_GLYPHS = RUNNING_SPRITE_GLYPHS;
 class RunningSprite {
+  count;
   constructor() {
     this.count = 0;
   }

package/dist/lib/cli/progress.js

@@ -28,13 +28,22 @@ let StepStatus = /*#__PURE__*/function (StepStatus) {
 exports.StepStatus = StepStatus;
 const COMPLETED_STEP_SLUGS = [StepStatus.SUCCESS, StepStatus.SKIPPED];
 class ProgressTracker {
+  hasFailure;
+  hasPrinted;
+  printInterval;
+
   // Track the state of each step
+  stepsFromCaller;
+  stepsFromServer;
 
   // Spinnerz go brrrr
+  runningSprite;
 
   // This gets printed before the step status
+  prefix;
 
   // This gets printed after the step status
+  suffix;
 
   /**
    * This determines from which step should we display the steps

package/dist/lib/keychain/insecure.js

@@ -15,6 +15,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 
 class Insecure {
+  file;
+  configstore;
   constructor(file) {
     this.file = file;
     this.configstore = new _configstore.default(this.file);

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

@@ -18,12 +18,19 @@ var _format = require("../../lib/cli/format");
 const PRINT_INTERVAL = process.env.DEBUG ? 5000 : 200; // How often the report is printed. Mainly affects the "spinner" animation.
 
 class MediaImportProgressTracker {
+  hasFailure;
+  hasPrinted;
+  printInterval;
+  status;
+
   // Spinnerz go brrrr
+  runningSprite;
 
   // This gets printed before the step status
+  prefix;
 
   // This gets printed after the step status
-
+  suffix;
   constructor(status) {
     this.runningSprite = new _format.RunningSprite();
     this.hasFailure = false;

package/dist/lib/token.js

@@ -21,6 +21,10 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 const SERVICE = 'vip-go-cli';
 exports.SERVICE = SERVICE;
 class Token {
+  _raw;
+  _id;
+  iat;
+  exp;
   constructor(token) {
     if (!token) {
       return;

package/helpers/prepublishOnly.js

@@ -7,7 +7,7 @@ const config = {
 	gitAllowDirty: true,
 	gitEnforceBranch: 'trunk',
 	nodeEnforceVersion: packageJSON.engines.node,
-	testBeforePublish: true,
+	testBeforePublish: process.env.CI !== 'true',
 };
 
 const releaseTag = process.env.npm_config_tag ?? 'latest';