@contember/migrations-client 2.1.0-alpha.9 → 2.1.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contember/migrations-client",
-  "version": "2.1.0-alpha.9",
+  "version": "2.1.0-beta.1",
   "license": "Apache-2.0",
   "main": "./dist/production/index.js",
   "typings": "./dist/types/index.d.ts",
@@ -26,14 +26,19 @@
     "test": "echo 'No tests'"
   },
   "dependencies": {
-    "@contember/engine-common": "2.1.0-alpha.9",
-    "@contember/graphql-client": "2.1.0-alpha.9",
-    "@contember/schema": "2.1.0-alpha.9",
-    "@contember/schema-migrations": "2.1.0-alpha.9",
-    "@contember/schema-utils": "2.1.0-alpha.9"
+    "@contember/engine-common": "2.1.0-beta.1",
+    "@contember/graphql-client": "2.1.0-beta.1",
+    "@contember/schema": "2.1.0-beta.1",
+    "@contember/schema-migrations": "2.1.0-beta.1",
+    "@contember/schema-utils": "2.1.0-beta.1"
   },
   "devDependencies": {
-    "@types/node": "^20.17.22"
+    "@types/node": "^24.12.0"
   },
-  "type": "module"
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/contember/contember.git",
+    "directory": "packages/migrations-client"
+  }
 }

package/src/JsLoader.ts

@@ -9,7 +9,6 @@ export class JsLoader implements MigrationFileLoader {
 	) {
 	}
 
-
 	public async load(file: MigrationFile): Promise<MigrationContent> {
 		const exports = await this.jsExecutor(file.path)
 		if (!('default' in exports) && !('query' in exports) && !('queries' in exports)) {
@@ -29,7 +28,6 @@ export class JsLoader implements MigrationFileLoader {
 				}
 				return migration
 			},
-
 		}
 	}
 }

package/src/MigrationExecuteHelper.ts

@@ -3,9 +3,7 @@ import { ContentMigrationFactoryArgs, ResolvedMigrationContent } from './Migrati
 import { assertNever } from './utils/assertNever'
 import { SystemClient } from './SystemClient'
 
