learned-kanji 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ohzono
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,106 @@
+# learned-kanji
+
+Check whether Japanese text uses only the kanji that have been taught by a given school grade in Japan.
+
+日本の学習指導要領に基づき、文章が「その学年までに習う漢字」だけで書かれているかを判定します。
+
+- Based on the official tables: 学年別漢字配当表 (1026 kanji, grades 1–6) and 常用漢字表 (2136 kanji)
+- Zero dependencies, ~16 KB, works in browsers and Node.js (ESM / CJS, TypeScript types included)
+- Fast: one pass over the string with a `Uint8Array` lookup, no regular expressions
+
+```sh
+npm install --save-dev learned-kanji
+```
+
+## Usage
+
+```ts
+import { isLearnedBy, unlearnedKanji } from 'learned-kanji';
+
+isLearnedBy('山と川', 1); // true
+isLearnedBy('海', 1); // false (海 is taught in grade 2)
+isLearnedBy('憂鬱な語彙', 9); // true
+isLearnedBy('薔薇', 9); // false
+
+unlearnedKanji('薔薇と海', 1); // ['薔', '薇', '海']
+```
+
+In a test, use `unlearnedKanji` so that a failure tells you which characters are wrong:
+
+```ts
+import { expect, test } from 'vitest';
+import { unlearnedKanji } from 'learned-kanji';
+import messages from '../src/locales/ja.json';
+
+test('UI text uses only kanji taught by the end of junior high school', () => {
+  for (const [key, text] of Object.entries(messages)) {
+    expect(unlearnedKanji(text, 9), key).toEqual([]);
+  }
+});
+```
+
+## Grades
+
+| `grade` | School year | Kanji allowed |
+| --- | --- | --- |
+| `1` – `6` | 小学校 1–6 年 | Cumulative 学年別漢字配当表: 80 / 240 / 440 / 642 / 835 / 1026 |
+| `7` – `9` | 中学校 1–3 年 | All of 常用漢字表: 2136 |
+
+The grade is inclusive: `isLearnedBy(text, 3)` means "taught by the end of grade 3".
+
+**7, 8 and 9 are the same set.** 中学校学習指導要領 does not allocate kanji to individual grades; it only says that students learn to read most of the 常用漢字 by the end of grade 9. There is no official data that tells grade 7 from grade 8, so this package does not invent one.
+
+## API
+
+### `isLearnedBy(text, grade, options?): boolean`
+
+`true` when every kanji in `text` has been taught by the end of `grade`. Stops at the first offending character.
+
+### `unlearnedKanji(text, grade, options?): string[]`
+
+The kanji that have not been taught by the end of `grade`: unique, in order of appearance.
+
+### `levelOfKanji(char, options?): 1 | 2 | 3 | 4 | 5 | 6 | 'secondary' | undefined`
+
+Where a single kanji is first taught. `'secondary'` means 常用漢字 outside the 配当表; `undefined` means it is not taught (or is not a single kanji).
+
+### `kanjiLearnedBy(grade): string[]`
+
+All kanji taught by the end of `grade`, in the order of the official tables.
+
+### `options.strict`
+
+常用漢字表 prints four characters in a form that differs from the one normally typed: 𠮟 塡 剝 頰. Almost all real text uses 叱 填 剥 頬 instead, so **both forms are accepted by default**. Pass `{ strict: true }` to accept only the official forms.
+
+Note that 𠮟 is U+20B9F, outside the BMP. It is handled correctly.
+
+### What is ignored
+
+Only kanji are judged. Hiragana, katakana, Latin letters, digits, punctuation, emoji and the iteration mark 々 always pass. Every CJK ideograph that is not in the tables (CJK Unified Ideographs, Extension A, Extension B and later, compatibility ideographs) fails.
+
+Radical characters (CJK Radicals Supplement and Kangxi Radicals, U+2E80–U+2FDF) also fail. They look identical to real kanji — `⼭` U+2F2D renders like `山` — and usually get into text through copy and paste from PDFs, so letting them pass would defeat the check.
+
+The text is not normalized. Enclosed and squared forms such as ㈱ ㊙ ㍻ are treated as symbols and pass; call `text.normalize('NFKC')` first if you want them judged as 株 秘 平成.
+
+Readings are not considered: a kanji counts as learned from the grade it is allocated to, even if a particular reading is taught later.
+
+## Complexity and limits
+
+- `isLearnedBy` is O(n) time and O(1) memory: one pass, one table lookup per character, no allocation, and it returns at the first offending kanji. About 3 ms per million characters on an M-series Mac.
+- `unlearnedKanji` is O(n) time. Its memory is bounded by the number of distinct offending kanji, not by the length of the text.
+- There is no length limit other than the maximum string length of the JavaScript engine (about 2^29 characters in V8). No regular expressions are used, so there is no backtracking and no ReDoS risk with untrusted input.
+- Importing the module builds a 21 KB table once (2140 writes).
+- `text` must be a string; this is enforced by the TypeScript types only. An invalid `grade` throws a `RangeError`.
+
+## Data sources
+
+- 文部科学省「小学校学習指導要領（平成29年告示）」国語 別表「学年別漢字配当表」, in force since April 2020
+- 文化庁「常用漢字表」（平成22年内閣告示第2号）
+
+The grade table was checked against two independent transcriptions and against the list of changes published in 文部科学省「小学校学習指導要領（平成29年告示）解説 国語編」 (20 kanji added, 25 prefecture kanji in grade 4, 32 kanji moved). The 常用漢字 list was checked against two independent transcriptions. The character counts are fixed by tests.
+
+Some older packages still ship the previous table (1006 kanji). This one does not.
+
+## License
+
+MIT. The kanji tables themselves are published by the Japanese government.

