shevchenko 2.1.3 → 3.0.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (468) hide show
  1. package/.github/workflows/npm-publish.yml +36 -0
  2. package/README.md +8 -7
  3. package/dist/cjs/anthroponym-declension/anthroponym-inflector.js +39 -0
  4. package/dist/cjs/anthroponym-declension/anthroponym-inflector.js.map +1 -0
  5. package/dist/cjs/anthroponym-declension/family-name-inflector.js +69 -0
  6. package/dist/cjs/anthroponym-declension/family-name-inflector.js.map +1 -0
  7. package/dist/cjs/anthroponym-declension/given-name-inflector.js +40 -0
  8. package/dist/cjs/anthroponym-declension/given-name-inflector.js.map +1 -0
  9. package/dist/cjs/anthroponym-declension/name-inflector.js +30 -0
  10. package/dist/cjs/anthroponym-declension/name-inflector.js.map +1 -0
  11. package/dist/cjs/anthroponym-declension/patronymic-name-inflector.js +40 -0
  12. package/dist/cjs/anthroponym-declension/patronymic-name-inflector.js.map +1 -0
  13. package/dist/cjs/bootstrap.js +29 -0
  14. package/dist/cjs/bootstrap.js.map +1 -0
  15. package/dist/cjs/gender-detection/detect-gender.js +55 -0
  16. package/dist/cjs/gender-detection/detect-gender.js.map +1 -0
  17. package/dist/cjs/gender-detection/given-names-genders.json.js +1158 -0
  18. package/dist/cjs/gender-detection/given-names-genders.json.js.map +1 -0
  19. package/dist/cjs/index.js +36 -0
  20. package/dist/cjs/index.js.map +1 -0
  21. package/dist/cjs/input-validation.js +83 -0
  22. package/dist/cjs/input-validation.js.map +1 -0
  23. package/dist/cjs/language/alphabet.js +54 -0
  24. package/dist/cjs/language/alphabet.js.map +1 -0
  25. package/dist/cjs/language/grammatical-case.js +27 -0
  26. package/dist/cjs/language/grammatical-case.js.map +1 -0
  27. package/dist/cjs/language/grammatical-gender.js +22 -0
  28. package/dist/cjs/language/grammatical-gender.js.map +1 -0
  29. package/dist/cjs/language/letter-case.js +49 -0
  30. package/dist/cjs/language/letter-case.js.map +1 -0
  31. package/dist/cjs/language/linguistics.js +35 -0
  32. package/dist/cjs/language/linguistics.js.map +1 -0
  33. package/dist/cjs/language/word-class.js +22 -0
  34. package/dist/cjs/language/word-class.js.map +1 -0
  35. package/dist/cjs/shevchenko.js +67 -154555
  36. package/dist/cjs/shevchenko.js.map +1 -1
  37. package/dist/cjs/word-class-recognition/artifacts/model.bundle.json.js +199 -0
  38. package/dist/cjs/word-class-recognition/artifacts/model.bundle.json.js.map +1 -0
  39. package/dist/cjs/word-class-recognition/cache/incorrect-predictions.json.js +1459 -0
  40. package/dist/cjs/word-class-recognition/cache/incorrect-predictions.json.js.map +1 -0
  41. package/dist/cjs/word-class-recognition/model-bundle-loader.js +74 -0
  42. package/dist/cjs/word-class-recognition/model-bundle-loader.js.map +1 -0
  43. package/dist/cjs/word-class-recognition/model-config.js +20 -0
  44. package/dist/cjs/word-class-recognition/model-config.js.map +1 -0
  45. package/dist/cjs/word-class-recognition/word-class-recognizer.js +76 -0
  46. package/dist/cjs/word-class-recognition/word-class-recognizer.js.map +1 -0
  47. package/dist/cjs/word-class-recognition/word-class-transformer.js +52 -0
  48. package/dist/cjs/word-class-recognition/word-class-transformer.js.map +1 -0
  49. package/dist/cjs/word-class-recognition/word-transformer.js +37 -0
  50. package/dist/cjs/word-class-recognition/word-transformer.js.map +1 -0
  51. package/dist/cjs/word-declension/append-command-runner.js +28 -0
  52. package/dist/cjs/word-declension/append-command-runner.js.map +1 -0
  53. package/dist/cjs/word-declension/command-runner-factory.js +38 -0
  54. package/dist/cjs/word-declension/command-runner-factory.js.map +1 -0
  55. package/dist/cjs/word-declension/declension-rule-inflector.js +65 -0
  56. package/dist/cjs/word-declension/declension-rule-inflector.js.map +1 -0
  57. package/dist/cjs/word-declension/declension-rule-matchers.js +43 -0
  58. package/dist/cjs/word-declension/declension-rule-matchers.js.map +1 -0
  59. package/dist/cjs/word-declension/declension-rules.json.js +7405 -0
  60. package/dist/cjs/word-declension/declension-rules.json.js.map +1 -0
  61. package/dist/cjs/word-declension/declension-types.js +24 -0
  62. package/dist/cjs/word-declension/declension-types.js.map +1 -0
  63. package/dist/cjs/word-declension/index.js +28 -0
  64. package/dist/cjs/word-declension/index.js.map +1 -0
  65. package/dist/cjs/word-declension/replace-command-runner.js +28 -0
  66. package/dist/cjs/word-declension/replace-command-runner.js.map +1 -0
  67. package/dist/es/anthroponym-declension/anthroponym-inflector.d.ts +16 -0
  68. package/dist/es/anthroponym-declension/anthroponym-inflector.d.ts.map +1 -0
  69. package/dist/es/anthroponym-declension/anthroponym-inflector.js +35 -0
  70. package/dist/es/anthroponym-declension/anthroponym-inflector.js.map +1 -0
  71. package/dist/es/anthroponym-declension/anthroponym.d.ts +6 -0
  72. package/dist/es/anthroponym-declension/anthroponym.d.ts.map +1 -0
  73. package/dist/es/anthroponym-declension/family-name-inflector.d.ts +14 -0
  74. package/dist/es/anthroponym-declension/family-name-inflector.d.ts.map +1 -0
  75. package/dist/es/anthroponym-declension/family-name-inflector.js +65 -0
  76. package/dist/es/anthroponym-declension/family-name-inflector.js.map +1 -0
  77. package/dist/es/anthroponym-declension/given-name-inflector.d.ts +12 -0
  78. package/dist/es/anthroponym-declension/given-name-inflector.d.ts.map +1 -0
  79. package/dist/es/anthroponym-declension/given-name-inflector.js +36 -0
  80. package/dist/es/anthroponym-declension/given-name-inflector.js.map +1 -0
  81. package/dist/es/anthroponym-declension/index.d.ts +6 -0
  82. package/dist/es/anthroponym-declension/index.d.ts.map +1 -0
  83. package/dist/es/anthroponym-declension/name-inflector.d.ts +12 -0
  84. package/dist/es/anthroponym-declension/name-inflector.d.ts.map +1 -0
  85. package/dist/es/anthroponym-declension/name-inflector.js +26 -0
  86. package/dist/es/anthroponym-declension/name-inflector.js.map +1 -0
  87. package/dist/es/anthroponym-declension/patronymic-name-inflector.d.ts +12 -0
  88. package/dist/es/anthroponym-declension/patronymic-name-inflector.d.ts.map +1 -0
  89. package/dist/es/anthroponym-declension/patronymic-name-inflector.js +36 -0
  90. package/dist/es/anthroponym-declension/patronymic-name-inflector.js.map +1 -0
  91. package/dist/es/bootstrap.d.ts +4 -0
  92. package/dist/{types → es}/bootstrap.d.ts.map +1 -1
  93. package/dist/es/bootstrap.js +25 -0
  94. package/dist/es/bootstrap.js.map +1 -0
  95. package/dist/es/contracts.d.ts +21 -0
  96. package/dist/es/contracts.d.ts.map +1 -0
  97. package/dist/es/gender-detection/detect-gender.d.ts +11 -0
  98. package/dist/es/gender-detection/detect-gender.d.ts.map +1 -0
  99. package/dist/es/gender-detection/detect-gender.js +51 -0
  100. package/dist/es/gender-detection/detect-gender.js.map +1 -0
  101. package/dist/es/gender-detection/detect-gender.test.d.ts +2 -0
  102. package/dist/es/gender-detection/detect-gender.test.d.ts.map +1 -0
  103. package/dist/es/gender-detection/given-names-genders.json.js +1156 -0
  104. package/dist/es/gender-detection/given-names-genders.json.js.map +1 -0
  105. package/dist/es/gender-detection/index.d.ts +2 -0
  106. package/dist/es/gender-detection/index.d.ts.map +1 -0
  107. package/dist/es/index.d.ts +2 -0
  108. package/dist/es/index.d.ts.map +1 -0
  109. package/dist/es/index.js +13 -0
  110. package/dist/es/index.js.map +1 -0
  111. package/dist/es/input-validation.d.ts +14 -0
  112. package/dist/es/input-validation.d.ts.map +1 -0
  113. package/dist/es/input-validation.js +78 -0
  114. package/dist/es/input-validation.js.map +1 -0
  115. package/dist/es/input-validation.test.d.ts +2 -0
  116. package/dist/es/input-validation.test.d.ts.map +1 -0
  117. package/dist/es/language/alphabet.d.ts +48 -0
  118. package/dist/es/language/alphabet.d.ts.map +1 -0
  119. package/dist/es/language/alphabet.js +52 -0
  120. package/dist/es/language/alphabet.js.map +1 -0
  121. package/dist/es/language/grammatical-case.d.ts +13 -0
  122. package/dist/es/language/grammatical-case.d.ts.map +1 -0
  123. package/dist/es/language/grammatical-case.js +25 -0
  124. package/dist/es/language/grammatical-case.js.map +1 -0
  125. package/dist/es/language/grammatical-gender.d.ts +8 -0
  126. package/dist/es/language/grammatical-gender.d.ts.map +1 -0
  127. package/dist/es/language/grammatical-gender.js +20 -0
  128. package/dist/es/language/grammatical-gender.js.map +1 -0
  129. package/dist/es/language/index.d.ts +7 -0
  130. package/dist/es/language/index.d.ts.map +1 -0
  131. package/dist/es/language/letter-case.d.ts +6 -0
  132. package/dist/es/language/letter-case.d.ts.map +1 -0
  133. package/dist/es/language/letter-case.js +45 -0
  134. package/dist/es/language/letter-case.js.map +1 -0
  135. package/dist/es/language/letter-case.test.d.ts +2 -0
  136. package/dist/es/language/letter-case.test.d.ts.map +1 -0
  137. package/dist/es/language/linguistics.d.ts +7 -0
  138. package/dist/es/language/linguistics.d.ts.map +1 -0
  139. package/dist/es/language/linguistics.js +30 -0
  140. package/dist/es/language/linguistics.js.map +1 -0
  141. package/dist/es/language/linguistics.test.d.ts +2 -0
  142. package/dist/es/language/linguistics.test.d.ts.map +1 -0
  143. package/dist/es/language/word-class.d.ts +8 -0
  144. package/dist/es/language/word-class.d.ts.map +1 -0
  145. package/dist/es/language/word-class.js +20 -0
  146. package/dist/es/language/word-class.js.map +1 -0
  147. package/dist/es/shevchenko.d.ts +54 -0
  148. package/dist/es/shevchenko.d.ts.map +1 -0
  149. package/dist/es/shevchenko.js +60 -154480
  150. package/dist/es/shevchenko.js.map +1 -1
  151. package/dist/es/word-class-recognition/artifacts/model.bundle.json.js +190 -0
  152. package/dist/es/word-class-recognition/artifacts/model.bundle.json.js.map +1 -0
  153. package/dist/es/word-class-recognition/cache/incorrect-predictions.json.js +1457 -0
  154. package/dist/es/word-class-recognition/cache/incorrect-predictions.json.js.map +1 -0
  155. package/dist/es/word-class-recognition/data.utils.d.ts +16 -0
  156. package/dist/es/word-class-recognition/data.utils.d.ts.map +1 -0
  157. package/dist/es/word-class-recognition/index.d.ts +3 -0
  158. package/dist/es/word-class-recognition/index.d.ts.map +1 -0
  159. package/dist/es/word-class-recognition/model-bundle-loader.d.ts +15 -0
  160. package/dist/es/word-class-recognition/model-bundle-loader.d.ts.map +1 -0
  161. package/dist/es/word-class-recognition/model-bundle-loader.js +69 -0
  162. package/dist/es/word-class-recognition/model-bundle-loader.js.map +1 -0
  163. package/dist/es/word-class-recognition/model-bundle-saver.d.ts +12 -0
  164. package/dist/es/word-class-recognition/model-bundle-saver.d.ts.map +1 -0
  165. package/dist/es/word-class-recognition/model-config.d.ts +5 -0
  166. package/dist/es/word-class-recognition/model-config.d.ts.map +1 -0
  167. package/dist/es/word-class-recognition/model-config.js +16 -0
  168. package/dist/es/word-class-recognition/model-config.js.map +1 -0
  169. package/dist/es/word-class-recognition/scripts/cache-incorrect-predictions.d.ts +2 -0
  170. package/dist/es/word-class-recognition/scripts/cache-incorrect-predictions.d.ts.map +1 -0
  171. package/dist/es/word-class-recognition/scripts/train-model.d.ts +7 -0
  172. package/dist/es/word-class-recognition/scripts/train-model.d.ts.map +1 -0
  173. package/dist/es/word-class-recognition/word-class-recognizer.d.ts +18 -0
  174. package/dist/es/word-class-recognition/word-class-recognizer.d.ts.map +1 -0
  175. package/dist/es/word-class-recognition/word-class-recognizer.js +52 -0
  176. package/dist/es/word-class-recognition/word-class-recognizer.js.map +1 -0
  177. package/dist/es/word-class-recognition/word-class-transformer.d.ts +6 -0
  178. package/dist/es/word-class-recognition/word-class-transformer.d.ts.map +1 -0
  179. package/dist/es/word-class-recognition/word-class-transformer.js +48 -0
  180. package/dist/es/word-class-recognition/word-class-transformer.js.map +1 -0
  181. package/dist/es/word-class-recognition/word-class-transformer.test.d.ts +2 -0
  182. package/dist/es/word-class-recognition/word-class-transformer.test.d.ts.map +1 -0
  183. package/dist/es/word-class-recognition/word-transformer.d.ts +7 -0
  184. package/dist/es/word-class-recognition/word-transformer.d.ts.map +1 -0
  185. package/dist/es/word-class-recognition/word-transformer.js +33 -0
  186. package/dist/es/word-class-recognition/word-transformer.js.map +1 -0
  187. package/dist/es/word-class-recognition/word-transformer.test.d.ts +2 -0
  188. package/dist/es/word-class-recognition/word-transformer.test.d.ts.map +1 -0
  189. package/dist/es/word-declension/append-command-runner.d.ts +12 -0
  190. package/dist/es/word-declension/append-command-runner.d.ts.map +1 -0
  191. package/dist/es/word-declension/append-command-runner.js +24 -0
  192. package/dist/es/word-declension/append-command-runner.js.map +1 -0
  193. package/dist/es/word-declension/command-runner-factory.d.ts +9 -0
  194. package/dist/es/word-declension/command-runner-factory.d.ts.map +1 -0
  195. package/dist/es/word-declension/command-runner-factory.js +34 -0
  196. package/dist/es/word-declension/command-runner-factory.js.map +1 -0
  197. package/dist/es/word-declension/declension-rule-inflector.d.ts +16 -0
  198. package/dist/es/word-declension/declension-rule-inflector.d.ts.map +1 -0
  199. package/dist/es/word-declension/declension-rule-inflector.js +60 -0
  200. package/dist/es/word-declension/declension-rule-inflector.js.map +1 -0
  201. package/dist/es/word-declension/declension-rule-matchers.d.ts +19 -0
  202. package/dist/es/word-declension/declension-rule-matchers.d.ts.map +1 -0
  203. package/dist/es/word-declension/declension-rule-matchers.js +36 -0
  204. package/dist/es/word-declension/declension-rule-matchers.js.map +1 -0
  205. package/dist/es/word-declension/declension-rules.json.js +7403 -0
  206. package/dist/es/word-declension/declension-rules.json.js.map +1 -0
  207. package/dist/es/word-declension/declension-types.d.ts +36 -0
  208. package/dist/es/word-declension/declension-types.d.ts.map +1 -0
  209. package/dist/es/word-declension/declension-types.js +22 -0
  210. package/dist/es/word-declension/declension-types.js.map +1 -0
  211. package/dist/es/word-declension/index.d.ts +7 -0
  212. package/dist/es/word-declension/index.d.ts.map +1 -0
  213. package/dist/es/word-declension/index.js +20 -0
  214. package/dist/es/word-declension/index.js.map +1 -0
  215. package/dist/es/word-declension/inflection-command-runner.d.ts +4 -0
  216. package/dist/es/word-declension/inflection-command-runner.d.ts.map +1 -0
  217. package/dist/es/word-declension/replace-command-runner.d.ts +12 -0
  218. package/dist/es/word-declension/replace-command-runner.d.ts.map +1 -0
  219. package/dist/es/word-declension/replace-command-runner.js +24 -0
  220. package/dist/es/word-declension/replace-command-runner.js.map +1 -0
  221. package/dist/es/word-declension/scripts/load-declension-rules.d.ts +2 -0
  222. package/dist/es/word-declension/scripts/load-declension-rules.d.ts.map +1 -0
  223. package/dist/umd/shevchenko.min.js +4680 -68
  224. package/dist/umd/shevchenko.min.js.map +1 -1
  225. package/package.json +38 -37
  226. package/src/anthroponym-declension/README.md +3 -0
  227. package/src/anthroponym-declension/anthroponym-inflector.ts +58 -0
  228. package/src/anthroponym-declension/anthroponym.ts +5 -0
  229. package/src/anthroponym-declension/family-name-inflector.ts +75 -0
  230. package/src/anthroponym-declension/given-name-inflector.ts +38 -0
  231. package/src/anthroponym-declension/index.ts +5 -0
  232. package/src/anthroponym-declension/name-inflector.ts +38 -0
  233. package/src/anthroponym-declension/patronymic-name-inflector.ts +38 -0
  234. package/src/bootstrap.ts +20 -47
  235. package/src/contracts.ts +22 -0
  236. package/src/gender-detection/README.md +5 -0
  237. package/src/gender-detection/detect-gender.ts +43 -0
  238. package/src/gender-detection/given-names-genders.json +1144 -0
  239. package/src/gender-detection/index.ts +1 -0
  240. package/src/index.ts +1 -0
  241. package/src/input-validation.ts +80 -0
  242. package/src/language/README.md +3 -0
  243. package/src/language/alphabet.ts +49 -0
  244. package/src/language/grammatical-case.ts +12 -0
  245. package/src/language/grammatical-gender.ts +7 -0
  246. package/src/language/index.ts +6 -0
  247. package/src/language/letter-case.ts +35 -0
  248. package/src/language/linguistics.ts +20 -0
  249. package/src/language/word-class.ts +7 -0
  250. package/src/shevchenko.ts +65 -33
  251. package/src/word-class-recognition/README.md +5 -0
  252. package/src/word-class-recognition/artifacts/model.bundle.json +7 -0
  253. package/src/word-class-recognition/artifacts/model.json +1 -0
  254. package/src/word-class-recognition/artifacts/weights.bin +0 -0
  255. package/src/word-class-recognition/cache/incorrect-predictions.json +1445 -0
  256. package/src/word-class-recognition/data.utils.ts +57 -0
  257. package/src/word-class-recognition/index.ts +2 -0
  258. package/src/word-class-recognition/model-bundle-loader.ts +73 -0
  259. package/src/word-class-recognition/model-bundle-saver.ts +105 -0
  260. package/src/word-class-recognition/model-config.ts +4 -0
  261. package/src/word-class-recognition/scripts/cache-incorrect-predictions.ts +46 -0
  262. package/src/word-class-recognition/scripts/train-model.ts +95 -0
  263. package/src/word-class-recognition/word-class-recognizer.ts +54 -0
  264. package/src/word-class-recognition/word-class-transformer.ts +38 -0
  265. package/src/word-class-recognition/word-transformer.ts +23 -0
  266. package/src/word-declension/README.md +3 -0
  267. package/src/word-declension/append-command-runner.ts +18 -0
  268. package/src/word-declension/command-runner-factory.ts +23 -0
  269. package/src/{anthroponym-inflection/rule-inflector.ts → word-declension/declension-rule-inflector.ts} +17 -7
  270. package/src/word-declension/declension-rule-matchers.ts +30 -0
  271. package/src/{resources/inflector/rules.json → word-declension/declension-rules.json} +1119 -1119
  272. package/src/word-declension/declension-types.ts +41 -0
  273. package/src/word-declension/index.ts +9 -0
  274. package/src/word-declension/inflection-command-runner.ts +3 -0
  275. package/src/word-declension/replace-command-runner.ts +18 -0
  276. package/src/word-declension/scripts/load-declension-rules.ts +14 -0
  277. package/dist/types/anthroponym-inflection/anthroponym-inflector.d.ts +0 -15
  278. package/dist/types/anthroponym-inflection/anthroponym-inflector.d.ts.map +0 -1
  279. package/dist/types/anthroponym-inflection/append-command-runner.d.ts +0 -12
  280. package/dist/types/anthroponym-inflection/append-command-runner.d.ts.map +0 -1
  281. package/dist/types/anthroponym-inflection/command-runner-factory.d.ts +0 -9
  282. package/dist/types/anthroponym-inflection/command-runner-factory.d.ts.map +0 -1
  283. package/dist/types/anthroponym-inflection/first-name-inflector.d.ts +0 -12
  284. package/dist/types/anthroponym-inflection/first-name-inflector.d.ts.map +0 -1
  285. package/dist/types/anthroponym-inflection/index.d.ts +0 -6
  286. package/dist/types/anthroponym-inflection/index.d.ts.map +0 -1
  287. package/dist/types/anthroponym-inflection/inflector-command-runner.d.ts +0 -4
  288. package/dist/types/anthroponym-inflection/inflector-command-runner.d.ts.map +0 -1
  289. package/dist/types/anthroponym-inflection/inflector.types.d.ts +0 -37
  290. package/dist/types/anthroponym-inflection/inflector.types.d.ts.map +0 -1
  291. package/dist/types/anthroponym-inflection/last-name-inflector.d.ts +0 -14
  292. package/dist/types/anthroponym-inflection/last-name-inflector.d.ts.map +0 -1
  293. package/dist/types/anthroponym-inflection/middle-name-inflector.d.ts +0 -12
  294. package/dist/types/anthroponym-inflection/middle-name-inflector.d.ts.map +0 -1
  295. package/dist/types/anthroponym-inflection/name-inflector.d.ts +0 -12
  296. package/dist/types/anthroponym-inflection/name-inflector.d.ts.map +0 -1
  297. package/dist/types/anthroponym-inflection/replace-command-runner.d.ts +0 -12
  298. package/dist/types/anthroponym-inflection/replace-command-runner.d.ts.map +0 -1
  299. package/dist/types/anthroponym-inflection/rule-inflector.d.ts +0 -12
  300. package/dist/types/anthroponym-inflection/rule-inflector.d.ts.map +0 -1
  301. package/dist/types/bootstrap.d.ts +0 -4
  302. package/dist/types/core/anthroponym.interface.d.ts +0 -8
  303. package/dist/types/core/anthroponym.interface.d.ts.map +0 -1
  304. package/dist/types/core/gender.enum.d.ts +0 -5
  305. package/dist/types/core/gender.enum.d.ts.map +0 -1
  306. package/dist/types/core/grammatical-case.enum.d.ts +0 -10
  307. package/dist/types/core/grammatical-case.enum.d.ts.map +0 -1
  308. package/dist/types/core/index.d.ts +0 -5
  309. package/dist/types/core/index.d.ts.map +0 -1
  310. package/dist/types/core/validator.d.ts +0 -8
  311. package/dist/types/core/validator.d.ts.map +0 -1
  312. package/dist/types/internal.d.ts +0 -2
  313. package/dist/types/internal.d.ts.map +0 -1
  314. package/dist/types/part-of-speech-recognition/index.d.ts +0 -6
  315. package/dist/types/part-of-speech-recognition/index.d.ts.map +0 -1
  316. package/dist/types/part-of-speech-recognition/neural-network-config.d.ts +0 -6
  317. package/dist/types/part-of-speech-recognition/neural-network-config.d.ts.map +0 -1
  318. package/dist/types/part-of-speech-recognition/neural-network-training-data.d.ts +0 -5
  319. package/dist/types/part-of-speech-recognition/neural-network-training-data.d.ts.map +0 -1
  320. package/dist/types/part-of-speech-recognition/neural-network.d.ts +0 -28
  321. package/dist/types/part-of-speech-recognition/neural-network.d.ts.map +0 -1
  322. package/dist/types/part-of-speech-recognition/part-of-speech-decoder.d.ts +0 -9
  323. package/dist/types/part-of-speech-recognition/part-of-speech-decoder.d.ts.map +0 -1
  324. package/dist/types/part-of-speech-recognition/part-of-speech-encoder.d.ts +0 -10
  325. package/dist/types/part-of-speech-recognition/part-of-speech-encoder.d.ts.map +0 -1
  326. package/dist/types/part-of-speech-recognition/part-of-speech-recognition-rule.d.ts +0 -19
  327. package/dist/types/part-of-speech-recognition/part-of-speech-recognition-rule.d.ts.map +0 -1
  328. package/dist/types/part-of-speech-recognition/part-of-speech-recognizer.d.ts +0 -14
  329. package/dist/types/part-of-speech-recognition/part-of-speech-recognizer.d.ts.map +0 -1
  330. package/dist/types/part-of-speech-recognition/part-of-speech.enum.d.ts +0 -5
  331. package/dist/types/part-of-speech-recognition/part-of-speech.enum.d.ts.map +0 -1
  332. package/dist/types/part-of-speech-recognition/word-encoder.d.ts +0 -9
  333. package/dist/types/part-of-speech-recognition/word-encoder.d.ts.map +0 -1
  334. package/dist/types/part-of-speech-recognition/word-transformer.d.ts +0 -7
  335. package/dist/types/part-of-speech-recognition/word-transformer.d.ts.map +0 -1
  336. package/dist/types/shevchenko.d.ts +0 -32
  337. package/dist/types/shevchenko.d.ts.map +0 -1
  338. package/dist/types/utils/lang.utils.d.ts +0 -7
  339. package/dist/types/utils/lang.utils.d.ts.map +0 -1
  340. package/dist/types/utils/regexp.utils.d.ts +0 -5
  341. package/dist/types/utils/regexp.utils.d.ts.map +0 -1
  342. package/dist/types/utils/string.utils.d.ts +0 -14
  343. package/dist/types/utils/string.utils.d.ts.map +0 -1
  344. package/nuxt/.eslintrc.json +0 -27
  345. package/nuxt/.prettierrc.json +0 -6
  346. package/nuxt/README.md +0 -27
  347. package/nuxt/app.config.ts +0 -3
  348. package/nuxt/app.vue +0 -5
  349. package/nuxt/assets/img/shevchenko_pixelized_304x304.jpg +0 -0
  350. package/nuxt/assets/img/shevchenko_pixelized_304x304.png +0 -0
  351. package/nuxt/assets/img/shevchenko_pixelized_608x608.jpg +0 -0
  352. package/nuxt/assets/style/main.scss +0 -3
  353. package/nuxt/components/about-modal.vue +0 -58
  354. package/nuxt/components/api-spec.vue +0 -25
  355. package/nuxt/components/contact-me-button.vue +0 -11
  356. package/nuxt/components/contact-me-modal.vue +0 -63
  357. package/nuxt/components/copy-button.vue +0 -38
  358. package/nuxt/components/declension-demo.vue +0 -38
  359. package/nuxt/components/declension-form.vue +0 -158
  360. package/nuxt/components/declension-preview.vue +0 -170
  361. package/nuxt/components/declension-results.vue +0 -135
  362. package/nuxt/components/error-404.vue +0 -15
  363. package/nuxt/components/github-issue-count.vue +0 -18
  364. package/nuxt/components/how-it-works.vue +0 -51
  365. package/nuxt/components/installation-instructions.vue +0 -33
  366. package/nuxt/components/library-docs.vue +0 -27
  367. package/nuxt/components/page-copyright.vue +0 -15
  368. package/nuxt/components/page-footer.vue +0 -32
  369. package/nuxt/components/page-header.vue +0 -4
  370. package/nuxt/components/preview-banner.vue +0 -32
  371. package/nuxt/components/share-links.vue +0 -108
  372. package/nuxt/components/top-nav-bar.vue +0 -165
  373. package/nuxt/components/ukrainian-flag.vue +0 -37
  374. package/nuxt/components/usage-example.vue +0 -32
  375. package/nuxt/composables/declension.ts +0 -124
  376. package/nuxt/composables/page-i18n.ts +0 -11
  377. package/nuxt/composables/page-meta.ts +0 -5
  378. package/nuxt/composables/route-utils.ts +0 -17
  379. package/nuxt/config.ts +0 -20
  380. package/nuxt/data/female-first-names.json +0 -556
  381. package/nuxt/data/male-first-names.json +0 -603
  382. package/nuxt/error.vue +0 -25
  383. package/nuxt/layouts/default.vue +0 -5
  384. package/nuxt/locales/en-US.json +0 -63
  385. package/nuxt/locales/uk-UA.json +0 -65
  386. package/nuxt/nuxt.config.ts +0 -99
  387. package/nuxt/package-lock.json +0 -19524
  388. package/nuxt/package.json +0 -37
  389. package/nuxt/pages/en-US/index.vue +0 -41
  390. package/nuxt/pages/index.vue +0 -68
  391. package/nuxt/plugins/i18n.ts +0 -26
  392. package/nuxt/public/.nojekyll +0 -0
  393. package/nuxt/public/CNAME +0 -1
  394. package/nuxt/public/android-icon-144x144.png +0 -0
  395. package/nuxt/public/android-icon-192x192.png +0 -0
  396. package/nuxt/public/android-icon-36x36.png +0 -0
  397. package/nuxt/public/android-icon-48x48.png +0 -0
  398. package/nuxt/public/android-icon-72x72.png +0 -0
  399. package/nuxt/public/android-icon-96x96.png +0 -0
  400. package/nuxt/public/apple-icon-114x114.png +0 -0
  401. package/nuxt/public/apple-icon-120x120.png +0 -0
  402. package/nuxt/public/apple-icon-144x144.png +0 -0
  403. package/nuxt/public/apple-icon-152x152.png +0 -0
  404. package/nuxt/public/apple-icon-180x180.png +0 -0
  405. package/nuxt/public/apple-icon-57x57.png +0 -0
  406. package/nuxt/public/apple-icon-60x60.png +0 -0
  407. package/nuxt/public/apple-icon-72x72.png +0 -0
  408. package/nuxt/public/apple-icon-76x76.png +0 -0
  409. package/nuxt/public/apple-icon-precomposed.png +0 -0
  410. package/nuxt/public/apple-icon.png +0 -0
  411. package/nuxt/public/browserconfig.xml +0 -2
  412. package/nuxt/public/favicon-16x16.png +0 -0
  413. package/nuxt/public/favicon-32x32.png +0 -0
  414. package/nuxt/public/favicon-96x96.png +0 -0
  415. package/nuxt/public/favicon.ico +0 -0
  416. package/nuxt/public/manifest.json +0 -41
  417. package/nuxt/public/ms-icon-144x144.png +0 -0
  418. package/nuxt/public/ms-icon-150x150.png +0 -0
  419. package/nuxt/public/ms-icon-310x310.png +0 -0
  420. package/nuxt/public/ms-icon-70x70.png +0 -0
  421. package/nuxt/public/preview-608x608.jpg +0 -0
  422. package/nuxt/scripts/postgenerate.js +0 -7
  423. package/nuxt/scripts/publish.js +0 -7
  424. package/nuxt/server/plugins/google-tag-manager.js +0 -37
  425. package/nuxt/tsconfig.json +0 -11
  426. package/src/anthroponym-inflection/anthroponym-inflector.ts +0 -38
  427. package/src/anthroponym-inflection/append-command-runner.ts +0 -18
  428. package/src/anthroponym-inflection/command-runner-factory.ts +0 -23
  429. package/src/anthroponym-inflection/first-name-inflector.ts +0 -41
  430. package/src/anthroponym-inflection/index.ts +0 -5
  431. package/src/anthroponym-inflection/inflector-command-runner.ts +0 -3
  432. package/src/anthroponym-inflection/inflector.types.ts +0 -42
  433. package/src/anthroponym-inflection/last-name-inflector.ts +0 -54
  434. package/src/anthroponym-inflection/middle-name-inflector.ts +0 -29
  435. package/src/anthroponym-inflection/name-inflector.ts +0 -19
  436. package/src/anthroponym-inflection/replace-command-runner.ts +0 -18
  437. package/src/core/anthroponym.interface.ts +0 -8
  438. package/src/core/gender.enum.ts +0 -4
  439. package/src/core/grammatical-case.enum.ts +0 -9
  440. package/src/core/index.ts +0 -4
  441. package/src/core/validator.ts +0 -39
  442. package/src/internal.ts +0 -1
  443. package/src/part-of-speech-recognition/index.ts +0 -5
  444. package/src/part-of-speech-recognition/neural-network-config.ts +0 -5
  445. package/src/part-of-speech-recognition/neural-network-training-data.ts +0 -5
  446. package/src/part-of-speech-recognition/neural-network.ts +0 -66
  447. package/src/part-of-speech-recognition/part-of-speech-decoder.ts +0 -26
  448. package/src/part-of-speech-recognition/part-of-speech-encoder.ts +0 -20
  449. package/src/part-of-speech-recognition/part-of-speech-recognition-rule.ts +0 -33
  450. package/src/part-of-speech-recognition/part-of-speech-recognizer.ts +0 -26
  451. package/src/part-of-speech-recognition/part-of-speech.enum.ts +0 -4
  452. package/src/part-of-speech-recognition/word-encoder.ts +0 -23
  453. package/src/part-of-speech-recognition/word-transformer.ts +0 -8
  454. package/src/resources/neural-networks/kosmii/README.md +0 -5
  455. package/src/resources/neural-networks/kosmii/cache.json +0 -8
  456. package/src/resources/neural-networks/kosmii/samples.json +0 -9435
  457. package/src/resources/neural-networks/kosmii/structure.json +0 -47898
  458. package/src/resources/neural-networks/pelykh/README.md +0 -5
  459. package/src/resources/neural-networks/pelykh/cache.json +0 -1
  460. package/src/resources/neural-networks/pelykh/samples.json +0 -221
  461. package/src/resources/neural-networks/pelykh/structure.json +0 -47898
  462. package/src/resources/neural-networks/pohorielova/README.md +0 -5
  463. package/src/resources/neural-networks/pohorielova/cache.json +0 -542
  464. package/src/resources/neural-networks/pohorielova/samples.json +0 -32147
  465. package/src/resources/neural-networks/pohorielova/structure.json +0 -47898
  466. package/src/utils/lang.utils.ts +0 -13
  467. package/src/utils/regexp.utils.ts +0 -11
  468. package/src/utils/string.utils.ts +0 -49