-
 export class MigrationExecutor {
-
 	async executeMigrations({
 		client,
 		migrations,

package/src/MigrationFile.ts

@@ -10,7 +10,8 @@ export interface MigrationFile {
 	getContent: () => Promise<MigrationContent>
 }
 
-export const isSchemaMigration = (content: MigrationContent): content is SchemaMigration => typeof content !== 'function' && 'modifications' in content
+export const isSchemaMigration = (content: MigrationContent): content is SchemaMigration =>
+	typeof content !== 'function' && 'modifications' in content
 
 export type ResolvedMigrationContent =
 	| SchemaMigration
@@ -52,4 +53,3 @@ export type ContentMigrationQuery = {
 	stage?: string
 	checkMutationResult?: boolean
 }
-

package/src/MigrationFilesManager.ts

@@ -83,7 +83,7 @@ export class MigrationFilesManager {
 		const files = await this.tryReadDir()
 
 		const extensions = Object.keys(this.loaders).join('|')
-		const regex = new RegExp('^\\d{4}-\\d{2}-\\d{2}-\\d{6}-[\\w-]+\\.(' + extensions  + ')$')
+		const regex = new RegExp('^\\d{4}-\\d{2}-\\d{2}-\\d{6}-[\\w-]+\\.(' + extensions + ')$')
 		const filteredFiles = await Promise.all(
 			files
 				.filter(it => it.isFile())

package/src/MigrationsResolver.ts

@@ -4,7 +4,6 @@ import { isSchemaMigration, MigrationFile } from './MigrationFile'
 import { MigrationVersionHelper } from '@contember/engine-common'
 
 export class MigrationsResolver {
-
 	constructor(private readonly migrationFilesManager: MigrationFilesManager) {}
 
 	public get directory(): string {
@@ -31,9 +30,7 @@ export class MigrationsResolver {
 	public async findSchemaMigrationByVersion(version: string): Promise<Migration | null> {
 		const migrations = await this.getSchemaMigrations()
 		return migrations
-			.find(it =>
-				MigrationVersionHelper.extractVersion(it.version) === MigrationVersionHelper.extractVersion(version),
-			)
+			.find(it => MigrationVersionHelper.extractVersion(it.version) === MigrationVersionHelper.extractVersion(version))
 			?? null
 	}
 

package/src/SchemaVersionBuilder.ts

@@ -25,8 +25,7 @@ export class SchemaVersionBuilder {
 		return (await this.migrationsResolver.getSchemaMigrations())
 			.filter(({ version }) => condition(version))
 			.reduce<Schema>(
-				(schema, { modifications, formatVersion }) =>
-					this.schemaMigrator.applyModifications(schema, modifications, formatVersion),
+				(schema, { modifications, formatVersion }) => this.schemaMigrator.applyModifications(schema, modifications, formatVersion),
 				initialSchema,
 			)
 	}

package/src/index.ts

@@ -1,15 +1,12 @@
 export {
+	calculateMigrationChecksum,
 	MigrationDescriber,
 	ModificationHandlerFactory,
 	SchemaDiffer,
 	SchemaMigrator,
 	VERSION_LATEST,
-	calculateMigrationChecksum,
-} from '@contember/schema-migrations'
-export type {
-	MigrationInfo,
-	Migration,
 } from '@contember/schema-migrations'
+export type { Migration, MigrationInfo } from '@contember/schema-migrations'
 export * from './JsLoader'
 export * from './JsonLoader'
 export * from './MigrationCreator'

package/src/migrations.ts

@@ -14,6 +14,7 @@ export interface ExecutedMigration extends Migration {
 export enum MigrationState {
 	TO_EXECUTE_OK = 'to_execute_ok',
 	TO_EXECUTE_ERROR = 'to_execute_error',
+	SKIP_EMPTY = 'skip_empty',
 	EXECUTED_OK = 'executed_ok',
 	EXECUTED_ERROR = 'executed_error',
 	EXECUTED_MISSING = 'executed_missing',
@@ -34,22 +35,26 @@ interface MigrationToExecuteInvalidStatus extends MigrationStatusBase<MigrationS
 	errorMessage: string
 }
 
-interface MigrationExecutedOkStatus extends MigrationStatusBase<MigrationState.EXECUTED_OK>{
+interface MigrationExecutedOkStatus extends MigrationStatusBase<MigrationState.EXECUTED_OK> {
 	executedMigration: ExecutedMigrationInfo
 	localMigration: MigrationFile
 }
 
-interface MigrationExecutedMissingStatus extends MigrationStatusBase<MigrationState.EXECUTED_MISSING>{
+interface MigrationExecutedMissingStatus extends MigrationStatusBase<MigrationState.EXECUTED_MISSING> {
 	executedMigration: ExecutedMigrationInfo
 	errorMessage: string
 }
 
-interface MigrationExecutedErrorStatus extends MigrationStatusBase<MigrationState.EXECUTED_ERROR>{
+interface MigrationExecutedErrorStatus extends MigrationStatusBase<MigrationState.EXECUTED_ERROR> {
 	executedMigration: ExecutedMigrationInfo
 	localMigration: MigrationFile
 	errorMessage: string
 }
 
+export interface MigrationSkipStatus extends MigrationStatusBase<MigrationState.SKIP_EMPTY> {
+	localMigration: MigrationFile
+}
+
 export type ErrorMigrationStatus =
 	| MigrationToExecuteInvalidStatus
 	| MigrationExecutedMissingStatus
@@ -59,6 +64,7 @@ export type AnyMigrationStatus =
 	| ErrorMigrationStatus
 	| MigrationToExecuteOkStatus
 	| MigrationExecutedOkStatus
+	| MigrationSkipStatus
 
 const isErrorMigrationStatus = (migration: AnyMigrationStatus): migration is ErrorMigrationStatus =>
 	[MigrationState.EXECUTED_ERROR, MigrationState.EXECUTED_MISSING, MigrationState.TO_EXECUTE_ERROR].includes(
@@ -70,7 +76,6 @@ export const sortMigrations = <M extends { version: string }>(migrations: M[]):
 }
 
 export class MigrationsStatusResolver {
-
 	async getMigrationsStatus(
 		executedMigrations: ExecutedMigrationInfo[],
 		localMigrations: MigrationFile[],
@@ -124,6 +129,16 @@ export class MigrationsStatusResolver {
 			if (allMigrations.find(it => it.version === localMigration.version)) {
 				continue
 			}
+			const migrationContent = await localMigration.getContent()
+			if (isSchemaMigration(migrationContent) && migrationContent.modifications.length === 0) {
+				allMigrations.push({
+					state: MigrationState.SKIP_EMPTY,
+					localMigration,
+					version: localMigration.version,
+					name: localMigration.name,
+				})
+				continue
+			}
 
 			if (latestExecuted && latestExecuted.version > localMigration.version) {
 				allMigrations.push({
@@ -148,10 +163,8 @@ export class MigrationsStatusResolver {
 			allMigrations: allMigrationsSorted,
 			errorMigrations: allMigrationsSorted.filter(isErrorMigrationStatus),
 			migrationsToExecute: allMigrationsSorted.filter(
-				(it): it is MigrationToExecuteOkStatus =>
-					it.state === MigrationState.TO_EXECUTE_OK || (force && it.state === MigrationState.TO_EXECUTE_ERROR),
+				(it): it is MigrationToExecuteOkStatus => it.state === MigrationState.TO_EXECUTE_OK || (force && it.state === MigrationState.TO_EXECUTE_ERROR),
 			),
 		}
 	}
-
 }