@microsoft/teamsfx-core 2.0.10-rc.0 → 2.0.10

package/build/component/generator/copilotPlugin/generator.js

@@ -0,0 +1,275 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CopilotPluginGenerator = void 0;
+const tslib_1 = require("tslib");
+/**
+ * @author yuqzho@microsoft.com
+ */
+const lib_1 = require("@feathersjs/hooks/lib");
+const teamsfx_api_1 = require("@microsoft/teamsfx-api");
+const generator_1 = require("../generator");
+const path_1 = tslib_1.__importDefault(require("path"));
+const actionExecutionMW_1 = require("../../middleware/actionExecutionMW");
+const telemetryEvents_1 = require("../spfx/utils/telemetryEvents");
+const questionNames_1 = require("../../../question/questionNames");
+const helper_1 = require("./helper");
+const localizeUtils_1 = require("../../../common/localizeUtils");
+const ManifestUtils_1 = require("../../driver/teamsApp/utils/ManifestUtils");
+const create_1 = require("../../../question/create");
+const fs = tslib_1.__importStar(require("fs-extra"));
+const error_1 = require("../../../error");
+const m365_spec_parser_1 = require("@microsoft/m365-spec-parser");
+const util = tslib_1.__importStar(require("util"));
+const util_1 = require("../../../question/util");
+const lodash_1 = require("lodash");
+const featureFlags_1 = require("../../../common/featureFlags");
+const fromApiSpecComponentName = "copilot-plugin-existing-api";
+const pluginFromApiSpecComponentName = "api-copilot-plugin-existing-api";
+const fromApiSpecTemplateName = "copilot-plugin-existing-api";
+const fromApiSpecWithApiKeyTemplateName = "copilot-plugin-existing-api-api-key";
+const fromOpenAIPlugincomponentName = "copilot-plugin-from-oai-plugin";
+const fromOpenAIPluginTemplateName = "copilot-plugin-from-oai-plugin";
+const forCustomCopilotRagCustomApi = "custom-copilot-rag-custom-api";
+const copilotPluginExistingApiSpecUrlTelemetryEvent = "copilot-plugin-existing-api-spec-url";
+const apiPluginFromApiSpecTemplateName = "api-plugin-existing-api";
+const failedToUpdateCustomApiTemplateErrorName = "failed-to-update-custom-api-template";
+function normalizePath(path) {
+    return "./" + path.replace(/\\/g, "/");
+}
+class CopilotPluginGenerator {
+    static async generateMeFromApiSpec(context, inputs, destinationPath, actionContext) {
+        const templateName = fromApiSpecTemplateName;
+        const componentName = fromApiSpecComponentName;
+        lodash_1.merge(actionContext === null || actionContext === void 0 ? void 0 : actionContext.telemetryProps, { ["template-name" /* templateName */]: templateName });
+        return await this.generate(context, inputs, destinationPath, templateName, componentName, false, inputs.apiAuthData);
+    }
+    static async generatePluginFromApiSpec(context, inputs, destinationPath, actionContext) {
+        const templateName = apiPluginFromApiSpecTemplateName;
+        const componentName = fromApiSpecComponentName;
+        lodash_1.merge(actionContext === null || actionContext === void 0 ? void 0 : actionContext.telemetryProps, { ["template-name" /* templateName */]: templateName });
+        return await this.generate(context, inputs, destinationPath, templateName, componentName, true, inputs.apiAuthData);
+    }
+    static async generateFromOpenAIPlugin(context, inputs, destinationPath) {
+        return await this.generate(context, inputs, destinationPath, fromOpenAIPluginTemplateName, fromOpenAIPlugincomponentName, false);
+    }
+    static async generateForCustomCopilotRagCustomApi(context, inputs, destinationPath) {
+        return await this.generate(context, inputs, destinationPath, forCustomCopilotRagCustomApi, forCustomCopilotRagCustomApi, false);
+    }
+    static async generate(context, inputs, destinationPath, templateName, componentName, isPlugin, authData) {
+        var _a, _b, _c;
+        try {
+            const appName = inputs[questionNames_1.QuestionNames.AppName];
+            const language = inputs[questionNames_1.QuestionNames.ProgrammingLanguage];
+            const safeProjectNameFromVS = language === "csharp" ? inputs[questionNames_1.QuestionNames.SafeProjectName] : undefined;
+            const type = templateName === forCustomCopilotRagCustomApi
+                ? m365_spec_parser_1.ProjectType.TeamsAi
+                : isPlugin
+                    ? m365_spec_parser_1.ProjectType.Copilot
+                    : m365_spec_parser_1.ProjectType.SME;
+            const manifestPath = path_1.default.join(destinationPath, teamsfx_api_1.AppPackageFolderName, teamsfx_api_1.ManifestTemplateFileName);
+            const apiSpecFolderPath = path_1.default.join(destinationPath, teamsfx_api_1.AppPackageFolderName, helper_1.defaultApiSpecFolderName);
+            let url = (_a = inputs[questionNames_1.QuestionNames.ApiSpecLocation]) !== null && _a !== void 0 ? _a : (_b = inputs.openAIPluginManifest) === null || _b === void 0 ? void 0 : _b.api.url;
+            url = url.trim();
+            let isYaml;
+            try {
+                isYaml = await helper_1.isYamlSpecFile(url);
+            }
+            catch (e) {
+                isYaml = false;
+            }
+            const openapiSpecFileName = isYaml ? helper_1.defaultApiSpecYamlFileName : helper_1.defaultApiSpecJsonFileName;
+            const openapiSpecPath = path_1.default.join(apiSpecFolderPath, openapiSpecFileName);
+            if (authData === null || authData === void 0 ? void 0 : authData.authName) {
+                const envName = helper_1.getEnvName(authData.authName, authData.authType);
+                context.templateVariables = generator_1.Generator.getDefaultVariables(appName, safeProjectNameFromVS, inputs.targetFramework, inputs.placeProjectFileInSolutionDir === "true", {
+                    authName: authData.authName,
+                    openapiSpecPath: normalizePath(path_1.default.join(teamsfx_api_1.AppPackageFolderName, helper_1.defaultApiSpecFolderName, openapiSpecFileName)),
+                    registrationIdEnvName: envName,
+                    authType: authData.authType,
+                });
+            }
+            else {
+                context.templateVariables = generator_1.Generator.getDefaultVariables(appName, safeProjectNameFromVS, inputs.targetFramework, inputs.placeProjectFileInSolutionDir === "true");
+            }
+            const filters = inputs[questionNames_1.QuestionNames.ApiOperation];
+            if (templateName != forCustomCopilotRagCustomApi) {
+                // download template
+                const templateRes = await generator_1.Generator.generateTemplate(context, destinationPath, templateName, language === create_1.ProgrammingLanguage.CSharp ? create_1.ProgrammingLanguage.CSharp : undefined);
+                if (templateRes.isErr())
+                    return teamsfx_api_1.err(templateRes.error);
+            }
+            context.telemetryReporter.sendTelemetryEvent(copilotPluginExistingApiSpecUrlTelemetryEvent, {
+                ["remote-url" /* isRemoteUrlTelemetryProperty */]: util_1.isValidHttpUrl(url).toString(),
+                ["generate-type" /* generateType */]: type.toString(),
+                ["auth-type" /* authType */]: (_c = authData === null || authData === void 0 ? void 0 : authData.authName) !== null && _c !== void 0 ? _c : "None",
+            });
+            // validate API spec
+            const specParser = new m365_spec_parser_1.SpecParser(url, isPlugin
+                ? helper_1.copilotPluginParserOptions
+                : {
+                    allowBearerTokenAuth: true,
+                    allowMultipleParameters: true,
+                    projectType: type,
+                    allowOauth2: featureFlags_1.isCopilotAuthEnabled(),
+                });
+            const validationRes = await specParser.validate();
+            const warnings = validationRes.warnings;
+            const operationIdWarning = warnings.find((w) => w.type === m365_spec_parser_1.WarningType.OperationIdMissing);
+            if (operationIdWarning && operationIdWarning.data) {
+                const apisMissingOperationId = operationIdWarning.data.filter((api) => filters.includes(api));
+                if (apisMissingOperationId.length > 0) {
+                    operationIdWarning.content = util.format(localizeUtils_1.getLocalizedString("core.common.MissingOperationId"), apisMissingOperationId.join(", "));
+                    delete operationIdWarning.data;
+                }
+                else {
+                    warnings.splice(warnings.indexOf(operationIdWarning), 1);
+                }
+            }
+            const specVersionWarning = warnings.find((w) => w.type === m365_spec_parser_1.WarningType.ConvertSwaggerToOpenAPI);
+            if (specVersionWarning) {
+                specVersionWarning.content = ""; // We don't care content of this warning
+            }
+            if (validationRes.status === m365_spec_parser_1.ValidationStatus.Error) {
+                helper_1.logValidationResults(validationRes.errors, warnings, context, true, false, true);
+                const errorMessage = inputs.platform === teamsfx_api_1.Platform.VSCode
+                    ? localizeUtils_1.getLocalizedString("core.createProjectQuestion.apiSpec.multipleValidationErrors.vscode.message")
+                    : localizeUtils_1.getLocalizedString("core.createProjectQuestion.apiSpec.multipleValidationErrors.message");
+                return teamsfx_api_1.err(new teamsfx_api_1.UserError(componentName, helper_1.invalidApiSpecErrorName, errorMessage, errorMessage));
+            }
+            // generate files
+            await fs.ensureDir(apiSpecFolderPath);
+            let generateResult;
+            if (isPlugin) {
+                const pluginManifestPath = path_1.default.join(destinationPath, teamsfx_api_1.AppPackageFolderName, helper_1.defaultPluginManifestFileName);
+                generateResult = await specParser.generateForCopilot(manifestPath, filters, openapiSpecPath, pluginManifestPath);
+            }
+            else {
+                const responseTemplateFolder = path_1.default.join(destinationPath, teamsfx_api_1.AppPackageFolderName, teamsfx_api_1.ResponseTemplatesFolderName);
+                generateResult = await specParser.generate(manifestPath, filters, openapiSpecPath, type === m365_spec_parser_1.ProjectType.TeamsAi ? undefined : responseTemplateFolder);
+            }
+            context.telemetryReporter.sendTelemetryEvent(helper_1.specParserGenerateResultTelemetryEvent, {
+                ["generate-type" /* generateType */]: type.toString(),
+                [helper_1.specParserGenerateResultAllSuccessTelemetryProperty]: generateResult.allSuccess.toString(),
+                [helper_1.specParserGenerateResultWarningsTelemetryProperty]: generateResult.warnings
+                    .map((w) => w.type.toString() + ": " + w.content)
+                    .join(";"),
+            });
+            if (generateResult.warnings.length > 0) {
+                generateResult.warnings.find((o) => {
+                    if (o.type === m365_spec_parser_1.WarningType.OperationOnlyContainsOptionalParam) {
+                        o.content = ""; // We don't care content of this warning
+                    }
+                });
+                warnings.push(...generateResult.warnings);
+            }
+            // update manifest based on openAI plugin manifest
+            const manifestRes = await ManifestUtils_1.manifestUtils._readAppManifest(manifestPath);
+            if (manifestRes.isErr()) {
+                return teamsfx_api_1.err(manifestRes.error);
+            }
+            const teamsManifest = manifestRes.value;
+            if (inputs.openAIPluginManifest) {
+                const updateManifestRes = await helper_1.OpenAIPluginManifestHelper.updateManifest(inputs.openAIPluginManifest, teamsManifest, manifestPath);
+                if (updateManifestRes.isErr())
+                    return teamsfx_api_1.err(updateManifestRes.error);
+            }
+            if (componentName === forCustomCopilotRagCustomApi) {
+                const specs = await specParser.getFilteredSpecs(filters);
+                const spec = specs[1];
+                try {
+                    await helper_1.updateForCustomApi(spec, language, destinationPath, openapiSpecFileName);
+                }
+                catch (error) {
+                    throw new teamsfx_api_1.SystemError(componentName, failedToUpdateCustomApiTemplateErrorName, error.message, error.message);
+                }
+            }
+            // log warnings
+            if (inputs.platform === teamsfx_api_1.Platform.CLI || inputs.platform === teamsfx_api_1.Platform.VS) {
+                const warnSummary = helper_1.generateScaffoldingSummary(warnings, teamsManifest, path_1.default.relative(destinationPath, openapiSpecPath));
+                if (warnSummary) {
+                    void context.logProvider.info(warnSummary);
+                }
+            }
+            if (inputs.platform === teamsfx_api_1.Platform.VSCode) {
+                return teamsfx_api_1.ok({
+                    warnings: warnings.map((warning) => {
+                        return {
+                            type: warning.type,
+                            content: warning.content,
+                            data: warning.data,
+                        };
+                    }),
+                });
+            }
+            else {
+                return teamsfx_api_1.ok({ warnings: undefined });
+            }
+        }
+        catch (e) {
+            let error;
+            if (e instanceof m365_spec_parser_1.SpecParserError) {
+                error = helper_1.convertSpecParserErrorToFxError(e);
+            }
+            else {
+                error = error_1.assembleError(e);
+            }
+            return teamsfx_api_1.err(error);
+        }
+    }
+}
+tslib_1.__decorate([
+    lib_1.hooks([
+        actionExecutionMW_1.ActionExecutionMW({
+            enableTelemetry: true,
+            telemetryComponentName: fromApiSpecComponentName,
+            telemetryEventName: telemetryEvents_1.TelemetryEvents.Generate,
+            errorSource: fromApiSpecComponentName,
+        }),
+    ]),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object, Object, String, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], CopilotPluginGenerator, "generateMeFromApiSpec", null);
+tslib_1.__decorate([
+    lib_1.hooks([
+        actionExecutionMW_1.ActionExecutionMW({
+            enableTelemetry: true,
+            telemetryComponentName: pluginFromApiSpecComponentName,
+            telemetryEventName: telemetryEvents_1.TelemetryEvents.Generate,
+            errorSource: pluginFromApiSpecComponentName,
+        }),
+    ]),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object, Object, String, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], CopilotPluginGenerator, "generatePluginFromApiSpec", null);
+tslib_1.__decorate([
+    lib_1.hooks([
+        actionExecutionMW_1.ActionExecutionMW({
+            enableTelemetry: true,
+            telemetryComponentName: fromOpenAIPlugincomponentName,
+            telemetryEventName: telemetryEvents_1.TelemetryEvents.Generate,
+            errorSource: fromOpenAIPlugincomponentName,
+        }),
+    ]),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object, Object, String]),
+    tslib_1.__metadata("design:returntype", Promise)
+], CopilotPluginGenerator, "generateFromOpenAIPlugin", null);
+tslib_1.__decorate([
+    lib_1.hooks([
+        actionExecutionMW_1.ActionExecutionMW({
+            enableTelemetry: true,
+            telemetryComponentName: fromOpenAIPlugincomponentName,
+            telemetryEventName: telemetryEvents_1.TelemetryEvents.Generate,
+            errorSource: fromOpenAIPlugincomponentName,
+        }),
+    ]),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object, Object, String]),
+    tslib_1.__metadata("design:returntype", Promise)
+], CopilotPluginGenerator, "generateForCustomCopilotRagCustomApi", null);
+exports.CopilotPluginGenerator = CopilotPluginGenerator;
+//# sourceMappingURL=generator.js.map

