typia 8.0.3 → 8.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (501) hide show
  1. package/lib/AssertionGuard.d.mts +1 -0
  2. package/lib/CamelCase.d.mts +26 -0
  3. package/lib/IRandomGenerator.d.mts +40 -0
  4. package/lib/IReadableURLSearchParams.d.mts +9 -0
  5. package/lib/IValidation.d.mts +1 -0
  6. package/lib/PascalCase.d.mts +25 -0
  7. package/lib/Primitive.d.mts +49 -0
  8. package/lib/Resolved.d.mts +39 -0
  9. package/lib/SnakeCase.d.mts +31 -0
  10. package/lib/TypeGuardError.d.mts +17 -0
  11. package/lib/executable/TypiaGenerateWizard.d.mts +8 -0
  12. package/lib/executable/TypiaPatchWizard.d.mts +4 -0
  13. package/lib/executable/TypiaSetupWizard.d.mts +7 -0
  14. package/lib/executable/setup/ArgumentParser.d.mts +7 -0
  15. package/lib/executable/setup/CommandExecutor.d.mts +3 -0
  16. package/lib/executable/setup/FileRetriever.d.mts +7 -0
  17. package/lib/executable/setup/PackageManager.d.mts +24 -0
  18. package/lib/executable/setup/PluginConfigurator.d.mts +4 -0
  19. package/lib/executable/typia.d.mts +4 -0
  20. package/lib/factories/CommentFactory.d.mts +5 -0
  21. package/lib/factories/ExpressionFactory.d.mts +29 -0
  22. package/lib/factories/IdentifierFactory.d.mts +8 -0
  23. package/lib/factories/JsonMetadataFactory.d.mts +19 -0
  24. package/lib/factories/LiteralFactory.d.mts +4 -0
  25. package/lib/factories/MetadataCollection.d.mts +40 -0
  26. package/lib/factories/MetadataCommentTagFactory.d.mts +1 -0
  27. package/lib/factories/MetadataFactory.d.mts +48 -0
  28. package/lib/factories/MetadataTypeTagFactory.d.mts +20 -0
  29. package/lib/factories/MetadataTypeTagSchemaFactory.d.mts +7 -0
  30. package/lib/factories/NumericRangeFactory.d.mts +6 -0
  31. package/lib/factories/ProtobufFactory.d.mts +13 -0
  32. package/lib/factories/StatementFactory.d.mts +19 -0
  33. package/lib/factories/TemplateFactory.d.mts +4 -0
  34. package/lib/factories/TypeFactory.d.mts +16 -0
  35. package/lib/factories/ValueFactory.d.mts +8 -0
  36. package/lib/factories/internal/metadata/IMetadataIteratorProps.d.mts +14 -0
  37. package/lib/factories/internal/metadata/MetadataHelper.d.mts +4 -0
  38. package/lib/factories/internal/metadata/emend_metadata_atomics.d.mts +2 -0
  39. package/lib/factories/internal/metadata/emplace_metadata_alias.d.mts +3 -0
  40. package/lib/factories/internal/metadata/emplace_metadata_array_type.d.mts +8 -0
  41. package/lib/factories/internal/metadata/emplace_metadata_object.d.mts +3 -0
  42. package/lib/factories/internal/metadata/emplace_metadata_tuple.d.mts +4 -0
  43. package/lib/factories/internal/metadata/explore_metadata.d.mts +8 -0
  44. package/lib/factories/internal/metadata/iterate_metadata.d.mts +2 -0
  45. package/lib/factories/internal/metadata/iterate_metadata_alias.d.mts +2 -0
  46. package/lib/factories/internal/metadata/iterate_metadata_array.d.mts +2 -0
  47. package/lib/factories/internal/metadata/iterate_metadata_atomic.d.mts +6 -0
  48. package/lib/factories/internal/metadata/iterate_metadata_coalesce.d.mts +6 -0
  49. package/lib/factories/internal/metadata/iterate_metadata_collection.d.mts +6 -0
  50. package/lib/factories/internal/metadata/iterate_metadata_comment_tags.d.mts +6 -0
  51. package/lib/factories/internal/metadata/iterate_metadata_constant.d.mts +2 -0
  52. package/lib/factories/internal/metadata/iterate_metadata_escape.d.mts +2 -0
  53. package/lib/factories/internal/metadata/iterate_metadata_function.d.mts +2 -0
  54. package/lib/factories/internal/metadata/iterate_metadata_intersection.d.mts +2 -0
  55. package/lib/factories/internal/metadata/iterate_metadata_map.d.mts +2 -0
  56. package/lib/factories/internal/metadata/iterate_metadata_native.d.mts +2 -0
  57. package/lib/factories/internal/metadata/iterate_metadata_object.d.mts +2 -0
  58. package/lib/factories/internal/metadata/iterate_metadata_set.d.mts +2 -0
  59. package/lib/factories/internal/metadata/iterate_metadata_sort.d.mts +6 -0
  60. package/lib/factories/internal/metadata/iterate_metadata_template.d.mts +2 -0
  61. package/lib/factories/internal/metadata/iterate_metadata_tuple.d.mts +3 -0
  62. package/lib/factories/internal/metadata/iterate_metadata_union.d.mts +2 -0
  63. package/lib/functional.d.mts +490 -0
  64. package/lib/http.d.mts +717 -0
  65. package/lib/index.d.mts +3 -0
  66. package/lib/internal/_IProtobufWriter.d.mts +15 -0
  67. package/lib/internal/_ProtobufReader.d.mts +35 -0
  68. package/lib/internal/_ProtobufSizer.d.mts +36 -0
  69. package/lib/internal/_ProtobufWriter.d.mts +45 -0
  70. package/lib/internal/_accessExpressionAsString.d.mts +1 -0
  71. package/lib/internal/_assertGuard.d.mts +2 -0
  72. package/lib/internal/_functionalTypeGuardErrorFactory.d.mts +2 -0
  73. package/lib/internal/_httpFormDataReadArray.d.mts +1 -0
  74. package/lib/internal/_httpFormDataReadBigint.d.mts +1 -0
  75. package/lib/internal/_httpFormDataReadBlob.d.mts +1 -0
  76. package/lib/internal/_httpFormDataReadBoolean.d.mts +1 -0
  77. package/lib/internal/_httpFormDataReadFile.d.mts +1 -0
  78. package/lib/internal/_httpFormDataReadNumber.d.mts +1 -0
  79. package/lib/internal/_httpFormDataReadString.d.mts +1 -0
  80. package/lib/internal/_httpHeaderReadBigint.d.mts +1 -0
  81. package/lib/internal/_httpHeaderReadBoolean.d.mts +1 -0
  82. package/lib/internal/_httpHeaderReadNumber.d.mts +1 -0
  83. package/lib/internal/_httpParameterReadBigint.d.mts +1 -0
  84. package/lib/internal/_httpParameterReadBoolean.d.mts +1 -0
  85. package/lib/internal/_httpParameterReadNumber.d.mts +1 -0
  86. package/lib/internal/_httpParameterReadString.d.mts +1 -0
  87. package/lib/internal/_httpQueryParseURLSearchParams.d.mts +2 -0
  88. package/lib/internal/_httpQueryReadArray.d.mts +1 -0
  89. package/lib/internal/_httpQueryReadBigint.d.mts +1 -0
  90. package/lib/internal/_httpQueryReadBoolean.d.mts +1 -0
  91. package/lib/internal/_httpQueryReadNumber.d.mts +1 -0
  92. package/lib/internal/_httpQueryReadString.d.mts +1 -0
  93. package/lib/internal/_isBetween.d.mts +1 -0
  94. package/lib/internal/_isBigintString.d.mts +1 -0
  95. package/lib/internal/_isFormatByte.d.mts +1 -0
  96. package/lib/internal/_isFormatDate.d.mts +1 -0
  97. package/lib/internal/_isFormatDateTime.d.mts +1 -0
  98. package/lib/internal/_isFormatDuration.d.mts +1 -0
  99. package/lib/internal/_isFormatEmail.d.mts +1 -0
  100. package/lib/internal/_isFormatHostname.d.mts +1 -0
  101. package/lib/internal/_isFormatIdnEmail.d.mts +1 -0
  102. package/lib/internal/_isFormatIdnHostname.d.mts +1 -0
  103. package/lib/internal/_isFormatIpv4.d.mts +1 -0
  104. package/lib/internal/_isFormatIpv6.d.mts +1 -0
  105. package/lib/internal/_isFormatIri.d.mts +1 -0
  106. package/lib/internal/_isFormatIriReference.d.mts +1 -0
  107. package/lib/internal/_isFormatJsonPointer.d.mts +1 -0
  108. package/lib/internal/_isFormatPassword.d.mts +1 -0
  109. package/lib/internal/_isFormatRegex.d.mts +1 -0
  110. package/lib/internal/_isFormatRelativeJsonPointer.d.mts +1 -0
  111. package/lib/internal/_isFormatTime.d.mts +1 -0
  112. package/lib/internal/_isFormatUri.d.mts +1 -0
  113. package/lib/internal/_isFormatUriReference.d.mts +1 -0
  114. package/lib/internal/_isFormatUriTemplate.d.mts +1 -0
  115. package/lib/internal/_isFormatUrl.d.mts +1 -0
  116. package/lib/internal/_isFormatUuid.d.mts +1 -0
  117. package/lib/internal/_isTypeFloat.d.mts +1 -0
  118. package/lib/internal/_isTypeInt32.d.mts +1 -0
  119. package/lib/internal/_isTypeInt64.d.mts +1 -0
  120. package/lib/internal/_isTypeUint32.d.mts +1 -0
  121. package/lib/internal/_isTypeUint64.d.mts +1 -0
  122. package/lib/internal/_isUniqueItems.d.mts +1 -0
  123. package/lib/internal/_jsonStringifyNumber.d.mts +1 -0
  124. package/lib/internal/_jsonStringifyRest.d.mts +1 -0
  125. package/lib/internal/_jsonStringifyString.d.mts +13 -0
  126. package/lib/internal/_jsonStringifyTail.d.mts +1 -0
  127. package/lib/internal/_llmApplicationFinalize.d.mts +2 -0
  128. package/lib/internal/_miscCloneAny.d.mts +2 -0
  129. package/lib/internal/_notationAny.d.mts +1 -0
  130. package/lib/internal/_notationCamel.d.mts +1 -0
  131. package/lib/internal/_notationPascal.d.mts +1 -0
  132. package/lib/internal/_notationSnake.d.mts +1 -0
  133. package/lib/internal/_randomArray.d.mts +4 -0
  134. package/lib/internal/_randomBigint.d.mts +2 -0
  135. package/lib/internal/_randomBoolean.d.mts +1 -0
  136. package/lib/internal/_randomFormatByte.d.mts +1 -0
  137. package/lib/internal/_randomFormatDate.d.mts +4 -0
  138. package/lib/internal/_randomFormatDatetime.d.mts +4 -0
  139. package/lib/internal/_randomFormatDuration.d.mts +1 -0
  140. package/lib/internal/_randomFormatEmail.d.mts +1 -0
  141. package/lib/internal/_randomFormatHostname.d.mts +1 -0
  142. package/lib/internal/_randomFormatIdnEmail.d.mts +1 -0
  143. package/lib/internal/_randomFormatIdnHostname.d.mts +1 -0
  144. package/lib/internal/_randomFormatIpv4.d.mts +1 -0
  145. package/lib/internal/_randomFormatIpv6.d.mts +1 -0
  146. package/lib/internal/_randomFormatIri.d.mts +1 -0
  147. package/lib/internal/_randomFormatIriReference.d.mts +1 -0
  148. package/lib/internal/_randomFormatJsonPointer.d.mts +1 -0
  149. package/lib/internal/_randomFormatPassword.d.mts +1 -0
  150. package/lib/internal/_randomFormatRegex.d.mts +1 -0
  151. package/lib/internal/_randomFormatRelativeJsonPointer.d.mts +1 -0
  152. package/lib/internal/_randomFormatTime.d.mts +1 -0
  153. package/lib/internal/_randomFormatUri.d.mts +1 -0
  154. package/lib/internal/_randomFormatUriReference.d.mts +1 -0
  155. package/lib/internal/_randomFormatUriTemplate.d.mts +1 -0
  156. package/lib/internal/_randomFormatUrl.d.mts +1 -0
  157. package/lib/internal/_randomFormatUuid.d.mts +1 -0
  158. package/lib/internal/_randomInteger.d.mts +2 -0
  159. package/lib/internal/_randomNumber.d.mts +2 -0
  160. package/lib/internal/_randomPattern.d.mts +1 -0
  161. package/lib/internal/_randomPick.d.mts +1 -0
  162. package/lib/internal/_randomString.d.mts +2 -0
  163. package/lib/internal/_throwTypeGuardError.d.mts +2 -0
  164. package/lib/internal/_validateReport.d.mts +2 -0
  165. package/lib/internal/private/__notationCapitalize.d.mts +1 -0
  166. package/lib/internal/private/__notationUnsnake.d.mts +4 -0
  167. package/lib/json.d.mts +480 -0
  168. package/lib/llm.d.mts +322 -0
  169. package/lib/misc.d.mts +453 -0
  170. package/lib/module.d.mts +707 -0
  171. package/lib/notations.d.mts +551 -0
  172. package/lib/programmers/AssertProgrammer.d.mts +31 -0
  173. package/lib/programmers/CheckerProgrammer.d.mts +125 -0
  174. package/lib/programmers/FeatureProgrammer.d.mts +249 -0
  175. package/lib/programmers/ImportProgrammer.d.mts +35 -0
  176. package/lib/programmers/IsProgrammer.d.mts +65 -0
  177. package/lib/programmers/RandomProgrammer.d.mts +22 -0
  178. package/lib/programmers/TypiaProgrammer.d.mts +8 -0
  179. package/lib/programmers/ValidateProgrammer.d.mts +22 -0
  180. package/lib/programmers/functional/FunctionalAssertFunctionProgrammer.d.mts +28 -0
  181. package/lib/programmers/functional/FunctionalAssertParametersProgrammer.d.mts +28 -0
  182. package/lib/programmers/functional/FunctionalAssertReturnProgrammer.d.mts +30 -0
  183. package/lib/programmers/functional/FunctionalIsFunctionProgrammer.d.mts +20 -0
  184. package/lib/programmers/functional/FunctionalIsParametersProgrammer.d.mts +27 -0
  185. package/lib/programmers/functional/FunctionalIsReturnProgrammer.d.mts +29 -0
  186. package/lib/programmers/functional/FunctionalValidateFunctionProgrammer.d.mts +25 -0
  187. package/lib/programmers/functional/FunctionalValidateParametersProgrammer.d.mts +27 -0
  188. package/lib/programmers/functional/FunctionalValidateReturnProgrammer.d.mts +29 -0
  189. package/lib/programmers/functional/internal/FunctionalGeneralProgrammer.d.mts +12 -0
  190. package/lib/programmers/helpers/AtomicPredicator.d.mts +14 -0
  191. package/lib/programmers/helpers/CloneJoiner.d.mts +16 -0
  192. package/lib/programmers/helpers/FunctionProgrammer.d.mts +16 -0
  193. package/lib/programmers/helpers/HttpMetadataUtil.d.mts +5 -0
  194. package/lib/programmers/helpers/ICheckEntry.d.mts +12 -0
  195. package/lib/programmers/helpers/IExpressionEntry.d.mts +8 -0
  196. package/lib/programmers/helpers/NotationJoiner.d.mts +17 -0
  197. package/lib/programmers/helpers/OptionPredicator.d.mts +7 -0
  198. package/lib/programmers/helpers/ProtobufUtil.d.mts +14 -0
  199. package/lib/programmers/helpers/ProtobufWire.d.mts +29 -0
  200. package/lib/programmers/helpers/PruneJoiner.d.mts +18 -0
  201. package/lib/programmers/helpers/RandomJoiner.d.mts +23 -0
  202. package/lib/programmers/helpers/StringifyJoinder.d.mts +17 -0
  203. package/lib/programmers/helpers/StringifyPredicator.d.mts +5 -0
  204. package/lib/programmers/helpers/UnionExplorer.d.mts +79 -0
  205. package/lib/programmers/helpers/UnionPredicator.d.mts +11 -0
  206. package/lib/programmers/helpers/disable_function_programmer_declare.d.mts +2 -0
  207. package/lib/programmers/http/HttpAssertFormDataProgrammer.d.mts +15 -0
  208. package/lib/programmers/http/HttpAssertHeadersProgrammer.d.mts +15 -0
  209. package/lib/programmers/http/HttpAssertQueryProgrammer.d.mts +19 -0
  210. package/lib/programmers/http/HttpFormDataProgrammer.d.mts +17 -0
  211. package/lib/programmers/http/HttpHeadersProgrammer.d.mts +18 -0
  212. package/lib/programmers/http/HttpIsFormDataProgrammer.d.mts +14 -0
  213. package/lib/programmers/http/HttpIsHeadersProgrammer.d.mts +14 -0
  214. package/lib/programmers/http/HttpIsQueryProgrammer.d.mts +18 -0
  215. package/lib/programmers/http/HttpParameterProgrammer.d.mts +7 -0
  216. package/lib/programmers/http/HttpQueryProgrammer.d.mts +21 -0
  217. package/lib/programmers/http/HttpValidateFormDataProgrammer.d.mts +15 -0
  218. package/lib/programmers/http/HttpValidateHeadersProgrammer.d.mts +15 -0
  219. package/lib/programmers/http/HttpValidateQueryProgrammer.d.mts +19 -0
  220. package/lib/programmers/internal/check_array_length.d.mts +1 -0
  221. package/lib/programmers/internal/check_bigint.d.mts +1 -0
  222. package/lib/programmers/internal/check_dynamic_key.d.mts +1 -0
  223. package/lib/programmers/internal/check_dynamic_properties.d.mts +1 -0
  224. package/lib/programmers/internal/check_everything.d.mts +1 -0
  225. package/lib/programmers/internal/check_native.d.mts +1 -0
  226. package/lib/programmers/internal/check_number.d.mts +1 -0
  227. package/lib/programmers/internal/check_object.d.mts +1 -0
  228. package/lib/programmers/internal/check_string.d.mts +1 -0
  229. package/lib/programmers/internal/check_template.d.mts +1 -0
  230. package/lib/programmers/internal/check_union_array_like.d.mts +1 -0
  231. package/lib/programmers/internal/decode_union_object.d.mts +1 -0
  232. package/lib/programmers/internal/feature_object_entries.d.mts +1 -0
  233. package/lib/programmers/internal/json_schema_alias.d.mts +7 -0
  234. package/lib/programmers/internal/json_schema_array.d.mts +6 -0
  235. package/lib/programmers/internal/json_schema_bigint.d.mts +3 -0
  236. package/lib/programmers/internal/json_schema_boolean.d.mts +3 -0
  237. package/lib/programmers/internal/json_schema_constant.d.mts +3 -0
  238. package/lib/programmers/internal/json_schema_description.d.mts +5 -0
  239. package/lib/programmers/internal/json_schema_discriminator.d.mts +3 -0
  240. package/lib/programmers/internal/json_schema_escaped.d.mts +1 -0
  241. package/lib/programmers/internal/json_schema_native.d.mts +6 -0
  242. package/lib/programmers/internal/json_schema_number.d.mts +3 -0
  243. package/lib/programmers/internal/json_schema_object.d.mts +1 -0
  244. package/lib/programmers/internal/json_schema_plugin.d.mts +6 -0
  245. package/lib/programmers/internal/json_schema_station.d.mts +8 -0
  246. package/lib/programmers/internal/json_schema_string.d.mts +3 -0
  247. package/lib/programmers/internal/json_schema_template.d.mts +3 -0
  248. package/lib/programmers/internal/json_schema_title.d.mts +5 -0
  249. package/lib/programmers/internal/json_schema_tuple.d.mts +6 -0
  250. package/lib/programmers/internal/metadata_to_pattern.d.mts +1 -0
  251. package/lib/programmers/internal/postfix_of_tuple.d.mts +1 -0
  252. package/lib/programmers/internal/prune_object_properties.d.mts +1 -0
  253. package/lib/programmers/internal/stringify_dynamic_properties.d.mts +1 -0
  254. package/lib/programmers/internal/stringify_native.d.mts +1 -0
  255. package/lib/programmers/internal/stringify_regular_properties.d.mts +1 -0
  256. package/lib/programmers/internal/template_to_pattern.d.mts +1 -0
  257. package/lib/programmers/internal/wrap_metadata_rest_tuple.d.mts +1 -0
  258. package/lib/programmers/json/JsonApplicationProgrammer.d.mts +24 -0
  259. package/lib/programmers/json/JsonAssertParseProgrammer.d.mts +15 -0
  260. package/lib/programmers/json/JsonAssertStringifyProgrammer.d.mts +15 -0
  261. package/lib/programmers/json/JsonIsParseProgrammer.d.mts +14 -0
  262. package/lib/programmers/json/JsonIsStringifyProgrammer.d.mts +14 -0
  263. package/lib/programmers/json/JsonSchemasProgrammer.d.mts +9 -0
  264. package/lib/programmers/json/JsonStringifyProgrammer.d.mts +15 -0
  265. package/lib/programmers/json/JsonValidateParseProgrammer.d.mts +15 -0
  266. package/lib/programmers/json/JsonValidateStringifyProgrammer.d.mts +15 -0
  267. package/lib/programmers/llm/LlmApplicationProgrammer.d.mts +19 -0
  268. package/lib/programmers/llm/LlmModelPredicator.d.mts +16 -0
  269. package/lib/programmers/llm/LlmParametersProgrammer.d.mts +14 -0
  270. package/lib/programmers/llm/LlmSchemaProgrammer.d.mts +18 -0
  271. package/lib/programmers/misc/MiscAssertCloneProgrammer.d.mts +15 -0
  272. package/lib/programmers/misc/MiscAssertPruneProgrammer.d.mts +15 -0
  273. package/lib/programmers/misc/MiscCloneProgrammer.d.mts +15 -0
  274. package/lib/programmers/misc/MiscIsCloneProgrammer.d.mts +14 -0
  275. package/lib/programmers/misc/MiscIsPruneProgrammer.d.mts +14 -0
  276. package/lib/programmers/misc/MiscLiteralsProgrammer.d.mts +9 -0
  277. package/lib/programmers/misc/MiscPruneProgrammer.d.mts +15 -0
  278. package/lib/programmers/misc/MiscValidateCloneProgrammer.d.mts +15 -0
  279. package/lib/programmers/misc/MiscValidatePruneProgrammer.d.mts +15 -0
  280. package/lib/programmers/notations/NotationAssertGeneralProgrammer.d.mts +19 -0
  281. package/lib/programmers/notations/NotationGeneralProgrammer.d.mts +24 -0
  282. package/lib/programmers/notations/NotationIsGeneralProgrammer.d.mts +18 -0
  283. package/lib/programmers/notations/NotationValidateGeneralProgrammer.d.mts +19 -0
  284. package/lib/programmers/protobuf/ProtobufAssertDecodeProgrammer.d.mts +16 -0
  285. package/lib/programmers/protobuf/ProtobufAssertEncodeProgrammer.d.mts +16 -0
  286. package/lib/programmers/protobuf/ProtobufDecodeProgrammer.d.mts +15 -0
  287. package/lib/programmers/protobuf/ProtobufEncodeProgrammer.d.mts +15 -0
  288. package/lib/programmers/protobuf/ProtobufIsDecodeProgrammer.d.mts +15 -0
  289. package/lib/programmers/protobuf/ProtobufIsEncodeProgrammer.d.mts +15 -0
  290. package/lib/programmers/protobuf/ProtobufMessageProgrammer.d.mts +9 -0
  291. package/lib/programmers/protobuf/ProtobufValidateDecodeProgrammer.d.mts +15 -0
  292. package/lib/programmers/protobuf/ProtobufValidateEncodeProgrammer.d.mts +15 -0
  293. package/lib/protobuf.d.mts +661 -0
  294. package/lib/reflect.d.mts +35 -0
  295. package/lib/schemas/json/IJsonApplication.d.mts +12 -0
  296. package/lib/schemas/json/IJsonSchemaCollection.d.mts +23 -0
  297. package/lib/schemas/json/__IJsonApplication.d.mts +35 -0
  298. package/lib/schemas/llm/ILlmApplicationOfValidate.d.mts +5 -0
  299. package/lib/schemas/llm/ILlmFunctionOfValidate.d.mts +5 -0
  300. package/lib/schemas/metadata/IJsDocTagInfo.d.mts +10 -0
  301. package/lib/schemas/metadata/IMetadata.d.mts +31 -0
  302. package/lib/schemas/metadata/IMetadataAlias.d.mts +5 -0
  303. package/lib/schemas/metadata/IMetadataAliasType.d.mts +10 -0
  304. package/lib/schemas/metadata/IMetadataApplication.d.mts +6 -0
  305. package/lib/schemas/metadata/IMetadataArray.d.mts +5 -0
  306. package/lib/schemas/metadata/IMetadataArrayType.d.mts +8 -0
  307. package/lib/schemas/metadata/IMetadataAtomic.d.mts +5 -0
  308. package/lib/schemas/metadata/IMetadataComponents.d.mts +10 -0
  309. package/lib/schemas/metadata/IMetadataConstant.d.mts +9 -0
  310. package/lib/schemas/metadata/IMetadataConstantValue.d.mts +9 -0
  311. package/lib/schemas/metadata/IMetadataDictionary.d.mts +10 -0
  312. package/lib/schemas/metadata/IMetadataEscaped.d.mts +5 -0
  313. package/lib/schemas/metadata/IMetadataFunction.d.mts +7 -0
  314. package/lib/schemas/metadata/IMetadataMap.d.mts +7 -0
  315. package/lib/schemas/metadata/IMetadataNative.d.mts +5 -0
  316. package/lib/schemas/metadata/IMetadataObject.d.mts +5 -0
  317. package/lib/schemas/metadata/IMetadataObjectType.d.mts +11 -0
  318. package/lib/schemas/metadata/IMetadataParameter.d.mts +8 -0
  319. package/lib/schemas/metadata/IMetadataProperty.d.mts +8 -0
  320. package/lib/schemas/metadata/IMetadataSet.d.mts +6 -0
  321. package/lib/schemas/metadata/IMetadataTemplate.d.mts +6 -0
  322. package/lib/schemas/metadata/IMetadataTuple.d.mts +5 -0
  323. package/lib/schemas/metadata/IMetadataTupleType.d.mts +8 -0
  324. package/lib/schemas/metadata/IMetadataTypeTag.d.mts +9 -0
  325. package/lib/schemas/metadata/Metadata.d.mts +50 -0
  326. package/lib/schemas/metadata/MetadataAlias.d.mts +13 -0
  327. package/lib/schemas/metadata/MetadataAliasType.d.mts +16 -0
  328. package/lib/schemas/metadata/MetadataApplication.d.mts +13 -0
  329. package/lib/schemas/metadata/MetadataArray.d.mts +16 -0
  330. package/lib/schemas/metadata/MetadataArrayType.d.mts +14 -0
  331. package/lib/schemas/metadata/MetadataAtomic.d.mts +12 -0
  332. package/lib/schemas/metadata/MetadataComponents.d.mts +16 -0
  333. package/lib/schemas/metadata/MetadataConstant.d.mts +11 -0
  334. package/lib/schemas/metadata/MetadataConstantValue.d.mts +16 -0
  335. package/lib/schemas/metadata/MetadataEscaped.d.mts +12 -0
  336. package/lib/schemas/metadata/MetadataFunction.d.mts +15 -0
  337. package/lib/schemas/metadata/MetadataMap.d.mts +14 -0
  338. package/lib/schemas/metadata/MetadataNative.d.mts +12 -0
  339. package/lib/schemas/metadata/MetadataObject.d.mts +16 -0
  340. package/lib/schemas/metadata/MetadataObjectType.d.mts +20 -0
  341. package/lib/schemas/metadata/MetadataParameter.d.mts +15 -0
  342. package/lib/schemas/metadata/MetadataProperty.d.mts +16 -0
  343. package/lib/schemas/metadata/MetadataSet.d.mts +13 -0
  344. package/lib/schemas/metadata/MetadataTemplate.d.mts +15 -0
  345. package/lib/schemas/metadata/MetadataTuple.d.mts +12 -0
  346. package/lib/schemas/metadata/MetadataTupleType.d.mts +13 -0
  347. package/lib/schemas/protobuf/IProtobufProperty.d.mts +5 -0
  348. package/lib/schemas/protobuf/IProtobufPropertyType.d.mts +28 -0
  349. package/lib/schemas/protobuf/IProtobufSchema.d.mts +38 -0
  350. package/lib/tags/Constant.d.mts +10 -0
  351. package/lib/tags/ContentMediaType.d.mts +9 -0
  352. package/lib/tags/Default.d.mts +14 -0
  353. package/lib/tags/Example.d.mts +14 -0
  354. package/lib/tags/Examples.d.mts +10 -0
  355. package/lib/tags/ExclusiveMaximum.d.mts +18 -0
  356. package/lib/tags/ExclusiveMinimum.d.mts +18 -0
  357. package/lib/tags/Format.d.mts +17 -0
  358. package/lib/tags/JsonSchemaPlugin.d.mts +7 -0
  359. package/lib/tags/MaxItems.d.mts +11 -0
  360. package/lib/tags/MaxLength.d.mts +11 -0
  361. package/lib/tags/Maximum.d.mts +16 -0
  362. package/lib/tags/MinItems.d.mts +11 -0
  363. package/lib/tags/MinLength.d.mts +11 -0
  364. package/lib/tags/Minimum.d.mts +16 -0
  365. package/lib/tags/MultipleOf.d.mts +16 -0
  366. package/lib/tags/Pattern.d.mts +22 -0
  367. package/lib/tags/Sequence.d.mts +9 -0
  368. package/lib/tags/TagBase.d.mts +60 -0
  369. package/lib/tags/Type.d.mts +17 -0
  370. package/lib/tags/UniqueItems.d.mts +11 -0
  371. package/lib/tags/index.d.mts +21 -0
  372. package/lib/tags/internal/FormatCheatSheet.d.mts +27 -0
  373. package/lib/transform.d.mts +5 -0
  374. package/lib/transformers/CallExpressionTransformer.d.mts +8 -0
  375. package/lib/transformers/FileTransformer.d.mts +5 -0
  376. package/lib/transformers/IProgrammerProps.d.mts +9 -0
  377. package/lib/transformers/ITransformOptions.d.mts +59 -0
  378. package/lib/transformers/ITransformProps.d.mts +7 -0
  379. package/lib/transformers/ITypiaContext.d.mts +15 -0
  380. package/lib/transformers/ImportTransformer.d.mts +7 -0
  381. package/lib/transformers/NodeTransformer.d.mts +8 -0
  382. package/lib/transformers/TransformerError.d.mts +15 -0
  383. package/lib/transformers/features/AssertTransformer.d.mts +5 -0
  384. package/lib/transformers/features/CreateAssertTransformer.d.mts +5 -0
  385. package/lib/transformers/features/CreateIsTransformer.d.mts +5 -0
  386. package/lib/transformers/features/CreateRandomTransformer.d.mts +5 -0
  387. package/lib/transformers/features/CreateValidateTransformer.d.mts +5 -0
  388. package/lib/transformers/features/IsTransformer.d.mts +5 -0
  389. package/lib/transformers/features/RandomTransformer.d.mts +5 -0
  390. package/lib/transformers/features/ValidateTransformer.d.mts +5 -0
  391. package/lib/transformers/features/functional/FunctionalGenericTransformer.d.mts +21 -0
  392. package/lib/transformers/features/http/CreateHttpAssertFormDataTransformer.d.mts +4 -0
  393. package/lib/transformers/features/http/CreateHttpAssertHeadersTransformer.d.mts +4 -0
  394. package/lib/transformers/features/http/CreateHttpAssertQueryTransformer.d.mts +4 -0
  395. package/lib/transformers/features/http/CreateHttpFormDataTransformer.d.mts +4 -0
  396. package/lib/transformers/features/http/CreateHttpHeadersTransformer.d.mts +4 -0
  397. package/lib/transformers/features/http/CreateHttpIsFormDataTransformer.d.mts +4 -0
  398. package/lib/transformers/features/http/CreateHttpIsHeadersTransformer.d.mts +4 -0
  399. package/lib/transformers/features/http/CreateHttpIsQueryTransformer.d.mts +4 -0
  400. package/lib/transformers/features/http/CreateHttpParameterTransformer.d.mts +4 -0
  401. package/lib/transformers/features/http/CreateHttpQueryTransformer.d.mts +4 -0
  402. package/lib/transformers/features/http/CreateHttpValidateFormDataTransformer.d.mts +4 -0
  403. package/lib/transformers/features/http/CreateHttpValidateHeadersTransformer.d.mts +4 -0
  404. package/lib/transformers/features/http/CreateHttpValidateQueryTransformer.d.mts +4 -0
  405. package/lib/transformers/features/http/HttpAssertFormDataTransformer.d.mts +4 -0
  406. package/lib/transformers/features/http/HttpAssertHeadersTransformer.d.mts +4 -0
  407. package/lib/transformers/features/http/HttpAssertQueryTransformer.d.mts +4 -0
  408. package/lib/transformers/features/http/HttpFormDataTransformer.d.mts +4 -0
  409. package/lib/transformers/features/http/HttpHeadersTransformer.d.mts +4 -0
  410. package/lib/transformers/features/http/HttpIsFormDataTransformer.d.mts +4 -0
  411. package/lib/transformers/features/http/HttpIsHeadersTransformer.d.mts +4 -0
  412. package/lib/transformers/features/http/HttpIsQueryTransformer.d.mts +4 -0
  413. package/lib/transformers/features/http/HttpParameterTransformer.d.mts +4 -0
  414. package/lib/transformers/features/http/HttpQueryTransformer.d.mts +4 -0
  415. package/lib/transformers/features/http/HttpValidateFormDataTransformer.d.mts +4 -0
  416. package/lib/transformers/features/http/HttpValidateHeadersTransformer.d.mts +4 -0
  417. package/lib/transformers/features/http/HttpValidateQueryTransformer.d.mts +4 -0
  418. package/lib/transformers/features/json/JsonAssertParseTransformer.d.mts +4 -0
  419. package/lib/transformers/features/json/JsonAssertStringifyTransformer.d.mts +4 -0
  420. package/lib/transformers/features/json/JsonCreateAssertParseTransformer.d.mts +4 -0
  421. package/lib/transformers/features/json/JsonCreateAssertStringifyTransformer.d.mts +4 -0
  422. package/lib/transformers/features/json/JsonCreateIsParseTransformer.d.mts +4 -0
  423. package/lib/transformers/features/json/JsonCreateIsStringifyTransformer.d.mts +4 -0
  424. package/lib/transformers/features/json/JsonCreateStringifyTransformer.d.mts +4 -0
  425. package/lib/transformers/features/json/JsonCreateValidateParseTransformer.d.mts +4 -0
  426. package/lib/transformers/features/json/JsonCreateValidateStringifyProgrammer.d.mts +4 -0
  427. package/lib/transformers/features/json/JsonIsParseTransformer.d.mts +4 -0
  428. package/lib/transformers/features/json/JsonIsStringifyTransformer.d.mts +4 -0
  429. package/lib/transformers/features/json/JsonSchemasTransformer.d.mts +5 -0
  430. package/lib/transformers/features/json/JsonStringifyTransformer.d.mts +4 -0
  431. package/lib/transformers/features/json/JsonValidateParseTransformer.d.mts +4 -0
  432. package/lib/transformers/features/json/JsonValidateStringifyTransformer.d.mts +4 -0
  433. package/lib/transformers/features/llm/LlmApplicationTransformer.d.mts +5 -0
  434. package/lib/transformers/features/llm/LlmParametersTransformer.d.mts +5 -0
  435. package/lib/transformers/features/llm/LlmSchemaTransformer.d.mts +5 -0
  436. package/lib/transformers/features/misc/MiscAssertCloneTransformer.d.mts +4 -0
  437. package/lib/transformers/features/misc/MiscAssertPruneTransformer.d.mts +4 -0
  438. package/lib/transformers/features/misc/MiscCloneTransformer.d.mts +4 -0
  439. package/lib/transformers/features/misc/MiscCreateAssertCloneTransformer.d.mts +4 -0
  440. package/lib/transformers/features/misc/MiscCreateAssertPruneTransformer.d.mts +4 -0
  441. package/lib/transformers/features/misc/MiscCreateCloneTransformer.d.mts +4 -0
  442. package/lib/transformers/features/misc/MiscCreateIsCloneTransformer.d.mts +4 -0
  443. package/lib/transformers/features/misc/MiscCreateIsPruneTransformer.d.mts +4 -0
  444. package/lib/transformers/features/misc/MiscCreatePruneTransformer.d.mts +4 -0
  445. package/lib/transformers/features/misc/MiscCreateValidateCloneTransformer.d.mts +4 -0
  446. package/lib/transformers/features/misc/MiscCreateValidatePruneTransformer.d.mts +4 -0
  447. package/lib/transformers/features/misc/MiscIsCloneTransformer.d.mts +4 -0
  448. package/lib/transformers/features/misc/MiscIsPruneTransformer.d.mts +4 -0
  449. package/lib/transformers/features/misc/MiscLiteralsTransformer.d.mts +5 -0
  450. package/lib/transformers/features/misc/MiscPruneTransformer.d.mts +4 -0
  451. package/lib/transformers/features/misc/MiscValidateCloneTransformer.d.mts +4 -0
  452. package/lib/transformers/features/misc/MiscValidatePruneTransformer.d.mts +4 -0
  453. package/lib/transformers/features/notations/NotationAssertGeneralTransformer.d.mts +4 -0
  454. package/lib/transformers/features/notations/NotationCreateAssertGeneralTransformer.d.mts +4 -0
  455. package/lib/transformers/features/notations/NotationCreateGeneralTransformer.d.mts +4 -0
  456. package/lib/transformers/features/notations/NotationCreateIsGeneralTransformer.d.mts +4 -0
  457. package/lib/transformers/features/notations/NotationCreateValidateGeneralTransformer.d.mts +4 -0
  458. package/lib/transformers/features/notations/NotationGeneralTransformer.d.mts +4 -0
  459. package/lib/transformers/features/notations/NotationIsGeneralTransformer.d.mts +4 -0
  460. package/lib/transformers/features/notations/NotationValidateGeneralTransformer.d.mts +4 -0
  461. package/lib/transformers/features/protobuf/ProtobufAssertDecodeTransformer.d.mts +4 -0
  462. package/lib/transformers/features/protobuf/ProtobufAssertEncodeTransformer.d.mts +4 -0
  463. package/lib/transformers/features/protobuf/ProtobufCreateAssertDecodeTransformer.d.mts +4 -0
  464. package/lib/transformers/features/protobuf/ProtobufCreateAssertEncodeTransformer.d.mts +4 -0
  465. package/lib/transformers/features/protobuf/ProtobufCreateDecodeTransformer.d.mts +4 -0
  466. package/lib/transformers/features/protobuf/ProtobufCreateEncodeTransformer.d.mts +4 -0
  467. package/lib/transformers/features/protobuf/ProtobufCreateIsDecodeTransformer.d.mts +4 -0
  468. package/lib/transformers/features/protobuf/ProtobufCreateIsEncodeTransformer.d.mts +4 -0
  469. package/lib/transformers/features/protobuf/ProtobufCreateValidateDecodeTransformer.d.mts +4 -0
  470. package/lib/transformers/features/protobuf/ProtobufCreateValidateEncodeTransformer.d.mts +4 -0
  471. package/lib/transformers/features/protobuf/ProtobufDecodeTransformer.d.mts +4 -0
  472. package/lib/transformers/features/protobuf/ProtobufEncodeTransformer.d.mts +4 -0
  473. package/lib/transformers/features/protobuf/ProtobufIsDecodeTransformer.d.mts +4 -0
  474. package/lib/transformers/features/protobuf/ProtobufIsEncodeTransformer.d.mts +4 -0
  475. package/lib/transformers/features/protobuf/ProtobufMessageTransformer.d.mts +5 -0
  476. package/lib/transformers/features/protobuf/ProtobufValidateDecodeTransformer.d.mts +4 -0
  477. package/lib/transformers/features/protobuf/ProtobufValidateEncodeTransformer.d.mts +4 -0
  478. package/lib/transformers/features/reflect/ReflectMetadataTransformer.d.mts +5 -0
  479. package/lib/transformers/features/reflect/ReflectNameTransformer.d.mts +5 -0
  480. package/lib/transformers/internal/GenericTransformer.d.mts +11 -0
  481. package/lib/typings/Atomic.d.mts +11 -0
  482. package/lib/typings/ClassProperties.d.mts +4 -0
  483. package/lib/typings/Customizable.d.mts +5 -0
  484. package/lib/typings/Equal.d.mts +15 -0
  485. package/lib/typings/IsTuple.d.mts +5 -0
  486. package/lib/typings/NativeClass.d.mts +1 -0
  487. package/lib/typings/OmitNever.d.mts +2 -0
  488. package/lib/typings/ProtobufAtomic.d.mts +5 -0
  489. package/lib/typings/SpecialFields.d.mts +3 -0
  490. package/lib/typings/ValidationPipe.d.mts +7 -0
  491. package/lib/typings/ValueOf.d.mts +6 -0
  492. package/lib/typings/Writable.d.mts +5 -0
  493. package/lib/utils/ArrayUtil.d.mts +7 -0
  494. package/lib/utils/Escaper.d.mts +4 -0
  495. package/lib/utils/MapUtil.d.mts +3 -0
  496. package/lib/utils/NamingConvention.d.mts +5 -0
  497. package/lib/utils/PatternUtil.d.mts +7 -0
  498. package/lib/utils/ProtobufNameEncoder.d.mts +4 -0
  499. package/lib/utils/Singleton.d.mts +6 -0
  500. package/lib/utils/StringUtil.d.mts +8 -0
  501. package/package.json +4 -5