package/dist/cjs/data.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Source data. Edit this file only when the official tables are revised.
+ *
+ * - GRADE_1..6: 文部科学省「小学校学習指導要領（平成29年告示）」国語 別表「学年別漢字配当表」
+ *   (in force since April 2020; 1026 characters, listed in the official order)
+ * - SECONDARY: 文化庁「常用漢字表」（平成22年内閣告示第2号, 2136 characters) minus the 1026 above.
+ *   中学校学習指導要領 does not allocate these to individual grades.
+ */
+/** 第1学年 (80字) */
+export declare const GRADE_1: string;
+/** 第2学年 (160字) */
+export declare const GRADE_2: string;
+/** 第3学年 (200字) */
+export declare const GRADE_3: string;
+/** 第4学年 (202字) */
+export declare const GRADE_4: string;
+/** 第5学年 (193字) */
+export declare const GRADE_5: string;
+/** 第6学年 (191字) */
+export declare const GRADE_6: string;
+/** 常用漢字のうち学年別漢字配当表にない字 (1110字) */
+export declare const SECONDARY: string;

package/dist/cjs/data.js

@@ -0,0 +1,73 @@
+"use strict";
+/**
+ * Source data. Edit this file only when the official tables are revised.
+ *
+ * - GRADE_1..6: 文部科学省「小学校学習指導要領（平成29年告示）」国語 別表「学年別漢字配当表」
+ *   (in force since April 2020; 1026 characters, listed in the official order)
+ * - SECONDARY: 文化庁「常用漢字表」（平成22年内閣告示第2号, 2136 characters) minus the 1026 above.
+ *   中学校学習指導要領 does not allocate these to individual grades.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SECONDARY = exports.GRADE_6 = exports.GRADE_5 = exports.GRADE_4 = exports.GRADE_3 = exports.GRADE_2 = exports.GRADE_1 = void 0;
+/** 第1学年 (80字) */
+exports.GRADE_1 = '一右雨円王音下火花貝学気九休玉金空月犬見五口校左三山子四糸字耳七車手十出女小上森' +
+    '人水正生青夕石赤千川先早草足村大男竹中虫町天田土二日入年白八百文木本名目立力林六';
+/** 第2学年 (160字) */
+exports.GRADE_2 = '引羽雲園遠何科夏家歌画回会海絵外角楽活間丸岩顔汽記帰弓牛魚京強教近兄形計元言原戸' +
+    '古午後語工公広交光考行高黄合谷国黒今才細作算止市矢姉思紙寺自時室社弱首秋週春書少' +
+    '場色食心新親図数西声星晴切雪船線前組走多太体台地池知茶昼長鳥朝直通弟店点電刀冬当' +
+    '東答頭同道読内南肉馬売買麦半番父風分聞米歩母方北毎妹万明鳴毛門夜野友用曜来里理話';
+/** 第3学年 (200字) */
+exports.GRADE_3 = '悪安暗医委意育員院飲運泳駅央横屋温化荷界開階寒感漢館岸起期客究急級宮球去橋業曲局' +
+    '銀区苦具君係軽血決研県庫湖向幸港号根祭皿仕死使始指歯詩次事持式実写者主守取酒受州' +
+    '拾終習集住重宿所暑助昭消商章勝乗植申身神真深進世整昔全相送想息速族他打対待代第題' +
+    '炭短談着注柱丁帳調追定庭笛鉄転都度投豆島湯登等動童農波配倍箱畑発反坂板皮悲美鼻筆' +
+    '氷表秒病品負部服福物平返勉放味命面問役薬由油有遊予羊洋葉陽様落流旅両緑礼列練路和';
+/** 第4学年 (202字) */
+exports.GRADE_4 = '愛案以衣位茨印英栄媛塩岡億加果貨課芽賀改械害街各覚潟完官管関観願岐希季旗器機議求' +
+    '泣給挙漁共協鏡競極熊訓軍郡群径景芸欠結建健験固功好香候康佐差菜最埼材崎昨札刷察参' +
+    '産散残氏司試児治滋辞鹿失借種周祝順初松笑唱焼照城縄臣信井成省清静席積折節説浅戦選' +
+    '然争倉巣束側続卒孫帯隊達単置仲沖兆低底的典伝徒努灯働特徳栃奈梨熱念敗梅博阪飯飛必' +
+    '票標不夫付府阜富副兵別辺変便包法望牧末満未民無約勇要養浴利陸良料量輪類令冷例連老' +
+    '労録';
+/** 第5学年 (193字) */
+exports.GRADE_5 = '圧囲移因永営衛易益液演応往桜可仮価河過快解格確額刊幹慣眼紀基寄規喜技義逆久旧救居' +
+    '許境均禁句型経潔件険検限現減故個護効厚耕航鉱構興講告混査再災妻採際在財罪殺雑酸賛' +
+    '士支史志枝師資飼示似識質舎謝授修述術準序招証象賞条状常情織職制性政勢精製税責績接' +
+    '設絶祖素総造像増則測属率損貸態団断築貯張停提程適統堂銅導得毒独任燃能破犯判版比肥' +
+    '非費備評貧布婦武復複仏粉編弁保墓報豊防貿暴脈務夢迷綿輸余容略留領歴';
+/** 第6学年 (191字) */
+exports.GRADE_6 = '胃異遺域宇映延沿恩我灰拡革閣割株干巻看簡危机揮貴疑吸供胸郷勤筋系敬警劇激穴券絹権' +
+    '憲源厳己呼誤后孝皇紅降鋼刻穀骨困砂座済裁策冊蚕至私姿視詞誌磁射捨尺若樹収宗就衆従' +
+    '縦縮熟純処署諸除承将傷障蒸針仁垂推寸盛聖誠舌宣専泉洗染銭善奏窓創装層操蔵臓存尊退' +
+    '宅担探誕段暖値宙忠著庁頂腸潮賃痛敵展討党糖届難乳認納脳派拝背肺俳班晩否批秘俵腹奮' +
+    '並陛閉片補暮宝訪亡忘棒枚幕密盟模訳郵優預幼欲翌乱卵覧裏律臨朗論';
+/** 常用漢字のうち学年別漢字配当表にない字 (1110字) */
+exports.SECONDARY = '亜哀挨曖握扱宛嵐依威為畏尉萎偉椅彙違維慰緯壱逸芋咽姻淫陰隠韻唄鬱畝浦詠影鋭疫悦越' +
+    '謁閲炎怨宴援煙猿鉛縁艶汚凹押旺欧殴翁奥憶臆虞乙俺卸穏佳苛架華菓渦嫁暇禍靴寡箇稼蚊' +
+    '牙瓦雅餓介戒怪拐悔皆塊楷潰壊懐諧劾崖涯慨蓋該概骸垣柿核殻郭較隔獲嚇穫岳顎掛括喝渇' +
+    '葛滑褐轄且釜鎌刈甘汗缶肝冠陥乾勘患貫喚堪換敢棺款閑勧寛歓監緩憾還環韓艦鑑含玩頑企' +
+    '伎忌奇祈軌既飢鬼亀幾棋棄毀畿輝騎宜偽欺儀戯擬犠菊吉喫詰却脚虐及丘朽臼糾嗅窮巨拒拠' +
+    '虚距御凶叫狂享況峡挟狭恐恭脅矯響驚仰暁凝巾斤菌琴僅緊錦謹襟吟駆惧愚偶遇隅串屈掘窟' +
+    '繰勲薫刑茎契恵啓掲渓蛍傾携継詣慶憬稽憩鶏迎鯨隙撃桁傑肩倹兼剣拳軒圏堅嫌献遣賢謙鍵' +
+    '繭顕懸幻玄弦舷股虎孤弧枯雇誇鼓錮顧互呉娯悟碁勾孔巧甲江坑抗攻更拘肯侯恒洪荒郊貢控' +
+    '梗喉慌硬絞項溝綱酵稿衡購乞拷剛傲豪克酷獄駒込頃昆恨婚痕紺魂墾懇沙唆詐鎖挫采砕宰栽' +
+    '彩斎債催塞歳載剤削柵索酢搾錯咲刹拶撮擦桟惨傘斬暫旨伺刺祉肢施恣脂紫嗣雌摯賜諮侍慈' +
+    '餌璽軸𠮟疾執湿嫉漆芝赦斜煮遮邪蛇酌釈爵寂朱狩殊珠腫趣寿呪需儒囚舟秀臭袖羞愁酬醜蹴' +
+    '襲汁充柔渋銃獣叔淑粛塾俊瞬旬巡盾准殉循潤遵庶緒如叙徐升召匠床抄肖尚昇沼宵症祥称渉' +
+    '紹訟掌晶焦硝粧詔奨詳彰憧衝償礁鐘丈冗浄剰畳壌嬢錠譲醸拭殖飾触嘱辱尻伸芯辛侵津唇娠' +
+    '振浸紳診寝慎審震薪刃尽迅甚陣尋腎須吹炊帥粋衰酔遂睡穂随髄枢崇据杉裾瀬是姓征斉牲凄' +
+    '逝婿誓請醒斥析脊隻惜戚跡籍拙窃摂仙占扇栓旋煎羨腺詮践箋潜遷薦繊鮮禅漸膳繕狙阻租措' +
+    '粗疎訴塑遡礎双壮荘捜挿桑掃曹曽爽喪痩葬僧遭槽踪燥霜騒藻憎贈即促捉俗賊遜汰妥唾堕惰' +
+    '駄耐怠胎泰堆袋逮替滞戴滝択沢卓拓託濯諾濁但脱奪棚誰丹旦胆淡嘆端綻鍛弾壇恥致遅痴稚' +
+    '緻畜逐蓄秩窒嫡抽衷酎鋳駐弔挑彫眺釣貼超跳徴嘲澄聴懲勅捗沈珍朕陳鎮椎墜塚漬坪爪鶴呈' +
+    '廷抵邸亭貞帝訂逓偵堤艇締諦泥摘滴溺迭哲徹撤添塡殿斗吐妬途渡塗賭奴怒到逃倒凍唐桃透' +
+    '悼盗陶塔搭棟痘筒稲踏謄藤闘騰洞胴瞳峠匿督篤凸突屯豚頓貪鈍曇丼那謎鍋軟尼弐匂虹尿妊' +
+    '忍寧捻粘悩濃把覇婆罵杯排廃輩培陪媒賠伯拍泊迫剝舶薄漠縛爆箸肌鉢髪伐抜罰閥氾帆汎伴' +
+    '畔般販斑搬煩頒範繁藩蛮盤妃彼披卑疲被扉碑罷避尾眉微膝肘匹泌姫漂苗描猫浜賓頻敏瓶扶' +
+    '怖附訃赴浮符普腐敷膚賦譜侮舞封伏幅覆払沸紛雰噴墳憤丙併柄塀幣弊蔽餅壁璧癖蔑偏遍哺' +
+    '捕舗募慕簿芳邦奉抱泡胞俸倣峰砲崩蜂飽褒縫乏忙坊妨房肪某冒剖紡傍帽貌膨謀頰朴睦僕墨' +
+    '撲没勃堀奔翻凡盆麻摩磨魔昧埋膜枕又抹慢漫魅岬蜜妙眠矛霧娘冥銘滅免麺茂妄盲耗猛網黙' +
+    '紋冶弥厄躍闇喩愉諭癒唯幽悠湧猶裕雄誘憂融与誉妖庸揚揺溶腰瘍踊窯擁謡抑沃翼拉裸羅雷' +
+    '頼絡酪辣濫藍欄吏痢履璃離慄柳竜粒隆硫侶虜慮了涼猟陵僚寮療瞭糧厘倫隣瑠涙累塁励戻鈴' +
+    '零霊隷齢麗暦劣烈裂恋廉錬呂炉賂露弄郎浪廊楼漏籠麓賄脇惑枠湾腕';

