@automattic/vip 2.35.0 → 2.35.1

package/CONTRIBUTING.md

@@ -113,7 +113,7 @@ Changelogs allow customers to keep up with all the changes happening across our
 
 ### Pre-publish Checks
 
-We use a custom pre-publish [script](https://github.com/Automattic/vip/blob/trunk/hellpers/prepublishOnly.js) that performs some confidence checks to avoid common mistakes.
+We use a custom pre-publish [script](https://github.com/Automattic/vip/blob/trunk/helpers/prepublishOnly.js) that performs some confidence checks to avoid common mistakes.
 
 Further checks can be added to this flow as needed.
 

package/dist/bin/vip-app-list.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+
 /**
  * External dependencies
  */
@@ -20,7 +21,6 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
   let response;
   try {
     response = 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) {

package/dist/bin/vip-app.js

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

package/dist/bin/vip-cache-purge-url.js

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

package/dist/bin/vip-cache.js

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

package/dist/bin/vip-config-envvar-delete.js

@@ -1,10 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */
@@ -31,6 +26,12 @@ const examples = [{
   usage: `${baseUsage} MY_VARIABLE`,
   description: 'Permanently deletes the environment variable "MY_VARIABLE"'
 }];
+
+/**
+ * @param {string[]} arg
+ * @param {object} opt
+ * @return {Promise<void>}
+ */
 async function deleteEnvVarCommand(arg, opt) {
   // Help the user by uppercasing input.
   const name = arg[0].trim().toUpperCase();

package/dist/bin/vip-config-envvar-get-all.js

@@ -1,10 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */
@@ -31,6 +26,12 @@ const examples = [{
   usage,
   description: 'Get the values of all environment variables'
 }];
+
+/**
+ * @param {string[]} arg
+ * @param {object} opt
+ * @return {Promise<void>}
+ */
 async function getAllEnvVarsCommand(arg, opt) {
   const trackingParams = {
     app_id: opt.app.id,

package/dist/bin/vip-config-envvar-get.js

@@ -1,10 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */
@@ -30,6 +25,12 @@ const examples = [{
   usage: `${baseUsage} MY_VARIABLE`,
   description: 'Get the value of the environment variable "MY_VARIABLE"'
 }];
+
+/**
+ * @param {string[]} arg
+ * @param {object} opt
+ * @return {Promise<void>}
+ */
 async function getEnvVarCommand(arg, opt) {
   // Help the user by uppercasing input.
   const name = arg[0].trim().toUpperCase();

package/dist/bin/vip-config-envvar-list.js

@@ -1,10 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */
@@ -31,6 +26,12 @@ const examples = [{
   usage,
   description: 'Lists all environment variables (names only)'
 }];
+
+/**
+ * @param {string[]} arg
+ * @param {object} opt
+ * @return {Promise<void>}
+ */
 async function listEnvVarsCommand(arg, opt) {
   const trackingParams = {
     app_id: opt.app.id,

package/dist/bin/vip-config-envvar-set.js

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

package/dist/bin/vip-config-envvar.js

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

package/dist/bin/vip-config-software-get.js

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

package/dist/bin/vip-config-software-update.js

@@ -1,10 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */
@@ -62,6 +57,8 @@ cmd.argv(process.argv, async (arg, opt) => {
     if (softwareSettings === null) {
       throw new _userError.default('Software settings are not supported for this environment.');
     }
+
+    /** @type {UpdatePromptOptions} */
     const updateOptions = {
       force: !!opt.yes
     };

package/dist/bin/vip-config-software.js

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

package/dist/bin/vip-config.js

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
+
 /**
  * External dependencies
  */
+
 /**
  * Internal dependencies
  */

package/dist/bin/vip-dev-env-create.js

@@ -1,10 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */
@@ -78,6 +73,8 @@ cmd.argv(process.argv, async (arg, opt) => {
     const messageToShow = `Environment already exists\n\n\nTo start the environment run:\n\n${startCommand}\n\n` + `To create another environment use ${_chalk.default.bold('--slug')} option with a unique name.\n`;
     exit.withError(messageToShow);
   }
+
+  /** @type {InstanceOptions} */
   let defaultOptions = {};
   try {
     if (opt.app) {

package/dist/bin/vip-dev-env-destroy.js

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

package/dist/bin/vip-dev-env-exec.js

@@ -1,10 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * 
- * @format
- */
-
 /**
  * Internal dependencies
  */
@@ -43,6 +38,8 @@ const examples = [{
     if (unmatchedArgs.length > 0 && !argSplitterFound) {
       throw new Error('Please provide "--" argument to separate arguments for "vip" and command to be executed (see "--help" for examples)');
     }
+
+    /** @type {string[]} */
     let arg = [];
     if (argSplitterFound && argSplitterIx + 1 < process.argv.length) {
       arg = process.argv.slice(argSplitterIx + 1);

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

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

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

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

package/dist/bin/vip-dev-env-import.js

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

package/dist/bin/vip-dev-env-info.js

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

package/dist/bin/vip-dev-env-list.js

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

package/dist/bin/vip-dev-env-logs.js

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

package/dist/bin/vip-dev-env-shell.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-// @format
+
 /**
  * External dependencies
  */
@@ -41,11 +41,18 @@ const examples = [{
   usage: `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} shell -S database -- ls -lha`,
   description: 'Runs `ls -lha` command in the shell of the database service in the dev environment'
 }];
+
+/**
+ * @param {string[]} args
+ * @return {string[]}
+ */
 function getCommand(args) {
   const splitterIdx = process.argv.findIndex(argument => '--' === argument);
   if (args.length > 0 && splitterIdx === -1) {
     throw new Error('Please provide "--" argument to separate arguments for "vip" and command to be executed (see "--help" for examples)');
   }
+
+  /** @type {string[]} */
   let cmd = [];
   if (splitterIdx !== -1 && splitterIdx + 1 < process.argv.length) {
     cmd = process.argv.slice(splitterIdx + 1);

package/dist/bin/vip-dev-env-start.js

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

package/dist/bin/vip-dev-env-stop.js

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

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

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

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

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

package/dist/bin/vip-dev-env-update.js

@@ -1,10 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */
@@ -45,6 +40,8 @@ cmd.argv(process.argv, async (arg, opt) => {
     }
     const currentInstanceData = (0, _devEnvironmentCore.readEnvironmentData)(slug);
     debug('Read instance data', currentInstanceData);
+
+    /** @type {InstanceOptions} */
     const preselectedOptions = {
       title: currentInstanceData.wpTitle,
       multisite: currentInstanceData.multisite,
@@ -53,6 +50,8 @@ cmd.argv(process.argv, async (arg, opt) => {
     const configurationFileOptions = await (0, _devEnvironmentConfigurationFile.getConfigurationFileOptions)();
     const thereAreOptionsFromConfigFile = Object.keys(configurationFileOptions).length > 0;
     const finalPreselectedOptions = (0, _devEnvironmentConfigurationFile.mergeConfigurationFileOptions)(preselectedOptions, configurationFileOptions);
+
+    /** @type {InstanceOptions} */
     const defaultOptions = {
       appCode: currentInstanceData.appCode.dir || currentInstanceData.appCode.tag || 'latest',
       muPlugins: currentInstanceData.muPlugins.dir || currentInstanceData.muPlugins.tag || 'latest',

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

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

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

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

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

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

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

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

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

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

package/dist/bin/vip-import-sql-status.js

@@ -1,10 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */
@@ -26,6 +21,7 @@ const appQuery = `
 id,
 name,
 type,
+typeId,
 environments{
 	id
 	appId

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

@@ -1,10 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * 
- * @format
- */
-
 /**
  * External dependencies
  */
@@ -90,6 +85,12 @@ const SQL_IMPORT_PREFLIGHT_PROGRESS_STEPS = [{
   id: 'queue_import',
   name: 'Queueing Import'
 }];
+
+/**
+ * @param {AppForImport} app
+ * @param {EnvForImport} env
+ * @param {string} fileName
+ */
 async function gates(app, env, fileName) {
   const {
     id: envId,
@@ -214,6 +215,10 @@ const promptToContinue = async ({
     exit.withError('The input did not match the expected environment label. Import aborted.');
   }
 };
+
+/**
+ * @returns {Promise<string[]>}
+ */
 async function validateAndGetTableNames({
   skipValidate,
   appId,

package/dist/bin/vip-import-validate-files.js

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

package/dist/bin/vip-import-validate-sql.js

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
+
 /**
  * External dependencies
  */
+
 /**
  * Internal dependencies
  */

package/dist/bin/vip-logs.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+
 /**
  * External dependencies
  */
@@ -31,6 +32,10 @@ const ALLOWED_FORMATS = ['csv', 'json', 'text'];
 const DEFAULT_POLLING_DELAY_IN_SECONDS = 30;
 const MIN_POLLING_DELAY_IN_SECONDS = 5;
 const MAX_POLLING_DELAY_IN_SECONDS = 300;
+
+/**
+ * @param {string[]} arg
+ */
 async function getLogs(arg, opt) {
   validateInputs(opt.type, opt.limit, opt.format);
   const trackingParams = getBaseTrackingParams(opt);
@@ -158,6 +163,12 @@ function printLogs(logs, format) {
   }
   console.log(output);
 }
+
+/**
+ * @param {string} type
+ * @param {number} limit
+ * @param {string} format
+ */
 function validateInputs(type, limit, format) {
   if (!ALLOWED_TYPES.includes(type)) {
     exit.withError(`Invalid type: ${type}. The supported types are: ${ALLOWED_TYPES.join(', ')}.`);

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) {