@microsoft/teamsfx-core 2.0.4-alpha.e83c26af7.0 → 2.0.4-alpha.ea55e6d34.0

package/build/common/spec-parser/specParser.js

@@ -9,6 +9,13 @@ const swagger_parser_1 = tslib_1.__importDefault(require("@apidevtools/swagger-p
 const specParserError_1 = require("./specParserError");
 const interfaces_1 = require("./interfaces");
 const constants_1 = require("./constants");
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const specFilter_1 = require("./specFilter");
+const utils_1 = require("./utils");
+const manifestUpdater_1 = require("./manifestUpdater");
+const adaptiveCardGenerator_1 = require("./adaptiveCardGenerator");
+const path_1 = tslib_1.__importDefault(require("path"));
 /**
  * A class that parses an OpenAPI specification file and provides methods to validate, list, and generate artifacts.
  */
@@ -19,6 +26,7 @@ class SpecParser {
      */
     constructor(path) {
         this.specPath = path;
+        this.parser = new swagger_parser_1.default();
     }
     /**
      * Validates the OpenAPI specification file and returns a validation result.
@@ -26,92 +34,87 @@ class SpecParser {
      * @returns A validation result object that contains information about any errors or warnings in the specification file.
      */
     async validate() {
-        const errors = [];
-        const warnings = [];
-        const parser = new swagger_parser_1.default();
         try {
-            if (!this.spec) {
-                this.spec = (await parser.validate(this.specPath));
+            const errors = [];
+            const warnings = [];
+            try {
+                await this.loadSpec();
+                await this.parser.validate(this.spec);
+            }
+            catch (e) {
+                // Spec not valid
+                errors.push({ type: interfaces_1.ErrorType.SpecNotValid, content: e.toString() });
+                return {
+                    status: interfaces_1.ValidationStatus.Error,
+                    warnings,
+                    errors,
+                };
+            }
+            // TODO: we will support swagger 2.0
+            if (!this.spec.openapi || this.spec.openapi < "3.0.0") {
+                errors.push({
+                    type: interfaces_1.ErrorType.VersionNotSupported,
+                    content: constants_1.ConstantString.SpecVersionNotSupported,
+                    data: this.spec.openapi,
+                });
+                return {
+                    status: interfaces_1.ValidationStatus.Error,
+                    warnings,
+                    errors,
+                };
+            }
+            // Server validation
+            const serverErrors = utils_1.validateServer(this.spec);
+            errors.push(...serverErrors);
+            // Remote reference not supported
+            const refPaths = this.parser.$refs.paths();
+            // refPaths [0] is the current spec file path
+            if (refPaths.length > 1) {
+                errors.push({
+                    type: interfaces_1.ErrorType.RemoteRefNotSupported,
+                    content: util.format(constants_1.ConstantString.RemoteRefNotSupported, refPaths.join(", ")),
+                    data: refPaths,
+                });
+            }
+            // No supported API
+            const apiMap = this.getAllSupportedApi(this.spec);
+            if (Object.keys(apiMap).length === 0) {
+                errors.push({
+                    type: interfaces_1.ErrorType.NoSupportedApi,
+                    content: constants_1.ConstantString.NoSupportedApi,
+                });
+            }
+            // OperationId missing
+            const apisMissingOperationId = [];
+            for (const key in apiMap) {
+                const pathObjectItem = apiMap[key];
+                if (!pathObjectItem.operationId) {
+                    apisMissingOperationId.push(key);
+                }
+            }
+            if (apisMissingOperationId.length > 0) {
+                warnings.push({
+                    type: interfaces_1.WarningType.OperationIdMissing,
+                    content: util.format(constants_1.ConstantString.MissingOperationId, apisMissingOperationId.join(", ")),
+                    data: apisMissingOperationId,
+                });
+            }
+            let status = interfaces_1.ValidationStatus.Valid;
+            if (warnings.length > 0 && errors.length === 0) {
+                status = interfaces_1.ValidationStatus.Warning;
+            }
+            else if (errors.length > 0) {
+                status = interfaces_1.ValidationStatus.Error;
             }
-        }
-        catch (e) {
-            // Spec not valid
-            errors.push({ type: interfaces_1.ErrorType.SpecNotValid, content: e.toString() });
-            return {
-                status: interfaces_1.ValidationStatus.Error,
-                warnings,
-                errors,
-            };
-        }
-        // Spec version not supported
-        if (!this.spec.openapi || this.spec.openapi < "3.0.0") {
-            errors.push({
-                type: interfaces_1.ErrorType.VersionNotSupported,
-                content: constants_1.ConstantString.SpecVersionNotSupported,
-            });
             return {
-                status: interfaces_1.ValidationStatus.Error,
+                status,
                 warnings,
                 errors,
             };
         }
-        // Server information invalid
-        if (!this.spec.servers || this.spec.servers.length === 0) {
-            errors.push({
-                type: interfaces_1.ErrorType.NoServerInformation,
-                content: constants_1.ConstantString.NoServerInformation,
-            });
-        }
-        else if (this.spec.servers.length > 1) {
-            errors.push({
-                type: interfaces_1.ErrorType.MultipleServerInformation,
-                content: constants_1.ConstantString.MultipleServerInformation,
-            });
-        }
-        // Remote reference not supported
-        const refPaths = parser.$refs.paths();
-        // refPaths [0] is the current spec file path
-        if (refPaths.length > 1) {
-            console.log("refPaths", refPaths);
-            errors.push({
-                type: interfaces_1.ErrorType.RemoteRefNotSupported,
-                content: util.format(constants_1.ConstantString.RemoteRefNotSupported, refPaths.join(", ")),
-            });
-        }
-        // No supported API
-        const apiMap = await this.getAllSupportedApi(this.spec);
-        if (Object.keys(apiMap).length === 0) {
-            errors.push({
-                type: interfaces_1.ErrorType.NoSupportedApi,
-                content: constants_1.ConstantString.NoSupportedApi,
-            });
-        }
-        // OperationId missing
-        const apisMissingOperationId = [];
-        for (const key in apiMap) {
-            const pathObjectItem = apiMap[key];
-            if (!pathObjectItem.operationId) {
-                apisMissingOperationId.push(key);
-            }
-        }
-        if (apisMissingOperationId.length > 0) {
-            warnings.push({
-                type: interfaces_1.WarningType.OperationIdMissing,
-                content: util.format(constants_1.ConstantString.MissingOperationId, apisMissingOperationId.join(", ")),
-            });
-        }
-        let status = interfaces_1.ValidationStatus.Valid;
-        if (warnings.length > 0 && errors.length === 0) {
-            status = interfaces_1.ValidationStatus.Warning;
-        }
-        else if (errors.length > 0) {
-            status = interfaces_1.ValidationStatus.Error;
+        catch (err) {
+            throw new specParserError_1.SpecParserError(err.toString(), interfaces_1.ErrorType.ValidateFailed);
         }
-        return {
-            status,
-            warnings,
-            errors,
-        };
     }
     /**
      * Lists all the OpenAPI operations in the specification file.
@@ -120,31 +123,115 @@ class SpecParser {
      */
     async list() {
         try {
-            if (!this.spec) {
-                this.spec = (await swagger_parser_1.default.validate(this.specPath));
-            }
-            const apiMap = await this.getAllSupportedApi(this.spec);
+            await this.loadSpec();
+            const apiMap = this.getAllSupportedApi(this.spec);
             return Array.from(Object.keys(apiMap));
         }
         catch (err) {
             throw new specParserError_1.SpecParserError(err.toString(), interfaces_1.ErrorType.ListFailed);
         }
     }
+    /**
+     * List all the OpenAPI operations in the specification file and return a map of operationId and operation path.
+     * @returns A map of operationId and operation path, such as [{'getPetById': 'GET /pets/{petId}'}, {'getUser': 'GET /user/{userId}'}]
+     */
+    async listOperationMap() {
+        try {
+            await this.loadSpec();
+            const apiMap = this.getAllSupportedApi(this.spec);
+            const operationMap = new Map();
+            for (const key in apiMap) {
+                const pathObjectItem = apiMap[key];
+                let operationId = pathObjectItem.operationId;
+                if (!operationId) {
+                    const [method, path] = key.split(" ");
+                    const methodName = method.toLowerCase();
+                    operationId = `${methodName}${utils_1.convertPathToCamelCase(path)}`;
+                }
+                operationMap.set(operationId, key);
+            }
+            return operationMap;
+        }
+        catch (err) {
+            throw new specParserError_1.SpecParserError(err.toString(), interfaces_1.ErrorType.ListOperationMapFailed);
+        }
+    }
     /**
      * Generates and update artifacts from the OpenAPI specification file. Generate Adaptive Cards, update Teams app manifest, and generate a new OpenAPI specification file.
      * @param manifestPath A file path of the Teams app manifest file to update.
      * @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
-     * @param specPath An optional file path of the new OpenAPI specification file to generate. If not specified or empty, no spec file will be generated.
-     * @param adaptiveCardFolder An optional folder path where the Adaptive Card files will be generated. If not specified or empty, Adaptive Card files will not be generated.
+     * @param outputSpecPath File path of the new OpenAPI specification file to generate. If not specified or empty, no spec file will be generated.
+     * @param adaptiveCardFolder Folder path where the Adaptive Card files will be generated. If not specified or empty, Adaptive Card files will not be generated.
      */
-    async generate(manifestPath, filter, specPath, adaptiveCardFolder, signal) {
-        if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
-            throw new specParserError_1.SpecParserError(constants_1.ConstantString.CancelledMessage, interfaces_1.ErrorType.Cancelled);
+    async generate(manifestPath, filter, outputSpecPath, adaptiveCardFolder, signal) {
+        const result = {
+            allSuccess: true,
+            warnings: [],
+        };
+        try {
+            if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+                throw new specParserError_1.SpecParserError(constants_1.ConstantString.CancelledMessage, interfaces_1.ErrorType.Cancelled);
+            }
+            await this.loadSpec();
+            if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+                throw new specParserError_1.SpecParserError(constants_1.ConstantString.CancelledMessage, interfaces_1.ErrorType.Cancelled);
+            }
+            const newUnResolvedSpec = specFilter_1.specFilter(filter, this.unResolveSpec, this.spec);
+            let resultStr;
+            if (outputSpecPath.endsWith(".yaml") || outputSpecPath.endsWith(".yml")) {
+                resultStr = js_yaml_1.default.dump(newUnResolvedSpec);
+            }
+            else {
+                resultStr = JSON.stringify(newUnResolvedSpec, null, 2);
+            }
+            await fs_extra_1.default.outputFile(outputSpecPath, resultStr);
+            if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+                throw new specParserError_1.SpecParserError(constants_1.ConstantString.CancelledMessage, interfaces_1.ErrorType.Cancelled);
+            }
+            const newSpec = (await this.parser.dereference(newUnResolvedSpec));
+            for (const url in newSpec.paths) {
+                for (const method in newSpec.paths[url]) {
+                    if (method === constants_1.ConstantString.GetMethod || method === constants_1.ConstantString.PostMethod) {
+                        const operation = newSpec.paths[url][method];
+                        try {
+                            const card = adaptiveCardGenerator_1.generateAdaptiveCard(operation);
+                            const fileName = path_1.default.join(adaptiveCardFolder, `${operation.operationId}.json`);
+                            await fs_extra_1.default.outputJSON(fileName, card, { spaces: 2 });
+                        }
+                        catch (err) {
+                            result.allSuccess = false;
+                            result.warnings.push({
+                                type: interfaces_1.WarningType.GenerateCardFailed,
+                                content: err.toString(),
+                                data: operation.operationId,
+                            });
+                        }
+                    }
+                }
+            }
+            if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+                throw new specParserError_1.SpecParserError(constants_1.ConstantString.CancelledMessage, interfaces_1.ErrorType.Cancelled);
+            }
+            const [updatedManifest, warnings] = await manifestUpdater_1.updateManifest(manifestPath, outputSpecPath, adaptiveCardFolder, newSpec);
+            await fs_extra_1.default.outputJSON(manifestPath, updatedManifest, { spaces: 2 });
+            result.warnings.push(...warnings);
+        }
+        catch (err) {
+            if (err instanceof specParserError_1.SpecParserError) {
+                throw err;
+            }
+            throw new specParserError_1.SpecParserError(err.toString(), interfaces_1.ErrorType.GenerateFailed);
+        }
+        return result;
+    }
+    async loadSpec() {
+        if (!this.spec) {
+            this.unResolveSpec = (await this.parser.parse(this.specPath));
+            const clonedUnResolveSpec = JSON.parse(JSON.stringify(this.unResolveSpec));
+            this.spec = (await this.parser.dereference(clonedUnResolveSpec));
         }
-        // TODO: implementation
     }
-    async getAllSupportedApi(spec) {
-        var _a;
+    getAllSupportedApi(spec) {
         if (this.apiMap !== undefined) {
             return this.apiMap;
         }
@@ -153,10 +240,10 @@ class SpecParser {
         for (const path in paths) {
             const methods = paths[path];
             for (const method in methods) {
-                // only list get and post method without auth
-                if ((method === constants_1.ConstantString.GetMethod || method === constants_1.ConstantString.PostMethod) &&
-                    !((_a = methods[method]) === null || _a === void 0 ? void 0 : _a.security)) {
-                    result[`${method.toUpperCase()} ${path}`] = methods[method];
+                // For developer preview, only support GET operation with only 1 parameter without auth
+                if (utils_1.isSupportedApi(method, path, spec)) {
+                    const operationObject = methods[method];
+                    result[`${method.toUpperCase()} ${path}`] = operationObject;
                 }
             }
         }

package/build/common/spec-parser/specParser.js.map

@@ -1 +1 @@
-{"version":3,"file":"specParser.js","sourceRoot":"","sources":["../../../src/common/spec-parser/specParser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,YAAY,CAAC;;;;AAEb,mDAA6B;AAC7B,yFAAwD;AAExD,uDAAoD;AACpD,6CAOsB;AACtB,2CAA6C;AAE7C;;GAEG;AACH,MAAa,UAAU;IAKrB;;;OAGG;IACH,YAAY,IAAY;QACtB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,MAAM,GAAkB,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,IAAI,wBAAa,EAAE,CAAC;QACnC,IAAI;YACF,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;gBACd,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAuB,CAAC;aAC1E;SACF;QAAC,OAAO,CAAC,EAAE;YACV,iBAAiB;YACjB,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,sBAAS,CAAC,YAAY,EAAE,OAAO,EAAG,CAAW,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAChF,OAAO;gBACL,MAAM,EAAE,6BAAgB,CAAC,KAAK;gBAC9B,QAAQ;gBACR,MAAM;aACP,CAAC;SACH;QAED,6BAA6B;QAC7B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE;YACrD,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,sBAAS,CAAC,mBAAmB;gBACnC,OAAO,EAAE,0BAAc,CAAC,uBAAuB;aAChD,CAAC,CAAC;YACH,OAAO;gBACL,MAAM,EAAE,6BAAgB,CAAC,KAAK;gBAC9B,QAAQ;gBACR,MAAM;aACP,CAAC;SACH;QAED,6BAA6B;QAC7B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YACxD,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,sBAAS,CAAC,mBAAmB;gBACnC,OAAO,EAAE,0BAAc,CAAC,mBAAmB;aAC5C,CAAC,CAAC;SACJ;aAAM,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACvC,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,sBAAS,CAAC,yBAAyB;gBACzC,OAAO,EAAE,0BAAc,CAAC,yBAAyB;aAClD,CAAC,CAAC;SACJ;QAED,iCAAiC;QACjC,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QAEtC,6CAA6C;QAC7C,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACvB,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAClC,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,sBAAS,CAAC,qBAAqB;gBACrC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,0BAAc,CAAC,qBAAqB,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAChF,CAAC,CAAC;SACJ;QAED,mBAAmB;QACnB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;YACpC,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,sBAAS,CAAC,cAAc;gBAC9B,OAAO,EAAE,0BAAc,CAAC,cAAc;aACvC,CAAC,CAAC;SACJ;QAED,sBAAsB;QACtB,MAAM,sBAAsB,GAAa,EAAE,CAAC;QAC5C,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE;gBAC/B,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAClC;SACF;QAED,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;YACrC,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,wBAAW,CAAC,kBAAkB;gBACpC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,0BAAc,CAAC,kBAAkB,EAAE,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC3F,CAAC,CAAC;SACJ;QAED,IAAI,MAAM,GAAG,6BAAgB,CAAC,KAAK,CAAC;QACpC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9C,MAAM,GAAG,6BAAgB,CAAC,OAAO,CAAC;SACnC;aAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5B,MAAM,GAAG,6BAAgB,CAAC,KAAK,CAAC;SACjC;QAED,OAAO;YACL,MAAM;YACN,QAAQ;YACR,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI;QACR,IAAI;YACF,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;gBACd,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,wBAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAuB,CAAC;aACjF;YACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxD,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;SACxC;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,iCAAe,CAAE,GAAa,CAAC,QAAQ,EAAE,EAAE,sBAAS,CAAC,UAAU,CAAC,CAAC;SAC5E;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CACZ,YAAoB,EACpB,MAAgB,EAChB,QAAiB,EACjB,kBAA2B,EAC3B,MAAoB;QAEpB,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,EAAE;YACnB,MAAM,IAAI,iCAAe,CAAC,0BAAc,CAAC,gBAAgB,EAAE,sBAAS,CAAC,SAAS,CAAC,CAAC;SACjF;QAED,uBAAuB;IACzB,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC9B,IAAwB;;QAExB,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAC7B,OAAO,IAAI,CAAC,MAAM,CAAC;SACpB;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,MAAM,MAAM,GAAiD,EAAE,CAAC;QAChE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;YAC5B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;gBAC5B,6CAA6C;gBAC7C,IACE,CAAC,MAAM,KAAK,0BAAc,CAAC,SAAS,IAAI,MAAM,KAAK,0BAAc,CAAC,UAAU,CAAC;oBAC7E,CAAC,CAAA,MAAA,OAAO,CAAC,MAAM,CAAC,0CAAE,QAAQ,CAAA,EAC1B;oBACA,MAAM,CAAC,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,CAA8B,CAAC;iBAC1F;aACF;SACF;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA9KD,gCA8KC"}
+{"version":3,"file":"specParser.js","sourceRoot":"","sources":["../../../src/common/spec-parser/specParser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,YAAY,CAAC;;;;AAEb,mDAA6B;AAC7B,yFAAwD;AAExD,uDAAoD;AACpD,6CASsB;AACtB,2CAA6C;AAC7C,8DAA6B;AAC7B,gEAA0B;AAC1B,6CAA0C;AAC1C,mCAAiF;AACjF,uDAAmD;AACnD,mEAA+D;AAC/D,wDAAwB;AAExB;;GAEG;AACH,MAAa,UAAU;IAQrB;;;OAGG;IACH,YAAY,IAAY;QACtB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAa,EAAE,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ;QACZ,IAAI;YACF,MAAM,MAAM,GAAkB,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAoB,EAAE,CAAC;YACrC,IAAI;gBACF,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACtB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAK,CAAC,CAAC;aACxC;YAAC,OAAO,CAAC,EAAE;gBACV,iBAAiB;gBACjB,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,sBAAS,CAAC,YAAY,EAAE,OAAO,EAAG,CAAW,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;gBAChF,OAAO;oBACL,MAAM,EAAE,6BAAgB,CAAC,KAAK;oBAC9B,QAAQ;oBACR,MAAM;iBACP,CAAC;aACH;YAED,oCAAoC;YACpC,IAAI,CAAC,IAAI,CAAC,IAAK,CAAC,OAAO,IAAI,IAAI,CAAC,IAAK,CAAC,OAAO,GAAG,OAAO,EAAE;gBACvD,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,sBAAS,CAAC,mBAAmB;oBACnC,OAAO,EAAE,0BAAc,CAAC,uBAAuB;oBAC/C,IAAI,EAAE,IAAI,CAAC,IAAK,CAAC,OAAO;iBACzB,CAAC,CAAC;gBACH,OAAO;oBACL,MAAM,EAAE,6BAAgB,CAAC,KAAK;oBAC9B,QAAQ;oBACR,MAAM;iBACP,CAAC;aACH;YAED,oBAAoB;YACpB,MAAM,YAAY,GAAG,sBAAc,CAAC,IAAI,CAAC,IAAK,CAAC,CAAC;YAChD,MAAM,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,CAAC;YAE7B,iCAAiC;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAE3C,6CAA6C;YAC7C,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;gBACvB,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,sBAAS,CAAC,qBAAqB;oBACrC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,0BAAc,CAAC,qBAAqB,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC/E,IAAI,EAAE,QAAQ;iBACf,CAAC,CAAC;aACJ;YAED,mBAAmB;YACnB,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAK,CAAC,CAAC;YACnD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBACpC,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,sBAAS,CAAC,cAAc;oBAC9B,OAAO,EAAE,0BAAc,CAAC,cAAc;iBACvC,CAAC,CAAC;aACJ;YAED,sBAAsB;YACtB,MAAM,sBAAsB,GAAa,EAAE,CAAC;YAC5C,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;gBACxB,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBACnC,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE;oBAC/B,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;iBAClC;aACF;YAED,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACrC,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,wBAAW,CAAC,kBAAkB;oBACpC,OAAO,EAAE,IAAI,CAAC,MAAM,CAClB,0BAAc,CAAC,kBAAkB,EACjC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC;oBACD,IAAI,EAAE,sBAAsB;iBAC7B,CAAC,CAAC;aACJ;YAED,IAAI,MAAM,GAAG,6BAAgB,CAAC,KAAK,CAAC;YACpC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC9C,MAAM,GAAG,6BAAgB,CAAC,OAAO,CAAC;aACnC;iBAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC5B,MAAM,GAAG,6BAAgB,CAAC,KAAK,CAAC;aACjC;YAED,OAAO;gBACL,MAAM;gBACN,QAAQ;gBACR,MAAM;aACP,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,iCAAe,CAAE,GAAa,CAAC,QAAQ,EAAE,EAAE,sBAAS,CAAC,cAAc,CAAC,CAAC;SAChF;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI;QACR,IAAI;YACF,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtB,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAK,CAAC,CAAC;YACnD,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;SACxC;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,iCAAe,CAAE,GAAa,CAAC,QAAQ,EAAE,EAAE,sBAAS,CAAC,UAAU,CAAC,CAAC;SAC5E;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB;QACpB,IAAI;YACF,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtB,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAK,CAAC,CAAC;YACnD,MAAM,YAAY,GAAG,IAAI,GAAG,EAAkB,CAAC;YAC/C,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;gBACxB,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBACnC,IAAI,WAAW,GAAG,cAAc,CAAC,WAAW,CAAC;gBAC7C,IAAI,CAAC,WAAW,EAAE;oBAChB,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBACtC,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;oBACxC,WAAW,GAAG,GAAG,UAAU,GAAG,8BAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;iBAC9D;gBACD,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;aACpC;YACD,OAAO,YAAY,CAAC;SACrB;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,iCAAe,CAAE,GAAa,CAAC,QAAQ,EAAE,EAAE,sBAAS,CAAC,sBAAsB,CAAC,CAAC;SACxF;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CACZ,YAAoB,EACpB,MAAgB,EAChB,cAAsB,EACtB,kBAA0B,EAC1B,MAAoB;QAEpB,MAAM,MAAM,GAAmB;YAC7B,UAAU,EAAE,IAAI;YAChB,QAAQ,EAAE,EAAE;SACb,CAAC;QACF,IAAI;YACF,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,EAAE;gBACnB,MAAM,IAAI,iCAAe,CAAC,0BAAc,CAAC,gBAAgB,EAAE,sBAAS,CAAC,SAAS,CAAC,CAAC;aACjF;YAED,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtB,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,EAAE;gBACnB,MAAM,IAAI,iCAAe,CAAC,0BAAc,CAAC,gBAAgB,EAAE,sBAAS,CAAC,SAAS,CAAC,CAAC;aACjF;YAED,MAAM,iBAAiB,GAAG,uBAAU,CAAC,MAAM,EAAE,IAAI,CAAC,aAAc,EAAE,IAAI,CAAC,IAAK,CAAC,CAAC;YAC9E,IAAI,SAAS,CAAC;YACd,IAAI,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACvE,SAAS,GAAG,iBAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;aAC5C;iBAAM;gBACL,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;aACxD;YACD,MAAM,kBAAE,CAAC,UAAU,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;YAE/C,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,EAAE;gBACnB,MAAM,IAAI,iCAAe,CAAC,0BAAc,CAAC,gBAAgB,EAAE,sBAAS,CAAC,SAAS,CAAC,CAAC;aACjF;YAED,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAuB,CAAC;YAEzF,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE;gBAC/B,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;oBACvC,IAAI,MAAM,KAAK,0BAAc,CAAC,SAAS,IAAI,MAAM,KAAK,0BAAc,CAAC,UAAU,EAAE;wBAC/E,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAE,CAAC,MAAM,CAA8B,CAAC;wBAC3E,IAAI;4BACF,MAAM,IAAI,GAAiB,4CAAoB,CAAC,SAAS,CAAC,CAAC;4BAC3D,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,SAAS,CAAC,WAAY,OAAO,CAAC,CAAC;4BACjF,MAAM,kBAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;yBACpD;wBAAC,OAAO,GAAG,EAAE;4BACZ,MAAM,CAAC,UAAU,GAAG,KAAK,CAAC;4BAC1B,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;gCACnB,IAAI,EAAE,wBAAW,CAAC,kBAAkB;gCACpC,OAAO,EAAG,GAAa,CAAC,QAAQ,EAAE;gCAClC,IAAI,EAAE,SAAS,CAAC,WAAY;6BAC7B,CAAC,CAAC;yBACJ;qBACF;iBACF;aACF;YAED,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,EAAE;gBACnB,MAAM,IAAI,iCAAe,CAAC,0BAAc,CAAC,gBAAgB,EAAE,sBAAS,CAAC,SAAS,CAAC,CAAC;aACjF;YAED,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,GAAG,MAAM,gCAAc,CACtD,YAAY,EACZ,cAAc,EACd,kBAAkB,EAClB,OAAO,CACR,CAAC;YAEF,MAAM,kBAAE,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;YAElE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;SACnC;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,GAAG,YAAY,iCAAe,EAAE;gBAClC,MAAM,GAAG,CAAC;aACX;YACD,MAAM,IAAI,iCAAe,CAAE,GAAa,CAAC,QAAQ,EAAE,EAAE,sBAAS,CAAC,cAAc,CAAC,CAAC;SAChF;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,QAAQ;QACpB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,IAAI,CAAC,aAAa,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAuB,CAAC;YACpF,MAAM,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;YAC3E,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAuB,CAAC;SACxF;IACH,CAAC;IAEO,kBAAkB,CAAC,IAAwB;QAGjD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAC7B,OAAO,IAAI,CAAC,MAAM,CAAC;SACpB;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,MAAM,MAAM,GAAiD,EAAE,CAAC;QAChE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;YAC5B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;gBAC5B,uFAAuF;gBACvF,IAAI,sBAAc,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE;oBACtC,MAAM,eAAe,GAAI,OAAe,CAAC,MAAM,CAA8B,CAAC;oBAC9E,MAAM,CAAC,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,GAAG,eAAe,CAAC;iBAC7D;aACF;SACF;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA/QD,gCA+QC"}

package/build/common/spec-parser/utils.d.ts

@@ -0,0 +1,29 @@
+import { OpenAPIV3 } from "openapi-types";
+import { CheckParamResult, ErrorResult } from "./interfaces";
+export declare function isYamlSpecFile(specPath: string): Promise<boolean>;
+export declare function checkParameters(paramObject: OpenAPIV3.ParameterObject[]): CheckParamResult;
+export declare function checkPostBody(schema: OpenAPIV3.SchemaObject): CheckParamResult;
+/**
+ * Checks if the given API is supported.
+ * @param {string} method - The HTTP method of the API.
+ * @param {string} path - The path of the API.
+ * @param {OpenAPIV3.Document} spec - The OpenAPI specification document.
+ * @returns {boolean} - Returns true if the API is supported, false otherwise.
+ * @description The following APIs are supported:
+ * 1. only support Get/Post operation without auth property
+ * 2. parameter inside query or path only support string, number, boolean and integer
+ * 3. parameter inside post body only support string, number, boolean, integer and object
+ * 4. request body + required parameters <= 1
+ * 5. response body should be “application/json” and not empty, and response code should be 20X
+ * 6. only support request body with “application/json” content type
+ */
+export declare function isSupportedApi(method: string, path: string, spec: OpenAPIV3.Document): boolean;
+export declare function updateFirstLetter(str: string): string;
+export declare function getRelativePath(from: string, to: string): string;
+export declare function getResponseJson(operationObject: OpenAPIV3.OperationObject | undefined): OpenAPIV3.MediaTypeObject;
+export declare function convertPathToCamelCase(path: string): string;
+export declare function getUrlProtocol(urlString: string): string | undefined;
+export declare function resolveServerUrl(url: string): string;
+export declare function checkServerUrl(servers: OpenAPIV3.ServerObject[]): ErrorResult[];
+export declare function validateServer(spec: OpenAPIV3.Document): ErrorResult[];
+//# sourceMappingURL=utils.d.ts.map

package/build/common/spec-parser/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/common/spec-parser/utils.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAG1C,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAa,MAAM,cAAc,CAAC;AAGxE,wBAAsB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAiBvE;AAED,wBAAgB,eAAe,CAAC,WAAW,EAAE,SAAS,CAAC,eAAe,EAAE,GAAG,gBAAgB,CA2C1F;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,SAAS,CAAC,YAAY,GAAG,gBAAgB,CAoC9E;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,QAAQ,GAAG,OAAO,CA0D9F;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAErD;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAGhE;AAED,wBAAgB,eAAe,CAC7B,eAAe,EAAE,SAAS,CAAC,eAAe,GAAG,SAAS,GACrD,SAAS,CAAC,eAAe,CAY3B;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAU3D;AAED,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAOpE;AAED,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAepD;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,YAAY,EAAE,GAAG,WAAW,EAAE,CAiC/E;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,GAAG,WAAW,EAAE,CA2CtE"}