package/dist/cjs/index.d.ts

@@ -0,0 +1,32 @@
+/**
+ * School year in Japan: 1–6 = 小学校, 7–9 = 中学校1–3年.
+ *
+ * 中学校学習指導要領 does not allocate kanji to individual grades, so 7, 8 and 9
+ * all mean the same set: the whole 常用漢字表 (2136 characters).
+ */
+export type Grade = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+/** Where a kanji is first taught: an elementary grade, or `'secondary'` (常用漢字 outside the 配当表). */
+export type KanjiLevel = 1 | 2 | 3 | 4 | 5 | 6 | 'secondary';
+export interface Options {
+    /**
+     * Accept only the glyphs printed in 常用漢字表. By default the four everyday
+     * variants 叱 填 剥 頬 are treated like their official forms 𠮟 塡 剝 頰.
+     */
+    strict?: boolean;
+}
+/** Tables this version is built from. */
+export declare const SOURCE: {
+    readonly elementary: "小学校学習指導要領（平成29年告示）国語 別表 学年別漢字配当表";
+    readonly secondary: "常用漢字表（平成22年内閣告示第2号）";
+};
+/**
+ * True when every kanji in `text` has been taught by the end of `grade`.
+ * Kana, Latin letters, digits, punctuation and 々 are ignored.
+ */
+export declare function isLearnedBy(text: string, grade: Grade, options?: Options): boolean;
+/** Kanji in `text` that have not been taught by the end of `grade`, unique, in order of appearance. */
+export declare function unlearnedKanji(text: string, grade: Grade, options?: Options): string[];
+/** Where `char` is first taught, or `undefined` when it is not a taught kanji. */
+export declare function levelOfKanji(char: string, options?: Options): KanjiLevel | undefined;
+/** All kanji taught by the end of `grade` (cumulative), in the order of the official tables. */
+export declare function kanjiLearnedBy(grade: Grade): string[];

