SDK&Tools

kintone-dts-gen

目次

kintone-dts-gen とは

固定リンクがコピーされました

kintone-dts-genは、kintoneアプリのTypeScript型定義ファイル（.d.ts）を生成できるCLIツールです。
このツールを利用すると、kintoneアプリのフィールドの型を一括作成できます。
TypeScriptでkintoneカスタマイズを開発する際に、より効率的に作業を進めることができます。

GitHub

固定リンクがコピーされました

https://github.com/kintone/js-sdk/tree/main/packages/dts-gen (External link)

ライセンス

固定リンクがコピーされました

MITライセンス (External link)

ドキュメント

固定リンクがコピーされました

https://github.com/kintone/js-sdk/blob/main/packages/dts-gen/README.md (External link)

下準備

固定リンクがコピーされました

kintone-dts-genを実行するには、Node.jsとパッケージ管理ツールのnpmが必要です。
Node.jsをインストールすると、npmは自動でインストールされます。

  1. Node.js公式サイトからインストーラーをダウンロードします。
    Node.js 公式サイト (External link)
    必要なNode.jsのバージョンは、次のリポジトリにあるenginesプロパティを確認してください。
    packages/dts-gen/package.json (External link)
    たとえば次の記載の場合、Node.jsのバージョン18以上が必要です。

    1
2
3

    "engines": {
  "node": ">=18"
},

  2. ダウンロードしたインストーラーを実行し、画面にしたがってセットアップします。

Quickstart

固定リンクがコピーされました

kintoneアプリを用意し、kintone-dts-genを使ってアプリの型定義ファイルを生成します。

Step1： kintone アプリの準備

固定リンクがコピーされました

  1. kintoneアプリを作成し、フィールドを配置します。
  2. 作成したアプリのURLで、アプリIDを確認します。
    URLのhttps://sample.cybozu.com/k/123の末尾の数字部分が、アプリIDです。
    上記の場合、アプリIDは、「123」です。

Step2：必要なパッケージのインストール

固定リンクがコピーされました

kintone-dts-genをインストールします。

1

npm install -D @kintone/dts-gen

Step3：型定義ファイルの作成

固定リンクがコピーされました

次のコマンドで、対象アプリの型定義ファイルを生成します。

1

npx kintone-dts-gen --base-url https://sample.cybozu.com -u ユーザー名 -p パスワード --app-id アプリID

成功すると、コマンドを実行したディレクトリに型定義ファイルfields.d.tsが作成されます。

補足

固定リンクがコピーされました

作成した型定義ファイルを使う方法は、次のページを参考してください。
kintoneアプリの型定義ファイルを活用して、kintoneカスタマイズをTypeScriptで開発してみよう

また、ユーザー名とパスワードによる認証のほか、APIトークンやOAuthトークンによる認証もサポートしています。