https://www.typescriptlang.org/docs/handbook/project-references.html

Currently, we compile TypeScript each package separately, which is not a problem now, but it might be a problem in the future we've had many packages in this repository.

I guess that TypeScript Project References solves the problem., so it's great to investigate it.

Target Package

• @kintone/[email protected]

Environment

• Operating System: macOS Big Sur 11.2.3
• Browser: Google Chrome : 90.0.4430.212（x86_64）
• Node.js version: v14.12.0

Current Behavior

Recently, You have updated Axios version to "^0.21.0".
It cause that request body byte size has been limited.
I think that limited 10MB. it's axios default limit

Expected Behavior

I think you know solution.
You have wrote note. and useful configuration statement has commentouted.
// maxBodyLength: Infinity,
https://github.com/kintone/js-sdk/blob/master/packages/rest-api-client/src/http/AxiosClient.ts#L88-L93

I think that the option parameter is necessary to use current version Axios.
Or We need A way to set maxBodyLengh parameter.

Please tell me any opinion.

Currently, Renovate doesn't seem to manage dependencies of packages in examples directory.
For example, this PR should update ts-node in rest-api-client-demo as well.
#211

ref. #66

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Cannot find preset's package (prConcurrentLimitNone)

Target Package

• @kintone/customize-uploader 4.0.9

Environment

• Operating System: macOS 10.15.7
• Browser: N.A.
• Node.js version: v14.16.1

Current Behavior

It looks like --proxy option is not passed to api client.

Expected Behavior

--proxy option works correctly

Motivation

The current limitation of updateRecords (limited until 100 records) is inconvenient so we'd like to add a method to be able to exceed the limitation.

Overview

This method is to be able to update over 100 records to an app.
Here is the interface we plan.

const results = await this.client.record.updateAllRecords({
  app: APP_ID,
  records
});

ref. kintone/js-sdk-ja#8

We should support the way of recognizing if the request fails due to network timeout.

Motivation

We'd like to support the situation that we add a record but update an existing record if the record has already been registered.

Overview

This method updates or inserts details of 1 record in an app. this updates a record if the unique key specifying by uniqueKey has matched any record, otherwise inserts a record.

const result = await this.client.record.upsertRecord({
  app: APP_ID,
  updateKey: {
    field,
    value,
  },
  record,
})

rest-api-client has a scripts directory that has scripts that are for testing and examples.
Currently, there are dependencies and npm-scripts only for the scripts in rest-api-client package.

I think it would be nice if the scripts are placed as a separate package.
It isn't an npm package, so it would be nice if the package is put into like examples/.

This behavior is related to #855, but still occurs even after merging #855.

Target Package

• @kintone/rest-api-client (all versions)

Environment

• React Native (We confirmed the behavior with Expo Go)

Current Behavior

• Create a React Native project with expo-cli

$ npm install --global expo-cli
$ expo init my-project

• Install the latest @kintone/rest-api-client

$ npm install @kintone/rest-api-client

• Modify App.tsx to create KintoneRestAPIClient without baseUrl

 import React from 'react';
 import { StyleSheet, Text, View } from 'react-native';

