Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 2.54 KB

README.md

File metadata and controls

67 lines (48 loc) · 2.54 KB

@b4moss/existian

HTML の data-* 属性で、入力値に対する非同期チェックを宣言的に書くための小さな JavaScript ライブラリ。

目的

入力 → debounce → 非同期チェック → 結果に応じた状態表示までを、HTML 側の最低限の宣言だけで扱えるようにする。

HTTP API そのものを抽象化するライブラリではなく、DOM イベントと非同期チェックをつなぐ薄いレイヤーとして設計する。

主な用途

  • ユーザー名の存在確認
  • メールアドレスの重複確認
  • 招待コードの有効性確認
  • その他、入力値に応じた API ベースの非同期チェック

スコープ

担当する

  • DOM イベントの監視
  • debounce
  • 非同期リクエスト
  • request の排他制御
  • stale response の無視
  • timeout
  • response の判定
  • state 属性の更新

担当しない

  • UI デザイン / メッセージ表示 / CSS
  • テンプレートエンジン
  • HTML 属性内で任意式を評価する DSL
  • 複雑な API レスポンス変換
  • フォーム全体のバリデーションフレームワーク

技術方針

  • パッケージ名: @b4moss/existian(現行 0.3.0)
  • Vite + TypeScript
  • 属性プレフィックス既定: data-ex-*(変更可能)
  • UI は持たない。状態を DOM に反映し、見た目は利用側 CSS の責務
  • ブラウザ向け npm パッケージ(ESM / CJS / IIFE)。構成は @b4moss/jp-local-gov-id / @b4moss/cachian を参考にする
  • 公開 API: init と関連型(InitOptions / ExistianHandle / BuildRequestContext 等)。IIFE では Existian.init
  • TDD(氷山パターン)。薄い DDD は意識するが、CRUD / Repository は持たない(パッケージ向け例外)

索引

OKF 版索引は index.md(okf_version: "0.1")。本文の正本は本ファイル(pillar)。

文書 役割
roadmap.md SemVer・マイルストーン一覧
plans/ 未実装の計画
specs/ 現行機能の仕様正本
tests/ テスト仕様(TDD 入力)
charter/ 開発憲章
charter/okf/ OKF v0.1 定義・執筆サンプル
override-charter.md 憲章オーバーライド

利用向けの導入はリポジトリ直下の README.md を参照。


以上