shevchenko 3.0.9 → 3.1.0-alpha.4

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 (294) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/anthroponym-declension/anthroponym-inflector.js +1 -4
  3. package/dist/cjs/anthroponym-declension/bootstrap.js +1 -4
  4. package/dist/cjs/anthroponym-declension/family-name-classifier/artifacts/model.bundle.json.js +2 -3
  5. package/dist/cjs/anthroponym-declension/family-name-classifier/cache/incorrect-predictions.json.js +1 -2
  6. package/dist/cjs/anthroponym-declension/family-name-classifier/family-name-class-transformer.js +1 -4
  7. package/dist/cjs/anthroponym-declension/family-name-classifier/family-name-classifer.js +4 -8
  8. package/dist/cjs/anthroponym-declension/family-name-classifier/model-bundle-loader.js +6 -9
  9. package/dist/cjs/anthroponym-declension/family-name-classifier/model-config.js +1 -4
  10. package/dist/cjs/anthroponym-declension/family-name-classifier/word-transformer.js +1 -4
  11. package/dist/cjs/anthroponym-declension/family-name-inflector.js +1 -4
  12. package/dist/cjs/anthroponym-declension/given-name-inflector.js +1 -4
  13. package/dist/cjs/anthroponym-declension/name-inflector.js +1 -4
  14. package/dist/cjs/anthroponym-declension/patronymic-name-inflector.js +1 -4
  15. package/dist/cjs/extension.js +32 -0
  16. package/dist/cjs/gender-detection/detect-gender.js +1 -4
  17. package/dist/cjs/gender-detection/given-names-genders.json.js +1 -2
  18. package/dist/cjs/index.js +14 -8
  19. package/dist/cjs/input-validation.js +1 -4
  20. package/dist/cjs/language/alphabet.js +1 -4
  21. package/dist/cjs/language/grammatical-case.js +1 -4
  22. package/dist/cjs/language/grammatical-gender.js +1 -4
  23. package/dist/cjs/language/letter-case.js +1 -4
  24. package/dist/cjs/language/linguistics.js +1 -4
  25. package/dist/cjs/language/word-class.js +1 -4
  26. package/dist/cjs/shevchenko.js +29 -28
  27. package/dist/cjs/word-declension/append-command-runner.js +1 -4
  28. package/dist/cjs/word-declension/bootstrap.js +2 -6
  29. package/dist/cjs/word-declension/command-runner-factory.js +1 -4
  30. package/dist/cjs/word-declension/declension-rule-inflector.js +1 -4
  31. package/dist/cjs/word-declension/declension-types.js +1 -4
  32. package/dist/cjs/word-declension/replace-command-runner.js +1 -4
  33. package/dist/cjs/word-declension/rules/artifacts/declension-rules.json.js +225 -6
  34. package/dist/cjs/word-declension/word-inflector.js +1 -7
  35. package/dist/es/anthroponym-declension/anthroponym-inflector.d.ts +0 -1
  36. package/dist/es/anthroponym-declension/anthroponym-inflector.js +1 -2
  37. package/dist/es/anthroponym-declension/anthroponym-inflector.test.d.ts +0 -1
  38. package/dist/es/anthroponym-declension/anthroponym.d.ts +0 -1
  39. package/dist/es/anthroponym-declension/bootstrap.d.ts +0 -1
  40. package/dist/es/anthroponym-declension/bootstrap.js +1 -2
  41. package/dist/es/anthroponym-declension/family-name-classifier/artifacts/model.bundle.json.js +1 -2
  42. package/dist/es/anthroponym-declension/family-name-classifier/cache/incorrect-predictions.json.js +1 -2
  43. package/dist/es/anthroponym-declension/family-name-classifier/data-utils.d.ts +0 -1
  44. package/dist/es/anthroponym-declension/family-name-classifier/family-name-class-transformer.d.ts +0 -1
  45. package/dist/es/anthroponym-declension/family-name-classifier/family-name-class-transformer.js +1 -2
  46. package/dist/es/anthroponym-declension/family-name-classifier/family-name-class-transformer.test.d.ts +0 -1
  47. package/dist/es/anthroponym-declension/family-name-classifier/family-name-class.d.ts +0 -1
  48. package/dist/es/anthroponym-declension/family-name-classifier/family-name-classifer.d.ts +0 -1
  49. package/dist/es/anthroponym-declension/family-name-classifier/family-name-classifer.js +1 -2
  50. package/dist/es/anthroponym-declension/family-name-classifier/index.d.ts +0 -1
  51. package/dist/es/anthroponym-declension/family-name-classifier/model-bundle-loader.d.ts +0 -1
  52. package/dist/es/anthroponym-declension/family-name-classifier/model-bundle-loader.js +1 -2
  53. package/dist/es/anthroponym-declension/family-name-classifier/model-bundle-saver.d.ts +0 -1
  54. package/dist/es/anthroponym-declension/family-name-classifier/model-config.d.ts +0 -1
  55. package/dist/es/anthroponym-declension/family-name-classifier/model-config.js +1 -2
  56. package/dist/es/anthroponym-declension/family-name-classifier/scripts/cache-incorrect-predictions.d.ts +0 -1
  57. package/dist/es/anthroponym-declension/family-name-classifier/scripts/train-model.d.ts +0 -1
  58. package/dist/es/anthroponym-declension/family-name-classifier/word-transformer.d.ts +0 -1
  59. package/dist/es/anthroponym-declension/family-name-classifier/word-transformer.js +1 -2
  60. package/dist/es/anthroponym-declension/family-name-classifier/word-transformer.test.d.ts +0 -1
  61. package/dist/es/anthroponym-declension/family-name-inflector.d.ts +0 -1
  62. package/dist/es/anthroponym-declension/family-name-inflector.js +1 -2
  63. package/dist/es/anthroponym-declension/given-name-inflector.d.ts +0 -1
  64. package/dist/es/anthroponym-declension/given-name-inflector.js +1 -2
  65. package/dist/es/anthroponym-declension/index.d.ts +0 -1
  66. package/dist/es/anthroponym-declension/name-inflector.d.ts +0 -1
  67. package/dist/es/anthroponym-declension/name-inflector.js +1 -2
  68. package/dist/es/anthroponym-declension/patronymic-name-inflector.d.ts +0 -1
  69. package/dist/es/anthroponym-declension/patronymic-name-inflector.js +1 -2
  70. package/dist/es/contracts.d.ts +39 -5
  71. package/dist/es/extension.d.ts +16 -0
  72. package/dist/es/extension.js +29 -0
  73. package/dist/es/gender-detection/detect-gender.d.ts +0 -1
  74. package/dist/es/gender-detection/detect-gender.js +1 -2
  75. package/dist/es/gender-detection/detect-gender.test.d.ts +0 -1
  76. package/dist/es/gender-detection/given-names-genders.json.js +1 -2
  77. package/dist/es/gender-detection/index.d.ts +0 -1
  78. package/dist/es/index.d.ts +0 -1
  79. package/dist/es/index.js +5 -3
  80. package/dist/es/input-validation.d.ts +0 -1
  81. package/dist/es/input-validation.js +1 -2
  82. package/dist/es/input-validation.test.d.ts +0 -1
  83. package/dist/es/language/alphabet.d.ts +0 -1
  84. package/dist/es/language/alphabet.js +1 -2
  85. package/dist/es/language/alphabet.test.d.ts +0 -1
  86. package/dist/es/language/grammatical-case.d.ts +0 -1
  87. package/dist/es/language/grammatical-case.js +1 -2
  88. package/dist/es/language/grammatical-gender.d.ts +0 -1
  89. package/dist/es/language/grammatical-gender.js +1 -2
  90. package/dist/es/language/index.d.ts +0 -1
  91. package/dist/es/language/letter-case.d.ts +0 -1
  92. package/dist/es/language/letter-case.js +1 -2
  93. package/dist/es/language/letter-case.test.d.ts +0 -1
  94. package/dist/es/language/linguistics.d.ts +0 -1
  95. package/dist/es/language/linguistics.js +1 -2
  96. package/dist/es/language/linguistics.test.d.ts +0 -1
  97. package/dist/es/language/word-class.d.ts +0 -1
  98. package/dist/es/language/word-class.js +1 -2
  99. package/dist/es/shevchenko.d.ts +4 -4
  100. package/dist/es/shevchenko.js +25 -27
  101. package/dist/es/word-declension/append-command-runner.d.ts +0 -1
  102. package/dist/es/word-declension/append-command-runner.js +1 -2
  103. package/dist/es/word-declension/bootstrap.d.ts +0 -1
  104. package/dist/es/word-declension/bootstrap.js +2 -4
  105. package/dist/es/word-declension/command-runner-factory.d.ts +0 -1
  106. package/dist/es/word-declension/command-runner-factory.js +1 -2
  107. package/dist/es/word-declension/declension-rule-inflector.d.ts +0 -1
  108. package/dist/es/word-declension/declension-rule-inflector.js +1 -2
  109. package/dist/es/word-declension/declension-rule-matchers.d.ts +0 -1
  110. package/dist/es/word-declension/declension-types.d.ts +0 -1
  111. package/dist/es/word-declension/declension-types.js +1 -2
  112. package/dist/es/word-declension/index.d.ts +0 -1
  113. package/dist/es/word-declension/inflection-command-runner.d.ts +0 -1
  114. package/dist/es/word-declension/replace-command-runner.d.ts +0 -1
  115. package/dist/es/word-declension/replace-command-runner.js +1 -2
  116. package/dist/es/word-declension/rules/artifacts/declension-rules.json.js +225 -6
  117. package/dist/es/word-declension/rules/scripts/build-declension-rules.d.ts +0 -1
  118. package/dist/es/word-declension/word-inflector.d.ts +1 -5
  119. package/dist/es/word-declension/word-inflector.js +1 -5
  120. package/dist/umd/shevchenko.min.js +396 -385
  121. package/package.json +1 -1
  122. package/dist/cjs/anthroponym-declension/anthroponym-inflector.js.map +0 -1
  123. package/dist/cjs/anthroponym-declension/bootstrap.js.map +0 -1
  124. package/dist/cjs/anthroponym-declension/family-name-classifier/artifacts/model.bundle.json.js.map +0 -1
  125. package/dist/cjs/anthroponym-declension/family-name-classifier/cache/incorrect-predictions.json.js.map +0 -1
  126. package/dist/cjs/anthroponym-declension/family-name-classifier/family-name-class-transformer.js.map +0 -1
  127. package/dist/cjs/anthroponym-declension/family-name-classifier/family-name-classifer.js.map +0 -1
  128. package/dist/cjs/anthroponym-declension/family-name-classifier/model-bundle-loader.js.map +0 -1
  129. package/dist/cjs/anthroponym-declension/family-name-classifier/model-config.js.map +0 -1
  130. package/dist/cjs/anthroponym-declension/family-name-classifier/word-transformer.js.map +0 -1
  131. package/dist/cjs/anthroponym-declension/family-name-inflector.js.map +0 -1
  132. package/dist/cjs/anthroponym-declension/given-name-inflector.js.map +0 -1
  133. package/dist/cjs/anthroponym-declension/name-inflector.js.map +0 -1
  134. package/dist/cjs/anthroponym-declension/patronymic-name-inflector.js.map +0 -1
  135. package/dist/cjs/gender-detection/detect-gender.js.map +0 -1
  136. package/dist/cjs/gender-detection/given-names-genders.json.js.map +0 -1
  137. package/dist/cjs/index.js.map +0 -1
  138. package/dist/cjs/input-validation.js.map +0 -1
  139. package/dist/cjs/language/alphabet.js.map +0 -1
  140. package/dist/cjs/language/grammatical-case.js.map +0 -1
  141. package/dist/cjs/language/grammatical-gender.js.map +0 -1
  142. package/dist/cjs/language/letter-case.js.map +0 -1
  143. package/dist/cjs/language/linguistics.js.map +0 -1
  144. package/dist/cjs/language/word-class.js.map +0 -1
  145. package/dist/cjs/shevchenko.js.map +0 -1
  146. package/dist/cjs/word-declension/append-command-runner.js.map +0 -1
  147. package/dist/cjs/word-declension/bootstrap.js.map +0 -1
  148. package/dist/cjs/word-declension/command-runner-factory.js.map +0 -1
  149. package/dist/cjs/word-declension/declension-rule-inflector.js.map +0 -1
  150. package/dist/cjs/word-declension/declension-types.js.map +0 -1
  151. package/dist/cjs/word-declension/replace-command-runner.js.map +0 -1
  152. package/dist/cjs/word-declension/rules/artifacts/declension-rules.json.js.map +0 -1
  153. package/dist/cjs/word-declension/word-inflector.js.map +0 -1
  154. package/dist/es/anthroponym-declension/anthroponym-inflector.d.ts.map +0 -1
  155. package/dist/es/anthroponym-declension/anthroponym-inflector.js.map +0 -1
  156. package/dist/es/anthroponym-declension/anthroponym-inflector.test.d.ts.map +0 -1
  157. package/dist/es/anthroponym-declension/anthroponym.d.ts.map +0 -1
  158. package/dist/es/anthroponym-declension/bootstrap.d.ts.map +0 -1
  159. package/dist/es/anthroponym-declension/bootstrap.js.map +0 -1
  160. package/dist/es/anthroponym-declension/family-name-classifier/artifacts/model.bundle.json.js.map +0 -1
  161. package/dist/es/anthroponym-declension/family-name-classifier/cache/incorrect-predictions.json.js.map +0 -1
  162. package/dist/es/anthroponym-declension/family-name-classifier/data-utils.d.ts.map +0 -1
  163. package/dist/es/anthroponym-declension/family-name-classifier/family-name-class-transformer.d.ts.map +0 -1
  164. package/dist/es/anthroponym-declension/family-name-classifier/family-name-class-transformer.js.map +0 -1
  165. package/dist/es/anthroponym-declension/family-name-classifier/family-name-class-transformer.test.d.ts.map +0 -1
  166. package/dist/es/anthroponym-declension/family-name-classifier/family-name-class.d.ts.map +0 -1
  167. package/dist/es/anthroponym-declension/family-name-classifier/family-name-classifer.d.ts.map +0 -1
  168. package/dist/es/anthroponym-declension/family-name-classifier/family-name-classifer.js.map +0 -1
  169. package/dist/es/anthroponym-declension/family-name-classifier/index.d.ts.map +0 -1
  170. package/dist/es/anthroponym-declension/family-name-classifier/model-bundle-loader.d.ts.map +0 -1
  171. package/dist/es/anthroponym-declension/family-name-classifier/model-bundle-loader.js.map +0 -1
  172. package/dist/es/anthroponym-declension/family-name-classifier/model-bundle-saver.d.ts.map +0 -1
  173. package/dist/es/anthroponym-declension/family-name-classifier/model-config.d.ts.map +0 -1
  174. package/dist/es/anthroponym-declension/family-name-classifier/model-config.js.map +0 -1
  175. package/dist/es/anthroponym-declension/family-name-classifier/scripts/cache-incorrect-predictions.d.ts.map +0 -1
  176. package/dist/es/anthroponym-declension/family-name-classifier/scripts/train-model.d.ts.map +0 -1
  177. package/dist/es/anthroponym-declension/family-name-classifier/word-transformer.d.ts.map +0 -1
  178. package/dist/es/anthroponym-declension/family-name-classifier/word-transformer.js.map +0 -1
  179. package/dist/es/anthroponym-declension/family-name-classifier/word-transformer.test.d.ts.map +0 -1
  180. package/dist/es/anthroponym-declension/family-name-inflector.d.ts.map +0 -1
  181. package/dist/es/anthroponym-declension/family-name-inflector.js.map +0 -1
  182. package/dist/es/anthroponym-declension/given-name-inflector.d.ts.map +0 -1
  183. package/dist/es/anthroponym-declension/given-name-inflector.js.map +0 -1
  184. package/dist/es/anthroponym-declension/index.d.ts.map +0 -1
  185. package/dist/es/anthroponym-declension/name-inflector.d.ts.map +0 -1
  186. package/dist/es/anthroponym-declension/name-inflector.js.map +0 -1
  187. package/dist/es/anthroponym-declension/patronymic-name-inflector.d.ts.map +0 -1
  188. package/dist/es/anthroponym-declension/patronymic-name-inflector.js.map +0 -1
  189. package/dist/es/contracts.d.ts.map +0 -1
  190. package/dist/es/gender-detection/detect-gender.d.ts.map +0 -1
  191. package/dist/es/gender-detection/detect-gender.js.map +0 -1
  192. package/dist/es/gender-detection/detect-gender.test.d.ts.map +0 -1
  193. package/dist/es/gender-detection/given-names-genders.json.js.map +0 -1
  194. package/dist/es/gender-detection/index.d.ts.map +0 -1
  195. package/dist/es/index.d.ts.map +0 -1
  196. package/dist/es/index.js.map +0 -1
  197. package/dist/es/input-validation.d.ts.map +0 -1
  198. package/dist/es/input-validation.js.map +0 -1
  199. package/dist/es/input-validation.test.d.ts.map +0 -1
  200. package/dist/es/language/alphabet.d.ts.map +0 -1
  201. package/dist/es/language/alphabet.js.map +0 -1
  202. package/dist/es/language/alphabet.test.d.ts.map +0 -1
  203. package/dist/es/language/grammatical-case.d.ts.map +0 -1
  204. package/dist/es/language/grammatical-case.js.map +0 -1
  205. package/dist/es/language/grammatical-gender.d.ts.map +0 -1
  206. package/dist/es/language/grammatical-gender.js.map +0 -1
  207. package/dist/es/language/index.d.ts.map +0 -1
  208. package/dist/es/language/letter-case.d.ts.map +0 -1
  209. package/dist/es/language/letter-case.js.map +0 -1
  210. package/dist/es/language/letter-case.test.d.ts.map +0 -1
  211. package/dist/es/language/linguistics.d.ts.map +0 -1
  212. package/dist/es/language/linguistics.js.map +0 -1
  213. package/dist/es/language/linguistics.test.d.ts.map +0 -1
  214. package/dist/es/language/word-class.d.ts.map +0 -1
  215. package/dist/es/language/word-class.js.map +0 -1
  216. package/dist/es/shevchenko.d.ts.map +0 -1
  217. package/dist/es/shevchenko.js.map +0 -1
  218. package/dist/es/word-declension/append-command-runner.d.ts.map +0 -1
  219. package/dist/es/word-declension/append-command-runner.js.map +0 -1
  220. package/dist/es/word-declension/bootstrap.d.ts.map +0 -1
  221. package/dist/es/word-declension/bootstrap.js.map +0 -1
  222. package/dist/es/word-declension/command-runner-factory.d.ts.map +0 -1
  223. package/dist/es/word-declension/command-runner-factory.js.map +0 -1
  224. package/dist/es/word-declension/declension-rule-inflector.d.ts.map +0 -1
  225. package/dist/es/word-declension/declension-rule-inflector.js.map +0 -1
  226. package/dist/es/word-declension/declension-rule-matchers.d.ts.map +0 -1
  227. package/dist/es/word-declension/declension-types.d.ts.map +0 -1
  228. package/dist/es/word-declension/declension-types.js.map +0 -1
  229. package/dist/es/word-declension/index.d.ts.map +0 -1
  230. package/dist/es/word-declension/inflection-command-runner.d.ts.map +0 -1
  231. package/dist/es/word-declension/replace-command-runner.d.ts.map +0 -1
  232. package/dist/es/word-declension/replace-command-runner.js.map +0 -1
  233. package/dist/es/word-declension/rules/artifacts/declension-rules.json.js.map +0 -1
  234. package/dist/es/word-declension/rules/scripts/build-declension-rules.d.ts.map +0 -1
  235. package/dist/es/word-declension/word-inflector.d.ts.map +0 -1
  236. package/dist/es/word-declension/word-inflector.js.map +0 -1
  237. package/dist/umd/shevchenko.min.js.map +0 -1
  238. package/src/anthroponym-declension/README.md +0 -3
  239. package/src/anthroponym-declension/anthroponym-inflector.ts +0 -58
  240. package/src/anthroponym-declension/anthroponym.ts +0 -5
  241. package/src/anthroponym-declension/bootstrap.ts +0 -17
  242. package/src/anthroponym-declension/family-name-classifier/README.md +0 -5
  243. package/src/anthroponym-declension/family-name-classifier/artifacts/model.bundle.json +0 -171
  244. package/src/anthroponym-declension/family-name-classifier/artifacts/model.json +0 -1
  245. package/src/anthroponym-declension/family-name-classifier/artifacts/weights.bin +0 -0
  246. package/src/anthroponym-declension/family-name-classifier/cache/incorrect-predictions.json +0 -1146
  247. package/src/anthroponym-declension/family-name-classifier/data-utils.ts +0 -57
  248. package/src/anthroponym-declension/family-name-classifier/family-name-class-transformer.ts +0 -37
  249. package/src/anthroponym-declension/family-name-classifier/family-name-class.ts +0 -8
  250. package/src/anthroponym-declension/family-name-classifier/family-name-classifer.ts +0 -68
  251. package/src/anthroponym-declension/family-name-classifier/index.ts +0 -3
  252. package/src/anthroponym-declension/family-name-classifier/model-bundle-loader.ts +0 -73
  253. package/src/anthroponym-declension/family-name-classifier/model-bundle-saver.ts +0 -105
  254. package/src/anthroponym-declension/family-name-classifier/model-config.ts +0 -4
  255. package/src/anthroponym-declension/family-name-classifier/scripts/cache-incorrect-predictions.ts +0 -46
  256. package/src/anthroponym-declension/family-name-classifier/scripts/train-model.ts +0 -95
  257. package/src/anthroponym-declension/family-name-classifier/word-transformer.ts +0 -26
  258. package/src/anthroponym-declension/family-name-inflector.ts +0 -56
  259. package/src/anthroponym-declension/given-name-inflector.ts +0 -27
  260. package/src/anthroponym-declension/index.ts +0 -5
  261. package/src/anthroponym-declension/name-inflector.ts +0 -38
  262. package/src/anthroponym-declension/patronymic-name-inflector.ts +0 -29
  263. package/src/contracts.ts +0 -30
  264. package/src/gender-detection/README.md +0 -5
  265. package/src/gender-detection/detect-gender.ts +0 -41
  266. package/src/gender-detection/given-names-genders.json +0 -1144
  267. package/src/gender-detection/index.ts +0 -1
  268. package/src/index.ts +0 -1
  269. package/src/input-validation.ts +0 -94
  270. package/src/language/README.md +0 -3
  271. package/src/language/alphabet.ts +0 -49
  272. package/src/language/grammatical-case.ts +0 -12
  273. package/src/language/grammatical-gender.ts +0 -7
  274. package/src/language/index.ts +0 -6
  275. package/src/language/letter-case.ts +0 -37
  276. package/src/language/linguistics.ts +0 -20
  277. package/src/language/word-class.ts +0 -7
  278. package/src/shevchenko.ts +0 -199
  279. package/src/word-declension/README.md +0 -3
  280. package/src/word-declension/append-command-runner.ts +0 -18
  281. package/src/word-declension/bootstrap.ts +0 -7
  282. package/src/word-declension/command-runner-factory.ts +0 -23
  283. package/src/word-declension/declension-rule-inflector.ts +0 -50
  284. package/src/word-declension/declension-rule-matchers.ts +0 -33
  285. package/src/word-declension/declension-types.ts +0 -43
  286. package/src/word-declension/index.ts +0 -1
  287. package/src/word-declension/inflection-command-runner.ts +0 -3
  288. package/src/word-declension/replace-command-runner.ts +0 -18
  289. package/src/word-declension/rules/adjective-declension-rules.json +0 -649
  290. package/src/word-declension/rules/artifacts/declension-rules.json +0 -7788
  291. package/src/word-declension/rules/exception-declension-rules.json +0 -842
  292. package/src/word-declension/rules/noun-declension-rules.json +0 -6301
  293. package/src/word-declension/rules/scripts/build-declension-rules.ts +0 -40
  294. package/src/word-declension/word-inflector.ts +0 -71
