@aiquants/virtualscroll 3.6.1 → 3.7.0

package/src/labels.ts

@@ -0,0 +1,236 @@
+/**
+ * @module labels
+ * @description Built-in UI chrome label catalog of the package. Covers exactly the seven strings
+ * the components render on their own: the ScrollBar arrow aria-labels, the VirtualScroll
+ * scroll-to-edge pill texts and the empty-state text. Live-region wording stays consumer-owned
+ * (`liveRegion.format` / `liveRegion.buildMessage`) and is not part of this catalog. The default
+ * locale is `"en"`; `"ja"` is the second locale. No language negotiation happens here: hosts map
+ * `navigator.language` (or anything else) to a supported locale themselves.
+ *
+ * @description パッケージ内蔵の UI クローム文言カタログ。コンポーネント自身が描画する 7 文言
+ * (ScrollBar 矢印の aria-label、VirtualScroll の端スクロールピル文言、空状態文言) だけを対象とし、
+ * ライブリージョンの文言は利用側の所有 (`liveRegion.format` / `liveRegion.buildMessage`) で
+ * 本カタログの対象外。既定ロケールは `"en"`、第 2 ロケールは `"ja"`。言語ネゴシエーションは行わず、
+ * `navigator.language` 等から対応ロケールへの対応付けはホスト側の責務。
+ */
+
+/**
+ * Supported UI chrome locales, in declaration order. The first entry is NOT implicitly the
+ * default — the default lives only in {@link resolveVirtualScrollLocale}.
+ * 対応する UI クロームロケールの一覧 (宣言順)。先頭要素が暗黙の既定値になるわけではなく、
+ * 既定値は {@link resolveVirtualScrollLocale} にのみ存在。
+ */
+export const VIRTUAL_SCROLL_LOCALES = ["en", "ja"] as const
+
+/**
+ * A supported UI chrome locale (`"en"` | `"ja"`).
+ * 対応 UI クロームロケール (`"en"` | `"ja"`)。
+ */
+export type VirtualScrollLocale = (typeof VIRTUAL_SCROLL_LOCALES)[number]
+
+/**
+ * The complete set of built-in chrome strings, one value per rendered surface.
+ * 内蔵クローム文言の完全な集合 (描画面ごとに 1 値)。
+ */
+export type VirtualScrollLabels = {
+    /**
+     * aria-label of the vertical ScrollBar start (up) arrow button.
+     * 縦 ScrollBar 始端 (上) 矢印ボタンの aria-label。
+     */
+    readonly scrollUp: string
+    /**
+     * aria-label of the vertical ScrollBar end (down) arrow button.
+     * 縦 ScrollBar 終端 (下) 矢印ボタンの aria-label。
+     */
+    readonly scrollDown: string
+    /**
+     * aria-label of the horizontal ScrollBar start (left) arrow button.
+     * 横 ScrollBar 始端 (左) 矢印ボタンの aria-label。
+     */
+    readonly scrollLeft: string
+    /**
+     * aria-label of the horizontal ScrollBar end (right) arrow button.
+     * 横 ScrollBar 終端 (右) 矢印ボタンの aria-label。
+     */
+    readonly scrollRight: string
+    /**
+     * Text of the VirtualScroll scroll-to-top pill, shown when
+     * `scrollBarOptions.enableScrollToTopBottomButtons` is on.
+     * `scrollBarOptions.enableScrollToTopBottomButtons` 有効時に表示される VirtualScroll 先頭移動ピルの文言。
+     */
+    readonly scrollToTop: string
+    /**
+     * Text of the VirtualScroll scroll-to-bottom pill, shown when
+     * `scrollBarOptions.enableScrollToTopBottomButtons` is on.
+     * `scrollBarOptions.enableScrollToTopBottomButtons` 有効時に表示される VirtualScroll 末尾移動ピルの文言。
+     */
+    readonly scrollToBottom: string
+    /**
+     * VirtualScroll empty-state text shown when `itemCount === 0`. VirtualGrid shows it too, for
+     * 0 rows, an all-frozen row set and degenerate bands (its embedded VirtualScroll gets 0 items).
+     * `itemCount === 0` 時の VirtualScroll 空状態文言。VirtualGrid も 0 行・全行固定・退化帯で表示
+     * (内蔵 VirtualScroll の項目数が 0 になるため)。
+     */
+    readonly noItems: string
+}
+
+/**
+ * Partial per-key overrides laid over the catalog of the chosen locale. An `undefined` value keeps
+ * the catalog value; any present value must be a string with non-whitespace content.
+ * 選択ロケールのカタログへ重ねるキー単位の部分上書き。`undefined` 値はカタログ値を維持し、
+ * 値を与える場合は空白以外の文字を含む文字列であることが必須。
+ */
+export type VirtualScrollLabelOverrides = { readonly [K in keyof VirtualScrollLabels]?: VirtualScrollLabels[K] }
+
+/**
+ * Every key of {@link VirtualScrollLabels}, in catalog order. This is the closed key set that
+ * overrides are validated against.
+ * {@link VirtualScrollLabels} の全キー (カタログ順)。上書き検証に用いる閉じたキー集合。
+ */
+export const VIRTUAL_SCROLL_LABEL_KEYS = ["scrollUp", "scrollDown", "scrollLeft", "scrollRight", "scrollToTop", "scrollToBottom", "noItems"] as const satisfies readonly (keyof VirtualScrollLabels)[]
+
+// satisfies は部分集合しか保証しないため、キー追加時の登録漏れを型で検出する
+const keysCoverEveryLabel: [Exclude<keyof VirtualScrollLabels, (typeof VIRTUAL_SCROLL_LABEL_KEYS)[number]>] extends [never] ? true : never = true
+void keysCoverEveryLabel
+
+/**
+ * Frozen built-in catalogs per locale. `en` is the package's historical English wording.
+ * ロケールごとの凍結済み内蔵カタログ。`en` はパッケージ従来の英語文言。
+ */
+export const VIRTUAL_SCROLL_LABEL_CATALOGS: Readonly<Record<VirtualScrollLocale, VirtualScrollLabels>> = Object.freeze({
+    en: Object.freeze({
+        scrollUp: "Scroll up",
+        scrollDown: "Scroll down",
+        scrollLeft: "Scroll left",
+        scrollRight: "Scroll right",
+        scrollToTop: "Top",
+        scrollToBottom: "Bottom",
+        noItems: "No items",
+    }),
+    ja: Object.freeze({
+        scrollUp: "上へスクロール",
+        scrollDown: "下へスクロール",
+        scrollLeft: "左へスクロール",
+        scrollRight: "右へスクロール",
+        scrollToTop: "先頭へ",
+        scrollToBottom: "末尾へ",
+        noItems: "項目がありません",
+    }),
+})
+
+/**
+ * Type guard: whether `value` is a member of {@link VIRTUAL_SCROLL_LOCALES}.
+ * `value` が {@link VIRTUAL_SCROLL_LOCALES} の要素かどうかの型ガード。
+ *
+ * @param value - Candidate value / 判定対象の値
+ * @returns `true` when `value` is a supported locale / 対応ロケールなら `true`
+ */
+const isVirtualScrollLocale = (value: unknown): value is VirtualScrollLocale => (VIRTUAL_SCROLL_LOCALES as readonly unknown[]).includes(value)
+
+/**
+ * Describes a rejected input for an error message without ever throwing: JSON for strings,
+ * `"null"` for `null`, otherwise the `typeof` tag. Never calls `String()` / `JSON.stringify` on
+ * arbitrary values, so BigInt, Symbol and null-prototype inputs still produce the documented
+ * RangeError with an accurate description.
+ * 拒否した入力をエラーメッセージ用に説明 (例外を投げない)。文字列は JSON 表記、`null` は `"null"`、
+ * それ以外は `typeof` のタグ。任意値へ `String()` / `JSON.stringify` を適用しないため、BigInt・Symbol・
+ * null プロトタイプの入力でも文書どおりの RangeError と正確な説明を維持。
+ *
+ * @param value - Rejected input / 拒否した入力
+ * @returns A short, non-throwing description of `value` / `value` の短い説明 (例外なし)
+ */
+const describeRejectedValue = (value: unknown): string => {
+    if (typeof value === "string") {
+        return JSON.stringify(value)
+    }
+    if (value === null) {
+        return "null"
+    }
+    return typeof value
+}
+
+/**
+ * Resolves the UI chrome locale. `undefined` (an absent prop) maps to the default `"en"`; a member
+ * of {@link VIRTUAL_SCROLL_LOCALES} is returned as-is. This is the single place the default lives.
+ * UI クロームロケールの解決。`undefined` (prop 未指定) は既定の `"en"`、
+ * {@link VIRTUAL_SCROLL_LOCALES} の要素はそのまま返却。既定値を持つ唯一の場所。
+ *
+ * @param locale - Requested locale, or `undefined` for the default / 要求ロケール (`undefined` で既定)
+ * @returns The resolved supported locale / 解決済みの対応ロケール
+ * @throws {RangeError} When `locale` is neither `undefined` nor a supported locale (`null`, `""`,
+ * `"EN"`, `"ja-JP"`, `"fr"`, numbers, ...) — no language negotiation /
+ * `undefined` でも対応ロケールでもない場合 (`null`、`""`、`"EN"`、`"ja-JP"`、`"fr"`、数値など)。言語ネゴシエーションなし
+ */
+export const resolveVirtualScrollLocale = (locale: VirtualScrollLocale | undefined): VirtualScrollLocale => {
+    if (locale === undefined) {
+        return "en"
+    }
+    if (isVirtualScrollLocale(locale)) {
+        return locale
+    }
+    const allowed = VIRTUAL_SCROLL_LOCALES.map((candidate) => JSON.stringify(candidate)).join(", ")
+    throw new RangeError(`[virtualscroll] locale must be one of ${allowed}; got ${describeRejectedValue(locale)}`)
+}
+
+/**
+ * Type guard: whether `key` is a member of {@link VIRTUAL_SCROLL_LABEL_KEYS}.
+ * `key` が {@link VIRTUAL_SCROLL_LABEL_KEYS} の要素かどうかの型ガード。
+ *
+ * @param key - Candidate own key of an overrides object / 上書きオブジェクトの自身のキー候補
+ * @returns `true` when `key` is a label key / ラベルキーなら `true`
+ */
+const isVirtualScrollLabelKey = (key: string): key is keyof VirtualScrollLabels => (VIRTUAL_SCROLL_LABEL_KEYS as readonly string[]).includes(key)
+
+/**
+ * Resolves the effective labels: the catalog of the resolved locale overlaid by `overrides`.
+ * Returns the frozen catalog itself (same identity) when `overrides` is `undefined`, otherwise a
+ * new frozen object. Inputs are never mutated.
+ * 実効ラベルの解決。解決済みロケールのカタログへ `overrides` を重ねた結果。`overrides` が
+ * `undefined` なら凍結カタログそのもの (同一参照)、それ以外は新しい凍結オブジェクトを返却。入力は不変。
+ *
+ * @param locale - Requested locale, or `undefined` for the default / 要求ロケール (`undefined` で既定)
+ * @param overrides - Per-key overrides, or `undefined` for none / キー単位の上書き (`undefined` で上書きなし)
+ * @returns The resolved, frozen labels / 解決済みの凍結ラベル
+ * @throws {RangeError} When the locale is unsupported, `overrides` is `null` or not an object,
+ * `overrides` is not a plain object (its prototype is neither `Object.prototype` nor `null`, e.g.
+ * an array or a class instance), an own key is not a label key, or a present own value is not a
+ * string with non-whitespace content. Only own properties are read /
+ * ロケールが非対応、`overrides` が `null` または非オブジェクト、`overrides` が素のオブジェクトでない
+ * (プロトタイプが `Object.prototype` でも `null` でもない。配列やクラスインスタンスなど)、自身のキーが
+ * ラベルキー外、または与えられた自身の値が空白以外の文字を含む文字列でない場合。読むのは自身の
+ * プロパティのみ
+ */
+export const resolveVirtualScrollLabels = (locale: VirtualScrollLocale | undefined, overrides: VirtualScrollLabelOverrides | undefined): VirtualScrollLabels => {
+    const catalog = VIRTUAL_SCROLL_LABEL_CATALOGS[resolveVirtualScrollLocale(locale)]
+    if (overrides === undefined) {
+        return catalog
+    }
+    if (overrides === null || typeof overrides !== "object") {
+        throw new RangeError(`[virtualscroll] labels must be an object; got ${describeRejectedValue(overrides)}`)
+    }
+    // 既知キー検査は自身のキーしか見ないため、継承経路を持つ入力 (配列・クラスインスタンス・
+    // 他オブジェクト継承) を許すと継承側の綴り誤りが無言で無視される
+    const prototype: unknown = Object.getPrototypeOf(overrides)
+    if (prototype !== Object.prototype && prototype !== null) {
+        throw new RangeError(`[virtualscroll] labels must be a plain object (prototype Object.prototype or null); got ${Array.isArray(overrides) ? "an array" : "an object with a non-plain prototype"}`)
+    }
+    const ownKeys = new Set(Object.keys(overrides))
+    for (const key of ownKeys) {
+        if (!isVirtualScrollLabelKey(key)) {
+            throw new RangeError(`[virtualscroll] labels.${key} is not a known label key; expected one of ${VIRTUAL_SCROLL_LABEL_KEYS.join(", ")}`)
+        }
+    }
+    const resolved: Record<keyof VirtualScrollLabels, string> = { ...catalog }
+    for (const key of VIRTUAL_SCROLL_LABEL_KEYS) {
+        // 検査したのと同じ自身のキー集合だけを読み、Object.prototype 汚染で継承されたラベルキーを拾わない
+        const value: unknown = ownKeys.has(key) ? overrides[key] : undefined
+        if (value === undefined) {
+            continue
+        }
+        if (typeof value !== "string" || value.trim() === "") {
+            throw new RangeError(`[virtualscroll] labels.${key} must be a non-blank string; got ${describeRejectedValue(value)}`)
+        }
+        resolved[key] = value
+    }
+    return Object.freeze(resolved)
+}