@microsoft/m365-spec-parser 0.2.2 → 0.2.3-alpha.572d2b73b.0

package/dist/index.esm2017.mjs

@@ -194,16 +194,19 @@ class SpecParserError extends Error {
 // Copyright (c) Microsoft Corporation.
 class Utils {
     static hasNestedObjectInSchema(schema) {
-        if (schema.type === "object") {
+        if (this.isObjectSchema(schema)) {
             for (const property in schema.properties) {
                 const nestedSchema = schema.properties[property];
-                if (nestedSchema.type === "object") {
+                if (this.isObjectSchema(nestedSchema)) {
                     return true;
                 }
             }
         }
         return false;
     }
+    static isObjectSchema(schema) {
+        return schema.type === "object" || (!schema.type && !!schema.properties);
+    }
     static containMultipleMediaTypes(bodyObject) {
         return Object.keys((bodyObject === null || bodyObject === void 0 ? void 0 : bodyObject.content) || {}).length > 1;
     }
@@ -432,7 +435,7 @@ class Utils {
                 optionalParams.push(parameter);
             }
         }
-        else if (schema.type === "object") {
+        else if (Utils.isObjectSchema(schema)) {
             const { properties } = schema;
             for (const property in properties) {
                 let isRequired = false;
@@ -546,29 +549,6 @@ class Utils {
         const serverUrl = operationServer || methodServer || rootServer;
         return serverUrl;
     }
-    static limitACBodyProperties(body, maxCount) {
-        const result = [];
-        let currentCount = 0;
-        for (const element of body) {
-            if (element.type === ConstantString.ContainerType) {
-                const items = this.limitACBodyProperties(element.items, maxCount - currentCount);
-                result.push({
-                    type: ConstantString.ContainerType,
-                    $data: element.$data,
-                    items: items,
-                });
-                currentCount += items.length;
-            }
-            else {
-                result.push(element);
-                currentCount++;
-            }
-            if (currentCount >= maxCount) {
-                break;
-            }
-        }
-        return result;
-    }
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -770,7 +750,7 @@ class Validator {
         }
         const isRequiredWithoutDefault = isRequired && schema.default === undefined;
         const isCopilot = this.projectType === ProjectType.Copilot;
-        if (isCopilot && this.hasNestedObjectInSchema(schema)) {
+        if (isCopilot && Utils.hasNestedObjectInSchema(schema)) {
             paramResult.isValid = false;
             paramResult.reason = [ErrorType.RequestBodyContainsNestedObject];
             return paramResult;
@@ -786,7 +766,7 @@ class Validator {
                 paramResult.optionalNum = paramResult.optionalNum + 1;
             }
         }
-        else if (schema.type === "object") {
+        else if (Utils.isObjectSchema(schema)) {
             const { properties } = schema;
             for (const property in properties) {
                 let isRequired = false;
@@ -822,7 +802,7 @@ class Validator {
         for (let i = 0; i < paramObject.length; i++) {
             const param = paramObject[i];
             const schema = param.schema;
-            if (isCopilot && this.hasNestedObjectInSchema(schema)) {
+            if (isCopilot && Utils.hasNestedObjectInSchema(schema)) {
                 paramResult.isValid = false;
                 paramResult.reason.push(ErrorType.ParamsContainsNestedObject);
                 continue;
@@ -865,17 +845,6 @@ class Validator {
         }
         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.
@@ -934,7 +903,7 @@ class CopilotValidator extends Validator {
         const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
         if (requestJsonBody) {
             const requestBodySchema = requestJsonBody.schema;
-            if (requestBodySchema.type !== "object") {
+            if (!Utils.isObjectSchema(requestBodySchema)) {
                 result.reason.push(ErrorType.PostBodySchemaIsNotJson);
             }
             const requestBodyParamResult = this.checkPostBodySchema(requestBodySchema, requestBody.required);
@@ -1314,7 +1283,7 @@ class SpecFilter {
 
 // Copyright (c) Microsoft Corporation.
 class AdaptiveCardGenerator {
-    static generateAdaptiveCard(operationItem, allowMultipleMediaType = false) {
+    static generateAdaptiveCard(operationItem, allowMultipleMediaType = false, maxElementCount = Number.MAX_SAFE_INTEGER) {
         try {
             const { json } = Utils.getResponseJson(operationItem, allowMultipleMediaType);
             let cardBody = [];
@@ -1325,7 +1294,7 @@ class AdaptiveCardGenerator {
                 if (jsonPath !== "$") {
                     schema = schema.properties[jsonPath];
                 }
-                cardBody = AdaptiveCardGenerator.generateCardFromResponse(schema, "");
+                cardBody = AdaptiveCardGenerator.generateCardFromResponse(schema, "", "", maxElementCount);
             }
             // if no schema, try to use example value
             if (cardBody.length === 0 && (json.examples || json.example)) {
@@ -1359,10 +1328,14 @@ class AdaptiveCardGenerator {
             throw new SpecParserError(err.toString(), ErrorType.GenerateAdaptiveCardFailed);
         }
     }
-    static generateCardFromResponse(schema, name, parentArrayName = "") {
+    static generateCardFromResponse(schema, name, parentArrayName = "", maxElementCount = Number.MAX_SAFE_INTEGER, counter = { count: 0 }) {
+        if (counter.count >= maxElementCount) {
+            return [];
+        }
         if (schema.type === "array") {
             // schema.items can be arbitrary object: schema { type: array, items: {} }
             if (Object.keys(schema.items).length === 0) {
+                counter.count++;
                 return [
                     {
                         type: ConstantString.TextBlockType,
@@ -1371,7 +1344,7 @@ class AdaptiveCardGenerator {
                     },
                 ];
             }
-            const obj = AdaptiveCardGenerator.generateCardFromResponse(schema.items, "", name);
+            const obj = AdaptiveCardGenerator.generateCardFromResponse(schema.items, "", name, maxElementCount, counter);
             const template = {
                 type: ConstantString.ContainerType,
                 $data: name ? `\${${name}}` : "${$root}",
@@ -1381,11 +1354,11 @@ class AdaptiveCardGenerator {
             return [template];
         }
         // some schema may not contain type but contain properties
-        if (schema.type === "object" || (!schema.type && schema.properties)) {
+        if (Utils.isObjectSchema(schema)) {
             const { properties } = schema;
             const result = [];
             for (const property in properties) {
-                const obj = AdaptiveCardGenerator.generateCardFromResponse(properties[property], name ? `${name}.${property}` : property, parentArrayName);
+                const obj = AdaptiveCardGenerator.generateCardFromResponse(properties[property], name ? `${name}.${property}` : property, parentArrayName, maxElementCount, counter);
                 result.push(...obj);
             }
             if (schema.additionalProperties) {
@@ -1398,6 +1371,7 @@ class AdaptiveCardGenerator {
             schema.type === "integer" ||
             schema.type === "boolean" ||
             schema.type === "number") {
+            counter.count++;
             if (!AdaptiveCardGenerator.isImageUrlProperty(schema, name, parentArrayName)) {
                 // string in root: "ddd"
                 let text = "result: ${$root}";
@@ -1422,24 +1396,17 @@ class AdaptiveCardGenerator {
                 ];
             }
             else {
-                if (name) {
-                    return [
-                        {
-                            type: "Image",
-                            url: `\${${name}}`,
-                            $when: `\${${name} != null && ${name} != ''}`,
-                        },
-                    ];
-                }
-                else {
-                    return [
-                        {
-                            type: "Image",
-                            url: "${$data}",
-                            $when: "${$data != null && $data != ''}",
-                        },
-                    ];
-                }
+                const url = name ? `\${${name}}` : "${$data}";
+                const condition = name
+                    ? `\${${name} != null && ${name} != ''}`
+                    : "${$data != null && $data != ''}";
+                return [
+                    {
+                        type: "Image",
+                        url,
+                        $when: condition,
+                    },
+                ];
             }
         }
         if (schema.oneOf || schema.anyOf || schema.not || schema.allOf) {
@@ -1449,7 +1416,7 @@ class AdaptiveCardGenerator {
     }
     // 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)) {
+        if (Utils.isObjectSchema(schema)) {
             const { properties } = schema;
             for (const property in properties) {
                 const schema = properties[property];
@@ -1701,7 +1668,7 @@ class ManifestUpdater {
                             if (requestBody) {
                                 const requestJsonBody = requestBody.content["application/json"];
                                 const requestBodySchema = requestJsonBody.schema;
-                                if (requestBodySchema.type === "object") {
+                                if (Utils.isObjectSchema(requestBodySchema)) {
                                     for (const property in requestBodySchema.properties) {
                                         const schema = requestBodySchema.properties[property];
                                         ManifestUpdater.checkSchema(schema, method, pathUrl);
@@ -1729,8 +1696,7 @@ class ManifestUpdater {
                                 try {
                                     const { json } = Utils.getResponseJson(operationItem);
                                     if (json.schema) {
-                                        const [card, jsonPath] = AdaptiveCardGenerator.generateAdaptiveCard(operationItem);
-                                        card.body = Utils.limitACBodyProperties(card.body, 5);
+                                        const [card, jsonPath] = AdaptiveCardGenerator.generateAdaptiveCard(operationItem, false, 5);
                                         const responseSemantic = wrapResponseSemantics(card, jsonPath);
                                         funcObj.capabilities = {
                                             response_semantics: responseSemantic,