機能
@nocobase/app-plugin-foundation は、アプリがどの Core の機能を組み込んでいるか、その利用の根拠、業務モジュールとの関連を表示します。
Foundation は既存の組み込みを観察するもので、プラグインをインストールしたり、実際の検収の代わりになったりはしません。
機能を調べる
アカウント、権限、ファイル、通知、AI などの機能を選び、設定、確認された利用、関連するパッケージを調べます。要求に応じて、プラグインは設定、登録されたサービス、既定の接続、マイグレーションの情報を読み取ります。結果は短時間キャッシュされ、Refresh で改めて収集します。
インストール済み、登録済み、設定済み、利用中は、それぞれ別の根拠です。依存関係があるだけでは、業務で使われていることの証明にはなりません。認識されない独自または商用の拡張は、利用状況が未確定のまま独立して表示されることがあります。
シナリオと例
例:メールの組み込みを確認する
- 認識されたメールのランタイムと、接続済みのアカウントを確認します。
- 業務モジュールを開き、その メール のアカウントとワークスペースのページが組み込まれていることを確認します。
- 制御した送受信のチェックを行い、利用できる利用の根拠を確認します。
Foundation は、実際の配信、モデルの呼び出し、検収のテストの代わりにはなりません。レコードの件数は明示的に要求したときにだけ数え、収集の失敗は 0 ではありません。
開発用のプロンプト(アプリのディレクトリで作業するコーディングエージェント向け):
Foundation を使って、Core の機能の根拠を管理者に見せてください。既存のページがあれば
再利用し、unrestricted だけのアクセスを保ち、設定の中に置いてください。デプロイでモジュールの
関連が必要なら、CLI の提供内容も追加してください。インストール済み、登録済み、設定済み、
観察された利用を区別してください。収集の失敗を 0 や未使用として表示しないでください。
一般ユーザーの API の呼び出しが拒否されることを検証し、メールなどの機能は別に制御した検収を行ってください。完了の条件管理者に根拠が表示され、一般ユーザーは拒否され、確認できない観察や失敗した観察が業務上の結論として表示されないこと。
主な仕組みと実装
以下は、この例での組み込みの領域と、想定される画面の変化です。開発作業を記述したもので、実際のファイル構成はアプリに合わせてください。
| 組み込みの領域 | コードまたは設定の変更 | 画面と動作の変化 |
|---|---|---|
| Client と Server のプラグインのオプション | ページとナビゲーションを設定する | 設定の中に機能の概要を表示する |
| 任意の CLI の提供内容とビルド | foundation-modules.json を生成する | デプロイ後も静的なモジュールの関連を保つ |
| 業務の検証の記録 | 観察を実際の検収と照らし合わせる | 依存関係があることを、組み込みが動いていることと取り違えない |
組み込みと入口
Client と Server は、Authentication や Authorization などの依存関係のあとに登録します。foundation() は /foundation とナビゲーションを追加します。既定のテンプレートは foundation({ settingsGroup: true }) を使います。
| Client のオプション | 用途 |
|---|---|
path | ページのパスを変える |
navigation: false | メニューの項目なしでページを残す |
routes: false | 公開の FoundationPage を自分でマウントする |
settingsGroup: true | 入口を設定の中に置く |
ページと GET /api/foundation/overview には、root の権限セットの保持者などの unrestricted の身元が必要です。これは任意のロールに割り当てられる通常のページの権限ではありません。
モジュールとデプロイ
モジュールはナビゲーションから、関連は認識されたページ、API、バックエンドの依存関係から来ます。マトリクスの空のセルは、未使用ではなく、確認できていないことを意味します。
デプロイ用のビルドで静的な関連を保つには、/cli の提供内容を登録します。これは dist/server/foundation-modules.json を生成します。既存のアプリはビルドし直す必要があります。解析で、スキャンした業務のソースが実行されることはありません。
AI 開発の制約と検証
プラグイン固有の開発の制約
- ページと API の unrestricted だけのアクセスを保ち、サインインしたすべてのユーザーに広げないでください。
- 空の関連や収集の失敗を未使用と解釈せず、観察の時刻を残してください。
- デプロイの成果物を確認し、メール、モデル、データベースの動作は別に検証してください。概要の件数は業務のテストの代わりにはなりません。
制限と検証
管理者のアクセス、一般ユーザーの拒否、更新、収集の失敗の表示を検証します。ほかの接続、不透明な組み込み、サポートされない拡張は、対象外のことがあります。保持された確かな観察には、元の時刻が表示されます。
Foundation は、プラグインのインストール、有効化、アップグレードを行わず、マイグレーションや業務のテストが通過したことも証明しません。関連:プラグインを管理する、データベースブラウザー。
これらはあなたの組み込みの検収の要件であり、実機での検証が完了したことを示すものではありません。実際の変更、実行したチェック、未検証の項目をエージェントに報告させてください。プロジェクトのガイダンス、スキル、共通のチェックについては アプリの開発を続ける と テスト を参照してください。
出典:公開のプラグインの入口と実装。