@strapi/strapi 5.12.0 → 5.12.2

package/dist/src/cli/utils/commander.js

@@ -0,0 +1,125 @@
+'use strict';
+
+var inquirer = require('inquirer');
+var commander = require('commander');
+var chalk = require('chalk');
+var fp = require('lodash/fp');
+var helpers = require('./helpers.js');
+
+/**
+ * argParser: Parse a comma-delimited string as an array
+ */ const parseList = (value)=>{
+    try {
+        return value.split(',').map((item)=>item.trim()); // trim shouldn't be necessary but might help catch unexpected whitespace characters
+    } catch (e) {
+        helpers.exitWith(1, `Unrecognized input: ${value}`);
+    }
+    return [];
+};
+/**
+ * Returns an argParser that returns a list
+ */ const getParseListWithChoices = (choices, errorMessage = 'Invalid options:')=>{
+    return (value)=>{
+        const list = parseList(value);
+        const invalid = list.filter((item)=>{
+            return !choices.includes(item);
+        });
+        if (invalid.length > 0) {
+            helpers.exitWith(1, `${errorMessage}: ${invalid.join(',')}`);
+        }
+        return list;
+    };
+};
+/**
+ * argParser: Parse a string as an integer
+ */ const parseInteger = (value)=>{
+    // parseInt takes a string and a radix
+    const parsedValue = parseInt(value, 10);
+    if (fp.isNaN(parsedValue)) {
+        throw new commander.InvalidOptionArgumentError(`Not an integer: ${value}`);
+    }
+    return parsedValue;
+};
+/**
+ * argParser: Parse a string as a URL object
+ */ const parseURL = (value)=>{
+    try {
+        const url = new URL(value);
+        if (!url.host) {
+            throw new commander.InvalidOptionArgumentError(`Could not parse url ${value}`);
+        }
+        return url;
+    } catch (e) {
+        throw new commander.InvalidOptionArgumentError(`Could not parse url ${value}`);
+    }
+};
+/**
+ * hook: if encrypt==true and key not provided, prompt for it
+ */ const promptEncryptionKey = async (thisCommand)=>{
+    const opts = thisCommand.opts();
+    if (!opts.encrypt && opts.key) {
+        return helpers.exitWith(1, 'Key may not be present unless encryption is used');
+    }
+    // if encrypt==true but we have no key, prompt for it
+    if (opts.encrypt && !(opts.key && opts.key.length > 0)) {
+        try {
+            const answers = await inquirer.prompt([
+                {
+                    type: 'password',
+                    message: 'Please enter an encryption key',
+                    name: 'key',
+                    validate (key) {
+                        if (key.length > 0) return true;
+                        return 'Key must be present when using the encrypt option';
+                    }
+                }
+            ]);
+            opts.key = answers.key;
+        } catch (e) {
+            return helpers.exitWith(1, 'Failed to get encryption key');
+        }
+        if (!opts.key) {
+            return helpers.exitWith(1, 'Failed to get encryption key');
+        }
+    }
+};
+/**
+ * hook: require a confirmation message to be accepted unless forceOption (-f,--force) is used
+ */ const getCommanderConfirmMessage = (message, { failMessage } = {})=>{
+    return async (command)=>{
+        const confirmed = await confirmMessage(message, {
+            force: command.opts().force
+        });
+        if (!confirmed) {
+            helpers.exitWith(1, failMessage);
+        }
+    };
+};
+const confirmMessage = async (message, { force } = {})=>{
+    // if we have a force option, respond yes
+    if (force === true) {
+        // attempt to mimic the inquirer prompt exactly
+        console.log(`${chalk.green('?')} ${chalk.bold(message)} ${chalk.cyan('Yes')}`);
+        return true;
+    }
+    const answers = await inquirer.prompt([
+        {
+            type: 'confirm',
+            message,
+            name: `confirm`,
+            default: false
+        }
+    ]);
+    return answers.confirm;
+};
+const forceOption = new commander.Option('--force', `Automatically answer "yes" to all prompts, including potentially destructive requests, and run non-interactively.`);
+
+exports.confirmMessage = confirmMessage;
+exports.forceOption = forceOption;
+exports.getCommanderConfirmMessage = getCommanderConfirmMessage;
+exports.getParseListWithChoices = getParseListWithChoices;
+exports.parseInteger = parseInteger;
+exports.parseList = parseList;
+exports.parseURL = parseURL;
+exports.promptEncryptionKey = promptEncryptionKey;
+//# sourceMappingURL=commander.js.map

