@odata2ts/odata2ts 0.23.1 → 0.25.0

package/lib/data-model/DataModelDigestion.js

@@ -1,275 +1,300 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Digester = void 0;
-const tslib_1 = require("tslib");
-const DataModel_1 = require("./DataModel");
-const ServiceConfigHelper_1 = require("./ServiceConfigHelper");
-class Digester {
-    constructor(version, schema, options, namingHelper, converters) {
-        this.version = version;
-        this.schema = schema;
-        this.options = options;
-        this.namingHelper = namingHelper;
-        this.model2Type = new Map();
-        this.mapProp = (p) => {
-            if (!p.$.Type) {
-                throw new Error(`No type information given for property [${p.$.Name}]!`);
-            }
-            const isCollection = !!p.$.Type.match(/^Collection\(/);
-            const dataType = p.$.Type.replace(/^Collection\(([^\)]+)\)/, "$1");
-            const configProp = this.serviceConfigHelper.findConfigPropByName(p.$.Name);
-            const name = this.namingHelper.getModelPropName((configProp === null || configProp === void 0 ? void 0 : configProp.mappedName) || p.$.Name);
-            let result;
-            // domain object known from service:
-            // EntityType, ComplexType or EnumType
-            if (dataType.startsWith(this.namingHelper.getServicePrefix())) {
-                const resultDt = this.model2Type.get(dataType);
-                if (!resultDt) {
-                    throw new Error(`Couldn't determine model type for data type with name '${dataType}'`);
-                }
-                // special handling for enums
-                if (resultDt === "EnumType" /* DataTypes.EnumType */) {
-                    result = {
-                        dataType: resultDt,
-                        type: this.namingHelper.getEnumName(dataType),
-                        qPath: "QEnumPath",
-                        qObject: isCollection ? "QEnumCollection" : undefined,
-                        qParam: "QEnumParam",
-                    };
-                }
-                // handling of complex & entity types
-                else {
-                    result = {
-                        dataType: resultDt,
-                        type: this.namingHelper.getModelName(dataType),
-                        qPath: "QEntityPath",
-                        qObject: this.namingHelper.getQName(dataType),
-                        qParam: "QComplexParam",
-                    };
-                }
-            }
-            // OData built-in data types
-            else if (dataType.startsWith(Digester.EDM_PREFIX)) {
-                const { outputType, qPath, qParam, qCollection } = this.mapODataType(dataType);
-                const { to, toModule: typeModule, converters } = this.dataModel.getConverter(dataType) || {};
-                const type = !to ? outputType : to.startsWith(Digester.EDM_PREFIX) ? this.mapODataType(to).outputType : to;
-                result = {
-                    dataType: "PrimitiveType" /* DataTypes.PrimitiveType */,
-                    type,
-                    typeModule,
-                    qPath,
-                    qParam,
-                    qObject: isCollection ? qCollection : undefined,
-                    converters,
-                };
-            }
-            else {
-                throw new Error(`Unknown type [${dataType}]: Not 'Collection(...)', not '${this.namingHelper.getServicePrefix()}*', not OData type 'Edm.*'`);
-            }
-            return Object.assign({ odataName: p.$.Name, name, odataType: p.$.Type, required: p.$.Nullable === "false", isCollection: isCollection, managed: configProp === null || configProp === void 0 ? void 0 : configProp.managed }, result);
-        };
-        this.dataModel = new DataModel_1.DataModel(version, converters);
-        this.serviceConfigHelper = new ServiceConfigHelper_1.ServiceConfigHelper(options);
-        this.collectModelTypes(this.schema);
-    }
-    digest() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            this.digestSchema(this.schema);
-            return this.dataModel;
-        });
-    }
-    collectModelTypes(schema) {
-        var _a, _b, _c;
-        const servicePrefix = this.namingHelper.getServicePrefix();
-        (_a = schema.EnumType) === null || _a === void 0 ? void 0 : _a.forEach((et) => {
-            this.model2Type.set(servicePrefix + et.$.Name, "EnumType" /* DataTypes.EnumType */);
-        });
-        (_b = schema.ComplexType) === null || _b === void 0 ? void 0 : _b.forEach((ct) => {
-            this.model2Type.set(servicePrefix + ct.$.Name, "ComplexType" /* DataTypes.ComplexType */);
-        });
-        (_c = schema.EntityType) === null || _c === void 0 ? void 0 : _c.forEach((et) => {
-            this.model2Type.set(servicePrefix + et.$.Name, "ModelType" /* DataTypes.ModelType */);
-        });
-    }
-    digestSchema(schema) {
-        // enums
-        if (schema.EnumType) {
-            for (const et of schema.EnumType) {
-                const name = et.$.Name;
-                this.dataModel.addEnum(name, {
-                    odataName: name,
-                    name: this.namingHelper.getEnumName(name),
-                    members: et.Member.map((m) => m.$.Name),
-                });
-            }
-        }
-        // entity types
-        this.addEntityType(schema.EntityType);
-        // complex types
-        this.addComplexType(schema.ComplexType);
-        this.postProcessModel();
-        // delegate to concrete entity container digestion
-        this.digestEntityContainer();
-    }
-    getBaseModel(model) {
-        var _a;
-        const entityConfig = this.serviceConfigHelper.findConfigEntityByName(model.$.Name);
-        const entityName = (entityConfig === null || entityConfig === void 0 ? void 0 : entityConfig.mappedName) || model.$.Name;
-        const name = this.namingHelper.getModelName(entityName);
-        const qName = this.namingHelper.getQName(entityName);
-        const editableName = this.namingHelper.getEditableModelName(entityName);
-        const odataName = model.$.Name;
-        const bType = model.$.BaseType;
-        const props = [...((_a = model.Property) !== null && _a !== void 0 ? _a : []), ...this.getNavigationProps(model)];
-        // support for base types, i.e. extends clause of interfaces
-        const baseClasses = [];
-        if (bType) {
-            baseClasses.push(this.namingHelper.getModelName(bType));
-        }
-        return {
-            name,
-            qName,
-            odataName,
-            editableName,
-            baseClasses,
-            props: props.map(this.mapProp),
-            baseProps: [], // postprocess required
-        };
-    }
-    addComplexType(models) {
-        if (!models || !models.length) {
-            return;
-        }
-        for (const model of models) {
-            const baseModel = this.getBaseModel(model);
-            this.dataModel.addComplexType(baseModel.name, baseModel);
-        }
-    }
-    addEntityType(models) {
-        var _a;
-        if (!models || !models.length) {
-            return;
-        }
-        for (const model of models) {
-            const baseModel = this.getBaseModel(model);
-            const entityConfig = this.serviceConfigHelper.findConfigEntityByName(model.$.Name);
-            const entityName = (entityConfig === null || entityConfig === void 0 ? void 0 : entityConfig.mappedName) || model.$.Name;
-            // key support: we add keys from this entity,
-            // but not keys stemming from base classes (postprocess required)
-            const keyNames = [];
-            if ((_a = entityConfig === null || entityConfig === void 0 ? void 0 : entityConfig.keys) === null || _a === void 0 ? void 0 : _a.length) {
-                keyNames.push(...entityConfig.keys);
-            }
-            else {
-                const entity = model;
-                if (entity.Key && entity.Key.length && entity.Key[0].PropertyRef.length) {
-                    const propNames = entity.Key[0].PropertyRef.map((key) => key.$.Name);
-                    keyNames.push(...propNames);
-                }
-            }
-            this.dataModel.addModel(baseModel.name, Object.assign(Object.assign({}, baseModel), { idModelName: this.namingHelper.getIdModelName(entityName), qIdFunctionName: this.namingHelper.getQIdFunctionName(entityName), generateId: true, keyNames: keyNames, keys: [], getKeyUnion: () => keyNames.join(" | ") }));
-        }
-    }
-    postProcessModel() {
-        // complex types
-        const complexTypes = this.dataModel.getComplexTypes();
-        complexTypes.forEach((model) => {
-            const [baseProps] = this.collectBaseClassPropsAndKeys(model, []);
-            model.baseProps = baseProps;
-        });
-        const modelTypes = this.dataModel.getModels();
-        // entity types
-        modelTypes.forEach((model) => {
-            const [baseProps, baseKeys, idName, qIdName] = this.collectBaseClassPropsAndKeys(model, []);
-            model.baseProps = baseProps;
-            if (!model.keyNames.length && idName) {
-                model.idModelName = idName;
-                model.qIdFunctionName = qIdName;
-                model.generateId = false;
-            }
-            model.keyNames.unshift(...baseKeys);
-            // sanity check: entity types require key specification
-            if (!model.keyNames.length) {
-                throw new Error(`Key property is missing from Entity "${model.name}" (${model.odataName})!`);
-            }
-            const isSingleKey = model.keyNames.length === 1;
-            const props = [...model.baseProps, ...model.props];
-            model.keys = model.keyNames.map((keyName) => {
-                const prop = props.find((p) => p.odataName === keyName);
-                if (!prop) {
-                    throw new Error(`Key with name [${keyName}] not found in props!`);
-                }
-                // automatically set key prop to managed, if this is the only key of the given entity
-                if (prop.managed === undefined) {
-                    prop.managed = !this.options.disableAutoManagedKey && isSingleKey;
-                }
-                return prop;
-            });
-        });
-        const sortedModelTypes = this.sortModelsByInheritance(modelTypes);
-        this.dataModel.setModels(sortedModelTypes);
-        const sortedComplexTypes = this.sortModelsByInheritance(complexTypes);
-        this.dataModel.setComplexTypes(sortedComplexTypes);
-    }
-    sortModelsByInheritance(models) {
-        // recursively visit all models and sort them by inheritance such that base classes
-        // are always before derived classes
-        const sortedModels = {};
-        const visitedModels = new Set();
-        const inProgressModels = new Set();
-        function visit(model) {
-            if (inProgressModels.has(model)) {
-                throw new Error("Cyclic dependencies detected!");
-            }
-            if (!visitedModels.has(model)) {
-                inProgressModels.add(model);
-                for (const baseClassName of model.baseClasses) {
-                    const baseClass = models.find((e) => e.name === baseClassName);
-                    if (baseClass) {
-                        visit(baseClass);
-                    }
-                }
-                visitedModels.add(model);
-                inProgressModels.delete(model);
-                sortedModels[model.name] = model;
-            }
-        }
-        for (const model of models) {
-            visit(model);
-        }
-        return sortedModels;
-    }
-    collectBaseClassPropsAndKeys(model, visitedModels) {
-        if (visitedModels.includes(model.name)) {
-            throw new Error(`Cyclic inheritance detected for model ${model.name}!`);
-        }
-        visitedModels.push(model.name);
-        return model.baseClasses.reduce(([props, keys, idName, qIdName], bc) => {
-            var _a;
-            const baseModel = this.dataModel.getModel(bc) || this.dataModel.getComplexType(bc);
-            let idNameResult = idName;
-            let qIdNameResult = qIdName;
-            // recursive
-            if (baseModel.baseClasses.length) {
-                const [parentProps, parentKeys, parentIdName, parentQIdName] = this.collectBaseClassPropsAndKeys(baseModel, visitedModels);
-                props.unshift(...parentProps);
-                keys.unshift(...parentKeys);
-                if (parentIdName) {
-                    idNameResult = parentIdName;
-                    qIdNameResult = parentQIdName;
-                }
-            }
-            props.push(...baseModel.props);
-            if ((_a = baseModel.keyNames) === null || _a === void 0 ? void 0 : _a.length) {
-                keys.push(...baseModel.keyNames.filter((kn) => !keys.includes(kn)));
-                idNameResult = baseModel.idModelName;
-                qIdNameResult = baseModel.qIdFunctionName;
-            }
-            return [props, keys, idNameResult, qIdNameResult];
-        }, [[], [], "", ""]);
-    }
-}
-exports.Digester = Digester;
-Digester.EDM_PREFIX = "Edm.";
-Digester.ROOT_OPERATION = "/";
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Digester = void 0;
+const tslib_1 = require("tslib");
+const DataModel_1 = require("./DataModel");
+const ServiceConfigHelper_1 = require("./ServiceConfigHelper");
+class Digester {
+    constructor(version, schemas, options, namingHelper, converters) {
+        this.version = version;
+        this.schemas = schemas;
+        this.options = options;
+        this.namingHelper = namingHelper;
+        this.model2Type = new Map();
+        this.mapProp = (p) => {
+            if (!p.$.Type) {
+                throw new Error(`No type information given for property [${p.$.Name}]!`);
+            }
+            const configProp = this.serviceConfigHelper.findConfigPropByName(p.$.Name);
+            const name = this.namingHelper.getModelPropName((configProp === null || configProp === void 0 ? void 0 : configProp.mappedName) || p.$.Name);
+            const isCollection = !!p.$.Type.match(/^Collection\(/);
+            let dataType = p.$.Type.replace(/^Collection\(([^\)]+)\)/, "$1");
+            if (this.namingHelper.includesServicePrefix(dataType)) {
+                const dtName = this.namingHelper.stripServicePrefix(dataType);
+                if (this.dataModel.getPrimitiveType(dtName) !== undefined) {
+                    dataType = this.dataModel.getPrimitiveType(dtName);
+                }
+            }
+            let result;
+            // domain object known from service:
+            // EntityType, ComplexType, EnumType or TypeDefinition
+            if (this.namingHelper.includesServicePrefix(dataType)) {
+                const resultDt = this.model2Type.get(dataType);
+                if (!resultDt) {
+                    throw new Error(`Couldn't determine model type for data type with name '${dataType}'`);
+                }
+                // special handling for enums
+                if (resultDt === "EnumType" /* DataTypes.EnumType */) {
+                    result = {
+                        dataType: resultDt,
+                        type: this.namingHelper.getEnumName(dataType),
+                        qPath: "QEnumPath",
+                        qObject: isCollection ? "QEnumCollection" : undefined,
+                        qParam: "QEnumParam",
+                    };
+                }
+                // handling of complex & entity types
+                else {
+                    result = {
+                        dataType: resultDt,
+                        type: this.namingHelper.getModelName(dataType),
+                        qPath: "QEntityPath",
+                        qObject: this.namingHelper.getQName(dataType),
+                        qParam: "QComplexParam",
+                    };
+                }
+            }
+            // OData built-in data types
+            else if (dataType.startsWith(Digester.EDM_PREFIX)) {
+                const { outputType, qPath, qParam, qCollection } = this.mapODataType(dataType);
+                const { to, toModule: typeModule, converters } = this.dataModel.getConverter(dataType) || {};
+                const type = !to ? outputType : to.startsWith(Digester.EDM_PREFIX) ? this.mapODataType(to).outputType : to;
+                result = {
+                    dataType: "PrimitiveType" /* DataTypes.PrimitiveType */,
+                    type,
+                    typeModule,
+                    qPath,
+                    qParam,
+                    qObject: isCollection ? qCollection : undefined,
+                    converters,
+                };
+            }
+            else {
+                throw new Error(`Unknown type [${dataType}]: Not 'Collection(...)', not OData type 'Edm.*', not starting with one of the namespaces!W`);
+            }
+            return Object.assign({ odataName: p.$.Name, name, odataType: p.$.Type, required: p.$.Nullable === "false", isCollection: isCollection, managed: configProp === null || configProp === void 0 ? void 0 : configProp.managed }, result);
+        };
+        this.dataModel = new DataModel_1.DataModel(version, converters);
+        this.serviceConfigHelper = new ServiceConfigHelper_1.ServiceConfigHelper(options);
+        this.collectModelTypes(schemas);
+    }
+    digest() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            this.digestEntityTypesAndOperations();
+            // delegate to version specific entity container digestion
+            this.schemas.forEach((schema) => this.digestEntityContainer(schema));
+            return this.dataModel;
+        });
+    }
+    collectModelTypes(schemas) {
+        schemas.forEach((schema) => {
+            var _a, _b, _c;
+            const servicePrefix = schema.$.Namespace + ".";
+            (_a = schema.EnumType) === null || _a === void 0 ? void 0 : _a.forEach((et) => {
+                this.model2Type.set(servicePrefix + et.$.Name, "EnumType" /* DataTypes.EnumType */);
+            });
+            (_b = schema.ComplexType) === null || _b === void 0 ? void 0 : _b.forEach((ct) => {
+                this.model2Type.set(servicePrefix + ct.$.Name, "ComplexType" /* DataTypes.ComplexType */);
+            });
+            (_c = schema.EntityType) === null || _c === void 0 ? void 0 : _c.forEach((et) => {
+                this.model2Type.set(servicePrefix + et.$.Name, "ModelType" /* DataTypes.ModelType */);
+            });
+        });
+    }
+    digestEntityTypesAndOperations() {
+        this.schemas.forEach((schema) => {
+            // type definitions: alias for primitive types
+            this.addTypeDefinition(schema.TypeDefinition);
+            // enums
+            if (schema.EnumType) {
+                for (const et of schema.EnumType) {
+                    const name = et.$.Name;
+                    this.dataModel.addEnum(name, {
+                        odataName: name,
+                        name: this.namingHelper.getEnumName(name),
+                        members: et.Member.map((m) => m.$.Name),
+                    });
+                }
+            }
+            // entity types
+            this.addEntityType(schema.EntityType);
+            // complex types
+            this.addComplexType(schema.ComplexType);
+            // V4 only: function & action types
+            this.digestOperations(schema);
+        });
+        this.postProcessModel();
+    }
+    getBaseModel(model) {
+        var _a;
+        const entityConfig = this.serviceConfigHelper.findConfigEntityByName(model.$.Name);
+        const entityName = (entityConfig === null || entityConfig === void 0 ? void 0 : entityConfig.mappedName) || model.$.Name;
+        const name = this.namingHelper.getModelName(entityName);
+        const qName = this.namingHelper.getQName(entityName);
+        const editableName = this.namingHelper.getEditableModelName(entityName);
+        const odataName = model.$.Name;
+        const bType = model.$.BaseType;
+        const props = [...((_a = model.Property) !== null && _a !== void 0 ? _a : []), ...this.getNavigationProps(model)];
+        // support for base types, i.e. extends clause of interfaces
+        const baseClasses = [];
+        if (bType) {
+            baseClasses.push(this.namingHelper.getModelName(bType));
+        }
+        return {
+            name,
+            qName,
+            odataName,
+            editableName,
+            baseClasses,
+            props: props.map(this.mapProp),
+            baseProps: [], // postprocess required
+        };
+    }
+    addTypeDefinition(types) {
+        if (!types || !types.length) {
+            return;
+        }
+        for (const t of types) {
+            this.dataModel.addTypeDefinition(t.$.Name, t.$.UnderlyingType);
+        }
+    }
+    addComplexType(models) {
+        if (!models || !models.length) {
+            return;
+        }
+        for (const model of models) {
+            const baseModel = this.getBaseModel(model);
+            this.dataModel.addComplexType(baseModel.name, baseModel);
+        }
+    }
+    addEntityType(models) {
+        var _a;
+        if (!models || !models.length) {
+            return;
+        }
+        for (const model of models) {
+            const baseModel = this.getBaseModel(model);
+            const entityConfig = this.serviceConfigHelper.findConfigEntityByName(model.$.Name);
+            const entityName = (entityConfig === null || entityConfig === void 0 ? void 0 : entityConfig.mappedName) || model.$.Name;
+            // key support: we add keys from this entity,
+            // but not keys stemming from base classes (postprocess required)
+            const keyNames = [];
+            if ((_a = entityConfig === null || entityConfig === void 0 ? void 0 : entityConfig.keys) === null || _a === void 0 ? void 0 : _a.length) {
+                keyNames.push(...entityConfig.keys);
+            }
+            else {
+                const entity = model;
+                if (entity.Key && entity.Key.length && entity.Key[0].PropertyRef.length) {
+                    const propNames = entity.Key[0].PropertyRef.map((key) => key.$.Name);
+                    keyNames.push(...propNames);
+                }
+            }
+            this.dataModel.addModel(baseModel.name, Object.assign(Object.assign({}, baseModel), { idModelName: this.namingHelper.getIdModelName(entityName), qIdFunctionName: this.namingHelper.getQIdFunctionName(entityName), generateId: true, keyNames: keyNames, keys: [], getKeyUnion: () => keyNames.join(" | ") }));
+        }
+    }
+    postProcessModel() {
+        // complex types
+        const complexTypes = this.dataModel.getComplexTypes();
+        complexTypes.forEach((model) => {
+            const [baseProps] = this.collectBaseClassPropsAndKeys(model, []);
+            model.baseProps = baseProps;
+        });
+        const modelTypes = this.dataModel.getModels();
+        // entity types
+        modelTypes.forEach((model) => {
+            const [baseProps, baseKeys, idName, qIdName] = this.collectBaseClassPropsAndKeys(model, []);
+            model.baseProps = baseProps;
+            if (!model.keyNames.length && idName) {
+                model.idModelName = idName;
+                model.qIdFunctionName = qIdName;
+                model.generateId = false;
+            }
+            model.keyNames.unshift(...baseKeys);
+            // sanity check: entity types require key specification
+            if (!model.keyNames.length) {
+                throw new Error(`Key property is missing from Entity "${model.name}" (${model.odataName})!`);
+            }
+            const isSingleKey = model.keyNames.length === 1;
+            const props = [...model.baseProps, ...model.props];
+            model.keys = model.keyNames.map((keyName) => {
+                const prop = props.find((p) => p.odataName === keyName);
+                if (!prop) {
+                    throw new Error(`Key with name [${keyName}] not found in props!`);
+                }
+                // automatically set key prop to managed, if this is the only key of the given entity
+                if (prop.managed === undefined) {
+                    prop.managed = !this.options.disableAutoManagedKey && isSingleKey;
+                }
+                return prop;
+            });
+        });
+        const sortedModelTypes = this.sortModelsByInheritance(modelTypes);
+        this.dataModel.setModels(sortedModelTypes);
+        const sortedComplexTypes = this.sortModelsByInheritance(complexTypes);
+        this.dataModel.setComplexTypes(sortedComplexTypes);
+    }
+    sortModelsByInheritance(models) {
+        // recursively visit all models and sort them by inheritance such that base classes
+        // are always before derived classes
+        const sortedModels = {};
+        const visitedModels = new Set();
+        const inProgressModels = new Set();
+        function visit(model) {
+            if (inProgressModels.has(model)) {
+                throw new Error("Cyclic dependencies detected!");
+            }
+            if (!visitedModels.has(model)) {
+                inProgressModels.add(model);
+                for (const baseClassName of model.baseClasses) {
+                    const baseClass = models.find((e) => e.name === baseClassName);
+                    if (baseClass) {
+                        visit(baseClass);
+                    }
+                }
+                visitedModels.add(model);
+                inProgressModels.delete(model);
+                sortedModels[model.name] = model;
+            }
+        }
+        for (const model of models) {
+            visit(model);
+        }
+        return sortedModels;
+    }
+    collectBaseClassPropsAndKeys(model, visitedModels) {
+        if (visitedModels.includes(model.name)) {
+            throw new Error(`Cyclic inheritance detected for model ${model.name}!`);
+        }
+        visitedModels.push(model.name);
+        return model.baseClasses.reduce(([props, keys, idName, qIdName], bc) => {
+            var _a;
+            const baseModel = this.dataModel.getModel(bc) || this.dataModel.getComplexType(bc);
+            if (!baseModel) {
+                throw new Error(`BaseModel "${bc}" doesn't exist!`);
+            }
+            let idNameResult = idName;
+            let qIdNameResult = qIdName;
+            // recursive
+            if (baseModel.baseClasses.length) {
+                const [parentProps, parentKeys, parentIdName, parentQIdName] = this.collectBaseClassPropsAndKeys(baseModel, visitedModels);
+                props.unshift(...parentProps);
+                keys.unshift(...parentKeys);
+                if (parentIdName) {
+                    idNameResult = parentIdName;
+                    qIdNameResult = parentQIdName;
+                }
+            }
+            props.push(...baseModel.props);
+            if ((_a = baseModel.keyNames) === null || _a === void 0 ? void 0 : _a.length) {
+                keys.push(...baseModel.keyNames.filter((kn) => !keys.includes(kn)));
+                idNameResult = baseModel.idModelName;
+                qIdNameResult = baseModel.qIdFunctionName;
+            }
+            return [props, keys, idNameResult, qIdNameResult];
+        }, [[], [], "", ""]);
+    }
+}
+exports.Digester = Digester;
+Digester.EDM_PREFIX = "Edm.";
+Digester.ROOT_OPERATION = "/";
 //# sourceMappingURL=DataModelDigestion.js.map