package/build/component/generator/copilotPlugin/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../src/component/generator/copilotPlugin/generator.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAElC;;GAEG;AAEH,+CAA8C;AAC9C,wDAegC;AAChC,4CAAyC;AACzC,wDAAwB;AACxB,0EAAsF;AACtF,mEAAgE;AAChE,mEAAgE;AAChE,qCAiBkB;AAClB,iEAAmE;AACnE,6EAA0E;AAC1E,qDAA+D;AAC/D,qDAA+B;AAC/B,0CAA+C;AAC/C,kEAMqC;AACrC,mDAA6B;AAC7B,iDAAwD;AACxD,mCAA+B;AAC/B,+DAAoE;AAEpE,MAAM,wBAAwB,GAAG,6BAA6B,CAAC;AAC/D,MAAM,8BAA8B,GAAG,iCAAiC,CAAC;AACzE,MAAM,uBAAuB,GAAG,6BAA6B,CAAC;AAC9D,MAAM,iCAAiC,GAAG,qCAAqC,CAAC;AAChF,MAAM,6BAA6B,GAAG,gCAAgC,CAAC;AACvE,MAAM,4BAA4B,GAAG,gCAAgC,CAAC;AACtE,MAAM,4BAA4B,GAAG,+BAA+B,CAAC;AACrE,MAAM,6CAA6C,GAAG,sCAAsC,CAAC;AAE7F,MAAM,gCAAgC,GAAG,yBAAyB,CAAC;AAEnE,MAAM,wCAAwC,GAAG,sCAAsC,CAAC;AASxF,SAAS,aAAa,CAAC,IAAY;IACjC,OAAO,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACzC,CAAC;AAMD,MAAa,sBAAsB;IAS1B,MAAM,CAAC,KAAK,CAAC,qBAAqB,CACvC,OAAgB,EAChB,MAAc,EACd,eAAuB,EACvB,aAA6B;QAE7B,MAAM,YAAY,GAAG,uBAAuB,CAAC;QAC7C,MAAM,aAAa,GAAG,wBAAwB,CAAC;QAE/C,cAAK,CAAC,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,cAAc,EAAE,EAAE,oCAAkC,EAAE,YAAY,EAAE,CAAC,CAAC;QAE3F,OAAO,MAAM,IAAI,CAAC,QAAQ,CACxB,OAAO,EACP,MAAM,EACN,eAAe,EACf,YAAY,EACZ,aAAa,EACb,KAAK,EACL,MAAM,CAAC,WAAW,CACnB,CAAC;IACJ,CAAC;IAUM,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAC3C,OAAgB,EAChB,MAAc,EACd,eAAuB,EACvB,aAA6B;QAE7B,MAAM,YAAY,GAAG,gCAAgC,CAAC;QACtD,MAAM,aAAa,GAAG,wBAAwB,CAAC;QAE/C,cAAK,CAAC,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,cAAc,EAAE,EAAE,oCAAkC,EAAE,YAAY,EAAE,CAAC,CAAC;QAE3F,OAAO,MAAM,IAAI,CAAC,QAAQ,CACxB,OAAO,EACP,MAAM,EACN,eAAe,EACf,YAAY,EACZ,aAAa,EACb,IAAI,EACJ,MAAM,CAAC,WAAW,CACnB,CAAC;IACJ,CAAC;IAUM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAC1C,OAAgB,EAChB,MAAc,EACd,eAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,QAAQ,CACxB,OAAO,EACP,MAAM,EACN,eAAe,EACf,4BAA4B,EAC5B,6BAA6B,EAC7B,KAAK,CACN,CAAC;IACJ,CAAC;IAUM,MAAM,CAAC,KAAK,CAAC,oCAAoC,CACtD,OAAgB,EAChB,MAAc,EACd,eAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,QAAQ,CACxB,OAAO,EACP,MAAM,EACN,eAAe,EACf,4BAA4B,EAC5B,4BAA4B,EAC5B,KAAK,CACN,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,QAAQ,CAC3B,OAAgB,EAChB,MAAc,EACd,eAAuB,EACvB,YAAoB,EACpB,aAAqB,EACrB,QAAiB,EACjB,QAAmB;;QAEnB,IAAI;YACF,MAAM,OAAO,GAAG,MAAM,CAAC,6BAAa,CAAC,OAAO,CAAC,CAAC;YAC9C,MAAM,QAAQ,GAAG,MAAM,CAAC,6BAAa,CAAC,mBAAmB,CAAC,CAAC;YAC3D,MAAM,qBAAqB,GACzB,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,6BAAa,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,MAAM,IAAI,GACR,YAAY,KAAK,4BAA4B;gBAC3C,CAAC,CAAC,8BAAW,CAAC,OAAO;gBACrB,CAAC,CAAC,QAAQ;oBACV,CAAC,CAAC,8BAAW,CAAC,OAAO;oBACrB,CAAC,CAAC,8BAAW,CAAC,GAAG,CAAC;YAEtB,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAC5B,eAAe,EACf,kCAAoB,EACpB,sCAAwB,CACzB,CAAC;YAEF,MAAM,iBAAiB,GAAG,cAAI,CAAC,IAAI,CACjC,eAAe,EACf,kCAAoB,EACpB,iCAAwB,CACzB,CAAC;YAEF,IAAI,GAAG,GAAG,MAAA,MAAM,CAAC,6BAAa,CAAC,eAAe,CAAC,mCAAI,MAAA,MAAM,CAAC,oBAAoB,0CAAE,GAAG,CAAC,GAAG,CAAC;YACxF,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;YAEjB,IAAI,MAAe,CAAC;YACpB,IAAI;gBACF,MAAM,GAAG,MAAM,uBAAc,CAAC,GAAG,CAAC,CAAC;aACpC;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,GAAG,KAAK,CAAC;aAChB;YAED,MAAM,mBAAmB,GAAG,MAAM,CAAC,CAAC,CAAC,mCAA0B,CAAC,CAAC,CAAC,mCAA0B,CAAC;YAC7F,MAAM,eAAe,GAAG,cAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAAC;YAE1E,IAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,EAAE;gBACtB,MAAM,OAAO,GAAG,mBAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACjE,OAAO,CAAC,iBAAiB,GAAG,qBAAS,CAAC,mBAAmB,CACvD,OAAO,EACP,qBAAqB,EACrB,MAAM,CAAC,eAAe,EACtB,MAAM,CAAC,6BAA6B,KAAK,MAAM,EAC/C;oBACE,QAAQ,EAAE,QAAQ,CAAC,QAAQ;oBAC3B,eAAe,EAAE,aAAa,CAC5B,cAAI,CAAC,IAAI,CAAC,kCAAoB,EAAE,iCAAwB,EAAE,mBAAmB,CAAC,CAC/E;oBACD,qBAAqB,EAAE,OAAO;oBAC9B,QAAQ,EAAE,QAAQ,CAAC,QAAQ;iBAC5B,CACF,CAAC;aACH;iBAAM;gBACL,OAAO,CAAC,iBAAiB,GAAG,qBAAS,CAAC,mBAAmB,CACvD,OAAO,EACP,qBAAqB,EACrB,MAAM,CAAC,eAAe,EACtB,MAAM,CAAC,6BAA6B,KAAK,MAAM,CAChD,CAAC;aACH;YACD,MAAM,OAAO,GAAG,MAAM,CAAC,6BAAa,CAAC,YAAY,CAAa,CAAC;YAE/D,IAAI,YAAY,IAAI,4BAA4B,EAAE;gBAChD,oBAAoB;gBACpB,MAAM,WAAW,GAAG,MAAM,qBAAS,CAAC,gBAAgB,CAClD,OAAO,EACP,eAAe,EACf,YAAY,EACZ,QAAQ,KAAK,4BAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,4BAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CACjF,CAAC;gBACF,IAAI,WAAW,CAAC,KAAK,EAAE;oBAAE,OAAO,iBAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;aACxD;YAED,OAAO,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,6CAA6C,EAAE;gBAC1F,iDAAkD,EAAE,qBAAc,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;gBAClF,oCAAkC,EAAE,IAAI,CAAC,QAAQ,EAAE;gBACnD,4BAA8B,EAAE,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,mCAAI,MAAM;aAC7D,CAAC,CAAC;YAEH,oBAAoB;YACpB,MAAM,UAAU,GAAG,IAAI,6BAAU,CAC/B,GAAG,EACH,QAAQ;gBACN,CAAC,CAAC,mCAA0B;gBAC5B,CAAC,CAAC;oBACE,oBAAoB,EAAE,IAAI;oBAC1B,uBAAuB,EAAE,IAAI;oBAC7B,WAAW,EAAE,IAAI;oBACjB,WAAW,EAAE,mCAAoB,EAAE;iBACpC,CACN,CAAC;YACF,MAAM,aAAa,GAAG,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC;YAClD,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;YACxC,MAAM,kBAAkB,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,8BAAW,CAAC,kBAAkB,CAAC,CAAC;YAC3F,IAAI,kBAAkB,IAAI,kBAAkB,CAAC,IAAI,EAAE;gBACjD,MAAM,sBAAsB,GAAI,kBAAkB,CAAC,IAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAClF,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CACtB,CAAC;gBACF,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;oBACrC,kBAAkB,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CACtC,kCAAkB,CAAC,gCAAgC,CAAC,EACpD,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;oBACF,OAAO,kBAAkB,CAAC,IAAI,CAAC;iBAChC;qBAAM;oBACL,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC;iBAC1D;aACF;YAED,MAAM,kBAAkB,GAAG,QAAQ,CAAC,IAAI,CACtC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,8BAAW,CAAC,uBAAuB,CACtD,CAAC;YACF,IAAI,kBAAkB,EAAE;gBACtB,kBAAkB,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC,wCAAwC;aAC1E;YAED,IAAI,aAAa,CAAC,MAAM,KAAK,mCAAgB,CAAC,KAAK,EAAE;gBACnD,6BAAoB,CAAC,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;gBACjF,MAAM,YAAY,GAChB,MAAM,CAAC,QAAQ,KAAK,sBAAQ,CAAC,MAAM;oBACjC,CAAC,CAAC,kCAAkB,CAChB,4EAA4E,CAC7E;oBACH,CAAC,CAAC,kCAAkB,CAChB,qEAAqE,CACtE,CAAC;gBACR,OAAO,iBAAG,CACR,IAAI,uBAAS,CAAC,aAAa,EAAE,gCAAuB,EAAE,YAAY,EAAE,YAAY,CAAC,CAClF,CAAC;aACH;YAED,iBAAiB;YACjB,MAAM,EAAE,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;YAEtC,IAAI,cAAc,CAAC;YAEnB,IAAI,QAAQ,EAAE;gBACZ,MAAM,kBAAkB,GAAG,cAAI,CAAC,IAAI,CAClC,eAAe,EACf,kCAAoB,EACpB,sCAA6B,CAC9B,CAAC;gBACF,cAAc,GAAG,MAAM,UAAU,CAAC,kBAAkB,CAClD,YAAY,EACZ,OAAO,EACP,eAAe,EACf,kBAAkB,CACnB,CAAC;aACH;iBAAM;gBACL,MAAM,sBAAsB,GAAG,cAAI,CAAC,IAAI,CACtC,eAAe,EACf,kCAAoB,EACpB,yCAA2B,CAC5B,CAAC;gBACF,cAAc,GAAG,MAAM,UAAU,CAAC,QAAQ,CACxC,YAAY,EACZ,OAAO,EACP,eAAe,EACf,IAAI,KAAK,8BAAW,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAClE,CAAC;aACH;YAED,OAAO,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,+CAAsC,EAAE;gBACnF,oCAAkC,EAAE,IAAI,CAAC,QAAQ,EAAE;gBACnD,CAAC,4DAAmD,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC,QAAQ,EAAE;gBAC3F,CAAC,0DAAiD,CAAC,EAAE,cAAc,CAAC,QAAQ;qBACzE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC;qBAChD,IAAI,CAAC,GAAG,CAAC;aACb,CAAC,CAAC;YAEH,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;oBACjC,IAAI,CAAC,CAAC,IAAI,KAAK,8BAAW,CAAC,kCAAkC,EAAE;wBAC7D,CAAC,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC,wCAAwC;qBACzD;gBACH,CAAC,CAAC,CAAC;gBACH,QAAQ,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;aAC3C;YAED,kDAAkD;YAClD,MAAM,WAAW,GAAG,MAAM,6BAAa,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;YAEvE,IAAI,WAAW,CAAC,KAAK,EAAE,EAAE;gBACvB,OAAO,iBAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;aAC/B;YAED,MAAM,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC;YACxC,IAAI,MAAM,CAAC,oBAAoB,EAAE;gBAC/B,MAAM,iBAAiB,GAAG,MAAM,mCAA0B,CAAC,cAAc,CACvE,MAAM,CAAC,oBAAoB,EAC3B,aAAa,EACb,YAAY,CACb,CAAC;gBACF,IAAI,iBAAiB,CAAC,KAAK,EAAE;oBAAE,OAAO,iBAAG,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;aACpE;YAED,IAAI,aAAa,KAAK,4BAA4B,EAAE;gBAClD,MAAM,KAAK,GAAG,MAAM,UAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;gBACzD,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBACtB,IAAI;oBACF,MAAM,2BAAkB,CAAC,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;iBAChF;gBAAC,OAAO,KAAU,EAAE;oBACnB,MAAM,IAAI,yBAAW,CACnB,aAAa,EACb,wCAAwC,EACxC,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,OAAO,CACd,CAAC;iBACH;aACF;YAED,eAAe;YACf,IAAI,MAAM,CAAC,QAAQ,KAAK,sBAAQ,CAAC,GAAG,IAAI,MAAM,CAAC,QAAQ,KAAK,sBAAQ,CAAC,EAAE,EAAE;gBACvE,MAAM,WAAW,GAAG,mCAA0B,CAC5C,QAAQ,EACR,aAAa,EACb,cAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC,CAChD,CAAC;gBAEF,IAAI,WAAW,EAAE;oBACf,KAAK,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;iBAC5C;aACF;YAED,IAAI,MAAM,CAAC,QAAQ,KAAK,sBAAQ,CAAC,MAAM,EAAE;gBACvC,OAAO,gBAAE,CAAC;oBACR,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;wBACjC,OAAO;4BACL,IAAI,EAAE,OAAO,CAAC,IAAI;4BAClB,OAAO,EAAE,OAAO,CAAC,OAAO;4BACxB,IAAI,EAAE,OAAO,CAAC,IAAI;yBACnB,CAAC;oBACJ,CAAC,CAAC;iBACH,CAAC,CAAC;aACJ;iBAAM;gBACL,OAAO,gBAAE,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;aACpC;SACF;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,KAAc,CAAC;YACnB,IAAI,CAAC,YAAY,kCAAe,EAAE;gBAChC,KAAK,GAAG,wCAA+B,CAAC,CAAC,CAAC,CAAC;aAC5C;iBAAM;gBACL,KAAK,GAAG,qBAAa,CAAC,CAAC,CAAC,CAAC;aAC1B;YACD,OAAO,iBAAG,CAAC,KAAK,CAAC,CAAC;SACnB;IACH,CAAC;CACF;AAnWC;IARC,WAAK,CAAC;QACL,qCAAiB,CAAC;YAChB,eAAe,EAAE,IAAI;YACrB,sBAAsB,EAAE,wBAAwB;YAChD,kBAAkB,EAAE,iCAAe,CAAC,QAAQ;YAC5C,WAAW,EAAE,wBAAwB;SACtC,CAAC;KACH,CAAC;;;;yDAqBD;AAUD;IARC,WAAK,CAAC;QACL,qCAAiB,CAAC;YAChB,eAAe,EAAE,IAAI;YACrB,sBAAsB,EAAE,8BAA8B;YACtD,kBAAkB,EAAE,iCAAe,CAAC,QAAQ;YAC5C,WAAW,EAAE,8BAA8B;SAC5C,CAAC;KACH,CAAC;;;;6DAqBD;AAUD;IARC,WAAK,CAAC;QACL,qCAAiB,CAAC;YAChB,eAAe,EAAE,IAAI;YACrB,sBAAsB,EAAE,6BAA6B;YACrD,kBAAkB,EAAE,iCAAe,CAAC,QAAQ;YAC5C,WAAW,EAAE,6BAA6B;SAC3C,CAAC;KACH,CAAC;;;;4DAcD;AAUD;IARC,WAAK,CAAC;QACL,qCAAiB,CAAC;YAChB,eAAe,EAAE,IAAI;YACrB,sBAAsB,EAAE,6BAA6B;YACrD,kBAAkB,EAAE,iCAAe,CAAC,QAAQ;YAC5C,WAAW,EAAE,6BAA6B;SAC3C,CAAC;KACH,CAAC;;;;wEAcD;AAzGH,wDA4WC"}

