@strapi/strapi 4.10.0-beta.1 → 4.10.1-experimental.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/{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 {

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/__tests__/templates.generate.js

@@ -0,0 +1,118 @@
+'use strict';
+
+jest.mock('fs-extra', () => ({
+  ensureDir: jest.fn(() => Promise.resolve()),
+  copy: jest.fn(() => Promise.resolve()),
+  pathExists: jest.fn(() => Promise.resolve()),
+  writeJSON: jest.fn(() => Promise.resolve()),
+}));
+
+const { resolve, join } = require('path');
+const fse = require('fs-extra');
+const inquirer = require('inquirer');
+
+const exportTemplate = require('../action');
+
+describe('templates:generate command', () => {
+  beforeEach(() => {
+    jest.spyOn(console, 'log').mockImplementation(() => {});
+    jest.clearAllMocks();
+  });
+
+  it('creates a new template directory', async () => {
+    fse.pathExists.mockReturnValue(false);
+    const directory = '../test-dir';
+    const rootPath = resolve(directory);
+    const templatePath = join(rootPath, 'template');
+
+    await exportTemplate(directory);
+
+    expect(fse.pathExists).toHaveBeenCalledWith(templatePath);
+    expect(fse.ensureDir).toHaveBeenCalledWith(templatePath);
+  });
+
+  it.each(['src', 'data'])('copies folder %s', async (item) => {
+    // Mock the empty directory arg
+    fse.pathExists.mockReturnValueOnce(false);
+    // Mock the folder exists
+    fse.pathExists.mockReturnValue(true);
+    const directory = '../test-dir';
+    const rootPath = resolve(directory);
+    const templatePath = join(rootPath, 'template');
+
+    await exportTemplate(directory);
+
+    expect(fse.pathExists).toHaveBeenCalledWith(join(process.cwd(), item));
+    expect(fse.copy).toHaveBeenCalledWith(join(process.cwd(), item), join(templatePath, item));
+  });
+
+  it('creates a json config file', async () => {
+    fse.pathExists.mockReturnValue(false);
+    const directory = '../test-dir';
+    const rootPath = resolve(directory);
+
+    await exportTemplate(directory);
+
+    expect(fse.pathExists).toHaveBeenCalledWith(join(rootPath, 'template.json'));
+    expect(fse.writeJSON).toHaveBeenCalledWith(join(rootPath, 'template.json'), {});
+  });
+
+  describe('handles prompt input', () => {
+    it('replaces directory if confirmed', async () => {
+      fse.pathExists.mockReturnValue(true);
+      const mockInquiry = jest
+        .spyOn(inquirer, 'prompt')
+        .mockImplementationOnce(() => ({ confirm: true }));
+      const directory = '../test-dir';
+      const rootPath = resolve(directory);
+      const templatePath = join(rootPath, 'template');
+
+      await exportTemplate(directory);
+
+      expect(fse.pathExists).toHaveBeenCalledWith(templatePath);
+      expect(mockInquiry).toHaveBeenLastCalledWith(
+        expect.objectContaining({ message: expect.any(String), name: 'confirm', type: 'confirm' })
+      );
+      expect(fse.ensureDir).toHaveBeenCalled();
+      expect(fse.copy).toHaveBeenCalled();
+    });
+
+    it('does not replace existing config file', async () => {
+      fse.pathExists.mockReturnValue(true);
+      jest.spyOn(inquirer, 'prompt').mockImplementationOnce(() => ({ confirm: true }));
+      const directory = '../test-dir';
+      const rootPath = resolve(directory);
+
+      await exportTemplate(directory);
+      expect(fse.pathExists).toHaveBeenCalledWith(join(rootPath, 'template.json'));
+      expect(fse.writeJSON).not.toHaveBeenCalled();
+    });
+
+    it('exits if not confirmed', async () => {
+      fse.pathExists.mockReturnValue(true);
+      jest.spyOn(console, 'error').mockImplementation(() => {});
+      const mockInquiry = jest
+        .spyOn(inquirer, 'prompt')
+        .mockImplementationOnce(() => ({ confirm: false }));
+
+      const mockExit = jest.spyOn(process, 'exit').mockImplementation(() => {
+        throw new Error('exit');
+      });
+      const directory = '../test-dir';
+      const rootPath = resolve(directory);
+      const templatePath = join(rootPath, 'template');
+
+      await exportTemplate(directory).catch((err) => {
+        expect(err).toEqual(new Error('exit'));
+      });
+
+      expect(fse.pathExists).toHaveBeenCalledWith(templatePath);
+      expect(mockInquiry).toHaveBeenLastCalledWith(
+        expect.objectContaining({ message: expect.any(String), name: 'confirm', type: 'confirm' })
+      );
+      expect(mockExit).toHaveBeenCalledWith(0);
+      expect(fse.ensureDir).not.toHaveBeenCalled();
+      expect(fse.copy).not.toHaveBeenCalled();
+    });
+  });
+});

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'));
+};