package/dist/cjs/index.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOURCE = void 0;
+exports.isLearnedBy = isLearnedBy;
+exports.unlearnedKanji = unlearnedKanji;
+exports.levelOfKanji = levelOfKanji;
+exports.kanjiLearnedBy = kanjiLearnedBy;
+const data_ts_1 = require("./data.js");
+/** Tables this version is built from. */
+exports.SOURCE = {
+    elementary: '小学校学習指導要領（平成29年告示）国語 別表 学年別漢字配当表',
+    secondary: '常用漢字表（平成22年内閣告示第2号）',
+};
+const BASE = 0x4e00;
+const END = 0x9fff;
+const RADICALS = 0x2e80;
+const RADICALS_END = 0x2fdf;
+const SECONDARY_LEVEL = 7;
+const VARIANT = 0x10;
+// 𠮟 is the only 常用漢字 outside the BMP.
+const SHIKARU = 0x20b9f;
+const GRADES = [data_ts_1.GRADE_1, data_ts_1.GRADE_2, data_ts_1.GRADE_3, data_ts_1.GRADE_4, data_ts_1.GRADE_5, data_ts_1.GRADE_6];
+// table[codePoint - BASE]: 0 = not taught, 1–6 = grade, 7 = secondary, 7|VARIANT = everyday variant
+const table = /* @__PURE__ */ buildTable();
+function buildTable() {
+    const t = new Uint8Array(END - BASE + 1);
+    GRADES.forEach((chars, i) => {
+        for (const ch of chars)
+            t[ch.codePointAt(0) - BASE] = i + 1;
+    });
+    for (const ch of data_ts_1.SECONDARY) {
+        const cp = ch.codePointAt(0);
+        if (cp !== SHIKARU)
+            t[cp - BASE] = SECONDARY_LEVEL;
+    }
+    for (const ch of '叱填剥頬')
+        t[ch.codePointAt(0) - BASE] = SECONDARY_LEVEL | VARIANT;
+    return t;
+}
+function limitOf(grade) {
+    if (!Number.isInteger(grade) || grade < 1 || grade > 9) {
+        throw new RangeError(`grade must be an integer from 1 to 9, got ${String(grade)}`);
+    }
+    return grade > 6 ? SECONDARY_LEVEL : grade;
+}
+/** Level of a code point outside the table range: 0 = kanji that is not taught, 7 = 𠮟, -1 = not a kanji. */
+function levelOutsideTable(cp) {
+    if (cp === SHIKARU)
+        return SECONDARY_LEVEL;
+    // Radicals (CJK Radicals Supplement, Kangxi Radicals: look-alikes such as ⼭ U+2F2D for 山),
+    // Extension A, compatibility ideographs, Extension B and beyond
+    if ((cp >= RADICALS && cp <= RADICALS_END) ||
+        (cp >= 0x3400 && cp <= 0x4dbf) ||
+        (cp >= 0xf900 && cp <= 0xfaff) ||
+        (cp >= 0x20000 && cp <= 0x3ffff)) {
+        return 0;
+    }
+    return -1;
+}
+function levelOf(cp, mask) {
+    return cp >= BASE && cp <= END ? table[cp - BASE] & mask : levelOutsideTable(cp);
+}
+function maskOf(options) {
+    return options?.strict ? 0xff : 0x0f;
+}
+/**
+ * The single scanning loop. Collects offending code points into `found`, or
+ * returns false at the first one when `found` is null. O(n), no allocation.
+ */
+function scan(text, limit, mask, found) {
+    for (let i = 0; i < text.length; i++) {
+        const c = text.charCodeAt(i);
+        if (c < RADICALS)
+            continue; // ASCII and other non-CJK text
+        let cp = c;
+        let v;
+        if (c >= BASE && c <= END) {
+            v = table[c - BASE] & mask;
+        }
+        else if (c > RADICALS_END && c < 0x3400) {
+            continue; // kana and CJK punctuation
+        }
+        else {
+            if (c >= 0xd800 && c <= 0xdbff) {
+                cp = text.codePointAt(i);
+                if (cp > 0xffff)
+                    i++;
+            }
+            v = levelOutsideTable(cp);
+        }
+        if (v === 0 || v > limit) {
+            if (found === null)
+                return false;
+            found.add(cp);
+        }
+    }
+    return found === null || found.size === 0;
+}
+/**
+ * True when every kanji in `text` has been taught by the end of `grade`.
+ * Kana, Latin letters, digits, punctuation and 々 are ignored.
+ */
+function isLearnedBy(text, grade, options) {
+    return scan(text, limitOf(grade), maskOf(options), null);
+}
+/** Kanji in `text` that have not been taught by the end of `grade`, unique, in order of appearance. */
+function unlearnedKanji(text, grade, options) {
+    const found = new Set();
+    scan(text, limitOf(grade), maskOf(options), found);
+    return Array.from(found, (cp) => String.fromCodePoint(cp));
+}
+/** Where `char` is first taught, or `undefined` when it is not a taught kanji. */
+function levelOfKanji(char, options) {
+    const cp = char.codePointAt(0);
+    if (cp === undefined || char.length !== (cp > 0xffff ? 2 : 1))
+        return undefined;
+    const v = levelOf(cp, maskOf(options));
+    if (v < 1 || v > SECONDARY_LEVEL)
+        return undefined;
+    return v === SECONDARY_LEVEL ? 'secondary' : v;
+}
+/** All kanji taught by the end of `grade` (cumulative), in the order of the official tables. */
+function kanjiLearnedBy(grade) {
+    const limit = limitOf(grade);
+    const chars = GRADES.slice(0, Math.min(limit, 6)).join('') + (limit === SECONDARY_LEVEL ? data_ts_1.SECONDARY : '');
+    return [...chars];
+}