+import { KintoneRestAPIClient } from "@kintone/rest-api-client";
+
 export default function App() {
+  const client = new KintoneRestAPIClient();
+
   return (
     <View style={styles.container}>
       <Text>Open up App.tsx to start working on your app!</Text>

• Run npm start and open the app with Expo Go (in iPhone or Android phone)

Then an error occurs.

ReferenceError: Can't find variable: location

Expected Behavior

It would be nice if we can see more helpful error message.
(For example, "In this environment, `baseUrl` is required" )

Motivation

Currently, file.uploadFile() supports only file data and we can't pass its path.
It would be more convenient if it also accepts the path of the file.

NOTE: This feature is available only in Node.js environment.

Overview

// We haven't fixed the interface yet.
const client = new KintoneRestAPIClient({ ... });
const result = await this.client.file.uploadFile({
  file: 'PATH_TO_FILE' // or separate parameter name?
})

Target Package

• @kintone/customize-uploader 3.1.9

Environment

• Operating System: Windows 10
• Browser:
• Node.js version: v14.16.0

Current Behavior

Option "guest-space-id" does not work when I use @kintone/customize-uploader to upload JS file to a guest space app.

Preparation: A guest space, and an app in this space

Steps to reproduce:

1. Install @kintone/customize-uploader.
2. Create a JS file.
3. Use command with "guest-space-id" option to upload the JS file to the guest space app.
   -> Failed to update customize setting and error occurs

E:\github.com\kintone\test>npx kintone-customize-uploader .\dest\customize-manifest.json --guest-space-id 5
? Input your kintone's base URL (https://example.cybozu.com): https://ldong.cybozu.com
? Input your username: test
? Input your password: [hidden]
Start uploading customization files
dest/test.js has been uploaded!
JavaScript/CSS files have been uploaded!
Failed to update customize setting
An error occured, retry
Failed to update customize setting
An error occured, retry
Failed to update customize setting
KintoneRestAPIError: [520] [GAIA_IL23] ゲストスペース内のアプリを操作する場合は、リクエストの送信先を「/k/guest/（ゲストスペースのID）/v1/...」にします。 (TdYjpvnw4Rj5kTL0p4JP)
    at KintoneResponseHandler.handleErrorResponse (E:\github.com\kintone\test\node_modules\@kintone\rest-api-client\lib\KintoneResponseHandler.js:57:15)
    at E:\github.com\kintone\test\node_modules\@kintone\rest-api-client\lib\KintoneResponseHandler.js:35:123
    at processTicksAndRejections (internal/process/task_queues.js:93:5)

Note

Maybe problem is here, parameter "guestSpaceId" is missing.

Expected Behavior

Can use @kintone/customize-uploader to upload JS file to a guest space app.

Target Package

• @kintone/[email protected] or later

Environment

• Operating System: any
• Browser: N.A.
• Node.js version: any (>= 12)

Current Behavior

Currently

$ npm install -g @kintone/plugin-uploader
$ kintone-plugin-uploader <path-to-plugin-file>
Open https://xxx.cybozu.com/login?saml=off
Trying to log in...
Navigate to https://xxx.cybozu.com/k/admin/system/plugin/
Trying to upload SAMPLE_text_connet_plugin_v1.3.4.zip
エラーが発生しました TimeoutError: waiting for selector `.ocean-ui-dialog` to be hidden failed: timeout 60000ms exceeded
    at new WaitTask (/Users/***/node_modules/puppeteer/lib/cjs/puppeteer/common/DOMWorld.js:509:34)
    at DOMWorld.waitForSelectorInPage (/Users/***/node_modules/puppeteer/lib/cjs/puppeteer/common/DOMWorld.js:420:26)
    at Object.internalHandler.waitFor (/Users/***/node_modules/puppeteer/lib/cjs/puppeteer/common/QueryHandler.js:31:77)
    at DOMWorld.waitForSelector (/Users/***/node_modules/puppeteer/lib/cjs/puppeteer/common/DOMWorld.js:313:29)
    at Frame.waitForSelector (/Users/***/node_modules/puppeteer/lib/cjs/puppeteer/common/FrameManager.js:841:51)
    at Page.waitForSelector (/Users/***/node_modules/puppeteer/lib/cjs/puppeteer/common/Page.js:1333:33)
    at /Users/***/node_modules/@kintone/plugin-uploader/dist/index.js:83:20
    at Generator.next (<anonymous>)
    at fulfilled (/Users/***/node_modules/@kintone/plugin-uploader/dist/index.js:5:58)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
✨  Done in 65.09s.

Expected Behavior

Can successfully upload the plugin.

Workaround

Use @kintone/[email protected].

ref. #65

When retrieving records with query,

https://developer.cybozu.io/hc/ja/articles/202331474-%E3%83%AC%E3%82%B3%E3%83%BC%E3%83%89%E3%81%AE%E5%8F%96%E5%BE%97-GET-

クエリ検索結果が10万件以上存在するとき、絞り込みが中断されます。
その場合レスポンスヘッダに「x-cybozu-warning : Filter aborted because of too many search results.」が追加されます。

We need to support this header or other ways for users to know this warning.

Target Package

• @kintone/rest-api-client 1.10.0

Environment

• Operating System: Windows 10
• Browser: Chrome 88.0.4324.182
• Node.js version: v14.15.3

Current Behavior

Step 1. Create a new kintone app, no field is OK.
Step 2. Add more than 500 records.
Step 3. On JS Customization page of this APP, add the UMD file of rest-api-client.
Step 4. On list page of this APP, open DevTools of browser and run following code.
const client = new KintoneRestAPIClient(); client.record .getAllRecordsWithId({ app: kintone.app.getId(), condition: '$id != "" or $id = ""' }) .then((resp) => { console.log(resp); }) .catch((err) => { console.log(err); });

=> Bug occurs:
The API requests are send continuously.
Always return the first 500 records.

Memo:
If condition is '($id != "" or $id = "")', this bug does not occur.

I think adding () in rest-api-client is better.

Expected Behavior

Do not send requests continuously.
Return the correct result.

Motivation

The current limitation of deleteRecords (limited until 100 records) is inconvenient so we'd like to add a method to be able to exceed the limitation.

Overview

This method is to be able to delete over 100 records to an app.
Here is the interface we plan.

const results = await this.client.record.deleteAllRecords({
  app: APP_ID,
  ids,
  revisions
});

Currently, data-loader prints the actual values of each environment variables in help messages.
Those variables often include sensitive values like a password, so I think we shouldn't print the actual values in the help message.
I haven't confirmed whether yargs has a proper way to fix this or not, so the Expected Behavior section might be changed.

Target Package

• @kintone/data-loader

Environment

• Operating System:
• Browser:
• Node.js version:

Current Behavior

*** is the actual values I've set as environment variables.

オプション:
  --version              バージョンを表示                                 [真偽]
  --help                 ヘルプを表示                                     [真偽]
  --base-url             Kintone Base Url
                                   [デフォルト: "https://***.cybozu.com/"]
  --username, -u         Kintone Username     [デフォルト: "***"]
  --password, -p         Kintone Password        [デフォルト: "***"]
  --api-token            App's API token
  --basic-auth-username  Kintone Basic Auth Username
  --basic-auth-password  Kintone Basic Auth Password
  --app                  The ID of the app
  --guest-space-id       The ID of guest space
  --file-path            file path
  --pfx-file-path        The path to client certificate file
  --pfx-file-password    The password of client certificate file

Expected Behavior

*** is the actual values I've set as environment variables.

オプション:
  --version              バージョンを表示                                 [真偽]
  --help                 ヘルプを表示                                     [真偽]
  --base-url             Kintone Base Url
                                   [デフォルト: KINTONE_BASE_URL]
  --username, -u         Kintone Username     [デフォルト: KINTONE_USER_NAME]
  --password, -p         Kintone Password        [デフォルト: KINTONE_PASSWORD]
  --api-token            App's API token
  --basic-auth-username  Kintone Basic Auth Username
  --basic-auth-password  Kintone Basic Auth Password
  --app                  The ID of the app
  --guest-space-id       The ID of guest space
  --file-path            file path
  --pfx-file-path        The path to client certificate file
  --pfx-file-password    The password of client certificate file

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Datasource	Name	Replacement PR?
npm	@types/js-base64
npm	@types/mime

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• fix(deps): update dependency eslint to v9

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency glob to ^10.4.2
• chore(deps): update dependency webpack to ^5.92.1
• fix(deps): update dependency @kintone/plugin-packer to ^8.1.3
• fix(deps): update dependency puppeteer to ^22.11.2
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update dependency execa to v9
• chore(deps): update pnpm to v9
• fix(deps): update dependency chalk to v5
• fix(deps): update dependency inquirer to v9 (inquirer, @types/inquirer)
• fix(deps): update dependency meow to v13
• fix(deps): update dependency mime to v4 (mime, @types/mime)
• fix(deps): update dependency os-locale to v6
• fix(deps): update dependency sort-package-json to v2

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Package

• @kintone/rest-api-client

Why

related to #622
When invalid guestSpaceId is given, rest-api-client generates invalid request url and causes runtime error.

What

validate guestSpaceId parameter.

This plan is a roadmap for the next few months.
We will introduce item details in each issue.

Plan Items

• ⚠️ support x-cybozu-warning header (#67)
• provide type definitions for each field type
• ✋ add a feature like config-helper that retrieves app field information

⚠️ … BREAKING CHANGE
🏃 ... work in progress
🤔 ... under discussion
✋ ... postpone

Japanese version: kintone/js-sdk-ja#2

Error: [520] [GAIA_LO04] A value 129 in the field xxx does not exist in the datasource app for lookup, or you do not have permission to view the app or the field.

Hi, I keep getting this error message when updating a lookup field of an app, there is nothing wrong when I update other types of fields.
Can you tell me how to solve this problem?
Thanks a lot.

kintone-js-sdk のように、file.data で Streamを受け取れるようにしていただけると嬉しいです。

Package

all packages

• @kintone/***

Why

Node.js v14 is the recommended version for most users, so we should run tests on CI with the version.

What

• Add Node.js v14 as a target version to run tests on CI
• Update the Node.js version to run lint scripts on CI from v12 to v14

BulkRequest のパラメータ requests[].api で APIのパスを指定する際に必要になるため
buildPathWithGuestSpaceId メソッドを public に使えるようにして欲しい。

※ buildPathWithGuestSpaceId メソッドが public でないため独自実装している例
https://github.com/r3-yamauchi/kintone-delete-by-cursor/blob/master/src/BulkDel.ts#L48
https://github.com/r3-yamauchi/kintone-delete-by-cursor/blob/master/src/Util.ts#L86

249164c#diff-0c5d15aae00d4d9c3cb6465b57d756aaR301
のように SDK内で内部的に BulkRequest している場合はよいが、BulkRequest を実行する実装を自分で書く場合もあるため

This plan is a roadmap for the next few months.
We focus on supporting all features that kintone-js-sdk has.

Plan Items

• addAllRecords (#102)
• updateAllRecords (#103)
• deleteAllRecords (#104)
• upsert single record (#105)
• support client certificate (#113)
• support OAuth bearer token header (#110)
• support Proxy server (#114)
• support file path in uploadFile() method (#115)
• ✋ upsert multiple records
• support UserAgent in Node environment

🏃 ... work in progress
🤔 ... under discussion
✋ ... postpone

Motivation

Kintone has OAuth access token support, but rest-api-client doesn't support yet.
So we want rest-api-client to accept OAuth access token.

ref. #64

Overview

This PR make rest-api-token to be able to accept OAuth token at its constructor.

// This interface hasn't fixed so we might change the interface
const client = new KintoneRestAPIClient({
  baseUrl: "https://example.cybozu.com",
  auth: {
    oauthToken: process.env.KINTONE_OAUTH_TOKEN
  }
});

rest-api-client supports Node and a browser environment, but some features are only available in one environment.
We run unit testing using Jest, so the unit tests are running on jsdom, which is a default environment for Jest.

Currently, it's not clear which tests are for a browser environment, which one is for a Node environment.
So we have to refactor tests to make a running environment clear.

IMHO, we might not need to use jsdom as the environment, because most tests should run on a Node environment.

Package

• @kintone/plugin-manifest-validator

Why

After the Kintone's next update on July 2021, new format version become available like '1.2.3'.

What

modify packages/plugin-manifest-validator/manifest-schema.json to accept new format.

Package

• @kintone/plugin-manifest-validator

Why

packages in js-sdk are intended to be written by TypeScript, but plugin-manifest-validator is not.

What

Migrate plugin-manifest-validator to TypeScript.

Target Package

• @kintone/dts-gen 4.0.0

Environment

• Operating System: macOS Big Sur 11.2.3
• Node.js version: 14.16.1

Current Behavior

Following the Maintenance Guide of @kintone/dts-gen, I executed yarn build & node ./dist/integration-tests/setup-test-app.js with some parameters written in the guide.
However, we got the error like bellow:

/path/to/workspace/js-sdk/packages/dts-gen/dist/integration-tests/setup-test-app.js:37
    .version("0.0.1")
     ^

TypeError: program.version is not a function
    at Object.<anonymous> (/path/to/workspace/js-sdk/packages/dts-gen/dist/integration-tests/setup-test-app.js:37:6)
    at Module._compile (internal/modules/cjs/loader.js:1063:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1092:10)
    at Module.load (internal/modules/cjs/loader.js:928:32)
    at Function.Module._load (internal/modules/cjs/loader.js:769:14)
    at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:72:12)
    at internal/main/run_main_module.js:17:47

Expected Behavior

can execute the setup script with no error.

these are helpful for contributors, so I'd like to put them in the repository.

Target Package

• @kintone/rest-api-client 1.3.0

Environment

• Operating System: Windows 10 Pro / macOS Catalina
• Node.js version: v12.15.0
• Visual Studio Code v1.45.1

Current Behavior

code completion on record.updateAllRecords() is not correct.

Some methods have the same issue, for example; updateRecords(), updateRecordAssignees(), deleteRecords(), deleteAllRecords(), deleteRecordComment(), and so on.

Expected Behavior

They should be RecordID and RevisionID.

In kintone.d.ts, The type property is optional for most field types.
https://github.com/kintone/dts-gen/blob/353ac959a38844f23e4f8fc0f928c9d0263fbd42/kintone.d.ts#L261

However, only Calc and File are requires type.
https://github.com/kintone/dts-gen/blob/353ac959a38844f23e4f8fc0f928c9d0263fbd42/kintone.d.ts#L289
https://github.com/kintone/dts-gen/blob/353ac959a38844f23e4f8fc0f928c9d0263fbd42/kintone.d.ts#L372

Is there a reason for this?

Versions

• @kintone/rest-api-client 1.10.0

• TypeScript: 4.1.5

Current Behavior

app.updateGeneralNotifications(#607 ) accepts notifications[].notifyToCommenter for their parameter.

Expected Behavior

Remove notifications[].notifyToCommenter from the type definition.
According to cybozu developer network, notificatons[] doesn't require the property notifyToCommenter.
https://developer.cybozu.io/hc/ja/articles/900004873663

Steps to reproduce the issue

N/A

Target Package

• @kintone/rest-api-client 1.41

Environment

• Operating System: MacOS
• Browser: Chrome
• Node.js version: N/A

Current Behavior

• URL: https://www.npmjs.com/package/@kintone/rest-api-client#references
• The user is receiving a 404 error when clicking any link in the references section: Record, App, File, or Bulk Request.

Expected Behavior

• URL: https://www.npmjs.com/package/@kintone/rest-api-client#references
• The user is directed to the correct documentation when clicking any link in the references section.

Package

• @kintone/plugin-manifest-validator

Why

Currently, @kintone/plugin-manifest-validator pass-through the Ajv ErrorObject.
It has increased the impact of the disruptive update of Ajv. ( see #786 )
Wrapping in its own error format minimizes external impact.

What

TBD

Tasks

• Add missing environment variables and CLI flags support in @kintone/plugin-uploader @chick-p
  • KINTONE_BASE_URL #534
• Add missing environment variables and CLI flags support in @kintone/customize-uploader @chick-p
  • KINTONE_BASE_URL #543
  • KINTONE_OAUTH_TOKEN #566
• Add missing environment variables and CLI flags support in @kintone/dts-gen @koba04 (@potaracom)
  • KINTONE_USERNAME #532 (#458)
  • KINTONE_PASSWORD #532 (#458)
  • KINTONE_BASE_URL #536
  • KINTONE_API_TOKEN #575
  • KINTONE_OAUTH_TOKEN #575
  • KINTONE_BASIC_AUTH_USERNAME #532 (#458)
  • KINTONE_BASIC_AUTH_PASSWORD #532 (#458)
  • HTTP_PROXY #585
  • HTTPS_PROXY #585
• Release a minor version of the packages
• Add deprecated warnings for the usage of KINTONE_DOMAIN, which includes domain option as well @chick-p
  • @kintone/plugin-uploader #697
  • @kintone/customize-uploader #602
• Add deprecated warnings for the usage of host, proxyHost, and proxyPort option
  • @kintone/dts-gen #869
• Release a minor version of the packages
  • @kintone/[email protected]
  • @kintone/[email protected]
  • @kintone/[email protected] (No CHANGELOG)
• Remove deprecated environment variables and CLI flags from the packages.
  • @kintone/plugin-uploader #1046
  • @kintone/customize-uploader #1047
  • @kintone/dts-gen #1048
• Release a major version of the packages 🎉

Package

• @kintone/dts-gen
• @kintone/customize-uploader
• @kintone/plugin-uploader

Why

Currently, those packages have some environment variables support like KINTONE_USERNAME and KINTONE_API_TOKEN, which is useful but the support has some inconsistency like kintone/js-sdk-ja#7 (comment) (Thank you @potaracom)

The inconsistency is cumbersome for developers who use these packages.
So we'd like to address the issue.

What

We will unify the usage of environment variables like the following.

Environment variables we use

• KINTONE_USERNAME ... Your user name
• KINTONE_PASSWORD ... Your password
• KINTONE_BASE_URL ... The URL of your Kintone environment e.g. https://example.kintone.com
• KINTONE_API_TOKEN ... API Token
• KINTONE_OAUTH_TOKEN ... OAuth Token
• KINTONE_BASIC_AUTH_USERNAME ... The user name of Basic Authentication
• KINTONE_BASIC_AUTH_PASSWORD ... The password of Basic Authentication
• HTTP_PROXY ... The URL of HTTP proxy server
• HTTPS_PROXY ... The URL of HTTPS proxy server

Matrix of the environment variables and packages

• 🙆‍♀️ Already supported
• 🚀 Will be supported in this issue
• ⛔ Won't be supported because of limitations of Kintone
• 🙅 Will be removed in this issue

Adoption strategy

1. Add missing environment variable support, which includes CLI options if required.
2. Release a minor version of the packages
3. Add deprecated warnings for the usage of KINTONE_DOMAIN, which includes domain option as well.
4. Release a minor version of the packages
5. Remove deprecated environment variables and CLI flags from the packages.
6. Release a major version of the packages

Package

• @kintone/rest-api-client
• (@kintone/dts-gen)

Why

Some methods rest-api-client provides accept a type parameter for a type definition of your app.

type MyAppRecord = { /* ... */ }
// the type of the record will be MyAppRecord
const record = client.record.getRecord<MyAppRecord>({ app: 1, id: 10 })

After #404 has been merged, we could define the type definition using types #404 exposes.
But it's a bit cumbersome because we have to define the type definition manually.

dts-gen provides us a command to be able to generate type definitions for your app.
But the type definition dts-gen generates is not compatible with rest-api-client expects (refs. #442).

What

We'd like to provide a way to generate type definitions, which are compatible with rest-api-client, automatically.

We could take some options to fix the issue.

1. Adding a feature to generate type definitions to be able to use with rest-api-client into dts-gen.
2. Creating a new package to generate type definitions to be able to use with rest-api-client.

Now, we have several types for a Kintone record type like the following.

• JS API
• API Response
• API Request

So we have to sort each type definition respectively.

https://github.com/kintone/js-sdk/blob/master/packages/rest-api-client/docs/file.md#uploadFile
の Parameters に
file.data String or Blob と書かれており、このページの冒頭にも

  const FILE = {
    name: "Hello.txt",
    data: "Hello World!"
  };

file.data に文字列を指定する例が書かれていますが、
Uncaught (in promise) TypeError: Failed to execute 'append' on 'FormData': parameter 2 is not of type 'Blob'.
が発生します。

    const blob = new Blob(["Hello World!"], {
      type: 'text/plain'
    });

    const { fileKey } = await client.file.uploadFile({
      file: {
        name: "Hello.txt",
        data: blob
      }
    });

と Blob を指定した場合は問題ありません。

関係のあると思われるソースコード箇所
https://github.com/kintone/js-sdk/blob/master/packages/rest-api-client/src/client/FileClient.ts#L41

kintone-cli を使用して TypeScript で カスタマイズを実装しています。

  "dependencies": {
    "@kintone/kintone-ui-component": "^0.6.0",
    "@kintone/rest-api-client": "^1.2.0",
    "react": "^16.8.6",
    "react-dom": "^16.7.0"
  },
  "devDependencies": {
    "local-web-server": "^2.6.1",
    "webpack": "^4.30.0",
    "webpack-cli": "^3.2.3",
    "babel-loader": "^8.0.5",
    "style-loader": "^0.23.1",
    "css-loader": "^2.1.0",
    "core-js": "^3.2.1",
    "regenerator-runtime": "^0.13.3",
    "@babel/core": "^7.3.3",
    "@babel/preset-env": "^7.3.1",
    "@babel/plugin-proposal-class-properties": "^7.3.3",
    "@babel/plugin-syntax-dynamic-import": "^7.2.0",
    "@babel/preset-typescript": "^7.3.3",
    "@babel/preset-react": "^7.0.0",
    "typescript": "^3.6.3",
    "@types/react": "^16.8.16",
    "@types/react-dom": "^16.8.4",
    "@kintone/customize-uploader": "^2.0.5",
    "eslint": "^6.5.1",
    "@cybozu/eslint-config": ">=7.1.0"
  },

I need support for OAuth access token authorization feature.
https://developer.kintone.io/hc/en-us/articles/360001562353/

setting the access token in the Authorization: Bearer header.

This feature has been waiting for a long time ago.
kintone-labs/kintone-basejs-sdk#65
kintone-labs/kintone-js-sdk#32

Motivation

The current limitation of addRecords (limited until 100 records) is inconvenient so we'd like to add a method to be able to exceed the limitation.

Overview

This method is to be able to add over 100 records to an app.
Here is the interface we plan.

const results = await this.client.record.addAllRecords({
  app: APP_ID,
  records
});

Target Doc

• js-sdk/packages/rest-api-client/docs/record.md

Current Behavior

• The return type of totalCount is described as String even though the value of totalCount will be null when the request parameter totalCount is set to false or ignored. I assume that the description should be String or null.

  • getRecords - Returns
    https://github.com/kintone/js-sdk/blob/master/packages/rest-api-client/docs/record.md#returns-4

• The return type of the totalCount is String even though the type is described as Integer on the reference page. I did not confirm which one is true, but we should fix either of them.

  • createCursor - Returns
    https://github.com/kintone/js-sdk/blob/master/packages/rest-api-client/docs/record.md#returns-18

  • createCursor - Reference
    https://github.com/kintone/js-sdk/blob/master/packages/rest-api-client/docs/record.md#reference-10

I generated type definition of SUBTABLE field.
The type and value.id properties are required, which makes them difficult to use.

  Table: {
    type: 'SUBTABLE';
    value: {
      id: string;
      value: {
        text1: kintone.fieldTypes.SingleLineText;
        text2: kintone.fieldTypes.SingleLineText;
      };
    }[];
  };

I wish the type and value.id properties were no longer required.

  Table: {
    type?: 'SUBTABLE';
    value: {
      id?: string;
      value: {
        text1: kintone.fieldTypes.SingleLineText;
        text2: kintone.fieldTypes.SingleLineText;
      };
    }[];
  };

ref. kintone/js-sdk-ja#8

In https://developer.kintone.io/hc/en-us/articles/212495188 (en) or https://developer.cybozu.io/hc/ja/articles/201941754#step10 (ja)

We should offer the way to know running concurrent API requests.

Motivation

We want to use rest-api-client under the network using proxy server.

NOTE: This feature is available only in Node.js environment.

Overview

We haven't fixed the interface and need to discuss, but something like the following: The client can accept the proxy server configurations.

const client = new KintoneRestAPIClient({
  baseUrl: "https://example.cybozu.com",
  proxy: 'http://our-proxy-server:port',
  // ...
});

Or we can respect environment variables such as HTTP_PROXY / HTTPS_PROXY.

ref. https://github.com/googleapis/google-api-nodejs-client#using-a-proxy

Package

• @kintone/rest-api-client

Why

for
I want to know which version a RestAPIClient is used from UMD builds.

e.g. React has a version property as React.version.

What

I have three options.
Personally, I prefer option 1.

1. Add a version property as a static property

KintoneRestAPIClient.version
// "1.3.0"

2. Add a version property as an instance property

const client = new KintoneRestAPIClient();
client.version;
// "1.3.0"

3. Add a version as a source comment

// Version: 1.3.0

This should keep the comment even after minification for the production build.

Motivation

We want to use rest-api-client for the subdomain in which Client Certificate Authentication is enabled

NOTE: This feature is available only in Node.js environment.

Overview

We haven't fixed the interface and need to discuss, but something like the following: The client can accept the client certificate file and its password.

const client = new KintoneRestAPIClient({
  baseUrl: "https://example.cybozu.com",
  auth: {
    clientCert: {
      file: fs.readFileSync('PATH_TO_CERT_FILE'), // or the path to certificate file
      password: 'PASSWORD'
    }
  }
});

Currently, we can't detect #176 because we don't have a test for this, so I have to add a test to be able to detect this.