@contember/schema-utils 1.3.0-alpha.7 → 1.3.0-beta.1

package/src/type-schema/model.ts

@@ -148,10 +148,22 @@ const viewSchemaCheck: Typesafe.Equals<Model.View, ReturnType<typeof viewSchemaI
 const viewSchema: Typesafe.Type<Model.View> = viewSchemaInner
 
 
-const indexesSchema = Typesafe.coalesce<Model.Indexes, Model.Indexes>(Typesafe.record(Typesafe.string, Typesafe.object({
-	fields: Typesafe.array(Typesafe.string),
-	name: Typesafe.string,
-})), { })
+const indexLike: Typesafe.Type<{readonly fields: readonly string[]; readonly name?: string | undefined}> = Typesafe.intersection(
+	Typesafe.object({
+		fields: Typesafe.array(Typesafe.string),
+	}),
+	Typesafe.partial({
+		name: Typesafe.string,
+	}),
+)
+
+const indexesSchema = Typesafe.coalesce<Model.Indexes, Model.Indexes>(
+	Typesafe.preprocess(
+		Typesafe.array(indexLike),
+		it => it?.constructor === Object ? Object.values(it) : it,
+	),
+	[],
+)
 
 const entitySchema = Typesafe.intersection(
 	Typesafe.object({
@@ -160,10 +172,10 @@ const entitySchema = Typesafe.intersection(
 		primaryColumn: Typesafe.string,
 		tableName: Typesafe.string,
 		fields: Typesafe.record(Typesafe.string, fieldSchema),
-		unique: Typesafe.record(Typesafe.string, Typesafe.object({
-			fields: Typesafe.array(Typesafe.string),
-			name: Typesafe.string,
-		})),
+		unique: Typesafe.preprocess(
+			Typesafe.array(indexLike),
+			it => it?.constructor === Object ? Object.values(it) : it,
+		),
 		indexes: indexesSchema,
 		eventLog: eventLogSchema,
 	}),

package/src/utils/deepCompare.ts

@@ -1,5 +1,7 @@
+type Path = (string | number)[]
+
 type CompareError = {
-	path: (string | number)[]
+	path: Path
 	message: string
 }
 
@@ -26,10 +28,41 @@ const getType = (val: any): ExtendedType => {
 	return 'object'
 }
 
-export function deepCompare(a: any, b: any, path: (string | number)[]): CompareError[] {
+type Comparator = (a: unknown, b: unknown) => CompareError[]
+
+export const compareArraysIgnoreOrder = (a: unknown, b: unknown, path: Path) => {
+	if (!Array.isArray(a) || !Array.isArray(b)) {
+		return [{ path, message: 'Invalid type, expected array' }]
+	}
+	if (a.length !== b.length) {
+		return [{ path, message: `Array length: ${a.length} != ${b.length}` }]
+	}
+	const haystack = [...b]
+	for (const needle of a) {
+		const index = haystack.findIndex(it => {
+			const errors = deepCompare(needle, it, path)
+			return errors.length === 0
+		})
+		if (index < 0) {
+			return [{ path, message: `Array item: ${JSON.stringify(needle)} not found in ${JSON.stringify(haystack)}` }]
+		}
+		haystack.splice(index, 1)
+	}
+	if (haystack.length > 0) {
+		return [{ path, message: `Array items: ${JSON.stringify(haystack)} not found in ${JSON.stringify(a)}` }]
+	}
+	return []
+}
+
+export function deepCompare(a: any, b: any, path: Path = [], getCustomComparator?: (path: Path) => Comparator | null): CompareError[] {
 	if (a === b) {
 		return []
 	}
+	const comparator = getCustomComparator?.(path)
+	if (comparator) {
+		return comparator(a, b)
+	}
+
 	const aType = getType(a)
 	const bType = getType(b)
 	if (aType !== bType) {
@@ -53,7 +86,7 @@ export function deepCompare(a: any, b: any, path: (string | number)[]): CompareE
 		}
 		const errors: CompareError[] = []
 		for (let i = 0; i < aLength; i++) {
-			errors.push(...deepCompare(a[i], b[i], [...path, i]))
+			errors.push(...deepCompare(a[i], b[i], [...path, i], getCustomComparator))
 		}
 		return errors
 	}
@@ -91,7 +124,7 @@ export function deepCompare(a: any, b: any, path: (string | number)[]): CompareE
 					message: `Missing property: ${key} not in right`,
 				})
 			} else {
-				errors.push(...deepCompare(a[key], b[key], [...path, key]))
+				errors.push(...deepCompare(a[key], b[key], [...path, key], getCustomComparator))
 			}
 		}
 		for (const key of bKeys) {

package/src/validation/ModelValidator.ts

@@ -54,15 +54,10 @@ export class ModelValidator {
 	}
 
 	private validateUniqueConstraints(uniqueConstraints: Model.Entity['unique'], fields: Set<string>, errors: ErrorBuilder): void {
-		for (const [constraintName, constraint] of Object.entries(uniqueConstraints)) {
-			const uniqueErrors = errors.for(constraintName)
-			if (constraint.name !== constraintName) {
-				uniqueErrors.add('MODEL_NAME_MISMATCH', `Constraint name ${constraint.name} does not match the name in a map "${constraintName}"`)
-				continue
-			}
+		for (const constraint of uniqueConstraints) {
 			for (const field of constraint.fields) {
 				if (!fields.has(field)) {
-					uniqueErrors.add('MODEL_UNDEFINED_FIELD', `Referenced field ${field} in a constraint does not exists`)
+					errors.add('MODEL_UNDEFINED_FIELD', `Referenced field ${field} in a constraint does not exists`)
 				}
 			}
 		}
@@ -266,25 +261,6 @@ export class ModelValidator {
 				visitManyHasOne: () => { },
 			})
 		}
-		for (const entity of entities) {
-			const entityErrorBuilder = errorBuilder.for(entity.name)
-			for (const index of Object.values(entity.indexes)) {
-				const description = `index name ${index.name} of entity ${entity.name}`
-				if (relationNames[index.name]) {
-					entityErrorBuilder.add('MODEL_NAME_COLLISION', `${description} collides with ${relationNames[index.name]}`)
-				} else {
-					relationNames[index.name] = description
-				}
-			}
-			for (const unique of Object.values(entity.unique)) {
-				const description = `unique index name ${unique.name} of entity ${entity.name}`
-				if (relationNames[unique.name]) {
-					entityErrorBuilder.add('MODEL_NAME_COLLISION', `${description} collides with ${relationNames[unique.name]}`)
-				} else {
-					relationNames[unique.name] = description
-				}
-			}
-		}
 	}
 }
 

