@microsoft/teamsfx-core 2.0.5 → 2.0.6-alpha.1e1beaa82.0

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

@@ -2,73 +2,158 @@
 // 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");
+const util_1 = require("util");
 async function updateManifest(manifestPath, outputSpecPath, adaptiveCardFolder, spec) {
     var _a;
-    // 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 ComposeExtension = {
-        type: "apiBased",
-        apiSpecFile: utils_1.getRelativePath(manifestPath, outputSpecPath),
-        commands: commands,
-        supportsConversationalAI: true,
-    };
-    const updatedPart = {
-        description: {
-            short: spec.info.title,
-            full: (_a = spec.info.description) !== null && _a !== void 0 ? _a : originalManifest.description.full,
-        },
-        composeExtensions: [ComposeExtension],
-    };
-    const updatedManifest = Object.assign(Object.assign({}, originalManifest), updatedPart);
-    return updatedManifest;
+    try {
+        // TODO: manifest interface can be updated when manifest parser library is ready
+        const originalManifest = await fs_extra_1.default.readJSON(manifestPath);
+        const [commands, warnings] = await generateCommands(spec, adaptiveCardFolder, manifestPath);
+        const ComposeExtension = {
+            composeExtensionType: "apiBased",
+            apiSpecificationFile: utils_1.getRelativePath(manifestPath, outputSpecPath),
+            commands: commands,
+        };
+        const updatedPart = {
+            description: {
+                short: spec.info.title,
+                full: (_a = spec.info.description) !== null && _a !== void 0 ? _a : originalManifest.description.full,
+            },
+            composeExtensions: [ComposeExtension],
+        };
+        const updatedManifest = Object.assign(Object.assign({}, originalManifest), updatedPart);
+        return [updatedManifest, warnings];
+    }
+    catch (err) {
+        throw new specParserError_1.SpecParserError(err.toString(), interfaces_1.ErrorType.UpdateManifestFailed);
+    }
 }
 exports.updateManifest = updateManifest;
-function generateCommands(spec, adaptiveCardFolder, manifestPath) {
-    var _a;
+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: utils_1.updateFirstLetter(name),
+            description: (_a = schema.description) !== null && _a !== void 0 ? _a : "",
+        };
+        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;
+async function generateCommands(spec, adaptiveCardFolder, manifestPath) {
+    var _a, _b;
     const paths = spec.paths;
     const commands = [];
+    const warnings = [];
     if (paths) {
         for (const pathUrl in paths) {
             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 requiredParams = [];
+                            const optionalParams = [];
+                            const paramObject = operationItem.parameters;
+                            if (paramObject) {
+                                paramObject.forEach((param) => {
+                                    var _a;
+                                    const parameter = {
+                                        name: param.name,
+                                        title: utils_1.updateFirstLetter(param.name),
+                                        description: (_a = param.description) !== null && _a !== void 0 ? _a : "",
+                                    };
+                                    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 adaptiveCardPath = path_1.default.join(adaptiveCardFolder, operationId + ".json");
+                            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 : "",
+                                id: operationId,
+                                parameters: parameters,
+                                description: (_b = operationItem.description) !== null && _b !== void 0 ? _b : "",
+                                apiResponseRenderingTemplateFile: (await fs_extra_1.default.pathExists(adaptiveCardPath))
+                                    ? utils_1.getRelativePath(manifestPath, adaptiveCardPath)
+                                    : "",
+                            };
+                            commands.push(command);
+                            if (requiredParams.length === 0 && optionalParams.length > 1) {
+                                warnings.push({
+                                    type: interfaces_1.WarningType.OperationOnlyContainsOptionalParam,
+                                    content: util_1.format(constants_1.ConstantString.OperationOnlyContainsOptionalParam, operationId),
+                                    data: operationId,
+                                });
+                            }
+                        }
                     }
-                    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);
                 }
             }
         }
     }
