@strapi/strapi 4.14.0-alpha.0 → 4.14.0

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

@@ -1,88 +0,0 @@
-'use strict';
-
-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 readPackageJSON = async (path) => {
-  try {
-    const packageObj = await fse.readJson(path);
-    const uuid = packageObj.strapi ? packageObj.strapi.uuid : null;
-
-    return { uuid, packageObj };
-  } catch (err) {
-    console.error(`${chalk.red('Error')}: ${err.message}`);
-  }
-};
-
-const writePackageJSON = async (path, file, spacing) => {
-  try {
-    await fse.writeJson(path, file, { spaces: spacing });
-    return true;
-  } catch (err) {
-    console.error(`${chalk.red('Error')}: ${err.message}`);
-  }
-};
-
-const sendEvent = async (uuid) => {
-  try {
-    const event = 'didOptOutTelemetry';
-
-    await fetch('https://analytics.strapi.io/api/v2/track', {
-      method: 'POST',
-      body: JSON.stringify({
-        event,
-        deviceId: machineID(),
-        groupProperties: { projectId: uuid },
-      }),
-      headers: {
-        'Content-Type': 'application/json',
-        'X-Strapi-Event': event,
-      },
-    });
-  } catch (e) {
-    // ...
-  }
-};
-
-module.exports = async function optOutTelemetry() {
-  const packageJSONPath = resolve(process.cwd(), 'package.json');
-  const exists = await fse.pathExists(packageJSONPath);
-
-  if (!exists) {
-    console.log(`${chalk.yellow('Warning')}: could not find package.json`);
-    process.exit(0);
-  }
-
-  const { uuid, packageObj } = await readPackageJSON(packageJSONPath);
-
-  if ((packageObj.strapi && packageObj.strapi.telemetryDisabled) || !uuid) {
-    console.log(`${chalk.yellow('Warning:')} telemetry is already disabled`);
-    process.exit(0);
-  }
-
-  const updatedPackageJSON = {
-    ...packageObj,
-    strapi: {
-      ...packageObj.strapi,
-      telemetryDisabled: true,
-    },
-  };
-
-  const write = await writePackageJSON(packageJSONPath, updatedPackageJSON, 2);
-
-  if (!write) {
-    console.log(
-      `${chalk.yellow(
-        'Warning'
-      )}: There has been an error, please set "telemetryDisabled": true in the "strapi" object of your package.json manually.`
-    );
-    process.exit(0);
-  }
-
-  await sendEvent(uuid);
-  console.log(`${chalk.green('Successfully opted out of Strapi telemetry')}`);
-  process.exit(0);
-};

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

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

@@ -1,104 +0,0 @@
-'use strict';
-
-const { resolve } = require('path');
-const { randomUUID } = require('crypto');
-const fse = require('fs-extra');
-const chalk = require('chalk');
-const fetch = require('node-fetch');
-const machineID = require('../../../../utils/machine-id');
-
-const readPackageJSON = async (path) => {
-  try {
-    const packageObj = await fse.readJson(path);
-    return packageObj;
-  } catch (err) {
-    console.error(`${chalk.red('Error')}: ${err.message}`);
-  }
-};
-
-const writePackageJSON = async (path, file, spacing) => {
-  try {
-    await fse.writeJson(path, file, { spaces: spacing });
-    return true;
-  } catch (err) {
-    console.error(`${chalk.red('Error')}: ${err.message}`);
-    console.log(
-      `${chalk.yellow(
-        'Warning'
-      )}: There has been an error, please set "telemetryDisabled": false in the "strapi" object of your package.json manually.`
-    );
-    return false;
-  }
-};
-
-const generateNewPackageJSON = (packageObj) => {
-  if (!packageObj.strapi) {
-    return {
-      ...packageObj,
-      strapi: {
-        uuid: randomUUID(),
-        telemetryDisabled: false,
-      },
-    };
-  }
-  return {
-    ...packageObj,
-    strapi: {
-      ...packageObj.strapi,
-      uuid: packageObj.strapi.uuid ? packageObj.strapi.uuid : randomUUID(),
-      telemetryDisabled: false,
-    },
-  };
-};
-
-const sendEvent = async (uuid) => {
-  try {
-    const event = 'didOptInTelemetry';
-
-    await fetch('https://analytics.strapi.io/api/v2/track', {
-      method: 'POST',
-      body: JSON.stringify({
-        event,
-        deviceId: machineID(),
-        groupProperties: { projectId: uuid },
-      }),
-      headers: {
-        'Content-Type': 'application/json',
-        'X-Strapi-Event': event,
-      },
-    });
-  } catch (e) {
-    // ...
-  }
-};
-
-module.exports = async function optInTelemetry() {
-  const packageJSONPath = resolve(process.cwd(), 'package.json');
-  const exists = await fse.pathExists(packageJSONPath);
-
-  if (!exists) {
-    console.log(`${chalk.yellow('Warning')}: could not find package.json`);
-    process.exit(0);
-  }
-
-  const packageObj = await readPackageJSON(packageJSONPath);
-
-  if (packageObj.strapi && packageObj.strapi.uuid) {
-    if (packageObj.strapi.telemetryDisabled === false) {
-      console.log(`${chalk.yellow('Warning:')} telemetry is already enabled`);
-      process.exit(0);
-    }
-  }
-
-  const updatedPackageJSON = generateNewPackageJSON(packageObj);
-
-  const write = await writePackageJSON(packageJSONPath, updatedPackageJSON, 2);
-
-  if (!write) {
-    process.exit(0);
-  }
-
-  await sendEvent(updatedPackageJSON.strapi.uuid);
-  console.log(`${chalk.green('Successfully opted into and enabled Strapi telemetry')}`);
-  process.exit(0);
-};

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

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

