@strapi/strapi 4.10.0-beta.1 → 4.10.0

package/lib/commands/{configurationRestore.js → actions/configuration/restore/action.js}

@@ -3,7 +3,7 @@
 const fs = require('fs');
 const _ = require('lodash');
 
-const strapi = require('../index');
+const strapi = require('../../../../index');
 
 /**
  * Will restore configurations. It reads from a file or stdin

package/lib/commands/actions/configuration/restore/command.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const { getLocalScript } = require('../../../utils/helpers');
+
+/**
+ * `$ strapi configuration:restore`
+ * @param {import('../../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('configuration:restore')
+    .alias('config:restore')
+    .description('Restore configurations of your application')
+    .option('-f, --file <file>', 'Input file, default input is stdin')
+    .option('-s, --strategy <strategy>', 'Strategy name, one of: "replace", "merge", "keep"')
+    .action(getLocalScript('configuration/restore'));
+};

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

@@ -2,7 +2,7 @@
 
 const REPL = require('repl');
 
-const strapi = require('../index');
+const strapi = require('../../../index');
 
 /**
  * `$ strapi console`
@@ -14,7 +14,7 @@ module.exports = async () => {
   app.start().then(() => {
     const repl = REPL.start(app.config.info.name + ' > ' || 'strapi > '); // eslint-disable-line prefer-template
 
-    repl.on('exit', function (err) {
+    repl.on('exit', (err) => {
       if (err) {
         app.log.error(err);
         process.exit(1);

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

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

package/lib/commands/{content-types/list.js → actions/content-types/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/content-types/list/command.js

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

package/lib/commands/{controllers/list.js → actions/controllers/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/controllers/list/command.js

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

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

@@ -9,9 +9,9 @@ const { getOr } = require('lodash/fp');
 const { joinBy } = require('@strapi/utils');
 const tsUtils = require('@strapi/typescript-utils');
 
-const loadConfiguration = require('../core/app-configuration');
-const strapi = require('../index');
-const { buildTypeScript, buildAdmin } = require('./builders');
+const loadConfiguration = require('../../../core/app-configuration');
+const strapi = require('../../../index');
+const { buildTypeScript, buildAdmin } = require('../../builders');
 
 /**
  * `$ strapi develop`

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

@@ -0,0 +1,19 @@
+'use strict';
+
+const { getLocalScript } = require('../../utils/helpers');
+
+/**
+ * `$ strapi develop`
+ * @param {import('../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('develop')
+    .alias('dev')
+    .option('--no-build', 'Disable build')
+    .option('--watch-admin', 'Enable watch', false)
+    .option('--polling', 'Watch for file changes in network directories', false)
+    .option('--browser <name>', 'Open the browser', true)
+    .description('Start your Strapi application in development mode')
+    .action(getLocalScript('develop'));
+};

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

@@ -25,8 +25,9 @@ const {
   exitMessageText,
   abortTransfer,
   getTransferTelemetryPayload,
-} = require('./utils');
-const { exitWith } = require('../utils/helpers');
+} = require('../../utils/data-transfer');
+const { exitWith } = require('../../utils/helpers');
+
 /**
  * @typedef ExportCommandOptions Options given to the CLI import command
  *

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

@@ -0,0 +1,45 @@
+'use strict';
+
+const { Option } = require('commander');
+const {
+  excludeOption,
+  onlyOption,
+  throttleOption,
+  validateExcludeOnly,
+} = require('../../utils/data-transfer');
+const { promptEncryptionKey } = require('../../utils/commander');
+const { getLocalScript } = require('../../utils/helpers');
+
+/**
+ * `$ strapi export`
+ * @param {import('../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('export')
+    .description('Export data from Strapi to file')
+    .allowExcessArguments(false)
+    .addOption(
+      new Option('--no-encrypt', `Disables 'aes-128-ecb' encryption of the output file`).default(
+        true
+      )
+    )
+    .addOption(
+      new Option('--no-compress', 'Disables gzip compression of output file').default(true)
+    )
+    .addOption(
+      new Option(
+        '-k, --key <string>',
+        'Provide encryption key in command instead of using the prompt'
+      )
+    )
+    .addOption(
+      new Option('-f, --file <file>', 'name to use for exported file (without extensions)')
+    )
+    .addOption(excludeOption)
+    .addOption(onlyOption)
+    .addOption(throttleOption)
+    .hook('preAction', validateExcludeOnly)
+    .hook('preAction', promptEncryptionKey)
+    .action(getLocalScript('export'));
+};

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

@@ -0,0 +1,18 @@
+'use strict';
+
+const { assertCwdContainsStrapiProject } = require('../../utils/helpers');
+
+/**
+ * `$ strapi generate`
+ * @param {import('../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command, argv }) => {
+  command
+    .command('generate')
+    .description('Launch the interactive API generator')
+    .action(() => {
+      assertCwdContainsStrapiProject('generate');
+      argv.splice(2, 1);
+      require('@strapi/generators').runCLI();
+    });
+};

package/lib/commands/{hooks/list.js → actions/hooks/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/hooks/list/command.js

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

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

@@ -21,8 +21,8 @@ const {
   exitMessageText,
   abortTransfer,
   getTransferTelemetryPayload,
-} = require('./utils');
-const { exitWith } = require('../utils/helpers');
+} = require('../../utils/data-transfer');
+const { exitWith } = require('../../utils/helpers');
 
 /**
  * @typedef {import('@strapi/data-transfer/src/file/providers').ILocalFileSourceProviderOptions} ILocalFileSourceProviderOptions

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/{report.js → actions/report/action.js}

@@ -1,7 +1,7 @@
 'use strict';
 
 const { EOL } = require('os');
-const strapi = require('../index');
+const strapi = require('../../../index');
 
 module.exports = async ({ uuid, dependencies, all }) => {
   const config = {

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 {