ビュー/JavaScriptアクション用の型定義ファイルのダウンロード

ビューとJavaScriptアクションの型定義ファイルをダウンロードできるようになりました。

手元のエディターでコードを編集する場合に型による入力補完などをご活用いただけます。

※ この機能は将来、別の機能による代替または廃止になる可能性があります。

型による補完の例

※以下はVS Codeを使用している場合の例です。

ビューのActionLinkやuseExecuteAction、JavaScriptアクションのexecuteActionなどのアクションの「IDまたは識別子」と「パラメーターの値」を入力する関数/コンポーネントでは、アクションの設定内容に基づいて入力が補完されます。

まずアクションのIDまたは識別子の入力では、プロジェクト内のアクションのIDと識別子の一覧から選択して入力できます。

さらにアクションのパラメーターの値の入力では、（入力したIDまたは識別子の）アクションに設定されているパラメーターの名前の一覧から選択して入力できます。

またパラメーターの値の型や、一部の設定内容もエディター上で確認できます。

ビュー

ビューでは@basemachina/viewモジュールの型定義ファイルがダウンロードでき、手元のエディターでのコードの編集時に、@basemachina/viewからimportした関数とコンポーネントの型表示、および入力補完が利用できるようになりました。

またビューは、コード取得設定を使用すると手元のエディタで編集したビューのコードを、GitHub上で管理できます。

今回のリリースで、コード取得設定を利用した場合に手元のエディターでより効率的にコードが編集できるようになります。

詳細はドキュメントの「@basemachina/viewの型定義ファイルのダウンロード」をご参照ください。

※ビューで型が定義されているのは関数と一部のコンポーネント（ActionLink, ViewLink, Link）のみです。

JavaScriptアクション

JavaScriptアクションでは@basemachina/actionモジュールの型定義ファイルがダウンロードでき、手元のエディターでのコードの編集時に、@basemachina/actionからimportとした関数とコンポーネントの型表示、および入力補完が利用できるようになりました。

また、JavaScriptアクションのハンドラー関数 (export defaultされる関数) の型を指定する場合は、Handlers型を利用できます。

※アクション編集画面のエディターで使用できるHandler型は使用できません。

// Handlers型のキーには、JavaScriptアクションのIDまたは識別子を指定します
/** @type { import("@basemachina/action").Handlers["getCustomerPageUrl"] } */
export default (
  { customerId },
  { vars, secrets, currentUser, environment },
) => {
  const customerPageUrl = `https://example.com/environments/${vars.ENVIRONMENT_ID}/${customerId}`;
  return customerPageUrl;
};

詳細はドキュメントの「@basemachina/actionの型定義ファイルのダウンロード」をご参照ください。

ビューの編集画面のエディターでの型表示と入力補完

型定義ファイルのダウンロードと合わせて、ビューの編集画面のエディターでも、@basemachina/viewでimportしたモジュールの関数とコンポーネントの型表示と入力補完が利用できるようになりました。

型の表示

入力補完

不具合修正

• ビューの編集画面のエディターで、入力中にエディターのサイズが小さくなる場合があるバグを修正しました