@microsoft/m365-spec-parser 0.2.4-alpha.e84e1682b.0 → 0.2.4-alpha.f33089c4c.0

package/dist/index.node.cjs.js

@@ -9,6 +9,7 @@ var fs = require('fs-extra');
 var path = require('path');
 var teamsManifest = require('@microsoft/teams-manifest');
 var crypto = require('crypto');
+var jsonSchemaRefParser = require('@apidevtools/json-schema-ref-parser');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -101,6 +102,7 @@ exports.WarningType = void 0;
     WarningType["ConvertSwaggerToOpenAPI"] = "convert-swagger-to-openapi";
     WarningType["FuncDescriptionTooLong"] = "function-description-too-long";
     WarningType["OperationIdContainsSpecialCharacters"] = "operationid-contains-special-characters";
+    WarningType["UnsupportedAuthType"] = "unsupported-auth-type";
     WarningType["GenerateJsonDataFailed"] = "generate-json-data-failed";
     WarningType["Unknown"] = "unknown";
 })(exports.WarningType || (exports.WarningType = {}));
@@ -140,6 +142,7 @@ ConstantString.SwaggerNotSupported = "Swagger 2.0 is not supported. Please conve
 ConstantString.SpecVersionNotSupported = "Unsupported OpenAPI version %s. Please use version 3.0.x.";
 ConstantString.MultipleAuthNotSupported = "Multiple authentication methods are unsupported. Ensure all selected APIs use identical authentication.";
 ConstantString.OperationIdContainsSpecialCharacters = "Operation id '%s' in OpenAPI description document contained special characters and was renamed to '%s'.";
+ConstantString.AuthTypeIsNotSupported = "Unsupported authorization type in API '%s'. No authorization will be used.";
 ConstantString.UnsupportedSchema = "Unsupported schema in %s %s: %s";
 ConstantString.FuncDescriptionTooLong = "The description of the function '%s' is too long. The current length is %s characters, while the maximum allowed length is %s characters.";
 ConstantString.GenerateJsonDataFailed = "Failed to generate JSON data for api: %s due to %s.";
@@ -154,12 +157,7 @@ ConstantString.AdaptiveCardType = "AdaptiveCard";
 ConstantString.TextBlockType = "TextBlock";
 ConstantString.ImageType = "Image";
 ConstantString.ContainerType = "Container";
