@contember/schema-migrations 1.1.2 → 1.2.0-alpha.11

package/src/modifications/relations/UpdateRelationOrderByModification.ts

@@ -1,12 +1,12 @@
 import { MigrationBuilder } from '@contember/database-migrations'
 import { Model, Schema } from '@contember/schema'
 import { SchemaUpdater, updateEntity, updateField, updateModel } from '../utils/schemaUpdateUtils'
-import { ModificationHandlerStatic } from '../ModificationHandler'
+import { createModificationType, Differ, ModificationHandler } from '../ModificationHandler'
 import deepEqual from 'fast-deep-equal'
 import { updateRelations } from '../utils/diffUtils'
 
-export const UpdateRelationOrderByModification: ModificationHandlerStatic<UpdateRelationOrderByModificationData> = class {
-	static id = 'updateRelationOrderBy'
+export class UpdateRelationOrderByModificationHandler implements ModificationHandler<UpdateRelationOrderByModificationData> {
+
 	constructor(private readonly data: UpdateRelationOrderByModificationData, private readonly schema: Schema) {}
 
 	public createSql(builder: MigrationBuilder): void {}
@@ -27,12 +27,21 @@ export const UpdateRelationOrderByModification: ModificationHandlerStatic<Update
 	describe() {
 		return { message: `Update order-by of relation ${this.data.entityName}.${this.data.fieldName}` }
 	}
+}
 
-	static createModification(data: UpdateRelationOrderByModificationData) {
-		return { modification: this.id, ...data }
-	}
+export interface UpdateRelationOrderByModificationData {
+	entityName: string
+	fieldName: string
+	orderBy: readonly Model.OrderBy[]
+}
 
-	static createDiff(originalSchema: Schema, updatedSchema: Schema) {
+export const updateRelationOrderByModification = createModificationType({
+	id: 'updateRelationOrderBy',
+	handler: UpdateRelationOrderByModificationHandler,
+})
+
+export class UpdateRelationOrderByDiffer implements Differ {
+	createDiff(originalSchema: Schema, updatedSchema: Schema) {
 		return updateRelations(originalSchema, updatedSchema, ({ updatedRelation, originalRelation, updatedEntity }) => {
 			const isItOrderable = (relation: Model.AnyRelation): relation is Model.OrderableRelation & Model.AnyRelation =>
 				relation.type === Model.RelationType.ManyHasMany || relation.type === Model.RelationType.OneHasMany
@@ -42,7 +51,7 @@ export const UpdateRelationOrderByModification: ModificationHandlerStatic<Update
 				isItOrderable(originalRelation) &&
 				!deepEqual(updatedRelation.orderBy || [], originalRelation.orderBy || [])
 			) {
-				return UpdateRelationOrderByModification.createModification({
+				return updateRelationOrderByModification.createModification({
 					entityName: updatedEntity.name,
 					fieldName: updatedRelation.name,
 					orderBy: updatedRelation.orderBy || [],
@@ -52,9 +61,3 @@ export const UpdateRelationOrderByModification: ModificationHandlerStatic<Update
 		})
 	}
 }
-
-export interface UpdateRelationOrderByModificationData {
-	entityName: string
-	fieldName: string
-	orderBy: readonly Model.OrderBy[]
-}

package/src/modifications/relations/index.ts

@@ -6,6 +6,6 @@ export * from './DisableOrphanRemovalModification'
 export * from './EnableOrphanRemovalModification'
 export * from './MakeRelationNotNullModification'
 export * from './MakeRelationNullableModification'
-export * from './ToggleManyHasManyEventLogModification'
+export * from './ToggleJunctionEventLogModification'
 export * from './UpdateRelationOnDeleteModification'
 export * from './UpdateRelationOrderByModification'

package/src/modifications/validation/PatchValidationSchemaModification.ts

@@ -1,11 +1,10 @@
 import { MigrationBuilder } from '@contember/database-migrations'
 import { SchemaUpdater } from '../utils/schemaUpdateUtils'
-import { ModificationHandlerStatic } from '../ModificationHandler'
+import { createModificationType, ModificationHandler } from '../ModificationHandler'
 import { applyPatch, Operation } from 'rfc6902'
 import deepCopy from '../../utils/deepCopy'
 
-export const PatchValidationSchemaModification: ModificationHandlerStatic<PatchValidationSchemaModificationData> = class {
-	static id = 'patchValidationSchema'
+export class PatchValidationSchemaModificationHandler implements ModificationHandler<PatchValidationSchemaModificationData> {
 	constructor(private readonly data: PatchValidationSchemaModificationData) {}
 
 	public createSql(builder: MigrationBuilder): void {}
@@ -28,12 +27,13 @@ export const PatchValidationSchemaModification: ModificationHandlerStatic<PatchV
 	describe() {
 		return { message: 'Update validation schema' }
 	}
-
-	static createModification(data: PatchValidationSchemaModificationData) {
-		return { modification: this.id, ...data }
-	}
 }
 
 export interface PatchValidationSchemaModificationData {
 	patch: Operation[]
 }
+
+export const patchValidationSchemaModification = createModificationType({
+	id: 'patchValidationSchema',
+	handler: PatchValidationSchemaModificationHandler,
+})

package/src/modifications/validation/UpdateValidationSchemaModification.ts

@@ -1,13 +1,12 @@
 import { MigrationBuilder } from '@contember/database-migrations'
 import { Schema, Validation } from '@contember/schema'
 import { SchemaUpdater } from '../utils/schemaUpdateUtils'
-import { ModificationHandlerStatic } from '../ModificationHandler'
+import { createModificationType, Differ, ModificationHandler } from '../ModificationHandler'
 import deepEqual from 'fast-deep-equal'
 import { createPatch } from 'rfc6902'
-import { PatchValidationSchemaModification } from './PatchValidationSchemaModification'
+import { patchValidationSchemaModification } from './PatchValidationSchemaModification'
 
-export const UpdateValidationSchemaModification: ModificationHandlerStatic<UpdateValidationSchemaModificationData> = class {
-	static id = 'updateValidationSchema'
+export class UpdateValidationSchemaModificationHandler implements ModificationHandler<UpdateValidationSchemaModificationData> {
 	constructor(private readonly data: UpdateValidationSchemaModificationData) {}
 
 	public createSql(builder: MigrationBuilder): void {}
@@ -23,22 +22,26 @@ export const UpdateValidationSchemaModification: ModificationHandlerStatic<Updat
 		return { message: 'Update validation schema' }
 	}
 
-	static createModification(data: UpdateValidationSchemaModificationData) {
-		return { modification: this.id, ...data }
-	}
+}
+
+export interface UpdateValidationSchemaModificationData {
+	schema: Validation.Schema
+}
 
-	static createDiff(originalSchema: Schema, updatedSchema: Schema) {
+export const updateValidationSchemaModification = createModificationType({
+	id: 'updateValidationSchema',
+	handler: UpdateValidationSchemaModificationHandler,
+})
+
+export class UpdateValidationSchemaDiffer implements Differ {
+	createDiff(originalSchema: Schema, updatedSchema: Schema) {
 		if (deepEqual(originalSchema.validation, updatedSchema.validation)) {
 			return []
 		}
 		const patch = createPatch(originalSchema.validation, updatedSchema.validation)
 		if (patch.length <= 20) {
-			return [PatchValidationSchemaModification.createModification({ patch })]
+			return [patchValidationSchemaModification.createModification({ patch })]
 		}
-		return [UpdateValidationSchemaModification.createModification({ schema: updatedSchema.validation })]
+		return [updateValidationSchemaModification.createModification({ schema: updatedSchema.validation })]
 	}
 }
-
-export interface UpdateValidationSchemaModificationData {
-	schema: Validation.Schema
-}

package/src/utils/PartialEntity.ts

@@ -0,0 +1,5 @@
+import { Model } from '@contember/schema'
+
+type SomePartial<E, K extends keyof E> = Omit<E, K> & Partial<Pick<E, K>>
+
+export type PartialEntity = SomePartial<Model.Entity, 'eventLog' | 'indexes'>

package/tests/cases/integration/createAndDropIndex.test.ts

@@ -0,0 +1,44 @@
+import { testMigrations } from '../../src/tests'
+import { SQL } from '../../src/tags'
+import { SchemaDefinition as def } from '@contember/schema-definition'
+
+namespace SchemaWithoutIndex {
+	export class Article {
+		title = def.stringColumn()
+	}
+}
+
+namespace SchemaWithIndex {
+	@def.Index('title')
+	export class Article {
+		title = def.stringColumn()
+	}
+}
+
+
+testMigrations('create index', {
+	originalSchema: def.createModel(SchemaWithoutIndex),
+	updatedSchema: def.createModel(SchemaWithIndex),
+	diff: [
+		{
+			modification: 'createIndex',
+			entityName: 'Article',
+			index: { name: 'idx_Article_title_2dc66a', fields: ['title'] },
+		},
+	],
+	sql: SQL`CREATE INDEX "idx_Article_title_2dc66a" ON "article" ("title");`,
+})
+
+
+testMigrations('drop index', {
+	originalSchema: def.createModel(SchemaWithIndex),
+	updatedSchema: def.createModel(SchemaWithoutIndex),
+	diff: [
+		{
+			modification: 'removeIndex',
+			entityName: 'Article',
+			indexName: 'idx_Article_title_2dc66a',
+		},
+	],
+	sql: SQL`DROP INDEX "idx_Article_title_2dc66a";`,
+})

package/tests/cases/integration/createEntity.test.ts

@@ -35,6 +35,7 @@ testMigrations('create a table (no relations, unique on column)', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -141,6 +142,7 @@ testMigrations('create a view', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 	],

package/tests/cases/integration/createManyHasMany.test.ts

@@ -34,6 +34,7 @@ testMigrations('create many has many relation (post with categories)', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{

package/tests/cases/integration/createManyHasOne.test.ts

@@ -36,6 +36,7 @@ testMigrations('create many has one relation (post with author)', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{

package/tests/cases/integration/createOneHasMany.test.ts

@@ -37,6 +37,7 @@ testMigrations('create one has many relation (post with locales)', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{

package/tests/cases/integration/createOneHasOne.test.ts

@@ -34,6 +34,7 @@ testMigrations('create one has one relation (site with settings)', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -56,6 +57,7 @@ testMigrations('create one has one relation (site with settings)', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{

package/tests/cases/integration/createView.test.ts

@@ -68,6 +68,7 @@ testMigrations('create view', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{

package/tests/cases/integration/updateView.test.ts

@@ -83,6 +83,7 @@ testMigrations('update a view 1', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -118,6 +119,7 @@ testMigrations('update a view 1', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -153,6 +155,7 @@ testMigrations('update a view 1', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 	],
@@ -227,6 +230,7 @@ testMigrations('update a view 2', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -262,6 +266,7 @@ testMigrations('update a view 2', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 	],
@@ -331,6 +336,7 @@ testMigrations('update a view 3', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 	],
@@ -402,6 +408,7 @@ testMigrations('update a view 4', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -437,6 +444,7 @@ testMigrations('update a view 4', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -472,6 +480,7 @@ testMigrations('update a view 4', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 	],

package/dist/src/modifications/relations/ToggleManyHasManyEventLogModification.d.ts

@@ -1,8 +0,0 @@
-import { ModificationHandlerStatic } from '../ModificationHandler';
-export declare const ToggleJunctionEventLogModification: ModificationHandlerStatic<ToggleJunctionEventLogModificationData>;
-export interface ToggleJunctionEventLogModificationData {
-    entityName: string;
-    fieldName: string;
-    enabled: boolean;
-}
-//# sourceMappingURL=ToggleManyHasManyEventLogModification.d.ts.map

package/dist/src/modifications/relations/ToggleManyHasManyEventLogModification.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ToggleManyHasManyEventLogModification.d.ts","sourceRoot":"","sources":["../../../../src/modifications/relations/ToggleManyHasManyEventLogModification.ts"],"names":[],"mappings":"AAGA,OAAO,EAA8B,yBAAyB,EAAE,MAAM,wBAAwB,CAAA;AAW9F,eAAO,MAAM,kCAAkC,EAAE,yBAAyB,CAAC,sCAAsC,CAiFhH,CAAA;AAED,MAAM,WAAW,sCAAsC;IACtD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,OAAO,CAAA;CAChB"}

package/dist/src/modifications/relations/ToggleManyHasManyEventLogModification.js

@@ -1,81 +0,0 @@
-"use strict";
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ToggleJunctionEventLogModification = void 0;
-const schema_1 = require("@contember/schema");
-const schemaUpdateUtils_1 = require("../utils/schemaUpdateUtils");
-const sqlUpdateUtils_1 = require("../utils/sqlUpdateUtils");
-const schema_utils_1 = require("@contember/schema-utils");
-const diffUtils_1 = require("../utils/diffUtils");
-const isIt_1 = require("../../utils/isIt");
-exports.ToggleJunctionEventLogModification = (_a = class {
-        constructor(data, schema, options) {
-            this.data = data;
-            this.schema = schema;
-            this.options = options;
-        }
-        createSql(builder) {
-            const entity = this.schema.model.entities[this.data.entityName];
-            const relation = entity.fields[this.data.fieldName];
-            if (!(0, schema_utils_1.isRelation)(relation) || relation.type !== schema_1.Model.RelationType.ManyHasMany || !(0, schema_utils_1.isOwningRelation)(relation)) {
-                throw new Error('invalid field');
-            }
-            const tableName = relation.joiningTable.tableName;
-            if (this.data.enabled) {
-                const primaryColumns = [
-                    relation.joiningTable.joiningColumn.columnName,
-                    relation.joiningTable.inverseJoiningColumn.columnName,
-                ];
-                (0, sqlUpdateUtils_1.createEventTrigger)(builder, this.options.systemSchema, tableName, primaryColumns);
-                (0, sqlUpdateUtils_1.createEventTrxTrigger)(builder, this.options.systemSchema, tableName);
-            }
-            else {
-                (0, sqlUpdateUtils_1.dropEventTrigger)(builder, tableName);
-                (0, sqlUpdateUtils_1.dropEventTrxTrigger)(builder, tableName);
-            }
-        }
-        getSchemaUpdater() {
-            const { entityName, fieldName, enabled } = this.data;
-            return (0, schemaUpdateUtils_1.updateModel)((0, schemaUpdateUtils_1.updateEntity)(entityName, (0, schemaUpdateUtils_1.updateField)(fieldName, ({ field: { joiningTable: { eventLog, ...joiningTable }, ...field } }) => {
-                return {
-                    ...field,
-                    joiningTable: {
-                        ...joiningTable,
-                        eventLog: {
-                            enabled,
-                        },
-                    },
-                };
-            })));
-        }
-        describe() {
-            return {
-                message: `${this.data.enabled ? 'Enable' : 'Disable'} event log for ${this.data.entityName}.${this.data.fieldName}`,
-            };
-        }
-        static createModification(data) {
-            return { modification: this.id, ...data };
-        }
-        static createDiff(originalSchema, updatedSchema) {
-            return (0, diffUtils_1.updateRelations)(originalSchema, updatedSchema, ({ originalRelation, updatedRelation, updatedEntity }) => {
-                var _a, _b, _c, _d;
-                if (originalRelation.type === updatedRelation.type &&
-                    (0, isIt_1.isIt)(updatedRelation, 'joiningTable') &&
-                    (0, isIt_1.isIt)(originalRelation, 'joiningTable')) {
-                    const newValue = (_b = (_a = updatedRelation.joiningTable.eventLog) === null || _a === void 0 ? void 0 : _a.enabled) !== null && _b !== void 0 ? _b : false;
-                    const oldValue = (_d = (_c = originalRelation.joiningTable.eventLog) === null || _c === void 0 ? void 0 : _c.enabled) !== null && _d !== void 0 ? _d : false;
-                    if (newValue !== oldValue) {
-                        return exports.ToggleJunctionEventLogModification.createModification({
-                            entityName: updatedEntity.name,
-                            fieldName: updatedRelation.name,
-                            enabled: newValue,
-                        });
-                    }
-                }
-                return undefined;
-            });
-        }
-    },
-    _a.id = 'toggleJunctionEventLog',
-    _a);
-//# sourceMappingURL=ToggleManyHasManyEventLogModification.js.map

package/dist/src/modifications/relations/ToggleManyHasManyEventLogModification.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ToggleManyHasManyEventLogModification.js","sourceRoot":"","sources":["../../../../src/modifications/relations/ToggleManyHasManyEventLogModification.ts"],"names":[],"mappings":";;;;AACA,8CAAiD;AACjD,kEAAkG;AAElG,4DAKgC;AAChC,0DAAsE;AACtE,kDAAoD;AACpD,2CAAuC;AAE1B,QAAA,kCAAkC,SAAsE;QAGpH,YACkB,IAA4C,EAC5C,MAAc,EACd,OAAmC;YAFnC,SAAI,GAAJ,IAAI,CAAwC;YAC5C,WAAM,GAAN,MAAM,CAAQ;YACd,YAAO,GAAP,OAAO,CAA4B;QAErD,CAAC;QAEM,SAAS,CAAC,OAAyB;YACzC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YAC/D,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACnD,IAAI,CAAC,IAAA,yBAAU,EAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,IAAI,KAAK,cAAK,CAAC,YAAY,CAAC,WAAW,IAAI,CAAC,IAAA,+BAAgB,EAAC,QAAQ,CAAC,EAAE;gBAC7G,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;aAChC;YACD,MAAM,SAAS,GAAG,QAAQ,CAAC,YAAY,CAAC,SAAS,CAAA;YACjD,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;gBACtB,MAAM,cAAc,GAAG;oBACtB,QAAQ,CAAC,YAAY,CAAC,aAAa,CAAC,UAAU;oBAC9C,QAAQ,CAAC,YAAY,CAAC,oBAAoB,CAAC,UAAU;iBACrD,CAAA;gBACD,IAAA,mCAAkB,EAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,SAAS,EAAE,cAAc,CAAC,CAAA;gBACjF,IAAA,sCAAqB,EAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,SAAS,CAAC,CAAA;aACpE;iBAAM;gBACN,IAAA,iCAAgB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAA;gBACpC,IAAA,oCAAmB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAA;aACvC;QACF,CAAC;QAEM,gBAAgB;YACtB,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,IAAI,CAAA;YACpD,OAAO,IAAA,+BAAW,EACjB,IAAA,gCAAY,EACX,UAAU,EACV,IAAA,+BAAW,EAAkC,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,EAAE,QAAQ,EAAE,GAAG,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE,EAAE;gBAChI,OAAO;oBACN,GAAG,KAAK;oBACR,YAAY,EAAE;wBACb,GAAG,YAAY;wBACf,QAAQ,EAAE;4BACT,OAAO;yBACP;qBACD;iBACD,CAAA;YACF,CAAC,CAAC,CACF,CACD,CAAA;QACF,CAAC;QAED,QAAQ;YACP,OAAO;gBACN,OAAO,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,kBAAkB,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;aACnH,CAAA;QACF,CAAC;QAED,MAAM,CAAC,kBAAkB,CAAC,IAA4C;YACrE,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,EAAE,CAAA;QAC1C,CAAC;QAED,MAAM,CAAC,UAAU,CAAC,cAAsB,EAAE,aAAqB;YAC9D,OAAO,IAAA,2BAAe,EAAC,cAAc,EAAE,aAAa,EAAE,CAAC,EAAE,gBAAgB,EAAE,eAAe,EAAE,aAAa,EAAE,EAAE,EAAE;;gBAC9G,IACC,gBAAgB,CAAC,IAAI,KAAK,eAAe,CAAC,IAAI;oBAC9C,IAAA,WAAI,EAA6B,eAAe,EAAE,cAAc,CAAC;oBACjE,IAAA,WAAI,EAA6B,gBAAgB,EAAE,cAAc,CAAC,EACjE;oBACD,MAAM,QAAQ,GAAG,MAAA,MAAA,eAAe,CAAC,YAAY,CAAC,QAAQ,0CAAE,OAAO,mCAAI,KAAK,CAAA;oBACxE,MAAM,QAAQ,GAAG,MAAA,MAAA,gBAAgB,CAAC,YAAY,CAAC,QAAQ,0CAAE,OAAO,mCAAI,KAAK,CAAA;oBACzE,IAAI,QAAQ,KAAK,QAAQ,EAAE;wBAC1B,OAAO,0CAAkC,CAAC,kBAAkB,CAAC;4BAC5D,UAAU,EAAE,aAAa,CAAC,IAAI;4BAC9B,SAAS,EAAE,eAAe,CAAC,IAAI;4BAC/B,OAAO,EAAE,QAAQ;yBACjB,CAAC,CAAA;qBACF;iBACD;gBACD,OAAO,SAAS,CAAA;YACjB,CAAC,CAAC,CAAA;QAEH,CAAC;KACD;IAhFO,KAAE,GAAG,wBAAwB;QAgFpC"}