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

package/dist/index.esm2017.mjs

@@ -41,8 +41,6 @@ var ErrorType;
     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";
@@ -62,6 +60,7 @@ var WarningType;
     WarningType["ConvertSwaggerToOpenAPI"] = "convert-swagger-to-openapi";
     WarningType["FuncDescriptionTooLong"] = "function-description-too-long";
     WarningType["OperationIdContainsSpecialCharacters"] = "operationid-contains-special-characters";
+    WarningType["GenerateJsonDataFailed"] = "generate-json-data-failed";
     WarningType["Unknown"] = "unknown";
 })(WarningType || (WarningType = {}));
 /**
@@ -102,6 +101,7 @@ ConstantString.MultipleAuthNotSupported = "Multiple authentication methods are u
 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.GenerateJsonDataFailed = "Failed to generate JSON data for api: %s due to %s.";
 ConstantString.WrappedCardVersion = "devPreview";
 ConstantString.WrappedCardSchema = "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.ResponseRenderingTemplate.schema.json";
 ConstantString.WrappedCardResponseLayout = "list";
@@ -195,17 +195,6 @@ class SpecParserError extends Error {
 
 // Copyright (c) Microsoft Corporation.
 class Utils {
-    static hasNestedObjectInSchema(schema) {
-        if (this.isObjectSchema(schema)) {
-            for (const property in schema.properties) {
-                const nestedSchema = schema.properties[property];
-                if (this.isObjectSchema(nestedSchema)) {
-                    return true;
-                }
-            }
-        }
-        return false;
-    }
     static isObjectSchema(schema) {
         return schema.type === "object" || (!schema.type && !!schema.properties);
     }
@@ -275,27 +264,33 @@ class Utils {
         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 (responseObject === null || responseObject === void 0 ? void 0 : responseObject.content) {
-                for (const contentType of Object.keys(responseObject.content)) {
-                    // json media type can also be "application/json; charset=utf-8"
-                    if (contentType.indexOf("application/json") >= 0) {
-                        multipleMediaType = false;
-                        json = responseObject.content[contentType];
-                        if (Utils.containMultipleMediaTypes(responseObject)) {
-                            multipleMediaType = true;
-                            if (!allowMultipleMediaType) {
-                                json = {};
-                            }
-                        }
-                        else {
-                            return { json, multipleMediaType };
-                        }
-                    }
-                }
+            if (!responseObject) {
+                continue;
+            }
+            multipleMediaType = Utils.containMultipleMediaTypes(responseObject);
+            if (!allowMultipleMediaType && multipleMediaType) {
+                json = {};
+                continue;
+            }
+            const mediaObj = Utils.getJsonContentType(responseObject);
+            if (Object.keys(mediaObj).length > 0) {
+                json = mediaObj;
+                return { json, multipleMediaType };
             }
         }
         return { json, multipleMediaType };
     }
+    static getJsonContentType(responseObject) {
+        if (responseObject.content) {
+            for (const contentType of Object.keys(responseObject.content)) {
+                // json media type can also be "application/json; charset=utf-8"
+                if (contentType.indexOf("application/json") >= 0) {
+                    return responseObject.content[contentType];
+                }
+            }
+        }
+        return {};
+    }
     static convertPathToCamelCase(path) {
         const pathSegments = path.split(/[./{]/);
         const camelCaseSegments = pathSegments.map((segment) => {
@@ -752,11 +747,6 @@ class Validator {
         }
         const isRequiredWithoutDefault = isRequired && schema.default === undefined;
         const isCopilot = this.projectType === ProjectType.Copilot;
-        if (isCopilot && Utils.hasNestedObjectInSchema(schema)) {
-            paramResult.isValid = false;
-            paramResult.reason = [ErrorType.RequestBodyContainsNestedObject];
-            return paramResult;
-        }
         if (schema.type === "string" ||
             schema.type === "integer" ||
             schema.type === "boolean" ||
@@ -804,11 +794,6 @@ class Validator {
         for (let i = 0; i < paramObject.length; i++) {
             const param = paramObject[i];
             const schema = param.schema;
-            if (isCopilot && Utils.hasNestedObjectInSchema(schema)) {
-                paramResult.isValid = false;
-                paramResult.reason.push(ErrorType.ParamsContainsNestedObject);
-                continue;
-            }
             const isRequiredWithoutDefault = param.required && schema.default === undefined;
             if (isCopilot) {
                 if (isRequiredWithoutDefault) {
@@ -1283,15 +1268,152 @@ class SpecFilter {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+class JsonDataGenerator {
+    static generate(schema) {
+        return this.generateMockData(schema);
+    }
+    static generateMockData(schema) {
+        if (this.visitedSchemas.has(schema)) {
+            return null; // Prevent circular reference
+        }
+        this.visitedSchemas.add(schema);
+        let result;
+        if (schema.anyOf) {
+            // Select the first schema in anyOf
+            const selectedSchema = schema.anyOf[0];
+            result = this.generateMockData(selectedSchema);
+        }
+        else if (schema.oneOf) {
+            // Select the first schema in oneOf
+            const selectedSchema = schema.oneOf[0];
+            result = this.generateMockData(selectedSchema);
+        }
+        else if (schema.allOf) {
+            // merge all schemas in allOf
+            result = {};
+            for (const subschema of schema.allOf) {
+                const data = this.generateMockData(subschema);
+                result = Object.assign(Object.assign({}, result), data);
+            }
+        }
+        else {
+            switch (schema.type) {
+                case "string":
+                    if (schema.example !== undefined) {
+                        result = schema.example;
+                    }
+                    else if (schema.format) {
+                        switch (schema.format) {
+                            case "date-time":
+                                result = "2024-11-01T05:25:43.593Z";
+                                break;
+                            case "email":
+                                result = "example@example.com";
+                                break;
+                            case "uuid":
+                                result = "123e4567-e89b-12d3-a456-426614174000";
+                                break;
+                            case "ipv4":
+                                result = "192.168.0.1";
+                                break;
+                            case "ipv6":
+                                result = "2001:0db8:85a3:0000:0000:8a2e:0370:7334";
+                                break;
+                            default:
+                                result = "example string";
+                        }
+                    }
+                    else {
+                        result = "example string";
+                    }
+                    break;
+                case "number":
+                    if (schema.example !== undefined) {
+                        result = schema.example;
+                    }
+                    else if (schema.format) {
+                        switch (schema.format) {
+                            case "float":
+                                result = 3.14;
+                                break;
+                            case "double":
+                                result = 3.14159;
+                                break;
+                            default:
+                                result = 123;
+                        }
+                    }
+                    else {
+                        result = 123;
+                    }
+                    break;
+                case "integer":
+                    if (schema.example !== undefined) {
+                        result = schema.example;
+                    }
+                    else if (schema.format) {
+                        switch (schema.format) {
+                            case "int32":
+                                result = 123456;
+                                break;
+                            case "int64":
+                                result = 123456789;
+                                break;
+                            default:
+                                result = 123;
+                        }
+                    }
+                    else {
+                        result = 123;
+                    }
+                    break;
+                case "boolean":
+                    result = schema.example !== undefined ? schema.example : true;
+                    break;
+                case "array":
+                    result = [this.generateMockData(schema.items)];
+                    break;
+                case "object":
+                    result = {};
+                    if (schema.properties) {
+                        for (const key in schema.properties) {
+                            result[key] = this.generateMockData(schema.properties[key]);
+                        }
+                    }
+                    break;
+                default:
+                    result = schema.example || null;
+            }
+        }
+        this.visitedSchemas.delete(schema);
+        return result;
+    }
+}
+JsonDataGenerator.visitedSchemas = new Set();
+
 // Copyright (c) Microsoft Corporation.
 class AdaptiveCardGenerator {
     static generateAdaptiveCard(operationItem, allowMultipleMediaType = false, maxElementCount = Number.MAX_SAFE_INTEGER) {
         try {
             const { json } = Utils.getResponseJson(operationItem, allowMultipleMediaType);
             let cardBody = [];
+            let jsonData = {};
+            const warnings = [];
+            const operationId = operationItem.operationId;
             let schema = json.schema;
             let jsonPath = "$";
             if (schema && Object.keys(schema).length > 0) {
+                try {
+                    jsonData = JsonDataGenerator.generate(schema);
+                }
+                catch (err) {
+                    warnings.push({
+                        type: WarningType.GenerateJsonDataFailed,
+                        content: Utils.format(ConstantString.GenerateJsonDataFailed, operationId, err.toString()),
+                        data: operationId,
+                    });
+                }
                 jsonPath = AdaptiveCardGenerator.getResponseJsonPathFromSchema(schema);
                 if (jsonPath !== "$") {
                     schema = schema.properties[jsonPath];
@@ -1324,7 +1446,7 @@ class AdaptiveCardGenerator {
                 version: ConstantString.AdaptiveCardVersion,
                 body: cardBody,
             };
-            return [fullCard, jsonPath];
+            return [fullCard, jsonPath, jsonData, warnings];
         }
         catch (err) {
             throw new SpecParserError(err.toString(), ErrorType.GenerateAdaptiveCardFailed);
@@ -1651,36 +1773,11 @@ class ManifestUpdater {
                 for (const method in operations) {
                     if (options.allowMethods.includes(method)) {
                         const operationItem = operations[method];
-                        const confirmationBodies = [];
                         if (operationItem) {
                             const operationId = operationItem.operationId;
                             const safeFunctionName = operationId.replace(/[^a-zA-Z0-9]/g, "_");
                             const description = (_a = operationItem.description) !== null && _a !== void 0 ? _a : "";
                             const summary = operationItem.summary;
-                            const paramObject = operationItem.parameters;
-                            const requestBody = operationItem.requestBody;
-                            if (paramObject) {
-                                for (let i = 0; i < paramObject.length; i++) {
-                                    const param = paramObject[i];
-                                    const schema = param.schema;
-                                    ManifestUpdater.checkSchema(schema, method, pathUrl);
-                                    confirmationBodies.push(ManifestUpdater.getConfirmationBodyItem(param.name));
-                                }
-                            }
-                            if (requestBody) {
-                                const requestJsonBody = requestBody.content["application/json"];
-                                const requestBodySchema = requestJsonBody.schema;
-                                if (Utils.isObjectSchema(requestBodySchema)) {
-                                    for (const property in requestBodySchema.properties) {
-                                        const schema = requestBodySchema.properties[property];
-                                        ManifestUpdater.checkSchema(schema, method, pathUrl);
-                                        confirmationBodies.push(ManifestUpdater.getConfirmationBodyItem(property));
-                                    }
-                                }
-                                else {
-                                    throw new SpecParserError(Utils.format(ConstantString.UnsupportedSchema, method, pathUrl, JSON.stringify(requestBodySchema)), ErrorType.UpdateManifestFailed);
-                                }
-                            }
                             let funcDescription = operationItem.description || operationItem.summary || "";
                             if (funcDescription.length > ConstantString.FunctionDescriptionMaxLens) {
                                 warnings.push({
@@ -1714,14 +1811,39 @@ class ManifestUpdater {
                                 }
                             }
                             if (options.allowConfirmation && method !== ConstantString.GetMethod) {
-                                if (!funcObj.capabilities) {
-                                    funcObj.capabilities = {};
+                                const paramObject = operationItem.parameters;
+                                const requestBody = operationItem.requestBody;
+                                const confirmationBodies = [];
+                                if (paramObject) {
+                                    for (let i = 0; i < paramObject.length; i++) {
+                                        const param = paramObject[i];
+                                        const schema = param.schema;
+                                        ManifestUpdater.checkSchema(schema, method, pathUrl);
+                                        confirmationBodies.push(ManifestUpdater.getConfirmationBodyItem(param.name));
+                                    }
+                                }
+                                if (requestBody) {
+                                    const requestJsonBody = Utils.getJsonContentType(requestBody);
+                                    const requestBodySchema = requestJsonBody.schema;
+                                    if (Utils.isObjectSchema(requestBodySchema)) {
+                                        for (const property in requestBodySchema.properties) {
+                                            const schema = requestBodySchema.properties[property];
+                                            ManifestUpdater.checkSchema(schema, method, pathUrl);
+                                            confirmationBodies.push(ManifestUpdater.getConfirmationBodyItem(property));
+                                        }
+                                    }
+                                    else {
+                                        throw new SpecParserError(Utils.format(ConstantString.UnsupportedSchema, method, pathUrl, JSON.stringify(requestBodySchema)), ErrorType.UpdateManifestFailed);
+                                    }
                                 }
-                                funcObj.capabilities.confirmation = {
-                                    type: "AdaptiveCard",
-                                    title: (_b = operationItem.summary) !== null && _b !== void 0 ? _b : description,
-                                };
                                 if (confirmationBodies.length > 0) {
+                                    if (!funcObj.capabilities) {
+                                        funcObj.capabilities = {};
+                                    }
+                                    funcObj.capabilities.confirmation = {
+                                        type: "AdaptiveCard",
+                                        title: (_b = operationItem.summary) !== null && _b !== void 0 ? _b : description,
+                                    };
                                     funcObj.capabilities.confirmation.body = confirmationBodies.join("\n");
                                 }
                             }
@@ -2228,13 +2350,14 @@ class SpecParser {
                         if (this.options.allowMethods.includes(method)) {
                             const operation = newSpec.paths[url][method];
                             try {
-                                const [card, jsonPath] = AdaptiveCardGenerator.generateAdaptiveCard(operation);
+                                const [card, jsonPath, jsonData, warnings] = AdaptiveCardGenerator.generateAdaptiveCard(operation);
+                                result.warnings.push(...warnings);
                                 const safeAdaptiveCardName = operation.operationId.replace(/[^a-zA-Z0-9]/g, "_");
                                 const fileName = path.join(adaptiveCardFolder, `${safeAdaptiveCardName}.json`);
                                 const wrappedCard = wrapAdaptiveCard(card, jsonPath);
                                 await fs.outputJSON(fileName, wrappedCard, { spaces: 2 });
                                 const dataFileName = path.join(adaptiveCardFolder, `${safeAdaptiveCardName}.data.json`);
-                                await fs.outputJSON(dataFileName, {}, { spaces: 2 });
+                                await fs.outputJSON(dataFileName, jsonData, { spaces: 2 });
                             }
                             catch (err) {
                                 result.allSuccess = false;