@microsoft/m365-spec-parser 0.1.0 → 0.1.1-alpha.0de595af8.0

package/dist/index.esm2017.js

@@ -15,7 +15,8 @@ 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["SpecVersionNotSupported"] = "spec-version-not-supported";
     ErrorType["ListFailed"] = "list-failed";
     ErrorType["listSupportedAPIInfoFailed"] = "list-supported-api-info-failed";
     ErrorType["FilterSpecFailed"] = "filter-spec-failed";
@@ -23,6 +24,22 @@ var ErrorType;
     ErrorType["GenerateAdaptiveCardFailed"] = "generate-adaptive-card-failed";
     ErrorType["GenerateFailed"] = "generate-failed";
     ErrorType["ValidateFailed"] = "validate-failed";
+    ErrorType["GetSpecFailed"] = "get-spec-failed";
+    ErrorType["AuthTypeIsNotSupported"] = "auth-type-is-not-supported";
+    ErrorType["MissingOperationId"] = "missing-operation-id";
+    ErrorType["PostBodyContainMultipleMediaTypes"] = "post-body-contain-multiple-media-types";
+    ErrorType["ResponseContainMultipleMediaTypes"] = "response-contain-multiple-media-types";
+    ErrorType["ResponseJsonIsEmpty"] = "response-json-is-empty";
+    ErrorType["PostBodySchemaIsNotJson"] = "post-body-schema-is-not-json";
+    ErrorType["PostBodyContainsRequiredUnsupportedSchema"] = "post-body-contains-required-unsupported-schema";
+    ErrorType["ParamsContainRequiredUnsupportedSchema"] = "params-contain-required-unsupported-schema";
+    ErrorType["ParamsContainsNestedObject"] = "params-contains-nested-object";
+    ErrorType["RequestBodyContainsNestedObject"] = "request-body-contains-nested-object";
+    ErrorType["ExceededRequiredParamsLimit"] = "exceeded-required-params-limit";
+    ErrorType["NoParameter"] = "no-parameter";
+    ErrorType["NoAPIInfo"] = "no-api-info";
+    ErrorType["MethodNotAllowed"] = "method-not-allowed";
+    ErrorType["UrlPathNotExist"] = "url-path-not-exist";
     ErrorType["Cancelled"] = "cancelled";
     ErrorType["Unknown"] = "unknown";
 })(ErrorType || (ErrorType = {}));
