typia 7.0.0-dev.20241005 → 7.0.0-dev.20241007

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 (630) hide show
  1. package/lib/IRandomGenerator.d.ts +17 -21
  2. package/lib/factories/ExpressionFactory.js +2 -2
  3. package/lib/factories/ExpressionFactory.js.map +1 -1
  4. package/lib/factories/LiteralFactory.d.ts +1 -1
  5. package/lib/factories/LiteralFactory.js +20 -17
  6. package/lib/factories/LiteralFactory.js.map +1 -1
  7. package/lib/factories/MetadataCommentTagFactory.js +28 -6
  8. package/lib/factories/MetadataCommentTagFactory.js.map +1 -1
  9. package/lib/index.mjs +184 -1437
  10. package/lib/index.mjs.map +1 -1
  11. package/lib/internal/$randomArray.d.ts +1 -1
  12. package/lib/internal/$randomArray.js +1 -0
  13. package/lib/internal/$randomArray.js.map +1 -1
  14. package/lib/internal/$randomBigint.d.ts +1 -1
  15. package/lib/internal/$randomBigint.js +1 -6
  16. package/lib/internal/$randomBigint.js.map +1 -1
  17. package/lib/internal/$randomFormatByte.d.ts +1 -0
  18. package/lib/internal/$randomFormatByte.js +7 -0
  19. package/lib/internal/$randomFormatByte.js.map +1 -0
  20. package/lib/internal/$randomFormatDate.js +1 -0
  21. package/lib/internal/$randomFormatDate.js.map +1 -1
  22. package/lib/internal/$randomFormatDatetime.js +1 -0
  23. package/lib/internal/$randomFormatDatetime.js.map +1 -1
  24. package/lib/internal/$randomFormatDuration.js +1 -0
  25. package/lib/internal/$randomFormatDuration.js.map +1 -1
  26. package/lib/internal/$randomFormatIpv4.js +1 -0
  27. package/lib/internal/$randomFormatIpv4.js.map +1 -1
  28. package/lib/internal/$randomFormatIpv6.js +1 -0
  29. package/lib/internal/$randomFormatIpv6.js.map +1 -1
  30. package/lib/internal/$randomFormatRelativeJsonPointer.js +5 -5
  31. package/lib/internal/$randomFormatRelativeJsonPointer.js.map +1 -1
  32. package/lib/internal/$randomFormatTime.js +2 -1
  33. package/lib/internal/$randomFormatTime.js.map +1 -1
  34. package/lib/internal/$randomFormatUuid.d.ts +1 -0
  35. package/lib/internal/{$randomUuid.js → $randomFormatUuid.js} +4 -4
  36. package/lib/internal/$randomFormatUuid.js.map +1 -0
  37. package/lib/internal/$randomInteger.d.ts +1 -1
  38. package/lib/internal/$randomInteger.js +7 -4
  39. package/lib/internal/$randomInteger.js.map +1 -1
  40. package/lib/internal/$randomNumber.d.ts +1 -1
  41. package/lib/internal/$randomNumber.js +14 -11
  42. package/lib/internal/$randomNumber.js.map +1 -1
  43. package/lib/internal/$randomPick.js +1 -0
  44. package/lib/internal/$randomPick.js.map +1 -1
  45. package/lib/internal/$randomString.d.ts +1 -1
  46. package/lib/internal/$randomString.js +4 -1
  47. package/lib/internal/$randomString.js.map +1 -1
  48. package/lib/llm.d.ts +2 -4
  49. package/lib/llm.js +1 -28
  50. package/lib/llm.js.map +1 -1
  51. package/lib/module.d.ts +4 -8
  52. package/lib/module.js +3 -7
  53. package/lib/module.js.map +1 -1
  54. package/lib/programmers/FeatureProgrammer.js +1 -1
  55. package/lib/programmers/FeatureProgrammer.js.map +1 -1
  56. package/lib/programmers/RandomProgrammer.js +281 -276
  57. package/lib/programmers/RandomProgrammer.js.map +1 -1
  58. package/lib/programmers/helpers/FunctionProgrammer.d.ts +1 -8
  59. package/lib/programmers/helpers/FunctionProgrammer.js +2 -24
  60. package/lib/programmers/helpers/FunctionProgrammer.js.map +1 -1
  61. package/lib/programmers/helpers/RandomJoiner.d.ts +6 -11
  62. package/lib/programmers/helpers/RandomJoiner.js +68 -41
  63. package/lib/programmers/helpers/RandomJoiner.js.map +1 -1
  64. package/lib/programmers/helpers/disable_function_programmer_declare.js +1 -4
  65. package/lib/programmers/helpers/disable_function_programmer_declare.js.map +1 -1
  66. package/lib/transformers/features/json/JsonApplicationTransformer.js +1 -1
  67. package/lib/transformers/features/json/JsonApplicationTransformer.js.map +1 -1
  68. package/lib/transformers/features/llm/LlmApplicationTransformer.js +2 -2
  69. package/lib/transformers/features/llm/LlmApplicationTransformer.js.map +1 -1
  70. package/lib/transformers/features/llm/LlmSchemaTransformer.js +1 -1
  71. package/lib/transformers/features/llm/LlmSchemaTransformer.js.map +1 -1
  72. package/lib/transformers/features/reflect/ReflectMetadataTransformer.js +1 -1
  73. package/lib/transformers/features/reflect/ReflectMetadataTransformer.js.map +1 -1
  74. package/package.json +1 -1
  75. package/src/CamelCase.ts +75 -75
  76. package/src/IRandomGenerator.ts +11 -27
  77. package/src/PascalCase.ts +71 -71
  78. package/src/Primitive.ts +92 -92
  79. package/src/Resolved.ts +74 -74
  80. package/src/SnakeCase.ts +126 -126
  81. package/src/executable/TypiaGenerateWizard.ts +83 -83
  82. package/src/executable/TypiaPatchWizard.ts +42 -42
  83. package/src/executable/TypiaSetupWizard.ts +174 -174
  84. package/src/executable/setup/ArgumentParser.ts +42 -42
  85. package/src/executable/setup/CommandExecutor.ts +8 -8
  86. package/src/executable/setup/FileRetriever.ts +19 -19
  87. package/src/executable/setup/PackageManager.ts +87 -87
  88. package/src/executable/setup/PluginConfigurator.ts +69 -69
  89. package/src/executable/typia.ts +55 -55
  90. package/src/factories/CommentFactory.ts +79 -79
  91. package/src/factories/ExpressionFactory.ts +164 -164
  92. package/src/factories/IdentifierFactory.ts +89 -89
  93. package/src/factories/JsonMetadataFactory.ts +63 -63
  94. package/src/factories/LiteralFactory.ts +18 -15
  95. package/src/factories/MetadataCollection.ts +278 -278
  96. package/src/factories/MetadataCommentTagFactory.ts +650 -622
  97. package/src/factories/MetadataFactory.ts +400 -400
  98. package/src/factories/MetadataTypeTagFactory.ts +385 -385
  99. package/src/factories/MetadataTypeTagSchemaFactory.ts +82 -82
  100. package/src/factories/NumericRangeFactory.ts +72 -72
  101. package/src/factories/ProtobufFactory.ts +275 -275
  102. package/src/factories/StatementFactory.ts +90 -90
  103. package/src/factories/TemplateFactory.ts +64 -64
  104. package/src/factories/TypeFactory.ts +140 -140
  105. package/src/factories/internal/metadata/IMetadataIteratorProps.ts +16 -16
  106. package/src/factories/internal/metadata/emplace_metadata_alias.ts +32 -32
  107. package/src/factories/internal/metadata/emplace_metadata_array_type.ts +39 -39
  108. package/src/factories/internal/metadata/emplace_metadata_object.ts +206 -206
  109. package/src/factories/internal/metadata/emplace_metadata_tuple.ts +56 -56
  110. package/src/factories/internal/metadata/explore_metadata.ts +30 -30
  111. package/src/factories/internal/metadata/iterate_metadata.ts +54 -54
  112. package/src/factories/internal/metadata/iterate_metadata_alias.ts +28 -28
  113. package/src/factories/internal/metadata/iterate_metadata_array.ts +63 -63
  114. package/src/factories/internal/metadata/iterate_metadata_atomic.ts +62 -62
  115. package/src/factories/internal/metadata/iterate_metadata_coalesce.ts +28 -28
  116. package/src/factories/internal/metadata/iterate_metadata_collection.ts +145 -145
  117. package/src/factories/internal/metadata/iterate_metadata_comment_tags.ts +32 -32
  118. package/src/factories/internal/metadata/iterate_metadata_constant.ts +76 -76
  119. package/src/factories/internal/metadata/iterate_metadata_escape.ts +49 -49
  120. package/src/factories/internal/metadata/iterate_metadata_function.ts +88 -88
  121. package/src/factories/internal/metadata/iterate_metadata_intersection.ts +216 -216
  122. package/src/factories/internal/metadata/iterate_metadata_map.ts +52 -52
  123. package/src/factories/internal/metadata/iterate_metadata_native.ts +236 -236
  124. package/src/factories/internal/metadata/iterate_metadata_object.ts +27 -27
  125. package/src/factories/internal/metadata/iterate_metadata_set.ts +39 -39
  126. package/src/factories/internal/metadata/iterate_metadata_sort.ts +83 -83
  127. package/src/factories/internal/metadata/iterate_metadata_template.ts +42 -42
  128. package/src/factories/internal/metadata/iterate_metadata_tuple.ts +26 -26
  129. package/src/factories/internal/metadata/iterate_metadata_union.ts +19 -19
  130. package/src/internal/$accessExpressionAsString.ts +46 -46
  131. package/src/internal/$assertGuard.ts +13 -13
  132. package/src/internal/$functionalTypeGuardErrorFactory.ts +4 -4
  133. package/src/internal/$httpFormDataReadArray.ts +4 -4
  134. package/src/internal/$httpFormDataReadBigint.ts +18 -18
  135. package/src/internal/$httpFormDataReadBlob.ts +10 -10
  136. package/src/internal/$httpFormDataReadBoolean.ts +16 -16
  137. package/src/internal/$httpFormDataReadFile.ts +10 -10
  138. package/src/internal/$httpFormDataReadNumber.ts +15 -15
  139. package/src/internal/$httpFormDataReadString.ts +10 -10
  140. package/src/internal/$httpHeaderReadBigint.ts +10 -10
  141. package/src/internal/$httpHeaderReadBoolean.ts +8 -8
  142. package/src/internal/$httpHeaderReadNumber.ts +7 -7
  143. package/src/internal/$httpParameterBigint.ts +10 -10
  144. package/src/internal/$httpParameterBoolean.ts +8 -8
  145. package/src/internal/$httpParameterNumber.ts +7 -7
  146. package/src/internal/$httpParameterString.ts +2 -2
  147. package/src/internal/$httpQueryParseURLSearchParams.ts +10 -10
  148. package/src/internal/$httpQueryReadArray.ts +4 -4
  149. package/src/internal/$httpQueryReadBigint.ts +12 -12
  150. package/src/internal/$httpQueryReadBoolean.ts +14 -14
  151. package/src/internal/$httpQueryReadNumber.ts +9 -9
  152. package/src/internal/$httpQueryReadString.ts +4 -4
  153. package/src/internal/$isBetween.ts +2 -2
  154. package/src/internal/$isBigintString.ts +8 -8
  155. package/src/internal/$jsonStringifyNumber.ts +12 -12
  156. package/src/internal/$jsonStringifyRest.ts +3 -3
  157. package/src/internal/$jsonStringifyString.ts +43 -43
  158. package/src/internal/$jsonStringifyTail.ts +2 -2
  159. package/src/internal/$llmApplicationFinalize.ts +18 -18
  160. package/src/internal/$miscCloneAny.ts +48 -48
  161. package/src/internal/$notationAny.ts +37 -37
  162. package/src/internal/$notationCamel.ts +13 -13
  163. package/src/internal/$notationPascal.ts +8 -8
  164. package/src/internal/$notationSnake.ts +43 -43
  165. package/src/internal/$randomArray.ts +21 -20
  166. package/src/internal/$randomBigint.ts +6 -15
  167. package/src/internal/$randomBoolean.ts +1 -1
  168. package/src/internal/{$randomByte.ts → $randomFormatByte.ts} +3 -3
  169. package/src/internal/$randomFormatDate.ts +18 -17
  170. package/src/internal/$randomFormatDatetime.ts +16 -15
  171. package/src/internal/$randomFormatDuration.ts +27 -26
  172. package/src/internal/$randomFormatEmail.ts +11 -11
  173. package/src/internal/$randomFormatHostname.ts +6 -6
  174. package/src/internal/$randomFormatIdnEmail.ts +3 -3
  175. package/src/internal/$randomFormatIdnHostname.ts +3 -3
  176. package/src/internal/$randomFormatIpv4.ts +11 -10
  177. package/src/internal/$randomFormatIpv6.ts +11 -10
  178. package/src/internal/$randomFormatIri.ts +3 -3
  179. package/src/internal/$randomFormatIriReference.ts +3 -3
  180. package/src/internal/$randomFormatJsonPointer.ts +7 -7
  181. package/src/internal/$randomFormatPassword.ts +8 -8
  182. package/src/internal/$randomFormatRegex.ts +4 -4
  183. package/src/internal/$randomFormatRelativeJsonPointer.ts +8 -8
  184. package/src/internal/$randomFormatTime.ts +14 -13
  185. package/src/internal/$randomFormatUri.ts +3 -3
  186. package/src/internal/$randomFormatUriReference.ts +3 -3
  187. package/src/internal/$randomFormatUriTemplate.ts +3 -3
  188. package/src/internal/$randomFormatUrl.ts +11 -11
  189. package/src/internal/{$randomUuid.ts → $randomFormatUuid.ts} +6 -6
  190. package/src/internal/$randomInteger.ts +47 -44
  191. package/src/internal/$randomNumber.ts +74 -71
  192. package/src/internal/$randomPattern.ts +10 -10
  193. package/src/internal/$randomPick.ts +9 -8
  194. package/src/internal/$randomString.ts +24 -24
  195. package/src/internal/$throwTypeGuardError.ts +5 -5
  196. package/src/internal/$validateReport.ts +13 -13
  197. package/src/internal/private/$__notationCapitalize.ts +2 -2
  198. package/src/internal/private/$__notationUnsnake.ts +24 -24
  199. package/src/json.ts +651 -651
  200. package/src/llm.ts +178 -186
  201. package/src/module.ts +933 -945
  202. package/src/programmers/AssertProgrammer.ts +456 -456
  203. package/src/programmers/CheckerProgrammer.ts +1610 -1610
  204. package/src/programmers/FeatureProgrammer.ts +616 -616
  205. package/src/programmers/ImportProgrammer.ts +109 -109
  206. package/src/programmers/IsProgrammer.ts +273 -273
  207. package/src/programmers/RandomProgrammer.ts +393 -381
  208. package/src/programmers/TypiaProgrammer.ts +171 -171
  209. package/src/programmers/ValidateProgrammer.ts +430 -430
  210. package/src/programmers/functional/FunctionalAssertFunctionProgrammer.ts +153 -153
  211. package/src/programmers/functional/FunctionalAssertParametersProgrammer.ts +125 -125
  212. package/src/programmers/functional/FunctionalAssertReturnProgrammer.ts +115 -115
  213. package/src/programmers/functional/FunctionalIsFunctionProgrammer.ts +72 -72
  214. package/src/programmers/functional/FunctionalIsParametersProgrammer.ts +113 -113
  215. package/src/programmers/functional/FunctionalIsReturnProgrammer.ts +116 -116
  216. package/src/programmers/functional/FunctionalValidateFunctionProgrammer.ts +123 -123
  217. package/src/programmers/functional/FunctionalValidateParametersProgrammer.ts +281 -281
  218. package/src/programmers/functional/FunctionalValidateReturnProgrammer.ts +134 -134
  219. package/src/programmers/functional/internal/FunctionalGeneralProgrammer.ts +34 -34
  220. package/src/programmers/helpers/AtomicPredicator.ts +35 -35
  221. package/src/programmers/helpers/CloneJoiner.ts +143 -143
  222. package/src/programmers/helpers/FunctionProgrammer.ts +67 -101
  223. package/src/programmers/helpers/HttpMetadataUtil.ts +21 -21
  224. package/src/programmers/helpers/NotationJoiner.ts +144 -144
  225. package/src/programmers/helpers/ProtobufUtil.ts +125 -125
  226. package/src/programmers/helpers/PruneJoiner.ts +148 -148
  227. package/src/programmers/helpers/RandomJoiner.ts +168 -162
  228. package/src/programmers/helpers/StringifyJoinder.ts +115 -115
  229. package/src/programmers/helpers/StringifyPredicator.ts +13 -13
  230. package/src/programmers/helpers/UnionExplorer.ts +372 -372
  231. package/src/programmers/helpers/UnionPredicator.ts +77 -77
  232. package/src/programmers/helpers/disable_function_programmer_declare.ts +1 -4
  233. package/src/programmers/http/HttpAssertFormDataProgrammer.ts +96 -96
  234. package/src/programmers/http/HttpAssertHeadersProgrammer.ts +96 -96
  235. package/src/programmers/http/HttpAssertQueryProgrammer.ts +102 -102
  236. package/src/programmers/http/HttpFormDataProgrammer.ts +308 -308
  237. package/src/programmers/http/HttpHeadersProgrammer.ts +404 -404
  238. package/src/programmers/http/HttpIsFormDataProgrammer.ts +108 -108
  239. package/src/programmers/http/HttpIsHeadersProgrammer.ts +108 -108
  240. package/src/programmers/http/HttpIsQueryProgrammer.ts +114 -114
  241. package/src/programmers/http/HttpParameterProgrammer.ts +115 -115
  242. package/src/programmers/http/HttpQueryProgrammer.ts +333 -333
  243. package/src/programmers/http/HttpValidateFormDataProgrammer.ts +90 -90
  244. package/src/programmers/http/HttpValidateHeadersProgrammer.ts +90 -90
  245. package/src/programmers/http/HttpValidateQueryProgrammer.ts +96 -96
  246. package/src/programmers/internal/application_array.ts +56 -56
  247. package/src/programmers/internal/application_bigint.ts +25 -25
  248. package/src/programmers/internal/application_boolean.ts +25 -25
  249. package/src/programmers/internal/application_description.ts +12 -12
  250. package/src/programmers/internal/application_escaped.ts +96 -96
  251. package/src/programmers/internal/application_number.ts +25 -25
  252. package/src/programmers/internal/application_plugin.ts +19 -19
  253. package/src/programmers/internal/application_string.ts +25 -25
  254. package/src/programmers/internal/application_templates.ts +64 -64
  255. package/src/programmers/internal/application_title.ts +20 -20
  256. package/src/programmers/internal/application_union_discriminator.ts +35 -35
  257. package/src/programmers/internal/application_v30_alias.ts +59 -59
  258. package/src/programmers/internal/application_v30_native.ts +29 -29
  259. package/src/programmers/internal/application_v30_object.ts +165 -165
  260. package/src/programmers/internal/application_v30_schema.ts +220 -220
  261. package/src/programmers/internal/application_v30_tuple.ts +33 -33
  262. package/src/programmers/internal/application_v31_alias.ts +47 -47
  263. package/src/programmers/internal/application_v31_constant.ts +29 -29
  264. package/src/programmers/internal/application_v31_native.ts +25 -25
  265. package/src/programmers/internal/application_v31_object.ts +147 -147
  266. package/src/programmers/internal/application_v31_schema.ts +215 -215
  267. package/src/programmers/internal/application_v31_tuple.ts +22 -22
  268. package/src/programmers/internal/check_array_length.ts +46 -46
  269. package/src/programmers/internal/check_bigint.ts +49 -49
  270. package/src/programmers/internal/check_dynamic_key.ts +201 -201
  271. package/src/programmers/internal/check_dynamic_properties.ts +208 -208
  272. package/src/programmers/internal/check_everything.ts +23 -23
  273. package/src/programmers/internal/check_native.ts +27 -27
  274. package/src/programmers/internal/check_number.ts +111 -111
  275. package/src/programmers/internal/check_object.ts +75 -75
  276. package/src/programmers/internal/check_string.ts +49 -49
  277. package/src/programmers/internal/check_template.ts +48 -48
  278. package/src/programmers/internal/check_union_array_like.ts +334 -334
  279. package/src/programmers/internal/decode_union_object.ts +116 -116
  280. package/src/programmers/internal/feature_object_entries.ts +61 -61
  281. package/src/programmers/internal/llm_schema_array.ts +22 -22
  282. package/src/programmers/internal/llm_schema_escaped.ts +84 -84
  283. package/src/programmers/internal/llm_schema_native.ts +17 -17
  284. package/src/programmers/internal/llm_schema_object.ts +132 -132
  285. package/src/programmers/internal/llm_schema_station.ts +190 -190
  286. package/src/programmers/internal/llm_schema_tuple.ts +31 -31
  287. package/src/programmers/internal/metadata_to_pattern.ts +42 -42
  288. package/src/programmers/internal/postfix_of_tuple.ts +5 -5
  289. package/src/programmers/internal/prune_object_properties.ts +63 -63
  290. package/src/programmers/internal/stringify_dynamic_properties.ts +162 -162
  291. package/src/programmers/internal/stringify_regular_properties.ts +81 -81
  292. package/src/programmers/internal/template_to_pattern.ts +23 -23
  293. package/src/programmers/internal/wrap_metadata_rest_tuple.ts +23 -23
  294. package/src/programmers/json/JsonApplicationProgrammer.ts +92 -92
  295. package/src/programmers/json/JsonAssertParseProgrammer.ts +104 -104
  296. package/src/programmers/json/JsonAssertStringifyProgrammer.ts +112 -112
  297. package/src/programmers/json/JsonIsParseProgrammer.ts +118 -118
  298. package/src/programmers/json/JsonIsStringifyProgrammer.ts +108 -108
  299. package/src/programmers/json/JsonStringifyProgrammer.ts +1124 -1124
  300. package/src/programmers/json/JsonValidateParseProgrammer.ts +95 -95
  301. package/src/programmers/json/JsonValidateStringifyProgrammer.ts +119 -119
  302. package/src/programmers/llm/LlmApplicationProgrammer.ts +235 -235
  303. package/src/programmers/llm/LlmSchemaProgrammer.ts +51 -51
  304. package/src/programmers/misc/MiscAssertCloneProgrammer.ts +92 -92
  305. package/src/programmers/misc/MiscAssertPruneProgrammer.ts +113 -113
  306. package/src/programmers/misc/MiscCloneProgrammer.ts +1029 -1029
  307. package/src/programmers/misc/MiscIsCloneProgrammer.ts +99 -99
  308. package/src/programmers/misc/MiscIsPruneProgrammer.ts +97 -97
  309. package/src/programmers/misc/MiscLiteralsProgrammer.ts +80 -80
  310. package/src/programmers/misc/MiscPruneProgrammer.ts +725 -725
  311. package/src/programmers/misc/MiscValidateCloneProgrammer.ts +109 -109
  312. package/src/programmers/misc/MiscValidatePruneProgrammer.ts +109 -109
  313. package/src/programmers/notations/NotationAssertGeneralProgrammer.ts +98 -98
  314. package/src/programmers/notations/NotationGeneralProgrammer.ts +973 -973
  315. package/src/programmers/notations/NotationIsGeneralProgrammer.ts +105 -105
  316. package/src/programmers/notations/NotationValidateGeneralProgrammer.ts +117 -117
  317. package/src/programmers/protobuf/ProtobufAssertDecodeProgrammer.ts +95 -95
  318. package/src/programmers/protobuf/ProtobufAssertEncodeProgrammer.ts +99 -99
  319. package/src/programmers/protobuf/ProtobufDecodeProgrammer.ts +711 -711
  320. package/src/programmers/protobuf/ProtobufEncodeProgrammer.ts +1019 -1019
  321. package/src/programmers/protobuf/ProtobufIsDecodeProgrammer.ts +109 -109
  322. package/src/programmers/protobuf/ProtobufIsEncodeProgrammer.ts +98 -98
  323. package/src/programmers/protobuf/ProtobufMessageProgrammer.ts +201 -201
  324. package/src/programmers/protobuf/ProtobufValidateDecodeProgrammer.ts +90 -90
  325. package/src/programmers/protobuf/ProtobufValidateEncodeProgrammer.ts +114 -114
  326. package/src/protobuf.ts +868 -868
  327. package/src/schemas/json/IJsonApplication.ts +22 -22
  328. package/src/schemas/metadata/IMetadata.ts +36 -36
  329. package/src/schemas/metadata/IMetadataConstantValue.ts +11 -11
  330. package/src/schemas/metadata/IMetadataFunction.ts +8 -8
  331. package/src/schemas/metadata/IMetadataParameter.ts +9 -9
  332. package/src/schemas/metadata/IMetadataTemplate.ts +7 -7
  333. package/src/schemas/metadata/Metadata.ts +616 -616
  334. package/src/schemas/metadata/MetadataAtomic.ts +87 -87
  335. package/src/schemas/metadata/MetadataConstantValue.ts +62 -62
  336. package/src/schemas/metadata/MetadataFunction.ts +49 -49
  337. package/src/schemas/metadata/MetadataObject.ts +139 -139
  338. package/src/schemas/metadata/MetadataParameter.ts +50 -50
  339. package/src/tags/Constant.ts +15 -15
  340. package/src/tags/Default.ts +22 -22
  341. package/src/tags/Example.ts +17 -17
  342. package/src/tags/Examples.ts +16 -16
  343. package/src/tags/ExclusiveMaximum.ts +25 -25
  344. package/src/tags/ExclusiveMinimum.ts +25 -25
  345. package/src/tags/JsonSchemaPlugin.ts +8 -8
  346. package/src/tags/Maximum.ts +19 -19
  347. package/src/tags/Minimum.ts +19 -19
  348. package/src/tags/MultipleOf.ts +21 -21
  349. package/src/tags/Pattern.ts +31 -31
  350. package/src/tags/Type.ts +32 -32
  351. package/src/tags/index.ts +20 -20
  352. package/src/transform.ts +35 -35
  353. package/src/transformers/CallExpressionTransformer.ts +540 -540
  354. package/src/transformers/FileTransformer.ts +120 -120
  355. package/src/transformers/IProgrammerProps.ts +11 -11
  356. package/src/transformers/ITransformProps.ts +9 -9
  357. package/src/transformers/ITypiaContext.ts +18 -18
  358. package/src/transformers/NodeTransformer.ts +17 -17
  359. package/src/transformers/TransformerError.ts +59 -59
  360. package/src/transformers/features/AssertTransformer.ts +24 -24
  361. package/src/transformers/features/CreateAssertTransformer.ts +24 -24
  362. package/src/transformers/features/CreateIsTransformer.ts +18 -18
  363. package/src/transformers/features/CreateRandomTransformer.ts +43 -43
  364. package/src/transformers/features/CreateValidateTransformer.ts +18 -18
  365. package/src/transformers/features/IsTransformer.ts +18 -18
  366. package/src/transformers/features/RandomTransformer.ts +41 -41
  367. package/src/transformers/features/ValidateTransformer.ts +18 -18
  368. package/src/transformers/features/functional/FunctionalGenericTransformer.ts +57 -57
  369. package/src/transformers/features/http/CreateHttpAssertFormDataTransformer.ts +13 -13
  370. package/src/transformers/features/http/CreateHttpAssertHeadersTransformer.ts +13 -13
  371. package/src/transformers/features/http/CreateHttpAssertQueryTransformer.ts +13 -13
  372. package/src/transformers/features/http/CreateHttpFormDataTransformer.ts +13 -13
  373. package/src/transformers/features/http/CreateHttpHeadersTransformer.ts +13 -13
  374. package/src/transformers/features/http/CreateHttpIsFormDataTransformer.ts +13 -13
  375. package/src/transformers/features/http/CreateHttpIsHeadersTransformer.ts +13 -13
  376. package/src/transformers/features/http/CreateHttpIsQueryTransformer.ts +13 -13
  377. package/src/transformers/features/http/CreateHttpParameterTransformer.ts +13 -13
  378. package/src/transformers/features/http/CreateHttpQueryTransformer.ts +13 -13
  379. package/src/transformers/features/http/CreateHttpValidateFormDataTransformer.ts +13 -13
  380. package/src/transformers/features/http/CreateHttpValidateHeadersTransformer.ts +13 -13
  381. package/src/transformers/features/http/CreateHttpValidateQueryTransformer.ts +13 -13
  382. package/src/transformers/features/http/HttpAssertFormDataTransformer.ts +13 -13
  383. package/src/transformers/features/http/HttpAssertHeadersTransformer.ts +13 -13
  384. package/src/transformers/features/http/HttpAssertQueryTransformer.ts +13 -13
  385. package/src/transformers/features/http/HttpFormDataTransformer.ts +13 -13
  386. package/src/transformers/features/http/HttpHeadersTransformer.ts +13 -13
  387. package/src/transformers/features/http/HttpIsFormDataTransformer.ts +13 -13
  388. package/src/transformers/features/http/HttpIsHeadersTransformer.ts +13 -13
  389. package/src/transformers/features/http/HttpIsQueryTransformer.ts +13 -13
  390. package/src/transformers/features/http/HttpParameterTransformer.ts +13 -13
  391. package/src/transformers/features/http/HttpQueryTransformer.ts +13 -13
  392. package/src/transformers/features/http/HttpValidateFormDataTransformer.ts +13 -13
  393. package/src/transformers/features/http/HttpValidateHeadersTransformer.ts +13 -13
  394. package/src/transformers/features/http/HttpValidateQueryTransformer.ts +13 -13
  395. package/src/transformers/features/json/JsonApplicationTransformer.ts +130 -130
  396. package/src/transformers/features/json/JsonAssertParseTransformer.ts +13 -13
  397. package/src/transformers/features/json/JsonAssertStringifyTransformer.ts +13 -13
  398. package/src/transformers/features/json/JsonCreateAssertParseTransformer.ts +13 -13
  399. package/src/transformers/features/json/JsonCreateAssertStringifyTransformer.ts +13 -13
  400. package/src/transformers/features/json/JsonCreateIsParseTransformer.ts +13 -13
  401. package/src/transformers/features/json/JsonCreateIsStringifyTransformer.ts +13 -13
  402. package/src/transformers/features/json/JsonCreateStringifyTransformer.ts +13 -13
  403. package/src/transformers/features/json/JsonCreateValidateParseTransformer.ts +13 -13
  404. package/src/transformers/features/json/JsonCreateValidateStringifyProgrammer.ts +13 -13
  405. package/src/transformers/features/json/JsonIsParseTransformer.ts +13 -13
  406. package/src/transformers/features/json/JsonIsStringifyTransformer.ts +13 -13
  407. package/src/transformers/features/json/JsonStringifyTransformer.ts +13 -13
  408. package/src/transformers/features/json/JsonValidateParseTransformer.ts +13 -13
  409. package/src/transformers/features/json/JsonValidateStringifyTransformer.ts +13 -13
  410. package/src/transformers/features/llm/LlmApplicationTransformer.ts +86 -86
  411. package/src/transformers/features/llm/LlmSchemaTransformer.ts +59 -59
  412. package/src/transformers/features/misc/MiscAssertCloneTransformer.ts +13 -13
  413. package/src/transformers/features/misc/MiscAssertPruneTransformer.ts +13 -13
  414. package/src/transformers/features/misc/MiscCloneTransformer.ts +13 -13
  415. package/src/transformers/features/misc/MiscCreateAssertCloneTransformer.ts +13 -13
  416. package/src/transformers/features/misc/MiscCreateAssertPruneTransformer.ts +13 -13
  417. package/src/transformers/features/misc/MiscCreateCloneTransformer.ts +13 -13
  418. package/src/transformers/features/misc/MiscCreateIsCloneTransformer.ts +13 -13
  419. package/src/transformers/features/misc/MiscCreateIsPruneTransformer.ts +13 -13
  420. package/src/transformers/features/misc/MiscCreatePruneTransformer.ts +13 -13
  421. package/src/transformers/features/misc/MiscCreateValidateCloneTransformer.ts +13 -13
  422. package/src/transformers/features/misc/MiscCreateValidatePruneTransformer.ts +13 -13
  423. package/src/transformers/features/misc/MiscIsCloneTransformer.ts +13 -13
  424. package/src/transformers/features/misc/MiscIsPruneTransformer.ts +13 -13
  425. package/src/transformers/features/misc/MiscLiteralsTransformer.ts +35 -35
  426. package/src/transformers/features/misc/MiscPruneTransformer.ts +13 -13
  427. package/src/transformers/features/misc/MiscValidateCloneTransformer.ts +13 -13
  428. package/src/transformers/features/misc/MiscValidatePruneTransformer.ts +13 -13
  429. package/src/transformers/features/notations/NotationAssertGeneralTransformer.ts +20 -20
  430. package/src/transformers/features/notations/NotationCreateAssertGeneralTransformer.ts +20 -20
  431. package/src/transformers/features/notations/NotationCreateGeneralTransformer.ts +20 -20
  432. package/src/transformers/features/notations/NotationCreateIsGeneralTransformer.ts +20 -20
  433. package/src/transformers/features/notations/NotationCreateValidateGeneralTransformer.ts +20 -20
  434. package/src/transformers/features/notations/NotationGeneralTransformer.ts +18 -18
  435. package/src/transformers/features/notations/NotationIsGeneralTransformer.ts +20 -20
  436. package/src/transformers/features/notations/NotationValidateGeneralTransformer.ts +20 -20
  437. package/src/transformers/features/protobuf/ProtobufAssertDecodeTransformer.ts +13 -13
  438. package/src/transformers/features/protobuf/ProtobufAssertEncodeTransformer.ts +13 -13
  439. package/src/transformers/features/protobuf/ProtobufCreateAssertDecodeTransformer.ts +13 -13
  440. package/src/transformers/features/protobuf/ProtobufCreateAssertEncodeTransformer.ts +13 -13
  441. package/src/transformers/features/protobuf/ProtobufCreateDecodeTransformer.ts +13 -13
  442. package/src/transformers/features/protobuf/ProtobufCreateEncodeTransformer.ts +13 -13
  443. package/src/transformers/features/protobuf/ProtobufCreateIsDecodeTransformer.ts +13 -13
  444. package/src/transformers/features/protobuf/ProtobufCreateIsEncodeTransformer.ts +13 -13
  445. package/src/transformers/features/protobuf/ProtobufCreateValidateDecodeTransformer.ts +13 -13
  446. package/src/transformers/features/protobuf/ProtobufCreateValidateEncodeTransformer.ts +13 -13
  447. package/src/transformers/features/protobuf/ProtobufDecodeTransformer.ts +13 -13
  448. package/src/transformers/features/protobuf/ProtobufEncodeTransformer.ts +13 -13
  449. package/src/transformers/features/protobuf/ProtobufIsDecodeTransformer.ts +13 -13
  450. package/src/transformers/features/protobuf/ProtobufIsEncodeTransformer.ts +13 -13
  451. package/src/transformers/features/protobuf/ProtobufMessageTransformer.ts +35 -35
  452. package/src/transformers/features/protobuf/ProtobufValidateDecodeTransformer.ts +13 -13
  453. package/src/transformers/features/protobuf/ProtobufValidateEncodeTransformer.ts +13 -13
  454. package/src/transformers/features/reflect/ReflectMetadataTransformer.ts +69 -69
  455. package/src/transformers/features/reflect/ReflectNameTransformer.ts +82 -82
  456. package/src/transformers/internal/GenericTransformer.ts +101 -101
  457. package/src/typings/Equal.ts +18 -18
  458. package/src/typings/IsTuple.ts +9 -9
  459. package/src/typings/NativeClass.ts +23 -23
  460. package/src/typings/ValueOf.ts +20 -20
  461. package/src/utils/Escaper.ts +50 -50
  462. package/src/utils/MapUtil.ts +14 -14
  463. package/src/utils/NameEncoder.ts +32 -32
  464. package/src/utils/NamingConvention.ts +94 -94
  465. package/src/utils/StringUtil.ts +16 -16
  466. package/lib/functional/$FormDataReader/$FormDataReader.d.ts +0 -7
  467. package/lib/functional/$FormDataReader/$FormDataReader.js +0 -86
  468. package/lib/functional/$FormDataReader/$FormDataReader.js.map +0 -1
  469. package/lib/functional/$FormDataReader/index.d.ts +0 -1
  470. package/lib/functional/$FormDataReader/index.js +0 -28
  471. package/lib/functional/$FormDataReader/index.js.map +0 -1
  472. package/lib/functional/$HeadersReader/$HeadersReader.d.ts +0 -4
  473. package/lib/functional/$HeadersReader/$HeadersReader.js +0 -36
  474. package/lib/functional/$HeadersReader/$HeadersReader.js.map +0 -1
  475. package/lib/functional/$HeadersReader/index.d.ts +0 -1
  476. package/lib/functional/$HeadersReader/index.js +0 -28
  477. package/lib/functional/$HeadersReader/index.js.map +0 -1
  478. package/lib/functional/$ParameterReader/$ParameterReader.d.ts +0 -4
  479. package/lib/functional/$ParameterReader/$ParameterReader.js +0 -36
  480. package/lib/functional/$ParameterReader/$ParameterReader.js.map +0 -1
  481. package/lib/functional/$ParameterReader/index.d.ts +0 -1
  482. package/lib/functional/$ParameterReader/index.js +0 -28
  483. package/lib/functional/$ParameterReader/index.js.map +0 -1
  484. package/lib/functional/$ProtobufReader.d.ts +0 -35
  485. package/lib/functional/$ProtobufReader.js +0 -166
  486. package/lib/functional/$ProtobufReader.js.map +0 -1
  487. package/lib/functional/$ProtobufSizer.d.ts +0 -36
  488. package/lib/functional/$ProtobufSizer.js +0 -118
  489. package/lib/functional/$ProtobufSizer.js.map +0 -1
  490. package/lib/functional/$ProtobufWriter.d.ts +0 -45
  491. package/lib/functional/$ProtobufWriter.js +0 -104
  492. package/lib/functional/$ProtobufWriter.js.map +0 -1
  493. package/lib/functional/$QueryReader/$QueryReader.d.ts +0 -6
  494. package/lib/functional/$QueryReader/$QueryReader.js +0 -55
  495. package/lib/functional/$QueryReader/$QueryReader.js.map +0 -1
  496. package/lib/functional/$QueryReader/index.d.ts +0 -1
  497. package/lib/functional/$QueryReader/index.js +0 -28
  498. package/lib/functional/$QueryReader/index.js.map +0 -1
  499. package/lib/functional/$any.d.ts +0 -1
  500. package/lib/functional/$any.js +0 -7
  501. package/lib/functional/$any.js.map +0 -1
  502. package/lib/functional/$clone.d.ts +0 -2
  503. package/lib/functional/$clone.js +0 -100
  504. package/lib/functional/$clone.js.map +0 -1
  505. package/lib/functional/$convention.d.ts +0 -1
  506. package/lib/functional/$convention.js +0 -60
  507. package/lib/functional/$convention.js.map +0 -1
  508. package/lib/functional/$dictionary.d.ts +0 -2
  509. package/lib/functional/$dictionary.js +0 -18
  510. package/lib/functional/$dictionary.js.map +0 -1
  511. package/lib/functional/$guard.d.ts +0 -1
  512. package/lib/functional/$guard.js +0 -21
  513. package/lib/functional/$guard.js.map +0 -1
  514. package/lib/functional/$is_between.d.ts +0 -1
  515. package/lib/functional/$is_between.js +0 -8
  516. package/lib/functional/$is_between.js.map +0 -1
  517. package/lib/functional/$join.d.ts +0 -1
  518. package/lib/functional/$join.js +0 -50
  519. package/lib/functional/$join.js.map +0 -1
  520. package/lib/functional/$number.d.ts +0 -1
  521. package/lib/functional/$number.js +0 -16
  522. package/lib/functional/$number.js.map +0 -1
  523. package/lib/functional/$report.d.ts +0 -2
  524. package/lib/functional/$report.js +0 -18
  525. package/lib/functional/$report.js.map +0 -1
  526. package/lib/functional/$rest.d.ts +0 -1
  527. package/lib/functional/$rest.js +0 -8
  528. package/lib/functional/$rest.js.map +0 -1
  529. package/lib/functional/$stoll.d.ts +0 -1
  530. package/lib/functional/$stoll.js +0 -14
  531. package/lib/functional/$stoll.js.map +0 -1
  532. package/lib/functional/$string.d.ts +0 -1
  533. package/lib/functional/$string.js +0 -43
  534. package/lib/functional/$string.js.map +0 -1
  535. package/lib/functional/$strlen.d.ts +0 -1
  536. package/lib/functional/$strlen.js +0 -13
  537. package/lib/functional/$strlen.js.map +0 -1
  538. package/lib/functional/$tail.d.ts +0 -1
  539. package/lib/functional/$tail.js +0 -11
  540. package/lib/functional/$tail.js.map +0 -1
  541. package/lib/functional/$throws.d.ts +0 -2
  542. package/lib/functional/$throws.js +0 -22
  543. package/lib/functional/$throws.js.map +0 -1
  544. package/lib/functional/IProtobufWriter.d.ts +0 -15
  545. package/lib/functional/IProtobufWriter.js +0 -3
  546. package/lib/functional/IProtobufWriter.js.map +0 -1
  547. package/lib/functional/Namespace/functional.d.ts +0 -4
  548. package/lib/functional/Namespace/functional.js +0 -9
  549. package/lib/functional/Namespace/functional.js.map +0 -1
  550. package/lib/functional/Namespace/http.d.ts +0 -8
  551. package/lib/functional/Namespace/http.js +0 -16
  552. package/lib/functional/Namespace/http.js.map +0 -1
  553. package/lib/functional/Namespace/index.d.ts +0 -30
  554. package/lib/functional/Namespace/index.js +0 -85
  555. package/lib/functional/Namespace/index.js.map +0 -1
  556. package/lib/functional/Namespace/json.d.ts +0 -9
  557. package/lib/functional/Namespace/json.js +0 -23
  558. package/lib/functional/Namespace/json.js.map +0 -1
  559. package/lib/functional/Namespace/llm.d.ts +0 -4
  560. package/lib/functional/Namespace/llm.js +0 -44
  561. package/lib/functional/Namespace/llm.js.map +0 -1
  562. package/lib/functional/Namespace/misc.d.ts +0 -11
  563. package/lib/functional/Namespace/misc.js +0 -22
  564. package/lib/functional/Namespace/misc.js.map +0 -1
  565. package/lib/functional/Namespace/notations.d.ts +0 -18
  566. package/lib/functional/Namespace/notations.js +0 -26
  567. package/lib/functional/Namespace/notations.js.map +0 -1
  568. package/lib/functional/Namespace/protobuf.d.ts +0 -17
  569. package/lib/functional/Namespace/protobuf.js +0 -25
  570. package/lib/functional/Namespace/protobuf.js.map +0 -1
  571. package/lib/functional/is.d.ts +0 -1
  572. package/lib/functional/is.js +0 -14
  573. package/lib/functional/is.js.map +0 -1
  574. package/lib/internal/$randomByte.d.ts +0 -1
  575. package/lib/internal/$randomByte.js +0 -7
  576. package/lib/internal/$randomByte.js.map +0 -1
  577. package/lib/internal/$randomUuid.d.ts +0 -1
  578. package/lib/internal/$randomUuid.js.map +0 -1
  579. package/lib/programmers/helpers/RandomRanger.d.ts +0 -33
  580. package/lib/programmers/helpers/RandomRanger.js +0 -158
  581. package/lib/programmers/helpers/RandomRanger.js.map +0 -1
  582. package/lib/programmers/internal/random_custom.d.ts +0 -1
  583. package/lib/programmers/internal/random_custom.js +0 -23
  584. package/lib/programmers/internal/random_custom.js.map +0 -1
  585. package/lib/utils/RandomGenerator/RandomGenerator.d.ts +0 -31
  586. package/lib/utils/RandomGenerator/RandomGenerator.js +0 -176
  587. package/lib/utils/RandomGenerator/RandomGenerator.js.map +0 -1
  588. package/lib/utils/RandomGenerator/index.d.ts +0 -1
  589. package/lib/utils/RandomGenerator/index.js +0 -28
  590. package/lib/utils/RandomGenerator/index.js.map +0 -1
  591. package/src/functional/$FormDataReader/$FormDataReader.ts +0 -83
  592. package/src/functional/$FormDataReader/index.ts +0 -1
  593. package/src/functional/$HeadersReader/$HeadersReader.ts +0 -26
  594. package/src/functional/$HeadersReader/index.ts +0 -1
  595. package/src/functional/$ParameterReader/$ParameterReader.ts +0 -29
  596. package/src/functional/$ParameterReader/index.ts +0 -1
  597. package/src/functional/$ProtobufReader.ts +0 -194
  598. package/src/functional/$ProtobufSizer.ts +0 -144
  599. package/src/functional/$ProtobufWriter.ts +0 -145
  600. package/src/functional/$QueryReader/$QueryReader.ts +0 -46
  601. package/src/functional/$QueryReader/index.ts +0 -1
  602. package/src/functional/$any.ts +0 -3
  603. package/src/functional/$clone.ts +0 -48
  604. package/src/functional/$convention.ts +0 -37
  605. package/src/functional/$dictionary.ts +0 -22
  606. package/src/functional/$guard.ts +0 -21
  607. package/src/functional/$is_between.ts +0 -2
  608. package/src/functional/$join.ts +0 -46
  609. package/src/functional/$number.ts +0 -12
  610. package/src/functional/$report.ts +0 -13
  611. package/src/functional/$rest.ts +0 -3
  612. package/src/functional/$stoll.ts +0 -8
  613. package/src/functional/$string.ts +0 -43
  614. package/src/functional/$strlen.ts +0 -7
  615. package/src/functional/$tail.ts +0 -5
  616. package/src/functional/$throws.ts +0 -10
  617. package/src/functional/IProtobufWriter.ts +0 -18
  618. package/src/functional/Namespace/functional.ts +0 -5
  619. package/src/functional/Namespace/http.ts +0 -9
  620. package/src/functional/Namespace/index.ts +0 -75
  621. package/src/functional/Namespace/json.ts +0 -15
  622. package/src/functional/Namespace/llm.ts +0 -20
  623. package/src/functional/Namespace/misc.ts +0 -14
  624. package/src/functional/Namespace/notations.ts +0 -23
  625. package/src/functional/Namespace/protobuf.ts +0 -20
  626. package/src/functional/is.ts +0 -10
  627. package/src/programmers/helpers/RandomRanger.ts +0 -225
  628. package/src/programmers/internal/random_custom.ts +0 -39
  629. package/src/utils/RandomGenerator/RandomGenerator.ts +0 -119
  630. package/src/utils/RandomGenerator/index.ts +0 -1