package/package.json CHANGED
@@ -1,41 +1,36 @@
1
1
  {
2
2
  "name": "shevchenko",
3
- "version": "2.1.3",
3
+ "version": "3.0.0-rc.0",
4
4
  "description": "JavaScript library for declension of Ukrainian anthroponyms",
5
5
  "browser": "./dist/umd/shevchenko.min.js",
6
6
  "main": "./dist/cjs/shevchenko.js",
7
7
  "module": "./dist/es/shevchenko.js",
8
- "types": "./dist/types/shevchenko.d.ts",
8
+ "types": "./dist/es/shevchenko.d.ts",
9
9
  "scripts": {
10
- "update:inflector-rules": "gulp update:inflector-rules",
11
- "train:pohorielova-network": "gulp train:pohorielova-network",
12
- "train:kosmii-network": "gulp train:kosmii-network",
13
- "train:pelykh-network": "gulp train:pelykh-network",
14
- "build:pohorielova-cache": "gulp build:pohorielova-cache",
15
- "build:kosmii-cache": "gulp build:kosmii-cache",
16
- "build:pelykh-cache": "gulp build:pelykh-cache",
17
- "build:network-cache": "gulp build:network-cache",
18
10
  "prebuild": "rimraf ./dist",
19
- "build": "rollup -c && tsc -p ./tsconfig.declaration.json",
20
- "lint": "tslint --fix -p ./tsconfig.json -c ./tslint.json",
21
- "test": "mocha --bail ./tests/main.js",
22
- "build:docs": "node ./docs/src/main.mjs"
11
+ "build": "rollup -c",
12
+ "lint": "eslint --fix ./src ./test",
13
+ "test": "jest"
23
14
  },
24
15
  "keywords": [
16
+ "ukrainian-language",
25
17
  "ukrainian",
26
- "language",
27
- "grammar",
28
- "linguistics",
29
- "inflection",
18
+ "anthroponym-declension",
19
+ "personal-name-declension",
20
+ "given-name-declension",
21
+ "first-name-declension",
22
+ "patronymic-name-declension",
23
+ "patronymic-declension",
24
+ "family-name-declension",
25
+ "surname-declension",
26
+ "word-declension",
30
27
  "declension",
31
- "anthroponym",
32
- "nominative",
33
- "genitive",
34
- "dative",
35
- "accusative",
36
- "ablative",
37
- "locative",
38
- "vocative"
28
+ "inflection",
29
+ "gender-detection",
30
+ "linguistics",
31
+ "morphology",
32
+ "natural-language-processing",
33
+ "nlp"
39
34
  ],
40
35
  "repository": {
41
36
  "type": "git",
@@ -53,27 +48,33 @@
53
48
  },
54
49
  "homepage": "https://tooleks.github.io/shevchenko-js",
55
50
  "dependencies": {
56
- "synaptic": "^1.1.4"
51
+ "@tensorflow/tfjs": "^4.1.0"
57
52
  },
58
53
  "devDependencies": {
54
+ "@rollup/plugin-alias": "^4.0.3",
59
55
  "@rollup/plugin-commonjs": "^16.0.0",
60
56
  "@rollup/plugin-json": "^4.1.0",
61
57
  "@rollup/plugin-node-resolve": "^10.0.0",
62
58
  "@rollup/plugin-typescript": "^6.1.0",
63
- "@types/lodash": "^4.14.165",
64
- "@types/synaptic": "^1.0.3",
59
+ "@tensorflow/tfjs-node": "^4.2.0",
60
+ "@types/jest": "^29.4.0",
61
+ "@types/lodash": "^4.14.191",
62
+ "@typescript-eslint/eslint-plugin": "^5.48.2",
63
+ "@typescript-eslint/parser": "^5.48.2",
65
64
  "axios": "^0.21.0",
66
- "chai": "^4.2.0",
67
- "ejs": "^3.1.7",
68
- "gulp": "^4.0.2",
69
- "i18n": "^0.13.2",
70
- "mocha": "^8.2.1",
71
- "nuxi": "*",
65
+ "csv": "^6.2.7",
66
+ "eslint": "^8.32.0",
67
+ "eslint-config-prettier": "^8.6.0",
68
+ "eslint-plugin-import": "^2.27.5",
69
+ "eslint-plugin-prettier": "^4.2.1",
70
+ "jest": "^29.3.1",
71
+ "lodash": "^4.17.21",
72
+ "prettier": "2.8.3",
72
73
  "rimraf": "^3.0.2",
73
74
  "rollup": "^2.34.2",
74
75
  "rollup-plugin-terser": "^7.0.2",
75
- "tslint": "^6.1.3",
76
- "tslint-config-airbnb": "^5.11.2",
76
+ "ts-jest": "^29.0.5",
77
+ "ts-node": "^10.9.1",
77
78
  "typescript": "^4.1.2"
78
79
  }
79
80
  }
@@ -0,0 +1,3 @@
1
+ # Anthroponym Declension Module
2
+
3
+ This module implements the anthroponym declension using the declension rules from the [rules repository](https://github.com/tooleks/shevchenko-rules).
@@ -0,0 +1,58 @@
1
+ import { GrammaticalCase, GrammaticalGender } from '../language';
2
+ import { Anthroponym } from './anthroponym';
3
+ import { FamilyNameInflector } from './family-name-inflector';
4
+ import { GivenNameInflector } from './given-name-inflector';
5
+ import { PatronymicNameInflector } from './patronymic-name-inflector';
6
+
7
+ export class AnthroponymInflector {
8
+ private readonly givenNameInflector: GivenNameInflector;
9
+ private readonly patronymicNameInflector: PatronymicNameInflector;
10
+ private readonly familyNameInflector: FamilyNameInflector;
11
+
12
+ constructor(
13
+ givenNameInflector: GivenNameInflector,
14
+ patronymicNameInflector: PatronymicNameInflector,
15
+ familyNameInflector: FamilyNameInflector,
16
+ ) {
17
+ this.givenNameInflector = givenNameInflector;
18
+ this.patronymicNameInflector = patronymicNameInflector;
19
+ this.familyNameInflector = familyNameInflector;
20
+ }
21
+
22
+ /**
23
+ * Inflects the anthroponym in the given grammatical case.
24
+ */
25
+ async inflect(
26
+ anthroponym: Anthroponym,
27
+ gender: GrammaticalGender,
28
+ grammaticalCase: GrammaticalCase,
29
+ ): Promise<Anthroponym> {
30
+ const inflectedAnthroponym: Anthroponym = {};
31
+
32
+ if (anthroponym.givenName != null) {
33
+ inflectedAnthroponym.givenName = await this.givenNameInflector.inflect(
34
+ anthroponym.givenName,
35
+ gender,
36
+ grammaticalCase,
37
+ );
38
+ }
39
+
40
+ if (anthroponym.patronymicName != null) {
41
+ inflectedAnthroponym.patronymicName = await this.patronymicNameInflector.inflect(
42
+ anthroponym.patronymicName,
43
+ gender,
44
+ grammaticalCase,
45
+ );
46
+ }
47
+
48
+ if (anthroponym.familyName != null) {
49
+ inflectedAnthroponym.familyName = await this.familyNameInflector.inflect(
50
+ anthroponym.familyName,
51
+ gender,
52
+ grammaticalCase,
53
+ );
54
+ }
55
+
56
+ return inflectedAnthroponym;
57
+ }
58
+ }
@@ -0,0 +1,5 @@
1
+ export interface Anthroponym {
2
+ givenName?: string;
3
+ patronymicName?: string;
4
+ familyName?: string;
5
+ }
@@ -0,0 +1,75 @@
1
+ import { GrammaticalCase, GrammaticalGender, isMonosyllable } from '../language';
2
+ import { WordClassRecognizer } from '../word-class-recognition';
3
+ import {
4
+ DeclensionRule,
5
+ DeclensionRuleInflector,
6
+ isApplicable,
7
+ isGenderApplicable,
8
+ isWordApplicable,
9
+ } from '../word-declension';
10
+ import { NameInflector } from './name-inflector';
11
+
12
+ /**
13
+ * Returns a new array with all elements that pass the async test implemented by the provided function.
14
+ */
15
+ async function filterAsync<T>(
16
+ array: T[],
17
+ predicate: (value: T, index: number, array: T[]) => Promise<boolean>,
18
+ ): Promise<T[]> {
19
+ const results = await Promise.all(array.map(predicate));
20
+ return array.filter((_v, index) => results[index]);
21
+ }
22
+
23
+ const UNKNOWN_FEMININE_WORD_CLASS_PATTERN = /[ая]$/i;
24
+ const UNKNOWN_MASCULINE_WORD_CLASS_PATTERN = /(ой|ий|ій|их)$/i;
25
+
26
+ export class FamilyNameInflector extends NameInflector {
27
+ private readonly rules: DeclensionRule[];
28
+ private readonly wordClassRecognizer: WordClassRecognizer;
29
+
30
+ constructor(rules: DeclensionRule[], wordClassRecognizer: WordClassRecognizer) {
31
+ super();
32
+ this.rules = rules;
33
+ this.wordClassRecognizer = wordClassRecognizer;
34
+ }
35
+
36
+ /**
37
+ * @inheritdoc
38
+ */
39
+ protected async inflectNamePart(
40
+ familyName: string,
41
+ gender: GrammaticalGender,
42
+ grammaticalCase: GrammaticalCase,
43
+ isLastWord: boolean,
44
+ ): Promise<string> {
45
+ if (!isLastWord && isMonosyllable(familyName)) {
46
+ return familyName;
47
+ }
48
+
49
+ const matchedRules = this.rules
50
+ .filter((rule) => isGenderApplicable(rule, gender))
51
+ .filter((rule) => isApplicable(rule, 'familyName'))
52
+ .filter((rule) => isWordApplicable(rule, familyName));
53
+
54
+ const [rule] = await filterAsync(matchedRules, async (rule) => {
55
+ const uknownWordClass =
56
+ (gender === GrammaticalGender.FEMININE &&
57
+ UNKNOWN_FEMININE_WORD_CLASS_PATTERN.test(familyName)) ||
58
+ (gender === GrammaticalGender.MASCULINE &&
59
+ UNKNOWN_MASCULINE_WORD_CLASS_PATTERN.test(familyName));
60
+
61
+ if (uknownWordClass) {
62
+ const wordClass = await this.wordClassRecognizer.recognize(familyName);
63
+ return wordClass === rule.wordClass;
64
+ }
65
+
66
+ return true;
67
+ });
68
+
69
+ if (rule == null) {
70
+ return familyName;
71
+ }
72
+
73
+ return new DeclensionRuleInflector(rule).inflect(familyName, grammaticalCase);
74
+ }
75
+ }
@@ -0,0 +1,38 @@
1
+ import { GrammaticalCase, GrammaticalGender } from '../language';
2
+ import {
3
+ DeclensionRule,
4
+ DeclensionRuleInflector,
5
+ isApplicable,
6
+ isGenderApplicable,
7
+ isWordApplicable,
8
+ } from '../word-declension';
9
+ import { NameInflector } from './name-inflector';
10
+
11
+ export class GivenNameInflector extends NameInflector {
12
+ private readonly rules: DeclensionRule[];
13
+
14
+ constructor(rules: DeclensionRule[]) {
15
+ super();
16
+ this.rules = rules;
17
+ }
18
+
19
+ /**
20
+ * @inheritdoc
21
+ */
22
+ protected inflectNamePart(
23
+ givenName: string,
24
+ gender: GrammaticalGender,
25
+ grammaticalCase: GrammaticalCase,
26
+ ): string {
27
+ const [rule] = this.rules
28
+ .filter((rule) => isGenderApplicable(rule, gender))
29
+ .filter((rule) => isApplicable(rule, 'givenName'))
30
+ .filter((rule) => isWordApplicable(rule, givenName));
31
+
32
+ if (rule == null) {
33
+ return givenName;
34
+ }
35
+
36
+ return new DeclensionRuleInflector(rule).inflect(givenName, grammaticalCase);
37
+ }
38
+ }
@@ -0,0 +1,5 @@
1
+ export * from './anthroponym';
2
+ export * from './anthroponym-inflector';
3
+ export * from './given-name-inflector';
4
+ export * from './patronymic-name-inflector';
5
+ export * from './family-name-inflector';
@@ -0,0 +1,38 @@
1
+ import { GrammaticalCase, GrammaticalGender } from '../language';
2
+
3
+ export abstract class NameInflector {
4
+ /**
5
+ * Inflects the name in the given grammatical case.
6
+ */
7
+ async inflect(
8
+ name: string,
9
+ gender: GrammaticalGender,
10
+ grammaticalCase: GrammaticalCase,
11
+ ): Promise<string> {
12
+ const inflectedNameParts: string[] = [];
13
+
14
+ const nameParts = name.split('-');
15
+ for (let index = 0; index < nameParts.length; index += 1) {
16
+ const inflectedNamePart = await this.inflectNamePart(
17
+ nameParts[index],
18
+ gender,
19
+ grammaticalCase,
20
+ index === nameParts.length - 1,
21
+ );
22
+
23
+ inflectedNameParts.push(inflectedNamePart);
24
+ }
25
+
26
+ return inflectedNameParts.join('-');
27
+ }
28
+
29
+ /**
30
+ * Inflects a single name part of the compound name in a given grammatical case.
31
+ */
32
+ protected abstract inflectNamePart(
33
+ word: string,
34
+ gender: GrammaticalGender,
35
+ grammaticalCase: GrammaticalCase,
36
+ isLastWord: boolean,
37
+ ): Promise<string> | string;
38
+ }
@@ -0,0 +1,38 @@
1
+ import { GrammaticalCase, GrammaticalGender } from '../language';
2
+ import {
3
+ DeclensionRule,
4
+ DeclensionRuleInflector,
5
+ isGenderApplicable,
6
+ isStriclyApplicable,
7
+ isWordApplicable,
8
+ } from '../word-declension';
9
+ import { NameInflector } from './name-inflector';
10
+
11
+ export class PatronymicNameInflector extends NameInflector {
12
+ private readonly rules: DeclensionRule[];
13
+
14
+ constructor(rules: DeclensionRule[]) {
15
+ super();
16
+ this.rules = rules;
17
+ }
18
+
19
+ /**
20
+ * @inheritdoc
21
+ */
22
+ protected inflectNamePart(
23
+ patronymicName: string,
24
+ gender: GrammaticalGender,
25
+ grammaticalCase: GrammaticalCase,
26
+ ): string {
27
+ const [rule] = this.rules
28
+ .filter((rule) => isGenderApplicable(rule, gender))
29
+ .filter((rule) => isStriclyApplicable(rule, 'patronymicName'))
30
+ .filter((rule) => isWordApplicable(rule, patronymicName));
31
+
32
+ if (rule == null) {
33
+ return patronymicName;
34
+ }
35
+
36
+ return new DeclensionRuleInflector(rule).inflect(patronymicName, grammaticalCase);
37
+ }
38
+ }
package/src/bootstrap.ts CHANGED
@@ -1,53 +1,26 @@
1
1
  import {
2
2
  AnthroponymInflector,
3
- FirstNameInflector,
4
- InflectorRule,
5
- LastNameInflector,
6
- MiddleNameInflector,
7
- } from './anthroponym-inflection';
8
- import { Gender } from './core';
9
- import {
10
- NeuralNetwork,
11
- NeuralNetworkTrainingData,
12
- PartOfSpeechRecognizer,
13
- PartOfSpeechRecognitionRule,
14
- } from './part-of-speech-recognition';
15
- // tslint:disable-next-line import-name
16
- import inflectorRules from './resources/inflector/rules.json';
17
- // tslint:disable-next-line import-name
18
- import kosmiiCache from './resources/neural-networks/kosmii/cache.json';
19
- // tslint:disable-next-line import-name
20
- import kosmiiStructure from './resources/neural-networks/kosmii/structure.json';
21
- // tslint:disable-next-line import-name
22
- import pelykhCache from './resources/neural-networks/pelykh/cache.json';
23
- // tslint:disable-next-line import-name
24
- import pelykhStructure from './resources/neural-networks/pelykh/structure.json';
25
- // tslint:disable-next-line import-name
26
- import pohorielovaCache from './resources/neural-networks/pohorielova/cache.json';
27
- // tslint:disable-next-line import-name
28
- import pohorielovaStructure from './resources/neural-networks/pohorielova/structure.json';
3
+ FamilyNameInflector,
4
+ GivenNameInflector,
5
+ PatronymicNameInflector,
6
+ } from './anthroponym-declension';
7
+ import { ModelBundleLoader, WordClassRecognizer } from './word-class-recognition';
8
+ import { DeclensionRule, declensionRules } from './word-declension';
9
+
10
+ const givenNameInflector = new GivenNameInflector(declensionRules as DeclensionRule[]);
11
+
12
+ const patronymicNameInflector = new PatronymicNameInflector(declensionRules as DeclensionRule[]);
29
13
 
30
- const partOfSpeechRecognizer = new PartOfSpeechRecognizer([
31
- new PartOfSpeechRecognitionRule(
32
- (word: string, gender: Gender) => gender === Gender.Female && /[ая]$/i.test(word),
33
- NeuralNetwork.fromJSON(pohorielovaStructure),
34
- pohorielovaCache as NeuralNetworkTrainingData,
35
- ),
36
- new PartOfSpeechRecognitionRule(
37
- (word: string, gender: Gender) => gender === Gender.Male && /(ой|ий|ій)$/i.test(word),
38
- NeuralNetwork.fromJSON(kosmiiStructure),
39
- kosmiiCache as NeuralNetworkTrainingData,
40
- ),
41
- new PartOfSpeechRecognitionRule(
42
- (word: string, gender: Gender) => gender === Gender.Male && /(их)$/i.test(word),
43
- NeuralNetwork.fromJSON(pelykhStructure),
44
- pelykhCache as NeuralNetworkTrainingData,
45
- ),
46
- ]);
14
+ const wordClassRecognizer = new WordClassRecognizer(new ModelBundleLoader());
15
+ const familyNameInflector = new FamilyNameInflector(
16
+ declensionRules as DeclensionRule[],
17
+ wordClassRecognizer,
18
+ );
47
19
 
48
- const firstNameInflector = new FirstNameInflector(inflectorRules as InflectorRule[]);
49
- const middleNameInflector = new MiddleNameInflector(inflectorRules as InflectorRule[]);
50
- const lastNameInflector = new LastNameInflector(inflectorRules as InflectorRule[], partOfSpeechRecognizer);
51
- const anthroponymInflector = new AnthroponymInflector(firstNameInflector, middleNameInflector, lastNameInflector);
20
+ const anthroponymInflector = new AnthroponymInflector(
21
+ givenNameInflector,
22
+ patronymicNameInflector,
23
+ familyNameInflector,
24
+ );
52
25
 
53
26
  export { anthroponymInflector };
@@ -0,0 +1,22 @@
1
+ import { Anthroponym } from './anthroponym-declension';
2
+ import { GrammaticalGender } from './language';
3
+
4
+ /**
5
+ * The input parameters for anthroponym declension.
6
+ */
7
+ export type DeclensionInput = Anthroponym & { gender: GrammaticalGender };
8
+
9
+ /**
10
+ * The output result of anthroponym declension.
11
+ */
12
+ export type DeclensionOutput = Anthroponym;
13
+
14
+ /**
15
+ * The input parameters for gender detection.
16
+ */
17
+ export type GenderDetectionInput = Anthroponym;
18
+
19
+ /**
20
+ * The output result of gender detection.
21
+ */
22
+ export type GenderDetectionOutput = GrammaticalGender | null;
@@ -0,0 +1,5 @@
1
+ # Gender Detection Module
2
+
3
+ This module implements the automatic gender detection of anthroponyms.
4
+
5
+ The implementation utilizes a combination of patronymic name word formation rules and a given name dictionary in order to determine the grammatical gender of an anthroponym.
@@ -0,0 +1,43 @@
1
+ import { Anthroponym } from '../anthroponym-declension';
2
+ import { GrammaticalGender } from '../language';
3
+ import givenNamesGenders from './given-names-genders.json';
4
+
5
+ const MASCULINE_PATRONYMIC_PATTERN = /[иі]ч$/;
6
+ const FEMININE_PATRONYMIC_PATTERN = /на$/;
7
+ const APOSTROPHE_VARIATION_PATTERN = /[`"]/g;
8
+
9
+ type GivenName = keyof typeof givenNamesGenders;
10
+
11
+ /**
12
+ * Detects the grammatical gender of the anthroponym using
13
+ * patronymic name endings and the dictionary of known given names.
14
+ *
15
+ * Returns the grammatical gender of the anthroponym.
16
+ * Returns null if the grammatical gender of the anthroponym cannot be detected.
17
+ */
18
+ export function detectGender(anthroponym: Anthroponym): GrammaticalGender | null {
19
+ if (anthroponym.patronymicName) {
20
+ const patronymicName = anthroponym.patronymicName
21
+ .replace(APOSTROPHE_VARIATION_PATTERN, "'")
22
+ .toLocaleLowerCase();
23
+
24
+ if (MASCULINE_PATRONYMIC_PATTERN.test(patronymicName)) {
25
+ return GrammaticalGender.MASCULINE;
26
+ } else if (FEMININE_PATRONYMIC_PATTERN.test(patronymicName)) {
27
+ return GrammaticalGender.FEMININE;
28
+ }
29
+ }
30
+
31
+ if (anthroponym.givenName) {
32
+ const givenName = anthroponym.givenName
33
+ .replace(APOSTROPHE_VARIATION_PATTERN, "'")
34
+ .toLocaleLowerCase() as GivenName;
35
+
36
+ const gender = givenNamesGenders[givenName];
37
+ if (gender != null) {
38
+ return gender as GrammaticalGender;
39
+ }
40
+ }
41
+
42
+ return null;
43
+ }