@microsoft/m365-spec-parser 0.2.2 → 0.2.3-alpha.09af212fe.0

package/dist/index.esm5.js

@@ -85,6 +85,7 @@ var WarningType;
     WarningType["OperationOnlyContainsOptionalParam"] = "operation-only-contains-optional-param";
     WarningType["ConvertSwaggerToOpenAPI"] = "convert-swagger-to-openapi";
     WarningType["FuncDescriptionTooLong"] = "function-description-too-long";
+    WarningType["OperationIdContainsSpecialCharacters"] = "operationid-contains-special-characters";
     WarningType["Unknown"] = "unknown";
 })(WarningType || (WarningType = {}));
 /**
@@ -130,6 +131,7 @@ ConstantString.ConvertSwaggerToOpenAPI = "The Swagger 2.0 file has been converte
 ConstantString.SwaggerNotSupported = "Swagger 2.0 is not supported. Please convert to OpenAPI 3.0 manually before proceeding.";
 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.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.WrappedCardVersion = "devPreview";
@@ -218,16 +220,19 @@ ConstantString.PluginManifestSchema = "https://developer.microsoft.com/json-sche
 // 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;
     }
@@ -456,7 +461,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;
@@ -570,29 +575,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.
@@ -794,7 +776,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;
@@ -810,7 +792,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;
@@ -846,7 +828,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;
@@ -889,17 +871,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.
@@ -958,7 +929,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);
@@ -1350,7 +1321,7 @@ class SpecParser {
 
 // 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 = [];
@@ -1361,7 +1332,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)) {
@@ -1395,10 +1366,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,
@@ -1407,7 +1382,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}",
@@ -1417,11 +1392,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) {
@@ -1434,6 +1409,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}";
@@ -1458,24 +1434,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) {
@@ -1485,7 +1454,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];