@@ -45,7 +62,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 {
@@ -72,7 +95,9 @@ 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.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.UnsupportedSchema = "Unsupported schema in %s %s: %s";
 ConstantString.WrappedCardVersion = "devPreview";
 ConstantString.WrappedCardSchema = "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.ResponseRenderingTemplate.schema.json";
 ConstantString.WrappedCardResponseLayout = "list";
@@ -84,6 +109,7 @@ ConstantString.AdaptiveCardType = "AdaptiveCard";
 ConstantString.TextBlockType = "TextBlock";
 ConstantString.ContainerType = "Container";
 ConstantString.RegistrationIdPostfix = "REGISTRATION_ID";
+ConstantString.OAuthRegistrationIdPostFix = "OAUTH_REGISTRATION_ID";
 ConstantString.ResponseCodeFor20X = [
     "200",
     "201",
@@ -143,205 +169,35 @@ 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 {
-    static checkParameters(paramObject) {
-        const paramResult = {
-            requiredNum: 0,
-            optionalNum: 0,
-            isValid: true,
-        };
-        if (!paramObject) {
-            return paramResult;
-        }
-        for (let i = 0; i < paramObject.length; i++) {
-            const param = paramObject[i];
-            const schema = param.schema;
-            const isRequiredWithoutDefault = param.required && schema.default === undefined;
-            if (param.in === "header" || param.in === "cookie") {
-                if (isRequiredWithoutDefault) {
-                    paramResult.isValid = false;
-                }
-                continue;
-            }
-            if (schema.type !== "boolean" &&
-                schema.type !== "string" &&
-                schema.type !== "number" &&
-                schema.type !== "integer") {
-                if (isRequiredWithoutDefault) {
-                    paramResult.isValid = false;
-                }
-                continue;
-            }
-            if (param.in === "query" || param.in === "path") {
-                if (isRequiredWithoutDefault) {
-                    paramResult.requiredNum = paramResult.requiredNum + 1;
-                }
-                else {
-                    paramResult.optionalNum = paramResult.optionalNum + 1;
-                }
-            }
-        }
-        return paramResult;
-    }
-    static checkPostBody(schema, isRequired = false) {
-        var _a;
-        const paramResult = {
-            requiredNum: 0,
-            optionalNum: 0,
-            isValid: true,
-        };
-        if (Object.keys(schema).length === 0) {
-            return paramResult;
-        }
-        const isRequiredWithoutDefault = isRequired && schema.default === undefined;
-        if (schema.type === "string" ||
-            schema.type === "integer" ||
-            schema.type === "boolean" ||
-            schema.type === "number") {
-            if (isRequiredWithoutDefault) {
-                paramResult.requiredNum = paramResult.requiredNum + 1;
-            }
-            else {
-                paramResult.optionalNum = paramResult.optionalNum + 1;
-            }
-        }
-        else if (schema.type === "object") {
-            const { properties } = schema;
-            for (const property in properties) {
-                let isRequired = false;
-                if (schema.required && ((_a = schema.required) === null || _a === void 0 ? void 0 : _a.indexOf(property)) >= 0) {
-                    isRequired = true;
-                }
-                const result = Utils.checkPostBody(properties[property], isRequired);
-                paramResult.requiredNum += result.requiredNum;
-                paramResult.optionalNum += result.optionalNum;
-                paramResult.isValid = paramResult.isValid && result.isValid;
-            }
-        }
-        else {
-            if (isRequiredWithoutDefault) {
-                paramResult.isValid = false;
-            }
-        }
-        return paramResult;
-    }
-    /**
-     * Checks if the given API is supported.
-     * @param {string} method - The HTTP method of the API.
-     * @param {string} path - The path of the API.
-     * @param {OpenAPIV3.Document} spec - The OpenAPI specification document.
-     * @returns {boolean} - Returns true if the API is supported, false otherwise.
-     * @description The following APIs are supported:
-     * 1. only support Get/Post operation without auth property
-     * 2. parameter inside query or path only support string, number, boolean and integer
-     * 3. parameter inside post body only support string, number, boolean, integer and object
-     * 4. request body + required parameters <= 1
-     * 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) {
-        const pathObj = spec.paths[path];
-        method = method.toLocaleLowerCase();
-        if (pathObj) {
-            if ((method === ConstantString.PostMethod || method === ConstantString.GetMethod) &&
-                pathObj[method]) {
-                const securities = pathObj[method].security;
-                const authArray = Utils.getAuthArray(securities, spec);
-                if (!Utils.isSupportedAuth(authArray, allowAPIKeyAuth, allowOauth2)) {
-                    return false;
-                }
-                const operationObject = pathObj[method];
-                if (!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) {
-                    return false;
-                }
-                const responseJson = Utils.getResponseJson(operationObject);
-                if (Object.keys(responseJson).length === 0) {
-                    return false;
-                }
-                let requestBodyParamResult = {
-                    requiredNum: 0,
-                    optionalNum: 0,
-                    isValid: true,
-                };
-                if (requestJsonBody) {
-                    const requestBodySchema = requestJsonBody.schema;
-                    requestBodyParamResult = Utils.checkPostBody(requestBodySchema, requestBody.required);
-                }
-                if (!requestBodyParamResult.isValid) {
-                    return false;
-                }
-                const paramResult = Utils.checkParameters(paramObject);
-                if (!paramResult.isValid) {
-                    return false;
-                }
-                if (requestBodyParamResult.requiredNum + paramResult.requiredNum > 1) {
-                    if (allowMultipleParameters &&
-                        requestBodyParamResult.requiredNum + paramResult.requiredNum <= 5) {
-                        return true;
-                    }
-                    return false;
-                }
-                else if (requestBodyParamResult.requiredNum +
-                    requestBodyParamResult.optionalNum +
-                    paramResult.requiredNum +
-                    paramResult.optionalNum ===
-                    0) {
-                    return false;
-                }
-                else {
+    static hasNestedObjectInSchema(schema) {
+        if (schema.type === "object") {
+            for (const property in schema.properties) {
+                const nestedSchema = schema.properties[property];
+                if (nestedSchema.type === "object") {
                     return true;
                 }
             }
         }
         return false;
     }
-    static isSupportedAuth(authSchemaArray, allowAPIKeyAuth, allowOauth2) {
-        if (authSchemaArray.length === 0) {
-            return true;
-        }
-        if (allowAPIKeyAuth || 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)) {
-                        return true;
-                    }
-                    else if (!allowAPIKeyAuth &&
-                        allowOauth2 &&
-                        Utils.isBearerTokenAuth(auths[0].authSchema)) {
-                        return true;
-                    }
-                    else if (allowAPIKeyAuth &&
-                        allowOauth2 &&
-                        (Utils.isAPIKeyAuth(auths[0].authSchema) ||
-                            Utils.isBearerTokenAuth(auths[0].authSchema))) {
-                        return true;
-                    }
-                }
-            }
-        }
-        return false;
+    static containMultipleMediaTypes(bodyObject) {
+        return Object.keys((bodyObject === null || bodyObject === void 0 ? void 0 : bodyObject.content) || {}).length > 1;
+    }
+    static isBearerTokenAuth(authScheme) {
+        return authScheme.type === "http" && authScheme.scheme === "bearer";
     }
-    static isAPIKeyAuth(authSchema) {
-        return authSchema.type === "apiKey";
+    static isAPIKeyAuth(authScheme) {
+        return authScheme.type === "apiKey";
     }
-    static isBearerTokenAuth(authSchema) {
-        return (authSchema.type === "oauth2" ||
-            authSchema.type === "openIdConnect" ||
-            (authSchema.type === "http" && authSchema.scheme === "bearer"));
+    static isOAuthWithAuthCodeFlow(authScheme) {
+        return !!(authScheme.type === "oauth2" &&
+            authScheme.flows &&
+            authScheme.flows.authorizationCode);
     }
     static getAuthArray(securities, spec) {
         var _a;
@@ -354,7 +210,7 @@ class Utils {
                 for (const name in security) {
                     const auth = securitySchemas[name];
                     authArray.push({
-                        authSchema: auth,
+                        authScheme: auth,
                         name: name,
                     });
                 }
@@ -372,18 +228,22 @@ class Utils {
     static getResponseJson(operationObject) {
         var _a, _b;
         let json = {};
+        let multipleMediaType = false;
         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"]) {
+                multipleMediaType = false;
                 json = responseObject.content["application/json"];
-                break;
+                if (Utils.containMultipleMediaTypes(responseObject)) {
+                    multipleMediaType = true;
+                    json = {};
+                }
+                else {
+                    break;
+                }
             }
         }
-        return json;
+        return { json, multipleMediaType };
     }
     static convertPathToCamelCase(path) {
         const pathSegments = path.split(/[./{]/);
@@ -403,10 +263,10 @@ class Utils {
             return undefined;
         }
     }
-    static resolveServerUrl(url) {
+    static resolveEnv(str) {
         const placeHolderReg = /\${{\s*([a-zA-Z_][a-zA-Z0-9_]*)\s*}}/g;
-        let matches = placeHolderReg.exec(url);
-        let newUrl = url;
+        let matches = placeHolderReg.exec(str);
+        let newStr = str;
         while (matches != null) {
             const envVar = matches[1];
             const envVal = process.env[envVar];
@@ -414,17 +274,17 @@ class Utils {
                 throw new Error(Utils.format(ConstantString.ResolveServerUrlFailed, envVar));
             }
             else {
-                newUrl = newUrl.replace(matches[0], envVal);
+                newStr = newStr.replace(matches[0], envVal);
             }
-            matches = placeHolderReg.exec(url);
+            matches = placeHolderReg.exec(str);
         }
-        return newUrl;
+        return newStr;
     }
     static checkServerUrl(servers) {
         const errors = [];
         let serverUrl;
         try {
-            serverUrl = Utils.resolveServerUrl(servers[0].url);
+            serverUrl = Utils.resolveEnv(servers[0].url);
         }
         catch (err) {
             errors.push({
@@ -454,7 +314,8 @@ class Utils {
         }
         return errors;
     }
-    static validateServer(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2) {
+    static validateServer(spec, options) {
+        var _a;
         const errors = [];
         let hasTopLevelServers = false;
         let hasPathLevelServers = false;
@@ -475,7 +336,7 @@ class Utils {
             }
             for (const method in methods) {
                 const operationObject = methods[method];
-                if (Utils.isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2)) {
+                if (((_a = options.allowMethods) === null || _a === void 0 ? void 0 : _a.includes(method)) && operationObject) {
                     if ((operationObject === null || operationObject === void 0 ? void 0 : operationObject.servers) && operationObject.servers.length >= 1) {
                         hasOperationLevelServers = true;
                         const serverErrors = Utils.checkServerUrl(operationObject.servers);
@@ -518,6 +379,7 @@ class Utils {
                 Utils.updateParameterWithInputType(schema, parameter);
             }
             if (isRequired && schema.default === undefined) {
+                parameter.isRequired = true;
                 requiredParams.push(parameter);
             }
             else {
@@ -562,7 +424,7 @@ class Utils {
             param.value = schema.default;
         }
     }
-    static parseApiInfo(operationItem, allowMultipleParameters) {
+    static parseApiInfo(operationItem, options) {
         var _a, _b;
         const requiredParams = [];
         const optionalParams = [];
@@ -576,11 +438,12 @@ 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") {
                     if (param.required && (schema === null || schema === void 0 ? void 0 : schema.default) === undefined) {
+                        parameter.isRequired = true;
                         requiredParams.push(parameter);
                     }
                     else {
@@ -594,19 +457,13 @@ 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);
             }
         }
         const operationId = operationItem.operationId;
-        const parameters = [];
-        if (requiredParams.length !== 0) {
-            parameters.push(...requiredParams);
-        }
-        else {
-            parameters.push(optionalParams[0]);
-        }
+        const parameters = [...requiredParams, ...optionalParams];
         const command = {
             context: ["compose"],
             type: "query",
@@ -615,32 +472,9 @@ class Utils {
             parameters: parameters,
             description: ((_b = operationItem.description) !== null && _b !== void 0 ? _b : "").slice(0, ConstantString.CommandDescriptionMaxLens),
         };
-        let warning = undefined;
-        if (requiredParams.length === 0 && optionalParams.length > 1) {
-            warning = {
-                type: WarningType.OperationOnlyContainsOptionalParam,
-                content: Utils.format(ConstantString.OperationOnlyContainsOptionalParam, operationId),
-                data: operationId,
-            };
-        }
-        return [command, warning];
-    }
-    static listSupportedAPIs(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2) {
-        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)) {
-                    const operationObject = methods[method];
-                    result[`${method.toUpperCase()} ${path}`] = operationObject;
-                }
-            }
-        }
-        return result;
+        return command;
     }
-    static validateSpec(spec, parser, isSwaggerFile, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2) {
+    static validateSpec(spec, parser, apiMap, isSwaggerFile, options) {
         const errors = [];
         const warnings = [];
         if (isSwaggerFile) {
@@ -649,8 +483,7 @@ class Utils {
                 content: ConstantString.ConvertSwaggerToOpenAPI,
             });
         }
-        // Server validation
-        const serverErrors = Utils.validateServer(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2);
+        const serverErrors = Utils.validateServer(spec, options);
         errors.push(...serverErrors);
         // Remote reference not supported
         const refPaths = parser.$refs.paths();
@@ -663,8 +496,8 @@ class Utils {
             });
         }
         // No supported API
-        const apiMap = Utils.listSupportedAPIs(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2);
-        if (Object.keys(apiMap).length === 0) {
+        const validAPIs = Object.entries(apiMap).filter(([, value]) => value.isValid);
+        if (validAPIs.length === 0) {
             errors.push({
                 type: ErrorType.NoSupportedApi,
                 content: ConstantString.NoSupportedApi,
@@ -673,8 +506,8 @@ class Utils {
         // OperationId missing
         const apisMissingOperationId = [];
         for (const key in apiMap) {
-            const pathObjectItem = apiMap[key];
-            if (!pathObjectItem.operationId) {
+            const { operation } = apiMap[key];
+            if (!operation.operationId) {
                 apisMissingOperationId.push(key);
             }
         }
@@ -715,6 +548,402 @@ 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.
+class Validator {
+    validateMethodAndPath(method, path) {
+        const result = { isValid: true, reason: [] };
+        if (this.options.allowMethods && !this.options.allowMethods.includes(method)) {
+            result.isValid = false;
+            result.reason.push(ErrorType.MethodNotAllowed);
+            return result;
+        }
+        const pathObj = this.spec.paths[path];
+        if (!pathObj || !pathObj[method]) {
+            result.isValid = false;
+            result.reason.push(ErrorType.UrlPathNotExist);
+            return result;
+        }
+        return result;
+    }
+    validateResponse(method, path) {
+        const result = { isValid: true, reason: [] };
+        const operationObject = this.spec.paths[path][method];
+        const { json, multipleMediaType } = Utils.getResponseJson(operationObject);
+        // only support response body only contains “application/json” content type
+        if (multipleMediaType) {
+            result.reason.push(ErrorType.ResponseContainMultipleMediaTypes);
+        }
+        else if (Object.keys(json).length === 0) {
+            // response body should not be empty
+            result.reason.push(ErrorType.ResponseJsonIsEmpty);
+        }
+        return result;
+    }
+    validateServer(method, path) {
+        const pathObj = this.spec.paths[path];
+        const result = { isValid: true, reason: [] };
+        const operationObject = pathObj[method];
+        const rootServer = this.spec.servers && this.spec.servers[0];
+        const methodServer = this.spec.paths[path].servers && this.spec.paths[path].servers[0];
+        const operationServer = operationObject.servers && operationObject.servers[0];
+        const serverUrl = operationServer || methodServer || rootServer;
+        if (!serverUrl) {
+            // should contain server URL
+            result.reason.push(ErrorType.NoServerInformation);
+        }
+        else {
+            // server url should be absolute url with https protocol
+            const serverValidateResult = Utils.checkServerUrl([serverUrl]);
+            result.reason.push(...serverValidateResult.map((item) => item.type));
+        }
+        return result;
+    }
+    validateAuth(method, path) {
+        const pathObj = this.spec.paths[path];
+        const operationObject = pathObj[method];
+        const securities = operationObject.security;
+        const authSchemeArray = Utils.getAuthArray(securities, this.spec);
+        if (authSchemeArray.length === 0) {
+            return { isValid: true, reason: [] };
+        }
+        if (this.options.allowAPIKeyAuth ||
+            this.options.allowOauth2 ||
+            this.options.allowBearerTokenAuth) {
+            // Currently we don't support multiple auth in one operation
+            if (authSchemeArray.length > 0 && authSchemeArray.every((auths) => auths.length > 1)) {
+                return {
+                    isValid: false,
+                    reason: [ErrorType.MultipleAuthNotSupported],
+                };
+            }
+            for (const auths of authSchemeArray) {
+                if (auths.length === 1) {
+                    if ((this.options.allowAPIKeyAuth && Utils.isAPIKeyAuth(auths[0].authScheme)) ||
+                        (this.options.allowOauth2 && Utils.isOAuthWithAuthCodeFlow(auths[0].authScheme)) ||
+                        (this.options.allowBearerTokenAuth && Utils.isBearerTokenAuth(auths[0].authScheme))) {
+                        return { isValid: true, reason: [] };
+                    }
+                }
+            }
+        }
+        return { isValid: false, reason: [ErrorType.AuthTypeIsNotSupported] };
+    }
+    checkPostBodySchema(schema, isRequired = false) {
+        var _a;
+        const paramResult = {
+            requiredNum: 0,
+            optionalNum: 0,
+            isValid: true,
+            reason: [],
+        };
+        if (Object.keys(schema).length === 0) {
+            return paramResult;
+        }
+        const isRequiredWithoutDefault = isRequired && schema.default === undefined;
+        const isCopilot = this.projectType === ProjectType.Copilot;
+        if (isCopilot && this.hasNestedObjectInSchema(schema)) {
+            paramResult.isValid = false;
+            paramResult.reason = [ErrorType.RequestBodyContainsNestedObject];
+            return paramResult;
+        }
+        if (schema.type === "string" ||
+            schema.type === "integer" ||
+            schema.type === "boolean" ||
+            schema.type === "number") {
+            if (isRequiredWithoutDefault) {
+                paramResult.requiredNum = paramResult.requiredNum + 1;
+            }
+            else {
+                paramResult.optionalNum = paramResult.optionalNum + 1;
+            }
+        }
+        else if (schema.type === "object") {
+            const { properties } = schema;
+            for (const property in properties) {
+                let isRequired = false;
+                if (schema.required && ((_a = schema.required) === null || _a === void 0 ? void 0 : _a.indexOf(property)) >= 0) {
+                    isRequired = true;
+                }
+                const result = this.checkPostBodySchema(properties[property], isRequired);
+                paramResult.requiredNum += result.requiredNum;
+                paramResult.optionalNum += result.optionalNum;
+                paramResult.isValid = paramResult.isValid && result.isValid;
+                paramResult.reason.push(...result.reason);
+            }
+        }
+        else {
+            if (isRequiredWithoutDefault && !isCopilot) {
+                paramResult.isValid = false;
+                paramResult.reason.push(ErrorType.PostBodyContainsRequiredUnsupportedSchema);
+            }
+        }
+        return paramResult;
+    }
+    checkParamSchema(paramObject) {
+        const paramResult = {
+            requiredNum: 0,
+            optionalNum: 0,
+            isValid: true,
+            reason: [],
+        };
+        if (!paramObject) {
+            return paramResult;
+        }
+        const isCopilot = this.projectType === ProjectType.Copilot;
+        for (let i = 0; i < paramObject.length; i++) {
+            const param = paramObject[i];
+            const schema = param.schema;
+            if (isCopilot && this.hasNestedObjectInSchema(schema)) {
+                paramResult.isValid = false;
+                paramResult.reason.push(ErrorType.ParamsContainsNestedObject);
+                continue;
+            }
+            const isRequiredWithoutDefault = param.required && schema.default === undefined;
+            if (isCopilot) {
+                if (isRequiredWithoutDefault) {
+                    paramResult.requiredNum = paramResult.requiredNum + 1;
+                }
+                else {
+                    paramResult.optionalNum = paramResult.optionalNum + 1;
+                }
+                continue;
+            }
+            if (param.in === "header" || param.in === "cookie") {
+                if (isRequiredWithoutDefault) {
+                    paramResult.isValid = false;
+                    paramResult.reason.push(ErrorType.ParamsContainRequiredUnsupportedSchema);
+                }
+                continue;
+            }
+            if (schema.type !== "boolean" &&
+                schema.type !== "string" &&
+                schema.type !== "number" &&
+                schema.type !== "integer") {
+                if (isRequiredWithoutDefault) {
+                    paramResult.isValid = false;
+                    paramResult.reason.push(ErrorType.ParamsContainRequiredUnsupportedSchema);
+                }
+                continue;
+            }
+            if (param.in === "query" || param.in === "path") {
+                if (isRequiredWithoutDefault) {
+                    paramResult.requiredNum = paramResult.requiredNum + 1;
+                }
+                else {
+                    paramResult.optionalNum = paramResult.optionalNum + 1;
+                }
+            }
+        }
+        return paramResult;
+    }
+    hasNestedObjectInSchema(schema) {
+        if (schema.type === "object") {
+            for (const property in schema.properties) {
+                const nestedSchema = schema.properties[property];
+                if (nestedSchema.type === "object") {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+}
+
+// Copyright (c) Microsoft Corporation.
+class CopilotValidator extends Validator {
+    constructor(spec, options) {
+        super();
+        this.projectType = ProjectType.Copilot;
+        this.options = options;
+        this.spec = spec;
+    }
+    validateAPI(method, path) {
+        const result = { isValid: true, reason: [] };
+        method = method.toLocaleLowerCase();
+        // validate method and path
+        const methodAndPathResult = this.validateMethodAndPath(method, path);
+        if (!methodAndPathResult.isValid) {
+            return methodAndPathResult;
+        }
+        const operationObject = this.spec.paths[path][method];
+        // validate auth
+        const authCheckResult = this.validateAuth(method, path);
+        result.reason.push(...authCheckResult.reason);
+        // validate operationId
+        if (!this.options.allowMissingId && !operationObject.operationId) {
+            result.reason.push(ErrorType.MissingOperationId);
+        }
+        // validate server
+        const validateServerResult = this.validateServer(method, path);
+        result.reason.push(...validateServerResult.reason);
+        // validate response
+        const validateResponseResult = this.validateResponse(method, path);
+        result.reason.push(...validateResponseResult.reason);
+        // validate requestBody
+        const requestBody = operationObject.requestBody;
+        const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
+        if (Utils.containMultipleMediaTypes(requestBody)) {
+            result.reason.push(ErrorType.PostBodyContainMultipleMediaTypes);
+        }
+        if (requestJsonBody) {
+            const requestBodySchema = requestJsonBody.schema;
+            if (requestBodySchema.type !== "object") {
+                result.reason.push(ErrorType.PostBodySchemaIsNotJson);
+            }
+            const requestBodyParamResult = this.checkPostBodySchema(requestBodySchema, requestBody.required);
+            result.reason.push(...requestBodyParamResult.reason);
+        }
+        // validate parameters
+        const paramObject = operationObject.parameters;
+        const paramResult = this.checkParamSchema(paramObject);
+        result.reason.push(...paramResult.reason);
+        if (result.reason.length > 0) {
+            result.isValid = false;
+        }
+        return result;
+    }
+}
+
+// Copyright (c) Microsoft Corporation.
+class SMEValidator extends Validator {
+    constructor(spec, options) {
+        super();
+        this.projectType = ProjectType.SME;
+        this.options = options;
+        this.spec = spec;
+    }
+    validateAPI(method, path) {
+        const result = { isValid: true, reason: [] };
+        method = method.toLocaleLowerCase();
+        // validate method and path
+        const methodAndPathResult = this.validateMethodAndPath(method, path);
+        if (!methodAndPathResult.isValid) {
+            return methodAndPathResult;
+        }
+        const operationObject = this.spec.paths[path][method];
+        // validate auth
+        const authCheckResult = this.validateAuth(method, path);
+        result.reason.push(...authCheckResult.reason);
+        // validate operationId
+        if (!this.options.allowMissingId && !operationObject.operationId) {
+            result.reason.push(ErrorType.MissingOperationId);
+        }
+        // validate server
+        const validateServerResult = this.validateServer(method, path);
+        result.reason.push(...validateServerResult.reason);
+        // validate response
+        const validateResponseResult = this.validateResponse(method, path);
+        result.reason.push(...validateResponseResult.reason);
+        let postBodyResult = {
+            requiredNum: 0,
+            optionalNum: 0,
+            isValid: true,
+            reason: [],
+        };
+        // validate requestBody
+        const requestBody = operationObject.requestBody;
+        const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
+        if (Utils.containMultipleMediaTypes(requestBody)) {
+            result.reason.push(ErrorType.PostBodyContainMultipleMediaTypes);
+        }
+        if (requestJsonBody) {
+            const requestBodySchema = requestJsonBody.schema;
+            postBodyResult = this.checkPostBodySchema(requestBodySchema, requestBody.required);
+            result.reason.push(...postBodyResult.reason);
+        }
+        // validate parameters
+        const paramObject = operationObject.parameters;
+        const paramResult = this.checkParamSchema(paramObject);
+        result.reason.push(...paramResult.reason);
+        // validate total parameters count
+        if (paramResult.isValid && postBodyResult.isValid) {
+            const paramCountResult = this.validateParamCount(postBodyResult, paramResult);
+            result.reason.push(...paramCountResult.reason);
+        }
+        if (result.reason.length > 0) {
+            result.isValid = false;
+        }
+        return result;
+    }
+    validateParamCount(postBodyResult, paramResult) {
+        const result = { isValid: true, reason: [] };
+        const totalRequiredParams = postBodyResult.requiredNum + paramResult.requiredNum;
+        const totalParams = totalRequiredParams + postBodyResult.optionalNum + paramResult.optionalNum;
+        if (totalRequiredParams > 1) {
+            if (!this.options.allowMultipleParameters ||
+                totalRequiredParams > SMEValidator.SMERequiredParamsMaxNum) {
+                result.reason.push(ErrorType.ExceededRequiredParamsLimit);
+            }
+        }
+        else if (totalParams === 0) {
+            result.reason.push(ErrorType.NoParameter);
+        }
+        return result;
+    }
+}
+SMEValidator.SMERequiredParamsMaxNum = 5;
+
+// Copyright (c) Microsoft Corporation.
+class TeamsAIValidator extends Validator {
+    constructor(spec, options) {
+        super();
+        this.projectType = ProjectType.TeamsAi;
+        this.options = options;
+        this.spec = spec;
+    }
+    validateAPI(method, path) {
+        const result = { isValid: true, reason: [] };
+        method = method.toLocaleLowerCase();
+        // validate method and path
+        const methodAndPathResult = this.validateMethodAndPath(method, path);
+        if (!methodAndPathResult.isValid) {
+            return methodAndPathResult;
+        }
+        const operationObject = this.spec.paths[path][method];
+        // validate operationId
+        if (!this.options.allowMissingId && !operationObject.operationId) {
+            result.reason.push(ErrorType.MissingOperationId);
+        }
+        // validate server
+        const validateServerResult = this.validateServer(method, path);
+        result.reason.push(...validateServerResult.reason);
+        if (result.reason.length > 0) {
+            result.isValid = false;
+        }
+        return result;
+    }
+}
+
+class ValidatorFactory {
+    static create(spec, options) {
+        var _a;
+        const type = (_a = options.projectType) !== null && _a !== void 0 ? _a : ProjectType.SME;
+        switch (type) {
+            case ProjectType.SME:
+                return new SMEValidator(spec, options);
+            case ProjectType.Copilot:
+                return new CopilotValidator(spec, options);
+            case ProjectType.TeamsAi:
+                return new TeamsAIValidator(spec, options);
+            default:
+                throw new Error(`Invalid project type: ${type}`);
+        }
+    }
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -733,7 +962,10 @@ class SpecParser {
             allowSwagger: false,
             allowAPIKeyAuth: false,
             allowMultipleParameters: false,
+            allowBearerTokenAuth: false,
             allowOauth2: false,
+            allowMethods: ["get", "post"],
+            projectType: ProjectType.SME,
         };
         this.pathOrSpec = pathOrDoc;
         this.parser = new SwaggerParser();
@@ -770,7 +1002,8 @@ class SpecParser {
                     ],
                 };
             }
-            return Utils.validateSpec(this.spec, this.parser, !!this.isSwaggerFile, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2);
+            const apiMap = this.getAPIs(this.spec);
+            return Utils.validateSpec(this.spec, this.parser, apiMap, !!this.isSwaggerFile, this.options);
         }
         catch (err) {
             throw new SpecParserError(err.toString(), ErrorType.ValidateFailed);
@@ -779,17 +1012,20 @@ class SpecParser {
     async listSupportedAPIInfo() {
         try {
             await this.loadSpec();
-            const apiMap = this.getAllSupportedAPIs(this.spec);
+            const apiMap = this.getAPIs(this.spec);
             const apiInfos = [];
             for (const key in apiMap) {
-                const pathObjectItem = apiMap[key];
+                const { operation, isValid } = apiMap[key];
+                if (!isValid) {
+                    continue;
+                }
                 const [method, path] = key.split(" ");
-                const operationId = pathObjectItem.operationId;
+                const operationId = operation.operationId;
                 // In Browser environment, this api is by default not support api without operationId
                 if (!operationId) {
                     continue;
                 }
-                const [command, warning] = Utils.parseApiInfo(pathObjectItem, this.options.allowMultipleParameters);
+                const command = Utils.parseApiInfo(operation, this.options);
                 const apiInfo = {
                     method: method,
                     path: path,
@@ -798,9 +1034,6 @@ class SpecParser {
                     parameters: command.parameters,
                     description: command.description,
                 };
-                if (warning) {
-                    apiInfo.warning = warning;
-                }
                 apiInfos.push(apiInfo);
             }
             return apiInfos;
@@ -818,12 +1051,32 @@ class SpecParser {
     async list() {
         throw new Error("Method not implemented.");
     }
+    /**
+     * Generate specs according to the filters.
+     * @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
+     */
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async getFilteredSpecs(filter, signal) {
+        throw new Error("Method not implemented.");
+    }
+    /**
+     * 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.
+     * @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
+     * @param outputSpecPath File path of the new OpenAPI specification file to generate. If not specified or empty, no spec file will be generated.
+     * @param pluginFilePath File path of the api plugin file to generate.
+     */
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async generateForCopilot(manifestPath, filter, outputSpecPath, pluginFilePath, signal) {
+        throw new Error("Method not implemented.");
+    }
     /**
      * 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.
      * @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
      * @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.
+     * @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
     async generate(manifestPath, filter, outputSpecPath, adaptiveCardFolder, signal) {
@@ -839,15 +1092,194 @@ class SpecParser {
             this.spec = (await this.parser.dereference(clonedUnResolveSpec));
         }
     }
-    getAllSupportedAPIs(spec) {
+    getAPIs(spec) {
         if (this.apiMap !== undefined) {
             return this.apiMap;
         }
-        const result = Utils.listSupportedAPIs(spec, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2);
+        const result = this.listAPIs(spec);
         this.apiMap = result;
         return result;
     }
+    listAPIs(spec) {
+        var _a;
+        const paths = spec.paths;
+        const result = {};
+        for (const path in paths) {
+            const methods = paths[path];
+            for (const method in methods) {
+                const operationObject = methods[method];
+                if (((_a = this.options.allowMethods) === null || _a === void 0 ? void 0 : _a.includes(method)) && operationObject) {
+                    const validator = ValidatorFactory.create(spec, this.options);
+                    const validateResult = validator.validateAPI(method, path);
+                    result[`${method.toUpperCase()} ${path}`] = {
+                        operation: operationObject,
+                        isValid: validateResult.isValid,
+                        reason: validateResult.reason,
+                    };
+                }
+            }
+        }
+        return result;
+    }
+}
+
+// Copyright (c) Microsoft Corporation.
+class AdaptiveCardGenerator {
+    static generateAdaptiveCard(operationItem) {
+        try {
+            const { json } = Utils.getResponseJson(operationItem);
+            let cardBody = [];
+            let schema = json.schema;
+            let jsonPath = "$";
+            if (schema && Object.keys(schema).length > 0) {
+                jsonPath = AdaptiveCardGenerator.getResponseJsonPathFromSchema(schema);
+                if (jsonPath !== "$") {
+                    schema = schema.properties[jsonPath];
+                }
+                cardBody = AdaptiveCardGenerator.generateCardFromResponse(schema, "");
+            }
+            // if no schema, try to use example value
+            if (cardBody.length === 0 && (json.examples || json.example)) {
+                cardBody = [
+                    {
+                        type: ConstantString.TextBlockType,
+                        text: "${jsonStringify($root)}",
+                        wrap: true,
+                    },
+                ];
+            }
+            // if no example value, use default success response
+            if (cardBody.length === 0) {
+                cardBody = [
+                    {
+                        type: ConstantString.TextBlockType,
+                        text: "success",
+                        wrap: true,
+                    },
+                ];
+            }
+            const fullCard = {
+                type: ConstantString.AdaptiveCardType,
+                $schema: ConstantString.AdaptiveCardSchema,
+                version: ConstantString.AdaptiveCardVersion,
+                body: cardBody,
+            };
+            return [fullCard, jsonPath];
+        }
+        catch (err) {
+            throw new SpecParserError(err.toString(), ErrorType.GenerateAdaptiveCardFailed);
+        }
+    }
+    static generateCardFromResponse(schema, name, parentArrayName = "") {
+        if (schema.type === "array") {
+            // schema.items can be arbitrary object: schema { type: array, items: {} }
+            if (Object.keys(schema.items).length === 0) {
+                return [
+                    {
+                        type: ConstantString.TextBlockType,
+                        text: name ? `${name}: \${jsonStringify(${name})}` : "result: ${jsonStringify($root)}",
+                        wrap: true,
+                    },
+                ];
+            }
+            const obj = AdaptiveCardGenerator.generateCardFromResponse(schema.items, "", name);
+            const template = {
+                type: ConstantString.ContainerType,
+                $data: name ? `\${${name}}` : "${$root}",
+                items: Array(),
+            };
+            template.items.push(...obj);
+            return [template];
+        }
+        // some schema may not contain type but contain properties
+        if (schema.type === "object" || (!schema.type && schema.properties)) {
+            const { properties } = schema;
+            const result = [];
+            for (const property in properties) {
+                const obj = AdaptiveCardGenerator.generateCardFromResponse(properties[property], name ? `${name}.${property}` : property, parentArrayName);
+                result.push(...obj);
+            }
+            if (schema.additionalProperties) {
+                // TODO: better ways to handler warnings.
+                console.warn(ConstantString.AdditionalPropertiesNotSupported);
+            }
+            return result;
+        }
+        if (schema.type === "string" ||
+            schema.type === "integer" ||
+            schema.type === "boolean" ||
+            schema.type === "number") {
+            if (!AdaptiveCardGenerator.isImageUrlProperty(schema, name, parentArrayName)) {
+                // string in root: "ddd"
+                let text = "result: ${$root}";
+                if (name) {
+                    // object { id: "1" }
+                    text = `${name}: \${if(${name}, ${name}, 'N/A')}`;
+                    if (parentArrayName) {
+                        // object types inside array: { tags: ["id": 1, "name": "name"] }
+                        text = `${parentArrayName}.${text}`;
+                    }
+                }
+                else if (parentArrayName) {
+                    // string array: photoUrls: ["1", "2"]
+                    text = `${parentArrayName}: ` + "${$data}";
+                }
+                return [
+                    {
+                        type: ConstantString.TextBlockType,
+                        text,
+                        wrap: true,
+                    },
+                ];
+            }
+            else {
+                if (name) {
+                    return [
+                        {
+                            type: "Image",
+                            url: `\${${name}}`,
+                            $when: `\${${name} != null}`,
+                        },
+                    ];
+                }
+                else {
+                    return [
+                        {
+                            type: "Image",
+                            url: "${$data}",
+                            $when: "${$data != null}",
+                        },
+                    ];
+                }
+            }
+        }
+        if (schema.oneOf || schema.anyOf || schema.not || schema.allOf) {
+            throw new Error(Utils.format(ConstantString.SchemaNotSupported, JSON.stringify(schema)));
+        }
+        throw new Error(Utils.format(ConstantString.UnknownSchema, JSON.stringify(schema)));
+    }
+    // Find the first array property in the response schema object with the well-known name
+    static getResponseJsonPathFromSchema(schema) {
+        if (schema.type === "object" || (!schema.type && schema.properties)) {
+            const { properties } = schema;
+            for (const property in properties) {
+                const schema = properties[property];
+                if (schema.type === "array" &&
+                    Utils.isWellKnownName(property, ConstantString.WellknownResultNames)) {
+                    return property;
+                }
+            }
+        }
+        return "$";
+    }
+    static isImageUrlProperty(schema, name, parentArrayName) {
+        const propertyName = name ? name : parentArrayName;
+        return (!!propertyName &&
+            schema.type === "string" &&
+            Utils.isWellKnownName(propertyName, ConstantString.WellknownImageName) &&
+            (propertyName.toLocaleLowerCase().indexOf("url") >= 0 || schema.format === "uri"));
+    }
 }
 
-export { ConstantString, ErrorType, SpecParser, SpecParserError, Utils, ValidationStatus, WarningType };
+export { AdaptiveCardGenerator, ConstantString, ErrorType, SpecParser, SpecParserError, Utils, ValidationStatus, WarningType };
 //# sourceMappingURL=index.esm2017.js.map