From d0570dc4723714d1e5987e4110178ee390078da9 Mon Sep 17 00:00:00 2001 From: Masaharu Tashiro Date: Thu, 19 Dec 2024 13:59:04 +0900 Subject: [PATCH 1/6] feat(rest): add `@kintone/rest` package --- packages/rest/LICENSE | 201 ++++++++++++++++++ packages/rest/README.md | 22 ++ .../docs/migration-from-rest-api-client.md | 3 + packages/rest/package.json | 17 ++ pnpm-lock.yaml | 2 + 5 files changed, 245 insertions(+) create mode 100644 packages/rest/LICENSE create mode 100644 packages/rest/README.md create mode 100644 packages/rest/docs/migration-from-rest-api-client.md create mode 100644 packages/rest/package.json diff --git a/packages/rest/LICENSE b/packages/rest/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/packages/rest/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/rest/README.md b/packages/rest/README.md new file mode 100644 index 0000000000..1b09a2d065 --- /dev/null +++ b/packages/rest/README.md @@ -0,0 +1,22 @@ +# @kintone/rest + +[![npm version](https://badge.fury.io/js/@kintone%2Frest.svg)](https://badge.fury.io/js/@kintone%2Frest) +![Node.js version](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/kintone/js-sdk/main/packages/rest/package.json&label=node&query=$.engines.node&colorB=blue) +[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-yellow.svg)](LICENSE) + +> kintone REST API client for JavaScript + +> [!WARNING] +> Experimental: This package is still under early development. + +## Migration + +See [Migration Guide](docs/migration-from-rest-api-client.md) + +## Usage + +TODO + +## License + +- [Apache 2.0](LICENSE) diff --git a/packages/rest/docs/migration-from-rest-api-client.md b/packages/rest/docs/migration-from-rest-api-client.md new file mode 100644 index 0000000000..0cd9478c1a --- /dev/null +++ b/packages/rest/docs/migration-from-rest-api-client.md @@ -0,0 +1,3 @@ +# Migration from @kintone/rest-api-client + +TODO diff --git a/packages/rest/package.json b/packages/rest/package.json new file mode 100644 index 0000000000..86f3945a95 --- /dev/null +++ b/packages/rest/package.json @@ -0,0 +1,17 @@ +{ + "name": "@kintone/rest", + "version": "0.0.0", + "description": "", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "keywords": [ + "kintone" + ], + "author": { + "name": "Cybozu, Inc.", + "url": "https://cybozu.co.jp" + }, + "license": "Apache-2.0" +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index adc982fa1c..6b68857408 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -395,6 +395,8 @@ importers: specifier: ^3.0.0 version: 3.0.0 + packages/rest: {} + packages/rest-api-client: dependencies: axios: From a17272cdcff14aa8a606e7c44c884fe050dbd742 Mon Sep 17 00:00:00 2001 From: shabaraba Date: Wed, 8 Jan 2025 16:21:19 +0900 Subject: [PATCH 2/6] feat(rest): add README.md --- packages/rest/README.md | 80 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 78 insertions(+), 2 deletions(-) diff --git a/packages/rest/README.md b/packages/rest/README.md index 1b09a2d065..c3a79a179f 100644 --- a/packages/rest/README.md +++ b/packages/rest/README.md @@ -4,19 +4,95 @@ ![Node.js version](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/kintone/js-sdk/main/packages/rest/package.json&label=node&query=$.engines.node&colorB=blue) [![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-yellow.svg)](LICENSE) -> kintone REST API client for JavaScript +kintone REST API client for JavaScript and TypeScript generated by [openapi-typescript](https://github.com/openapi-ts/openapi-typescript). > [!WARNING] > Experimental: This package is still under early development. +- [Migration](#migration) +- [Installation](#installation) +- [Usage](#usage) +- [References](#references) +- [Contribution Guide](#contribution-guide) +- [License](#license) + ## Migration See [Migration Guide](docs/migration-from-rest-api-client.md) -## Usage +## Installation + +This library is distributed on `npm`. + +```shell +npm install @kintone/rest +``` + +You can then use `require` or `import` to import the library. + +```javascript +// CommonJS +const { createClient } = require("@kintone/rest"); +// ES modules +import { createClient } from "@kintone/rest"; +``` + +```ts +import { createClient, paths } from "@kintone/rest"; +``` + +## Browser support TODO +## Usage + +Here is a sample code that retrieves app records. + +```ts +import { createClient, paths } from "@kintone/rest"; + +const client = createClient({ + baseUrl: "https://example.cybozu.com", + headers: { + "X-Cybozu-Authorization": procecc.env.KINTONE_AUTHORIZATION, + // Use API token authentication + // auth: { apiToken: process.env.KINTONE_API_TOKEN } + // "X-Cybozu-API-Token": procecc.env.KINTONE_AUTHORIZATION, + // Use OAuth token authentication + // "Authorization: `Basic ${process.env.KINTONE_OAUTH_TOKEN}`, + }, +}); + +try { + const resp = await client.GET("/k/v1/records.json", { + params: { + query: { app: 1 }, + }, + }); + console.log(resp.data?.records); +} catch (e) { + console.error(e); +} +``` + +When you use JavScript, the Client can be created as follows: + +```js +import { createClient } from "@kintone/rest"; + +const client = createClient({ + baseUrl: "https://example.cybozu.com", + headers: { + "X-Cybozu-Authorization": procecc.env.KINTONE_AUTHORIZATION, + }, +}); +``` + +## Contribution Guide + +See [CONTRIBUTING.md](https://github.com/kintone/js-sdk/tree/main/CONTRIBUTING.md) + ## License - [Apache 2.0](LICENSE) From 1cd438c43ed7fa3fa5c6d9d5656d2f2ccc7d7b7d Mon Sep 17 00:00:00 2001 From: shabaraba Date: Tue, 14 Jan 2025 09:49:27 +0900 Subject: [PATCH 3/6] chore(rest): add engines field to package.json --- packages/rest/package.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/rest/package.json b/packages/rest/package.json index 86f3945a95..df7c5605d7 100644 --- a/packages/rest/package.json +++ b/packages/rest/package.json @@ -9,6 +9,9 @@ "keywords": [ "kintone" ], + "engines": { + "node": ">=18" + }, "author": { "name": "Cybozu, Inc.", "url": "https://cybozu.co.jp" From d885dbd33ee4a420cb7e504d25d5791c292a6fa0 Mon Sep 17 00:00:00 2001 From: shabaraba Date: Tue, 14 Jan 2025 15:21:04 +0900 Subject: [PATCH 4/6] chore(rest): fix in README.md --- packages/rest/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/rest/README.md b/packages/rest/README.md index c3a79a179f..9eb1eb9e49 100644 --- a/packages/rest/README.md +++ b/packages/rest/README.md @@ -57,8 +57,7 @@ const client = createClient({ headers: { "X-Cybozu-Authorization": procecc.env.KINTONE_AUTHORIZATION, // Use API token authentication - // auth: { apiToken: process.env.KINTONE_API_TOKEN } - // "X-Cybozu-API-Token": procecc.env.KINTONE_AUTHORIZATION, + // "X-Cybozu-API-Token": procecc.env.KINTONE_API_TOKEN, // Use OAuth token authentication // "Authorization: `Basic ${process.env.KINTONE_OAUTH_TOKEN}`, }, From 72cacced75193c162a70c2afcb53db65998c14f3 Mon Sep 17 00:00:00 2001 From: shabaraba Date: Tue, 14 Jan 2025 15:51:03 +0900 Subject: [PATCH 5/6] chore(rest): fix typo in README.md --- packages/rest/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/rest/README.md b/packages/rest/README.md index 9eb1eb9e49..3aeeac9c0d 100644 --- a/packages/rest/README.md +++ b/packages/rest/README.md @@ -55,9 +55,9 @@ import { createClient, paths } from "@kintone/rest"; const client = createClient({ baseUrl: "https://example.cybozu.com", headers: { - "X-Cybozu-Authorization": procecc.env.KINTONE_AUTHORIZATION, + "X-Cybozu-Authorization": process.env.KINTONE_AUTHORIZATION, // Use API token authentication - // "X-Cybozu-API-Token": procecc.env.KINTONE_API_TOKEN, + // "X-Cybozu-API-Token": process.env.KINTONE_API_TOKEN, // Use OAuth token authentication // "Authorization: `Basic ${process.env.KINTONE_OAUTH_TOKEN}`, }, @@ -83,7 +83,7 @@ import { createClient } from "@kintone/rest"; const client = createClient({ baseUrl: "https://example.cybozu.com", headers: { - "X-Cybozu-Authorization": procecc.env.KINTONE_AUTHORIZATION, + "X-Cybozu-Authorization": process.env.KINTONE_AUTHORIZATION, }, }); ``` From 4ff5a25ba6a7a681bdd31a57e6edd9080f74faa6 Mon Sep 17 00:00:00 2001 From: shabaraba Date: Fri, 17 Jan 2025 17:08:23 +0900 Subject: [PATCH 6/6] chore(rest): add migration guide --- .../docs/migration-from-rest-api-client.md | 147 +++++++++++++++++- 1 file changed, 146 insertions(+), 1 deletion(-) diff --git a/packages/rest/docs/migration-from-rest-api-client.md b/packages/rest/docs/migration-from-rest-api-client.md index 0cd9478c1a..e7c62a5a8f 100644 --- a/packages/rest/docs/migration-from-rest-api-client.md +++ b/packages/rest/docs/migration-from-rest-api-client.md @@ -1,3 +1,148 @@ # Migration from @kintone/rest-api-client -TODO +This topic provides instructions for migrating from `@kintone/rest-api-client` to `@kintone/rest`. + +`@kintone/rest-api-client`は手作業でメソッドを開発していたのに対して、`@kintone/rest`は`openapi-ts/openapi-typescript`で自動生成しています。 +これにより、常に最新のREST APIを`js-sdk`で利用することができます。 + +## Installation + +```bash +npm install @kintone/rest +``` + +## Migration + +### client + +`@kintone/rest-api-client`では、以下のようにclientを作成していました。 + +```ts +[import](2025-01-17_import.md) { KintoneRestAPIClient } from "@kintone/rest-api-client"; + +const client = new KintoneRestAPIClient({ + baseUrl: "https://example.cybozu.com", + // Use password authentication + auth: { + username: process.env.KINTONE_USERNAME, + password: process.env.KINTONE_PASSWORD, + }, +}); +``` + +`@kintone/rest`では、以下のようにclientを作成します。 +`auth`を引数に取るのではなく、直接`headers`に設定します。 + +```ts +import { createClient, paths } from "@kintone/rest"; + +const client = createClient({ + baseUrl: "https://example.cybozu.com", + headers: { + "X-Cybozu-Authorization": process.env.KINTONE_AUTHORIZATION, +``` + +JavaScriptの場合は、以下のようになります。 + +```js +import { createClient } from "@kintone/rest"; + +const client = createClient({ + baseUrl: "https://example.cybozu.com", + headers: { + "X-Cybozu-Authorization": process.env.KINTONE_AUTHORIZATION, + }, +}); +``` + +### call API + +`@kintone/rest-api-client`では、`client`インスタンスのメソッドとして提供されていました。 + +```ts +client.record + .getRecords({ app: "1" }) + .then((resp) => { + console.log(resp.records); + }) + .catch((err) => { + console.log(err); + }); +``` + +一方で`openapi-ts/openapi-typescript`で生成された`@kintone/rest`は、REST APIのパスを関数として提供します。 +APIのパスやリクエストなどの詳細は[仕様書](https://kintone.dev/en/)を参照ください。 + +#### guest space + +`@kintone/rest-api-client`では、guest space用のクライアントを作成していました + +```ts +const client = createClient({ + baseUrl: "https://example.cybozu.com", + headers: { + "X-Cybozu-Authorization": process.env.KINTONE_AUTHORIZATION, + }, + guestSpaceId: 1, +}); +const getRecordsResponse = await client.record.getRecords({ app: "1" })); +``` + +`@kintone/rest`では、ゲストスペース用のエンドポイントを`path`に指定します。 + +```ts +const client = createClient({ + baseUrl: "https://example.cybozu.com", + headers: { + "X-Cybozu-Authorization": process.env.KINTONE_AUTHORIZATION, + }, +}); + +const getRecordsResponse = await client.GET("/k/guest/1/v1/records.json", { + params: { + query: { app: 1 }, + }, +}); +``` + +#### preview app + +`@kintone/rest-api-client`では、デプロイ前のアプリに対する操作は、メソッド引数に`preview: true`を指定することで行っていました。 + +```ts +const client = createClient({ + baseUrl: "https://example.cybozu.com", + headers: { + "X-Cybozu-Authorization": process.env.KINTONE_AUTHORIZATION, + }, +}); +const getAppAcl = await client.app.getAppAcl({ app: "1", preview: true })); +``` + +`@kintone/rest`では、preview用のエンドポイントを`path`に指定します。 + +```ts +const client = createClient({ + baseUrl: "https://example.cybozu.com", + headers: { + "X-Cybozu-Authorization": process.env.KINTONE_AUTHORIZATION, + }, +}); + +const getAppAclResponse = await client.GET("/k/v1/preview/app/acl.json", { + params: { + query: { app: 1 }, + }, +}); +``` + +### できないこと + +`@kintone/rest-api-client`では、以下のような機能が提供されていましたが、`@kintone/rest`では提供していません。 + +- ブラウザでのセッション認証 +- proxy +- clientCertAuth +- httpAgent +- featureFlags +- socketTimeout