@@ -1 +0,0 @@
1
- export * from './detect-gender';
package/src/index.ts DELETED
@@ -1 +0,0 @@
1
- export * from './shevchenko';
@@ -1,94 +0,0 @@
1
- import { DeclensionInput, GenderDetectionInput } from './contracts';
2
- import { GrammaticalGender } from './language';
3
-
4
- export class InputValidationError extends TypeError {}
5
-
6
- /**
7
- * Validates if a given value is a valid input for declension.
8
- *
9
- * @throws {InputValidationError}
10
- */
11
- export function validateDeclensionInput(value: unknown): asserts value is DeclensionInput {
12
- if (!isObject(value)) {
13
- throw new InputValidationError('The input type must be an object.');
14
- }
15
-
16
- if (!isIn(value.gender, Object.values(GrammaticalGender))) {
17
- throw new InputValidationError(
18
- `The "gender" parameter must be one of the following: "${GrammaticalGender.MASCULINE}", "${GrammaticalGender.FEMININE}".`,
19
- );
20
- }
21
-
22
- if (
23
- !isDefined(value.givenName) &&
24
- !isDefined(value.patronymicName) &&
25
- !isDefined(value.familyName)
26
- ) {
27
- throw new InputValidationError(
28
- 'At least one of the following parameters must present: "givenName", "patronymicName", "familyName".',
29
- );
30
- }
31
-
32
- if (isDefined(value.givenName) && !isString(value.givenName)) {
33
- throw new InputValidationError('The "givenName" parameter must be a string.');
34
- }
35
-
36
- if (isDefined(value.patronymicName) && !isString(value.patronymicName)) {
37
- throw new InputValidationError('The "patronymicName" parameter must be a string.');
38
- }
39
-
40
- if (isDefined(value.familyName) && !isString(value.familyName)) {
41
- throw new InputValidationError('The "familyName" parameter must be a string.');
42
- }
43
- }
44
-
45
- /**
46
- * Validates if a given value is a valid input for gender detection.
47
- *
48
- * @throws {InputValidationError}
49
- */
50
- export function validateGenderDetectionInput(
51
- value: unknown,
52
- ): asserts value is GenderDetectionInput {
53
- if (!isObject(value)) {
54
- throw new InputValidationError('The input type must be an object.');
55
- }
56
-
57
- if (
58
- !isDefined(value.givenName) &&
59
- !isDefined(value.patronymicName) &&
60
- !isDefined(value.familyName)
61
- ) {
62
- throw new InputValidationError(
63
- 'At least one of the following parameters must present: "givenName", "patronymicName", "familyName".',
64
- );
65
- }
66
-
67
- if (isDefined(value.givenName) && !isString(value.givenName)) {
68
- throw new InputValidationError('The "givenName" parameter must be a string.');
69
- }
70
-
71
- if (isDefined(value.patronymicName) && !isString(value.patronymicName)) {
72
- throw new InputValidationError('The "patronymicName" parameter must be a string.');
73
- }
74
-
75
- if (isDefined(value.familyName) && !isString(value.familyName)) {
76
- throw new InputValidationError('The "familyName" parameter must be a string.');
77
- }
78
- }
79
-
80
- function isDefined<T>(value: T | undefined): value is T {
81
- return typeof value !== 'undefined';
82
- }
83
-
84
- function isObject(value: unknown): value is Record<string, unknown> {
85
- return value != null && typeof value === 'object';
86
- }
87
-
88
- function isString(value: unknown): value is string {
89
- return typeof value === 'string';
90
- }
91
-
92
- function isIn<T>(value: unknown, values: T[]): value is T {
93
- return values.includes(value as T);
94
- }
@@ -1,3 +0,0 @@
1
- # Language Module
2
-
3
- This module provides data types and utilities that are related to the Ukrainian language and linguistics and can be used in other modules or applications.
@@ -1,49 +0,0 @@
1
- /**
2
- * Ukrainian alphabet encoding where the key is the letter of the alphabet
3
- * and the value is the order number of the corresponding letter starting from 1.
4
- */
5
- export enum AlphabetEncoding {
6
- 'а' = 1,
7
- 'б',
8
- 'в',
9
- 'г',
10
- 'ґ',
11
- 'д',
12
- 'е',
13
- 'є',
14
- 'ж',
15
- 'з',
16
- 'и',
17
- 'і',
18
- 'ї',
19
- 'й',
20
- 'к',
21
- 'л',
22
- 'м',
23
- 'н',
24
- 'о',
25
- 'п',
26
- 'р',
27
- 'с',
28
- 'т',
29
- 'у',
30
- 'ф',
31
- 'х',
32
- 'ц',
33
- 'ч',
34
- 'ш',
35
- 'щ',
36
- 'ь',
37
- 'ю',
38
- 'я',
39
- }
40
-
41
- /**
42
- * Size of Ukrainian alphabet.
43
- */
44
- export const ALPHABET_SIZE = Object.keys(AlphabetEncoding).length / 2;
45
-
46
- /**
47
- * A letter of Ukrainian alphabet.
48
- */
49
- export type Letter = keyof typeof AlphabetEncoding;
@@ -1,12 +0,0 @@
1
- /**
2
- * Enum representing the possible grammatical cases.
3
- */
4
- export enum GrammaticalCase {
5
- NOMINATIVE = 'nominative',
6
- GENITIVE = 'genitive',
7
- DATIVE = 'dative',
8
- ACCUSATIVE = 'accusative',
9
- ABLATIVE = 'ablative',
10
- LOCATIVE = 'locative',
11
- VOCATIVE = 'vocative',
12
- }
@@ -1,7 +0,0 @@
1
- /**
2
- * Enum representing the possible grammatical genders.
3
- */
4
- export enum GrammaticalGender {
5
- MASCULINE = 'masculine',
6
- FEMININE = 'feminine',
7
- }
@@ -1,6 +0,0 @@
1
- export * from './alphabet';
2
- export * from './word-class';
3
- export * from './linguistics';
4
- export * from './grammatical-case';
5
- export * from './grammatical-gender';
6
- export * from './letter-case';
@@ -1,37 +0,0 @@
1
- /**
2
- * Copies a letter case pattern from a template word to a target word.
3
- * Returns a modified target word in the letter case of the template word.
4
- */
5
- export function copyLetterCase(templateWord: string, targetWord: string): string {
6
- let resultWord = '';
7
-
8
- for (let index = 0; index < targetWord.length; index += 1) {
9
- const templateLetter = templateWord[index] || templateWord[templateWord.length - 1];
10
- const targetLetter = targetWord[index];
11
- if (inLowerCase(templateLetter)) {
12
- resultWord += targetLetter.toLowerCase();
13
- } else if (inUpperCase(templateLetter)) {
14
- resultWord += targetLetter.toUpperCase();
15
- } else {
16
- resultWord += targetLetter;
17
- }
18
- }
19
-
20
- return resultWord;
21
- }
22
-
23
- /**
24
- * Detects if a letter is in the upper case at the specified index.
25
- */
26
- function inUpperCase(word: string, index = 0): boolean {
27
- const letter = word.charAt(index);
28
- return letter === letter.toUpperCase();
29
- }
30
-
31
- /**
32
- * Detects if a letter is in the lower case at the specified index.
33
- */
34
- function inLowerCase(word: string, index = 0): boolean {
35
- const letter = word.charAt(index);
36
- return letter === letter.toLowerCase();
37
- }
@@ -1,20 +0,0 @@
1
- export const PATTERN_VOWELS = /[аоуеиіяюєї]/gi;
2
-
3
- /**
4
- * Returns a number of syllables in a given word.
5
- */
6
- function countSyllables(word: string): number {
7
- const matches = word.match(PATTERN_VOWELS);
8
- if (matches == null) {
9
- return 0;
10
- }
11
- return matches.length;
12
- }
13
-
14
- /**
15
- * Returns true if a given word is a monosyllable.
16
- * Returns false otherwise.
17
- */
18
- export function isMonosyllable(word: string): boolean {
19
- return countSyllables(word) === 1;
20
- }
@@ -1,7 +0,0 @@
1
- /**
2
- * Enum representing the possible grammatical word classes (also known as part of speech).
3
- */
4
- export enum WordClass {
5
- NOUN = 'noun',
6
- ADJECTIVE = 'adjective',
7
- }
package/src/shevchenko.ts DELETED
@@ -1,199 +0,0 @@
1
- import { anthroponymInflector } from './anthroponym-declension/bootstrap';
2
- import {
3
- DeclensionInput,
4
- DeclensionOutput,
5
- GenderDetectionInput,
6
- GenderDetectionOutput,
7
- } from './contracts';
8
- import { detectGender as autoDetectGender } from './gender-detection';
9
- import {
10
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
11
- InputValidationError,
12
- validateDeclensionInput,
13
- validateGenderDetectionInput,
14
- } from './input-validation';
15
- import { GrammaticalCase } from './language';
16
-
17
- export * from './contracts';
18
- export { InputValidationError } from './input-validation';
19
- export { GrammaticalGender, GrammaticalCase } from './language';
20
- export { Anthroponym } from './anthroponym-declension';
21
-
22
- /**
23
- * Inflects an anthroponym in nominative grammatical case.
24
- *
25
- * @example
26
- * ```ts
27
- * const anthroponym = await shevchenko.inNominative({
28
- * gender: shevchenko.GrammaticalGender.MASCULINE,
29
- * givenName: 'Тарас',
30
- * patronymicName: 'Григорович',
31
- * familyName: 'Шевченко',
32
- * });
33
- * ```
34
- * @throws {InputValidationError} Input validation error.
35
- */
36
- export async function inNominative<T extends DeclensionInput>(
37
- input: T,
38
- ): Promise<DeclensionOutput<T>> {
39
- validateDeclensionInput(input);
40
- const result = await anthroponymInflector.inflect(
41
- input,
42
- input.gender,
43
- GrammaticalCase.NOMINATIVE,
44
- );
45
- return result as DeclensionOutput<T>;
46
- }
47
-
48
- /**
49
- * Inflects an anthroponym in genitive grammatical case.
50
- *
51
- * @example
52
- * ```ts
53
- * const anthroponym = await shevchenko.inGenitive({
54
- * gender: shevchenko.GrammaticalGender.MASCULINE,
55
- * givenName: 'Тарас',
56
- * patronymicName: 'Григорович',
57
- * familyName: 'Шевченко',
58
- * });
59
- * ```
60
- * @throws {InputValidationError} Input validation error.
61
- */
62
- export async function inGenitive<T extends DeclensionInput>(
63
- input: T,
64
- ): Promise<DeclensionOutput<T>> {
65
- validateDeclensionInput(input);
66
- const result = await anthroponymInflector.inflect(input, input.gender, GrammaticalCase.GENITIVE);
67
- return result as DeclensionOutput<T>;
68
- }
69
-
70
- /**
71
- * Inflects an anthroponym in dative grammatical case.
72
- *
73
- * @example
74
- * ```ts
75
- * const anthroponym = await shevchenko.inDative({
76
- * gender: shevchenko.GrammaticalGender.MASCULINE,
77
- * givenName: 'Тарас',
78
- * patronymicName: 'Григорович',
79
- * familyName: 'Шевченко',
80
- * });
81
- * ```
82
- * @throws {InputValidationError} Input validation error.
83
- */
84
- export async function inDative<T extends DeclensionInput>(input: T): Promise<DeclensionOutput<T>> {
85
- validateDeclensionInput(input);
86
- const result = await anthroponymInflector.inflect(input, input.gender, GrammaticalCase.DATIVE);
87
- return result as DeclensionOutput<T>;
88
- }
89
-
90
- /**
91
- * Inflects an anthroponym in accusative grammatical case.
92
- *
93
- * @example
94
- * ```ts
95
- * const anthroponym = await shevchenko.inAccusative({
96
- * gender: shevchenko.GrammaticalGender.MASCULINE,
97
- * givenName: 'Тарас',
98
- * patronymicName: 'Григорович',
99
- * familyName: 'Шевченко',
100
- * });
101
- * ```
102
- * @throws {InputValidationError} Input validation error.
103
- */
104
- export async function inAccusative<T extends DeclensionInput>(
105
- input: T,
106
- ): Promise<DeclensionOutput<T>> {
107
- validateDeclensionInput(input);
108
- const result = await anthroponymInflector.inflect(
109
- input,
110
- input.gender,
111
- GrammaticalCase.ACCUSATIVE,
112
- );
113
- return result as DeclensionOutput<T>;
114
- }
115
-
116
- /**
117
- * Inflects an anthroponym in ablative grammatical case.
118
- *
119
- * @example
120
- * ```ts
121
- * const anthroponym = await shevchenko.inAblative({
122
- * gender: shevchenko.GrammaticalGender.MASCULINE,
123
- * givenName: 'Тарас',
124
- * patronymicName: 'Григорович',
125
- * familyName: 'Шевченко',
126
- * });
127
- * ```
128
- * @throws {InputValidationError} Input validation error.
129
- */
130
- export async function inAblative<T extends DeclensionInput>(
131
- input: T,
132
- ): Promise<DeclensionOutput<T>> {
133
- validateDeclensionInput(input);
134
- const result = await anthroponymInflector.inflect(input, input.gender, GrammaticalCase.ABLATIVE);
135
- return result as DeclensionOutput<T>;
136
- }
137
-
138
- /**
139
- * Inflects an anthroponym in locative grammatical case.
140
- *
141
- * @example
142
- * ```ts
143
- * const anthroponym = await shevchenko.inLocative({
144
- * gender: shevchenko.GrammaticalGender.MASCULINE,
145
- * givenName: 'Тарас',
146
- * patronymicName: 'Григорович',
147
- * familyName: 'Шевченко',
148
- * });
149
- * ```
150
- * @throws {InputValidationError} Input validation error.
151
- */
152
- export async function inLocative<T extends DeclensionInput>(
153
- input: T,
154
- ): Promise<DeclensionOutput<T>> {
155
- validateDeclensionInput(input);
156
- const result = await anthroponymInflector.inflect(input, input.gender, GrammaticalCase.LOCATIVE);
157
- return result as DeclensionOutput<T>;
158
- }
159
-
160
- /**
161
- * Inflects an anthroponym in vocative grammatical case.
162
- *
163
- * @example
164
- * ```ts
165
- * const anthroponym = await shevchenko.inVocative({
166
- * gender: shevchenko.GrammaticalGender.MASCULINE,
167
- * givenName: 'Тарас',
168
- * patronymicName: 'Григорович',
169
- * familyName: 'Шевченко',
170
- * });
171
- * ```
172
- * @throws {InputValidationError} Input validation error.
173
- */
174
- export async function inVocative<T extends DeclensionInput>(
175
- input: T,
176
- ): Promise<DeclensionOutput<T>> {
177
- validateDeclensionInput(input);
178
- const result = await anthroponymInflector.inflect(input, input.gender, GrammaticalCase.VOCATIVE);
179
- return result as DeclensionOutput<T>;
180
- }
181
-
182
- /**
183
- * Returns the grammatical gender of an anthroponym.
184
- * Returns null if the grammatical gender cannot be detected.
185
- *
186
- * @example
187
- * ```ts
188
- * const gender = await shevchenko.detectGender({
189
- * givenName: 'Тарас',
190
- * patronymicName: 'Григорович',
191
- * familyName: 'Шевченко',
192
- * });
193
- * ```
194
- * @throws {InputValidationError} Input validation error.
195
- */
196
- export async function detectGender(input: GenderDetectionInput): Promise<GenderDetectionOutput> {
197
- validateGenderDetectionInput(input);
198
- return autoDetectGender(input);
199
- }
@@ -1,3 +0,0 @@
1
- # Word Declension Module
2
-
3
- This module provides services and datatypes for the word declension.
@@ -1,18 +0,0 @@
1
- import { InflectionCommand } from './declension-types';
2
- import { InflectionCommandRunner } from './inflection-command-runner';
3
-
4
- export class AppendCommandRunner implements InflectionCommandRunner {
5
- private readonly command: InflectionCommand;
6
-
7
- constructor(command: InflectionCommand) {
8
- this.command = command;
9
- }
10
-
11
- /**
12
- * Appends the command value to the given value.
13
- * Returns a new value.
14
- */
15
- exec(value: string): string {
16
- return value + this.command.value;
17
- }
18
- }
@@ -1,7 +0,0 @@
1
- import { DeclensionRule } from './declension-types';
2
- import untypedDeclensionRules from './rules/artifacts/declension-rules.json';
3
- import { WordInflector } from './word-inflector';
4
-
5
- const declensionRules = untypedDeclensionRules as DeclensionRule[];
6
-
7
- export const wordInflector = new WordInflector(declensionRules);
@@ -1,23 +0,0 @@
1
- import { AppendCommandRunner } from './append-command-runner';
2
- import { InflectionCommand, InflectionCommandAction } from './declension-types';
3
- import { InflectionCommandRunner } from './inflection-command-runner';
4
- import { ReplaceCommandRunner } from './replace-command-runner';
5
-
6
- export class CommandRunnerFactory {
7
- /**
8
- * Creates a new command runner for the given command.
9
- */
10
- make(command: InflectionCommand): InflectionCommandRunner {
11
- switch (command.action) {
12
- case InflectionCommandAction.APPEND: {
13
- return new AppendCommandRunner(command);
14
- }
15
- case InflectionCommandAction.REPLACE: {
16
- return new ReplaceCommandRunner(command);
17
- }
18
- default: {
19
- throw new TypeError(`Invalid command action: ${command.action}.`);
20
- }
21
- }
22
- }
23
- }
@@ -1,50 +0,0 @@
1
- import { copyLetterCase, GrammaticalCase } from '../language';
2
- import { CommandRunnerFactory } from './command-runner-factory';
3
- import { DeclensionRule } from './declension-types';
4
-
5
- /**
6
- * Counts a number of groups in a given regular expression.
7
- */
8
- export function countGroups(src: RegExp | string): number {
9
- const pattern = new RegExp(`${src.toString()}|`);
10
- const matches = pattern.exec('');
11
- if (matches == null) {
12
- return 0;
13
- }
14
- return matches.length - 1;
15
- }
16
-
17
- export class DeclensionRuleInflector {
18
- private readonly rule: DeclensionRule;
19
- private readonly commandRunnerFactory: CommandRunnerFactory;
20
-
21
- constructor(rule: DeclensionRule) {
22
- this.rule = rule;
23
- this.commandRunnerFactory = new CommandRunnerFactory();
24
- }
25
-
26
- /**
27
- * Inflects the given word in the given grammatical case using the rule.
28
- */
29
- inflect(word: string, grammaticalCase: GrammaticalCase): string {
30
- const [commands] = this.rule.grammaticalCases[grammaticalCase];
31
- if (commands) {
32
- const searchValue = new RegExp(this.rule.pattern.modify, 'gi');
33
- const inflectedWord = word.replace(searchValue, (match, ...groups) => {
34
- let replacer = '';
35
- const groupCount = countGroups(this.rule.pattern.modify);
36
- for (let groupIndex = 0; groupIndex < groupCount; groupIndex += 1) {
37
- let value = groups[groupIndex];
38
- const command = commands[groupIndex];
39
- if (command != null) {
40
- value = this.commandRunnerFactory.make(command).exec(value);
41
- }
42
- replacer += value;
43
- }
44
- return replacer;
45
- });
46
- return copyLetterCase(word, inflectedWord);
47
- }
48
- return word;
49
- }
50
- }
@@ -1,33 +0,0 @@
1
- import { GrammaticalGender } from '../language';
2
- import { ApplicationType, DeclensionRule } from './declension-types';
3
-
4
- /**
5
- * Determines if a given declension rule applies to a specified gender.
6
- */
7
- export function isGenderApplicable(rule: DeclensionRule, gender: GrammaticalGender): boolean {
8
- return rule.gender.includes(gender);
9
- }
10
-
11
- /**
12
- * Determines if a given declension rule applies to a specified application type.
13
- */
14
- export function isApplicable(rule: DeclensionRule, applicationType: ApplicationType): boolean {
15
- return rule.applicationType.length === 0 || rule.applicationType.includes(applicationType);
16
- }
17
-
18
- /**
19
- * Determines if a given declension rule strictly applies to a specified application type.
20
- */
21
- export function isStriclyApplicable(
22
- rule: DeclensionRule,
23
- applicationType: ApplicationType,
24
- ): boolean {
25
- return rule.applicationType.includes(applicationType);
26
- }
27
-
28
- /**
29
- * Determines if a given declension rule applies to a specified word.
30
- */
31
- export function isWordApplicable(rule: DeclensionRule, word: string): boolean {
32
- return new RegExp(rule.pattern.find, 'gi').test(word);
33
- }
@@ -1,43 +0,0 @@
1
- import { GrammaticalCase, GrammaticalGender, WordClass } from '../language';
2
-
3
- export type DeclensionRule = {
4
- description: string;
5
- examples: string[];
6
- wordClass: WordClass;
7
- gender: GrammaticalGender[];
8
- priority: number;
9
- applicationType: ApplicationType[];
10
- pattern: DeclensionPattern;
11
- grammaticalCases: GrammaticalCases;
12
- };
13
-
14
- export type ApplicationType = 'givenName' | 'patronymicName' | 'familyName';
15
-
16
- export type DeclensionPattern = {
17
- find: string;
18
- modify: string;
19
- };
20
-
21
- export type GrammaticalCases = {
22
- [GrammaticalCase.NOMINATIVE]: InflectionCommands[];
23
- [GrammaticalCase.GENITIVE]: InflectionCommands[];
24
- [GrammaticalCase.DATIVE]: InflectionCommands[];
25
- [GrammaticalCase.ACCUSATIVE]: InflectionCommands[];
26
- [GrammaticalCase.ABLATIVE]: InflectionCommands[];
27
- [GrammaticalCase.LOCATIVE]: InflectionCommands[];
28
- [GrammaticalCase.VOCATIVE]: InflectionCommands[];
29
- };
30
-
31
- export type InflectionCommands = {
32
- [groupIndex: string]: InflectionCommand;
33
- };
34
-
35
- export type InflectionCommand = {
36
- action: InflectionCommandAction;
37
- value: string;
38
- };
39
-
40
- export enum InflectionCommandAction {
41
- REPLACE = 'replace',
42
- APPEND = 'append',
43
- }
@@ -1 +0,0 @@
1
- export * from './word-inflector';
@@ -1,3 +0,0 @@
1
- export interface InflectionCommandRunner {
2
- exec(value: string): string;
3
- }
@@ -1,18 +0,0 @@
1
- import { InflectionCommand } from './declension-types';
2
- import { InflectionCommandRunner } from './inflection-command-runner';
3
-
4
- export class ReplaceCommandRunner implements InflectionCommandRunner {
5
- private readonly command: InflectionCommand;
6
-
7
- constructor(command: InflectionCommand) {
8
- this.command = command;
9
- }
10
-
11
- /**
12
- * Replaces the given value with the command value.
13
- * Returns a new value.
14
- */
15
- exec(): string {
16
- return this.command.value;
17
- }
18
- }