@strapi/strapi 4.10.0-beta.0 → 4.10.0

package/lib/commands/actions/import/command.js

@@ -0,0 +1,97 @@
+'use strict';
+
+const { Option } = require('commander');
+const path = require('path');
+const inquirer = require('inquirer');
+const {
+  excludeOption,
+  onlyOption,
+  throttleOption,
+  validateExcludeOnly,
+} = require('../../utils/data-transfer');
+const { confirmMessage, forceOption } = require('../../utils/commander');
+const { getLocalScript, exitWith } = require('../../utils/helpers');
+
+/**
+ * `$ strapi import`
+ * @param {import('../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('import')
+    .description('Import data from file to Strapi')
+    .allowExcessArguments(false)
+    .requiredOption(
+      '-f, --file <file>',
+      'path and filename for the Strapi export file you want to import'
+    )
+    .addOption(
+      new Option(
+        '-k, --key <string>',
+        'Provide encryption key in command instead of using the prompt'
+      )
+    )
+    .addOption(forceOption)
+    .addOption(excludeOption)
+    .addOption(onlyOption)
+    .addOption(throttleOption)
+    .hook('preAction', validateExcludeOnly)
+    .hook('preAction', async (thisCommand) => {
+      const opts = thisCommand.opts();
+      const ext = path.extname(String(opts.file));
+
+      // check extension to guess if we should prompt for key
+      if (ext === '.enc') {
+        if (!opts.key) {
+          const answers = await inquirer.prompt([
+            {
+              type: 'password',
+              message: 'Please enter your decryption key',
+              name: 'key',
+            },
+          ]);
+          if (!answers.key?.length) {
+            exitWith(1, 'No key entered, aborting import.');
+          }
+          opts.key = answers.key;
+        }
+      }
+    })
+    // set decrypt and decompress options based on filename
+    .hook('preAction', (thisCommand) => {
+      const opts = thisCommand.opts();
+
+      const { extname, parse } = path;
+
+      let file = opts.file;
+
+      if (extname(file) === '.enc') {
+        file = parse(file).name; // trim the .enc extension
+        thisCommand.opts().decrypt = true;
+      } else {
+        thisCommand.opts().decrypt = false;
+      }
+
+      if (extname(file) === '.gz') {
+        file = parse(file).name; // trim the .gz extension
+        thisCommand.opts().decompress = true;
+      } else {
+        thisCommand.opts().decompress = false;
+      }
+
+      if (extname(file) !== '.tar') {
+        exitWith(
+          1,
+          `The file '${opts.file}' does not appear to be a valid Strapi data file. It must have an extension ending in .tar[.gz][.enc]`
+        );
+      }
+    })
+    .hook(
+      'preAction',
+      confirmMessage(
+        'The import will delete all assets and data in your database. Are you sure you want to proceed?',
+        { failMessage: 'Import process aborted' }
+      )
+    )
+    .action(getLocalScript('import'));
+};

package/lib/commands/{install.js → actions/install/action.js}

@@ -4,7 +4,7 @@ const { join } = require('path');
 const { existsSync } = require('fs-extra');
 const ora = require('ora');
 const execa = require('execa');
-const findPackagePath = require('../load/package-path');
+const findPackagePath = require('../../../load/package-path');
 
 module.exports = async (plugins) => {
   const loader = ora();

package/lib/commands/actions/install/command.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const { getLocalScript } = require('../../utils/helpers');
+
+/**
+ * `$ strapi install`
+ * @param {import('../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('install [plugins...]')
+    .description('Install a Strapi plugin')
+    .action(getLocalScript('install'));
+};

package/lib/commands/{middlewares/list.js → actions/middlewares/list/action.js}

@@ -3,9 +3,9 @@
 const CLITable = require('cli-table3');
 const chalk = require('chalk');
 
-const strapi = require('../../index');
+const strapi = require('../../../../index');
 
-module.exports = async function () {
+module.exports = async () => {
   const appContext = await strapi.compile();
   const app = await strapi(appContext).register();
 

package/lib/commands/actions/middlewares/list/command.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const { getLocalScript } = require('../../../utils/helpers');
+
+/**
+ * `$ strapi middlewares:list`
+ * @param {import('../../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('middlewares:list')
+    .description('List all the application middlewares')
+    .action(getLocalScript('middlewares/list'));
+};

package/lib/commands/{new.js → actions/new/action.js}

@@ -8,6 +8,6 @@ const { generateNewApp } = require('@strapi/generate-new');
  * Generate a new Strapi application.
  */
 
