@microsoft/m365-spec-parser 0.2.2-alpha.6e69e41c0.0 → 0.2.2-alpha.7f0eac5b0.0

package/dist/index.node.cjs.js

@@ -302,23 +302,28 @@ class Utils {
         return str.charAt(0).toUpperCase() + str.slice(1);
     }
     static getResponseJson(operationObject, allowMultipleMediaType = false) {
-        var _a, _b;
+        var _a;
         let json = {};
         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 ((_b = responseObject === null || responseObject === void 0 ? void 0 : responseObject.content) === null || _b === void 0 ? void 0 : _b["application/json"]) {
-                multipleMediaType = false;
-                json = responseObject.content["application/json"];
-                if (Utils.containMultipleMediaTypes(responseObject)) {
-                    multipleMediaType = true;
-                    if (!allowMultipleMediaType) {
-                        json = {};
+            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 };
+                        }
                     }
                 }
-                else {
-                    break;
-                }
             }
         }
         return { json, multipleMediaType };
@@ -578,6 +583,29 @@ 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.
@@ -1125,6 +1153,161 @@ class ValidatorFactory {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+class SpecOptimizer {
+    static optimize(spec, options) {
+        const mergedOptions = Object.assign(Object.assign({}, SpecOptimizer.defaultOptions), (options !== null && options !== void 0 ? options : {}));
+        const newSpec = JSON.parse(JSON.stringify(spec));
+        if (mergedOptions.removeUserDefinedRootProperty) {
+            SpecOptimizer.removeUserDefinedRootProperty(newSpec);
+        }
+        if (mergedOptions.removeUnusedComponents) {
+            SpecOptimizer.removeUnusedComponents(newSpec);
+        }
+        if (mergedOptions.removeUnusedTags) {
+            SpecOptimizer.removeUnusedTags(newSpec);
+        }
+        if (mergedOptions.removeUnusedSecuritySchemas) {
+            SpecOptimizer.removeUnusedSecuritySchemas(newSpec);
+        }
+        return newSpec;
+    }
+    static removeUnusedSecuritySchemas(spec) {
+        if (!spec.components || !spec.components.securitySchemes) {
+            return;
+        }
+        const usedSecuritySchemas = new Set();
+        for (const pathKey in spec.paths) {
+            for (const methodKey in spec.paths[pathKey]) {
+                const operation = spec.paths[pathKey][methodKey];
+                if (operation.security) {
+                    operation.security.forEach((securityReq) => {
+                        for (const schemaKey in securityReq) {
+                            usedSecuritySchemas.add(schemaKey);
+                        }
+                    });
+                }
+            }
+        }
+        if (spec.security) {
+            spec.security.forEach((securityReq) => {
+                for (const schemaKey in securityReq) {
+                    usedSecuritySchemas.add(schemaKey);
+                }
+            });
+        }
+        for (const schemaKey in spec.components.securitySchemes) {
+            if (!usedSecuritySchemas.has(schemaKey)) {
+                delete spec.components.securitySchemes[schemaKey];
+            }
+        }
+        if (Object.keys(spec.components.securitySchemes).length === 0) {
+            delete spec.components.securitySchemes;
+        }
+        if (Object.keys(spec.components).length === 0) {
+            delete spec.components;
+        }
+    }
+    static removeUnusedTags(spec) {
+        if (!spec.tags) {
+            return;
+        }
+        const usedTags = new Set();
+        for (const pathKey in spec.paths) {
+            for (const methodKey in spec.paths[pathKey]) {
+                const operation = spec.paths[pathKey][methodKey];
+                if (operation.tags) {
+                    operation.tags.forEach((tag) => usedTags.add(tag));
+                }
+            }
+        }
+        spec.tags = spec.tags.filter((tagObj) => usedTags.has(tagObj.name));
+    }
+    static removeUserDefinedRootProperty(spec) {
+        for (const key in spec) {
+            if (key.startsWith("x-")) {
+                delete spec[key];
+            }
+        }
+    }
+    static removeUnusedComponents(spec) {
+        const components = spec.components;
+        if (!components) {
+            return;
+        }
+        delete spec.components;
+        const usedComponentsSet = new Set();
+        const specString = JSON.stringify(spec);
+        const componentReferences = SpecOptimizer.getComponentReferences(specString);
+        for (const reference of componentReferences) {
+            this.addComponent(reference, usedComponentsSet, components);
+        }
+        const newComponents = {};
+        for (const componentName of usedComponentsSet) {
+            const parts = componentName.split("/");
+            const component = this.getComponent(componentName, components);
+            if (component) {
+                let current = newComponents;
+                for (let i = 2; i < parts.length; i++) {
+                    if (i === parts.length - 1) {
+                        current[parts[i]] = component;
+                    }
+                    else if (!current[parts[i]]) {
+                        current[parts[i]] = {};
+                    }
+                    current = current[parts[i]];
+                }
+            }
+        }
+        // securitySchemes are referenced directly by name, to void issue, just keep them all and use removeUnusedSecuritySchemas to remove unused ones
+        if (components.securitySchemes) {
+            newComponents.securitySchemes = components.securitySchemes;
+        }
+        if (Object.keys(newComponents).length !== 0) {
+            spec.components = newComponents;
+        }
+    }
+    static getComponentReferences(specString) {
+        const matches = Array.from(specString.matchAll(/['"](#\/components\/.+?)['"]/g));
+        const matchResult = matches.map((match) => match[1]);
+        return matchResult;
+    }
+    static getComponent(componentPath, components) {
+        const parts = componentPath.split("/");
+        let current = components;
+        for (const part of parts) {
+            if (part === "#" || part === "components") {
+                continue;
+            }
+            current = current[part];
+            if (!current) {
+                return null;
+            }
+        }
+        return current;
+    }
+    static addComponent(componentName, usedComponentsSet, components) {
+        if (usedComponentsSet.has(componentName)) {
+            return;
+        }
+        usedComponentsSet.add(componentName);
+        const component = this.getComponent(componentName, components);
+        if (component) {
+            const componentString = JSON.stringify(component);
+            const componentReferences = SpecOptimizer.getComponentReferences(componentString);
+            for (const reference of componentReferences) {
+                this.addComponent(reference, usedComponentsSet, components);
+            }
+        }
+    }
+}
+SpecOptimizer.defaultOptions = {
+    removeUnusedComponents: true,
+    removeUnusedTags: true,
+    removeUserDefinedRootProperty: true,
+    removeUnusedSecuritySchemas: true,
+};
+
 // Copyright (c) Microsoft Corporation.
 class SpecFilter {
     static specFilter(filter, unResolveSpec, resolvedSpec, options) {
@@ -1158,7 +1341,7 @@ class SpecFilter {
                 }
             }
             newSpec.paths = newPaths;
-            return newSpec;
+            return SpecOptimizer.optimize(newSpec);
         }
         catch (err) {
             throw new SpecParserError(err.toString(), exports.ErrorType.FilterSpecFailed);
@@ -1281,7 +1464,7 @@ class AdaptiveCardGenerator {
                         {
                             type: "Image",
                             url: `\${${name}}`,
-                            $when: `\${${name} != null}`,
+                            $when: `\${${name} != null && ${name} != ''}`,
                         },
                     ];
                 }
@@ -1290,7 +1473,7 @@ class AdaptiveCardGenerator {
                         {
                             type: "Image",
                             url: "${$data}",
-                            $when: "${$data != null}",
+                            $when: "${$data != null && $data != ''}",
                         },
                     ];
                 }
@@ -1383,7 +1566,7 @@ function inferPreviewCardTemplate(card) {
         result.image = {
             url: `\${${inferredProperties.imageUrl}}`,
             alt: `\${if(${inferredProperties.imageUrl}, ${inferredProperties.imageUrl}, 'N/A')}`,
-            $when: `\${${inferredProperties.imageUrl} != null}`,
+            $when: `\${${inferredProperties.imageUrl} != null && ${inferredProperties.imageUrl} != ''}`,
         };
     }
     return result;
@@ -1528,6 +1711,7 @@ class ManifestUpdater {
                             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;
@@ -1555,7 +1739,7 @@ class ManifestUpdater {
                                     }
                                 }
                                 const funcObj = {
-                                    name: operationId,
+                                    name: safeFunctionName,
                                     description: description,
                                 };
                                 if (options.allowResponseSemantics) {
@@ -1563,7 +1747,7 @@ class ManifestUpdater {
                                         const { json } = Utils.getResponseJson(operationItem);
                                         if (json.schema) {
                                             const [card, jsonPath] = AdaptiveCardGenerator.generateAdaptiveCard(operationItem);
-                                            card.body = card.body.slice(0, 5);
+                                            card.body = Utils.limitACBodyProperties(card.body, 5);
                                             const responseSemantic = wrapResponseSemantics(card, jsonPath);
                                             funcObj.capabilities = {
                                                 response_semantics: responseSemantic,
@@ -1591,7 +1775,7 @@ class ManifestUpdater {
                                     }
                                 }
                                 functions.push(funcObj);
-                                functionNames.push(operationId);
+                                functionNames.push(safeFunctionName);
                                 const conversationStarterStr = (summary !== null && summary !== void 0 ? summary : description).slice(0, ConstantString.ConversationStarterMaxLens);
                                 if (conversationStarterStr) {
                                     conversationStarters.push(conversationStarterStr);
@@ -1929,19 +2113,36 @@ class SpecParser {
                         isValid: isValid,
                         reason: reason,
                     };
-                    if (isValid) {
+                    // Try best to parse server url and auth type
+                    try {
                         const serverObj = Utils.getServerObject(spec, method.toLocaleLowerCase(), path);
                         if (serverObj) {
                             apiResult.server = serverObj.url;
                         }
+                    }
+                    catch (err) {
+                        // ignore
+                    }
+                    try {
                         const authArray = Utils.getAuthArray(operation.security, spec);
-                        for (const auths of authArray) {
-                            if (auths.length === 1) {
-                                apiResult.auth = auths[0];
-                                break;
+                        if (authArray.length !== 0) {
+                            for (const auths of authArray) {
+                                if (auths.length === 1) {
+                                    apiResult.auth = auths[0];
+                                    break;
+                                }
+                                else {
+                                    apiResult.auth = {
+                                        authScheme: { type: "multipleAuth" },
+                                        name: auths.map((auth) => auth.name).join(", "),
+                                    };
+                                }
                             }
                         }
                     }
+                    catch (err) {
+                        // ignore
+                    }
                     result.APIs.push(apiResult);
                 }
                 result.allAPICount = result.APIs.length;
@@ -2052,10 +2253,11 @@ class SpecParser {
                                 const operation = newSpec.paths[url][method];
                                 try {
                                     const [card, jsonPath] = AdaptiveCardGenerator.generateAdaptiveCard(operation);
-                                    const fileName = path__default['default'].join(adaptiveCardFolder, `${operation.operationId}.json`);
+                                    const safeAdaptiveCardName = operation.operationId.replace(/[^a-zA-Z0-9]/g, "_");
+                                    const fileName = path__default['default'].join(adaptiveCardFolder, `${safeAdaptiveCardName}.json`);
                                     const wrappedCard = wrapAdaptiveCard(card, jsonPath);
                                     yield fs__default['default'].outputJSON(fileName, wrappedCard, { spaces: 2 });
-                                    const dataFileName = path__default['default'].join(adaptiveCardFolder, `${operation.operationId}.data.json`);
+                                    const dataFileName = path__default['default'].join(adaptiveCardFolder, `${safeAdaptiveCardName}.data.json`);
                                     yield fs__default['default'].outputJSON(dataFileName, {}, { spaces: 2 });
                                 }
                                 catch (err) {