@odata2ts/odata2ts 0.23.0 → 0.24.0

package/lib/generator/ModelGenerator.js

@@ -1,184 +1,212 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateModels = void 0;
-const ImportContainer_1 = require("./ImportContainer");
-const generateModels = (dataModel, sourceFile, version, options, namingHelper) => {
-    const generator = new ModelGenerator(dataModel, sourceFile, version, options, namingHelper);
-    return generator.generate();
-};
-exports.generateModels = generateModels;
-const DEFERRED_CONTENT = "DeferredContent";
-class ModelGenerator {
-    constructor(dataModel, sourceFile, version, options, namingHelper) {
-        this.dataModel = dataModel;
-        this.sourceFile = sourceFile;
-        this.version = version;
-        this.options = options;
-        this.namingHelper = namingHelper;
-    }
-    generate() {
-        this.importContainer = new ImportContainer_1.ImportContainer(this.namingHelper.getFileNames());
-        this.generateEnums();
-        this.generateModels();
-        if (!this.options.skipOperations) {
-            this.generateUnboundOperationParams();
-        }
-    }
-    generateEnums() {
-        this.dataModel.getEnums().forEach((et) => {
-            this.sourceFile.addEnum({
-                name: et.name,
-                isExported: true,
-                members: et.members.map((mem) => ({ name: mem, initializer: `"${mem}"` })),
-            });
-        });
-    }
-    generateModels() {
-        this.dataModel.getModels().forEach((model) => {
-            this.generateModel(model);
-            if (!this.options.skipIdModels) {
-                this.generateIdModel(model);
-            }
-            if (!this.options.skipEditableModels) {
-                this.generateEditableModel(model);
-            }
-            if (!this.options.skipOperations) {
-                this.generateBoundOperationParams(model.name);
-            }
-        });
-        this.dataModel.getComplexTypes().forEach((model) => {
-            this.generateModel(model);
-            if (!this.options.skipEditableModels) {
-                this.generateEditableModel(model);
-            }
-        });
-        this.sourceFile.addImportDeclarations(this.importContainer.getImportDeclarations());
-    }
-    generateModel(model) {
-        this.sourceFile.addInterface({
-            name: model.name,
-            isExported: true,
-            properties: model.props.map((p) => {
-                const isEntity = p.dataType == "ModelType" /* DataTypes.ModelType */;
-                return {
-                    name: p.name,
-                    type: this.getPropType(p),
-                    // props for entities or entity collections are not added in V4 if not explicitly expanded
-                    hasQuestionToken: this.dataModel.isV4() && isEntity,
-                };
-            }),
-            extends: model.baseClasses,
-        });
-    }
-    getPropType(prop) {
-        const isEntity = prop.dataType == "ModelType" /* DataTypes.ModelType */;
-        // V2 entity special: deferred content
-        let suffix = "";
-        if (isEntity && this.dataModel.isV2()) {
-            this.importContainer.addFromCore(DEFERRED_CONTENT);
-            suffix = ` | ${DEFERRED_CONTENT}`;
-        }
-        // custom types which require type imports => possible via converters
-        else if (prop.typeModule) {
-            this.importContainer.addCustomType(prop.typeModule, prop.type);
-        }
-        // Collections
-        if (prop.isCollection) {
-            const type = `Array<${prop.type}>`;
-            if (this.dataModel.isV2() && this.options.v2ModelsWithExtraResultsWrapping) {
-                return `{ results: ${type} }` + suffix;
-            }
-            else {
-                return type + suffix;
-            }
-        }
-        // primitive, enum & complex types
-        return prop.type + (prop.required ? "" : " | null") + suffix;
-    }
-    generateIdModel(model) {
-        if (!model.generateId) {
-            return;
-        }
-        const singleType = model.keys.length === 1 ? `${model.keys[0].type} | ` : "";
-        const keyTypes = model.keys.map((keyProp) => `${keyProp.name}: ${this.getPropType(keyProp)}`).join(",");
-        const type = `${singleType}{${keyTypes}}`;
-        this.sourceFile.addTypeAlias({
-            name: model.idModelName,
-            isExported: true,
-            type,
-        });
-    }
-    generateEditableModel(model) {
-        const entityTypes = ["ModelType" /* DataTypes.ModelType */, "ComplexType" /* DataTypes.ComplexType */];
-        const allProps = [...model.baseProps, ...model.props].filter((p) => !p.managed);
-        const requiredProps = allProps
-            .filter((p) => p.required && !entityTypes.includes(p.dataType))
-            .map((p) => `"${p.name}"`)
-            .join(" | ");
-        const optionalProps = allProps
-            .filter((p) => !p.required && !entityTypes.includes(p.dataType))
-            .map((p) => `"${p.name}"`)
-            .join(" | ");
-        const complexProps = allProps.filter((p) => p.dataType === "ComplexType" /* DataTypes.ComplexType */);
-        const extendsClause = [
-            requiredProps ? `Pick<${model.name}, ${requiredProps}>` : null,
-            optionalProps ? `Partial<Pick<${model.name}, ${optionalProps}>>` : null,
-        ].filter((e) => !!e);
-        this.sourceFile.addInterface({
-            name: model.editableName,
-            isExported: true,
-            extends: extendsClause,
-            properties: !complexProps
-                ? undefined
-                : complexProps.map((p) => {
-                    return {
-                        name: p.name,
-                        type: this.getEditablePropType(p),
-                        // optional props don't need to be specified in editable model
-                        // also, entities would require deep insert func => we make it optional for now
-                        hasQuestionToken: !p.required || p.dataType === "ModelType" /* DataTypes.ModelType */,
-                    };
-                }),
-        });
-    }
-    getEditablePropType(prop) {
-        const type = prop.dataType === "ModelType" /* DataTypes.ModelType */
-            ? this.dataModel.getModel(prop.type).editableName
-            : prop.dataType === "ComplexType" /* DataTypes.ComplexType */
-                ? this.dataModel.getComplexType(prop.type).editableName
-                : prop.type;
-        // Collections
-        if (prop.isCollection) {
-            return `Array<${type}>`;
-        }
-        // primitive, enum & complex types
-        return type + (prop.required ? "" : " | null");
-    }
-    generateUnboundOperationParams() {
-        this.dataModel.getUnboundOperationTypes().forEach((operation) => {
-            this.generateOperationParams(operation);
-        });
-    }
-    generateBoundOperationParams(entityName) {
-        this.dataModel.getOperationTypeByEntityOrCollectionBinding(entityName).forEach((operation) => {
-            this.generateOperationParams(operation);
-        });
-    }
-    generateOperationParams(operation) {
-        if (!operation.parameters.length) {
-            return;
-        }
-        this.sourceFile.addInterface({
-            name: operation.paramsModelName,
-            isExported: true,
-            properties: operation.parameters.map((p) => {
-                return {
-                    name: p.name,
-                    type: this.getPropType(p),
-                    hasQuestionToken: !p.required,
-                };
-            }),
-        });
-    }
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateModels = void 0;
+const ts_morph_1 = require("ts-morph");
+const ImportContainer_1 = require("./ImportContainer");
+const generateModels = (dataModel, sourceFile, version, options, namingHelper) => {
+    const generator = new ModelGenerator(dataModel, sourceFile, version, options, namingHelper);
+    return generator.generate();
+};
+exports.generateModels = generateModels;
+const DEFERRED_CONTENT = "DeferredContent";
+class ModelGenerator {
+    constructor(dataModel, sourceFile, version, options, namingHelper) {
+        this.dataModel = dataModel;
+        this.sourceFile = sourceFile;
+        this.version = version;
+        this.options = options;
+        this.namingHelper = namingHelper;
+    }
+    generate() {
+        this.importContainer = new ImportContainer_1.ImportContainer(this.namingHelper.getFileNames());
+        this.generateEnums();
+        this.generateModels();
+        if (!this.options.skipOperations) {
+            this.generateUnboundOperationParams();
+        }
+    }
+    generateEnums() {
+        this.dataModel.getEnums().forEach((et) => {
+            this.sourceFile.addEnum({
+                name: et.name,
+                isExported: true,
+                members: et.members.map((mem) => ({ name: mem, initializer: `"${mem}"` })),
+            });
+        });
+    }
+    generateModels() {
+        this.dataModel.getModels().forEach((model) => {
+            this.generateModel(model);
+            if (!this.options.skipIdModels) {
+                this.generateIdModel(model);
+            }
+            if (!this.options.skipEditableModels) {
+                this.generateEditableModel(model);
+            }
+            if (!this.options.skipOperations) {
+                this.generateBoundOperationParams(model.name);
+            }
+        });
+        this.dataModel.getComplexTypes().forEach((model) => {
+            this.generateModel(model);
+            if (!this.options.skipEditableModels) {
+                this.generateEditableModel(model);
+            }
+        });
+        this.sourceFile.addImportDeclarations(this.importContainer.getImportDeclarations());
+    }
+    generateModel(model) {
+        this.sourceFile.addInterface({
+            name: model.name,
+            isExported: true,
+            properties: model.props.map((p) => {
+                const isEntity = p.dataType == "ModelType" /* DataTypes.ModelType */;
+                return {
+                    name: p.name,
+                    type: this.getPropType(p),
+                    // props for entities or entity collections are not added in V4 if not explicitly expanded
+                    hasQuestionToken: this.dataModel.isV4() && isEntity,
+                    docs: this.options.skipComments ? undefined : [this.generatePropDoc(p, model)],
+                };
+            }),
+            extends: model.baseClasses,
+        });
+    }
+    generatePropDoc(prop, model) {
+        var _a, _b;
+        const isKeyProp = (_a = model.keyNames) === null || _a === void 0 ? void 0 : _a.includes(prop.odataName);
+        const baseAttribs = [];
+        if (isKeyProp) {
+            baseAttribs.push("**Key Property**: This is a key property used to identify the entity.");
+        }
+        if (prop.managed) {
+            baseAttribs.push("**Managed**: This property is managed on the server side and cannot be edited.");
+        }
+        if ((_b = prop.converters) === null || _b === void 0 ? void 0 : _b.length) {
+            baseAttribs.push(`**Applied Converters**: ${prop.converters.map((c) => c.converterId).join(",")}.`);
+        }
+        const attributeTable = [
+            ["Name", prop.odataName],
+            ["Type", prop.odataType],
+        ];
+        if (prop.required) {
+            attributeTable.push(["Nullable", "false"]);
+        }
+        const description = (baseAttribs ? baseAttribs.join("<br/>") + "\n\n" : "") +
+            "OData Attributes:\n" +
+            "|Attribute Name | Attribute Value |\n| --- | ---|\n" +
+            attributeTable.map((row) => `| ${row[0]} | \`${row[1]}\` |`).join("\n");
+        return { kind: ts_morph_1.StructureKind.JSDoc, description };
+    }
+    getPropType(prop) {
+        const isEntity = prop.dataType == "ModelType" /* DataTypes.ModelType */;
+        // V2 entity special: deferred content
+        let suffix = "";
+        if (isEntity && this.dataModel.isV2()) {
+            this.importContainer.addFromCore(DEFERRED_CONTENT);
+            suffix = ` | ${DEFERRED_CONTENT}`;
+        }
+        // custom types which require type imports => possible via converters
+        else if (prop.typeModule) {
+            this.importContainer.addCustomType(prop.typeModule, prop.type);
+        }
+        // Collections
+        if (prop.isCollection) {
+            const type = `Array<${prop.type}>`;
+            if (this.dataModel.isV2() && this.options.v2ModelsWithExtraResultsWrapping) {
+                return `{ results: ${type} }` + suffix;
+            }
+            else {
+                return type + suffix;
+            }
+        }
+        // primitive, enum & complex types
+        return prop.type + (prop.required ? "" : " | null") + suffix;
+    }
+    generateIdModel(model) {
+        if (!model.generateId) {
+            return;
+        }
+        const singleType = model.keys.length === 1 ? `${model.keys[0].type} | ` : "";
+        const keyTypes = model.keys.map((keyProp) => `${keyProp.name}: ${this.getPropType(keyProp)}`).join(",");
+        const type = `${singleType}{${keyTypes}}`;
+        this.sourceFile.addTypeAlias({
+            name: model.idModelName,
+            isExported: true,
+            type,
+        });
+    }
+    generateEditableModel(model) {
+        const entityTypes = ["ModelType" /* DataTypes.ModelType */, "ComplexType" /* DataTypes.ComplexType */];
+        const allProps = [...model.baseProps, ...model.props].filter((p) => !p.managed);
+        const requiredProps = allProps
+            .filter((p) => p.required && !entityTypes.includes(p.dataType))
+            .map((p) => `"${p.name}"`)
+            .join(" | ");
+        const optionalProps = allProps
+            .filter((p) => !p.required && !entityTypes.includes(p.dataType))
+            .map((p) => `"${p.name}"`)
+            .join(" | ");
+        const complexProps = allProps.filter((p) => p.dataType === "ComplexType" /* DataTypes.ComplexType */);
+        const extendsClause = [
+            requiredProps ? `Pick<${model.name}, ${requiredProps}>` : null,
+            optionalProps ? `Partial<Pick<${model.name}, ${optionalProps}>>` : null,
+        ].filter((e) => !!e);
+        this.sourceFile.addInterface({
+            name: model.editableName,
+            isExported: true,
+            extends: extendsClause,
+            properties: !complexProps
+                ? undefined
+                : complexProps.map((p) => {
+                    return {
+                        name: p.name,
+                        type: this.getEditablePropType(p),
+                        // optional props don't need to be specified in editable model
+                        // also, entities would require deep insert func => we make it optional for now
+                        hasQuestionToken: !p.required || p.dataType === "ModelType" /* DataTypes.ModelType */,
+                    };
+                }),
+        });
+    }
+    getEditablePropType(prop) {
+        const type = prop.dataType === "ModelType" /* DataTypes.ModelType */
+            ? this.dataModel.getModel(prop.type).editableName
+            : prop.dataType === "ComplexType" /* DataTypes.ComplexType */
+                ? this.dataModel.getComplexType(prop.type).editableName
+                : prop.type;
+        // Collections
+        if (prop.isCollection) {
+            return `Array<${type}>`;
+        }
+        // primitive, enum & complex types
+        return type + (prop.required ? "" : " | null");
+    }
+    generateUnboundOperationParams() {
+        this.dataModel.getUnboundOperationTypes().forEach((operation) => {
+            this.generateOperationParams(operation);
+        });
+    }
+    generateBoundOperationParams(entityName) {
+        this.dataModel.getOperationTypeByEntityOrCollectionBinding(entityName).forEach((operation) => {
+            this.generateOperationParams(operation);
+        });
+    }
+    generateOperationParams(operation) {
+        if (!operation.parameters.length) {
+            return;
+        }
+        this.sourceFile.addInterface({
+            name: operation.paramsModelName,
+            isExported: true,
+            properties: operation.parameters.map((p) => {
+                return {
+                    name: p.name,
+                    type: this.getPropType(p),
+                    hasQuestionToken: !p.required,
+                };
+            }),
+        });
+    }
+}
 //# sourceMappingURL=ModelGenerator.js.map

package/lib/generator/ModelGenerator.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelGenerator.js","sourceRoot":"","sources":["../../src/generator/ModelGenerator.ts"],"names":[],"mappings":";;;AAOA,uDAAoD;AAE7C,MAAM,cAAc,GAAiC,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE;IACpH,MAAM,SAAS,GAAG,IAAI,cAAc,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;IAC5F,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;AAC9B,CAAC,CAAC;AAHW,QAAA,cAAc,kBAGzB;AAEF,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAE3C,MAAM,cAAc;IAGlB,YACU,SAAoB,EACpB,UAAsB,EACtB,OAAsB,EACtB,OAAiC,EACjC,YAA0B;QAJ1B,cAAS,GAAT,SAAS,CAAW;QACpB,eAAU,GAAV,UAAU,CAAY;QACtB,YAAO,GAAP,OAAO,CAAe;QACtB,YAAO,GAAP,OAAO,CAA0B;QACjC,iBAAY,GAAZ,YAAY,CAAc;IACjC,CAAC;IAEG,QAAQ;QACb,IAAI,CAAC,eAAe,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC,CAAC;QAE7E,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;YAChC,IAAI,CAAC,8BAA8B,EAAE,CAAC;SACvC;IACH,CAAC;IAEO,aAAa;QACnB,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;YACvC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;gBACtB,IAAI,EAAE,EAAE,CAAC,IAAI;gBACb,UAAU,EAAE,IAAI;gBAChB,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,GAAG,GAAG,EAAE,CAAC,CAAC;aAC3E,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,cAAc;QACpB,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3C,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC1B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;gBAC9B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;aAC7B;YACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE;gBACpC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;aACnC;YACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;gBAChC,IAAI,CAAC,4BAA4B,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;aAC/C;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACjD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC1B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE;gBACpC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;aACnC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC,IAAI,CAAC,eAAe,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACtF,CAAC;IAEO,aAAa,CAAC,KAAkB;QACtC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YAC3B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBAChC,MAAM,QAAQ,GAAG,CAAC,CAAC,QAAQ,yCAAuB,CAAC;gBACnD,OAAO;oBACL,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;oBACzB,0FAA0F;oBAC1F,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,QAAQ;iBACpD,CAAC;YACJ,CAAC,CAAC;YACF,OAAO,EAAE,KAAK,CAAC,WAAW;SAC3B,CAAC,CAAC;IACL,CAAC;IAEO,WAAW,CAAC,IAAmB;QACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,yCAAuB,CAAC;QAEtD,sCAAsC;QACtC,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE;YACrC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;YACnD,MAAM,GAAG,MAAM,gBAAgB,EAAE,CAAC;SACnC;QACD,qEAAqE;aAChE,IAAI,IAAI,CAAC,UAAU,EAAE;YACxB,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;SAChE;QAED,cAAc;QACd,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,MAAM,IAAI,GAAG,SAAS,IAAI,CAAC,IAAI,GAAG,CAAC;YACnC,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE;gBAC1E,OAAO,cAAc,IAAI,IAAI,GAAG,MAAM,CAAC;aACxC;iBAAM;gBACL,OAAO,IAAI,GAAG,MAAM,CAAC;aACtB;SACF;QAED,kCAAkC;QAClC,OAAO,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;IAC/D,CAAC;IAEO,eAAe,CAAC,KAAgB;QACtC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;YACrB,OAAO;SACR;QACD,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7E,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxG,MAAM,IAAI,GAAG,GAAG,UAAU,IAAI,QAAQ,GAAG,CAAC;QAE1C,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YAC3B,IAAI,EAAE,KAAK,CAAC,WAAW;YACvB,UAAU,EAAE,IAAI;YAChB,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAEO,qBAAqB,CAAC,KAAkB;QAC9C,MAAM,WAAW,GAAG,kFAA4C,CAAC;QACjE,MAAM,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,SAAS,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAEhF,MAAM,aAAa,GAAG,QAAQ;aAC3B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;aAC9D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC;aACzB,IAAI,CAAC,KAAK,CAAC,CAAC;QACf,MAAM,aAAa,GAAG,QAAQ;aAC3B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;aAC/D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC;aACzB,IAAI,CAAC,KAAK,CAAC,CAAC;QACf,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,8CAA0B,CAAC,CAAC;QAElF,MAAM,aAAa,GAAG;YACpB,aAAa,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC,IAAI,KAAK,aAAa,GAAG,CAAC,CAAC,CAAC,IAAI;YAC9D,aAAa,CAAC,CAAC,CAAC,gBAAgB,KAAK,CAAC,IAAI,KAAK,aAAa,IAAI,CAAC,CAAC,CAAC,IAAI;SACxE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAElC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YAC3B,IAAI,EAAE,KAAK,CAAC,YAAY;YACxB,UAAU,EAAE,IAAI;YAChB,OAAO,EAAE,aAAa;YACtB,UAAU,EAAE,CAAC,YAAY;gBACvB,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;oBACrB,OAAO;wBACL,IAAI,EAAE,CAAC,CAAC,IAAI;wBACZ,IAAI,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;wBACjC,8DAA8D;wBAC9D,+EAA+E;wBAC/E,gBAAgB,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,QAAQ,0CAAwB;qBACpE,CAAC;gBACJ,CAAC,CAAC;SACP,CAAC,CAAC;IACL,CAAC;IAEO,mBAAmB,CAAC,IAAmB;QAC7C,MAAM,IAAI,GACR,IAAI,CAAC,QAAQ,0CAAwB;YACnC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,YAAY;YACjD,CAAC,CAAC,IAAI,CAAC,QAAQ,8CAA0B;gBACzC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,YAAY;gBACvD,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAEhB,cAAc;QACd,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,SAAS,IAAI,GAAG,CAAC;SACzB;QAED,kCAAkC;QAClC,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACjD,CAAC;IAEO,8BAA8B;QACpC,IAAI,CAAC,SAAS,CAAC,wBAAwB,EAAE,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC9D,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,4BAA4B,CAAC,UAAkB;QACrD,IAAI,CAAC,SAAS,CAAC,2CAA2C,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC3F,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,uBAAuB,CAAC,SAAwB;QACtD,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE;YAChC,OAAO;SACR;QACD,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YAC3B,IAAI,EAAE,SAAS,CAAC,eAAe;YAC/B,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBACzC,OAAO;oBACL,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;oBACzB,gBAAgB,EAAE,CAAC,CAAC,CAAC,QAAQ;iBAC9B,CAAC;YACJ,CAAC,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { ODataVersions } from \"@odata2ts/odata-core\";\r\nimport { SourceFile } from \"ts-morph\";\r\n\r\nimport { DataModel } from \"../data-model/DataModel\";\r\nimport { ComplexType, DataTypes, ModelType, OperationType, PropertyModel } from \"../data-model/DataTypeModel\";\r\nimport { NamingHelper } from \"../data-model/NamingHelper\";\r\nimport { EntityBasedGeneratorFunction, GeneratorFunctionOptions } from \"../FactoryFunctionModel\";\r\nimport { ImportContainer } from \"./ImportContainer\";\r\n\r\nexport const generateModels: EntityBasedGeneratorFunction = (dataModel, sourceFile, version, options, namingHelper) => {\r\n  const generator = new ModelGenerator(dataModel, sourceFile, version, options, namingHelper);\r\n  return generator.generate();\r\n};\r\n\r\nconst DEFERRED_CONTENT = \"DeferredContent\";\r\n\r\nclass ModelGenerator {\r\n  private importContainer!: ImportContainer;\r\n\r\n  constructor(\r\n    private dataModel: DataModel,\r\n    private sourceFile: SourceFile,\r\n    private version: ODataVersions,\r\n    private options: GeneratorFunctionOptions,\r\n    private namingHelper: NamingHelper\r\n  ) {}\r\n\r\n  public generate(): void {\r\n    this.importContainer = new ImportContainer(this.namingHelper.getFileNames());\r\n\r\n    this.generateEnums();\r\n    this.generateModels();\r\n    if (!this.options.skipOperations) {\r\n      this.generateUnboundOperationParams();\r\n    }\r\n  }\r\n\r\n  private generateEnums() {\r\n    this.dataModel.getEnums().forEach((et) => {\r\n      this.sourceFile.addEnum({\r\n        name: et.name,\r\n        isExported: true,\r\n        members: et.members.map((mem) => ({ name: mem, initializer: `\"${mem}\"` })),\r\n      });\r\n    });\r\n  }\r\n\r\n  private generateModels() {\r\n    this.dataModel.getModels().forEach((model) => {\r\n      this.generateModel(model);\r\n      if (!this.options.skipIdModels) {\r\n        this.generateIdModel(model);\r\n      }\r\n      if (!this.options.skipEditableModels) {\r\n        this.generateEditableModel(model);\r\n      }\r\n      if (!this.options.skipOperations) {\r\n        this.generateBoundOperationParams(model.name);\r\n      }\r\n    });\r\n    this.dataModel.getComplexTypes().forEach((model) => {\r\n      this.generateModel(model);\r\n      if (!this.options.skipEditableModels) {\r\n        this.generateEditableModel(model);\r\n      }\r\n    });\r\n\r\n    this.sourceFile.addImportDeclarations(this.importContainer.getImportDeclarations());\r\n  }\r\n\r\n  private generateModel(model: ComplexType) {\r\n    this.sourceFile.addInterface({\r\n      name: model.name,\r\n      isExported: true,\r\n      properties: model.props.map((p) => {\r\n        const isEntity = p.dataType == DataTypes.ModelType;\r\n        return {\r\n          name: p.name,\r\n          type: this.getPropType(p),\r\n          // props for entities or entity collections are not added in V4 if not explicitly expanded\r\n          hasQuestionToken: this.dataModel.isV4() && isEntity,\r\n        };\r\n      }),\r\n      extends: model.baseClasses,\r\n    });\r\n  }\r\n\r\n  private getPropType(prop: PropertyModel): string {\r\n    const isEntity = prop.dataType == DataTypes.ModelType;\r\n\r\n    // V2 entity special: deferred content\r\n    let suffix = \"\";\r\n    if (isEntity && this.dataModel.isV2()) {\r\n      this.importContainer.addFromCore(DEFERRED_CONTENT);\r\n      suffix = ` | ${DEFERRED_CONTENT}`;\r\n    }\r\n    // custom types which require type imports => possible via converters\r\n    else if (prop.typeModule) {\r\n      this.importContainer.addCustomType(prop.typeModule, prop.type);\r\n    }\r\n\r\n    // Collections\r\n    if (prop.isCollection) {\r\n      const type = `Array<${prop.type}>`;\r\n      if (this.dataModel.isV2() && this.options.v2ModelsWithExtraResultsWrapping) {\r\n        return `{ results: ${type} }` + suffix;\r\n      } else {\r\n        return type + suffix;\r\n      }\r\n    }\r\n\r\n    // primitive, enum & complex types\r\n    return prop.type + (prop.required ? \"\" : \" | null\") + suffix;\r\n  }\r\n\r\n  private generateIdModel(model: ModelType) {\r\n    if (!model.generateId) {\r\n      return;\r\n    }\r\n    const singleType = model.keys.length === 1 ? `${model.keys[0].type} | ` : \"\";\r\n    const keyTypes = model.keys.map((keyProp) => `${keyProp.name}: ${this.getPropType(keyProp)}`).join(\",\");\r\n    const type = `${singleType}{${keyTypes}}`;\r\n\r\n    this.sourceFile.addTypeAlias({\r\n      name: model.idModelName,\r\n      isExported: true,\r\n      type,\r\n    });\r\n  }\r\n\r\n  private generateEditableModel(model: ComplexType) {\r\n    const entityTypes = [DataTypes.ModelType, DataTypes.ComplexType];\r\n    const allProps = [...model.baseProps, ...model.props].filter((p) => !p.managed);\r\n\r\n    const requiredProps = allProps\r\n      .filter((p) => p.required && !entityTypes.includes(p.dataType))\r\n      .map((p) => `\"${p.name}\"`)\r\n      .join(\" | \");\r\n    const optionalProps = allProps\r\n      .filter((p) => !p.required && !entityTypes.includes(p.dataType))\r\n      .map((p) => `\"${p.name}\"`)\r\n      .join(\" | \");\r\n    const complexProps = allProps.filter((p) => p.dataType === DataTypes.ComplexType);\r\n\r\n    const extendsClause = [\r\n      requiredProps ? `Pick<${model.name}, ${requiredProps}>` : null,\r\n      optionalProps ? `Partial<Pick<${model.name}, ${optionalProps}>>` : null,\r\n    ].filter((e): e is string => !!e);\r\n\r\n    this.sourceFile.addInterface({\r\n      name: model.editableName,\r\n      isExported: true,\r\n      extends: extendsClause,\r\n      properties: !complexProps\r\n        ? undefined\r\n        : complexProps.map((p) => {\r\n            return {\r\n              name: p.name,\r\n              type: this.getEditablePropType(p),\r\n              // optional props don't need to be specified in editable model\r\n              // also, entities would require deep insert func => we make it optional for now\r\n              hasQuestionToken: !p.required || p.dataType === DataTypes.ModelType,\r\n            };\r\n          }),\r\n    });\r\n  }\r\n\r\n  private getEditablePropType(prop: PropertyModel): string {\r\n    const type =\r\n      prop.dataType === DataTypes.ModelType\r\n        ? this.dataModel.getModel(prop.type).editableName\r\n        : prop.dataType === DataTypes.ComplexType\r\n        ? this.dataModel.getComplexType(prop.type).editableName\r\n        : prop.type;\r\n\r\n    // Collections\r\n    if (prop.isCollection) {\r\n      return `Array<${type}>`;\r\n    }\r\n\r\n    // primitive, enum & complex types\r\n    return type + (prop.required ? \"\" : \" | null\");\r\n  }\r\n\r\n  private generateUnboundOperationParams() {\r\n    this.dataModel.getUnboundOperationTypes().forEach((operation) => {\r\n      this.generateOperationParams(operation);\r\n    });\r\n  }\r\n\r\n  private generateBoundOperationParams(entityName: string) {\r\n    this.dataModel.getOperationTypeByEntityOrCollectionBinding(entityName).forEach((operation) => {\r\n      this.generateOperationParams(operation);\r\n    });\r\n  }\r\n\r\n  private generateOperationParams(operation: OperationType) {\r\n    if (!operation.parameters.length) {\r\n      return;\r\n    }\r\n    this.sourceFile.addInterface({\r\n      name: operation.paramsModelName,\r\n      isExported: true,\r\n      properties: operation.parameters.map((p) => {\r\n        return {\r\n          name: p.name,\r\n          type: this.getPropType(p),\r\n          hasQuestionToken: !p.required,\r\n        };\r\n      }),\r\n    });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ModelGenerator.js","sourceRoot":"","sources":["../../src/generator/ModelGenerator.ts"],"names":[],"mappings":";;;AACA,uCAAmF;AAMnF,uDAAoD;AAE7C,MAAM,cAAc,GAAiC,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE;IACpH,MAAM,SAAS,GAAG,IAAI,cAAc,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;IAC5F,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;AAC9B,CAAC,CAAC;AAHW,QAAA,cAAc,kBAGzB;AAEF,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAE3C,MAAM,cAAc;IAGlB,YACU,SAAoB,EACpB,UAAsB,EACtB,OAAsB,EACtB,OAAiC,EACjC,YAA0B;QAJ1B,cAAS,GAAT,SAAS,CAAW;QACpB,eAAU,GAAV,UAAU,CAAY;QACtB,YAAO,GAAP,OAAO,CAAe;QACtB,YAAO,GAAP,OAAO,CAA0B;QACjC,iBAAY,GAAZ,YAAY,CAAc;IACjC,CAAC;IAEG,QAAQ;QACb,IAAI,CAAC,eAAe,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC,CAAC;QAE7E,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;YAChC,IAAI,CAAC,8BAA8B,EAAE,CAAC;SACvC;IACH,CAAC;IAEO,aAAa;QACnB,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;YACvC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;gBACtB,IAAI,EAAE,EAAE,CAAC,IAAI;gBACb,UAAU,EAAE,IAAI;gBAChB,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,GAAG,GAAG,EAAE,CAAC,CAAC;aAC3E,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,cAAc;QACpB,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3C,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC1B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;gBAC9B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;aAC7B;YACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE;gBACpC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;aACnC;YACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;gBAChC,IAAI,CAAC,4BAA4B,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;aAC/C;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACjD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC1B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE;gBACpC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;aACnC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC,IAAI,CAAC,eAAe,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACtF,CAAC;IAEO,aAAa,CAAC,KAA8B;QAClD,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YAC3B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBAChC,MAAM,QAAQ,GAAG,CAAC,CAAC,QAAQ,yCAAuB,CAAC;gBACnD,OAAO;oBACL,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;oBACzB,0FAA0F;oBAC1F,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,QAAQ;oBACnD,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;iBAC/E,CAAC;YACJ,CAAC,CAAC;YACF,OAAO,EAAE,KAAK,CAAC,WAAW;SAC3B,CAAC,CAAC;IACL,CAAC;IAEO,eAAe,CAAC,IAAmB,EAAE,KAA8B;;QACzE,MAAM,SAAS,GAAG,MAAC,KAAmB,CAAC,QAAQ,0CAAE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAkB,EAAE,CAAC;QACtC,IAAI,SAAS,EAAE;YACb,WAAW,CAAC,IAAI,CAAC,uEAAuE,CAAC,CAAC;SAC3F;QACD,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,WAAW,CAAC,IAAI,CAAC,gFAAgF,CAAC,CAAC;SACpG;QACD,IAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,MAAM,EAAE;YAC3B,WAAW,CAAC,IAAI,CAAC,2BAA2B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACrG;QAED,MAAM,cAAc,GAA4B;YAC9C,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC;YACxB,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC;SACzB,CAAC;QACF,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,cAAc,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;SAC5C;QAED,MAAM,WAAW,GACf,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YACvD,qBAAqB;YACrB,qDAAqD;YACrD,cAAc,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE1E,OAAO,EAAE,IAAI,EAAE,wBAAa,CAAC,KAAK,EAAE,WAAW,EAAE,CAAC;IACpD,CAAC;IAEO,WAAW,CAAC,IAAmB;QACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,yCAAuB,CAAC;QAEtD,sCAAsC;QACtC,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE;YACrC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;YACnD,MAAM,GAAG,MAAM,gBAAgB,EAAE,CAAC;SACnC;QACD,qEAAqE;aAChE,IAAI,IAAI,CAAC,UAAU,EAAE;YACxB,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;SAChE;QAED,cAAc;QACd,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,MAAM,IAAI,GAAG,SAAS,IAAI,CAAC,IAAI,GAAG,CAAC;YACnC,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE;gBAC1E,OAAO,cAAc,IAAI,IAAI,GAAG,MAAM,CAAC;aACxC;iBAAM;gBACL,OAAO,IAAI,GAAG,MAAM,CAAC;aACtB;SACF;QAED,kCAAkC;QAClC,OAAO,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;IAC/D,CAAC;IAEO,eAAe,CAAC,KAAgB;QACtC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;YACrB,OAAO;SACR;QACD,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7E,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxG,MAAM,IAAI,GAAG,GAAG,UAAU,IAAI,QAAQ,GAAG,CAAC;QAE1C,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YAC3B,IAAI,EAAE,KAAK,CAAC,WAAW;YACvB,UAAU,EAAE,IAAI;YAChB,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAEO,qBAAqB,CAAC,KAAkB;QAC9C,MAAM,WAAW,GAAG,kFAA4C,CAAC;QACjE,MAAM,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,SAAS,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAEhF,MAAM,aAAa,GAAG,QAAQ;aAC3B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;aAC9D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC;aACzB,IAAI,CAAC,KAAK,CAAC,CAAC;QACf,MAAM,aAAa,GAAG,QAAQ;aAC3B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;aAC/D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC;aACzB,IAAI,CAAC,KAAK,CAAC,CAAC;QACf,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,8CAA0B,CAAC,CAAC;QAElF,MAAM,aAAa,GAAG;YACpB,aAAa,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC,IAAI,KAAK,aAAa,GAAG,CAAC,CAAC,CAAC,IAAI;YAC9D,aAAa,CAAC,CAAC,CAAC,gBAAgB,KAAK,CAAC,IAAI,KAAK,aAAa,IAAI,CAAC,CAAC,CAAC,IAAI;SACxE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAElC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YAC3B,IAAI,EAAE,KAAK,CAAC,YAAY;YACxB,UAAU,EAAE,IAAI;YAChB,OAAO,EAAE,aAAa;YACtB,UAAU,EAAE,CAAC,YAAY;gBACvB,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;oBACrB,OAAO;wBACL,IAAI,EAAE,CAAC,CAAC,IAAI;wBACZ,IAAI,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;wBACjC,8DAA8D;wBAC9D,+EAA+E;wBAC/E,gBAAgB,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,QAAQ,0CAAwB;qBACpE,CAAC;gBACJ,CAAC,CAAC;SACP,CAAC,CAAC;IACL,CAAC;IAEO,mBAAmB,CAAC,IAAmB;QAC7C,MAAM,IAAI,GACR,IAAI,CAAC,QAAQ,0CAAwB;YACnC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,YAAY;YACjD,CAAC,CAAC,IAAI,CAAC,QAAQ,8CAA0B;gBACzC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,YAAY;gBACvD,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAEhB,cAAc;QACd,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,SAAS,IAAI,GAAG,CAAC;SACzB;QAED,kCAAkC;QAClC,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACjD,CAAC;IAEO,8BAA8B;QACpC,IAAI,CAAC,SAAS,CAAC,wBAAwB,EAAE,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC9D,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,4BAA4B,CAAC,UAAkB;QACrD,IAAI,CAAC,SAAS,CAAC,2CAA2C,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC3F,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,uBAAuB,CAAC,SAAwB;QACtD,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE;YAChC,OAAO;SACR;QACD,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YAC3B,IAAI,EAAE,SAAS,CAAC,eAAe;YAC/B,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBACzC,OAAO;oBACL,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;oBACzB,gBAAgB,EAAE,CAAC,CAAC,CAAC,QAAQ;iBAC9B,CAAC;YACJ,CAAC,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { ODataVersions } from \"@odata2ts/odata-core\";\r\nimport { JSDocStructure, OptionalKind, SourceFile, StructureKind } from \"ts-morph\";\r\n\r\nimport { DataModel } from \"../data-model/DataModel\";\r\nimport { ComplexType, DataTypes, ModelType, OperationType, PropertyModel } from \"../data-model/DataTypeModel\";\r\nimport { NamingHelper } from \"../data-model/NamingHelper\";\r\nimport { EntityBasedGeneratorFunction, GeneratorFunctionOptions } from \"../FactoryFunctionModel\";\r\nimport { ImportContainer } from \"./ImportContainer\";\r\n\r\nexport const generateModels: EntityBasedGeneratorFunction = (dataModel, sourceFile, version, options, namingHelper) => {\r\n  const generator = new ModelGenerator(dataModel, sourceFile, version, options, namingHelper);\r\n  return generator.generate();\r\n};\r\n\r\nconst DEFERRED_CONTENT = \"DeferredContent\";\r\n\r\nclass ModelGenerator {\r\n  private importContainer!: ImportContainer;\r\n\r\n  constructor(\r\n    private dataModel: DataModel,\r\n    private sourceFile: SourceFile,\r\n    private version: ODataVersions,\r\n    private options: GeneratorFunctionOptions,\r\n    private namingHelper: NamingHelper\r\n  ) {}\r\n\r\n  public generate(): void {\r\n    this.importContainer = new ImportContainer(this.namingHelper.getFileNames());\r\n\r\n    this.generateEnums();\r\n    this.generateModels();\r\n    if (!this.options.skipOperations) {\r\n      this.generateUnboundOperationParams();\r\n    }\r\n  }\r\n\r\n  private generateEnums() {\r\n    this.dataModel.getEnums().forEach((et) => {\r\n      this.sourceFile.addEnum({\r\n        name: et.name,\r\n        isExported: true,\r\n        members: et.members.map((mem) => ({ name: mem, initializer: `\"${mem}\"` })),\r\n      });\r\n    });\r\n  }\r\n\r\n  private generateModels() {\r\n    this.dataModel.getModels().forEach((model) => {\r\n      this.generateModel(model);\r\n      if (!this.options.skipIdModels) {\r\n        this.generateIdModel(model);\r\n      }\r\n      if (!this.options.skipEditableModels) {\r\n        this.generateEditableModel(model);\r\n      }\r\n      if (!this.options.skipOperations) {\r\n        this.generateBoundOperationParams(model.name);\r\n      }\r\n    });\r\n    this.dataModel.getComplexTypes().forEach((model) => {\r\n      this.generateModel(model);\r\n      if (!this.options.skipEditableModels) {\r\n        this.generateEditableModel(model);\r\n      }\r\n    });\r\n\r\n    this.sourceFile.addImportDeclarations(this.importContainer.getImportDeclarations());\r\n  }\r\n\r\n  private generateModel(model: ComplexType | ModelType) {\r\n    this.sourceFile.addInterface({\r\n      name: model.name,\r\n      isExported: true,\r\n      properties: model.props.map((p) => {\r\n        const isEntity = p.dataType == DataTypes.ModelType;\r\n        return {\r\n          name: p.name,\r\n          type: this.getPropType(p),\r\n          // props for entities or entity collections are not added in V4 if not explicitly expanded\r\n          hasQuestionToken: this.dataModel.isV4() && isEntity,\r\n          docs: this.options.skipComments ? undefined : [this.generatePropDoc(p, model)],\r\n        };\r\n      }),\r\n      extends: model.baseClasses,\r\n    });\r\n  }\r\n\r\n  private generatePropDoc(prop: PropertyModel, model: ComplexType | ModelType): OptionalKind<JSDocStructure> {\r\n    const isKeyProp = (model as ModelType).keyNames?.includes(prop.odataName);\r\n    const baseAttribs: Array<string> = [];\r\n    if (isKeyProp) {\r\n      baseAttribs.push(\"**Key Property**: This is a key property used to identify the entity.\");\r\n    }\r\n    if (prop.managed) {\r\n      baseAttribs.push(\"**Managed**: This property is managed on the server side and cannot be edited.\");\r\n    }\r\n    if (prop.converters?.length) {\r\n      baseAttribs.push(`**Applied Converters**: ${prop.converters.map((c) => c.converterId).join(\",\")}.`);\r\n    }\r\n\r\n    const attributeTable: Array<[string, string]> = [\r\n      [\"Name\", prop.odataName],\r\n      [\"Type\", prop.odataType],\r\n    ];\r\n    if (prop.required) {\r\n      attributeTable.push([\"Nullable\", \"false\"]);\r\n    }\r\n\r\n    const description =\r\n      (baseAttribs ? baseAttribs.join(\"<br/>\") + \"\\n\\n\" : \"\") +\r\n      \"OData Attributes:\\n\" +\r\n      \"|Attribute Name | Attribute Value |\\n| --- | ---|\\n\" +\r\n      attributeTable.map((row) => `| ${row[0]} | \\`${row[1]}\\` |`).join(\"\\n\");\r\n\r\n    return { kind: StructureKind.JSDoc, description };\r\n  }\r\n\r\n  private getPropType(prop: PropertyModel): string {\r\n    const isEntity = prop.dataType == DataTypes.ModelType;\r\n\r\n    // V2 entity special: deferred content\r\n    let suffix = \"\";\r\n    if (isEntity && this.dataModel.isV2()) {\r\n      this.importContainer.addFromCore(DEFERRED_CONTENT);\r\n      suffix = ` | ${DEFERRED_CONTENT}`;\r\n    }\r\n    // custom types which require type imports => possible via converters\r\n    else if (prop.typeModule) {\r\n      this.importContainer.addCustomType(prop.typeModule, prop.type);\r\n    }\r\n\r\n    // Collections\r\n    if (prop.isCollection) {\r\n      const type = `Array<${prop.type}>`;\r\n      if (this.dataModel.isV2() && this.options.v2ModelsWithExtraResultsWrapping) {\r\n        return `{ results: ${type} }` + suffix;\r\n      } else {\r\n        return type + suffix;\r\n      }\r\n    }\r\n\r\n    // primitive, enum & complex types\r\n    return prop.type + (prop.required ? \"\" : \" | null\") + suffix;\r\n  }\r\n\r\n  private generateIdModel(model: ModelType) {\r\n    if (!model.generateId) {\r\n      return;\r\n    }\r\n    const singleType = model.keys.length === 1 ? `${model.keys[0].type} | ` : \"\";\r\n    const keyTypes = model.keys.map((keyProp) => `${keyProp.name}: ${this.getPropType(keyProp)}`).join(\",\");\r\n    const type = `${singleType}{${keyTypes}}`;\r\n\r\n    this.sourceFile.addTypeAlias({\r\n      name: model.idModelName,\r\n      isExported: true,\r\n      type,\r\n    });\r\n  }\r\n\r\n  private generateEditableModel(model: ComplexType) {\r\n    const entityTypes = [DataTypes.ModelType, DataTypes.ComplexType];\r\n    const allProps = [...model.baseProps, ...model.props].filter((p) => !p.managed);\r\n\r\n    const requiredProps = allProps\r\n      .filter((p) => p.required && !entityTypes.includes(p.dataType))\r\n      .map((p) => `\"${p.name}\"`)\r\n      .join(\" | \");\r\n    const optionalProps = allProps\r\n      .filter((p) => !p.required && !entityTypes.includes(p.dataType))\r\n      .map((p) => `\"${p.name}\"`)\r\n      .join(\" | \");\r\n    const complexProps = allProps.filter((p) => p.dataType === DataTypes.ComplexType);\r\n\r\n    const extendsClause = [\r\n      requiredProps ? `Pick<${model.name}, ${requiredProps}>` : null,\r\n      optionalProps ? `Partial<Pick<${model.name}, ${optionalProps}>>` : null,\r\n    ].filter((e): e is string => !!e);\r\n\r\n    this.sourceFile.addInterface({\r\n      name: model.editableName,\r\n      isExported: true,\r\n      extends: extendsClause,\r\n      properties: !complexProps\r\n        ? undefined\r\n        : complexProps.map((p) => {\r\n            return {\r\n              name: p.name,\r\n              type: this.getEditablePropType(p),\r\n              // optional props don't need to be specified in editable model\r\n              // also, entities would require deep insert func => we make it optional for now\r\n              hasQuestionToken: !p.required || p.dataType === DataTypes.ModelType,\r\n            };\r\n          }),\r\n    });\r\n  }\r\n\r\n  private getEditablePropType(prop: PropertyModel): string {\r\n    const type =\r\n      prop.dataType === DataTypes.ModelType\r\n        ? this.dataModel.getModel(prop.type).editableName\r\n        : prop.dataType === DataTypes.ComplexType\r\n        ? this.dataModel.getComplexType(prop.type).editableName\r\n        : prop.type;\r\n\r\n    // Collections\r\n    if (prop.isCollection) {\r\n      return `Array<${type}>`;\r\n    }\r\n\r\n    // primitive, enum & complex types\r\n    return type + (prop.required ? \"\" : \" | null\");\r\n  }\r\n\r\n  private generateUnboundOperationParams() {\r\n    this.dataModel.getUnboundOperationTypes().forEach((operation) => {\r\n      this.generateOperationParams(operation);\r\n    });\r\n  }\r\n\r\n  private generateBoundOperationParams(entityName: string) {\r\n    this.dataModel.getOperationTypeByEntityOrCollectionBinding(entityName).forEach((operation) => {\r\n      this.generateOperationParams(operation);\r\n    });\r\n  }\r\n\r\n  private generateOperationParams(operation: OperationType) {\r\n    if (!operation.parameters.length) {\r\n      return;\r\n    }\r\n    this.sourceFile.addInterface({\r\n      name: operation.paramsModelName,\r\n      isExported: true,\r\n      properties: operation.parameters.map((p) => {\r\n        return {\r\n          name: p.name,\r\n          type: this.getPropType(p),\r\n          hasQuestionToken: !p.required,\r\n        };\r\n      }),\r\n    });\r\n  }\r\n}\r\n"]}

package/lib/generator/QueryObjectGenerator.d.ts

@@ -1,2 +1,2 @@
-import { EntityBasedGeneratorFunction } from "../FactoryFunctionModel";
-export declare const generateQueryObjects: EntityBasedGeneratorFunction;
+import { EntityBasedGeneratorFunction } from "../FactoryFunctionModel";
+export declare const generateQueryObjects: EntityBasedGeneratorFunction;