shevchenko 3.0.7 → 3.0.9

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 (135) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +4 -4
  3. package/dist/cjs/anthroponym-declension/anthroponym-inflector.js +3 -3
  4. package/dist/cjs/anthroponym-declension/bootstrap.js +3 -3
  5. package/dist/cjs/anthroponym-declension/family-name-classifier/artifacts/model.bundle.json.js +3 -3
  6. package/dist/cjs/anthroponym-declension/family-name-classifier/cache/incorrect-predictions.json.js +3 -3
  7. package/dist/cjs/anthroponym-declension/family-name-classifier/family-name-class-transformer.js +3 -3
  8. package/dist/cjs/anthroponym-declension/family-name-classifier/family-name-classifer.js +3 -3
  9. package/dist/cjs/anthroponym-declension/family-name-classifier/model-bundle-loader.js +3 -3
  10. package/dist/cjs/anthroponym-declension/family-name-classifier/model-config.js +3 -3
  11. package/dist/cjs/anthroponym-declension/family-name-classifier/word-transformer.js +3 -3
  12. package/dist/cjs/anthroponym-declension/family-name-inflector.js +4 -4
  13. package/dist/cjs/anthroponym-declension/family-name-inflector.js.map +1 -1
  14. package/dist/cjs/anthroponym-declension/given-name-inflector.js +4 -4
  15. package/dist/cjs/anthroponym-declension/given-name-inflector.js.map +1 -1
  16. package/dist/cjs/anthroponym-declension/name-inflector.js +3 -3
  17. package/dist/cjs/anthroponym-declension/patronymic-name-inflector.js +5 -5
  18. package/dist/cjs/anthroponym-declension/patronymic-name-inflector.js.map +1 -1
  19. package/dist/cjs/gender-detection/detect-gender.js +3 -3
  20. package/dist/cjs/gender-detection/given-names-genders.json.js +3 -3
  21. package/dist/cjs/index.js +5 -3
  22. package/dist/cjs/index.js.map +1 -1
  23. package/dist/cjs/input-validation.js +54 -49
  24. package/dist/cjs/input-validation.js.map +1 -1
  25. package/dist/cjs/language/alphabet.js +3 -3
  26. package/dist/cjs/language/grammatical-case.js +3 -3
  27. package/dist/cjs/language/grammatical-gender.js +3 -3
  28. package/dist/cjs/language/letter-case.js +3 -3
  29. package/dist/cjs/language/linguistics.js +3 -3
  30. package/dist/cjs/language/word-class.js +3 -3
  31. package/dist/cjs/shevchenko.js +97 -18
  32. package/dist/cjs/shevchenko.js.map +1 -1
  33. package/dist/cjs/word-declension/append-command-runner.js +3 -3
  34. package/dist/cjs/word-declension/bootstrap.js +4 -4
  35. package/dist/cjs/word-declension/command-runner-factory.js +3 -3
  36. package/dist/cjs/word-declension/declension-rule-inflector.js +3 -3
  37. package/dist/cjs/word-declension/declension-types.js +3 -3
  38. package/dist/cjs/word-declension/declension-types.js.map +1 -1
  39. package/dist/cjs/word-declension/replace-command-runner.js +3 -3
  40. package/dist/cjs/word-declension/{declension-rules.json.js → rules/artifacts/declension-rules.json.js} +123 -103
  41. package/dist/{es/word-declension → cjs/word-declension/rules/artifacts}/declension-rules.json.js.map +1 -1
  42. package/dist/cjs/word-declension/word-inflector.js +7 -7
  43. package/dist/cjs/word-declension/word-inflector.js.map +1 -1
  44. package/dist/es/anthroponym-declension/anthroponym-inflector.js +3 -3
  45. package/dist/es/anthroponym-declension/anthroponym.d.ts +2 -2
  46. package/dist/es/anthroponym-declension/anthroponym.d.ts.map +1 -1
  47. package/dist/es/anthroponym-declension/bootstrap.js +3 -3
  48. package/dist/es/anthroponym-declension/family-name-classifier/artifacts/model.bundle.json.js +3 -3
  49. package/dist/es/anthroponym-declension/family-name-classifier/cache/incorrect-predictions.json.js +3 -3
  50. package/dist/es/anthroponym-declension/family-name-classifier/data-utils.d.ts +3 -3
  51. package/dist/es/anthroponym-declension/family-name-classifier/data-utils.d.ts.map +1 -1
  52. package/dist/es/anthroponym-declension/family-name-classifier/family-name-class-transformer.js +3 -3
  53. package/dist/es/anthroponym-declension/family-name-classifier/family-name-class.d.ts +2 -2
  54. package/dist/es/anthroponym-declension/family-name-classifier/family-name-class.d.ts.map +1 -1
  55. package/dist/es/anthroponym-declension/family-name-classifier/family-name-classifer.js +3 -3
  56. package/dist/es/anthroponym-declension/family-name-classifier/model-bundle-loader.js +3 -3
  57. package/dist/es/anthroponym-declension/family-name-classifier/model-config.js +3 -3
  58. package/dist/es/anthroponym-declension/family-name-classifier/scripts/train-model.d.ts +2 -2
  59. package/dist/es/anthroponym-declension/family-name-classifier/scripts/train-model.d.ts.map +1 -1
  60. package/dist/es/anthroponym-declension/family-name-classifier/word-transformer.js +3 -3
  61. package/dist/es/anthroponym-declension/family-name-inflector.js +4 -4
  62. package/dist/es/anthroponym-declension/family-name-inflector.js.map +1 -1
  63. package/dist/es/anthroponym-declension/given-name-inflector.js +4 -4
  64. package/dist/es/anthroponym-declension/given-name-inflector.js.map +1 -1
  65. package/dist/es/anthroponym-declension/name-inflector.js +3 -3
  66. package/dist/es/anthroponym-declension/patronymic-name-inflector.d.ts.map +1 -1
  67. package/dist/es/anthroponym-declension/patronymic-name-inflector.js +5 -5
  68. package/dist/es/anthroponym-declension/patronymic-name-inflector.js.map +1 -1
  69. package/dist/es/contracts.d.ts +10 -4
  70. package/dist/es/contracts.d.ts.map +1 -1
  71. package/dist/es/gender-detection/detect-gender.js +3 -3
  72. package/dist/es/gender-detection/given-names-genders.json.js +3 -3
  73. package/dist/es/index.js +4 -3
  74. package/dist/es/index.js.map +1 -1
  75. package/dist/es/input-validation.d.ts +6 -4
  76. package/dist/es/input-validation.d.ts.map +1 -1
  77. package/dist/es/input-validation.js +54 -50
  78. package/dist/es/input-validation.js.map +1 -1
  79. package/dist/es/language/alphabet.js +3 -3
  80. package/dist/es/language/grammatical-case.js +3 -3
  81. package/dist/es/language/grammatical-gender.js +3 -3
  82. package/dist/es/language/letter-case.js +3 -3
  83. package/dist/es/language/linguistics.js +3 -3
  84. package/dist/es/language/word-class.js +3 -3
  85. package/dist/es/shevchenko.d.ts +87 -15
  86. package/dist/es/shevchenko.d.ts.map +1 -1
  87. package/dist/es/shevchenko.js +97 -18
  88. package/dist/es/shevchenko.js.map +1 -1
  89. package/dist/es/word-declension/append-command-runner.js +3 -3
  90. package/dist/es/word-declension/bootstrap.js +4 -4
  91. package/dist/es/word-declension/command-runner-factory.js +3 -3
  92. package/dist/es/word-declension/declension-rule-inflector.js +3 -3
  93. package/dist/es/word-declension/declension-rule-matchers.d.ts +5 -5
  94. package/dist/es/word-declension/declension-rule-matchers.d.ts.map +1 -1
  95. package/dist/es/word-declension/declension-types.d.ts +12 -11
  96. package/dist/es/word-declension/declension-types.d.ts.map +1 -1
  97. package/dist/es/word-declension/declension-types.js +3 -3
  98. package/dist/es/word-declension/declension-types.js.map +1 -1
  99. package/dist/es/word-declension/replace-command-runner.js +3 -3
  100. package/dist/es/word-declension/{declension-rules.json.js → rules/artifacts/declension-rules.json.js} +123 -103
  101. package/dist/{cjs/word-declension → es/word-declension/rules/artifacts}/declension-rules.json.js.map +1 -1
  102. package/dist/es/word-declension/rules/scripts/build-declension-rules.d.ts +2 -0
  103. package/dist/es/word-declension/rules/scripts/build-declension-rules.d.ts.map +1 -0
  104. package/dist/es/word-declension/word-inflector.d.ts +5 -7
  105. package/dist/es/word-declension/word-inflector.d.ts.map +1 -1
  106. package/dist/es/word-declension/word-inflector.js +7 -7
  107. package/dist/es/word-declension/word-inflector.js.map +1 -1
  108. package/dist/umd/shevchenko.min.js +188 -188
  109. package/dist/umd/shevchenko.min.js.map +1 -1
  110. package/package.json +5 -6
  111. package/src/anthroponym-declension/anthroponym.ts +2 -2
  112. package/src/anthroponym-declension/family-name-classifier/data-utils.ts +3 -3
  113. package/src/anthroponym-declension/family-name-classifier/family-name-class.ts +2 -2
  114. package/src/anthroponym-declension/family-name-classifier/model-bundle-saver.ts +4 -4
  115. package/src/anthroponym-declension/family-name-classifier/scripts/cache-incorrect-predictions.ts +6 -6
  116. package/src/anthroponym-declension/family-name-classifier/scripts/train-model.ts +7 -7
  117. package/src/anthroponym-declension/family-name-inflector.ts +1 -1
  118. package/src/anthroponym-declension/given-name-inflector.ts +1 -1
  119. package/src/anthroponym-declension/patronymic-name-inflector.ts +3 -2
  120. package/src/contracts.ts +12 -4
  121. package/src/input-validation.ts +65 -51
  122. package/src/shevchenko.ts +127 -23
  123. package/src/word-declension/README.md +1 -1
  124. package/src/word-declension/bootstrap.ts +1 -1
  125. package/src/word-declension/declension-rule-matchers.ts +10 -7
  126. package/src/word-declension/declension-types.ts +13 -11
  127. package/src/word-declension/rules/adjective-declension-rules.json +649 -0
  128. package/src/word-declension/{declension-rules.json → rules/artifacts/declension-rules.json} +121 -100
  129. package/src/word-declension/rules/exception-declension-rules.json +842 -0
  130. package/src/word-declension/rules/noun-declension-rules.json +6301 -0
  131. package/src/word-declension/rules/scripts/build-declension-rules.ts +40 -0
  132. package/src/word-declension/word-inflector.ts +13 -11
  133. package/dist/es/word-declension/scripts/load-declension-rules.d.ts +0 -2
  134. package/dist/es/word-declension/scripts/load-declension-rules.d.ts.map +0 -1
  135. package/src/word-declension/scripts/load-declension-rules.ts +0 -14
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * @file JavaScript library for declension of Ukrainian anthroponyms
3
3
  * @module shevchenko
