@strapi/strapi 4.10.0-beta.0 → 4.10.0

package/lib/Strapi.js

@@ -27,6 +27,7 @@ const createCustomFields = require('./services/custom-fields');
 const createContentAPI = require('./services/content-api');
 const createUpdateNotifier = require('./utils/update-notifier');
 const createStartupLogger = require('./utils/startup-logger');
+const createStrapiFetch = require('./utils/fetch');
 const { LIFECYCLES } = require('./utils/lifecycles');
 const ee = require('./utils/ee');
 const contentTypesRegistry = require('./core/registries/content-types');
@@ -43,6 +44,7 @@ const apisRegistry = require('./core/registries/apis');
 const bootstrap = require('./core/bootstrap');
 const loaders = require('./core/loaders');
 const { destroyOnSignal } = require('./utils/signals');
+const getNumberOfDynamicZones = require('./services/utils/dynamic-zones');
 const sanitizersRegistry = require('./core/registries/sanitizers');
 const convertCustomFieldType = require('./utils/convert-custom-field-type');
 
@@ -117,6 +119,7 @@ class Strapi {
     this.telemetry = createTelemetry(this);
     this.requestContext = requestContext;
     this.customFields = createCustomFields(this);
+    this.fetch = createStrapiFetch(this);
 
     createUpdateNotifier(this).notify();
 
@@ -249,6 +252,9 @@ class Strapi {
       groupProperties: {
         database: strapi.config.get('database.connection.client'),
         plugins: Object.keys(strapi.plugins),
+        numberOfAllContentTypes: _.size(this.contentTypes), // TODO: V5: This event should be renamed numberOfContentTypes in V5 as the name is already taken to describe the number of content types using i18n.
+        numberOfComponents: _.size(this.components),
+        numberOfDynamicZones: getNumberOfDynamicZones(),
         // TODO: to add back
         // providers: this.config.installedProviders,
       },
@@ -389,6 +395,7 @@ class Strapi {
       eventHub: this.eventHub,
       logger: this.log,
       configuration: this.config.get('server.webhooks', {}),
+      fetch: this.fetch,
     });
 
     this.registerInternalHooks();
@@ -468,7 +475,7 @@ class Strapi {
     await this.startWebhooks();
 
     await this.server.initMiddlewares();
-    await this.server.initRouting();
+    this.server.initRouting();
 
     await this.contentAPI.permissions.registerActions();
 
@@ -536,17 +543,17 @@ class Strapi {
     // plugins
     await this.container.get('modules')[lifecycleName]();
 
-    // user
-    const userLifecycleFunction = this.app && this.app[lifecycleName];
-    if (isFunction(userLifecycleFunction)) {
-      await userLifecycleFunction({ strapi: this });
-    }
-
     // admin
     const adminLifecycleFunction = this.admin && this.admin[lifecycleName];
     if (isFunction(adminLifecycleFunction)) {
       await adminLifecycleFunction({ strapi: this });
     }
+
+    // user
+    const userLifecycleFunction = this.app && this.app[lifecycleName];
+    if (isFunction(userLifecycleFunction)) {
+      await userLifecycleFunction({ strapi: this });
+    }
   }
 
   getModel(uid) {

package/lib/commands/{admin-create.js → actions/admin/create-user/action.js}

@@ -3,7 +3,7 @@
 const { yup } = require('@strapi/utils');
 const _ = require('lodash');
 const inquirer = require('inquirer');
-const strapi = require('../index');
+const strapi = require('../../../../index');
 
 const emailValidator = yup.string().email('Invalid email address').lowercase();
 
@@ -57,7 +57,7 @@ const promptQuestions = [
  * @param {string} cmdOptions.firstname - new admin's first name
  * @param {string} [cmdOptions.lastname] - new admin's last name
  */
-module.exports = async function (cmdOptions = {}) {
+module.exports = async (cmdOptions = {}) => {
   let { email, password, firstname, lastname } = cmdOptions;
 
   if (

package/lib/commands/actions/admin/create-user/command.js

@@ -0,0 +1,19 @@
+'use strict';
+
+const { getLocalScript } = require('../../../utils/helpers');
+
+/**
+ * `$ strapi admin:create-user`
+ * @param {import('../../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('admin:create-user')
+    .alias('admin:create')
+    .description('Create a new admin')
+    .option('-e, --email <email>', 'Email of the new admin')
+    .option('-p, --password <password>', 'Password of the new admin')
+    .option('-f, --firstname <first name>', 'First name of the new admin')
+    .option('-l, --lastname <last name>', 'Last name of the new admin')
+    .action(getLocalScript('admin/create-user'));
+};

package/lib/commands/{admin-reset.js → actions/admin/reset-user-password/action.js}

@@ -2,7 +2,7 @@
 
 const _ = require('lodash');
 const inquirer = require('inquirer');
-const strapi = require('../index');
+const strapi = require('../../../../index');
 
 const promptQuestions = [
   { type: 'input', name: 'email', message: 'User email?' },
@@ -20,7 +20,7 @@ const promptQuestions = [
  * @param {string} cmdOptions.email - user's email
  * @param {string} cmdOptions.password - user's new password
  */
-module.exports = async function (cmdOptions = {}) {
+module.exports = async (cmdOptions = {}) => {
   const { email, password } = cmdOptions;
 
   if (_.isEmpty(email) && _.isEmpty(password) && process.stdin.isTTY) {

package/lib/commands/actions/admin/reset-user-password/command.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const { getLocalScript } = require('../../../utils/helpers');
+
+/**
+ * `$ strapi admin:reset-user-password`
+ * @param {import('../../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('admin:reset-user-password')
+    .alias('admin:reset-password')
+    .description("Reset an admin user's password")
+    .option('-e, --email <email>', 'The user email')
+    .option('-p, --password <password>', 'New password for the user')
+    .action(getLocalScript('admin/reset-user-password'));
+};

package/lib/commands/{configurationDump.js → actions/configuration/dump/action.js}

@@ -1,7 +1,7 @@
 'use strict';
 
 const fs = require('fs');
-const strapi = require('../index');
+const strapi = require('../../../../index');
 
 const CHUNK_SIZE = 100;
 

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

@@ -0,0 +1,17 @@
+'use strict';
+
+const { getLocalScript } = require('../../../utils/helpers');
+
+/**
+ * `$ strapi configuration:dump`
+ * @param {import('../../../../types/core/commands').AddCommandOptions} options
+ */
+module.exports = ({ command }) => {
+  command
+    .command('configuration:dump')
+    .alias('config:dump')
+    .description('Dump configurations of your application')
+    .option('-f, --file <file>', 'Output file, default output is stdout')
+    .option('-p, --pretty', 'Format the output JSON with indentation and line breaks', false)
+    .action(getLocalScript('configuration/dump'));
+};

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}

@@ -22,15 +22,22 @@ const {
   createStrapiInstance,
   formatDiagnostic,
   loadersFactory,
-} = require('./utils');
-const { exitWith } = require('../utils/helpers');
+  exitMessageText,
+  abortTransfer,
+  getTransferTelemetryPayload,
+} = require('../../utils/data-transfer');
+const { exitWith } = require('../../utils/helpers');
+
 /**
  * @typedef ExportCommandOptions Options given to the CLI import command
  *
- * @property {string} [file] The file path to import
+ * @property {string} [file] The file path to export to
  * @property {boolean} [encrypt] Used to encrypt the final archive
- * @property {string} [key] Encryption key, only useful when encryption is enabled
+ * @property {string} [key] Encryption key, used only when encryption is enabled
  * @property {boolean} [compress] Used to compress the final archive
+ * @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
  */
 
 const BYTES_IN_MB = 1024 * 1024;
@@ -58,6 +65,7 @@ module.exports = async (opts) => {
     schemaStrategy: 'ignore', // for an export to file, schemaStrategy will always be skipped
     exclude: opts.exclude,
     only: opts.only,
+    throttle: opts.throttle,
     transforms: {
       links: [
         {
@@ -97,23 +105,21 @@ module.exports = async (opts) => {
     updateLoader(stage, data);
   });
 
-  const getTelemetryPayload = (/* payload */) => {
-    return {
-      eventProperties: {
-        source: engine.sourceProvider.name,
-        destination: engine.destinationProvider.name,
-      },
-    };
-  };
-
   progress.on('transfer::start', async () => {
     console.log(`Starting export...`);
-    await strapi.telemetry.send('didDEITSProcessStart', getTelemetryPayload());
+
+    await strapi.telemetry.send('didDEITSProcessStart', getTransferTelemetryPayload(engine));
   });
 
   let results;
   let outFile;
   try {
+    // Abort transfer if user interrupts process
+    ['SIGTERM', 'SIGINT', 'SIGQUIT'].forEach((signal) => {
+      process.removeAllListeners(signal);
+      process.on(signal, () => abortTransfer({ engine, strapi }));
+    });
+
     results = await engine.transfer();
     outFile = results.destination.file.path;
     const outFileExists = await fs.pathExists(outFile);
@@ -121,11 +127,13 @@ module.exports = async (opts) => {
       throw new TransferEngineTransferError(`Export file not created "${outFile}"`);
     }
   } catch {
-    await strapi.telemetry.send('didDEITSProcessFail', getTelemetryPayload());
-    exitWith(1, 'Export process failed.');
+    await strapi.telemetry.send('didDEITSProcessFail', getTransferTelemetryPayload(engine));
+    exitWith(1, exitMessageText('export', true));
   }
 
-  await strapi.telemetry.send('didDEITSProcessFinish', getTelemetryPayload());
+  // 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());
@@ -133,8 +141,8 @@ module.exports = async (opts) => {
     console.error('There was an error displaying the results of the transfer.');
   }
 
-  console.log(`${chalk.bold('Export process has been completed successfully!')}`);
-  exitWith(0, `Export archive is in ${chalk.green(outFile)}`);
+  console.log(`Export archive is in ${chalk.green(outFile)}`);
+  exitWith(0, exitMessageText('export'));
 };
 
 /**

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}

@@ -18,13 +18,33 @@ const {
   createStrapiInstance,
   formatDiagnostic,
   loadersFactory,
-} = require('./utils');
-const { exitWith } = require('../utils/helpers');
+  exitMessageText,
+  abortTransfer,
+  getTransferTelemetryPayload,
+} = require('../../utils/data-transfer');
+const { exitWith } = require('../../utils/helpers');
 
 /**
- * @typedef {import('@strapi/data-transfer').ILocalFileSourceProviderOptions} ILocalFileSourceProviderOptions
+ * @typedef {import('@strapi/data-transfer/src/file/providers').ILocalFileSourceProviderOptions} ILocalFileSourceProviderOptions
  */
 
+/**
+ * @typedef ImportCommandOptions Options given to the CLI import command
+ *
+ * @property {string} [file] The file path to import
+ * @property {string} [key] Encryption key, used when encryption is enabled
+ * @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
+ */
+
+/**
+ * Import command.
+ *
+ * It transfers data from a file to a local Strapi instance
+ *
+ * @param {ImportCommandOptions} opts
+ */
 module.exports = async (opts) => {
   // validate inputs from Commander
   if (!isObject(opts)) {
@@ -63,6 +83,7 @@ module.exports = async (opts) => {
     schemaStrategy: opts.schemaStrategy || DEFAULT_SCHEMA_STRATEGY,
     exclude: opts.exclude,
     only: opts.only,
+    throttle: opts.throttle,
     rules: {
       links: [
         {
@@ -102,27 +123,26 @@ module.exports = async (opts) => {
     updateLoader(stage, data);
   });
 
-  const getTelemetryPayload = () => {
-    return {
-      eventProperties: {
-        source: engine.sourceProvider.name,
-        destination: engine.destinationProvider.name,
-      },
-    };
-  };
-
   progress.on('transfer::start', async () => {
     console.log('Starting import...');
-    await strapiInstance.telemetry.send('didDEITSProcessStart', getTelemetryPayload());
+    await strapiInstance.telemetry.send(
+      'didDEITSProcessStart',
+      getTransferTelemetryPayload(engine)
+    );
   });
 
   let results;
   try {
+    // 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) {
-    await strapiInstance.telemetry.send('didDEITSProcessFail', getTelemetryPayload());
-    console.error('Import process failed.');
-    process.exit(1);
+    await strapiInstance.telemetry.send('didDEITSProcessFail', getTransferTelemetryPayload(engine));
+    exitWith(1, exitMessageText('import', true));
   }
 
   try {
@@ -132,10 +152,11 @@ module.exports = async (opts) => {
     console.error('There was an error displaying the results of the transfer.');
   }
 
-  await strapiInstance.telemetry.send('didDEITSProcessFinish', getTelemetryPayload());
+  // Note: we need to await telemetry or else the process ends before it is sent
+  await strapiInstance.telemetry.send('didDEITSProcessFinish', getTransferTelemetryPayload(engine));
   await strapiInstance.destroy();
 
-  exitWith(0, 'Import process has been completed successfully!');
+  exitWith(0, exitMessageText('import'));
 };
 
 /**