@@ -1,96 +0,0 @@
-'use strict';
-
-const { resolve, join, basename } = require('path');
-const fse = require('fs-extra');
-const chalk = require('chalk');
-const inquirer = require('inquirer');
-
-// All directories that a template could need
-const TEMPLATE_CONTENT = ['src', 'data'];
-
-/**
- *
- * @param {string} templatePath Absolute path to template directory
- * @param {string} rootBase Name of the root directory
- */
-async function copyContent(templatePath, rootBase) {
-  for (const item of TEMPLATE_CONTENT) {
-    try {
-      const pathToCopy = join(process.cwd(), item);
-
-      if (!(await fse.pathExists(pathToCopy))) {
-        continue;
-      }
-
-      await fse.copy(pathToCopy, join(templatePath, item));
-      const currentProjectBase = basename(process.cwd());
-      console.log(
-        `${chalk.green(
-          'success'
-        )}: copy ${currentProjectBase}/${item} => ${rootBase}/template/${item}`
-      );
-    } catch (error) {
-      console.error(`${chalk.red('error')}: ${error.message}`);
-    }
-  }
-}
-
-/**
- *
- * @param {string} rootPath Absolute path to the root directory
- */
-async function writeTemplateJson(rootPath) {
-  try {
-    await fse.writeJSON(join(rootPath, 'template.json'), {});
-    console.log(`${chalk.green('success')}: create JSON config file`);
-  } catch (error) {
-    console.error(`${chalk.red('error')}: ${error.message}`);
-  }
-}
-
-/**
- *
- * @param {string} rootPath Absolute path to the root directory
- * @returns boolean
- */
-async function templateConfigExists(rootPath) {
-  const configExists = await fse.pathExists(join(rootPath, 'template.json'));
-  console.log(`checking: ${join(rootPath, 'template.json')}. result ${configExists}`);
-  return configExists;
-}
-
-module.exports = async function generateTemplate(directory) {
-  const rootPath = resolve(directory);
-
-  // Get path to template directory: <rootPath>/template
-  const templatePath = join(rootPath, 'template');
-
-  // Check if the template directory exists
-  const exists = await fse.pathExists(templatePath);
-  const rootBase = basename(rootPath);
-
-  if (exists) {
-    // Confirm the user wants to replace the existing template
-    const inquiry = await inquirer.prompt({
-      type: 'confirm',
-      name: 'confirm',
-      message: `${chalk.yellow(rootBase)} already exists.  Do you want to replace it?`,
-    });
-
-    if (!inquiry.confirm) {
-      process.exit(0);
-    }
-  }
-
-  // Create or replace root directory with <roothPath>/template
-  await fse.ensureDir(templatePath);
-  // Copy content to /template
-  await copyContent(templatePath, rootBase);
-  // Create config file if it doesn't exist
-  const configExists = await templateConfigExists(rootPath);
-  if (!configExists) {
-    await writeTemplateJson(rootPath);
-  }
-
-  console.log(`${chalk.green('success')}: generated template at ${chalk.yellow(rootPath)}`);
-};

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

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

