@microsoft/m365-spec-parser 0.2.2-alpha.a0aeb8641.0 → 0.2.2-alpha.ab66695dd.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,8 +220,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://developer.microsoft.com/json-schemas/copilot/plugin/v2.1/schema.json";
 
 // Copyright (c) Microsoft Corporation.
 class SpecParserError extends Error {
@@ -231,16 +235,19 @@ class SpecParserError extends Error {
 // Copyright (c) Microsoft Corporation.
 class Utils {
     static hasNestedObjectInSchema(schema) {
-        if (schema.type === "object") {
+        if (this.isObjectSchema(schema)) {
             for (const property in schema.properties) {
                 const nestedSchema = schema.properties[property];
-                if (nestedSchema.type === "object") {
+                if (this.isObjectSchema(nestedSchema)) {
                     return true;
                 }
             }
         }
         return false;
     }
+    static isObjectSchema(schema) {
+        return schema.type === "object" || (!schema.type && !!schema.properties);
+    }
     static containMultipleMediaTypes(bodyObject) {
         return Object.keys((bodyObject === null || bodyObject === void 0 ? void 0 : bodyObject.content) || {}).length > 1;
     }
@@ -469,7 +476,7 @@ class Utils {
                 optionalParams.push(parameter);
             }
         }
-        else if (schema.type === "object") {
+        else if (Utils.isObjectSchema(schema)) {
             const { properties } = schema;
             for (const property in properties) {
                 let isRequired = false;
@@ -807,7 +814,7 @@ class Validator {
         }
         const isRequiredWithoutDefault = isRequired && schema.default === undefined;
         const isCopilot = this.projectType === exports.ProjectType.Copilot;
-        if (isCopilot && this.hasNestedObjectInSchema(schema)) {
+        if (isCopilot && Utils.hasNestedObjectInSchema(schema)) {
             paramResult.isValid = false;
             paramResult.reason = [exports.ErrorType.RequestBodyContainsNestedObject];
             return paramResult;
@@ -823,7 +830,7 @@ class Validator {
                 paramResult.optionalNum = paramResult.optionalNum + 1;
             }
         }
-        else if (schema.type === "object") {
+        else if (Utils.isObjectSchema(schema)) {
             const { properties } = schema;
             for (const property in properties) {
                 let isRequired = false;
@@ -859,7 +866,7 @@ class Validator {
         for (let i = 0; i < paramObject.length; i++) {
             const param = paramObject[i];
             const schema = param.schema;
-            if (isCopilot && this.hasNestedObjectInSchema(schema)) {
+            if (isCopilot && Utils.hasNestedObjectInSchema(schema)) {
                 paramResult.isValid = false;
                 paramResult.reason.push(exports.ErrorType.ParamsContainsNestedObject);
                 continue;
@@ -902,17 +909,6 @@ class Validator {
         }
         return paramResult;
     }
-    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;
-    }
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -971,7 +967,7 @@ class CopilotValidator extends Validator {
         const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
         if (requestJsonBody) {
             const requestBodySchema = requestJsonBody.schema;
-            if (requestBodySchema.type !== "object") {
+            if (!Utils.isObjectSchema(requestBodySchema)) {
                 result.reason.push(exports.ErrorType.PostBodySchemaIsNotJson);
             }
             const requestBodyParamResult = this.checkPostBodySchema(requestBodySchema, requestBody.required);
@@ -1418,7 +1414,7 @@ class AdaptiveCardGenerator {
             return [template];
         }
         // some schema may not contain type but contain properties
-        if (schema.type === "object" || (!schema.type && schema.properties)) {
+        if (Utils.isObjectSchema(schema)) {
             const { properties } = schema;
             const result = [];
             for (const property in properties) {
@@ -1486,7 +1482,7 @@ class AdaptiveCardGenerator {
     }
     // 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)) {
+        if (Utils.isObjectSchema(schema)) {
             const { properties } = schema;
             for (const property in properties) {
                 const schema = properties[property];
@@ -1638,7 +1634,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);
@@ -1655,7 +1651,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];
         });
     }
@@ -1678,7 +1674,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 = [];
@@ -1727,7 +1723,7 @@ class ManifestUpdater {
                                 if (requestBody) {
                                     const requestJsonBody = requestBody.content["application/json"];
                                     const requestBodySchema = requestJsonBody.schema;
-                                    if (requestBodySchema.type === "object") {
+                                    if (Utils.isObjectSchema(requestBodySchema)) {
                                         for (const property in requestBodySchema.properties) {
                                             const schema = requestBodySchema.properties[property];
                                             ManifestUpdater.checkSchema(schema, method, pathUrl);
@@ -1738,9 +1734,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 {
@@ -1789,6 +1794,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,
@@ -1811,6 +1820,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 &&
@@ -2013,6 +2027,7 @@ class SpecParser {
     validate() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
+                let hash = "";
                 try {
                     yield this.loadSpec();
                     if (!this.parser.$refs.circular) {
@@ -2028,8 +2043,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) {
@@ -2039,6 +2059,7 @@ class SpecParser {
                         errors: [
                             { type: exports.ErrorType.SwaggerNotSupported, content: ConstantString.SwaggerNotSupported },
                         ],
+                        specHash: hash,
                     };
                 }
                 // Remote reference not supported
@@ -2072,6 +2093,7 @@ class SpecParser {
                     status: status,
                     warnings: warnings,
                     errors: errors,
+                    specHash: hash,
                 };
             }
             catch (err) {
@@ -2194,7 +2216,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,
@@ -2209,7 +2231,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 });