-    return commands;
+    return [commands, warnings];
 }
 exports.generateCommands = generateCommands;
 //# sourceMappingURL=manifestUpdater.js.map

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;;;;AAIb,gEAA0B;AAC1B,wDAAwB;AACxB,mCAA6D;AAEtD,KAAK,UAAU,cAAc,CAClC,YAAoB,EACpB,cAAsB,EACtB,kBAA0B,EAC1B,IAAwB;;IAExB,gFAAgF;IAChF,MAAM,gBAAgB,GAAoB,MAAM,kBAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAE1E,MAAM,QAAQ,GAAG,gBAAgB,CAAC,IAAI,EAAE,kBAAkB,EAAE,YAAY,CAAC,CAAC;IAC1E,MAAM,gBAAgB,GAAqB;QACzC,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE,uBAAe,CAAC,YAAY,EAAE,cAAc,CAAC;QAC1D,QAAQ,EAAE,QAAQ;QAClB,wBAAwB,EAAE,IAAI;KAC/B,CAAC;IAEF,MAAM,WAAW,GAAoB;QACnC,WAAW,EAAE;YACX,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;YACtB,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,CAAC,WAAW,mCAAI,gBAAgB,CAAC,WAAW,CAAC,IAAI;SACjE;QACD,iBAAiB,EAAE,CAAC,gBAAgB,CAAC;KACtC,CAAC;IAEF,MAAM,eAAe,mCAAQ,gBAAgB,GAAK,WAAW,CAAE,CAAC;IAEhE,OAAO,eAAe,CAAC;AACzB,CAAC;AA5BD,wCA4BC;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,6CAAgF;AAChF,gEAA0B;AAC1B,wDAAwB;AACxB,mCAA6D;AAC7D,uDAAoD;AACpD,2CAA6C;AAC7C,+BAA8B;AAMvB,KAAK,UAAU,cAAc,CAClC,YAAoB,EACpB,cAAsB,EACtB,kBAA0B,EAC1B,IAAwB;;IAExB,IAAI;QACF,gFAAgF;QAChF,MAAM,gBAAgB,GAAqB,MAAM,kBAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAE3E,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,kBAAkB,EAAE,YAAY,CAAC,CAAC;QAC5F,MAAM,gBAAgB,GAAsB;YAC1C,oBAAoB,EAAE,UAAU;YAChC,oBAAoB,EAAE,uBAAe,CAAC,YAAY,EAAE,cAAc,CAAC;YACnE,QAAQ,EAAE,QAAQ;SACnB,CAAC;QAEF,MAAM,WAAW,GAAG;YAClB,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,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;KACpC;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,EACZ,UAAU,GAAG,KAAK;;IAElB,MAAM,cAAc,GAAgB,EAAE,CAAC;IACvC,MAAM,cAAc,GAAgB,EAAE,CAAC;IAEvC,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,MAAM,SAAS,GAAG;YAChB,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,yBAAiB,CAAC,IAAI,CAAC;YAC9B,WAAW,EAAE,MAAA,MAAM,CAAC,WAAW,mCAAI,EAAE;SACtC,CAAC;QACF,IAAI,UAAU,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE;YAC9C,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAChC;aAAM;YACL,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAChC;KACF;SAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE;QACnC,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE;YACjC,IAAI,UAAU,GAAG,KAAK,CAAC;YACvB,IAAI,MAAM,CAAC,QAAQ,IAAI,CAAA,MAAA,MAAM,CAAC,QAAQ,0CAAE,OAAO,CAAC,QAAQ,CAAC,KAAI,CAAC,EAAE;gBAC9D,UAAU,GAAG,IAAI,CAAC;aACnB;YACD,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,4BAA4B,CACzD,UAAU,CAAC,QAAQ,CAA2B,EAC9C,QAAQ,EACR,UAAU,CACX,CAAC;YAEF,cAAc,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;YAClC,cAAc,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;SACnC;KACF;IAED,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;AAC1C,CAAC;AA3CD,oEA2CC;AAEM,KAAK,UAAU,gBAAgB,CACpC,IAAwB,EACxB,kBAA0B,EAC1B,YAAoB;;IAEpB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACzB,MAAM,QAAQ,GAAiC,EAAE,CAAC;IAClD,MAAM,QAAQ,GAAoB,EAAE,CAAC;IACrC,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,cAAc,GAAgB,EAAE,CAAC;4BACvC,MAAM,cAAc,GAAgB,EAAE,CAAC;4BACvC,MAAM,WAAW,GAAG,aAAa,CAAC,UAAyC,CAAC;4BAE5E,IAAI,WAAW,EAAE;gCACf,WAAW,CAAC,OAAO,CAAC,CAAC,KAAgC,EAAE,EAAE;;oCACvD,MAAM,SAAS,GAAc;wCAC3B,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;oCAEF,MAAM,MAAM,GAAG,KAAK,CAAC,MAAgC,CAAC;oCACtD,IAAI,KAAK,CAAC,EAAE,KAAK,QAAQ,IAAI,KAAK,CAAC,EAAE,KAAK,QAAQ,EAAE;wCAClD,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,MAAK,SAAS,EAAE;4CACnD,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;yCAChC;6CAAM;4CACL,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;yCAChC;qCACF;gCACH,CAAC,CAAC,CAAC;6BACJ;4BAED,IAAI,aAAa,CAAC,WAAW,EAAE;gCAC7B,MAAM,WAAW,GAAG,aAAa,CAAC,WAA0C,CAAC;gCAC7E,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;gCAC5D,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;oCACzC,MAAM,MAAM,GAAG,WAAW,CAAC,MAAgC,CAAC;oCAC5D,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,4BAA4B,CACzD,MAAM,EACN,aAAa,EACb,WAAW,CAAC,QAAQ,CACrB,CAAC;oCACF,cAAc,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;oCAClC,cAAc,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;iCACnC;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,UAAU,GAAG,EAAE,CAAC;4BAEtB,IAAI,cAAc,CAAC,MAAM,IAAI,CAAC,EAAE;gCAC9B,UAAU,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;6BACpC;iCAAM;gCACL,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;6BACpC;4BAED,MAAM,OAAO,GAA+B;gCAC1C,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,WAAW,EAAE,MAAA,aAAa,CAAC,WAAW,mCAAI,EAAE;gCAC5C,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;4BAEvB,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;gCAC5D,QAAQ,CAAC,IAAI,CAAC;oCACZ,IAAI,EAAE,wBAAW,CAAC,kCAAkC;oCACpD,OAAO,EAAE,aAAM,CAAC,0BAAc,CAAC,kCAAkC,EAAE,WAAW,CAAC;oCAC/E,IAAI,EAAE,WAAW;iCAClB,CAAC,CAAC;6BACJ;yBACF;qBACF;iBACF;aACF;SACF;KACF;IAED,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAC9B,CAAC;AAjGD,4CAiGC"}

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;AAK1C,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EAAE,EAChB,aAAa,EAAE,SAAS,CAAC,QAAQ,GAChC,SAAS,CAAC,QAAQ,CA8BpB"}
+{"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

@@ -4,44 +4,37 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.specFilter = void 0;
 const utils_1 = require("./utils");
-const allMethodNames = ["get", "post", "put", "delete", "patch", "head", "options", "trace"];
-function specFilter(filter, unResolveSpec) {
-    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)) {
-            continue;
-        }
-        if (!newPaths[path]) {
-            newPaths[path] = Object.assign({}, unResolveSpec.paths[path]);
-            for (const m of allMethodNames) {
-                delete newPaths[path][m];
+const specParserError_1 = require("./specParserError");
+const interfaces_1 = require("./interfaces");
+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, resolvedSpec)) {
+                continue;
+            }
+            if (!newPaths[path]) {
+                newPaths[path] = Object.assign({}, unResolveSpec.paths[path]);
+                for (const m of constants_1.ConstantString.AllOperationMethods) {
+                    delete newPaths[path][m];
+                }
+            }
+            newPaths[path][methodName] = unResolveSpec.paths[path][methodName];
+            // Add the operationId if missing
+            if (!newPaths[path][methodName].operationId) {
+                newPaths[path][methodName].operationId = `${methodName}${utils_1.convertPathToCamelCase(path)}`;
             }
         }