package/src/protobuf.ts CHANGED
@@ -1,868 +1,868 @@
1
- import { IValidation } from "./IValidation";
2
- import { Resolved } from "./Resolved";
3
- import { TypeGuardError } from "./TypeGuardError";
4
-
5
- /* ===========================================================
6
- PROTOCOL BUFFER
7
- - MESSAGE
8
- - DECODE
9
- - ENCODE
10
- - FACTORY FUNCTIONS
11
- ==============================================================
12
- SCHEMA
13
- ----------------------------------------------------------- */
14
- /**
15
- * > You must configure the generic argument `T`.
16
- *
17
- * Protocol Buffer Message Schema.
18
- *
19
- * Creates a Protocol Buffer Message Schema from a TypeScript type. The message
20
- * schema would be returned as a string value, and it can be used to share with
21
- * other developers/languages/frameworks.
22
- *
23
- * For reference, Protocol Buffer has lots of restrictions, so that expression power
24
- * of Protocol Buffer is not enough strong to fully meet the TypeScript type specs.
25
- * In such reason, if you put a TypeScript type that is not compatible with Protocol
26
- * Buffer, this function would throw compilation errors.
27
- *
28
- * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
29
- *
30
- * @template T Target type
31
- * @returns Protocol Buffer Message Schema.
32
- *
33
- * @author Jeongho Nam - https://github.com/samchon
34
- */
35
- export function message(): never;
36
-
37
- /**
38
- * Protocol Buffer Message Schema.
39
- *
40
- * Creates a Protocol Buffer Message Schema from a TypeScript type. The message
41
- * schema would be returned as a string value, and it can be used to share with
42
- * other developers/languages/frameworks.
43
- *
44
- * For reference, Protocol Buffer has lots of restrictions, so that expression power
45
- * of Protocol Buffer is not enough strong to fully meet the TypeScript type specs.
46
- * In such reason, if you put a TypeScript type that is not compatible with Protocol
47
- * Buffer, this function would throw compilation errors.
48
- *
49
- * @template T Target type
50
- * @returns Protocol Buffer Message Schema.
51
- *
52
- * @author Jeongho Nam - https://github.com/samchon
53
- */
54
- export function message<T>(): string;
55
-
56
- /**
57
- * @internal
58
- */
59
- export function message(): never {
60
- halt("message");
61
- }
62
-
63
- /* -----------------------------------------------------------
64
- DECODE
65
- ----------------------------------------------------------- */
66
- /**
67
- * > You must configure the generic argument `T`.
68
- *
69
- * Protocol Buffer Decoder.
70
- *
71
- * `typia.protobuf.decode()` is a function decoding a binary data of Protocol Buffer
72
- * format to a TypeScript instance.
73
- *
74
- * For reference, as Protocol Buffer handles binary data directly, there's no way
75
- * when `input` binary data was not encoded from the `T` typed value. In that case,
76
- * unexpected behavior or internal error would be occured. Therefore, I recommend you
77
- * to encode binary data of Protocol Buffer from type safe encode functions like below.
78
- * Use {@link encode} function only when you can ensure it.
79
- *
80
- * - {@link assertEncode}
81
- * - {@link isEncode}
82
- * - {@link validateEncode}
83
- *
84
- * Also, `typia` is providing type safe decoders like {@link assertDecode}, but it
85
- * is just for additional type validation like `number & Minimum<7>` or
86
- * `string & Format<"uuid">` cases, that are represented by
87
- * [custom tags](https://typia.io/docs/validators/tags). Thus, I repeat that,
88
- * you've to ensure the type safety when using decoder functions.
89
- *
90
- * @template T Expected type of decoded value
91
- * @param input Protobuf Buffer binary data
92
- * @returns Decoded value
93
- *
94
- * @author Jeongho Nam - https://github.com/samchon
95
- */
96
- export function decode(input: Uint8Array): never;
97
-
98
- /**
99
- * Protocol Buffer Decoder.
100
- *
101
- * `typia.protobuf.decode()` is a function decoding a binary data of Protocol Buffer
102
- * format to a TypeScript instance.
103
- *
104
- * For reference, as Protocol Buffer handles binary data directly, there's no way
105
- * when `input` binary data was not encoded from the `T` typed value. In that case,
106
- * unexpected behavior or internal error would be occured. Therefore, I recommend you
107
- * to encode binary data of Protocol Buffer from type safe encode functions like below.
108
- * Use {@link encode} function only when you can ensure it.
109
- *
110
- * - {@link assertEncode}
111
- * - {@link isEncode}
112
- * - {@link validateEncode}
113
- *
114
- * Also, `typia` is providing type safe decoders like {@link assertDecode}, but it
115
- * is just for additional type validation like `number & Minimum<7>` or
116
- * `string & Format<"uuid">` cases, that are represented by
117
- * [custom tags](https://typia.io/docs/validators/tags). Thus, I repeat that,
118
- * you've to ensure the type safety when using decoder functions.
119
- *
120
- * @template T Expected type of decoded value
121
- * @param input Protobuf Buffer binary data
122
- * @returns Decoded value
123
- *
124
- * @author Jeongho Nam - https://github.com/samchon
125
- */
126
- export function decode<T>(input: Uint8Array): Resolved<T>;
127
-
128
- /**
129
- * @internal
130
- */
131
- export function decode(): never {
132
- halt("decode");
133
- }
134
-
135
- /**
136
- * > You must configure the generic argument `T`.
137
- *
138
- * Protocol Buffer Decoder wity type assertion, but not safe.
139
- *
140
- * `typia.protobuf.assertDecode()` is a combination function of {@link decode} and
141
- * {@link assert} function. Therefore, it decodes a binary data of Protocol Buffer to
142
- * a TypeScript instance, and performs type assertion process. If decoded value is
143
- * following the type `T`, it returns the decoded value. Otherwise, it throws
144
- * {@link TypeGuardError} instead.
145
- *
146
- * However, note that, this validation is not always safe. It just performs additional
147
- * type assertion like `number & Minimum<7>` or `string & Format<"uuid">` cases,
148
- * that are represented by [custom tags](https://typia.io/docs/validators/tags).
149
- * Therefore, when using `typia.protobuf.assertDecode<T>()` function, you have to
150
- * ensure the type safety by yourself.
151
- *
152
- * In such type safety reason, I recommend you to use type safe encode functions.
153
- *
154
- * - {@link assertEncode}
155
- * - {@link isEncode}
156
- * - {@link validateEncode}
157
- *
158
- * @template T Expected type of decoded value
159
- * @param input Protobuf Buffer binary data
160
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
161
- * @returns Decoded value
162
- *
163
- * @author Jeongho Nam - https://github.com/samchon
164
- */
165
- export function assertDecode(
166
- input: Uint8Array,
167
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
168
- ): never;
169
-
170
- /**
171
- * Protocol Buffer Decoder wity type assertion, but not safe.
172
- *
173
- * `typia.protobuf.assertDecode()` is a combination function of {@link decode} and
174
- * {@link assert} function. Therefore, it decodes a binary data of Protocol Buffer to
175
- * a TypeScript instance, and performs type assertion process. If decoded value is
176
- * following the type `T`, it returns the decoded value. Otherwise, it throws
177
- * {@link TypeGuardError} instead.
178
- *
179
- * However, note that, this validation is not always safe. It just performs additional
180
- * type assertion like `number & Minimum<7>` or `string & Format<"uuid">` cases,
181
- * that are represented by [custom tags](https://typia.io/docs/validators/tags).
182
- * Therefore, when using `typia.protobuf.assertDecode<T>()` function, you have to
183
- * ensure the type safety by yourself.
184
- *
185
- * In such type safety reason, I recommend you to use type safe encode functions.
186
- *
187
- * - {@link assertEncode}
188
- * - {@link isEncode}
189
- * - {@link validateEncode}
190
- *
191
- * @template T Expected type of decoded value
192
- * @param input Protobuf Buffer binary data
193
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
194
- * @returns Decoded value
195
- *
196
- * @author Jeongho Nam - https://github.com/samchon
197
- */
198
- export function assertDecode<T>(
199
- input: Uint8Array,
200
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
201
- ): Resolved<T>;
202
-
203
- /**
204
- * @internal
205
- */
206
- export function assertDecode(): never {
207
- halt("assertDecode");
208
- }
209
-
210
- /**
211
- * > You must configure the generic argument `T`.
212
- *
213
- * Protocol Buffer Decoder wity type checking, but not safe.
214
- *
215
- * `typia.protobuf.isDecode()` is a combination function of {@link decode} and
216
- * {@link is} function. Therefore, it decodes a binary data of Protocol Buffer to
217
- * a TypeScript instance, and performs type checking process. If decoded value is
218
- * following the type `T`, it returns the decoded value. Otherwise, it returns
219
- * `null` value instead.
220
- *
221
- * However, note that, this validation is not always safe. It just performs additional
222
- * type checking like `number & Minimum<7>` or `string & Format<"uuid">` cases,
223
- * that are represented by [custom tags](https://typia.io/docs/validators/tags).
224
- * Therefore, when using `typia.protobuf.isDecode<T>()` function, you have to
225
- * ensure the type safety by yourself.
226
- *
227
- * In such type safety reason, I recommend you to use type safe encode functions.
228
- *
229
- * - {@link assertEncode}
230
- * - {@link isEncode}
231
- * - {@link validateEncode}
232
- *
233
- * @template T Expected type of decoded value
234
- * @param input Protobuf Buffer binary data
235
- * @returns Decoded value
236
- *
237
- * @author Jeongho Nam - https://github.com/samchon
238
- */
239
- export function isDecode(input: Uint8Array): never;
240
-
241
- /**
242
- * Protocol Buffer Decoder wity type checking, but not safe.
243
- *
244
- * `typia.protobuf.isDecode()` is a combination function of {@link decode} and
245
- * {@link is} function. Therefore, it decodes a binary data of Protocol Buffer to
246
- * a TypeScript instance, and performs type checking process. If decoded value is
247
- * following the type `T`, it returns the decoded value. Otherwise, it returns
248
- * `null` value instead.
249
- *
250
- * However, note that, this validation is not always safe. It just performs additional
251
- * type checking like `number & Minimum<7>` or `string & Format<"uuid">` cases,
252
- * that are represented by [custom tags](https://typia.io/docs/validators/tags).
253
- * Therefore, when using `typia.protobuf.isDecode<T>()` function, you have to
254
- * ensure the type safety by yourself.
255
- *
256
- * In such type safety reason, I recommend you to use type safe encode functions.
257
- *
258
- * - {@link assertEncode}
259
- * - {@link isEncode}
260
- * - {@link validateEncode}
261
- *
262
- * @template T Expected type of decoded value
263
- * @param input Protobuf Buffer binary data
264
- * @returns Decoded value
265
- *
266
- * @author Jeongho Nam - https://github.com/samchon
267
- */
268
- export function isDecode<T>(input: Uint8Array): Resolved<T> | null;
269
-
270
- /**
271
- * @internal
272
- */
273
- export function isDecode(): never {
274
- halt("isDecode");
275
- }
276
-
277
- /**
278
- * > You must configure the generic argument `T`.
279
- *
280
- * Protocol Buffer Decoder wity type validation, but not safe.
281
- *
282
- * `typia.protobuf.validateDecode()` is a combination function of {@link decode} and
283
- * {@link validate} function. Therefore, it decodes a binary data of Protocol Buffer to
284
- * a TypeScript instance, and performs type validation process. If decoded value is
285
- * following the type `T`, it returns the decoded value with
286
- * {@link IValidation.ISuccess} typed instance. Otherwise, it returns
287
- * {@link IValidation.IFailure} value instead with detailed error reasons.
288
- *
289
- * However, note that, this validation is not always safe. It just performs additional
290
- * type validation like `number & Minimum<7>` or `string & Format<"uuid">` cases,
291
- * that are represented by [custom tags](https://typia.io/docs/validators/tags).
292
- * Therefore, when using `typia.protobuf.validateDecode<T>()` function, you have to
293
- * ensure the type safety by yourself.
294
- *
295
- * In such type safety reason, I recommend you to use type safe encode functions.
296
- *
297
- * - {@link assertEncode}
298
- * - {@link isEncode}
299
- * - {@link validateEncode}
300
- *
301
- * @template T Expected type of decoded value
302
- * @param input Protobuf Buffer binary data
303
- * @returns Decoded value
304
- *
305
- * @author Jeongho Nam - https://github.com/samchon
306
- */
307
- export function validateDecode(input: Uint8Array): never;
308
-
309
- /**
310
- * Protocol Buffer Decoder wity type validation, but not safe.
311
- *
312
- * `typia.protobuf.validateDecode()` is a combination function of {@link decode} and
313
- * {@link validate} function. Therefore, it decodes a binary data of Protocol Buffer to
314
- * a TypeScript instance, and performs type validation process. If decoded value is
315
- * following the type `T`, it returns the decoded value with
316
- * {@link IValidation.ISuccess} typed instance. Otherwise, it returns
317
- * {@link IValidation.IFailure} value instead with detailed error reasons.
318
- *
319
- * However, note that, this validation is not always safe. It just performs additional
320
- * type validation like `number & Minimum<7>` or `string & Format<"uuid">` cases,
321
- * that are represented by [custom tags](https://typia.io/docs/validators/tags).
322
- * Therefore, when using `typia.protobuf.validateDecode<T>()` function, you have to
323
- * ensure the type safety by yourself.
324
- *
325
- * In such type safety reason, I recommend you to use type safe encode functions.
326
- *
327
- * - {@link assertEncode}
328
- * - {@link isEncode}
329
- * - {@link validateEncode}
330
- *
331
- * @template T Expected type of decoded value
332
- * @param input Protobuf Buffer binary data
333
- * @returns Decoded value
334
- *
335
- * @author Jeongho Nam - https://github.com/samchon
336
- */
337
- export function validateDecode<T>(input: Uint8Array): IValidation<Resolved<T>>;
338
-
339
- /**
340
- * @internal
341
- */
342
- export function validateDecode(): never {
343
- halt("validateDecode");
344
- }
345
-
346
- /* -----------------------------------------------------------
347
- ENCODE
348
- ----------------------------------------------------------- */
349
- /**
350
- * Protocol Buffer Encoder.
351
- *
352
- * Converts an input value to a binary data of Protocol Buffer format.
353
- *
354
- * For reference, this `typia.protobuf.encode()` does not validate the `input` value.
355
- * It just believes that the `input` value is valid and converts it to a binary data
356
- * directly. Therefore, if you can't ensure the `input` value type, it would better to
357
- * call one of below functions intead.
358
- *
359
- * - {@link assertEncode}
360
- * - {@link isEncode}
361
- * - {@link validateEncode}
362
- *
363
- * By the way, you know what? Expression power of Protocol Buffer is not enough strong
364
- * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
365
- * type that is not compatible with Protocol Buffer, this function would throw
366
- * compilation errors.
367
- *
368
- * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
369
- *
370
- * @template T Type of the value input
371
- * @param input A value to encode
372
- * @returns Encoded binary data
373
- *
374
- * @author Jeongho Nam - https://github.com/samchon
375
- */
376
- export function encode<T>(input: T): Uint8Array;
377
-
378
- /**
379
- * @internal
380
- */
381
- export function encode(): never {
382
- halt("encode");
383
- }
384
-
385
- /**
386
- * Protocol Buffer Encoder with type assertion.
387
- *
388
- * `typia.protobuf.assertEncode()` is a combination function of {@link assert} and
389
- * {@link encode}.
390
- *
391
- * Therefore, it converts an `input` value to a binary data of
392
- * Protocol Buffer, with type assertion. If `input` value is not valid, it throws
393
- * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value,
394
- * Protocol Buffer binary data would be returned.
395
- *
396
- * If you can trust `input` value, or want to perform other type of validation, use
397
- * below functions intead.
398
- *
399
- * - {@link encode}
400
- * - {@link isEncode}
401
- * - {@link validateEncode}
402
- *
403
- * By the way, you know what? Expression power of Protocol Buffer is not enough strong
404
- * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
405
- * type that is not compatible with Protocol Buffer, this function would throw
406
- * compilation errors.
407
- *
408
- * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
409
- *
410
- * @template T Type of the value input
411
- * @param input A value to encode
412
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
413
- * @returns Encoded binary data
414
- *
415
- * @author Jeongho Nam - https://github.com/samchon
416
- */
417
- export function assertEncode<T>(
418
- input: T,
419
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
420
- ): Uint8Array;
421
-
422
- /**
423
- * Protocol Buffer Encoder with type assertion.
424
- *
425
- * `typia.protobuf.assertEncode()` is a combination function of {@link assert} and
426
- * {@link encode}.
427
- *
428
- * Therefore, it converts an `input` value to a binary data of
429
- * Protocol Buffer, with type assertion. If `input` value is not valid, it throws
430
- * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value,
431
- * Protocol Buffer binary data would be returned.
432
- *
433
- * If you can trust `input` value, or want to perform other type of validation, use
434
- * below functions intead.
435
- *
436
- * - {@link encode}
437
- * - {@link isEncode}
438
- * - {@link validateEncode}
439
- *
440
- * By the way, you know what? Expression power of Protocol Buffer is not enough strong
441
- * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
442
- * type that is not compatible with Protocol Buffer, this function would throw
443
- * compilation errors.
444
- *
445
- * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
446
- *
447
- * @template T Type of the value input
448
- * @param input A value to encode
449
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
450
- * @returns Encoded binary data
451
- *
452
- * @author Jeongho Nam - https://github.com/samchon
453
- */
454
- export function assertEncode<T>(
455
- input: unknown,
456
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
457
- ): Uint8Array;
458
-
459
- /**
460
- * @internal
461
- */
462
- export function assertEncode(): never {
463
- halt("assertEncode");
464
- }
465
-
466
- /**
467
- * Protocol Buffer Encoder with type checking.
468
- *
469
- * `typia.protobuf.isEncode()` is a combination function of {@link is} and
470
- * {@link encode}.
471
- *
472
- * Therefore, it converts an `input` value to a binary data of
473
- * Protocol Buffer, with type checking. If `input` value is not valid, it returns
474
- * `null` value. Otherwise, there's no problem on the `input` value, Protocol
475
- * Buffer binary data would be returned.
476
- *
477
- * If you can trust `input` value, or want to perform other type of validation, use
478
- * below functions intead.
479
- *
480
- * - {@link encode}
481
- * - {@link assertEncode}
482
- * - {@link validateEncode}
483
- *
484
- * By the way, you know what? Expression power of Protocol Buffer is not enough strong
485
- * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
486
- * type that is not compatible with Protocol Buffer, this function would throw
487
- * compilation errors.
488
- *
489
- * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
490
- *
491
- * @template T Type of the value input
492
- * @param input A value to encode
493
- * @returns Encoded binary data
494
- *
495
- * @author Jeongho Nam - https://github.com/samchon
496
- */
497
- export function isEncode<T>(input: T): Uint8Array | null;
498
-
499
- /**
500
- * Protocol Buffer Encoder with type checking.
501
- *
502
- * `typia.protobuf.isEncode()` is a combination function of {@link is} and
503
- * {@link encode}.
504
- *
505
- * Therefore, it converts an `input` value to a binary data of
506
- * Protocol Buffer, with type checking. If `input` value is not valid, it returns
507
- * `null` value. Otherwise, there's no problem on the `input` value, Protocol
508
- * Buffer binary data would be returned.
509
- *
510
- * If you can trust `input` value, or want to perform other type of validation, use
511
- * below functions intead.
512
- *
513
- * - {@link encode}
514
- * - {@link assertEncode}
515
- * - {@link validateEncode}
516
- *
517
- * By the way, you know what? Expression power of Protocol Buffer is not enough strong
518
- * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
519
- * type that is not compatible with Protocol Buffer, this function would throw
520
- * compilation errors.
521
- *
522
- * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
523
- *
524
- * @template T Type of the value input
525
- * @param input A value to encode
526
- * @returns Encoded binary data
527
- *
528
- * @author Jeongho Nam - https://github.com/samchon
529
- */
530
- export function isEncode<T>(input: unknown): Uint8Array | null;
531
-
532
- /**
533
- * @internal
534
- */
535
- export function isEncode(): never {
536
- halt("isEncode");
537
- }
538
-
539
- /**
540
- * Protocol Buffer Encoder with type validation.
541
- *
542
- * `typia.protobuf.validateEncode()` is a combination function of
543
- * {@link validation} and {@link encode}.
544
- *
545
- * Therefore, it converts an `input` value to a binary data of
546
- * Protocol Buffer, with type validation. If `input` value is not valid, it returns
547
- * {@link IValidation.IFailure} value with detailed error reasons. Otherwise, there's
548
- * no problem on the `input` value, Protocol Buffer binary data would be stored in
549
- * `data` property of the output {@link IValidation.ISuccess} instance.
550
- *
551
- * If you can trust `input` value, or want to perform other type of validation, use
552
- * below functions intead.
553
- *
554
- * - {@link encode}
555
- * - {@link assertEncode}
556
- * - {@link isEncode}
557
- *
558
- * By the way, you know what? Expression power of Protocol Buffer is not enough strong
559
- * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
560
- * type that is not compatible with Protocol Buffer, this function would throw
561
- * compilation errors.
562
- *
563
- * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
564
- *
565
- * @template T Type of the value input
566
- * @param input A value to encode
567
- * @returns Encoded binary data
568
- *
569
- * @author Jeongho Nam - https://github.com/samchon
570
- */
571
- export function validateEncode<T>(input: T): IValidation<Uint8Array>;
572
-
573
- /**
574
- * Protocol Buffer Encoder with type validation.
575
- *
576
- * `typia.protobuf.validateEncode()` is a combination function of
577
- * {@link validation} and {@link encode}.
578
- *
579
- * Therefore, it converts an `input` value to a binary data of
580
- * Protocol Buffer, with type validation. If `input` value is not valid, it returns
581
- * {@link IValidation.IFailure} value with detailed error reasons. Otherwise, there's
582
- * no problem on the `input` value, Protocol Buffer binary data would be stored in
583
- * `data` property of the output {@link IValidation.ISuccess} instance.
584
- *
585
- * If you can trust `input` value, or want to perform other type of validation, use
586
- * below functions intead.
587
- *
588
- * - {@link encode}
589
- * - {@link assertEncode}
590
- * - {@link isEncode}
591
- *
592
- * By the way, you know what? Expression power of Protocol Buffer is not enough strong
593
- * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
594
- * type that is not compatible with Protocol Buffer, this function would throw
595
- * compilation errors.
596
- *
597
- * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
598
- *
599
- * @template T Type of the value input
600
- * @param input A value to encode
601
- * @returns Encoded binary data
602
- *
603
- * @author Jeongho Nam - https://github.com/samchon
604
- */
605
- export function validateEncode<T>(input: unknown): IValidation<Uint8Array>;
606
-
607
- /**
608
- * @internal
609
- */
610
- export function validateEncode(): never {
611
- halt("validateEncode");
612
- }
613
-
614
- /* -----------------------------------------------------------
615
- FACTORY FUNCTIONS
616
- ----------------------------------------------------------- */
617
- /**
618
- * Creates a reusable {@link decode} function.
619
- *
620
- * @danger You must configure the generic argument `T`
621
- * @returns Nothing until you configure the generic argument `T`
622
- * @throws compile error
623
- *
624
- * @author Jeongho Nam - https://github.com/samchon
625
- */
626
- export function createDecode(): never;
627
-
628
- /**
629
- * Creates a reusable {@link decode} function.
630
- *
631
- * @template T Target type
632
- * @returns A reusable `decode` function
633
- *
634
- * @author Jeongho Nam - https://github.com/samchon
635
- */
636
- export function createDecode<T>(): (input: Uint8Array) => Resolved<T>;
637
-
638
- /**
639
- * @internal
640
- */
641
- export function createDecode<T>(): (input: Uint8Array) => Resolved<T> {
642
- halt("createDecode");
643
- }
644
-
645
- /**
646
- * Creates a reusable {@link isDecode} function.
647
- *
648
- * @danger You must configure the generic argument `T`
649
- * @returns Nothing until you configure the generic argument `T`
650
- * @throws compile error
651
- *
652
- * @author Jeongho Nam - https://github.com/samchon
653
- */
654
- export function createIsDecode(): never;
655
-
656
- /**
657
- * Creates a reusable {@link isDecode} function.
658
- *
659
- * @template T Target type
660
- * @returns A reusable `isDecode` function
661
- *
662
- * @author Jeongho Nam - https://github.com/samchon
663
- */
664
- export function createIsDecode<T>(): (input: Uint8Array) => Resolved<T> | null;
665
-
666
- /**
667
- * @internal
668
- */
669
- export function createIsDecode<T>(): (input: Uint8Array) => Resolved<T> | null {
670
- halt("createIsDecode");
671
- }
672
-
673
- /**
674
- * Creates a reusable {@link assertDecode} function.
675
- *
676
- * @danger You must configure the generic argument `T`
677
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
678
- * @returns Nothing until you configure the generic argument `T`
679
- * @throws compile error
680
- *
681
- * @author Jeongho Nam - https://github.com/samchon
682
- */
683
- export function createAssertDecode(
684
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
685
- ): never;
686
-
687
- /**
688
- * Creates a reusable {@link assertDecode} function.
689
- *
690
- * @template T Target type
691
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
692
- * @returns A reusable `assertDecode` function
693
- *
694
- * @author Jeongho Nam - https://github.com/samchon
695
- */
696
- export function createAssertDecode<T>(
697
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
698
- ): (input: Uint8Array) => Resolved<T>;
699
-
700
- /**
701
- * @internal
702
- */
703
- export function createAssertDecode<T>(): (input: Uint8Array) => Resolved<T> {
704
- halt("createAssertDecode");
705
- }
706
-
707
- /**
708
- * Creates a reusable {@link validateDecode} function.
709
- *
710
- * @danger You must configure the generic argument `T`
711
- * @returns Nothing until you configure the generic argument `T`
712
- * @throws compile error
713
- *
714
- * @author Jeongho Nam - https://github.com/samchon
715
- */
716
- export function createValidateDecode(): never;
717
-
718
- /**
719
- * Creates a reusable {@link validateDecode} function.
720
- *
721
- * @template T Target type
722
- * @returns A reusable `validateDecode` function
723
- *
724
- * @author Jeongho Nam - https://github.com/samchon
725
- */
726
- export function createValidateDecode<T>(): (
727
- input: Uint8Array,
728
- ) => IValidation<Resolved<T>>;
729
-
730
- /**
731
- * @internal
732
- */
733
- export function createValidateDecode<T>(): (
734
- input: Uint8Array,
735
- ) => IValidation<Resolved<T>> {
736
- halt("createValidateDecode");
737
- }
738
-
739
- /**
740
- * Creates a reusable {@link encode} function.
741
- *
742
- * @danger You must configure the generic argument `T`
743
- * @returns Nothing until you configure the generic argument `T`
744
- * @throws compile error
745
- *
746
- * @author Jeongho Nam - https://github.com/samchon
747
- */
748
- export function createEncode(): never;
749
-
750
- /**
751
- * Creates a reusable {@link encode} function.
752
- *
753
- * @template T Target type
754
- * @returns A reusable `encode` function
755
- *
756
- * @author Jeongho Nam - https://github.com/samchon
757
- */
758
- export function createEncode<T>(): (input: T) => Uint8Array;
759
-
760
- /**
761
- * @internal
762
- */
763
- export function createEncode<T>(): (input: T) => Uint8Array {
764
- halt("createEncode");
765
- }
766
-
767
- /**
768
- * Creates a reusable {@link isEncode} function.
769
- *
770
- * @danger You must configure the generic argument `T`
771
- * @returns Nothing until you configure the generic argument `T`
772
- * @throws compile error
773
- *
774
- * @author Jeongho Nam - https://github.com/samchon
775
- */
776
- export function createIsEncode(): never;
777
-
778
- /**
779
- * Creates a reusable {@link isEncode} function.
780
- *
781
- * @template T Target type
782
- * @returns A reusable `isEncode` function
783
- *
784
- * @author Jeongho Nam - https://github.com/samchon
785
- */
786
- export function createIsEncode<T>(): (input: T) => Uint8Array | null;
787
-
788
- /**
789
- * @internal
790
- */
791
- export function createIsEncode<T>(): (input: T) => Uint8Array | null {
792
- halt("createIsEncode");
793
- }
794
-
795
- /**
796
- * Creates a reusable {@link assertEncode} function.
797
- *
798
- * @danger You must configure the generic argument `T`
799
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
800
- * @returns Nothing until you configure the generic argument `T`
801
- * @throws compile error
802
- *
803
- * @author Jeongho Nam - https://github.com/samchon
804
- */
805
- export function createAssertEncode(
806
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
807
- ): never;
808
-
809
- /**
810
- * Creates a reusable {@link assertEncode} function.
811
- *
812
- * @template T Target type
813
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
814
- * @returns A reusable `assertEncode` function
815
- *
816
- * @author Jeongho Nam - https://github.com/samchon
817
- */
818
- export function createAssertEncode<T>(
819
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
820
- ): (input: T) => Uint8Array;
821
-
822
- /**
823
- * @internal
824
- */
825
- export function createAssertEncode<T>(): (input: T) => Uint8Array {
826
- halt("createAssertEncode");
827
- }
828
-
829
- /**
830
- * Creates a reusable {@link validateEncode} function.
831
- *
832
- * @danger You must configure the generic argument `T`
833
- * @returns Nothing until you configure the generic argument `T`
834
- * @throws compile error
835
- *
836
- * @author Jeongho Nam - https://github.com/samchon
837
- */
838
- export function createValidateEncode(): never;
839
-
840
- /**
841
- * Creates a reusable {@link validateEncode} function.
842
- *
843
- * @template T Target type
844
- * @returns A reusable `validateEncode` function
845
- *
846
- * @author Jeongho Nam - https://github.com/samchon
847
- */
848
- export function createValidateEncode<T>(): (
849
- input: T,
850
- ) => IValidation<Uint8Array>;
851
-
852
- /**
853
- * @internal
854
- */
855
- export function createValidateEncode<T>(): (
856
- input: T,
857
- ) => IValidation<Uint8Array> {
858
- halt("createValidateEncode");
859
- }
860
-
861
- /**
862
- * @internal
863
- */
864
- function halt(name: string): never {
865
- throw new Error(
866
- `Error on typia.protobuf.${name}(): no transform has been configured. Read and follow https://typia.io/docs/setup please.`,
867
- );
868
- }
1
+ import { IValidation } from "./IValidation";
2
+ import { Resolved } from "./Resolved";
3
+ import { TypeGuardError } from "./TypeGuardError";
4
+
5
+ /* ===========================================================
6
+ PROTOCOL BUFFER
7
+ - MESSAGE
8
+ - DECODE
9
+ - ENCODE
10
+ - FACTORY FUNCTIONS
11
+ ==============================================================
12
+ SCHEMA
13
+ ----------------------------------------------------------- */
14
+ /**
15
+ * > You must configure the generic argument `T`.
16
+ *
17
+ * Protocol Buffer Message Schema.
18
+ *
19
+ * Creates a Protocol Buffer Message Schema from a TypeScript type. The message
20
+ * schema would be returned as a string value, and it can be used to share with
21
+ * other developers/languages/frameworks.
22
+ *
23
+ * For reference, Protocol Buffer has lots of restrictions, so that expression power
24
+ * of Protocol Buffer is not enough strong to fully meet the TypeScript type specs.
25
+ * In such reason, if you put a TypeScript type that is not compatible with Protocol
26
+ * Buffer, this function would throw compilation errors.
27
+ *
28
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
29
+ *
30
+ * @template T Target type
31
+ * @returns Protocol Buffer Message Schema.
32
+ *
33
+ * @author Jeongho Nam - https://github.com/samchon
34
+ */
35
+ export function message(): never;
36
+
37
+ /**
38
+ * Protocol Buffer Message Schema.
39
+ *
40
+ * Creates a Protocol Buffer Message Schema from a TypeScript type. The message
41
+ * schema would be returned as a string value, and it can be used to share with
42
+ * other developers/languages/frameworks.
43
+ *
44
+ * For reference, Protocol Buffer has lots of restrictions, so that expression power
45
+ * of Protocol Buffer is not enough strong to fully meet the TypeScript type specs.
46
+ * In such reason, if you put a TypeScript type that is not compatible with Protocol
47
+ * Buffer, this function would throw compilation errors.
48
+ *
49
+ * @template T Target type
50
+ * @returns Protocol Buffer Message Schema.
51
+ *
52
+ * @author Jeongho Nam - https://github.com/samchon
53
+ */
54
+ export function message<T>(): string;
55
+
56
+ /**
57
+ * @internal
58
+ */
59
+ export function message(): never {
60
+ halt("message");
61
+ }
62
+
63
+ /* -----------------------------------------------------------
64
+ DECODE
65
+ ----------------------------------------------------------- */
66
+ /**
67
+ * > You must configure the generic argument `T`.
68
+ *
69
+ * Protocol Buffer Decoder.
70
+ *
71
+ * `typia.protobuf.decode()` is a function decoding a binary data of Protocol Buffer
72
+ * format to a TypeScript instance.
73
+ *
74
+ * For reference, as Protocol Buffer handles binary data directly, there's no way
75
+ * when `input` binary data was not encoded from the `T` typed value. In that case,
76
+ * unexpected behavior or internal error would be occured. Therefore, I recommend you
77
+ * to encode binary data of Protocol Buffer from type safe encode functions like below.
78
+ * Use {@link encode} function only when you can ensure it.
79
+ *
80
+ * - {@link assertEncode}
81
+ * - {@link isEncode}
82
+ * - {@link validateEncode}
83
+ *
84
+ * Also, `typia` is providing type safe decoders like {@link assertDecode}, but it
85
+ * is just for additional type validation like `number & Minimum<7>` or
86
+ * `string & Format<"uuid">` cases, that are represented by
87
+ * [custom tags](https://typia.io/docs/validators/tags). Thus, I repeat that,
88
+ * you've to ensure the type safety when using decoder functions.
89
+ *
90
+ * @template T Expected type of decoded value
91
+ * @param input Protobuf Buffer binary data
92
+ * @returns Decoded value
93
+ *
94
+ * @author Jeongho Nam - https://github.com/samchon
95
+ */
96
+ export function decode(input: Uint8Array): never;
97
+
98
+ /**
99
+ * Protocol Buffer Decoder.
100
+ *
101
+ * `typia.protobuf.decode()` is a function decoding a binary data of Protocol Buffer
102
+ * format to a TypeScript instance.
103
+ *
104
+ * For reference, as Protocol Buffer handles binary data directly, there's no way
105
+ * when `input` binary data was not encoded from the `T` typed value. In that case,
106
+ * unexpected behavior or internal error would be occured. Therefore, I recommend you
107
+ * to encode binary data of Protocol Buffer from type safe encode functions like below.
108
+ * Use {@link encode} function only when you can ensure it.
109
+ *
110
+ * - {@link assertEncode}
111
+ * - {@link isEncode}
112
+ * - {@link validateEncode}
113
+ *
114
+ * Also, `typia` is providing type safe decoders like {@link assertDecode}, but it
115
+ * is just for additional type validation like `number & Minimum<7>` or
116
+ * `string & Format<"uuid">` cases, that are represented by
117
+ * [custom tags](https://typia.io/docs/validators/tags). Thus, I repeat that,
118
+ * you've to ensure the type safety when using decoder functions.
119
+ *
120
+ * @template T Expected type of decoded value
121
+ * @param input Protobuf Buffer binary data
122
+ * @returns Decoded value
123
+ *
124
+ * @author Jeongho Nam - https://github.com/samchon
125
+ */
126
+ export function decode<T>(input: Uint8Array): Resolved<T>;
127
+
128
+ /**
129
+ * @internal
130
+ */
131
+ export function decode(): never {
132
+ halt("decode");
133
+ }
134
+
135
+ /**
136
+ * > You must configure the generic argument `T`.
137
+ *
138
+ * Protocol Buffer Decoder wity type assertion, but not safe.
139
+ *
140
+ * `typia.protobuf.assertDecode()` is a combination function of {@link decode} and
141
+ * {@link assert} function. Therefore, it decodes a binary data of Protocol Buffer to
142
+ * a TypeScript instance, and performs type assertion process. If decoded value is
143
+ * following the type `T`, it returns the decoded value. Otherwise, it throws
144
+ * {@link TypeGuardError} instead.
145
+ *
146
+ * However, note that, this validation is not always safe. It just performs additional
147
+ * type assertion like `number & Minimum<7>` or `string & Format<"uuid">` cases,
148
+ * that are represented by [custom tags](https://typia.io/docs/validators/tags).
149
+ * Therefore, when using `typia.protobuf.assertDecode<T>()` function, you have to
150
+ * ensure the type safety by yourself.
151
+ *
152
+ * In such type safety reason, I recommend you to use type safe encode functions.
153
+ *
154
+ * - {@link assertEncode}
155
+ * - {@link isEncode}
156
+ * - {@link validateEncode}
157
+ *
158
+ * @template T Expected type of decoded value
159
+ * @param input Protobuf Buffer binary data
160
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
161
+ * @returns Decoded value
162
+ *
163
+ * @author Jeongho Nam - https://github.com/samchon
164
+ */
165
+ export function assertDecode(
166
+ input: Uint8Array,
167
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
168
+ ): never;
169
+
170
+ /**
171
+ * Protocol Buffer Decoder wity type assertion, but not safe.
172
+ *
173
+ * `typia.protobuf.assertDecode()` is a combination function of {@link decode} and
174
+ * {@link assert} function. Therefore, it decodes a binary data of Protocol Buffer to
175
+ * a TypeScript instance, and performs type assertion process. If decoded value is
176
+ * following the type `T`, it returns the decoded value. Otherwise, it throws
177
+ * {@link TypeGuardError} instead.
178
+ *
179
+ * However, note that, this validation is not always safe. It just performs additional
180
+ * type assertion like `number & Minimum<7>` or `string & Format<"uuid">` cases,
181
+ * that are represented by [custom tags](https://typia.io/docs/validators/tags).
182
+ * Therefore, when using `typia.protobuf.assertDecode<T>()` function, you have to
183
+ * ensure the type safety by yourself.
184
+ *
185
+ * In such type safety reason, I recommend you to use type safe encode functions.
186
+ *
187
+ * - {@link assertEncode}
188
+ * - {@link isEncode}
189
+ * - {@link validateEncode}
190
+ *
191
+ * @template T Expected type of decoded value
192
+ * @param input Protobuf Buffer binary data
193
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
194
+ * @returns Decoded value
195
+ *
196
+ * @author Jeongho Nam - https://github.com/samchon
197
+ */
198
+ export function assertDecode<T>(
199
+ input: Uint8Array,
200
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
201
+ ): Resolved<T>;
202
+
203
+ /**
204
+ * @internal
205
+ */
206
+ export function assertDecode(): never {
207
+ halt("assertDecode");
208
+ }
209
+
210
+ /**
211
+ * > You must configure the generic argument `T`.
212
+ *
213
+ * Protocol Buffer Decoder wity type checking, but not safe.
214
+ *
215
+ * `typia.protobuf.isDecode()` is a combination function of {@link decode} and
216
+ * {@link is} function. Therefore, it decodes a binary data of Protocol Buffer to
217
+ * a TypeScript instance, and performs type checking process. If decoded value is
218
+ * following the type `T`, it returns the decoded value. Otherwise, it returns
219
+ * `null` value instead.
220
+ *
221
+ * However, note that, this validation is not always safe. It just performs additional
222
+ * type checking like `number & Minimum<7>` or `string & Format<"uuid">` cases,
223
+ * that are represented by [custom tags](https://typia.io/docs/validators/tags).
224
+ * Therefore, when using `typia.protobuf.isDecode<T>()` function, you have to
225
+ * ensure the type safety by yourself.
226
+ *
227
+ * In such type safety reason, I recommend you to use type safe encode functions.
228
+ *
229
+ * - {@link assertEncode}
230
+ * - {@link isEncode}
231
+ * - {@link validateEncode}
232
+ *
233
+ * @template T Expected type of decoded value
234
+ * @param input Protobuf Buffer binary data
235
+ * @returns Decoded value
236
+ *
237
+ * @author Jeongho Nam - https://github.com/samchon
238
+ */
239
+ export function isDecode(input: Uint8Array): never;
240
+
241
+ /**
242
+ * Protocol Buffer Decoder wity type checking, but not safe.
243
+ *
244
+ * `typia.protobuf.isDecode()` is a combination function of {@link decode} and
245
+ * {@link is} function. Therefore, it decodes a binary data of Protocol Buffer to
246
+ * a TypeScript instance, and performs type checking process. If decoded value is
247
+ * following the type `T`, it returns the decoded value. Otherwise, it returns
248
+ * `null` value instead.
249
+ *
250
+ * However, note that, this validation is not always safe. It just performs additional
251
+ * type checking like `number & Minimum<7>` or `string & Format<"uuid">` cases,
252
+ * that are represented by [custom tags](https://typia.io/docs/validators/tags).
253
+ * Therefore, when using `typia.protobuf.isDecode<T>()` function, you have to
254
+ * ensure the type safety by yourself.
255
+ *
256
+ * In such type safety reason, I recommend you to use type safe encode functions.
257
+ *
258
+ * - {@link assertEncode}
259
+ * - {@link isEncode}
260
+ * - {@link validateEncode}
261
+ *
262
+ * @template T Expected type of decoded value
263
+ * @param input Protobuf Buffer binary data
264
+ * @returns Decoded value
265
+ *
266
+ * @author Jeongho Nam - https://github.com/samchon
267
+ */
268
+ export function isDecode<T>(input: Uint8Array): Resolved<T> | null;
269
+
270
+ /**
271
+ * @internal
272
+ */
273
+ export function isDecode(): never {
274
+ halt("isDecode");
275
+ }
276
+
277
+ /**
278
+ * > You must configure the generic argument `T`.
279
+ *
280
+ * Protocol Buffer Decoder wity type validation, but not safe.
281
+ *
282
+ * `typia.protobuf.validateDecode()` is a combination function of {@link decode} and
283
+ * {@link validate} function. Therefore, it decodes a binary data of Protocol Buffer to
284
+ * a TypeScript instance, and performs type validation process. If decoded value is
285
+ * following the type `T`, it returns the decoded value with
286
+ * {@link IValidation.ISuccess} typed instance. Otherwise, it returns
287
+ * {@link IValidation.IFailure} value instead with detailed error reasons.
288
+ *
289
+ * However, note that, this validation is not always safe. It just performs additional
290
+ * type validation like `number & Minimum<7>` or `string & Format<"uuid">` cases,
291
+ * that are represented by [custom tags](https://typia.io/docs/validators/tags).
292
+ * Therefore, when using `typia.protobuf.validateDecode<T>()` function, you have to
293
+ * ensure the type safety by yourself.
294
+ *
295
+ * In such type safety reason, I recommend you to use type safe encode functions.
296
+ *
297
+ * - {@link assertEncode}
298
+ * - {@link isEncode}
299
+ * - {@link validateEncode}
300
+ *
301
+ * @template T Expected type of decoded value
302
+ * @param input Protobuf Buffer binary data
303
+ * @returns Decoded value
304
+ *
305
+ * @author Jeongho Nam - https://github.com/samchon
306
+ */
307
+ export function validateDecode(input: Uint8Array): never;
308
+
309
+ /**
310
+ * Protocol Buffer Decoder wity type validation, but not safe.
311
+ *
312
+ * `typia.protobuf.validateDecode()` is a combination function of {@link decode} and
313
+ * {@link validate} function. Therefore, it decodes a binary data of Protocol Buffer to
314
+ * a TypeScript instance, and performs type validation process. If decoded value is
315
+ * following the type `T`, it returns the decoded value with
316
+ * {@link IValidation.ISuccess} typed instance. Otherwise, it returns
317
+ * {@link IValidation.IFailure} value instead with detailed error reasons.
318
+ *
319
+ * However, note that, this validation is not always safe. It just performs additional
320
+ * type validation like `number & Minimum<7>` or `string & Format<"uuid">` cases,
321
+ * that are represented by [custom tags](https://typia.io/docs/validators/tags).
322
+ * Therefore, when using `typia.protobuf.validateDecode<T>()` function, you have to
323
+ * ensure the type safety by yourself.
324
+ *
325
+ * In such type safety reason, I recommend you to use type safe encode functions.
326
+ *
327
+ * - {@link assertEncode}
328
+ * - {@link isEncode}
329
+ * - {@link validateEncode}
330
+ *
331
+ * @template T Expected type of decoded value
332
+ * @param input Protobuf Buffer binary data
333
+ * @returns Decoded value
334
+ *
335
+ * @author Jeongho Nam - https://github.com/samchon
336
+ */
337
+ export function validateDecode<T>(input: Uint8Array): IValidation<Resolved<T>>;
338
+
339
+ /**
340
+ * @internal
341
+ */
342
+ export function validateDecode(): never {
343
+ halt("validateDecode");
344
+ }
345
+
346
+ /* -----------------------------------------------------------
347
+ ENCODE
348
+ ----------------------------------------------------------- */
349
+ /**
350
+ * Protocol Buffer Encoder.
351
+ *
352
+ * Converts an input value to a binary data of Protocol Buffer format.
353
+ *
354
+ * For reference, this `typia.protobuf.encode()` does not validate the `input` value.
355
+ * It just believes that the `input` value is valid and converts it to a binary data
356
+ * directly. Therefore, if you can't ensure the `input` value type, it would better to
357
+ * call one of below functions intead.
358
+ *
359
+ * - {@link assertEncode}
360
+ * - {@link isEncode}
361
+ * - {@link validateEncode}
362
+ *
363
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
364
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
365
+ * type that is not compatible with Protocol Buffer, this function would throw
366
+ * compilation errors.
367
+ *
368
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
369
+ *
370
+ * @template T Type of the value input
371
+ * @param input A value to encode
372
+ * @returns Encoded binary data
373
+ *
374
+ * @author Jeongho Nam - https://github.com/samchon
375
+ */
376
+ export function encode<T>(input: T): Uint8Array;
377
+
378
+ /**
379
+ * @internal
380
+ */
381
+ export function encode(): never {
382
+ halt("encode");
383
+ }
384
+
385
+ /**
386
+ * Protocol Buffer Encoder with type assertion.
387
+ *
388
+ * `typia.protobuf.assertEncode()` is a combination function of {@link assert} and
389
+ * {@link encode}.
390
+ *
391
+ * Therefore, it converts an `input` value to a binary data of
392
+ * Protocol Buffer, with type assertion. If `input` value is not valid, it throws
393
+ * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value,
394
+ * Protocol Buffer binary data would be returned.
395
+ *
396
+ * If you can trust `input` value, or want to perform other type of validation, use
397
+ * below functions intead.
398
+ *
399
+ * - {@link encode}
400
+ * - {@link isEncode}
401
+ * - {@link validateEncode}
402
+ *
403
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
404
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
405
+ * type that is not compatible with Protocol Buffer, this function would throw
406
+ * compilation errors.
407
+ *
408
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
409
+ *
410
+ * @template T Type of the value input
411
+ * @param input A value to encode
412
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
413
+ * @returns Encoded binary data
414
+ *
415
+ * @author Jeongho Nam - https://github.com/samchon
416
+ */
417
+ export function assertEncode<T>(
418
+ input: T,
419
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
420
+ ): Uint8Array;
421
+
422
+ /**
423
+ * Protocol Buffer Encoder with type assertion.
424
+ *
425
+ * `typia.protobuf.assertEncode()` is a combination function of {@link assert} and
426
+ * {@link encode}.
427
+ *
428
+ * Therefore, it converts an `input` value to a binary data of
429
+ * Protocol Buffer, with type assertion. If `input` value is not valid, it throws
430
+ * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value,
431
+ * Protocol Buffer binary data would be returned.
432
+ *
433
+ * If you can trust `input` value, or want to perform other type of validation, use
434
+ * below functions intead.
435
+ *
436
+ * - {@link encode}
437
+ * - {@link isEncode}
438
+ * - {@link validateEncode}
439
+ *
440
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
441
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
442
+ * type that is not compatible with Protocol Buffer, this function would throw
443
+ * compilation errors.
444
+ *
445
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
446
+ *
447
+ * @template T Type of the value input
448
+ * @param input A value to encode
449
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
450
+ * @returns Encoded binary data
451
+ *
452
+ * @author Jeongho Nam - https://github.com/samchon
453
+ */
454
+ export function assertEncode<T>(
455
+ input: unknown,
456
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
457
+ ): Uint8Array;
458
+
459
+ /**
460
+ * @internal
461
+ */
462
+ export function assertEncode(): never {
463
+ halt("assertEncode");
464
+ }
465
+
466
+ /**
467
+ * Protocol Buffer Encoder with type checking.
468
+ *
469
+ * `typia.protobuf.isEncode()` is a combination function of {@link is} and
470
+ * {@link encode}.
471
+ *
472
+ * Therefore, it converts an `input` value to a binary data of
473
+ * Protocol Buffer, with type checking. If `input` value is not valid, it returns
474
+ * `null` value. Otherwise, there's no problem on the `input` value, Protocol
475
+ * Buffer binary data would be returned.
476
+ *
477
+ * If you can trust `input` value, or want to perform other type of validation, use
478
+ * below functions intead.
479
+ *
480
+ * - {@link encode}
481
+ * - {@link assertEncode}
482
+ * - {@link validateEncode}
483
+ *
484
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
485
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
486
+ * type that is not compatible with Protocol Buffer, this function would throw
487
+ * compilation errors.
488
+ *
489
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
490
+ *
491
+ * @template T Type of the value input
492
+ * @param input A value to encode
493
+ * @returns Encoded binary data
494
+ *
495
+ * @author Jeongho Nam - https://github.com/samchon
496
+ */
497
+ export function isEncode<T>(input: T): Uint8Array | null;
498
+
499
+ /**
500
+ * Protocol Buffer Encoder with type checking.
501
+ *
502
+ * `typia.protobuf.isEncode()` is a combination function of {@link is} and
503
+ * {@link encode}.
504
+ *
505
+ * Therefore, it converts an `input` value to a binary data of
506
+ * Protocol Buffer, with type checking. If `input` value is not valid, it returns
507
+ * `null` value. Otherwise, there's no problem on the `input` value, Protocol
508
+ * Buffer binary data would be returned.
509
+ *
510
+ * If you can trust `input` value, or want to perform other type of validation, use
511
+ * below functions intead.
512
+ *
513
+ * - {@link encode}
514
+ * - {@link assertEncode}
515
+ * - {@link validateEncode}
516
+ *
517
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
518
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
519
+ * type that is not compatible with Protocol Buffer, this function would throw
520
+ * compilation errors.
521
+ *
522
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
523
+ *
524
+ * @template T Type of the value input
525
+ * @param input A value to encode
526
+ * @returns Encoded binary data
527
+ *
528
+ * @author Jeongho Nam - https://github.com/samchon
529
+ */
530
+ export function isEncode<T>(input: unknown): Uint8Array | null;
531
+
532
+ /**
533
+ * @internal
534
+ */
535
+ export function isEncode(): never {
536
+ halt("isEncode");
537
+ }
538
+
539
+ /**
540
+ * Protocol Buffer Encoder with type validation.
541
+ *
542
+ * `typia.protobuf.validateEncode()` is a combination function of
543
+ * {@link validation} and {@link encode}.
544
+ *
545
+ * Therefore, it converts an `input` value to a binary data of
546
+ * Protocol Buffer, with type validation. If `input` value is not valid, it returns
547
+ * {@link IValidation.IFailure} value with detailed error reasons. Otherwise, there's
548
+ * no problem on the `input` value, Protocol Buffer binary data would be stored in
549
+ * `data` property of the output {@link IValidation.ISuccess} instance.
550
+ *
551
+ * If you can trust `input` value, or want to perform other type of validation, use
552
+ * below functions intead.
553
+ *
554
+ * - {@link encode}
555
+ * - {@link assertEncode}
556
+ * - {@link isEncode}
557
+ *
558
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
559
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
560
+ * type that is not compatible with Protocol Buffer, this function would throw
561
+ * compilation errors.
562
+ *
563
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
564
+ *
565
+ * @template T Type of the value input
566
+ * @param input A value to encode
567
+ * @returns Encoded binary data
568
+ *
569
+ * @author Jeongho Nam - https://github.com/samchon
570
+ */
571
+ export function validateEncode<T>(input: T): IValidation<Uint8Array>;
572
+
573
+ /**
574
+ * Protocol Buffer Encoder with type validation.
575
+ *
576
+ * `typia.protobuf.validateEncode()` is a combination function of
577
+ * {@link validation} and {@link encode}.
578
+ *
579
+ * Therefore, it converts an `input` value to a binary data of
580
+ * Protocol Buffer, with type validation. If `input` value is not valid, it returns
581
+ * {@link IValidation.IFailure} value with detailed error reasons. Otherwise, there's
582
+ * no problem on the `input` value, Protocol Buffer binary data would be stored in
583
+ * `data` property of the output {@link IValidation.ISuccess} instance.
584
+ *
585
+ * If you can trust `input` value, or want to perform other type of validation, use
586
+ * below functions intead.
587
+ *
588
+ * - {@link encode}
589
+ * - {@link assertEncode}
590
+ * - {@link isEncode}
591
+ *
592
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
593
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
594
+ * type that is not compatible with Protocol Buffer, this function would throw
595
+ * compilation errors.
596
+ *
597
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
598
+ *
599
+ * @template T Type of the value input
600
+ * @param input A value to encode
601
+ * @returns Encoded binary data
602
+ *
603
+ * @author Jeongho Nam - https://github.com/samchon
604
+ */
605
+ export function validateEncode<T>(input: unknown): IValidation<Uint8Array>;
606
+
607
+ /**
608
+ * @internal
609
+ */
610
+ export function validateEncode(): never {
611
+ halt("validateEncode");
612
+ }
613
+
614
+ /* -----------------------------------------------------------
615
+ FACTORY FUNCTIONS
616
+ ----------------------------------------------------------- */
617
+ /**
618
+ * Creates a reusable {@link decode} function.
619
+ *
620
+ * @danger You must configure the generic argument `T`
621
+ * @returns Nothing until you configure the generic argument `T`
622
+ * @throws compile error
623
+ *
624
+ * @author Jeongho Nam - https://github.com/samchon
625
+ */
626
+ export function createDecode(): never;
627
+
628
+ /**
629
+ * Creates a reusable {@link decode} function.
630
+ *
631
+ * @template T Target type
632
+ * @returns A reusable `decode` function
633
+ *
634
+ * @author Jeongho Nam - https://github.com/samchon
635
+ */
636
+ export function createDecode<T>(): (input: Uint8Array) => Resolved<T>;
637
+
638
+ /**
639
+ * @internal
640
+ */
641
+ export function createDecode<T>(): (input: Uint8Array) => Resolved<T> {
642
+ halt("createDecode");
643
+ }
644
+
645
+ /**
646
+ * Creates a reusable {@link isDecode} function.
647
+ *
648
+ * @danger You must configure the generic argument `T`
649
+ * @returns Nothing until you configure the generic argument `T`
650
+ * @throws compile error
651
+ *
652
+ * @author Jeongho Nam - https://github.com/samchon
653
+ */
654
+ export function createIsDecode(): never;
655
+
656
+ /**
657
+ * Creates a reusable {@link isDecode} function.
658
+ *
659
+ * @template T Target type
660
+ * @returns A reusable `isDecode` function
661
+ *
662
+ * @author Jeongho Nam - https://github.com/samchon
663
+ */
664
+ export function createIsDecode<T>(): (input: Uint8Array) => Resolved<T> | null;
665
+
666
+ /**
667
+ * @internal
668
+ */
669
+ export function createIsDecode<T>(): (input: Uint8Array) => Resolved<T> | null {
670
+ halt("createIsDecode");
671
+ }
672
+
673
+ /**
674
+ * Creates a reusable {@link assertDecode} function.
675
+ *
676
+ * @danger You must configure the generic argument `T`
677
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
678
+ * @returns Nothing until you configure the generic argument `T`
679
+ * @throws compile error
680
+ *
681
+ * @author Jeongho Nam - https://github.com/samchon
682
+ */
683
+ export function createAssertDecode(
684
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
685
+ ): never;
686
+
687
+ /**
688
+ * Creates a reusable {@link assertDecode} function.
689
+ *
690
+ * @template T Target type
691
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
692
+ * @returns A reusable `assertDecode` function
693
+ *
694
+ * @author Jeongho Nam - https://github.com/samchon
695
+ */
696
+ export function createAssertDecode<T>(
697
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
698
+ ): (input: Uint8Array) => Resolved<T>;
699
+
700
+ /**
701
+ * @internal
702
+ */
703
+ export function createAssertDecode<T>(): (input: Uint8Array) => Resolved<T> {
704
+ halt("createAssertDecode");
705
+ }
706
+
707
+ /**
708
+ * Creates a reusable {@link validateDecode} function.
709
+ *
710
+ * @danger You must configure the generic argument `T`
711
+ * @returns Nothing until you configure the generic argument `T`
712
+ * @throws compile error
713
+ *
714
+ * @author Jeongho Nam - https://github.com/samchon
715
+ */
716
+ export function createValidateDecode(): never;
717
+
718
+ /**
719
+ * Creates a reusable {@link validateDecode} function.
720
+ *
721
+ * @template T Target type
722
+ * @returns A reusable `validateDecode` function
723
+ *
724
+ * @author Jeongho Nam - https://github.com/samchon
725
+ */
726
+ export function createValidateDecode<T>(): (
727
+ input: Uint8Array,
728
+ ) => IValidation<Resolved<T>>;
729
+
730
+ /**
731
+ * @internal
732
+ */
733
+ export function createValidateDecode<T>(): (
734
+ input: Uint8Array,
735
+ ) => IValidation<Resolved<T>> {
736
+ halt("createValidateDecode");
737
+ }
738
+
739
+ /**
740
+ * Creates a reusable {@link encode} function.
741
+ *
742
+ * @danger You must configure the generic argument `T`
743
+ * @returns Nothing until you configure the generic argument `T`
744
+ * @throws compile error
745
+ *
746
+ * @author Jeongho Nam - https://github.com/samchon
747
+ */
748
+ export function createEncode(): never;
749
+
750
+ /**
751
+ * Creates a reusable {@link encode} function.
752
+ *
753
+ * @template T Target type
754
+ * @returns A reusable `encode` function
755
+ *
756
+ * @author Jeongho Nam - https://github.com/samchon
757
+ */
758
+ export function createEncode<T>(): (input: T) => Uint8Array;
759
+
760
+ /**
761
+ * @internal
762
+ */
763
+ export function createEncode<T>(): (input: T) => Uint8Array {
764
+ halt("createEncode");
765
+ }
766
+
767
+ /**
768
+ * Creates a reusable {@link isEncode} function.
769
+ *
770
+ * @danger You must configure the generic argument `T`
771
+ * @returns Nothing until you configure the generic argument `T`
772
+ * @throws compile error
773
+ *
774
+ * @author Jeongho Nam - https://github.com/samchon
775
+ */
776
+ export function createIsEncode(): never;
777
+
778
+ /**
779
+ * Creates a reusable {@link isEncode} function.
780
+ *
781
+ * @template T Target type
782
+ * @returns A reusable `isEncode` function
783
+ *
784
+ * @author Jeongho Nam - https://github.com/samchon
785
+ */
786
+ export function createIsEncode<T>(): (input: T) => Uint8Array | null;
787
+
788
+ /**
789
+ * @internal
790
+ */
791
+ export function createIsEncode<T>(): (input: T) => Uint8Array | null {
792
+ halt("createIsEncode");
793
+ }
794
+
795
+ /**
796
+ * Creates a reusable {@link assertEncode} function.
797
+ *
798
+ * @danger You must configure the generic argument `T`
799
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
800
+ * @returns Nothing until you configure the generic argument `T`
801
+ * @throws compile error
802
+ *
803
+ * @author Jeongho Nam - https://github.com/samchon
804
+ */
805
+ export function createAssertEncode(
806
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
807
+ ): never;
808
+
809
+ /**
810
+ * Creates a reusable {@link assertEncode} function.
811
+ *
812
+ * @template T Target type
813
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
814
+ * @returns A reusable `assertEncode` function
815
+ *
816
+ * @author Jeongho Nam - https://github.com/samchon
817
+ */
818
+ export function createAssertEncode<T>(
819
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
820
+ ): (input: T) => Uint8Array;
821
+
822
+ /**
823
+ * @internal
824
+ */
825
+ export function createAssertEncode<T>(): (input: T) => Uint8Array {
826
+ halt("createAssertEncode");
827
+ }
828
+
829
+ /**
830
+ * Creates a reusable {@link validateEncode} function.
831
+ *
832
+ * @danger You must configure the generic argument `T`
833
+ * @returns Nothing until you configure the generic argument `T`
834
+ * @throws compile error
835
+ *
836
+ * @author Jeongho Nam - https://github.com/samchon
837
+ */
838
+ export function createValidateEncode(): never;
839
+
840
+ /**
841
+ * Creates a reusable {@link validateEncode} function.
842
+ *
843
+ * @template T Target type
844
+ * @returns A reusable `validateEncode` function
845
+ *
846
+ * @author Jeongho Nam - https://github.com/samchon
847
+ */
848
+ export function createValidateEncode<T>(): (
849
+ input: T,
850
+ ) => IValidation<Uint8Array>;
851
+
852
+ /**
853
+ * @internal
854
+ */
855
+ export function createValidateEncode<T>(): (
856
+ input: T,
857
+ ) => IValidation<Uint8Array> {
858
+ halt("createValidateEncode");
859
+ }
860
+
861
+ /**
862
+ * @internal
863
+ */
864
+ function halt(name: string): never {
865
+ throw new Error(
866
+ `Error on typia.protobuf.${name}(): no transform has been configured. Read and follow https://typia.io/docs/setup please.`,
867
+ );
868
+ }