@odata2ts/odata2ts 0.23.0 → 0.24.0

package/lib/generator/QueryObjectGenerator.js

@@ -1,240 +1,240 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateQueryObjects = void 0;
-const odata_core_1 = require("@odata2ts/odata-core");
-const ts_morph_1 = require("ts-morph");
-const processors_1 = require("xml2js/lib/processors");
-const ImportContainer_1 = require("./ImportContainer");
-const generateQueryObjects = (dataModel, sourceFile, version, options, namingHelper) => {
-    const generator = new QueryObjectGenerator(dataModel, sourceFile, version, options, namingHelper);
-    return generator.generate();
-};
-exports.generateQueryObjects = generateQueryObjects;
-class QueryObjectGenerator {
-    constructor(dataModel, sourceFile, version, options, namingHelper) {
-        this.dataModel = dataModel;
-        this.sourceFile = sourceFile;
-        this.version = version;
-        this.options = options;
-        this.namingHelper = namingHelper;
-    }
-    generate() {
-        const importContainer = new ImportContainer_1.ImportContainer(this.namingHelper.getFileNames());
-        this.generateModels(importContainer);
-        if (!this.options.skipOperations) {
-            this.generateUnboundOperations(importContainer);
-        }
-        this.sourceFile.addImportDeclarations(importContainer.getImportDeclarations(false));
-    }
-    generateModels(importContainer) {
-        this.dataModel.getModels().forEach((model) => {
-            this.generateModel(model, importContainer);
-            if (!this.options.skipIdModels) {
-                this.generateIdFunction(model, importContainer);
-            }
-            if (!this.options.skipOperations) {
-                this.generateBoundOperations(model.name, importContainer);
-            }
-        });
-        this.dataModel.getComplexTypes().forEach((model) => {
-            this.generateModel(model, importContainer);
-        });
-        if (this.dataModel.getModels().length || this.dataModel.getComplexTypes().length) {
-            importContainer.addFromQObject("QueryObject");
-        }
-    }
-    generateModel(model, importContainer) {
-        let extendsClause = "QueryObject";
-        if (model.baseClasses.length) {
-            const baseClass = model.baseClasses[0];
-            const baseModel = this.dataModel.getModel(baseClass) || this.dataModel.getComplexType(baseClass);
-            extendsClause = baseModel.qName;
-        }
-        this.sourceFile.addClass({
-            name: model.qName,
-            isExported: true,
-            extends: extendsClause,
-            properties: this.generateQueryObjectProps(model.props, importContainer),
-        });
-        this.sourceFile.addVariableStatement({
-            declarationKind: ts_morph_1.VariableDeclarationKind.Const,
-            isExported: true,
-            declarations: [
-                {
-                    name: (0, processors_1.firstCharLowerCase)(model.qName),
-                    initializer: `new ${model.qName}()`,
-                },
-            ],
-        });
-    }
-    generateQueryObjectProps(props, importContainer) {
-        return props.map((prop) => {
-            const { odataName } = prop;
-            const name = this.namingHelper.getQPropName(prop.name);
-            const isModelType = prop.dataType === "ModelType" /* DataTypes.ModelType */ || prop.dataType === "ComplexType" /* DataTypes.ComplexType */;
-            let qPathInit;
-            // factor in collections
-            if (prop.isCollection) {
-                const cType = `Q${isModelType ? "Entity" : ""}CollectionPath`;
-                const qObject = prop.qObject;
-                if (!qObject) {
-                    throw new Error("QObject for collection is missing!");
-                }
-                qPathInit = `new ${cType}(this.withPrefix("${odataName}"), () => ${qObject})`;
-                importContainer.addFromQObject(cType);
-                if (!isModelType) {
-                    importContainer.addFromQObject(qObject);
-                }
-            }
-            else {
-                if (isModelType) {
-                    qPathInit = `new ${prop.qPath}(this.withPrefix("${odataName}"), () => ${prop.qObject})`;
-                }
-                else {
-                    let converterStmt = this.generateConverterStmt(prop.converters, importContainer);
-                    qPathInit = `new ${prop.qPath}(this.withPrefix("${odataName}")${converterStmt ? `, ${converterStmt}` : ""})`;
-                }
-                // add import for data type
-                importContainer.addFromQObject(prop.qPath);
-            }
-            return {
-                name,
-                scope: ts_morph_1.Scope.Public,
-                isReadonly: true,
-                initializer: qPathInit,
-            };
-        });
-    }
-    generateConverterStmt(converters, importContainer) {
-        if (!(converters === null || converters === void 0 ? void 0 : converters.length)) {
-            return;
-        }
-        converters.forEach((converter) => {
-            importContainer.addCustomType(converter.package, converter.converterId);
-        });
-        if (converters.length === 1) {
-            return converters[0].converterId;
-        }
-        else {
-            importContainer.addCustomType("@odata2ts/converter-runtime", "createChain");
-            const [first, second, ...moreConverters] = converters;
-            return moreConverters.reduce((stmt, conv) => `${stmt}.chain(${conv.converterId})`, `createChain(${first.converterId}, ${second.converterId})`);
-        }
-    }
-    generateIdFunction(model, importContainer) {
-        if (!model.generateId) {
-            return;
-        }
-        const qFunc = "QId";
-        importContainer.addFromQObject(qFunc);
-        importContainer.addGeneratedModel(model.idModelName);
-        this.sourceFile.addClass({
-            name: model.qIdFunctionName,
-            isExported: true,
-            extends: `${qFunc}<${model.idModelName}>`,
-            properties: [
-                {
-                    name: "params",
-                    scope: ts_morph_1.Scope.Private,
-                    isReadonly: true,
-                    initializer: this.getParamInitString(model.keys, importContainer),
-                },
-            ],
-            methods: [
-                {
-                    name: "getParams",
-                    statements: ["return this.params"],
-                },
-            ],
-        });
-    }
-    getParamInitString(props, importContainer) {
-        return `[${props
-            .map((prop) => {
-            var _a;
-            const isComplexParam = prop.dataType === "ModelType" /* DataTypes.ModelType */ || prop.dataType === "ComplexType" /* DataTypes.ComplexType */;
-            if (prop.qParam) {
-                importContainer.addFromQObject(prop.qParam);
-            }
-            const isMappedNameNecessary = prop.odataName !== prop.name;
-            const mappedName = isMappedNameNecessary ? `"${prop.name}"` : ((_a = prop.converters) === null || _a === void 0 ? void 0 : _a.length) ? "undefined" : undefined;
-            const converterStmt = this.generateConverterStmt(prop.converters, importContainer);
-            const mappedNameParam = mappedName ? `, ${mappedName}` : "";
-            const complexQParam = isComplexParam ? `, new ${prop.qObject}()` : "";
-            const converterParam = converterStmt ? `, ${converterStmt}` : "";
-            return `new ${prop.qParam}("${prop.odataName}"${complexQParam}${mappedNameParam}${converterParam})`;
-        })
-            .join(",")}]`;
-    }
-    generateUnboundOperations(importContainer) {
-        this.dataModel.getUnboundOperationTypes().forEach((operation) => {
-            this.generateOperation(operation, importContainer);
-        });
-    }
-    generateBoundOperations(bindingName, importContainer) {
-        this.dataModel.getOperationTypeByEntityOrCollectionBinding(bindingName).forEach((operation) => {
-            this.generateOperation(operation, importContainer);
-        });
-    }
-    generateOperation(operation, importContainer) {
-        var _a;
-        const isV2 = this.version === odata_core_1.ODataVersions.V2;
-        const qOperation = operation.type === "Action" /* OperationTypes.Action */ ? "QAction" : "QFunction";
-        const returnType = operation.returnType;
-        let returnTypeOpStmt = "";
-        const hasParams = operation.parameters.length > 0;
-        importContainer.addFromQObject(qOperation);
-        if (hasParams) {
-            importContainer.addGeneratedModel(operation.paramsModelName);
-        }
-        if (returnType) {
-            if (returnType.dataType === "ComplexType" /* DataTypes.ComplexType */ || returnType.dataType === "ModelType" /* DataTypes.ModelType */) {
-                if (returnType.qObject) {
-                    importContainer.addFromQObject("OperationReturnType", "ReturnTypes", "QComplexParam");
-                    returnTypeOpStmt = `new OperationReturnType(ReturnTypes.COMPLEX${returnType.isCollection ? "_COLLECTION" : ""}, new QComplexParam("NONE", new ${returnType.qObject}))`;
-                }
-            }
-            else if (returnType.converters && returnType.qParam) {
-                importContainer.addFromQObject("OperationReturnType", "ReturnTypes", returnType.qParam);
-                returnTypeOpStmt = `new OperationReturnType(ReturnTypes.VALUE${returnType.isCollection ? "_COLLECTION" : ""}, new ${returnType.qParam}("NONE", undefined, ${this.generateConverterStmt(returnType.converters, importContainer)}))`;
-            }
-        }
-        this.sourceFile.addClass({
-            name: operation.qName,
-            isExported: true,
-            extends: qOperation + (hasParams ? `<${operation.paramsModelName}>` : ""),
-            properties: [
-                {
-                    name: "params",
-                    scope: ts_morph_1.Scope.Private,
-                    isReadonly: true,
-                    type: ((_a = operation.parameters) === null || _a === void 0 ? void 0 : _a.length) ? undefined : "[]",
-                    initializer: this.getParamInitString(operation.parameters, importContainer),
-                },
-            ],
-            ctors: [
-                {
-                    statements: [
-                        `super("${operation.odataName}"${returnTypeOpStmt ? ", " + returnTypeOpStmt : isV2 ? ", undefined" : ""}${isV2 ? ", { v2Mode: true }" : ""})`,
-                    ],
-                },
-            ],
-            methods: [
-                {
-                    name: "getParams",
-                    statements: ["return this.params"],
-                },
-                // functions without params: add an overriding buildUrl() to not force users to have to pass undefined as param
-                ...(operation.type === "Function" /* OperationTypes.Function */ && !hasParams
-                    ? [
-                        {
-                            name: "buildUrl",
-                            statements: ["return super.buildUrl(undefined)"],
-                        },
-                    ]
-                    : []),
-            ],
-        });
-    }
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateQueryObjects = void 0;
+const odata_core_1 = require("@odata2ts/odata-core");
+const ts_morph_1 = require("ts-morph");
+const processors_1 = require("xml2js/lib/processors");
+const ImportContainer_1 = require("./ImportContainer");
+const generateQueryObjects = (dataModel, sourceFile, version, options, namingHelper) => {
+    const generator = new QueryObjectGenerator(dataModel, sourceFile, version, options, namingHelper);
+    return generator.generate();
+};
+exports.generateQueryObjects = generateQueryObjects;
+class QueryObjectGenerator {
+    constructor(dataModel, sourceFile, version, options, namingHelper) {
+        this.dataModel = dataModel;
+        this.sourceFile = sourceFile;
+        this.version = version;
+        this.options = options;
+        this.namingHelper = namingHelper;
+    }
+    generate() {
+        const importContainer = new ImportContainer_1.ImportContainer(this.namingHelper.getFileNames());
+        this.generateModels(importContainer);
+        if (!this.options.skipOperations) {
+            this.generateUnboundOperations(importContainer);
+        }
+        this.sourceFile.addImportDeclarations(importContainer.getImportDeclarations(false));
+    }
+    generateModels(importContainer) {
+        this.dataModel.getModels().forEach((model) => {
+            this.generateModel(model, importContainer);
+            if (!this.options.skipIdModels) {
+                this.generateIdFunction(model, importContainer);
+            }
+            if (!this.options.skipOperations) {
+                this.generateBoundOperations(model.name, importContainer);
+            }
+        });
+        this.dataModel.getComplexTypes().forEach((model) => {
+            this.generateModel(model, importContainer);
+        });
+        if (this.dataModel.getModels().length || this.dataModel.getComplexTypes().length) {
+            importContainer.addFromQObject("QueryObject");
+        }
+    }
+    generateModel(model, importContainer) {
+        let extendsClause = "QueryObject";
+        if (model.baseClasses.length) {
+            const baseClass = model.baseClasses[0];
+            const baseModel = this.dataModel.getModel(baseClass) || this.dataModel.getComplexType(baseClass);
+            extendsClause = baseModel.qName;
+        }
+        this.sourceFile.addClass({
+            name: model.qName,
+            isExported: true,
+            extends: extendsClause,
+            properties: this.generateQueryObjectProps(model.props, importContainer),
+        });
+        this.sourceFile.addVariableStatement({
+            declarationKind: ts_morph_1.VariableDeclarationKind.Const,
+            isExported: true,
+            declarations: [
+                {
+                    name: (0, processors_1.firstCharLowerCase)(model.qName),
+                    initializer: `new ${model.qName}()`,
+                },
+            ],
+        });
+    }
+    generateQueryObjectProps(props, importContainer) {
+        return props.map((prop) => {
+            const { odataName } = prop;
+            const name = this.namingHelper.getQPropName(prop.name);
+            const isModelType = prop.dataType === "ModelType" /* DataTypes.ModelType */ || prop.dataType === "ComplexType" /* DataTypes.ComplexType */;
+            let qPathInit;
+            // factor in collections
+            if (prop.isCollection) {
+                const cType = `Q${isModelType ? "Entity" : ""}CollectionPath`;
+                const qObject = prop.qObject;
+                if (!qObject) {
+                    throw new Error("QObject for collection is missing!");
+                }
+                qPathInit = `new ${cType}(this.withPrefix("${odataName}"), () => ${qObject})`;
+                importContainer.addFromQObject(cType);
+                if (!isModelType) {
+                    importContainer.addFromQObject(qObject);
+                }
+            }
+            else {
+                if (isModelType) {
+                    qPathInit = `new ${prop.qPath}(this.withPrefix("${odataName}"), () => ${prop.qObject})`;
+                }
+                else {
+                    let converterStmt = this.generateConverterStmt(prop.converters, importContainer);
+                    qPathInit = `new ${prop.qPath}(this.withPrefix("${odataName}")${converterStmt ? `, ${converterStmt}` : ""})`;
+                }
+                // add import for data type
+                importContainer.addFromQObject(prop.qPath);
+            }
+            return {
+                name,
+                scope: ts_morph_1.Scope.Public,
+                isReadonly: true,
+                initializer: qPathInit,
+            };
+        });
+    }
+    generateConverterStmt(converters, importContainer) {
+        if (!(converters === null || converters === void 0 ? void 0 : converters.length)) {
+            return;
+        }
+        converters.forEach((converter) => {
+            importContainer.addCustomType(converter.package, converter.converterId);
+        });
+        if (converters.length === 1) {
+            return converters[0].converterId;
+        }
+        else {
+            importContainer.addCustomType("@odata2ts/converter-runtime", "createChain");
+            const [first, second, ...moreConverters] = converters;
+            return moreConverters.reduce((stmt, conv) => `${stmt}.chain(${conv.converterId})`, `createChain(${first.converterId}, ${second.converterId})`);
+        }
+    }
+    generateIdFunction(model, importContainer) {
+        if (!model.generateId) {
+            return;
+        }
+        const qFunc = "QId";
+        importContainer.addFromQObject(qFunc);
+        importContainer.addGeneratedModel(model.idModelName);
+        this.sourceFile.addClass({
+            name: model.qIdFunctionName,
+            isExported: true,
+            extends: `${qFunc}<${model.idModelName}>`,
+            properties: [
+                {
+                    name: "params",
+                    scope: ts_morph_1.Scope.Private,
+                    isReadonly: true,
+                    initializer: this.getParamInitString(model.keys, importContainer),
+                },
+            ],
+            methods: [
+                {
+                    name: "getParams",
+                    statements: ["return this.params"],
+                },
+            ],
+        });
+    }
+    getParamInitString(props, importContainer) {
+        return `[${props
+            .map((prop) => {
+            var _a;
+            const isComplexParam = prop.dataType === "ModelType" /* DataTypes.ModelType */ || prop.dataType === "ComplexType" /* DataTypes.ComplexType */;
+            if (prop.qParam) {
+                importContainer.addFromQObject(prop.qParam);
+            }
+            const isMappedNameNecessary = prop.odataName !== prop.name;
+            const mappedName = isMappedNameNecessary ? `"${prop.name}"` : ((_a = prop.converters) === null || _a === void 0 ? void 0 : _a.length) ? "undefined" : undefined;
+            const converterStmt = this.generateConverterStmt(prop.converters, importContainer);
+            const mappedNameParam = mappedName ? `, ${mappedName}` : "";
+            const complexQParam = isComplexParam ? `, new ${prop.qObject}()` : "";
+            const converterParam = converterStmt ? `, ${converterStmt}` : "";
+            return `new ${prop.qParam}("${prop.odataName}"${complexQParam}${mappedNameParam}${converterParam})`;
+        })
+            .join(",")}]`;
+    }
+    generateUnboundOperations(importContainer) {
+        this.dataModel.getUnboundOperationTypes().forEach((operation) => {
+            this.generateOperation(operation, importContainer);
+        });
+    }
+    generateBoundOperations(bindingName, importContainer) {
+        this.dataModel.getOperationTypeByEntityOrCollectionBinding(bindingName).forEach((operation) => {
+            this.generateOperation(operation, importContainer);
+        });
+    }
+    generateOperation(operation, importContainer) {
+        var _a;
+        const isV2 = this.version === odata_core_1.ODataVersions.V2;
+        const qOperation = operation.type === "Action" /* OperationTypes.Action */ ? "QAction" : "QFunction";
+        const returnType = operation.returnType;
+        let returnTypeOpStmt = "";
+        const hasParams = operation.parameters.length > 0;
+        importContainer.addFromQObject(qOperation);
+        if (hasParams) {
+            importContainer.addGeneratedModel(operation.paramsModelName);
+        }
+        if (returnType) {
+            if (returnType.dataType === "ComplexType" /* DataTypes.ComplexType */ || returnType.dataType === "ModelType" /* DataTypes.ModelType */) {
+                if (returnType.qObject) {
+                    importContainer.addFromQObject("OperationReturnType", "ReturnTypes", "QComplexParam");
+                    returnTypeOpStmt = `new OperationReturnType(ReturnTypes.COMPLEX${returnType.isCollection ? "_COLLECTION" : ""}, new QComplexParam("NONE", new ${returnType.qObject}))`;
+                }
+            }
+            else if (returnType.converters && returnType.qParam) {
+                importContainer.addFromQObject("OperationReturnType", "ReturnTypes", returnType.qParam);
+                returnTypeOpStmt = `new OperationReturnType(ReturnTypes.VALUE${returnType.isCollection ? "_COLLECTION" : ""}, new ${returnType.qParam}("NONE", undefined, ${this.generateConverterStmt(returnType.converters, importContainer)}))`;
+            }
+        }
+        this.sourceFile.addClass({
+            name: operation.qName,
+            isExported: true,
+            extends: qOperation + (hasParams ? `<${operation.paramsModelName}>` : ""),
+            properties: [
+                {
+                    name: "params",
+                    scope: ts_morph_1.Scope.Private,
+                    isReadonly: true,
+                    type: ((_a = operation.parameters) === null || _a === void 0 ? void 0 : _a.length) ? undefined : "[]",
+                    initializer: this.getParamInitString(operation.parameters, importContainer),
+                },
+            ],
+            ctors: [
+                {
+                    statements: [
+                        `super("${operation.odataName}"${returnTypeOpStmt ? ", " + returnTypeOpStmt : isV2 ? ", undefined" : ""}${isV2 ? ", { v2Mode: true }" : ""})`,
+                    ],
+                },
+            ],
+            methods: [
+                {
+                    name: "getParams",
+                    statements: ["return this.params"],
+                },
+                // functions without params: add an overriding buildUrl() to not force users to have to pass undefined as param
+                ...(operation.type === "Function" /* OperationTypes.Function */ && !hasParams
+                    ? [
+                        {
+                            name: "buildUrl",
+                            statements: ["return super.buildUrl(undefined)"],
+                        },
+                    ]
+                    : []),
+            ],
+        });
+    }
+}
 //# sourceMappingURL=QueryObjectGenerator.js.map

package/lib/generator/ServiceGenerator.d.ts

@@ -1,8 +1,8 @@
-import { ODataVersions } from "@odata2ts/odata-core";
-import { ClassDeclarationStructure } from "ts-morph";
-import { DataModel } from "../data-model/DataModel";
-import { NamingHelper } from "../data-model/NamingHelper";
-import { ProjectManager } from "../project/ProjectManager";
-export interface PropsAndOps extends Required<Pick<ClassDeclarationStructure, "properties" | "methods">> {
-}
-export declare function generateServices(dataModel: DataModel, project: ProjectManager, version: ODataVersions, namingHelper: NamingHelper): Promise<void>;
+import { ODataVersions } from "@odata2ts/odata-core";
+import { ClassDeclarationStructure } from "ts-morph";
+import { DataModel } from "../data-model/DataModel";
+import { NamingHelper } from "../data-model/NamingHelper";
+import { ProjectManager } from "../project/ProjectManager";
+export interface PropsAndOps extends Required<Pick<ClassDeclarationStructure, "properties" | "methods">> {
+}
+export declare function generateServices(dataModel: DataModel, project: ProjectManager, version: ODataVersions, namingHelper: NamingHelper): Promise<void>;