@microsoft/teamsfx-core 2.0.6-alpha.ae74bd5cd.0 → 2.0.6-alpha.bb3771d20.0

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

@@ -1,26 +1,31 @@
 import SwaggerParser from "@apidevtools/swagger-parser";
-import { GenerateResult, ValidateResult } from "./interfaces";
+import { OpenAPIV3 } from "openapi-types";
+import { APIInfo, GenerateResult, ParseOptions, ValidateResult } from "./interfaces";
 /**
  * A class that parses an OpenAPI specification file and provides methods to validate, list, and generate artifacts.
  */
 export declare class SpecParser {
-    readonly specPath: string;
+    readonly pathOrSpec: string | OpenAPIV3.Document;
     readonly parser: SwaggerParser;
+    readonly options: ParseOptions;
     private apiMap;
     private spec;
     private unResolveSpec;
     private isSwaggerFile;
+    private defaultOptions;
     /**
      * Creates a new instance of the SpecParser class.
-     * @param path The URL or file path of the OpenAPI specification file. The OpenAPI specification file must have a version of 3.0 or higher.
+     * @param pathOrDoc The path to the OpenAPI specification file or the OpenAPI specification object.
+     * @param options The options for parsing the OpenAPI specification file.
      */
-    constructor(path: string);
+    constructor(pathOrDoc: string | OpenAPIV3.Document, options?: ParseOptions);
     /**
      * Validates the OpenAPI specification file and returns a validation result.
      *
      * @returns A validation result object that contains information about any errors or warnings in the specification file.
      */
     validate(): Promise<ValidateResult>;
+    listSupportedAPIInfo(): Promise<APIInfo[]>;
     /**
      * Lists all the OpenAPI operations in the specification file.
      * @returns A string array that represents the HTTP method and path of each operation, such as ['GET /pets/{petId}', 'GET /user/{userId}']
@@ -41,6 +46,6 @@ export declare class SpecParser {
      */
     generate(manifestPath: string, filter: string[], outputSpecPath: string, adaptiveCardFolder: string, signal?: AbortSignal): Promise<GenerateResult>;
     private loadSpec;
-    private getAllSupportedApi;
+    private getAllSupportedAPIs;
 }
 //# sourceMappingURL=specParser.d.ts.map

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;AAIxD,OAAO,EAIL,cAAc,EACd,cAAc,EAIf,MAAM,cAAc,CAAC;AAWtB;;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;IACtD,OAAO,CAAC,aAAa,CAAsB;IAE3C;;;OAGG;gBACS,IAAI,EAAE,MAAM;IAKxB;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,cAAc,CAAC;IAsFzC;;;;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;YA2EZ,QAAQ;IAetB,OAAO,CAAC,kBAAkB;CAqB3B"}
+{"version":3,"file":"specParser.d.ts","sourceRoot":"","sources":["../../../src/common/spec-parser/specParser.ts"],"names":[],"mappings":"AAIA,OAAO,aAAa,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAK1C,OAAO,EACL,OAAO,EAEP,cAAc,EACd,YAAY,EACZ,cAAc,EAGf,MAAM,cAAc,CAAC;AAStB;;GAEG;AACH,qBAAa,UAAU;IACrB,SAAgB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC;IACxD,SAAgB,MAAM,EAAE,aAAa,CAAC;IACtC,SAAgB,OAAO,EAAE,YAAY,CAAC;IAEtC,OAAO,CAAC,MAAM,CAA0D;IACxE,OAAO,CAAC,IAAI,CAAiC;IAC7C,OAAO,CAAC,aAAa,CAAiC;IACtD,OAAO,CAAC,aAAa,CAAsB;IAE3C,OAAO,CAAC,cAAc,CAGpB;IAEF;;;;OAIG;gBACS,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,YAAY;IAS1E;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,cAAc,CAAC;IA8BnC,oBAAoB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAIhD;;;;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;YAgFZ,QAAQ;IAetB,OAAO,CAAC,mBAAmB;CAU5B"}

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

@@ -4,19 +4,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SpecParser = void 0;
 const tslib_1 = require("tslib");
-const util = tslib_1.__importStar(require("util"));
 const swagger_parser_1 = tslib_1.__importDefault(require("@apidevtools/swagger-parser"));