@@ -0,0 +1,661 @@
1
+ import { IValidation } from "./IValidation";
2
+ import { Resolved } from "./Resolved";
3
+ import { TypeGuardError } from "./TypeGuardError";
4
+ /**
5
+ * > You must configure the generic argument `T`.
6
+ *
7
+ * Protocol Buffer Message Schema.
8
+ *
9
+ * Creates a Protocol Buffer Message Schema from a TypeScript type. The message
10
+ * schema would be returned as a string value, and it can be used to share with
11
+ * other developers/languages/frameworks.
12
+ *
13
+ * For reference, Protocol Buffer has lots of restrictions, so that expression power
14
+ * of Protocol Buffer is not enough strong to fully meet the TypeScript type specs.
15
+ * In such reason, if you put a TypeScript type that is not compatible with Protocol
16
+ * Buffer, this function would throw compilation errors.
17
+ *
18
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
19
+ *
20
+ * @template T Target type
21
+ * @returns Protocol Buffer Message Schema.
22
+ *
23
+ * @author Jeongho Nam - https://github.com/samchon
24
+ */
25
+ export declare function message(): never;
26
+ /**
27
+ * Protocol Buffer Message Schema.
28
+ *
29
+ * Creates a Protocol Buffer Message Schema from a TypeScript type. The message
30
+ * schema would be returned as a string value, and it can be used to share with
31
+ * other developers/languages/frameworks.
32
+ *
33
+ * For reference, Protocol Buffer has lots of restrictions, so that expression power
34
+ * of Protocol Buffer is not enough strong to fully meet the TypeScript type specs.
35
+ * In such reason, if you put a TypeScript type that is not compatible with Protocol
36
+ * Buffer, this function would throw compilation errors.
37
+ *
38
+ * @template T Target type
39
+ * @returns Protocol Buffer Message Schema.
40
+ *
41
+ * @author Jeongho Nam - https://github.com/samchon
42
+ */
43
+ export declare function message<T>(): string;
44
+ /**
45
+ * > You must configure the generic argument `T`.
46
+ *
47
+ * Protocol Buffer Decoder.
48
+ *
49
+ * `typia.protobuf.decode()` is a function decoding a binary data of Protocol Buffer
50
+ * format to a TypeScript instance.
51
+ *
52
+ * For reference, as Protocol Buffer handles binary data directly, there's no way
53
+ * when `input` binary data was not encoded from the `T` typed value. In that case,
54
+ * unexpected behavior or internal error would be occurred. Therefore, I recommend you
55
+ * to encode binary data of Protocol Buffer from type safe encode functions like below.
56
+ * Use {@link encode} function only when you can ensure it.
57
+ *
58
+ * - {@link assertEncode}
59
+ * - {@link isEncode}
60
+ * - {@link validateEncode}
61
+ *
62
+ * Also, `typia` is providing type safe decoders like {@link assertDecode}, but it
63
+ * is just for additional type validation like `number & Minimum<7>` or
64
+ * `string & Format<"uuid">` cases, that are represented by
65
+ * [custom tags](https://typia.io/docs/validators/tags). Thus, I repeat that,
66
+ * you've to ensure the type safety when using decoder functions.
67
+ *
68
+ * @template T Expected type of decoded value
69
+ * @param input Protobuf Buffer binary data
70
+ * @returns Decoded value
71
+ *
72
+ * @author Jeongho Nam - https://github.com/samchon
73
+ */
74
+ export declare function decode(input: Uint8Array): never;
75
+ /**
76
+ * Protocol Buffer Decoder.
77
+ *
78
+ * `typia.protobuf.decode()` is a function decoding a binary data of Protocol Buffer
79
+ * format to a TypeScript instance.
80
+ *
81
+ * For reference, as Protocol Buffer handles binary data directly, there's no way
82
+ * when `input` binary data was not encoded from the `T` typed value. In that case,
83
+ * unexpected behavior or internal error would be occurred. Therefore, I recommend you
84
+ * to encode binary data of Protocol Buffer from type safe encode functions like below.
85
+ * Use {@link encode} function only when you can ensure it.
86
+ *
87
+ * - {@link assertEncode}
88
+ * - {@link isEncode}
89
+ * - {@link validateEncode}
90
+ *
91
+ * Also, `typia` is providing type safe decoders like {@link assertDecode}, but it
92
+ * is just for additional type validation like `number & Minimum<7>` or
93
+ * `string & Format<"uuid">` cases, that are represented by
94
+ * [custom tags](https://typia.io/docs/validators/tags). Thus, I repeat that,
95
+ * you've to ensure the type safety when using decoder functions.
96
+ *
97
+ * @template T Expected type of decoded value
98
+ * @param input Protobuf Buffer binary data
99
+ * @returns Decoded value
100
+ *
101
+ * @author Jeongho Nam - https://github.com/samchon
102
+ */
103
+ export declare function decode<T>(input: Uint8Array): Resolved<T>;
104
+ /**
105
+ * > You must configure the generic argument `T`.
106
+ *
107
+ * Protocol Buffer Decoder wity type assertion, but not safe.
108
+ *
109
+ * `typia.protobuf.assertDecode()` is a combination function of {@link decode} and
110
+ * {@link assert} function. Therefore, it decodes a binary data of Protocol Buffer to
111
+ * a TypeScript instance, and performs type assertion process. If decoded value is
112
+ * following the type `T`, it returns the decoded value. Otherwise, it throws
113
+ * {@link TypeGuardError} instead.
114
+ *
115
+ * However, note that, this validation is not always safe. It just performs additional
116
+ * type assertion like `number & Minimum<7>` or `string & Format<"uuid">` cases,
117
+ * that are represented by [custom tags](https://typia.io/docs/validators/tags).
118
+ * Therefore, when using `typia.protobuf.assertDecode<T>()` function, you have to
119
+ * ensure the type safety by yourself.
120
+ *
121
+ * In such type safety reason, I recommend you to use type safe encode functions.
122
+ *
123
+ * - {@link assertEncode}
124
+ * - {@link isEncode}
125
+ * - {@link validateEncode}
126
+ *
127
+ * @template T Expected type of decoded value
128
+ * @param input Protobuf Buffer binary data
129
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
130
+ * @returns Decoded value
131
+ *
132
+ * @author Jeongho Nam - https://github.com/samchon
133
+ */
134
+ export declare function assertDecode(input: Uint8Array, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never;
135
+ /**
136
+ * Protocol Buffer Decoder wity type assertion, but not safe.
137
+ *
138
+ * `typia.protobuf.assertDecode()` is a combination function of {@link decode} and
139
+ * {@link assert} function. Therefore, it decodes a binary data of Protocol Buffer to
140
+ * a TypeScript instance, and performs type assertion process. If decoded value is
141
+ * following the type `T`, it returns the decoded value. Otherwise, it throws
142
+ * {@link TypeGuardError} instead.
143
+ *
144
+ * However, note that, this validation is not always safe. It just performs additional
145
+ * type assertion like `number & Minimum<7>` or `string & Format<"uuid">` cases,
146
+ * that are represented by [custom tags](https://typia.io/docs/validators/tags).
147
+ * Therefore, when using `typia.protobuf.assertDecode<T>()` function, you have to
148
+ * ensure the type safety by yourself.
149
+ *
150
+ * In such type safety reason, I recommend you to use type safe encode functions.
151
+ *
152
+ * - {@link assertEncode}
153
+ * - {@link isEncode}
154
+ * - {@link validateEncode}
155
+ *
156
+ * @template T Expected type of decoded value
157
+ * @param input Protobuf Buffer binary data
158
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
159
+ * @returns Decoded value
160
+ *
161
+ * @author Jeongho Nam - https://github.com/samchon
162
+ */
163
+ export declare function assertDecode<T>(input: Uint8Array, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): Resolved<T>;
164
+ /**
165
+ * > You must configure the generic argument `T`.
166
+ *
167
+ * Protocol Buffer Decoder wity type checking, but not safe.
168
+ *
169
+ * `typia.protobuf.isDecode()` is a combination function of {@link decode} and
170
+ * {@link is} function. Therefore, it decodes a binary data of Protocol Buffer to
171
+ * a TypeScript instance, and performs type checking process. If decoded value is
172
+ * following the type `T`, it returns the decoded value. Otherwise, it returns
173
+ * `null` value instead.
174
+ *
175
+ * However, note that, this validation is not always safe. It just performs additional
176
+ * type checking like `number & Minimum<7>` or `string & Format<"uuid">` cases,
177
+ * that are represented by [custom tags](https://typia.io/docs/validators/tags).
178
+ * Therefore, when using `typia.protobuf.isDecode<T>()` function, you have to
179
+ * ensure the type safety by yourself.
180
+ *
181
+ * In such type safety reason, I recommend you to use type safe encode functions.
182
+ *
183
+ * - {@link assertEncode}
184
+ * - {@link isEncode}
185
+ * - {@link validateEncode}
186
+ *
187
+ * @template T Expected type of decoded value
188
+ * @param input Protobuf Buffer binary data
189
+ * @returns Decoded value
190
+ *
191
+ * @author Jeongho Nam - https://github.com/samchon
192
+ */
193
+ export declare function isDecode(input: Uint8Array): never;
194
+ /**
195
+ * Protocol Buffer Decoder wity type checking, but not safe.
196
+ *
197
+ * `typia.protobuf.isDecode()` is a combination function of {@link decode} and
198
+ * {@link is} function. Therefore, it decodes a binary data of Protocol Buffer to
199
+ * a TypeScript instance, and performs type checking process. If decoded value is
200
+ * following the type `T`, it returns the decoded value. Otherwise, it returns
201
+ * `null` value instead.
202
+ *
203
+ * However, note that, this validation is not always safe. It just performs additional
204
+ * type checking like `number & Minimum<7>` or `string & Format<"uuid">` cases,
205
+ * that are represented by [custom tags](https://typia.io/docs/validators/tags).
206
+ * Therefore, when using `typia.protobuf.isDecode<T>()` function, you have to
207
+ * ensure the type safety by yourself.
208
+ *
209
+ * In such type safety reason, I recommend you to use type safe encode functions.
210
+ *
211
+ * - {@link assertEncode}
212
+ * - {@link isEncode}
213
+ * - {@link validateEncode}
214
+ *
215
+ * @template T Expected type of decoded value
216
+ * @param input Protobuf Buffer binary data
217
+ * @returns Decoded value
218
+ *
219
+ * @author Jeongho Nam - https://github.com/samchon
220
+ */
221
+ export declare function isDecode<T>(input: Uint8Array): Resolved<T> | null;
222
+ /**
223
+ * > You must configure the generic argument `T`.
224
+ *
225
+ * Protocol Buffer Decoder wity type validation, but not safe.
226
+ *
227
+ * `typia.protobuf.validateDecode()` is a combination function of {@link decode} and
228
+ * {@link validate} function. Therefore, it decodes a binary data of Protocol Buffer to
229
+ * a TypeScript instance, and performs type validation process. If decoded value is
230
+ * following the type `T`, it returns the decoded value with
231
+ * {@link IValidation.ISuccess} typed instance. Otherwise, it returns
232
+ * {@link IValidation.IFailure} value instead with detailed error reasons.
233
+ *
234
+ * However, note that, this validation is not always safe. It just performs additional
235
+ * type validation like `number & Minimum<7>` or `string & Format<"uuid">` cases,
236
+ * that are represented by [custom tags](https://typia.io/docs/validators/tags).
237
+ * Therefore, when using `typia.protobuf.validateDecode<T>()` function, you have to
238
+ * ensure the type safety by yourself.
239
+ *
240
+ * In such type safety reason, I recommend you to use type safe encode functions.
241
+ *
242
+ * - {@link assertEncode}
243
+ * - {@link isEncode}
244
+ * - {@link validateEncode}
245
+ *
246
+ * @template T Expected type of decoded value
247
+ * @param input Protobuf Buffer binary data
248
+ * @returns Decoded value
249
+ *
250
+ * @author Jeongho Nam - https://github.com/samchon
251
+ */
252
+ export declare function validateDecode(input: Uint8Array): never;
253
+ /**
254
+ * Protocol Buffer Decoder wity type validation, but not safe.
255
+ *
256
+ * `typia.protobuf.validateDecode()` is a combination function of {@link decode} and
257
+ * {@link validate} function. Therefore, it decodes a binary data of Protocol Buffer to
258
+ * a TypeScript instance, and performs type validation process. If decoded value is
259
+ * following the type `T`, it returns the decoded value with
260
+ * {@link IValidation.ISuccess} typed instance. Otherwise, it returns
261
+ * {@link IValidation.IFailure} value instead with detailed error reasons.
262
+ *
263
+ * However, note that, this validation is not always safe. It just performs additional
264
+ * type validation like `number & Minimum<7>` or `string & Format<"uuid">` cases,
265
+ * that are represented by [custom tags](https://typia.io/docs/validators/tags).
266
+ * Therefore, when using `typia.protobuf.validateDecode<T>()` function, you have to
267
+ * ensure the type safety by yourself.
268
+ *
269
+ * In such type safety reason, I recommend you to use type safe encode functions.
270
+ *
271
+ * - {@link assertEncode}
272
+ * - {@link isEncode}
273
+ * - {@link validateEncode}
274
+ *
275
+ * @template T Expected type of decoded value
276
+ * @param input Protobuf Buffer binary data
277
+ * @returns Decoded value
278
+ *
279
+ * @author Jeongho Nam - https://github.com/samchon
280
+ */
281
+ export declare function validateDecode<T>(input: Uint8Array): IValidation<Resolved<T>>;
282
+ /**
283
+ * Protocol Buffer Encoder.
284
+ *
285
+ * Converts an input value to a binary data of Protocol Buffer format.
286
+ *
287
+ * For reference, this `typia.protobuf.encode()` does not validate the `input` value.
288
+ * It just believes that the `input` value is valid and converts it to a binary data
289
+ * directly. Therefore, if you can't ensure the `input` value type, it would better to
290
+ * call one of below functions instead.
291
+ *
292
+ * - {@link assertEncode}
293
+ * - {@link isEncode}
294
+ * - {@link validateEncode}
295
+ *
296
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
297
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
298
+ * type that is not compatible with Protocol Buffer, this function would throw
299
+ * compilation errors.
300
+ *
301
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
302
+ *
303
+ * @template T Type of the value input
304
+ * @param input A value to encode
305
+ * @returns Encoded binary data
306
+ *
307
+ * @author Jeongho Nam - https://github.com/samchon
308
+ */
309
+ export declare function encode<T>(input: T): Uint8Array;
310
+ /**
311
+ * Protocol Buffer Encoder with type assertion.
312
+ *
313
+ * `typia.protobuf.assertEncode()` is a combination function of {@link assert} and
314
+ * {@link encode}.
315
+ *
316
+ * Therefore, it converts an `input` value to a binary data of
317
+ * Protocol Buffer, with type assertion. If `input` value is not valid, it throws
318
+ * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value,
319
+ * Protocol Buffer binary data would be returned.
320
+ *
321
+ * If you can trust `input` value, or want to perform other type of validation, use
322
+ * below functions instead.
323
+ *
324
+ * - {@link encode}
325
+ * - {@link isEncode}
326
+ * - {@link validateEncode}
327
+ *
328
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
329
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
330
+ * type that is not compatible with Protocol Buffer, this function would throw
331
+ * compilation errors.
332
+ *
333
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
334
+ *
335
+ * @template T Type of the value input
336
+ * @param input A value to encode
337
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
338
+ * @returns Encoded binary data
339
+ *
340
+ * @author Jeongho Nam - https://github.com/samchon
341
+ */
342
+ export declare function assertEncode<T>(input: T, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): Uint8Array;
343
+ /**
344
+ * Protocol Buffer Encoder with type assertion.
345
+ *
346
+ * `typia.protobuf.assertEncode()` is a combination function of {@link assert} and
347
+ * {@link encode}.
348
+ *
349
+ * Therefore, it converts an `input` value to a binary data of
350
+ * Protocol Buffer, with type assertion. If `input` value is not valid, it throws
351
+ * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value,
352
+ * Protocol Buffer binary data would be returned.
353
+ *
354
+ * If you can trust `input` value, or want to perform other type of validation, use
355
+ * below functions instead.
356
+ *
357
+ * - {@link encode}
358
+ * - {@link isEncode}
359
+ * - {@link validateEncode}
360
+ *
361
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
362
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
363
+ * type that is not compatible with Protocol Buffer, this function would throw
364
+ * compilation errors.
365
+ *
366
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
367
+ *
368
+ * @template T Type of the value input
369
+ * @param input A value to encode
370
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
371
+ * @returns Encoded binary data
372
+ *
373
+ * @author Jeongho Nam - https://github.com/samchon
374
+ */
375
+ export declare function assertEncode<T>(input: unknown, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): Uint8Array;
376
+ /**
377
+ * Protocol Buffer Encoder with type checking.
378
+ *
379
+ * `typia.protobuf.isEncode()` is a combination function of {@link is} and
380
+ * {@link encode}.
381
+ *
382
+ * Therefore, it converts an `input` value to a binary data of
383
+ * Protocol Buffer, with type checking. If `input` value is not valid, it returns
384
+ * `null` value. Otherwise, there's no problem on the `input` value, Protocol
385
+ * Buffer binary data would be returned.
386
+ *
387
+ * If you can trust `input` value, or want to perform other type of validation, use
388
+ * below functions instead.
389
+ *
390
+ * - {@link encode}
391
+ * - {@link assertEncode}
392
+ * - {@link validateEncode}
393
+ *
394
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
395
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
396
+ * type that is not compatible with Protocol Buffer, this function would throw
397
+ * compilation errors.
398
+ *
399
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
400
+ *
401
+ * @template T Type of the value input
402
+ * @param input A value to encode
403
+ * @returns Encoded binary data
404
+ *
405
+ * @author Jeongho Nam - https://github.com/samchon
406
+ */
407
+ export declare function isEncode<T>(input: T): Uint8Array | null;
408
+ /**
409
+ * Protocol Buffer Encoder with type checking.
410
+ *
411
+ * `typia.protobuf.isEncode()` is a combination function of {@link is} and
412
+ * {@link encode}.
413
+ *
414
+ * Therefore, it converts an `input` value to a binary data of
415
+ * Protocol Buffer, with type checking. If `input` value is not valid, it returns
416
+ * `null` value. Otherwise, there's no problem on the `input` value, Protocol
417
+ * Buffer binary data would be returned.
418
+ *
419
+ * If you can trust `input` value, or want to perform other type of validation, use
420
+ * below functions instead.
421
+ *
422
+ * - {@link encode}
423
+ * - {@link assertEncode}
424
+ * - {@link validateEncode}
425
+ *
426
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
427
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
428
+ * type that is not compatible with Protocol Buffer, this function would throw
429
+ * compilation errors.
430
+ *
431
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
432
+ *
433
+ * @template T Type of the value input
434
+ * @param input A value to encode
435
+ * @returns Encoded binary data
436
+ *
437
+ * @author Jeongho Nam - https://github.com/samchon
438
+ */
439
+ export declare function isEncode<T>(input: unknown): Uint8Array | null;
440
+ /**
441
+ * Protocol Buffer Encoder with type validation.
442
+ *
443
+ * `typia.protobuf.validateEncode()` is a combination function of
444
+ * {@link validation} and {@link encode}.
445
+ *
446
+ * Therefore, it converts an `input` value to a binary data of
447
+ * Protocol Buffer, with type validation. If `input` value is not valid, it returns
448
+ * {@link IValidation.IFailure} value with detailed error reasons. Otherwise, there's
449
+ * no problem on the `input` value, Protocol Buffer binary data would be stored in
450
+ * `data` property of the output {@link IValidation.ISuccess} instance.
451
+ *
452
+ * If you can trust `input` value, or want to perform other type of validation, use
453
+ * below functions instead.
454
+ *
455
+ * - {@link encode}
456
+ * - {@link assertEncode}
457
+ * - {@link isEncode}
458
+ *
459
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
460
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
461
+ * type that is not compatible with Protocol Buffer, this function would throw
462
+ * compilation errors.
463
+ *
464
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
465
+ *
466
+ * @template T Type of the value input
467
+ * @param input A value to encode
468
+ * @returns Encoded binary data
469
+ *
470
+ * @author Jeongho Nam - https://github.com/samchon
471
+ */
472
+ export declare function validateEncode<T>(input: T): IValidation<Uint8Array>;
473
+ /**
474
+ * Protocol Buffer Encoder with type validation.
475
+ *
476
+ * `typia.protobuf.validateEncode()` is a combination function of
477
+ * {@link validation} and {@link encode}.
478
+ *
479
+ * Therefore, it converts an `input` value to a binary data of
480
+ * Protocol Buffer, with type validation. If `input` value is not valid, it returns
481
+ * {@link IValidation.IFailure} value with detailed error reasons. Otherwise, there's
482
+ * no problem on the `input` value, Protocol Buffer binary data would be stored in
483
+ * `data` property of the output {@link IValidation.ISuccess} instance.
484
+ *
485
+ * If you can trust `input` value, or want to perform other type of validation, use
486
+ * below functions instead.
487
+ *
488
+ * - {@link encode}
489
+ * - {@link assertEncode}
490
+ * - {@link isEncode}
491
+ *
492
+ * By the way, you know what? Expression power of Protocol Buffer is not enough strong
493
+ * to fully meet the TypeScript type specs. In such reason, if you put a TypeScript
494
+ * type that is not compatible with Protocol Buffer, this function would throw
495
+ * compilation errors.
496
+ *
497
+ * - [Restrictions of Protocol Buffer](https://typia.io/docs/protobuf/message/#restrictions)
498
+ *
499
+ * @template T Type of the value input
500
+ * @param input A value to encode
501
+ * @returns Encoded binary data
502
+ *
503
+ * @author Jeongho Nam - https://github.com/samchon
504
+ */
505
+ export declare function validateEncode<T>(input: unknown): IValidation<Uint8Array>;
506
+ /**
507
+ * Creates a reusable {@link decode} function.
508
+ *
509
+ * @danger You must configure the generic argument `T`
510
+ * @returns Nothing until you configure the generic argument `T`
511
+ * @throws compile error
512
+ *
513
+ * @author Jeongho Nam - https://github.com/samchon
514
+ */
515
+ export declare function createDecode(): never;
516
+ /**
517
+ * Creates a reusable {@link decode} function.
518
+ *
519
+ * @template T Target type
520
+ * @returns A reusable `decode` function
521
+ *
522
+ * @author Jeongho Nam - https://github.com/samchon
523
+ */
524
+ export declare function createDecode<T>(): (input: Uint8Array) => Resolved<T>;
525
+ /**
526
+ * Creates a reusable {@link isDecode} function.
527
+ *
528
+ * @danger You must configure the generic argument `T`
529
+ * @returns Nothing until you configure the generic argument `T`
530
+ * @throws compile error
531
+ *
532
+ * @author Jeongho Nam - https://github.com/samchon
533
+ */
534
+ export declare function createIsDecode(): never;
535
+ /**
536
+ * Creates a reusable {@link isDecode} function.
537
+ *
538
+ * @template T Target type
539
+ * @returns A reusable `isDecode` function
540
+ *
541
+ * @author Jeongho Nam - https://github.com/samchon
542
+ */
543
+ export declare function createIsDecode<T>(): (input: Uint8Array) => Resolved<T> | null;
544
+ /**
545
+ * Creates a reusable {@link assertDecode} function.
546
+ *
547
+ * @danger You must configure the generic argument `T`
548
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
549
+ * @returns Nothing until you configure the generic argument `T`
550
+ * @throws compile error
551
+ *
552
+ * @author Jeongho Nam - https://github.com/samchon
553
+ */
554
+ export declare function createAssertDecode(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never;
555
+ /**
556
+ * Creates a reusable {@link assertDecode} function.
557
+ *
558
+ * @template T Target type
559
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
560
+ * @returns A reusable `assertDecode` function
561
+ *
562
+ * @author Jeongho Nam - https://github.com/samchon
563
+ */
564
+ export declare function createAssertDecode<T>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: Uint8Array) => Resolved<T>;
565
+ /**
566
+ * Creates a reusable {@link validateDecode} function.
567
+ *
568
+ * @danger You must configure the generic argument `T`
569
+ * @returns Nothing until you configure the generic argument `T`
570
+ * @throws compile error
571
+ *
572
+ * @author Jeongho Nam - https://github.com/samchon
573
+ */
574
+ export declare function createValidateDecode(): never;
575
+ /**
576
+ * Creates a reusable {@link validateDecode} function.
577
+ *
578
+ * @template T Target type
579
+ * @returns A reusable `validateDecode` function
580
+ *
581
+ * @author Jeongho Nam - https://github.com/samchon
582
+ */
583
+ export declare function createValidateDecode<T>(): (input: Uint8Array) => IValidation<Resolved<T>>;
584
+ /**
585
+ * Creates a reusable {@link encode} function.
586
+ *
587
+ * @danger You must configure the generic argument `T`
588
+ * @returns Nothing until you configure the generic argument `T`
589
+ * @throws compile error
590
+ *
591
+ * @author Jeongho Nam - https://github.com/samchon
592
+ */
593
+ export declare function createEncode(): never;
594
+ /**
595
+ * Creates a reusable {@link encode} function.
596
+ *
597
+ * @template T Target type
598
+ * @returns A reusable `encode` function
599
+ *
600
+ * @author Jeongho Nam - https://github.com/samchon
601
+ */
602
+ export declare function createEncode<T>(): (input: T) => Uint8Array;
603
+ /**
604
+ * Creates a reusable {@link isEncode} function.
605
+ *
606
+ * @danger You must configure the generic argument `T`
607
+ * @returns Nothing until you configure the generic argument `T`
608
+ * @throws compile error
609
+ *
610
+ * @author Jeongho Nam - https://github.com/samchon
611
+ */
612
+ export declare function createIsEncode(): never;
613
+ /**
614
+ * Creates a reusable {@link isEncode} function.
615
+ *
616
+ * @template T Target type
617
+ * @returns A reusable `isEncode` function
618
+ *
619
+ * @author Jeongho Nam - https://github.com/samchon
620
+ */
621
+ export declare function createIsEncode<T>(): (input: T) => Uint8Array | null;
622
+ /**
623
+ * Creates a reusable {@link assertEncode} function.
624
+ *
625
+ * @danger You must configure the generic argument `T`
626
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
627
+ * @returns Nothing until you configure the generic argument `T`
628
+ * @throws compile error
629
+ *
630
+ * @author Jeongho Nam - https://github.com/samchon
631
+ */
632
+ export declare function createAssertEncode(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never;
633
+ /**
634
+ * Creates a reusable {@link assertEncode} function.
635
+ *
636
+ * @template T Target type
637
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
638
+ * @returns A reusable `assertEncode` function
639
+ *
640
+ * @author Jeongho Nam - https://github.com/samchon
641
+ */
642
+ export declare function createAssertEncode<T>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: T) => Uint8Array;
643
+ /**
644
+ * Creates a reusable {@link validateEncode} function.
645
+ *
646
+ * @danger You must configure the generic argument `T`
647
+ * @returns Nothing until you configure the generic argument `T`
648
+ * @throws compile error
649
+ *
650
+ * @author Jeongho Nam - https://github.com/samchon
651
+ */
652
+ export declare function createValidateEncode(): never;
653
+ /**
654
+ * Creates a reusable {@link validateEncode} function.
655
+ *
656
+ * @template T Target type
657
+ * @returns A reusable `validateEncode` function
658
+ *
659
+ * @author Jeongho Nam - https://github.com/samchon
660
+ */
661
+ export declare function createValidateEncode<T>(): (input: T) => IValidation<Uint8Array>;
@@ -0,0 +1,35 @@
1
+ import { IMetadataApplication } from "./schemas/metadata/IMetadataApplication";
2
+ /**
3
+ * > You must configure the generic argument `Types`.
4
+ *
5
+ * Metadata Application.
6
+ *
7
+ * Creates a Metadata application which contains the metadata and components.
8
+ *
9
+ * Note that, all of the collection types like Array, Tuple and Objects are
10
+ * stored in the {@link IMetadataApplication.components} property. Also, alias
11
+ * types are stored in the {@link IMetadataApplication.aliases} property, too.
12
+ *
13
+ * @template Types Tuple of target types
14
+ * @returns Metadata application
15
+ *
16
+ * @author Jeongho Nam - https://github.com/samchon
17
+ */
18
+ export declare function metadata(): never;
19
+ /**
20
+ * Metadata Application.
21
+ *
22
+ * Creates a Metadata application which contains the metadata and components.
23
+ *
24
+ * Note that, all of the collection types like Array, Tuple and Objects are
25
+ * stored in the {@link IMetadataApplication.components} property. Also, alias
26
+ * types are stored in the {@link IMetadataApplication.aliases} property, too.
27
+ *
28
+ * @template Types Tuple of target types
29
+ * @returns Metadata application
30
+ *
31
+ * @author Jeongho Nam - https://github.com/samchon
32
+ */
33
+ export declare function metadata<Types extends unknown[]>(): IMetadataApplication;
34
+ export declare function name<T, Regular extends boolean = false>(): string;
35
+ export declare function name(): never;