@microsoft/m365-spec-parser 0.1.1-alpha.ded43fb2d.0 → 0.1.1-alpha.e1b11d5b2.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];
@@ -1361,14 +1367,17 @@ class ManifestUpdater {
     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, authInfo, options);
         return [manifest, apiPlugin];
@@ -1380,39 +1389,20 @@ 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;
+    static checkSchema(schema, method, pathUrl) {
         if (schema.type === "array") {
             const items = schema.items;
-            parameter = {
-                type: "array",
-                items: ManifestUpdater.mapOpenAPISchemaToFuncParam(items, method, pathUrl),
-            };
+            ManifestUpdater.checkSchema(items, method, pathUrl);
         }
-        else if (schema.type === "string" ||
-            schema.type === "boolean" ||
-            schema.type === "integer" ||
-            schema.type === "number") {
-            parameter = {
-                type: schema.type,
-            };
-        }
-        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);
         }
-        if (schema.enum) {
-            parameter.enum = schema.enum;
-        }
-        if (schema.description) {
-            parameter.description = schema.description;
-        }
-        if (schema.default) {
-            parameter.default = schema.default;
-        }
-        return parameter;
     }
     static async generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d;
         const functions = [];
         const functionNames = [];
         const conversationStarters = [];
@@ -1428,7 +1418,8 @@ class ManifestUpdater {
                 pluginAuthObj.type = "ApiKeyPluginVault";
             }
             if (pluginAuthObj.type !== "None") {
-                pluginAuthObj.reference_id = `${Utils.getSafeRegistrationIdEnvName(authInfo.name)}_REGISTRATION_ID`;
+                const safeRegistrationIdName = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.RegistrationIdPostfix[authInfo.authScheme.type]}`);
+                pluginAuthObj.reference_id = `\${{${safeRegistrationIdName}}}`;
             }
         }
         for (const pathUrl in paths) {
@@ -1442,37 +1433,24 @@ class ManifestUpdater {
                         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);
+                                    ManifestUpdater.checkSchema(schema, method, pathUrl);
                                     confirmationBodies.push(ManifestUpdater.getConfirmationBodyItem(param.name));
-                                    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);
+                                        ManifestUpdater.checkSchema(schema, method, pathUrl);
                                         confirmationBodies.push(ManifestUpdater.getConfirmationBodyItem(property));
                                     }
                                 }
@@ -1484,15 +1462,15 @@ class ManifestUpdater {
                                 name: operationId,
                                 description: description,
                             };
-                            if (paramObject || requestBody) {
-                                funcObj.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) {
@@ -1500,7 +1478,7 @@ class ManifestUpdater {
                                 }
                                 funcObj.capabilities.confirmation = {
                                     type: "AdaptiveCard",
-                                    title: (_c = operationItem.summary) !== null && _c !== void 0 ? _c : description,
+                                    title: (_b = operationItem.summary) !== null && _b !== void 0 ? _b : description,
                                 };
                                 if (confirmationBodies.length > 0) {
                                     funcObj.capabilities.confirmation.body = confirmationBodies.join("\n");
@@ -1508,8 +1486,9 @@ class ManifestUpdater {
                             }
                             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);
                             }
                         }
                     }
@@ -1532,7 +1511,7 @@ class ManifestUpdater {
         }
         apiPlugin.functions = apiPlugin.functions || [];
         for (const func of functions) {
-            const index = (_d = apiPlugin.functions) === null || _d === void 0 ? void 0 : _d.findIndex((f) => f.name === func.name);
+            const index = (_c = apiPlugin.functions) === null || _c === void 0 ? void 0 : _c.findIndex((f) => f.name === func.name);
             if (index === -1) {
                 apiPlugin.functions.push(func);
             }
@@ -1568,7 +1547,7 @@ class ManifestUpdater {
         }
         if (!apiPlugin.description_for_human) {
             apiPlugin.description_for_human =
-                (_e = spec.info.description) !== null && _e !== void 0 ? _e : "<Please add description of the plugin>";
+                (_d = spec.info.description) !== null && _d !== void 0 ? _d : "<Please add description of the plugin>";
         }
         if (options.allowConversationStarters && conversationStarters.length > 0) {
             if (!apiPlugin.capabilities) {
@@ -1601,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 = {
@@ -1723,6 +1702,7 @@ class SpecParser {
             allowResponseSemantics: false,
             allowConfirmation: false,
             projectType: ProjectType.SME,
+            isGptPlugin: false,
         };
         this.pathOrSpec = pathOrDoc;
         this.parser = new SwaggerParser();