Appkit Core

業務アプリケーション向けの、フレームワークに依存しない TypeScript の構成要素です。

概要

JSON Schema で業務レコードを検証し、レコードとファイルの操作を明示的なアダプターに接続して、AI が提案した変更を適用前に確認できます。Core は契約とヘルパーを提供し、永続化と権限はアプリケーションが制御します。

導入する理由と価値

バックエンド、スクリプト、フロントエンドで、React に依存せずに共通の検証とレコードの契約が必要な場合に Core を使用します。機能別のサブパスでストレージ、スキーマ、グラフ、AI の API を選び、プロバイダー固有の SDK の要件を明確にできます。

アプリケーションに必要なもの	選択するもの
検証、ストレージ、レコードアダプター、依存関係の計画、地域別ヘルパー	Core のみ
React コンポーネント、スキーマフォーム、レコードテーブル、チャット UI	Core に依存する Appkit React

Core はライブラリであり、ホストされたバックエンドではありません。認証、認可、マイグレーション、トランザクション、最終的な書き込みはアプリケーションが担います。

主な機能

スキーマとレコード: JSON Schema による検証、スキーマ変換、データアクセスの契約。データガイド
ファイルストレージ: ハッシュ、署名、ZIP のヘルパー、明示的なオブジェクトストレージのアダプター。ストレージガイド
業務計算: 依存グラフと計画、日本・米国向けの地域別ヘルパー。グラフ · 日本 · 米国
AI 提案の確認: 構造化入力の検証、アクションの契約、アプリケーションが実行する前の提案確認。AI ガイド

クイックスタート

要件とインストール

対応する Node ランタイムは Node.js 24 以降です。Core に React は不要です。パッケージは ESM、CommonJS、TypeScript の型宣言を提供します。実行時の要件は選択する機能によっても異なります。たとえば JSON Schema の検証は実行時に関数をコンパイルするため、それを許可するホストが必要です。

npm install @alneas/appkit-core
# Or: bun add @alneas/appkit-core

パッケージ名でインストールし、機能別のサブパスをインポートに使用します。以下の検証例には、任意のプロバイダー SDK は不要です。データベースや AI SDK の連携には追加のピア依存が必要な場合があります。公開インポートとピア依存の要件を参照してください。

保存前に申請内容を検証する

import { createAjvValidator } from '@alneas/appkit-core/data/schema';

const schema = {
  type: 'object',
  properties: {
    name: { type: 'string', minLength: 2 },
    reason: { type: 'string' },
  },
  required: ['name'],
  additionalProperties: false,
};

const validate = createAjvValidator({ locale: 'en' });
const input: unknown = { name: 'A' };
const result = validate(schema, input);

console.log(result.valid); // false: the name is too short
console.log(result.errors); // field paths and validation messages
console.log(validate(schema, { name: 'Ada', reason: 'Equipment request' }).valid);
// true

このデフォルトのバリデーターオプションでは、入力の型変換、デフォルト値の挿入、余分なキーの削除を行いません。無効な入力にはエラーを返しますが、無効なスキーマやバリデーター設定では例外が発生する場合があります。成功結果はデータが妥当であることを示しますが、TypeScript の型を絞り込んだり、書き込みを認可したりはしません。検証後に受け入れたレコードを、アプリケーションの永続化層へ渡してください。DataAccessAdapter の契約とプロバイダー別のエントリーポイントは、データガイドを参照してください。

次のステップ

変更履歴: バージョン別の追加、修正、更新時の注意事項。
データとスキーマのガイド: レコードの契約とデータベースアダプター。
公開エクスポートと任意のピア依存: 正確なインポート先と SDK の要件。
AI のセキュリティと承認の境界: 検証、権限、ツールの実行。
AI エラーコードと復旧: 再試行前に失敗を調査する方法。

コーディングエージェント向け

エージェント向け指示から始め、API カタログとドキュメント全文を使用してください。インストール済みパッケージには、これらのファイルが consumer-ai/ と llms-full.txt 配下に含まれます。場所は manifest の appkit.agent フィールドにも記載しています。

開発への参加とライセンス

開発への参加 · リリース手順 · MIT ライセンス