@automattic/vip 4.1.5 → 4.1.8

package/dist/lib/vip-import-validate-files.js

@@ -1,155 +1,183 @@
 "use strict";
-
-exports.__esModule = true;
-exports.summaryLogs = exports.logErrors = exports.isFileSanitized = exports.isDirectory = exports.folderStructureValidation = exports.findNestedDirectories = exports.doesImageHaveExistingSource = exports.ValidateFilesErrors = void 0;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.summaryLogs = exports.logErrors = exports.doesImageHaveExistingSource = exports.isFileSanitized = exports.folderStructureValidation = exports.findNestedDirectories = exports.isDirectory = exports.ValidateFilesErrors = void 0;
 exports.validateFiles = validateFiles;
-var _chalk = _interopRequireDefault(require("chalk"));
-var _fs = _interopRequireDefault(require("fs"));
-var _path = _interopRequireDefault(require("path"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /**
  * External dependencies
  */
-/**
- * Internal dependencies
- */
-let ValidateFilesErrors = exports.ValidateFilesErrors = /*#__PURE__*/function (ValidateFilesErrors) {
-  ValidateFilesErrors["INVALID_TYPES"] = "invalid_types";
-  ValidateFilesErrors["INTERMEDIATE_IMAGES"] = "intermediate_images";
-  ValidateFilesErrors["INVALID_SIZES"] = "invalid_sizes";
-  ValidateFilesErrors["INVALID_NAMES"] = "invalid_names";
-  ValidateFilesErrors["INVALID_NAME_CHARACTER_COUNTS"] = "invalid_name_character_counts";
-  return ValidateFilesErrors;
-}({});
+const chalk_1 = __importDefault(require("chalk"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+var ValidateFilesErrors;
+(function (ValidateFilesErrors) {
+    ValidateFilesErrors["INVALID_TYPES"] = "invalid_types";
+    ValidateFilesErrors["INTERMEDIATE_IMAGES"] = "intermediate_images";
+    ValidateFilesErrors["INVALID_SIZES"] = "invalid_sizes";
+    ValidateFilesErrors["INVALID_NAMES"] = "invalid_names";
+    ValidateFilesErrors["INVALID_NAME_CHARACTER_COUNTS"] = "invalid_name_character_counts";
+})(ValidateFilesErrors || (exports.ValidateFilesErrors = ValidateFilesErrors = {}));
 /**
  * File info validation
  *
  * Validate the file info for media files
  */
 async function validateFiles(files, mediaImportConfig) {
-  const validationResult = {
-    intermediateImagesTotal: 0,
-    errorFileTypes: [],
-    errorFileNames: [],
-    errorFileSizes: [],
-    errorFileNamesCharCount: [],
-    intermediateImages: {}
-  };
-  const fileValidationPromises = files.map(async file => {
-    const isFolder = await isDirectory(file);
-    const fileExtType = getFileExtType(file, mediaImportConfig.allowedFileTypes);
-    if (isInvalidFile(fileExtType, isFolder)) {
-      validationResult.errorFileTypes.push(file);
-    }
-    if (!isFileSizeValid(file, mediaImportConfig.fileSizeLimitInBytes)) {
-      validationResult.errorFileSizes.push(file);
-    }
-    if (isFileSanitized(file)) {
-      validationResult.errorFileNames.push(file);
-    }
-    if (!isFileNameCharCountValid(file, mediaImportConfig?.fileNameCharCount)) {
-      validationResult.errorFileNamesCharCount.push(file);
-    }
-    const original = doesImageHaveExistingSource(file);
-    if (original) {
-      validationResult.intermediateImagesTotal++;
-      if (validationResult.intermediateImages[original]) {
-        validationResult.intermediateImages[original] += `, ${file}`;
-      } else {
-        validationResult.intermediateImages[original] = file;
-      }
-    }
-  });
-  await Promise.all(fileValidationPromises);
-  return validationResult;
+    const validationResult = {
+        intermediateImagesTotal: 0,
+        errorFileTypes: [],
+        errorFileNames: [],
+        errorFileSizes: [],
+        errorFileNamesCharCount: [],
+        intermediateImages: {},
+    };
+    const fileValidationPromises = files.map(async (file) => {
+        const isFolder = await (0, exports.isDirectory)(file);
+        const fileExtType = getFileExtType(file, mediaImportConfig.allowedFileTypes);
+        if (isInvalidFile(fileExtType, isFolder)) {
+            validationResult.errorFileTypes.push(file);
+        }
+        if (!isFileSizeValid(file, mediaImportConfig.fileSizeLimitInBytes)) {
+            validationResult.errorFileSizes.push(file);
+        }
+        if ((0, exports.isFileSanitized)(file)) {
+            validationResult.errorFileNames.push(file);
+        }
+        if (!isFileNameCharCountValid(file, mediaImportConfig?.fileNameCharCount)) {
+            validationResult.errorFileNamesCharCount.push(file);
+        }
+        const original = (0, exports.doesImageHaveExistingSource)(file);
+        if (original) {
+            validationResult.intermediateImagesTotal++;
+            if (validationResult.intermediateImages[original]) {
+                validationResult.intermediateImages[original] += `, ${file}`;
+            }
+            else {
+                validationResult.intermediateImages[original] = file;
+            }
+        }
+    });
+    await Promise.all(fileValidationPromises);
+    return validationResult;
 }
-const isDirectory = async file => {
-  const stats = await _fs.default.promises.stat(file);
-  return stats.isDirectory();
+const isDirectory = async (file) => {
+    const stats = await fs_1.default.promises.stat(file);
+    return stats.isDirectory();
 };
 exports.isDirectory = isDirectory;
 const getFileExtType = (file, allowedFileTypes) => {
-  if (!allowedFileTypes) return {
-    ext: null,
-    type: null
-  };
-  return getExtAndType(file, allowedFileTypes);
+    if (!allowedFileTypes)
+        return { ext: null, type: null };
+    return getExtAndType(file, allowedFileTypes);
 };
 const isInvalidFile = (fileExtType, isFolder) => {
-  return !fileExtType.type || !fileExtType.ext || isFolder;
+    return !fileExtType.type || !fileExtType.ext || isFolder;
 };
 const getExtAndType = (filePath, allowedFileTypes) => {
-  const extType = {
-    ext: null,
-    type: null
-  };
-  for (const [key, value] of Object.entries(allowedFileTypes)) {
-    // Create a regular expression to match the file extension
-    // eslint-disable-next-line security/detect-non-literal-regexp
-    const regex = new RegExp(`(?:\\.)(${key})$`, 'i');
-    const matches = regex.exec(filePath);
-    if (matches) {
-      extType.type = value;
-      extType.ext = matches[1];
-      break;
-    }
-  }
-  return extType;
+    const extType = { ext: null, type: null };
+    for (const [key, value] of Object.entries(allowedFileTypes)) {
+        // Create a regular expression to match the file extension
+        // eslint-disable-next-line security/detect-non-literal-regexp
+        const regex = new RegExp(`(?:\\.)(${key})$`, 'i');
+        const matches = regex.exec(filePath);
+        if (matches) {
+            extType.type = value;
+            extType.ext = matches[1];
+            break;
+        }
+    }
+    return extType;
 };
 const isFileSizeValid = (filePathOnDisk, fileSizeLimitInBytes) => {
-  const fileStat = _fs.default.statSync(filePathOnDisk);
-  return fileSizeLimitInBytes >= fileStat.size;
+    const fileStat = fs_1.default.statSync(filePathOnDisk);
+    return fileSizeLimitInBytes >= fileStat.size;
 };
 const isFileNameCharCountValid = (file, fileNameCharCount) => {
-  const filename = _path.default.basename(file);
-  return filename.length <= fileNameCharCount;
+    const filename = path_1.default.basename(file);
+    return filename.length <= fileNameCharCount;
 };
-
 /**
  * End file info validation
  */
-
 /**
  * Character validation global variables
  *
  * Accepted and prohibited characters for filenames
  */
-
 // Accepted characters in filenames
-
-const acceptedCharacters = ['Non-English characters', '(', ')', '[', ']', '~', '&', '#', '%', '=', '’', `'`, '×', '@', '`', '?', '*', '!', '"', '\\', '<', '>', ':', ';', ',', '/', '$', '|', '`', '{', '}', 'spaces'];
+const acceptedCharacters = [
+    'Non-English characters',
+    '(',
+    ')',
+    '[',
+    ']',
+    '~',
+    '&',
+    '#',
+    '%',
+    '=',
+    '’',
+    `'`,
+    '×',
+    '@',
+    '`',
+    '?',
+    '*',
+    '!',
+    '"',
+    '\\',
+    '<',
+    '>',
+    ':',
+    ';',
+    ',',
+    '/',
+    '$',
+    '|',
+    '`',
+    '{',
+    '}',
+    'spaces',
+];
 const acceptedCharactersSet = new Set(acceptedCharacters); // Prevent duplicates with a Set
-
 // Prohibited characters in filenames
 const prohibitedCharacters = ['+', '%20'];
 const prohibitedCharactersSet = new Set(prohibitedCharacters);
-
 /**
  * Recommendations
  *
  * Recommend alternatives to invalid folders or files
  */
-
 // Recommend the WordPress year/month file structure for media files
 const recommendedFileStructure = () => {
-  console.log(_chalk.default.underline('We recommend the WordPress default folder structure for your media files: \n\n') + _chalk.default.underline('Single sites:') + _chalk.default.yellow('`uploads/year/month/image.png`\n') + ' e.g.-' + _chalk.default.yellow('`uploads/2020/06/image.png`\n') + _chalk.default.underline('Multisites:') + _chalk.default.cyan('`uploads/sites/siteID/year/month/image.png`\n') + ' e.g.-' + _chalk.default.cyan('`uploads/sites/5/2020/06/images.png`\n'));
-  console.log('------------------------------------------------------------');
-  console.log();
+    console.log(chalk_1.default.underline('We recommend the WordPress default folder structure for your media files: \n\n') +
+        chalk_1.default.underline('Single sites:') +
+        chalk_1.default.yellow('`uploads/year/month/image.png`\n') +
+        ' e.g.-' +
+        chalk_1.default.yellow('`uploads/2020/06/image.png`\n') +
+        chalk_1.default.underline('Multisites:') +
+        chalk_1.default.cyan('`uploads/sites/siteID/year/month/image.png`\n') +
+        ' e.g.-' +
+        chalk_1.default.cyan('`uploads/sites/5/2020/06/images.png`\n'));
+    console.log('------------------------------------------------------------');
+    console.log();
 };
-
 // Recommend accepted file types
-const recommendAcceptableFileTypes = allowedFileTypesString => {
-  console.log('Accepted file types: \n\n' + _chalk.default.magenta(`${allowedFileTypesString}`));
-  console.log();
+const recommendAcceptableFileTypes = (allowedFileTypesString) => {
+    console.log('Accepted file types: \n\n' + chalk_1.default.magenta(`${allowedFileTypesString}`));
+    console.log();
 };
-
 // Accepted file name characters
 const recommendAcceptableFileNames = () => {
-  const allowedCharacters = [...acceptedCharactersSet].join(' ');
-  const notAllowedCharacters = [...prohibitedCharactersSet].join(' ');
-  console.log('The following characters are allowed in file names:\n' + _chalk.default.green(`All special characters, including: ${allowedCharacters}\n\n`) + 'The following characters are prohibited in file names:\n' + _chalk.default.red(`Encoded or alternate whitespace, such as ${notAllowedCharacters}, are converted to proper spaces\n`));
+    const allowedCharacters = [...acceptedCharactersSet].join(' ');
+    const notAllowedCharacters = [...prohibitedCharactersSet].join(' ');
+    console.log('The following characters are allowed in file names:\n' +
+        chalk_1.default.green(`All special characters, including: ${allowedCharacters}\n\n`) +
+        'The following characters are prohibited in file names:\n' +
+        chalk_1.default.red(`Encoded or alternate whitespace, such as ${notAllowedCharacters}, are converted to proper spaces\n`));
 };
-
 /**
  * Nested Directory Search
  *
@@ -165,133 +193,107 @@ const recommendAcceptableFileNames = () => {
  */
 const files = [];
 const folderStructureObj = {};
-const findNestedDirectories = directory => {
-  let nestedDirectories;
-  try {
-    // Read nested directories within the given directory
-    nestedDirectories = _fs.default.readdirSync(directory);
-
-    // Filter out hidden files such as .DS_Store
-    nestedDirectories = nestedDirectories.filter(file => !/(^|\/)\.[^/.]/g.test(file));
-    nestedDirectories.forEach(dir => {
-      // Concatenate the file path of the parent directory with the nested directory
-      const filePath = _path.default.join(directory, dir);
-      const statSync = _fs.default.statSync(filePath); // Get stats on the file/folder
-
-      // Keep looking for nested directories until we hit individual files
-      if (statSync.isDirectory()) {
-        findNestedDirectories(filePath);
-      } else {
-        // Once we hit media files, add the path of all existing folders
-        // as object keys to validate folder structure later on
-        folderStructureObj[directory] = true;
-
-        // Also, push individual files to an array to do individual file validations later on
-        return files.push(filePath);
-      }
-    });
-  } catch (error) {
-    console.error(_chalk.default.red('✕'), ` Error: Cannot read nested directory: ${directory}. Reason: ${error.message}`);
-    return;
-  }
-  return {
-    files,
-    folderStructureObj
-  };
+const findNestedDirectories = (directory) => {
+    let nestedDirectories;
+    try {
+        // Read nested directories within the given directory
+        nestedDirectories = fs_1.default.readdirSync(directory);
+        // Filter out hidden files such as .DS_Store
+        nestedDirectories = nestedDirectories.filter(file => !/(^|\/)\.[^/.]/g.test(file));
+        nestedDirectories.forEach(dir => {
+            // Concatenate the file path of the parent directory with the nested directory
+            const filePath = path_1.default.join(directory, dir);
+            const statSync = fs_1.default.statSync(filePath); // Get stats on the file/folder
+            // Keep looking for nested directories until we hit individual files
+            if (statSync.isDirectory()) {
+                (0, exports.findNestedDirectories)(filePath);
+            }
+            else {
+                // Once we hit media files, add the path of all existing folders
+                // as object keys to validate folder structure later on
+                folderStructureObj[directory] = true;
+                // Also, push individual files to an array to do individual file validations later on
+                return files.push(filePath);
+            }
+        });
+    }
+    catch (error) {
+        console.error(chalk_1.default.red('✕'), ` Error: Cannot read nested directory: ${directory}. Reason: ${error.message}`);
+        return;
+    }
+    return { files, folderStructureObj };
 };
-
-/**
- * Folder structure validation
- *
- * Identify the index position of each directory to validate the folder structure
- *
- * @param {string}  folderPath Path of the entire folder structure
- * @param {boolean} sites      Check if site is a multisite or single site
- * @return {Object} indexes
- */
 exports.findNestedDirectories = findNestedDirectories;
 function getIndexPositionOfFolders(folderPath, sites = false) {
-  let sitesIndex;
-  let siteIDIndex;
-  let yearIndex;
-  let monthIndex;
-  let pathMutate = folderPath; // Mutate `path` for multisites
-
-  // Turn the path into an array to determine index position
-  const directories = pathMutate.split('/');
-
-  /**
-   * Upload folder
-   *
-   * Find if an `uploads` folder exists and return its index position
-   */
-  const uploadsIndex = directories.indexOf('uploads');
-
-  /**
-   * Multisite folder
-   *
-   * If a sites directory exists, find the directory and return its index position
-   * Find if a siteID folder exists via regex, then obtain that value
-   */
-  if (sites) {
-    sitesIndex = directories.indexOf('sites');
-    const regexSiteID = /\/sites\/(\d+)/g;
-    const siteID = regexSiteID.exec(pathMutate); // Returns an array with the regex-matching value
-
-    if (siteID) {
-      siteIDIndex = directories.indexOf(siteID[1]);
-
-      // Remove the multisite-specific path to avoid confusing a 2 digit site ID with the month
-      // e.g.- `uploads/sites/11/2020/06` -> `uploads/2020/06`
-      pathMutate = pathMutate.replace(siteID[0], '');
-    }
-  }
-
-  /**
-   * Year folder
-   *
-   * Find if a year folder exists via a four digit regex matching pattern,
-   * then obtain that value
-   */
-  const regexYear = /\b\d{4}\b/g;
-  const year = regexYear.exec(pathMutate); // Returns an array with the regex-matching value
-
-  if (year) {
-    yearIndex = directories.indexOf(year[0]);
-  }
-
-  /**
-   * Month folder
-   *
-   * Find if a month folder exists via a two digit regex matching pattern,
-   * then obtain that value
-   */
-  const regexMonth = /\b\d{2}\b/g;
-  const month = regexMonth.exec(pathMutate); // Returns an array with the regex-matching value
-
-  if (month) {
-    monthIndex = directories.indexOf(month[0]);
-  }
-
-  // Multisite
-  if (sites) {
+    let sitesIndex;
+    let siteIDIndex;
+    let yearIndex;
+    let monthIndex;
+    let pathMutate = folderPath; // Mutate `path` for multisites
+    // Turn the path into an array to determine index position
+    const directories = pathMutate.split('/');
+    /**
+     * Upload folder
+     *
+     * Find if an `uploads` folder exists and return its index position
+     */
+    const uploadsIndex = directories.indexOf('uploads');
+    /**
+     * Multisite folder
+     *
+     * If a sites directory exists, find the directory and return its index position
+     * Find if a siteID folder exists via regex, then obtain that value
+     */
+    if (sites) {
+        sitesIndex = directories.indexOf('sites');
+        const regexSiteID = /\/sites\/(\d+)/g;
+        const siteID = regexSiteID.exec(pathMutate); // Returns an array with the regex-matching value
+        if (siteID) {
+            siteIDIndex = directories.indexOf(siteID[1]);
+            // Remove the multisite-specific path to avoid confusing a 2 digit site ID with the month
+            // e.g.- `uploads/sites/11/2020/06` -> `uploads/2020/06`
+            pathMutate = pathMutate.replace(siteID[0], '');
+        }
+    }
+    /**
+     * Year folder
+     *
+     * Find if a year folder exists via a four digit regex matching pattern,
+     * then obtain that value
+     */
+    const regexYear = /\b\d{4}\b/g;
+    const year = regexYear.exec(pathMutate); // Returns an array with the regex-matching value
+    if (year) {
+        yearIndex = directories.indexOf(year[0]);
+    }
+    /**
+     * Month folder
+     *
+     * Find if a month folder exists via a two digit regex matching pattern,
+     * then obtain that value
+     */
+    const regexMonth = /\b\d{2}\b/g;
+    const month = regexMonth.exec(pathMutate); // Returns an array with the regex-matching value
+    if (month) {
+        monthIndex = directories.indexOf(month[0]);
+    }
+    // Multisite
+    if (sites) {
+        return {
+            uploadsIndex,
+            sitesIndex,
+            siteIDIndex,
+            yearIndex,
+            monthIndex,
+        };
+    }
+    // Single site
     return {
-      uploadsIndex,
-      sitesIndex,
-      siteIDIndex,
-      yearIndex,
-      monthIndex
+        uploadsIndex,
+        yearIndex,
+        monthIndex,
     };
-  }
-
-  // Single site
-  return {
-    uploadsIndex,
-    yearIndex,
-    monthIndex
-  };
 }
-
 /**
  * Single site folder structure validation
  *
@@ -304,57 +306,48 @@ function getIndexPositionOfFolders(folderPath, sites = false) {
  * @param {string} folderPath Path of the entire folder structure
  * @return {string|null} Returns null if the folder structure is good; else, returns the folder path
  */
-const singleSiteValidation = folderPath => {
-  let errors = 0; // Tally individual folder errors
-
-  console.log(_chalk.default.bold('Folder:'), _chalk.default.cyan(`${folderPath}`));
-
-  // Use destructuring to retrieve the index position of each folder
-  const {
-    uploadsIndex,
-    yearIndex,
-    monthIndex
-  } = getIndexPositionOfFolders(folderPath);
-
-  /**
-   * Logging
-   */
-
-  // Uploads folder
-  if (uploadsIndex === 0) {
-    console.log();
-    console.log('✅ File structure: Uploads directory exists');
-  } else {
-    console.log();
-    console.log(_chalk.default.yellow('✕'), 'Recommended: Media files should reside in an', _chalk.default.magenta('`uploads`'), 'directory');
-    errors++;
-  }
-
-  // Year folder
-  if (yearIndex && yearIndex === 1) {
-    console.log('✅ File structure: Year directory exists (format: YYYY)');
-  } else {
-    console.log(_chalk.default.yellow('✕'), 'Recommended: Structure your WordPress media files into', _chalk.default.magenta('`uploads/YYYY`'), 'directories');
-    errors++;
-  }
-
-  // Month folder
-  if (monthIndex && monthIndex === 2) {
-    console.log('✅ File structure: Month directory exists (format: MM)');
-    console.log();
-  } else {
-    console.log(_chalk.default.yellow('✕'), 'Recommended: Structure your WordPress media files into', _chalk.default.magenta('`uploads/YYYY/MM`'), 'directories');
-    console.log();
-    errors++;
-  }
-
-  // Push individual folder errors to the collective array of errors
-  if (errors > 0) {
-    return folderPath;
-  }
-  return null;
+const singleSiteValidation = (folderPath) => {
+    let errors = 0; // Tally individual folder errors
+    console.log(chalk_1.default.bold('Folder:'), chalk_1.default.cyan(`${folderPath}`));
+    // Use destructuring to retrieve the index position of each folder
+    const { uploadsIndex, yearIndex, monthIndex } = getIndexPositionOfFolders(folderPath);
+    /**
+     * Logging
+     */
+    // Uploads folder
+    if (uploadsIndex === 0) {
+        console.log();
+        console.log('✅ File structure: Uploads directory exists');
+    }
+    else {
+        console.log();
+        console.log(chalk_1.default.yellow('✕'), 'Recommended: Media files should reside in an', chalk_1.default.magenta('`uploads`'), 'directory');
+        errors++;
+    }
+    // Year folder
+    if (yearIndex && yearIndex === 1) {
+        console.log('✅ File structure: Year directory exists (format: YYYY)');
+    }
+    else {
+        console.log(chalk_1.default.yellow('✕'), 'Recommended: Structure your WordPress media files into', chalk_1.default.magenta('`uploads/YYYY`'), 'directories');
+        errors++;
+    }
+    // Month folder
+    if (monthIndex && monthIndex === 2) {
+        console.log('✅ File structure: Month directory exists (format: MM)');
+        console.log();
+    }
+    else {
+        console.log(chalk_1.default.yellow('✕'), 'Recommended: Structure your WordPress media files into', chalk_1.default.magenta('`uploads/YYYY/MM`'), 'directories');
+        console.log();
+        errors++;
+    }
+    // Push individual folder errors to the collective array of errors
+    if (errors > 0) {
+        return folderPath;
+    }
+    return null;
 };
-
 /**
  * Multisite folder structure validation
  *
@@ -368,76 +361,65 @@ const singleSiteValidation = folderPath => {
  * @param {string} folderPath Path of the entire folder structure
  * @return {string|null} Returns null if the folder structure is good; else, returns the folder path
  */
-const multiSiteValidation = folderPath => {
-  let errors = 0; // Tally individual folder errors
-
-  console.log(_chalk.default.bold('Folder:'), _chalk.default.cyan(`${folderPath}`));
-
-  // Use destructuring to retrieve the index position of each folder
-  const {
-    uploadsIndex,
-    sitesIndex,
-    siteIDIndex,
-    yearIndex,
-    monthIndex
-  } = getIndexPositionOfFolders(folderPath, true);
-
-  /**
-   * Logging
-   */
-
-  // Uploads folder
-  if (uploadsIndex === 0) {
-    console.log();
-    console.log('✅ File structure: Uploads directory exists');
-  } else {
-    console.log();
-    console.log(_chalk.default.yellow('✕'), 'Recommended: Media files should reside in an', _chalk.default.magenta('`uploads`'), 'directory');
-    errors++;
-  }
-
-  // Sites folder
-  if (sitesIndex === 1) {
-    console.log('✅ File structure: Sites directory exists');
-  } else {
-    console.log();
-    console.log(_chalk.default.yellow('✕'), 'Recommended: Media files should reside in an', _chalk.default.magenta('`sites`'), 'directory');
-    errors++;
-  }
-
-  // Site ID folder
-  if (siteIDIndex && siteIDIndex === 2) {
-    console.log('✅ File structure: Site ID directory exists');
-  } else {
-    console.log(_chalk.default.yellow('✕'), 'Recommended: Structure your WordPress media files into', _chalk.default.magenta('`uploads/sites/<siteID>`'), 'directories');
-    errors++;
-  }
-
-  // Year folder
-  if (yearIndex && yearIndex === 3) {
-    console.log('✅ File structure: Year directory exists (format: YYYY)');
-  } else {
-    console.log(_chalk.default.yellow('✕'), 'Recommended: Structure your WordPress media files into', _chalk.default.magenta('`uploads/sites/<siteID>/YYYY`'), 'directories');
-    errors++;
-  }
-
-  // Month folder
-  if (monthIndex && monthIndex === 4) {
-    console.log('✅ File structure: Month directory exists (format: MM)');
-    console.log();
-  } else {
-    console.log(_chalk.default.yellow('✕'), 'Recommended: Structure your WordPress media files into', _chalk.default.magenta('`uploads/sites/<siteID>/YYYY/MM`'), 'directories');
-    console.log();
-    errors++;
-  }
-
-  // Push individual folder errors to the collective array of errors
-  if (errors > 0) {
-    return folderPath;
-  }
-  return null;
+const multiSiteValidation = (folderPath) => {
+    let errors = 0; // Tally individual folder errors
+    console.log(chalk_1.default.bold('Folder:'), chalk_1.default.cyan(`${folderPath}`));
+    // Use destructuring to retrieve the index position of each folder
+    const { uploadsIndex, sitesIndex, siteIDIndex, yearIndex, monthIndex } = getIndexPositionOfFolders(folderPath, true);
+    /**
+     * Logging
+     */
+    // Uploads folder
+    if (uploadsIndex === 0) {
+        console.log();
+        console.log('✅ File structure: Uploads directory exists');
+    }
+    else {
+        console.log();
+        console.log(chalk_1.default.yellow('✕'), 'Recommended: Media files should reside in an', chalk_1.default.magenta('`uploads`'), 'directory');
+        errors++;
+    }
+    // Sites folder
+    if (sitesIndex === 1) {
+        console.log('✅ File structure: Sites directory exists');
+    }
+    else {
+        console.log();
+        console.log(chalk_1.default.yellow('✕'), 'Recommended: Media files should reside in an', chalk_1.default.magenta('`sites`'), 'directory');
+        errors++;
+    }
+    // Site ID folder
+    if (siteIDIndex && siteIDIndex === 2) {
+        console.log('✅ File structure: Site ID directory exists');
+    }
+    else {
+        console.log(chalk_1.default.yellow('✕'), 'Recommended: Structure your WordPress media files into', chalk_1.default.magenta('`uploads/sites/<siteID>`'), 'directories');
+        errors++;
+    }
+    // Year folder
+    if (yearIndex && yearIndex === 3) {
+        console.log('✅ File structure: Year directory exists (format: YYYY)');
+    }
+    else {
+        console.log(chalk_1.default.yellow('✕'), 'Recommended: Structure your WordPress media files into', chalk_1.default.magenta('`uploads/sites/<siteID>/YYYY`'), 'directories');
+        errors++;
+    }
+    // Month folder
+    if (monthIndex && monthIndex === 4) {
+        console.log('✅ File structure: Month directory exists (format: MM)');
+        console.log();
+    }
+    else {
+        console.log(chalk_1.default.yellow('✕'), 'Recommended: Structure your WordPress media files into', chalk_1.default.magenta('`uploads/sites/<siteID>/YYYY/MM`'), 'directories');
+        console.log();
+        errors++;
+    }
+    // Push individual folder errors to the collective array of errors
+    if (errors > 0) {
+        return folderPath;
+    }
+    return null;
 };
-
 /**
  * Folder structure validation
  *
@@ -446,32 +428,31 @@ const multiSiteValidation = folderPath => {
  * @param {Array} folderStructureKeys Array of paths for each folder
  * @return {Array} All the erroneous folder paths in an array
  */
-const folderStructureValidation = folderStructureKeys => {
-  // Collect all the folder paths that aren't in the recommended structure
-  const allErrors = [];
-
-  // Loop through each path to validate the folder structure format
-  for (const folderPath of folderStructureKeys) {
-    let badFolders;
-
-    // Check for multisite folder structure
-    if (folderPath.search('sites') !== -1) {
-      // Returns null if the folder path is good, otherwise it returns the folder path itself
-      badFolders = multiSiteValidation(folderPath);
-    } else {
-      // Returns null if the folder path is good, otherwise it returns the folder path itself
-      badFolders = singleSiteValidation(folderPath);
-    }
-    if (badFolders) {
-      allErrors.push(badFolders);
-    }
-  }
-  if (allErrors.length > 0) {
-    recommendedFileStructure();
-  }
-  return allErrors;
+const folderStructureValidation = (folderStructureKeys) => {
+    // Collect all the folder paths that aren't in the recommended structure
+    const allErrors = [];
+    // Loop through each path to validate the folder structure format
+    for (const folderPath of folderStructureKeys) {
+        let badFolders;
+        // Check for multisite folder structure
+        if (folderPath.search('sites') !== -1) {
+            // Returns null if the folder path is good, otherwise it returns the folder path itself
+            badFolders = multiSiteValidation(folderPath);
+        }
+        else {
+            // Returns null if the folder path is good, otherwise it returns the folder path itself
+            badFolders = singleSiteValidation(folderPath);
+        }
+        if (badFolders) {
+            allErrors.push(badFolders);
+        }
+    }
+    if (allErrors.length > 0) {
+        recommendedFileStructure();
+    }
+    return allErrors;
 };
-
+exports.folderStructureValidation = folderStructureValidation;
 /**
  * Character validation
  *
@@ -481,21 +462,17 @@ const folderStructureValidation = folderStructureKeys => {
  * @param {string} file - The current file being validated
  * @return {boolean} - Checks if the filename has been sanitized
  */
-exports.folderStructureValidation = folderStructureValidation;
-const isFileSanitized = file => {
-  const filename = _path.default.basename(file);
-  let sanitizedFile = filename;
-
-  // Convert encoded or alternate whitespace into a proper space
-  // Encoded spaces (%20), no-break spaces - keeps words together (\u00A0), and plus signs
-  const regexSpaces = /\u00A0|(%20)|\+/g;
-  sanitizedFile = sanitizedFile.replace(regexSpaces, ' ');
-
-  // Check if the filename has been sanitized
-
-  return sanitizedFile !== filename;
+const isFileSanitized = (file) => {
+    const filename = path_1.default.basename(file);
+    let sanitizedFile = filename;
+    // Convert encoded or alternate whitespace into a proper space
+    // Encoded spaces (%20), no-break spaces - keeps words together (\u00A0), and plus signs
+    const regexSpaces = /\u00A0|(%20)|\+/g;
+    sanitizedFile = sanitizedFile.replace(regexSpaces, ' ');
+    // Check if the filename has been sanitized
+    return sanitizedFile !== filename;
 };
-
+exports.isFileSanitized = isFileSanitized;
 /**
  * Intermediate image validation
  *
@@ -510,123 +487,137 @@ const isFileSanitized = file => {
  * @param {string} filename The current file being validated
  * @return {Array} Returns an array of the matching regex characters
  */
-exports.isFileSanitized = isFileSanitized;
-const identifyIntermediateImage = filename => {
-  // eslint-disable-next-line security/detect-unsafe-regex
-  const regex = /([_-])?(\d+x\d+)(@\d+\w)?(\.\w{3,4})$/;
-  return filename.match(regex); // NOSONAR
+const identifyIntermediateImage = (filename) => {
+    // eslint-disable-next-line security/detect-unsafe-regex
+    const regex = /([_-])?(\d+x\d+)(@\d+\w)?(\.\w{3,4})$/;
+    return filename.match(regex); // NOSONAR
 };
-
 // Check if an intermediate image has an existing original (source) image
-const doesImageHaveExistingSource = file => {
-  const filename = _path.default.basename(file);
-
-  // Intermediate image regex check
-  const intermediateImage = identifyIntermediateImage(filename);
-  if (null !== intermediateImage) {
-    const imageSizing = intermediateImage[0]; // First capture group of the regex validation
-    const extension = _path.default.extname(filename).slice(1); // Extension of the path (e.g.- `.jpg`)
-
-    // Filename manipulation: if an image is an intermediate image, strip away the image sizing
-    // e.g.- `panda4000x6000.png` -> `panda.png`
-    const baseFileName = filename.replace(imageSizing, '') + '.' + extension;
-    const splitFolder = file.split('/');
-
-    // Remove the last element (intermediate image filename) and replace it with the original image filename
-    splitFolder.splice(splitFolder.length - 1, 1, baseFileName);
-    const originalImage = splitFolder.join('/');
-
-    // Check if an image with the same path + name (the original) already exists
-    if (_fs.default.existsSync(originalImage)) {
-      return originalImage;
-    }
-  }
-  return false;
+const doesImageHaveExistingSource = (file) => {
+    const filename = path_1.default.basename(file);
+    // Intermediate image regex check
+    const intermediateImage = identifyIntermediateImage(filename);
+    if (null !== intermediateImage) {
+        const imageSizing = intermediateImage[0]; // First capture group of the regex validation
+        const extension = path_1.default.extname(filename).slice(1); // Extension of the path (e.g.- `.jpg`)
+        // Filename manipulation: if an image is an intermediate image, strip away the image sizing
+        // e.g.- `panda4000x6000.png` -> `panda.png`
+        const baseFileName = filename.replace(imageSizing, '') + '.' + extension;
+        const splitFolder = file.split('/');
+        // Remove the last element (intermediate image filename) and replace it with the original image filename
+        splitFolder.splice(splitFolder.length - 1, 1, baseFileName);
+        const originalImage = splitFolder.join('/');
+        // Check if an image with the same path + name (the original) already exists
+        if (fs_1.default.existsSync(originalImage)) {
+            return originalImage;
+        }
+    }
+    return false;
 };
-
+exports.doesImageHaveExistingSource = doesImageHaveExistingSource;
 /**
  * Error logging
  *
  * Log errors for invalid folders or files
  */
-exports.doesImageHaveExistingSource = doesImageHaveExistingSource;
-const logErrors = ({
-  errorType,
-  invalidFiles,
-  limit
-}) => {
-  if (invalidFiles.length === 0) {
-    return;
-  }
-  invalidFiles.forEach(file => {
-    switch (errorType) {
-      case ValidateFilesErrors.INVALID_TYPES:
-        console.error(_chalk.default.red('✕'), 'File extensions: Invalid file type for file: ', _chalk.default.cyan(`${file}`));
-        console.log();
-        recommendAcceptableFileTypes(limit);
-        break;
-      case ValidateFilesErrors.INTERMEDIATE_IMAGES:
-        console.error(_chalk.default.red('✕'), 'Intermediate images: Duplicate files found:\n' + 'Original file: ' + _chalk.default.blue(`${file}\n`) + 'Intermediate images: ' + _chalk.default.cyan(`${limit[file]}\n`));
-        break;
-      case ValidateFilesErrors.INVALID_SIZES:
-        console.error(_chalk.default.red('✕'), `File size cannot be more than ${limit / 1024 / 1024 / 1024} GB`, _chalk.default.cyan(`${file}`));
-        console.log();
-        break;
-      case ValidateFilesErrors.INVALID_NAME_CHARACTER_COUNTS:
-        console.error(_chalk.default.red('✕'), `File name cannot have more than ${limit} characters`, _chalk.default.cyan(`${file}`));
-        break;
-      case ValidateFilesErrors.INVALID_NAMES:
-        console.error(_chalk.default.red('✕'), 'Character validation: Invalid filename for file: ', _chalk.default.cyan(`${file}`));
-        recommendAcceptableFileNames();
-        break;
-      default:
-        console.error(_chalk.default.red('✕'), 'Unknown error type:', errorType);
-    }
-  });
-  console.log();
+const logErrors = ({ errorType, invalidFiles, limit }) => {
+    if (invalidFiles.length === 0) {
+        return;
+    }
+    invalidFiles.forEach(file => {
+        switch (errorType) {
+            case ValidateFilesErrors.INVALID_TYPES:
+                console.error(chalk_1.default.red('✕'), 'File extensions: Invalid file type for file: ', chalk_1.default.cyan(`${file}`));
+                console.log();
+                recommendAcceptableFileTypes(limit);
+                break;
+            case ValidateFilesErrors.INTERMEDIATE_IMAGES:
+                console.error(chalk_1.default.red('✕'), 'Intermediate images: Duplicate files found:\n' +
+                    'Original file: ' +
+                    chalk_1.default.blue(`${file}\n`) +
+                    'Intermediate images: ' +
+                    chalk_1.default.cyan(`${limit[file]}\n`));
+                break;
+            case ValidateFilesErrors.INVALID_SIZES:
+                console.error(chalk_1.default.red('✕'), `File size cannot be more than ${limit / 1024 / 1024 / 1024} GB`, chalk_1.default.cyan(`${file}`));
+                console.log();
+                break;
+            case ValidateFilesErrors.INVALID_NAME_CHARACTER_COUNTS:
+                console.error(chalk_1.default.red('✕'), `File name cannot have more than ${limit} characters`, chalk_1.default.cyan(`${file}`));
+                break;
+            case ValidateFilesErrors.INVALID_NAMES:
+                console.error(chalk_1.default.red('✕'), 'Character validation: Invalid filename for file: ', chalk_1.default.cyan(`${file}`));
+                recommendAcceptableFileNames();
+                break;
+            default:
+                console.error(chalk_1.default.red('✕'), 'Unknown error type:', errorType);
+        }
+    });
+    console.log();
 };
 exports.logErrors = logErrors;
-const summaryLogs = ({
-  folderErrorsLength,
-  intImagesErrorsLength,
-  fileTypeErrorsLength,
-  fileErrorFileSizesLength,
-  filenameErrorsLength,
-  fileNameCharCountErrorsLength,
-  totalFiles,
-  totalFolders
-}) => {
-  const messages = [];
-  if (folderErrorsLength > 0) {
-    messages.push(_chalk.default.bgYellow(' RECOMMENDED ') + _chalk.default.bold.yellow(` ${folderErrorsLength} folders, `) + `${totalFolders} folders total`);
-  } else {
-    messages.push(_chalk.default.bgGreen('    PASS     ') + _chalk.default.bold.green(` ${totalFolders} folders, `) + `${totalFolders} folders total`);
-  }
-  if (intImagesErrorsLength > 0) {
-    messages.push(_chalk.default.white.bgRed('   ERROR     ') + _chalk.default.red(` ${intImagesErrorsLength} intermediate images`) + `, ${totalFiles} files total`);
-  } else {
-    messages.push(_chalk.default.white.bgGreen('    PASS     ') + _chalk.default.green(` ${intImagesErrorsLength} intermediate images`) + `, ${totalFiles} files total`);
-  }
-  if (fileTypeErrorsLength > 0) {
-    messages.push(_chalk.default.white.bgRed('   ERROR     ') + _chalk.default.red(` ${fileTypeErrorsLength} invalid file extensions`) + `, ${totalFiles} files total`);
-  } else {
-    messages.push(_chalk.default.white.bgGreen('    PASS     ') + _chalk.default.green(` ${fileTypeErrorsLength} invalid file extensions`) + `, ${totalFiles} files total`);
-  }
-  if (fileErrorFileSizesLength > 0) {
-    messages.push(_chalk.default.white.bgRed('   ERROR     ') + _chalk.default.red(` ${fileTypeErrorsLength} invalid file sizes`) + `, ${totalFiles} files total`);
-  } else {
-    messages.push(_chalk.default.white.bgGreen('    PASS     ') + _chalk.default.green(` ${fileTypeErrorsLength} invalid file sizes`) + `, ${totalFiles} files total`);
-  }
-  if (filenameErrorsLength) {
-    messages.push(_chalk.default.white.bgRed('   ERROR     ') + _chalk.default.red(` ${filenameErrorsLength} invalid filenames`) + `, ${totalFiles} files total`);
-  } else {
-    messages.push(_chalk.default.bgGreen('    PASS     ') + _chalk.default.green(` ${filenameErrorsLength} invalid filenames`) + `, ${totalFiles} files total`);
-  }
-  if (fileNameCharCountErrorsLength) {
-    messages.push(_chalk.default.white.bgRed('   ERROR     ') + _chalk.default.red(` ${filenameErrorsLength} file names reached the maximum character count limit `) + `, ${totalFiles} files total`);
-  } else {
-    messages.push(_chalk.default.bgGreen('    PASS     ') + _chalk.default.green(` ${filenameErrorsLength} file names reached the maximum character count limit`) + `, ${totalFiles} files total`);
-  }
-  console.log(`\n${messages.join('\n')}\n`);
+const summaryLogs = ({ folderErrorsLength, intImagesErrorsLength, fileTypeErrorsLength, fileErrorFileSizesLength, filenameErrorsLength, fileNameCharCountErrorsLength, totalFiles, totalFolders, }) => {
+    const messages = [];
+    if (folderErrorsLength > 0) {
+        messages.push(chalk_1.default.bgYellow(' RECOMMENDED ') +
+            chalk_1.default.bold.yellow(` ${folderErrorsLength} folders, `) +
+            `${totalFolders} folders total`);
+    }
+    else {
+        messages.push(chalk_1.default.bgGreen('    PASS     ') +
+            chalk_1.default.bold.green(` ${totalFolders} folders, `) +
+            `${totalFolders} folders total`);
+    }
+    if (intImagesErrorsLength > 0) {
+        messages.push(chalk_1.default.white.bgRed('   ERROR     ') +
+            chalk_1.default.red(` ${intImagesErrorsLength} intermediate images`) +
+            `, ${totalFiles} files total`);
+    }
+    else {
+        messages.push(chalk_1.default.white.bgGreen('    PASS     ') +
+            chalk_1.default.green(` ${intImagesErrorsLength} intermediate images`) +
+            `, ${totalFiles} files total`);
+    }
+    if (fileTypeErrorsLength > 0) {
+        messages.push(chalk_1.default.white.bgRed('   ERROR     ') +
+            chalk_1.default.red(` ${fileTypeErrorsLength} invalid file extensions`) +
+            `, ${totalFiles} files total`);
+    }
+    else {
+        messages.push(chalk_1.default.white.bgGreen('    PASS     ') +
+            chalk_1.default.green(` ${fileTypeErrorsLength} invalid file extensions`) +
+            `, ${totalFiles} files total`);
+    }
+    if (fileErrorFileSizesLength > 0) {
+        messages.push(chalk_1.default.white.bgRed('   ERROR     ') +
+            chalk_1.default.red(` ${fileTypeErrorsLength} invalid file sizes`) +
+            `, ${totalFiles} files total`);
+    }
+    else {
+        messages.push(chalk_1.default.white.bgGreen('    PASS     ') +
+            chalk_1.default.green(` ${fileTypeErrorsLength} invalid file sizes`) +
+            `, ${totalFiles} files total`);
+    }
+    if (filenameErrorsLength) {
+        messages.push(chalk_1.default.white.bgRed('   ERROR     ') +
+            chalk_1.default.red(` ${filenameErrorsLength} invalid filenames`) +
+            `, ${totalFiles} files total`);
+    }
+    else {
+        messages.push(chalk_1.default.bgGreen('    PASS     ') +
+            chalk_1.default.green(` ${filenameErrorsLength} invalid filenames`) +
+            `, ${totalFiles} files total`);
+    }
+    if (fileNameCharCountErrorsLength) {
+        messages.push(chalk_1.default.white.bgRed('   ERROR     ') +
+            chalk_1.default.red(` ${filenameErrorsLength} file names reached the maximum character count limit `) +
+            `, ${totalFiles} files total`);
+    }
+    else {
+        messages.push(chalk_1.default.bgGreen('    PASS     ') +
+            chalk_1.default.green(` ${filenameErrorsLength} file names reached the maximum character count limit`) +
+            `, ${totalFiles} files total`);
+    }
+    console.log(`\n${messages.join('\n')}\n`);
 };
-exports.summaryLogs = summaryLogs;
+exports.summaryLogs = summaryLogs;