-        newPaths[path][methodName] = unResolveSpec.paths[path][methodName];
-        // Add the operationId if missing
-        if (!newPaths[path][methodName].operationId) {
-            newPaths[path][methodName].operationId = `${methodName}${convertPathToCamelCase(path)}`;
-        }
+        newSpec.paths = newPaths;
+        return newSpec;
+    }
+    catch (err) {
+        throw new specParserError_1.SpecParserError(err.toString(), interfaces_1.ErrorType.FilterSpecFailed);
     }
-    newSpec.paths = newPaths;
-    return newSpec;
 }
 exports.specFilter = specFilter;
-function convertPathToCamelCase(path) {
-    const pathSegments = path.split("/");
-    const camelCaseSegments = pathSegments.map((segment) => {
-        if (segment.startsWith("{")) {
-            const name = segment.substring(1, segment.length - 1);
-            return name.charAt(0).toUpperCase() + name.slice(1);
-        }
-        else {
-            return segment;
-        }
-    });
-    const camelCasePath = camelCaseSegments.join("");
-    return camelCasePath.charAt(0).toUpperCase() + camelCasePath.slice(1);
-}
 //# sourceMappingURL=specFilter.js.map

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,mCAAyC;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,MAAM,OAAO,qBAAQ,aAAa,CAAE,CAAC;IACrC,MAAM,QAAQ,GAA0B,EAAE,CAAC;IAC3C,KAAK,MAAM,UAAU,IAAI,MAAM,EAAE;QAC/B,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7C,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;QAExC,IAAI,CAAC,sBAAc,CAAC,UAAU,EAAE,IAAI,EAAE,aAAa,CAAC,EAAE;YACpD,SAAS;SACV;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACnB,QAAQ,CAAC,IAAI,CAAC,qBAAQ,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAE,CAAC;YAClD,KAAK,MAAM,CAAC,IAAI,cAAc,EAAE;gBAC9B,OAAQ,QAAQ,CAAC,IAAI,CAAS,CAAC,CAAC,CAAC,CAAC;aACnC;SACF;QAEA,QAAQ,CAAC,IAAI,CAAS,CAAC,UAAU,CAAC,GAAI,aAAa,CAAC,KAAK,CAAC,IAAI,CAAS,CAAC,UAAU,CAAC,CAAC;QAErF,iCAAiC;QACjC,IAAI,CAAE,QAAQ,CAAC,IAAI,CAAS,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE;YACnD,QAAQ,CAAC,IAAI,CAAS,CAAC,UAAU,CAAC,CAAC,WAAW,GAAG,GAAG,UAAU,GAAG,sBAAsB,CACtF,IAAI,CACL,EAAE,CAAC;SACL;KACF;IAED,OAAO,CAAC,KAAK,GAAG,QAAQ,CAAC;IACzB,OAAO,OAAO,CAAC;AACjB,CAAC;AAjCD,gCAiCC;AAED,SAAS,sBAAsB,CAAC,IAAY;IAC1C,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACrC,MAAM,iBAAiB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QACrD,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACrD;aAAM;YACL,OAAO,OAAO,CAAC;SAChB;IACH,CAAC,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjD,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACxE,CAAC"}
+{"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.
  */
@@ -9,6 +9,7 @@ export declare class SpecParser {
     private apiMap;
     private spec;
     private unResolveSpec;
+    private isSwaggerFile;
     /**
      * 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.
@@ -26,6 +27,11 @@ export declare class SpecParser {
      * 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>>;
     /**
      * 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.
@@ -33,7 +39,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;IAgGzC;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAU/B;;;;;;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;YA8CF,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;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"}