@aiquants/spreadsheet 0.12.0 → 0.13.0

package/src/model/validationMessages.ts

@@ -0,0 +1,203 @@
+/**
+ * @fileoverview Built-in data-validation verdict messages per UI chrome locale — the table that
+ * validateCellText reads when a rule carries no `errorMessage`. INTERNAL: not exported from the
+ * package barrel; the public override stays the per-rule `errorMessage`. Pure, React-free.
+ *
+ * Contract (pinned by validationMessages.spec.ts and dataValidation.spec.ts):
+ * - One frozen ValidationMessageCatalog per SpreadsheetLocale; every template takes the bounds
+ *   already normalised by dataValidation.ts (number / date bounds trimmed, textLength bounds
+ *   stringified, checkbox strings defaulted) and never re-normalises them.
+ * - Templates are WHOLE SENTENCES per (rule type, op): Japanese puts the bound before the
+ *   predicate, so a fragment table ("greater than" + bound) cannot express it.
+ * - `en` is byte-identical to the pre-i18n English summaries ("Value must be a number greater
+ *   than 5." etc.); `ja` follows the workspace Japanese spacing rule (a half-width space around
+ *   ASCII alphanumerics, 「」 exempt).
+ * - between / notBetween receive `b` only for complete rules: an incomplete rule is inert and
+ *   never produces a message.
+ *
+ * UI クロームロケール別の組込みデータ検証メッセージ — 規則に `errorMessage` が無いとき
+ * validateCellText が読む表。内部専用 (パッケージの barrel からは export しない — 公開の上書き手段は
+ * 規則毎の `errorMessage`)。純関数・React 非依存。
+ * 契約: SpreadsheetLocale 毎に凍結した ValidationMessageCatalog を 1 つ持ち、各テンプレートは
+ * dataValidation.ts が正規化済みの境界 (number / date は trim、textLength は文字列化、checkbox は既定
+ * 適用済み) を受け取り再正規化しない。テンプレートは (規則型, op) 毎の文全体 (日本語は境界が述語より
+ * 前に来るため、断片表では表現不能)。`en` は i18n 以前の英語要約とバイト単位で同一、`ja` は
+ * ワークスペースの和文スペース規則 (半角英数字の前後に半角スペース、「」内は対象外) に従う。
+ * between / notBetween の `b` は完全な規則でだけ渡る (不完全な規則は不活性でメッセージを作らない)。
+ */
+
+import type { ValidationCompareOp, ValidationTextOp } from "./dataValidation.ts"
+import type { SpreadsheetLocale } from "./labels.ts"
+
+/**
+ * Whole-sentence templates of one ordered rule family (number / textLength / date), one per
+ * comparison op; `b` is the upper bound for between / notBetween and unused by the other six.
+ * 順序規則族 (number / textLength / date) 1 つ分の文全体テンプレート (比較 op 毎に 1 つ)。`b` は
+ * between / notBetween の上限で、他の 6 op では未使用。
+ */
+type CompareTemplates = { readonly [K in ValidationCompareOp]: (a: string, b: string | undefined) => string }
+
+/**
+ * The built-in verdict messages of one locale: a sentence for `list`, per-op templates for the
+ * three ordered families, per-op templates for `text` (the four needle ops take the needle; the
+ * two shape checks are fixed sentences), and templates for `checkbox` and `custom`.
+ * 1 ロケール分の組込み判定メッセージ。list の文、順序 3 族の op 別テンプレート、text の op 別
+ * テンプレート (needle 系 4 op は探索文字列を受け取り、形式検査 2 op は固定文)、checkbox と custom の
+ * テンプレート。
+ */
+export type ValidationMessageCatalog = {
+    readonly list: string
+    readonly number: CompareTemplates
+    readonly textLength: CompareTemplates
+    readonly date: CompareTemplates
+    readonly text: {
+        readonly contains: (v: string) => string
+        readonly notContains: (v: string) => string
+        readonly startsWith: (v: string) => string
+        readonly endsWith: (v: string) => string
+        readonly isEmail: string
+        readonly isUrl: string
+    }
+    readonly checkbox: (checked: string, unchecked: string) => string
+    readonly custom: (formula: string) => string
+}
+
+/** Compile-time proof that the `text` templates are keyed by exactly the ValidationTextOp vocabulary (a new op without a message, or a stray key, turns tsc red). / text テンプレートのキーが ValidationTextOp 語彙と完全一致することの型水準の証明 (メッセージの無い新 op や余分なキーは tsc が赤)。 */
+const textTemplatesMatchTextOps: [keyof ValidationMessageCatalog["text"]] extends [ValidationTextOp] ? ([ValidationTextOp] extends [keyof ValidationMessageCatalog["text"]] ? true : never) : never = true
+void textTemplatesMatchTextOps
+
+/** English wording of the four ordered ops of one family (the other four are shared). / 規則族 1 つ分の順序 4 op の英語の言い回し (残る 4 つは共通)。 */
+type OrderWords = { readonly gt: string; readonly gte: string; readonly lt: string; readonly lte: string }
+
+/** English wording for number / textLength messages. / number / textLength メッセージの英語の言い回し。 */
+const NUMERIC_WORDS: OrderWords = { gt: "greater than", gte: "greater than or equal to", lt: "less than", lte: "less than or equal to" }
+
+/** English wording for date messages. / date メッセージの英語の言い回し。 */
+const DATE_WORDS: OrderWords = { gt: "after", gte: "on or after", lt: "before", lte: "on or before" }
+
+/**
+ * English phrase for an ordered op with the family wording: "greater than 5", "between 1 and 9", ...
+ * 規則族の語彙を使った順序 op の英語句 ("greater than 5"、"between 1 and 9" など)。
+ *
+ * @param op - The comparison op / 比較 op
+ * @param a - The normalised lower (or only) bound / 正規化済みの下限 (または唯一の境界)
+ * @param b - The normalised upper bound for between / notBetween / between 系の正規化済み上限
+ * @param words - The family wording of the four ordered ops / 順序 4 op の規則族別の言い回し
+ * @returns The comparison phrase without subject or full stop / 主語と句点を含まない比較句
+ */
+const comparePhrase = (op: ValidationCompareOp, a: string, b: string | undefined, words: OrderWords): string => {
+    switch (op) {
+        case "gt":
+        case "gte":
+        case "lt":
+        case "lte":
+            return `${words[op]} ${a}`
+        case "eq":
+            return `equal to ${a}`
+        case "neq":
+            return `not equal to ${a}`
+        case "between":
+            return `between ${a} and ${b}`
+        default:
+            // 残る順序 op は notBetween (語彙外の op は dataValidation.ts の assertRuleShape が先に拒否済み)
+            return `not between ${a} and ${b}`
+    }
+}
+
+/**
+ * Builds the English templates of one ordered family as `${subject} ${phrase}.`, e.g.
+ * "Value must be a number greater than 5.".
+ * 順序規則族 1 つ分の英語テンプレートを `${subject} ${phrase}.` の形で構築 (例:
+ * "Value must be a number greater than 5.")。
+ *
+ * @param subject - The sentence head before the comparison phrase / 比較句の前に置く文頭
+ * @param words - The family wording of the four ordered ops / 順序 4 op の規則族別の言い回し
+ * @returns The frozen per-op templates / op 別の凍結テンプレート
+ */
+const englishCompareTemplates = (subject: string, words: OrderWords): CompareTemplates => {
+    const sentence =
+        (op: ValidationCompareOp) =>
+        (a: string, b: string | undefined): string =>
+            `${subject} ${comparePhrase(op, a, b, words)}.`
+    return Object.freeze({
+        gt: sentence("gt"),
+        gte: sentence("gte"),
+        lt: sentence("lt"),
+        lte: sentence("lte"),
+        eq: sentence("eq"),
+        neq: sentence("neq"),
+        between: sentence("between"),
+        notBetween: sentence("notBetween"),
+    })
+}
+
+/** The English catalog — byte-identical to the pre-i18n built-in summaries. / 英語カタログ — i18n 以前の組込み要約とバイト単位で同一。 */
+const EN: ValidationMessageCatalog = Object.freeze({
+    list: "Value must be one of the list items.",
+    number: englishCompareTemplates("Value must be a number", NUMERIC_WORDS),
+    textLength: englishCompareTemplates("Text length must be", NUMERIC_WORDS),
+    date: englishCompareTemplates("Value must be a date", DATE_WORDS),
+    text: Object.freeze({
+        contains: (v: string) => `Value must contain "${v}".`,
+        notContains: (v: string) => `Value must not contain "${v}".`,
+        startsWith: (v: string) => `Value must start with "${v}".`,
+        endsWith: (v: string) => `Value must end with "${v}".`,
+        isEmail: "Value must be a valid email address.",
+        isUrl: "Value must be a valid URL.",
+    }),
+    checkbox: (checked: string, unchecked: string) => `Value must be "${checked}" or "${unchecked}".`,
+    custom: (formula: string) => `Value does not satisfy the formula ${formula}.`,
+})
+
+/** The Japanese catalog — whole sentences with the bound first. / 日本語カタログ — 境界を先に置いた文全体。 */
+const JA: ValidationMessageCatalog = Object.freeze({
+    list: "リストの項目のいずれかを入力してください。",
+    number: Object.freeze({
+        gt: (a: string) => `${a} より大きい数値を入力してください。`,
+        gte: (a: string) => `${a} 以上の数値を入力してください。`,
+        lt: (a: string) => `${a} より小さい数値を入力してください。`,
+        lte: (a: string) => `${a} 以下の数値を入力してください。`,
+        eq: (a: string) => `${a} に等しい数値を入力してください。`,
+        neq: (a: string) => `${a} 以外の数値を入力してください。`,
+        between: (a: string, b: string | undefined) => `${a} から ${b} までの数値を入力してください。`,
+        notBetween: (a: string, b: string | undefined) => `${a} から ${b} までの範囲外の数値を入力してください。`,
+    }),
+    textLength: Object.freeze({
+        gt: (a: string) => `${a} 文字より長いテキストを入力してください。`,
+        gte: (a: string) => `${a} 文字以上のテキストを入力してください。`,
+        lt: (a: string) => `${a} 文字より短いテキストを入力してください。`,
+        lte: (a: string) => `${a} 文字以下のテキストを入力してください。`,
+        eq: (a: string) => `${a} 文字のテキストを入力してください。`,
+        neq: (a: string) => `${a} 文字以外の長さのテキストを入力してください。`,
+        between: (a: string, b: string | undefined) => `${a} 文字から ${b} 文字までのテキストを入力してください。`,
+        notBetween: (a: string, b: string | undefined) => `${a} 文字から ${b} 文字までの範囲外の長さのテキストを入力してください。`,
+    }),
+    date: Object.freeze({
+        gt: (a: string) => `${a} より後の日付を入力してください。`,
+        gte: (a: string) => `${a} 以降の日付を入力してください。`,
+        lt: (a: string) => `${a} より前の日付を入力してください。`,
+        lte: (a: string) => `${a} 以前の日付を入力してください。`,
+        eq: (a: string) => `${a} の日付を入力してください。`,
+        neq: (a: string) => `${a} 以外の日付を入力してください。`,
+        between: (a: string, b: string | undefined) => `${a} から ${b} までの日付を入力してください。`,
+        notBetween: (a: string, b: string | undefined) => `${a} から ${b} までの範囲外の日付を入力してください。`,
+    }),
+    text: Object.freeze({
+        contains: (v: string) => `「${v}」を含む値を入力してください。`,
+        notContains: (v: string) => `「${v}」を含まない値を入力してください。`,
+        startsWith: (v: string) => `「${v}」で始まる値を入力してください。`,
+        endsWith: (v: string) => `「${v}」で終わる値を入力してください。`,
+        isEmail: "有効なメールアドレスを入力してください。",
+        isUrl: "有効な URL を入力してください。",
+    }),
+    checkbox: (checked: string, unchecked: string) => `「${checked}」または「${unchecked}」を入力してください。`,
+    custom: (formula: string) => `数式 ${formula} を満たす値を入力してください。`,
+})
+
+/**
+ * The built-in verdict messages per UI chrome locale (frozen at every level). Keyed by exactly the
+ * SpreadsheetLocale set, so validateCellText checks a locale by own-key membership here.
+ * UI クロームロケール別の組込み判定メッセージ (全階層で凍結)。キーは SpreadsheetLocale 集合と完全一致
+ * するため、validateCellText はここへの自身のキーの所属でロケールを検査する。
+ */
+export const VALIDATION_MESSAGE_CATALOGS: Readonly<Record<SpreadsheetLocale, ValidationMessageCatalog>> = Object.freeze({ en: EN, ja: JA })