@pipelab/migration 1.0.0-beta.1 → 1.0.0-beta.10

package/.oxfmtrc.json

@@ -1,3 +1,3 @@
 {
-  "ignorePatterns": ["dist", "out", "node_modules", "bin"]
+  "ignorePatterns": ["dist", "out", "node_modules", "bin", "**/*.d.ts"]
 }

package/CHANGELOG.md

@@ -1,5 +1,59 @@
 # @pipelab/migration
 
+## 1.0.0-beta.10
+
+### Patch Changes
+
+- s
+
+## 1.0.0-beta.9
+
+### Patch Changes
+
+- fg
+
+## 1.0.0-beta.8
+
+### Patch Changes
+
+- changes
+
+## 1.0.0-beta.7
+
+### Patch Changes
+
+- bump
+
+## 1.0.0-beta.6
+
+### Patch Changes
+
+- fixes
+
+## 1.0.0-beta.5
+
+### Patch Changes
+
+- bump
+
+## 1.0.0-beta.4
+
+### Patch Changes
+
+- beta tag
+
+## 1.0.0-beta.3
+
+### Patch Changes
+
+- bump
+
+## 1.0.0-beta.2
+
+### Patch Changes
+
+- update
+
 ## 1.0.0-beta.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -7,6 +7,7 @@ type MigrationFn<From, To> = (state: From, targetVersion: string) => Awaitable<T
 type MigrateOptions = {
   debug?: boolean;
   target?: SemVer;
+  onStep?: (state: any, version: SemVer) => Promise<void> | void;
 };
 declare const MigrationSchemaValidator: valibot.ObjectSchema<{
   readonly version: valibot.CustomSchema<`${number}.${number}.${number}`, undefined>;
@@ -15,24 +16,22 @@ declare const createVersionSchema: <OBJECTENTRIES extends ObjectEntries>(schema:
 type MigrationSchema = InferOutput<typeof MigrationSchemaValidator>;
 type OmitVersion<T> = Omit<T, keyof MigrationSchema>;
 type SemVer = `${number}.${number}.${number}`;
-interface MigrationClass<Down, Current, Up> {
+interface MigrationClass<Current, Up> {
   version: SemVer;
   up: MigrationFn<Current, Up>;
-  down: MigrationFn<Current, Down>;
 }
-interface MigrationObjInput<Down, Current, Up> {
+interface MigrationObjInput<Current, Up> {
   version: SemVer;
   up: MigrationFn<OmitVersion<Current>, OmitVersion<Up>>;
-  down: MigrationFn<OmitVersion<Current>, OmitVersion<Down>>;
 }
 interface MigratorConfig<InitialState, FinalState> {
-  migrations: MigrationClass<any, any, any>[];
+  migrations: MigrationClass<any, any>[];
   coerce?: boolean;
   defaultValue?: FinalState;
 }
 declare class Migrator<InitialState extends MigrationSchema, OutputState extends MigrationSchema> {
   current: SemVer;
-  migrations: Record<SemVer, MigrationClass<any, any, any>>;
+  migrations: Record<SemVer, MigrationClass<any, any>>;
   coerce: boolean;
   defaultValue: OutputState;
   constructor(config: MigratorConfig<InitialState, OutputState>);
@@ -43,17 +42,8 @@ declare class Migrator<InitialState extends MigrationSchema, OutputState extends
 }
 //#endregion
 //#region src/models/createMigration.d.ts
-declare function createMigration<Down extends MigrationSchema, Current extends MigrationSchema, Up extends MigrationSchema>(migration: MigrationObjInput<Down, Current, Up>): MigrationClass<Down, Current, Up>;
-declare const initialVersion: () => never;
+declare function createMigration<Current extends MigrationSchema, Up extends MigrationSchema>(migration: MigrationObjInput<Current, Up>): MigrationClass<Current, Up>;
 declare const finalVersion: () => never;
-/**
- * @deprecated
- * @param version
- * @param migration
- * @returns
- */
-declare function initial<Current extends MigrationSchema, Up extends MigrationSchema>(version: SemVer, migration: MigrationFn<OmitVersion<Current>, OmitVersion<Up>>): MigrationClass<Current, Current, Up>;
-declare function final<Current extends MigrationSchema, Down extends MigrationSchema>(version: SemVer, migration: MigrationFn<OmitVersion<Current>, OmitVersion<Down>>): MigrationClass<Down, Current, Current>;
 //#endregion
 //#region src/models/createMigrator.d.ts
 declare const createMigrator: <InitialState extends MigrationSchema, FinalState extends MigrationSchema>() => {
@@ -62,5 +52,5 @@ declare const createMigrator: <InitialState extends MigrationSchema, FinalState
 };
 type MigratorFactory<InitialState extends MigrationSchema, FinalState extends MigrationSchema> = ReturnType<typeof createMigrator<InitialState, FinalState>>;
 //#endregion
-export { type MigrationFn, type MigrationSchema, type Migrator, type MigratorConfig, MigratorFactory, type OmitVersion, type SemVer, createMigration, createMigrator, createVersionSchema, final, finalVersion, initial, initialVersion };
+export { type Awaitable, type MigrationFn, type MigrationSchema, type Migrator, type MigratorConfig, MigratorFactory, type OmitVersion, type SemVer, createMigration, createMigrator, createVersionSchema, finalVersion };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/models/migration.ts","../src/models/createMigration.ts","../src/models/createMigrator.ts"],"mappings":";;;;KAMY,SAAA,MAAe,OAAA,CAAQ,CAAA,IAAK,CAAA;AAAA,KAE5B,WAAA,cAAyB,KAAA,EAAO,IAAA,EAAM,aAAA,aAA0B,SAAA,CAAU,EAAA;AAAA,KAE1E,cAAA;EACV,KAAA;EACA,MAAA,GAAS,MAAA;AAAA;AAAA,cAUE,wBAAA,EAEX,OAAA,CAFmC,YAAA;EAAA,kBAEnC,OAAA,CAAA,YAAA;AAAA;AAAA,cAEW,mBAAA,yBAA6C,aAAA,EAAe,MAAA,EAAQ,aAAA,KAAa,OAAA,CAAA,YAAA,CAAA,aAAA;AAAA,KAKlF,eAAA,GAAkB,WAAA,QAAmB,wBAAA;AAAA,KAErC,WAAA,MAAiB,IAAA,CAAK,CAAA,QAAS,eAAA;AAAA,KAE/B,MAAA;AAAA,UAEK,cAAA;EACf,OAAA,EAAS,MAAA;EACT,EAAA,EAAI,WAAA,CAAY,OAAA,EAAS,EAAA;EACzB,IAAA,EAAM,WAAA,CAAY,OAAA,EAAS,IAAA;AAAA;AAAA,UAGZ,iBAAA;EACf,OAAA,EAAS,MAAA;EACT,EAAA,EAAI,WAAA,CAAY,WAAA,CAAY,OAAA,GAAU,WAAA,CAAY,EAAA;EAClD,IAAA,EAAM,WAAA,CAAY,WAAA,CAAY,OAAA,GAAU,WAAA,CAAY,IAAA;AAAA;AAAA,UAGrC,cAAA;EACf,UAAA,EAAY,cAAA;EACZ,MAAA;EACA,YAAA,GAAe,UAAA;AAAA;AAAA,cAGJ,QAAA,sBAA8B,eAAA,sBAAqC,eAAA;EAC9E,OAAA,EAAS,MAAA;EAET,UAAA,EAAY,MAAA,CAAO,MAAA,EAAQ,cAAA;EAE3B,MAAA;EACA,YAAA,EAAc,WAAA;cAEF,MAAA,EAAQ,cAAA,CAAe,YAAA,EAAc,WAAA;EAYjD,WAAA,CAAA;EAKM,OAAA,CACJ,MAAA,EAAQ,eAAA,cACR,OAAA,GAAU,cAAA,GACT,OAAA,CAAQ,WAAA;EAiEX,SAAA,CAAU,OAAA,EAAS,MAAA,GAAS,MAAA;EAI5B,aAAA,CAAc,OAAA,EAAS,MAAA;AAAA;;;iBC/IT,eAAA,cACD,eAAA,kBACG,eAAA,aACL,eAAA,CAAA,CACX,SAAA,EAAW,iBAAA,CAAkB,IAAA,EAAM,OAAA,EAAS,EAAA,IAAM,cAAA,CAAe,IAAA,EAAM,OAAA,EAAS,EAAA;AAAA,cAgBrE,cAAA;AAAA,cAIA,YAAA;AD3Bb;;;;;;AAAA,iBCyCgB,OAAA,iBAAwB,eAAA,aAA4B,eAAA,CAAA,CAClE,OAAA,EAAS,MAAA,EACT,SAAA,EAAW,WAAA,CAAY,WAAA,CAAY,OAAA,GAAU,WAAA,CAAY,EAAA,KACxD,cAAA,CAAe,OAAA,EAAS,OAAA,EAAS,EAAA;AAAA,iBAUpB,KAAA,iBAAsB,eAAA,eAA8B,eAAA,CAAA,CAClE,OAAA,EAAS,MAAA,EACT,SAAA,EAAW,WAAA,CAAY,WAAA,CAAY,OAAA,GAAU,WAAA,CAAY,IAAA,KACxD,cAAA,CAAe,IAAA,EAAM,OAAA,EAAS,OAAA;;;cC7DpB,cAAA,wBACU,eAAA,qBACF,eAAA;8BAGW,UAAA,GAAa,UAAA;2BAI/B,cAAA,CAAe,YAAA,EAAc,UAAA,IACpC,QAAA,CAAS,YAAA,EAAc,UAAA;AAAA;AAAA,KAMlB,eAAA,sBACW,eAAA,qBACF,eAAA,IACjB,UAAA,QAAkB,cAAA,CAAe,YAAA,EAAc,UAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/models/migration.ts","../src/models/createMigration.ts","../src/models/createMigrator.ts"],"mappings":";;;;KAMY,SAAA,MAAe,OAAA,CAAQ,CAAA,IAAK,CAAA;AAAA,KAE5B,WAAA,cAAyB,KAAA,EAAO,IAAA,EAAM,aAAA,aAA0B,SAAA,CAAU,EAAA;AAAA,KAE1E,cAAA;EACV,KAAA;EACA,MAAA,GAAS,MAAA;EACT,MAAA,IAAU,KAAA,OAAY,OAAA,EAAS,MAAA,KAAW,OAAA;AAAA;AAAA,cAU/B,wBAAA,EAEX,OAAA,CAFmC,YAAA;EAAA,kBAEnC,OAAA,CAAA,YAAA;AAAA;AAAA,cAEW,mBAAA,yBAA6C,aAAA,EAAe,MAAA,EAAQ,aAAA,KAAa,OAAA,CAAA,YAAA,CAAA,aAAA;AAAA,KAKlF,eAAA,GAAkB,WAAA,QAAmB,wBAAA;AAAA,KAErC,WAAA,MAAiB,IAAA,CAAK,CAAA,QAAS,eAAA;AAAA,KAE/B,MAAA;AAAA,UAEK,cAAA;EACf,OAAA,EAAS,MAAA;EACT,EAAA,EAAI,WAAA,CAAY,OAAA,EAAS,EAAA;AAAA;AAAA,UAGV,iBAAA;EACf,OAAA,EAAS,MAAA;EACT,EAAA,EAAI,WAAA,CAAY,WAAA,CAAY,OAAA,GAAU,WAAA,CAAY,EAAA;AAAA;AAAA,UAGnC,cAAA;EACf,UAAA,EAAY,cAAA;EACZ,MAAA;EACA,YAAA,GAAe,UAAA;AAAA;AAAA,cAGJ,QAAA,sBAA8B,eAAA,sBAAqC,eAAA;EAC9E,OAAA,EAAS,MAAA;EAET,UAAA,EAAY,MAAA,CAAO,MAAA,EAAQ,cAAA;EAE3B,MAAA;EACA,YAAA,EAAc,WAAA;cAEF,MAAA,EAAQ,cAAA,CAAe,YAAA,EAAc,WAAA;EAYjD,WAAA,CAAA;EAKM,OAAA,CACJ,MAAA,EAAQ,eAAA,cACR,OAAA,GAAU,cAAA,GACT,OAAA,CAAQ,WAAA;EAqEX,SAAA,CAAU,OAAA,EAAS,MAAA,GAAS,MAAA;EAI5B,aAAA,CAAc,OAAA,EAAS,MAAA;AAAA;;;iBClJT,eAAA,iBAAgC,eAAA,aAA4B,eAAA,CAAA,CAC1E,SAAA,EAAW,iBAAA,CAAkB,OAAA,EAAS,EAAA,IACrC,cAAA,CAAe,OAAA,EAAS,EAAA;AAAA,cAad,YAAA;;;cCtBA,cAAA,wBACU,eAAA,qBACF,eAAA;8BAGW,UAAA,GAAa,UAAA;2BAI/B,cAAA,CAAe,YAAA,EAAc,UAAA,IACpC,QAAA,CAAS,YAAA,EAAc,UAAA;AAAA;AAAA,KAMlB,eAAA,sBACW,eAAA,qBACF,eAAA,IACjB,UAAA,QAAkB,cAAA,CAAe,YAAA,EAAc,UAAA"}

package/dist/index.mjs

@@ -7,47 +7,15 @@ function createMigration(migration) {
 	return {
 		version: migration.version,
 		up: async (state, nextVersion) => {
-			const newState = await migration.up(state, nextVersion);
-			newState.version = nextVersion;
-			return newState;
-		},
-		down: async (state, nextVersion) => {
-			const newState = await migration.down(state, nextVersion);
+			const newState = migration.up ? await migration.up(state, nextVersion) : state;
 			newState.version = nextVersion;
 			return newState;
 		}
 	};
 }
-const initialVersion = () => {
-	throw new Error("Unable to go down on the initial version!");
-};
 const finalVersion = () => {
 	throw new Error("Unable to go up on the final version!");
 };
-/**
-* @deprecated
-* @param version
-* @param migration
-* @returns
-*/
-function initial(version, migration) {
-	return createMigration({
-		version,
-		up: migration,
-		down() {
-			throw new Error("Unable to go down on the initial version!");
-		}
-	});
-}
-function final(version, migration) {
-	return createMigration({
-		version,
-		up: () => {
-			throw new Error(`Unable to go up on the final version "${version}"!`);
-		},
-		down: migration
-	});
-}
 //#endregion
 //#region src/utils/object-keys.ts
 const objectKeys = Object.keys;
@@ -83,20 +51,19 @@ var Migrator = class {
 		if (currentIndex === -1) throw new Error(`Current version "${currentVersion}" not found in migrations`);
 		if (targetIndex === -1) throw new Error(`Target version "${targetVersion}" not found in migrations`);
 		if (currentIndex === targetIndex) return finalState;
-		const isUpgrade = currentIndex < targetIndex;
-		const increment = isUpgrade ? 1 : -1;
-		const direction = isUpgrade ? "up" : "down";
-		for (let i = currentIndex; isUpgrade ? i < targetIndex : i > targetIndex; i += increment) {
+		if (!(currentIndex < targetIndex)) return finalState;
+		for (let i = currentIndex; i < targetIndex; i++) {
 			const currentVersion = versions[i];
-			const nextVersion = versions[i + increment];
+			const nextVersion = versions[i + 1];
 			if (options?.debug) console.log("	Migrating to version:", nextVersion);
 			const migrationVersion = currentVersion;
 			const migration = this.migrations[migrationVersion];
 			const { version: _, ...stateWithoutVersion } = finalState;
 			finalState = {
-				...await migration[direction](stateWithoutVersion, currentVersion),
+				...await migration.up(stateWithoutVersion, currentVersion),
 				version: nextVersion
 			};
+			if (options?.onStep) await options.onStep(finalState, nextVersion);
 			if (options?.debug) console.log("	Migrated state:", finalState);
 		}
 		return finalState;
@@ -122,6 +89,6 @@ const createMigrator = () => {
 	};
 };
 //#endregion
-export { createMigration, createMigrator, createVersionSchema, final, finalVersion, initial, initialVersion };
+export { createMigration, createMigrator, createVersionSchema, finalVersion };
 
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/models/createMigration.ts","../src/utils/object-keys.ts","../src/models/migration.ts","../src/models/createMigrator.ts"],"sourcesContent":["import {\n  MigrationFn,\n  MigrationObjInput,\n  MigrationClass,\n  MigrationSchema,\n  OmitVersion,\n  SemVer,\n} from \"./migration\";\n\nexport function createMigration<\n  Down extends MigrationSchema,\n  Current extends MigrationSchema,\n  Up extends MigrationSchema,\n>(migration: MigrationObjInput<Down, Current, Up>): MigrationClass<Down, Current, Up> {\n  return {\n    version: migration.version,\n    up: async (state, nextVersion) => {\n      const newState = (await migration.up(state, nextVersion)) as unknown as Up;\n      newState.version = nextVersion as SemVer;\n      return newState;\n    },\n    down: async (state, nextVersion) => {\n      const newState = (await migration.down(state, nextVersion)) as unknown as Down;\n      newState.version = nextVersion as SemVer;\n      return newState;\n    },\n  };\n}\n\nexport const initialVersion = () => {\n  throw new Error(\"Unable to go down on the initial version!\");\n};\n\nexport const finalVersion = () => {\n  throw new Error(\"Unable to go up on the final version!\");\n};\n\n// export const finalVersion = <T>(state: T) => {\n//   return state\n// }\n\n/**\n * @deprecated\n * @param version\n * @param migration\n * @returns\n */\nexport function initial<Current extends MigrationSchema, Up extends MigrationSchema>(\n  version: SemVer,\n  migration: MigrationFn<OmitVersion<Current>, OmitVersion<Up>>,\n): MigrationClass<Current, Current, Up> {\n  return createMigration({\n    version,\n    up: migration,\n    down() {\n      throw new Error(\"Unable to go down on the initial version!\");\n    },\n  });\n}\n\nexport function final<Current extends MigrationSchema, Down extends MigrationSchema>(\n  version: SemVer,\n  migration: MigrationFn<OmitVersion<Current>, OmitVersion<Down>>,\n): MigrationClass<Down, Current, Current> {\n  return createMigration({\n    version,\n    up: () => {\n      throw new Error(`Unable to go up on the final version \"${version}\"!`);\n    },\n    down: migration,\n  });\n}\n","export type ObjectKeys<T extends object> = `${Exclude<keyof T, symbol>}`;\n\nexport const objectKeys = Object.keys as <Type extends object>(\n  value: Type,\n) => Array<ObjectKeys<Type>>;\nexport const objectEntries = Object.entries as <Type extends Record<PropertyKey, unknown>>(\n  value: Type,\n) => Array<[ObjectKeys<Type>, Type[ObjectKeys<Type>]]>;\n","import * as semver from \"semver\";\nimport { coerce } from \"semver\";\nimport { objectKeys } from \"../utils/object-keys\";\nimport { klona } from \"klona\";\nimport { custom, InferOutput, object, ObjectEntries } from \"valibot\";\n\nexport type Awaitable<T> = Promise<T> | T;\n\nexport type MigrationFn<From, To> = (state: From, targetVersion: string) => Awaitable<To>;\n\nexport type MigrateOptions = {\n  debug?: boolean;\n  target?: SemVer;\n};\n\nconst SemverValidator = custom<SemVer>((input) =>\n  typeof input === \"string\" ? /^\\d+\\.\\d+\\.\\d+$/.test(input) : false,\n);\n\nexport const SemverVersionValidator = SemverValidator;\n// export const SemverVersionValidator = optional(SemverValidator, '1.0.0')\n\nexport const MigrationSchemaValidator = object({\n  version: SemverVersionValidator,\n});\n\nexport const createVersionSchema = <OBJECTENTRIES extends ObjectEntries>(schema: OBJECTENTRIES) =>\n  object({\n    ...schema,\n  });\n\nexport type MigrationSchema = InferOutput<typeof MigrationSchemaValidator>;\n\nexport type OmitVersion<T> = Omit<T, keyof MigrationSchema>;\n\nexport type SemVer = `${number}.${number}.${number}`;\n\nexport interface MigrationClass<Down, Current, Up> {\n  version: SemVer;\n  up: MigrationFn<Current, Up>;\n  down: MigrationFn<Current, Down>;\n}\n\nexport interface MigrationObjInput<Down, Current, Up> {\n  version: SemVer;\n  up: MigrationFn<OmitVersion<Current>, OmitVersion<Up>>;\n  down: MigrationFn<OmitVersion<Current>, OmitVersion<Down>>;\n}\n\nexport interface MigratorConfig<InitialState, FinalState> {\n  migrations: MigrationClass<any, any, any>[];\n  coerce?: boolean;\n  defaultValue?: FinalState;\n}\n\nexport class Migrator<InitialState extends MigrationSchema, OutputState extends MigrationSchema> {\n  current: SemVer;\n\n  migrations: Record<SemVer, MigrationClass<any, any, any>> = {};\n\n  coerce: boolean;\n  defaultValue: OutputState;\n\n  constructor(config: MigratorConfig<InitialState, OutputState>) {\n    config.migrations.forEach((migration) => {\n      this.migrations[migration.version] = migration;\n    });\n\n    this.defaultValue = config?.defaultValue ?? ({} as OutputState);\n\n    const versions = this.getVersions();\n    this.current = versions[versions.length - 1];\n    this.coerce = config?.coerce ?? true;\n  }\n\n  getVersions() {\n    const keys = objectKeys(this.migrations);\n    return semver.sort(keys);\n  }\n\n  async migrate(\n    _state: MigrationSchema | undefined,\n    options?: MigrateOptions,\n  ): Promise<OutputState> {\n    const state = _state ?? this.defaultValue;\n    const currentVersion = this.tryCoerce(state.version);\n    const targetVersion = this.tryCoerce(options?.target ?? this.current);\n\n    if (options?.debug) {\n      console.log(\"Migrating from\", currentVersion, \"to\", targetVersion);\n    }\n\n    let finalState = klona(state) as any; // Using any here because we'll be transforming between versions\n    const versions = this.getVersions();\n    const currentIndex = versions.indexOf(currentVersion);\n    const targetIndex = versions.indexOf(targetVersion);\n\n    if (currentIndex === -1) {\n      throw new Error(`Current version \"${currentVersion}\" not found in migrations`);\n    }\n    if (targetIndex === -1) {\n      throw new Error(`Target version \"${targetVersion}\" not found in migrations`);\n    }\n\n    // If we're already at the target version, return the state\n    if (currentIndex === targetIndex) {\n      return finalState as OutputState;\n    }\n\n    // Get the migration path\n    const isUpgrade = currentIndex < targetIndex;\n    const increment = isUpgrade ? 1 : -1;\n    const direction = isUpgrade ? \"up\" : \"down\";\n\n    // Perform migrations\n    for (let i = currentIndex; isUpgrade ? i < targetIndex : i > targetIndex; i += increment) {\n      const currentVersion = versions[i];\n      const nextVersion = versions[i + increment];\n\n      if (options?.debug) {\n        console.log(\"\\tMigrating to version:\", nextVersion);\n      }\n\n      // For upgrades, use current version's migration\n      // For downgrades, use previous version's migration\n      const migrationVersion = currentVersion;\n      const migration = this.migrations[migrationVersion];\n\n      // Remove version before migration\n      const { version: _, ...stateWithoutVersion } = finalState;\n\n      // Perform migration\n      const migratedState = await migration[direction](stateWithoutVersion, currentVersion);\n\n      // Add new version\n      finalState = {\n        ...migratedState,\n        version: nextVersion,\n      };\n\n      if (options?.debug) {\n        console.log(\"\\tMigrated state:\", finalState);\n      }\n    }\n\n    return finalState as OutputState;\n  }\n\n  tryCoerce(version: SemVer): SemVer {\n    return this.coerce ? ((coerce(version)?.version as SemVer | undefined) ?? version) : version;\n  }\n\n  needMigration(version: SemVer) {\n    const newVersion = this.tryCoerce(version);\n    return semver.lt(newVersion, this.current);\n  }\n}\n","import { MigratorConfig, Migrator, MigrationSchema } from \"./migration\";\n\nexport const createMigrator = <\n  InitialState extends MigrationSchema,\n  FinalState extends MigrationSchema,\n>() => {\n  return {\n    createDefault(defaultState: FinalState): FinalState {\n      return defaultState;\n    },\n    createMigrations(\n      config: MigratorConfig<InitialState, FinalState>,\n    ): Migrator<InitialState, FinalState> {\n      return new Migrator<InitialState, FinalState>(config);\n    },\n  };\n};\n\nexport type MigratorFactory<\n  InitialState extends MigrationSchema,\n  FinalState extends MigrationSchema,\n> = ReturnType<typeof createMigrator<InitialState, FinalState>>;\n"],"mappings":";;;;;AASA,SAAgB,gBAId,WAAoF;AACpF,QAAO;EACL,SAAS,UAAU;EACnB,IAAI,OAAO,OAAO,gBAAgB;GAChC,MAAM,WAAY,MAAM,UAAU,GAAG,OAAO,YAAY;AACxD,YAAS,UAAU;AACnB,UAAO;;EAET,MAAM,OAAO,OAAO,gBAAgB;GAClC,MAAM,WAAY,MAAM,UAAU,KAAK,OAAO,YAAY;AAC1D,YAAS,UAAU;AACnB,UAAO;;EAEV;;AAGH,MAAa,uBAAuB;AAClC,OAAM,IAAI,MAAM,4CAA4C;;AAG9D,MAAa,qBAAqB;AAChC,OAAM,IAAI,MAAM,wCAAwC;;;;;;;;AAa1D,SAAgB,QACd,SACA,WACsC;AACtC,QAAO,gBAAgB;EACrB;EACA,IAAI;EACJ,OAAO;AACL,SAAM,IAAI,MAAM,4CAA4C;;EAE/D,CAAC;;AAGJ,SAAgB,MACd,SACA,WACwC;AACxC,QAAO,gBAAgB;EACrB;EACA,UAAU;AACR,SAAM,IAAI,MAAM,yCAAyC,QAAQ,IAAI;;EAEvE,MAAM;EACP,CAAC;;;;ACpEJ,MAAa,aAAa,OAAO;ACoBO,OAAO,EAC7C,SARsB,QAAgB,UACtC,OAAO,UAAU,WAAW,kBAAkB,KAAK,MAAM,GAAG,MAC7D,EAOA,CAAC;AAEF,MAAa,uBAA4D,WACvE,OAAO,EACL,GAAG,QACJ,CAAC;AA0BJ,IAAa,WAAb,MAAiG;CAC/F;CAEA,aAA4D,EAAE;CAE9D;CACA;CAEA,YAAY,QAAmD;AAC7D,SAAO,WAAW,SAAS,cAAc;AACvC,QAAK,WAAW,UAAU,WAAW;IACrC;AAEF,OAAK,eAAe,QAAQ,gBAAiB,EAAE;EAE/C,MAAM,WAAW,KAAK,aAAa;AACnC,OAAK,UAAU,SAAS,SAAS,SAAS;AAC1C,OAAK,SAAS,QAAQ,UAAU;;CAGlC,cAAc;EACZ,MAAM,OAAO,WAAW,KAAK,WAAW;AACxC,SAAO,OAAO,KAAK,KAAK;;CAG1B,MAAM,QACJ,QACA,SACsB;EACtB,MAAM,QAAQ,UAAU,KAAK;EAC7B,MAAM,iBAAiB,KAAK,UAAU,MAAM,QAAQ;EACpD,MAAM,gBAAgB,KAAK,UAAU,SAAS,UAAU,KAAK,QAAQ;AAErE,MAAI,SAAS,MACX,SAAQ,IAAI,kBAAkB,gBAAgB,MAAM,cAAc;EAGpE,IAAI,aAAa,MAAM,MAAM;EAC7B,MAAM,WAAW,KAAK,aAAa;EACnC,MAAM,eAAe,SAAS,QAAQ,eAAe;EACrD,MAAM,cAAc,SAAS,QAAQ,cAAc;AAEnD,MAAI,iBAAiB,GACnB,OAAM,IAAI,MAAM,oBAAoB,eAAe,2BAA2B;AAEhF,MAAI,gBAAgB,GAClB,OAAM,IAAI,MAAM,mBAAmB,cAAc,2BAA2B;AAI9E,MAAI,iBAAiB,YACnB,QAAO;EAIT,MAAM,YAAY,eAAe;EACjC,MAAM,YAAY,YAAY,IAAI;EAClC,MAAM,YAAY,YAAY,OAAO;AAGrC,OAAK,IAAI,IAAI,cAAc,YAAY,IAAI,cAAc,IAAI,aAAa,KAAK,WAAW;GACxF,MAAM,iBAAiB,SAAS;GAChC,MAAM,cAAc,SAAS,IAAI;AAEjC,OAAI,SAAS,MACX,SAAQ,IAAI,0BAA2B,YAAY;GAKrD,MAAM,mBAAmB;GACzB,MAAM,YAAY,KAAK,WAAW;GAGlC,MAAM,EAAE,SAAS,GAAG,GAAG,wBAAwB;AAM/C,gBAAa;IACX,GAJoB,MAAM,UAAU,WAAW,qBAAqB,eAAe;IAKnF,SAAS;IACV;AAED,OAAI,SAAS,MACX,SAAQ,IAAI,oBAAqB,WAAW;;AAIhD,SAAO;;CAGT,UAAU,SAAyB;AACjC,SAAO,KAAK,SAAW,OAAO,QAAQ,EAAE,WAAkC,UAAW;;CAGvF,cAAc,SAAiB;EAC7B,MAAM,aAAa,KAAK,UAAU,QAAQ;AAC1C,SAAO,OAAO,GAAG,YAAY,KAAK,QAAQ;;;;;ACxJ9C,MAAa,uBAGN;AACL,QAAO;EACL,cAAc,cAAsC;AAClD,UAAO;;EAET,iBACE,QACoC;AACpC,UAAO,IAAI,SAAmC,OAAO;;EAExD"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/models/createMigration.ts","../src/utils/object-keys.ts","../src/models/migration.ts","../src/models/createMigrator.ts"],"sourcesContent":["import {\n  MigrationFn,\n  MigrationObjInput,\n  MigrationClass,\n  MigrationSchema,\n  OmitVersion,\n  SemVer,\n} from \"./migration\";\n\nexport function createMigration<Current extends MigrationSchema, Up extends MigrationSchema>(\n  migration: MigrationObjInput<Current, Up>,\n): MigrationClass<Current, Up> {\n  return {\n    version: migration.version,\n    up: async (state, nextVersion) => {\n      const newState = migration.up\n        ? ((await migration.up(state, nextVersion)) as unknown as Up)\n        : (state as unknown as Up);\n      newState.version = nextVersion as SemVer;\n      return newState;\n    },\n  };\n}\n\nexport const finalVersion = () => {\n  throw new Error(\"Unable to go up on the final version!\");\n};\n","export type ObjectKeys<T extends object> = `${Exclude<keyof T, symbol>}`;\n\nexport const objectKeys = Object.keys as <Type extends object>(\n  value: Type,\n) => Array<ObjectKeys<Type>>;\nexport const objectEntries = Object.entries as <Type extends Record<PropertyKey, unknown>>(\n  value: Type,\n) => Array<[ObjectKeys<Type>, Type[ObjectKeys<Type>]]>;\n","import * as semver from \"semver\";\nimport { coerce } from \"semver\";\nimport { objectKeys } from \"../utils/object-keys\";\nimport { klona } from \"klona\";\nimport { custom, InferOutput, object, ObjectEntries } from \"valibot\";\n\nexport type Awaitable<T> = Promise<T> | T;\n\nexport type MigrationFn<From, To> = (state: From, targetVersion: string) => Awaitable<To>;\n\nexport type MigrateOptions = {\n  debug?: boolean;\n  target?: SemVer;\n  onStep?: (state: any, version: SemVer) => Promise<void> | void;\n};\n\nconst SemverValidator = custom<SemVer>((input) =>\n  typeof input === \"string\" ? /^\\d+\\.\\d+\\.\\d+$/.test(input) : false,\n);\n\nexport const SemverVersionValidator = SemverValidator;\n// export const SemverVersionValidator = optional(SemverValidator, '1.0.0')\n\nexport const MigrationSchemaValidator = object({\n  version: SemverVersionValidator,\n});\n\nexport const createVersionSchema = <OBJECTENTRIES extends ObjectEntries>(schema: OBJECTENTRIES) =>\n  object({\n    ...schema,\n  });\n\nexport type MigrationSchema = InferOutput<typeof MigrationSchemaValidator>;\n\nexport type OmitVersion<T> = Omit<T, keyof MigrationSchema>;\n\nexport type SemVer = `${number}.${number}.${number}`;\n\nexport interface MigrationClass<Current, Up> {\n  version: SemVer;\n  up: MigrationFn<Current, Up>;\n}\n\nexport interface MigrationObjInput<Current, Up> {\n  version: SemVer;\n  up: MigrationFn<OmitVersion<Current>, OmitVersion<Up>>;\n}\n\nexport interface MigratorConfig<InitialState, FinalState> {\n  migrations: MigrationClass<any, any>[];\n  coerce?: boolean;\n  defaultValue?: FinalState;\n}\n\nexport class Migrator<InitialState extends MigrationSchema, OutputState extends MigrationSchema> {\n  current: SemVer;\n\n  migrations: Record<SemVer, MigrationClass<any, any>> = {};\n\n  coerce: boolean;\n  defaultValue: OutputState;\n\n  constructor(config: MigratorConfig<InitialState, OutputState>) {\n    config.migrations.forEach((migration) => {\n      this.migrations[migration.version] = migration;\n    });\n\n    this.defaultValue = config?.defaultValue ?? ({} as OutputState);\n\n    const versions = this.getVersions();\n    this.current = versions[versions.length - 1];\n    this.coerce = config?.coerce ?? true;\n  }\n\n  getVersions() {\n    const keys = objectKeys(this.migrations);\n    return semver.sort(keys);\n  }\n\n  async migrate(\n    _state: MigrationSchema | undefined,\n    options?: MigrateOptions,\n  ): Promise<OutputState> {\n    const state = _state ?? this.defaultValue;\n    const currentVersion = this.tryCoerce(state.version);\n    const targetVersion = this.tryCoerce(options?.target ?? this.current);\n\n    if (options?.debug) {\n      console.log(\"Migrating from\", currentVersion, \"to\", targetVersion);\n    }\n\n    let finalState = klona(state) as any; // Using any here because we'll be transforming between versions\n    const versions = this.getVersions();\n    const currentIndex = versions.indexOf(currentVersion);\n    const targetIndex = versions.indexOf(targetVersion);\n\n    if (currentIndex === -1) {\n      throw new Error(`Current version \"${currentVersion}\" not found in migrations`);\n    }\n    if (targetIndex === -1) {\n      throw new Error(`Target version \"${targetVersion}\" not found in migrations`);\n    }\n\n    // If we're already at the target version, return the state\n    if (currentIndex === targetIndex) {\n      return finalState as OutputState;\n    }\n\n    // Get the migration path\n    const isUpgrade = currentIndex < targetIndex;\n\n    if (!isUpgrade) {\n      return finalState as OutputState;\n    }\n\n    // Perform migrations\n    for (let i = currentIndex; i < targetIndex; i++) {\n      const currentVersion = versions[i];\n      const nextVersion = versions[i + 1];\n\n      if (options?.debug) {\n        console.log(\"\\tMigrating to version:\", nextVersion);\n      }\n\n      const migrationVersion = currentVersion;\n      const migration = this.migrations[migrationVersion];\n\n      // Remove version before migration\n      const { version: _, ...stateWithoutVersion } = finalState;\n\n      // Perform migration\n      const migratedState = await migration.up(stateWithoutVersion, currentVersion);\n\n      // Add new version\n      finalState = {\n        ...migratedState,\n        version: nextVersion,\n      };\n\n      if (options?.onStep) {\n        await options.onStep(finalState, nextVersion);\n      }\n\n      if (options?.debug) {\n        console.log(\"\\tMigrated state:\", finalState);\n      }\n    }\n\n    return finalState as OutputState;\n  }\n\n  tryCoerce(version: SemVer): SemVer {\n    return this.coerce ? ((coerce(version)?.version as SemVer | undefined) ?? version) : version;\n  }\n\n  needMigration(version: SemVer) {\n    const newVersion = this.tryCoerce(version);\n    return semver.lt(newVersion, this.current);\n  }\n}\n","import { MigratorConfig, Migrator, MigrationSchema } from \"./migration\";\n\nexport const createMigrator = <\n  InitialState extends MigrationSchema,\n  FinalState extends MigrationSchema,\n>() => {\n  return {\n    createDefault(defaultState: FinalState): FinalState {\n      return defaultState;\n    },\n    createMigrations(\n      config: MigratorConfig<InitialState, FinalState>,\n    ): Migrator<InitialState, FinalState> {\n      return new Migrator<InitialState, FinalState>(config);\n    },\n  };\n};\n\nexport type MigratorFactory<\n  InitialState extends MigrationSchema,\n  FinalState extends MigrationSchema,\n> = ReturnType<typeof createMigrator<InitialState, FinalState>>;\n"],"mappings":";;;;;AASA,SAAgB,gBACd,WAC6B;AAC7B,QAAO;EACL,SAAS,UAAU;EACnB,IAAI,OAAO,OAAO,gBAAgB;GAChC,MAAM,WAAW,UAAU,KACrB,MAAM,UAAU,GAAG,OAAO,YAAY,GACvC;AACL,YAAS,UAAU;AACnB,UAAO;;EAEV;;AAGH,MAAa,qBAAqB;AAChC,OAAM,IAAI,MAAM,wCAAwC;;;;ACvB1D,MAAa,aAAa,OAAO;ACqBO,OAAO,EAC7C,SARsB,QAAgB,UACtC,OAAO,UAAU,WAAW,kBAAkB,KAAK,MAAM,GAAG,MAC7D,EAOA,CAAC;AAEF,MAAa,uBAA4D,WACvE,OAAO,EACL,GAAG,QACJ,CAAC;AAwBJ,IAAa,WAAb,MAAiG;CAC/F;CAEA,aAAuD,EAAE;CAEzD;CACA;CAEA,YAAY,QAAmD;AAC7D,SAAO,WAAW,SAAS,cAAc;AACvC,QAAK,WAAW,UAAU,WAAW;IACrC;AAEF,OAAK,eAAe,QAAQ,gBAAiB,EAAE;EAE/C,MAAM,WAAW,KAAK,aAAa;AACnC,OAAK,UAAU,SAAS,SAAS,SAAS;AAC1C,OAAK,SAAS,QAAQ,UAAU;;CAGlC,cAAc;EACZ,MAAM,OAAO,WAAW,KAAK,WAAW;AACxC,SAAO,OAAO,KAAK,KAAK;;CAG1B,MAAM,QACJ,QACA,SACsB;EACtB,MAAM,QAAQ,UAAU,KAAK;EAC7B,MAAM,iBAAiB,KAAK,UAAU,MAAM,QAAQ;EACpD,MAAM,gBAAgB,KAAK,UAAU,SAAS,UAAU,KAAK,QAAQ;AAErE,MAAI,SAAS,MACX,SAAQ,IAAI,kBAAkB,gBAAgB,MAAM,cAAc;EAGpE,IAAI,aAAa,MAAM,MAAM;EAC7B,MAAM,WAAW,KAAK,aAAa;EACnC,MAAM,eAAe,SAAS,QAAQ,eAAe;EACrD,MAAM,cAAc,SAAS,QAAQ,cAAc;AAEnD,MAAI,iBAAiB,GACnB,OAAM,IAAI,MAAM,oBAAoB,eAAe,2BAA2B;AAEhF,MAAI,gBAAgB,GAClB,OAAM,IAAI,MAAM,mBAAmB,cAAc,2BAA2B;AAI9E,MAAI,iBAAiB,YACnB,QAAO;AAMT,MAAI,EAFc,eAAe,aAG/B,QAAO;AAIT,OAAK,IAAI,IAAI,cAAc,IAAI,aAAa,KAAK;GAC/C,MAAM,iBAAiB,SAAS;GAChC,MAAM,cAAc,SAAS,IAAI;AAEjC,OAAI,SAAS,MACX,SAAQ,IAAI,0BAA2B,YAAY;GAGrD,MAAM,mBAAmB;GACzB,MAAM,YAAY,KAAK,WAAW;GAGlC,MAAM,EAAE,SAAS,GAAG,GAAG,wBAAwB;AAM/C,gBAAa;IACX,GAJoB,MAAM,UAAU,GAAG,qBAAqB,eAAe;IAK3E,SAAS;IACV;AAED,OAAI,SAAS,OACX,OAAM,QAAQ,OAAO,YAAY,YAAY;AAG/C,OAAI,SAAS,MACX,SAAQ,IAAI,oBAAqB,WAAW;;AAIhD,SAAO;;CAGT,UAAU,SAAyB;AACjC,SAAO,KAAK,SAAW,OAAO,QAAQ,EAAE,WAAkC,UAAW;;CAGvF,cAAc,SAAiB;EAC7B,MAAM,aAAa,KAAK,UAAU,QAAQ;AAC1C,SAAO,OAAO,GAAG,YAAY,KAAK,QAAQ;;;;;AC3J9C,MAAa,uBAGN;AACL,QAAO;EACL,cAAc,cAAsC;AAClD,UAAO;;EAET,iBACE,QACoC;AACpC,UAAO,IAAI,SAAmC,OAAO;;EAExD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipelab/migration",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.10",
   "private": false,
   "description": "Migration utilities for Pipelab data structures",
   "license": "FSL-1.1-MIT",
@@ -35,11 +35,14 @@
     "@types/semver": "^7.5.8",
     "tsdown": "0.21.2",
     "typescript": "5.9.3",
-    "@pipelab/tsconfig": "1.0.0-beta.1"
+    "vitest": "3.1.4",
+    "@pipelab/tsconfig": "1.0.0-beta.10"
   },
   "scripts": {
     "build": "tsdown",
     "format": "oxfmt .",
-    "lint": "oxlint ."
+    "lint": "oxlint .",
+    "typecheck": "tsc -b",
+    "test": "vitest run"
   }
 }

package/src/index.ts

@@ -7,5 +7,6 @@ export type {
   MigrationFn,
   SemVer,
   OmitVersion,
+  Awaitable,
 } from "./models/migration";
 export { createVersionSchema } from "./models/migration";

package/src/models/createMigration.ts

@@ -7,66 +7,21 @@ import {
   SemVer,
 } from "./migration";
 
-export function createMigration<
-  Down extends MigrationSchema,
-  Current extends MigrationSchema,
-  Up extends MigrationSchema,
->(migration: MigrationObjInput<Down, Current, Up>): MigrationClass<Down, Current, Up> {
+export function createMigration<Current extends MigrationSchema, Up extends MigrationSchema>(
+  migration: MigrationObjInput<Current, Up>,
+): MigrationClass<Current, Up> {
   return {
     version: migration.version,
     up: async (state, nextVersion) => {
-      const newState = (await migration.up(state, nextVersion)) as unknown as Up;
-      newState.version = nextVersion as SemVer;
-      return newState;
-    },
-    down: async (state, nextVersion) => {
-      const newState = (await migration.down(state, nextVersion)) as unknown as Down;
+      const newState = migration.up
+        ? ((await migration.up(state, nextVersion)) as unknown as Up)
+        : (state as unknown as Up);
       newState.version = nextVersion as SemVer;
       return newState;
     },
   };
 }
 
-export const initialVersion = () => {
-  throw new Error("Unable to go down on the initial version!");
-};
-
 export const finalVersion = () => {
   throw new Error("Unable to go up on the final version!");
 };
-
-// export const finalVersion = <T>(state: T) => {
-//   return state
-// }
-
-/**
- * @deprecated
- * @param version
- * @param migration
- * @returns
- */
-export function initial<Current extends MigrationSchema, Up extends MigrationSchema>(
-  version: SemVer,
-  migration: MigrationFn<OmitVersion<Current>, OmitVersion<Up>>,
-): MigrationClass<Current, Current, Up> {
-  return createMigration({
-    version,
-    up: migration,
-    down() {
-      throw new Error("Unable to go down on the initial version!");
-    },
-  });
-}
-
-export function final<Current extends MigrationSchema, Down extends MigrationSchema>(
-  version: SemVer,
-  migration: MigrationFn<OmitVersion<Current>, OmitVersion<Down>>,
-): MigrationClass<Down, Current, Current> {
-  return createMigration({
-    version,
-    up: () => {
-      throw new Error(`Unable to go up on the final version "${version}"!`);
-    },
-    down: migration,
-  });
-}

package/src/models/migration.spec.ts

@@ -1,10 +1,10 @@
 import { describe, test, expect, beforeAll, beforeEach, afterEach, vi } from "vitest";
-import { createMigration, final, finalVersion, initial, initialVersion } from "./createMigration";
+import { createMigration, finalVersion } from "./createMigration";
 import { createMigrator, MigratorFactory } from "./createMigrator";
 import { Migrator, MigrationSchema } from "./migration";
 import { z } from "zod";
 
-export const withMigration = (obj: z.AnyZodObject) =>
+export const withMigration = (obj: z.ZodObject<any>) =>
   z
     .object({
       version: z.string(),
@@ -53,70 +53,31 @@ describe("migrator", () => {
   let migratorInstance: MigratorFactory<V1, V4>;
   let migratorMigrations: Migrator<V1, V4>;
   beforeAll(() => {
-    // migratorInstance = createMigrator<V4>({
-    //   migrations: [
-    //     initial<V1, V2>('1.0.0', (state) => ({
-    //       dummyV2: state.dummyV1,
-    //     })),
-    //     createMigration<V1, V2, V3>({
-    //       version: '2.0.0',
-    //       up: (state) => ({
-    //         dummyV3: state.dummyV2,
-    //       }),
-    //       down: (state) => ({
-    //         dummyV1: state.dummyV2,
-    //       }),
-    //     }),
-    //     createMigration<V2, V3, V4>({
-    //       version: '3.0.0',
-    //       up: (state) => ({
-    //         dummy: state.dummyV3,
-    //       }),
-    //       down: (state) => ({
-    //         dummyV2: state.dummyV3,
-    //       }),
-    //     }),
-    //     final<V4, V3>('4.0.0', (state) => ({
-    //       dummyV3: state.dummy,
-    //     })),
-    //   ],
-    // });
-
     migratorInstance = createMigrator<V1, V4>();
     migratorMigrations = migratorInstance.createMigrations({
-      defaultValue: outputV1,
+      defaultValue: outputV4,
       migrations: [
-        createMigration<never, V1, V2>({
+        createMigration<V1, V2>({
           version: "1.0.0",
           up: (state) => ({
             dummyV2: state.dummyV1,
           }),
-          down: initialVersion,
         }),
-        createMigration<V1, V2, V3>({
+        createMigration<V2, V3>({
           version: "2.0.0",
           up: (state) => ({
             dummyV3: state.dummyV2,
           }),
-          down: (state) => ({
-            dummyV1: state.dummyV2,
-          }),
         }),
-        createMigration<V2, V3, V4>({
+        createMigration<V3, V4>({
           version: "3.0.0",
           up: (state) => ({
             dummy: state.dummyV3,
           }),
-          down: (state) => ({
-            dummyV2: state.dummyV3,
-          }),
         }),
-        createMigration<V3, V4, never>({
+        createMigration<V4, never>({
           version: "4.0.0",
           up: finalVersion,
-          down: (state) => ({
-            dummyV3: state.dummy,
-          }),
         }),
       ],
     });
@@ -165,48 +126,38 @@ describe("migrator", () => {
     return expect(migratorMigrations.migrate(input)).resolves.toStrictEqual(outputV4);
   });
 
-  test("should downgrade", async () => {
+  test("should skip downgrades silently / not support them", async () => {
     const input: V4 = {
       dummy: "aaa",
       version: "4.0.0",
     };
-    const result = await migratorMigrations.migrate(input);
-    expect(result).toEqual(outputV4);
-    const resultDown = await migratorMigrations.migrate(result, {
+    // Migrate should return the exact state since downgrades are bypassed
+    const result = await migratorMigrations.migrate(input, {
       target: "3.0.0",
     });
-    expect(resultDown).toEqual(outputV3);
-    const resultDown2 = await migratorMigrations.migrate(resultDown, {
-      target: "2.0.0",
-    });
-    expect(resultDown2).toEqual(outputV2);
-    const resultUp = await migratorMigrations.migrate(resultDown2, {
-      target: "3.0.0",
-    });
-    expect(resultUp).toEqual(outputV3);
+    expect(result).toEqual(input);
   });
 
-  test("should throw if target is not in migrations", async () => {
-    const input: V4 = {
-      dummy: "aaa",
-      version: "1.2.0",
+  test("should support onStep callback during migration", async () => {
+    const input: V1 = {
+      dummyV1: "aaa",
+      version: "1.0.0",
     };
 
-    const badMigratorInstance = createMigrator<V1, V4>().createMigrations({
-      migrations: [
-        initial<V1, V2>("1.0.0", (state) => ({
-          dummyV2: state.dummyV1,
-        })),
-        final<V4, V3>("4.0.0", (state) => ({
-          dummyV3: state.dummy,
-        })),
-      ],
+    const steps: any[] = [];
+    await migratorMigrations.migrate(input, {
+      onStep: async (state, version) => {
+        steps.push({ ...state, version });
+      },
     });
 
-    return expect(badMigratorInstance.migrate(input)).rejects.toThrow();
+    expect(steps).toHaveLength(3); // 1 -> 2, 2 -> 3, 3 -> 4
+    expect(steps[0]).toEqual(expect.objectContaining({ dummyV2: "aaa", version: "2.0.0" }));
+    expect(steps[1]).toEqual(expect.objectContaining({ dummyV3: "aaa", version: "3.0.0" }));
+    expect(steps[2]).toEqual(expect.objectContaining({ dummy: "aaa", version: "4.0.0" }));
   });
 
-  test("should throw on migration not found", async () => {
+  test("should throw if target is not in migrations", async () => {
     const input: V4 = {
       dummy: "aaa",
       version: "1.2.0",
@@ -214,16 +165,20 @@ describe("migrator", () => {
 
     const badMigratorInstance = createMigrator<V1, V4>().createMigrations({
       migrations: [
-        initial<V1, V2>("1.0.0", (state) => ({
-          dummyV2: state.dummyV1,
-        })),
-        final<V4, V3>("4.0.0", (state) => ({
-          dummyV3: state.dummy,
-        })),
+        createMigration<V1, V2>({
+          version: "1.0.0",
+          up: (state) => ({
+            dummyV2: state.dummyV1,
+          }),
+        }),
+        createMigration<V4, never>({
+          version: "4.0.0",
+          up: finalVersion,
+        }),
       ],
     });
 
-    await expect(badMigratorInstance.migrate(input)).rejects.toThrow();
+    return expect(badMigratorInstance.migrate(input)).rejects.toThrow();
   });
 
   test("should migrate an incomplete version (loose)", async () => {
@@ -235,19 +190,15 @@ describe("migrator", () => {
 
     const migrator = createMigrator<V1, V4>().createMigrations({
       migrations: [
-        createMigration<never, V1, V2>({
+        createMigration<V1, V2>({
           version: "1.0.0",
           up: (state) => ({
             dummyV2: state.dummyV1,
           }),
-          down: initialVersion,
         }),
-        createMigration<V1, V2, never>({
+        createMigration<V2, never>({
           version: "2.0.0",
           up: finalVersion,
-          down: (state) => ({
-            dummyV1: state.dummyV2,
-          }),
         }),
       ],
     });
@@ -266,19 +217,15 @@ describe("migrator", () => {
 
     const migrator = createMigrator<V1, V2>().createMigrations({
       migrations: [
-        createMigration<never, V1, V2>({
+        createMigration<V1, V2>({
           version: "1.0.0",
           up: (state) => ({
             dummyV2: state.dummyV1,
           }),
-          down: initialVersion,
         }),
-        createMigration<V1, V2, never>({
+        createMigration<V2, never>({
           version: "2.0.0",
           up: finalVersion,
-          down: (state) => ({
-            dummyV1: state.dummyV2,
-          }),
         }),
       ],
       coerce: false,
@@ -306,7 +253,7 @@ describe("async", () => {
 
     const migrator = createMigrator<V1, V2>().createMigrations({
       migrations: [
-        createMigration<never, V1, V2>({
+        createMigration<V1, V2>({
           version: "1.0.0",
           up: async (state) => {
             await sleep(1000);
@@ -314,17 +261,10 @@ describe("async", () => {
               dummyV2: state.dummyV1,
             };
           },
-          down: initialVersion,
         }),
-        createMigration<V1, V2, never>({
+        createMigration<V2, never>({
           version: "2.0.0",
           up: finalVersion,
-          down: async (state) => {
-            await sleep(1000);
-            return {
-              dummyV1: state.dummyV2,
-            };
-          },
         }),
       ],
     });

package/src/models/migration.ts

@@ -11,6 +11,7 @@ export type MigrationFn<From, To> = (state: From, targetVersion: string) => Awai
 export type MigrateOptions = {
   debug?: boolean;
   target?: SemVer;
+  onStep?: (state: any, version: SemVer) => Promise<void> | void;
 };
 
 const SemverValidator = custom<SemVer>((input) =>
@@ -35,20 +36,18 @@ export type OmitVersion<T> = Omit<T, keyof MigrationSchema>;
 
 export type SemVer = `${number}.${number}.${number}`;
 
-export interface MigrationClass<Down, Current, Up> {
+export interface MigrationClass<Current, Up> {
   version: SemVer;
   up: MigrationFn<Current, Up>;
-  down: MigrationFn<Current, Down>;
 }
 
-export interface MigrationObjInput<Down, Current, Up> {
+export interface MigrationObjInput<Current, Up> {
   version: SemVer;
   up: MigrationFn<OmitVersion<Current>, OmitVersion<Up>>;
-  down: MigrationFn<OmitVersion<Current>, OmitVersion<Down>>;
 }
 
 export interface MigratorConfig<InitialState, FinalState> {
-  migrations: MigrationClass<any, any, any>[];
+  migrations: MigrationClass<any, any>[];
   coerce?: boolean;
   defaultValue?: FinalState;
 }
@@ -56,7 +55,7 @@ export interface MigratorConfig<InitialState, FinalState> {
 export class Migrator<InitialState extends MigrationSchema, OutputState extends MigrationSchema> {
   current: SemVer;
 
-  migrations: Record<SemVer, MigrationClass<any, any, any>> = {};
+  migrations: Record<SemVer, MigrationClass<any, any>> = {};
 
   coerce: boolean;
   defaultValue: OutputState;
@@ -109,20 +108,20 @@ export class Migrator<InitialState extends MigrationSchema, OutputState extends
 
     // Get the migration path
     const isUpgrade = currentIndex < targetIndex;
-    const increment = isUpgrade ? 1 : -1;
-    const direction = isUpgrade ? "up" : "down";
+
+    if (!isUpgrade) {
+      return finalState as OutputState;
+    }
 
     // Perform migrations
-    for (let i = currentIndex; isUpgrade ? i < targetIndex : i > targetIndex; i += increment) {
+    for (let i = currentIndex; i < targetIndex; i++) {
       const currentVersion = versions[i];
-      const nextVersion = versions[i + increment];
+      const nextVersion = versions[i + 1];
 
       if (options?.debug) {
         console.log("\tMigrating to version:", nextVersion);
       }
 
-      // For upgrades, use current version's migration
-      // For downgrades, use previous version's migration
       const migrationVersion = currentVersion;
       const migration = this.migrations[migrationVersion];
 
@@ -130,7 +129,7 @@ export class Migrator<InitialState extends MigrationSchema, OutputState extends
       const { version: _, ...stateWithoutVersion } = finalState;
 
       // Perform migration
-      const migratedState = await migration[direction](stateWithoutVersion, currentVersion);
+      const migratedState = await migration.up(stateWithoutVersion, currentVersion);
 
       // Add new version
       finalState = {
@@ -138,6 +137,10 @@ export class Migrator<InitialState extends MigrationSchema, OutputState extends
         version: nextVersion,
       };
 
+      if (options?.onStep) {
+        await options.onStep(finalState, nextVersion);
+      }
+
       if (options?.debug) {
         console.log("\tMigrated state:", finalState);
       }