package/src/validation/SchemaValidator.ts

@@ -7,6 +7,7 @@ import { ActionsValidator } from './ActionsValidator'
 
 export interface SchemaValidatorSkippedErrors {
 	code: ValidationErrorCode
+	skipUntil?: string
 	path?: string
 }
 

package/tests/cases/unit/__snapshots__/laxSchemaConverter.test.ts.snap

@@ -45,12 +45,12 @@ exports[`lax schema converter basic 1`] = `
             "type": "String",
           },
         },
-        "indexes": {},
+        "indexes": [],
         "name": "Article",
         "primary": "id",
         "primaryColumn": "id",
         "tableName": "article",
-        "unique": {},
+        "unique": [],
       },
     },
     "enums": {
@@ -117,12 +117,12 @@ exports[`lax schema converter many-has-many 1`] = `
             "type": "String",
           },
         },
-        "indexes": {},
+        "indexes": [],
         "name": "Article",
         "primary": "id",
         "primaryColumn": "id",
         "tableName": "article",
-        "unique": {},
+        "unique": [],
       },
       "Tag": {
         "eventLog": {
@@ -143,12 +143,12 @@ exports[`lax schema converter many-has-many 1`] = `
             "type": "Uuid",
           },
         },
-        "indexes": {},
+        "indexes": [],
         "name": "Tag",
         "primary": "id",
         "primaryColumn": "id",
         "tableName": "tag",
-        "unique": {},
+        "unique": [],
       },
     },
     "enums": {},
@@ -200,12 +200,12 @@ exports[`lax schema converter one-has-many 1`] = `
             "type": "String",
           },
         },
-        "indexes": {},
+        "indexes": [],
         "name": "Article",
         "primary": "id",
         "primaryColumn": "id",
         "tableName": "article",
