henkan 2.4.12 → 3.0.1

package/docs/api/type-aliases/NameIDEntryMap.md

@@ -0,0 +1,13 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / NameIDEntryMap
+
+# Type Alias: NameIDEntryMap
+
+> **NameIDEntryMap** = `Map`\<[`StringNumber`](StringNumber.md), [`DictName`](../interfaces/DictName.md)\>
+
+Defined in: [types.ts:497](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L497)
+
+A `JMnedict entry ID` ---> [DictName](../interfaces/DictName.md) `object` map

package/docs/api/type-aliases/Result.md

@@ -6,8 +6,8 @@
 
 # Type Alias: Result
 
-> **Result** = [`Word`](../interfaces/Word.md) \| [`Kanji`](../interfaces/Kanji.md) \| [`Radical`](../interfaces/Radical.md) \| [`Kana`](../interfaces/Kana.md) \| [`Grammar`](../interfaces/Grammar.md)
+> **Result** = [`Word`](../interfaces/Word.md) \| [`Name`](../interfaces/Name.md) \| [`Kanji`](../interfaces/Kanji.md) \| [`Radical`](../interfaces/Radical.md) \| [`Kana`](../interfaces/Kana.md) \| [`Grammar`](../interfaces/Grammar.md)
 
-Defined in: [types.ts:959](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L959)
+Defined in: [types.ts:1059](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1059)
 
 Any type of converted entry from a [Dict](Dict.md) array + others not from a dictionary

package/docs/api/type-aliases/WordDefinitionsMap.md

@@ -8,6 +8,6 @@
 
 > **WordDefinitionsMap** = `Map`\<[`StringNumber`](StringNumber.md), [`Definition`](../interfaces/Definition.md)[]\>
 
-Defined in: [types.ts:463](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L463)
+Defined in: [types.ts:517](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L517)
 
 A `JMdict entry ID` ---> `Japanese definitions associated with the JMdict entry` map

package/docs/api/type-aliases/WordIDEntryMap.md

@@ -8,6 +8,6 @@
 
 > **WordIDEntryMap** = `Map`\<[`StringNumber`](StringNumber.md), [`DictWord`](../interfaces/DictWord.md)\>
 
-Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L443)
+Defined in: [types.ts:493](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L493)
 
 A `JMdict entry ID` ---> [DictWord](../interfaces/DictWord.md) `object` map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "henkan",