@@ -1,200 +0,0 @@
-'use strict';
-
-const {
-  engine: { createTransferEngine },
-  strapi: {
-    providers: {
-      createRemoteStrapiDestinationProvider,
-      createLocalStrapiSourceProvider,
-      createLocalStrapiDestinationProvider,
-      createRemoteStrapiSourceProvider,
-    },
-  },
-} = require('@strapi/data-transfer');
-const { isObject } = require('lodash/fp');
-
-const {
-  buildTransferTable,
-  createStrapiInstance,
-  DEFAULT_IGNORED_CONTENT_TYPES,
-  formatDiagnostic,
-  loadersFactory,
-  exitMessageText,
-  abortTransfer,
-  getTransferTelemetryPayload,
-  setSignalHandler,
-  getDiffHandler,
-  getAssetsBackupHandler,
-  parseRestoreFromOptions,
-} = require('../../utils/data-transfer');
-const { exitWith } = require('../../utils/helpers');
-
-/**
- * @typedef TransferCommandOptions Options given to the CLI transfer command
- *
- * @property {URL|undefined} [to] The url of a remote Strapi to use as remote destination
- * @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
- */
-
-/**
- * Transfer command.
- *
- * Transfers data between local Strapi and remote Strapi instances
- *
- * @param {TransferCommandOptions} opts
- */
-module.exports = async (opts) => {
-  // Validate inputs from Commander
-  if (!isObject(opts)) {
-    exitWith(1, 'Could not parse command arguments');
-  }
-
-  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 no URL provided, use local Strapi
-  if (!opts.from) {
-    source = createLocalStrapiSourceProvider({
-      getStrapi: () => strapi,
-    });
-  }
-  // if URL provided, set up a remote source provider
-  else {
-    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: parseRestoreFromOptions(opts),
-    });
-  }
-  // if URL provided, set up a remote destination provider
-  else {
-    if (!opts.toToken) {
-      exitWith(1, 'Missing token for remote destination');
-    }
-
-    destination = createRemoteStrapiDestinationProvider({
-      url: opts.to,
-      auth: {
-        type: 'token',
-        token: opts.toToken,
-      },
-      strategy: 'restore',
-      restore: parseRestoreFromOptions(opts),
-    });
-  }
-
-  if (!source || !destination) {
-    exitWith(1, 'Could not create providers');
-  }
-
-  const engine = createTransferEngine(source, destination, {
-    versionStrategy: 'exact',
-    schemaStrategy: 'strict',
-    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('transfer'));
-
-  const progress = engine.progress.stream;
-
-  const { updateLoader } = loadersFactory();
-
-  engine.onSchemaDiff(getDiffHandler(engine, { force: opts.force, action: 'transfer' }));
-
-  engine.addErrorHandler(
-    'ASSETS_DIRECTORY_ERR',
-    getAssetsBackupHandler(engine, { force: opts.force, action: 'transfer' })
-  );
-
-  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('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 {
-    // Abort transfer if user interrupts process
-    setSignalHandler(() => abortTransfer({ engine, strapi }));
-
-    results = await engine.transfer();
-  } catch (e) {
-    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.');
-  }
-
-  exitWith(0, exitMessageText('transfer'));
-};

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

