refactor: rename apiPlugin to plugin (#11011)

* refactor: rename apiPlugin to plugin * refactor: minor * refactor: rename
OfficeDev · Mar 8, 2024 · e3ec125 · e3ec125
1 parent 4c89d70
commit e3ec125
Show file tree

Hide file tree

Showing 16 changed files with 44 additions and 48 deletions.
diff --git a/packages/fx-core/src/component/driver/teamsApp/createAppPackage.ts b/packages/fx-core/src/component/driver/teamsApp/createAppPackage.ts
@@ -221,17 +221,13 @@ export class CreateAppPackageDriver implements StepDriver {
     }
 
     // API plugin
-    if (
-      manifest.apiPlugins &&
-      manifest.apiPlugins.length > 0 &&
-      manifest.apiPlugins[0].pluginFile
-    ) {
-      const pluginFile = path.resolve(appDirectory, manifest.apiPlugins[0].pluginFile);
+    if (manifest.plugins && manifest.plugins.length > 0 && manifest.plugins[0].pluginFile) {
+      const pluginFile = path.resolve(appDirectory, manifest.plugins[0].pluginFile);
       const checkExistenceRes = await this.validateReferencedFile(pluginFile, appDirectory);
       if (checkExistenceRes.isErr()) {
         return err(checkExistenceRes.error);
       }
-      const dir = path.dirname(manifest.apiPlugins[0].pluginFile);
+      const dir = path.dirname(manifest.plugins[0].pluginFile);
       this.addFileInZip(zip, dir, pluginFile);
 
       const addFilesRes = await this.addPluginRelatedFiles(zip, pluginFile, appDirectory);

diff --git a/packages/fx-core/src/component/driver/teamsApp/utils/ManifestUtils.ts b/packages/fx-core/src/component/driver/teamsApp/utils/ManifestUtils.ts
@@ -286,7 +286,7 @@ export class ManifestUtils {
     manifest: TeamsAppManifest,
     manifestPath: string
   ): Promise<Result<string, FxError>> {
-    const pluginFile = manifest.apiPlugins?.[0]?.pluginFile;
+    const pluginFile = manifest.plugins?.[0]?.pluginFile;
     if (pluginFile) {
       const plugin = path.resolve(path.dirname(manifestPath), pluginFile);
       const doesFileExist = await fs.pathExists(plugin);

diff --git a/packages/fx-core/src/component/generator/copilotPlugin/generator.ts b/packages/fx-core/src/component/generator/copilotPlugin/generator.ts
@@ -187,15 +187,15 @@ export class CopilotPluginGenerator {
     destinationPath: string,
     templateName: string,
     componentName: string,
-    isApiPlugin: boolean,
+    isPlugin: boolean,
     apiKeyAuthData?: ApiKeyAuthInfo
   ): Promise<Result<CopilotPluginGeneratorResult, FxError>> {
     try {
       const appName = inputs[QuestionNames.AppName];
       const language = inputs[QuestionNames.ProgrammingLanguage];
       const safeProjectNameFromVS =
         language === "csharp" ? inputs[QuestionNames.SafeProjectName] : undefined;
-      const type = isApiPlugin ? GenerateType.ApiPlugin : GenerateType.ME;
+      const type = isPlugin ? GenerateType.ApiPlugin : GenerateType.ME;
 
       const manifestPath = path.join(
         destinationPath,

diff --git a/packages/fx-core/src/question/create.ts b/packages/fx-core/src/question/create.ts
@@ -1853,7 +1853,7 @@ export function apiOperationQuestion(includeExistingAPIs = true): MultiSelectQue
   // export for unit test
   let placeholder = "";
 
-  const isApiPlugin = (inputs?: Inputs): boolean => {
+  const isPlugin = (inputs?: Inputs): boolean => {
     return (
       !!inputs && inputs[QuestionNames.Capabilities] === CapabilityOptions.copilotPluginApiSpec().id
     );
@@ -1863,20 +1863,20 @@ export function apiOperationQuestion(includeExistingAPIs = true): MultiSelectQue
     type: "multiSelect",
     name: QuestionNames.ApiOperation,
     title: (inputs: Inputs) => {
-      return isApiPlugin(inputs)
+      return isPlugin(inputs)
         ? getLocalizedString("core.createProjectQuestion.apiSpec.copilotOperation.title")
         : getLocalizedString("core.createProjectQuestion.apiSpec.operation.title");
     },
     cliDescription: "Select Operation(s) Teams Can Interact with.",
     cliShortName: "o",
     placeholder: (inputs: Inputs) => {
-      const isApiPlugin =
+      const isPlugin =
         inputs[QuestionNames.Capabilities] === CapabilityOptions.copilotPluginApiSpec().id;
       if (!includeExistingAPIs) {
         placeholder = getLocalizedString(
           "core.createProjectQuestion.apiSpec.operation.placeholder.skipExisting"
         );
-      } else if (isApiPlugin) {
+      } else if (isPlugin) {
         placeholder = ""; // TODO: add placeholder for api plugin
       } else if (isApiKeyEnabled()) {
         placeholder = getLocalizedString(

diff --git a/packages/fx-core/tests/component/driver/teamsApp/createAppPackage.test.ts b/packages/fx-core/tests/component/driver/teamsApp/createAppPackage.test.ts
@@ -211,7 +211,7 @@ describe("teamsApp/createAppPackage", async () => {
       });
 
       const manifest = new TeamsAppManifest();
-      manifest.apiPlugins = [
+      manifest.plugins = [
         {
           pluginFile: "plugin.json",
         },
@@ -247,7 +247,7 @@ describe("teamsApp/createAppPackage", async () => {
       });
 
       const manifest = new TeamsAppManifest();
-      manifest.apiPlugins = [
+      manifest.plugins = [
         {
           pluginFile: "resources/ai-plugin.json",
         },
@@ -278,7 +278,7 @@ describe("teamsApp/createAppPackage", async () => {
       sinon.stub(fs, "readJSON").throws(new Error("fake error"));
 
       const manifest = new TeamsAppManifest();
-      manifest.apiPlugins = [
+      manifest.plugins = [
         {
           pluginFile: "resources/ai-plugin.json",
         },
@@ -590,7 +590,7 @@ describe("teamsApp/createAppPackage", async () => {
     };
 
     const manifest = new TeamsAppManifest();
-    manifest.apiPlugins = [
+    manifest.plugins = [
       {
         pluginFile: "resources/ai-plugin.json",
       },

diff --git a/packages/fx-core/tests/component/driver/teamsApp/pluginManifestUtils.test.ts b/packages/fx-core/tests/component/driver/teamsApp/pluginManifestUtils.test.ts
@@ -71,7 +71,7 @@ describe("pluginManifestUtils", () => {
     staticTabs: [],
     permissions: [],
     validDomains: [],
-    apiPlugins: [
+    plugins: [
       {
         pluginFile: "resources/plugin.json",
       },
@@ -190,7 +190,7 @@ describe("pluginManifestUtils", () => {
     sandbox.stub(fs, "pathExists").resolves(true);
 
     const res = await pluginManifestUtils.getApiSpecFilePathFromTeamsManifest(
-      { ...teamsManifest, apiPlugins: [] },
+      { ...teamsManifest, plugins: [] },
       "/test/path"
     );
     chai.assert.isTrue(res.isErr());

diff --git a/packages/fx-core/tests/component/generator/copilotPluginGenerator.test.ts b/packages/fx-core/tests/component/generator/copilotPluginGenerator.test.ts
@@ -896,7 +896,7 @@ describe("formatValidationErrors", () => {
 describe("listPluginExistingOperations", () => {
   const teamsManifestWithPlugin: TeamsAppManifest = {
     ...teamsManifest,
-    apiPlugins: [
+    plugins: [
       {
         pluginFile: "resources/plugin.json",
       },

diff --git a/packages/fx-core/tests/core/FxCore.test.ts b/packages/fx-core/tests/core/FxCore.test.ts
@@ -1668,7 +1668,7 @@ describe("copilotPlugin", async () => {
       projectPath: path.join(os.tmpdir(), appName),
     };
     const manifest = new TeamsAppManifest();
-    manifest.apiPlugins = [
+    manifest.plugins = [
       {
         pluginFile: "ai-plugin.json",
       },
@@ -1705,7 +1705,7 @@ describe("copilotPlugin", async () => {
       projectPath: path.join(os.tmpdir(), appName),
     };
     const manifest = new TeamsAppManifest();
-    manifest.apiPlugins = [
+    manifest.plugins = [
       {
         pluginFile: "ai-plugin.json",
       },

diff --git a/packages/manifest/src/ManifestCommonProperties.ts b/packages/manifest/src/ManifestCommonProperties.ts
@@ -29,5 +29,5 @@ export interface ManifestCommonProperties {
   /**
    * Whether it's an API plugin
    */
-  isApiPlugin: boolean;
+  isPlugin: boolean;
 }
diff --git a/packages/manifest/src/index.ts b/packages/manifest/src/index.ts
@@ -134,7 +134,7 @@ export class ManifestUtil {
       manifestVersion: manifest.manifestVersion,
       isApiME: false,
       isSPFx: false,
-      isApiPlugin: false,
+      isPlugin: false,
     };
 
     // If it's copilot plugin app
@@ -155,10 +155,10 @@ export class ManifestUtil {
       properties.isSPFx = true;
     }
 
-    if ((manifest as TeamsAppManifest).apiPlugins) {
-      const apiPlugins = (manifest as TeamsAppManifest).apiPlugins;
+    if ((manifest as TeamsAppManifest).plugins) {
+      const apiPlugins = (manifest as TeamsAppManifest).plugins;
       if (apiPlugins && apiPlugins.length > 0 && apiPlugins[0].pluginFile)
-        properties.isApiPlugin = true;
+        properties.isPlugin = true;
     }
 
     return properties;

diff --git a/packages/manifest/src/manifest.ts b/packages/manifest/src/manifest.ts
@@ -360,7 +360,7 @@ export interface ITogetherModeScene {
   seatsReservedForOrganizersOrPresenters: number;
 }
 
-export interface IApiPlugin {
+export interface IPlugin {
   pluginFile: string;
 }
 
@@ -541,7 +541,7 @@ export class TeamsAppManifest implements AppManifest {
     };
   };
   /**
-   * Pointer to Plugin manifest.
+   * Pointer to plugin manifest.
    */
-  apiPlugins?: IApiPlugin[];
+  plugins?: IPlugin[];
 }
diff --git a/packages/spec-parser/src/manifestUpdater.ts b/packages/spec-parser/src/manifestUpdater.ts
@@ -28,7 +28,7 @@ export class ManifestUpdater {
   ): Promise<[TeamsAppManifest, PluginManifestSchema]> {
     const manifest: TeamsAppManifest = await fs.readJSON(manifestPath);
     const apiPluginRelativePath = ManifestUpdater.getRelativePath(manifestPath, apiPluginFilePath);
-    manifest.apiPlugins = [
+    manifest.plugins = [
       {
         pluginFile: apiPluginRelativePath,
       },

diff --git a/packages/spec-parser/test/manifestUpdater.test.ts b/packages/spec-parser/test/manifestUpdater.test.ts
@@ -83,14 +83,14 @@ describe("updateManifestWithAiPlugin", () => {
     const expectedManifest = {
       name: { short: "Original Name", full: "Original Full Name" },
       description: { short: "My API", full: "My API description" },
-      apiPlugins: [
+      plugins: [
         {
           pluginFile: "ai-plugin.json",
         },
       ],
     };
 
-    const expectedApiPlugins: PluginManifestSchema = {
+    const expectedPlugins: PluginManifestSchema = {
       schema_version: "v2",
       name_for_human: "My API",
       description_for_human: "My API description",
@@ -147,7 +147,7 @@ describe("updateManifestWithAiPlugin", () => {
     );
 
     expect(manifest).to.deep.equal(expectedManifest);
-    expect(apiPlugin).to.deep.equal(expectedApiPlugins);
+    expect(apiPlugin).to.deep.equal(expectedPlugins);
   });
 
   it("should update the manifest with the correct manifest and apiPlugin files with optional parameters", async () => {
@@ -221,14 +221,14 @@ describe("updateManifestWithAiPlugin", () => {
     const expectedManifest = {
       name: { short: "Original Name", full: "Original Full Name" },
       description: { short: "My API", full: "My API description" },
-      apiPlugins: [
+      plugins: [
         {
           pluginFile: "ai-plugin.json",
         },
       ],
     };
 
-    const expectedApiPlugins: PluginManifestSchema = {
+    const expectedPlugins: PluginManifestSchema = {
       schema_version: "v2",
       name_for_human: "My API",
       description_for_human: "My API description",
@@ -289,7 +289,7 @@ describe("updateManifestWithAiPlugin", () => {
     );
 
     expect(manifest).to.deep.equal(expectedManifest);
-    expect(apiPlugin).to.deep.equal(expectedApiPlugins);
+    expect(apiPlugin).to.deep.equal(expectedPlugins);
   });
 
   it("should generate default ai plugin file if no api", async () => {
@@ -318,14 +318,14 @@ describe("updateManifestWithAiPlugin", () => {
     const expectedManifest = {
       name: { short: "Original Name", full: "Original Full Name" },
       description: { short: "My API", full: "My API description" },
-      apiPlugins: [
+      plugins: [
         {
           pluginFile: "ai-plugin.json",
         },
       ],
     };
 
-    const expectedApiPlugins: PluginManifestSchema = {
+    const expectedPlugins: PluginManifestSchema = {
       schema_version: "v2",
       name_for_human: "My API",
       description_for_human: "My API description",
@@ -353,7 +353,7 @@ describe("updateManifestWithAiPlugin", () => {
     );
 
     expect(manifest).to.deep.equal(expectedManifest);
-    expect(apiPlugin).to.deep.equal(expectedApiPlugins);
+    expect(apiPlugin).to.deep.equal(expectedPlugins);
   });
 
   it("should truncate if title is long", async () => {
@@ -425,14 +425,14 @@ describe("updateManifestWithAiPlugin", () => {
         short: "long title long title long title long title long title long title long title lon",
         full: "This is the description",
       },
-      apiPlugins: [
+      plugins: [
         {
           pluginFile: "ai-plugin.json",
         },
       ],
     };
 
-    const expectedApiPlugins: PluginManifestSchema = {
+    const expectedPlugins: PluginManifestSchema = {
       schema_version: "v2",
       name_for_human:
         "long title long title long title long title long title long title long title long title long title long title long title long title",
@@ -490,7 +490,7 @@ describe("updateManifestWithAiPlugin", () => {
     );
 
     expect(manifest).to.deep.equal(expectedManifest);
-    expect(apiPlugin).to.deep.equal(expectedApiPlugins);
+    expect(apiPlugin).to.deep.equal(expectedPlugins);
   });
 
   it("should throw error if has nested object property", async () => {

diff --git a/packages/vscode-extension/src/codeLensProvider.ts b/packages/vscode-extension/src/codeLensProvider.ts
@@ -568,7 +568,7 @@ export class ApiPluginCodeLensProvider implements vscode.CodeLensProvider {
       const manifestContent = fs.readFileSync(manifestFilePath, "utf-8");
       const manifest = JSON.parse(manifestContent);
       const manifestProperties = ManifestUtil.parseCommonProperties(manifest);
-      if (!manifestProperties.isApiPlugin) {
+      if (!manifestProperties.isPlugin) {
         return [];
       }
 

diff --git a/packages/vscode-extension/test/extension/codeLensProvider.test.ts b/packages/vscode-extension/test/extension/codeLensProvider.test.ts
@@ -323,7 +323,7 @@ describe("Api plugin CodeLensProvider", () => {
 
   it("Add API", async () => {
     const manifest = new TeamsAppManifest();
-    manifest.apiPlugins = [
+    manifest.plugins = [
       {
         pluginFile: "test.json",
       },
@@ -433,7 +433,7 @@ describe("Api plugin CodeLensProvider", () => {
 
   it("Do not show codelens for if not API plugin project", async () => {
     const manifest = new TeamsAppManifest();
-    manifest.apiPlugins = [];
+    manifest.plugins = [];
     const openApiObject = {
       openapi: "3.0",
     };

diff --git a/packages/vscode-extension/test/extension/handlers.test.ts b/packages/vscode-extension/test/extension/handlers.test.ts
@@ -2484,7 +2484,7 @@ describe("autoOpenProjectHandler", () => {
       isApiME: true,
       isSPFx: false,
       isApiBasedMe: true,
-      isApiPlugin: false,
+      isPlugin: false,
     };
     const parseManifestStub = sandbox.stub(ManifestUtil, "parseCommonProperties").returns(parseRes);
     VsCodeLogInstance.outputChannel = {