microcms-typegen

microCMSのAPIスキーマから、microcms-js-sdkで使うTypeScriptの型定義を自動生成するCLIです。

保守方針

このツールの現在の保守レベルはActiveです。

詳細はSDKの保守方針をご覧ください。

動作環境

• Node.js 22.18+
• TypeScript 6.0+（設定ファイル・生成型を型検査する場合）

CLIの実行自体にTypeScriptのインストールは不要です。

使い方

1. 初期設定を作成する

導入するプロジェクトのルートで実行します。

npm install -D microcms-typegen
npx microcms-typegen init

initは実行したディレクトリにmicrocms-typegen.config.tsを作成します。既存ファイルは上書きせずスキップします。作成後は出力先を確認してください。

2. 環境変数を設定する

「API情報の取得」権限を持つAPIキーを用意し、プロジェクトの.envに設定します。既存の.envがある場合は、必要な項目を追加してください。

MICROCMS_SERVICE_DOMAIN=your-service
MICROCMS_API_INFO_API_KEY=your-api-info-api-key

3. 型を生成・確認する

型を生成します。

npx microcms-typegen generate

生成済みの型と現在のAPIスキーマの差分を確認する場合は、checkを実行します。

npx microcms-typegen check

コマンドの役割

コマンド	説明
init	最小限のTypeScript設定ファイルを作成。既存ファイルはスキップ
generate	現在のAPIスキーマから型ファイルを生成・更新
check	生成済みの型と現在のAPIスキーマを比較。差分やファイルの欠落があれば終了コード1

checkはファイルを変更しないため、CIでも利用できます。

設定ファイル

設定ファイルはES modules形式のTypeScript（.ts）のみ対応しています。package.jsonで"type": "commonjs"を明示しているプロジェクトでの設定読み込みには対応していません。

作業ディレクトリのmicrocms-typegen.config.tsを自動で読み込みます。複数のmicroCMSサービスを1つの設定ファイルで管理でき、servicesにサービスごとの設定を記述します。以下は1サービスにオプションを指定した例です。

import type { Config } from 'microcms-typegen';

export default {
  services: {
    main: {
      serviceDomain: process.env.MICROCMS_SERVICE_DOMAIN,
      apiKey: process.env.MICROCMS_API_INFO_API_KEY,
      output: './src/microcms-types.ts',
      typeRules: {
        trustReadFieldConstraints: {
          trustReferenceAvailability: true,
        },
      },
      endpoints: ['blog', 'category'],
      extensionFieldTypes: {
        blog: {
          extension: {
            from: './blog-extension-types',
            data: 'BlogExtension',
          },
          'panel.embed': {
            from: './blog-extension-types',
            data: 'PanelEmbed',
          },
        },
      },
    },
  },
} satisfies Config;

Note

型検査でprocessが見つからない場合は、開発依存関係に@types/nodeを追加し、設定ファイルに適用するtsconfig.jsonのcompilerOptions.typesに"node"を含めてください。

servicesの各キー（例のmain）がサービス名です。複数サービスではキーを追加し、それぞれ別の出力先を指定します。既定では全サービスを処理し、1サービスだけ実行する場合は--service mainで選択できます。各サービス設定に記述する項目は次のとおりです。

項目	必須	説明
serviceDomain	はい	サービスID。URLではなくyour-serviceの部分を指定
apiKey	はい	「API情報の取得」権限を持つAPIキー
output	はい	コマンドを実行したディレクトリを基準とする、生成する.tsファイルのパス
endpoints	いいえ	対象APIのエンドポイントIDの配列。省略すると全APIが対象
typeRules	いいえ	生成型のルール。省略したルールには既定値を適用
typeRules.trustReadFieldConstraints	いいえ	trueまたはオブジェクトで、保存済みデータが必須・最小件数1以上を満たすと信頼する。既定値はfalse
typeRules.trustReadFieldConstraints.trustReferenceAvailability	いいえ	オブジェクト内で、参照先が取得できると信頼して参照型を絞る。既定値はfalse
extensionFieldTypes	いいえ	エンドポイント・フィールドごとの拡張フィールド型の設定
extensionFieldTypes.<endpoint>.<fieldPath>.from	-	生成ファイルから見た、型定義ファイルのモジュールパス
extensionFieldTypes.<endpoint>.<fieldPath>.data	-	型定義ファイルからエクスポートしたdataの型名

