@microsoft/m365-spec-parser 0.1.1-alpha.169a2b37a.0 → 0.1.1-alpha.2f5decfcc.0

package/dist/index.node.cjs.js

@@ -61,7 +61,7 @@ exports.ErrorType = void 0;
     ErrorType["NoExtraAPICanBeAdded"] = "no-extra-api-can-be-added";
     ErrorType["ResolveServerUrlFailed"] = "resolve-server-url-failed";
     ErrorType["SwaggerNotSupported"] = "swagger-not-supported";
-    ErrorType["MultipleAPIKeyNotSupported"] = "multiple-api-key-not-supported";
+    ErrorType["MultipleAuthNotSupported"] = "multiple-auth-not-supported";
     ErrorType["ListFailed"] = "list-failed";
     ErrorType["listSupportedAPIInfoFailed"] = "list-supported-api-info-failed";
     ErrorType["FilterSpecFailed"] = "filter-spec-failed";
@@ -117,7 +117,7 @@ ConstantString.ResolveServerUrlFailed = "Unable to resolve the server URL: pleas
 ConstantString.OperationOnlyContainsOptionalParam = "Operation %s contains multiple optional parameters. The first optional parameter is used for this command.";
 ConstantString.ConvertSwaggerToOpenAPI = "The Swagger 2.0 file has been converted to OpenAPI 3.0.";
 ConstantString.SwaggerNotSupported = "Swagger 2.0 is not supported. Please convert to OpenAPI 3.0 manually before proceeding.";
-ConstantString.MultipleAPIKeyNotSupported = "Multiple API keys are not supported. Please make sure that all selected APIs use the same API key.";
+ConstantString.MultipleAuthNotSupported = "Multiple authentication methods are unsupported. Ensure all selected APIs use identical authentication.";
 ConstantString.UnsupportedSchema = "Unsupported schema in %s %s: %s";
 ConstantString.WrappedCardVersion = "devPreview";
 ConstantString.WrappedCardSchema = "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.ResponseRenderingTemplate.schema.json";
@@ -130,6 +130,7 @@ ConstantString.AdaptiveCardType = "AdaptiveCard";
 ConstantString.TextBlockType = "TextBlock";
 ConstantString.ContainerType = "Container";
 ConstantString.RegistrationIdPostfix = "REGISTRATION_ID";
+ConstantString.OAuthRegistrationIdPostFix = "OAUTH_REGISTRATION_ID";
 ConstantString.ResponseCodeFor20X = [
     "200",
     "201",
@@ -311,6 +312,9 @@ class Utils {
         }
         return paramResult;
     }
