@microsoft/m365-spec-parser 0.1.1-alpha.f4dd51600.0 → 0.1.1-alpha.fbb412c19.0

package/dist/index.esm2017.mjs

@@ -83,7 +83,7 @@ ConstantString.RemoteRefNotSupported = "Remote reference is not supported: %s.";
 ConstantString.MissingOperationId = "Missing operationIds: %s.";
 ConstantString.NoSupportedApi = "No supported API is found in the OpenAPI description document: only GET and POST methods are supported, additionally, there can be at most one required parameter, and no auth is allowed.";
 ConstantString.AdditionalPropertiesNotSupported = "'additionalProperties' is not supported, and will be ignored.";
-ConstantString.SchemaNotSupported = "'oneOf', 'anyOf', and 'not' schema are not supported: %s.";
+ConstantString.SchemaNotSupported = "'oneOf', 'allOf', 'anyOf', and 'not' schema are not supported: %s.";
 ConstantString.UnknownSchema = "Unknown schema: %s.";
 ConstantString.UrlProtocolNotSupported = "Server url is not correct: protocol %s is not supported, you should use https protocol instead.";
 ConstantString.RelativeServerUrlNotSupported = "Server url is not correct: relative server url is not supported.";
@@ -105,8 +105,12 @@ ConstantString.AdaptiveCardType = "AdaptiveCard";
 ConstantString.TextBlockType = "TextBlock";
 ConstantString.ImageType = "Image";
 ConstantString.ContainerType = "Container";
