@microsoft/m365-spec-parser 0.1.1-alpha.ebe783822.0 → 0.1.1-alpha.fc0606a28.0

package/dist/index.esm2017.js

@@ -23,6 +23,7 @@ var ErrorType;
     ErrorType["GenerateAdaptiveCardFailed"] = "generate-adaptive-card-failed";
     ErrorType["GenerateFailed"] = "generate-failed";
     ErrorType["ValidateFailed"] = "validate-failed";
+    ErrorType["GetSpecFailed"] = "get-spec-failed";
     ErrorType["Cancelled"] = "cancelled";
     ErrorType["Unknown"] = "unknown";
 })(ErrorType || (ErrorType = {}));
@@ -73,6 +74,7 @@ ConstantString.OperationOnlyContainsOptionalParam = "Operation %s contains multi
 ConstantString.ConvertSwaggerToOpenAPI = "The Swagger 2.0 file has been converted to OpenAPI 3.0.";
 ConstantString.SwaggerNotSupported = "Swagger 2.0 is not supported. Please convert to OpenAPI 3.0 manually before proceeding.";
 ConstantString.MultipleAPIKeyNotSupported = "Multiple API keys are not supported. Please make sure that all selected APIs use the same API key.";
+ConstantString.UnsupportedSchema = "Unsupported schema in %s %s: %s";
 ConstantString.WrappedCardVersion = "devPreview";
 ConstantString.WrappedCardSchema = "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.ResponseRenderingTemplate.schema.json";
 ConstantString.WrappedCardResponseLayout = "list";
