@oliasoft-open-source/node-json-migrator 4.3.0-beta-1 → 4.3.0-beta-3

package/dist/index.cjs

@@ -7683,19 +7683,17 @@ const getPlannedMigrations = async ({ config }) => {
 };
 const PlanModule = { getPlannedMigrations };
 
-const templateMigrationFileLegacyRuleset = (entity) => `import produce from 'immer';
+const templateMigrationFileWithMetaDataLegacy = (entity) => `import produce from 'immer';
 //other imports not allowed
 
 export default (${entity}, metaData = {}) => produce(${entity}, (draft) => {
-  void metaData;
   // https://immerjs.github.io/immer/produce#example
 });
 `;
-const templateMigrationFileRuleset = (entity) => `import { produce } from 'immer';
+const templateMigrationFileWithMetaData = (entity) => `import { produce } from 'immer';
 //other imports not allowed
 
 export default (${entity}, metaData = {}) => produce(${entity}, (draft) => {
-  void metaData;
   // https://immerjs.github.io/immer/produce#example
 });
 `;
@@ -7713,35 +7711,36 @@ export default (${entity}) => produce(${entity}, (draft) => {
   // https://immerjs.github.io/immer/produce#example
 });
 `;
-const getTemplateMigrationFile = async (entity, type) => {
-  let template = type === "ruleset" ? templateMigrationFileLegacyRuleset(entity) : templateMigrationFileLegacy(entity);
+const getTemplateMigrationFile = async (entity, enableMetaData) => {
+  let template = enableMetaData ? templateMigrationFileWithMetaDataLegacy(entity) : templateMigrationFileLegacy(entity);
   try {
     await Promise.resolve().then(function () { return require('./immer-BsT8CIGL.cjs'); }).then(({ produce }) => {
       if (produce) {
-        template = type === "ruleset" ? templateMigrationFileRuleset(entity) : templateMigrationFile(entity);
+        template = enableMetaData ? templateMigrationFileWithMetaData(entity) : templateMigrationFile(entity);
       }
     });
   } catch (_error) {
   }
   return template;
 };
-const templateTestFile = (fileName, entity, type) => `import test from 'node:test';
+const templateTestFile = (fileName, entity, enableMetaData) => `import { describe, test } from 'node:test';
 import assert from 'node:assert/strict';
 import migrate from './${fileName}';
 
-test('describe ${entity} change', async (t) => {
-  await t.test('describe test', async () => {
+describe('${entity} change', () => {
+  test('should migrate an empty ${entity}', () => {
     // arrange
     const ${entity} = {};
 
     // act
-    const next${capitalize(entity)} = ${type === "ruleset" ? `migrate(${entity}, /* metaData */ {})` : `migrate(${entity})`};
+    const next${capitalize(entity)} = ${enableMetaData ? `migrate(${entity}, /* metaData */ {})` : `migrate(${entity})`};
 
     // assert
+    assert.ok(next${capitalize(entity)});
   });
 });
 `;
