@strapi/strapi 4.14.0-beta.0 → 4.15.0-alpha.0

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

@@ -1,217 +0,0 @@
-'use strict';
-
-const path = require('path');
-const cluster = require('cluster');
-const fs = require('fs-extra');
-const chokidar = require('chokidar');
-const execa = require('execa');
-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');
-
-/**
- * `$ strapi develop`
- *
- */
-
-module.exports = async ({ build, watchAdmin, polling, browser }) => {
-  const appDir = process.cwd();
-
-  const isTSProject = await tsUtils.isUsingTypeScript(appDir);
-  const outDir = await tsUtils.resolveOutDir(appDir);
-  const distDir = isTSProject ? outDir : appDir;
-
-  try {
-    if (cluster.isMaster || cluster.isPrimary) {
-      return primaryProcess({
-        distDir,
-        appDir,
-        build,
-        browser,
-        isTSProject,
-        watchAdmin,
-      });
-    }
-
-    if (cluster.isWorker) {
-      return workerProcess({ appDir, distDir, watchAdmin, polling, isTSProject });
-    }
-  } catch (e) {
-    console.error(e);
-    process.exit(1);
-  }
-};
-
-const primaryProcess = async ({ distDir, appDir, build, isTSProject, watchAdmin, browser }) => {
-  if (isTSProject) {
-    await buildTypeScript({ srcDir: appDir, distDir, watch: false });
-  }
-
-  const config = loadConfiguration({ appDir, distDir });
-  const serveAdminPanel = getOr(true, 'admin.serveAdminPanel')(config);
-
-  const buildExists = fs.existsSync(path.join(distDir, 'build'));
-
-  // Don't run the build process if the admin is in watch mode
-  if (build && !watchAdmin && serveAdminPanel && !buildExists) {
-    try {
-      await buildAdmin({
-        buildDestDir: distDir,
-        forceBuild: false,
-        optimization: false,
-        srcDir: appDir,
-      });
-    } catch (err) {
-      process.exit(1);
-    }
-  }
-
-  if (watchAdmin) {
-    try {
-      execa('npm', ['run', '-s', 'strapi', 'watch-admin', '--', '--browser', browser], {
-        stdio: 'inherit',
-      });
-    } catch (err) {
-      process.exit(1);
-    }
-  }
-
-  cluster.on('message', async (worker, message) => {
-    switch (message) {
-      case 'reload':
-        if (isTSProject) {
-          await buildTypeScript({ srcDir: appDir, distDir, watch: false });
-        }
-
-        console.info('The server is restarting\n');
-
-        worker.send('kill');
-        break;
-      case 'killed':
-        cluster.fork();
-        break;
-      case 'stop':
-        process.exit(1);
-        break;
-      default: {
-        break;
-      }
-    }
-  });
-
-  cluster.fork();
-};
-
-const workerProcess = async ({ appDir, distDir, watchAdmin, polling, isTSProject }) => {
-  const strapiInstance = await strapi({
-    distDir,
-    autoReload: true,
-    serveAdminPanel: !watchAdmin,
-  }).load();
-
-  /**
-   * TypeScript automatic type generation upon dev server restart
-   * Its implementation, configuration and behavior can change in future releases
-   * @experimental
-   */
-  const shouldGenerateTypeScriptTypes = strapiInstance.config.get('typescript.autogenerate', false);
-
-  if (shouldGenerateTypeScriptTypes) {
-    await tsUtils.generators.generate({
-      strapi: strapiInstance,
-      pwd: appDir,
-      rootDir: undefined,
-      logger: { silent: true, debug: false },
-      artifacts: { contentTypes: true, components: true },
-    });
-  }
-
-  const adminWatchIgnoreFiles = strapiInstance.config.get('admin.watchIgnoreFiles', []);
-  watchFileChanges({
-    appDir,
-    strapiInstance,
-    watchIgnoreFiles: adminWatchIgnoreFiles,
-    polling,
-    isTSProject,
-  });
-
-  process.on('message', async (message) => {
-    switch (message) {
-      case 'kill': {
-        await strapiInstance.destroy();
-        process.send('killed');
-        process.exit();
-        break;
-      }
-      default: {
-        break;
-      }
-      // Do nothing.
-    }
-  });
-
-  return strapiInstance.start();
-};
-
-/**
- * Init file watching to auto restart strapi app
- * @param {Object} options - Options object
- * @param {string} options.appDir - This is the path where the app is located, the watcher will watch the files under this folder
- * @param {Strapi} options.strapi - Strapi instance
- * @param {array} options.watchIgnoreFiles - Array of custom file paths that should not be watched
- */
-function watchFileChanges({ appDir, strapiInstance, watchIgnoreFiles, polling }) {
-  const restart = async () => {
-    if (strapiInstance.reload.isWatching && !strapiInstance.reload.isReloading) {
-      strapiInstance.reload.isReloading = true;
-      strapiInstance.reload();
-    }
-  };
-
-  const watcher = chokidar.watch(appDir, {
-    ignoreInitial: true,
-    usePolling: polling,
-    ignored: [
-      /(^|[/\\])\../, // dot files
-      /tmp/,
-      '**/src/admin/**',
-      '**/src/plugins/**/admin/**',
-      '**/dist/src/plugins/test/admin/**',
-      '**/documentation',
-      '**/documentation/**',
-      '**/node_modules',
-      '**/node_modules/**',
-      '**/plugins.json',
-      '**/build',
-      '**/build/**',
-      '**/index.html',
-      '**/public',
-      '**/public/**',
-      strapiInstance.dirs.static.public,
-      joinBy('/', strapiInstance.dirs.static.public, '**'),
-      '**/*.db*',
-      '**/exports/**',
-      '**/dist/**',
-      '**/*.d.ts',
-      ...watchIgnoreFiles,
-    ],
-  });
-
-  watcher
-    .on('add', (path) => {
-      strapiInstance.log.info(`File created: ${path}`);
-      restart();
-    })
-    .on('change', (path) => {
-      strapiInstance.log.info(`File changed: ${path}`);
-      restart();
-    })
-    .on('unlink', (path) => {
-      strapiInstance.log.info(`File deleted: ${path}`);
-      restart();
-    });
-}

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

