@microsoft/m365-spec-parser 0.2.2-alpha.9389d4dc7.0 → 0.2.2-alpha.99de858a6.0

package/dist/index.esm2017.mjs

@@ -3,6 +3,7 @@ import converter from 'swagger2openapi';
 import jsyaml from 'js-yaml';
 import fs from 'fs-extra';
 import path from 'path';
+import { createHash } from 'crypto';
 
 // Copyright (c) Microsoft Corporation.
 /**
@@ -58,6 +59,7 @@ var WarningType;
     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";
 })(WarningType || (WarningType = {}));
 /**
@@ -96,6 +98,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";
@@ -175,8 +178,9 @@ 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";
+ConstantString.PluginManifestSchema = "https://aka.ms/json-schemas/copilot/plugin/v2.1/schema.json";
 
 // Copyright (c) Microsoft Corporation.
 class SpecParserError extends Error {
@@ -1596,7 +1600,7 @@ function inferProperties(card) {
 
 // Copyright (c) Microsoft Corporation.
 class ManifestUpdater {
-    static async updateManifestWithAiPlugin(manifestPath, outputSpecPath, apiPluginFilePath, spec, options, authInfo) {
+    static async updateManifestWithAiPlugin(manifestPath, outputSpecPath, apiPluginFilePath, spec, options, authInfo, existingPluginManifestInfo) {
         const manifest = await fs.readJSON(manifestPath);
         const apiPluginRelativePath = ManifestUpdater.getRelativePath(manifestPath, apiPluginFilePath);
         manifest.copilotExtensions = manifest.copilotExtensions || {};
@@ -1612,7 +1616,7 @@ class ManifestUpdater {
         }
         const appName = this.removeEnvs(manifest.name.short);
         const specRelativePath = ManifestUpdater.getRelativePath(manifestPath, outputSpecPath);
-        const [apiPlugin, warnings] = await ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options);
+        const [apiPlugin, warnings] = await ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options, existingPluginManifestInfo);
         return [manifest, apiPlugin, warnings];
     }
     static updateManifestDescription(manifest, spec) {
@@ -1634,7 +1638,7 @@ class ManifestUpdater {
             throw new SpecParserError(Utils.format(ConstantString.UnsupportedSchema, method, pathUrl, JSON.stringify(schema)), ErrorType.UpdateManifestFailed);
         }
     }
-    static async generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options) {
+    static async generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options, existingPluginManifestInfo) {
         var _a, _b, _c, _d;
         const warnings = [];
         const functions = [];
@@ -1693,9 +1697,18 @@ class ManifestUpdater {
                                     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({
+                                    type: 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 {
@@ -1744,6 +1757,10 @@ class ManifestUpdater {
         if (await fs.pathExists(apiPluginFilePath)) {
             apiPlugin = await fs.readJSON(apiPluginFilePath);
         }
+        else if (existingPluginManifestInfo &&
+            (await fs.pathExists(existingPluginManifestInfo.manifestPath))) {
+            apiPlugin = await fs.readJSON(existingPluginManifestInfo.manifestPath);
+        }
         else {
             apiPlugin = {
                 $schema: ConstantString.PluginManifestSchema,
@@ -1766,6 +1783,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 &&
@@ -1962,6 +1984,7 @@ class SpecParser {
      */
     async validate() {
         try {
+            let hash = "";
             try {
                 await this.loadSpec();
                 if (!this.parser.$refs.circular) {
@@ -1977,8 +2000,13 @@ class SpecParser {
                     status: ValidationStatus.Error,
                     warnings: [],
                     errors: [{ type: ErrorType.SpecNotValid, content: e.toString() }],
+                    specHash: hash,
                 };
             }
+            if (this.unResolveSpec.servers) {
+                const serverString = JSON.stringify(this.unResolveSpec.servers);
+                hash = createHash("sha256").update(serverString).digest("hex");
+            }
             const errors = [];
             const warnings = [];
             if (!this.options.allowSwagger && this.isSwaggerFile) {
@@ -1988,6 +2016,7 @@ class SpecParser {
                     errors: [
                         { type: ErrorType.SwaggerNotSupported, content: ConstantString.SwaggerNotSupported },
                     ],
+                    specHash: hash,
                 };
             }
             // Remote reference not supported
@@ -2021,6 +2050,7 @@ class SpecParser {
                 status: status,
                 warnings: warnings,
                 errors: errors,
+                specHash: hash,
             };
         }
         catch (err) {
@@ -2136,7 +2166,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.
      */
-    async generateForCopilot(manifestPath, filter, outputSpecPath, pluginFilePath, signal) {
+    async generateForCopilot(manifestPath, filter, outputSpecPath, pluginFilePath, existingPluginFilePath, signal) {
         const result = {
             allSuccess: true,
             warnings: [],
@@ -2150,7 +2180,13 @@ class SpecParser {
             if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
                 throw new SpecParserError(ConstantString.CancelledMessage, ErrorType.Cancelled);
             }
-            const [updatedManifest, apiPlugin, warnings] = await ManifestUpdater.updateManifestWithAiPlugin(manifestPath, outputSpecPath, pluginFilePath, newSpec, this.options, authInfo);
+            const existingPluginManifestInfo = existingPluginFilePath
+                ? {
+                    manifestPath: existingPluginFilePath,
+                    specPath: this.pathOrSpec,
+                }
+                : undefined;
+            const [updatedManifest, apiPlugin, warnings] = await ManifestUpdater.updateManifestWithAiPlugin(manifestPath, outputSpecPath, pluginFilePath, newSpec, this.options, authInfo, existingPluginManifestInfo);
             result.warnings.push(...warnings);
             await fs.outputJSON(manifestPath, updatedManifest, { spaces: 4 });
             await fs.outputJSON(pluginFilePath, apiPlugin, { spaces: 4 });