package/dist/src/cli/utils/commander.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commander.js","sources":["../../../../src/cli/utils/commander.ts"],"sourcesContent":["/**\n * This file includes hooks to use for commander.hook and argParsers for commander.argParser\n */\n\nimport inquirer from 'inquirer';\nimport { Command, InvalidOptionArgumentError, Option } from 'commander';\nimport chalk from 'chalk';\nimport { isNaN } from 'lodash/fp';\nimport { exitWith } from './helpers';\n\n/**\n * argParser: Parse a comma-delimited string as an array\n */\nconst parseList = (value: string) => {\n  try {\n    return value.split(',').map((item) => item.trim()); // trim shouldn't be necessary but might help catch unexpected whitespace characters\n  } catch (e) {\n    exitWith(1, `Unrecognized input: ${value}`);\n  }\n\n  return [];\n};\n\n/**\n * Returns an argParser that returns a list\n */\nconst getParseListWithChoices = (choices: string[], errorMessage = 'Invalid options:') => {\n  return (value: string) => {\n    const list = parseList(value);\n    const invalid = list.filter((item) => {\n      return !choices.includes(item);\n    });\n\n    if (invalid.length > 0) {\n      exitWith(1, `${errorMessage}: ${invalid.join(',')}`);\n    }\n\n    return list;\n  };\n};\n\n/**\n * argParser: Parse a string as an integer\n */\nconst parseInteger = (value: string) => {\n  // parseInt takes a string and a radix\n  const parsedValue = parseInt(value, 10);\n  if (isNaN(parsedValue)) {\n    throw new InvalidOptionArgumentError(`Not an integer: ${value}`);\n  }\n  return parsedValue;\n};\n\n/**\n * argParser: Parse a string as a URL object\n */\nconst parseURL = (value: string) => {\n  try {\n    const url = new URL(value);\n    if (!url.host) {\n      throw new InvalidOptionArgumentError(`Could not parse url ${value}`);\n    }\n\n    return url;\n  } catch (e) {\n    throw new InvalidOptionArgumentError(`Could not parse url ${value}`);\n  }\n};\n\n/**\n * hook: if encrypt==true and key not provided, prompt for it\n */\nconst promptEncryptionKey = async (thisCommand: Command) => {\n  const opts = thisCommand.opts();\n\n  if (!opts.encrypt && opts.key) {\n    return exitWith(1, 'Key may not be present unless encryption is used');\n  }\n\n  // if encrypt==true but we have no key, prompt for it\n  if (opts.encrypt && !(opts.key && opts.key.length > 0)) {\n    try {\n      const answers = await inquirer.prompt([\n        {\n          type: 'password',\n          message: 'Please enter an encryption key',\n          name: 'key',\n          validate(key) {\n            if (key.length > 0) return true;\n\n            return 'Key must be present when using the encrypt option';\n          },\n        },\n      ]);\n      opts.key = answers.key;\n    } catch (e) {\n      return exitWith(1, 'Failed to get encryption key');\n    }\n    if (!opts.key) {\n      return exitWith(1, 'Failed to get encryption key');\n    }\n  }\n};\n\n/**\n * hook: require a confirmation message to be accepted unless forceOption (-f,--force) is used\n */\nconst getCommanderConfirmMessage = (\n  message: string,\n  { failMessage }: { failMessage?: string } = {}\n) => {\n  return async (command: Command) => {\n    const confirmed = await confirmMessage(message, { force: command.opts().force });\n    if (!confirmed) {\n      exitWith(1, failMessage);\n    }\n  };\n};\n\nconst confirmMessage = async (message: string, { force }: { force?: boolean } = {}) => {\n  // if we have a force option, respond yes\n  if (force === true) {\n    // attempt to mimic the inquirer prompt exactly\n    console.log(`${chalk.green('?')} ${chalk.bold(message)} ${chalk.cyan('Yes')}`);\n    return true;\n  }\n\n  const answers = await inquirer.prompt([\n    {\n      type: 'confirm',\n      message,\n      name: `confirm`,\n      default: false,\n    },\n  ]);\n\n  return answers.confirm;\n};\n\nconst forceOption = new Option(\n  '--force',\n  `Automatically answer \"yes\" to all prompts, including potentially destructive requests, and run non-interactively.`\n);\n\nexport {\n  getParseListWithChoices,\n  parseList,\n  parseURL,\n  parseInteger,\n  promptEncryptionKey,\n  getCommanderConfirmMessage,\n  confirmMessage,\n  forceOption,\n};\n"],"names":["parseList","value","split","map","item","trim","e","exitWith","getParseListWithChoices","choices","errorMessage","list","invalid","filter","includes","length","join","parseInteger","parsedValue","parseInt","isNaN","InvalidOptionArgumentError","parseURL","url","URL","host","promptEncryptionKey","thisCommand","opts","encrypt","key","answers","inquirer","prompt","type","message","name","validate","getCommanderConfirmMessage","failMessage","command","confirmed","confirmMessage","force","console","log","chalk","green","bold","cyan","default","confirm","forceOption","Option"],"mappings":";;;;;;;;AAUA;;IAGA,MAAMA,YAAY,CAACC,KAAAA,GAAAA;IACjB,IAAI;QACF,OAAOA,KAAAA,CAAMC,KAAK,CAAC,GAAKC,CAAAA,CAAAA,GAAG,CAAC,CAACC,IAASA,GAAAA,IAAAA,CAAKC,IAAI,EAAA,CAAA,CAAA;AACjD,KAAA,CAAE,OAAOC,CAAG,EAAA;AACVC,QAAAA,gBAAAA,CAAS,CAAG,EAAA,CAAC,oBAAoB,EAAEN,MAAM,CAAC,CAAA;AAC5C;AAEA,IAAA,OAAO,EAAE;AACX;AAEA;;AAEC,IACKO,MAAAA,uBAAAA,GAA0B,CAACC,OAAAA,EAAmBC,eAAe,kBAAkB,GAAA;AACnF,IAAA,OAAO,CAACT,KAAAA,GAAAA;AACN,QAAA,MAAMU,OAAOX,SAAUC,CAAAA,KAAAA,CAAAA;AACvB,QAAA,MAAMW,OAAUD,GAAAA,IAAAA,CAAKE,MAAM,CAAC,CAACT,IAAAA,GAAAA;YAC3B,OAAO,CAACK,OAAQK,CAAAA,QAAQ,CAACV,IAAAA,CAAAA;AAC3B,SAAA,CAAA;QAEA,IAAIQ,OAAAA,CAAQG,MAAM,GAAG,CAAG,EAAA;YACtBR,gBAAS,CAAA,CAAA,EAAG,CAAC,EAAEG,YAAa,CAAA,EAAE,EAAEE,OAAQI,CAAAA,IAAI,CAAC,GAAA,CAAA,CAAK,CAAC,CAAA;AACrD;QAEA,OAAOL,IAAAA;AACT,KAAA;AACF;AAEA;;IAGA,MAAMM,eAAe,CAAChB,KAAAA,GAAAA;;IAEpB,MAAMiB,WAAAA,GAAcC,SAASlB,KAAO,EAAA,EAAA,CAAA;AACpC,IAAA,IAAImB,SAAMF,WAAc,CAAA,EAAA;AACtB,QAAA,MAAM,IAAIG,oCAA2B,CAAA,CAAC,gBAAgB,EAAEpB,MAAM,CAAC,CAAA;AACjE;IACA,OAAOiB,WAAAA;AACT;AAEA;;IAGA,MAAMI,WAAW,CAACrB,KAAAA,GAAAA;IAChB,IAAI;QACF,MAAMsB,GAAAA,GAAM,IAAIC,GAAIvB,CAAAA,KAAAA,CAAAA;QACpB,IAAI,CAACsB,GAAIE,CAAAA,IAAI,EAAE;AACb,YAAA,MAAM,IAAIJ,oCAA2B,CAAA,CAAC,oBAAoB,EAAEpB,MAAM,CAAC,CAAA;AACrE;QAEA,OAAOsB,GAAAA;AACT,KAAA,CAAE,OAAOjB,CAAG,EAAA;AACV,QAAA,MAAM,IAAIe,oCAA2B,CAAA,CAAC,oBAAoB,EAAEpB,MAAM,CAAC,CAAA;AACrE;AACF;AAEA;;IAGA,MAAMyB,sBAAsB,OAAOC,WAAAA,GAAAA;IACjC,MAAMC,IAAAA,GAAOD,YAAYC,IAAI,EAAA;AAE7B,IAAA,IAAI,CAACA,IAAKC,CAAAA,OAAO,IAAID,IAAAA,CAAKE,GAAG,EAAE;AAC7B,QAAA,OAAOvB,iBAAS,CAAG,EAAA,kDAAA,CAAA;AACrB;;AAGA,IAAA,IAAIqB,IAAKC,CAAAA,OAAO,IAAI,EAAED,IAAKE,CAAAA,GAAG,IAAIF,IAAAA,CAAKE,GAAG,CAACf,MAAM,GAAG,CAAA,CAAI,EAAA;QACtD,IAAI;AACF,YAAA,MAAMgB,OAAU,GAAA,MAAMC,QAASC,CAAAA,MAAM,CAAC;AACpC,gBAAA;oBACEC,IAAM,EAAA,UAAA;oBACNC,OAAS,EAAA,gCAAA;oBACTC,IAAM,EAAA,KAAA;AACNC,oBAAAA,QAAAA,CAAAA,CAASP,GAAG,EAAA;AACV,wBAAA,IAAIA,GAAIf,CAAAA,MAAM,GAAG,CAAA,EAAG,OAAO,IAAA;wBAE3B,OAAO,mDAAA;AACT;AACF;AACD,aAAA,CAAA;YACDa,IAAKE,CAAAA,GAAG,GAAGC,OAAAA,CAAQD,GAAG;AACxB,SAAA,CAAE,OAAOxB,CAAG,EAAA;AACV,YAAA,OAAOC,iBAAS,CAAG,EAAA,8BAAA,CAAA;AACrB;QACA,IAAI,CAACqB,IAAKE,CAAAA,GAAG,EAAE;AACb,YAAA,OAAOvB,iBAAS,CAAG,EAAA,8BAAA,CAAA;AACrB;AACF;AACF;AAEA;;IAGA,MAAM+B,6BAA6B,CACjCH,OAAAA,EACA,EAAEI,WAAW,EAA4B,GAAG,EAAE,GAAA;AAE9C,IAAA,OAAO,OAAOC,OAAAA,GAAAA;QACZ,MAAMC,SAAAA,GAAY,MAAMC,cAAAA,CAAeP,OAAS,EAAA;YAAEQ,KAAOH,EAAAA,OAAAA,CAAQZ,IAAI,EAAA,CAAGe;AAAM,SAAA,CAAA;AAC9E,QAAA,IAAI,CAACF,SAAW,EAAA;AACdlC,YAAAA,gBAAAA,CAAS,CAAGgC,EAAAA,WAAAA,CAAAA;AACd;AACF,KAAA;AACF;AAEMG,MAAAA,cAAAA,GAAiB,OAAOP,OAAiB,EAAA,EAAEQ,KAAK,EAAuB,GAAG,EAAE,GAAA;;AAEhF,IAAA,IAAIA,UAAU,IAAM,EAAA;;QAElBC,OAAQC,CAAAA,GAAG,CAAC,CAAC,EAAEC,MAAMC,KAAK,CAAC,KAAK,CAAC,EAAED,MAAME,IAAI,CAACb,SAAS,CAAC,EAAEW,MAAMG,IAAI,CAAC,OAAO,CAAC,CAAA;QAC7E,OAAO,IAAA;AACT;AAEA,IAAA,MAAMlB,OAAU,GAAA,MAAMC,QAASC,CAAAA,MAAM,CAAC;AACpC,QAAA;YACEC,IAAM,EAAA,SAAA;AACNC,YAAAA,OAAAA;YACAC,IAAM,EAAA,CAAC,OAAO,CAAC;YACfc,OAAS,EAAA;AACX;AACD,KAAA,CAAA;AAED,IAAA,OAAOnB,QAAQoB,OAAO;AACxB;AAEA,MAAMC,cAAc,IAAIC,gBAAAA,CACtB,SACA,EAAA,CAAC,iHAAiH,CAAC;;;;;;;;;;;"}

package/dist/src/cli/utils/commander.mjs

@@ -0,0 +1,116 @@
+import inquirer from 'inquirer';
+import { Option, InvalidOptionArgumentError } from 'commander';
+import chalk from 'chalk';
+import { isNaN } from 'lodash/fp';
+import { exitWith } from './helpers.mjs';
+
+/**
+ * argParser: Parse a comma-delimited string as an array
+ */ const parseList = (value)=>{
+    try {
+        return value.split(',').map((item)=>item.trim()); // trim shouldn't be necessary but might help catch unexpected whitespace characters
+    } catch (e) {
+        exitWith(1, `Unrecognized input: ${value}`);
+    }
+    return [];
+};
+/**
+ * Returns an argParser that returns a list
+ */ const getParseListWithChoices = (choices, errorMessage = 'Invalid options:')=>{
+    return (value)=>{
+        const list = parseList(value);
+        const invalid = list.filter((item)=>{
+            return !choices.includes(item);
+        });
+        if (invalid.length > 0) {
+            exitWith(1, `${errorMessage}: ${invalid.join(',')}`);
+        }
+        return list;
+    };
+};
+/**
+ * argParser: Parse a string as an integer
+ */ const parseInteger = (value)=>{
+    // parseInt takes a string and a radix
+    const parsedValue = parseInt(value, 10);
+    if (isNaN(parsedValue)) {
+        throw new InvalidOptionArgumentError(`Not an integer: ${value}`);
+    }
+    return parsedValue;
+};
+/**
+ * argParser: Parse a string as a URL object
+ */ const parseURL = (value)=>{
+    try {
+        const url = new URL(value);
+        if (!url.host) {
+            throw new InvalidOptionArgumentError(`Could not parse url ${value}`);
+        }
+        return url;
+    } catch (e) {
+        throw new InvalidOptionArgumentError(`Could not parse url ${value}`);
+    }
+};
+/**
+ * hook: if encrypt==true and key not provided, prompt for it
+ */ const promptEncryptionKey = async (thisCommand)=>{
+    const opts = thisCommand.opts();
+    if (!opts.encrypt && opts.key) {
+        return exitWith(1, 'Key may not be present unless encryption is used');
+    }
+    // if encrypt==true but we have no key, prompt for it
+    if (opts.encrypt && !(opts.key && opts.key.length > 0)) {
+        try {
+            const answers = await inquirer.prompt([
+                {
+                    type: 'password',
+                    message: 'Please enter an encryption key',
+                    name: 'key',
+                    validate (key) {
+                        if (key.length > 0) return true;
+                        return 'Key must be present when using the encrypt option';
+                    }
+                }
+            ]);
+            opts.key = answers.key;
+        } catch (e) {
+            return exitWith(1, 'Failed to get encryption key');
+        }
+        if (!opts.key) {
+            return exitWith(1, 'Failed to get encryption key');
+        }
+    }
+};
+/**
+ * hook: require a confirmation message to be accepted unless forceOption (-f,--force) is used
+ */ const getCommanderConfirmMessage = (message, { failMessage } = {})=>{
+    return async (command)=>{
+        const confirmed = await confirmMessage(message, {
+            force: command.opts().force
+        });
+        if (!confirmed) {
+            exitWith(1, failMessage);
+        }
+    };
+};
+const confirmMessage = async (message, { force } = {})=>{
+    // if we have a force option, respond yes
+    if (force === true) {
+        // attempt to mimic the inquirer prompt exactly
+        console.log(`${chalk.green('?')} ${chalk.bold(message)} ${chalk.cyan('Yes')}`);
+        return true;
+    }
+    const answers = await inquirer.prompt([
+        {
+            type: 'confirm',
+            message,
+            name: `confirm`,
+            default: false
+        }
+    ]);
+    return answers.confirm;
+};
+const forceOption = new Option('--force', `Automatically answer "yes" to all prompts, including potentially destructive requests, and run non-interactively.`);
+
+export { confirmMessage, forceOption, getCommanderConfirmMessage, getParseListWithChoices, parseInteger, parseList, parseURL, promptEncryptionKey };
+//# sourceMappingURL=commander.mjs.map

package/dist/src/cli/utils/commander.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"commander.mjs","sources":["../../../../src/cli/utils/commander.ts"],"sourcesContent":["/**\n * This file includes hooks to use for commander.hook and argParsers for commander.argParser\n */\n\nimport inquirer from 'inquirer';\nimport { Command, InvalidOptionArgumentError, Option } from 'commander';\nimport chalk from 'chalk';\nimport { isNaN } from 'lodash/fp';\nimport { exitWith } from './helpers';\n\n/**\n * argParser: Parse a comma-delimited string as an array\n */\nconst parseList = (value: string) => {\n  try {\n    return value.split(',').map((item) => item.trim()); // trim shouldn't be necessary but might help catch unexpected whitespace characters\n  } catch (e) {\n    exitWith(1, `Unrecognized input: ${value}`);\n  }\n\n  return [];\n};\n\n/**\n * Returns an argParser that returns a list\n */\nconst getParseListWithChoices = (choices: string[], errorMessage = 'Invalid options:') => {\n  return (value: string) => {\n    const list = parseList(value);\n    const invalid = list.filter((item) => {\n      return !choices.includes(item);\n    });\n\n    if (invalid.length > 0) {\n      exitWith(1, `${errorMessage}: ${invalid.join(',')}`);\n    }\n\n    return list;\n  };\n};\n\n/**\n * argParser: Parse a string as an integer\n */\nconst parseInteger = (value: string) => {\n  // parseInt takes a string and a radix\n  const parsedValue = parseInt(value, 10);\n  if (isNaN(parsedValue)) {\n    throw new InvalidOptionArgumentError(`Not an integer: ${value}`);\n  }\n  return parsedValue;\n};\n\n/**\n * argParser: Parse a string as a URL object\n */\nconst parseURL = (value: string) => {\n  try {\n    const url = new URL(value);\n    if (!url.host) {\n      throw new InvalidOptionArgumentError(`Could not parse url ${value}`);\n    }\n\n    return url;\n  } catch (e) {\n    throw new InvalidOptionArgumentError(`Could not parse url ${value}`);\n  }\n};\n\n/**\n * hook: if encrypt==true and key not provided, prompt for it\n */\nconst promptEncryptionKey = async (thisCommand: Command) => {\n  const opts = thisCommand.opts();\n\n  if (!opts.encrypt && opts.key) {\n    return exitWith(1, 'Key may not be present unless encryption is used');\n  }\n\n  // if encrypt==true but we have no key, prompt for it\n  if (opts.encrypt && !(opts.key && opts.key.length > 0)) {\n    try {\n      const answers = await inquirer.prompt([\n        {\n          type: 'password',\n          message: 'Please enter an encryption key',\n          name: 'key',\n          validate(key) {\n            if (key.length > 0) return true;\n\n            return 'Key must be present when using the encrypt option';\n          },\n        },\n      ]);\n      opts.key = answers.key;\n    } catch (e) {\n      return exitWith(1, 'Failed to get encryption key');\n    }\n    if (!opts.key) {\n      return exitWith(1, 'Failed to get encryption key');\n    }\n  }\n};\n\n/**\n * hook: require a confirmation message to be accepted unless forceOption (-f,--force) is used\n */\nconst getCommanderConfirmMessage = (\n  message: string,\n  { failMessage }: { failMessage?: string } = {}\n) => {\n  return async (command: Command) => {\n    const confirmed = await confirmMessage(message, { force: command.opts().force });\n    if (!confirmed) {\n      exitWith(1, failMessage);\n    }\n  };\n};\n\nconst confirmMessage = async (message: string, { force }: { force?: boolean } = {}) => {\n  // if we have a force option, respond yes\n  if (force === true) {\n    // attempt to mimic the inquirer prompt exactly\n    console.log(`${chalk.green('?')} ${chalk.bold(message)} ${chalk.cyan('Yes')}`);\n    return true;\n  }\n\n  const answers = await inquirer.prompt([\n    {\n      type: 'confirm',\n      message,\n      name: `confirm`,\n      default: false,\n    },\n  ]);\n\n  return answers.confirm;\n};\n\nconst forceOption = new Option(\n  '--force',\n  `Automatically answer \"yes\" to all prompts, including potentially destructive requests, and run non-interactively.`\n);\n\nexport {\n  getParseListWithChoices,\n  parseList,\n  parseURL,\n  parseInteger,\n  promptEncryptionKey,\n  getCommanderConfirmMessage,\n  confirmMessage,\n  forceOption,\n};\n"],"names":["parseList","value","split","map","item","trim","e","exitWith","getParseListWithChoices","choices","errorMessage","list","invalid","filter","includes","length","join","parseInteger","parsedValue","parseInt","isNaN","InvalidOptionArgumentError","parseURL","url","URL","host","promptEncryptionKey","thisCommand","opts","encrypt","key","answers","inquirer","prompt","type","message","name","validate","getCommanderConfirmMessage","failMessage","command","confirmed","confirmMessage","force","console","log","chalk","green","bold","cyan","default","confirm","forceOption","Option"],"mappings":";;;;;;AAUA;;IAGA,MAAMA,YAAY,CAACC,KAAAA,GAAAA;IACjB,IAAI;QACF,OAAOA,KAAAA,CAAMC,KAAK,CAAC,GAAKC,CAAAA,CAAAA,GAAG,CAAC,CAACC,IAASA,GAAAA,IAAAA,CAAKC,IAAI,EAAA,CAAA,CAAA;AACjD,KAAA,CAAE,OAAOC,CAAG,EAAA;AACVC,QAAAA,QAAAA,CAAS,CAAG,EAAA,CAAC,oBAAoB,EAAEN,MAAM,CAAC,CAAA;AAC5C;AAEA,IAAA,OAAO,EAAE;AACX;AAEA;;AAEC,IACKO,MAAAA,uBAAAA,GAA0B,CAACC,OAAAA,EAAmBC,eAAe,kBAAkB,GAAA;AACnF,IAAA,OAAO,CAACT,KAAAA,GAAAA;AACN,QAAA,MAAMU,OAAOX,SAAUC,CAAAA,KAAAA,CAAAA;AACvB,QAAA,MAAMW,OAAUD,GAAAA,IAAAA,CAAKE,MAAM,CAAC,CAACT,IAAAA,GAAAA;YAC3B,OAAO,CAACK,OAAQK,CAAAA,QAAQ,CAACV,IAAAA,CAAAA;AAC3B,SAAA,CAAA;QAEA,IAAIQ,OAAAA,CAAQG,MAAM,GAAG,CAAG,EAAA;YACtBR,QAAS,CAAA,CAAA,EAAG,CAAC,EAAEG,YAAa,CAAA,EAAE,EAAEE,OAAQI,CAAAA,IAAI,CAAC,GAAA,CAAA,CAAK,CAAC,CAAA;AACrD;QAEA,OAAOL,IAAAA;AACT,KAAA;AACF;AAEA;;IAGA,MAAMM,eAAe,CAAChB,KAAAA,GAAAA;;IAEpB,MAAMiB,WAAAA,GAAcC,SAASlB,KAAO,EAAA,EAAA,CAAA;AACpC,IAAA,IAAImB,MAAMF,WAAc,CAAA,EAAA;AACtB,QAAA,MAAM,IAAIG,0BAA2B,CAAA,CAAC,gBAAgB,EAAEpB,MAAM,CAAC,CAAA;AACjE;IACA,OAAOiB,WAAAA;AACT;AAEA;;IAGA,MAAMI,WAAW,CAACrB,KAAAA,GAAAA;IAChB,IAAI;QACF,MAAMsB,GAAAA,GAAM,IAAIC,GAAIvB,CAAAA,KAAAA,CAAAA;QACpB,IAAI,CAACsB,GAAIE,CAAAA,IAAI,EAAE;AACb,YAAA,MAAM,IAAIJ,0BAA2B,CAAA,CAAC,oBAAoB,EAAEpB,MAAM,CAAC,CAAA;AACrE;QAEA,OAAOsB,GAAAA;AACT,KAAA,CAAE,OAAOjB,CAAG,EAAA;AACV,QAAA,MAAM,IAAIe,0BAA2B,CAAA,CAAC,oBAAoB,EAAEpB,MAAM,CAAC,CAAA;AACrE;AACF;AAEA;;IAGA,MAAMyB,sBAAsB,OAAOC,WAAAA,GAAAA;IACjC,MAAMC,IAAAA,GAAOD,YAAYC,IAAI,EAAA;AAE7B,IAAA,IAAI,CAACA,IAAKC,CAAAA,OAAO,IAAID,IAAAA,CAAKE,GAAG,EAAE;AAC7B,QAAA,OAAOvB,SAAS,CAAG,EAAA,kDAAA,CAAA;AACrB;;AAGA,IAAA,IAAIqB,IAAKC,CAAAA,OAAO,IAAI,EAAED,IAAKE,CAAAA,GAAG,IAAIF,IAAAA,CAAKE,GAAG,CAACf,MAAM,GAAG,CAAA,CAAI,EAAA;QACtD,IAAI;AACF,YAAA,MAAMgB,OAAU,GAAA,MAAMC,QAASC,CAAAA,MAAM,CAAC;AACpC,gBAAA;oBACEC,IAAM,EAAA,UAAA;oBACNC,OAAS,EAAA,gCAAA;oBACTC,IAAM,EAAA,KAAA;AACNC,oBAAAA,QAAAA,CAAAA,CAASP,GAAG,EAAA;AACV,wBAAA,IAAIA,GAAIf,CAAAA,MAAM,GAAG,CAAA,EAAG,OAAO,IAAA;wBAE3B,OAAO,mDAAA;AACT;AACF;AACD,aAAA,CAAA;YACDa,IAAKE,CAAAA,GAAG,GAAGC,OAAAA,CAAQD,GAAG;AACxB,SAAA,CAAE,OAAOxB,CAAG,EAAA;AACV,YAAA,OAAOC,SAAS,CAAG,EAAA,8BAAA,CAAA;AACrB;QACA,IAAI,CAACqB,IAAKE,CAAAA,GAAG,EAAE;AACb,YAAA,OAAOvB,SAAS,CAAG,EAAA,8BAAA,CAAA;AACrB;AACF;AACF;AAEA;;IAGA,MAAM+B,6BAA6B,CACjCH,OAAAA,EACA,EAAEI,WAAW,EAA4B,GAAG,EAAE,GAAA;AAE9C,IAAA,OAAO,OAAOC,OAAAA,GAAAA;QACZ,MAAMC,SAAAA,GAAY,MAAMC,cAAAA,CAAeP,OAAS,EAAA;YAAEQ,KAAOH,EAAAA,OAAAA,CAAQZ,IAAI,EAAA,CAAGe;AAAM,SAAA,CAAA;AAC9E,QAAA,IAAI,CAACF,SAAW,EAAA;AACdlC,YAAAA,QAAAA,CAAS,CAAGgC,EAAAA,WAAAA,CAAAA;AACd;AACF,KAAA;AACF;AAEMG,MAAAA,cAAAA,GAAiB,OAAOP,OAAiB,EAAA,EAAEQ,KAAK,EAAuB,GAAG,EAAE,GAAA;;AAEhF,IAAA,IAAIA,UAAU,IAAM,EAAA;;QAElBC,OAAQC,CAAAA,GAAG,CAAC,CAAC,EAAEC,MAAMC,KAAK,CAAC,KAAK,CAAC,EAAED,MAAME,IAAI,CAACb,SAAS,CAAC,EAAEW,MAAMG,IAAI,CAAC,OAAO,CAAC,CAAA;QAC7E,OAAO,IAAA;AACT;AAEA,IAAA,MAAMlB,OAAU,GAAA,MAAMC,QAASC,CAAAA,MAAM,CAAC;AACpC,QAAA;YACEC,IAAM,EAAA,SAAA;AACNC,YAAAA,OAAAA;YACAC,IAAM,EAAA,CAAC,OAAO,CAAC;YACfc,OAAS,EAAA;AACX;AACD,KAAA,CAAA;AAED,IAAA,OAAOnB,QAAQoB,OAAO;AACxB;AAEA,MAAMC,cAAc,IAAIC,MAAAA,CACtB,SACA,EAAA,CAAC,iHAAiH,CAAC;;;;"}

package/dist/src/cli/utils/data-transfer.js

@@ -0,0 +1,378 @@
+'use strict';
+
+var chalk = require('chalk');
+var CLITable = require('cli-table3');
+var commander = require('commander');
+var logger = require('@strapi/logger');
+var core = require('@strapi/core');
+var ora = require('ora');
+var fp = require('lodash/fp');
+var dataTransfer = require('@strapi/data-transfer');
+var helpers = require('./helpers.js');
+var commander$1 = require('./commander.js');
+
+const { errors: { TransferEngineInitializationError } } = dataTransfer.engine;
+const exitMessageText = (process1, error = false)=>{
+    const processCapitalized = process1[0].toUpperCase() + process1.slice(1);
+    if (!error) {
+        return chalk.bold(chalk.green(`${processCapitalized} process has been completed successfully!`));
+    }
+    return chalk.bold(chalk.red(`${processCapitalized} process failed.`));
+};
+const pad = (n)=>{
+    return (n < 10 ? '0' : '') + String(n);
+};
+const yyyymmddHHMMSS = ()=>{
+    const date = new Date();
+    return date.getFullYear() + pad(date.getMonth() + 1) + pad(date.getDate()) + pad(date.getHours()) + pad(date.getMinutes()) + pad(date.getSeconds());
+};
+const getDefaultExportName = ()=>{
+    return `export_${yyyymmddHHMMSS()}`;
+};
+const buildTransferTable = (resultData)=>{
+    if (!resultData) {
+        return;
+    }
+    // Build pretty table
+    const table = new CLITable({
+        head: [
+            'Type',
+            'Count',
+            'Size'
+        ].map((text)=>chalk.bold.blue(text))
+    });
+    let totalBytes = 0;
+    let totalItems = 0;
+    Object.keys(resultData).forEach((stage)=>{
+        const item = resultData[stage];
+        if (!item) {
+            return;
+        }
+        table.push([
+            {
+                hAlign: 'left',
+                content: chalk.bold(stage)
+            },
+            {
+                hAlign: 'right',
+                content: item.count
+            },
+            {
+                hAlign: 'right',
+                content: `${helpers.readableBytes(item.bytes, 1, 11)} `
+            }
+        ]);
+        totalBytes += item.bytes;
+        totalItems += item.count;
+        if (item.aggregates) {
+            Object.keys(item.aggregates).sort().forEach((subkey)=>{
+                if (!item.aggregates) {
+                    return;
+                }
+                const subitem = item.aggregates[subkey];
+                table.push([
+                    {
+                        hAlign: 'left',
+                        content: `-- ${chalk.bold.grey(subkey)}`
+                    },
+                    {
+                        hAlign: 'right',
+                        content: chalk.grey(subitem.count)
+                    },
+                    {
+                        hAlign: 'right',
+                        content: chalk.grey(`(${helpers.readableBytes(subitem.bytes, 1, 11)})`)
+                    }
+                ]);
+            });
+        }
+    });
+    table.push([
+        {
+            hAlign: 'left',
+            content: chalk.bold.green('Total')
+        },
+        {
+            hAlign: 'right',
+            content: chalk.bold.green(totalItems)
+        },
+        {
+            hAlign: 'right',
+            content: `${chalk.bold.green(helpers.readableBytes(totalBytes, 1, 11))} `
+        }
+    ]);
+    return table;
+};
+const DEFAULT_IGNORED_CONTENT_TYPES = [
+    'admin::permission',
+    'admin::user',
+    'admin::role',
+    'admin::api-token',
+    'admin::api-token-permission',
+    'admin::transfer-token',
+    'admin::transfer-token-permission',
+    'admin::audit-log',
+    'plugin::content-releases.release',
+    'plugin::content-releases.release-action'
+];
+const abortTransfer = async ({ engine, strapi: strapi1 })=>{
+    try {
+        await engine.abortTransfer();
+        await strapi1.destroy();
+    } catch (e) {
+        // ignore because there's not much else we can do
+        return false;
+    }
+    return true;
+};
+const setSignalHandler = async (handler, signals = [
+    'SIGINT',
+    'SIGTERM',
+    'SIGQUIT'
+])=>{
+    signals.forEach((signal)=>{
+        // We specifically remove ALL listeners because we have to clear the one added in Strapi bootstrap that has a process.exit
+        // TODO: Ideally Strapi bootstrap would not add that listener, and then this could be more flexible and add/remove only what it needs to
+        process.removeAllListeners(signal);
+        process.on(signal, handler);
+    });
+};
+const createStrapiInstance = async (opts = {})=>{
+    try {
+        const appContext = await core.compileStrapi();
+        const app = core.createStrapi({
+            ...opts,
+            ...appContext
+        });
+        app.log.level = opts.logLevel || 'error';
+        return await app.load();
+    } catch (error) {
+        if (error instanceof Error && 'code' in error && error.code === 'ECONNREFUSED') {
+            throw new Error('Process failed. Check the database connection with your Strapi project.');
+        }
+        throw error;
+    }
+};
+const transferDataTypes = Object.keys(dataTransfer.engine.TransferGroupPresets);
+const throttleOption = new commander.Option('--throttle <delay after each entity>', `Add a delay in milliseconds between each transferred entity`).argParser(commander$1.parseInteger).hideHelp(); // This option is not publicly documented
+const excludeOption = new commander.Option('--exclude <comma-separated data types>', `Exclude data using comma-separated types. Available types: ${transferDataTypes.join(',')}`).argParser(commander$1.getParseListWithChoices(transferDataTypes, 'Invalid options for "exclude"'));
+const onlyOption = new commander.Option('--only <command-separated data types>', `Include only these types of data (plus schemas). Available types: ${transferDataTypes.join(',')}`).argParser(commander$1.getParseListWithChoices(transferDataTypes, 'Invalid options for "only"'));
+const validateExcludeOnly = (command)=>{
+    const { exclude, only } = command.opts();
+    if (!only || !exclude) {
+        return;
+    }
+    const choicesInBoth = only.filter((n)=>{
+        return exclude.indexOf(n) !== -1;
+    });
+    if (choicesInBoth.length > 0) {
+        helpers.exitWith(1, `Data types may not be used in both "exclude" and "only" in the same command. Found in both: ${choicesInBoth.join(',')}`);
+    }
+};
+const errorColors = {
+    fatal: chalk.red,
+    error: chalk.red,
+    silly: chalk.yellow
+};
+const formatDiagnostic = (operation, info)=>{
+    // Create log file for all incoming diagnostics
+    let logger$1;
+    const getLogger = ()=>{
+        if (!logger$1) {
+            logger$1 = logger.createLogger(logger.configs.createOutputFileConfiguration(`${operation}_${Date.now()}.log`, {
+                level: 'info',
+                format: logger.formats?.detailedLogs
+            }));
+        }
+        return logger$1;
+    };
+    // We don't want to write a log file until there is something to be logged
+    return ({ details, kind })=>{
+        try {
+            if (kind === 'error') {
+                const { message, severity = 'fatal' } = details;
+                const colorizeError = errorColors[severity];
+                const errorMessage = colorizeError(`[${severity.toUpperCase()}] ${message}`);
+                getLogger().error(errorMessage);
+            }
+            if (kind === 'info' && info) {
+                const { message, params, origin } = details;
+                const msg = `[${origin ?? 'transfer'}] ${message}\n${params ? JSON.stringify(params, null, 2) : ''}`;
+                getLogger().info(msg);
+            }
+            if (kind === 'warning') {
+                const { origin, message } = details;
+                getLogger().warn(`(${origin ?? 'transfer'}) ${message}`);
+            }
+        } catch (err) {
+            getLogger().error(err);
+        }
+    };
+};
+const loadersFactory = (defaultLoaders = {})=>{
+    const loaders = defaultLoaders;
+    const updateLoader = (stage, data)=>{
+        if (!(stage in loaders)) {
+            createLoader(stage);
+        }
+        const stageData = data[stage];
+        const elapsedTime = stageData?.startTime ? (stageData?.endTime || Date.now()) - stageData.startTime : 0;
+        const size = `size: ${helpers.readableBytes(stageData?.bytes ?? 0)}`;
+        const elapsed = `elapsed: ${elapsedTime} ms`;
+        const speed = elapsedTime > 0 ? `(${helpers.readableBytes((stageData?.bytes ?? 0) * 1000 / elapsedTime)}/s)` : '';
+        loaders[stage].text = `${stage}: ${stageData?.count ?? 0} transfered (${size}) (${elapsed}) ${!stageData?.endTime ? speed : ''}`;
+        return loaders[stage];
+    };
+    const createLoader = (stage)=>{
+        Object.assign(loaders, {
+            [stage]: ora()
+        });
+        return loaders[stage];
+    };
+    const getLoader = (stage)=>{
+        return loaders[stage];
+    };
+    return {
+        updateLoader,
+        createLoader,
+        getLoader
+    };
+};
+/**
+ * Get the telemetry data to be sent for a didDEITSProcess* event from an initialized transfer engine object
+ */ const getTransferTelemetryPayload = (engine)=>{
+    return {
+        eventProperties: {
+            source: engine?.sourceProvider?.name,
+            destination: engine?.destinationProvider?.name
+        }
+    };
+};
+/**
+ * Get a transfer engine schema diff handler that confirms with the user before bypassing a schema check
+ */ const getDiffHandler = (engine, { force, action })=>{
+    return async (context, next)=>{
+        // if we abort here, we need to actually exit the process because of conflict with inquirer prompt
+        setSignalHandler(async ()=>{
+            await abortTransfer({
+                engine,
+                strapi: strapi
+            });
+            helpers.exitWith(1, exitMessageText(action, true));
+        });
+        let workflowsStatus;
+        const source = 'Schema Integrity';
+        Object.entries(context.diffs).forEach(([uid, diffs])=>{
+            for (const diff of diffs){
+                const path = [
+                    uid
+                ].concat(diff.path).join('.');
+                const endPath = diff.path[diff.path.length - 1];
+                // Catch known features
+                if (uid === 'plugin::review-workflows.workflow' || uid === 'plugin::review-workflows.workflow-stage' || endPath?.startsWith('strapi_stage') || endPath?.startsWith('strapi_assignee')) {
+                    workflowsStatus = diff.kind;
+                } else if (diff.kind === 'added') {
+                    engine.reportWarning(chalk.red(`${chalk.bold(path)} does not exist on source`), source);
+                } else if (diff.kind === 'deleted') {
+                    engine.reportWarning(chalk.red(`${chalk.bold(path)} does not exist on destination`), source);
+                } else if (diff.kind === 'modified') {
+                    engine.reportWarning(chalk.red(`${chalk.bold(path)} has a different data type`), source);
+                }
+            }
+        });
+        // output the known feature warnings
+        if (workflowsStatus === 'added') {
+            engine.reportWarning(chalk.red(`Review workflows feature does not exist on source`), source);
+        } else if (workflowsStatus === 'deleted') {
+            engine.reportWarning(chalk.red(`Review workflows feature does not exist on destination`), source);
+        } else if (workflowsStatus === 'modified') {
+            engine.panic(new TransferEngineInitializationError('Unresolved differences in schema [review workflows]'));
+        }
+        const confirmed = await commander$1.confirmMessage('There are differences in schema between the source and destination, and the data listed above will be lost. Are you sure you want to continue?', {
+            force
+        });
+        // reset handler back to normal
+        setSignalHandler(()=>abortTransfer({
+                engine,
+                strapi: strapi
+            }));
+        if (confirmed) {
+            context.ignoredDiffs = fp.merge(context.diffs, context.ignoredDiffs);
+        }
+        return next(context);
+    };
+};
+const getAssetsBackupHandler = (engine, { force, action })=>{
+    return async (context, next)=>{
+        // if we abort here, we need to actually exit the process because of conflict with inquirer prompt
+        setSignalHandler(async ()=>{
+            await abortTransfer({
+                engine,
+                strapi: strapi
+            });
+            helpers.exitWith(1, exitMessageText(action, true));
+        });
+        console.warn('The backup for the assets could not be created inside the public directory. Ensure Strapi has write permissions on the public directory.');
+        const confirmed = await commander$1.confirmMessage('Do you want to continue without backing up your public/uploads files?', {
+            force
+        });
+        if (confirmed) {
+            context.ignore = true;
+        }
+        // reset handler back to normal
+        setSignalHandler(()=>abortTransfer({
+                engine,
+                strapi: strapi
+            }));
+        return next(context);
+    };
+};
+const shouldSkipStage = (opts, dataKind)=>{
+    if (opts.exclude?.includes(dataKind)) {
+        return true;
+    }
+    if (opts.only) {
+        return !opts.only.includes(dataKind);
+    }
+    return false;
+};
+// Based on exclude/only from options, create the restore object to match
+const parseRestoreFromOptions = (opts)=>{
+    const entitiesOptions = {
+        exclude: DEFAULT_IGNORED_CONTENT_TYPES,
+        include: undefined
+    };
+    // if content is not included, send an empty array for include
+    if (opts.only && !opts.only.includes('content') || opts.exclude?.includes('content')) {
+        entitiesOptions.include = [];
+    }
+    const restoreConfig = {
+        entities: entitiesOptions,
+        assets: !shouldSkipStage(opts, 'files'),
+        configuration: {
+            webhook: !shouldSkipStage(opts, 'config'),
+            coreStore: !shouldSkipStage(opts, 'config')
+        }
+    };
+    return restoreConfig;
+};
+
+exports.DEFAULT_IGNORED_CONTENT_TYPES = DEFAULT_IGNORED_CONTENT_TYPES;
+exports.abortTransfer = abortTransfer;
+exports.buildTransferTable = buildTransferTable;
+exports.createStrapiInstance = createStrapiInstance;
+exports.excludeOption = excludeOption;
+exports.exitMessageText = exitMessageText;
+exports.formatDiagnostic = formatDiagnostic;
+exports.getAssetsBackupHandler = getAssetsBackupHandler;
+exports.getDefaultExportName = getDefaultExportName;
+exports.getDiffHandler = getDiffHandler;
+exports.getTransferTelemetryPayload = getTransferTelemetryPayload;
+exports.loadersFactory = loadersFactory;
+exports.onlyOption = onlyOption;
+exports.parseRestoreFromOptions = parseRestoreFromOptions;
+exports.setSignalHandler = setSignalHandler;
+exports.shouldSkipStage = shouldSkipStage;
+exports.throttleOption = throttleOption;
+exports.validateExcludeOnly = validateExcludeOnly;
+//# sourceMappingURL=data-transfer.js.map