feat(rest-api-client): add plugin.getPlugins method

packages/rest-api-client/src/KintoneRestAPIClient.ts

@@ -4,6 +4,7 @@ import { AppClient } from "./client/AppClient";
 import { RecordClient } from "./client/RecordClient";
 import { SpaceClient } from "./client/SpaceClient";
 import { FileClient } from "./client/FileClient";
+import { PluginClient } from "./client/PluginClient";
 import { DefaultHttpClient } from "./http/";
 import type { ProxyConfig } from "./http/HttpClientInterface";
 import type { BasicAuth, DiscriminatedAuth } from "./types/auth";
@@ -66,6 +67,7 @@ export class KintoneRestAPIClient {
   app: AppClient;
   space: SpaceClient;
   file: FileClient;
+  plugin: PluginClient;
   private bulkRequest_: BulkRequestClient;
   private baseUrl?: string;
 
@@ -97,6 +99,7 @@ export class KintoneRestAPIClient {
     this.app = new AppClient(httpClient, guestSpaceId);
     this.space = new SpaceClient(httpClient, guestSpaceId);
     this.file = new FileClient(httpClient, guestSpaceId);
+    this.plugin = new PluginClient(httpClient);
   }
 
   public static get version() {

packages/rest-api-client/src/client/PluginClient.ts

@@ -0,0 +1,14 @@
+import { BaseClient } from "./BaseClient";
+import type {
+  GetPluginsForRequest,
+  GetPluginsForResponse,
+} from "./types/plugin";
+
+export class PluginClient extends BaseClient {
+  public getPlugins(
+    params: GetPluginsForRequest,
+  ): Promise<GetPluginsForResponse> {
+    const path = this.buildPath({ endpointName: "plugins" });
+    return this.client.get(path, params);
+  }
+}

packages/rest-api-client/src/client/__tests__/PluginClient.test.ts

@@ -0,0 +1,37 @@
+import type { MockClient } from "../../http/MockClient";
+import { buildMockClient } from "../../http/MockClient";
+import { KintoneRequestConfigBuilder } from "../../KintoneRequestConfigBuilder";
+import { PluginClient } from "../PluginClient";
+
+describe("PluginClient", () => {
+  let mockClient: MockClient;
+  let pluginClient: PluginClient;
+
+  beforeEach(() => {
+    const requestConfigBuilder = new KintoneRequestConfigBuilder({
+      baseUrl: "https://example.cybozu.com",
+      auth: { type: "apiToken", apiToken: "foo" },
+    });
+    mockClient = buildMockClient(requestConfigBuilder);
+    pluginClient = new PluginClient(mockClient);
+  });
+
+  describe("getPlugins", () => {
+    const params = {
+      offset: 1,
+      limit: 2,
+    };
+    beforeEach(async () => {
+      await pluginClient.getPlugins(params);
+    });
+    it("should pass the path to the http client", () => {
+      expect(mockClient.getLogs()[0].path).toBe("/k/v1/plugins.json");
+    });
+    it("should send a GET request", () => {
+      expect(mockClient.getLogs()[0].method).toBe("get");
+    });
+    it("should pass the param to the http client", () => {
+      expect(mockClient.getLogs()[0].params).toEqual(params);
+    });
+  });
+});

packages/rest-api-client/src/client/types/plugin/index.ts

@@ -0,0 +1,15 @@
+type Plugin = {
+  id: string;
+  name: string;
+  isMarketPlugin: boolean;
+  revision: string;
+};
+
+export type GetPluginsForRequest = {
+  offset?: number;
+  limit?: number;
+};
+
+export type GetPluginsForResponse = {
+  plugins: Plugin[];
+};