-ConstantString.RegistrationIdPostfix = "REGISTRATION_ID";
-ConstantString.OAuthRegistrationIdPostFix = "OAUTH_REGISTRATION_ID";
+ConstantString.RegistrationIdPostfix = {
+    apiKey: "REGISTRATION_ID",
+    oauth2: "CONFIGURATION_ID",
+    http: "REGISTRATION_ID",
+    openIdConnect: "REGISTRATION_ID",
+};
 ConstantString.ResponseCodeFor20X = [
     "200",
     "201",
@@ -165,6 +169,7 @@ ConstantString.ShortDescriptionMaxLens = 80;
 ConstantString.FullDescriptionMaxLens = 4000;
 ConstantString.CommandDescriptionMaxLens = 128;
 ConstantString.ParameterDescriptionMaxLens = 128;
+ConstantString.ConversationStarterMaxLens = 50;
 ConstantString.CommandTitleMaxLens = 32;
 ConstantString.ParameterTitleMaxLens = 32;
 ConstantString.SMERequiredParamsMaxNum = 5;
@@ -209,9 +214,10 @@ class Utils {
         var _a;
         const result = [];
         const securitySchemas = (_a = spec.components) === null || _a === void 0 ? void 0 : _a.securitySchemes;
-        if (securities && securitySchemas) {
-            for (let i = 0; i < securities.length; i++) {
-                const security = securities[i];
+        const securitiesArr = securities !== null && securities !== void 0 ? securities : spec.security;
+        if (securitiesArr && securitySchemas) {
+            for (let i = 0; i < securitiesArr.length; i++) {
+                const security = securitiesArr[i];
                 const authArray = [];
                 for (const name in security) {
                     const auth = securitySchemas[name];
@@ -228,6 +234,25 @@ class Utils {
         result.sort((a, b) => a[0].name.localeCompare(b[0].name));
         return result;
     }
+    static getAuthInfo(spec) {
+        let authInfo = undefined;
+        for (const url in spec.paths) {
+            for (const method in spec.paths[url]) {
+                const operation = spec.paths[url][method];
+                const authArray = Utils.getAuthArray(operation.security, spec);
+                if (authArray && authArray.length > 0) {
+                    const currentAuth = authArray[0][0];
+                    if (!authInfo) {
+                        authInfo = authArray[0][0];
+                    }
+                    else if (authInfo.name !== currentAuth.name) {
+                        throw new SpecParserError(ConstantString.MultipleAuthNotSupported, ErrorType.MultipleAuthNotSupported);
+                    }
+                }
+            }
+        }
+        return authInfo;
+    }
     static updateFirstLetter(str) {
         return str.charAt(0).toUpperCase() + str.slice(1);
     }
@@ -609,13 +634,15 @@ class Validator {
         const result = { isValid: true, reason: [] };
         const operationObject = this.spec.paths[path][method];
         const { json, multipleMediaType } = Utils.getResponseJson(operationObject);
-        // only support response body only contains “application/json” content type
-        if (multipleMediaType) {
-            result.reason.push(ErrorType.ResponseContainMultipleMediaTypes);
-        }
-        else if (Object.keys(json).length === 0) {
-            // response body should not be empty
-            result.reason.push(ErrorType.ResponseJsonIsEmpty);
+        if (this.options.projectType === ProjectType.SME) {
+            // only support response body only contains “application/json” content type
+            if (multipleMediaType) {
+                result.reason.push(ErrorType.ResponseContainMultipleMediaTypes);
+            }
+            else if (Object.keys(json).length === 0) {
+                // response body should not be empty
+                result.reason.push(ErrorType.ResponseJsonIsEmpty);
+            }
         }
         return result;
     }
@@ -833,9 +860,6 @@ class CopilotValidator extends Validator {
         // validate requestBody
         const requestBody = operationObject.requestBody;
         const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
-        if (Utils.containMultipleMediaTypes(requestBody)) {
-            result.reason.push(ErrorType.PostBodyContainMultipleMediaTypes);
-        }
         if (requestJsonBody) {
             const requestBodySchema = requestJsonBody.schema;
             if (requestBodySchema.type !== "object") {
@@ -1340,19 +1364,22 @@ function inferProperties(card) {
 
 // Copyright (c) Microsoft Corporation.
 class ManifestUpdater {
-    static async updateManifestWithAiPlugin(manifestPath, outputSpecPath, apiPluginFilePath, spec, options) {
+    static async updateManifestWithAiPlugin(manifestPath, outputSpecPath, apiPluginFilePath, spec, options, authInfo) {
         const manifest = await fs.readJSON(manifestPath);
         const apiPluginRelativePath = ManifestUpdater.getRelativePath(manifestPath, apiPluginFilePath);
-        manifest.plugins = [
-            {
-                file: apiPluginRelativePath,
-                id: ConstantString.DefaultPluginId,
-            },
-        ];
+        // Insert plugins in manifest.json if it is plugin for Copilot.
+        if (!options.isGptPlugin) {
+            manifest.plugins = [
+                {
+                    file: apiPluginRelativePath,
+                    id: ConstantString.DefaultPluginId,
+                },
+            ];
+            ManifestUpdater.updateManifestDescription(manifest, spec);
+        }
         const appName = this.removeEnvs(manifest.name.short);
-        ManifestUpdater.updateManifestDescription(manifest, spec);
         const specRelativePath = ManifestUpdater.getRelativePath(manifestPath, outputSpecPath);
-        const apiPlugin = await ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, options);
+        const apiPlugin = await ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options);
         return [manifest, apiPlugin];
     }
     static updateManifestDescription(manifest, spec) {
@@ -1362,26 +1389,39 @@ class ManifestUpdater {
             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;
+    static checkSchema(schema, method, pathUrl) {
+        if (schema.type === "array") {
+            const items = schema.items;
+            ManifestUpdater.checkSchema(items, method, pathUrl);
         }
-        else {
+        else if (schema.type !== "string" &&
+            schema.type !== "boolean" &&
+            schema.type !== "integer" &&
+            schema.type !== "number") {
             throw new SpecParserError(Utils.format(ConstantString.UnsupportedSchema, method, pathUrl, JSON.stringify(schema)), ErrorType.UpdateManifestFailed);
         }
-        return parameter;
     }
-    static async generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, options) {
+    static async generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options) {
         var _a, _b, _c, _d;
         const functions = [];
         const functionNames = [];
         const conversationStarters = [];
         const paths = spec.paths;
+        const pluginAuthObj = {
+            type: "None",
+        };
+        if (authInfo) {
+            if (Utils.isOAuthWithAuthCodeFlow(authInfo.authScheme)) {
+                pluginAuthObj.type = "OAuthPluginVault";
+            }
+            else if (Utils.isBearerTokenAuth(authInfo.authScheme)) {
+                pluginAuthObj.type = "ApiKeyPluginVault";
+            }
+            if (pluginAuthObj.type !== "None") {
+                const safeRegistrationIdName = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.RegistrationIdPostfix[authInfo.authScheme.type]}`);
+                pluginAuthObj.reference_id = `\${{${safeRegistrationIdName}}}`;
+            }
+        }
         for (const pathUrl in paths) {
             const pathItem = paths[pathUrl];
             if (pathItem) {
@@ -1389,39 +1429,29 @@ class ManifestUpdater {
                 for (const method in operations) {
                     if (options.allowMethods.includes(method)) {
                         const operationItem = operations[method];
+                        const confirmationBodies = [];
                         if (operationItem) {
                             const operationId = operationItem.operationId;
                             const description = (_a = operationItem.description) !== null && _a !== void 0 ? _a : "";
+                            const summary = operationItem.summary;
                             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 : "";
-                                    }
+                                    ManifestUpdater.checkSchema(schema, method, pathUrl);
+                                    confirmationBodies.push(ManifestUpdater.getConfirmationBodyItem(param.name));
                                 }
                             }
                             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);
+                                        ManifestUpdater.checkSchema(schema, method, pathUrl);
+                                        confirmationBodies.push(ManifestUpdater.getConfirmationBodyItem(property));
                                     }
                                 }
                                 else {
@@ -1431,19 +1461,34 @@ class ManifestUpdater {
                             const funcObj = {
                                 name: operationId,
                                 description: description,
-                                parameters: parameters,
                             };
                             if (options.allowResponseSemantics) {
-                                const [card, jsonPath] = AdaptiveCardGenerator.generateAdaptiveCard(operationItem);
-                                const responseSemantic = wrapResponseSemantics(card, jsonPath);
-                                funcObj.capabilities = {
-                                    response_semantics: responseSemantic,
+                                const { json } = Utils.getResponseJson(operationItem);
+                                if (json.schema) {
+                                    const [card, jsonPath] = AdaptiveCardGenerator.generateAdaptiveCard(operationItem);
+                                    const responseSemantic = wrapResponseSemantics(card, jsonPath);
+                                    funcObj.capabilities = {
+                                        response_semantics: responseSemantic,
+                                    };
+                                }
+                            }
+                            if (options.allowConfirmation && method !== ConstantString.GetMethod) {
+                                if (!funcObj.capabilities) {
+                                    funcObj.capabilities = {};
+                                }
+                                funcObj.capabilities.confirmation = {
+                                    type: "AdaptiveCard",
+                                    title: (_b = operationItem.summary) !== null && _b !== void 0 ? _b : description,
                                 };
+                                if (confirmationBodies.length > 0) {
+                                    funcObj.capabilities.confirmation.body = confirmationBodies.join("\n");
+                                }
                             }
                             functions.push(funcObj);
                             functionNames.push(operationId);
-                            if (description) {
-                                conversationStarters.push(description);
+                            const conversationStarterStr = (summary !== null && summary !== void 0 ? summary : description).slice(0, ConstantString.ConversationStarterMaxLens);
+                            if (conversationStarterStr) {
+                                conversationStarters.push(conversationStarterStr);
                             }
                         }
                     }
@@ -1456,9 +1501,10 @@ class ManifestUpdater {
         }
         else {
             apiPlugin = {
-                schema_version: "v2",
+                schema_version: "v2.1",
                 name_for_human: "",
                 description_for_human: "",
+                namespace: "",
                 functions: [],
                 runtimes: [],
             };
@@ -1474,13 +1520,16 @@ class ManifestUpdater {
             }
         }
         apiPlugin.runtimes = apiPlugin.runtimes || [];
-        const index = apiPlugin.runtimes.findIndex((runtime) => runtime.spec.url === specRelativePath);
+        const index = apiPlugin.runtimes.findIndex((runtime) => {
+            var _a, _b;
+            return runtime.spec.url === specRelativePath &&
+                runtime.type === "OpenApi" &&
+                ((_b = (_a = runtime.auth) === null || _a === void 0 ? void 0 : _a.type) !== null && _b !== void 0 ? _b : "None") === pluginAuthObj.type;
+        });
         if (index === -1) {
             apiPlugin.runtimes.push({
                 type: "OpenApi",
-                auth: {
-                    type: "none",
-                },
+                auth: pluginAuthObj,
                 spec: {
                     url: specRelativePath,
                 },
@@ -1493,6 +1542,9 @@ class ManifestUpdater {
         if (!apiPlugin.name_for_human) {
             apiPlugin.name_for_human = appName;
         }
+        if (!apiPlugin.namespace) {
+            apiPlugin.namespace = ManifestUpdater.removeAllSpecialCharacters(appName);
+        }
         if (!apiPlugin.description_for_human) {
             apiPlugin.description_for_human =
                 (_d = spec.info.description) !== null && _d !== void 0 ? _d : "<Please add description of the plugin>";
@@ -1528,21 +1580,21 @@ class ManifestUpdater {
                 };
                 if (authInfo) {
                     const auth = authInfo.authScheme;
+                    const safeRegistrationIdName = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.RegistrationIdPostfix[authInfo.authScheme.type]}`);
                     if (Utils.isAPIKeyAuth(auth) || Utils.isBearerTokenAuth(auth)) {
-                        const safeApiSecretRegistrationId = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.RegistrationIdPostfix}`);
+                        const safeApiSecretRegistrationId = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.RegistrationIdPostfix[authInfo.authScheme.type]}`);
                         composeExtension.authorization = {
                             authType: "apiSecretServiceAuth",
                             apiSecretServiceAuthConfiguration: {
-                                apiSecretRegistrationId: `\${{${safeApiSecretRegistrationId}}}`,
+                                apiSecretRegistrationId: `\${{${safeRegistrationIdName}}}`,
                             },
                         };
                     }
                     else if (Utils.isOAuthWithAuthCodeFlow(auth)) {
-                        const safeOAuth2RegistrationId = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.OAuthRegistrationIdPostFix}`);
                         composeExtension.authorization = {
                             authType: "oAuth2.0",
                             oAuthConfiguration: {
-                                oauthConfigurationId: `\${{${safeOAuth2RegistrationId}}}`,
+                                oauthConfigurationId: `\${{${safeRegistrationIdName}}}`,
                             },
                         };
                         updatedPart.webApplicationInfo = {
@@ -1619,6 +1671,12 @@ class ManifestUpdater {
         }
         return newStr;
     }
+    static removeAllSpecialCharacters(str) {
+        return str.toLowerCase().replace(/[^a-z0-9]/g, "");
+    }
+    static getConfirmationBodyItem(paramName) {
+        return `* **${Utils.updateFirstLetter(paramName)}**: {{function.parameters.${paramName}}}`;
+    }
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -1642,7 +1700,9 @@ class SpecParser {
             allowMethods: ["get", "post"],
             allowConversationStarters: false,
             allowResponseSemantics: false,
+            allowConfirmation: false,
             projectType: ProjectType.SME,
+            isGptPlugin: false,
         };
         this.pathOrSpec = pathOrDoc;
         this.parser = new SwaggerParser();
@@ -1814,18 +1874,12 @@ class SpecParser {
             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);
+            const authInfo = Utils.getAuthInfo(newSpec);
+            await this.saveFilterSpec(outputSpecPath, newUnResolvedSpec);
             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, this.options);
+            const [updatedManifest, apiPlugin] = await ManifestUpdater.updateManifestWithAiPlugin(manifestPath, outputSpecPath, pluginFilePath, newSpec, this.options, authInfo);
             await fs.outputJSON(manifestPath, updatedManifest, { spaces: 2 });
             await fs.outputJSON(pluginFilePath, apiPlugin, { spaces: 2 });
         }
@@ -1853,35 +1907,11 @@ class SpecParser {
             const newSpecs = await this.getFilteredSpecs(filter, signal);
             const newUnResolvedSpec = newSpecs[0];
             const newSpec = newSpecs[1];
-            let hasMultipleAuth = false;
             let authInfo = undefined;
-            for (const url in newSpec.paths) {
-                for (const method in newSpec.paths[url]) {
-                    const operation = newSpec.paths[url][method];
-                    const authArray = Utils.getAuthArray(operation.security, newSpec);
-                    if (authArray && authArray.length > 0) {
-                        const currentAuth = authArray[0][0];
-                        if (!authInfo) {
-                            authInfo = authArray[0][0];
-                        }
-                        else if (authInfo.name !== currentAuth.name) {
-                            hasMultipleAuth = true;
-                            break;
-                        }
-                    }
-                }
-            }
-            if (hasMultipleAuth && this.options.projectType !== ProjectType.TeamsAi) {
-                throw new SpecParserError(ConstantString.MultipleAuthNotSupported, ErrorType.MultipleAuthNotSupported);
-            }
-            let resultStr;
-            if (outputSpecPath.endsWith(".yaml") || outputSpecPath.endsWith(".yml")) {
-                resultStr = jsyaml.dump(newUnResolvedSpec);
+            if (this.options.projectType === ProjectType.SME) {
+                authInfo = Utils.getAuthInfo(newSpec);
             }
-            else {
-                resultStr = JSON.stringify(newUnResolvedSpec, null, 2);
-            }
-            await fs.outputFile(outputSpecPath, resultStr);
+            await this.saveFilterSpec(outputSpecPath, newUnResolvedSpec);
             if (adaptiveCardFolder) {
                 for (const url in newSpec.paths) {
                     for (const method in newSpec.paths[url]) {
@@ -1949,6 +1979,16 @@ class SpecParser {
         this.validator = validator;
         return validator;
     }
+    async saveFilterSpec(outputSpecPath, unResolvedSpec) {
+        let resultStr;
+        if (outputSpecPath.endsWith(".yaml") || outputSpecPath.endsWith(".yml")) {
+            resultStr = jsyaml.dump(unResolvedSpec);
+        }
+        else {
+            resultStr = JSON.stringify(unResolvedSpec, null, 2);
+        }
+        await fs.outputFile(outputSpecPath, resultStr);
+    }
 }
 
 export { AdaptiveCardGenerator, ConstantString, ErrorType, ProjectType, SpecParser, SpecParserError, Utils, ValidationStatus, WarningType };