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

package/dist/index.esm2017.js

@@ -53,6 +53,7 @@ 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 = {}));
@@ -100,6 +101,7 @@ 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.";
@@ -114,12 +116,7 @@ ConstantString.AdaptiveCardType = "AdaptiveCard";
 ConstantString.TextBlockType = "TextBlock";
 ConstantString.ImageType = "Image";
 ConstantString.ContainerType = "Container";
-ConstantString.RegistrationIdPostfix = {
-    apiKey: "REGISTRATION_ID",
-    oauth2: "CONFIGURATION_ID",
-    http: "REGISTRATION_ID",
-    openIdConnect: "REGISTRATION_ID",
-};
+ConstantString.RegistrationIdPostfix = "REGISTRATION_ID";
 ConstantString.ResponseCodeFor20X = [
     "200",
     "201",
@@ -131,6 +128,7 @@ ConstantString.ResponseCodeFor20X = [
     "207",
     "208",
     "226",
+    "2XX",
     "default",
 ];
 ConstantString.AllOperationMethods = [
@@ -200,11 +198,32 @@ 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 = [];
@@ -229,6 +248,20 @@ 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) {
@@ -699,6 +732,9 @@ 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)) ||
@@ -720,7 +756,6 @@ class CopilotValidator extends Validator {
         this.projectType = ProjectType.Copilot;
         this.options = options;
         this.spec = spec;
-        this.checkCircularReference();
     }
     validateSpec() {
         const result = { errors: [], warnings: [] };
@@ -746,10 +781,6 @@ 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);