henkan 1.1.2 → 2.0.0

package/docs/api/interfaces/NoteHeaderKeys.md

@@ -0,0 +1,75 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / NoteHeaderKeys
+
+# Interface: NoteHeaderKeys
+
+Defined in: [types.ts:905](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L905)
+
+Anki note file headers keys
+
+## See
+
+[https://docs.ankiweb.net/importing/text-files.html#file-headers](https://docs.ankiweb.net/importing/text-files.html#file-headers)
+
+## Properties
+
+### deck
+
+> `readonly` **deck**: `` `${string}:` ``
+
+Defined in: [types.ts:925](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L925)
+
+Deck name column header
+
+***
+
+### guid
+
+> `readonly` **guid**: `` `${string}:` ``
+
+Defined in: [types.ts:917](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L917)
+
+GUID column header
+
+***
+
+### html
+
+> `readonly` **html**: `` `${string}:false` `` \| `` `${string}:true` ``
+
+Defined in: [types.ts:913](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L913)
+
+HTML treatment
+
+***
+
+### notetype
+
+> `readonly` **notetype**: `` `${string}:` ``
+
+Defined in: [types.ts:921](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L921)
+
+Note type column header
+
+***
+
+### separator
+
+> `readonly` **separator**: `` `${string}:${string}` ``
+
+Defined in: [types.ts:909](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L909)
+
+Field separator
+
+***
+
+### tags
+
+> `readonly` **tags**: `` `${string}:` ``
+
+Defined in: [types.ts:929](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L929)
+
+Tags column header (*must be completed with a number after `:`*)

package/docs/api/interfaces/Radical.md

@@ -44,19 +44,19 @@ Whether or not this entry should be converted into an Anki note
 
 ***
 
-### fromJpdb?
+### externalInfo?
 
-> `optional` **fromJpdb**: `true`
+> `optional` **externalInfo**: `true`
 
 Defined in: [types.ts:725](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L725)
 
-Whether or not this radical/component object contains information **only** from `jpdb.io`
+Whether or not this radical/component object contains information extracted from [sources](#sources)
 
 ***
 
 ### id?
 
-> `readonly` `optional` **id**: `string`
+> `optional` **id**: `` `${number}` ``
 
 Defined in: [types.ts:507](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L507)
 
@@ -100,7 +100,7 @@ The radical/component mnemonic
 
 ### noteID?
 
-> `readonly` `optional` **noteID**: `` `radical_${string}` ``
+> `optional` **noteID**: `string`
 
 Defined in: [types.ts:503](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L503)
 

package/docs/api/interfaces/ResultEntry.md

@@ -48,7 +48,7 @@ Whether or not this entry should be converted into an Anki note
 
 ### id?
 
-> `readonly` `optional` **id**: `string`
+> `optional` **id**: `` `${number}` ``
 
 Defined in: [types.ts:507](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L507)
 
@@ -58,7 +58,7 @@ ID used for the Anki note ID
 
 ### noteID?
 
-> `readonly` `optional` **noteID**: `` `${EntryType}_${string}` ``
+> `optional` **noteID**: `string`
 
 Defined in: [types.ts:503](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L503)
 

package/docs/api/interfaces/TanakaExample.md

@@ -14,7 +14,7 @@ Tanaka Corpus `examples.utf` examples
 
 ### furigana?
 
-> `readonly` `optional` **furigana**: `string`
+> `optional` **furigana**: `string`
 
 Defined in: [types.ts:414](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L414)
 

package/docs/api/interfaces/UsefulRegExps.md

@@ -6,7 +6,7 @@
 
 # Interface: UsefulRegExps
 
-Defined in: [types.ts:874](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L874)
+Defined in: [types.ts:935](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L935)
 
 Some useful regular expressions
 
@@ -16,7 +16,7 @@ Some useful regular expressions
 
 > `readonly` **hiragana**: `RegExp`
 
-Defined in: [types.ts:878](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L878)
+Defined in: [types.ts:939](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L939)
 
 Matches any *hiragana* character(s)
 
@@ -26,7 +26,7 @@ Matches any *hiragana* character(s)
 
 > `readonly` **kanji**: `RegExp`
 
-Defined in: [types.ts:886](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L886)
+Defined in: [types.ts:947](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L947)
 
 Matches any *kanji* character(s)
 
@@ -36,7 +36,7 @@ Matches any *kanji* character(s)
 
 > `readonly` **katakana**: `RegExp`
 
-Defined in: [types.ts:882](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L882)
+Defined in: [types.ts:943](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L943)
 
 Matches any *katakana* character(s)
 
@@ -46,7 +46,7 @@ Matches any *katakana* character(s)
 
 > `readonly` **regExChars**: `RegExp`
 
-Defined in: [types.ts:890](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L890)
+Defined in: [types.ts:951](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L951)
 
 Matches any character that is part of the regex syntax
 
@@ -56,7 +56,7 @@ Matches any character that is part of the regex syntax
 
 > `readonly` **tanakaID**: `RegExp`
 
-Defined in: [types.ts:894](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L894)
+Defined in: [types.ts:955](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L955)
 
 Matches the `#ID=` part in a Tanaka Corpus `examples.utf` file
 
@@ -66,7 +66,7 @@ Matches the `#ID=` part in a Tanaka Corpus `examples.utf` file
 
 > `readonly` **tanakaPart**: `RegExp`
 
-Defined in: [types.ts:898](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L898)
+Defined in: [types.ts:959](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L959)
 
 Matches and splits a part found in the `B` section of a Tanaka Corpus `examples.utf` file
 
@@ -76,6 +76,6 @@ Matches and splits a part found in the `B` section of a Tanaka Corpus `examples.
 
 > `readonly` **tanakaReferenceID**: `RegExp`
 
-Defined in: [types.ts:902](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L902)
+Defined in: [types.ts:963](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L963)
 
 Matches the reference ID element of a Tanaka example part

package/docs/api/interfaces/Word.md

@@ -70,7 +70,7 @@ Whether or not this entry should be converted into an Anki note
 
 ### id?
 
-> `readonly` `optional` **id**: `string`
+> `optional` **id**: `` `${number}` ``
 
 Defined in: [types.ts:507](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L507)
 
@@ -104,7 +104,7 @@ The word kanji forms
 
 ### noteID?
 
-> `readonly` `optional` **noteID**: `` `word_${string}` ``
+> `optional` **noteID**: `string`
 
 Defined in: [types.ts:503](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L503)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "henkan",
-  "version": "1.1.2",
+  "version": "2.0.0",
   "description": "A Node.JS library that helps you convert any dictionary from EDRDG, transform their entries into more user-friendly schemas and create Anki notes from them.",
   "keywords": [
     "fjsd",
@@ -52,24 +52,24 @@
   "scripts": {
     "test": "vitest",
     "test:watch": "vitest --watch",
-    "test:coverage": "vitest run --coverage",
     "test:ci": "vitest run --coverage",
     "clean": "rimraf dist",
     "build:types": "tsc -p tsconfig.types.json",
     "build:cjs": "node ./scripts/build-esbuild.cjs cjs",
     "build:esm": "node ./scripts/build-esbuild.cjs esm",
     "build": "npm run clean && npm run build:types && npm run build:esm && npm run build:cjs",
-    "lint": "eslint 'src/**/*.{ts,tsx}' --fix && eslint 'test/**/*.{ts,tsx}' --fix",
+    "lint": "eslint src --ext .ts,.tsx --fix --fix-type problem,suggestion,layout && eslint test --ext .ts,.tsx --fix --fix-type problem,suggestion,layout",
     "prepare": "npm run lint && npm run build && npm run docs:api",
-    "docs:api": "typedoc --plugin typedoc-plugin-markdown --out docs/api src/index.ts --readme none --excludePrivate --excludeProtected --excludeNotDocumented --hideGenerator --sourceLinkTemplate \"https://github.com/Ronokof/Henkan/blob/{gitRevision}/{path}#L{line}\" --gitRevision main"
+    "docs:api": "typedoc --plugin typedoc-plugin-markdown --out docs/api src/index.ts --readme none --excludePrivate --excludeProtected --excludeNotDocumented --hideGenerator --sourceLinkTemplate \"https://github.com/Ronokof/Henkan/blob/{gitRevision}/{path}#L{line}\" --gitRevision main",
+    "sync-node-types": "node ./scripts/sync-node-types.cjs"
   },
   "devDependencies": {
-    "@types/node": "^25.0.1",
+    "@types/node": "^24.10.4",
     "@types/xml2js": "^0.4.14",
-    "@typescript-eslint/eslint-plugin": "^8.49.0",
-    "@typescript-eslint/parser": "^8.49.0",
-    "@vitest/coverage-v8": "^4.0.15",
-    "esbuild": "^0.27.1",
+    "@typescript-eslint/eslint-plugin": "^8.50.0",
+    "@typescript-eslint/parser": "^8.50.0",
+    "@vitest/coverage-v8": "^4.0.16",
+    "esbuild": "^0.27.2",
     "eslint": "^9.39.2",
     "eslint-plugin-prettier": "^5.5.4",
     "prettier": "^3.7.4",
@@ -77,10 +77,9 @@
     "typedoc": "^0.28.15",
     "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.15"
+    "vitest": "^4.0.16"
   },
   "dependencies": {
-    "@aws-sdk/client-polly": "^3.948.0",
     "fflate": "^0.8.2",
     "iconv-lite": "^0.7.1",
     "kuroshiro": "^1.2.0",
@@ -89,6 +88,6 @@
     "xml2js": "^0.6.2"
   },
   "engines": {
-    "node": ">=22.17.0"
+    "node": ">=24.12.0"
   }
 }

package/docs/api/functions/convertJawiktionary.md

@@ -1,29 +0,0 @@
-[**henkan**](../README.md)
-
-***
-
-[henkan](../README.md) / convertJawiktionary
-
-# Function: convertJawiktionary()
-
-> **convertJawiktionary**(`stream`): `Promise`\<`any`[]\>
-
-Defined in: [utils.ts:781](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L781)
-
-Converts and filters a `ja.wiktionary.org` JSONL dump
-
-The dump file needs to be converted from a `jawiktionary-latest-pages-articles.xml.bz2` file from [https://dumps.wikimedia.org/jawiktionary/latest/](https://dumps.wikimedia.org/jawiktionary/latest/) using [wiktextract](https://github.com/tatuylonen/wiktextract).
-
-## Parameters
-
-### stream
-
-`ReadStream`
-
-The stream of a JSONL dump file
-
-## Returns
-
-`Promise`\<`any`[]\>
-
-An array containing only Japanese entries

package/docs/api/functions/synthesizeSpeech.md

@@ -1,39 +0,0 @@
-[**henkan**](../README.md)
-
-***
-
-[henkan](../README.md) / synthesizeSpeech
-
-# Function: synthesizeSpeech()
-
-> **synthesizeSpeech**(`client`, `input`, `options`): `Promise`\<`Buffer`\<`ArrayBuffer`\> \| `null`\>
-
-Defined in: [utils.ts:2398](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2398)
-
-Synthesizes text to speech audio using [Amazon Polly](https://aws.amazon.com/polly/).
-
-## Parameters
-
-### client
-
-`PollyClient`
-
-An Amazon Polly Client instance
-
-### input
-
-`string`
-
-The input in SSML format or plain text (adjust `TextType` property in `options`)
-
-### options
-
-`Omit`\<`SynthesizeSpeechCommandInput`, `"Text"`\>
-
-Speech generation settings
-
-## Returns
-
-`Promise`\<`Buffer`\<`ArrayBuffer`\> \| `null`\>
-
-A promise resolving with an audio stream buffer or with `null` if the generation failed