package/dist/cjs/package.json

@@ -0,0 +1 @@
+{ "type": "commonjs" }

package/dist/data.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Source data. Edit this file only when the official tables are revised.
+ *
+ * - GRADE_1..6: 文部科学省「小学校学習指導要領（平成29年告示）」国語 別表「学年別漢字配当表」
+ *   (in force since April 2020; 1026 characters, listed in the official order)
+ * - SECONDARY: 文化庁「常用漢字表」（平成22年内閣告示第2号, 2136 characters) minus the 1026 above.
+ *   中学校学習指導要領 does not allocate these to individual grades.
+ */
+/** 第1学年 (80字) */
+export declare const GRADE_1: string;
+/** 第2学年 (160字) */
+export declare const GRADE_2: string;
+/** 第3学年 (200字) */
+export declare const GRADE_3: string;
+/** 第4学年 (202字) */
+export declare const GRADE_4: string;
+/** 第5学年 (193字) */
+export declare const GRADE_5: string;
+/** 第6学年 (191字) */
+export declare const GRADE_6: string;
+/** 常用漢字のうち学年別漢字配当表にない字 (1110字) */
+export declare const SECONDARY: string;

package/dist/data.js

@@ -0,0 +1,70 @@
+/**
+ * Source data. Edit this file only when the official tables are revised.
+ *
+ * - GRADE_1..6: 文部科学省「小学校学習指導要領（平成29年告示）」国語 別表「学年別漢字配当表」
+ *   (in force since April 2020; 1026 characters, listed in the official order)
+ * - SECONDARY: 文化庁「常用漢字表」（平成22年内閣告示第2号, 2136 characters) minus the 1026 above.
+ *   中学校学習指導要領 does not allocate these to individual grades.
+ */
+/** 第1学年 (80字) */
+export const GRADE_1 = '一右雨円王音下火花貝学気九休玉金空月犬見五口校左三山子四糸字耳七車手十出女小上森' +
+    '人水正生青夕石赤千川先早草足村大男竹中虫町天田土二日入年白八百文木本名目立力林六';
+/** 第2学年 (160字) */
+export const GRADE_2 = '引羽雲園遠何科夏家歌画回会海絵外角楽活間丸岩顔汽記帰弓牛魚京強教近兄形計元言原戸' +
+    '古午後語工公広交光考行高黄合谷国黒今才細作算止市矢姉思紙寺自時室社弱首秋週春書少' +
+    '場色食心新親図数西声星晴切雪船線前組走多太体台地池知茶昼長鳥朝直通弟店点電刀冬当' +
+    '東答頭同道読内南肉馬売買麦半番父風分聞米歩母方北毎妹万明鳴毛門夜野友用曜来里理話';
+/** 第3学年 (200字) */
+export const GRADE_3 = '悪安暗医委意育員院飲運泳駅央横屋温化荷界開階寒感漢館岸起期客究急級宮球去橋業曲局' +
+    '銀区苦具君係軽血決研県庫湖向幸港号根祭皿仕死使始指歯詩次事持式実写者主守取酒受州' +
+    '拾終習集住重宿所暑助昭消商章勝乗植申身神真深進世整昔全相送想息速族他打対待代第題' +
+    '炭短談着注柱丁帳調追定庭笛鉄転都度投豆島湯登等動童農波配倍箱畑発反坂板皮悲美鼻筆' +
+    '氷表秒病品負部服福物平返勉放味命面問役薬由油有遊予羊洋葉陽様落流旅両緑礼列練路和';
+/** 第4学年 (202字) */
+export const GRADE_4 = '愛案以衣位茨印英栄媛塩岡億加果貨課芽賀改械害街各覚潟完官管関観願岐希季旗器機議求' +
+    '泣給挙漁共協鏡競極熊訓軍郡群径景芸欠結建健験固功好香候康佐差菜最埼材崎昨札刷察参' +
+    '産散残氏司試児治滋辞鹿失借種周祝順初松笑唱焼照城縄臣信井成省清静席積折節説浅戦選' +
+    '然争倉巣束側続卒孫帯隊達単置仲沖兆低底的典伝徒努灯働特徳栃奈梨熱念敗梅博阪飯飛必' +
+    '票標不夫付府阜富副兵別辺変便包法望牧末満未民無約勇要養浴利陸良料量輪類令冷例連老' +
+    '労録';
+/** 第5学年 (193字) */
+export const GRADE_5 = '圧囲移因永営衛易益液演応往桜可仮価河過快解格確額刊幹慣眼紀基寄規喜技義逆久旧救居' +
+    '許境均禁句型経潔件険検限現減故個護効厚耕航鉱構興講告混査再災妻採際在財罪殺雑酸賛' +
+    '士支史志枝師資飼示似識質舎謝授修述術準序招証象賞条状常情織職制性政勢精製税責績接' +
+    '設絶祖素総造像増則測属率損貸態団断築貯張停提程適統堂銅導得毒独任燃能破犯判版比肥' +
+    '非費備評貧布婦武復複仏粉編弁保墓報豊防貿暴脈務夢迷綿輸余容略留領歴';
+/** 第6学年 (191字) */
+export const GRADE_6 = '胃異遺域宇映延沿恩我灰拡革閣割株干巻看簡危机揮貴疑吸供胸郷勤筋系敬警劇激穴券絹権' +
+    '憲源厳己呼誤后孝皇紅降鋼刻穀骨困砂座済裁策冊蚕至私姿視詞誌磁射捨尺若樹収宗就衆従' +
+    '縦縮熟純処署諸除承将傷障蒸針仁垂推寸盛聖誠舌宣専泉洗染銭善奏窓創装層操蔵臓存尊退' +
+    '宅担探誕段暖値宙忠著庁頂腸潮賃痛敵展討党糖届難乳認納脳派拝背肺俳班晩否批秘俵腹奮' +
+    '並陛閉片補暮宝訪亡忘棒枚幕密盟模訳郵優預幼欲翌乱卵覧裏律臨朗論';
+/** 常用漢字のうち学年別漢字配当表にない字 (1110字) */
+export const SECONDARY = '亜哀挨曖握扱宛嵐依威為畏尉萎偉椅彙違維慰緯壱逸芋咽姻淫陰隠韻唄鬱畝浦詠影鋭疫悦越' +
+    '謁閲炎怨宴援煙猿鉛縁艶汚凹押旺欧殴翁奥憶臆虞乙俺卸穏佳苛架華菓渦嫁暇禍靴寡箇稼蚊' +
+    '牙瓦雅餓介戒怪拐悔皆塊楷潰壊懐諧劾崖涯慨蓋該概骸垣柿核殻郭較隔獲嚇穫岳顎掛括喝渇' +
+    '葛滑褐轄且釜鎌刈甘汗缶肝冠陥乾勘患貫喚堪換敢棺款閑勧寛歓監緩憾還環韓艦鑑含玩頑企' +
+    '伎忌奇祈軌既飢鬼亀幾棋棄毀畿輝騎宜偽欺儀戯擬犠菊吉喫詰却脚虐及丘朽臼糾嗅窮巨拒拠' +
+    '虚距御凶叫狂享況峡挟狭恐恭脅矯響驚仰暁凝巾斤菌琴僅緊錦謹襟吟駆惧愚偶遇隅串屈掘窟' +
+    '繰勲薫刑茎契恵啓掲渓蛍傾携継詣慶憬稽憩鶏迎鯨隙撃桁傑肩倹兼剣拳軒圏堅嫌献遣賢謙鍵' +
+    '繭顕懸幻玄弦舷股虎孤弧枯雇誇鼓錮顧互呉娯悟碁勾孔巧甲江坑抗攻更拘肯侯恒洪荒郊貢控' +
+    '梗喉慌硬絞項溝綱酵稿衡購乞拷剛傲豪克酷獄駒込頃昆恨婚痕紺魂墾懇沙唆詐鎖挫采砕宰栽' +
+    '彩斎債催塞歳載剤削柵索酢搾錯咲刹拶撮擦桟惨傘斬暫旨伺刺祉肢施恣脂紫嗣雌摯賜諮侍慈' +
+    '餌璽軸𠮟疾執湿嫉漆芝赦斜煮遮邪蛇酌釈爵寂朱狩殊珠腫趣寿呪需儒囚舟秀臭袖羞愁酬醜蹴' +
+    '襲汁充柔渋銃獣叔淑粛塾俊瞬旬巡盾准殉循潤遵庶緒如叙徐升召匠床抄肖尚昇沼宵症祥称渉' +
+    '紹訟掌晶焦硝粧詔奨詳彰憧衝償礁鐘丈冗浄剰畳壌嬢錠譲醸拭殖飾触嘱辱尻伸芯辛侵津唇娠' +
+    '振浸紳診寝慎審震薪刃尽迅甚陣尋腎須吹炊帥粋衰酔遂睡穂随髄枢崇据杉裾瀬是姓征斉牲凄' +
+    '逝婿誓請醒斥析脊隻惜戚跡籍拙窃摂仙占扇栓旋煎羨腺詮践箋潜遷薦繊鮮禅漸膳繕狙阻租措' +
+    '粗疎訴塑遡礎双壮荘捜挿桑掃曹曽爽喪痩葬僧遭槽踪燥霜騒藻憎贈即促捉俗賊遜汰妥唾堕惰' +
+    '駄耐怠胎泰堆袋逮替滞戴滝択沢卓拓託濯諾濁但脱奪棚誰丹旦胆淡嘆端綻鍛弾壇恥致遅痴稚' +
+    '緻畜逐蓄秩窒嫡抽衷酎鋳駐弔挑彫眺釣貼超跳徴嘲澄聴懲勅捗沈珍朕陳鎮椎墜塚漬坪爪鶴呈' +
+    '廷抵邸亭貞帝訂逓偵堤艇締諦泥摘滴溺迭哲徹撤添塡殿斗吐妬途渡塗賭奴怒到逃倒凍唐桃透' +
+    '悼盗陶塔搭棟痘筒稲踏謄藤闘騰洞胴瞳峠匿督篤凸突屯豚頓貪鈍曇丼那謎鍋軟尼弐匂虹尿妊' +
+    '忍寧捻粘悩濃把覇婆罵杯排廃輩培陪媒賠伯拍泊迫剝舶薄漠縛爆箸肌鉢髪伐抜罰閥氾帆汎伴' +
+    '畔般販斑搬煩頒範繁藩蛮盤妃彼披卑疲被扉碑罷避尾眉微膝肘匹泌姫漂苗描猫浜賓頻敏瓶扶' +
+    '怖附訃赴浮符普腐敷膚賦譜侮舞封伏幅覆払沸紛雰噴墳憤丙併柄塀幣弊蔽餅壁璧癖蔑偏遍哺' +
+    '捕舗募慕簿芳邦奉抱泡胞俸倣峰砲崩蜂飽褒縫乏忙坊妨房肪某冒剖紡傍帽貌膨謀頰朴睦僕墨' +
+    '撲没勃堀奔翻凡盆麻摩磨魔昧埋膜枕又抹慢漫魅岬蜜妙眠矛霧娘冥銘滅免麺茂妄盲耗猛網黙' +
+    '紋冶弥厄躍闇喩愉諭癒唯幽悠湧猶裕雄誘憂融与誉妖庸揚揺溶腰瘍踊窯擁謡抑沃翼拉裸羅雷' +
+    '頼絡酪辣濫藍欄吏痢履璃離慄柳竜粒隆硫侶虜慮了涼猟陵僚寮療瞭糧厘倫隣瑠涙累塁励戻鈴' +
+    '零霊隷齢麗暦劣烈裂恋廉錬呂炉賂露弄郎浪廊楼漏籠麓賄脇惑枠湾腕';

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+/**
+ * School year in Japan: 1–6 = 小学校, 7–9 = 中学校1–3年.
+ *
+ * 中学校学習指導要領 does not allocate kanji to individual grades, so 7, 8 and 9
+ * all mean the same set: the whole 常用漢字表 (2136 characters).
+ */
+export type Grade = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+/** Where a kanji is first taught: an elementary grade, or `'secondary'` (常用漢字 outside the 配当表). */
+export type KanjiLevel = 1 | 2 | 3 | 4 | 5 | 6 | 'secondary';
+export interface Options {
+    /**
+     * Accept only the glyphs printed in 常用漢字表. By default the four everyday
+     * variants 叱 填 剥 頬 are treated like their official forms 𠮟 塡 剝 頰.
+     */
+    strict?: boolean;
+}
+/** Tables this version is built from. */
+export declare const SOURCE: {
+    readonly elementary: "小学校学習指導要領（平成29年告示）国語 別表 学年別漢字配当表";
+    readonly secondary: "常用漢字表（平成22年内閣告示第2号）";
+};
+/**
+ * True when every kanji in `text` has been taught by the end of `grade`.
+ * Kana, Latin letters, digits, punctuation and 々 are ignored.
+ */
+export declare function isLearnedBy(text: string, grade: Grade, options?: Options): boolean;
+/** Kanji in `text` that have not been taught by the end of `grade`, unique, in order of appearance. */
+export declare function unlearnedKanji(text: string, grade: Grade, options?: Options): string[];
+/** Where `char` is first taught, or `undefined` when it is not a taught kanji. */
+export declare function levelOfKanji(char: string, options?: Options): KanjiLevel | undefined;
+/** All kanji taught by the end of `grade` (cumulative), in the order of the official tables. */
+export declare function kanjiLearnedBy(grade: Grade): string[];

