@microsoft/m365-spec-parser 0.2.1 → 0.2.2-alpha.089f82c02.0

package/dist/index.esm5.js

@@ -43,10 +43,12 @@ var ErrorType;
     ErrorType["RelativeServerUrlNotSupported"] = "relative-server-url-not-supported";
     ErrorType["NoSupportedApi"] = "no-supported-api";
     ErrorType["NoExtraAPICanBeAdded"] = "no-extra-api-can-be-added";
+    ErrorType["AddedAPINotInOriginalSpec"] = "added-api-not-in-original-spec";
     ErrorType["ResolveServerUrlFailed"] = "resolve-server-url-failed";
     ErrorType["SwaggerNotSupported"] = "swagger-not-supported";
     ErrorType["MultipleAuthNotSupported"] = "multiple-auth-not-supported";
     ErrorType["SpecVersionNotSupported"] = "spec-version-not-supported";
+    ErrorType["CircularReferenceNotSupported"] = "circular-reference-not-supported";
     ErrorType["ListFailed"] = "list-failed";
     ErrorType["listSupportedAPIInfoFailed"] = "list-supported-api-info-failed";
     ErrorType["FilterSpecFailed"] = "filter-spec-failed";
@@ -283,7 +285,7 @@ class Utils {
     static updateFirstLetter(str) {
         return str.charAt(0).toUpperCase() + str.slice(1);
     }
-    static getResponseJson(operationObject) {
+    static getResponseJson(operationObject, allowMultipleMediaType = false) {
         var _a, _b;
         let json = {};
         let multipleMediaType = false;
@@ -294,7 +296,9 @@ class Utils {
                 json = responseObject.content["application/json"];
                 if (Utils.containMultipleMediaTypes(responseObject)) {
                     multipleMediaType = true;
-                    json = {};
+                    if (!allowMultipleMediaType) {
+                        json = {};
+                    }
                 }
                 else {
                     break;
@@ -562,6 +566,19 @@ class Utils {
 
 // Copyright (c) Microsoft Corporation.
 class Validator {
+    constructor() {
+        this.hasCircularReference = false;
+    }
+    checkCircularReference() {
+        try {
+            JSON.stringify(this.spec);
+        }
+        catch (e) {
+            if (e.message.includes("Converting circular structure to JSON")) {
+                this.hasCircularReference = true;
+            }
+        }
+    }
     listAPIs() {
         var _a;
         if (this.apiMap) {
@@ -657,6 +674,22 @@ class Validator {
         }
         return result;
     }
+    validateCircularReference(method, path) {
+        const result = { isValid: true, reason: [] };
+        if (this.hasCircularReference) {
+            const operationObject = this.spec.paths[path][method];
+            try {
+                JSON.stringify(operationObject);
+            }
+            catch (e) {
+                if (e.message.includes("Converting circular structure to JSON")) {
+                    result.isValid = false;
+                    result.reason.push(ErrorType.CircularReferenceNotSupported);
+                }
+            }
+        }
+        return result;
+    }
     validateResponse(method, path) {
         const result = { isValid: true, reason: [] };
         const operationObject = this.spec.paths[path][method];
@@ -845,6 +878,7 @@ class CopilotValidator extends Validator {
         this.projectType = ProjectType.Copilot;
         this.options = options;
         this.spec = spec;
+        this.checkCircularReference();
     }
     validateSpec() {
         const result = { errors: [], warnings: [] };
@@ -870,6 +904,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);
@@ -913,6 +951,7 @@ class SMEValidator extends Validator {
         this.projectType = ProjectType.SME;
         this.options = options;
         this.spec = spec;
+        this.checkCircularReference();
     }
     validateSpec() {
         const result = { errors: [], warnings: [] };
@@ -940,6 +979,10 @@ class SMEValidator 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);
@@ -1010,6 +1053,7 @@ class TeamsAIValidator extends Validator {
         this.projectType = ProjectType.TeamsAi;
         this.options = options;
         this.spec = spec;
+        this.checkCircularReference();
     }
     validateSpec() {
         const result = { errors: [], warnings: [] };
@@ -1029,6 +1073,10 @@ class TeamsAIValidator 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 operationId
         if (!this.options.allowMissingId && !operationObject.operationId) {
@@ -1271,9 +1319,9 @@ class SpecParser {
 
 // Copyright (c) Microsoft Corporation.
 class AdaptiveCardGenerator {
-    static generateAdaptiveCard(operationItem) {
+    static generateAdaptiveCard(operationItem, allowMultipleMediaType = false) {
         try {
-            const { json } = Utils.getResponseJson(operationItem);
+            const { json } = Utils.getResponseJson(operationItem, allowMultipleMediaType);
             let cardBody = [];
             let schema = json.schema;
             let jsonPath = "$";