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

package/build/component/generator/apiSpec/helper.js

@@ -1,834 +0,0 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEnvName = exports.updateForCustomApi = exports.formatValidationErrors = exports.convertSpecParserErrorToFxError = exports.generateScaffoldingSummary = exports.logValidationResults = exports.generateFromApiSpec = exports.listPluginExistingOperations = exports.listOperations = exports.invalidApiSpecErrorName = exports.specParserGenerateResultWarningsTelemetryProperty = exports.specParserGenerateResultAllSuccessTelemetryProperty = exports.specParserGenerateResultTelemetryEvent = exports.getParserOptions = void 0;
-const tslib_1 = require("tslib");
-/**
- * @author yuqzho@microsoft.com
- */
-const m365_spec_parser_1 = require("@microsoft/m365-spec-parser");
-const teamsfx_api_1 = require("@microsoft/teamsfx-api");
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const os_1 = require("os");
-const path_1 = tslib_1.__importDefault(require("path"));
-const featureFlags_1 = require("../../../common/featureFlags");
-const localizeUtils_1 = require("../../../common/localizeUtils");
-const error_1 = require("../../../error");
-const constants_1 = require("../../../question/constants");
-const constant_1 = require("../../configManager/constant");
-const ManifestUtils_1 = require("../../driver/teamsApp/utils/ManifestUtils");
-const PluginManifestUtils_1 = require("../../driver/teamsApp/utils/PluginManifestUtils");
-const telemetry_1 = require("../../../common/telemetry");
-const util = tslib_1.__importStar(require("util"));
-const constants_2 = require("../../../common/constants");
-function getParserOptions(type, isDeclarativeCopilot) {
-    return type === m365_spec_parser_1.ProjectType.Copilot
-        ? {
-            isGptPlugin: isDeclarativeCopilot,
-            allowAPIKeyAuth: false,
-            allowBearerTokenAuth: true,
-            allowMultipleParameters: true,
-            allowOauth2: true,
-            projectType: m365_spec_parser_1.ProjectType.Copilot,
-            allowMissingId: true,
-            allowSwagger: true,
-            allowMethods: [
-                "get",
-                "post",
-                "put",
-                "delete",
-                "patch",
-                "head",
-                "connect",
-                "options",
-                "trace",
-            ],
-            allowResponseSemantics: true,
-            allowConversationStarters: true,
-            allowConfirmation: false, // confirmation is not stable for public preview in Sydney, so it's temporarily set to false
-        }
-        : {
-            projectType: type,
-            allowBearerTokenAuth: true,
-            allowMultipleParameters: true,
-            allowOauth2: featureFlags_1.featureFlagManager.getBooleanValue(featureFlags_1.FeatureFlags.SMEOAuth),
-        };
-}
-exports.getParserOptions = getParserOptions;
-exports.specParserGenerateResultTelemetryEvent = "spec-parser-generate-result";
-exports.specParserGenerateResultAllSuccessTelemetryProperty = "all-success";
-exports.specParserGenerateResultWarningsTelemetryProperty = "warnings";
-exports.invalidApiSpecErrorName = "invalid-api-spec";
-const apiSpecNotUsedInPlugin = "api-spec-not-used-in-plugin";
-async function listOperations(context, apiSpecUrl, inputs, includeExistingAPIs = true, shouldLogWarning = true, existingCorrelationId) {
-    const isPlugin = inputs[constants_1.QuestionNames.ApiPluginType] === constants_1.apiPluginApiSpecOptionId;
-    const isCustomApi = inputs[constants_1.QuestionNames.CustomCopilotRag] === constants_1.CustomCopilotRagOptions.customApi().id;
-    const projectType = isPlugin
-        ? m365_spec_parser_1.ProjectType.Copilot
-        : isCustomApi
-            ? m365_spec_parser_1.ProjectType.TeamsAi
-            : m365_spec_parser_1.ProjectType.SME;
-    try {
-        const specParser = new m365_spec_parser_1.SpecParser(apiSpecUrl, getParserOptions(projectType));
-        const validationRes = await specParser.validate();
-        validationRes.errors = formatValidationErrors(validationRes.errors, inputs);
-        logValidationResults(projectType, validationRes.errors, validationRes.warnings, context, shouldLogWarning, false, validationRes.specHash, existingCorrelationId);
-        if (validationRes.status === m365_spec_parser_1.ValidationStatus.Error) {
-            return (0, teamsfx_api_1.err)(validationRes.errors);
-        }
-        const listResult = await specParser.list();
-        const invalidAPIs = listResult.APIs.filter((value) => !value.isValid);
-        for (const invalidAPI of invalidAPIs) {
-            context.logProvider.warning(`${invalidAPI.api} ${(0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.list.unsupportedBecause")} ${invalidAPI.reason.map(mapInvalidReasonToMessage).join(", ")}`);
-        }
-        const bearerTokenAuthAPIs = listResult.APIs.filter((api) => api.auth && m365_spec_parser_1.Utils.isBearerTokenAuth(api.auth.authScheme));
-        const oauth2AuthAPIs = listResult.APIs.filter((api) => api.auth && m365_spec_parser_1.Utils.isOAuthWithAuthCodeFlow(api.auth.authScheme));
-        const otherAuthAPIs = listResult.APIs.filter((api) => api.auth &&
-            !m365_spec_parser_1.Utils.isOAuthWithAuthCodeFlow(api.auth.authScheme) &&
-            !m365_spec_parser_1.Utils.isBearerTokenAuth(api.auth.authScheme));
-        let operations = listResult.APIs.filter((value) => value.isValid);
-        context.telemetryReporter.sendTelemetryEvent("spec-parser-list-apis-result" /* telemetryEvents.listApis */, {
-            ["generate-type" /* telemetryProperties.generateType */]: projectType.toString(),
-            ["valid-apis-count" /* telemetryProperties.validApisCount */]: listResult.validAPICount.toString(),
-            ["all-apis-count" /* telemetryProperties.allApisCount */]: listResult.allAPICount.toString(),
-            ["is-from-adding-api" /* telemetryProperties.isFromAddingApi */]: (!includeExistingAPIs).toString(),
-            ["bearer-token-auth-count" /* telemetryProperties.bearerTokenAuthCount */]: bearerTokenAuthAPIs.length.toString(),
-            ["oauth2-auth-count" /* telemetryProperties.oauth2AuthCount */]: oauth2AuthAPIs.length.toString(),
-            ["other-auth-count" /* telemetryProperties.otherAuthCount */]: otherAuthAPIs.length.toString(),
-            ["spec-hash" /* telemetryProperties.specHash */]: validationRes.specHash,
-        });
-        // Filter out exsiting APIs
-        if (!includeExistingAPIs) {
-            const teamsManifestPath = inputs[constants_1.QuestionNames.ManifestPath];
-            if (!teamsManifestPath) {
-                throw new error_1.MissingRequiredInputError("teamsManifestPath", "inputs");
-            }
-            const manifest = await ManifestUtils_1.manifestUtils._readAppManifest(teamsManifestPath);
-            let existingOperations = [];
-            if (manifest.isOk()) {
-                let isOriginalSpec;
-                if (isPlugin) {
-                    existingOperations = await listPluginExistingOperations(manifest.value, teamsManifestPath, inputs[constants_1.QuestionNames.DestinationApiSpecFilePath]);
-                    const operationAPIs = operations.map((operation) => operation.api);
-                    isOriginalSpec = existingOperations.every((operation) => operationAPIs.includes(operation));
-                }
-                else {
-                    const existingOperationIds = ManifestUtils_1.manifestUtils.getOperationIds(manifest.value);
-                    existingOperations = operations
-                        .filter((operation) => existingOperationIds.includes(operation.operationId))
-                        .map((operation) => operation.api);
-                    isOriginalSpec = existingOperations.length === existingOperationIds.length;
-                }
-                if (!isOriginalSpec) {
-                    const errors = formatValidationErrors([
-                        {
-                            type: m365_spec_parser_1.ErrorType.AddedAPINotInOriginalSpec,
-                            content: "",
-                        },
-                    ], inputs);
-                    logValidationResults(projectType, errors, [], context, true, false, validationRes.specHash, existingCorrelationId);
-                    return (0, teamsfx_api_1.err)(errors);
-                }
-                operations = operations.filter((operation) => !existingOperations.includes(operation.api));
-                // No extra API can be added
-                if (operations.length == 0) {
-                    const errors = formatValidationErrors([
-                        {
-                            type: m365_spec_parser_1.ErrorType.NoExtraAPICanBeAdded,
-                            content: "",
-                        },
-                    ], inputs);
-                    logValidationResults(projectType, errors, [], context, true, false, validationRes.specHash, existingCorrelationId);
-                    return (0, teamsfx_api_1.err)(errors);
-                }
-            }
-            else {
-                throw manifest.error;
-            }
-        }
-        const sortedOperations = sortOperations(operations);
-        return (0, teamsfx_api_1.ok)(sortedOperations);
-    }
-    catch (e) {
-        if (e instanceof m365_spec_parser_1.SpecParserError) {
-            throw convertSpecParserErrorToFxError(e);
-        }
-        else {
-            throw e;
-        }
-    }
-}
-exports.listOperations = listOperations;
-function sortOperations(operations) {
-    const operationsWithSeparator = [];
-    for (const operation of operations) {
-        const arr = operation.api.toUpperCase().split(" ");
-        const result = {
-            id: operation.api,
-            label: operation.api,
-            groupName: arr[0],
-            detail: !operation.auth
-                ? (0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.api.noAuth")
-                : m365_spec_parser_1.Utils.isBearerTokenAuth(operation.auth.authScheme)
-                    ? (0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.api.apiKeyAuth")
-                    : m365_spec_parser_1.Utils.isOAuthWithAuthCodeFlow(operation.auth.authScheme)
-                        ? (0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.api.oauth")
-                        : "",
-            data: {
-                serverUrl: operation.server,
-            },
-        };
-        if (operation.auth) {
-            if (m365_spec_parser_1.Utils.isBearerTokenAuth(operation.auth.authScheme)) {
-                result.data.authType = "apiKey";
-                result.data.authName = operation.auth.name;
-            }
-            else if (m365_spec_parser_1.Utils.isOAuthWithAuthCodeFlow(operation.auth.authScheme)) {
-                result.data.authType = "oauth2";
-                result.data.authName = operation.auth.name;
-            }
-        }
-        operationsWithSeparator.push(result);
-    }
-    return operationsWithSeparator.sort((operation1, operation2) => {
-        const arr1 = operation1.id.toLowerCase().split(" ");
-        const arr2 = operation2.id.toLowerCase().split(" ");
-        return arr1[0] < arr2[0] ? -1 : arr1[0] > arr2[0] ? 1 : arr1[1].localeCompare(arr2[1]);
-    });
-}
-function formatTelemetryValidationProperty(result) {
-    return result.type.toString();
-}
-async function listPluginExistingOperations(manifest, teamsManifestPath, destinationApiSpecFilePath) {
-    const getApiSPecFileRes = await PluginManifestUtils_1.pluginManifestUtils.getApiSpecFilePathFromTeamsManifest(manifest, teamsManifestPath);
-    if (getApiSPecFileRes.isErr()) {
-        throw getApiSPecFileRes.error;
-    }
-    let apiSpecFilePath;
-    const apiSpecFiles = getApiSPecFileRes.value;
-    for (const file of apiSpecFiles) {
-        if (path_1.default.resolve(file) === path_1.default.resolve(destinationApiSpecFilePath)) {
-            apiSpecFilePath = file;
-            break;
-        }
-    }
-    if (!apiSpecFilePath) {
-        throw new teamsfx_api_1.UserError("listPluginExistingOperations", apiSpecNotUsedInPlugin, (0, localizeUtils_1.getLocalizedString)("error.copilotPlugin.apiSpecNotUsedInPlugin", destinationApiSpecFilePath), (0, localizeUtils_1.getLocalizedString)("error.copilotPlugin.apiSpecNotUsedInPlugin", destinationApiSpecFilePath));
-    }
-    const specParser = new m365_spec_parser_1.SpecParser(apiSpecFilePath, getParserOptions(m365_spec_parser_1.ProjectType.Copilot));
-    const listResult = await specParser.list();
-    return listResult.APIs.map((o) => o.api);
-}
-exports.listPluginExistingOperations = listPluginExistingOperations;
-async function generateFromApiSpec(specParser, teamsManifestPath, inputs, context, sourceComponent, projectType, outputFilePath) {
-    const operations = featureFlags_1.featureFlagManager.getBooleanValue(featureFlags_1.FeatureFlags.KiotaIntegration) &&
-        inputs[constants_1.QuestionNames.ApiPluginManifestPath]
-        ? (await specParser.list()).APIs.filter((value) => value.isValid).map((value) => value.api)
-        : inputs[constants_1.QuestionNames.ApiOperation];
-    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) => operations.includes(api));
-        if (apisMissingOperationId.length > 0) {
-            operationIdWarning.content = util.format((0, 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) {
-        logValidationResults(projectType, validationRes.errors, warnings, context, false, true, validationRes.specHash);
-        const errorMessage = inputs.platform === teamsfx_api_1.Platform.VSCode
-            ? (0, localizeUtils_1.getLocalizedString)("core.createProjectQuestion.apiSpec.multipleValidationErrors.vscode.message")
-            : (0, localizeUtils_1.getLocalizedString)("core.createProjectQuestion.apiSpec.multipleValidationErrors.message");
-        return (0, teamsfx_api_1.err)(new teamsfx_api_1.UserError(sourceComponent, exports.invalidApiSpecErrorName, errorMessage, errorMessage));
-    }
-    try {
-        const generateResult = projectType === m365_spec_parser_1.ProjectType.Copilot
-            ? await specParser.generateForCopilot(teamsManifestPath, operations, outputFilePath.destinationApiSpecFilePath, outputFilePath.pluginManifestFilePath, inputs[constants_1.QuestionNames.ApiPluginManifestPath])
-            : await specParser.generate(teamsManifestPath, operations, outputFilePath.destinationApiSpecFilePath, projectType === m365_spec_parser_1.ProjectType.TeamsAi ? undefined : outputFilePath.responseTemplateFolder);
-        // Send SpecParser.generate() warnings
-        context.telemetryReporter.sendTelemetryEvent(exports.specParserGenerateResultTelemetryEvent, {
-            ["generate-type" /* telemetryProperties.generateType */]: projectType.toString(),
-            [exports.specParserGenerateResultAllSuccessTelemetryProperty]: generateResult.allSuccess.toString(),
-            [exports.specParserGenerateResultWarningsTelemetryProperty]: generateResult.warnings
-                .map((w) => w.type.toString() + ": " + w.content)
-                .join(";"),
-            [telemetry_1.TelemetryProperty.Component]: sourceComponent,
-        });
-        if (generateResult.warnings && 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);
-        }
-        return (0, teamsfx_api_1.ok)({ warnings });
-    }
-    catch (e) {
-        let error;
-        if (e instanceof m365_spec_parser_1.SpecParserError) {
-            error = convertSpecParserErrorToFxError(e);
-        }
-        else {
-            error = (0, error_1.assembleError)(e, sourceComponent);
-        }
-        return (0, teamsfx_api_1.err)(error);
-    }
-}
-exports.generateFromApiSpec = generateFromApiSpec;
-function logValidationResults(projectType, errors, warnings, context, shouldLogWarning, shouldSkipTelemetry, specHash, existingCorrelationId) {
-    if (!shouldSkipTelemetry) {
-        const properties = {
-            ["validation-status" /* telemetryProperties.validationStatus */]: errors.length !== 0 ? "error" : warnings.length !== 0 ? "warning" : "success",
-            ["validation-errors" /* telemetryProperties.validationErrors */]: errors
-                .map((error) => formatTelemetryValidationProperty(error))
-                .join(";"),
-            ["validation-warnings" /* telemetryProperties.validationWarnings */]: warnings
-                .map((warn) => formatTelemetryValidationProperty(warn))
-                .join(";"),
-            ["project-type" /* telemetryProperties.projectType */]: projectType.toString(),
-        };
-        if (specHash) {
-            properties["spec-hash" /* telemetryProperties.specHash */] = specHash;
-        }
-        const specNotValidError = errors.find((error) => error.type === m365_spec_parser_1.ErrorType.SpecNotValid);
-        if (specNotValidError) {
-            properties[telemetry_1.ApiSpecTelemetryPropertis.SpecNotValidDetails] = specNotValidError.content;
-        }
-        if (existingCorrelationId) {
-            properties["correlation-id"] = existingCorrelationId;
-        }
-        context.telemetryReporter.sendTelemetryEvent("validate-api-spec" /* telemetryEvents.validateApiSpec */, properties);
-    }
-    if (errors.length === 0 && (warnings.length === 0 || !shouldLogWarning)) {
-        return;
-    }
-    // errors > 0 || (warnings > 0 && shouldLogWarning)
-    const errorMessage = errors
-        .map((error) => {
-        return `${constant_1.SummaryConstant.Failed} ${error.content}`;
-    })
-        .join(os_1.EOL);
-    const warningMessage = shouldLogWarning
-        ? warnings
-            .map((warning) => {
-            return `${constant_1.SummaryConstant.NotExecuted} ${warning.content}`;
-        })
-            .join(os_1.EOL)
-        : "";
-    const failed = errors.length;
-    const warns = warnings.length;
-    const summaryStr = [];
-    if (failed > 0) {
-        summaryStr.push((0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.validate.summary.validate.failed", failed));
-    }
-    if (warns > 0 && shouldLogWarning) {
-        summaryStr.push((0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.validate.summary.validate.warning", warns));
-    }
-    const outputMessage = os_1.EOL +
-        (0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.validate.apiSpec.summary", summaryStr.join(", "), errorMessage, warningMessage);
-    void context.logProvider.info(outputMessage);
-}
-exports.logValidationResults = logValidationResults;
-/**
- * Generate scaffolding warning summary.
- * @param warnings warnings returned from spec-parser.
- * @param teamsManifest Teams manifest.
- * @param apiSpecFilePath API spec path relative of project path.
- * @param pluginManifestPath Plugin manifest path relative of project path.
- * @param projectPath Project path.
- * @returns Warning message.
- */
-async function generateScaffoldingSummary(warnings, teamsManifest, apiSpecFilePath, pluginManifestPath, projectPath) {
-    const apiSpecWarningMessage = formatApiSpecValidationWarningMessage(warnings, apiSpecFilePath, teamsManifest);
-    const manifestWarningResult = validateTeamsManifestLength(teamsManifest, warnings);
-    const manifestWarningMessage = manifestWarningResult.map((warn) => {
-        return `${constant_1.SummaryConstant.NotExecuted} ${warn}`;
-    });
-    let pluginWarningMessage = [];
-    if (pluginManifestPath) {
-        const pluginManifestWarningResult = await validatePluginManifestLength(pluginManifestPath, projectPath, warnings);
-        pluginWarningMessage = pluginManifestWarningResult.map((warn) => {
-            return `${constant_1.SummaryConstant.NotExecuted} ${warn}`;
-        });
-    }
-    if (apiSpecWarningMessage.length ||
-        manifestWarningMessage.length ||
-        pluginWarningMessage.length) {
-        let details = "";
-        if (apiSpecWarningMessage.length) {
-            details += os_1.EOL + apiSpecWarningMessage.join(os_1.EOL);
-        }
-        if (manifestWarningMessage.length) {
-            details += os_1.EOL + manifestWarningMessage.join(os_1.EOL);
-        }
-        if (pluginWarningMessage.length) {
-            details += os_1.EOL + pluginWarningMessage.join(os_1.EOL);
-        }
-        return (0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary", details);
-    }
-    else {
-        return "";
-    }
-}
-exports.generateScaffoldingSummary = generateScaffoldingSummary;
-function formatApiSpecValidationWarningMessage(specWarnings, apiSpecFileName, teamsManifest) {
-    const resultWarnings = [];
-    const operationIdWarning = specWarnings.find((w) => w.type === m365_spec_parser_1.WarningType.OperationIdMissing);
-    if (operationIdWarning) {
-        const isApiMe = teamsfx_api_1.ManifestUtil.parseCommonProperties(teamsManifest).isApiME;
-        resultWarnings.push((0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.operationId", `${constant_1.SummaryConstant.NotExecuted} ${operationIdWarning.content}`, isApiMe ? teamsfx_api_1.ManifestTemplateFileName : apiSpecFileName));
-    }
-    const swaggerWarning = specWarnings.find((w) => w.type === m365_spec_parser_1.WarningType.ConvertSwaggerToOpenAPI);
-    if (swaggerWarning) {
-        resultWarnings.push(`${constant_1.SummaryConstant.NotExecuted} ` +
-            (0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.swaggerVersion", apiSpecFileName));
-    }
-    return resultWarnings;
-}
-function validateTeamsManifestLength(teamsManifest, warnings) {
-    var _a, _b, _c, _d;
-    const nameShortLimit = 30;
-    const nameFullLimit = 100;
-    const descriptionShortLimit = 80;
-    const descriptionFullLimit = 4000;
-    const appnameSuffixPlaceholder = "${{APP_NAME_SUFFIX}}";
-    const devEnv = "dev";
-    const resultWarnings = [];
-    // validate name
-    const shortNameLength = teamsManifest.name.short.includes(appnameSuffixPlaceholder)
-        ? teamsManifest.name.short.length - appnameSuffixPlaceholder.length + devEnv.length
-        : teamsManifest.name.short.length;
-    if (shortNameLength > nameShortLimit) {
-        resultWarnings.push(formatLengthExceedingErrorMessage("/name/short", nameShortLimit));
-    }
-    if (!!teamsManifest.name.full && ((_a = teamsManifest.name.full) === null || _a === void 0 ? void 0 : _a.length) > nameFullLimit) {
-        resultWarnings.push(formatLengthExceedingErrorMessage("/name/full", nameFullLimit));
-    }
-    // validate description
-    if (teamsManifest.description.short.length > descriptionShortLimit) {
-        resultWarnings.push(formatLengthExceedingErrorMessage("/description/short", descriptionShortLimit));
-    }
-    if (!((_b = teamsManifest.description.full) === null || _b === void 0 ? void 0 : _b.length)) {
-        resultWarnings.push((0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.teamsManifest.missingFullDescription") +
-            (0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.teamsManifest.mitigation", "full/description", path_1.default.join(teamsfx_api_1.AppPackageFolderName, teamsfx_api_1.ManifestTemplateFileName)));
-    }
-    if (teamsManifest.description.full.length > descriptionFullLimit) {
-        resultWarnings.push(formatLengthExceedingErrorMessage("/description/full", descriptionFullLimit));
-    }
-    // validate command
-    if (teamsfx_api_1.ManifestUtil.parseCommonProperties(teamsManifest).isApiME) {
-        const optionalParamsOnlyWarnings = warnings.filter((o) => o.type === m365_spec_parser_1.WarningType.OperationOnlyContainsOptionalParam);
-        if (optionalParamsOnlyWarnings) {
-            for (const optionalParamsOnlyWarning of optionalParamsOnlyWarnings) {
-                resultWarnings.push((0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.api.optionalParametersOnly", optionalParamsOnlyWarning.data.commandId, optionalParamsOnlyWarning.data.commandId) +
-                    (0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.api.optionalParametersOnly.mitigation", optionalParamsOnlyWarning.data.parameterName, optionalParamsOnlyWarning.data.commandId, path_1.default.join(teamsfx_api_1.AppPackageFolderName, teamsfx_api_1.ManifestTemplateFileName), path_1.default.join(teamsfx_api_1.AppPackageFolderName, (_c = teamsManifest.composeExtensions[0].apiSpecificationFile) !== null && _c !== void 0 ? _c : "")));
-            }
-        }
-        const commands = teamsManifest.composeExtensions[0].commands;
-        for (const command of commands) {
-            if (command.type === "query") {
-                if (!command.apiResponseRenderingTemplateFile) {
-                    const errorDetail = (_d = warnings.find((w) => w.type === m365_spec_parser_1.WarningType.GenerateCardFailed && w.data === command.id)) === null || _d === void 0 ? void 0 : _d.content;
-                    resultWarnings.push((0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.teamsManifest.missingCardTemlate", "apiResponseRenderingTemplateFile", command.id) +
-                        (0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.teamsManifest.missingCardTemlate.mitigation", teamsfx_api_1.AppPackageFolderName, `composeExtensions/commands/${command.id}/apiResponseRenderingTemplateFile`, path_1.default.join(teamsfx_api_1.AppPackageFolderName, teamsfx_api_1.ManifestTemplateFileName)) +
-                        (errorDetail ? os_1.EOL + errorDetail : ""));
-                }
-            }
-        }
-    }
-    return resultWarnings;
-}
-async function validatePluginManifestLength(pluginManifestPath, projectPath, warnings) {
-    const functionDescriptionLimit = 100;
-    const resultWarnings = [];
-    const manifestRes = await PluginManifestUtils_1.pluginManifestUtils.readPluginManifestFile(path_1.default.join(projectPath, pluginManifestPath));
-    if (manifestRes.isErr()) {
-        (0, telemetry_1.sendTelemetryErrorEvent)("spec-generator", "failed-to-get-generate-warning" /* telemetryEvents.failedToGetGenerateWarning */, manifestRes.error);
-        return [];
-    }
-    // validate function description
-    const functions = manifestRes.value.functions;
-    const functionDescriptionWarnings = warnings
-        .filter((w) => w.type === m365_spec_parser_1.WarningType.FuncDescriptionTooLong)
-        .map((w) => w.data);
-    if (functions) {
-        functions.forEach((func) => {
-            if (!func.description) {
-                resultWarnings.push((0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.pluginManifest.missingFunctionDescription", func.name) +
-                    (0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.pluginManifest.missingFunctionDescription.mitigation", func.name, pluginManifestPath));
-            }
-            else if (functionDescriptionWarnings.includes(func.name)) {
-                resultWarnings.push((0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.pluginManifest.functionDescription.lengthExceeding", func.name, functionDescriptionLimit) +
-                    (0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.pluginManifest.functionDescription.lengthExceeding.mitigation", func.name, pluginManifestPath));
-            }
-        });
-    }
-    return resultWarnings;
-}
-function formatLengthExceedingErrorMessage(field, limit) {
-    return ((0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.teamsManifest.lengthExceeding", field, limit.toString()) +
-        (0, localizeUtils_1.getLocalizedString)("core.copilotPlugin.scaffold.summary.warning.teamsManifest.mitigation", field, path_1.default.join(teamsfx_api_1.AppPackageFolderName, teamsfx_api_1.ManifestTemplateFileName)));
-}
-function convertSpecParserErrorToFxError(error) {
-    return new teamsfx_api_1.SystemError(constants_2.SpecParserSource, error.errorType.toString(), error.message, error.message);
-}
-exports.convertSpecParserErrorToFxError = convertSpecParserErrorToFxError;
-function formatValidationErrors(errors, inputs) {
-    return errors.map((error) => {
-        return {
-            type: error.type,
-            content: formatValidationErrorContent(error, inputs),
-            data: error.data,
-        };
-    });
-}
-exports.formatValidationErrors = formatValidationErrors;
-function mapInvalidReasonToMessage(reason) {
-    switch (reason) {
-        case m365_spec_parser_1.ErrorType.AuthTypeIsNotSupported:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.AuthTypeIsNotSupported");
-        case m365_spec_parser_1.ErrorType.MissingOperationId:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.MissingOperationId");
-        case m365_spec_parser_1.ErrorType.PostBodyContainMultipleMediaTypes:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.PostBodyContainMultipleMediaTypes");
-        case m365_spec_parser_1.ErrorType.ResponseContainMultipleMediaTypes:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.ResponseContainMultipleMediaTypes");
-        case m365_spec_parser_1.ErrorType.ResponseJsonIsEmpty:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.ResponseJsonIsEmpty");
-        case m365_spec_parser_1.ErrorType.PostBodySchemaIsNotJson:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.PostBodySchemaIsNotJson");
-        case m365_spec_parser_1.ErrorType.PostBodyContainsRequiredUnsupportedSchema:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.PostBodyContainsRequiredUnsupportedSchema");
-        case m365_spec_parser_1.ErrorType.ParamsContainRequiredUnsupportedSchema:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.ParamsContainRequiredUnsupportedSchema");
-        case m365_spec_parser_1.ErrorType.ParamsContainsNestedObject:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.ParamsContainsNestedObject");
-        case m365_spec_parser_1.ErrorType.RequestBodyContainsNestedObject:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.RequestBodyContainsNestedObject");
-        case m365_spec_parser_1.ErrorType.ExceededRequiredParamsLimit:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.ExceededRequiredParamsLimit");
-        case m365_spec_parser_1.ErrorType.NoParameter:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.NoParameter");
-        case m365_spec_parser_1.ErrorType.NoAPIInfo:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.NoAPIInfo");
-        case m365_spec_parser_1.ErrorType.MethodNotAllowed:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.MethodNotAllowed");
-        case m365_spec_parser_1.ErrorType.UrlPathNotExist:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.UrlPathNotExist");
-        case m365_spec_parser_1.ErrorType.CircularReferenceNotSupported:
-            return (0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.CircularReference");
-        default:
-            return reason.toString();
-    }
-}
-function formatValidationErrorContent(error, inputs) {
-    const isPlugin = inputs[constants_1.QuestionNames.ApiPluginType] === constants_1.apiPluginApiSpecOptionId;
-    try {
-        switch (error.type) {
-            case m365_spec_parser_1.ErrorType.SpecNotValid: {
-                let content = error.content;
-                if (error.content.startsWith("ResolverError: Error downloading")) {
-                    content = error.content
-                        .split("\n")
-                        .map((o) => o.trim())
-                        .join(". ");
-                    content = `${content}. ${(0, localizeUtils_1.getLocalizedString)("core.common.ErrorFetchApiSpec")}`;
-                }
-                return content;
-            }
-            case m365_spec_parser_1.ErrorType.RemoteRefNotSupported:
-                return (0, localizeUtils_1.getLocalizedString)("core.common.RemoteRefNotSupported", error.data.join(", "));
-            case m365_spec_parser_1.ErrorType.NoServerInformation:
-                return (0, localizeUtils_1.getLocalizedString)("core.common.NoServerInformation");
-            case m365_spec_parser_1.ErrorType.UrlProtocolNotSupported:
-                return (0, localizeUtils_1.getLocalizedString)("core.common.UrlProtocolNotSupported", error.data);
-            case m365_spec_parser_1.ErrorType.RelativeServerUrlNotSupported:
-                return (0, localizeUtils_1.getLocalizedString)("core.common.RelativeServerUrlNotSupported");
-            case m365_spec_parser_1.ErrorType.NoSupportedApi:
-                const messages = [];
-                const invalidAPIInfo = error.data;
-                for (const info of invalidAPIInfo) {
-                    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-                    const mes = `${info.api}: ${info.reason.map(mapInvalidReasonToMessage).join(", ")}`;
-                    messages.push(mes);
-                }
-                if (messages.length === 0) {
-                    messages.push((0, localizeUtils_1.getLocalizedString)("core.common.invalidReason.NoAPIs"));
-                }
-                return isPlugin
-                    ? (0, localizeUtils_1.getLocalizedString)("core.common.NoSupportedApiCopilot", messages.join("\n"))
-                    : (0, localizeUtils_1.getLocalizedString)("core.common.NoSupportedApi", messages.join("\n"));
-            case m365_spec_parser_1.ErrorType.NoExtraAPICanBeAdded:
-                return isPlugin
-                    ? (0, localizeUtils_1.getLocalizedString)("error.copilot.noExtraAPICanBeAdded")
-                    : (0, localizeUtils_1.getLocalizedString)("error.apime.noExtraAPICanBeAdded");
-            case m365_spec_parser_1.ErrorType.ResolveServerUrlFailed:
-                return error.content;
-            case m365_spec_parser_1.ErrorType.Cancelled:
-                return (0, localizeUtils_1.getLocalizedString)("core.common.CancelledMessage");
-            case m365_spec_parser_1.ErrorType.SwaggerNotSupported:
-                return (0, localizeUtils_1.getLocalizedString)("core.common.SwaggerNotSupported");
-            case m365_spec_parser_1.ErrorType.SpecVersionNotSupported:
-                return (0, localizeUtils_1.getLocalizedString)("core.common.SpecVersionNotSupported", error.data);
-            case m365_spec_parser_1.ErrorType.AddedAPINotInOriginalSpec:
-                return (0, localizeUtils_1.getLocalizedString)("core.common.AddedAPINotInOriginalSpec");
-            default:
-                return error.content;
-        }
-    }
-    catch (e) {
-        return error.content;
-    }
-}
-function parseSpec(spec) {
-    const res = [];
-    let needAuth = false;
-    const paths = spec.paths;
-    if (paths) {
-        for (const pathUrl in paths) {
-            const pathItem = paths[pathUrl];
-            if (pathItem) {
-                const operations = pathItem;
-                for (const method in operations) {
-                    if (method === "get" || method === "post") {
-                        const operationItem = operations[method];
-                        if (operationItem) {
-                            const authResult = m365_spec_parser_1.Utils.getAuthArray(operationItem.security, spec);
-                            const hasAuth = authResult.length != 0;
-                            if (hasAuth) {
-                                needAuth = true;
-                            }
-                            res.push({
-                                item: operationItem,
-                                method: method,
-                                pathUrl: pathUrl,
-                                auth: hasAuth,
-                            });
-                        }
-                    }
-                }
-            }
-        }
-    }
-    return [res, needAuth];
-}
-const commonLanguages = [constants_1.ProgrammingLanguage.TS, constants_1.ProgrammingLanguage.JS, constants_1.ProgrammingLanguage.PY];
-async function updatePromptForCustomApi(spec, language, chatFolder) {
-    if (commonLanguages.includes(language)) {
-        const promptFilePath = path_1.default.join(chatFolder, "skprompt.txt");
-        const prompt = `The following is a conversation with an AI assistant.\nThe assistant can help to call APIs for the open api spec file${spec.info.description ? ". " + spec.info.description : "."}\nIf the API doesn't require parameters, invoke it with default JSON object { "path": null, "body": null, "query": null }.\n\ncontext:\nAvailable actions: {{getAction}}.`;
-        await fs_extra_1.default.writeFile(promptFilePath, prompt, { encoding: "utf-8", flag: "w" });
-    }
-}
-async function updateAdaptiveCardForCustomApi(specItems, language, destinationPath) {
-    if (commonLanguages.includes(language)) {
-        const adaptiveCardsFolderPath = path_1.default.join(destinationPath, "src", "adaptiveCards");
-        await fs_extra_1.default.ensureDir(adaptiveCardsFolderPath);
-        for (const item of specItems) {
-            const name = item.item.operationId.replace(/[^a-zA-Z0-9]/g, "_");
-            const [card, jsonPath] = m365_spec_parser_1.AdaptiveCardGenerator.generateAdaptiveCard(item.item, true);
-            if (jsonPath !== "$" && card.body && card.body[0] && card.body[0].$data) {
-                card.body[0].$data = `\${${jsonPath}}`;
-            }
-            const cardFilePath = path_1.default.join(adaptiveCardsFolderPath, `${name}.json`);
-            await fs_extra_1.default.writeFile(cardFilePath, JSON.stringify(card, null, 2));
-        }
-    }
-}
-async function updateActionForCustomApi(specItems, language, chatFolder) {
-    var _a, _b;
-    if (commonLanguages.includes(language)) {
-        const actionsFilePath = path_1.default.join(chatFolder, "actions.json");
-        const actions = [];
-        for (const item of specItems) {
-            const parameters = {
-                type: "object",
-                properties: {},
-                required: [],
-            };
-            const paramObject = item.item.parameters;
-            if (paramObject) {
-                for (let i = 0; i < paramObject.length; i++) {
-                    const param = paramObject[i];
-                    const schema = param.schema;
-                    const paramType = param.in;
-                    if (!parameters.properties[paramType]) {
-                        parameters.properties[paramType] = {
-                            type: "object",
-                            properties: {},
-                            required: [],
-                        };
-                    }
-                    parameters.properties[paramType].properties[param.name] = schema;
-                    parameters.properties[paramType].properties[param.name].description =
-                        (_a = param.description) !== null && _a !== void 0 ? _a : "";
-                    if (param.required) {
-                        parameters.properties[paramType].required.push(param.name);
-                        if (!parameters.required.includes(paramType)) {
-                            parameters.required.push(paramType);
-                        }
-                    }
-                }
-            }
-            actions.push({
-                name: item.item.operationId,
-                description: (_b = item.item.description) !== null && _b !== void 0 ? _b : item.item.summary,
-                parameters: parameters,
-            });
-        }
-        await fs_extra_1.default.writeFile(actionsFilePath, JSON.stringify(actions, null, 2));
-    }
-}
-const ActionCode = {
-    javascript: `
-app.ai.action("{{operationId}}", async (context, state, parameter) => {
-  const client = await api.getClient();
-  // Add authentication configuration for the client
-  const path = client.paths["{{pathUrl}}"];
-  if (path && path.{{method}}) {
-    const result = await path.{{method}}(parameter.path, parameter.body, {
-      params: parameter.query,
-    });
-    const cardName = "{{operationId}}".replace(/[^a-zA-Z0-9]/g, "_");
-    const card = generateAdaptiveCard("../adaptiveCards/" + cardName + ".json", result);
-    await context.sendActivity({ attachments: [card] });
-  } else {
-    await context.sendActivity("no result");
-  }
-  return "result";
-});
-  `,
-    typescript: `
-app.ai.action("{{operationId}}", async (context: TurnContext, state: ApplicationTurnState, parameter: any) => {
-  const client = await api.getClient();
-  // Add authentication configuration for the client
-  const path = client.paths["{{pathUrl}}"];
-  if (path && path.{{method}}) {
-    const result = await path.{{method}}(parameter.path, parameter.body, {
-      params: parameter.query,
-    });
-    const cardName = "{{operationId}}".replace(/[^a-zA-Z0-9]/g, "_");
-    const card = generateAdaptiveCard("../adaptiveCards/" + cardName + ".json", result);
-    await context.sendActivity({ attachments: [card] });
-  } else {
-    await context.sendActivity("no result");
-  }
-  return "result";
-});
-  `,
-    python: `
-@bot_app.ai.action("{{operationId}}")
-async def {{operationId}}(
-  context: ActionTurnContext[Dict[str, Any]],
-  state: AppTurnState,
-):
-  parameters = context.data
-  path = parameters.get("path", {})
-  body = parameters.get("body", None)
-  query = parameters.get("query", {})
-  resp = client.{{operationId}}(**path, json=body, _headers={}, _params=query, _cookies={})
-
-  if resp.status_code != 200:
-    await context.send_activity(resp.reason)
-  else:
-    card_template_path = os.path.join(current_dir, 'adaptiveCards/{{operationId}}.json')
-    with open(card_template_path) as card_template_file:
-        adaptive_card_template = card_template_file.read()
-
-    renderer = AdaptiveCardRenderer(adaptive_card_template)
-
-    json_resoponse_str = resp.text
-    rendered_card_str = renderer.render(json_resoponse_str)
-    rendered_card_json = json.loads(rendered_card_str)
-    card = CardFactory.adaptive_card(rendered_card_json)
-    message = MessageFactory.attachment(card)
-    
-    await context.send_activity(message)
-  return "success"
-  `,
-};
-const AuthCode = {
-    javascript: {
-        actionCode: `addAuthConfig(client);`,
-        actionPlaceholder: `// Add authentication configuration for the client`,
-    },
-    typescript: {
-        actionCode: `addAuthConfig(client);`,
-        actionPlaceholder: `// Add authentication configuration for the client`,
-    },
-};
-async function updateCodeForCustomApi(specItems, language, destinationPath, openapiSpecFileName, needAuth) {
-    if (language === constants_1.ProgrammingLanguage.JS || language === constants_1.ProgrammingLanguage.TS) {
-        const codeTemplate = ActionCode[language === constants_1.ProgrammingLanguage.JS ? "javascript" : "typescript"];
-        const appFolderPath = path_1.default.join(destinationPath, "src", "app");
-        const actionsCode = [];
-        const authCodeTemplate = AuthCode[language === constants_1.ProgrammingLanguage.JS ? "javascript" : "typescript"];
-        for (const item of specItems) {
-            const auth = item.auth;
-            const code = codeTemplate
-                .replace(authCodeTemplate.actionPlaceholder, auth ? authCodeTemplate.actionCode : "")
-                .replace(/{{operationId}}/g, item.item.operationId)
-                .replace(/{{pathUrl}}/g, item.pathUrl)
-                .replace(/{{method}}/g, item.method);
-            actionsCode.push(code);
-        }
-        // Update code in app file
-        const indexFilePath = path_1.default.join(appFolderPath, language === constants_1.ProgrammingLanguage.JS ? "app.js" : "app.ts");
-        const indexFileContent = (await fs_extra_1.default.readFile(indexFilePath)).toString();
-        const updateIndexFileContent = indexFileContent
-            .replace("{{OPENAPI_SPEC_PATH}}", openapiSpecFileName)
-            .replace("// Replace with action code", actionsCode.join("\n"));
-        await fs_extra_1.default.writeFile(indexFilePath, updateIndexFileContent);
-    }
-    else if (language === constants_1.ProgrammingLanguage.PY) {
-        // Update code in bot.py
-        const actionsCode = [];
-        const codeTemplate = ActionCode["python"];
-        for (const item of specItems) {
-            const code = codeTemplate
-                .replace(/{{operationId}}/g, item.item.operationId)
-                .replace(/{{pathUrl}}/g, item.pathUrl)
-                .replace(/{{method}}/g, item.method);
-            actionsCode.push(code);
-        }
-        const botFilePath = path_1.default.join(destinationPath, "src", "bot.py");
-        const botFileContent = (await fs_extra_1.default.readFile(botFilePath)).toString();
-        const updateBotFileContent = botFileContent
-            .replace("{{OPENAPI_SPEC_PATH}}", openapiSpecFileName)
-            .replace("# Replace with action code", actionsCode.join("\n"));
-        await fs_extra_1.default.writeFile(botFilePath, updateBotFileContent);
-    }
-}
-async function updateForCustomApi(spec, language, destinationPath, openapiSpecFileName) {
-    const chatFolder = path_1.default.join(destinationPath, "src", "prompts", "chat");
-    await fs_extra_1.default.ensureDir(chatFolder);
-    // 1. update prompt folder
-    await updatePromptForCustomApi(spec, language, chatFolder);
-    const [specItems, needAuth] = parseSpec(spec);
-    // 2. update adaptive card folder
-    await updateAdaptiveCardForCustomApi(specItems, language, destinationPath);
-    // 3. update actions file
-    await updateActionForCustomApi(specItems, language, chatFolder);
-    // 4. update code
-    await updateCodeForCustomApi(specItems, language, destinationPath, openapiSpecFileName, needAuth);
-}
-exports.updateForCustomApi = updateForCustomApi;
-const EnvNameMapping = {
-    apiKey: "REGISTRATION_ID",
-    oauth2: "CONFIGURATION_ID",
-};
-function getEnvName(authName, authType) {
-    return m365_spec_parser_1.Utils.getSafeRegistrationIdEnvName(`${authName}_${EnvNameMapping[authType !== null && authType !== void 0 ? authType : "apiKey"]}`);
-}
-exports.getEnvName = getEnvName;
-//# sourceMappingURL=helper.js.map