-  "version": "2.4.12",
-  "description": "Converter & Simplifier for JMdict, KANJIDIC, KRADFILE2, RADKFILE2 and Tanaka Corpus",
+  "version": "3.0.1",
+  "description": "Converter & Simplifier for JMdict, JMnedict, KANJIDIC, KRADFILE2, RADKFILE2 and Tanaka Corpus",
   "keywords": [
     "fjsd",
     "japanese",
@@ -15,6 +15,7 @@
     "kanji",
     "japanese-grammar",
     "jmdict",
+    "jmnedict",
     "kanjidic2",
     "kradfile2",
     "radkfile2",
@@ -72,17 +73,17 @@
   },
   "devDependencies": {
     "@types/node": "^24.10.9",
-    "@typescript-eslint/eslint-plugin": "^8.54.0",
-    "@typescript-eslint/parser": "^8.54.0",
+    "@typescript-eslint/eslint-plugin": "^8.55.0",
+    "@typescript-eslint/parser": "^8.55.0",
     "@vitest/coverage-v8": "^4.0.18",
     "esbuild": "^0.27.3",
     "eslint": "^9.39.2",
     "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jsdoc": "^62.5.4",
+    "eslint-plugin-jsdoc": "^62.5.5",
     "eslint-plugin-prettier": "^5.5.5",
     "prettier": "^3.8.1",
-    "rimraf": "^6.1.2",
-    "typedoc": "^0.28.16",
+    "rimraf": "^6.1.3",
+    "typedoc": "^0.28.17",
     "typedoc-plugin-markdown": "^4.10.0",
     "typescript": "^5.9.3",
     "vitest": "^4.0.18"

package/src/types.ts

@@ -47,7 +47,7 @@ export type POS =
 /**
  * Standardized dictionary names
  */
-export type DictName = "JMDict" | "Kanjidic" | "tanaka" | "radk" | "krad";
+export type DictNames = "JMDict" | "Kanjidic" | "tanaka" | "radk" | "krad";
 
 /**
  * A number written as a string
@@ -55,9 +55,9 @@ export type DictName = "JMDict" | "Kanjidic" | "tanaka" | "radk" | "krad";
 export type StringNumber = `${number}`;
 
 /**
- * Word kanji form information
+ * Word/Name kanji form information
  *
- * Equivalent to the `k_ele` JMdict element
+ * Equivalent to the `k_ele` JMdict/JMnedict element
  */
 export interface DictKanjiForm {
   /**
@@ -79,9 +79,9 @@ export interface DictKanjiForm {
 }
 
 /**
- * Word reading information
+ * Word/Name reading information
  *
- * Equivalent to the `r_ele` JMdict element
+ * Equivalent to the `r_ele` JMdict/JMnedict element
  */
 export interface DictReading {
   /**
@@ -221,6 +221,56 @@ export interface DictWord {
   hasPhrases?: true | undefined;
 }
 
+/**
+ * Name translation information
+ *
+ * Equivalent to the `trans` JMnedict element
+ */
+export interface NeDictMeaning {
+  /**
+   * Name translations
+   */
+  translations: string[];
+  /**
+   * Types of the name
+   */
+  nameTypes?: string[] | undefined;
+}
+
+/**
+ * JMnedict entry (name)
+ *
+ * Equivalent to the `entry` JMnedict element
+ */
+export interface DictName {
+  /**
+   * The entry sequence number
+   */
+  readonly id: StringNumber;
+  /**
+   * The name's readings
+   */
+  nameReadings: DictReading[];
+  /**
+   * The name's meanings/senses
+   */
+  meanings: NeDictMeaning[];
+  /**
+   * The name's kanji forms
+   */
+  kanjiForms?: DictKanjiForm[] | undefined;
+  /**
+   * Whether or not the entry has a priority tag (`k_pri` or `r_pri`)
+   */
+  isCommon?: true | undefined;
+  /**
+   * Whether or not the entry has at least one Tanaka Corpus phrase associated with it
+   *
+   * **May not always be accurate**
+   */
+  hasPhrases?: true | undefined;
+}
+
 /**
  * Miscellaneous information about the kanji
  *
@@ -441,6 +491,10 @@ export interface TanakaExample {
  * A `JMdict entry ID` ---> {@link DictWord} `object` map
  */
 export type WordIDEntryMap = Map<StringNumber, DictWord>;
+/**
+ * A `JMnedict entry ID` ---> {@link DictName} `object` map
+ */
+export type NameIDEntryMap = Map<StringNumber, DictName>;
 /**
  * A `KANJIDIC kanji character` ---> {@link DictKanji} `object` map
  */
@@ -454,9 +508,9 @@ export type KanjiSVGMap = Map<string, string>;
  */
 export type KanjiWordsMap = Map<string, DictWord[]>;
 /**
- * A `JMdict entry ID` ---> `Tanaka examples associated with the JMdict entry` map
+ * A `JMdict/JMnedict entry ID` ---> `Tanaka examples associated with the JMdict/JMnedict entry` map
  */
-export type WordExamplesMap = Map<StringNumber, TanakaExample[]>;
+export type EntryExamplesMap = Map<StringNumber, TanakaExample[]>;
 /**
  * A `JMdict entry ID` ---> `Japanese definitions associated with the JMdict entry` map
  */
@@ -470,6 +524,10 @@ export interface EntryMaps {
    * @see {@link WordIDEntryMap}
    */
   wordIDEntryMap?: WordIDEntryMap | undefined;
+  /**
+   * @see {@link NameIDEntryMap}
+   */
+  nameIDEntryMap?: NameIDEntryMap | undefined;
   /**
    * @see {@link KanjiWordsMap}
    */
@@ -479,9 +537,13 @@ export interface EntryMaps {
    */
   kanjiEntryMap?: KanjiEntryMap | undefined;
   /**
-   * @see {@link WordExamplesMap}
+   * @see {@link EntryExamplesMap}
+   */
+  wordExamplesMap?: EntryExamplesMap | undefined;
+  /**
+   * @see {@link EntryExamplesMap}
    */
-  wordExamplesMap?: WordExamplesMap | undefined;
+  nameExamplesMap?: EntryExamplesMap | undefined;
   /**
    * @see {@link WordDefinitionsMap}
    */
@@ -581,7 +643,13 @@ export type Dict =
 /**
  * Names of entry types used for the Anki note IDs
  */
-export type EntryType = "word" | "kanji" | "radical" | "kana" | "grammar";
+export type EntryType =
+  | "word"
+  | "name"
+  | "kanji"
+  | "radical"
+  | "kana"
+  | "grammar";
 
 /**
  * Basic Anki note information
@@ -628,7 +696,7 @@ export interface NoteAndTag {
 }
 
 /**
- * A kanji form of the word
+ * A kanji form of the word/name
  *
  * Converted from a {@link DictKanjiForm}
  */
@@ -648,7 +716,7 @@ export interface KanjiForm {
 }
 
 /**
- * A reading of the word
+ * A reading of the word/name
  *
  * Converted from {@link DictReading}
  */
@@ -672,9 +740,9 @@ export interface Reading {
 }
 
 /**
- * A translation of the word
+ * A translation of the word/name
  *
- * Converted from {@link DictMeaning}
+ * Converted from {@link DictMeaning} or {@link NeDictMeaning}
  */
 export interface Translation {
   /**
@@ -879,6 +947,38 @@ export interface Word extends ResultEntry<"word"> {
   usuallyInKana?: true | undefined;
 }
 
+/**
+ * Name information
+ *
+ * Converted from {@link DictName}
+ */
+export interface Name extends ResultEntry<"name"> {
+  /**
+   * The name readings (in kana)
+   */
+  nameReadings: Reading[];
+  /**
+   * The name translations
+   */
+  translations: Translation[];
+  /**
+   * The name kanji forms
+   */
+  kanjiForms?: KanjiForm[] | undefined;
+  /**
+   * A list of kanji used in the kanji forms
+   */
+  kanji?: Kanji[] | undefined;
+  /**
+   * Phrases associated to the name
+   */
+  phrases?: Phrase[] | undefined;
+  /**
+   * @see {@link DictName.isCommon}
+   */
+  common?: true | undefined;
+}
+
 /**
  * Kana information
  */
@@ -956,7 +1056,7 @@ export interface Grammar extends ResultEntry<"grammar"> {
 /**
  * Any type of converted entry from a {@link Dict} array + others not from a dictionary
  */
-export type Result = Word | Kanji | Radical | Kana | Grammar;
+export type Result = Word | Name | Kanji | Radical | Kana | Grammar;
 
 /**
  * Default note ID, note type and deck name of a note