@microsoft/teamsfx-core 3.0.0-alpha.09e5fe9da.0 → 3.0.0-alpha.0fa12bc9d.0

package/build/core/FxCore.js

@@ -16,6 +16,7 @@ const typedi_1 = require("typedi");
 const url_1 = require("url");
 const teamsDevPortalClient_1 = require("../client/teamsDevPortalClient");
 const constants_1 = require("../common/constants");
+const daSpecParser_1 = require("../common/daSpecParser");
 const featureFlags_1 = require("../common/featureFlags");
 const globalVars_1 = require("../common/globalVars");
 const localizeUtils_1 = require("../common/localizeUtils");
@@ -30,10 +31,9 @@ const constants_2 = require("../component/constants");
 const coordinator_1 = require("../component/coordinator");
 const aadManifestHelper_1 = require("../component/driver/aad/utility/aadManifestHelper");
 const buildAadManifest_1 = require("../component/driver/aad/utility/buildAadManifest");
-const utils_2 = require("../component/driver/share/utils");
 require("../component/driver/index");
 require("../component/driver/script/scriptDriver");
-require("../component/feature/sso");
+const utils_2 = require("../component/driver/share/utils");
 const appStudio_1 = require("../component/driver/teamsApp/appStudio");
 const errors_1 = require("../component/driver/teamsApp/errors");
 const results_1 = require("../component/driver/teamsApp/results");