-const createMigration = async (directory, description, entity, type = "dataset") => {
+const createMigration = async (directory, description, entity, enableMetaData) => {
   if (!validateFileDescription(description)) {
     throw new Error("Invalid migration description");
   }
@@ -7754,14 +7753,14 @@ const createMigration = async (directory, description, entity, type = "dataset")
     await fs.promises.mkdir(directoryFullPath, { recursive: true });
     const templateMigrationScript = await getTemplateMigrationFile(
       entity,
-      type
+      enableMetaData
     );
     await fs.promises.writeFile(filePath, templateMigrationScript, {
       encoding: "utf8"
     });
     await fs.promises.writeFile(
       testFilePath,
-      templateTestFile(fileName, entity, type),
+      templateTestFile(fileName, entity, enableMetaData),
       {
         encoding: "utf8"
       }

package/dist/index.d.cts

@@ -1,5 +1,10 @@
 import { IDatabase, IHelpers, ITask } from 'pg-promise';
 
+/**
+ * Generate a new entity migration
+ */
+declare const createMigration: (directory: string, description: string, entity: string, enableMetaData?: boolean) => Promise<void>;
+
 type TPlanEntry = {
     fileName: string;
     fileHash: string;
@@ -20,7 +25,6 @@ type TMigration = {
     script?: string;
     migrator?: (payload: TPayload, metaData?: TMetaData) => TPayload;
 };
-type TMigrationType = 'dataset' | 'ruleset';
 type TRecordDetails = {
     id: number | string;
     name: string;
@@ -90,11 +94,6 @@ type TOnMigrationErrorsPayload = {
 };
 type TOnMigrationErrors = (params: TOnMigrationErrorsPayload) => Promise<void>;
 
-/**
- * Generate a new entity migration
- */
-declare const createMigration: (directory: string, description: string, entity: string, type?: TMigrationType) => Promise<void>;
-
 declare const getPlannedMigrations: ({ config }: {
     config: TConfig;
 }) => Promise<{
@@ -159,4 +158,4 @@ declare const printVersionHistory: ({ config }: {
     config: TConfig;
 }) => Promise<void>;
 
-export { type TAfterMigrateRecord, type TAfterMigrateRecordPayload, type TBeforeMigrateRecord, type TBeforeMigrateRecordPayload, type TConfig, type TEntityColumnNames, type TMetaData, type TMigration, type TMigrationErrorPayload, type TMigrationType, type TOnMigrationErrors, type TOnMigrationErrorsPayload, type TPayload, type TPlan, type TPlanEntry, type TRecord, type TRecordDetails, type TRecordDetailsList, createMigration, getPlannedMigrations, getPlannedVersion, getVersions, migrate, migrateAll, pipe, printVersionHistory };
+export { type TAfterMigrateRecord, type TAfterMigrateRecordPayload, type TBeforeMigrateRecord, type TBeforeMigrateRecordPayload, type TConfig, type TEntityColumnNames, type TMetaData, type TMigration, type TMigrationErrorPayload, type TOnMigrationErrors, type TOnMigrationErrorsPayload, type TPayload, type TPlan, type TPlanEntry, type TRecord, type TRecordDetails, type TRecordDetailsList, createMigration, getPlannedMigrations, getPlannedVersion, getVersions, migrate, migrateAll, pipe, printVersionHistory };

package/dist/index.d.mts

@@ -1,5 +1,10 @@
 import { IDatabase, IHelpers, ITask } from 'pg-promise';
 
+/**
+ * Generate a new entity migration
+ */
+declare const createMigration: (directory: string, description: string, entity: string, enableMetaData?: boolean) => Promise<void>;
+
 type TPlanEntry = {
     fileName: string;
     fileHash: string;
@@ -20,7 +25,6 @@ type TMigration = {
     script?: string;
     migrator?: (payload: TPayload, metaData?: TMetaData) => TPayload;
 };
-type TMigrationType = 'dataset' | 'ruleset';
 type TRecordDetails = {
     id: number | string;
     name: string;
@@ -90,11 +94,6 @@ type TOnMigrationErrorsPayload = {
 };
 type TOnMigrationErrors = (params: TOnMigrationErrorsPayload) => Promise<void>;
 
-/**
- * Generate a new entity migration
- */
-declare const createMigration: (directory: string, description: string, entity: string, type?: TMigrationType) => Promise<void>;
-
 declare const getPlannedMigrations: ({ config }: {
     config: TConfig;
 }) => Promise<{
@@ -159,4 +158,4 @@ declare const printVersionHistory: ({ config }: {
     config: TConfig;
 }) => Promise<void>;
 
-export { type TAfterMigrateRecord, type TAfterMigrateRecordPayload, type TBeforeMigrateRecord, type TBeforeMigrateRecordPayload, type TConfig, type TEntityColumnNames, type TMetaData, type TMigration, type TMigrationErrorPayload, type TMigrationType, type TOnMigrationErrors, type TOnMigrationErrorsPayload, type TPayload, type TPlan, type TPlanEntry, type TRecord, type TRecordDetails, type TRecordDetailsList, createMigration, getPlannedMigrations, getPlannedVersion, getVersions, migrate, migrateAll, pipe, printVersionHistory };
+export { type TAfterMigrateRecord, type TAfterMigrateRecordPayload, type TBeforeMigrateRecord, type TBeforeMigrateRecordPayload, type TConfig, type TEntityColumnNames, type TMetaData, type TMigration, type TMigrationErrorPayload, type TOnMigrationErrors, type TOnMigrationErrorsPayload, type TPayload, type TPlan, type TPlanEntry, type TRecord, type TRecordDetails, type TRecordDetailsList, createMigration, getPlannedMigrations, getPlannedVersion, getVersions, migrate, migrateAll, pipe, printVersionHistory };

package/dist/index.mjs

@@ -7662,19 +7662,17 @@ const getPlannedMigrations = async ({ config }) => {
 };
 const PlanModule = { getPlannedMigrations };
 
-const templateMigrationFileLegacyRuleset = (entity) => `import produce from 'immer';
+const templateMigrationFileWithMetaDataLegacy = (entity) => `import produce from 'immer';
 //other imports not allowed
 
 export default (${entity}, metaData = {}) => produce(${entity}, (draft) => {
-  void metaData;
   // https://immerjs.github.io/immer/produce#example
 });
 `;
-const templateMigrationFileRuleset = (entity) => `import { produce } from 'immer';
+const templateMigrationFileWithMetaData = (entity) => `import { produce } from 'immer';
 //other imports not allowed
 
 export default (${entity}, metaData = {}) => produce(${entity}, (draft) => {
-  void metaData;
   // https://immerjs.github.io/immer/produce#example
 });
 `;
@@ -7692,35 +7690,36 @@ export default (${entity}) => produce(${entity}, (draft) => {
   // https://immerjs.github.io/immer/produce#example
 });
 `;
-const getTemplateMigrationFile = async (entity, type) => {
-  let template = type === "ruleset" ? templateMigrationFileLegacyRuleset(entity) : templateMigrationFileLegacy(entity);
+const getTemplateMigrationFile = async (entity, enableMetaData) => {
+  let template = enableMetaData ? templateMigrationFileWithMetaDataLegacy(entity) : templateMigrationFileLegacy(entity);
   try {
     await import('./immer-C8oEWD0M.mjs').then(({ produce }) => {
       if (produce) {
-        template = type === "ruleset" ? templateMigrationFileRuleset(entity) : templateMigrationFile(entity);
+        template = enableMetaData ? templateMigrationFileWithMetaData(entity) : templateMigrationFile(entity);
       }
     });
   } catch (_error) {
   }
   return template;
 };
-const templateTestFile = (fileName, entity, type) => `import test from 'node:test';
+const templateTestFile = (fileName, entity, enableMetaData) => `import { describe, test } from 'node:test';
 import assert from 'node:assert/strict';
 import migrate from './${fileName}';
 
-test('describe ${entity} change', async (t) => {
-  await t.test('describe test', async () => {
+describe('${entity} change', () => {
+  test('should migrate an empty ${entity}', () => {
     // arrange
     const ${entity} = {};
 
     // act
-    const next${capitalize(entity)} = ${type === "ruleset" ? `migrate(${entity}, /* metaData */ {})` : `migrate(${entity})`};
+    const next${capitalize(entity)} = ${enableMetaData ? `migrate(${entity}, /* metaData */ {})` : `migrate(${entity})`};
 
     // assert
+    assert.ok(next${capitalize(entity)});
   });
 });
 `;
-const createMigration = async (directory, description, entity, type = "dataset") => {
+const createMigration = async (directory, description, entity, enableMetaData) => {
   if (!validateFileDescription(description)) {
     throw new Error("Invalid migration description");
   }
@@ -7733,14 +7732,14 @@ const createMigration = async (directory, description, entity, type = "dataset")
     await promises.mkdir(directoryFullPath, { recursive: true });
     const templateMigrationScript = await getTemplateMigrationFile(
       entity,
-      type
+      enableMetaData
     );
     await promises.writeFile(filePath, templateMigrationScript, {
       encoding: "utf8"
     });
     await promises.writeFile(
       testFilePath,
-      templateTestFile(fileName, entity, type),
+      templateTestFile(fileName, entity, enableMetaData),
       {
         encoding: "utf8"
       }

package/package.json

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