@@ -1,19 +0,0 @@
-'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/actions/export/action.js

@@ -1,184 +0,0 @@
-'use strict';
-
-const {
-  file: {
-    providers: { createLocalFileDestinationProvider },
-  },
-  strapi: {
-    providers: { createLocalStrapiSourceProvider },
-  },
-  engine: { createTransferEngine },
-} = require('@strapi/data-transfer');
-
-const { isObject, isString, isFinite, toNumber } = require('lodash/fp');
-const fs = require('fs-extra');
-const chalk = require('chalk');
-
-const { TransferEngineTransferError } = require('@strapi/data-transfer').engine.errors;
-const {
-  getDefaultExportName,
-  buildTransferTable,
-  DEFAULT_IGNORED_CONTENT_TYPES,
-  createStrapiInstance,
-  formatDiagnostic,
-  loadersFactory,
-  exitMessageText,
-  abortTransfer,
-  getTransferTelemetryPayload,
-  setSignalHandler,
-} = 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 export to
- * @property {boolean} [encrypt] Used to encrypt the final archive
- * @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;
-
-/**
- * Export command.
- *
- * It transfers data from a local Strapi instance to a file
- *
- * @param {ExportCommandOptions} opts
- */
-module.exports = async (opts) => {
-  // Validate inputs from Commander
-  if (!isObject(opts)) {
-    exitWith(1, 'Could not parse command arguments');
-  }
-
-  const strapi = await createStrapiInstance();
-
-  const source = createSourceProvider(strapi);
-  const destination = createDestinationProvider(opts);
-
-  const engine = createTransferEngine(source, destination, {
-    versionStrategy: 'ignore', // for an export to file, versionStrategy will always be skipped
-    schemaStrategy: 'ignore', // for an export to file, schemaStrategy will always be skipped
-    exclude: opts.exclude,
-    only: opts.only,
-    throttle: opts.throttle,
-    transforms: {
-      links: [
-        {
-          filter(link) {
-            return (
-              !DEFAULT_IGNORED_CONTENT_TYPES.includes(link.left.type) &&
-              !DEFAULT_IGNORED_CONTENT_TYPES.includes(link.right.type)
-            );
-          },
-        },
-      ],
-      entities: [
-        {
-          filter(entity) {
-            return !DEFAULT_IGNORED_CONTENT_TYPES.includes(entity.type);
-          },
-        },
-      ],
-    },
-  });
-
-  engine.diagnostics.onDiagnostic(formatDiagnostic('export'));
-
-  const progress = engine.progress.stream;
-
-  const { updateLoader } = loadersFactory();
-
-  progress.on(`stage::start`, ({ stage, data }) => {
-    updateLoader(stage, data).start();
-  });
-
-  progress.on('stage::finish', ({ stage, data }) => {
-    updateLoader(stage, data).succeed();
-  });
-
-  progress.on('stage::progress', ({ stage, data }) => {
-    updateLoader(stage, data);
-  });
-
-  progress.on('transfer::start', async () => {
-    console.log(`Starting export...`);
-
-    await strapi.telemetry.send('didDEITSProcessStart', getTransferTelemetryPayload(engine));
-  });
-
-  let results;
-  let outFile;
-  try {
-    // Abort transfer if user interrupts process
-    setSignalHandler(() => abortTransfer({ engine, strapi }));
-
-    results = await engine.transfer();
-    outFile = results.destination.file.path;
-    const outFileExists = await fs.pathExists(outFile);
-    if (!outFileExists) {
-      throw new TransferEngineTransferError(`Export file not created "${outFile}"`);
-    }
-  } catch {
-    await strapi.telemetry.send('didDEITSProcessFail', getTransferTelemetryPayload(engine));
-    exitWith(1, exitMessageText('export', 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.');
-  }
-
-  console.log(`Export archive is in ${chalk.green(outFile)}`);
-  exitWith(0, exitMessageText('export'));
-};
-
-/**
- * It creates a local strapi destination provider
- */
-const createSourceProvider = (strapi) => {
-  return createLocalStrapiSourceProvider({
-    async getStrapi() {
-      return strapi;
-    },
-  });
-};
-
-/**
- * It creates a local file destination provider based on the given options
- *
- * @param {ExportCommandOptions} opts
- */
-const createDestinationProvider = (opts) => {
-  const { file, compress, encrypt, key, maxSizeJsonl } = opts;
-
-  const filepath = isString(file) && file.length > 0 ? file : getDefaultExportName();
-
-  const maxSizeJsonlInMb = isFinite(toNumber(maxSizeJsonl))
-    ? toNumber(maxSizeJsonl) * BYTES_IN_MB
-    : undefined;
-
-  return createLocalFileDestinationProvider({
-    file: {
-      path: filepath,
-      maxSizeJsonl: maxSizeJsonlInMb,
-    },
-    encryption: {
-      enabled: encrypt,
-      key: encrypt ? key : undefined,
-    },
-    compression: {
-      enabled: compress,
-    },
-  });
-};

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

@@ -1,45 +0,0 @@
-'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

@@ -1,18 +0,0 @@
-'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/actions/hooks/list/action.js

@@ -1,23 +0,0 @@
-'use strict';
-
-const CLITable = require('cli-table3');
-const chalk = require('chalk');
-
-const strapi = require('../../../../index');
-
-module.exports = async () => {
-  const appContext = await strapi.compile();
-  const app = await strapi(appContext).register();
-
-  const list = app.container.get('hooks').keys();
-
-  const infoTable = new CLITable({
-    head: [chalk.blue('Name')],
-  });
-
-  list.forEach((name) => infoTable.push([name]));
-
-  console.log(infoTable.toString());
-
-  await app.destroy();
-};

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

@@ -1,14 +0,0 @@
-'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/actions/import/action.js

@@ -1,181 +0,0 @@
-'use strict';
-
-const {
-  file: {
-    providers: { createLocalFileSourceProvider },
-  },
-  strapi: {
-    providers: { createLocalStrapiDestinationProvider, DEFAULT_CONFLICT_STRATEGY },
-  },
-  engine: { createTransferEngine, DEFAULT_VERSION_STRATEGY, DEFAULT_SCHEMA_STRATEGY },
-} = require('@strapi/data-transfer');
-
-const { isObject } = require('lodash/fp');
-
-const {
-  buildTransferTable,
-  DEFAULT_IGNORED_CONTENT_TYPES,
-  createStrapiInstance,
-  formatDiagnostic,
-  loadersFactory,
-  exitMessageText,
-  abortTransfer,
-  getTransferTelemetryPayload,
-  setSignalHandler,
-  getDiffHandler,
-  parseRestoreFromOptions,
-} = require('../../utils/data-transfer');
-const { exitWith } = require('../../utils/helpers');
-
-/**
- * @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)) {
-    exitWith(1, 'Could not parse arguments');
-  }
-
-  /**
-   * From strapi backup file
-   */
-  const sourceOptions = getLocalFileSourceOptions(opts);
-
-  const source = createLocalFileSourceProvider(sourceOptions);
-
-  /**
-   * To local Strapi instance
-   */
-  const strapiInstance = await createStrapiInstance();
-
-  const destinationOptions = {
-    async getStrapi() {
-      return strapiInstance;
-    },
-    autoDestroy: false,
-    strategy: opts.conflictStrategy || DEFAULT_CONFLICT_STRATEGY,
-    restore: parseRestoreFromOptions(opts),
-  };
-
-  const destination = createLocalStrapiDestinationProvider(destinationOptions);
-
-  /**
-   * Configure and run the transfer engine
-   */
-  const engineOptions = {
-    versionStrategy: opts.versionStrategy || DEFAULT_VERSION_STRATEGY,
-    schemaStrategy: opts.schemaStrategy || DEFAULT_SCHEMA_STRATEGY,
-    exclude: opts.exclude,
-    only: opts.only,
-    throttle: opts.throttle,
-    transforms: {
-      links: [
-        {
-          filter(link) {
-            return (
-              !DEFAULT_IGNORED_CONTENT_TYPES.includes(link.left.type) &&
-              !DEFAULT_IGNORED_CONTENT_TYPES.includes(link.right.type)
-            );
-          },
-        },
-      ],
-      entities: [
-        {
-          filter: (entity) => !DEFAULT_IGNORED_CONTENT_TYPES.includes(entity.type),
-        },
-      ],
-    },
-  };
-
-  const engine = createTransferEngine(source, destination, engineOptions);
-
-  engine.diagnostics.onDiagnostic(formatDiagnostic('import'));
-
-  const progress = engine.progress.stream;
-
-  const { updateLoader } = loadersFactory();
-
-  engine.onSchemaDiff(getDiffHandler(engine, { force: opts.force, action: 'import' }));
-
-  progress.on(`stage::start`, ({ stage, data }) => {
-    updateLoader(stage, data).start();
-  });
-
-  progress.on('stage::finish', ({ stage, data }) => {
-    updateLoader(stage, data).succeed();
-  });
-
-  progress.on('stage::progress', ({ stage, data }) => {
-    updateLoader(stage, data);
-  });
-
-  progress.on('transfer::start', async () => {
-    console.log('Starting import...');
-    await strapiInstance.telemetry.send(
-      'didDEITSProcessStart',
-      getTransferTelemetryPayload(engine)
-    );
-  });
-
-  let results;
-  try {
-    // Abort transfer if user interrupts process
-    setSignalHandler(() => abortTransfer({ engine, strapi }));
-
-    results = await engine.transfer();
-  } catch (e) {
-    await strapiInstance.telemetry.send('didDEITSProcessFail', getTransferTelemetryPayload(engine));
-    exitWith(1, exitMessageText('import', true));
-  }
-
-  try {
-    const table = buildTransferTable(results.engine);
-    console.log(table.toString());
-  } catch (e) {
-    console.error('There was an error displaying the results of the transfer.');
-  }
-
-  // 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, exitMessageText('import'));
-};
-
-/**
- * Infer local file source provider options based on a given filename
- *
- * @param {{ file: string; key?: string }} opts
- *
- * @return {ILocalFileSourceProviderOptions}
- */
-const getLocalFileSourceOptions = (opts) => {
-  /**
-   * @type {ILocalFileSourceProviderOptions}
-   */
-  const options = {
-    file: { path: opts.file },
-    compression: { enabled: !!opts.decompress },
-    encryption: { enabled: !!opts.decrypt, key: opts.key },
-  };
-
-  return options;
-};