@microsoft/m365-spec-parser 0.2.2-alpha.8020c3125.0 → 0.2.2-alpha.82b9276fd.0

package/dist/index.node.cjs.js

@@ -7,6 +7,7 @@ var converter = require('swagger2openapi');
 var jsyaml = require('js-yaml');
 var fs = require('fs-extra');
 var path = require('path');
+var crypto = require('crypto');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -100,6 +101,7 @@ exports.WarningType = void 0;
     WarningType["GenerateCardFailed"] = "generate-card-failed";
     WarningType["OperationOnlyContainsOptionalParam"] = "operation-only-contains-optional-param";
     WarningType["ConvertSwaggerToOpenAPI"] = "convert-swagger-to-openapi";
+    WarningType["FuncDescriptionTooLong"] = "function-description-too-long";
     WarningType["Unknown"] = "unknown";
 })(exports.WarningType || (exports.WarningType = {}));
 /**
@@ -138,6 +140,7 @@ ConstantString.SwaggerNotSupported = "Swagger 2.0 is not supported. Please conve
 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.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";
 ConstantString.WrappedCardSchema = "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.ResponseRenderingTemplate.schema.json";
 ConstantString.WrappedCardResponseLayout = "list";
@@ -217,6 +220,7 @@ ConstantString.ConversationStarterMaxLens = 50;
 ConstantString.CommandTitleMaxLens = 32;
 ConstantString.ParameterTitleMaxLens = 32;
 ConstantString.SMERequiredParamsMaxNum = 5;
+ConstantString.FunctionDescriptionMaxLens = 100;
 ConstantString.DefaultPluginId = "plugin_1";
 ConstantString.PluginManifestSchema = "https://aka.ms/json-schemas/copilot-extensions/v2.1/plugin.schema.json";
 
@@ -302,23 +306,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 };
@@ -592,10 +601,11 @@ class Utils {
                 currentCount += items.length;
             }
             else {
-                if (currentCount < maxCount) {
-                    result.push(element);
-                    currentCount++;
-                }
+                result.push(element);
+                currentCount++;
+            }
+            if (currentCount >= maxCount) {
+                break;
             }
         }
         return result;
@@ -1632,7 +1642,7 @@ function inferProperties(card) {
 
 // Copyright (c) Microsoft Corporation.
 class ManifestUpdater {
-    static updateManifestWithAiPlugin(manifestPath, outputSpecPath, apiPluginFilePath, spec, options, authInfo) {
+    static updateManifestWithAiPlugin(manifestPath, outputSpecPath, apiPluginFilePath, spec, options, authInfo, existingPluginManifestInfo) {
         return __awaiter(this, void 0, void 0, function* () {
             const manifest = yield fs__default['default'].readJSON(manifestPath);
             const apiPluginRelativePath = ManifestUpdater.getRelativePath(manifestPath, apiPluginFilePath);
@@ -1649,7 +1659,7 @@ class ManifestUpdater {
             }
             const appName = this.removeEnvs(manifest.name.short);
             const specRelativePath = ManifestUpdater.getRelativePath(manifestPath, outputSpecPath);
-            const [apiPlugin, warnings] = yield ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options);
+            const [apiPlugin, warnings] = yield ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options, existingPluginManifestInfo);
             return [manifest, apiPlugin, warnings];
         });
     }
@@ -1672,7 +1682,7 @@ class ManifestUpdater {
             throw new SpecParserError(Utils.format(ConstantString.UnsupportedSchema, method, pathUrl, JSON.stringify(schema)), exports.ErrorType.UpdateManifestFailed);
         }
     }
-    static generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options) {
+    static generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options, existingPluginManifestInfo) {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
             const warnings = [];
@@ -1732,9 +1742,18 @@ class ManifestUpdater {
                                         throw new SpecParserError(Utils.format(ConstantString.UnsupportedSchema, method, pathUrl, JSON.stringify(requestBodySchema)), exports.ErrorType.UpdateManifestFailed);
                                     }
                                 }
+                                let funcDescription = operationItem.description || operationItem.summary || "";
+                                if (funcDescription.length > ConstantString.FunctionDescriptionMaxLens) {
+                                    warnings.push({
+                                        type: exports.WarningType.FuncDescriptionTooLong,
+                                        content: Utils.format(ConstantString.FuncDescriptionTooLong, safeFunctionName, funcDescription.length.toString(), ConstantString.FunctionDescriptionMaxLens.toString()),
+                                        data: safeFunctionName,
+                                    });
+                                    funcDescription = funcDescription.slice(0, ConstantString.FunctionDescriptionMaxLens);
+                                }
                                 const funcObj = {
                                     name: safeFunctionName,
-                                    description: description,
+                                    description: funcDescription,
                                 };
                                 if (options.allowResponseSemantics) {
                                     try {
@@ -1783,6 +1802,10 @@ class ManifestUpdater {
             if (yield fs__default['default'].pathExists(apiPluginFilePath)) {
                 apiPlugin = yield fs__default['default'].readJSON(apiPluginFilePath);
             }
+            else if (existingPluginManifestInfo &&
+                (yield fs__default['default'].pathExists(existingPluginManifestInfo.manifestPath))) {
+                apiPlugin = yield fs__default['default'].readJSON(existingPluginManifestInfo.manifestPath);
+            }
             else {
                 apiPlugin = {
                     $schema: ConstantString.PluginManifestSchema,
@@ -1805,6 +1828,11 @@ class ManifestUpdater {
                 }
             }
             apiPlugin.runtimes = apiPlugin.runtimes || [];
+            // Need to delete previous runtime since spec path has changed
+            if (existingPluginManifestInfo) {
+                const relativePath = ManifestUpdater.getRelativePath(existingPluginManifestInfo.manifestPath, existingPluginManifestInfo.specPath);
+                apiPlugin.runtimes = apiPlugin.runtimes.filter((runtime) => runtime.spec.url !== relativePath);
+            }
             const index = apiPlugin.runtimes.findIndex((runtime) => {
                 var _a, _b;
                 return runtime.spec.url === specRelativePath &&
@@ -2007,6 +2035,7 @@ class SpecParser {
     validate() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
+                let hash = "";
                 try {
                     yield this.loadSpec();
                     if (!this.parser.$refs.circular) {
@@ -2022,8 +2051,13 @@ class SpecParser {
                         status: exports.ValidationStatus.Error,
                         warnings: [],
                         errors: [{ type: exports.ErrorType.SpecNotValid, content: e.toString() }],
+                        specHash: hash,
                     };
                 }
+                if (this.unResolveSpec.servers) {
+                    const serverString = JSON.stringify(this.unResolveSpec.servers);
+                    hash = crypto.createHash("sha256").update(serverString).digest("hex");
+                }
                 const errors = [];
                 const warnings = [];
                 if (!this.options.allowSwagger && this.isSwaggerFile) {
@@ -2033,6 +2067,7 @@ class SpecParser {
                         errors: [
                             { type: exports.ErrorType.SwaggerNotSupported, content: ConstantString.SwaggerNotSupported },
                         ],
+                        specHash: hash,
                     };
                 }
                 // Remote reference not supported
@@ -2066,6 +2101,7 @@ class SpecParser {
                     status: status,
                     warnings: warnings,
                     errors: errors,
+                    specHash: hash,
                 };
             }
             catch (err) {
@@ -2188,7 +2224,7 @@ class SpecParser {
      * @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.
      */