package/dist/index.js

@@ -0,0 +1,120 @@
+import { GRADE_1, GRADE_2, GRADE_3, GRADE_4, GRADE_5, GRADE_6, SECONDARY } from "./data.js";
+/** Tables this version is built from. */
+export const SOURCE = {
+    elementary: '小学校学習指導要領（平成29年告示）国語 別表 学年別漢字配当表',
+    secondary: '常用漢字表（平成22年内閣告示第2号）',
+};
+const BASE = 0x4e00;
+const END = 0x9fff;
+const RADICALS = 0x2e80;
+const RADICALS_END = 0x2fdf;
+const SECONDARY_LEVEL = 7;
+const VARIANT = 0x10;
+// 𠮟 is the only 常用漢字 outside the BMP.
+const SHIKARU = 0x20b9f;
+const GRADES = [GRADE_1, GRADE_2, GRADE_3, GRADE_4, GRADE_5, GRADE_6];
+// table[codePoint - BASE]: 0 = not taught, 1–6 = grade, 7 = secondary, 7|VARIANT = everyday variant
+const table = /* @__PURE__ */ buildTable();
+function buildTable() {
+    const t = new Uint8Array(END - BASE + 1);
+    GRADES.forEach((chars, i) => {
+        for (const ch of chars)
+            t[ch.codePointAt(0) - BASE] = i + 1;
+    });
+    for (const ch of SECONDARY) {
+        const cp = ch.codePointAt(0);
+        if (cp !== SHIKARU)
+            t[cp - BASE] = SECONDARY_LEVEL;
+    }
+    for (const ch of '叱填剥頬')
+        t[ch.codePointAt(0) - BASE] = SECONDARY_LEVEL | VARIANT;
+    return t;
+}
+function limitOf(grade) {
+    if (!Number.isInteger(grade) || grade < 1 || grade > 9) {
+        throw new RangeError(`grade must be an integer from 1 to 9, got ${String(grade)}`);
+    }
+    return grade > 6 ? SECONDARY_LEVEL : grade;
+}
+/** Level of a code point outside the table range: 0 = kanji that is not taught, 7 = 𠮟, -1 = not a kanji. */
+function levelOutsideTable(cp) {
+    if (cp === SHIKARU)
+        return SECONDARY_LEVEL;
+    // Radicals (CJK Radicals Supplement, Kangxi Radicals: look-alikes such as ⼭ U+2F2D for 山),
+    // Extension A, compatibility ideographs, Extension B and beyond
+    if ((cp >= RADICALS && cp <= RADICALS_END) ||
+        (cp >= 0x3400 && cp <= 0x4dbf) ||
+        (cp >= 0xf900 && cp <= 0xfaff) ||
+        (cp >= 0x20000 && cp <= 0x3ffff)) {
+        return 0;
+    }
+    return -1;
+}
+function levelOf(cp, mask) {
+    return cp >= BASE && cp <= END ? table[cp - BASE] & mask : levelOutsideTable(cp);
+}
+function maskOf(options) {
+    return options?.strict ? 0xff : 0x0f;
+}
+/**
+ * The single scanning loop. Collects offending code points into `found`, or
+ * returns false at the first one when `found` is null. O(n), no allocation.
+ */
+function scan(text, limit, mask, found) {
+    for (let i = 0; i < text.length; i++) {
+        const c = text.charCodeAt(i);
+        if (c < RADICALS)
+            continue; // ASCII and other non-CJK text
+        let cp = c;
+        let v;
+        if (c >= BASE && c <= END) {
+            v = table[c - BASE] & mask;
+        }
+        else if (c > RADICALS_END && c < 0x3400) {
+            continue; // kana and CJK punctuation
+        }
+        else {
+            if (c >= 0xd800 && c <= 0xdbff) {
+                cp = text.codePointAt(i);
+                if (cp > 0xffff)
+                    i++;
+            }
+            v = levelOutsideTable(cp);
+        }
+        if (v === 0 || v > limit) {
+            if (found === null)
+                return false;
+            found.add(cp);
+        }
+    }
+    return found === null || found.size === 0;
+}
+/**
+ * True when every kanji in `text` has been taught by the end of `grade`.
+ * Kana, Latin letters, digits, punctuation and 々 are ignored.
+ */
+export function isLearnedBy(text, grade, options) {
+    return scan(text, limitOf(grade), maskOf(options), null);
+}
+/** Kanji in `text` that have not been taught by the end of `grade`, unique, in order of appearance. */
+export function unlearnedKanji(text, grade, options) {
+    const found = new Set();
+    scan(text, limitOf(grade), maskOf(options), found);
+    return Array.from(found, (cp) => String.fromCodePoint(cp));
+}
+/** Where `char` is first taught, or `undefined` when it is not a taught kanji. */
+export function levelOfKanji(char, options) {
+    const cp = char.codePointAt(0);
+    if (cp === undefined || char.length !== (cp > 0xffff ? 2 : 1))
+        return undefined;
+    const v = levelOf(cp, maskOf(options));
+    if (v < 1 || v > SECONDARY_LEVEL)
+        return undefined;
+    return v === SECONDARY_LEVEL ? 'secondary' : v;
+}
+/** All kanji taught by the end of `grade` (cumulative), in the order of the official tables. */
+export function kanjiLearnedBy(grade) {
+    const limit = limitOf(grade);
+    const chars = GRADES.slice(0, Math.min(limit, 6)).join('') + (limit === SECONDARY_LEVEL ? SECONDARY : '');
+    return [...chars];
+}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "learned-kanji",
+  "version": "0.1.0",
+  "description": "Check whether Japanese text uses only the kanji taught by a given school grade in Japan (学年別漢字配当表 / 常用漢字表). Zero dependencies, fast, works in browsers.",
+  "keywords": [
+    "kanji",
+    "japanese",
+    "kyoiku-kanji",
+    "joyo-kanji",
+    "教育漢字",
+    "常用漢字",
+    "学年別漢字配当表",
+    "grade",
+    "school",
+    "validation",
+    "test"
+  ],
+  "license": "MIT",
+  "author": "ohzono",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ohzono/learned-kanji.git"
+  },
+  "homepage": "https://github.com/ohzono/learned-kanji#readme",
+  "bugs": "https://github.com/ohzono/learned-kanji/issues",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "node scripts/build.mjs",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "node --test \"test/*.test.ts\"",
+    "test:dist": "node --test test/smoke/smoke.test.mjs",
+    "bench": "node bench.mjs",
+    "prepublishOnly": "npm run typecheck && npm test && npm run build && npm run test:dist"
+  },
+  "devDependencies": {
+    "typescript": "~5.9.3"
+  }
+}