Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(rest-api-client): add method of plugin.installPlugin #2931

Merged
merged 1 commit into from
Aug 15, 2024

Conversation

chihiro-adachi
Copy link
Contributor

@chihiro-adachi chihiro-adachi commented Aug 15, 2024

Why

  • Support plugin.installPlugin method to be able to install an imported plug-in in the Kintone environment.

What

  • Add a document for the new method.
  • Add new unit tests.

How to test

  1. prepare a zip file for a plug-in and upload it in Kintone.
  2. run below code and check logs:
import {KintoneRestAPIClient} from '@kintone/rest-api-client';

const client = new KintoneRestAPIClient();

const fileKey = (await client.file.uploadFile({
  file: {
    path: "./files/plugin.zip"
  }
})).fileKey;

if (typeof fileKey == "string") {
  console.log(await client.plugin.installPlugin({fileKey: fileKey}));
}

Checklist

  • Read CONTRIBUTING.md
  • Updated documentation if it is required.
  • Added tests if it is required.
  • Passed pnpm lint and pnpm test on the root directory.

@github-actions github-actions bot added the pkg: rest-api-client @kintone/rest-api-client label Aug 15, 2024
@chihiro-adachi chihiro-adachi force-pushed the feat/add-method-plugin-installPlugin branch from cb34b33 to 48b423a Compare August 15, 2024 06:28
@chihiro-adachi chihiro-adachi force-pushed the feat/add-method-plugin-installPlugin branch from 48b423a to c54e519 Compare August 15, 2024 07:16
@chihiro-adachi chihiro-adachi marked this pull request as ready for review August 15, 2024 07:20
Copy link
Member

@tasshi-me tasshi-me left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTMです!!!

@hisasami hisasami merged commit 510a580 into main Aug 15, 2024
17 checks passed
@hisasami hisasami deleted the feat/add-method-plugin-installPlugin branch August 15, 2024 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: rest-api-client @kintone/rest-api-client
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants