@microsoft/m365-spec-parser 0.2.2-alpha.4a7c0c761.0 → 0.2.2-alpha.557dab381.0

package/dist/index.esm2017.mjs

@@ -536,6 +536,28 @@ 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 {
+                if (currentCount < maxCount) {
+                    result.push(element);
+                    currentCount++;
+                }
+            }
+        }
+        return result;
+    }
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -1083,6 +1105,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) {
@@ -1116,7 +1293,7 @@ class SpecFilter {
                 }
             }
             newSpec.paths = newPaths;
-            return newSpec;
+            return SpecOptimizer.optimize(newSpec);
         }
         catch (err) {
             throw new SpecParserError(err.toString(), ErrorType.FilterSpecFailed);
@@ -1239,7 +1416,7 @@ class AdaptiveCardGenerator {
                         {
                             type: "Image",
                             url: `\${${name}}`,
-                            $when: `\${${name} != null}`,
+                            $when: `\${${name} != null && ${name} != ''}`,
                         },
                     ];
                 }
@@ -1248,7 +1425,7 @@ class AdaptiveCardGenerator {
                         {
                             type: "Image",
                             url: "${$data}",
-                            $when: "${$data != null}",
+                            $when: "${$data != null && $data != ''}",
                         },
                     ];
                 }
@@ -1341,7 +1518,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;
@@ -1483,6 +1660,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;
@@ -1510,7 +1688,7 @@ class ManifestUpdater {
                                 }
                             }
                             const funcObj = {
-                                name: operationId,
+                                name: safeFunctionName,
                                 description: description,
                             };
                             if (options.allowResponseSemantics) {
@@ -1518,7 +1696,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,
@@ -1546,7 +1724,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);
@@ -1874,19 +2052,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;
@@ -1991,10 +2186,11 @@ class SpecParser {
                             const operation = newSpec.paths[url][method];
                             try {
                                 const [card, jsonPath] = AdaptiveCardGenerator.generateAdaptiveCard(operation);
-                                const fileName = path.join(adaptiveCardFolder, `${operation.operationId}.json`);
+                                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, `${operation.operationId}.data.json`);
+                                const dataFileName = path.join(adaptiveCardFolder, `${safeAdaptiveCardName}.data.json`);
                                 await fs.outputJSON(dataFileName, {}, { spaces: 2 });
                             }
                             catch (err) {