-    generateForCopilot(manifestPath, filter, outputSpecPath, pluginFilePath, signal) {
+    generateForCopilot(manifestPath, filter, outputSpecPath, pluginFilePath, existingPluginFilePath, signal) {
         return __awaiter(this, void 0, void 0, function* () {
             const result = {
                 allSuccess: true,
@@ -2203,7 +2239,13 @@ class SpecParser {
                 if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
                     throw new SpecParserError(ConstantString.CancelledMessage, exports.ErrorType.Cancelled);
                 }
-                const [updatedManifest, apiPlugin, warnings] = yield ManifestUpdater.updateManifestWithAiPlugin(manifestPath, outputSpecPath, pluginFilePath, newSpec, this.options, authInfo);
+                const existingPluginManifestInfo = existingPluginFilePath
+                    ? {
+                        manifestPath: existingPluginFilePath,
+                        specPath: this.pathOrSpec,
+                    }
+                    : undefined;
+                const [updatedManifest, apiPlugin, warnings] = yield ManifestUpdater.updateManifestWithAiPlugin(manifestPath, outputSpecPath, pluginFilePath, newSpec, this.options, authInfo, existingPluginManifestInfo);
                 result.warnings.push(...warnings);
                 yield fs__default['default'].outputJSON(manifestPath, updatedManifest, { spaces: 4 });
                 yield fs__default['default'].outputJSON(pluginFilePath, apiPlugin, { spaces: 4 });