-        "unique": {},
+        "unique": [],
       },
       "Category": {
         "eventLog": {
@@ -226,12 +226,12 @@ exports[`lax schema converter one-has-many 1`] = `
             "type": "Uuid",
           },
         },
-        "indexes": {},
+        "indexes": [],
         "name": "Category",
         "primary": "id",
         "primaryColumn": "id",
         "tableName": "category",
-        "unique": {},
+        "unique": [],
       },
     },
     "enums": {},
@@ -283,12 +283,12 @@ exports[`lax schema converter one-has-one 1`] = `
             "type": "String",
           },
         },
-        "indexes": {},
+        "indexes": [],
         "name": "Article",
         "primary": "id",
         "primaryColumn": "id",
         "tableName": "article",
-        "unique": {},
+        "unique": [],
       },
       "Content": {
         "eventLog": {
@@ -310,12 +310,12 @@ exports[`lax schema converter one-has-one 1`] = `
             "type": "Uuid",
           },
         },
-        "indexes": {},
+        "indexes": [],
         "name": "Content",
         "primary": "id",
         "primaryColumn": "id",
         "tableName": "content",
-        "unique": {},
+        "unique": [],
       },
     },
     "enums": {},

package/tests/cases/unit/deepCompare.test.ts

@@ -0,0 +1,44 @@
+import { assert, describe, test } from 'vitest'
+import { compareArraysIgnoreOrder } from '../../../src'
+
+describe('deep compare', () => {
+	test('compare array ignore order - success', () => {
+		const actual = compareArraysIgnoreOrder([
+			{ foo: 'bar' },
+			{ lorem: 'ipsum' },
+		], [
+			{ lorem: 'ipsum' },
+			{ foo: 'bar' },
+		], [])
+		assert.deepStrictEqual(actual, [])
+	})
+
+	test('compare array ignore order - missing in A', () => {
+		const actual = compareArraysIgnoreOrder([
+			{ lorem: 'ipsum' },
+			{ lorem: 'ipsum' },
+		], [
+			{ lorem: 'ipsum' },
+			{ foo: 'bar' },
+		], [])
+		assert.deepStrictEqual(actual, [{
+			path: [],
+			message: 'Array item: {"lorem":"ipsum"} not found in [{"foo":"bar"}]',
+		}])
+	})
+
+	test('compare array ignore order - missing in B', () => {
+		const actual = compareArraysIgnoreOrder([
+			{ foo: 'bar' },
+			{ lorem: 'ipsum' },
+		], [
+			{ lorem: 'ipsum' },
+			{ lorem: 'ipsum' },
+		], [])
+		assert.deepStrictEqual(actual, [{
+			path: [],
+			message: 'Array item: {"foo":"bar"} not found in [{"lorem":"ipsum"},{"lorem":"ipsum"}]',
+		}],
+		)
+	})
+})

package/tests/cases/unit/modelValidator.test.ts

@@ -4,73 +4,6 @@ import { ModelValidator } from '../../../src'
 
 
 
-test('index name collision', () => {
-	const model: Model.Schema = {
-		enums: {},
-		entities: {
-			Foo: {
-				fields: {
-					id: {
-						columnName: 'id',
-						name: 'id',
-						nullable: false,
-						type: Model.ColumnType.Uuid,
-						columnType: 'uuid',
-					},
-				},
-				name: 'Foo',
-				primary: 'id',
-				primaryColumn: 'id',
-				tableName: 'foo',
-				unique: {},
-				eventLog: {
-					enabled: true,
-				},
-				indexes: {
-					test: { fields: ['id'], name: 'test' },
-				},
-			},
-			Bar: {
-				fields: {
-					id: {
-						columnName: 'id',
-						name: 'id',
-						nullable: false,
-						type: Model.ColumnType.Uuid,
-						columnType: 'uuid',
-					},
-				},
-				name: 'Bar',
-				primary: 'id',
-				primaryColumn: 'id',
-				tableName: 'bar',
-				unique: {
-					test: { fields: ['id'], name: 'test' },
-				},
-				eventLog: {
-					enabled: true,
-				},
-				indexes: {
-					foo: { fields: ['id'], name: 'foo' },
-				},
-			},
-		},
-	}
-	const validator = new ModelValidator(model)
-	assert.deepStrictEqual(validator.validate(), [
-		{
-			code: 'MODEL_NAME_COLLISION',
-			message: 'index name foo of entity Bar collides with table name foo of entity Foo',
-			path: ['entities', 'Bar'],
-		},
-		{
-			code: 'MODEL_NAME_COLLISION',
-			message: 'unique index name test of entity Bar collides with index name test of entity Foo',
-			path: ['entities', 'Bar'],
-		},
-	])
-})
-
 
 test('"meta" collision', () => {
 	const model: Model.Schema = {
@@ -90,9 +23,9 @@ test('"meta" collision', () => {
 				primary: 'id',
 				primaryColumn: 'id',
 				tableName: 'foo',
-				unique: {},
+				unique: [],
 				eventLog: { enabled: true },
-				indexes: {},
+				indexes: [],
 			},
 			FooMeta: {
 				fields: {
@@ -108,9 +41,9 @@ test('"meta" collision', () => {
 				primary: 'id',
 				primaryColumn: 'id',
 				tableName: 'foo_meta',
-				unique: {},
+				unique: [],
 				eventLog: { enabled: true },
-				indexes: {},
+				indexes: [],
 			},
 			BarMeta: {
 				fields: {
@@ -126,9 +59,9 @@ test('"meta" collision', () => {
 				primary: 'id',
 				primaryColumn: 'id',
 				tableName: 'bar',
-				unique: {},
+				unique: [],
 				eventLog: { enabled: true },
-				indexes: {},
+				indexes: [],
 			},
 		},
 	}

package/dist/src/model/NamingHelper.d.ts

@@ -1,9 +0,0 @@
-export declare class NamingHelper {
-    static createForeignKeyIndexName(tableName: string, column: string): string;
-    static createJunctionTablePrimaryConstraintName(tableName: string): string;
-    static createForeignKeyName(fromTable: string, fromColumn: string, toTable: string, toColumn: string): string;
-    static createIndexName: (entityName: string, fields: readonly string[]) => string;
-    static createUniqueConstraintName: (entityName: string, fields: readonly string[]) => string;
-    private static createUniqueSuffix;
-}
-//# sourceMappingURL=NamingHelper.d.ts.map

package/dist/src/model/NamingHelper.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NamingHelper.d.ts","sourceRoot":"","sources":["../../../src/model/NamingHelper.ts"],"names":[],"mappings":"AAIA,qBAAa,YAAY;WACV,yBAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;WAK3D,wCAAwC,CAAC,SAAS,EAAE,MAAM;WAK1D,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IAOpH,OAAc,eAAe,eAAgB,MAAM,UAAU,SAAS,MAAM,EAAE,KAAG,MAAM,CAKtF;IAED,OAAc,0BAA0B,eAAgB,MAAM,UAAU,SAAS,MAAM,EAAE,KAAG,MAAM,CAKjG;IAED,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAGhC;CACD"}

package/dist/src/model/NamingHelper.js

@@ -1,44 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NamingHelper = void 0;
-const sha256_1 = __importDefault(require("crypto-js/sha256"));
-const enc_hex_1 = __importDefault(require("crypto-js/enc-hex"));
-class NamingHelper {
-    static createForeignKeyIndexName(tableName, column) {
-        // format matches https://github.com/salsita/node-pg-migrate/blob/9331f6fda98795e3f3733461f9b71345168b99d8/src/operations/indexes.ts#L21
-        return `${tableName}_${column}_index`;
-    }
-    static createJunctionTablePrimaryConstraintName(tableName) {
-        // format matches https://github.com/salsita/node-pg-migrate/blob/9331f6fda98795e3f3733461f9b71345168b99d8/src/operations/tables.ts#L204
-        return `${tableName}_pkey`;
-    }
-    static createForeignKeyName(fromTable, fromColumn, toTable, toColumn) {
-        return 'fk_'
-            + fromTable + '_'
-            + fromColumn + '_'
-            + this.createUniqueSuffix([fromTable, fromColumn, toTable, toColumn]);
-    }
-}
-exports.NamingHelper = NamingHelper;
-_a = NamingHelper;
-NamingHelper.createIndexName = (entityName, fields) => {
-    return 'idx_'
-        + entityName + '_'
-        + fields.join('_') + '_'
-        + _a.createUniqueSuffix([entityName, ...fields]);
-};
-NamingHelper.createUniqueConstraintName = (entityName, fields) => {
-    return 'unique_'
-        + entityName + '_'
-        + fields.join('_') + '_'
-        + _a.createUniqueSuffix([entityName, ...fields]);
-};
-NamingHelper.createUniqueSuffix = (values) => {
-    const uniqueSuffix = (0, sha256_1.default)(JSON.stringify(values)).toString(enc_hex_1.default);
-    return uniqueSuffix.slice(0, 6);
-};
-//# sourceMappingURL=NamingHelper.js.map

package/dist/src/model/NamingHelper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"NamingHelper.js","sourceRoot":"","sources":["../../../src/model/NamingHelper.ts"],"names":[],"mappings":";;;;;;;AAAA,8DAAqC;AACrC,gEAAsC;AAGtC,MAAa,YAAY;IACjB,MAAM,CAAC,yBAAyB,CAAC,SAAiB,EAAE,MAAc;QACxE,wIAAwI;QACxI,OAAO,GAAG,SAAS,IAAI,MAAM,QAAQ,CAAA;IACtC,CAAC;IAEM,MAAM,CAAC,wCAAwC,CAAC,SAAiB;QACvE,wIAAwI;QACxI,OAAO,GAAG,SAAS,OAAO,CAAA;IAC3B,CAAC;IAEM,MAAM,CAAC,oBAAoB,CAAC,SAAiB,EAAE,UAAkB,EAAE,OAAe,EAAE,QAAgB;QAC1G,OAAO,KAAK;cACT,SAAS,GAAG,GAAG;cACf,UAAU,GAAG,GAAG;cAChB,IAAI,CAAC,kBAAkB,CAAC,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAA;IACvE,CAAC;;AAhBF,oCAoCC;;AAlBc,4BAAe,GAAG,CAAC,UAAkB,EAAE,MAAyB,EAAU,EAAE;IACzF,OAAO,MAAM;UACV,UAAU,GAAG,GAAG;UAChB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG;UACtB,EAAI,CAAC,kBAAkB,CAAC,CAAC,UAAU,EAAE,GAAG,MAAM,CAAC,CAAC,CAAA;AACpD,CAAC,CAAA;AAEa,uCAA0B,GAAG,CAAC,UAAkB,EAAE,MAAyB,EAAU,EAAE;IACpG,OAAO,SAAS;UACb,UAAU,GAAG,GAAG;UAChB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG;UACtB,EAAI,CAAC,kBAAkB,CAAC,CAAC,UAAU,EAAE,GAAG,MAAM,CAAC,CAAC,CAAA;AACpD,CAAC,CAAA;AAEc,+BAAkB,GAAG,CAAC,MAAgB,EAAU,EAAE;IAChE,MAAM,YAAY,GAAG,IAAA,gBAAM,EAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,iBAAM,CAAC,CAAA;IACpE,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAChC,CAAC,CAAA"}

package/src/model/NamingHelper.ts

@@ -1,41 +0,0 @@
-import Sha256 from 'crypto-js/sha256'
-import EncHex from 'crypto-js/enc-hex'
-
-
-export class NamingHelper {
-	public static createForeignKeyIndexName(tableName: string, column: string) {
-		// format matches https://github.com/salsita/node-pg-migrate/blob/9331f6fda98795e3f3733461f9b71345168b99d8/src/operations/indexes.ts#L21
-		return `${tableName}_${column}_index`
-	}
-
-	public static createJunctionTablePrimaryConstraintName(tableName: string) {
-		// format matches https://github.com/salsita/node-pg-migrate/blob/9331f6fda98795e3f3733461f9b71345168b99d8/src/operations/tables.ts#L204
-		return `${tableName}_pkey`
-	}
-
-	public static createForeignKeyName(fromTable: string, fromColumn: string, toTable: string, toColumn: string): string {
-		return 'fk_'
-			+ fromTable + '_'
-			+ fromColumn + '_'
-			+ this.createUniqueSuffix([fromTable, fromColumn, toTable, toColumn])
-	}
-
-	public static createIndexName = (entityName: string, fields: readonly string[]): string => {
-		return 'idx_'
-			+ entityName + '_'
-			+ fields.join('_') + '_'
-			+ this.createUniqueSuffix([entityName, ...fields])
-	}
-
-	public static createUniqueConstraintName = (entityName: string, fields: readonly string[]): string => {
-		return 'unique_'
-			+ entityName + '_'
-			+ fields.join('_') + '_'
-			+ this.createUniqueSuffix([entityName, ...fields])
-	}
-
-	private static createUniqueSuffix = (values: string[]): string => {
-		const uniqueSuffix = Sha256(JSON.stringify(values)).toString(EncHex)
-		return uniqueSuffix.slice(0, 6)
-	}
-}