-ConstantString.RegistrationIdPostfix = {
-    apiKey: "REGISTRATION_ID",
-    oauth2: "CONFIGURATION_ID",
-    http: "REGISTRATION_ID",
-    openIdConnect: "REGISTRATION_ID",
-};
+ConstantString.RegistrationIdPostfix = "REGISTRATION_ID";
 ConstantString.ResponseCodeFor20X = [
     "200",
     "201",
@@ -171,6 +169,7 @@ ConstantString.ResponseCodeFor20X = [
     "207",
     "208",
     "226",
+    "2XX",
     "default",
 ];
 ConstantString.AllOperationMethods = [
@@ -248,11 +247,32 @@ class Utils {
     static isAPIKeyAuth(authScheme) {
         return authScheme.type === "apiKey";
     }
+    static isAPIKeyAuthButNotInCookie(authScheme) {
+        return authScheme.type === "apiKey" && authScheme.in !== "cookie";
+    }
     static isOAuthWithAuthCodeFlow(authScheme) {
         return !!(authScheme.type === "oauth2" &&
             authScheme.flows &&
             authScheme.flows.authorizationCode);
     }
+    static isNotSupportedAuth(authSchemeArray) {
+        if (authSchemeArray.length === 0) {
+            return false;
+        }
+        if (authSchemeArray.length > 0 && authSchemeArray.every((auths) => auths.length > 1)) {
+            return true;
+        }
+        for (const auths of authSchemeArray) {
+            if (auths.length === 1) {
+                if (Utils.isOAuthWithAuthCodeFlow(auths[0].authScheme) ||
+                    Utils.isBearerTokenAuth(auths[0].authScheme) ||
+                    Utils.isAPIKeyAuthButNotInCookie(auths[0].authScheme)) {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
     static getAuthArray(securities, spec) {
         var _a;
         const result = [];
@@ -277,6 +297,20 @@ class Utils {
         result.sort((a, b) => a[0].name.localeCompare(b[0].name));
         return result;
     }
+    static getAuthMap(spec) {
+        const authMap = {};
+        for (const url in spec.paths) {
+            for (const method in spec.paths[url]) {
+                const operation = spec.paths[url][method];
+                const authArray = Utils.getAuthArray(operation.security, spec);
+                if (authArray && authArray.length > 0) {
+                    const currentAuth = authArray[0][0];
+                    authMap[operation.operationId] = currentAuth;
+                }
+            }
+        }
+        return authMap;
+    }
     static getAuthInfo(spec) {
         let authInfo = undefined;
         for (const url in spec.paths) {
@@ -747,6 +781,9 @@ class Validator {
                     reason: [exports.ErrorType.MultipleAuthNotSupported],
                 };
             }
+            if (this.projectType === exports.ProjectType.Copilot) {
+                return { isValid: true, reason: [] };
+            }
             for (const auths of authSchemeArray) {
                 if (auths.length === 1) {
                     if ((this.options.allowAPIKeyAuth && Utils.isAPIKeyAuth(auths[0].authScheme)) ||
@@ -1698,7 +1735,7 @@ function inferProperties(card) {
 
 // Copyright (c) Microsoft Corporation.
 class ManifestUpdater {
-    static updateManifestWithAiPlugin(manifestPath, outputSpecPath, apiPluginFilePath, spec, options, authInfo, existingPluginManifestInfo) {
+    static updateManifestWithAiPlugin(manifestPath, outputSpecPath, apiPluginFilePath, spec, options, authMap, existingPluginManifestInfo) {
         return __awaiter(this, void 0, void 0, function* () {
             const manifest = yield fs__default['default'].readJSON(manifestPath);
             const apiPluginRelativePath = ManifestUpdater.getRelativePath(manifestPath, apiPluginFilePath);
@@ -1729,7 +1766,7 @@ class ManifestUpdater {
             }
             const appName = this.removeEnvs(manifest.name.short);
             const specRelativePath = ManifestUpdater.getRelativePath(manifestPath, outputSpecPath);
-            const [apiPlugin, warnings] = yield ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options, existingPluginManifestInfo);
+            const [apiPlugin, warnings] = yield ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authMap, options, existingPluginManifestInfo);
             return [manifest, apiPlugin, warnings];
         });
     }
@@ -1752,29 +1789,14 @@ class ManifestUpdater {
             throw new SpecParserError(Utils.format(ConstantString.UnsupportedSchema, method, pathUrl, JSON.stringify(schema)), exports.ErrorType.UpdateManifestFailed);
         }
     }
-    static generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options, existingPluginManifestInfo) {
+    static generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authMap, options, existingPluginManifestInfo) {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
             const warnings = [];
             const functions = [];
-            const functionNames = [];
+            const functionNamesMap = {};
             const conversationStarters = [];
             const paths = spec.paths;
-            const pluginAuthObj = {
-                type: "None",
-            };
-            if (authInfo) {
-                if (Utils.isOAuthWithAuthCodeFlow(authInfo.authScheme)) {
-                    pluginAuthObj.type = "OAuthPluginVault";
-                }
-                else if (Utils.isBearerTokenAuth(authInfo.authScheme)) {
-                    pluginAuthObj.type = "ApiKeyPluginVault";
-                }
-                if (pluginAuthObj.type !== "None") {
-                    const safeRegistrationIdName = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.RegistrationIdPostfix[authInfo.authScheme.type]}`);
-                    pluginAuthObj.reference_id = `\${{${safeRegistrationIdName}}}`;
-                }
-            }
             for (const pathUrl in paths) {
                 const pathItem = paths[pathUrl];
                 if (pathItem) {
@@ -1857,7 +1879,29 @@ class ManifestUpdater {
                                     }
                                 }
                                 functions.push(funcObj);
-                                functionNames.push(safeFunctionName);
+                                const authInfo = authMap[operationId];
+                                let key = "None";
+                                let authName = "None";
+                                if (authInfo) {
+                                    if (Utils.isOAuthWithAuthCodeFlow(authInfo.authScheme)) {
+                                        key = "OAuthPluginVault";
+                                        authName = authInfo.name;
+                                    }
+                                    else if (Utils.isBearerTokenAuth(authInfo.authScheme) ||
+                                        Utils.isAPIKeyAuthButNotInCookie(authInfo.authScheme)) {
+                                        key = "ApiKeyPluginVault";
+                                        authName = authInfo.name;
+                                    }
+                                }
+                                if (functionNamesMap[key]) {
+                                    functionNamesMap[key].functionNames.push(safeFunctionName);
+                                }
+                                else {
+                                    functionNamesMap[key] = {
+                                        functionNames: [safeFunctionName],
+                                        authName: authName,
+                                    };
+                                }
                                 const conversationStarterStr = (summary !== null && summary !== void 0 ? summary : description).slice(0, ConstantString.ConversationStarterMaxLens);
                                 if (conversationStarterStr) {
                                     conversationStarters.push(conversationStarterStr);
@@ -1867,6 +1911,12 @@ class ManifestUpdater {
                     }
                 }
             }
+            if (Object.keys(functionNamesMap).length === 0) {
+                functionNamesMap["None"] = {
+                    functionNames: [],
+                    authName: "None",
+                };
+            }
             let apiPlugin;
             if (yield fs__default['default'].pathExists(apiPluginFilePath)) {
                 apiPlugin = yield fs__default['default'].readJSON(apiPluginFilePath);
@@ -1902,24 +1952,35 @@ class ManifestUpdater {
                 const relativePath = ManifestUpdater.getRelativePath(existingPluginManifestInfo.manifestPath, existingPluginManifestInfo.specPath);
                 apiPlugin.runtimes = apiPlugin.runtimes.filter((runtime) => runtime.spec.url !== relativePath);
             }
-            const index = apiPlugin.runtimes.findIndex((runtime) => {
-                var _a, _b;
-                return runtime.spec.url === specRelativePath &&
-                    runtime.type === "OpenApi" &&
-                    ((_b = (_a = runtime.auth) === null || _a === void 0 ? void 0 : _a.type) !== null && _b !== void 0 ? _b : "None") === pluginAuthObj.type;
-            });
-            if (index === -1) {
-                apiPlugin.runtimes.push({
-                    type: "OpenApi",
-                    auth: pluginAuthObj,
-                    spec: {
-                        url: specRelativePath,
-                    },
-                    run_for_functions: functionNames,
+            for (const authType in functionNamesMap) {
+                const pluginAuthObj = {
+                    type: authType,
+                };
+                const authName = functionNamesMap[authType].authName;
+                if (pluginAuthObj.type !== "None") {
+                    const safeRegistrationIdName = Utils.getSafeRegistrationIdEnvName(`${authName}_${ConstantString.RegistrationIdPostfix}`);
+                    pluginAuthObj.reference_id = `\${{${safeRegistrationIdName}}}`;
+                }
+                const functionNamesInfo = functionNamesMap[authType];
+                const index = apiPlugin.runtimes.findIndex((runtime) => {
+                    var _a, _b;
+                    return runtime.spec.url === specRelativePath &&
+                        runtime.type === "OpenApi" &&
+                        ((_b = (_a = runtime.auth) === null || _a === void 0 ? void 0 : _a.type) !== null && _b !== void 0 ? _b : "None") === authType;
                 });
-            }
-            else {
-                apiPlugin.runtimes[index].run_for_functions = functionNames;
+                if (index === -1) {
+                    apiPlugin.runtimes.push({
+                        type: "OpenApi",
+                        auth: pluginAuthObj,
+                        spec: {
+                            url: specRelativePath,
+                        },
+                        run_for_functions: functionNamesInfo.functionNames,
+                    });
+                }
+                else {
+                    apiPlugin.runtimes[index].run_for_functions = functionNamesInfo.functionNames;
+                }
             }
             if (!apiPlugin.name_for_human) {
                 apiPlugin.name_for_human = appName;
@@ -1962,7 +2023,7 @@ class ManifestUpdater {
                     };
                     if (authInfo) {
                         const auth = authInfo.authScheme;
-                        const safeRegistrationIdName = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.RegistrationIdPostfix[authInfo.authScheme.type]}`);
+                        const safeRegistrationIdName = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.RegistrationIdPostfix}`);
                         if (Utils.isAPIKeyAuth(auth) || Utils.isBearerTokenAuth(auth)) {
                             composeExtension.authorization = {
                                 authType: "apiSecretServiceAuth",
@@ -2092,6 +2153,7 @@ class SpecParser {
         };
         this.pathOrSpec = pathOrDoc;
         this.parser = new SwaggerParser__default['default']();
+        this.refParser = new jsonSchemaRefParser.$RefParser();
         this.options = Object.assign(Object.assign({}, this.defaultOptions), (options !== null && options !== void 0 ? options : {}));
     }
     /**
@@ -2105,12 +2167,15 @@ class SpecParser {
                 let hash = "";
                 try {
                     yield this.loadSpec();
-                    if (!this.parser.$refs.circular) {
+                    if (!this.refParser.$refs.circular) {
                         yield this.parser.validate(this.spec);
                     }
                     else {
+                        // The following code hangs for Graph API, support will be added when SwaggerParser is updated.
+                        /*
                         const clonedUnResolveSpec = JSON.parse(JSON.stringify(this.unResolveSpec));
-                        yield this.parser.validate(clonedUnResolveSpec);
+                        await this.parser.validate(clonedUnResolveSpec);
+                        */
                     }
                 }
                 catch (e) {
@@ -2138,7 +2203,7 @@ class SpecParser {
                     };
                 }
                 // Remote reference not supported
-                const refPaths = this.parser.$refs.paths();
+                const refPaths = this.refParser.$refs.paths();
                 // refPaths [0] is the current spec file path
                 if (refPaths.length > 1) {
                     errors.push({
@@ -2273,7 +2338,7 @@ class SpecParser {
                     throw new SpecParserError(ConstantString.CancelledMessage, exports.ErrorType.Cancelled);
                 }
                 const clonedUnResolveSpec = JSON.parse(JSON.stringify(newUnResolvedSpec));
-                const newSpec = (yield this.parser.dereference(clonedUnResolveSpec));
+                const newSpec = yield this.deReferenceSpec(clonedUnResolveSpec);
                 return [newUnResolvedSpec, newSpec];
             }
             catch (err) {
@@ -2284,6 +2349,12 @@ class SpecParser {
             }
         });
     }
+    deReferenceSpec(spec) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.refParser.dereference(spec);
+            return result;
+        });
+    }
     /**
      * 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.
@@ -2301,7 +2372,6 @@ class SpecParser {
                 const newSpecs = yield this.getFilteredSpecs(filter, signal);
                 const newUnResolvedSpec = newSpecs[0];
                 const newSpec = newSpecs[1];
-                const authInfo = Utils.getAuthInfo(newSpec);
                 const paths = newUnResolvedSpec.paths;
                 for (const pathUrl in paths) {
                     const operations = paths[pathUrl];
@@ -2309,15 +2379,22 @@ class SpecParser {
                         const operationItem = operations[method];
                         const operationId = operationItem.operationId;
                         const containsSpecialCharacters = /[^a-zA-Z0-9_]/.test(operationId);
-                        if (!containsSpecialCharacters) {
-                            continue;
+                        if (containsSpecialCharacters) {
+                            operationItem.operationId = operationId.replace(/[^a-zA-Z0-9]/g, "_");
+                            result.warnings.push({
+                                type: exports.WarningType.OperationIdContainsSpecialCharacters,
+                                content: Utils.format(ConstantString.OperationIdContainsSpecialCharacters, operationId, operationItem.operationId),
+                                data: operationId,
+                            });
+                        }
+                        const authArray = Utils.getAuthArray(operationItem.security, newSpec);
+                        if (Utils.isNotSupportedAuth(authArray)) {
+                            result.warnings.push({
+                                type: exports.WarningType.UnsupportedAuthType,
+                                content: Utils.format(ConstantString.AuthTypeIsNotSupported, operationId),
+                                data: operationId,
+                            });
                         }
-                        operationItem.operationId = operationId.replace(/[^a-zA-Z0-9]/g, "_");
-                        result.warnings.push({
-                            type: exports.WarningType.OperationIdContainsSpecialCharacters,
-                            content: Utils.format(ConstantString.OperationIdContainsSpecialCharacters, operationId, operationItem.operationId),
-                            data: operationId,
-                        });
                     }
                 }
                 yield this.saveFilterSpec(outputSpecPath, newUnResolvedSpec);
@@ -2330,7 +2407,8 @@ class SpecParser {
                         specPath: this.pathOrSpec,
                     }
                     : undefined;
-                const [updatedManifest, apiPlugin, warnings] = yield ManifestUpdater.updateManifestWithAiPlugin(manifestPath, outputSpecPath, pluginFilePath, newSpec, this.options, authInfo, existingPluginManifestInfo);
+                const authMap = Utils.getAuthMap(newSpec);
+                const [updatedManifest, apiPlugin, warnings] = yield ManifestUpdater.updateManifestWithAiPlugin(manifestPath, outputSpecPath, pluginFilePath, newSpec, this.options, authMap, existingPluginManifestInfo);
                 result.warnings.push(...warnings);
                 yield fs__default['default'].outputJSON(manifestPath, updatedManifest, { spaces: 4 });
                 yield fs__default['default'].outputJSON(pluginFilePath, apiPlugin, { spaces: 4 });
@@ -2422,7 +2500,7 @@ class SpecParser {
                     this.isSwaggerFile = true;
                 }
                 const clonedUnResolveSpec = JSON.parse(JSON.stringify(this.unResolveSpec));
-                this.spec = (yield this.parser.dereference(clonedUnResolveSpec));
+                this.spec = yield this.deReferenceSpec(clonedUnResolveSpec);
             }
         });
     }