@microsoft/m365-spec-parser 0.1.1-alpha.8d8f5a0bb.0 → 0.1.1-alpha.a372ccf67.0

package/dist/index.esm5.js

@@ -45,7 +45,7 @@ var ErrorType;
     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";
@@ -76,7 +76,13 @@ var ValidationStatus;
     ValidationStatus[ValidationStatus["Valid"] = 0] = "Valid";
     ValidationStatus[ValidationStatus["Warning"] = 1] = "Warning";
     ValidationStatus[ValidationStatus["Error"] = 2] = "Error";
-})(ValidationStatus || (ValidationStatus = {}));
+})(ValidationStatus || (ValidationStatus = {}));
+var ProjectType;
+(function (ProjectType) {
+    ProjectType[ProjectType["Copilot"] = 0] = "Copilot";
+    ProjectType[ProjectType["SME"] = 1] = "SME";
+    ProjectType[ProjectType["TeamsAi"] = 2] = "TeamsAi";
+})(ProjectType || (ProjectType = {}));
 
 // Copyright (c) Microsoft Corporation.
 class SpecParserError extends Error {
@@ -103,7 +109,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";
@@ -116,6 +122,7 @@ ConstantString.AdaptiveCardType = "AdaptiveCard";
 ConstantString.TextBlockType = "TextBlock";
 ConstantString.ContainerType = "Container";
 ConstantString.RegistrationIdPostfix = "REGISTRATION_ID";
+ConstantString.OAuthRegistrationIdPostFix = "OAUTH_REGISTRATION_ID";
 ConstantString.ResponseCodeFor20X = [
     "200",
     "201",
@@ -175,7 +182,8 @@ ConstantString.FullDescriptionMaxLens = 4000;
 ConstantString.CommandDescriptionMaxLens = 128;
 ConstantString.ParameterDescriptionMaxLens = 128;
 ConstantString.CommandTitleMaxLens = 32;
-ConstantString.ParameterTitleMaxLens = 32;
+ConstantString.ParameterTitleMaxLens = 32;
+ConstantString.SMERequiredParamsMaxNum = 5;
 
 // Copyright (c) Microsoft Corporation.
 class Utils {
@@ -288,6 +296,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.
@@ -302,32 +313,40 @@ class Utils {
      * 5. response body should be “application/json” and not empty, and response code should be 20X
      * 6. only support request body with “application/json” content type
      */
-    static isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot) {
+    static isSupportedApi(method, path, spec, options) {
+        var _a;
         const pathObj = spec.paths[path];
         method = method.toLocaleLowerCase();
         if (pathObj) {
-            if ((method === ConstantString.PostMethod || method === ConstantString.GetMethod) &&
-                pathObj[method]) {
+            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, allowAPIKeyAuth, allowOauth2)) {
-                    return false;
+                const isTeamsAi = options.projectType === ProjectType.TeamsAi;
+                const isCopilot = options.projectType === 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 (!allowMissingId && !operationObject.operationId) {
+                if (!options.allowMissingId && !operationObject.operationId) {
                     return false;
                 }
                 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,
@@ -352,8 +371,9 @@ class Utils {
                     return true;
                 }
                 if (requestBodyParamResult.requiredNum + paramResult.requiredNum > 1) {
-                    if (allowMultipleParameters &&
-                        requestBodyParamResult.requiredNum + paramResult.requiredNum <= 5) {
+                    if (options.allowMultipleParameters &&
+                        requestBodyParamResult.requiredNum + paramResult.requiredNum <=
+                            ConstantString.SMERequiredParamsMaxNum) {
                         return true;
                     }
                     return false;
@@ -372,29 +392,31 @@ class Utils {
         }
         return false;
     }
-    static isSupportedAuth(authSchemaArray, allowAPIKeyAuth, allowOauth2) {
+    static isSupportedAuth(authSchemaArray, options) {
         if (authSchemaArray.length === 0) {
             return true;
         }
-        if (allowAPIKeyAuth || allowOauth2) {
+        if (options.allowAPIKeyAuth || options.allowOauth2) {
             // Currently we don't support multiple auth in one operation
             if (authSchemaArray.length > 0 && authSchemaArray.every((auths) => auths.length > 1)) {
                 return false;
             }
             for (const auths of authSchemaArray) {
                 if (auths.length === 1) {
-                    if (!allowOauth2 && allowAPIKeyAuth && Utils.isAPIKeyAuth(auths[0].authSchema)) {
+                    if (!options.allowOauth2 &&
+                        options.allowAPIKeyAuth &&
+                        Utils.isAPIKeyAuth(auths[0].authSchema)) {
                         return true;
                     }
-                    else if (!allowAPIKeyAuth &&
-                        allowOauth2 &&
-                        Utils.isBearerTokenAuth(auths[0].authSchema)) {
+                    else if (!options.allowAPIKeyAuth &&
+                        options.allowOauth2 &&
+                        Utils.isOAuthWithAuthCodeFlow(auths[0].authSchema)) {
                         return true;
                     }
-                    else if (allowAPIKeyAuth &&
-                        allowOauth2 &&
+                    else if (options.allowAPIKeyAuth &&
+                        options.allowOauth2 &&
                         (Utils.isAPIKeyAuth(auths[0].authSchema) ||
-                            Utils.isBearerTokenAuth(auths[0].authSchema))) {
+                            Utils.isOAuthWithAuthCodeFlow(auths[0].authSchema))) {
                         return true;
                     }
                 }
@@ -405,10 +427,11 @@ class Utils {
     static isAPIKeyAuth(authSchema) {
         return authSchema.type === "apiKey";
     }
-    static isBearerTokenAuth(authSchema) {
-        return (authSchema.type === "oauth2" ||
-            authSchema.type === "openIdConnect" ||
-            (authSchema.type === "http" && authSchema.scheme === "bearer"));
+    static isOAuthWithAuthCodeFlow(authSchema) {
+        if (authSchema.type === "oauth2" && authSchema.flows && authSchema.flows.authorizationCode) {
+            return true;
+        }
+        return false;
     }
     static getAuthArray(securities, spec) {
         var _a;
@@ -436,18 +459,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;
@@ -521,7 +545,7 @@ class Utils {
         }
         return errors;
     }
-    static validateServer(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot) {
+    static validateServer(spec, options) {
         const errors = [];
         let hasTopLevelServers = false;
         let hasPathLevelServers = false;
@@ -542,7 +566,7 @@ class Utils {
             }
             for (const method in methods) {
                 const operationObject = methods[method];
-                if (Utils.isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot)) {
+                if (Utils.isSupportedApi(method, path, spec, options)) {
                     if ((operationObject === null || operationObject === void 0 ? void 0 : operationObject.servers) && operationObject.servers.length >= 1) {
                         hasOperationLevelServers = true;
                         const serverErrors = Utils.checkServerUrl(operationObject.servers);
@@ -629,7 +653,7 @@ class Utils {
             param.value = schema.default;
         }
     }
-    static parseApiInfo(operationItem, allowMultipleParameters) {
+    static parseApiInfo(operationItem, options) {
         var _a, _b;
         const requiredParams = [];
         const optionalParams = [];
@@ -643,7 +667,7 @@ class Utils {
                     description: ((_a = param.description) !== null && _a !== void 0 ? _a : "").slice(0, ConstantString.ParameterDescriptionMaxLens),
                 };
                 const schema = param.schema;
-                if (allowMultipleParameters && schema) {
+                if (options.allowMultipleParameters && schema) {
                     Utils.updateParameterWithInputType(schema, parameter);
                 }
                 if (param.in !== "header" && param.in !== "cookie") {
@@ -661,7 +685,7 @@ class Utils {
             const requestJson = requestBody.content["application/json"];
             if (Object.keys(requestJson).length !== 0) {
                 const schema = requestJson.schema;
-                const [requiredP, optionalP] = Utils.generateParametersFromSchema(schema, "requestBody", allowMultipleParameters, requestBody.required);
+                const [requiredP, optionalP] = Utils.generateParametersFromSchema(schema, "requestBody", !!options.allowMultipleParameters, requestBody.required);
                 requiredParams.push(...requiredP);
                 optionalParams.push(...optionalP);
             }
@@ -692,14 +716,13 @@ class Utils {
         }
         return [command, warning];
     }
-    static listSupportedAPIs(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot) {
+    static listSupportedAPIs(spec, options) {
         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.isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot)) {
+                if (Utils.isSupportedApi(method, path, spec, options)) {
                     const operationObject = methods[method];
                     result[`${method.toUpperCase()} ${path}`] = operationObject;
                 }
@@ -707,7 +730,7 @@ class Utils {
         }
         return result;
     }
-    static validateSpec(spec, parser, isSwaggerFile, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot) {
+    static validateSpec(spec, parser, isSwaggerFile, options) {
         const errors = [];
         const warnings = [];
         if (isSwaggerFile) {
@@ -717,7 +740,7 @@ class Utils {
             });
         }
         // Server validation
-        const serverErrors = Utils.validateServer(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot);
+        const serverErrors = Utils.validateServer(spec, options);
         errors.push(...serverErrors);
         // Remote reference not supported
         const refPaths = parser.$refs.paths();
@@ -730,7 +753,7 @@ class Utils {
             });
         }
         // No supported API
-        const apiMap = Utils.listSupportedAPIs(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot);
+        const apiMap = Utils.listSupportedAPIs(spec, options);
         if (Object.keys(apiMap).length === 0) {
             errors.push({
                 type: ErrorType.NoSupportedApi,
@@ -801,7 +824,8 @@ class SpecParser {
             allowAPIKeyAuth: false,
             allowMultipleParameters: false,
             allowOauth2: false,
-            isCopilot: false,
+            allowMethods: ["get", "post"],
+            projectType: ProjectType.SME,
         };
         this.pathOrSpec = pathOrDoc;
         this.parser = new SwaggerParser();
@@ -839,7 +863,7 @@ class SpecParser {
                         ],
                     };
                 }
-                return Utils.validateSpec(this.spec, this.parser, !!this.isSwaggerFile, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2, this.options.isCopilot);
+                return Utils.validateSpec(this.spec, this.parser, !!this.isSwaggerFile, this.options);
             }
             catch (err) {
                 throw new SpecParserError(err.toString(), ErrorType.ValidateFailed);
@@ -860,7 +884,7 @@ class SpecParser {
                     if (!operationId) {
                         continue;
                     }
-                    const [command, warning] = Utils.parseApiInfo(pathObjectItem, this.options.allowMultipleParameters);
+                    const [command, warning] = Utils.parseApiInfo(pathObjectItem, this.options);
                     const apiInfo = {
                         method: method,
                         path: path,
@@ -924,7 +948,7 @@ class SpecParser {
      * @param isMe Boolean that indicates whether the project is an Messaging Extension. For Messaging Extension, composeExtensions will be added in Teams app manifest.
      */
     // eslint-disable-next-line @typescript-eslint/require-await
-    generate(manifestPath, filter, outputSpecPath, adaptiveCardFolder, signal, isMe) {
+    generate(manifestPath, filter, outputSpecPath, adaptiveCardFolder, signal) {
         return __awaiter(this, void 0, void 0, function* () {
             throw new Error("Method not implemented.");
         });
@@ -945,7 +969,7 @@ class SpecParser {
         if (this.apiMap !== undefined) {
             return this.apiMap;
         }
-        const result = Utils.listSupportedAPIs(spec, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2, this.options.isCopilot);
+        const result = Utils.listSupportedAPIs(spec, this.options);
         this.apiMap = result;
         return result;
     }