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

package/dist/index.esm2017.mjs

@@ -5,6 +5,7 @@ import fs from 'fs-extra';
 import path from 'path';
 import { ManifestUtil } from '@microsoft/teams-manifest';
 import { createHash } from 'crypto';
+import { $RefParser } from '@apidevtools/json-schema-ref-parser';
 
 // Copyright (c) Microsoft Corporation.
 /**
@@ -59,6 +60,7 @@ var WarningType;
     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";
 })(WarningType || (WarningType = {}));
@@ -98,6 +100,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.";
@@ -112,12 +115,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",
@@ -129,6 +127,7 @@ ConstantString.ResponseCodeFor20X = [
     "207",
     "208",
     "226",
+    "2XX",
     "default",
 ];
 ConstantString.AllOperationMethods = [
@@ -206,11 +205,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 = [];
@@ -235,6 +255,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) {
@@ -705,6 +739,9 @@ class Validator {
                     reason: [ErrorType.MultipleAuthNotSupported],
                 };
             }
+            if (this.projectType === ProjectType.Copilot) {
+                return { isValid: true, reason: [] };
+            }
             for (const auths of authSchemeArray) {
                 if (auths.length === 1) {
                     if ((this.options.allowAPIKeyAuth && Utils.isAPIKeyAuth(auths[0].authScheme)) ||
@@ -1656,7 +1693,7 @@ function inferProperties(card) {
 
 // Copyright (c) Microsoft Corporation.
 class ManifestUpdater {
-    static async updateManifestWithAiPlugin(manifestPath, outputSpecPath, apiPluginFilePath, spec, options, authInfo, existingPluginManifestInfo) {
+    static async updateManifestWithAiPlugin(manifestPath, outputSpecPath, apiPluginFilePath, spec, options, authMap, existingPluginManifestInfo) {
         const manifest = await fs.readJSON(manifestPath);
         const apiPluginRelativePath = ManifestUpdater.getRelativePath(manifestPath, apiPluginFilePath);
         const useCopilotExtensionsInSchema = await ManifestUtil.useCopilotExtensionsInSchema(manifest);
@@ -1686,7 +1723,7 @@ class ManifestUpdater {
         }
         const appName = this.removeEnvs(manifest.name.short);
         const specRelativePath = ManifestUpdater.getRelativePath(manifestPath, outputSpecPath);
-        const [apiPlugin, warnings] = await ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options, existingPluginManifestInfo);
+        const [apiPlugin, warnings] = await ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authMap, options, existingPluginManifestInfo);
         return [manifest, apiPlugin, warnings];
     }
     static updateManifestDescription(manifest, spec) {
@@ -1708,28 +1745,13 @@ class ManifestUpdater {
             throw new SpecParserError(Utils.format(ConstantString.UnsupportedSchema, method, pathUrl, JSON.stringify(schema)), ErrorType.UpdateManifestFailed);
         }
     }
-    static async generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options, existingPluginManifestInfo) {
+    static async generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authMap, options, existingPluginManifestInfo) {
         var _a, _b, _c, _d;
         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) {
@@ -1812,7 +1834,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);
@@ -1822,6 +1866,12 @@ class ManifestUpdater {
                 }
             }
         }
+        if (Object.keys(functionNamesMap).length === 0) {
+            functionNamesMap["None"] = {
+                functionNames: [],
+                authName: "None",
+            };
+        }
         let apiPlugin;
         if (await fs.pathExists(apiPluginFilePath)) {
             apiPlugin = await fs.readJSON(apiPluginFilePath);
@@ -1857,24 +1907,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;
@@ -1915,7 +1976,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",
@@ -2042,6 +2103,7 @@ class SpecParser {
         };
         this.pathOrSpec = pathOrDoc;
         this.parser = new SwaggerParser();
+        this.refParser = new $RefParser();
         this.options = Object.assign(Object.assign({}, this.defaultOptions), (options !== null && options !== void 0 ? options : {}));
     }
     /**
@@ -2054,12 +2116,15 @@ class SpecParser {
             let hash = "";
             try {
                 await this.loadSpec();
-                if (!this.parser.$refs.circular) {
+                if (!this.refParser.$refs.circular) {
                     await 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));
                     await this.parser.validate(clonedUnResolveSpec);
+                    */
                 }
             }
             catch (e) {
@@ -2087,7 +2152,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({
@@ -2216,7 +2281,7 @@ class SpecParser {
                 throw new SpecParserError(ConstantString.CancelledMessage, ErrorType.Cancelled);
             }
             const clonedUnResolveSpec = JSON.parse(JSON.stringify(newUnResolvedSpec));
-            const newSpec = (await this.parser.dereference(clonedUnResolveSpec));
+            const newSpec = await this.deReferenceSpec(clonedUnResolveSpec);
             return [newUnResolvedSpec, newSpec];
         }
         catch (err) {
@@ -2226,6 +2291,10 @@ class SpecParser {
             throw new SpecParserError(err.toString(), ErrorType.GetSpecFailed);
         }
     }
+    async deReferenceSpec(spec) {
+        const result = await 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.
@@ -2242,7 +2311,6 @@ class SpecParser {
             const newSpecs = await 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];
@@ -2250,15 +2318,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: 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: WarningType.UnsupportedAuthType,
+                            content: Utils.format(ConstantString.AuthTypeIsNotSupported, operationId),
+                            data: operationId,
+                        });
                     }
-                    operationItem.operationId = operationId.replace(/[^a-zA-Z0-9]/g, "_");
-                    result.warnings.push({
-                        type: WarningType.OperationIdContainsSpecialCharacters,
-                        content: Utils.format(ConstantString.OperationIdContainsSpecialCharacters, operationId, operationItem.operationId),
-                        data: operationId,
-                    });
                 }
             }
             await this.saveFilterSpec(outputSpecPath, newUnResolvedSpec);
@@ -2271,7 +2346,8 @@ class SpecParser {
                     specPath: this.pathOrSpec,
                 }
                 : undefined;
-            const [updatedManifest, apiPlugin, warnings] = await ManifestUpdater.updateManifestWithAiPlugin(manifestPath, outputSpecPath, pluginFilePath, newSpec, this.options, authInfo, existingPluginManifestInfo);
+            const authMap = Utils.getAuthMap(newSpec);
+            const [updatedManifest, apiPlugin, warnings] = await ManifestUpdater.updateManifestWithAiPlugin(manifestPath, outputSpecPath, pluginFilePath, newSpec, this.options, authMap, existingPluginManifestInfo);
             result.warnings.push(...warnings);
             await fs.outputJSON(manifestPath, updatedManifest, { spaces: 4 });
             await fs.outputJSON(pluginFilePath, apiPlugin, { spaces: 4 });
@@ -2359,7 +2435,7 @@ class SpecParser {
                 this.isSwaggerFile = true;
             }
             const clonedUnResolveSpec = JSON.parse(JSON.stringify(this.unResolveSpec));
-            this.spec = (await this.parser.dereference(clonedUnResolveSpec));
+            this.spec = await this.deReferenceSpec(clonedUnResolveSpec);
         }
     }
     getAPIs(spec) {