4
- * @version 3.0.7
5
- * @author Oleksandr Tolochko <tooleks@gmail.com>
4
+ * @version 3.0.9
5
+ * @author Oleksandr Tolochko <shevchenko-js@tooleks.com>
6
6
  * @license MIT
7
- * @copyright 2017-2023 Oleksandr Tolochko <tooleks@gmail.com>
7
+ * @copyright 2017-2024 Oleksandr Tolochko <shevchenko-js@tooleks.com>
8
8
  * @see {@link git+https://github.com/tooleks/shevchenko-js.git}
9
9
  */
10
10
  import './language/alphabet.js';
@@ -12,67 +12,71 @@ import './language/word-class.js';
12
12
  import './language/grammatical-case.js';
13
13
  import { GrammaticalGender } from './language/grammatical-gender.js';
14
14
 
15
- /**
16
- * Validates if a given value is a valid input for declension.
17
- *
18
- * @throws {TypeError}
19
- */
20
- function validateDeclensionInput(input) {
21
- validateObject(input);
22
- validateGender(input.gender);
23
- validateAnthroponym(input);
24
- }
25
- /**
26
- * Validates if a given value is a valid input for gender detection.
27
- *
28
- * @throws {TypeError}
29
- */
30
- function validateGenderDetectionInput(input) {
31
- validateObject(input);
32
- validateAnthroponym(input);
15
+ class InputValidationError extends TypeError {
33
16
  }
34
17
  /**
35
- * Validates if a given value is an object.
18
+ * Validates if a given value is a valid input for declension.
36
19
  *
37
- * @throws {TypeError}
20
+ * @throws {InputValidationError}
38
21
  */
39
- function validateObject(object) {
40
- if (typeof object !== 'object' || object == null) {
41
- throw new TypeError('The input type must be an object.');
22
+ function validateDeclensionInput(value) {
23
+ if (!isObject(value)) {
24
+ throw new InputValidationError('The input type must be an object.');
42
25
  }
43
- }
44
- /**
45
- * Validates if a given value is a valid grammatical gender.
46
- *
47
- * @throws {TypeError}
48
- */
49
- function validateGender(gender) {
50
- if (![GrammaticalGender.MASCULINE, GrammaticalGender.FEMININE].includes(gender)) {
51
- throw new TypeError(`The "gender" parameter must be one of the following: "${GrammaticalGender.MASCULINE}", "${GrammaticalGender.FEMININE}".`);
26
+ if (!isIn(value.gender, Object.values(GrammaticalGender))) {
27
+ throw new InputValidationError(`The "gender" parameter must be one of the following: "${GrammaticalGender.MASCULINE}", "${GrammaticalGender.FEMININE}".`);
28
+ }
29
+ if (!isDefined(value.givenName) &&
30
+ !isDefined(value.patronymicName) &&
31
+ !isDefined(value.familyName)) {
32
+ throw new InputValidationError('At least one of the following parameters must present: "givenName", "patronymicName", "familyName".');
33
+ }
34
+ if (isDefined(value.givenName) && !isString(value.givenName)) {
35
+ throw new InputValidationError('The "givenName" parameter must be a string.');
36
+ }
37
+ if (isDefined(value.patronymicName) && !isString(value.patronymicName)) {
38
+ throw new InputValidationError('The "patronymicName" parameter must be a string.');
39
+ }
40
+ if (isDefined(value.familyName) && !isString(value.familyName)) {
41
+ throw new InputValidationError('The "familyName" parameter must be a string.');
52
42
  }
53
43
  }
54
44
  /**
55
- * Validates if a given value is a valid anthroponym.
45
+ * Validates if a given value is a valid input for gender detection.
56
46
  *
57
- * @throws {TypeError}
47
+ * @throws {InputValidationError}
58
48
  */
59
- function validateAnthroponym(anthroponym) {
60
- if (typeof anthroponym.givenName === 'undefined' &&
61
- typeof anthroponym.patronymicName === 'undefined' &&
62
- typeof anthroponym.familyName === 'undefined') {
63
- throw new TypeError('At least one of the following parameters must present: "givenName", "patronymicName", "familyName".');
49
+ function validateGenderDetectionInput(value) {
50
+ if (!isObject(value)) {
51
+ throw new InputValidationError('The input type must be an object.');
52
+ }
53
+ if (!isDefined(value.givenName) &&
54
+ !isDefined(value.patronymicName) &&
55
+ !isDefined(value.familyName)) {
56
+ throw new InputValidationError('At least one of the following parameters must present: "givenName", "patronymicName", "familyName".');
64
57
  }
65
- if (typeof anthroponym.givenName !== 'undefined' && typeof anthroponym.givenName !== 'string') {
66
- throw new TypeError('The "givenName" parameter must be a string.');
58
+ if (isDefined(value.givenName) && !isString(value.givenName)) {
59
+ throw new InputValidationError('The "givenName" parameter must be a string.');
67
60
  }
68
- if (typeof anthroponym.patronymicName !== 'undefined' &&
69
- typeof anthroponym.patronymicName !== 'string') {
70
- throw new TypeError('The "patronymicName" parameter must be a string.');
61
+ if (isDefined(value.patronymicName) && !isString(value.patronymicName)) {
62
+ throw new InputValidationError('The "patronymicName" parameter must be a string.');
71
63
  }
72
- if (typeof anthroponym.familyName !== 'undefined' && typeof anthroponym.familyName !== 'string') {
73
- throw new TypeError('The "familyName" parameter must be a string.');
64
+ if (isDefined(value.familyName) && !isString(value.familyName)) {
65
+ throw new InputValidationError('The "familyName" parameter must be a string.');
74
66
  }
75
67
  }
68
+ function isDefined(value) {
69
+ return typeof value !== 'undefined';
70
+ }
71
+ function isObject(value) {
72
+ return value != null && typeof value === 'object';
73
+ }
74
+ function isString(value) {
75
+ return typeof value === 'string';
76
+ }
77
+ function isIn(value, values) {
78
+ return values.includes(value);
79
+ }
76
80
 
77
- export { validateDeclensionInput, validateGenderDetectionInput };
81
+ export { InputValidationError, validateDeclensionInput, validateGenderDetectionInput };
78
82
  //# sourceMappingURL=input-validation.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"input-validation.js","sources":["../../src/input-validation.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;;;;;;AAIA;;;;AAIG;AACG,SAAU,uBAAuB,CAAC,KAAsB,EAAA;IAC5D,cAAc,CAAC,KAAK,CAAC,CAAC;AACtB,IAAA,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,mBAAmB,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED;;;;AAIG;AACG,SAAU,4BAA4B,CAAC,KAA2B,EAAA;IACtE,cAAc,CAAC,KAAK,CAAC,CAAC;IACtB,mBAAmB,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED;;;;AAIG;AACH,SAAS,cAAc,CAAC,MAAe,EAAA;IACrC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,IAAI,IAAI,EAAE;AAChD,QAAA,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAC;AAC1D,KAAA;AACH,CAAC;AAED;;;;AAIG;AACH,SAAS,cAAc,CAAC,MAAyB,EAAA;AAC/C,IAAA,IAAI,CAAC,CAAC,iBAAiB,CAAC,SAAS,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;AAC/E,QAAA,MAAM,IAAI,SAAS,CACjB,CAAA,sDAAA,EAAyD,iBAAiB,CAAC,SAAS,CAAA,IAAA,EAAO,iBAAiB,CAAC,QAAQ,CAAA,EAAA,CAAI,CAC1H,CAAC;AACH,KAAA;AACH,CAAC;AAED;;;;AAIG;AACH,SAAS,mBAAmB,CAAC,WAAwB,EAAA;AACnD,IAAA,IACE,OAAO,WAAW,CAAC,SAAS,KAAK,WAAW;AAC5C,QAAA,OAAO,WAAW,CAAC,cAAc,KAAK,WAAW;AACjD,QAAA,OAAO,WAAW,CAAC,UAAU,KAAK,WAAW,EAC7C;AACA,QAAA,MAAM,IAAI,SAAS,CACjB,qGAAqG,CACtG,CAAC;AACH,KAAA;AAED,IAAA,IAAI,OAAO,WAAW,CAAC,SAAS,KAAK,WAAW,IAAI,OAAO,WAAW,CAAC,SAAS,KAAK,QAAQ,EAAE;AAC7F,QAAA,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;AACpE,KAAA;AAED,IAAA,IACE,OAAO,WAAW,CAAC,cAAc,KAAK,WAAW;AACjD,QAAA,OAAO,WAAW,CAAC,cAAc,KAAK,QAAQ,EAC9C;AACA,QAAA,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAC;AACzE,KAAA;AAED,IAAA,IAAI,OAAO,WAAW,CAAC,UAAU,KAAK,WAAW,IAAI,OAAO,WAAW,CAAC,UAAU,KAAK,QAAQ,EAAE;AAC/F,QAAA,MAAM,IAAI,SAAS,CAAC,8CAA8C,CAAC,CAAC;AACrE,KAAA;AACH;;;;"}
1
+ {"version":3,"file":"input-validation.js","sources":["../../src/input-validation.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;;;;;;AAGM,MAAO,oBAAqB,SAAQ,SAAS,CAAA;AAAG,CAAA;AAEtD;;;;AAIG;AACG,SAAU,uBAAuB,CAAC,KAAc,EAAA;AACpD,IAAA,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;AACpB,QAAA,MAAM,IAAI,oBAAoB,CAAC,mCAAmC,CAAC,CAAC;AACrE,KAAA;AAED,IAAA,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,EAAE;AACzD,QAAA,MAAM,IAAI,oBAAoB,CAC5B,CAAA,sDAAA,EAAyD,iBAAiB,CAAC,SAAS,CAAA,IAAA,EAAO,iBAAiB,CAAC,QAAQ,CAAA,EAAA,CAAI,CAC1H,CAAC;AACH,KAAA;AAED,IAAA,IACE,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC;AAC3B,QAAA,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC;AAChC,QAAA,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,EAC5B;AACA,QAAA,MAAM,IAAI,oBAAoB,CAC5B,qGAAqG,CACtG,CAAC;AACH,KAAA;AAED,IAAA,IAAI,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;AAC5D,QAAA,MAAM,IAAI,oBAAoB,CAAC,6CAA6C,CAAC,CAAC;AAC/E,KAAA;AAED,IAAA,IAAI,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE;AACtE,QAAA,MAAM,IAAI,oBAAoB,CAAC,kDAAkD,CAAC,CAAC;AACpF,KAAA;AAED,IAAA,IAAI,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;AAC9D,QAAA,MAAM,IAAI,oBAAoB,CAAC,8CAA8C,CAAC,CAAC;AAChF,KAAA;AACH,CAAC;AAED;;;;AAIG;AACG,SAAU,4BAA4B,CAC1C,KAAc,EAAA;AAEd,IAAA,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;AACpB,QAAA,MAAM,IAAI,oBAAoB,CAAC,mCAAmC,CAAC,CAAC;AACrE,KAAA;AAED,IAAA,IACE,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC;AAC3B,QAAA,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC;AAChC,QAAA,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,EAC5B;AACA,QAAA,MAAM,IAAI,oBAAoB,CAC5B,qGAAqG,CACtG,CAAC;AACH,KAAA;AAED,IAAA,IAAI,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;AAC5D,QAAA,MAAM,IAAI,oBAAoB,CAAC,6CAA6C,CAAC,CAAC;AAC/E,KAAA;AAED,IAAA,IAAI,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE;AACtE,QAAA,MAAM,IAAI,oBAAoB,CAAC,kDAAkD,CAAC,CAAC;AACpF,KAAA;AAED,IAAA,IAAI,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;AAC9D,QAAA,MAAM,IAAI,oBAAoB,CAAC,8CAA8C,CAAC,CAAC;AAChF,KAAA;AACH,CAAC;AAED,SAAS,SAAS,CAAI,KAAoB,EAAA;AACxC,IAAA,OAAO,OAAO,KAAK,KAAK,WAAW,CAAC;AACtC,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc,EAAA;IAC9B,OAAO,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AACpD,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc,EAAA;AAC9B,IAAA,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED,SAAS,IAAI,CAAI,KAAc,EAAE,MAAW,EAAA;AAC1C,IAAA,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAU,CAAC,CAAC;AACrC;;;;"}
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * @file JavaScript library for declension of Ukrainian anthroponyms
3
3
  * @module shevchenko
4
- * @version 3.0.7
5
- * @author Oleksandr Tolochko <tooleks@gmail.com>
4
+ * @version 3.0.9
5
+ * @author Oleksandr Tolochko <shevchenko-js@tooleks.com>
6
6
  * @license MIT
7
- * @copyright 2017-2023 Oleksandr Tolochko <tooleks@gmail.com>
7
+ * @copyright 2017-2024 Oleksandr Tolochko <shevchenko-js@tooleks.com>
8
8
  * @see {@link git+https://github.com/tooleks/shevchenko-js.git}
9
9
  */
10
10
  /**
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * @file JavaScript library for declension of Ukrainian anthroponyms
3
3
  * @module shevchenko
4
- * @version 3.0.7
5
- * @author Oleksandr Tolochko <tooleks@gmail.com>
4
+ * @version 3.0.9
5
+ * @author Oleksandr Tolochko <shevchenko-js@tooleks.com>
6
6
  * @license MIT
7
- * @copyright 2017-2023 Oleksandr Tolochko <tooleks@gmail.com>
7
+ * @copyright 2017-2024 Oleksandr Tolochko <shevchenko-js@tooleks.com>
8
8
  * @see {@link git+https://github.com/tooleks/shevchenko-js.git}
9
9
  */
10
10
  /**
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * @file JavaScript library for declension of Ukrainian anthroponyms
3
3
  * @module shevchenko
4
- * @version 3.0.7
5
- * @author Oleksandr Tolochko <tooleks@gmail.com>
4
+ * @version 3.0.9
5
+ * @author Oleksandr Tolochko <shevchenko-js@tooleks.com>
6
6
  * @license MIT
7
- * @copyright 2017-2023 Oleksandr Tolochko <tooleks@gmail.com>
7
+ * @copyright 2017-2024 Oleksandr Tolochko <shevchenko-js@tooleks.com>
8
8
  * @see {@link git+https://github.com/tooleks/shevchenko-js.git}
9
9
  */
10
10
  /**
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * @file JavaScript library for declension of Ukrainian anthroponyms
3
3
  * @module shevchenko
4
- * @version 3.0.7
5
- * @author Oleksandr Tolochko <tooleks@gmail.com>
4
+ * @version 3.0.9
5
+ * @author Oleksandr Tolochko <shevchenko-js@tooleks.com>
6
6
  * @license MIT
7
- * @copyright 2017-2023 Oleksandr Tolochko <tooleks@gmail.com>
7
+ * @copyright 2017-2024 Oleksandr Tolochko <shevchenko-js@tooleks.com>
8
8
  * @see {@link git+https://github.com/tooleks/shevchenko-js.git}
9
9
  */
10
10
  /**
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * @file JavaScript library for declension of Ukrainian anthroponyms
3
3
  * @module shevchenko
4
- * @version 3.0.7
5
- * @author Oleksandr Tolochko <tooleks@gmail.com>
4
+ * @version 3.0.9
5
+ * @author Oleksandr Tolochko <shevchenko-js@tooleks.com>
6
6
  * @license MIT
7
- * @copyright 2017-2023 Oleksandr Tolochko <tooleks@gmail.com>
7
+ * @copyright 2017-2024 Oleksandr Tolochko <shevchenko-js@tooleks.com>
8
8
  * @see {@link git+https://github.com/tooleks/shevchenko-js.git}
9
9
  */
10
10
  const PATTERN_VOWELS = /[аоуеиіяюєї]/gi;
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * @file JavaScript library for declension of Ukrainian anthroponyms
3
3
  * @module shevchenko
4
- * @version 3.0.7
5
- * @author Oleksandr Tolochko <tooleks@gmail.com>
4
+ * @version 3.0.9
5
+ * @author Oleksandr Tolochko <shevchenko-js@tooleks.com>
6
6
  * @license MIT
7
- * @copyright 2017-2023 Oleksandr Tolochko <tooleks@gmail.com>
7
+ * @copyright 2017-2024 Oleksandr Tolochko <shevchenko-js@tooleks.com>
8
8
  * @see {@link git+https://github.com/tooleks/shevchenko-js.git}
9
9
  */
10
10
  /**
@@ -1,54 +1,126 @@
1
1
  import { DeclensionInput, DeclensionOutput, GenderDetectionInput, GenderDetectionOutput } from './contracts';
2
2
  export * from './contracts';
3
+ export { InputValidationError } from './input-validation';
3
4
  export { GrammaticalGender, GrammaticalCase } from './language';
4
5
  export { Anthroponym } from './anthroponym-declension';
5
6
  /**
6
7
  * Inflects an anthroponym in nominative grammatical case.
7
8
  *
8
- * @throws {TypeError} Input validation error.
9
+ * @example
10
+ * ```ts
11
+ * const anthroponym = await shevchenko.inNominative({
12
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
13
+ * givenName: 'Тарас',
14
+ * patronymicName: 'Григорович',
15
+ * familyName: 'Шевченко',
16
+ * });
17
+ * ```
18
+ * @throws {InputValidationError} Input validation error.
9
19
  */
10
- export declare function inNominative(input: DeclensionInput): Promise<DeclensionOutput>;
20
+ export declare function inNominative<T extends DeclensionInput>(input: T): Promise<DeclensionOutput<T>>;
11
21
  /**
12
22
  * Inflects an anthroponym in genitive grammatical case.
13
23
  *
14
- * @throws {TypeError} Input validation error.
24
+ * @example
25
+ * ```ts
26
+ * const anthroponym = await shevchenko.inGenitive({
27
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
28
+ * givenName: 'Тарас',
29
+ * patronymicName: 'Григорович',
30
+ * familyName: 'Шевченко',
31
+ * });
32
+ * ```
33
+ * @throws {InputValidationError} Input validation error.
15
34
  */
16
- export declare function inGenitive(input: DeclensionInput): Promise<DeclensionOutput>;
35
+ export declare function inGenitive<T extends DeclensionInput>(input: T): Promise<DeclensionOutput<T>>;
17
36
  /**
18
37
  * Inflects an anthroponym in dative grammatical case.
19
38
  *
20
- * @throws {TypeError} Input validation error.
39
+ * @example
40
+ * ```ts
41
+ * const anthroponym = await shevchenko.inDative({
42
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
43
+ * givenName: 'Тарас',
44
+ * patronymicName: 'Григорович',
45
+ * familyName: 'Шевченко',
46
+ * });
47
+ * ```
48
+ * @throws {InputValidationError} Input validation error.
21
49
  */
22
- export declare function inDative(input: DeclensionInput): Promise<DeclensionOutput>;
50
+ export declare function inDative<T extends DeclensionInput>(input: T): Promise<DeclensionOutput<T>>;
23
51
  /**
24
52
  * Inflects an anthroponym in accusative grammatical case.
25
53
  *
26
- * @throws {TypeError} Input validation error.
54
+ * @example
55
+ * ```ts
56
+ * const anthroponym = await shevchenko.inAccusative({
57
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
58
+ * givenName: 'Тарас',
59
+ * patronymicName: 'Григорович',
60
+ * familyName: 'Шевченко',
61
+ * });
62
+ * ```
63
+ * @throws {InputValidationError} Input validation error.
27
64
  */
28
- export declare function inAccusative(input: DeclensionInput): Promise<DeclensionOutput>;
65
+ export declare function inAccusative<T extends DeclensionInput>(input: T): Promise<DeclensionOutput<T>>;
29
66
  /**
30
67
  * Inflects an anthroponym in ablative grammatical case.
31
68
  *
32
- * @throws {TypeError} Input validation error.
69
+ * @example
70
+ * ```ts
71
+ * const anthroponym = await shevchenko.inAblative({
72
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
73
+ * givenName: 'Тарас',
74
+ * patronymicName: 'Григорович',
75
+ * familyName: 'Шевченко',
76
+ * });
77
+ * ```
78
+ * @throws {InputValidationError} Input validation error.
33
79
  */
34
- export declare function inAblative(input: DeclensionInput): Promise<DeclensionOutput>;
80
+ export declare function inAblative<T extends DeclensionInput>(input: T): Promise<DeclensionOutput<T>>;
35
81
  /**
36
82
  * Inflects an anthroponym in locative grammatical case.
37
83
  *
38
- * @throws {TypeError} Input validation error.
84
+ * @example
85
+ * ```ts
86
+ * const anthroponym = await shevchenko.inLocative({
87
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
88
+ * givenName: 'Тарас',
89
+ * patronymicName: 'Григорович',
90
+ * familyName: 'Шевченко',
91
+ * });
92
+ * ```
93
+ * @throws {InputValidationError} Input validation error.
39
94
  */
40
- export declare function inLocative(input: DeclensionInput): Promise<DeclensionOutput>;
95
+ export declare function inLocative<T extends DeclensionInput>(input: T): Promise<DeclensionOutput<T>>;
41
96
  /**
42
97
  * Inflects an anthroponym in vocative grammatical case.
43
98
  *
44
- * @throws {TypeError} Input validation error.
99
+ * @example
100
+ * ```ts
101
+ * const anthroponym = await shevchenko.inVocative({
102
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
103
+ * givenName: 'Тарас',
104
+ * patronymicName: 'Григорович',
105
+ * familyName: 'Шевченко',
106
+ * });
107
+ * ```
108
+ * @throws {InputValidationError} Input validation error.
45
109
  */
46
- export declare function inVocative(input: DeclensionInput): Promise<DeclensionOutput>;
110
+ export declare function inVocative<T extends DeclensionInput>(input: T): Promise<DeclensionOutput<T>>;
47
111
  /**
48
112
  * Returns the grammatical gender of an anthroponym.
49
113
  * Returns null if the grammatical gender cannot be detected.
50
114
  *
51
- * @throws {TypeError} Input validation error.
115
+ * @example
116
+ * ```ts
117
+ * const gender = await shevchenko.detectGender({
118
+ * givenName: 'Тарас',
119
+ * patronymicName: 'Григорович',
120
+ * familyName: 'Шевченко',
121
+ * });
122
+ * ```
123
+ * @throws {InputValidationError} Input validation error.
52
124
  */
53
125
  export declare function detectGender(input: GenderDetectionInput): Promise<GenderDetectionOutput>;
54
126
  //# sourceMappingURL=shevchenko.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"shevchenko.d.ts","sourceRoot":"","sources":["../../src/shevchenko.ts"],"names":[],"mappings":"AACA,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,aAAa,CAAC;AAKrB,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAGpF;AAED;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAGlF;AAED;;;;GAIG;AACH,wBAAsB,QAAQ,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAGhF;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAGpF;AAED;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAGlF;AAED;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAGlF;AAED;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAGlF;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAG9F"}
1
+ {"version":3,"file":"shevchenko.d.ts","sourceRoot":"","sources":["../../src/shevchenko.ts"],"names":[],"mappings":"AACA,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,aAAa,CAAC;AAUrB,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;;;;;;;;;;;GAaG;AACH,wBAAsB,YAAY,CAAC,CAAC,SAAS,eAAe,EAC1D,KAAK,EAAE,CAAC,GACP,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAQ9B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,UAAU,CAAC,CAAC,SAAS,eAAe,EACxD,KAAK,EAAE,CAAC,GACP,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAI9B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,QAAQ,CAAC,CAAC,SAAS,eAAe,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAIhG;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,YAAY,CAAC,CAAC,SAAS,eAAe,EAC1D,KAAK,EAAE,CAAC,GACP,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAQ9B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,UAAU,CAAC,CAAC,SAAS,eAAe,EACxD,KAAK,EAAE,CAAC,GACP,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAI9B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,UAAU,CAAC,CAAC,SAAS,eAAe,EACxD,KAAK,EAAE,CAAC,GACP,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAI9B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,UAAU,CAAC,CAAC,SAAS,eAAe,EACxD,KAAK,EAAE,CAAC,GACP,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAI9B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAG9F"}
@@ -1,15 +1,16 @@
1
1
  /**
2
2
  * @file JavaScript library for declension of Ukrainian anthroponyms
3
3
  * @module shevchenko
4
- * @version 3.0.7
5
- * @author Oleksandr Tolochko <tooleks@gmail.com>
4
+ * @version 3.0.9
5
+ * @author Oleksandr Tolochko <shevchenko-js@tooleks.com>
6
6
  * @license MIT
7
- * @copyright 2017-2023 Oleksandr Tolochko <tooleks@gmail.com>
7
+ * @copyright 2017-2024 Oleksandr Tolochko <shevchenko-js@tooleks.com>
8
8
  * @see {@link git+https://github.com/tooleks/shevchenko-js.git}
9
9
  */
10
10
  import { anthroponymInflector } from './anthroponym-declension/bootstrap.js';
11
11
  import { detectGender as detectGender$1 } from './gender-detection/detect-gender.js';
12
12
  import { validateDeclensionInput, validateGenderDetectionInput } from './input-validation.js';
13
+ export { InputValidationError } from './input-validation.js';
13
14
  import './language/alphabet.js';
14
15
  import './language/word-class.js';
15
16
  import { GrammaticalCase } from './language/grammatical-case.js';
@@ -19,71 +20,149 @@ export { GrammaticalGender } from './language/grammatical-gender.js';
19
20
  /**
20
21
  * Inflects an anthroponym in nominative grammatical case.
21
22
  *
22
- * @throws {TypeError} Input validation error.
23
+ * @example
24
+ * ```ts
25
+ * const anthroponym = await shevchenko.inNominative({
26
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
27
+ * givenName: 'Тарас',
28
+ * patronymicName: 'Григорович',
29
+ * familyName: 'Шевченко',
30
+ * });
31
+ * ```
32
+ * @throws {InputValidationError} Input validation error.
23
33
  */
24
34
  async function inNominative(input) {
25
35
  validateDeclensionInput(input);
26
- return anthroponymInflector.inflect(input, input.gender, GrammaticalCase.NOMINATIVE);
36
+ const result = await anthroponymInflector.inflect(input, input.gender, GrammaticalCase.NOMINATIVE);
37
+ return result;
27
38
  }
28
39
  /**
29
40
  * Inflects an anthroponym in genitive grammatical case.
30
41
  *
31
- * @throws {TypeError} Input validation error.
42
+ * @example
43
+ * ```ts
44
+ * const anthroponym = await shevchenko.inGenitive({
45
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
46
+ * givenName: 'Тарас',
47
+ * patronymicName: 'Григорович',
48
+ * familyName: 'Шевченко',
49
+ * });
50
+ * ```
51
+ * @throws {InputValidationError} Input validation error.
32
52
  */
33
53
  async function inGenitive(input) {
34
54
  validateDeclensionInput(input);
35
- return anthroponymInflector.inflect(input, input.gender, GrammaticalCase.GENITIVE);
55
+ const result = await anthroponymInflector.inflect(input, input.gender, GrammaticalCase.GENITIVE);
56
+ return result;
36
57
  }
37
58
  /**
38
59
  * Inflects an anthroponym in dative grammatical case.
39
60
  *
40
- * @throws {TypeError} Input validation error.
61
+ * @example
62
+ * ```ts
63
+ * const anthroponym = await shevchenko.inDative({
64
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
65
+ * givenName: 'Тарас',
66
+ * patronymicName: 'Григорович',
67
+ * familyName: 'Шевченко',
68
+ * });
69
+ * ```
70
+ * @throws {InputValidationError} Input validation error.
41
71
  */
42
72
  async function inDative(input) {
43
73
  validateDeclensionInput(input);
44
- return anthroponymInflector.inflect(input, input.gender, GrammaticalCase.DATIVE);
74
+ const result = await anthroponymInflector.inflect(input, input.gender, GrammaticalCase.DATIVE);
75
+ return result;
45
76
  }
46
77
  /**
47
78
  * Inflects an anthroponym in accusative grammatical case.
48
79
  *
49
- * @throws {TypeError} Input validation error.
80
+ * @example
81
+ * ```ts
82
+ * const anthroponym = await shevchenko.inAccusative({
83
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
84
+ * givenName: 'Тарас',
85
+ * patronymicName: 'Григорович',
86
+ * familyName: 'Шевченко',
87
+ * });
88
+ * ```
89
+ * @throws {InputValidationError} Input validation error.
50
90
  */
51
91
  async function inAccusative(input) {
52
92
  validateDeclensionInput(input);
53
- return anthroponymInflector.inflect(input, input.gender, GrammaticalCase.ACCUSATIVE);
93
+ const result = await anthroponymInflector.inflect(input, input.gender, GrammaticalCase.ACCUSATIVE);
94
+ return result;
54
95
  }
55
96
  /**
56
97
  * Inflects an anthroponym in ablative grammatical case.
57
98
  *
58
- * @throws {TypeError} Input validation error.
99
+ * @example
100
+ * ```ts
101
+ * const anthroponym = await shevchenko.inAblative({
102
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
103
+ * givenName: 'Тарас',
104
+ * patronymicName: 'Григорович',
105
+ * familyName: 'Шевченко',
106
+ * });
107
+ * ```
108
+ * @throws {InputValidationError} Input validation error.
59
109
  */
60
110
  async function inAblative(input) {
61
111
  validateDeclensionInput(input);
62
- return anthroponymInflector.inflect(input, input.gender, GrammaticalCase.ABLATIVE);
112
+ const result = await anthroponymInflector.inflect(input, input.gender, GrammaticalCase.ABLATIVE);
113
+ return result;
63
114
  }
64
115
  /**
65
116
  * Inflects an anthroponym in locative grammatical case.
66
117
  *
67
- * @throws {TypeError} Input validation error.
118
+ * @example
119
+ * ```ts
120
+ * const anthroponym = await shevchenko.inLocative({
121
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
122
+ * givenName: 'Тарас',
123
+ * patronymicName: 'Григорович',
124
+ * familyName: 'Шевченко',
125
+ * });
126
+ * ```
127
+ * @throws {InputValidationError} Input validation error.
68
128
  */
69
129
  async function inLocative(input) {
70
130
  validateDeclensionInput(input);
71
- return anthroponymInflector.inflect(input, input.gender, GrammaticalCase.LOCATIVE);
131
+ const result = await anthroponymInflector.inflect(input, input.gender, GrammaticalCase.LOCATIVE);
132
+ return result;
72
133
  }
73
134
  /**
74
135
  * Inflects an anthroponym in vocative grammatical case.
75
136
  *
76
- * @throws {TypeError} Input validation error.
137
+ * @example
138
+ * ```ts
139
+ * const anthroponym = await shevchenko.inVocative({
140
+ * gender: shevchenko.GrammaticalGender.MASCULINE,
141
+ * givenName: 'Тарас',
142
+ * patronymicName: 'Григорович',
143
+ * familyName: 'Шевченко',
144
+ * });
145
+ * ```
146
+ * @throws {InputValidationError} Input validation error.
77
147
  */
78
148
  async function inVocative(input) {
79
149
  validateDeclensionInput(input);
80
- return anthroponymInflector.inflect(input, input.gender, GrammaticalCase.VOCATIVE);
150
+ const result = await anthroponymInflector.inflect(input, input.gender, GrammaticalCase.VOCATIVE);
151
+ return result;
81
152
  }
82
153
  /**
83
154
  * Returns the grammatical gender of an anthroponym.
84
155
  * Returns null if the grammatical gender cannot be detected.
85
156
  *
86
- * @throws {TypeError} Input validation error.
157
+ * @example
158
+ * ```ts
159
+ * const gender = await shevchenko.detectGender({
160
+ * givenName: 'Тарас',
161
+ * patronymicName: 'Григорович',
162
+ * familyName: 'Шевченко',
163
+ * });
164
+ * ```
165
+ * @throws {InputValidationError} Input validation error.
87
166
  */
88
167
  async function detectGender(input) {
89
168
  validateGenderDetectionInput(input);
@@ -1 +1 @@
1
- {"version":3,"file":"shevchenko.js","sources":["../../src/shevchenko.ts"],"sourcesContent":[null],"names":["autoDetectGender"],"mappings":";;;;;;;;;;;;;;;;;;AAeA;;;;AAIG;AACI,eAAe,YAAY,CAAC,KAAsB,EAAA;IACvD,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,OAAO,oBAAoB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;AACvF,CAAC;AAED;;;;AAIG;AACI,eAAe,UAAU,CAAC,KAAsB,EAAA;IACrD,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,OAAO,oBAAoB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;AACrF,CAAC;AAED;;;;AAIG;AACI,eAAe,QAAQ,CAAC,KAAsB,EAAA;IACnD,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,OAAO,oBAAoB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;AACnF,CAAC;AAED;;;;AAIG;AACI,eAAe,YAAY,CAAC,KAAsB,EAAA;IACvD,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,OAAO,oBAAoB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;AACvF,CAAC;AAED;;;;AAIG;AACI,eAAe,UAAU,CAAC,KAAsB,EAAA;IACrD,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,OAAO,oBAAoB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;AACrF,CAAC;AAED;;;;AAIG;AACI,eAAe,UAAU,CAAC,KAAsB,EAAA;IACrD,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,OAAO,oBAAoB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;AACrF,CAAC;AAED;;;;AAIG;AACI,eAAe,UAAU,CAAC,KAAsB,EAAA;IACrD,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,OAAO,oBAAoB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;AACrF,CAAC;AAED;;;;;AAKG;AACI,eAAe,YAAY,CAAC,KAA2B,EAAA;IAC5D,4BAA4B,CAAC,KAAK,CAAC,CAAC;AACpC,IAAA,OAAOA,cAAgB,CAAC,KAAK,CAAC,CAAC;AACjC;;;;"}
1
+ {"version":3,"file":"shevchenko.js","sources":["../../src/shevchenko.ts"],"sourcesContent":[null],"names":["autoDetectGender"],"mappings":";;;;;;;;;;;;;;;;;;;AAqBA;;;;;;;;;;;;;AAaG;AACI,eAAe,YAAY,CAChC,KAAQ,EAAA;IAER,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAC/C,KAAK,EACL,KAAK,CAAC,MAAM,EACZ,eAAe,CAAC,UAAU,CAC3B,CAAC;AACF,IAAA,OAAO,MAA6B,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;;;AAaG;AACI,eAAe,UAAU,CAC9B,KAAQ,EAAA;IAER,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;AACjG,IAAA,OAAO,MAA6B,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;;;AAaG;AACI,eAAe,QAAQ,CAA4B,KAAQ,EAAA;IAChE,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;AAC/F,IAAA,OAAO,MAA6B,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;;;AAaG;AACI,eAAe,YAAY,CAChC,KAAQ,EAAA;IAER,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAC/C,KAAK,EACL,KAAK,CAAC,MAAM,EACZ,eAAe,CAAC,UAAU,CAC3B,CAAC;AACF,IAAA,OAAO,MAA6B,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;;;AAaG;AACI,eAAe,UAAU,CAC9B,KAAQ,EAAA;IAER,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;AACjG,IAAA,OAAO,MAA6B,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;;;AAaG;AACI,eAAe,UAAU,CAC9B,KAAQ,EAAA;IAER,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;AACjG,IAAA,OAAO,MAA6B,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;;;AAaG;AACI,eAAe,UAAU,CAC9B,KAAQ,EAAA;IAER,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAC/B,IAAA,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;AACjG,IAAA,OAAO,MAA6B,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;;;AAaG;AACI,eAAe,YAAY,CAAC,KAA2B,EAAA;IAC5D,4BAA4B,CAAC,KAAK,CAAC,CAAC;AACpC,IAAA,OAAOA,cAAgB,CAAC,KAAK,CAAC,CAAC;AACjC;;;;"}
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * @file JavaScript library for declension of Ukrainian anthroponyms
3
3
  * @module shevchenko
4
- * @version 3.0.7
5
- * @author Oleksandr Tolochko <tooleks@gmail.com>
4
+ * @version 3.0.9
5
+ * @author Oleksandr Tolochko <shevchenko-js@tooleks.com>
6
6
  * @license MIT
7
- * @copyright 2017-2023 Oleksandr Tolochko <tooleks@gmail.com>
7
+ * @copyright 2017-2024 Oleksandr Tolochko <shevchenko-js@tooleks.com>
8
8
  * @see {@link git+https://github.com/tooleks/shevchenko-js.git}
9
9
  */
10
10
  class AppendCommandRunner {
@@ -1,13 +1,13 @@
1
1
  /**
2
2
  * @file JavaScript library for declension of Ukrainian anthroponyms
3
3
  * @module shevchenko
4
- * @version 3.0.7
5
- * @author Oleksandr Tolochko <tooleks@gmail.com>
4
+ * @version 3.0.9
5
+ * @author Oleksandr Tolochko <shevchenko-js@tooleks.com>
6
6
  * @license MIT
7
- * @copyright 2017-2023 Oleksandr Tolochko <tooleks@gmail.com>
7
+ * @copyright 2017-2024 Oleksandr Tolochko <shevchenko-js@tooleks.com>
8
8
  * @see {@link git+https://github.com/tooleks/shevchenko-js.git}
9
9
  */
10
- import untypedDeclensionRules from './declension-rules.json.js';
10
+ import untypedDeclensionRules from './rules/artifacts/declension-rules.json.js';
11
11
  import { WordInflector } from './word-inflector.js';
12
12
 
13
13
  const declensionRules = untypedDeclensionRules;
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * @file JavaScript library for declension of Ukrainian anthroponyms
3
3
  * @module shevchenko
4
- * @version 3.0.7
5
- * @author Oleksandr Tolochko <tooleks@gmail.com>
4
+ * @version 3.0.9
5
+ * @author Oleksandr Tolochko <shevchenko-js@tooleks.com>
6
6
  * @license MIT
7
- * @copyright 2017-2023 Oleksandr Tolochko <tooleks@gmail.com>
7
+ * @copyright 2017-2024 Oleksandr Tolochko <shevchenko-js@tooleks.com>
8
8
  * @see {@link git+https://github.com/tooleks/shevchenko-js.git}
9
9
  */
10
10
  import { AppendCommandRunner } from './append-command-runner.js';