@contember/schema-migrations 2.1.0-alpha.3 → 2.1.0-alpha.35

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

@@ -4,59 +4,60 @@ import { SchemaBuilder } from '@contember/schema-definition'
 import { Model } from '@contember/schema'
 import { SQL } from '../../src/tags'
 
-describe('patch acl', () => testMigrations({
-	original: {
-		model: new SchemaBuilder()
-			.entity('Site', entity => entity.column('name', c => c.type(Model.ColumnType.String)))
-			.buildSchema(),
-	},
-	updated: {
-		model: new SchemaBuilder()
-			.entity('Site', entity => entity.column('name', c => c.type(Model.ColumnType.String)))
-			.buildSchema(),
-		acl: {
-			roles: {
-				admin: {
-					variables: {},
-					stages: '*',
-					entities: {
-						Site: {
-							predicates: {},
-							operations: {
-								read: {
-									id: true,
-								},
-							},
-						},
-					},
-				},
-			},
+describe('patch acl', () =>
+	testMigrations({
+		original: {
+			model: new SchemaBuilder()
+				.entity('Site', entity => entity.column('name', c => c.type(Model.ColumnType.String)))
+				.buildSchema(),
 		},
-	},
-	diff: [
-		{
-			modification: 'patchAclSchema',
-			patch: [
-				{
-					op: 'add',
-					path: '/roles/admin',
-					value: {
+		updated: {
+			model: new SchemaBuilder()
+				.entity('Site', entity => entity.column('name', c => c.type(Model.ColumnType.String)))
+				.buildSchema(),
+			acl: {
+				roles: {
+					admin: {
 						variables: {},
+						stages: '*',
 						entities: {
 							Site: {
+								predicates: {},
 								operations: {
 									read: {
 										id: true,
 									},
 								},
-								predicates: {},
 							},
 						},
-						stages: '*',
 					},
 				},
-			],
+			},
 		},
-	],
-	sql: SQL``,
-}))
+		diff: [
+			{
+				modification: 'patchAclSchema',
+				patch: [
+					{
+						op: 'add',
+						path: '/roles/admin',
+						value: {
+							variables: {},
+							entities: {
+								Site: {
+									operations: {
+										read: {
+											id: true,
+										},
+									},
+									predicates: {},
+								},
+							},
+							stages: '*',
+						},
+					},
+				],
+			},
+		],
+		sql: SQL``,
+	}))

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

@@ -0,0 +1,184 @@
+import { Actions } from '@contember/schema'
+import { emptySchema } from '@contember/schema-utils'
+import { describe } from 'bun:test'
+import { testMigrations } from '../../src/tests'
+import { c, createSchema } from '@contember/schema-definition'
+namespace Schema {
+	export class Post {
+		title = c.stringColumn()
+		description = c.stringColumn()
+		category = c.manyHasOne(Category, 'articles')
+	}
+
+	export class Category {
+		name = c.stringColumn()
+		slug = c.stringColumn()
+		articles = c.oneHasMany(Post, 'category')
+	}
+}
+
+describe('patch trigger', () =>
+	testMigrations({
+		original: {
+			...createSchema(Schema),
+			actions: {
+				triggers: {
+					'post_created': {
+						type: 'basic',
+						name: 'post_created',
+						entity: 'Post',
+						create: true,
+						delete: false,
+						update: false,
+						target: 'webhook',
+						selection: [
+							'id',
+							'title',
+							['category', {}, ['name']],
+						],
+					} satisfies Actions.BasicTrigger,
+				},
+				targets: {
+					'webhook': {
+						type: 'webhook',
+						name: 'webhook',
+						url: 'https://example.com/webhook',
+					} satisfies Actions.WebhookTarget,
+				},
+			},
+		},
+		updated: {
+			...createSchema(Schema),
+			actions: {
+				triggers: {
+					'post_created': {
+						type: 'basic',
+						name: 'post_created',
+						entity: 'Post',
+						create: true,
+						delete: false,
+						update: false,
+						target: 'webhook',
+						selection: [
+							'id',
+							'title',
+							'description', // added field
+							['category', {}, ['name', 'slug']], // added sub-field
+						],
+					} satisfies Actions.BasicTrigger,
+				},
+				targets: {
+					'webhook': {
+						type: 'webhook',
+						name: 'webhook',
+						url: 'https://example.com/webhook',
+					} satisfies Actions.WebhookTarget,
+				},
+			},
+		},
+		diff: [
+			{
+				modification: 'patchTrigger',
+				triggerName: 'post_created',
+				patch: [
+					{
+						op: 'replace',
+						path: '/selection/2',
+						value: 'description',
+					},
+					{
+						op: 'add',
+						path: '/selection/-',
+						value: [
+							'category',
+							{},
+							[
+								'name',
+								'slug',
+							],
+						],
+					},
+				],
+			},
+		],
+		sql: '', // no SQL changes for action modifications
+	}))
+
+describe('patch watch trigger', () =>
+	testMigrations({
+		original: {
+			...createSchema(Schema),
+			actions: {
+				triggers: {
+					'post_watch': {
+						type: 'watch',
+						name: 'post_watch',
+						entity: 'Post',
+						target: 'webhook',
+						watch: [
+							'title',
+							['category', {}, ['name']],
+						],
+					} satisfies Actions.WatchTrigger,
+				},
+				targets: {
+					'webhook': {
+						type: 'webhook',
+						name: 'webhook',
+						url: 'https://example.com/webhook',
+					} satisfies Actions.WebhookTarget,
+				},
+			},
+		},
+		updated: {
+			...createSchema(Schema),
+			actions: {
+				triggers: {
+					'post_watch': {
+						type: 'watch',
+						name: 'post_watch',
+						entity: 'Post',
+						target: 'webhook',
+						watch: [
+							'title',
+							'description', // added field
+							['category', {}, ['name', 'slug']], // added sub-field
+						],
+					} satisfies Actions.WatchTrigger,
+				},
+				targets: {
+					'webhook': {
+						type: 'webhook',
+						name: 'webhook',
+						url: 'https://example.com/webhook',
+					} satisfies Actions.WebhookTarget,
+				},
+			},
+		},
+		diff: [
+			{
+				modification: 'patchTrigger',
+				triggerName: 'post_watch',
+				patch: [
+					{
+						op: 'replace',
+						path: '/watch/1',
+						value: 'description',
+					},
+					{
+						op: 'add',
+						path: '/watch/-',
+						value: [
+							'category',
+							{},
+							[
+								'name',
+								'slug',
+							],
+						],
+					},
+				],
+			},
+		],
+		sql: '', // no SQL changes for action modifications
+	}))

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

@@ -5,63 +5,65 @@ import { Acl, Model } from '@contember/schema'
 import { SQL } from '../../src/tags'
 import { SchemaDefinition as def } from '@contember/schema-definition'
 
-describe('remove an entity', () => testMigrations({
-	original: {
-		model: new SchemaBuilder()
-			.entity('Author', e => e.column('name', c => c.type(Model.ColumnType.String)))
-			.entity('Post', e =>
-				e
-					.column('title', c => c.type(Model.ColumnType.String))
-					.manyHasOne('author', r => r.target('Author').onDelete(Model.OnDelete.cascade)),
-			)
-			.buildSchema(),
-	},
-	updated: {
-		model: new SchemaBuilder()
-			.entity('Post', e => e.column('title', c => c.type(Model.ColumnType.String)))
-			.buildSchema(),
-	},
-	diff: [
-		{
-			modification: 'removeEntity',
-			entityName: 'Author',
+describe('remove an entity', () =>
+	testMigrations({
+		original: {
+			model: new SchemaBuilder()
+				.entity('Author', e => e.column('name', c => c.type(Model.ColumnType.String)))
+				.entity('Post', e =>
+					e
+						.column('title', c => c.type(Model.ColumnType.String))
+						.manyHasOne('author', r => r.target('Author').onDelete(Model.OnDelete.cascade)))
+				.buildSchema(),
 		},
-	],
-	sql: SQL`ALTER TABLE "post" DROP "author_id"; DROP TABLE "author";`,
-}))
-
-describe('remove entity with acl', () => testMigrations({
-	original: {
-		model: new SchemaBuilder()
-			.entity('Site', entity => entity.column('name', c => c.type(Model.ColumnType.String)))
-			.entity('Post', entity => entity.column('title').manyHasOne('site', r => r.target('Site')))
-			.buildSchema(),
-		acl: {
-			roles: {
-				admin: {
-					variables: {
-						siteId: {
-							type: Acl.VariableType.entity,
-							entityName: 'Site',
-						},
-					},
-					stages: '*',
-					entities: {
-						Site: {
-							predicates: {},
-							operations: {
-								read: {
-									id: true,
-								},
+		updated: {
+			model: new SchemaBuilder()
+				.entity('Post', e => e.column('title', c => c.type(Model.ColumnType.String)))
+				.buildSchema(),
+		},
+		diff: [
+			{
+				modification: 'removeEntity',
+				entityName: 'Author',
+			},
+		],
+		sql: SQL`ALTER TABLE "post" DROP "author_id"; DROP TABLE "author";`,
+	}))
+
+describe('remove entity with acl', () =>
+	testMigrations({
+		original: {
+			model: new SchemaBuilder()
+				.entity('Site', entity => entity.column('name', c => c.type(Model.ColumnType.String)))
+				.entity('Post', entity => entity.column('title').manyHasOne('site', r => r.target('Site')))
+				.buildSchema(),
+			acl: {
+				roles: {
+					admin: {
+						variables: {
+							siteId: {
+								type: Acl.VariableType.entity,
+								entityName: 'Site',
 							},
 						},
-						Post: {
-							predicates: {
-								site: { site: { id: 'siteId' } },
+						stages: '*',
+						entities: {
+							Site: {
+								predicates: {},
+								operations: {
+									read: {
+										id: true,
+									},
+								},
 							},
-							operations: {
-								read: {
-									title: 'site',
+							Post: {
+								predicates: {
+									site: { site: { id: 'siteId' } },
+								},
+								operations: {
+									read: {
+										title: 'site',
+									},
 								},
 							},
 						},
@@ -69,22 +71,22 @@ describe('remove entity with acl', () => testMigrations({
 				},
 			},
 		},
-	},
-	updated: {
-		model: new SchemaBuilder().entity('Post', entity => entity.column('title')).buildSchema(),
-		acl: {
-			roles: {
-				admin: {
-					variables: {},
-					stages: '*',
-					entities: {
-						Post: {
-							predicates: {
-								site: {},
-							},
-							operations: {
-								read: {
-									title: 'site',
+		updated: {
+			model: new SchemaBuilder().entity('Post', entity => entity.column('title')).buildSchema(),
+			acl: {
+				roles: {
+					admin: {
+						variables: {},
+						stages: '*',
+						entities: {
+							Post: {
+								predicates: {
+									site: {},
+								},
+								operations: {
+									read: {
+										title: 'site',
+									},
 								},
 							},
 						},
@@ -92,15 +94,14 @@ describe('remove entity with acl', () => testMigrations({
 				},
 			},
 		},
-	},
-	diff: [
-		{
-			modification: 'removeEntity',
-			entityName: 'Site',
-		},
-	],
-	sql: SQL`ALTER TABLE "post" DROP "site_id"; DROP TABLE "site";`,
-}))
+		diff: [
+			{
+				modification: 'removeEntity',
+				entityName: 'Site',
+			},
+		],
+		sql: SQL`ALTER TABLE "post" DROP "site_id"; DROP TABLE "site";`,
+	}))
 
 namespace ViewEntityOriginalSchema {
 	@def.View("SELECT null as id, 'John' AS name")
@@ -108,22 +109,21 @@ namespace ViewEntityOriginalSchema {
 		name = def.stringColumn()
 	}
 }
-describe('remove a view', () => testMigrations({
-	original: createSchema(ViewEntityOriginalSchema),
-	updated: {},
-	diff: [
-		{
-			modification: 'removeEntity',
-			entityName: 'Author',
-		},
-	],
-	sql: SQL`
+describe('remove a view', () =>
+	testMigrations({
+		original: createSchema(ViewEntityOriginalSchema),
+		updated: {},
+		diff: [
+			{
+				modification: 'removeEntity',
+				entityName: 'Author',
+			},
+		],
+		sql: SQL`
 	DROP VIEW "author";`,
-}))
-
+	}))
 
 namespace EntityWithManyHasManyOriginalSchema {
-
 	export class Book {
 		title = def.stringColumn()
 		tags = def.manyHasMany(Tag, 'books')
@@ -134,70 +134,65 @@ namespace EntityWithManyHasManyOriginalSchema {
 		books = def.manyHasManyInverse(Book, 'tags')
 	}
 }
-describe('remove junction table, when both entities are removed', () => testMigrations({
-	original: createSchema(EntityWithManyHasManyOriginalSchema),
-	updated: {},
-	diff: [
-		{
-			modification: 'removeEntity',
-			entityName: 'Book',
-		},
-		{
-			modification: 'removeEntity',
-			entityName: 'Tag',
-		},
-	],
-	sql: SQL`DROP TABLE "book_tags";
+describe('remove junction table, when both entities are removed', () =>
+	testMigrations({
+		original: createSchema(EntityWithManyHasManyOriginalSchema),
+		updated: {},
+		diff: [
+			{
+				modification: 'removeEntity',
+				entityName: 'Book',
+			},
+			{
+				modification: 'removeEntity',
+				entityName: 'Tag',
+			},
+		],
+		sql: SQL`DROP TABLE "book_tags";
 DROP TABLE "book"; 
 DROP TABLE "tag";`,
-}))
-
+	}))
 
 namespace EntityWithManyHasManyUpdatedSchema {
-
 	export class Tag {
 		name = def.stringColumn()
 	}
 }
-describe('remove junction table, when owning entity is removed', () => testMigrations({
-	original: createSchema(EntityWithManyHasManyOriginalSchema),
-	updated: createSchema(EntityWithManyHasManyUpdatedSchema),
-	diff: [
-		{
-			modification: 'removeEntity',
-			entityName: 'Book',
-		},
-
-	],
-	sql: SQL`DROP TABLE "book_tags";
+describe('remove junction table, when owning entity is removed', () =>
+	testMigrations({
+		original: createSchema(EntityWithManyHasManyOriginalSchema),
+		updated: createSchema(EntityWithManyHasManyUpdatedSchema),
+		diff: [
+			{
+				modification: 'removeEntity',
+				entityName: 'Book',
+			},
+		],
+		sql: SQL`DROP TABLE "book_tags";
 DROP TABLE "book";`,
-}))
-
+	}))
 
 namespace EntityWithManyHasMany2UpdatedSchema {
-
 	export class Book {
 		title = def.stringColumn()
 	}
 }
-describe('remove junction table, when inverse entity is removed', () => testMigrations({
-	original: createSchema(EntityWithManyHasManyOriginalSchema),
-	updated: createSchema(EntityWithManyHasMany2UpdatedSchema),
-	diff: [
-		{
-			modification: 'removeEntity',
-			entityName: 'Tag',
-		},
-
-	],
-	sql: SQL`
+describe('remove junction table, when inverse entity is removed', () =>
+	testMigrations({
+		original: createSchema(EntityWithManyHasManyOriginalSchema),
+		updated: createSchema(EntityWithManyHasMany2UpdatedSchema),
+		diff: [
+			{
+				modification: 'removeEntity',
+				entityName: 'Tag',
+			},
+		],
+		sql: SQL`
 DROP TABLE "book_tags";
 DROP TABLE "tag";`,
-}))
-
+	}))
 
 namespace EntityWithSelfReferencingRelationOriginalSchema {
-
 	export class Person {
 		name = def.stringColumn()
 		parent = def.manyHasOne(Person, 'children')
@@ -205,14 +200,15 @@ namespace EntityWithSelfReferencingRelationOriginalSchema {
 	}
 }
 
-describe('remove self-referencing relation', () => testMigrations({
-	original: createSchema(EntityWithSelfReferencingRelationOriginalSchema),
-	updated: {},
-	diff: [
-		{
-			modification: 'removeEntity',
-			entityName: 'Person',
-		},
-	],
-	sql: SQL`ALTER TABLE "person" DROP "parent_id"; DROP TABLE "person";`,
-}))
+describe('remove self-referencing relation', () =>
+	testMigrations({
+		original: createSchema(EntityWithSelfReferencingRelationOriginalSchema),
+		updated: {},
+		diff: [
+			{
+				modification: 'removeEntity',
+				entityName: 'Person',
+			},
+		],
+		sql: SQL`ALTER TABLE "person" DROP "parent_id"; DROP TABLE "person";`,
+	}))