@microsoft/m365-spec-parser 0.1.1-alpha.a277dba4e.0 → 0.1.1-alpha.b015b287e.0

package/dist/index.esm5.js

@@ -55,6 +55,21 @@ var ErrorType;
     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 = {}));
@@ -205,6 +220,7 @@ class Utils {
             requiredNum: 0,
             optionalNum: 0,
             isValid: true,
+            reason: [],
         };
         if (!paramObject) {
             return paramResult;
@@ -214,6 +230,7 @@ class Utils {
             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;
@@ -229,6 +246,7 @@ class Utils {
             if (param.in === "header" || param.in === "cookie") {
                 if (isRequiredWithoutDefault) {
                     paramResult.isValid = false;
+                    paramResult.reason.push(ErrorType.ParamsContainRequiredUnsupportedSchema);
                 }
                 continue;
             }
@@ -238,6 +256,7 @@ class Utils {
                 schema.type !== "integer") {
                 if (isRequiredWithoutDefault) {
                     paramResult.isValid = false;
+                    paramResult.reason.push(ErrorType.ParamsContainRequiredUnsupportedSchema);
                 }
                 continue;
             }
@@ -258,6 +277,7 @@ class Utils {
             requiredNum: 0,
             optionalNum: 0,
             isValid: true,
+            reason: [],
         };
         if (Object.keys(schema).length === 0) {
             return paramResult;
@@ -265,6 +285,7 @@ class Utils {
         const isRequiredWithoutDefault = isRequired && schema.default === undefined;
         if (isCopilot && this.hasNestedObjectInSchema(schema)) {
             paramResult.isValid = false;
+            paramResult.reason = [ErrorType.RequestBodyContainsNestedObject];
             return paramResult;
         }
         if (schema.type === "string" ||
@@ -289,11 +310,13 @@ class Utils {
                 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;
@@ -317,103 +340,123 @@ class Utils {
      */
     static isSupportedApi(method, path, spec, options) {
         var _a;
-        const pathObj = spec.paths[path];
+        const result = { isValid: true, reason: [] };
         method = method.toLocaleLowerCase();
-        if (pathObj) {
-            if (((_a = options.allowMethods) === null || _a === void 0 ? void 0 : _a.includes(method)) && pathObj[method]) {
-                const securities = pathObj[method].security;
-                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 (!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"];
-                if (!isTeamsAi && Utils.containMultipleMediaTypes(requestBody)) {
-                    return false;
-                }
-                const responseJson = Utils.getResponseJson(operationObject, isTeamsAi);
-                if (Object.keys(responseJson).length === 0) {
-                    return false;
-                }
-                // Teams AI project doesn't care about request parameters/body
-                if (isTeamsAi) {
-                    return true;
-                }
-                let requestBodyParamResult = {
-                    requiredNum: 0,
-                    optionalNum: 0,
-                    isValid: true,
-                };
-                if (requestJsonBody) {
-                    const requestBodySchema = requestJsonBody.schema;
-                    if (isCopilot && requestBodySchema.type !== "object") {
-                        return false;
-                    }
-                    requestBodyParamResult = Utils.checkPostBody(requestBodySchema, requestBody.required, isCopilot);
-                }
-                if (!requestBodyParamResult.isValid) {
-                    return false;
-                }
-                const paramResult = Utils.checkParameters(paramObject, isCopilot);
-                if (!paramResult.isValid) {
-                    return false;
+        if (options.allowMethods && !options.allowMethods.includes(method)) {
+            result.isValid = false;
+            result.reason.push(ErrorType.MethodNotAllowed);
+            return result;
+        }
+        const pathObj = spec.paths[path];
+        if (!pathObj || !pathObj[method]) {
+            result.isValid = false;
+            result.reason.push(ErrorType.UrlPathNotExist);
+            return result;
+        }
+        const securities = pathObj[method].security;
+        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);
+            const authCheckResult = Utils.isSupportedAuth(authArray, options);
+            if (!authCheckResult.isValid) {
+                result.reason.push(...authCheckResult.reason);
+            }
+        }
+        const operationObject = pathObj[method];
+        if (!options.allowMissingId && !operationObject.operationId) {
+            result.reason.push(ErrorType.MissingOperationId);
+        }
+        const rootServer = spec.servers && spec.servers[0];
+        const methodServer = spec.paths[path].servers && ((_a = spec.paths[path]) === null || _a === void 0 ? void 0 : _a.servers[0]);
+        const operationServer = operationObject.servers && operationObject.servers[0];
+        const serverUrl = operationServer || methodServer || rootServer;
+        if (!serverUrl) {
+            result.reason.push(ErrorType.NoServerInformation);
+        }
+        else {
+            const serverValidateResult = Utils.checkServerUrl([serverUrl]);
+            result.reason.push(...serverValidateResult.map((item) => item.type));
+        }
+        const paramObject = operationObject.parameters;
+        const requestBody = operationObject.requestBody;
+        const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
+        if (!isTeamsAi && Utils.containMultipleMediaTypes(requestBody)) {
+            result.reason.push(ErrorType.PostBodyContainMultipleMediaTypes);
+        }
+        const { json, multipleMediaType } = Utils.getResponseJson(operationObject, isTeamsAi);
+        if (multipleMediaType && !isTeamsAi) {
+            result.reason.push(ErrorType.ResponseContainMultipleMediaTypes);
+        }
+        else if (Object.keys(json).length === 0) {
+            result.reason.push(ErrorType.ResponseJsonIsEmpty);
+        }
+        // Teams AI project doesn't care about request parameters/body
+        if (!isTeamsAi) {
+            let requestBodyParamResult = {
+                requiredNum: 0,
+                optionalNum: 0,
+                isValid: true,
+                reason: [],
+            };
+            if (requestJsonBody) {
+                const requestBodySchema = requestJsonBody.schema;
+                if (isCopilot && requestBodySchema.type !== "object") {
+                    result.reason.push(ErrorType.PostBodySchemaIsNotJson);
                 }
-                // Copilot support arbitrary parameters
-                if (isCopilot) {
-                    return true;
+                requestBodyParamResult = Utils.checkPostBody(requestBodySchema, requestBody.required, isCopilot);
+                if (!requestBodyParamResult.isValid && requestBodyParamResult.reason) {
+                    result.reason.push(...requestBodyParamResult.reason);
                 }
-                if (requestBodyParamResult.requiredNum + paramResult.requiredNum > 1) {
-                    if (options.allowMultipleParameters &&
-                        requestBodyParamResult.requiredNum + paramResult.requiredNum <=
-                            ConstantString.SMERequiredParamsMaxNum) {
-                        return true;
+            }
+            const paramResult = Utils.checkParameters(paramObject, isCopilot);
+            if (!paramResult.isValid && paramResult.reason) {
+                result.reason.push(...paramResult.reason);
+            }
+            // Copilot support arbitrary parameters
+            if (!isCopilot && paramResult.isValid && requestBodyParamResult.isValid) {
+                const totalRequiredParams = requestBodyParamResult.requiredNum + paramResult.requiredNum;
+                const totalParams = totalRequiredParams + requestBodyParamResult.optionalNum + paramResult.optionalNum;
+                if (totalRequiredParams > 1) {
+                    if (!options.allowMultipleParameters ||
+                        totalRequiredParams > ConstantString.SMERequiredParamsMaxNum) {
+                        result.reason.push(ErrorType.ExceededRequiredParamsLimit);
                     }
-                    return false;
                 }
-                else if (requestBodyParamResult.requiredNum +
-                    requestBodyParamResult.optionalNum +
-                    paramResult.requiredNum +
-                    paramResult.optionalNum ===
-                    0) {
-                    return false;
-                }
-                else {
-                    return true;
+                else if (totalParams === 0) {
+                    result.reason.push(ErrorType.NoParameter);
                 }
             }
         }
-        return false;
+        if (result.reason.length > 0) {
+            result.isValid = false;
+        }
+        return result;
     }
     static isSupportedAuth(authSchemeArray, options) {
         if (authSchemeArray.length === 0) {
-            return true;
+            return { isValid: true, reason: [] };
         }
         if (options.allowAPIKeyAuth || options.allowOauth2 || options.allowBearerTokenAuth) {
             // Currently we don't support multiple auth in one operation
             if (authSchemeArray.length > 0 && authSchemeArray.every((auths) => auths.length > 1)) {
-                return false;
+                return {
+                    isValid: false,
+                    reason: [ErrorType.MultipleAuthNotSupported],
+                };
             }
             for (const auths of authSchemeArray) {
                 if (auths.length === 1) {
                     if ((options.allowAPIKeyAuth && Utils.isAPIKeyAuth(auths[0].authScheme)) ||
                         (options.allowOauth2 && Utils.isOAuthWithAuthCodeFlow(auths[0].authScheme)) ||
                         (options.allowBearerTokenAuth && Utils.isBearerTokenAuth(auths[0].authScheme))) {
-                        return true;
+                        return { isValid: true, reason: [] };
                     }
                 }
             }
         }
-        return false;
+        return { isValid: false, reason: [ErrorType.AuthTypeIsNotSupported] };
     }
     static isBearerTokenAuth(authScheme) {
         return authScheme.type === "http" && authScheme.scheme === "bearer";
@@ -456,11 +499,17 @@ class Utils {
     static getResponseJson(operationObject, isTeamsAiProject = false) {
         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];
             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"];
-                if (!isTeamsAiProject && Utils.containMultipleMediaTypes(responseObject)) {
+                if (Utils.containMultipleMediaTypes(responseObject)) {
+                    multipleMediaType = true;
+                    if (isTeamsAiProject) {
+                        break;
+                    }
                     json = {};
                 }
                 else {
@@ -468,7 +517,7 @@ class Utils {
                 }
             }
         }
-        return json;
+        return { json, multipleMediaType };
     }
     static convertPathToCamelCase(path) {
         const pathSegments = path.split(/[./{]/);
@@ -488,10 +537,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];
@@ -499,17 +548,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({
@@ -540,6 +589,7 @@ class Utils {
         return errors;
     }
     static validateServer(spec, options) {
+        var _a;
         const errors = [];
         let hasTopLevelServers = false;
         let hasPathLevelServers = false;
@@ -560,7 +610,7 @@ class Utils {
             }
             for (const method in methods) {
                 const operationObject = methods[method];
-                if (Utils.isSupportedApi(method, path, spec, options)) {
+                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);
@@ -687,13 +737,7 @@ class Utils {
             }
         }
         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",
@@ -702,25 +746,23 @@ 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];
+        return command;
     }
-    static listSupportedAPIs(spec, options) {
+    static listAPIs(spec, options) {
+        var _a;
         const paths = spec.paths;
         const result = {};
         for (const path in paths) {
             const methods = paths[path];
             for (const method in methods) {
-                if (Utils.isSupportedApi(method, path, spec, options)) {
-                    const operationObject = methods[method];
-                    result[`${method.toUpperCase()} ${path}`] = operationObject;
+                const operationObject = methods[method];
+                if (((_a = options.allowMethods) === null || _a === void 0 ? void 0 : _a.includes(method)) && operationObject) {
+                    const validateResult = Utils.isSupportedApi(method, path, spec, options);
+                    result[`${method.toUpperCase()} ${path}`] = {
+                        operation: operationObject,
+                        isValid: validateResult.isValid,
+                        reason: validateResult.reason,
+                    };
                 }
             }
         }
@@ -729,13 +771,13 @@ class Utils {
     static validateSpec(spec, parser, isSwaggerFile, options) {
         const errors = [];
         const warnings = [];
+        const apiMap = Utils.listAPIs(spec, options);
         if (isSwaggerFile) {
             warnings.push({
                 type: WarningType.ConvertSwaggerToOpenAPI,
                 content: ConstantString.ConvertSwaggerToOpenAPI,
             });
         }
-        // Server validation
         const serverErrors = Utils.validateServer(spec, options);
         errors.push(...serverErrors);
         // Remote reference not supported
@@ -749,8 +791,8 @@ class Utils {
             });
         }
         // No supported API
-        const apiMap = Utils.listSupportedAPIs(spec, options);
-        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,
@@ -759,8 +801,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);
             }
         }
@@ -894,7 +936,7 @@ class SpecParser {
                     if (!operationId) {
                         continue;
                     }
-                    const [command, warning] = Utils.parseApiInfo(pathObjectItem, this.options);
+                    const command = Utils.parseApiInfo(pathObjectItem, this.options);
                     const apiInfo = {
                         method: method,
                         path: path,
@@ -903,9 +945,6 @@ class SpecParser {
                         parameters: command.parameters,
                         description: command.description,
                     };
-                    if (warning) {
-                        apiInfo.warning = warning;
-                    }
                     apiInfos.push(apiInfo);
                 }
                 return apiInfos;
@@ -979,17 +1018,35 @@ class SpecParser {
         if (this.apiMap !== undefined) {
             return this.apiMap;
         }
-        const result = Utils.listSupportedAPIs(spec, this.options);
+        const result = this.listSupportedAPIs(spec, this.options);
         this.apiMap = result;
         return result;
     }
+    listSupportedAPIs(spec, options) {
+        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 = options.allowMethods) === null || _a === void 0 ? void 0 : _a.includes(method)) && operationObject) {
+                    const validateResult = Utils.isSupportedApi(method, path, spec, options);
+                    if (validateResult.isValid) {
+                        result[`${method.toUpperCase()} ${path}`] = operationObject;
+                    }
+                }
+            }
+        }
+        return result;
+    }
 }
 
 // Copyright (c) Microsoft Corporation.
 class AdaptiveCardGenerator {
     static generateAdaptiveCard(operationItem) {
         try {
-            const json = Utils.getResponseJson(operationItem);
+            const { json } = Utils.getResponseJson(operationItem);
             let cardBody = [];
             let schema = json.schema;
             let jsonPath = "$";