拡張フィールドを設定する場合は、対象フィールドのfromとdataを両方指定します。<fieldPath>は、通常は拡張フィールドのフィールドID（例：extension）です。カスタムフィールド内の拡張フィールドでは、カスタムフィールドIDとその中の拡張フィールドIDをつないだ文字列を用いてください。その場合、カスタムフィールドを配置したフィールドIDは指定に含める必要はありません。

拡張フィールドの設定（extensionFieldTypes）

拡張フィールドのdataの形式はAPIスキーマから判定できないため、指定がなければ読み取り型はunknownとなります。 dataの型が決まっている場合は、あらかじめ定義することが可能です。 メタデータ（id・title・description・imageUrl・updatedAt）は規定の項目となるため、定義は不要です。

// src/blog-extension-types.ts
export type BlogExtension = {
  place: {
    name: string;
    address: string;
  };
};

export type PanelEmbed = { html: string };

型生成ルール（typeRules）

運用上保証できる条件を指定することで、生成型に含まれる空値の可能性を絞れます。

• trustReadFieldConstraints：保存済みデータが必須・最小件数1以上の制約を満たすことを保証できる場合に、ONにしてください。必須項目の空値を型から絞り、必須・最小件数1以上の繰り返しを1件以上の配列型にします。後から必須・最小件数を設定した場合は、既存データにおいて値が欠けていることがあります。
• trustReadFieldConstraints.trustReferenceAvailability：参照先の公開状態やAPIキーの権限を含め、常に取得できることを保証できる場合に、ONにしてください。必須の単一参照からnullを除き、必須・最小件数1以上の複数参照を1件以上の配列型にします。参照先が下書きのみ・公開終了の状態になり、APIキーにその状態を取得する権限がない場合は、参照が除外され、nullや空配列になり得ます。

Note

上記のオプションは現在、読み取り型に適用されます。書き込みでは、これから送るデータを現在のスキーマに合わせて型検査するため、必須・最小件数1以上を常に反映します。

CLIオプション

オプション	説明
--service <name>	設定ファイルの1サービスを選択。省略時は全サービス
--config <file>	TypeScript設定ファイルを指定。省略時は作業ディレクトリのmicrocms-typegen.config.tsを読み込み
--force	generate専用。生成済みコメントがない既存ファイルも上書き
--help	ヘルプを表示

生成型の利用方法

生成ファイルには、エンドポイントごとの標準的な読み取り型（Blogなど）と、全エンドポイントの型情報をまとめたサービス型が出力されます。サービス型の名前はservicesのキーから作られ、設定例のmainならMainServiceSchemaです。この型にはdepth別の読み取り型、指定可能なfields、書き込み用の型も含まれます。

SDKのcreateClientにサービス型を指定すると、読み取りではエンドポイントとdepth・fieldsに応じた戻り値型を、書き込みではエンドポイントに応じた入力型を推論します。エンドポイントごとの標準型は、メソッドへ個別に型を指定する方法でも利用できます。

具体的な読み書き、クエリに応じた型抽出、メソッドごとの型指定は、SDKのREADMEのTypeScript節を参照してください。

型生成のサンプルで入力スキーマ・生成結果を確認できます。補完や戻り値の型をエディタで試す例は、SDKの利用例を参照してください。

補足

空値

フィールドごとのレスポンス形式に合わせ、生成型には未入力時の省略・null・空文字・空配列などを含めています。 登録方法が限定されている場合や、必須設定の設定タイミングによっては、実際には生じない空値まで含み、型が広くなることがあります。

Note

必須項目などの読み取り型を絞る場合は、型生成ルールを参照してください。

開発者向け情報

typegenの開発に関する情報は、開発ガイドを参照してください。

ライセンス

Apache License 2.0