@oliasoft-open-source/node-json-migrator 2.1.0 → 2.3.0-beta-1

package/dist/create/create.js

@@ -4,19 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createMigration = void 0;
-
 var _path = _interopRequireDefault(require("path"));
-
 var _fs = require("fs");
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _validator = require("../plan/validator");
-
 var _plan = require("../plan/plan");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const templateMigrationFile = `import produce from 'immer';
 //other imports not allowed
 
@@ -24,7 +17,6 @@ export default (dataset) => produce(dataset, (draft) => {
   // https://immerjs.github.io/immer/produce#example
 });
 `;
-
 const templateTestFile = fileName => `import migrate from './${fileName}';
 
 describe('describe dataset change', () => {
@@ -39,6 +31,7 @@ describe('describe dataset change', () => {
   });
 });
 `;
+
 /**
  * Generate a new dataset migration
  *
@@ -46,22 +39,16 @@ describe('describe dataset change', () => {
  * @param {String} description description of change-set / migration
  */
 
-
 const createMigration = async (directory, description) => {
   if (!(0, _validator.validateFileDescription)(description)) {
     throw new Error('Invalid migration description');
   }
-
   try {
     const directoryFullPath = _path.default.resolve(directory, description);
-
     const fileName = `${description}.js`;
     const testFileName = `${description}.test.js`;
-
     const filePath = _path.default.resolve(directoryFullPath, fileName);
-
     const testFilePath = _path.default.resolve(directoryFullPath, testFileName);
-
     await _fs.promises.mkdir(directoryFullPath, {
       recursive: true
     });
@@ -86,5 +73,4 @@ const createMigration = async (directory, description) => {
     throw new Error('Unable to create migration file');
   }
 };
-
 exports.createMigration = createMigration;

package/dist/database/database.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.replaceMigrationsRecords = exports.migrationTablesExist = exports.insertVersions = exports.insertMigrationsRecords = exports.getVersions = exports.getPlanFromVersion = exports.getMigrationRecords = exports.createMigrationsTables = void 0;
-
 const migrationTablesExist = (db, entity) => {
   const query = `
     SELECT EXISTS (
@@ -15,9 +14,7 @@ const migrationTablesExist = (db, entity) => {
   `;
   return db.any(query);
 };
-
 exports.migrationTablesExist = migrationTablesExist;
-
 const createMigrationsTables = (db, entity) => {
   const query = `
     CREATE TABLE IF NOT EXISTS ${entity}_migrations (
@@ -36,9 +33,7 @@ const createMigrationsTables = (db, entity) => {
   `;
   return db.any(query);
 };
-
 exports.createMigrationsTables = createMigrationsTables;
-
 const getMigrationRecords = (db, entity) => {
   const query = `
     SELECT file_hash, file_name, sequence FROM ${entity}_migrations
@@ -50,9 +45,7 @@ const getMigrationRecords = (db, entity) => {
     sequence: r.sequence
   })));
 };
-
 exports.getMigrationRecords = getMigrationRecords;
-
 const insertMigrationsRecords = (db, pgpHelpers, entity, migrations) => {
   if (migrations.length) {
     const toInsert = migrations.map(m => ({
@@ -60,7 +53,6 @@ const insertMigrationsRecords = (db, pgpHelpers, entity, migrations) => {
       file_hash: m.fileHash,
       sequence: m.sequence
     })).filter(m => m.file_hash !== null); //can't insert null file hash
-
     const cs = new pgpHelpers.ColumnSet(['file_name', 'file_hash', 'sequence'], {
       table: `${entity}_migrations`
     });
@@ -69,9 +61,7 @@ const insertMigrationsRecords = (db, pgpHelpers, entity, migrations) => {
     return db.none(query);
   }
 };
-
 exports.insertMigrationsRecords = insertMigrationsRecords;
-
 const replaceMigrationsRecords = async (db, pgpHelpers, entity, migrations) => {
   /*
     OW-9043: Table is used for change detection/tracking. DELETE ALL not
@@ -82,9 +72,7 @@ const replaceMigrationsRecords = async (db, pgpHelpers, entity, migrations) => {
   await db.none(truncate);
   await insertMigrationsRecords(db, pgpHelpers, entity, migrations);
 };
-
 exports.replaceMigrationsRecords = replaceMigrationsRecords;
-
 const insertVersions = (db, pgpHelpers, entity, records) => {
   const cs = new pgpHelpers.ColumnSet(['version', 'plan'], {
     table: `${entity}_versions`
@@ -93,19 +81,15 @@ const insertVersions = (db, pgpHelpers, entity, records) => {
   const query = pgpHelpers.insert(records, cs) + onConflict;
   return db.none(query);
 };
-
 exports.insertVersions = insertVersions;
-
 const getPlanFromVersion = (db, entity, version) => {
   const query = `
     SELECT plan FROM ${entity}_versions
     WHERE version=$1;
   `;
-  return db.oneOrNone(query, [version], r => (r === null || r === void 0 ? void 0 : r.plan) || null);
+  return db.oneOrNone(query, [version], r => r?.plan || null);
 };
-
 exports.getPlanFromVersion = getPlanFromVersion;
-
 const getVersions = async (db, entity) => {
   const query = `
     SELECT
@@ -115,5 +99,4 @@ const getVersions = async (db, entity) => {
   `;
   return db.any(query);
 };
-
 exports.getVersions = getVersions;

package/dist/executed/executed.js

@@ -4,17 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getExecutedMigrationsFromVersion = void 0;
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _database = require("../database/database");
-
 var _validator = require("../plan/validator");
-
 var _git = require("../git/git");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * Get the executed migrations for a given payload version
  *
@@ -27,43 +21,37 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {Array<Object>} plannedMigrations planned migration entries
  * returns Promise<Array<Object>> executed migration entries
  */
+
 const getExecutedMigrationsFromVersion = async (database, pgpHelpers, entity, directory, currentVersion, plannedVersion, plannedMigrations) => {
   if (!currentVersion) {
     //when there is no current version, payload has never been migrated
     //so executed entries is empty
     return [];
   }
-
   if (currentVersion === plannedVersion) {
     //when planned version matches current version, there is nothing to migrate
     return plannedMigrations;
   } else {
     //otherwise we look up the historical plan file for that version from the DB
     let planFromVersion = await (0, _database.getPlanFromVersion)(database, entity, currentVersion);
-
     if (planFromVersion === null) {
-      var _historicalPlans$find;
-
       //if not in database, try to get it from the git history
       console.warn(_chalk.default.yellow(`Version not found in ${entity}_version table, trying git history instead`));
       const planFilePath = `${directory}/plan.json`;
       const {
         historicalPlans
-      } = await (0, _git.getHistoricalPlansFromGit)(planFilePath); //cache the response in the entity versions table
-
+      } = await (0, _git.getHistoricalPlansFromGit)(planFilePath);
+      //cache the response in the entity versions table
       await (0, _database.insertVersions)(database, pgpHelpers, entity, historicalPlans);
-      planFromVersion = ((_historicalPlans$find = historicalPlans.find(p => p.version === currentVersion)) === null || _historicalPlans$find === void 0 ? void 0 : _historicalPlans$find.plan) || null;
+      planFromVersion = historicalPlans.find(p => p.version === currentVersion)?.plan || null;
     }
-
     if (planFromVersion !== null) {
       let migrationsFromHistory = null;
-
       try {
         migrationsFromHistory = JSON.parse(planFromVersion);
       } catch {
         throw new Error(`Invalid record in ${entity}_version table (cannot parse JSON)`);
       }
-
       if (!(0, _validator.validatePlan)(migrationsFromHistory)) {
         throw new Error(`Invalid plan in ${entity}_version table (does not match schema)`);
       } else {
@@ -74,5 +62,4 @@ const getExecutedMigrationsFromVersion = async (database, pgpHelpers, entity, di
     }
   }
 };
-
 exports.getExecutedMigrationsFromVersion = getExecutedMigrationsFromVersion;

package/dist/git/git.js

@@ -4,15 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getPlanRevisionsFromGit = exports.getPlanFromGit = exports.getHistoricalPlansFromGit = exports.exec = void 0;
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _child_process = require("child_process");
-
 var _hash = require("../hash/hash");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const exec = command => new Promise((resolve, reject) => {
   const args = ['-c', command];
   const thread = (0, _child_process.spawn)('bash', args, {
@@ -31,16 +26,13 @@ const exec = command => new Promise((resolve, reject) => {
       reject(stdErr.join(''));
       return;
     }
-
     resolve(stdOut.join(''));
   });
 });
-
 exports.exec = exec;
-
 const getPlanRevisionsFromGit = async planFilePath => {
   const stdOut = await exec(`git rev-list --pretty='format:%H|%ad' HEAD ${planFilePath}`);
-  const lines = stdOut.split(/\r\n|\r|\n/).filter(r => r === null || r === void 0 ? void 0 : r.includes('|'));
+  const lines = stdOut.split(/\r\n|\r|\n/).filter(r => r?.includes('|'));
   return lines.map(line => {
     const [version, timeStamp] = line.split('|');
     const utcTimeStamp = new Date(timeStamp).toISOString();
@@ -50,15 +42,11 @@ const getPlanRevisionsFromGit = async planFilePath => {
     };
   });
 };
-
 exports.getPlanRevisionsFromGit = getPlanRevisionsFromGit;
-
 const getPlanFromGit = async (planFilePath, revision) => {
   return exec(`git show ${revision}:${planFilePath}`);
 };
-
 exports.getPlanFromGit = getPlanFromGit;
-
 const getHistoricalPlansFromGit = async planFilePath => {
   try {
     const revisions = await getPlanRevisionsFromGit(planFilePath);
@@ -79,5 +67,4 @@ const getHistoricalPlansFromGit = async planFilePath => {
     throw new Error('Unable to fetch plan.json history from git');
   }
 };
-
 exports.getHistoricalPlansFromGit = getHistoricalPlansFromGit;

package/dist/glob/glob.js

@@ -4,16 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.sortFilePathsByFilename = exports.getUniqueSkippedFileNames = exports.getSkippedFilePaths = exports.getMigrationFilePaths = void 0;
-
 var _path = _interopRequireDefault(require("path"));
-
 var _globPromise = _interopRequireDefault(require("glob-promise"));
-
 var _lodash = require("lodash");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const matchSkip = /(.skip|.skip\d+).js$/g;
+
 /**
  * Sorts migration file paths
  *
@@ -24,48 +20,39 @@ const matchSkip = /(.skip|.skip\d+).js$/g;
 const sortFilePathsByFilename = filePaths => (0, _lodash.sortBy)(filePaths, file => {
   return _path.default.parse(file).base;
 });
+
 /**
  * Gets paths to entity migrations in a directory
  *
  * @param {String} pathToMigrations
  * @returns {Promise<Array<String>>} matching migration filePaths
  */
-
-
 exports.sortFilePathsByFilename = sortFilePathsByFilename;
-
 const getMigrationFilePaths = async pathToMigrations => {
   const filePath = pattern => `${pathToMigrations}${pattern}`;
-
   const filePaths = await (0, _globPromise.default)(filePath('/**/*.js'), {
     ignore: [filePath('/**/*.skip?([0-9]*).js'), filePath('/**/index.js'), filePath('/**/plan.json'), filePath('/**/*.bundle.js'), filePath('/**/*.test.js'), filePath('/**/*.spec.js'), filePath('/**/__tests__/*'), filePath('/**/__test__/*')]
   });
   return sortFilePathsByFilename(filePaths);
 };
+
 /**
  * Gets paths to skipped migrations in a directory
  *
  * @param {String} pathToMigrations
  * @returns {Promise<Array<String>>} skipped migration filePaths
  */
-
-
 exports.getMigrationFilePaths = getMigrationFilePaths;
-
 const getSkippedFilePaths = async pathToMigrations => {
   const filePath = pattern => `${pathToMigrations}${pattern}`;
-
   const filePaths = await (0, _globPromise.default)(filePath('/**/*.skip?([0-9]*).js'), {
     ignore: [filePath('/**/index.js'), filePath('/**/plan.json'), filePath('/**/*.bundle.js'), filePath('/**/*.test.js'), filePath('/**/*.spec.js'), filePath('/**/__tests__/*'), filePath('/**/__test__/*')]
   });
   return sortFilePathsByFilename(filePaths);
 };
-
 exports.getSkippedFilePaths = getSkippedFilePaths;
-
 const getUniqueSkippedFileNames = skippedPaths => {
   const fileNames = skippedPaths.map(p => _path.default.parse(p).base.replace(matchSkip, '.js'));
   return Array.from(new Set(fileNames));
 };
-
 exports.getUniqueSkippedFileNames = getUniqueSkippedFileNames;

package/dist/hash/hash.js

@@ -4,19 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.hash = void 0;
-
 var crypto = _interopRequireWildcard(require("crypto"));
-
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
 /**
  * Generate SHA256 hash from a string
  *
  * @param {String} string
  * @returns {String} SHA256 hash
  */
-const hash = string => crypto.createHash('sha256').update(string).digest('hex');
 
+const hash = string => crypto.createHash('sha256').update(string).digest('hex');
 exports.hash = hash;

package/dist/history/history.js

@@ -4,15 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.printVersionHistory = void 0;
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _git = require("../git/git");
-
 var _database = require("../database/database");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * Parse plan.json
  *
@@ -29,6 +24,7 @@ const parsePlan = plan => {
     }
   })();
 };
+
 /**
  * @typedef {Object} Configuration
  * @property {string} directory (path to migrations directory)
@@ -42,8 +38,6 @@ const parsePlan = plan => {
  * @param {Object} args
  * @param {Configuration} args.config
  */
-
-
 const printVersionHistory = async ({
   config
 }) => {
@@ -52,35 +46,34 @@ const printVersionHistory = async ({
     entity,
     directory
   } = config;
-
   try {
-    const planFilePath = `${directory}/plan.json`; //read version history from database cache
+    const planFilePath = `${directory}/plan.json`;
 
+    //read version history from database cache
     const versionHistoryFromDatabase = await (0, _database.getVersions)(database, entity);
     const fullDatabaseVersionHistory = versionHistoryFromDatabase.map(d => {
-      const plan = parsePlan(d === null || d === void 0 ? void 0 : d.plan);
-      const finalMigration = plan !== null && plan !== void 0 && plan.length ? plan[plan.length - 1] : null;
+      const plan = parsePlan(d?.plan);
+      const finalMigration = plan?.length ? plan[plan.length - 1] : null;
       return {
-        planVersion: d === null || d === void 0 ? void 0 : d.version,
-        lastFileName: (finalMigration === null || finalMigration === void 0 ? void 0 : finalMigration.fileName) || null,
-        lastSequence: (finalMigration === null || finalMigration === void 0 ? void 0 : finalMigration.sequence) || null
+        planVersion: d?.version,
+        lastFileName: finalMigration?.fileName || null,
+        lastSequence: finalMigration?.sequence || null
       };
-    }); //read full version history from git logs (back to beginning of time)
+    });
 
+    //read full version history from git logs (back to beginning of time)
     const {
       historicalPlans: fullHistoricalPlans
     } = await (0, _git.getHistoricalPlansFromGit)(planFilePath);
     const fullGitVersionHistory = fullHistoricalPlans.map(p => {
-      var _p$revision, _p$revision2;
-
-      const plan = parsePlan(p === null || p === void 0 ? void 0 : p.plan);
-      const finalMigration = plan !== null && plan !== void 0 && plan.length ? plan[plan.length - 1] : null;
+      const plan = parsePlan(p?.plan);
+      const finalMigration = plan?.length ? plan[plan.length - 1] : null;
       return {
-        gitCommitHash: p === null || p === void 0 ? void 0 : (_p$revision = p.revision) === null || _p$revision === void 0 ? void 0 : _p$revision.version,
-        planVersion: p === null || p === void 0 ? void 0 : p.version,
-        timeStamp: p === null || p === void 0 ? void 0 : (_p$revision2 = p.revision) === null || _p$revision2 === void 0 ? void 0 : _p$revision2.timeStamp,
-        lastFileName: (finalMigration === null || finalMigration === void 0 ? void 0 : finalMigration.fileName) || null,
-        lastSequence: (finalMigration === null || finalMigration === void 0 ? void 0 : finalMigration.sequence) || null
+        gitCommitHash: p?.revision?.version,
+        planVersion: p?.version,
+        timeStamp: p?.revision?.timeStamp,
+        lastFileName: finalMigration?.fileName || null,
+        lastSequence: finalMigration?.sequence || null
       };
     });
     const output = {
@@ -93,5 +86,4 @@ const printVersionHistory = async ({
     throw new Error('Unable to print debug history');
   }
 };
-
 exports.printVersionHistory = printVersionHistory;

package/dist/index.js

@@ -45,17 +45,10 @@ Object.defineProperty(exports, "printVersionHistory", {
     return _history.printVersionHistory;
   }
 });
-
 var _create = require("./create/create");
-
 var _plan = require("./plan/plan");
-
 var _plannedVersion = require("./plan/planned-version");
-
 var _migrate = require("./migrate/migrate");
-
 var _pipe = require("./pipe/pipe");
-
 var _database = require("./database/database");
-
 var _history = require("./history/history");

package/dist/migrate/migrate.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.migrate = void 0;
-
 var _pipe = require("../pipe/pipe");
-
 var _pending = require("../pending/pending");
-
 /**
  * @typedef {Array|Object} Payload
  */
@@ -43,6 +40,7 @@ var _pending = require("../pending/pending");
  * @param {Configuration} args.config
  * @returns Promise<{nextPayload: Payload, nextVersion: string}>
  */
+
 const migrate = async ({
   payload,
   config
@@ -59,5 +57,4 @@ const migrate = async ({
     nextVersion
   };
 };
-
 exports.migrate = migrate;

package/dist/pending/pending.js

@@ -4,15 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getPendingMigrators = exports.getPendingMigrations = void 0;
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _plan = require("../plan/plan");
-
 var _executed = require("../executed/executed");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const getPendingMigrations = ({
   plannedMigrations,
   executedMigrations,
@@ -20,21 +15,17 @@ const getPendingMigrations = ({
 }) => {
   const executedMigrationFileNames = executedMigrations.map(e => e.fileName);
   const pendingMigrations = plannedMigrations.filter(m => !executedMigrationFileNames.includes(m.fileName));
-
   if (printPendingFileNames) {
     pendingMigrations.forEach(m => {
       console.log(_chalk.default.gray(`  ${m.fileName}`));
     });
   }
-
   return pendingMigrations.map(m => ({
     fileName: m.fileName,
     migrator: m.migrator
   }));
 };
-
 exports.getPendingMigrations = getPendingMigrations;
-
 const getPendingMigrators = async ({
   config
 }) => {
@@ -64,5 +55,4 @@ const getPendingMigrators = async ({
     nextVersion
   };
 };
-
 exports.getPendingMigrators = getPendingMigrators;

package/dist/pipe/pipe.js

@@ -4,11 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.pipe = void 0;
-
 const errorMessage = (fileName, message, stack) => `Unhandled exception in file ${fileName}: ${message}
 
   ${stack}
 `;
+
 /**
  * Executes the pending migrators on a payload, returns modified payload
  *
@@ -25,17 +25,14 @@ const errorMessage = (fileName, message, stack) => `Unhandled exception in file
  * @returns {Object} migratedPayload
  */
 
-
 const pipe = (migrations, payload) => migrations.reduce((v, m) => {
-  if (typeof (m === null || m === void 0 ? void 0 : m.migrator) !== 'function') {
+  if (typeof m?.migrator !== 'function') {
     throw new TypeError('Expected a function');
   }
-
   try {
     return m.migrator(v);
   } catch (error) {
-    throw new Error(errorMessage(m === null || m === void 0 ? void 0 : m.fileName, error.message, error.stack));
+    throw new Error(errorMessage(m?.fileName, error.message, error.stack));
   }
 }, payload);
-
 exports.pipe = pipe;

package/dist/plan/cached-planned-version.js

@@ -5,13 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.setCachedPlannedVersion = exports.getCachedPlannedVersion = void 0;
 let cachedPlannedVersion = null;
-
 const getCachedPlannedVersion = () => cachedPlannedVersion;
-
 exports.getCachedPlannedVersion = getCachedPlannedVersion;
-
 const setCachedPlannedVersion = version => {
   cachedPlannedVersion = version;
 };
-
 exports.setCachedPlannedVersion = setCachedPlannedVersion;

package/dist/plan/plan.js

@@ -4,30 +4,21 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.writePlan = exports.sortPlanEntries = exports.readPlan = exports.parsePlan = exports.getPlannedMigrations = exports.getNextSequenceString = exports.generatePlanEntries = void 0;
-
 var _path = _interopRequireDefault(require("path"));
-
 var _fs = require("fs");
-
 var _moduleFromString = require("module-from-string");
-
 var _hash = require("../hash/hash");
-
 var _glob = require("../glob/glob");
-
 var _validator = require("./validator");
-
 var _database = require("../database/database");
-
 var _cachedPlannedVersion = require("./cached-planned-version");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 //https://stackoverflow.com/a/31102605/942635
 const sortEntry = entry => Object.keys(entry).sort().reduce((obj, key) => {
   obj[key] = entry[key];
   return obj;
 }, {});
+
 /**
  * Sorts the plan entries by sequence string
  *
@@ -35,44 +26,36 @@ const sortEntry = entry => Object.keys(entry).sort().reduce((obj, key) => {
  * returns Array<Object>
  */
 
-
 const maxSequence = 1000000;
-
-const sortPlanEntries = plannedMigrations => plannedMigrations //dotted sequence sort https://stackoverflow.com/a/40201629/942635
+const sortPlanEntries = plannedMigrations => plannedMigrations
+//dotted sequence sort https://stackoverflow.com/a/40201629/942635
 .sort((a, b) => a.sequence.replace(/\d+/g, n => +n + maxSequence).localeCompare(b.sequence.replace(/\d+/g, n => +n + maxSequence))).map(p => sortEntry(p));
+
 /**
  * Get next automatic sequence string
  *
  * @param {String} sortedPlannedMigrations
  * returns String next sequence
  */
-
-
 exports.sortPlanEntries = sortPlanEntries;
-
 const getNextSequenceString = sortedPlannedMigrations => {
   const lastMigration = sortedPlannedMigrations[sortedPlannedMigrations.length - 1];
-
   if (!lastMigration) {
     return '1';
   }
-
   const currentLastSequenceNumber = lastMigration.sequence;
   return `${parseInt(`${currentLastSequenceNumber}`, 10) + 1}`;
 };
+
 /**
  * Read the plan.json file
  *
  * @param {String} directory path to migrations directory
  * returns Promise<String> plan.json string
  */
-
-
 exports.getNextSequenceString = getNextSequenceString;
-
 const readPlan = async directory => {
   let plan;
-
   try {
     plan = await _fs.promises.readFile(`${directory}/plan.json`, {
       encoding: 'utf8'
@@ -82,31 +65,27 @@ const readPlan = async directory => {
     return '[]';
   }
 };
+
 /**
  * Parse the plan.json string into a sorted object
  *
  * @param {String} plan plan.json string
  * returns Array<Object> migration entries from plan.json
  */
-
-
 exports.readPlan = readPlan;
-
 const parsePlan = plan => {
   let plannedMigrations;
-
   try {
     plannedMigrations = JSON.parse(plan);
   } catch {
     throw new Error('Invalid JSON for migrator plan.js (unable to parse file)');
   }
-
   if (!(0, _validator.validatePlan)(plannedMigrations)) {
     throw new Error('Invalid JSON for migrator plan.js (does not match schema)');
   }
-
   return sortPlanEntries(plannedMigrations);
 };
+
 /**
  * Write the plan.json file
  *
@@ -114,34 +93,27 @@ const parsePlan = plan => {
  * @param {String} content string to be written to file
  * returns Promise<>
  */
-
-
 exports.parsePlan = parsePlan;
-
 const writePlan = async (directory, content) => {
   //todo this is not being written in the correct order
   await _fs.promises.writeFile(_path.default.resolve(`${directory}/plan.json`), content, {
     encoding: 'utf8'
   });
 };
+
 /**
  * Generate plan entries
  *
  * @param {Array<Object>} sortedMigrationEntries
  * returns Array<Object>
  */
-
-
 exports.writePlan = writePlan;
-
 const generatePlanEntries = sortedMigrationEntries => sortedMigrationEntries.map(m => ({
   fileHash: m.fileHash,
   fileName: m.fileName,
   sequence: m.sequence
 }));
-
 exports.generatePlanEntries = generatePlanEntries;
-
 const getPlannedMigrations = async ({
   config
 }) => {
@@ -154,7 +126,6 @@ const getPlannedMigrations = async ({
     dry,
     importModule = true
   } = config;
-
   if (database && !dry) {
     /*
       OW-9043 and OW-9238: The tool tries to self-create its own meta tables
@@ -164,12 +135,10 @@ const getPlannedMigrations = async ({
       because it throws errors.
     */
     const tablesExist = await (0, _database.migrationTablesExist)(database, entity);
-
     if (!tablesExist) {
       await (0, _database.createMigrationsTables)(database, entity);
     }
   }
-
   const rawPlan = await readPlan(directory);
   const parsedPlan = parsePlan(rawPlan);
   const plannedMigrations = parsedPlan.map(m => ({
@@ -180,8 +149,6 @@ const getPlannedMigrations = async ({
   const filePaths = await (0, _glob.getMigrationFilePaths)(directory);
   const skippedFilePaths = await (0, _glob.getSkippedFilePaths)(directory);
   const plannedMigrationsWithFileEntries = await Promise.all(plannedMigrations.map(async m => {
-    var _await$importFromStri;
-
     const {
       fileName
     } = m;
@@ -190,17 +157,15 @@ const getPlannedMigrations = async ({
     const script = filePath ? await _fs.promises.readFile(filePath, {
       encoding: 'utf8'
     }) : null;
-    const migrator = script && importModule ? (_await$importFromStri = await (0, _moduleFromString.importFromString)(script)) === null || _await$importFromStri === void 0 ? void 0 : _await$importFromStri.default : null;
-    const fileHash = script ? (0, _hash.hash)(script) : null; //skipped files
+    const migrator = script && importModule ? (await (0, _moduleFromString.importFromString)(script))?.default : null;
+    const fileHash = script ? (0, _hash.hash)(script) : null;
 
+    //skipped files
     const skipMatch = '(.skip|.skip\\d+).js$';
-
     const nameMatch = _path.default.parse(m.fileName).name;
-
     const regex = new RegExp(`${nameMatch}${skipMatch}`, 'g');
     const matchingSkippedFilePaths = skippedFilePaths.filter(f => {
       const name = _path.default.parse(f).base;
-
       return name.match(regex);
     });
     const skippedFileHashes = await Promise.all(matchingSkippedFilePaths.map(async skippedFilePath => {
@@ -209,7 +174,8 @@ const getPlannedMigrations = async ({
       });
       return skippedScript ? (0, _hash.hash)(skippedScript) : null;
     }));
-    return { ...m,
+    return {
+      ...m,
       filePath,
       isValidFileName,
       script,
@@ -221,32 +187,29 @@ const getPlannedMigrations = async ({
   const historicalMigrations = database ? await (0, _database.getMigrationRecords)(database, entity) : [];
   const plannedMigrationsWithHistory = plannedMigrationsWithFileEntries.map(m => {
     const historicalMigration = historicalMigrations.find(h => h.fileName === m.fileName);
-    return { ...m,
-      fileHashFromHistory: (historicalMigration === null || historicalMigration === void 0 ? void 0 : historicalMigration.fileHash) || null,
-      sequenceFromHistory: (historicalMigration === null || historicalMigration === void 0 ? void 0 : historicalMigration.sequence) || null
+    return {
+      ...m,
+      fileHashFromHistory: historicalMigration?.fileHash || null,
+      sequenceFromHistory: historicalMigration?.sequence || null
     };
   });
   (0, _validator.throwIfFilesNotFound)(plannedMigrationsWithHistory, importModule);
   (0, _validator.throwIfFileNamesInvalid)(plannedMigrationsWithHistory);
   (0, _validator.throwIfFileNamesNotUnique)(plannedMigrationsWithHistory);
   (0, _validator.throwIfSequenceNotUnique)(plannedMigrationsWithHistory);
-
   if (!force) {
     (0, _validator.warnIfFilesHaveBeenRemovedFromPlan)(plannedMigrationsWithHistory, historicalMigrations);
     (0, _validator.throwIfFilesHaveChanged)(plannedMigrationsWithHistory);
     (0, _validator.throwIfSequenceHasChanged)(plannedMigrationsWithHistory);
   }
-
   (0, _validator.throwIfSequenceHasIntegerGaps)(plannedMigrationsWithHistory);
   const validatedPlannedMigrations = generatePlanEntries(plannedMigrationsWithHistory);
   const validatedPlan = JSON.stringify(validatedPlannedMigrations, null, 2);
   const nextVersion = (0, _hash.hash)(validatedPlan);
   const planHasChanged = validatedPlan !== rawPlan;
-
   if (!dry && planHasChanged) {
     await writePlan(directory, validatedPlan);
   }
-
   if (database && !dry) {
     await (0, _database.replaceMigrationsRecords)(database, pgpHelpers, entity, validatedPlannedMigrations);
     const versionRecord = [{
@@ -255,12 +218,10 @@ const getPlannedMigrations = async ({
     }];
     await (0, _database.insertVersions)(database, pgpHelpers, entity, versionRecord);
   }
-
   (0, _cachedPlannedVersion.setCachedPlannedVersion)(nextVersion);
   return {
     plannedMigrations: plannedMigrationsWithHistory,
     nextVersion
   };
 };
-
 exports.getPlannedMigrations = getPlannedMigrations;

package/dist/plan/planned-version.js

@@ -4,15 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getPlannedVersion = void 0;
-
 var _fs = require("fs");
-
 var _hash = require("../hash/hash");
-
 var _plan = require("./plan");
-
 var _cachedPlannedVersion = require("./cached-planned-version");
-
 const getPlannedVersion = async ({
   config
 }) => {
@@ -25,10 +20,10 @@ const getPlannedVersion = async ({
   const plannedVersion = (0, _hash.hash)(currentPlan);
   const cachedPlannedVersion = (0, _cachedPlannedVersion.getCachedPlannedVersion)();
   return cachedPlannedVersion === plannedVersion ? cachedPlannedVersion : (await (0, _plan.getPlannedMigrations)({
-    config: { ...config,
+    config: {
+      ...config,
       importModule: false
     }
   })).nextVersion;
 };
-
 exports.getPlannedVersion = getPlannedVersion;

package/dist/plan/validator.js

@@ -4,27 +4,21 @@ 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
+(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
  *
@@ -37,92 +31,77 @@ const validatePlan = plan => {
   const {
     errors
   } = planValidator;
-
-  if (errors !== null && errors !== void 0 && errors.length) {
+  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
-
-
+  }
+  //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 {
@@ -135,21 +114,18 @@ const throwIfFilesHaveChanged = migrationEntries => {
     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 {
@@ -159,46 +135,39 @@ const throwIfSequenceHasChanged = migrationEntries => {
     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
+  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);
@@ -208,47 +177,40 @@ const throwIfSequenceHasIntegerGaps = migrationEntries => {
     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
+  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;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@oliasoft-open-source/node-json-migrator",
-  "version": "2.1.0",
+  "version": "2.3.0-beta-1",
   "description": "A library for JSON migrations",
   "scripts": {
     "build": "npx babel src --ignore 'src/**/*.test.js' --out-dir dist --copy-files --no-copy-ignored",
-    "test": "npm run prettier:check && npm run lint:check && npm run test:unit:coverage",
+    "test": "yarn run prettier:check && yarn run lint:check && yarn run test:unit:coverage",
     "test:unit": "jest --silent=true",
     "test:unit:coverage": "jest --silent=true --collectCoverage=true",
     "test:unit:verbose": "jest --silent=false --verbose",

package/release-notes.md

@@ -0,0 +1,10 @@
+# Node JSON Migrator Release Notes
+
+## 2.3.0
+
+- switch from npm to yarn (to match other repos)
+- Add optional CI pipeline that automates publishing of beta releases ([OW-10003](https://oliasoft.atlassian.net/browse/OW-10003))
+
+## 2.2.0
+
+- first publish of release notes