@wcstack/state 2.5.1 → 2.6.0

package/README.ja.md

@@ -969,6 +969,7 @@ get total() { return this.price * exchangeRate; }          // モジュール変
 | `this.$trackDependency(path)` | 依存を明示的に追加し、そのパスの変更でこの getter を dirty にする |
 | `this.$postUpdate(path)` | 追跡外の入力が変わったことを getter の外から通知する |
 | `this.$untrackDependency(fn)` | 依存として登録せずにパスを読む（上の対称） |
+| `this.$eq(path, key)` / `$eqPath(path, keyPath)` / `$eqIndex(path)` | 鍵付き購読: 「`path` はこの行の鍵に等しいか」をパターン依存なしで答える（[鍵付き選択](#鍵付き選択eq--eqpath--eqindex)） |
 
 ```javascript
 // ✅ 時計を state 側で刻み、getter は純粋なまま
@@ -995,6 +996,31 @@ getter の例外は握り潰されません。評価された場所（バイン
 
 `$untrackDependency(fn)` は setter の規則を getter に意図的に適用するもので、`fn` の中の読み取りは追跡されません。`$trackDependency(path)` は最初の規則に対する逃げ道です。
 
+### 鍵付き選択（`$eq` / `$eqPath` / `$eqIndex`）
+
+「この行は選択中か」を答える行 getter は、依存追跡が最も効きにくい形です。`get "items.*.selected"() { return this.$1 === this.selectedIndex; }` と書くと全行が `selectedIndex` に依存し、1 クリックで 1 万行の getter が再評価されます。鍵付きの形は各行を **その行自身の鍵** の下に購読させ、パスへの書き込みでは「選択されていた行」と「選択される行」だけを再評価します：
+
+| API | 鍵 | 選択の付き先 | 備考 |
+|---|---|---|---|
+| `this.$eq(path, key)` | 任意の値 | 鍵 | `path` は依存を張らずに読み、行は `key` の下に登録される |
+| `this.$eqPath(path, keyPath)` | `keyPath` の値（ワイルドカードはこの行で解決） | id | 鍵も依存を張らずに読むので、リストの置換や並べ替えで行が再評価されない |
+| `this.$eqIndex(path, level = 1)` | この行の index（`$1`。`level` でワイルドカード段を選ぶ） | index | `$1` を読む場合と違い getter を **index 依存に記録しない**: 行の移動はリスト差分が鍵を付け替えるので、1 行削除で再評価されるのは高々 2 行 |
+
+```javascript
+export default {
+  items: [],
+  selectedId: null,
+  selectedIndex: null,
+  // id による選択: 並べ替えや削除をまたいで同じ行に付いて行く
+  get "items.*.selected"() { return this.$eqPath("selectedId", "items.*.id"); },
+  // 位置による選択: 同じ仕事量で index に付く
+  get "items.*.current"() { return this.$eqIndex("selectedIndex"); },
+  onSelect(e, $1) { this.selectedId = this["items." + $1 + ".id"]; this.selectedIndex = $1; },
+};
+```
+
+規則: 3 つの呼び出しが購読を張るのはリスト行の getter の中で評価されたときだけで、それ以外では比較結果を返すだけです。行の購読はリスト差分がその行を外した時点で落ちます。鍵の比較は `Object.is` ですが、Map の意味論により `+0` と `-0`、`NaN` 同士は同じ鍵になります。`$eqPath` は鍵を依存なしで読むので、行の鍵がその場で書き換わっても行は再評価されません — 変わらない同一性（id）に使い、鍵自体が動く場合は追跡付きの読みと `$eq` を組み合わせてください。
+
 ### ループインデックス変数（`$1`, `$2`, ...）
 
 getter やイベントハンドラ内で、`this.$1`、`this.$2` などで現在のループイテレーションのインデックスを取得できます（0始まりの値、1始まりの命名）：
@@ -1041,6 +1067,7 @@ export default {
 | `this.$postUpdate(path)` | 指定パスの更新通知を手動で発行 |
 | `this.$trackDependency(path)` | キャッシュ無効化のための依存関係を手動で登録 |
 | `this.$untrackDependency(fn)` | fn 実行中の依存追跡を抑止して値を読む（`$trackDependency` と対称） |
+| `this.$eq(path, key)` / `$eqPath(path, keyPath)` / `$eqIndex(path, level?)` | 鍵付き購読: 「`path` の値はこの行の鍵か」（[鍵付き選択](#鍵付き選択eq--eqpath--eqindex)） |
 | `this.$stateElement` | `IStateElement` インスタンスへのアクセス |
 | `this.$1`, `this.$2`, ... | 現在のループインデックス（1始まりの命名、0始まりの値） |
 
@@ -2641,6 +2668,38 @@ this.$getAll("matrix.*.*", [row]);
 | `$watch` の書き込み連鎖 | 32 | そのバッチの watch 発火をスキップ |
 | バインディングの適用失敗 | — | その 1 本のみスキップ |
 
+### 3.0 への準備（`wcs/v3-migration`）
+
+3.0 は互換層を持ちません。代わりにこのリリースは、3.0 が拒否する書き方・読み方が変わる書き方を 2.x のまま動かしつつ名指しで知らせます。警告は書き方とサイトごとに 1 回だけ、コード `wcs/v3-migration` で出し、3.0 での扱いと今の書き換え先を示します：
+
+```
+[@wcstack/state] [wcs/v3-migration] "value#ro#wo": 3.0 rejects a second "#". Write "value#ro,wo".
+See "Preparing for 3.0" in the @wcstack/state README.
+```
+
+| 書き方 | 2.x | 3.0 | 今の書き方 |
+|---|---|---|---|
+| 2 つ目の `#`（`value#ro#wo:`） | 最初の修飾子列だけ残す | `[wcs/binding-syntax]` | `value#ro,wo:` |
+| `else:` の後ろの値 | 無視 | `[wcs/binding-syntax]` | `else:` |
+| `for` / `if` / `elseif` / `else` / `...` の修飾子・フィルタ | ただのプロパティのバインディングになる | `[wcs/binding-syntax]` | キーワードだけ |
+| `radio#ro:` / `checkbox#ro:` | `radio` という名前のプロパティになり効かない | 修飾子を守る radio / checkbox のバインディング | —（意図どおりか確かめる） |
+| フィルタ引数の閉じていない引用符 | 黙って閉じる | `[wcs/binding-syntax]` | 引用符を閉じる |
+| フィルタが受け取る数を超える引数 | 余りは無視 | `[wcs/filter-arity]` | 余りを消す |
+| `eq` / `ne` の引用符の無い `true` / `false` / `null`（`eq(true)`） | 真偽値・`null` の値を文字列と比べる | 型付きの値と比べる | 文字列で比べ続けるなら `eq('true')` |
+| `defaults` の引用符の無い `true` / `false` / `null` | 文字列（`"null"`）を既定値にする | 型付きの値を既定値にする | 文字列のままなら `defaults('null')` |
+| `truthy` / `falsy` / `defaults` に来た `0n` | 真 | 偽（JavaScript の真偽判定） | — |
+| `textContent` / `innerText` / `innerHTML` への `undefined` | 前のテキストを残す（使い回した行では前の行のもの） | 空にする | 「値なし」は `""` か `null` を返す |
+| `attr.*` への `undefined` / `null` | `"undefined"` / `"null"` を書く | 属性を削除する | — |
+| `style.*` への `undefined` | 前の値を残す | 消す | — |
+| `$resolve(path, indexes, undefined)` | 読む | `undefined` を書く（引数の個数で決める） | 読むなら `$resolve(path, indexes)` |
+| readonly のプロキシからの `$resolve(path, indexes, value)` / `$setAll` | 書く | `This state is readonly.` を投げる | `createState("writable", …)` から書く |
+| `#ro` のマウント（`state#ro: user`）を通るコンポーネントの書き込み | ホストのツリーに書く | `[wcs/mount-readonly]` | ホストで書くか、`#ro` を外す |
+| 部分マウントに隠された自前の既定値（コンポーネントが `name` を宣言し、`state.name: user.name`） | 既定値が勝つ（警告あり） | 明示したマウントが勝つ | 既定値を消す |
+
+もう 1 つは予告でなく先に入れています：ボリュームやマウントされたコンポーネントの `$errorCallback` は黙って無視していましたが、ルート専用のキー（`$commandTokens`、`$on` など）を挙げる既存の警告で名指しするようにしました（3.0 と同じ）。動くのは今もルートの state だけです。
+
+値の警告はその値が実際に来たときにだけ出ます。コンソールが静かでも、テストが通らなかった経路については何も分かりません。文法の行はバインディングを最初に解析したときに調べます。`npx @wcstack/lint <file>`（と VS Code 拡張）も同じ判定で `wcs/v3-migration`（info）として報告するので、ページを動かさずに見つけられます。
+
 ## 設定
 
 `bootstrapState()` に部分的な設定オブジェクトを渡します：

package/README.md

@@ -969,6 +969,7 @@ The rule: **read only through `this`, and don't write state or touch the DOM fro
 | `this.$trackDependency(path)` | Register an extra dependency so this getter is dirtied when that path changes |
 | `this.$postUpdate(path)` | Announce that an untracked input changed, from outside the getter |
 | `this.$untrackDependency(fn)` | Read a path *without* registering it as a dependency (the inverse) |
+| `this.$eq(path, key)` / `$eqPath(path, keyPath)` / `$eqIndex(path)` | A keyed subscription: "is `path` equal to this row's key?" without a pattern dependency (see [Keyed selection](#keyed-selection-eq--eqpath--eqindex)) |
 
 ```javascript
 // ✅ The clock ticks in state; the getter stays pure
@@ -995,6 +996,31 @@ The first rule is the one static analysis can catch: `wcs-validate` and the VS C
 
 `$untrackDependency(fn)` applies the setter rule to a getter on purpose: reads inside `fn` are not tracked. `$trackDependency(path)` is the escape hatch for the first rule.
 
+### Keyed selection (`$eq` / `$eqPath` / `$eqIndex`)
+
+A row getter that answers "is this row the selected one?" is the classic case where dependency tracking scales badly: `get "items.*.selected"() { return this.$1 === this.selectedIndex; }` makes every row depend on `selectedIndex`, so one click re-evaluates 10,000 getters. The keyed forms subscribe each row under **its own key** instead, and a write to the path re-evaluates only the row that was selected and the row that becomes selected:
+
+| API | Key | Selection follows | Notes |
+|---|---|---|---|
+| `this.$eq(path, key)` | any value | the key | `path` is read without a dependency; the row registers under `key` |
+| `this.$eqPath(path, keyPath)` | the value at `keyPath` (wildcards resolve to this row) | the id | reads the key without a dependency too, so replacing or reordering the list never re-evaluates the rows |
+| `this.$eqIndex(path, level = 1)` | this row's index (`$1`; `level` picks the wildcard) | the index | unlike reading `$1`, the getter is **not** recorded as index-dependent: the list diff re-keys moved rows, so removing a row re-evaluates at most two rows |
+
+```javascript
+export default {
+  items: [],
+  selectedId: null,
+  selectedIndex: null,
+  // selection by id: survives sorting and removal
+  get "items.*.selected"() { return this.$eqPath("selectedId", "items.*.id"); },
+  // selection by position: the same row count of work, keyed on the index
+  get "items.*.current"() { return this.$eqIndex("selectedIndex"); },
+  onSelect(e, $1) { this.selectedId = this["items." + $1 + ".id"]; this.selectedIndex = $1; },
+};
+```
+
+Rules: the three calls only subscribe when evaluated inside a getter under a list row (elsewhere they just return the comparison); a row's subscription is dropped when the list diff removes the row; keys compare with `Object.is` except that Map semantics treat `+0`/`-0` and `NaN`/`NaN` as equal. `$eqPath` reads the key without a dependency, so a row whose key changes in place is not re-evaluated by that change — use it for identities that do not change (ids), and `$eq` with a tracked read when the key itself is live.
+
 ### Loop Index Variables (`$1`, `$2`, ...)
 
 Inside getters and event handlers, `this.$1`, `this.$2`, etc. provide the current loop iteration index (0-based value, 1-based naming):
@@ -1041,6 +1067,7 @@ Inside state objects (getters / methods), the following APIs are available via `
 | `this.$postUpdate(path)` | Manually trigger update notification for a path |
 | `this.$trackDependency(path)` | Manually register a dependency for cache invalidation |
 | `this.$untrackDependency(fn)` | Read values inside fn without registering dependencies (symmetric to `$trackDependency`) |
+| `this.$eq(path, key)` / `$eqPath(path, keyPath)` / `$eqIndex(path, level?)` | Keyed subscription for "is this row's key the value of `path`?" (see [Keyed selection](#keyed-selection-eq--eqpath--eqindex)) |
 | `this.$command.<name>` | Access a `CommandToken` declared in `$commandTokens` (see [Command Token](#command-token-method-binding)) |
 | `this.$stateElement` | Access to the `IStateElement` instance |
 | `this.$1`, `this.$2`, ... | Current loop index (1-based naming, 0-based value) |
@@ -2645,6 +2672,38 @@ Every failure mode reports and continues; nothing already applied is reverted:
 | `$watch` write chain | 32 | Skip watch firing for that batch |
 | Binding apply failure | — | Skip that one binding |
 
+### Preparing for 3.0 (`wcs/v3-migration`)
+
+3.0 has no compatibility layer. Instead, this release names each form that 3.0 rejects or reads differently, while still running it the 2.x way. Each warning is printed once per form and site, under the code `wcs/v3-migration`, and says what 3.0 does and what to write now:
+
+```
+[@wcstack/state] [wcs/v3-migration] "value#ro#wo": 3.0 rejects a second "#". Write "value#ro,wo".
+See "Preparing for 3.0" in the @wcstack/state README.
+```
+
+| Form | 2.x | 3.0 | Write now |
+|---|---|---|---|
+| A second `#` (`value#ro#wo:`) | Keeps the first modifier list | `[wcs/binding-syntax]` | `value#ro,wo:` |
+| A value after `else:` | Ignored | `[wcs/binding-syntax]` | `else:` |
+| Modifiers or filters on `for` / `if` / `elseif` / `else` / `...` | A plain property binding | `[wcs/binding-syntax]` | The bare keyword |
+| `radio#ro:` / `checkbox#ro:` | A property named `radio`, no effect | A radio / checkbox binding that honours the modifiers | — (check the binding still does what you meant) |
+| An unterminated quote in filter arguments | Closed silently | `[wcs/binding-syntax]` | Close the quote |
+| More filter arguments than the filter takes | The rest ignored | `[wcs/filter-arity]` | Remove them |
+| Unquoted `true` / `false` / `null` in `eq` / `ne` (`eq(true)`) | Compares a boolean or `null` value with the string | Compares with the typed value | `eq('true')` to keep the text comparison |
+| Unquoted `true` / `false` / `null` in `defaults` | Falls back to the string (`"null"`) | Falls back to the typed value | `defaults('null')` to keep the text |
+| `0n` through `truthy` / `falsy` / `defaults` | Truthy | Falsy (JavaScript truthiness) | — |
+| `undefined` into `textContent` / `innerText` / `innerHTML` | Keeps the previous text (in a reused row, the previous row's) | Empties it | Return `""` or `null` for "no value" |
+| `undefined` / `null` into `attr.*` | Writes `"undefined"` / `"null"` | Removes the attribute | — |
+| `undefined` into `style.*` | Keeps the previous value | Clears it | — |
+| `$resolve(path, indexes, undefined)` | Reads | Writes `undefined` (the argument count decides) | `$resolve(path, indexes)` to read |
+| `$resolve(path, indexes, value)` / `$setAll` on a readonly proxy | Writes | Throws `This state is readonly.` | Write from `createState("writable", …)` |
+| A component writing through a `#ro` mount (`state#ro: user`) | Writes the host's tree | `[wcs/mount-readonly]` | Write on the host, or drop `#ro` |
+| An own default shadowed by a partial mount (`state.name: user.name` while the component declares `name`) | The default wins, with a warning | The explicit mount wins | Remove the default |
+
+One more change arrives early instead of being announced: `$errorCallback` on a volume or a mounted component, which was ignored silently, is now named by the warning that already lists the root-only keys (`$commandTokens`, `$on`, …), as 3.0 does. It still runs only on the root state.
+
+A value warning fires only when that value actually arrives, so a clean console proves nothing about the paths your tests did not reach. The syntax rows are checked when a binding is first parsed, and `npx @wcstack/lint <file>` (and the VS Code extension) reports them with the same check, as `wcs/v3-migration` at info severity, without running the page.
+
 ## Configuration
 
 Pass a partial configuration object to `bootstrapState()`: