/**
* @typedef {Object} DefaultOptions
* @property {Boolean} [useObsoleteKana=false] - Set to true to use obsolete characters, such as ゐ and ゑ.
* @example
* toHiragana('we', { useObsoleteKana: true })
* // => 'ゑ'
* @property {Boolean} [passRomaji=false] - Set to true to pass romaji when using mixed syllabaries with toKatakana() or toHiragana()
* @example
* toHiragana('only convert the katakana: ヒラガナ', { passRomaji: true })
* // => "only convert the katakana: ひらがな"
* @property {Boolean} [upcaseKatakana=false] - Set to true to convert katakana to uppercase using toRomaji()
* @example
* toRomaji('ひらがな カタカナ', { upcaseKatakana: true })
* // => "hiragana KATAKANA"
* @property {Boolean} [IMEMode=false] - Set to true to handle conversion from a text input as it is being typed
*/
/**
* Default config for KanaWana, user passed options will be merged with this
* @type {DefaultOptions}
* @ignore
*/
export const DEFAULT_OPTIONS = {
useObsoleteKana: false,
passRomaji: false,
upcaseKatakana: false,
IMEMode: false,
};
// CharCode References
// http://unicode-table.com
// http://www.rikai.com/library/kanjitables/kanji_codes.unicode.shtml
/**
* All Japanese regex, for mixes of kanji and kana like "泣き虫"
* Includes Japanese full-width punctuation ranges
* Doesn't include *half-width katakana / roman letters* since they should be considered typos
* @type {RegExp}
* @ignore
*/
export const KANJI_KANA_REGEX = /[\u3000-\u303f\u3040-\u309f\u30a0-\u30ff\uff01-\uff0f\u4e00-\u9faf\u3400-\u4dbf]/;
/**
* Basic Latin unicode regex, for determining Romaji written as Hepburn romanisation
* Includes upper/lowercase long vowels like "ā, ī, ū, ē, ō"
* Includes curly quotes ‘’ “”
* @type {RegExp}
* @ignore
*/
export const ROMAJI_REGEX = /[\u0000-\u007f\u0100-\u0101\u0112-\u0113\u012a-\u012b\u014c-\u014d\u016a-\u016b\u2018-\u2019\u201C-\u201D]/;
// TODO: just use a regex instead? not sure why these are in arrays
export const ENGLISH_PUNCTUATION_RANGES = [
[0x21, 0x2F],
[0x3A, 0x3F],
[0x5B, 0x60],
[0x7B, 0x7E],
[0x2018, 0x2019], // ‘ ’
[0x201C, 0x201D], // “ ”
];
export const JAPANESE_FULLWIDTH_PUNCTUATION_RANGES = [
[0x3001, 0x303E],
[0x30FB, 0x30FC],
[0xFF01, 0xFF0F],
[0xFF1A, 0xFF1F],
[0xFF3B, 0xFF3F],
[0xFF5B, 0xFF60],
];
export const LOWERCASE_START = 0x61;
export const LOWERCASE_END = 0x7A;
export const UPPERCASE_START = 0x41;
export const UPPERCASE_END = 0x5A;
export const HIRAGANA_START = 0x3041;
export const HIRAGANA_END = 0x3096;
export const KATAKANA_START = 0x30A1;
export const KATAKANA_END = 0x30FC;
export const KANJI_START = 0x4E00;
export const KANJI_END = 0x9FAF;
export const LOWERCASE_FULLWIDTH_START = 0xFF41;
export const LOWERCASE_FULLWIDTH_END = 0xFF5A;
export const UPPERCASE_FULLWIDTH_START = 0xFF21;
export const UPPERCASE_FULLWIDTH_END = 0xFF3A;
export const PROLONGED_SOUND_MARK = 0x30FC;
export const KANA_SLASH_DOT = 0x30FB;
export const LONG_VOWELS = {
a: 'あ',
i: 'い',
u: 'う',
e: 'え',
o: 'う',
};
export const FOUR_CHAR_EDGECASES = [
'lts',
'chy',
'shy',
];
export const FROM_ROMAJI = {
'.': '。',
',': '、',
':': '：',
'/': '・',
'!': '！',
'?': '？',
'~': '〜',
'-': 'ー',
'‘': '「',
'’': '」',
'“': '『',
'”': '』',
'[': '［',
']': '］',
'(': '（',
')': '）',
'{': '｛',
'}': '｝',
'a': 'あ',
'i': 'い',
'u': 'う',
'e': 'え',
'o': 'お',
'yi': 'い',
'wu': 'う',
'whu': 'う',
'xa': 'ぁ',
'xi': 'ぃ',
'xu': 'ぅ',
'xe': 'ぇ',
'xo': 'ぉ',
'xyi': 'ぃ',
'xye': 'ぇ',
'ye': 'いぇ',
'wha': 'うぁ',
'whi': 'うぃ',
'whe': 'うぇ',
'who': 'うぉ',
'wi': 'うぃ',
'we': 'うぇ',
'va': 'ゔぁ',
'vi': 'ゔぃ',
'vu': 'ゔ',
've': 'ゔぇ',
'vo': 'ゔぉ',
'vya': 'ゔゃ',
'vyi': 'ゔぃ',
'vyu': 'ゔゅ',
'vye': 'ゔぇ',
'vyo': 'ゔょ',
'ka': 'か',
'ki': 'き',
'ku': 'く',
'ke': 'け',
'ko': 'こ',
'lka': 'ヵ',
'lke': 'ヶ',
'xka': 'ヵ',
'xke': 'ヶ',
'kya': 'きゃ',
'kyi': 'きぃ',
'kyu': 'きゅ',
'kye': 'きぇ',
'kyo': 'きょ',
'ca': 'か',
'ci': 'き',
'cu': 'く',
'ce': 'け',
'co': 'こ',
'lca': 'ヵ',
'lce': 'ヶ',
'xca': 'ヵ',
'xce': 'ヶ',
'qya': 'くゃ',
'qyu': 'くゅ',
'qyo': 'くょ',
'qwa': 'くぁ',
'qwi': 'くぃ',
'qwu': 'くぅ',
'qwe': 'くぇ',
'qwo': 'くぉ',
'qa': 'くぁ',
'qi': 'くぃ',
'qe': 'くぇ',
'qo': 'くぉ',
'kwa': 'くぁ',
'qyi': 'くぃ',
'qye': 'くぇ',
'ga': 'が',
'gi': 'ぎ',
'gu': 'ぐ',
'ge': 'げ',
'go': 'ご',
'gya': 'ぎゃ',
'gyi': 'ぎぃ',
'gyu': 'ぎゅ',
'gye': 'ぎぇ',
'gyo': 'ぎょ',
'gwa': 'ぐぁ',
'gwi': 'ぐぃ',
'gwu': 'ぐぅ',
'gwe': 'ぐぇ',
'gwo': 'ぐぉ',
'sa': 'さ',
'si': 'し',
'shi': 'し',
'su': 'す',
'se': 'せ',
'so': 'そ',
'za': 'ざ',
'zi': 'じ',
'zu': 'ず',
'ze': 'ぜ',
'zo': 'ぞ',
'ji': 'じ',
'sya': 'しゃ',
'syi': 'しぃ',
'syu': 'しゅ',
'sye': 'しぇ',
'syo': 'しょ',
'sha': 'しゃ',
'shu': 'しゅ',
'she': 'しぇ',
'sho': 'しょ',
'shya': 'しゃ', // 4 character code
'shyu': 'しゅ', // 4 character code
'shye': 'しぇ', // 4 character code
'shyo': 'しょ', // 4 character code
'swa': 'すぁ',
'swi': 'すぃ',
'swu': 'すぅ',
'swe': 'すぇ',
'swo': 'すぉ',
'zya': 'じゃ',
'zyi': 'じぃ',
'zyu': 'じゅ',
'zye': 'じぇ',
'zyo': 'じょ',
'ja': 'じゃ',
'ju': 'じゅ',
'je': 'じぇ',
'jo': 'じょ',
'jya': 'じゃ',
'jyi': 'じぃ',
'jyu': 'じゅ',
'jye': 'じぇ',
'jyo': 'じょ',
'ta': 'た',
'ti': 'ち',
'tu': 'つ',
'te': 'て',
'to': 'と',
'chi': 'ち',
'tsu': 'つ',
'ltu': 'っ',
'xtu': 'っ',
'tya': 'ちゃ',
'tyi': 'ちぃ',
'tyu': 'ちゅ',
'tye': 'ちぇ',
'tyo': 'ちょ',
'cha': 'ちゃ',
'chu': 'ちゅ',
'che': 'ちぇ',
'cho': 'ちょ',
'cya': 'ちゃ',
'cyi': 'ちぃ',
'cyu': 'ちゅ',
'cye': 'ちぇ',
'cyo': 'ちょ',
'chya': 'ちゃ', // 4 character code
'chyu': 'ちゅ', // 4 character code
'chye': 'ちぇ', // 4 character code
'chyo': 'ちょ', // 4 character code
'tsa': 'つぁ',
'tsi': 'つぃ',
'tse': 'つぇ',
'tso': 'つぉ',
'tha': 'てゃ',
'thi': 'てぃ',
'thu': 'てゅ',
'the': 'てぇ',
'tho': 'てょ',
'twa': 'とぁ',
'twi': 'とぃ',
'twu': 'とぅ',
'twe': 'とぇ',
'two': 'とぉ',
'da': 'だ',
'di': 'ぢ',
'du': 'づ',
'de': 'で',
'do': 'ど',
'dya': 'ぢゃ',
'dyi': 'ぢぃ',
'dyu': 'ぢゅ',
'dye': 'ぢぇ',
'dyo': 'ぢょ',
'dha': 'でゃ',
'dhi': 'でぃ',
'dhu': 'でゅ',
'dhe': 'でぇ',
'dho': 'でょ',
'dwa': 'どぁ',
'dwi': 'どぃ',
'dwu': 'どぅ',
'dwe': 'どぇ',
'dwo': 'どぉ',
'na': 'な',
'ni': 'に',
'nu': 'ぬ',
'ne': 'ね',
'no': 'の',
'nya': 'にゃ',
'nyi': 'にぃ',
'nyu': 'にゅ',
'nye': 'にぇ',
'nyo': 'にょ',
'ha': 'は',
'hi': 'ひ',
'hu': 'ふ',
'he': 'へ',
'ho': 'ほ',
'fu': 'ふ',
'hya': 'ひゃ',
'hyi': 'ひぃ',
'hyu': 'ひゅ',
'hye': 'ひぇ',
'hyo': 'ひょ',
'fya': 'ふゃ',
'fyu': 'ふゅ',
'fyo': 'ふょ',
'fwa': 'ふぁ',
'fwi': 'ふぃ',
'fwu': 'ふぅ',
'fwe': 'ふぇ',
'fwo': 'ふぉ',
'fa': 'ふぁ',
'fi': 'ふぃ',
'fe': 'ふぇ',
'fo': 'ふぉ',
'fyi': 'ふぃ',
'fye': 'ふぇ',
'ba': 'ば',
'bi': 'び',
'bu': 'ぶ',
'be': 'べ',
'bo': 'ぼ',
'bya': 'びゃ',
'byi': 'びぃ',
'byu': 'びゅ',
'bye': 'びぇ',
'byo': 'びょ',
'pa': 'ぱ',
'pi': 'ぴ',
'pu': 'ぷ',
'pe': 'ぺ',
'po': 'ぽ',
'pya': 'ぴゃ',
'pyi': 'ぴぃ',
'pyu': 'ぴゅ',
'pye': 'ぴぇ',
'pyo': 'ぴょ',
'ma': 'ま',
'mi': 'み',
'mu': 'む',
'me': 'め',
'mo': 'も',
'mya': 'みゃ',
'myi': 'みぃ',
'myu': 'みゅ',
'mye': 'みぇ',
'myo': 'みょ',
'ya': 'や',
'yu': 'ゆ',
'yo': 'よ',
'xya': 'ゃ',
'xyu': 'ゅ',
'xyo': 'ょ',
'ra': 'ら',
'ri': 'り',
'ru': 'る',
're': 'れ',
'ro': 'ろ',
'rya': 'りゃ',
'ryi': 'りぃ',
'ryu': 'りゅ',
'rye': 'りぇ',
'ryo': 'りょ',
'la': 'ら',
'li': 'り',
'lu': 'る',
'le': 'れ',
'lo': 'ろ',
'lya': 'りゃ',
'lyi': 'りぃ',
'lyu': 'りゅ',
'lye': 'りぇ',
'lyo': 'りょ',
'wa': 'わ',
'wo': 'を',
'lwe': 'ゎ',
'xwa': 'ゎ',
'n': 'ん',
'nn': 'ん',
'n ': 'ん', // n + space
'xn': 'ん',
'ltsu': 'っ', // 4 character code
};
export const TO_ROMAJI = {
' ': ' ',
'！': '!',
'？': '?',
'。': '.',
'：': ':',
'・': '/',
'、': ',',
'〜': '~',
'ー': '-',
'「': '‘',
'」': '’',
'『': '“',
'』': '”',
'［': '[',
'］': ']',
'（': '(',
'）': ')',
'｛': '{',
'｝': '}',
'あ': 'a',
'い': 'i',
'う': 'u',
'え': 'e',
'お': 'o',
'ゔぁ': 'va',
'ゔぃ': 'vi',
'ゔ': 'vu',
'ゔぇ': 've',
'ゔぉ': 'vo',
'か': 'ka',
'き': 'ki',
'きゃ': 'kya',
'きぃ': 'kyi',
'きゅ': 'kyu',
'く': 'ku',
'け': 'ke',
'こ': 'ko',
'が': 'ga',
'ぎ': 'gi',
'ぐ': 'gu',
'げ': 'ge',
'ご': 'go',
'ぎゃ': 'gya',
'ぎぃ': 'gyi',
'ぎゅ': 'gyu',
'ぎぇ': 'gye',
'ぎょ': 'gyo',
'さ': 'sa',
'す': 'su',
'せ': 'se',
'そ': 'so',
'ざ': 'za',
'ず': 'zu',
'ぜ': 'ze',
'ぞ': 'zo',
'し': 'shi',
'しゃ': 'sha',
'しゅ': 'shu',
'しょ': 'sho',
'じ': 'ji',
'じゃ': 'ja',
'じゅ': 'ju',
'じょ': 'jo',
'た': 'ta',
'ち': 'chi',
'ちゃ': 'cha',
'ちゅ': 'chu',
'ちょ': 'cho',
'つ': 'tsu',
'て': 'te',
'と': 'to',
'だ': 'da',
'ぢ': 'di',
'づ': 'du',
'で': 'de',
'ど': 'do',
'な': 'na',
'に': 'ni',
'にゃ': 'nya',
'にゅ': 'nyu',
'にょ': 'nyo',
'ぬ': 'nu',
'ね': 'ne',
'の': 'no',
'は': 'ha',
'ひ': 'hi',
'ふ': 'fu',
'へ': 'he',
'ほ': 'ho',
'ひゃ': 'hya',
'ひゅ': 'hyu',
'ひょ': 'hyo',
'ふぁ': 'fa',
'ふぃ': 'fi',
'ふぇ': 'fe',
'ふぉ': 'fo',
'ば': 'ba',
'び': 'bi',
'ぶ': 'bu',
'べ': 'be',
'ぼ': 'bo',
'びゃ': 'bya',
'びゅ': 'byu',
'びょ': 'byo',
'ぱ': 'pa',
'ぴ': 'pi',
'ぷ': 'pu',
'ぺ': 'pe',
'ぽ': 'po',
'ぴゃ': 'pya',
'ぴゅ': 'pyu',
'ぴょ': 'pyo',
'ま': 'ma',
'み': 'mi',
'む': 'mu',
'め': 'me',
'も': 'mo',
'みゃ': 'mya',
'みゅ': 'myu',
'みょ': 'myo',
'や': 'ya',
'ゆ': 'yu',
'よ': 'yo',
'ら': 'ra',
'り': 'ri',
'る': 'ru',
'れ': 're',
'ろ': 'ro',
'りゃ': 'rya',
'りゅ': 'ryu',
'りょ': 'ryo',
'わ': 'wa',
'を': 'wo',
'ん': 'n',
// Archaic characters
'ゐ': 'wi',
'ゑ': 'we',
// Uncommon character combos
'きぇ': 'kye',
'きょ': 'kyo',
'じぃ': 'jyi',
'じぇ': 'jye',
'ちぃ': 'cyi',
'ちぇ': 'che',
'ひぃ': 'hyi',
'ひぇ': 'hye',
'びぃ': 'byi',
'びぇ': 'bye',
'ぴぃ': 'pyi',
'ぴぇ': 'pye',
'みぇ': 'mye',
'みぃ': 'myi',
'りぃ': 'ryi',
'りぇ': 'rye',
'にぃ': 'nyi',
'にぇ': 'nye',
'しぃ': 'syi',
'しぇ': 'she',
'いぇ': 'ye',
'うぁ': 'wha',
'うぉ': 'who',
'うぃ': 'wi',
'うぇ': 'we',
'ゔゃ': 'vya',
'ゔゅ': 'vyu',
'ゔょ': 'vyo',
'すぁ': 'swa',
'すぃ': 'swi',
'すぅ': 'swu',
'すぇ': 'swe',
'すぉ': 'swo',
'くゃ': 'qya',
'くゅ': 'qyu',
'くょ': 'qyo',
'くぁ': 'qwa',
'くぃ': 'qwi',
'くぅ': 'qwu',
'くぇ': 'qwe',
'くぉ': 'qwo',
'ぐぁ': 'gwa',
'ぐぃ': 'gwi',
'ぐぅ': 'gwu',
'ぐぇ': 'gwe',
'ぐぉ': 'gwo',
'つぁ': 'tsa',
'つぃ': 'tsi',
'つぇ': 'tse',
'つぉ': 'tso',
'てゃ': 'tha',
'てぃ': 'thi',
'てゅ': 'thu',
'てぇ': 'the',
'てょ': 'tho',
'とぁ': 'twa',
'とぃ': 'twi',
'とぅ': 'twu',
'とぇ': 'twe',
'とぉ': 'two',
'ぢゃ': 'dya',
'ぢぃ': 'dyi',
'ぢゅ': 'dyu',
'ぢぇ': 'dye',
'ぢょ': 'dyo',
'でゃ': 'dha',
'でぃ': 'dhi',
'でゅ': 'dhu',
'でぇ': 'dhe',
'でょ': 'dho',
'どぁ': 'dwa',
'どぃ': 'dwi',
'どぅ': 'dwu',
'どぇ': 'dwe',
'どぉ': 'dwo',
'ふぅ': 'fwu',
'ふゃ': 'fya',
'ふゅ': 'fyu',
'ふょ': 'fyo',
// Small Characters (normally not transliterated alone)
'ぁ': 'a',
'ぃ': 'i',
'ぇ': 'e',
'ぅ': 'u',
'ぉ': 'o',
'ゃ': 'ya',
'ゅ': 'yu',
'ょ': 'yo',
'っ': '',
'ゕ': 'ka',
'ゖ': 'ka',
'ゎ': 'wa',
// Ambiguous consonant vowel pairs
'んあ': 'n\'a',
'んい': 'n\'i',
'んう': 'n\'u',
'んえ': 'n\'e',
'んお': 'n\'o',
'んや': 'n\'ya',
'んゆ': 'n\'yu',
'んよ': 'n\'yo',
};