package/build/component/generator/copilotPlugin/helper.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @author yuqzho@microsoft.com
+ */
+import { Context, FxError, OpenAIPluginManifest, Result, TeamsAppManifest, ApiOperation, Warning, Inputs } from "@microsoft/teamsfx-api";
+import { ErrorType as ApiSpecErrorType, WarningResult, SpecParserError, ErrorResult as ApiSpecErrorResult, ParseOptions } from "@microsoft/m365-spec-parser";
+import { OpenAPIV3 } from "openapi-types";
+declare enum OpenAIPluginManifestErrorType {
+    AuthNotSupported = "openai-pliugin-auth-not-supported",
+    ApiUrlMissing = "openai-plugin-api-url-missing"
+}
+export declare const copilotPluginParserOptions: ParseOptions;
+export declare const specParserGenerateResultTelemetryEvent = "spec-parser-generate-result";
+export declare const specParserGenerateResultAllSuccessTelemetryProperty = "all-success";
+export declare const specParserGenerateResultWarningsTelemetryProperty = "warnings";
+export declare const invalidApiSpecErrorName = "invalid-api-spec";
+export declare const defaultApiSpecFolderName = "apiSpecificationFile";
+export declare const defaultApiSpecYamlFileName = "openapi.yaml";
+export declare const defaultApiSpecJsonFileName = "openapi.json";
+export declare const defaultPluginManifestFileName = "ai-plugin.json";
+export interface ErrorResult {
+    /**
+     * The type of error.
+     */
+    type: ApiSpecErrorType | OpenAIPluginManifestErrorType;
+    /**
+     * The content of the error.
+     */
+    content: string;
+    data?: any;
+}
+export declare class OpenAIPluginManifestHelper {
+    static loadOpenAIPluginManifest(input: string): Promise<OpenAIPluginManifest>;
+    static updateManifest(openAiPluginManifest: OpenAIPluginManifest, teamsAppManifest: TeamsAppManifest, manifestPath: string): Promise<Result<undefined, FxError>>;
+}
+export declare function listOperations(context: Context, manifest: OpenAIPluginManifest | undefined, apiSpecUrl: string | undefined, inputs: Inputs, includeExistingAPIs?: boolean, shouldLogWarning?: boolean, existingCorrelationId?: string): Promise<Result<ApiOperation[], ErrorResult[]>>;
+export declare function listPluginExistingOperations(manifest: TeamsAppManifest, teamsManifestPath: string, destinationApiSpecFilePath: string): Promise<string[]>;
+export declare function logValidationResults(errors: ErrorResult[], warnings: WarningResult[], context: Context, isApiSpec: boolean, shouldLogWarning: boolean, shouldSkipTelemetry: boolean, existingCorrelationId?: string): void;
+export declare function generateScaffoldingSummary(warnings: Warning[], teamsManifest: TeamsAppManifest, apiSpecFilePath: string): string;
+export declare function convertSpecParserErrorToFxError(error: SpecParserError): FxError;
+export declare function isYamlSpecFile(specPath: string): Promise<boolean>;
+export declare function formatValidationErrors(errors: ApiSpecErrorResult[], inputs: Inputs): ApiSpecErrorResult[];
+export declare function updateForCustomApi(spec: OpenAPIV3.Document, language: string, destinationPath: string, openapiSpecFileName: string): Promise<void>;
+export declare function getEnvName(authName: string, authType?: string): string;
+export {};
+//# sourceMappingURL=helper.d.ts.map