-module.exports = function (...args) {
+module.exports = (...args) => {
   return generateNewApp(...args);
 };

package/lib/commands/actions/new/command.js

@@ -0,0 +1,35 @@
+'use strict';
+
+const { yellow } = require('chalk');
+
+/**
+ * `$ strapi new`
+ * @param {import('../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('new <directory>')
+    .option('--no-run', 'Do not start the application after it is created')
+    .option('--use-npm', 'Force usage of npm instead of yarn to create the project')
+    .option('--debug', 'Display database connection errors')
+    .option('--quickstart', 'Create quickstart app')
+    .option('--dbclient <dbclient>', 'Database client')
+    .option('--dbhost <dbhost>', 'Database host')
+    .option('--dbport <dbport>', 'Database port')
+    .option('--dbname <dbname>', 'Database name')
+    .option('--dbusername <dbusername>', 'Database username')
+    .option('--dbpassword <dbpassword>', 'Database password')
+    .option('--dbssl <dbssl>', 'Database SSL')
+    .option('--dbfile <dbfile>', 'Database file path for sqlite')
+    .option('--dbforce', 'Allow overwriting existing database content')
+    .option('-ts, --typescript', 'Create a typescript project')
+    .description('Create a new application')
+    .hook('preAction', () => {
+      console.warn(
+        yellow(
+          'The `strapi new` command has been deprecated in v4 and will be removed in v5. `create-strapi-app` should be used to create a new Strapi project.'
+        )
+      );
+    })
+    .action(require('./action'));
+};

package/lib/commands/{policies/list.js → actions/policies/list/action.js}

@@ -3,9 +3,9 @@
 const CLITable = require('cli-table3');
 const chalk = require('chalk');
 
-const strapi = require('../../index');
+const strapi = require('../../../../index');
 
-module.exports = async function () {
+module.exports = async () => {
   const appContext = await strapi.compile();
   const app = await strapi(appContext).register();
 

package/lib/commands/actions/policies/list/command.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const { getLocalScript } = require('../../../utils/helpers');
+
+/**
+ * `$ strapi policies:list`
+ * @param {import('../../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('policies:list')
+    .description('List all the application policies')
+    .action(getLocalScript('policies/list'));
+};

package/lib/commands/actions/report/action.js

@@ -0,0 +1,35 @@
+'use strict';
+
+const { EOL } = require('os');
+const strapi = require('../../../index');
+
+module.exports = async ({ uuid, dependencies, all }) => {
+  const config = {
+    reportUUID: Boolean(all || uuid),
+    reportDependencies: Boolean(all || dependencies),
+  };
+
+  const appContext = await strapi.compile();
+  const app = await strapi(appContext).register();
+
+  let debugInfo = `Launched In: ${Date.now() - app.config.launchedAt} ms
+Environment: ${app.config.environment}
+OS: ${process.platform}-${process.arch}
+Strapi Version: ${app.config.info.strapi}
+Node/Yarn Version: ${process.env.npm_config_user_agent}
+Edition: ${app.EE ? 'Enterprise' : 'Community'}
+Database: ${app?.config?.database?.connection?.client ?? 'unknown'}`;
+
+  if (config.reportUUID) {
+    debugInfo += `${EOL}UUID: ${app.config.uuid}`;
+  }
+
+  if (config.reportDependencies) {
+    debugInfo += `${EOL}Dependencies: ${JSON.stringify(app.config.info.dependencies, null, 2)}
+Dev Dependencies: ${JSON.stringify(app.config.info.devDependencies, null, 2)}`;
+  }
+
+  console.log(debugInfo);
+
+  await app.destroy();
+};

package/lib/commands/actions/report/command.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const { getLocalScript } = require('../../utils/helpers');
+
+/**
+ * `$ strapi report`
+ * @param {import('../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('report')
+    .description('Get system stats for debugging and submitting issues')
+    .option('-u, --uuid', 'Include Project UUID')
+    .option('-d, --dependencies', 'Include Project Dependencies')
+    .option('--all', 'Include All Information')
+    .action(getLocalScript('report'));
+};

package/lib/commands/{routes/list.js → actions/routes/list/action.js}

@@ -4,9 +4,9 @@ const CLITable = require('cli-table3');
 const chalk = require('chalk');
 const { toUpper } = require('lodash/fp');
 
-const strapi = require('../../index');
+const strapi = require('../../../../index');
 
-module.exports = async function () {
+module.exports = async () => {
   const appContext = await strapi.compile();
   const app = await strapi(appContext).load();
 

package/lib/commands/actions/routes/list/command.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const { getLocalScript } = require('../../../utils/helpers');
+
+/**
+ * `$ strapi routes:list``
+ * @param {import('../../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('routes:list')
+    .description('List all the application routes')
+    .action(getLocalScript('routes/list'));
+};

package/lib/commands/{services/list.js → actions/services/list/action.js}

@@ -3,9 +3,9 @@
 const CLITable = require('cli-table3');
 const chalk = require('chalk');
 
-const strapi = require('../../index');
+const strapi = require('../../../../index');
 
-module.exports = async function () {
+module.exports = async () => {
   const appContext = await strapi.compile();
   const app = await strapi(appContext).register();
 

package/lib/commands/actions/services/list/command.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const { getLocalScript } = require('../../../utils/helpers');
+
+/**
+ * `$ strapi services:list`
+ * @param {import('../../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('services:list')
+    .description('List all the application services')
+    .action(getLocalScript('services/list'));
+};

package/lib/commands/{start.js → actions/start/action.js}

@@ -2,7 +2,7 @@
 
 const fs = require('fs');
 const tsUtils = require('@strapi/typescript-utils');
-const strapi = require('../index');
+const strapi = require('../../../index');
 
 /**
  * `$ strapi start`

package/lib/commands/actions/start/command.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const { getLocalScript } = require('../../utils/helpers');
+
+/**
+ * `$ strapi start`
+ * @param {import('../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('start')
+    .description('Start your Strapi application')
+    .action(getLocalScript('start'));
+};

package/lib/commands/{opt-out-telemetry.js → actions/telemetry/disable/action.js}

@@ -4,7 +4,7 @@ const { resolve } = require('path');
 const fse = require('fs-extra');
 const chalk = require('chalk');
 const fetch = require('node-fetch');
-const machineID = require('../utils/machine-id');
+const machineID = require('../../../../utils/machine-id');
 
 const readPackageJSON = async (path) => {
   try {

package/lib/commands/actions/telemetry/disable/command.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const { getLocalScript } = require('../../../utils/helpers');
+
+/**
+ * `$ strapi telemetry:disable`
+ * @param {import('../../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('telemetry:disable')
+    .description('Disable anonymous telemetry and metadata sending to Strapi analytics')
+    .action(getLocalScript('telemetry/disable'));
+};

package/lib/commands/{opt-in-telemetry.js → actions/telemetry/enable/action.js}

@@ -5,7 +5,7 @@ const fse = require('fs-extra');
 const chalk = require('chalk');
 const fetch = require('node-fetch');
 const { v4: uuidv4 } = require('uuid');
-const machineID = require('../utils/machine-id');
+const machineID = require('../../../../utils/machine-id');
 
 const readPackageJSON = async (path) => {
   try {

package/lib/commands/actions/telemetry/enable/command.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const { getLocalScript } = require('../../../utils/helpers');
+
+/**
+ * `$ strapi telemetry:enable`
+ * @param {import('../../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('telemetry:enable')
+    .description('Enable anonymous telemetry and metadata sending to Strapi analytics')
+    .action(getLocalScript('telemetry/enable'));
+};

package/lib/commands/actions/templates/generate/command.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const { getLocalScript } = require('../../../utils/helpers');
+
+/**
+ *`$ strapi templates:generate <directory>`
+ * @param {import('../../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('templates:generate <directory>')
+    .description('Generate template from Strapi project')
+    .action(getLocalScript('templates/generate'));
+};

package/lib/commands/{transfer/transfer.js → actions/transfer/action.js}

@@ -7,11 +7,11 @@ const {
       createRemoteStrapiDestinationProvider,
       createLocalStrapiSourceProvider,
       createLocalStrapiDestinationProvider,
+      createRemoteStrapiSourceProvider,
     },
   },
 } = require('@strapi/data-transfer');
 const { isObject } = require('lodash/fp');
-const chalk = require('chalk');
 
 const {
   buildTransferTable,
@@ -19,8 +19,11 @@ const {
   DEFAULT_IGNORED_CONTENT_TYPES,
   formatDiagnostic,
   loadersFactory,
-} = require('./utils');
-const { exitWith } = require('../utils/helpers');
+  exitMessageText,
+  abortTransfer,
+  getTransferTelemetryPayload,
+} = require('../../utils/data-transfer');
+const { exitWith } = require('../../utils/helpers');
 
 /**
  * @typedef TransferCommandOptions Options given to the CLI transfer command
@@ -29,6 +32,9 @@ const { exitWith } = require('../utils/helpers');
  * @property {URL|undefined} [from] The url of a remote Strapi to use as remote source
  * @property {string|undefined} [toToken] The transfer token for the remote Strapi destination
  * @property {string|undefined} [fromToken] The transfer token for the remote Strapi source
+ * @property {(keyof import('@strapi/data-transfer/src/engine').TransferGroupFilter)[]} [only] If present, only include these filtered groups of data
+ * @property {(keyof import('@strapi/data-transfer/src/engine').TransferGroupFilter)[]} [exclude] If present, exclude these filtered groups of data
+ * @property {number|undefined} [throttle] Delay in ms after each record
  */
 
 /**
@@ -44,15 +50,14 @@ module.exports = async (opts) => {
     exitWith(1, 'Could not parse command arguments');
   }
 
-  const strapi = await createStrapiInstance();
+  if (!(opts.from || opts.to) || (opts.from && opts.to)) {
+    exitWith(1, 'Exactly one source (from) or destination (to) option must be provided');
+  }
 
+  const strapi = await createStrapiInstance();
   let source;
   let destination;
 
-  if (!opts.from && !opts.to) {
-    exitWith(1, 'At least one source (from) or destination (to) option must be provided');
-  }
-
   // if no URL provided, use local Strapi
   if (!opts.from) {
     source = createLocalStrapiSourceProvider({
@@ -61,13 +66,28 @@ module.exports = async (opts) => {
   }
   // if URL provided, set up a remote source provider
   else {
-    exitWith(1, `Remote Strapi source provider not yet implemented`);
+    if (!opts.fromToken) {
+      exitWith(1, 'Missing token for remote destination');
+    }
+
+    source = createRemoteStrapiSourceProvider({
+      getStrapi: () => strapi,
+      url: opts.from,
+      auth: {
+        type: 'token',
+        token: opts.fromToken,
+      },
+    });
   }
 
   // if no URL provided, use local Strapi
   if (!opts.to) {
     destination = createLocalStrapiDestinationProvider({
       getStrapi: () => strapi,
+      strategy: 'restore',
+      restore: {
+        entities: { exclude: DEFAULT_IGNORED_CONTENT_TYPES },
+      },
     });
   }
   // if URL provided, set up a remote destination provider
@@ -96,6 +116,9 @@ module.exports = async (opts) => {
   const engine = createTransferEngine(source, destination, {
     versionStrategy: 'exact',
     schemaStrategy: 'strict',
+    exclude: opts.exclude,
+    only: opts.only,
+    throttle: opts.throttle,
     transforms: {
       links: [
         {
@@ -135,15 +158,39 @@ module.exports = async (opts) => {
     updateLoader(stage, data);
   });
 
+  progress.on('stage::error', ({ stage, data }) => {
+    updateLoader(stage, data).fail();
+  });
+
+  progress.on('transfer::start', async () => {
+    console.log(`Starting transfer...`);
+
+    await strapi.telemetry.send('didDEITSProcessStart', getTransferTelemetryPayload(engine));
+  });
+
   let results;
   try {
-    console.log(`Starting transfer...`);
+    // Abort transfer if user interrupts process
+    ['SIGTERM', 'SIGINT', 'SIGQUIT'].forEach((signal) => {
+      process.removeAllListeners(signal);
+      process.on(signal, () => abortTransfer({ engine, strapi }));
+    });
+
     results = await engine.transfer();
   } catch (e) {
-    exitWith(1, 'Transfer process failed.');
+    await strapi.telemetry.send('didDEITSProcessFail', getTransferTelemetryPayload(engine));
+    exitWith(1, exitMessageText('transfer', true));
+  }
+
+  // Note: we need to await telemetry or else the process ends before it is sent
+  await strapi.telemetry.send('didDEITSProcessFinish', getTransferTelemetryPayload(engine));
+
+  try {
+    const table = buildTransferTable(results.engine);
+    console.log(table.toString());
+  } catch (e) {
+    console.error('There was an error displaying the results of the transfer.');
   }
 
-  const table = buildTransferTable(results.engine);
-  console.log(table.toString());
-  exitWith(0, `${chalk.bold('Transfer process has been completed successfully!')}`);
+  exitWith(0, exitMessageText('transfer'));
 };