@microsoft/m365-spec-parser 0.1.1-alpha.cf377d39f.0 → 0.1.1-alpha.fc0606a28.0

package/dist/index.esm2017.mjs

@@ -70,6 +70,7 @@ ConstantString.OperationOnlyContainsOptionalParam = "Operation %s contains multi
 ConstantString.ConvertSwaggerToOpenAPI = "The Swagger 2.0 file has been converted to OpenAPI 3.0.";
 ConstantString.SwaggerNotSupported = "Swagger 2.0 is not supported. Please convert to OpenAPI 3.0 manually before proceeding.";
 ConstantString.MultipleAPIKeyNotSupported = "Multiple API keys are not supported. Please make sure that all selected APIs use the same API key.";
+ConstantString.UnsupportedSchema = "Unsupported schema in %s %s: %s";
 ConstantString.WrappedCardVersion = "devPreview";
 ConstantString.WrappedCardSchema = "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.ResponseRenderingTemplate.schema.json";
 ConstantString.WrappedCardResponseLayout = "list";
@@ -152,7 +153,18 @@ class SpecParserError extends Error {
 
 // Copyright (c) Microsoft Corporation.
 class Utils {
-    static checkParameters(paramObject) {
+    static 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;
+    }
+    static checkParameters(paramObject, isCopilot) {
         const paramResult = {
             requiredNum: 0,
             optionalNum: 0,
@@ -164,7 +176,20 @@ class Utils {
         for (let i = 0; i < paramObject.length; i++) {
             const param = paramObject[i];
             const schema = param.schema;
+            if (isCopilot && this.hasNestedObjectInSchema(schema)) {
+                paramResult.isValid = false;
+                continue;
+            }
             const isRequiredWithoutDefault = param.required && schema.default === undefined;
+            if (isCopilot) {
+                if (isRequiredWithoutDefault) {
+                    paramResult.requiredNum = paramResult.requiredNum + 1;
+                }
+                else {
+                    paramResult.optionalNum = paramResult.optionalNum + 1;
+                }
+                continue;
+            }
             if (param.in === "header" || param.in === "cookie") {
                 if (isRequiredWithoutDefault) {
                     paramResult.isValid = false;
@@ -191,7 +216,7 @@ class Utils {
         }
         return paramResult;
     }
-    static checkPostBody(schema, isRequired = false) {
+    static checkPostBody(schema, isRequired = false, isCopilot = false) {
         var _a;
         const paramResult = {
             requiredNum: 0,
@@ -202,6 +227,10 @@ class Utils {
             return paramResult;
         }
         const isRequiredWithoutDefault = isRequired && schema.default === undefined;
+        if (isCopilot && this.hasNestedObjectInSchema(schema)) {
+            paramResult.isValid = false;
+            return paramResult;
+        }
         if (schema.type === "string" ||
             schema.type === "integer" ||
             schema.type === "boolean" ||
@@ -220,14 +249,14 @@ class Utils {
                 if (schema.required && ((_a = schema.required) === null || _a === void 0 ? void 0 : _a.indexOf(property)) >= 0) {
                     isRequired = true;
                 }
-                const result = Utils.checkPostBody(properties[property], isRequired);
+                const result = Utils.checkPostBody(properties[property], isRequired, isCopilot);
                 paramResult.requiredNum += result.requiredNum;
                 paramResult.optionalNum += result.optionalNum;
                 paramResult.isValid = paramResult.isValid && result.isValid;
             }
         }
         else {
-            if (isRequiredWithoutDefault) {
+            if (isRequiredWithoutDefault && !isCopilot) {
                 paramResult.isValid = false;
             }
         }
@@ -247,7 +276,7 @@ class Utils {
      * 5. response body should be “application/json” and not empty, and response code should be 20X
      * 6. only support request body with “application/json” content type
      */
-    static isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2) {
+    static isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot) {
         const pathObj = spec.paths[path];
         method = method.toLocaleLowerCase();
         if (pathObj) {
@@ -280,15 +309,22 @@ class Utils {
                 };
                 if (requestJsonBody) {
                     const requestBodySchema = requestJsonBody.schema;
-                    requestBodyParamResult = Utils.checkPostBody(requestBodySchema, requestBody.required);
+                    if (isCopilot && requestBodySchema.type !== "object") {
+                        return false;
+                    }
+                    requestBodyParamResult = Utils.checkPostBody(requestBodySchema, requestBody.required, isCopilot);
                 }
                 if (!requestBodyParamResult.isValid) {
                     return false;
                 }
-                const paramResult = Utils.checkParameters(paramObject);
+                const paramResult = Utils.checkParameters(paramObject, isCopilot);
                 if (!paramResult.isValid) {
                     return false;
                 }
+                // Copilot support arbitrary parameters
+                if (isCopilot) {
+                    return true;
+                }
                 if (requestBodyParamResult.requiredNum + paramResult.requiredNum > 1) {
                     if (allowMultipleParameters &&
                         requestBodyParamResult.requiredNum + paramResult.requiredNum <= 5) {
@@ -459,7 +495,7 @@ class Utils {
         }
         return errors;
     }
-    static validateServer(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2) {
+    static validateServer(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot) {
         const errors = [];
         let hasTopLevelServers = false;
         let hasPathLevelServers = false;
@@ -480,7 +516,7 @@ class Utils {
             }
             for (const method in methods) {
                 const operationObject = methods[method];
-                if (Utils.isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2)) {
+                if (Utils.isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot)) {
                     if ((operationObject === null || operationObject === void 0 ? void 0 : operationObject.servers) && operationObject.servers.length >= 1) {
                         hasOperationLevelServers = true;
                         const serverErrors = Utils.checkServerUrl(operationObject.servers);
@@ -630,14 +666,14 @@ class Utils {
         }
         return [command, warning];
     }
-    static listSupportedAPIs(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2) {
+    static listSupportedAPIs(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot) {
         const paths = spec.paths;
         const result = {};
         for (const path in paths) {
             const methods = paths[path];
             for (const method in methods) {
                 // For developer preview, only support GET operation with only 1 parameter without auth
-                if (Utils.isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2)) {
+                if (Utils.isSupportedApi(method, path, spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot)) {
                     const operationObject = methods[method];
                     result[`${method.toUpperCase()} ${path}`] = operationObject;
                 }
@@ -645,7 +681,7 @@ class Utils {
         }
         return result;
     }
-    static validateSpec(spec, parser, isSwaggerFile, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2) {
+    static validateSpec(spec, parser, isSwaggerFile, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot) {
         const errors = [];
         const warnings = [];
         if (isSwaggerFile) {
@@ -655,7 +691,7 @@ class Utils {
             });
         }
         // Server validation
-        const serverErrors = Utils.validateServer(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2);
+        const serverErrors = Utils.validateServer(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot);
         errors.push(...serverErrors);
         // Remote reference not supported
         const refPaths = parser.$refs.paths();
@@ -668,7 +704,7 @@ class Utils {
             });
         }
         // No supported API
-        const apiMap = Utils.listSupportedAPIs(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2);
+        const apiMap = Utils.listSupportedAPIs(spec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot);
         if (Object.keys(apiMap).length === 0) {
             errors.push({
                 type: ErrorType.NoSupportedApi,
@@ -724,14 +760,14 @@ class Utils {
 
 // Copyright (c) Microsoft Corporation.
 class SpecFilter {
-    static specFilter(filter, unResolveSpec, resolvedSpec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2) {
+    static specFilter(filter, unResolveSpec, resolvedSpec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot) {
         try {
             const newSpec = Object.assign({}, unResolveSpec);
             const newPaths = {};
             for (const filterItem of filter) {
                 const [method, path] = filterItem.split(" ");
                 const methodName = method.toLowerCase();
-                if (!Utils.isSupportedApi(methodName, path, resolvedSpec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2)) {
+                if (!Utils.isSupportedApi(methodName, path, resolvedSpec, allowMissingId, allowAPIKeyAuth, allowMultipleParameters, allowOauth2, isCopilot)) {
                     continue;
                 }
                 if (!newPaths[path]) {
@@ -757,8 +793,124 @@ class SpecFilter {
 
 // Copyright (c) Microsoft Corporation.
 class ManifestUpdater {
-    static async updateManifest(manifestPath, outputSpecPath, adaptiveCardFolder, spec, allowMultipleParameters, auth, isMe) {
+    static async updateManifestWithAiPlugin(manifestPath, outputSpecPath, apiPluginFilePath, spec) {
+        const manifest = await fs.readJSON(manifestPath);
+        const apiPluginRelativePath = ManifestUpdater.getRelativePath(manifestPath, apiPluginFilePath);
+        manifest.apiPlugins = [
+            {
+                pluginFile: apiPluginRelativePath,
+            },
+        ];
+        ManifestUpdater.updateManifestDescription(manifest, spec);
+        const specRelativePath = ManifestUpdater.getRelativePath(manifestPath, outputSpecPath);
+        const apiPlugin = ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath);
+        return [manifest, apiPlugin];
+    }
+    static updateManifestDescription(manifest, spec) {
         var _a, _b;
+        manifest.description = {
+            short: spec.info.title.slice(0, ConstantString.ShortDescriptionMaxLens),
+            full: (_b = ((_a = spec.info.description) !== null && _a !== void 0 ? _a : manifest.description.full)) === null || _b === void 0 ? void 0 : _b.slice(0, ConstantString.FullDescriptionMaxLens),
+        };
+    }
+    static mapOpenAPISchemaToFuncParam(schema, method, pathUrl) {
+        let parameter;
+        if (schema.type === "string" ||
+            schema.type === "boolean" ||
+            schema.type === "integer" ||
+            schema.type === "number" ||
+            schema.type === "array") {
+            parameter = schema;
+        }
+        else {
+            throw new SpecParserError(Utils.format(ConstantString.UnsupportedSchema, method, pathUrl, JSON.stringify(schema)), ErrorType.UpdateManifestFailed);
+        }
+        return parameter;
+    }
+    static generatePluginManifestSchema(spec, specRelativePath) {
+        var _a, _b, _c;
+        const functions = [];
+        const functionNames = [];
+        const paths = spec.paths;
+        for (const pathUrl in paths) {
+            const pathItem = paths[pathUrl];
+            if (pathItem) {
+                const operations = pathItem;
+                for (const method in operations) {
+                    if (ConstantString.AllOperationMethods.includes(method)) {
+                        const operationItem = operations[method];
+                        if (operationItem) {
+                            const operationId = operationItem.operationId;
+                            const description = (_a = operationItem.description) !== null && _a !== void 0 ? _a : "";
+                            const paramObject = operationItem.parameters;
+                            const requestBody = operationItem.requestBody;
+                            const parameters = {
+                                type: "object",
+                                properties: {},
+                                required: [],
+                            };
+                            if (paramObject) {
+                                for (let i = 0; i < paramObject.length; i++) {
+                                    const param = paramObject[i];
+                                    const schema = param.schema;
+                                    parameters.properties[param.name] = ManifestUpdater.mapOpenAPISchemaToFuncParam(schema, method, pathUrl);
+                                    if (param.required) {
+                                        parameters.required.push(param.name);
+                                    }
+                                    if (!parameters.properties[param.name].description) {
+                                        parameters.properties[param.name].description = (_b = param.description) !== null && _b !== void 0 ? _b : "";
+                                    }
+                                }
+                            }
+                            if (requestBody) {
+                                const requestJsonBody = requestBody.content["application/json"];
+                                const requestBodySchema = requestJsonBody.schema;
+                                if (requestBodySchema.type === "object") {
+                                    if (requestBodySchema.required) {
+                                        parameters.required.push(...requestBodySchema.required);
+                                    }
+                                    for (const property in requestBodySchema.properties) {
+                                        const schema = requestBodySchema.properties[property];
+                                        parameters.properties[property] = ManifestUpdater.mapOpenAPISchemaToFuncParam(schema, method, pathUrl);
+                                    }
+                                }
+                                else {
+                                    throw new SpecParserError(Utils.format(ConstantString.UnsupportedSchema, method, pathUrl, JSON.stringify(requestBodySchema)), ErrorType.UpdateManifestFailed);
+                                }
+                            }
+                            const funcObj = {
+                                name: operationId,
+                                description: description,
+                                parameters: parameters,
+                            };
+                            functions.push(funcObj);
+                            functionNames.push(operationId);
+                        }
+                    }
+                }
+            }
+        }
+        const apiPlugin = {
+            schema_version: "v2",
+            name_for_human: spec.info.title,
+            description_for_human: (_c = spec.info.description) !== null && _c !== void 0 ? _c : "<Please add description of the plugin>",
+            functions: functions,
+            runtimes: [
+                {
+                    type: "OpenApi",
+                    auth: {
+                        type: "none", // TODO, support auth in the future
+                    },
+                    spec: {
+                        url: specRelativePath,
+                    },
+                    run_for_functions: functionNames,
+                },
+            ],
+        };
+        return apiPlugin;
+    }
+    static async updateManifest(manifestPath, outputSpecPath, adaptiveCardFolder, spec, allowMultipleParameters, auth, isMe) {
         try {
             const originalManifest = await fs.readJSON(manifestPath);
             const updatedPart = {};
@@ -792,10 +944,8 @@ class ManifestUpdater {
                     };
                 }
             }
-            updatedPart.description = {
-                short: spec.info.title.slice(0, ConstantString.ShortDescriptionMaxLens),
-                full: (_b = ((_a = spec.info.description) !== null && _a !== void 0 ? _a : originalManifest.description.full)) === null || _b === void 0 ? void 0 : _b.slice(0, ConstantString.FullDescriptionMaxLens),
-            };
+            updatedPart.description = originalManifest.description;
+            ManifestUpdater.updateManifestDescription(updatedPart, spec);
             updatedPart.composeExtensions = isMe === undefined || isMe === true ? [composeExtension] : [];
             const updatedManifest = Object.assign(Object.assign({}, originalManifest), updatedPart);
             return [updatedManifest, warnings];
@@ -1107,6 +1257,7 @@ class SpecParser {
             allowAPIKeyAuth: false,
             allowMultipleParameters: false,
             allowOauth2: false,
+            isCopilot: false,
         };
         this.pathOrSpec = pathOrDoc;
         this.parser = new SwaggerParser();
@@ -1139,7 +1290,7 @@ class SpecParser {
                     ],
                 };
             }
-            return Utils.validateSpec(this.spec, this.parser, !!this.isSwaggerFile, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2);
+            return Utils.validateSpec(this.spec, this.parser, !!this.isSwaggerFile, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2, this.options.isCopilot);
         }
         catch (err) {
             throw new SpecParserError(err.toString(), ErrorType.ValidateFailed);
@@ -1214,7 +1365,7 @@ class SpecParser {
             if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
                 throw new SpecParserError(ConstantString.CancelledMessage, ErrorType.Cancelled);
             }
-            const newUnResolvedSpec = SpecFilter.specFilter(filter, this.unResolveSpec, this.spec, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2);
+            const newUnResolvedSpec = SpecFilter.specFilter(filter, this.unResolveSpec, this.spec, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2, this.options.isCopilot);
             if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
                 throw new SpecParserError(ConstantString.CancelledMessage, ErrorType.Cancelled);
             }
@@ -1228,6 +1379,45 @@ class SpecParser {
             throw new SpecParserError(err.toString(), ErrorType.GetSpecFailed);
         }
     }
+    /**
+     * Generates and update artifacts from the OpenAPI specification file. Generate Adaptive Cards, update Teams app manifest, and generate a new OpenAPI specification file.
+     * @param manifestPath A file path of the Teams app manifest file to update.
+     * @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
+     * @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) {
+        const result = {
+            allSuccess: true,
+            warnings: [],
+        };
+        try {
+            const newSpecs = await this.getFilteredSpecs(filter, signal);
+            const newUnResolvedSpec = newSpecs[0];
+            const newSpec = newSpecs[1];
+            let resultStr;
+            if (outputSpecPath.endsWith(".yaml") || outputSpecPath.endsWith(".yml")) {
+                resultStr = jsyaml.dump(newUnResolvedSpec);
+            }
+            else {
+                resultStr = JSON.stringify(newUnResolvedSpec, null, 2);
+            }
+            await fs.outputFile(outputSpecPath, resultStr);
+            if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+                throw new SpecParserError(ConstantString.CancelledMessage, ErrorType.Cancelled);
+            }
+            const [updatedManifest, apiPlugin] = await ManifestUpdater.updateManifestWithAiPlugin(manifestPath, outputSpecPath, pluginFilePath, newSpec);
+            await fs.outputJSON(manifestPath, updatedManifest, { spaces: 2 });
+            await fs.outputJSON(pluginFilePath, apiPlugin, { spaces: 2 });
+        }
+        catch (err) {
+            if (err instanceof SpecParserError) {
+                throw err;
+            }
+            throw new SpecParserError(err.toString(), ErrorType.GenerateFailed);
+        }
+        return result;
+    }
     /**
      * Generates and update artifacts from the OpenAPI specification file. Generate Adaptive Cards, update Teams app manifest, and generate a new OpenAPI specification file.
      * @param manifestPath A file path of the Teams app manifest file to update.
@@ -1328,7 +1518,7 @@ class SpecParser {
         if (this.apiMap !== undefined) {
             return this.apiMap;
         }
-        const result = Utils.listSupportedAPIs(spec, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2);
+        const result = Utils.listSupportedAPIs(spec, this.options.allowMissingId, this.options.allowAPIKeyAuth, this.options.allowMultipleParameters, this.options.allowOauth2, this.options.isCopilot);
         this.apiMap = result;
         return result;
     }