@@ -43,7 +43,9 @@ const ManifestUtils_1 = require("../component/driver/teamsApp/utils/ManifestUtil
 const PluginManifestUtils_1 = require("../component/driver/teamsApp/utils/PluginManifestUtils");
 const utils_3 = require("../component/driver/teamsApp/utils/utils");
 const utils_4 = require("../component/driver/util/utils");
+require("../component/feature/sso");
 const helper_1 = require("../component/generator/declarativeAgent/helper");
+const oneDriveSharePointHandler_1 = require("../component/generator/declarativeAgent/oneDriveSharePointHandler");
 const helper_2 = require("../component/generator/openApiSpec/helper");
 const launchHelper_1 = require("../component/m365/launchHelper");
 const packageService_1 = require("../component/m365/packageService");
@@ -59,8 +61,8 @@ const common_2 = require("../error/common");
 const upgrade_1 = require("../error/upgrade");
 const yml_1 = require("../error/yml");
 const constants_3 = require("../question/constants");
-const create_1 = require("../question/create");
 const other_1 = require("../question/other");
+const ProjectTypeOptions_1 = require("../question/scaffold/vsc/ProjectTypeOptions");
 const callback_1 = require("./callback");
 const collaborator_1 = require("./collaborator");
 const crypto_1 = require("./crypto");
@@ -68,12 +70,11 @@ const environmentName_1 = require("./environmentName");
 const concurrentLocker_1 = require("./middleware/concurrentLocker");
 const contextInjector_1 = require("./middleware/contextInjector");
 const errorHandler_1 = require("./middleware/errorHandler");
+const fileLocker_1 = require("./middleware/fileLocker");
 const projectMigratorV3_1 = require("./middleware/projectMigratorV3");
+const retry_1 = require("./middleware/retry");
 const v3MigrationUtils_1 = require("./middleware/utils/v3MigrationUtils");
 const telemetry_2 = require("./telemetry");
-const oneDriveSharePointHandler_1 = require("../component/generator/declarativeAgent/oneDriveSharePointHandler");
-const fileLocker_1 = require("./middleware/fileLocker");
-const daSpecParser_1 = require("../common/daSpecParser");
 class FxCore {
     constructor(tools) {
         (0, globalVars_1.setTools)(tools);
@@ -88,7 +89,7 @@ class FxCore {
     }
     async createProject(inputs) {
         const context = (0, globalVars_1.createContext)();
-        if (inputs[constants_3.QuestionNames.ProjectType] === constants_3.ProjectTypeOptions.startWithGithubCopilot().id) {
+        if (inputs[constants_3.QuestionNames.ProjectType] === ProjectTypeOptions_1.ProjectTypeOptions.startWithGithubCopilot().id) {
             return (0, teamsfx_api_1.ok)({ projectPath: "", shouldInvokeTeamsAgent: true });
         }
         inputs[constants_3.QuestionNames.Scratch] = constants_3.ScratchOptions.yes().id;
@@ -104,7 +105,7 @@ class FxCore {
         // should never happen as we do same check on Developer Portal.
         if (inputs.teamsAppFromTdp) {
             if ((0, utils_3.containsUnsupportedFeature)(inputs.teamsAppFromTdp)) {
-                return (0, teamsfx_api_1.err)(new common_2.InputValidationError("manifest.json", "Teams app contains unsupported features"));
+                return (0, teamsfx_api_1.err)(new common_2.InputValidationError("manifest.json", "App contains unsupported features"));
             }
             else {
                 context.telemetryReporter.sendTelemetryEvent(telemetry_2.CoreTelemetryEvent.CreateFromTdpStart, {
@@ -140,7 +141,7 @@ class FxCore {
         if (genRes.isErr())
             return (0, teamsfx_api_1.err)(genRes.error);
         //3. ensure unique projectId in teamsapp.yaml (optional)
-        const ymlPath = path.join(projectPath, versionMetadata_1.MetadataV3.configFile);
+        const ymlPath = pathUtils_1.pathUtils.getYmlFilePath(projectPath, "dev");
         const result = { projectPath: projectPath };
         if (await fs_extra_1.default.pathExists(ymlPath)) {
             const ensureRes = await coordinator_1.coordinator.ensureTrackingId(projectPath, inputs.projectId);
@@ -160,10 +161,19 @@ class FxCore {
         inputs.projectPath = context.projectPath;
         return res;
     }
+    /**
+     * Wrapper of provisionResourcesOnce, which will retry if NeedRedoError is thrown.
+     */
+    async provisionResources(inputs) {
+        const res = (0, retry_1.runWithRetry)(async () => {
+            return this.provisionResourcesOnce(inputs);
+        }, (result, attempt) => result.isErr() && result.error instanceof common_2.NeedRedoError);
+        return res;
+    }
     /**
      * lifecycle commands: provision
      */
-    async provisionResources(inputs, ctx) {
+    async provisionResourcesOnce(inputs, ctx) {
         inputs.stage = teamsfx_api_1.Stage.provision;
         const context = (0, utils_4.createDriverContext)(inputs);
         try {
@@ -243,7 +253,7 @@ class FxCore {
             return (0, teamsfx_api_1.err)(new common_2.MissingRequiredInputError("env", "FxCore"));
         }
         const teamsappYamlPath = pathUtils_1.pathUtils.getYmlFilePath(inputs.projectPath, inputs.env);
-        const yamlProjectModel = await metadataUtil_1.metadataUtil.parse(teamsappYamlPath, inputs.env);
+        const yamlProjectModel = await metadataUtil_1.metadataUtil.parse(teamsappYamlPath);
         if (yamlProjectModel.isErr()) {
             return (0, teamsfx_api_1.err)(yamlProjectModel.error);
         }
@@ -860,7 +870,7 @@ class FxCore {
             return (0, teamsfx_api_1.err)(manifestRes.error);
         }
         const teamsAppId = manifestRes.value.id;
-        const properties = teamsfx_api_1.ManifestUtil.parseCommonProperties(manifestRes.value);
+        const properties = ManifestUtils_1.manifestUtils.parseCommonProperties(manifestRes.value);
         const launchHelper = new launchHelper_1.LaunchHelper(globalVars_1.TOOLS.tokenProvider.m365TokenProvider, globalVars_1.TOOLS.logProvider);
         const result = await launchHelper.getLaunchUrl(hub, teamsAppId, properties, true);
         return result;
@@ -869,9 +879,6 @@ class FxCore {
      * Warning: this API only works for CLI_HELP, it has no business with interactive run for CLI!
      */
     getQuestions(stage, inputs) {
-        if (stage === teamsfx_api_1.Stage.create) {
-            return (0, teamsfx_api_1.ok)((0, create_1.createProjectCliHelpNode)());
-        }
         return (0, teamsfx_api_1.ok)(undefined);
     }
     /**
@@ -936,7 +943,7 @@ class FxCore {
     async getTeamsAppName(projectPath) {
         var _a;
         const ymlPath = pathUtils_1.pathUtils.getYmlFilePath(projectPath, "dev");
-        const maybeProjectModel = await metadataUtil_1.metadataUtil.parse(ymlPath, "dev");
+        const maybeProjectModel = await metadataUtil_1.metadataUtil.parse(ymlPath);
         if (maybeProjectModel.isErr()) {
             return (0, teamsfx_api_1.err)(maybeProjectModel.error);
         }
@@ -959,7 +966,7 @@ class FxCore {
     async getProjectInfo(projectPath, env) {
         var _a;
         const ymlPath = pathUtils_1.pathUtils.getYmlFilePath(projectPath, env);
-        const maybeProjectModel = await metadataUtil_1.metadataUtil.parse(ymlPath, env);
+        const maybeProjectModel = await metadataUtil_1.metadataUtil.parse(ymlPath);
         if (maybeProjectModel.isErr()) {
             return (0, teamsfx_api_1.err)(maybeProjectModel.error);
         }
@@ -1417,8 +1424,8 @@ class FxCore {
             if (authNameAndSchemes.length > 0) {
                 const doesLocalYamlPathExists = await fs_extra_1.default.pathExists(path.join(inputs.projectPath, versionMetadata_1.MetadataV3.localConfigFile));
                 confirmMessage = doesLocalYamlPathExists
-                    ? (0, localizeUtils_1.getLocalizedString)("core.addApi.confirm.localTeamsYaml", path.relative(inputs.projectPath, appPackageFolder), versionMetadata_1.MetadataV3.localConfigFile, versionMetadata_1.MetadataV3.configFile)
-                    : (0, localizeUtils_1.getLocalizedString)("core.addApi.confirm.teamsYaml", path.relative(inputs.projectPath, appPackageFolder), versionMetadata_1.MetadataV3.configFile);
+                    ? (0, localizeUtils_1.getLocalizedString)("core.addApi.confirm.localTeamsYaml", path.relative(inputs.projectPath, appPackageFolder), versionMetadata_1.MetadataV4.localConfigFile, versionMetadata_1.MetadataV4.configFile)
+                    : (0, localizeUtils_1.getLocalizedString)("core.addApi.confirm.teamsYaml", path.relative(inputs.projectPath, appPackageFolder), versionMetadata_1.MetadataV4.configFile);
             }
         }
         // confirm
@@ -1517,6 +1524,85 @@ class FxCore {
         }
         return (0, teamsfx_api_1.ok)(undefined);
     }
+    async regeneratePlugin(inputs) {
+        const projectPath = inputs.projectPath;
+        const context = (0, globalVars_1.createContext)();
+        const teamsManifestPath = inputs[constants_3.QuestionNames.ManifestPath];
+        const appPackageFolder = path.dirname(teamsManifestPath);
+        const manifestRes = await ManifestUtils_1.manifestUtils._readAppManifest(teamsManifestPath);
+        if (manifestRes.isErr()) {
+            return (0, teamsfx_api_1.err)(manifestRes.error);
+        }
+        const gptManifestFilePathRes = await CopilotGptManifestUtils_1.copilotGptManifestUtils.getManifestPath(teamsManifestPath);
+        if (gptManifestFilePathRes.isErr()) {
+            return (0, teamsfx_api_1.err)(gptManifestFilePathRes.error);
+        }
+        let confirmMessage = (0, localizeUtils_1.getLocalizedString)("core.addApi.confirm", path.relative(projectPath, appPackageFolder));
+        // Will be used if generating from API spec
+        let authNameAndSchemes = [];
+        const specPath = inputs[constants_3.QuestionNames.ApiSpecLocation].trim();
+        const listResult = await (0, daSpecParser_1.listAPIInfo)(specPath);
+        authNameAndSchemes = this.parseAuthNameAndScheme(listResult, inputs);
+        if (authNameAndSchemes.length > 0) {
+            const doesLocalYamlPathExists = await fs_extra_1.default.pathExists(path.join(projectPath, versionMetadata_1.MetadataV3.localConfigFile));
+            confirmMessage = doesLocalYamlPathExists
+                ? (0, localizeUtils_1.getLocalizedString)("core.addApi.confirm.localTeamsYaml", path.relative(projectPath, appPackageFolder), versionMetadata_1.MetadataV4.localConfigFile, versionMetadata_1.MetadataV4.configFile)
+                : (0, localizeUtils_1.getLocalizedString)("core.addApi.confirm.teamsYaml", path.relative(projectPath, appPackageFolder), versionMetadata_1.MetadataV4.configFile);
+        }
+        const confirmRes = await context.userInteraction.showMessage("warn", confirmMessage, true, (0, localizeUtils_1.getLocalizedString)("core.regenerateApi.continue"));
+        if (confirmRes.isErr()) {
+            return (0, teamsfx_api_1.err)(confirmRes.error);
+        }
+        else if (confirmRes.value !== (0, localizeUtils_1.getLocalizedString)("core.regenerateApi.continue")) {
+            return (0, teamsfx_api_1.err)(new common_2.UserCancelError());
+        }
+        const destinationPluginManifestPath = inputs[constants_3.QuestionNames.SelectPluginManifest];
+        const destinationApiSpecPath = inputs[constants_3.QuestionNames.SelectOpenAPISpecFromPlugin];
+        const generateRes = await (0, helper_2.generateFromApiSpec)(undefined, teamsManifestPath, inputs, context, teamsfx_api_1.Stage.RegeneratePlugin, m365_spec_parser_1.ProjectType.Copilot, {
+            destinationApiSpecFilePath: destinationApiSpecPath,
+            pluginManifestFilePath: destinationPluginManifestPath,
+        }, inputs[constants_3.QuestionNames.ApiSpecLocation].trim(), true);
+        if (generateRes.isErr()) {
+            return (0, teamsfx_api_1.err)(generateRes.error);
+        }
+        const warnings = generateRes.value.warnings;
+        if (warnings && warnings.length > 0) {
+            const warnSummary = await (0, helper_2.generateScaffoldingSummary)(warnings, manifestRes.value, path.relative(projectPath, destinationApiSpecPath), path.relative(projectPath, destinationPluginManifestPath), projectPath);
+            context.logProvider.info(warnSummary + "\n");
+        }
+        for (const authNameAndScheme of authNameAndSchemes) {
+            await this.updateAuthActionInYaml(authNameAndScheme.authName, authNameAndScheme.authScheme, projectPath, destinationApiSpecPath, destinationPluginManifestPath, false);
+        }
+        const declarativeAgentManifestPath = gptManifestFilePathRes.value;
+        const declarativeAgentManifesRes = await CopilotGptManifestUtils_1.copilotGptManifestUtils.readCopilotGptManifestFile(declarativeAgentManifestPath);
+        if (declarativeAgentManifesRes.isErr()) {
+            return (0, teamsfx_api_1.err)(declarativeAgentManifesRes.error);
+        }
+        const declarativeAgentManifest = declarativeAgentManifesRes.value;
+        for (const action of declarativeAgentManifest.actions) {
+            const actionPath = path.normalize(path.join(appPackageFolder, action.file));
+            await CopilotGptManifestUtils_1.copilotGptManifestUtils.updateConversationStarters(actionPath, declarativeAgentManifest);
+        }
+        const actionId = inputs[constants_3.QuestionNames.SelectPluginId];
+        if (inputs.platform === teamsfx_api_1.Platform.VSCode) {
+            const successMessage = (0, localizeUtils_1.getLocalizedString)("core.regeneratePlugin.success.vsc", actionId);
+            const viewPluginManifest = (0, localizeUtils_1.getLocalizedString)("core.regeneratePlugin.success.viewPluginManifest");
+            void context.userInteraction
+                .showMessage("info", successMessage, false, viewPluginManifest)
+                .then((userRes) => {
+                var _a, _b;
+                if (userRes.isOk() && userRes.value === viewPluginManifest) {
+                    context.telemetryReporter.sendTelemetryEvent(telemetry_1.TelemetryEvent.ViewPluginManifestAfterAdded);
+                    void ((_b = (_a = globalVars_1.TOOLS === null || globalVars_1.TOOLS === void 0 ? void 0 : globalVars_1.TOOLS.ui) === null || _a === void 0 ? void 0 : _a.openFile) === null || _b === void 0 ? void 0 : _b.call(_a, destinationPluginManifestPath));
+                }
+            });
+        }
+        else {
+            const successMessage = (0, localizeUtils_1.getLocalizedString)("core.regeneratePlugin.success", actionId, destinationPluginManifestPath);
+            void context.userInteraction.showMessage("info", successMessage, false);
+        }
+        return (0, teamsfx_api_1.ok)(undefined);
+    }
     /**
      * Add Knowledge
      */
@@ -1784,19 +1870,42 @@ class FxCore {
                 return (0, teamsfx_api_1.err)(new common_2.UserCancelError());
             }
             const selectedLabel = inputs[constants_3.QuestionNames.SensitivityLabel];
-            const declarativeAgentManifestRes = await CopilotGptManifestUtils_1.copilotGptManifestUtils.readCopilotGptManifestFile(declarativeAgentManifestPath);
+            const declarativeAgentManifestRes = await CopilotGptManifestUtils_1.copilotGptManifestUtils.readDeclarativeAgentManifestFile(declarativeAgentManifestPath);
             if (declarativeAgentManifestRes.isErr()) {
                 return (0, teamsfx_api_1.err)(declarativeAgentManifestRes.error);
             }
             const declarativeAgentManifest = declarativeAgentManifestRes.value;
-            declarativeAgentManifest.sensitivity_label = selectedLabel;
-            const writeRes = await CopilotGptManifestUtils_1.copilotGptManifestUtils.writeCopilotGptManifestFile(declarativeAgentManifest, declarativeAgentManifestPath);
+            declarativeAgentManifest.sensitivity_label = {
+                id: selectedLabel,
+            };
+            const writeRes = await CopilotGptManifestUtils_1.copilotGptManifestUtils.writeDeclarativeAgentManifestFile(declarativeAgentManifest, declarativeAgentManifestPath);
             if (writeRes.isErr()) {
                 return (0, teamsfx_api_1.err)(writeRes.error);
             }
             return (0, teamsfx_api_1.ok)(undefined);
         });
     }
+    async installAppToChannel(inputs) {
+        const installAppDriver = typedi_1.Container.get("devChannel/installApp");
+        const context = (0, utils_4.createDriverContext)(inputs);
+        (0, globalVars_1.setErrorContext)({ component: "devChannelInstallApp" });
+        const env = inputs.env;
+        const readEnvRes = await envUtil_1.envUtil.readEnv(context.projectPath, env, false, false);
+        if (readEnvRes.isErr()) {
+            return (0, teamsfx_api_1.err)(readEnvRes.error);
+        }
+        const envObject = readEnvRes.value;
+        const inputArgs = {
+            appPackagePath: inputs.appPackagePath,
+            teamId: envObject.TEAM_ID,
+            channelId: envObject.CHANNEL_ID,
+        };
+        const res = await installAppDriver.execute(inputArgs, context, new Map());
+        if (res.result.isErr()) {
+            return (0, teamsfx_api_1.err)(res.result.error);
+        }
+        return (0, teamsfx_api_1.ok)(undefined);
+    }
     async updateAuthActionInYaml(authName, authScheme, projectPath, apSpecPath, pluginManifestPath, forceToAddNew = true) {
         if (authName && authScheme) {
             const authInjectRes = await (0, helper_2.injectAuthAction)(projectPath, authName, authScheme, apSpecPath, forceToAddNew);
@@ -1817,7 +1926,8 @@ class FxCore {
             if (operation &&
                 operation.auth &&
                 (m365_spec_parser_1.Utils.isBearerTokenAuth(operation.auth.authScheme) ||
-                    m365_spec_parser_1.Utils.isOAuthWithAuthCodeFlow(operation.auth.authScheme))) {
+                    m365_spec_parser_1.Utils.isOAuthWithAuthCodeFlow(operation.auth.authScheme) ||
+                    m365_spec_parser_1.Utils.isAPIKeyAuthButNotInCookie(operation.auth.authScheme))) {
                 if (result.find((value) => value.authName === operation.auth.name)) {
                     continue;
                 }
@@ -1991,7 +2101,7 @@ tslib_1.__decorate([
     tslib_1.__metadata("design:type", Function),
     tslib_1.__metadata("design:paramtypes", [Object, Object]),
     tslib_1.__metadata("design:returntype", Promise)
-], FxCore.prototype, "provisionResources", null);
+], FxCore.prototype, "provisionResourcesOnce", null);
 tslib_1.__decorate([
     (0, hooks_1.hooks)([
         (0, globalVars_1.ErrorContextMW)({ component: "FxCore", stage: "uninstall", reset: true }),
@@ -2534,6 +2644,17 @@ tslib_1.__decorate([
     tslib_1.__metadata("design:paramtypes", [Object]),
     tslib_1.__metadata("design:returntype", Promise)
 ], FxCore.prototype, "addPlugin", null);
+tslib_1.__decorate([
+    (0, hooks_1.hooks)([
+        (0, globalVars_1.ErrorContextMW)({ component: "FxCore", stage: teamsfx_api_1.Stage.RegeneratePlugin }),
+        errorHandler_1.ErrorHandlerMW,
+        (0, questionMW_1.QuestionMW)("regeneratePlugin"),
+        concurrentLocker_1.ConcurrentLockerMW,
+    ]),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FxCore.prototype, "regeneratePlugin", null);
 tslib_1.__decorate([
     (0, hooks_1.hooks)([
         (0, globalVars_1.ErrorContextMW)({ component: "FxCore", stage: teamsfx_api_1.Stage.addKnowledge }),
@@ -2586,5 +2707,16 @@ tslib_1.__decorate([
     tslib_1.__metadata("design:paramtypes", [Object]),
     tslib_1.__metadata("design:returntype", Promise)
 ], FxCore.prototype, "setSensitivityLabel", null);
+tslib_1.__decorate([
+    (0, hooks_1.hooks)([
+        (0, globalVars_1.ErrorContextMW)({ component: "FxCore", stage: teamsfx_api_1.Stage.installApp }),
+        errorHandler_1.ErrorHandlerMW,
+        (0, envMW_1.EnvLoaderMW)(false),
+        contextInjector_1.ContextInjectorMW,
+    ]),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FxCore.prototype, "installAppToChannel", null);
 exports.FxCore = FxCore;
 //# sourceMappingURL=FxCore.js.map