@microsoft/teamsfx-core 2.0.4-alpha.8b06251e7.0 → 2.0.4-alpha.8d68ea31a.0

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

@@ -2,24 +2,24 @@
 // Licensed under the MIT license.
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateCommands = exports.updateManifest = void 0;
+exports.generateCommands = exports.generateParametersFromSchema = exports.updateManifest = void 0;
 const tslib_1 = require("tslib");
 const interfaces_1 = require("./interfaces");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const utils_1 = require("./utils");
 const specParserError_1 = require("./specParserError");
+const constants_1 = require("./constants");
 async function updateManifest(manifestPath, outputSpecPath, adaptiveCardFolder, spec) {
     var _a;
     try {
         // TODO: manifest interface can be updated when manifest parser library is ready
         const originalManifest = await fs_extra_1.default.readJSON(manifestPath);
-        const commands = generateCommands(spec, adaptiveCardFolder, manifestPath);
+        const commands = await generateCommands(spec, adaptiveCardFolder, manifestPath);
         const ComposeExtension = {
-            type: "apiBased",
-            apiSpecFile: utils_1.getRelativePath(manifestPath, outputSpecPath),
+            composeExtensionType: "apiBased",
+            apiSpecificationFile: utils_1.getRelativePath(manifestPath, outputSpecPath),
             commands: commands,
-            supportsConversationalAI: true,
         };
         const updatedPart = {
             description: {
@@ -36,7 +36,30 @@ async function updateManifest(manifestPath, outputSpecPath, adaptiveCardFolder,
     }
 }
 exports.updateManifest = updateManifest;
-function generateCommands(spec, adaptiveCardFolder, manifestPath) {
+function generateParametersFromSchema(schema, name) {
+    var _a;
+    const parameters = [];
+    if (schema.type === "string" ||
+        schema.type === "integer" ||
+        schema.type === "boolean" ||
+        schema.type === "number") {
+        parameters.push({
+            name: name,
+            title: utils_1.updateFirstLetter(name),
+            description: (_a = schema.description) !== null && _a !== void 0 ? _a : "",
+        });
+    }
+    else if (schema.type === "object") {
+        const { properties } = schema;
+        for (const property in properties) {
+            const result = generateParametersFromSchema(properties[property], property);
+            parameters.push(...result);
+        }
+    }
+    return parameters;
+}
+exports.generateParametersFromSchema = generateParametersFromSchema;
+async function generateCommands(spec, adaptiveCardFolder, manifestPath) {
     var _a;
     const paths = spec.paths;
     const commands = [];
@@ -45,32 +68,47 @@ function generateCommands(spec, adaptiveCardFolder, manifestPath) {
             const pathItem = paths[pathUrl];
             if (pathItem) {
                 const operations = pathItem;
-                // Currently only support GET method
-                const operationItem = operations.get;
-                if (operationItem) {
-                    const parameters = [];
-                    const paramObject = operationItem.parameters;
-                    if (paramObject) {
-                        paramObject.forEach((param) => {
-                            var _a;
-                            param = param;
-                            parameters.push({
-                                name: param.name,
-                                title: utils_1.updateFirstLetter(param.name),
-                                description: (_a = param.description) !== null && _a !== void 0 ? _a : "",
-                            });
-                        });
+                // Currently only support GET and POST method
+                for (const method in operations) {
+                    if (method === constants_1.ConstantString.PostMethod || method === constants_1.ConstantString.GetMethod) {
+                        const operationItem = operations[method];
+                        if (operationItem) {
+                            const parameters = [];
+                            const paramObject = operationItem.parameters;
+                            if (paramObject) {
+                                paramObject.forEach((param) => {
+                                    var _a;
+                                    parameters.push({
+                                        name: param.name,
+                                        title: utils_1.updateFirstLetter(param.name),
+                                        description: (_a = param.description) !== null && _a !== void 0 ? _a : "",
+                                    });
+                                });
+                            }
+                            if (operationItem.requestBody) {
+                                const requestJson = operationItem.requestBody
+                                    .content["application/json"];
+                                if (Object.keys(requestJson).length !== 0) {
+                                    const schema = requestJson.schema;
+                                    const result = generateParametersFromSchema(schema, "requestBody");
+                                    parameters.push(...result);
+                                }
+                            }
+                            const operationId = operationItem.operationId;
+                            const adaptiveCardPath = path_1.default.join(adaptiveCardFolder, operationId + ".json");
+                            const command = {
+                                context: ["compose"],
+                                type: "query",
+                                title: (_a = operationItem.summary) !== null && _a !== void 0 ? _a : "",
+                                id: operationId,
+                                parameters: parameters,
+                                apiResponseRenderingTemplateFile: (await fs_extra_1.default.pathExists(adaptiveCardPath))
+                                    ? utils_1.getRelativePath(manifestPath, adaptiveCardPath)
+                                    : "",
+                            };
+                            commands.push(command);
+                        }
                     }
-                    const adaptiveCardPath = path_1.default.join(adaptiveCardFolder, operationItem.operationId + ".json");
-                    const command = {
-                        context: ["compose"],
-                        type: "query",
-                        title: (_a = operationItem.summary) !== null && _a !== void 0 ? _a : "",
-                        id: operationItem.operationId,
-                        parameters: parameters,
-                        apiResponseRenderingTemplate: utils_1.getRelativePath(manifestPath, adaptiveCardPath),
-                    };
-                    commands.push(command);
                 }
             }
         }

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

@@ -1 +1 @@
-{"version":3,"file":"manifestUpdater.js","sourceRoot":"","sources":["../../../src/common/spec-parser/manifestUpdater.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,YAAY,CAAC;;;;AAGb,6CAAgG;AAChG,gEAA0B;AAC1B,wDAAwB;AACxB,mCAA6D;AAC7D,uDAAoD;AAE7C,KAAK,UAAU,cAAc,CAClC,YAAoB,EACpB,cAAsB,EACtB,kBAA0B,EAC1B,IAAwB;;IAExB,IAAI;QACF,gFAAgF;QAChF,MAAM,gBAAgB,GAAoB,MAAM,kBAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAE1E,MAAM,QAAQ,GAAG,gBAAgB,CAAC,IAAI,EAAE,kBAAkB,EAAE,YAAY,CAAC,CAAC;QAC1E,MAAM,gBAAgB,GAAqB;YACzC,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,uBAAe,CAAC,YAAY,EAAE,cAAc,CAAC;YAC1D,QAAQ,EAAE,QAAQ;YAClB,wBAAwB,EAAE,IAAI;SAC/B,CAAC;QAEF,MAAM,WAAW,GAAoB;YACnC,WAAW,EAAE;gBACX,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;gBACtB,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,CAAC,WAAW,mCAAI,gBAAgB,CAAC,WAAW,CAAC,IAAI;aACjE;YACD,iBAAiB,EAAE,CAAC,gBAAgB,CAAC;SACtC,CAAC;QAEF,MAAM,eAAe,mCAAQ,gBAAgB,GAAK,WAAW,CAAE,CAAC;QAEhE,OAAO,eAAe,CAAC;KACxB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,iCAAe,CAAE,GAAa,CAAC,QAAQ,EAAE,EAAE,sBAAS,CAAC,oBAAoB,CAAC,CAAC;KACtF;AACH,CAAC;AAhCD,wCAgCC;AAED,SAAgB,gBAAgB,CAC9B,IAAwB,EACxB,kBAA0B,EAC1B,YAAoB;;IAEpB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACzB,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,IAAI,KAAK,EAAE;QACT,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE;YAC3B,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;YAChC,IAAI,QAAQ,EAAE;gBACZ,MAAM,UAAU,GAAG,QAAQ,CAAC;gBAE5B,oCAAoC;gBACpC,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC;gBAErC,IAAI,aAAa,EAAE;oBACjB,MAAM,UAAU,GAAgB,EAAE,CAAC;oBACnC,MAAM,WAAW,GAAG,aAAa,CAAC,UAAU,CAAC;oBAE7C,IAAI,WAAW,EAAE;wBACf,WAAW,CAAC,OAAO,CAAC,CAAC,KAA4D,EAAE,EAAE;;4BACnF,KAAK,GAAG,KAAkC,CAAC;4BAC3C,UAAU,CAAC,IAAI,CAAC;gCACd,IAAI,EAAE,KAAK,CAAC,IAAI;gCAChB,KAAK,EAAE,yBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC;gCACpC,WAAW,EAAE,MAAA,KAAK,CAAC,WAAW,mCAAI,EAAE;6BACrC,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;qBACJ;oBAED,MAAM,gBAAgB,GAAG,cAAI,CAAC,IAAI,CAChC,kBAAkB,EAClB,aAAa,CAAC,WAAY,GAAG,OAAO,CACrC,CAAC;oBAEF,MAAM,OAAO,GAAY;wBACvB,OAAO,EAAE,CAAC,SAAS,CAAC;wBACpB,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,MAAA,aAAa,CAAC,OAAO,mCAAI,EAAE;wBAClC,EAAE,EAAE,aAAa,CAAC,WAAY;wBAC9B,UAAU,EAAE,UAAU;wBACtB,4BAA4B,EAAE,uBAAe,CAAC,YAAY,EAAE,gBAAgB,CAAC;qBAC9E,CAAC;oBACF,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;iBACxB;aACF;SACF;KACF;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAnDD,4CAmDC"}
+{"version":3,"file":"manifestUpdater.js","sourceRoot":"","sources":["../../../src/common/spec-parser/manifestUpdater.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,YAAY,CAAC;;;;AAGb,6CAAgG;AAChG,gEAA0B;AAC1B,wDAAwB;AACxB,mCAA6D;AAC7D,uDAAoD;AACpD,2CAA6C;AAEtC,KAAK,UAAU,cAAc,CAClC,YAAoB,EACpB,cAAsB,EACtB,kBAA0B,EAC1B,IAAwB;;IAExB,IAAI;QACF,gFAAgF;QAChF,MAAM,gBAAgB,GAAoB,MAAM,kBAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAE1E,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,kBAAkB,EAAE,YAAY,CAAC,CAAC;QAChF,MAAM,gBAAgB,GAAqB;YACzC,oBAAoB,EAAE,UAAU;YAChC,oBAAoB,EAAE,uBAAe,CAAC,YAAY,EAAE,cAAc,CAAC;YACnE,QAAQ,EAAE,QAAQ;SACnB,CAAC;QAEF,MAAM,WAAW,GAAoB;YACnC,WAAW,EAAE;gBACX,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;gBACtB,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,CAAC,WAAW,mCAAI,gBAAgB,CAAC,WAAW,CAAC,IAAI;aACjE;YACD,iBAAiB,EAAE,CAAC,gBAAgB,CAAC;SACtC,CAAC;QAEF,MAAM,eAAe,mCAAQ,gBAAgB,GAAK,WAAW,CAAE,CAAC;QAEhE,OAAO,eAAe,CAAC;KACxB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,iCAAe,CAAE,GAAa,CAAC,QAAQ,EAAE,EAAE,sBAAS,CAAC,oBAAoB,CAAC,CAAC;KACtF;AACH,CAAC;AA/BD,wCA+BC;AAED,SAAgB,4BAA4B,CAC1C,MAA8B,EAC9B,IAAY;;IAEZ,MAAM,UAAU,GAAgB,EAAE,CAAC;IAEnC,IACE,MAAM,CAAC,IAAI,KAAK,QAAQ;QACxB,MAAM,CAAC,IAAI,KAAK,SAAS;QACzB,MAAM,CAAC,IAAI,KAAK,SAAS;QACzB,MAAM,CAAC,IAAI,KAAK,QAAQ,EACxB;QACA,UAAU,CAAC,IAAI,CAAC;YACd,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,yBAAiB,CAAC,IAAI,CAAC;YAC9B,WAAW,EAAE,MAAA,MAAM,CAAC,WAAW,mCAAI,EAAE;SACtC,CAAC,CAAC;KACJ;SAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE;QACnC,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE;YACjC,MAAM,MAAM,GAAG,4BAA4B,CACzC,UAAU,CAAC,QAAQ,CAA2B,EAC9C,QAAQ,CACT,CAAC;YAEF,UAAU,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;SAC5B;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AA9BD,oEA8BC;AAEM,KAAK,UAAU,gBAAgB,CACpC,IAAwB,EACxB,kBAA0B,EAC1B,YAAoB;;IAEpB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACzB,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,IAAI,KAAK,EAAE;QACT,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE;YAC3B,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;YAChC,IAAI,QAAQ,EAAE;gBACZ,MAAM,UAAU,GAAG,QAAQ,CAAC;gBAE5B,6CAA6C;gBAC7C,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE;oBAC/B,IAAI,MAAM,KAAK,0BAAc,CAAC,UAAU,IAAI,MAAM,KAAK,0BAAc,CAAC,SAAS,EAAE;wBAC/E,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;wBACzC,IAAI,aAAa,EAAE;4BACjB,MAAM,UAAU,GAAgB,EAAE,CAAC;4BACnC,MAAM,WAAW,GAAG,aAAa,CAAC,UAAyC,CAAC;4BAE5E,IAAI,WAAW,EAAE;gCACf,WAAW,CAAC,OAAO,CAAC,CAAC,KAAgC,EAAE,EAAE;;oCACvD,UAAU,CAAC,IAAI,CAAC;wCACd,IAAI,EAAE,KAAK,CAAC,IAAI;wCAChB,KAAK,EAAE,yBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC;wCACpC,WAAW,EAAE,MAAA,KAAK,CAAC,WAAW,mCAAI,EAAE;qCACrC,CAAC,CAAC;gCACL,CAAC,CAAC,CAAC;6BACJ;4BAED,IAAI,aAAa,CAAC,WAAW,EAAE;gCAC7B,MAAM,WAAW,GAAI,aAAa,CAAC,WAA2C;qCAC3E,OAAO,CAAC,kBAAkB,CAAC,CAAC;gCAC/B,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;oCACzC,MAAM,MAAM,GAAG,WAAW,CAAC,MAAgC,CAAC;oCAC5D,MAAM,MAAM,GAAG,4BAA4B,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;oCACnE,UAAU,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;iCAC5B;6BACF;4BAED,MAAM,WAAW,GAAG,aAAa,CAAC,WAAY,CAAC;4BAE/C,MAAM,gBAAgB,GAAG,cAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC;4BAE9E,MAAM,OAAO,GAAY;gCACvB,OAAO,EAAE,CAAC,SAAS,CAAC;gCACpB,IAAI,EAAE,OAAO;gCACb,KAAK,EAAE,MAAA,aAAa,CAAC,OAAO,mCAAI,EAAE;gCAClC,EAAE,EAAE,WAAW;gCACf,UAAU,EAAE,UAAU;gCACtB,gCAAgC,EAAE,CAAC,MAAM,kBAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;oCACvE,CAAC,CAAC,uBAAe,CAAC,YAAY,EAAE,gBAAgB,CAAC;oCACjD,CAAC,CAAC,EAAE;6BACP,CAAC;4BACF,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;yBACxB;qBACF;iBACF;aACF;SACF;KACF;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAhED,4CAgEC"}

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

@@ -1,3 +1,3 @@
 import { OpenAPIV3 } from "openapi-types";
-export declare function specFilter(filter: string[], unResolveSpec: OpenAPIV3.Document): OpenAPIV3.Document;
+export declare function specFilter(filter: string[], unResolveSpec: OpenAPIV3.Document, resolvedSpec: OpenAPIV3.Document): OpenAPIV3.Document;
 //# sourceMappingURL=specFilter.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"specFilter.d.ts","sourceRoot":"","sources":["../../../src/common/spec-parser/specFilter.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAO1C,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EAAE,EAChB,aAAa,EAAE,SAAS,CAAC,QAAQ,GAChC,SAAS,CAAC,QAAQ,CAkCpB"}
+{"version":3,"file":"specFilter.d.ts","sourceRoot":"","sources":["../../../src/common/spec-parser/specFilter.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAM1C,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EAAE,EAChB,aAAa,EAAE,SAAS,CAAC,QAAQ,EACjC,YAAY,EAAE,SAAS,CAAC,QAAQ,GAC/B,SAAS,CAAC,QAAQ,CAkCpB"}

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

@@ -6,20 +6,20 @@ exports.specFilter = void 0;
 const utils_1 = require("./utils");
 const specParserError_1 = require("./specParserError");
 const interfaces_1 = require("./interfaces");
-const allMethodNames = ["get", "post", "put", "delete", "patch", "head", "options", "trace"];
-function specFilter(filter, unResolveSpec) {
+const constants_1 = require("./constants");
+function specFilter(filter, unResolveSpec, resolvedSpec) {
     try {
         const newSpec = Object.assign({}, unResolveSpec);
         const newPaths = {};
         for (const filterItem of filter) {
             const [method, path] = filterItem.split(" ");
             const methodName = method.toLowerCase();
-            if (!utils_1.isSupportedApi(methodName, path, unResolveSpec)) {
+            if (!utils_1.isSupportedApi(methodName, path, resolvedSpec)) {
                 continue;
             }
             if (!newPaths[path]) {
                 newPaths[path] = Object.assign({}, unResolveSpec.paths[path]);
-                for (const m of allMethodNames) {
+                for (const m of constants_1.ConstantString.AllOperationMethods) {
                     delete newPaths[path][m];
                 }
             }

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

@@ -1 +1 @@
-{"version":3,"file":"specFilter.js","sourceRoot":"","sources":["../../../src/common/spec-parser/specFilter.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,YAAY,CAAC;;;AAGb,mCAAiE;AACjE,uDAAoD;AACpD,6CAAyC;AAEzC,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAE7F,SAAgB,UAAU,CACxB,MAAgB,EAChB,aAAiC;IAEjC,IAAI;QACF,MAAM,OAAO,qBAAQ,aAAa,CAAE,CAAC;QACrC,MAAM,QAAQ,GAA0B,EAAE,CAAC;QAC3C,KAAK,MAAM,UAAU,IAAI,MAAM,EAAE;YAC/B,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC7C,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;YAExC,IAAI,CAAC,sBAAc,CAAC,UAAU,EAAE,IAAI,EAAE,aAAa,CAAC,EAAE;gBACpD,SAAS;aACV;YAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACnB,QAAQ,CAAC,IAAI,CAAC,qBAAQ,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAE,CAAC;gBAClD,KAAK,MAAM,CAAC,IAAI,cAAc,EAAE;oBAC9B,OAAQ,QAAQ,CAAC,IAAI,CAAS,CAAC,CAAC,CAAC,CAAC;iBACnC;aACF;YAEA,QAAQ,CAAC,IAAI,CAAS,CAAC,UAAU,CAAC,GAAI,aAAa,CAAC,KAAK,CAAC,IAAI,CAAS,CAAC,UAAU,CAAC,CAAC;YAErF,iCAAiC;YACjC,IAAI,CAAE,QAAQ,CAAC,IAAI,CAAS,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE;gBACnD,QAAQ,CAAC,IAAI,CAAS,CAAC,UAAU,CAAC,CAAC,WAAW,GAAG,GAAG,UAAU,GAAG,8BAAsB,CACtF,IAAI,CACL,EAAE,CAAC;aACL;SACF;QAED,OAAO,CAAC,KAAK,GAAG,QAAQ,CAAC;QACzB,OAAO,OAAO,CAAC;KAChB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,iCAAe,CAAE,GAAa,CAAC,QAAQ,EAAE,EAAE,sBAAS,CAAC,gBAAgB,CAAC,CAAC;KAClF;AACH,CAAC;AArCD,gCAqCC"}
+{"version":3,"file":"specFilter.js","sourceRoot":"","sources":["../../../src/common/spec-parser/specFilter.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,YAAY,CAAC;;;AAGb,mCAAiE;AACjE,uDAAoD;AACpD,6CAAyC;AACzC,2CAA6C;AAE7C,SAAgB,UAAU,CACxB,MAAgB,EAChB,aAAiC,EACjC,YAAgC;IAEhC,IAAI;QACF,MAAM,OAAO,qBAAQ,aAAa,CAAE,CAAC;QACrC,MAAM,QAAQ,GAA0B,EAAE,CAAC;QAC3C,KAAK,MAAM,UAAU,IAAI,MAAM,EAAE;YAC/B,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC7C,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;YAExC,IAAI,CAAC,sBAAc,CAAC,UAAU,EAAE,IAAI,EAAE,YAAY,CAAC,EAAE;gBACnD,SAAS;aACV;YAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACnB,QAAQ,CAAC,IAAI,CAAC,qBAAQ,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAE,CAAC;gBAClD,KAAK,MAAM,CAAC,IAAI,0BAAc,CAAC,mBAAmB,EAAE;oBAClD,OAAQ,QAAQ,CAAC,IAAI,CAAS,CAAC,CAAC,CAAC,CAAC;iBACnC;aACF;YAEA,QAAQ,CAAC,IAAI,CAAS,CAAC,UAAU,CAAC,GAAI,aAAa,CAAC,KAAK,CAAC,IAAI,CAAS,CAAC,UAAU,CAAC,CAAC;YAErF,iCAAiC;YACjC,IAAI,CAAE,QAAQ,CAAC,IAAI,CAAS,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE;gBACnD,QAAQ,CAAC,IAAI,CAAS,CAAC,UAAU,CAAC,CAAC,WAAW,GAAG,GAAG,UAAU,GAAG,8BAAsB,CACtF,IAAI,CACL,EAAE,CAAC;aACL;SACF;QAED,OAAO,CAAC,KAAK,GAAG,QAAQ,CAAC;QACzB,OAAO,OAAO,CAAC;KAChB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,iCAAe,CAAE,GAAa,CAAC,QAAQ,EAAE,EAAE,sBAAS,CAAC,gBAAgB,CAAC,CAAC;KAClF;AACH,CAAC;AAtCD,gCAsCC"}

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

@@ -1,5 +1,5 @@
 import SwaggerParser from "@apidevtools/swagger-parser";
-import { ValidateResult } from "./interfaces";
+import { GenerateResult, ValidateResult } from "./interfaces";
 /**
  * A class that parses an OpenAPI specification file and provides methods to validate, list, and generate artifacts.
  */
@@ -38,7 +38,7 @@ export declare class SpecParser {
      * @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.
      */
-    generate(manifestPath: string, filter: string[], outputSpecPath: string, adaptiveCardFolder: string, signal?: AbortSignal): Promise<void>;
+    generate(manifestPath: string, filter: string[], outputSpecPath: string, adaptiveCardFolder: string, signal?: AbortSignal): Promise<GenerateResult>;
     private loadSpec;
     private getAllSupportedApi;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"specParser.d.ts","sourceRoot":"","sources":["../../../src/common/spec-parser/specParser.ts"],"names":[],"mappings":"AAKA,OAAO,aAAa,MAAM,6BAA6B,CAAC;AAGxD,OAAO,EAIL,cAAc,EAIf,MAAM,cAAc,CAAC;AAUtB;;GAEG;AACH,qBAAa,UAAU;IACrB,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,MAAM,EAAE,aAAa,CAAC;IAEtC,OAAO,CAAC,MAAM,CAA0D;IACxE,OAAO,CAAC,IAAI,CAAiC;IAC7C,OAAO,CAAC,aAAa,CAAiC;IAEtD;;;OAGG;gBACS,IAAI,EAAE,MAAM;IAKxB;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,cAAc,CAAC;IAuGzC;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAU/B;;;OAGG;IACG,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAqBtD;;;;;;OAMG;IACG,QAAQ,CACZ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,EAAE,EAChB,cAAc,EAAE,MAAM,EACtB,kBAAkB,EAAE,MAAM,EAC1B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,IAAI,CAAC;YAqDF,QAAQ;IAQtB,OAAO,CAAC,kBAAkB;CAqB3B"}
+{"version":3,"file":"specParser.d.ts","sourceRoot":"","sources":["../../../src/common/spec-parser/specParser.ts"],"names":[],"mappings":"AAKA,OAAO,aAAa,MAAM,6BAA6B,CAAC;AAGxD,OAAO,EAIL,cAAc,EACd,cAAc,EAIf,MAAM,cAAc,CAAC;AAUtB;;GAEG;AACH,qBAAa,UAAU;IACrB,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,MAAM,EAAE,aAAa,CAAC;IAEtC,OAAO,CAAC,MAAM,CAA0D;IACxE,OAAO,CAAC,IAAI,CAAiC;IAC7C,OAAO,CAAC,aAAa,CAAiC;IAEtD;;;OAGG;gBACS,IAAI,EAAE,MAAM;IAKxB;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,cAAc,CAAC;IA6FzC;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAU/B;;;OAGG;IACG,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAqBtD;;;;;;OAMG;IACG,QAAQ,CACZ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,EAAE,EAChB,cAAc,EAAE,MAAM,EACtB,kBAAkB,EAAE,MAAM,EAC1B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,cAAc,CAAC;YAwEZ,QAAQ;IAQtB,OAAO,CAAC,kBAAkB;CAqB3B"}

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

@@ -50,7 +50,7 @@ class SpecParser {
                     errors,
                 };
             }
-            // Spec version not supported
+            // TODO: we will support swagger 2.0
             if (!this.spec.openapi || this.spec.openapi < "3.0.0") {
                 errors.push({
                     type: interfaces_1.ErrorType.VersionNotSupported,
@@ -63,20 +63,9 @@ class SpecParser {
                     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,
-                    data: this.spec.servers,
-                });
-            }
+            // 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
@@ -175,7 +164,10 @@ class SpecParser {
      * @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, outputSpecPath, adaptiveCardFolder, signal) {
-        var _a;
+        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);
@@ -184,7 +176,7 @@ class SpecParser {
             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);
+            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);
@@ -197,17 +189,31 @@ class SpecParser {
                 throw new specParserError_1.SpecParserError(constants_1.ConstantString.CancelledMessage, interfaces_1.ErrorType.Cancelled);
             }
             const newSpec = (await this.parser.dereference(newUnResolvedSpec));
-            const updatedManifest = await manifestUpdater_1.updateManifest(manifestPath, outputSpecPath, adaptiveCardFolder, newSpec);
-            await fs_extra_1.default.outputJSON(manifestPath, updatedManifest, { spaces: 2 });
+            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);
             }
-            for (const url in newSpec.paths) {
-                const getOperation = (_a = newSpec.paths[url]) === null || _a === void 0 ? void 0 : _a.get;
-                const card = adaptiveCardGenerator_1.generateAdaptiveCard(getOperation);
-                const fileName = path_1.default.join(adaptiveCardFolder, `${getOperation.operationId}.json`);
-                await fs_extra_1.default.outputJSON(fileName, card, { spaces: 2 });
-            }
+            const updatedManifest = await manifestUpdater_1.updateManifest(manifestPath, outputSpecPath, adaptiveCardFolder, newSpec);
+            await fs_extra_1.default.outputJSON(manifestPath, updatedManifest, { spaces: 2 });
         }
         catch (err) {
             if (err instanceof specParserError_1.SpecParserError) {
@@ -215,6 +221,7 @@ class SpecParser {
             }
             throw new specParserError_1.SpecParserError(err.toString(), interfaces_1.ErrorType.GenerateFailed);
         }
+        return result;
     }
     async loadSpec() {
         if (!this.spec) {

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,6CAQsB;AACtB,2CAA6C;AAC7C,8DAA6B;AAC7B,gEAA0B;AAC1B,6CAA0C;AAC1C,mCAAiE;AACjE,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,6BAA6B;YAC7B,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,6BAA6B;YAC7B,IAAI,CAAC,IAAI,CAAC,IAAK,CAAC,OAAO,IAAI,IAAI,CAAC,IAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC1D,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,sBAAS,CAAC,mBAAmB;oBACnC,OAAO,EAAE,0BAAc,CAAC,mBAAmB;iBAC5C,CAAC,CAAC;aACJ;iBAAM,IAAI,IAAI,CAAC,IAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;gBACxC,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,sBAAS,CAAC,yBAAyB;oBACzC,OAAO,EAAE,0BAAc,CAAC,yBAAyB;oBACjD,IAAI,EAAE,IAAI,CAAC,IAAK,CAAC,OAAO;iBACzB,CAAC,CAAC;aACJ;YAED,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,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,CAAC,CAAC;YAClE,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,MAAM,eAAe,GAAG,MAAM,gCAAc,CAC1C,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,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,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE;gBAC/B,MAAM,YAAY,GAAG,MAAA,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,0CAAE,GAAG,CAAC;gBAC7C,MAAM,IAAI,GAAiB,4CAAoB,CAAC,YAAa,CAAC,CAAC;gBAC/D,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,YAAa,CAAC,WAAY,OAAO,CAAC,CAAC;gBACrF,MAAM,kBAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;aACpD;SACF;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;IACH,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;AApQD,gCAoQC"}
+{"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,eAAe,GAAG,MAAM,gCAAc,CAC1C,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;SACnE;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;AA7QD,gCA6QC"}

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

@@ -1,8 +1,28 @@
 import { OpenAPIV3 } from "openapi-types";
+import { ErrorResult } from "./interfaces";
 export declare function isYamlSpecFile(specPath: string): Promise<boolean>;
+export declare function checkRequiredParameters(paramObject: OpenAPIV3.ParameterObject[], limit?: number): boolean;
+export declare function isSupportedSchema(schema: OpenAPIV3.SchemaObject): boolean;
+/**
+ * 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 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

@@ -1 +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,wBAAsB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAiBvE;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,QAAQ,GAAG,OAAO,CAgC9F;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,CAiB3B;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAU3D"}
+{"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,WAAW,EAAa,MAAM,cAAc,CAAC;AAEtD,wBAAsB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAiBvE;AAED,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,SAAS,CAAC,eAAe,EAAE,EACxC,KAAK,SAAI,GACR,OAAO,CAgCT;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,SAAS,CAAC,YAAY,GAAG,OAAO,CA2BzE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,QAAQ,GAAG,OAAO,CAsC9F;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,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,YAAY,EAAE,GAAG,WAAW,EAAE,CAoB/E;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,GAAG,WAAW,EAAE,CA2CtE"}

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

@@ -2,12 +2,14 @@
 // Licensed under the MIT license.
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertPathToCamelCase = exports.getResponseJson = exports.getRelativePath = exports.updateFirstLetter = exports.isSupportedApi = exports.isYamlSpecFile = void 0;
+exports.validateServer = exports.checkServerUrl = exports.getUrlProtocol = exports.convertPathToCamelCase = exports.getResponseJson = exports.getRelativePath = exports.updateFirstLetter = exports.isSupportedApi = exports.isSupportedSchema = exports.checkRequiredParameters = exports.isYamlSpecFile = void 0;
 const tslib_1 = require("tslib");
 const axios_1 = tslib_1.__importDefault(require("axios"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const constants_1 = require("./constants");
 const path_1 = tslib_1.__importDefault(require("path"));
+const util = tslib_1.__importStar(require("util"));
+const interfaces_1 = require("./interfaces");
 async function isYamlSpecFile(specPath) {
     if (specPath.endsWith(".yaml") || specPath.endsWith(".yml")) {
         return true;
@@ -28,30 +30,104 @@ async function isYamlSpecFile(specPath) {
     }
 }
 exports.isYamlSpecFile = isYamlSpecFile;
+function checkRequiredParameters(paramObject, limit = 1) {
+    if (limit === 0 && !paramObject) {
+        return true;
+    }
+    let requiredParamCount = 0;
+    for (let i = 0; i < paramObject.length; i++) {
+        const param = paramObject[i];
+        if (param.in === "header" || param.in === "cookie") {
+            return false;
+        }
+        const schema = param.schema;
+        if (schema.type !== "boolean" &&
+            schema.type !== "string" &&
+            schema.type !== "number" &&
+            schema.type !== "integer") {
+            return false;
+        }
+        if (param.required && (param.in === "query" || param.in === "path")) {
+            requiredParamCount++;
+        }
+    }
+    if (requiredParamCount <= limit) {
+        return true;
+    }
+    return false;
+}
+exports.checkRequiredParameters = checkRequiredParameters;
+function isSupportedSchema(schema) {
+    // we support schema: {}
+    if (Object.keys(schema).length === 0) {
+        return true;
+    }
+    if (schema.type === "string" ||
+        schema.type === "integer" ||
+        schema.type === "boolean" ||
+        schema.type === "number") {
+        return true;
+    }
+    else if (schema.type === "array") {
+        return false;
+    }
+    else if (schema.type === "object") {
+        const { properties } = schema;
+        for (const property in properties) {
+            const result = isSupportedSchema(properties[property]);
+            if (!result) {
+                return false;
+            }
+        }
+        return true;
+    }
+    else {
+        return false;
+    }
+}
+exports.isSupportedSchema = isSupportedSchema;
+/**
+ * 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
+ */
 function isSupportedApi(method, path, spec) {
     var _a;
     const pathObj = spec.paths[path];
     method = method.toLocaleLowerCase();
     if (pathObj) {
-        if (method === constants_1.ConstantString.GetMethod && pathObj[method] && !((_a = pathObj[method]) === null || _a === void 0 ? void 0 : _a.security)) {
+        if ((method === constants_1.ConstantString.PostMethod || method === constants_1.ConstantString.GetMethod) &&
+            pathObj[method] &&
+            !((_a = pathObj[method]) === null || _a === void 0 ? void 0 : _a.security)) {
             const operationObject = pathObj[method];
             const paramObject = operationObject.parameters;
-            if (!paramObject || paramObject.length === 0) {
+            const requestBody = operationObject.requestBody;
+            const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
+            const parameterLimit = requestJsonBody ? 0 : 1;
+            const responseJson = getResponseJson(operationObject);
+            if (Object.keys(responseJson).length === 0) {
+                return false;
+            }
+            if ((!paramObject || paramObject.length === 0) && !requestBody) {
                 return true;
             }
-            if (paramObject && paramObject.length === 1) {
-                for (let i = 0; i < paramObject.length; i++) {
-                    const param = paramObject[i];
-                    if (param.in === "query" || param.in === "path") {
-                        const schema = param.schema;
-                        if (schema.type === "boolean" ||
-                            schema.type === "integer" ||
-                            schema.type === "number" ||
-                            schema.type === "string") {
-                            return true;
-                        }
-                    }
+            const valid = checkRequiredParameters(paramObject, parameterLimit);
+            if (valid) {
+                if (requestBody) {
+                    const schema = requestJsonBody.schema;
+                    const requestJsonBodySupported = isSupportedSchema(schema);
+                    return requestJsonBodySupported;
                 }
+                return true;
             }
         }
     }
@@ -68,10 +144,14 @@ function getRelativePath(from, to) {
 }
 exports.getRelativePath = getRelativePath;
 function getResponseJson(operationObject) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
-    let json = (_h = (_d = (_c = (_b = (_a = operationObject === null || operationObject === void 0 ? void 0 : operationObject.responses) === null || _a === void 0 ? void 0 : _a["200"]) === null || _b === void 0 ? void 0 : _b.content) === null || _c === void 0 ? void 0 : _c["application/json"]) !== null && _d !== void 0 ? _d : (_g = (_f = (_e = operationObject === null || operationObject === void 0 ? void 0 : operationObject.responses) === null || _e === void 0 ? void 0 : _e["201"]) === null || _f === void 0 ? void 0 : _f.content) === null || _g === void 0 ? void 0 : _g["application/json"]) !== null && _h !== void 0 ? _h : (_l = (_k = (_j = operationObject === null || operationObject === void 0 ? void 0 : operationObject.responses) === null || _j === void 0 ? void 0 : _j.default) === null || _k === void 0 ? void 0 : _k.content) === null || _l === void 0 ? void 0 : _l["application/json"];
-    if (!json) {
-        json = {};
+    var _a, _b;
+    let json = {};
+    for (const code of constants_1.ConstantString.ResponseCodeFor20X) {
+        const responseObject = (_a = operationObject === null || operationObject === void 0 ? void 0 : operationObject.responses) === null || _a === void 0 ? void 0 : _a[code];
+        if ((_b = responseObject === null || responseObject === void 0 ? void 0 : responseObject.content) === null || _b === void 0 ? void 0 : _b["application/json"]) {
+            json = responseObject.content["application/json"];
+            break;
+        }
     }
     return json;
 }
@@ -88,4 +168,75 @@ function convertPathToCamelCase(path) {
     return camelCasePath;
 }
 exports.convertPathToCamelCase = convertPathToCamelCase;
+function getUrlProtocol(urlString) {
+    try {
+        const url = new URL(urlString);
+        return url.protocol;
+    }
+    catch (err) {
+        return undefined;
+    }
+}
+exports.getUrlProtocol = getUrlProtocol;
+function checkServerUrl(servers) {
+    const errors = [];
+    const protocol = getUrlProtocol(servers[0].url);
+    if (!protocol) {
+        // Relative server url is not supported
+        errors.push({
+            type: interfaces_1.ErrorType.RelativeServerUrlNotSupported,
+            content: constants_1.ConstantString.RelativeServerUrlNotSupported,
+            data: servers,
+        });
+    }
+    else if (protocol !== "https:") {
+        // Http server url is not supported
+        errors.push({
+            type: interfaces_1.ErrorType.UrlProtocolNotSupported,
+            content: util.format(constants_1.ConstantString.UrlProtocolNotSupported, protocol),
+            data: servers,
+        });
+    }
+    return errors;
+}
+exports.checkServerUrl = checkServerUrl;
+function validateServer(spec) {
+    const errors = [];
+    let hasTopLevelServers = false;
+    let hasPathLevelServers = false;
+    let hasOperationLevelServers = false;
+    if (spec.servers && spec.servers.length >= 1) {
+        hasTopLevelServers = true;
+        // for multiple server, we only use the first url
+        const serverErrors = checkServerUrl(spec.servers);
+        errors.push(...serverErrors);
+    }
+    const paths = spec.paths;
+    for (const path in paths) {
+        const methods = paths[path];
+        if ((methods === null || methods === void 0 ? void 0 : methods.servers) && methods.servers.length >= 1) {
+            hasPathLevelServers = true;
+            const serverErrors = checkServerUrl(methods.servers);
+            errors.push(...serverErrors);
+        }
+        for (const method in methods) {
+            const operationObject = methods[method];
+            if (isSupportedApi(method, path, spec)) {
+                if ((operationObject === null || operationObject === void 0 ? void 0 : operationObject.servers) && operationObject.servers.length >= 1) {
+                    hasOperationLevelServers = true;
+                    const serverErrors = checkServerUrl(operationObject.servers);
+                    errors.push(...serverErrors);
+                }
+            }
+        }
+    }
+    if (!hasTopLevelServers && !hasPathLevelServers && !hasOperationLevelServers) {
+        errors.push({
+            type: interfaces_1.ErrorType.NoServerInformation,
+            content: constants_1.ConstantString.NoServerInformation,
+        });
+    }
+    return errors;
+}
+exports.validateServer = validateServer;
 //# sourceMappingURL=utils.js.map