@oliasoft-open-source/node-json-migrator 3.1.0-beta-4 → 3.1.0-beta-5

package/dist/index.cjs

@@ -2321,6 +2321,11 @@ const throwIfFilesNotFound = (migrationEntries, importModule) => {
   }
 };
 
+const capitalize = (word) => {
+  if (!word) return "";
+  return word[0].toUpperCase() + word.slice(1);
+};
+
 const loadModuleFromString = async (script) => {
   let patchedScript = script;
   try {
@@ -9036,7 +9041,7 @@ const getRecordList = async (db, entity, entityTableName, entityColumnNames, lat
       version
     FROM $(entityTable:name)
     WHERE (
-      version IS NULL
+      version IS NULL OR version = ''
       OR (
         version <> $(latestVersion)
         AND (
@@ -9324,47 +9329,47 @@ const getPlannedMigrations = async ({ config }) => {
 };
 const PlanModule = { getPlannedMigrations };
 
-const templateMigrationFileLegacy = `import produce from 'immer';
+const templateMigrationFileLegacy = (entity) => `import produce from 'immer';
 //other imports not allowed
 
-export default (dataset) => produce(dataset, (draft) => {
+export default (${entity}) => produce(${entity}, (draft) => {
   // https://immerjs.github.io/immer/produce#example
 });
 `;
-const templateMigrationFile = `import { produce } from 'immer';
+const templateMigrationFile = (entity) => `import { produce } from 'immer';
 //other imports not allowed
 
-export default (dataset) => produce(dataset, (draft) => {
+export default (${entity}) => produce(${entity}, (draft) => {
   // https://immerjs.github.io/immer/produce#example
 });
 `;
-const getTemplateMigrationFile = async () => {
-  let template = templateMigrationFileLegacy;
+const getTemplateMigrationFile = async (entity) => {
+  let template = templateMigrationFileLegacy(entity);
   try {
     await Promise.resolve().then(function () { return require('./immer-BsT8CIGL.cjs'); }).then(({ produce }) => {
       if (produce) {
-        template = templateMigrationFile;
+        template = templateMigrationFile(entity);
       }
     });
   } catch (_error) {
   }
   return template;
 };
-const templateTestFile = (fileName) => `import migrate from './${fileName}';
+const templateTestFile = (fileName, entity) => `import migrate from './${fileName}';
 
-describe('describe dataset change', () => {
+describe('describe ${entity} change', () => {
   test('describe test', () => {
     //arrange
-    const dataset = {};
+    const ${entity} = {};
 
     //act
-    const nextDataset = migrate(dataset);
+    const next${capitalize(entity)} = migrate(${entity});
 
     //assert
   });
 });
 `;
-const createMigration = async (directory, description) => {
+const createMigration = async (directory, description, entity) => {
   if (!validateFileDescription(description)) {
     throw new Error("Invalid migration description");
   }
@@ -9375,11 +9380,11 @@ const createMigration = async (directory, description) => {
     const filePath = path$1.resolve(directoryFullPath, fileName);
     const testFilePath = path$1.resolve(directoryFullPath, testFileName);
     await fs.promises.mkdir(directoryFullPath, { recursive: true });
-    const templateMigrationScript = await getTemplateMigrationFile();
+    const templateMigrationScript = await getTemplateMigrationFile(entity);
     await fs.promises.writeFile(filePath, templateMigrationScript, {
       encoding: "utf8"
     });
-    await fs.promises.writeFile(testFilePath, templateTestFile(fileName), {
+    await fs.promises.writeFile(testFilePath, templateTestFile(fileName, entity), {
       encoding: "utf8"
     });
     const rawPlan = await readPlan(directory);
@@ -9391,7 +9396,7 @@ const createMigration = async (directory, description) => {
     });
     const nextPlan = JSON.stringify(nextPlannedMigrations, null, 2);
     await writePlan(directory, nextPlan);
-    console.log(chalk.green(`Created new dataset migration ${fileName} \u2713`));
+    console.log(chalk.green(`Created new ${entity} migration ${fileName} \u2713`));
   } catch (error) {
     console.log(chalk.red(error));
     throw new Error("Unable to create migration file");
@@ -9435,11 +9440,11 @@ const terminals = Object.freeze({
   bash: "bash",
   cmd: "cmd"
 });
-const historyError = `Unable to fetch git history. Possible reasons:
-    - Have you merged latest master branch into your environment (pull latest migrations)?
+const historyError = `Unable to fetch migrations history from git. Possible reasons:
+    - Have you merged latest master branch into your environment (fetch latest migrations)?
     - Are you trying to downgrade data (not allowed), e.g. newer data into an older environment?
-        - Not allowed to export from TEST and import to PROD
-        - Not allowed to export datasets generated from migration feature branches into TEST, PROD or master ENVs
+        - Not allowed to export data from TEST and import to PROD
+        - Not allowed to export data from feature branches and import into TEST, PROD or master ENVs
     - On Windows? Do you have git and a terminal (bash or cmd) in your PATH? Try cmder.app, gitforwindows.org, or WSL
 `;
 const commandAvailable = (command) => {
@@ -9725,7 +9730,7 @@ const migrateRecord = async ({
     };
     console.log(
       chalk.red(
-        ` Dataset migration with id ${record.id} failed:
+        ` ${capitalize(config.entity)} migration with id ${record.id} failed:
  ${error.stack}`
       )
     );
@@ -9756,15 +9761,24 @@ const migrateRecords = async ({
     }
   }
   if (migrationErrors.length) {
+    try {
+      await onMigrationErrors({
+        migrationErrors,
+        dry
+      });
+    } catch (error) {
+      console.log(
+        chalk.red(
+          `Handling errors for ${config.entity} migrations failed:
+ ${error.stack}`
+        )
+      );
+    }
     console.log(
       chalk.yellow(
         `Completed ${config?.entity ?? "entity"} migrations (some failed)${config?.dry ? " [dry-run, no output written]" : ""} \u2713`
       )
     );
-    await onMigrationErrors({
-      migrationErrors,
-      dry
-    });
   } else {
     console.log(
       chalk.green(

package/dist/index.d.cts

@@ -1,9 +1,9 @@
 import { IDatabase, IHelpers, ITask } from 'pg-promise';
 
 /**
- * Generate a new dataset migration
+ * Generate a new entity migration
  */
-declare const createMigration: (directory: string, description: string) => Promise<void>;
+declare const createMigration: (directory: string, description: string, entity: string) => Promise<void>;
 
 type TMigration = {
     fileName?: string;

package/dist/index.d.mts

@@ -1,9 +1,9 @@
 import { IDatabase, IHelpers, ITask } from 'pg-promise';
 
 /**
- * Generate a new dataset migration
+ * Generate a new entity migration
  */
-declare const createMigration: (directory: string, description: string) => Promise<void>;
+declare const createMigration: (directory: string, description: string, entity: string) => Promise<void>;
 
 type TMigration = {
     fileName?: string;

package/dist/index.mjs

@@ -2300,6 +2300,11 @@ const throwIfFilesNotFound = (migrationEntries, importModule) => {
   }
 };
 
+const capitalize = (word) => {
+  if (!word) return "";
+  return word[0].toUpperCase() + word.slice(1);
+};
+
 const loadModuleFromString = async (script) => {
   let patchedScript = script;
   try {
@@ -9015,7 +9020,7 @@ const getRecordList = async (db, entity, entityTableName, entityColumnNames, lat
       version
     FROM $(entityTable:name)
     WHERE (
-      version IS NULL
+      version IS NULL OR version = ''
       OR (
         version <> $(latestVersion)
         AND (
@@ -9303,47 +9308,47 @@ const getPlannedMigrations = async ({ config }) => {
 };
 const PlanModule = { getPlannedMigrations };
 
-const templateMigrationFileLegacy = `import produce from 'immer';
+const templateMigrationFileLegacy = (entity) => `import produce from 'immer';
 //other imports not allowed
 
-export default (dataset) => produce(dataset, (draft) => {
+export default (${entity}) => produce(${entity}, (draft) => {
   // https://immerjs.github.io/immer/produce#example
 });
 `;
-const templateMigrationFile = `import { produce } from 'immer';
+const templateMigrationFile = (entity) => `import { produce } from 'immer';
 //other imports not allowed
 
-export default (dataset) => produce(dataset, (draft) => {
+export default (${entity}) => produce(${entity}, (draft) => {
   // https://immerjs.github.io/immer/produce#example
 });
 `;
-const getTemplateMigrationFile = async () => {
-  let template = templateMigrationFileLegacy;
+const getTemplateMigrationFile = async (entity) => {
+  let template = templateMigrationFileLegacy(entity);
   try {
     await import('./immer-C8oEWD0M.mjs').then(({ produce }) => {
       if (produce) {
-        template = templateMigrationFile;
+        template = templateMigrationFile(entity);
       }
     });
   } catch (_error) {
   }
   return template;
 };
-const templateTestFile = (fileName) => `import migrate from './${fileName}';
+const templateTestFile = (fileName, entity) => `import migrate from './${fileName}';
 
-describe('describe dataset change', () => {
+describe('describe ${entity} change', () => {
   test('describe test', () => {
     //arrange
-    const dataset = {};
+    const ${entity} = {};
 
     //act
-    const nextDataset = migrate(dataset);
+    const next${capitalize(entity)} = migrate(${entity});
 
     //assert
   });
 });
 `;
-const createMigration = async (directory, description) => {
+const createMigration = async (directory, description, entity) => {
   if (!validateFileDescription(description)) {
     throw new Error("Invalid migration description");
   }
@@ -9354,11 +9359,11 @@ const createMigration = async (directory, description) => {
     const filePath = path$1.resolve(directoryFullPath, fileName);
     const testFilePath = path$1.resolve(directoryFullPath, testFileName);
     await promises.mkdir(directoryFullPath, { recursive: true });
-    const templateMigrationScript = await getTemplateMigrationFile();
+    const templateMigrationScript = await getTemplateMigrationFile(entity);
     await promises.writeFile(filePath, templateMigrationScript, {
       encoding: "utf8"
     });
-    await promises.writeFile(testFilePath, templateTestFile(fileName), {
+    await promises.writeFile(testFilePath, templateTestFile(fileName, entity), {
       encoding: "utf8"
     });
     const rawPlan = await readPlan(directory);
@@ -9370,7 +9375,7 @@ const createMigration = async (directory, description) => {
     });
     const nextPlan = JSON.stringify(nextPlannedMigrations, null, 2);
     await writePlan(directory, nextPlan);
-    console.log(chalk.green(`Created new dataset migration ${fileName} \u2713`));
+    console.log(chalk.green(`Created new ${entity} migration ${fileName} \u2713`));
   } catch (error) {
     console.log(chalk.red(error));
     throw new Error("Unable to create migration file");
@@ -9414,11 +9419,11 @@ const terminals = Object.freeze({
   bash: "bash",
   cmd: "cmd"
 });
-const historyError = `Unable to fetch git history. Possible reasons:
-    - Have you merged latest master branch into your environment (pull latest migrations)?
+const historyError = `Unable to fetch migrations history from git. Possible reasons:
+    - Have you merged latest master branch into your environment (fetch latest migrations)?
     - Are you trying to downgrade data (not allowed), e.g. newer data into an older environment?
-        - Not allowed to export from TEST and import to PROD
-        - Not allowed to export datasets generated from migration feature branches into TEST, PROD or master ENVs
+        - Not allowed to export data from TEST and import to PROD
+        - Not allowed to export data from feature branches and import into TEST, PROD or master ENVs
     - On Windows? Do you have git and a terminal (bash or cmd) in your PATH? Try cmder.app, gitforwindows.org, or WSL
 `;
 const commandAvailable = (command) => {
@@ -9704,7 +9709,7 @@ const migrateRecord = async ({
     };
     console.log(
       chalk.red(
-        ` Dataset migration with id ${record.id} failed:
+        ` ${capitalize(config.entity)} migration with id ${record.id} failed:
  ${error.stack}`
       )
     );
@@ -9735,15 +9740,24 @@ const migrateRecords = async ({
     }
   }
   if (migrationErrors.length) {
+    try {
+      await onMigrationErrors({
+        migrationErrors,
+        dry
+      });
+    } catch (error) {
+      console.log(
+        chalk.red(
+          `Handling errors for ${config.entity} migrations failed:
+ ${error.stack}`
+        )
+      );
+    }
     console.log(
       chalk.yellow(
         `Completed ${config?.entity ?? "entity"} migrations (some failed)${config?.dry ? " [dry-run, no output written]" : ""} \u2713`
       )
     );
-    await onMigrationErrors({
-      migrationErrors,
-      dry
-    });
   } else {
     console.log(
       chalk.green(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oliasoft-open-source/node-json-migrator",
-  "version": "3.1.0-beta-4",
+  "version": "3.1.0-beta-5",
   "description": "A library for JSON migrations",
   "homepage": "https://oliasoft-open-source.gitlab.io/node-postgresql-migrator",
   "bugs": {