package/build/component/generator/copilotPlugin/helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../../../src/component/generator/copilotPlugin/helper.ts"],"names":[],"mappings":"AAGA;;GAEG;AAEH,OAAO,EACL,OAAO,EACP,OAAO,EAEP,oBAAoB,EACpB,MAAM,EAIN,gBAAgB,EAChB,YAAY,EAEZ,OAAO,EAKP,MAAM,EACP,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EAEL,SAAS,IAAI,gBAAgB,EAE7B,aAAa,EAEb,eAAe,EAEf,WAAW,IAAI,kBAAkB,EAGjC,YAAY,EAIb,MAAM,6BAA6B,CAAC;AAWrC,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAuB1C,aAAK,6BAA6B;IAChC,gBAAgB,sCAAsC;IACtD,aAAa,kCAAkC;CAChD;AAED,eAAO,MAAM,0BAA0B,EAAE,YAYxC,CAAC;AAEF,eAAO,MAAM,sCAAsC,gCAAgC,CAAC;AACpF,eAAO,MAAM,mDAAmD,gBAAgB,CAAC;AACjF,eAAO,MAAM,iDAAiD,aAAa,CAAC;AAE5E,eAAO,MAAM,uBAAuB,qBAAqB,CAAC;AAG1D,eAAO,MAAM,wBAAwB,yBAAyB,CAAC;AAC/D,eAAO,MAAM,0BAA0B,iBAAiB,CAAC;AACzD,eAAO,MAAM,0BAA0B,iBAAiB,CAAC;AACzD,eAAO,MAAM,6BAA6B,mBAAmB,CAAC;AAE9D,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,gBAAgB,GAAG,6BAA6B,CAAC;IAEvD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AAED,qBAAa,0BAA0B;WACxB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;WA0BtE,cAAc,CACzB,oBAAoB,EAAE,oBAAoB,EAC1C,gBAAgB,EAAE,gBAAgB,EAClC,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;CAUvC;AAED,wBAAsB,cAAc,CAClC,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,oBAAoB,GAAG,SAAS,EAC1C,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,MAAM,EAAE,MAAM,EACd,mBAAmB,UAAO,EAC1B,gBAAgB,UAAO,EACvB,qBAAqB,CAAC,EAAE,MAAM,GAC7B,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAkHhD;AA8CD,wBAAsB,4BAA4B,CAChD,QAAQ,EAAE,gBAAgB,EAC1B,iBAAiB,EAAE,MAAM,EACzB,0BAA0B,EAAE,MAAM,GACjC,OAAO,CAAC,MAAM,EAAE,CAAC,CA6BnB;AAED,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,WAAW,EAAE,EACrB,QAAQ,EAAE,aAAa,EAAE,EACzB,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,OAAO,EAClB,gBAAgB,EAAE,OAAO,EACzB,mBAAmB,EAAE,OAAO,EAC5B,qBAAqB,CAAC,EAAE,MAAM,GAC7B,IAAI,CAuEN;AA0BD,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,OAAO,EAAE,EACnB,aAAa,EAAE,gBAAgB,EAC/B,eAAe,EAAE,MAAM,GACtB,MAAM,CAyBR;AAmKD,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAE/E;AAED,wBAAsB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAiBvE;AAED,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,kBAAkB,EAAE,EAC5B,MAAM,EAAE,MAAM,GACb,kBAAkB,EAAE,CAQtB;AA4TD,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,SAAS,CAAC,QAAQ,EACxB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,mBAAmB,EAAE,MAAM,GAC1B,OAAO,CAAC,IAAI,CAAC,CAiBf;AAOD,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAEtE"}