@@ -147,7 +149,18 @@ ConstantString.ParameterTitleMaxLens = 32;
 
 // Copyright (c) Microsoft Corporation.
 class Utils {
-    static checkParameters(paramObject) {
+    static 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;
+    }
+    static checkParameters(paramObject, isCopilot) {
         const paramResult = {
             requiredNum: 0,
             optionalNum: 0,
@@ -159,7 +172,20 @@ class Utils {
         for (let i = 0; i < paramObject.length; i++) {
             const param = paramObject[i];
             const schema = param.schema;
+            if (isCopilot && this.hasNestedObjectInSchema(schema)) {
+                paramResult.isValid = false;
+                continue;
+            }
             const isRequiredWithoutDefault = param.required && schema.default === undefined;
+            if (isCopilot) {
+                if (isRequiredWithoutDefault) {
+                    paramResult.requiredNum = paramResult.requiredNum + 1;
+                }
+                else {
+                    paramResult.optionalNum = paramResult.optionalNum + 1;
+                }
+                continue;
+            }
             if (param.in === "header" || param.in === "cookie") {
                 if (isRequiredWithoutDefault) {
                     paramResult.isValid = false;
@@ -186,7 +212,7 @@ class Utils {
         }
         return paramResult;
     }
-    static checkPostBody(schema, isRequired = false) {
+    static checkPostBody(schema, isRequired = false, isCopilot = false) {
         var _a;
         const paramResult = {
             requiredNum: 0,
@@ -197,6 +223,10 @@ class Utils {
             return paramResult;
         }
         const isRequiredWithoutDefault = isRequired && schema.default === undefined;
+        if (isCopilot && this.hasNestedObjectInSchema(schema)) {
+            paramResult.isValid = false;
+            return paramResult;
+        }
         if (schema.type === "string" ||
             schema.type === "integer" ||
             schema.type === "boolean" ||
@@ -215,14 +245,14 @@ class Utils {
                 if (schema.required && ((_a = schema.required) === null || _a === void 0 ? void 0 : _a.indexOf(property)) >= 0) {
                     isRequired = true;
                 }
-                const result = Utils.checkPostBody(properties[property], isRequired);
+                const result = Utils.checkPostBody(properties[property], isRequired, isCopilot);
                 paramResult.requiredNum += result.requiredNum;
                 paramResult.optionalNum += result.optionalNum;
                 paramResult.isValid = paramResult.isValid && result.isValid;
             }
         }
         else {
-            if (isRequiredWithoutDefault) {
+            if (isRequiredWithoutDefault && !isCopilot) {
                 paramResult.isValid = false;
             }
         }
@@ -242,7 +272,7 @@ class Utils {
      * 5. response body should be “application/json” and not empty, and response code should be 20X
      * 6. only support request body with “application/json” content type
      */
-    static isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2) {
+    static isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot) {
         const pathObj = spec.paths[path];
         method = method.toLocaleLowerCase();
         if (pathObj) {
@@ -275,15 +305,22 @@ class Utils {
                 };
                 if (requestJsonBody) {
                     const requestBodySchema = requestJsonBody.schema;
-                    requestBodyParamResult = Utils.checkPostBody(requestBodySchema, requestBody.required);
+                    if (isCopilot && requestBodySchema.type !== "object") {
+                        return false;
+                    }
+                    requestBodyParamResult = Utils.checkPostBody(requestBodySchema, requestBody.required, isCopilot);
                 }
                 if (!requestBodyParamResult.isValid) {
                     return false;
                 }
-                const paramResult = Utils.checkParameters(paramObject);
+                const paramResult = Utils.checkParameters(paramObject, isCopilot);
                 if (!paramResult.isValid) {
                     return false;
                 }
+                // Copilot support arbitrary parameters
+                if (isCopilot) {
+                    return true;
+                }
                 if (requestBodyParamResult.requiredNum + paramResult.requiredNum > 1) {
                     if (allowMultipleParameters &&
                         requestBodyParamResult.requiredNum + paramResult.requiredNum <= 5) {
@@ -454,7 +491,7 @@ class Utils {
         }
         return errors;
     }
-    static validateServer(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2) {
+    static validateServer(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot) {
         const errors = [];
         let hasTopLevelServers = false;
         let hasPathLevelServers = false;
@@ -475,7 +512,7 @@ class Utils {
             }
             for (const method in methods) {
                 const operationObject = methods[method];
-                if (Utils.isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2)) {
+                if (Utils.isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot)) {
                     if ((operationObject === null || operationObject === void 0 ? void 0 : operationObject.servers) && operationObject.servers.length >= 1) {
                         hasOperationLevelServers = true;
                         const serverErrors = Utils.checkServerUrl(operationObject.servers);
@@ -625,14 +662,14 @@ class Utils {
         }
         return [command, warning];
     }
-    static listSupportedAPIs(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2) {
+    static listSupportedAPIs(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot) {
         const paths = spec.paths;
         const result = {};
         for (const path in paths) {
             const methods = paths[path];
             for (const method in methods) {
                 // For developer preview, only support GET operation with only 1 parameter without auth
-                if (Utils.isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2)) {
+                if (Utils.isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot)) {
                     const operationObject = methods[method];
                     result[`${method.toUpperCase()} ${path}`] = operationObject;
                 }
@@ -640,7 +677,7 @@ class Utils {
         }
         return result;
     }
-    static validateSpec(spec, parser, isSwaggerFile, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2) {
+    static validateSpec(spec, parser, isSwaggerFile, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot) {
         const errors = [];
         const warnings = [];
         if (isSwaggerFile) {
@@ -650,7 +687,7 @@ class Utils {
             });
         }
         // Server validation
-        const serverErrors = Utils.validateServer(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2);
+        const serverErrors = Utils.validateServer(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot);
         errors.push(...serverErrors);
         // Remote reference not supported
         const refPaths = parser.$refs.paths();
@@ -663,7 +700,7 @@ class Utils {
             });
         }
         // No supported API
-        const apiMap = Utils.listSupportedAPIs(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2);
+        const apiMap = Utils.listSupportedAPIs(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot);
         if (Object.keys(apiMap).length === 0) {
             errors.push({
                 type: ErrorType.NoSupportedApi,
@@ -734,6 +771,7 @@ class SpecParser {
             allowAPIKeyAuth: false,
             allowMultipleParameters: false,
             allowOauth2: false,
+            isCopilot: false,
         };
         this.pathOrSpec = pathOrDoc;
         this.parser = new SwaggerParser();
@@ -770,7 +808,7 @@ class SpecParser {
                     ],
                 };
             }
-            return Utils.validateSpec(this.spec, this.parser, !!this.isSwaggerFile, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2);
+            return Utils.validateSpec(this.spec, this.parser, !!this.isSwaggerFile, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2, this.options.isCopilot);
         }
         catch (err) {
             throw new SpecParserError(err.toString(), ErrorType.ValidateFailed);
@@ -818,15 +856,35 @@ class SpecParser {
     async list() {
         throw new Error("Method not implemented.");
     }
+    /**
+     * Generate specs according to the filters.
+     * @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
+     */
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async getFilteredSpecs(filter, signal) {
+        throw new Error("Method not implemented.");
+    }
+    /**
+     * Generates and update artifacts from the OpenAPI specification file. Generate Adaptive Cards, update Teams app manifest, and generate a new OpenAPI specification file.
+     * @param manifestPath A file path of the Teams app manifest file to update.
+     * @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
+     * @param outputSpecPath File path of the new OpenAPI specification file to generate. If not specified or empty, no spec file will be generated.
+     * @param pluginFilePath File path of the api plugin file to generate.
+     */
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async generateForCopilot(manifestPath, filter, outputSpecPath, pluginFilePath, signal) {
+        throw new Error("Method not implemented.");
+    }
     /**
      * Generates and update artifacts from the OpenAPI specification file. Generate Adaptive Cards, update Teams app manifest, and generate a new OpenAPI specification file.
      * @param manifestPath A file path of the Teams app manifest file to update.
      * @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
      * @param outputSpecPath File path of the new OpenAPI specification file to generate. If not specified or empty, no spec file will be generated.
      * @param adaptiveCardFolder Folder path where the Adaptive Card files will be generated. If not specified or empty, Adaptive Card files will not be generated.
+     * @param isMe Boolean that indicates whether the project is an Messaging Extension. For Messaging Extension, composeExtensions will be added in Teams app manifest.
      */
     // eslint-disable-next-line @typescript-eslint/require-await
-    async generate(manifestPath, filter, outputSpecPath, adaptiveCardFolder, signal) {
+    async generate(manifestPath, filter, outputSpecPath, adaptiveCardFolder, signal, isMe) {
         throw new Error("Method not implemented.");
     }
     async loadSpec() {
@@ -843,11 +901,169 @@ class SpecParser {
         if (this.apiMap !== undefined) {
             return this.apiMap;
         }
-        const result = Utils.listSupportedAPIs(spec, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2);
+        const result = Utils.listSupportedAPIs(spec, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2, this.options.isCopilot);
         this.apiMap = result;
         return result;
     }
 }
 
-export { ConstantString, ErrorType, SpecParser, SpecParserError, Utils, ValidationStatus, WarningType };
+// Copyright (c) Microsoft Corporation.
+class AdaptiveCardGenerator {
+    static generateAdaptiveCard(operationItem) {
+        try {
+            const json = Utils.getResponseJson(operationItem);
+            let cardBody = [];
+            let schema = json.schema;
+            let jsonPath = "$";
+            if (schema && Object.keys(schema).length > 0) {
+                jsonPath = AdaptiveCardGenerator.getResponseJsonPathFromSchema(schema);
+                if (jsonPath !== "$") {
+                    schema = schema.properties[jsonPath];
+                }
+                cardBody = AdaptiveCardGenerator.generateCardFromResponse(schema, "");
+            }
+            // if no schema, try to use example value
+            if (cardBody.length === 0 && (json.examples || json.example)) {
+                cardBody = [
+                    {
+                        type: ConstantString.TextBlockType,
+                        text: "${jsonStringify($root)}",
+                        wrap: true,
+                    },
+                ];
+            }
+            // if no example value, use default success response
+            if (cardBody.length === 0) {
+                cardBody = [
+                    {
+                        type: ConstantString.TextBlockType,
+                        text: "success",
+                        wrap: true,
+                    },
+                ];
+            }
+            const fullCard = {
+                type: ConstantString.AdaptiveCardType,
+                $schema: ConstantString.AdaptiveCardSchema,
+                version: ConstantString.AdaptiveCardVersion,
+                body: cardBody,
+            };
+            return [fullCard, jsonPath];
+        }
+        catch (err) {
+            throw new SpecParserError(err.toString(), ErrorType.GenerateAdaptiveCardFailed);
+        }
+    }
+    static generateCardFromResponse(schema, name, parentArrayName = "") {
+        if (schema.type === "array") {
+            // schema.items can be arbitrary object: schema { type: array, items: {} }
+            if (Object.keys(schema.items).length === 0) {
+                return [
+                    {
+                        type: ConstantString.TextBlockType,
+                        text: name ? `${name}: \${jsonStringify(${name})}` : "result: ${jsonStringify($root)}",
+                        wrap: true,
+                    },
+                ];
+            }
+            const obj = AdaptiveCardGenerator.generateCardFromResponse(schema.items, "", name);
+            const template = {
+                type: ConstantString.ContainerType,
+                $data: name ? `\${${name}}` : "${$root}",
+                items: Array(),
+            };
+            template.items.push(...obj);
+            return [template];
+        }
+        // some schema may not contain type but contain properties
+        if (schema.type === "object" || (!schema.type && schema.properties)) {
+            const { properties } = schema;
+            const result = [];
+            for (const property in properties) {
+                const obj = AdaptiveCardGenerator.generateCardFromResponse(properties[property], name ? `${name}.${property}` : property, parentArrayName);
+                result.push(...obj);
+            }
+            if (schema.additionalProperties) {
+                // TODO: better ways to handler warnings.
+                console.warn(ConstantString.AdditionalPropertiesNotSupported);
+            }
+            return result;
+        }
+        if (schema.type === "string" ||
+            schema.type === "integer" ||
+            schema.type === "boolean" ||
+            schema.type === "number") {
+            if (!AdaptiveCardGenerator.isImageUrlProperty(schema, name, parentArrayName)) {
+                // string in root: "ddd"
+                let text = "result: ${$root}";
+                if (name) {
+                    // object { id: "1" }
+                    text = `${name}: \${if(${name}, ${name}, 'N/A')}`;
+                    if (parentArrayName) {
+                        // object types inside array: { tags: ["id": 1, "name": "name"] }
+                        text = `${parentArrayName}.${text}`;
+                    }
+                }
+                else if (parentArrayName) {
+                    // string array: photoUrls: ["1", "2"]
+                    text = `${parentArrayName}: ` + "${$data}";
+                }
+                return [
+                    {
+                        type: ConstantString.TextBlockType,
+                        text,
+                        wrap: true,
+                    },
+                ];
+            }
+            else {
+                if (name) {
+                    return [
+                        {
+                            type: "Image",
+                            url: `\${${name}}`,
+                            $when: `\${${name} != null}`,
+                        },
+                    ];
+                }
+                else {
+                    return [
+                        {
+                            type: "Image",
+                            url: "${$data}",
+                            $when: "${$data != null}",
+                        },
+                    ];
+                }
+            }
+        }
+        if (schema.oneOf || schema.anyOf || schema.not || schema.allOf) {
+            throw new Error(Utils.format(ConstantString.SchemaNotSupported, JSON.stringify(schema)));
+        }
+        throw new Error(Utils.format(ConstantString.UnknownSchema, JSON.stringify(schema)));
+    }
+    // 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)) {
+            const { properties } = schema;
+            for (const property in properties) {
+                const schema = properties[property];
+                if (schema.type === "array" &&
+                    Utils.isWellKnownName(property, ConstantString.WellknownResultNames)) {
+                    return property;
+                }
+            }
+        }
+        return "$";
+    }
+    static isImageUrlProperty(schema, name, parentArrayName) {
+        const propertyName = name ? name : parentArrayName;
+        return (!!propertyName &&
+            schema.type === "string" &&
+            Utils.isWellKnownName(propertyName, ConstantString.WellknownImageName) &&
+            (propertyName.toLocaleLowerCase().indexOf("url") >= 0 || schema.format === "uri"));
+    }
+}
+
+export { AdaptiveCardGenerator, ConstantString, ErrorType, SpecParser, SpecParserError, Utils, ValidationStatus, WarningType };
 //# sourceMappingURL=index.esm2017.js.map