@@ -1,115 +0,0 @@
-'use strict';
-
-const inquirer = require('inquirer');
-const { Option } = require('commander');
-const { getCommanderConfirmMessage, forceOption, parseURL } = require('../../utils/commander');
-const {
-  getLocalScript,
-  exitWith,
-  assertUrlHasProtocol,
-  ifOptions,
-} = require('../../utils/helpers');
-const {
-  excludeOption,
-  onlyOption,
-  throttleOption,
-  validateExcludeOnly,
-} = require('../../utils/data-transfer');
-
-/**
- * `$ strapi transfer`
- * @param {import('../../../types/core/commands').AddCommandOptions} options
- */
-module.exports = ({ command }) => {
-  command
-    .command('transfer')
-    .description('Transfer data from one source to another')
-    .allowExcessArguments(false)
-    .addOption(
-      new Option(
-        '--from <sourceURL>',
-        `URL of the remote Strapi instance to get data from`
-      ).argParser(parseURL)
-    )
-    .addOption(new Option('--from-token <token>', `Transfer token for the remote Strapi source`))
-    .addOption(
-      new Option(
-        '--to <destinationURL>',
-        `URL of the remote Strapi instance to send data to`
-      ).argParser(parseURL)
-    )
-    .addOption(new Option('--to-token <token>', `Transfer token for the remote Strapi destination`))
-    .addOption(forceOption)
-    .addOption(excludeOption)
-    .addOption(onlyOption)
-    .addOption(throttleOption)
-    .hook('preAction', validateExcludeOnly)
-    .hook(
-      'preAction',
-      ifOptions(
-        (opts) => !(opts.from || opts.to) || (opts.from && opts.to),
-        () =>
-          exitWith(
-            1,
-            'Exactly one remote source (from) or destination (to) option must be provided'
-          )
-      )
-    )
-    // If --from is used, validate the URL and token
-    .hook(
-      'preAction',
-      ifOptions(
-        (opts) => opts.from,
-        async (thisCommand) => {
-          assertUrlHasProtocol(thisCommand.opts().from, ['https:', 'http:']);
-          if (!thisCommand.opts().fromToken) {
-            const answers = await inquirer.prompt([
-              {
-                type: 'password',
-                message: 'Please enter your transfer token for the remote Strapi source',
-                name: 'fromToken',
-              },
-            ]);
-            if (!answers.fromToken?.length) {
-              exitWith(1, 'No token provided for remote source, aborting transfer.');
-            }
-            thisCommand.opts().fromToken = answers.fromToken;
-          }
-
-          await getCommanderConfirmMessage(
-            'The transfer will delete all the local Strapi assets and its database. Are you sure you want to proceed?',
-            { failMessage: 'Transfer process aborted' }
-          )(thisCommand);
-        }
-      )
-    )
-    // If --to is used, validate the URL, token, and confirm restore
-    .hook(
-      'preAction',
-      ifOptions(
-        (opts) => opts.to,
-        async (thisCommand) => {
-          assertUrlHasProtocol(thisCommand.opts().to, ['https:', 'http:']);
-          if (!thisCommand.opts().toToken) {
-            const answers = await inquirer.prompt([
-              {
-                type: 'password',
-                message: 'Please enter your transfer token for the remote Strapi destination',
-                name: 'toToken',
-              },
-            ]);
-            if (!answers.toToken?.length) {
-              exitWith(1, 'No token provided for remote destination, aborting transfer.');
-            }
-            thisCommand.opts().toToken = answers.toToken;
-          }
-
-          await getCommanderConfirmMessage(
-            'The transfer will delete existing data from the remote Strapi! Are you sure you want to proceed?',
-            { failMessage: 'Transfer process aborted' }
-          )(thisCommand);
-        }
-      )
-    )
-    .action(getLocalScript('transfer'));
-};

package/lib/commands/actions/ts/generate-types/action.js

@@ -1,29 +0,0 @@
-'use strict';
-
-const tsUtils = require('@strapi/typescript-utils');
-
-const strapi = require('../../../../index');
-
-module.exports = async ({ debug, silent, verbose, outDir }) => {
-  if ((debug || verbose) && silent) {
-    console.error('Flags conflict: both silent and debug mode are enabled, exiting...');
-    process.exit(1);
-  }
-
-  const appContext = await strapi.compile();
-  const app = await strapi(appContext).register();
-
-  await tsUtils.generators.generate({
-    strapi: app,
-    pwd: appContext.appDir,
-    rootDir: outDir ?? undefined,
-    logger: {
-      silent,
-      // TODO V5: verbose is deprecated and should be removed
-      debug: debug || verbose,
-    },
-    artifacts: { contentTypes: true, components: true },
-  });
-
-  app.destroy();
-};

package/lib/commands/actions/ts/generate-types/command.js

@@ -1,21 +0,0 @@
-'use strict';
-
-const { getLocalScript } = require('../../../utils/helpers');
-
-/**
- * `$ strapi ts:generate-types`
- * @param {import('../../../../types/core/commands').AddCommandOptions} options
- */
-module.exports = ({ command }) => {
-  command
-    .command('ts:generate-types')
-    .description(`Generate TypeScript typings for your schemas`)
-    .option('--verbose', `[DEPRECATED] The verbose option has been replaced by debug`, false)
-    .option('-d, --debug', `Run the generation with debug messages`, false)
-    .option('-s, --silent', `Run the generation silently, without any output`, false)
-    .option(
-      '-o, --out-dir <outDir>',
-      'Specify a relative root directory in which the definitions will be generated. Changing this value might break types exposed by Strapi that relies on generated types.'
-    )
-    .action(getLocalScript('ts/generate-types'));
-};