-const specParserError_1 = require("./specParserError");
 const swagger2openapi_1 = tslib_1.__importDefault(require("swagger2openapi"));
-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 path_1 = tslib_1.__importDefault(require("path"));
+const interfaces_1 = require("./interfaces");
+const constants_1 = require("./constants");
+const specParserError_1 = require("./specParserError");
 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"));
 const adaptiveCardWrapper_1 = require("./adaptiveCardWrapper");
 /**
  * A class that parses an OpenAPI specification file and provides methods to validate, list, and generate artifacts.
@@ -24,11 +23,17 @@ const adaptiveCardWrapper_1 = require("./adaptiveCardWrapper");
 class SpecParser {
     /**
      * Creates a new instance of the SpecParser class.
-     * @param path The URL or file path of the OpenAPI specification file. The OpenAPI specification file must have a version of 3.0 or higher.
+     * @param pathOrDoc The path to the OpenAPI specification file or the OpenAPI specification object.
+     * @param options The options for parsing the OpenAPI specification file.
      */
-    constructor(path) {
-        this.specPath = path;
+    constructor(pathOrDoc, options) {
+        this.defaultOptions = {
+            allowMissingId: true,
+            allowSwagger: true,
+        };
+        this.pathOrSpec = pathOrDoc;
         this.parser = new swagger_parser_1.default();
+        this.options = Object.assign(Object.assign({}, this.defaultOptions), (options !== null && options !== void 0 ? options : {}));
     }
     /**
      * Validates the OpenAPI specification file and returns a validation result.
@@ -37,80 +42,36 @@ class SpecParser {
      */
     async validate() {
         try {
-            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,
+                    warnings: [],
+                    errors: [{ type: interfaces_1.ErrorType.SpecNotValid, content: e.toString() }],
                 };
             }
-            if (this.isSwaggerFile) {
-                warnings.push({
-                    type: interfaces_1.WarningType.ConvertSwaggerToOpenAPI,
-                    content: constants_1.ConstantString.ConvertSwaggerToOpenAPI,
-                });
-            }
-            // 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;
+            if (!this.options.allowSwagger && this.isSwaggerFile) {
+                return {
+                    status: interfaces_1.ValidationStatus.Error,
+                    warnings: [],
+                    errors: [
+                        { type: interfaces_1.ErrorType.SwaggerNotSupported, content: constants_1.ConstantString.SwaggerNotSupported },
+                    ],
+                };
             }
-            return {
-                status,
-                warnings,
-                errors,
-            };
+            return utils_1.validateSpec(this.spec, this.parser, !!this.isSwaggerFile);
         }
         catch (err) {
             throw new specParserError_1.SpecParserError(err.toString(), interfaces_1.ErrorType.ValidateFailed);
         }
     }
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async listSupportedAPIInfo() {
+        throw new Error("Method not implemented.");
+    }
     /**
      * Lists all the OpenAPI operations in the specification file.
      * @returns A string array that represents the HTTP method and path of each operation, such as ['GET /pets/{petId}', 'GET /user/{userId}']
@@ -119,7 +80,7 @@ class SpecParser {
     async list() {
         try {
             await this.loadSpec();
-            const apiMap = this.getAllSupportedApi(this.spec);
+            const apiMap = this.getAllSupportedAPIs(this.spec);
             return Array.from(Object.keys(apiMap));
         }
         catch (err) {
@@ -133,7 +94,7 @@ class SpecParser {
     async listOperationMap() {
         try {
             await this.loadSpec();
-            const apiMap = this.getAllSupportedApi(this.spec);
+            const apiMap = this.getAllSupportedAPIs(this.spec);
             const operationMap = new Map();
             for (const key in apiMap) {
                 const pathObjectItem = apiMap[key];
@@ -171,7 +132,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, this.spec);
+            const newUnResolvedSpec = specFilter_1.specFilter(filter, this.unResolveSpec, this.spec, this.options.allowMissingId);
             let resultStr;
             if (outputSpecPath.endsWith(".yaml") || outputSpecPath.endsWith(".yml")) {
                 resultStr = js_yaml_1.default.dump(newUnResolvedSpec);
@@ -222,7 +183,7 @@ class SpecParser {
     }
     async loadSpec() {
         if (!this.spec) {
-            this.unResolveSpec = (await this.parser.parse(this.specPath));
+            this.unResolveSpec = (await this.parser.parse(this.pathOrSpec));
             // Convert swagger 2.0 to openapi 3.0
             if (!this.unResolveSpec.openapi && this.unResolveSpec.swagger === "2.0") {
                 const specObj = await swagger2openapi_1.default.convert(this.unResolveSpec, {});
@@ -233,22 +194,11 @@ class SpecParser {
             this.spec = (await this.parser.dereference(clonedUnResolveSpec));
         }
     }
-    getAllSupportedApi(spec) {
+    getAllSupportedAPIs(spec) {
         if (this.apiMap !== undefined) {
             return this.apiMap;
         }
-        const paths = spec.paths;
-        const result = {};
-        for (const path in paths) {
-            const methods = paths[path];
-            for (const method in methods) {
-                // 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;
-                }
-            }
-        }
+        const result = utils_1.listSupportedAPIs(spec, this.options.allowMissingId);
         this.apiMap = result;
         return result;
     }

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,8EAAwC;AACxC,6CASsB;AACtB,2CAA6C;AAC7C,8DAA6B;AAC7B,gEAA0B;AAC1B,6CAA0C;AAC1C,mCAAiF;AACjF,uDAAmD;AACnD,mEAA+D;AAC/D,wDAAwB;AACxB,+DAAyD;AAEzD;;GAEG;AACH,MAAa,UAAU;IASrB;;;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,IAAI,IAAI,CAAC,aAAa,EAAE;gBACtB,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,wBAAW,CAAC,uBAAuB;oBACzC,OAAO,EAAE,0BAAc,CAAC,uBAAuB;iBAChD,CAAC,CAAC;aACJ;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,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,4CAAoB,CAAC,SAAS,CAAC,CAAC;4BACzD,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,SAAS,CAAC,WAAY,OAAO,CAAC,CAAC;4BACjF,MAAM,WAAW,GAAG,sCAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;4BACrD,MAAM,kBAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;yBAC3D;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,qCAAqC;YACrC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,IAAK,IAAI,CAAC,aAAqB,CAAC,OAAO,KAAK,KAAK,EAAE;gBAChF,MAAM,OAAO,GAAG,MAAM,yBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,aAAoB,EAAE,EAAE,CAAC,CAAC;gBACvE,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,OAA6B,CAAC;gBAC3D,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;aAC3B;YAED,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;AAjRD,gCAiRC"}
+{"version":3,"file":"specParser.js","sourceRoot":"","sources":["../../../src/common/spec-parser/specParser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,YAAY,CAAC;;;;AAEb,yFAAwD;AAExD,8EAAwC;AACxC,8DAA6B;AAC7B,gEAA0B;AAC1B,wDAAwB;AACxB,6CAQsB;AACtB,2CAA6C;AAC7C,uDAAoD;AACpD,6CAA0C;AAC1C,mCAAkF;AAClF,uDAAmD;AACnD,mEAA+D;AAC/D,+DAAyD;AAEzD;;GAEG;AACH,MAAa,UAAU;IAerB;;;;OAIG;IACH,YAAY,SAAsC,EAAE,OAAsB;QAVlE,mBAAc,GAAiB;YACrC,cAAc,EAAE,IAAI;YACpB,YAAY,EAAE,IAAI;SACnB,CAAC;QAQA,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAa,EAAE,CAAC;QAClC,IAAI,CAAC,OAAO,mCACP,IAAI,CAAC,cAAc,GACnB,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CACnB,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ;QACZ,IAAI;YACF,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,OAAO;oBACL,MAAM,EAAE,6BAAgB,CAAC,KAAK;oBAC9B,QAAQ,EAAE,EAAE;oBACZ,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,sBAAS,CAAC,YAAY,EAAE,OAAO,EAAG,CAAW,CAAC,QAAQ,EAAE,EAAE,CAAC;iBAC7E,CAAC;aACH;YAED,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC,aAAa,EAAE;gBACpD,OAAO;oBACL,MAAM,EAAE,6BAAgB,CAAC,KAAK;oBAC9B,QAAQ,EAAE,EAAE;oBACZ,MAAM,EAAE;wBACN,EAAE,IAAI,EAAE,sBAAS,CAAC,mBAAmB,EAAE,OAAO,EAAE,0BAAc,CAAC,mBAAmB,EAAE;qBACrF;iBACF,CAAC;aACH;YAED,OAAO,oBAAY,CAAC,IAAI,CAAC,IAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACpE;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,iCAAe,CAAE,GAAa,CAAC,QAAQ,EAAE,EAAE,sBAAS,CAAC,cAAc,CAAC,CAAC;SAChF;IACH,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,oBAAoB;QACxB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI;QACR,IAAI;YACF,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtB,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAK,CAAC,CAAC;YACpD,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,mBAAmB,CAAC,IAAI,CAAC,IAAK,CAAC,CAAC;YACpD,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,CAClC,MAAM,EACN,IAAI,CAAC,aAAc,EACnB,IAAI,CAAC,IAAK,EACV,IAAI,CAAC,OAAO,CAAC,cAAe,CAC7B,CAAC;YACF,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,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,4CAAoB,CAAC,SAAS,CAAC,CAAC;4BACzD,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,SAAS,CAAC,WAAY,OAAO,CAAC,CAAC;4BACjF,MAAM,WAAW,GAAG,sCAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;4BACrD,MAAM,kBAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;yBAC3D;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,UAAU,CAAC,CAAuB,CAAC;YACtF,qCAAqC;YACrC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,IAAK,IAAI,CAAC,aAAqB,CAAC,OAAO,KAAK,KAAK,EAAE;gBAChF,MAAM,OAAO,GAAG,MAAM,yBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,aAAoB,EAAE,EAAE,CAAC,CAAC;gBACvE,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,OAA6B,CAAC;gBAC3D,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;aAC3B;YAED,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,mBAAmB,CAAC,IAAwB;QAGlD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAC7B,OAAO,IAAI,CAAC,MAAM,CAAC;SACpB;QACD,MAAM,MAAM,GAAG,yBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,cAAe,CAAC,CAAC;QACrE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAlOD,gCAkOC"}

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

@@ -1,6 +1,7 @@
 import { OpenAPIV3 } from "openapi-types";
-import { CheckParamResult, ErrorResult } from "./interfaces";
-export declare function isYamlSpecFile(specPath: string): Promise<boolean>;
+import SwaggerParser from "@apidevtools/swagger-parser";
+import { CheckParamResult, ErrorResult, Parameter, ValidateResult, WarningResult } from "./interfaces";
+import { IMessagingExtensionCommand } from "@microsoft/teamsfx-api";
 export declare function checkParameters(paramObject: OpenAPIV3.ParameterObject[]): CheckParamResult;
 export declare function checkPostBody(schema: OpenAPIV3.SchemaObject, isRequired?: boolean): CheckParamResult;
 /**
@@ -17,14 +18,20 @@ export declare function checkPostBody(schema: OpenAPIV3.SchemaObject, isRequired
  * 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 isSupportedApi(method: string, path: string, spec: OpenAPIV3.Document, allowMissingId: boolean): 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[];
+export declare function validateServer(spec: OpenAPIV3.Document, allowMissingId: boolean): ErrorResult[];
 export declare function isWellKnownName(name: string, wellknownNameList: string[]): boolean;
+export declare function generateParametersFromSchema(schema: OpenAPIV3.SchemaObject, name: string, isRequired?: boolean): [Parameter[], Parameter[]];
+export declare function parseApiInfo(operationItem: OpenAPIV3.OperationObject): [IMessagingExtensionCommand, WarningResult | undefined];
+export declare function listSupportedAPIs(spec: OpenAPIV3.Document, allowMissingId: boolean): {
+    [key: string]: OpenAPIV3.OperationObject;
+};
+export declare function validateSpec(spec: OpenAPIV3.Document, parser: SwaggerParser, isSwaggerFile: boolean): ValidateResult;
+export declare function format(str: string, ...args: string[]): string;
 //# 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,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,CA6C1F;AAED,wBAAgB,aAAa,CAC3B,MAAM,EAAE,SAAS,CAAC,YAAY,EAC9B,UAAU,UAAQ,GACjB,gBAAgB,CA0ClB;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,CAQ3D;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;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,GAAG,OAAO,CAQlF"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/common/spec-parser/utils.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,aAAa,MAAM,6BAA6B,CAAC;AAExD,OAAO,EACL,gBAAgB,EAChB,WAAW,EAEX,SAAS,EACT,cAAc,EAEd,aAAa,EAEd,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AAEpE,wBAAgB,eAAe,CAAC,WAAW,EAAE,SAAS,CAAC,eAAe,EAAE,GAAG,gBAAgB,CA6C1F;AAED,wBAAgB,aAAa,CAC3B,MAAM,EAAE,SAAS,CAAC,YAAY,EAC9B,UAAU,UAAQ,GACjB,gBAAgB,CA0ClB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,SAAS,CAAC,QAAQ,EACxB,cAAc,EAAE,OAAO,GACtB,OAAO,CA6DT;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAErD;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,CAQ3D;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,CAkC/E;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,EAAE,cAAc,EAAE,OAAO,GAAG,WAAW,EAAE,CA2C/F;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,GAAG,OAAO,CAQlF;AAED,wBAAgB,4BAA4B,CAC1C,MAAM,EAAE,SAAS,CAAC,YAAY,EAC9B,IAAI,EAAE,MAAM,EACZ,UAAU,UAAQ,GACjB,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,CAAC,CAuC5B;AAED,wBAAgB,YAAY,CAC1B,aAAa,EAAE,SAAS,CAAC,eAAe,GACvC,CAAC,0BAA0B,EAAE,aAAa,GAAG,SAAS,CAAC,CAsEzD;AAED,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,SAAS,CAAC,QAAQ,EACxB,cAAc,EAAE,OAAO,GACtB;IACD,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC,eAAe,CAAC;CAC1C,CAcA;AAED,wBAAgB,YAAY,CAC1B,IAAI,EAAE,SAAS,CAAC,QAAQ,EACxB,MAAM,EAAE,aAAa,EACrB,aAAa,EAAE,OAAO,GACrB,cAAc,CAiEhB;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAM7D"}

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

@@ -2,35 +2,9 @@
 // Licensed under the MIT license.
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isWellKnownName = exports.validateServer = exports.checkServerUrl = exports.resolveServerUrl = exports.getUrlProtocol = exports.convertPathToCamelCase = exports.getResponseJson = exports.getRelativePath = exports.updateFirstLetter = exports.isSupportedApi = exports.checkPostBody = exports.checkParameters = 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"));
+exports.format = exports.validateSpec = exports.listSupportedAPIs = exports.parseApiInfo = exports.generateParametersFromSchema = exports.isWellKnownName = exports.validateServer = exports.checkServerUrl = exports.resolveServerUrl = exports.getUrlProtocol = exports.convertPathToCamelCase = exports.getResponseJson = exports.updateFirstLetter = exports.isSupportedApi = exports.checkPostBody = exports.checkParameters = void 0;
 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");
-const util_1 = require("util");
-async function isYamlSpecFile(specPath) {
-    if (specPath.endsWith(".yaml") || specPath.endsWith(".yml")) {
-        return true;
-    }
-    else if (specPath.endsWith(".json")) {
-        return false;
-    }
-    const isRemoteFile = specPath.startsWith("http:") || specPath.startsWith("https:");
-    const fileContent = isRemoteFile
-        ? (await axios_1.default.get(specPath)).data
-        : await fs_extra_1.default.readFile(specPath, "utf-8");
-    try {
-        JSON.parse(fileContent);
-        return false;
-    }
-    catch (error) {
-        return true;
-    }
-}
-exports.isYamlSpecFile = isYamlSpecFile;
 function checkParameters(paramObject) {
     const paramResult = {
         requiredNum: 0,
@@ -128,7 +102,7 @@ exports.checkPostBody = checkPostBody;
  * 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) {
+function isSupportedApi(method, path, spec, allowMissingId) {
     var _a;
     const pathObj = spec.paths[path];
     method = method.toLocaleLowerCase();
@@ -137,6 +111,9 @@ function isSupportedApi(method, path, spec) {
             pathObj[method] &&
             !((_a = pathObj[method]) === null || _a === void 0 ? void 0 : _a.security)) {
             const operationObject = pathObj[method];
+            if (!allowMissingId && !operationObject.operationId) {
+                return false;
+            }
             const paramObject = operationObject.parameters;
             const requestBody = operationObject.requestBody;
             const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
@@ -182,11 +159,6 @@ function updateFirstLetter(str) {
     return str.charAt(0).toUpperCase() + str.slice(1);
 }
 exports.updateFirstLetter = updateFirstLetter;
-function getRelativePath(from, to) {
-    const relativePath = path_1.default.relative(path_1.default.dirname(from), to);
-    return path_1.default.normalize(relativePath).replace(/\\/g, "/");
-}
-exports.getRelativePath = getRelativePath;
 function getResponseJson(operationObject) {
     var _a, _b;
     let json = {};
@@ -228,7 +200,7 @@ function resolveServerUrl(url) {
         const envVar = matches[1];
         const envVal = process.env[envVar];
         if (!envVal) {
-            throw new Error(util_1.format(constants_1.ConstantString.ResolveServerUrlFailed, envVar));
+            throw new Error(format(constants_1.ConstantString.ResolveServerUrlFailed, envVar));
         }
         else {
             newUrl = newUrl.replace(matches[0], envVal);
@@ -263,16 +235,17 @@ function checkServerUrl(servers) {
     }
     else if (protocol !== "https:") {
         // Http server url is not supported
+        const protocolString = protocol.slice(0, -1);
         errors.push({
             type: interfaces_1.ErrorType.UrlProtocolNotSupported,
-            content: util.format(constants_1.ConstantString.UrlProtocolNotSupported, protocol.slice(0, -1)),
-            data: servers,
+            content: format(constants_1.ConstantString.UrlProtocolNotSupported, protocol.slice(0, -1)),
+            data: protocolString,
         });
     }
     return errors;
 }
 exports.checkServerUrl = checkServerUrl;
-function validateServer(spec) {
+function validateServer(spec, allowMissingId) {
     const errors = [];
     let hasTopLevelServers = false;
     let hasPathLevelServers = false;
@@ -293,7 +266,7 @@ function validateServer(spec) {
         }
         for (const method in methods) {
             const operationObject = methods[method];
-            if (isSupportedApi(method, path, spec)) {
+            if (isSupportedApi(method, path, spec, allowMissingId)) {
                 if ((operationObject === null || operationObject === void 0 ? void 0 : operationObject.servers) && operationObject.servers.length >= 1) {
                     hasOperationLevelServers = true;
                     const serverErrors = checkServerUrl(operationObject.servers);
@@ -321,4 +294,183 @@ function isWellKnownName(name, wellknownNameList) {
     return false;
 }
 exports.isWellKnownName = isWellKnownName;
+function generateParametersFromSchema(schema, name, isRequired = false) {
+    var _a, _b;
+    const requiredParams = [];
+    const optionalParams = [];
+    if (schema.type === "string" ||
+        schema.type === "integer" ||
+        schema.type === "boolean" ||
+        schema.type === "number") {
+        const parameter = {
+            name: name,
+            title: updateFirstLetter(name).slice(0, constants_1.ConstantString.ParameterTitleMaxLens),
+            description: ((_a = schema.description) !== null && _a !== void 0 ? _a : "").slice(0, constants_1.ConstantString.ParameterDescriptionMaxLens),
+        };
+        if (isRequired && schema.default === undefined) {
+            requiredParams.push(parameter);
+        }
+        else {
+            optionalParams.push(parameter);
+        }
+    }
+    else if (schema.type === "object") {
+        const { properties } = schema;
+        for (const property in properties) {
+            let isRequired = false;
+            if (schema.required && ((_b = schema.required) === null || _b === void 0 ? void 0 : _b.indexOf(property)) >= 0) {
+                isRequired = true;
+            }
+            const [requiredP, optionalP] = generateParametersFromSchema(properties[property], property, isRequired);
+            requiredParams.push(...requiredP);
+            optionalParams.push(...optionalP);
+        }
+    }
+    return [requiredParams, optionalParams];
+}
+exports.generateParametersFromSchema = generateParametersFromSchema;
+function parseApiInfo(operationItem) {
+    var _a, _b;
+    const requiredParams = [];
+    const optionalParams = [];
+    const paramObject = operationItem.parameters;
+    if (paramObject) {
+        paramObject.forEach((param) => {
+            var _a;
+            const parameter = {
+                name: param.name,
+                title: updateFirstLetter(param.name).slice(0, constants_1.ConstantString.ParameterTitleMaxLens),
+                description: ((_a = param.description) !== null && _a !== void 0 ? _a : "").slice(0, constants_1.ConstantString.ParameterDescriptionMaxLens),
+            };
+            const schema = param.schema;
+            if (param.in !== "header" && param.in !== "cookie") {
+                if (param.required && (schema === null || schema === void 0 ? void 0 : schema.default) === undefined) {
+                    requiredParams.push(parameter);
+                }
+                else {
+                    optionalParams.push(parameter);
+                }
+            }
+        });
+    }
+    if (operationItem.requestBody) {
+        const requestBody = operationItem.requestBody;
+        const requestJson = requestBody.content["application/json"];
+        if (Object.keys(requestJson).length !== 0) {
+            const schema = requestJson.schema;
+            const [requiredP, optionalP] = generateParametersFromSchema(schema, "requestBody", requestBody.required);
+            requiredParams.push(...requiredP);
+            optionalParams.push(...optionalP);
+        }
+    }
+    const operationId = operationItem.operationId;
+    const parameters = [];
+    if (requiredParams.length != 0) {
+        parameters.push(...requiredParams);
+    }
+    else {
+        parameters.push(optionalParams[0]);
+    }
+    const command = {
+        context: ["compose"],
+        type: "query",
+        title: ((_a = operationItem.summary) !== null && _a !== void 0 ? _a : "").slice(0, constants_1.ConstantString.CommandTitleMaxLens),
+        id: operationId,
+        parameters: parameters,
+        description: ((_b = operationItem.description) !== null && _b !== void 0 ? _b : "").slice(0, constants_1.ConstantString.CommandDescriptionMaxLens),
+    };
+    let warning = undefined;
+    if (requiredParams.length === 0 && optionalParams.length > 1) {
+        warning = {
+            type: interfaces_1.WarningType.OperationOnlyContainsOptionalParam,
+            content: format(constants_1.ConstantString.OperationOnlyContainsOptionalParam, operationId),
+            data: operationId,
+        };
+    }
+    return [command, warning];
+}
+exports.parseApiInfo = parseApiInfo;
+function listSupportedAPIs(spec, allowMissingId) {
+    const paths = spec.paths;
+    const result = {};
+    for (const path in paths) {
+        const methods = paths[path];
+        for (const method in methods) {
+            // For developer preview, only support GET operation with only 1 parameter without auth
+            if (isSupportedApi(method, path, spec, allowMissingId)) {
+                const operationObject = methods[method];
+                result[`${method.toUpperCase()} ${path}`] = operationObject;
+            }
+        }
+    }
+    return result;
+}
+exports.listSupportedAPIs = listSupportedAPIs;
+function validateSpec(spec, parser, isSwaggerFile) {
+    const errors = [];
+    const warnings = [];
+    if (isSwaggerFile) {
+        warnings.push({
+            type: interfaces_1.WarningType.ConvertSwaggerToOpenAPI,
+            content: constants_1.ConstantString.ConvertSwaggerToOpenAPI,
+        });
+    }
+    // Server validation
+    const serverErrors = validateServer(spec, true);
+    errors.push(...serverErrors);
+    // Remote reference not supported
+    const refPaths = parser.$refs.paths();
+    // refPaths [0] is the current spec file path
+    if (refPaths.length > 1) {
+        errors.push({
+            type: interfaces_1.ErrorType.RemoteRefNotSupported,
+            content: format(constants_1.ConstantString.RemoteRefNotSupported, refPaths.join(", ")),
+            data: refPaths,
+        });
+    }
+    // No supported API
+    const apiMap = listSupportedAPIs(spec, true);
+    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: 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;
+    }
+    return {
+        status,
+        warnings,
+        errors,
+    };
+}
+exports.validateSpec = validateSpec;
+function format(str, ...args) {
+    let index = 0;
+    return str.replace(/%s/g, () => {
+        const arg = args[index++];
+        return arg !== undefined ? arg : "";
+    });
+}
+exports.format = format;
 //# sourceMappingURL=utils.js.map