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

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;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"}
+{"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,EAChC,cAAuB,EACvB,eAAwB,EACxB,uBAAgC,EAChC,WAAoB;IAEpB,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,IACE,CAAC,sBAAc,CACb,UAAU,EACV,IAAI,EACJ,YAAY,EACZ,cAAc,EACd,eAAe,EACf,uBAAuB,EACvB,WAAW,CACZ,EACD;gBACA,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;AApDD,gCAoDC"}

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

@@ -0,0 +1,46 @@
+import SwaggerParser from "@apidevtools/swagger-parser";
+import { OpenAPIV3 } from "openapi-types";
+import { APIInfo, GenerateResult, ParseOptions, ValidateResult, ListAPIResult } from "./interfaces";
+/**
+ * A class that parses an OpenAPI specification file and provides methods to validate, list, and generate artifacts.
+ */
+export declare class SpecParser {
+    readonly pathOrSpec: string | OpenAPIV3.Document;
+    readonly parser: SwaggerParser;
+    readonly options: Required<ParseOptions>;
+    private apiMap;
+    private spec;
+    private unResolveSpec;
+    private isSwaggerFile;
+    private defaultOptions;
+    /**
+     * Creates a new instance of the SpecParser class.
+     * @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(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}']
+     * according to copilot plugin spec, only list get and post method without auth
+     */
+    list(): Promise<ListAPIResult[]>;
+    /**
+     * Generates and update artifacts from the OpenAPI specification file. Generate Adaptive Cards, update Teams app manifest, and generate a new OpenAPI specification file.
+     * @param manifestPath A file path of the Teams app manifest file to update.
+     * @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
+     * @param 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<GenerateResult>;
+    private loadSpec;
+    private getAllSupportedAPIs;
+}
+//# sourceMappingURL=specParser.browser.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"specParser.browser.d.ts","sourceRoot":"","sources":["../../../src/common/spec-parser/specParser.browser.ts"],"names":[],"mappings":"AAIA,OAAO,aAAa,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EACL,OAAO,EAEP,cAAc,EACd,YAAY,EACZ,cAAc,EAGd,aAAa,EACd,MAAM,cAAc,CAAC;AAKtB;;GAEG;AACH,qBAAa,UAAU;IACrB,SAAgB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC;IACxD,SAAgB,MAAM,EAAE,aAAa,CAAC;IACtC,SAAgB,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;IAEhD,OAAO,CAAC,MAAM,CAA0D;IACxE,OAAO,CAAC,IAAI,CAAiC;IAC7C,OAAO,CAAC,aAAa,CAAiC;IACtD,OAAO,CAAC,aAAa,CAAsB;IAE3C,OAAO,CAAC,cAAc,CAMpB;IAEF;;;;OAIG;gBACS,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,YAAY;IAS1E;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,cAAc,CAAC;IAqCnC,oBAAoB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IA0ChD;;;;OAIG;IAEG,IAAI,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAItC;;;;;;OAMG;IAEG,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;YAIZ,QAAQ;IAYtB,OAAO,CAAC,mBAAmB;CAgB5B"}

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

@@ -0,0 +1,139 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpecParser = void 0;
+const tslib_1 = require("tslib");
+const swagger_parser_1 = tslib_1.__importDefault(require("@apidevtools/swagger-parser"));
+const interfaces_1 = require("./interfaces");
+const specParserError_1 = require("./specParserError");
+const utils_1 = require("./utils");
+const constants_1 = require("./constants");
+/**
+ * A class that parses an OpenAPI specification file and provides methods to validate, list, and generate artifacts.
+ */
+class SpecParser {
+    /**
+     * Creates a new instance of the SpecParser class.
+     * @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(pathOrDoc, options) {
+        this.defaultOptions = {
+            allowMissingId: false,
+            allowSwagger: false,
+            allowAPIKeyAuth: false,
+            allowMultipleParameters: false,
+            allowOauth2: false,
+        };
+        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.
+     *
+     * @returns A validation result object that contains information about any errors or warnings in the specification file.
+     */
+    async validate() {
+        try {
+            try {
+                await this.loadSpec();
+                await this.parser.validate(this.spec);
+            }
+            catch (e) {
+                return {
+                    status: interfaces_1.ValidationStatus.Error,
+                    warnings: [],
+                    errors: [{ type: interfaces_1.ErrorType.SpecNotValid, content: e.toString() }],
+                };
+            }
+            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 utils_1.validateSpec(this.spec, this.parser, !!this.isSwaggerFile, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2);
+        }
+        catch (err) {
+            throw new specParserError_1.SpecParserError(err.toString(), interfaces_1.ErrorType.ValidateFailed);
+        }
+    }
+    async listSupportedAPIInfo() {
+        try {
+            await this.loadSpec();
+            const apiMap = this.getAllSupportedAPIs(this.spec);
+            const apiInfos = [];
+            for (const key in apiMap) {
+                const pathObjectItem = apiMap[key];
+                const [method, path] = key.split(" ");
+                const operationId = pathObjectItem.operationId;
+                // In Browser environment, this api is by default not support api without operationId
+                if (!operationId) {
+                    continue;
+                }
+                const [command, warning] = utils_1.parseApiInfo(pathObjectItem, this.options.allowMultipleParameters);
+                const apiInfo = {
+                    method: method,
+                    path: path,
+                    title: command.title,
+                    id: operationId,
+                    parameters: command.parameters,
+                    description: command.description,
+                };
+                if (warning) {
+                    apiInfo.warning = warning;
+                }
+                apiInfos.push(apiInfo);
+            }
+            return apiInfos;
+        }
+        catch (err) {
+            throw new specParserError_1.SpecParserError(err.toString(), interfaces_1.ErrorType.listSupportedAPIInfoFailed);
+        }
+    }
+    /**
+     * 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}']
+     * according to copilot plugin spec, only list get and post method without auth
+     */
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async list() {
+        throw new Error("Method not implemented.");
+    }
+    /**
+     * Generates and update artifacts from the OpenAPI specification file. Generate Adaptive Cards, update Teams app manifest, and generate a new OpenAPI specification file.
+     * @param manifestPath A file path of the Teams app manifest file to update.
+     * @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
+     * @param 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.
+     */
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async generate(manifestPath, filter, outputSpecPath, adaptiveCardFolder, signal) {
+        throw new Error("Method not implemented.");
+    }
+    async loadSpec() {
+        if (!this.spec) {
+            this.unResolveSpec = (await this.parser.parse(this.pathOrSpec));
+            if (!this.unResolveSpec.openapi && this.unResolveSpec.swagger === "2.0") {
+                this.isSwaggerFile = true;
+            }
+            const clonedUnResolveSpec = JSON.parse(JSON.stringify(this.unResolveSpec));
+            this.spec = (await this.parser.dereference(clonedUnResolveSpec));
+        }
+    }
+    getAllSupportedAPIs(spec) {
+        if (this.apiMap !== undefined) {
+            return this.apiMap;
+        }
+        const result = utils_1.listSupportedAPIs(spec, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowAPIKeyAuth);
+        this.apiMap = result;
+        return result;
+    }
+}
+exports.SpecParser = SpecParser;
+//# sourceMappingURL=specParser.browser.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"specParser.browser.js","sourceRoot":"","sources":["../../../src/common/spec-parser/specParser.browser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,YAAY,CAAC;;;;AAEb,yFAAwD;AAExD,6CASsB;AACtB,uDAAoD;AACpD,mCAAwE;AACxE,2CAA6C;AAE7C;;GAEG;AACH,MAAa,UAAU;IAkBrB;;;;OAIG;IACH,YAAY,SAAsC,EAAE,OAAsB;QAblE,mBAAc,GAAiB;YACrC,cAAc,EAAE,KAAK;YACrB,YAAY,EAAE,KAAK;YACnB,eAAe,EAAE,KAAK;YACtB,uBAAuB,EAAE,KAAK;YAC9B,WAAW,EAAE,KAAK;SACnB,CAAC;QAQA,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAa,EAAE,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,gCACV,IAAI,CAAC,cAAc,GACnB,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CACO,CAAC;IAC9B,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,CACjB,IAAI,CAAC,IAAK,EACV,IAAI,CAAC,MAAM,EACX,CAAC,CAAC,IAAI,CAAC,aAAa,EACpB,IAAI,CAAC,OAAO,CAAC,cAAc,EAC3B,IAAI,CAAC,OAAO,CAAC,eAAe,EAC5B,IAAI,CAAC,OAAO,CAAC,uBAAuB,EACpC,IAAI,CAAC,OAAO,CAAC,WAAW,CACzB,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,KAAK,CAAC,oBAAoB;QACxB,IAAI;YACF,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtB,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAK,CAAC,CAAC;YACpD,MAAM,QAAQ,GAAc,EAAE,CAAC;YAC/B,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;gBACxB,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBACnC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACtC,MAAM,WAAW,GAAG,cAAc,CAAC,WAAW,CAAC;gBAE/C,qFAAqF;gBACrF,IAAI,CAAC,WAAW,EAAE;oBAChB,SAAS;iBACV;gBAED,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,oBAAY,CACrC,cAAc,EACd,IAAI,CAAC,OAAO,CAAC,uBAAuB,CACrC,CAAC;gBAEF,MAAM,OAAO,GAAY;oBACvB,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,EAAE,EAAE,WAAW;oBACf,UAAU,EAAE,OAAO,CAAC,UAA0B;oBAC9C,WAAW,EAAE,OAAO,CAAC,WAAY;iBAClC,CAAC;gBAEF,IAAI,OAAO,EAAE;oBACX,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;iBAC3B;gBAED,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACxB;YAED,OAAO,QAAQ,CAAC;SACjB;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,iCAAe,CAAE,GAAa,CAAC,QAAQ,EAAE,EAAE,sBAAS,CAAC,0BAA0B,CAAC,CAAC;SAC5F;IACH,CAAC;IAED;;;;OAIG;IACH,4DAA4D;IAC5D,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACH,4DAA4D;IAC5D,KAAK,CAAC,QAAQ,CACZ,YAAoB,EACpB,MAAgB,EAChB,cAAsB,EACtB,kBAA0B,EAC1B,MAAoB;QAEpB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,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,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,IAAK,IAAI,CAAC,aAAqB,CAAC,OAAO,KAAK,KAAK,EAAE;gBAChF,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,CAC9B,IAAI,EACJ,IAAI,CAAC,OAAO,CAAC,cAAc,EAC3B,IAAI,CAAC,OAAO,CAAC,eAAe,EAC5B,IAAI,CAAC,OAAO,CAAC,uBAAuB,EACpC,IAAI,CAAC,OAAO,CAAC,eAAe,CAC7B,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA5KD,gCA4KC"}

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

@@ -1,37 +1,37 @@
 import SwaggerParser from "@apidevtools/swagger-parser";
-import { GenerateResult, ValidateResult } from "./interfaces";
+import { OpenAPIV3 } from "openapi-types";
+import { APIInfo, GenerateResult, ListAPIResult, 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: Required<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}']
      * according to copilot plugin spec, only list get and post method without auth
      */
-    list(): Promise<string[]>;
-    /**
-     * List all the OpenAPI operations in the specification file and return a map of operationId and operation path.
-     * @returns A map of operationId and operation path, such as [{'getPetById': 'GET /pets/{petId}'}, {'getUser': 'GET /user/{userId}'}]
-     */
-    listOperationMap(): Promise<Map<string, string>>;
+    list(): Promise<ListAPIResult[]>;
     /**
      * Generates and update artifacts from the OpenAPI specification file. Generate Adaptive Cards, update Teams app manifest, and generate a new OpenAPI specification file.
      * @param manifestPath A file path of the Teams app manifest file to update.
@@ -41,6 +41,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,aAAa,EACb,YAAY,EACZ,cAAc,EAGf,MAAM,cAAc,CAAC;AAetB;;GAEG;AACH,qBAAa,UAAU;IACrB,SAAgB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC;IACxD,SAAgB,MAAM,EAAE,aAAa,CAAC;IACtC,SAAgB,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;IAEhD,OAAO,CAAC,MAAM,CAA0D;IACxE,OAAO,CAAC,IAAI,CAAiC;IAC7C,OAAO,CAAC,aAAa,CAAiC;IACtD,OAAO,CAAC,aAAa,CAAsB;IAE3C,OAAO,CAAC,cAAc,CAMpB;IAEF;;;;OAIG;gBACS,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,YAAY;IAS1E;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,cAAc,CAAC;IAsCnC,oBAAoB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAIhD;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAwDtC;;;;;;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;YAuHZ,QAAQ;IAetB,OAAO,CAAC,mBAAmB;CAgB5B"}

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,20 @@ 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,
+            allowAPIKeyAuth: false,
+            allowMultipleParameters: false,
+            allowOauth2: false,
+        };
+        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,118 +45,86 @@ 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, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2);
         }
         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}']
      * according to copilot plugin spec, only list get and post method without auth
      */
     async list() {
+        var _a;
         try {
             await this.loadSpec();
-            const apiMap = this.getAllSupportedApi(this.spec);
-            return Array.from(Object.keys(apiMap));
-        }
-        catch (err) {
-            throw new specParserError_1.SpecParserError(err.toString(), interfaces_1.ErrorType.ListFailed);
-        }
-    }
-    /**
-     * List all the OpenAPI operations in the specification file and return a map of operationId and operation path.
-     * @returns A map of operationId and operation path, such as [{'getPetById': 'GET /pets/{petId}'}, {'getUser': 'GET /user/{userId}'}]
-     */
-    async listOperationMap() {
-        try {
-            await this.loadSpec();
-            const apiMap = this.getAllSupportedApi(this.spec);
-            const operationMap = new Map();
-            for (const key in apiMap) {
-                const pathObjectItem = apiMap[key];
-                let operationId = pathObjectItem.operationId;
+            const spec = this.spec;
+            const apiMap = this.getAllSupportedAPIs(spec);
+            const result = [];
+            for (const apiKey in apiMap) {
+                const apiResult = {
+                    api: "",
+                    server: "",
+                    operationId: "",
+                };
+                const [method, path] = apiKey.split(" ");
+                const operation = apiMap[apiKey];
+                const rootServer = spec.servers && spec.servers[0];
+                const methodServer = spec.paths[path].servers && ((_a = spec.paths[path]) === null || _a === void 0 ? void 0 : _a.servers[0]);
+                const operationServer = operation.servers && operation.servers[0];
+                const serverUrl = operationServer || methodServer || rootServer;
+                if (!serverUrl) {
+                    throw new specParserError_1.SpecParserError(constants_1.ConstantString.NoServerInformation, interfaces_1.ErrorType.NoServerInformation);
+                }
+                apiResult.server = utils_1.resolveServerUrl(serverUrl.url);
+                let operationId = operation.operationId;
                 if (!operationId) {
-                    const [method, path] = key.split(" ");
-                    const methodName = method.toLowerCase();
-                    operationId = `${methodName}${utils_1.convertPathToCamelCase(path)}`;
+                    operationId = `${method.toLowerCase()}${utils_1.convertPathToCamelCase(path)}`;
                 }
-                operationMap.set(operationId, key);
+                apiResult.operationId = operationId;
+                const authArray = utils_1.getAuthArray(operation.security, spec);
+                for (const auths of authArray) {
+                    if (auths.length === 1) {
+                        apiResult.auth = auths[0].authSchema;
+                        break;
+                    }
+                }
+                apiResult.api = apiKey;
+                result.push(apiResult);
             }
-            return operationMap;
+            return result;
         }
         catch (err) {
-            throw new specParserError_1.SpecParserError(err.toString(), interfaces_1.ErrorType.ListOperationMapFailed);
+            if (err instanceof specParserError_1.SpecParserError) {
+                throw err;
+            }
+            throw new specParserError_1.SpecParserError(err.toString(), interfaces_1.ErrorType.ListFailed);
         }
     }
     /**
@@ -171,7 +147,29 @@ 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, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2);
+            if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+                throw new specParserError_1.SpecParserError(constants_1.ConstantString.CancelledMessage, interfaces_1.ErrorType.Cancelled);
+            }
+            const newSpec = (await this.parser.dereference(newUnResolvedSpec));
+            const AuthSet = new Set();
+            let hasMultipleAPIKeyAuth = false;
+            for (const url in newSpec.paths) {
+                for (const method in newSpec.paths[url]) {
+                    const operation = newSpec.paths[url][method];
+                    const authArray = utils_1.getAuthArray(operation.security, newSpec);
+                    if (authArray && authArray.length > 0) {
+                        AuthSet.add(authArray[0][0].authSchema);
+                        if (AuthSet.size > 1) {
+                            hasMultipleAPIKeyAuth = true;
+                            break;
+                        }
+                    }
+                }
+            }
+            if (hasMultipleAPIKeyAuth) {
+                throw new specParserError_1.SpecParserError(constants_1.ConstantString.MultipleAPIKeyNotSupported, interfaces_1.ErrorType.MultipleAPIKeyNotSupported);
+            }
             let resultStr;
             if (outputSpecPath.endsWith(".yaml") || outputSpecPath.endsWith(".yml")) {
                 resultStr = js_yaml_1.default.dump(newUnResolvedSpec);
@@ -180,19 +178,18 @@ class SpecParser {
                 resultStr = JSON.stringify(newUnResolvedSpec, null, 2);
             }
             await fs_extra_1.default.outputFile(outputSpecPath, resultStr);
-            if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
-                throw new specParserError_1.SpecParserError(constants_1.ConstantString.CancelledMessage, interfaces_1.ErrorType.Cancelled);
-            }
-            const newSpec = (await this.parser.dereference(newUnResolvedSpec));
             for (const url in newSpec.paths) {
                 for (const method in newSpec.paths[url]) {
-                    if (method === constants_1.ConstantString.GetMethod || method === constants_1.ConstantString.PostMethod) {
+                    // paths object may contain description/summary, so we need to check if it is a operation object
+                    if (method === constants_1.ConstantString.PostMethod || method === constants_1.ConstantString.GetMethod) {
                         const operation = newSpec.paths[url][method];
                         try {
                             const [card, jsonPath] = adaptiveCardGenerator_1.generateAdaptiveCard(operation);
                             const fileName = path_1.default.join(adaptiveCardFolder, `${operation.operationId}.json`);
                             const wrappedCard = adaptiveCardWrapper_1.wrapAdaptiveCard(card, jsonPath);
                             await fs_extra_1.default.outputJSON(fileName, wrappedCard, { spaces: 2 });
+                            const dataFileName = path_1.default.join(adaptiveCardFolder, `${operation.operationId}.data.json`);
+                            await fs_extra_1.default.outputJSON(dataFileName, {}, { spaces: 2 });
                         }
                         catch (err) {
                             result.allSuccess = false;
@@ -208,7 +205,8 @@ 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 [updatedManifest, warnings] = await manifestUpdater_1.updateManifest(manifestPath, outputSpecPath, adaptiveCardFolder, newSpec);
+            const auth = Array.from(AuthSet)[0];
+            const [updatedManifest, warnings] = await manifestUpdater_1.updateManifest(manifestPath, outputSpecPath, adaptiveCardFolder, newSpec, this.options.allowMultipleParameters, auth);
             await fs_extra_1.default.outputJSON(manifestPath, updatedManifest, { spaces: 2 });
             result.warnings.push(...warnings);
         }
@@ -222,7 +220,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 +231,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.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2);
         this.apiMap = result;
         return result;
     }