+    static containMultipleMediaTypes(bodyObject) {
+        return Object.keys((bodyObject === null || bodyObject === void 0 ? void 0 : bodyObject.content) || {}).length > 1;
+    }
     /**
      * Checks if the given API is supported.
      * @param {string} method - The HTTP method of the API.
@@ -332,9 +336,14 @@ class Utils {
         if (pathObj) {
             if (((_a = options.allowMethods) === null || _a === void 0 ? void 0 : _a.includes(method)) && pathObj[method]) {
                 const securities = pathObj[method].security;
-                const authArray = Utils.getAuthArray(securities, spec);
-                if (!Utils.isSupportedAuth(authArray, options)) {
-                    return false;
+                const isTeamsAi = options.projectType === exports.ProjectType.TeamsAi;
+                const isCopilot = options.projectType === exports.ProjectType.Copilot;
+                // Teams AI project doesn't care about auth, it will use authProvider for user to implement
+                if (!isTeamsAi) {
+                    const authArray = Utils.getAuthArray(securities, spec);
+                    if (!Utils.isSupportedAuth(authArray, options)) {
+                        return false;
+                    }
                 }
                 const operationObject = pathObj[method];
                 if (!options.allowMissingId && !operationObject.operationId) {
@@ -343,20 +352,22 @@ class Utils {
                 const paramObject = operationObject.parameters;
                 const requestBody = operationObject.requestBody;
                 const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
-                const mediaTypesCount = Object.keys((requestBody === null || requestBody === void 0 ? void 0 : requestBody.content) || {}).length;
-                if (mediaTypesCount > 1) {
+                if (!isTeamsAi && Utils.containMultipleMediaTypes(requestBody)) {
                     return false;
                 }
-                const responseJson = Utils.getResponseJson(operationObject);
+                const responseJson = Utils.getResponseJson(operationObject, isTeamsAi);
                 if (Object.keys(responseJson).length === 0) {
                     return false;
                 }
+                // Teams AI project doesn't care about request parameters/body
+                if (isTeamsAi) {
+                    return true;
+                }
                 let requestBodyParamResult = {
                     requiredNum: 0,
                     optionalNum: 0,
                     isValid: true,
                 };
-                const isCopilot = options.projectType === exports.ProjectType.Copilot;
                 if (requestJsonBody) {
                     const requestBodySchema = requestJsonBody.schema;
                     if (isCopilot && requestBodySchema.type !== "object") {
@@ -397,31 +408,20 @@ class Utils {
         }
         return false;
     }
-    static isSupportedAuth(authSchemaArray, options) {
-        if (authSchemaArray.length === 0) {
+    static isSupportedAuth(authSchemeArray, options) {
+        if (authSchemeArray.length === 0) {
             return true;
         }
-        if (options.allowAPIKeyAuth || options.allowOauth2) {
+        if (options.allowAPIKeyAuth || options.allowOauth2 || options.allowBearerTokenAuth) {
             // Currently we don't support multiple auth in one operation
-            if (authSchemaArray.length > 0 && authSchemaArray.every((auths) => auths.length > 1)) {
+            if (authSchemeArray.length > 0 && authSchemeArray.every((auths) => auths.length > 1)) {
                 return false;
             }
-            for (const auths of authSchemaArray) {
+            for (const auths of authSchemeArray) {
                 if (auths.length === 1) {
-                    if (!options.allowOauth2 &&
-                        options.allowAPIKeyAuth &&
-                        Utils.isAPIKeyAuth(auths[0].authSchema)) {
-                        return true;
-                    }
-                    else if (!options.allowAPIKeyAuth &&
-                        options.allowOauth2 &&
-                        Utils.isBearerTokenAuth(auths[0].authSchema)) {
-                        return true;
-                    }
-                    else if (options.allowAPIKeyAuth &&
-                        options.allowOauth2 &&
-                        (Utils.isAPIKeyAuth(auths[0].authSchema) ||
-                            Utils.isBearerTokenAuth(auths[0].authSchema))) {
+                    if ((options.allowAPIKeyAuth && Utils.isAPIKeyAuth(auths[0].authScheme)) ||
+                        (options.allowOauth2 && Utils.isOAuthWithAuthCodeFlow(auths[0].authScheme)) ||
+                        (options.allowBearerTokenAuth && Utils.isBearerTokenAuth(auths[0].authScheme))) {
                         return true;
                     }
                 }
@@ -429,13 +429,17 @@ class Utils {
         }
         return false;
     }
-    static isAPIKeyAuth(authSchema) {
-        return authSchema.type === "apiKey";
+    static isBearerTokenAuth(authScheme) {
+        return authScheme.type === "http" && authScheme.scheme === "bearer";
     }
-    static isBearerTokenAuth(authSchema) {
-        return (authSchema.type === "oauth2" ||
-            authSchema.type === "openIdConnect" ||
-            (authSchema.type === "http" && authSchema.scheme === "bearer"));
+    static isAPIKeyAuth(authScheme) {
+        return authScheme.type === "apiKey";
+    }
+    static isOAuthWithAuthCodeFlow(authScheme) {
+        if (authScheme.type === "oauth2" && authScheme.flows && authScheme.flows.authorizationCode) {
+            return true;
+        }
+        return false;
     }
     static getAuthArray(securities, spec) {
         var _a;
@@ -448,7 +452,7 @@ class Utils {
                 for (const name in security) {
                     const auth = securitySchemas[name];
                     authArray.push({
-                        authSchema: auth,
+                        authScheme: auth,
                         name: name,
                     });
                 }
@@ -463,18 +467,19 @@ class Utils {
     static updateFirstLetter(str) {
         return str.charAt(0).toUpperCase() + str.slice(1);
     }
-    static getResponseJson(operationObject) {
+    static getResponseJson(operationObject, isTeamsAiProject = false) {
         var _a, _b;
         let json = {};
         for (const code of ConstantString.ResponseCodeFor20X) {
             const responseObject = (_a = operationObject === null || operationObject === void 0 ? void 0 : operationObject.responses) === null || _a === void 0 ? void 0 : _a[code];
-            const mediaTypesCount = Object.keys((responseObject === null || responseObject === void 0 ? void 0 : responseObject.content) || {}).length;
-            if (mediaTypesCount > 1) {
-                return {};
-            }
             if ((_b = responseObject === null || responseObject === void 0 ? void 0 : responseObject.content) === null || _b === void 0 ? void 0 : _b["application/json"]) {
                 json = responseObject.content["application/json"];
-                break;
+                if (!isTeamsAiProject && Utils.containMultipleMediaTypes(responseObject)) {
+                    json = {};
+                }
+                else {
+                    break;
+                }
             }
         }
         return json;
@@ -612,6 +617,7 @@ class Utils {
                 Utils.updateParameterWithInputType(schema, parameter);
             }
             if (isRequired && schema.default === undefined) {
+                parameter.isRequired = true;
                 requiredParams.push(parameter);
             }
             else {
@@ -675,6 +681,7 @@ class Utils {
                 }
                 if (param.in !== "header" && param.in !== "cookie") {
                     if (param.required && (schema === null || schema === void 0 ? void 0 : schema.default) === undefined) {
+                        parameter.isRequired = true;
                         requiredParams.push(parameter);
                     }
                     else {
@@ -725,7 +732,6 @@ class Utils {
         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.isSupportedApi(method, path, spec, options)) {
                     const operationObject = methods[method];
                     result[`${method.toUpperCase()} ${path}`] = operationObject;
@@ -809,6 +815,19 @@ class Utils {
         }
         return safeRegistrationIdEnvName;
     }
+    static getAllAPICount(spec) {
+        let count = 0;
+        const paths = spec.paths;
+        for (const path in paths) {
+            const methods = paths[path];
+            for (const method in methods) {
+                if (ConstantString.AllOperationMethods.includes(method)) {
+                    count++;
+                }
+            }
+        }
+        return count;
+    }
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -965,7 +984,7 @@ class ManifestUpdater {
         };
         return apiPlugin;
     }
-    static updateManifest(manifestPath, outputSpecPath, spec, options, adaptiveCardFolder, auth) {
+    static updateManifest(manifestPath, outputSpecPath, spec, options, adaptiveCardFolder, authInfo) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 const originalManifest = yield fs__default['default'].readJSON(manifestPath);
@@ -981,10 +1000,10 @@ class ManifestUpdater {
                         apiSpecificationFile: ManifestUpdater.getRelativePath(manifestPath, outputSpecPath),
                         commands: commands,
                     };
-                    if (auth) {
-                        if (Utils.isAPIKeyAuth(auth)) {
-                            auth = auth;
-                            const safeApiSecretRegistrationId = Utils.getSafeRegistrationIdEnvName(`${auth.name}_${ConstantString.RegistrationIdPostfix}`);
+                    if (authInfo) {
+                        const auth = authInfo.authScheme;
+                        if (Utils.isAPIKeyAuth(auth) || Utils.isBearerTokenAuth(auth)) {
+                            const safeApiSecretRegistrationId = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.RegistrationIdPostfix}`);
                             composeExtension.authorization = {
                                 authType: "apiSecretServiceAuth",
                                 apiSecretServiceAuthConfiguration: {
@@ -992,11 +1011,12 @@ class ManifestUpdater {
                                 },
                             };
                         }
-                        else if (Utils.isBearerTokenAuth(auth)) {
+                        else if (Utils.isOAuthWithAuthCodeFlow(auth)) {
+                            const safeOAuth2RegistrationId = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.OAuthRegistrationIdPostFix}`);
                             composeExtension.authorization = {
-                                authType: "microsoftEntra",
-                                microsoftEntraConfiguration: {
-                                    supportsSingleSignOn: true,
+                                authType: "oAuth2.0",
+                                oAuthConfiguration: {
+                                    oauthConfigurationId: `\${{${safeOAuth2RegistrationId}}}`,
                                 },
                             };
                             updatedPart.webApplicationInfo = {
@@ -1323,6 +1343,7 @@ class SpecParser {
             allowMissingId: true,
             allowSwagger: true,
             allowAPIKeyAuth: false,
+            allowBearerTokenAuth: false,
             allowMultipleParameters: false,
             allowOauth2: false,
             allowMethods: ["get", "post"],
@@ -1385,7 +1406,11 @@ class SpecParser {
                 yield this.loadSpec();
                 const spec = this.spec;
                 const apiMap = this.getAllSupportedAPIs(spec);
-                const result = [];
+                const result = {
+                    validAPIs: [],
+                    allAPICount: 0,
+                    validAPICount: 0,
+                };
                 for (const apiKey in apiMap) {
                     const apiResult = {
                         api: "",
@@ -1410,13 +1435,15 @@ class SpecParser {
                     const authArray = Utils.getAuthArray(operation.security, spec);
                     for (const auths of authArray) {
                         if (auths.length === 1) {
-                            apiResult.auth = auths[0].authSchema;
+                            apiResult.auth = auths[0];
                             break;
                         }
                     }
                     apiResult.api = apiKey;
-                    result.push(apiResult);
+                    result.validAPIs.push(apiResult);
                 }
+                result.allAPICount = Utils.getAllAPICount(spec);
+                result.validAPICount = result.validAPIs.length;
                 return result;
             }
             catch (err) {
@@ -1514,23 +1541,23 @@ class SpecParser {
                 const newSpecs = yield this.getFilteredSpecs(filter, signal);
                 const newUnResolvedSpec = newSpecs[0];
                 const newSpec = newSpecs[1];
-                const AuthSet = new Set();
-                let hasMultipleAPIKeyAuth = false;
+                const authSet = new Set();
+                let hasMultipleAuth = false;
                 for (const url in newSpec.paths) {
                     for (const method in newSpec.paths[url]) {
                         const operation = newSpec.paths[url][method];
                         const authArray = Utils.getAuthArray(operation.security, newSpec);
                         if (authArray && authArray.length > 0) {
-                            AuthSet.add(authArray[0][0].authSchema);
-                            if (AuthSet.size > 1) {
-                                hasMultipleAPIKeyAuth = true;
+                            authSet.add(authArray[0][0]);
+                            if (authSet.size > 1) {
+                                hasMultipleAuth = true;
                                 break;
                             }
                         }
                     }
                 }
-                if (hasMultipleAPIKeyAuth) {
-                    throw new SpecParserError(ConstantString.MultipleAPIKeyNotSupported, exports.ErrorType.MultipleAPIKeyNotSupported);
+                if (hasMultipleAuth && this.options.projectType !== exports.ProjectType.TeamsAi) {
+                    throw new SpecParserError(ConstantString.MultipleAuthNotSupported, exports.ErrorType.MultipleAuthNotSupported);
                 }
                 let resultStr;
                 if (outputSpecPath.endsWith(".yaml") || outputSpecPath.endsWith(".yml")) {
@@ -1569,8 +1596,8 @@ class SpecParser {
                 if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
                     throw new SpecParserError(ConstantString.CancelledMessage, exports.ErrorType.Cancelled);
                 }
-                const auth = Array.from(AuthSet)[0];
-                const [updatedManifest, warnings] = yield ManifestUpdater.updateManifest(manifestPath, outputSpecPath, newSpec, this.options, adaptiveCardFolder, auth);
+                const authInfo = Array.from(authSet)[0];
+                const [updatedManifest, warnings] = yield ManifestUpdater.updateManifest(manifestPath, outputSpecPath, newSpec, this.options, adaptiveCardFolder, authInfo);
                 yield fs__default['default'].outputJSON(manifestPath, updatedManifest, { spaces: 2 });
                 result.warnings.push(...warnings);
             }