@oliasoft-open-source/node-json-migrator 2.3.10 → 3.0.0-beta-1

package/dist/plan/validator.js

@@ -1,216 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.warnIfFilesHaveBeenRemovedFromPlan = exports.validatePlan = exports.validateFileName = exports.validateFileDescription = exports.throwIfSequenceNotUnique = exports.throwIfSequenceHasIntegerGaps = exports.throwIfSequenceHasChanged = exports.throwIfFilesNotFound = exports.throwIfFilesHaveChanged = exports.throwIfFileNamesNotUnique = exports.throwIfFileNamesInvalid = void 0;
-var _chalk = _interopRequireDefault(require("chalk"));
-var _lodash = require("lodash");
-var _ajv = _interopRequireDefault(require("ajv"));
-var _ajvErrors = _interopRequireDefault(require("ajv-errors"));
-var _planSchema = _interopRequireDefault(require("./plan.schema.json"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-const isNonEmptyString = input => (0, _lodash.isString)(input) && input.length > 0;
-const ajv = new _ajv.default({
-  allErrors: true
-});
-(0, _ajvErrors.default)(ajv);
-
-//sequence pattern: https://regex101.com/r/4qHZLm/1
-const planValidator = ajv.compile(_planSchema.default);
-
-/**
- * Validates if a plan matches the schema
- *
- * @param {Array<Object>} plan
- * @returns {Boolean} valid
- */
-
-const validatePlan = plan => {
-  const valid = planValidator(plan);
-  const {
-    errors
-  } = planValidator;
-  if (errors?.length) {
-    errors.forEach(e => console.error(`${e.message}${e.instancePath ? `at ${e.instancePath}` : ''}`));
-  }
-  return valid;
-};
-
-/**
- * Validates if file description format is valid
- *
- * @param {String} description
- * @returns {Boolean} valid
- */
-exports.validatePlan = validatePlan;
-const validateFileDescription = description => {
-  if (!description) {
-    return false;
-  }
-  //https://regex101.com/r/IO0dzF/1
-  const validFileName = /^([a-z]+|(([a-z]+-)+[a-z]+))$/g;
-  return validFileName.test(description);
-};
-
-/**
- * Validates if fileName format is valid
- *
- * @param {String} fileName
- * @returns {Boolean} valid
- */
-exports.validateFileDescription = validateFileDescription;
-const validateFileName = fileName => {
-  //https://regex101.com/r/EX2RlS/1
-  const validFileName = /^([a-z]+|(([a-z]+-)+[a-z]+))(.js|.skip.js)$/g;
-  return validFileName.test(fileName);
-};
-
-/**
- * Throws if file names are invalid
- *
- * @param {Array<Object>} migrationEntries
- */
-exports.validateFileName = validateFileName;
-const throwIfFileNamesInvalid = fileEntries => {
-  const invalidFileNames = fileEntries.filter(f => !f.isValidFileName).map(f => f.fileName);
-  if (invalidFileNames.length) {
-    invalidFileNames.forEach(name => console.error(_chalk.default.red(name)));
-    throw new Error('Invalid migration filename format (use kebab-case)');
-  }
-};
-
-/**
- * Warns if files have been removed
- *
- * @param {Array<Object>} migrationEntries
- * @param {Array<Object>} historicalMigrations
- */
-exports.throwIfFileNamesInvalid = throwIfFileNamesInvalid;
-const warnIfFilesHaveBeenRemovedFromPlan = (migrationEntries, historicalMigrations) => {
-  const fileNames = migrationEntries.map(f => f.fileName);
-  const deletedFilesNames = historicalMigrations.filter(e => !fileNames.includes(e.fileName)).map(e => e.fileName);
-  if (deletedFilesNames.length) {
-    deletedFilesNames.forEach(name => console.warn(_chalk.default.yellow(name)));
-    console.warn(_chalk.default.yellow('Previously executed migration files have been deleted from plan.json (rename file to .skip.js and replace with a new file instead)'));
-  }
-};
-
-/**
- * Throws error if any pre-existing file has changed
- *
- * @param {Array<Object>} migrationEntries
- */
-exports.warnIfFilesHaveBeenRemovedFromPlan = warnIfFilesHaveBeenRemovedFromPlan;
-const throwIfFilesHaveChanged = migrationEntries => {
-  const changedFilesNames = migrationEntries.filter(m => {
-    const {
-      fileHash,
-      fileHashFromPlan,
-      fileHashFromHistory,
-      skippedFileHashes
-    } = m;
-    const matchesHistory = !isNonEmptyString(fileHashFromHistory) || [fileHash].concat(skippedFileHashes).includes(fileHashFromHistory);
-    const matchesPlan = !isNonEmptyString(fileHashFromPlan) || [fileHash].concat(skippedFileHashes).includes(fileHashFromPlan);
-    return !(matchesHistory && matchesPlan);
-  }).map(f => f.fileName);
-  if (changedFilesNames.length) {
-    changedFilesNames.forEach(name => console.error(_chalk.default.red(name)));
-    throw new Error('Not allowed to change migration files (for unreleased local work, you can use the `force` option)');
-  }
-};
-
-/**
- * Throws error if previous sequence numbers have changed
- *
- * @param {Array<Object>} migrationEntries
- */
-exports.throwIfFilesHaveChanged = throwIfFilesHaveChanged;
-const throwIfSequenceHasChanged = migrationEntries => {
-  const changeSequences = migrationEntries.filter(m => {
-    const {
-      sequence,
-      sequenceFromHistory
-    } = m;
-    const changed = (0, _lodash.isString)(sequenceFromHistory) && sequenceFromHistory !== sequence;
-    return changed;
-  }).map(f => f.fileName);
-  if (changeSequences.length) {
-    changeSequences.forEach(name => console.error(_chalk.default.red(name)));
-    throw new Error('Not allowed to change migration sequences in plan.json');
-  }
-};
-
-/**
- * Throws error if sequence numbers are not unique
- *
- * @param {Array<Object>} migrationEntries
- */
-exports.throwIfSequenceHasChanged = throwIfSequenceHasChanged;
-const throwIfSequenceNotUnique = migrationEntries => {
-  const sequenceNumbers = migrationEntries.map(f => f.sequence);
-  const repeatedSequenceNumbers = sequenceNumbers.filter(
-  //https://stackoverflow.com/a/59517965/942635
-  (s => v => s.has(v) || !s.add(v))(new Set()));
-  const duplicates = migrationEntries.filter(f => repeatedSequenceNumbers.includes(f.sequence)).map(f => f.fileName);
-  if (duplicates.length) {
-    duplicates.forEach(fileName => console.error(_chalk.default.red(fileName)));
-    throw new Error('Migrations must have unique sequence numbers in plan.json');
-  }
-};
-
-/**
- * Throws error if sequence numbers are not unique
- *
- * @param {Array<Object>} migrationEntries
- */
-exports.throwIfSequenceNotUnique = throwIfSequenceNotUnique;
-const throwIfSequenceHasIntegerGaps = migrationEntries => {
-  const toInteger = sequence => parseInt(sequence.split('.')[0], 10);
-  const unique = arr => Array.from(new Set(arr));
-  const sequences = migrationEntries.map(s => s.sequence);
-  const sequenceIntegers = sequences.map(s => toInteger(s));
-  const uniqueSequenceIntegers = unique(sequenceIntegers);
-  const orderedUniqueSequenceIntegers = uniqueSequenceIntegers.sort((a, b) => a - b);
-  const max = orderedUniqueSequenceIntegers[orderedUniqueSequenceIntegers.length - 1];
-  const expected = Array.from({
-    length: max
-  }, (v, k) => k + 1);
-  const missing = (0, _lodash.xor)(orderedUniqueSequenceIntegers, expected);
-  if (missing.length) {
-    throw new Error(`Migration sequence numbers in plan.json have unexpected gaps: ${missing.join(', ')}`);
-  }
-};
-
-/**
- * Throws error if file names are not unique
- *
- * @param {Array<Object>} migrationEntries
- */
-exports.throwIfSequenceHasIntegerGaps = throwIfSequenceHasIntegerGaps;
-const throwIfFileNamesNotUnique = migrationEntries => {
-  const fileNames = migrationEntries.map(f => f.fileName);
-  const repeatedFileNames = fileNames.filter(
-  //https://stackoverflow.com/a/59517965/942635
-  (s => v => s.has(v) || !s.add(v))(new Set()));
-  if (repeatedFileNames.length) {
-    repeatedFileNames.forEach(fileName => console.error(_chalk.default.red(fileName)));
-    throw new Error('Migration file names must be unique');
-  }
-};
-
-/**
- * Throws error if files listed in plan.json are found
- *
- * @param {Array<Object>} migrationEntries
- * @param {Boolean} importModule
- */
-exports.throwIfFileNamesNotUnique = throwIfFileNamesNotUnique;
-const throwIfFilesNotFound = (migrationEntries, importModule) => {
-  const migrationsWithoutFiles = migrationEntries.filter(m => !m.script || importModule && !m.script && !m.migrator);
-  if (migrationsWithoutFiles.length) {
-    migrationsWithoutFiles.forEach(migration => console.error(_chalk.default.red(migration.fileName)));
-    throw new Error('Migration files from plan.json are missing from filesystem');
-  }
-};
-exports.throwIfFilesNotFound = throwIfFilesNotFound;