@microsoft/m365-spec-parser 0.2.4-rc.0 → 0.2.4

package/dist/index.esm5.js

@@ -62,8 +62,11 @@ var ErrorType;
     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";
@@ -83,7 +86,6 @@ 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 = {}));
@@ -131,7 +133,6 @@ 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.";
@@ -141,12 +142,17 @@ ConstantString.WrappedCardResponseLayout = "list";
 ConstantString.GetMethod = "get";
 ConstantString.PostMethod = "post";
 ConstantString.AdaptiveCardVersion = "1.5";
-ConstantString.AdaptiveCardSchema = "https://adaptivecards.io/schemas/adaptive-card.json";
+ConstantString.AdaptiveCardSchema = "http://adaptivecards.io/schemas/adaptive-card.json";
 ConstantString.AdaptiveCardType = "AdaptiveCard";
 ConstantString.TextBlockType = "TextBlock";
 ConstantString.ImageType = "Image";
 ConstantString.ContainerType = "Container";
-ConstantString.RegistrationIdPostfix = "REGISTRATION_ID";
+ConstantString.RegistrationIdPostfix = {
+    apiKey: "REGISTRATION_ID",
+    oauth2: "CONFIGURATION_ID",
+    http: "REGISTRATION_ID",
+    openIdConnect: "REGISTRATION_ID",
+};
 ConstantString.ResponseCodeFor20X = [
     "200",
     "201",
@@ -158,7 +164,6 @@ ConstantString.ResponseCodeFor20X = [
     "207",
     "208",
     "226",
-    "2XX",
     "default",
 ];
 ConstantString.AllOperationMethods = [
@@ -216,6 +221,17 @@ ConstantString.PluginManifestSchema = "https://developer.microsoft.com/json-sche
 
 // Copyright (c) Microsoft Corporation.
 class Utils {
+    static hasNestedObjectInSchema(schema) {
+        if (this.isObjectSchema(schema)) {
+            for (const property in schema.properties) {
+                const nestedSchema = schema.properties[property];
+                if (this.isObjectSchema(nestedSchema)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
     static isObjectSchema(schema) {
         return schema.type === "object" || (!schema.type && !!schema.properties);
     }
@@ -228,32 +244,11 @@ 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 = [];
@@ -278,20 +273,6 @@ 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) {
@@ -320,32 +301,26 @@ class Utils {
         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];
-            if (!responseObject) {
-                continue;
-            }
-            multipleMediaType = Utils.containMultipleMediaTypes(responseObject);
-            if (!allowMultipleMediaType && multipleMediaType) {
-                json = {};
-                continue;
-            }
-            const mediaObj = Utils.getJsonContentType(responseObject);
-            if (Object.keys(mediaObj).length > 0) {
-                json = mediaObj;
-                return { json, multipleMediaType };
-            }
-        }
-        return { json, multipleMediaType };
-    }
-    static getJsonContentType(responseObject) {
-        if (responseObject.content) {
-            for (const contentType of Object.keys(responseObject.content)) {
-                // json media type can also be "application/json; charset=utf-8"
-                if (contentType.indexOf("application/json") >= 0) {
-                    return responseObject.content[contentType];
+            if (responseObject === null || responseObject === void 0 ? void 0 : responseObject.content) {
+                for (const contentType of Object.keys(responseObject.content)) {
+                    // json media type can also be "application/json; charset=utf-8"
+                    if (contentType.indexOf("application/json") >= 0) {
+                        multipleMediaType = false;
+                        json = responseObject.content[contentType];
+                        if (Utils.containMultipleMediaTypes(responseObject)) {
+                            multipleMediaType = true;
+                            if (!allowMultipleMediaType) {
+                                json = {};
+                            }
+                        }
+                        else {
+                            return { json, multipleMediaType };
+                        }
+                    }
                 }
             }
         }
-        return {};
+        return { json, multipleMediaType };
     }
     static convertPathToCamelCase(path) {
         const pathSegments = path.split(/[./{]/);
@@ -382,7 +357,7 @@ class Utils {
         }
         return newStr;
     }
-    static checkServerUrl(servers, allowHttp = false) {
+    static checkServerUrl(servers) {
         const errors = [];
         let serverUrl;
         try {
@@ -405,7 +380,8 @@ class Utils {
                 data: servers,
             });
         }
-        else if (protocol !== "https:" && !(protocol === "http:" && allowHttp)) {
+        else if (protocol !== "https:") {
+            // Http server url is not supported
             const protocolString = protocol.slice(0, -1);
             errors.push({
                 type: ErrorType.UrlProtocolNotSupported,
@@ -421,11 +397,10 @@ class Utils {
         let hasTopLevelServers = false;
         let hasPathLevelServers = false;
         let hasOperationLevelServers = false;
-        const allowHttp = options.projectType === ProjectType.Copilot;
         if (spec.servers && spec.servers.length >= 1) {
             hasTopLevelServers = true;
             // for multiple server, we only use the first url
-            const serverErrors = Utils.checkServerUrl(spec.servers, allowHttp);
+            const serverErrors = Utils.checkServerUrl(spec.servers);
             errors.push(...serverErrors);
         }
         const paths = spec.paths;
@@ -433,7 +408,7 @@ class Utils {
             const methods = paths[path];
             if ((methods === null || methods === void 0 ? void 0 : methods.servers) && methods.servers.length >= 1) {
                 hasPathLevelServers = true;
-                const serverErrors = Utils.checkServerUrl(methods.servers, allowHttp);
+                const serverErrors = Utils.checkServerUrl(methods.servers);
                 errors.push(...serverErrors);
             }
             for (const method in methods) {
@@ -441,7 +416,7 @@ class Utils {
                 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, allowHttp);
+                        const serverErrors = Utils.checkServerUrl(operationObject.servers);
                         errors.push(...serverErrors);
                     }
                 }
@@ -730,6 +705,22 @@ class Validator {
         }
         return result;
     }
+    validateResponse(method, path) {
+        const result = { isValid: true, reason: [] };
+        const operationObject = this.spec.paths[path][method];
+        const { json, multipleMediaType } = Utils.getResponseJson(operationObject);
+        if (this.options.projectType === ProjectType.SME) {
+            // 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 result = { isValid: true, reason: [] };
         const serverObj = Utils.getServerObject(this.spec, method, path);
@@ -738,8 +729,8 @@ class Validator {
             result.reason.push(ErrorType.NoServerInformation);
         }
         else {
-            const allowHttp = this.projectType === ProjectType.Copilot;
-            const serverValidateResult = Utils.checkServerUrl([serverObj], allowHttp);
+            // server url should be absolute url with https protocol
+            const serverValidateResult = Utils.checkServerUrl([serverObj]);
             result.reason.push(...serverValidateResult.map((item) => item.type));
         }
         return result;
@@ -762,9 +753,6 @@ 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)) ||
@@ -777,6 +765,114 @@ class Validator {
         }
         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 && Utils.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 (Utils.isObjectSchema(schema)) {
+            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 && Utils.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;
+    }
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -786,6 +882,7 @@ class CopilotValidator extends Validator {
         this.projectType = ProjectType.Copilot;
         this.options = options;
         this.spec = spec;
+        this.checkCircularReference();
     }
     validateSpec() {
         const result = { errors: [], warnings: [] };
@@ -811,6 +908,10 @@ class CopilotValidator extends Validator {
         if (!methodAndPathResult.isValid) {
             return methodAndPathResult;
         }
+        const circularReferenceResult = this.validateCircularReference(method, path);
+        if (!circularReferenceResult.isValid) {
+            return circularReferenceResult;
+        }
         const operationObject = this.spec.paths[path][method];
         // validate auth
         const authCheckResult = this.validateAuth(method, path);
@@ -822,6 +923,24 @@ class CopilotValidator extends Validator {
         // 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 (requestJsonBody) {
+            const requestBodySchema = requestJsonBody.schema;
+            if (!Utils.isObjectSchema(requestBodySchema)) {
+                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;
         }
@@ -913,108 +1032,6 @@ class SMEValidator extends Validator {
         }
         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;
-    }
-    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 (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 (Utils.isObjectSchema(schema)) {
-            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;
-        }
-        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;
-                    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;
-    }
     validateParamCount(postBodyResult, paramResult) {
         const result = { isValid: true, reason: [] };
         const totalRequiredParams = postBodyResult.requiredNum + paramResult.requiredNum;