cruddl 3.3.1 → 3.3.2

package/dist/spec/model/implementation/field.spec.js

@@ -1,648 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const chai_1 = require("chai");
-const model_1 = require("../../../src/model");
-const validation_utils_1 = require("./validation-utils");
-describe('Field', () => {
-    const model = new model_1.Model({
-        types: [
-            {
-                name: 'Address',
-                kind: model_1.TypeKind.VALUE_OBJECT,
-                fields: [
-                    {
-                        name: 'name',
-                        typeName: 'String',
-                    },
-                ],
-            },
-            {
-                name: 'Country',
-                kind: model_1.TypeKind.ROOT_ENTITY,
-                keyFieldName: 'isoCode',
-                fields: [
-                    {
-                        name: 'isoCode',
-                        typeName: 'String',
-                    },
-                ],
-            },
-            {
-                name: 'Shipment',
-                kind: model_1.TypeKind.ROOT_ENTITY,
-                fields: [
-                    {
-                        name: 'deliveries',
-                        typeName: 'Delivery',
-                        isList: true,
-                        isRelation: true,
-                    },
-                    {
-                        name: 'delivery',
-                        typeName: 'Delivery',
-                        isRelation: true,
-                    },
-                    {
-                        name: 'deliveryNonRelation',
-                        typeName: 'Delivery',
-                    },
-                    {
-                        name: 'deliveryWithInverseOf',
-                        typeName: 'Delivery',
-                        isRelation: true,
-                        inverseOfFieldName: 'shipment',
-                    },
-                    {
-                        name: 'handlingUnits',
-                        typeName: 'HandlingUnit',
-                        isRelation: true,
-                        isList: true,
-                    },
-                ],
-            },
-            {
-                name: 'Delivery',
-                kind: model_1.TypeKind.ROOT_ENTITY,
-                fields: [
-                    {
-                        name: 'shipment',
-                        typeName: 'Shipment',
-                        isRelation: true,
-                    },
-                    {
-                        name: 'countryIsoCode',
-                        typeName: 'String',
-                    },
-                    {
-                        name: 'lineItems',
-                        typeName: 'DeliveryLineItem',
-                        isList: true,
-                    },
-                ],
-            },
-            {
-                name: 'HandlingUnit',
-                kind: model_1.TypeKind.ROOT_ENTITY,
-                fields: [],
-            },
-            {
-                name: 'Item',
-                kind: model_1.TypeKind.CHILD_ENTITY,
-                fields: [],
-            },
-            {
-                name: 'DangerousGoodsInfo',
-                kind: model_1.TypeKind.ENTITY_EXTENSION,
-                fields: [],
-            },
-            {
-                name: 'DeliveryLineItem',
-                kind: model_1.TypeKind.CHILD_ENTITY,
-                fields: [
-                    {
-                        name: 'parent',
-                        isParentField: true,
-                        typeName: 'Delivery',
-                    },
-                ],
-            },
-        ],
-        permissionProfiles: [
-            {
-                profiles: {
-                    default: {
-                        permissions: [
-                            {
-                                roles: ['accounting'],
-                                access: 'readWrite',
-                            },
-                        ],
-                    },
-                    accounting: {
-                        permissions: [
-                            {
-                                roles: ['accounting'],
-                                access: 'readWrite',
-                            },
-                        ],
-                    },
-                },
-            },
-        ],
-    });
-    const shipmentType = model.getRootEntityTypeOrThrow('Shipment');
-    const deliveryType = model.getRootEntityTypeOrThrow('Delivery');
-    const handlingUnitType = model.getRootEntityTypeOrThrow('HandlingUnit');
-    const addressType = model.getValueObjectTypeOrThrow('Address');
-    const itemType = model.getChildEntityTypeOrThrow('Item');
-    const dangerousGoodsInfoType = model.getEntityExtensionTypeOrThrow('DangerousGoodsInfo');
-    describe('with type', () => {
-        it('accepts built-in type', () => {
-            const field = new model_1.Field({
-                name: 'deliveryNumber',
-                typeName: 'String',
-            }, deliveryType);
-            (0, validation_utils_1.expectToBeValid)(field);
-        });
-        it('accepts user-defined types', () => {
-            const field = new model_1.Field({
-                name: 'address',
-                typeName: 'Address',
-            }, deliveryType);
-            (0, validation_utils_1.expectToBeValid)(field);
-            (0, chai_1.expect)(field.type).to.equal(model.getType('Address'));
-            (0, chai_1.expect)(field.hasValidType).to.be.true;
-        });
-        it('reports undefined type', () => {
-            const field = new model_1.Field({
-                name: 'deliveryNumber',
-                typeName: 'UndefinedType',
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, 'UndefinedType');
-        });
-        it('falls back to pseudo type if typeName is not found', () => {
-            // this is important so that the model does not break if it is invalid
-            const field = new model_1.Field({
-                name: 'deliveryNumber',
-                typeName: 'Undefined',
-            }, deliveryType);
-            (0, chai_1.expect)(field.type).not.to.be.undefined;
-            (0, chai_1.expect)(field.type.name).to.equal('Undefined');
-            (0, chai_1.expect)(field.hasValidType).to.be.false;
-        });
-    });
-    describe('with name', () => {
-        it('rejects empty names', () => {
-            const field = new model_1.Field({
-                name: '',
-                typeName: 'String',
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `Field name is empty.`);
-        });
-        it('accepts one-character names', () => {
-            // describe('me', () => it('is not stupid') );
-            const field = new model_1.Field({
-                name: 'a',
-                typeName: 'String',
-            }, deliveryType);
-            (0, validation_utils_1.expectToBeValid)(field);
-        });
-        it('warns about names including an underscore', () => {
-            const field = new model_1.Field({
-                name: 'some_field_name',
-                typeName: 'String',
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleWarningToInclude)(field, `Field names should not include underscores.`);
-        });
-        it('rejects names starting with an underscore', () => {
-            const field = new model_1.Field({
-                name: '_internal',
-                typeName: 'String',
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `Field names cannot start with an underscore.`);
-        });
-        it('warns about names starting with an uppercase character', () => {
-            const field = new model_1.Field({
-                name: 'ThisIsNotAFieldName',
-                typeName: 'String',
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleWarningToInclude)(field, `Field names should start with a lowercase character.`);
-        });
-    });
-    describe('with root entity type', () => {
-        it('rejects fields with root entity type without @relation or @reference', () => {
-            const field = new model_1.Field({
-                name: 'country',
-                typeName: 'Country',
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, 'root entity');
-        });
-        it('rejects fields with both @relation and @reference', () => {
-            const field = new model_1.Field({
-                name: 'country',
-                typeName: 'Country',
-                isRelation: true,
-                isReference: true,
-                referenceKeyField: 'countryIsoCode',
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, '@reference and @relation cannot be combined');
-        });
-    });
-    describe('with relations', () => {
-        it('rejects @relation on non-root-entity-type as declaring type', () => {
-            const field = new model_1.Field({
-                name: 'handlingUnit',
-                typeName: 'HandlingUnit',
-                isRelation: true,
-            }, addressType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, 'Relations can only be defined on root entity types. Consider using @reference instead');
-        });
-        it('rejects @relation to non-root-entity type', () => {
-            const field = new model_1.Field({
-                name: 'address',
-                typeName: 'Address',
-                isRelation: true,
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, 'Type "Address" cannot be used with @relation because it is not a root entity type');
-        });
-        describe('without inverseOf', () => {
-            it('accepts', () => {
-                const field = deliveryType.getFieldOrThrow('shipment'); // need a field woven into the model here
-                (0, validation_utils_1.expectToBeValid)(field);
-            });
-            it('provides the other field as inverseField', () => {
-                const field = deliveryType.getFieldOrThrow('shipment'); // need a field woven into the model here
-                (0, chai_1.expect)(field.inverseField).to.equal(shipmentType.getFieldOrThrow('deliveryWithInverseOf'));
-            });
-            it('resolves inverseField to undefined if there is none', () => {
-                const field = shipmentType.getFieldOrThrow('handlingUnits');
-                (0, chai_1.expect)(field.inverseField).to.be.undefined;
-            });
-            it('rejects if there are multiple inverse fields', () => {
-                const m = new model_1.Model({
-                    types: [
-                        {
-                            name: 'Delivery',
-                            kind: model_1.TypeKind.ROOT_ENTITY,
-                            fields: [
-                                {
-                                    name: 'packager',
-                                    typeName: 'Person',
-                                    isRelation: true,
-                                    inverseOfFieldName: 'delivery',
-                                },
-                                {
-                                    name: 'shipper',
-                                    typeName: 'Person',
-                                    isRelation: true,
-                                    inverseOfFieldName: 'delivery',
-                                },
-                            ],
-                        },
-                        {
-                            name: 'Person',
-                            kind: model_1.TypeKind.ROOT_ENTITY,
-                            fields: [
-                                {
-                                    name: 'delivery',
-                                    typeName: 'Delivery',
-                                    isRelation: true,
-                                },
-                            ],
-                        },
-                    ],
-                });
-                const field = m.getRootEntityTypeOrThrow('Person').getFieldOrThrow('delivery');
-                const result = (0, validation_utils_1.validate)(field);
-                (0, chai_1.expect)(result.messages.length).to.equal(2);
-                for (const message of result.messages) {
-                    (0, chai_1.expect)(message.severity).to.equal(model_1.Severity.Error);
-                    (0, chai_1.expect)(message.message).to.equal('Multiple fields ("Delivery.packager", "Delivery.shipper") declare inverseOf to "Person.delivery".');
-                }
-            });
-            describe('warns if there is an unrelated inverse relation', () => {
-                const field = shipmentType.getFieldOrThrow('delivery');
-                const result = (0, validation_utils_1.validate)(field);
-                (0, chai_1.expect)(result.messages.length, result.toString()).to.equal(1);
-                (0, chai_1.expect)(result.messages[0].severity).to.equal(model_1.Severity.Warning);
-                (0, chai_1.expect)(result.messages[0].message).to.equal('This field and "Delivery.shipment" define separate relations. Consider using the "inverseOf" argument to add a backlink to an existing relation.');
-            });
-        });
-        describe('with inverseOf', () => {
-            describe('that is not a list', () => {
-                const field = new model_1.Field({
-                    name: 'shipment',
-                    typeName: 'Shipment',
-                    isRelation: true,
-                    inverseOfFieldName: 'delivery',
-                }, deliveryType);
-                it('accepts', () => {
-                    (0, validation_utils_1.expectToBeValid)(field);
-                });
-                it('provides the field in inverseOf', () => {
-                    (0, chai_1.expect)(field.inverseOf).to.equal(shipmentType.getField('delivery'));
-                });
-            });
-            describe('that is a list', () => {
-                const field = new model_1.Field({
-                    name: 'shipment',
-                    typeName: 'Shipment',
-                    isRelation: true,
-                    inverseOfFieldName: 'deliveries',
-                }, deliveryType);
-                it('accepts', () => {
-                    (0, validation_utils_1.expectToBeValid)(field);
-                });
-                it('provides the field in inverseOf', () => {
-                    (0, chai_1.expect)(field.inverseOf).to.equal(shipmentType.getField('deliveries'));
-                });
-            });
-            it('rejects inverseOf to undefined field', () => {
-                const field = new model_1.Field({
-                    name: 'shipment',
-                    typeName: 'Shipment',
-                    isRelation: true,
-                    inverseOfFieldName: 'undefinedField',
-                }, deliveryType);
-                (0, validation_utils_1.expectSingleErrorToInclude)(field, 'Field "undefinedField" does not exist on type "Shipment"');
-            });
-            it('rejects inverseOf to non-relation field', () => {
-                const field = new model_1.Field({
-                    name: 'shipment',
-                    typeName: 'Shipment',
-                    isRelation: true,
-                    inverseOfFieldName: 'deliveryNonRelation',
-                }, deliveryType);
-                (0, validation_utils_1.expectSingleErrorToInclude)(field, 'Field "Shipment.deliveryNonRelation" used as inverse field of "Delivery.shipment" does not have the @relation directive');
-            });
-            it('rejects inverseOf to field that has inverseOf set', () => {
-                const field = new model_1.Field({
-                    name: 'shipment',
-                    typeName: 'Shipment',
-                    isRelation: true,
-                    inverseOfFieldName: 'deliveryWithInverseOf',
-                }, deliveryType);
-                (0, validation_utils_1.expectSingleErrorToInclude)(field, 'Field "Shipment.deliveryWithInverseOf" used as inverse field of "Delivery.shipment" should not declare inverseOf itself');
-            });
-            it("rejects inverseOf to field with different type than the field's declaring type", () => {
-                const field = new model_1.Field({
-                    name: 'shipment',
-                    typeName: 'Shipment',
-                    isRelation: true,
-                    inverseOfFieldName: 'handlingUnits',
-                }, deliveryType);
-                (0, validation_utils_1.expectSingleErrorToInclude)(field, 'Field "Shipment.handlingUnits" used as inverse field of "Delivery.shipment" has named type "HandlingUnit" but should be of type "Delivery"');
-            });
-            it('does not set inverseField', () => {
-                const field = new model_1.Field({
-                    name: 'shipment',
-                    typeName: 'Shipment',
-                    isRelation: true,
-                    inverseOfFieldName: 'delivery',
-                }, deliveryType);
-                (0, chai_1.expect)(field.inverseField).to.be.undefined;
-            });
-        });
-    });
-    describe('with references', () => {
-        it('accepts @reference to root entity type', () => {
-            const field = new model_1.Field({
-                name: 'country',
-                typeName: 'Country',
-                isReference: true,
-                referenceKeyField: 'countryIsoCode',
-            }, deliveryType);
-            (0, validation_utils_1.expectToBeValid)(field);
-        });
-        it('rejects @reference to root entity type without @key field', () => {
-            const field = new model_1.Field({
-                name: 'handlingUnit',
-                typeName: 'HandlingUnit',
-                isReference: true,
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `"HandlingUnit" cannot be used as @reference type because it does not have a field annotated with @key`);
-        });
-        it('rejects @reference to value object type', () => {
-            const field = new model_1.Field({
-                name: 'address',
-                typeName: 'Address',
-                isReference: true,
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `"Address" cannot be used as @reference type because is not a root entity type.`);
-        });
-        it('rejects @reference on list field', () => {
-            const field = new model_1.Field({
-                name: 'countries',
-                typeName: 'Country',
-                isReference: true,
-                referenceKeyField: 'countryIsoCode',
-                isList: true,
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `@reference is not supported with list types. Consider wrapping the reference in a child entity or value object type.`);
-        });
-    });
-    describe('with entity extension type', () => {
-        it('accepts entity extensions embedded in root entities', () => {
-            const field = new model_1.Field({
-                name: 'items',
-                typeName: 'DangerousGoodsInfo',
-            }, deliveryType);
-            (0, validation_utils_1.expectToBeValid)(field);
-        });
-        it('accepts entity extensions embedded in child entities', () => {
-            const field = new model_1.Field({
-                name: 'items',
-                typeName: 'DangerousGoodsInfo',
-            }, itemType);
-            (0, validation_utils_1.expectToBeValid)(field);
-        });
-        it('accepts entity extensions embedded in entity extensions', () => {
-            const field = new model_1.Field({
-                name: 'items',
-                typeName: 'DangerousGoodsInfo',
-            }, dangerousGoodsInfoType);
-            (0, validation_utils_1.expectToBeValid)(field);
-        });
-        it('rejects entity extensions embedded in value objects', () => {
-            const field = new model_1.Field({
-                name: 'items',
-                typeName: 'DangerousGoodsInfo',
-            }, addressType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `Type "DangerousGoodsInfo" is an entity extension type and cannot be used within value object types. Change "Address" to an entity extension type or use a value object type for "items".`);
-        });
-        it('rejects entity extension types on list fields', () => {
-            const field = new model_1.Field({
-                name: 'items',
-                typeName: 'DangerousGoodsInfo',
-                isList: true,
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `Type "DangerousGoodsInfo" is an entity extension type and cannot be used in a list. Change the field type to "DangerousGoodsInfo" (without brackets), or use a child entity or value object type instead.`);
-        });
-    });
-    describe('with child entity type', () => {
-        it('accepts child entities embedded in root entities', () => {
-            const field = new model_1.Field({
-                name: 'items',
-                typeName: 'Item',
-                isList: true,
-            }, deliveryType);
-            (0, validation_utils_1.expectToBeValid)(field);
-        });
-        it('accepts child entities embedded in child entities', () => {
-            const field = new model_1.Field({
-                name: 'items',
-                typeName: 'Item',
-                isList: true,
-            }, itemType);
-            (0, validation_utils_1.expectToBeValid)(field);
-        });
-        it('accepts child entities embedded in entity extensions', () => {
-            const field = new model_1.Field({
-                name: 'items',
-                typeName: 'Item',
-                isList: true,
-            }, dangerousGoodsInfoType);
-            (0, validation_utils_1.expectToBeValid)(field);
-        });
-        it('rejects child entities embedded in value objects', () => {
-            const field = new model_1.Field({
-                name: 'items',
-                typeName: 'Item',
-                isList: true,
-            }, addressType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `Type "Item" is a child entity type and cannot be used within value object types. Change "Address" to an entity extension type or use a value object type for "items".`);
-        });
-        it('rejects child entity types on non-list fields', () => {
-            const field = new model_1.Field({
-                name: 'items',
-                typeName: 'Item',
-                isList: false,
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `Type "Item" is a child entity type and can only be used in a list. Change the field type to "[Item]", or use an entity extension or value object type instead.`);
-        });
-    });
-    describe('with default value', () => {
-        it('accepts on scalar types', () => {
-            const field = new model_1.Field({
-                name: 'amount',
-                typeName: 'Int',
-                defaultValue: 123,
-            }, itemType);
-            const res = (0, validation_utils_1.validate)(field);
-            (0, chai_1.expect)(res.messages.length, res.toString()).to.equal(1);
-            (0, chai_1.expect)(res.messages[0].severity, res.toString()).to.equal(model_1.Severity.Info); // warning about no type checking for default values
-        });
-        it('accepts on value object types', () => {
-            const field = new model_1.Field({
-                name: 'address',
-                typeName: 'Address',
-                defaultValue: 123,
-            }, deliveryType);
-            const res = (0, validation_utils_1.validate)(field);
-            (0, chai_1.expect)(res.messages.length, res.toString()).to.equal(1);
-            (0, chai_1.expect)(res.messages[0].severity, res.toString()).to.equal(model_1.Severity.Info); // warning about no type checking for default values
-        });
-    });
-    describe('with permissions', () => {
-        describe('with permission profile', () => {
-            const field = new model_1.Field({
-                name: 'totalAmount',
-                typeName: 'Int',
-                permissions: {
-                    permissionProfileName: 'accounting',
-                },
-            }, deliveryType);
-            it('accepts', () => {
-                (0, validation_utils_1.expectToBeValid)(field);
-            });
-            it('resolves permission profile', () => {
-                (0, chai_1.expect)(field.permissionProfile).to.equal(model.rootNamespace.getPermissionProfileOrThrow('accounting'));
-            });
-        });
-        it('accepts direct role specifier', () => {
-            const field = new model_1.Field({
-                name: 'totalAmount',
-                typeName: 'Int',
-                permissions: {
-                    roles: {
-                        read: ['accounting'],
-                        readWrite: ['admin'],
-                    },
-                },
-            }, deliveryType);
-            (0, validation_utils_1.expectToBeValid)(field);
-        });
-        it('rejects combining roles and permission profiles', () => {
-            const field = new model_1.Field({
-                name: 'totalAmount',
-                typeName: 'Int',
-                permissions: {
-                    permissionProfileName: 'accounting',
-                    roles: {
-                        read: ['accounting'],
-                        readWrite: ['admin'],
-                    },
-                },
-            }, deliveryType);
-            const result = (0, validation_utils_1.validate)(field);
-            (0, chai_1.expect)(result.messages.length).to.equal(2);
-            for (const message of result.messages) {
-                (0, chai_1.expect)(message.severity).to.equal(model_1.Severity.Error);
-                (0, chai_1.expect)(message.message).to.equal(`Permission profile and explicit role specifiers cannot be combined.`);
-            }
-        });
-        it('rejects missing permission profile', () => {
-            const field = new model_1.Field({
-                name: 'totalAmount',
-                typeName: 'Int',
-                permissions: {
-                    permissionProfileName: 'undefined',
-                },
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `Permission profile "undefined" not found`);
-        });
-    });
-    describe('with calc mutations', () => {
-        it('accepts ADD and MULTIPLY on Int', () => {
-            const field = new model_1.Field({
-                name: 'amount',
-                typeName: 'Int',
-                calcMutationOperators: [
-                    model_1.CalcMutationsOperator.ADD,
-                    model_1.CalcMutationsOperator.MULTIPLY,
-                ],
-            }, itemType);
-            (0, validation_utils_1.expectToBeValid)(field);
-        });
-        it('accepts APPEND on String', () => {
-            const field = new model_1.Field({
-                name: 'log',
-                typeName: 'String',
-                calcMutationOperators: [model_1.CalcMutationsOperator.APPEND],
-            }, deliveryType);
-            (0, validation_utils_1.expectToBeValid)(field);
-        });
-        it('rejects APPEND on Boolean', () => {
-            const field = new model_1.Field({
-                name: 'isConfirmed',
-                typeName: 'Boolean',
-                calcMutationOperators: [model_1.CalcMutationsOperator.APPEND],
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `Type "Boolean" does not support any calc mutation operators.`);
-        });
-        it('rejects APPEND on Int', () => {
-            const field = new model_1.Field({
-                name: 'amount',
-                typeName: 'Int',
-                calcMutationOperators: [model_1.CalcMutationsOperator.APPEND],
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `Calc mutation operator "APPEND" is not supported on type "Int" (supported operators: "MULTIPLY", "DIVIDE", "ADD", "SUBTRACT", "MODULO").`);
-        });
-        it('rejects MULTIPLY on String', () => {
-            const field = new model_1.Field({
-                name: 'deliveryNumber',
-                typeName: 'String',
-                calcMutationOperators: [model_1.CalcMutationsOperator.MULTIPLY],
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `Calc mutation operator "MULTIPLY" is not supported on type "String" (supported operators: "APPEND", "PREPEND").`);
-        });
-        it('rejects APPEND on lists', () => {
-            const field = new model_1.Field({
-                name: 'amount',
-                typeName: 'String',
-                isList: true,
-                calcMutationOperators: [model_1.CalcMutationsOperator.APPEND],
-            }, deliveryType);
-            (0, validation_utils_1.expectSingleErrorToInclude)(field, `Calc mutations are not supported on list fields.`);
-        });
-        it('warns about @calcMutations within a value object', () => {
-            const field = new model_1.Field({
-                name: 'amount',
-                typeName: 'Int',
-                calcMutationOperators: [model_1.CalcMutationsOperator.ADD],
-            }, addressType);
-            (0, validation_utils_1.expectSingleWarningToInclude)(field, `Calc mutations do not work within value objects because value objects cannot be updated. This will be an error in a future release.`);
-        });
-    });
-});
-//# sourceMappingURL=field.spec.js.map