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
package/lib/http.d.mts ADDED
@@ -0,0 +1,717 @@
1
+ import { Atomic } from "./typings/Atomic";
2
+ import { IReadableURLSearchParams } from "./IReadableURLSearchParams";
3
+ import { IValidation } from "./IValidation";
4
+ import { Resolved } from "./Resolved";
5
+ import { TypeGuardError } from "./TypeGuardError";
6
+ /**
7
+ * Form data decoder.
8
+ *
9
+ * `typia.http.formData()` is a function decoding `FormData` instance, with
10
+ * automatic type casting to the expected type. When roperty type be defined
11
+ * as `boolean` or `Blob` type, `typia.http.formData()` will cast the value to
12
+ * the expected type when decoding.
13
+ *
14
+ * By the way, as `FormData` is not enough to express complex data structures,
15
+ * `typia.http.formData()` function has some limitations. If target type `T` is
16
+ * not following those restrictions, compilation errors would be occurred.
17
+ *
18
+ * 1. Type `T` must be an object type
19
+ * 2. Do not allow dynamic property
20
+ * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array types are allowed
21
+ * 4. By the way, union type never be not allowed
22
+ *
23
+ * Also, `typia.http.formData()` function does not perform validation about the
24
+ * decoded value. Therefore, if you can't sure that input data is following the
25
+ * `T` type, it would better to call one of below functions instead.
26
+ *
27
+ * @template T Expected type of decoded value
28
+ * @param input FormData instance
29
+ * @returns Decoded form FormData
30
+ *
31
+ * @author Jeongho Nam - https://github.com/samchon
32
+ */
33
+ export declare function formData<T extends object>(input: FormData): Resolved<T>;
34
+ /**
35
+ * Form data decoder with type assertion.
36
+ *
37
+ * `typia.http.assertFormData()` is a function decoding `FormData` instance, with
38
+ * automatic type casting to the expected type. When roperty type be defined
39
+ * as `boolean` or `Blob` type, `typia.http.assertFormData()` will cast the value
40
+ * to the expected type when decoding.
41
+ *
42
+ * Also, after decoding, `typia.http.assertFormData()` performs type assertion to
43
+ * the decoded value by combining with {@link assert} function. Therefore, when
44
+ * the decoded value is not following the `T` type, {@link TypeGuardError} or
45
+ * custom error generated by *errorFactory* would be thrown.
46
+ *
47
+ * By the way, as `FormData` is not enough to express complex data structures,
48
+ * `typia.http.assertFormData()` function has some limitations. If target type `T`
49
+ * is not following those restrictions, compilation errors would be occurred.
50
+ *
51
+ * 1. Type `T` must be an object type
52
+ * 2. Do not allow dynamic property
53
+ * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array types are allowed
54
+ * 4. By the way, union type never be not allowed
55
+ *
56
+ * @template T Expected type of decoded value
57
+ * @param input FormData instance
58
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
59
+ * @returns Decoded form FormData
60
+ *
61
+ * @author Jeongho Nam - https://github.com/samchon
62
+ */
63
+ export declare function assertFormData<T extends object>(input: FormData, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): Resolved<T>;
64
+ /**
65
+ * Form data decoder with type checking.
66
+ *
67
+ * `typia.http.isFormData()` is a function decoding `FormData` instance, with
68
+ * automatic type casting to the expected type. When roperty type be defined
69
+ * as `boolean` or `Blob` type, `typia.http.isFormData()` will cast the value
70
+ * to the expected type when decoding.
71
+ *
72
+ * Also, after decoding, `typia.http.isFormData()` performs type checking to the
73
+ * decoded value by combining with {@link is} function. Therefore, when the
74
+ * decoded value is not following the `T` type, `null` value would be returned.
75
+ *
76
+ * By the way, as `FormData` is not enough to express complex data structures,
77
+ * `typia.http.isFormData()` function has some limitations. If target type `T` is
78
+ * not following those restrictions, compilation errors would be occurred.
79
+ *
80
+ * 1. Type `T` must be an object type
81
+ * 2. Do not allow dynamic property
82
+ * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array types are allowed
83
+ * 4. By the way, union type never be not allowed
84
+ *
85
+ * @template T Expected type of decoded value
86
+ * @param input FormData instance
87
+ * @returns Decoded form FormData or `null` value
88
+ *
89
+ * @author Jeongho Nam - https://github.com/samchon
90
+ */
91
+ export declare function isFormData<T extends object>(input: FormData): Resolved<T> | null;
92
+ /**
93
+ * Form data decoder with type validation.
94
+ *
95
+ * `typia.http.validateFormData()` is a function decoding `FormData` instance,
96
+ * with automatic type casting to the expected type. When roperty type be defined
97
+ * as `boolean` or `Blob` type, `typia.http.validateFormData()` will cast the
98
+ * value to the expected type when decoding.
99
+ *
100
+ * Also, after decoding, `typia.http.validateFormData()` performs type validation
101
+ * to the decoded value by combining with {@link validate} function. Therefore,
102
+ * when the decoded value is not following the `T` type,
103
+ * {@link IValidation.IFailure} would be returned. Otherwise,
104
+ * x@xxxx IValidation.ISuccess} would be returned.
105
+ *
106
+ * By the way, as `FormData` is not enough to express complex data structures,
107
+ * `typia.http.validateFormData()` function has some limitations. If target type
108
+ * `T` is not following those restrictions, compilation errors would be occurred.
109
+ *
110
+ * 1. Type `T` must be an object type
111
+ * 2. Do not allow dynamic property
112
+ * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array types are allowed
113
+ * 4. By the way, union type never be not allowed
114
+ *
115
+ * @template T Expected type of decoded value
116
+ * @param input FormData instance
117
+ * @returns Validation result with decoded form FormData
118
+ *
119
+ * @author Jeongho Nam - https://github.com/samchon
120
+ */
121
+ export declare function validateFormData<T extends object>(input: FormData): IValidation<Resolved<T>>;
122
+ /**
123
+ * URL query decoder.
124
+ *
125
+ * `typia.http.query()` is a function decoding a query string or an `URLSearchParams`
126
+ * instance, with automatic type casting to the expected type. When property type be
127
+ * defined as `boolean` or `number` type, `typia.http.query()` will cast the value to
128
+ * the expected type when decoding.
129
+ *
130
+ * By the way, as URL query is not enough to express complex data structures,
131
+ * `typia.http.query()` function has some limitations. If target type `T` is not
132
+ * following those restrictions, compilation errors would be occurred.
133
+ *
134
+ * 1. Type `T` must be an object type
135
+ * 2. Do not allow dynamic property
136
+ * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
137
+ * 4. By the way, union type never be not allowed
138
+ *
139
+ * Also, `typia.http.query()` function does not perform validation about the decoded
140
+ * value. Therefore, if you can't sure that input data is following the `T` type,
141
+ * it would better to call one of below functions instead.
142
+ *
143
+ * - {@link assertQuery}
144
+ * - {@link isQuery}
145
+ * - {@link validateQuery}
146
+ *
147
+ * @template T Expected type of decoded value
148
+ * @param input Query string or URLSearchParams instance
149
+ * @returns Decoded query object
150
+ *
151
+ * @author Jeongho Nam - https://github.com/samchon
152
+ */
153
+ export declare function query<T extends object>(input: string | IReadableURLSearchParams): Resolved<T>;
154
+ /**
155
+ * URL query decoder with type assertion.
156
+ *
157
+ * `typia.http.assertQuery()` is a function decoding a query string or an
158
+ * `URLSearchParams` instance, with automatic type casting to the expected type.
159
+ * When property type be defined as `boolean` or `number` type,
160
+ * `typia.http.assertQuery()` will cast the value to the expected type when decoding.
161
+ *
162
+ * Also, after decoding, `typia.http.assertQuery()` performs type assertion to the
163
+ * decoded value by combining with {@link assert} function. Therefore, when the
164
+ * decoded value is not following the `T` type, {@link TypeGuardError} or custom
165
+ * error generated by *errorFactory* would be thrown.
166
+ *
167
+ * By the way, as URL query is not enough to express complex data structures,
168
+ * `typia.http.assertQuery()` function has some limitations. If target type `T` is
169
+ * notfollowing those restrictions, compilation errors would be occurred.
170
+ *
171
+ * 1. Type `T` must be an object type
172
+ * 2. Do not allow dynamic property
173
+ * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
174
+ * 4. By the way, union type never be not allowed
175
+ *
176
+ * @template T Expected type of decoded value
177
+ * @param input Query string or URLSearchParams instance
178
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
179
+ * @returns Decoded query object
180
+ *
181
+ * @author Jeongho Nam - https://github.com/samchon
182
+ */
183
+ export declare function assertQuery<T extends object>(input: string | IReadableURLSearchParams, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): Resolved<T>;
184
+ /**
185
+ * URL query decoder with type checking.
186
+ *
187
+ * `typia.http.isQuery()` is a function decoding a query string or an
188
+ * `URLSearchParams` instance, with automatic type casting to the expected type.
189
+ * When property type be defined as `boolean` or `number` type,
190
+ * `typia.http.isQuery()` will cast the value to the expected type when decoding.
191
+ *
192
+ * Also, after decoding, `typia.http.isQuery()` performs type checking to the
193
+ * decoded value by combining with {@link is} function. Therefore, when the
194
+ * decoded value is not following the `T` type, `null` value would be returned.
195
+ *
196
+ * By the way, as URL query is not enough to express complex data structures,
197
+ * `typia.http.isQuery()` function has some limitations. If target type `T` is
198
+ * notfollowing those restrictions, compilation errors would be occurred.
199
+ *
200
+ * 1. Type `T` must be an object type
201
+ * 2. Do not allow dynamic property
202
+ * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
203
+ * 4. By the way, union type never be not allowed
204
+ *
205
+ * @template T Expected type of decoded value
206
+ * @param input Query string or URLSearchParams instance
207
+ * @returns Decoded query object or `null` value
208
+ *
209
+ * @author Jeongho Nam - https://github.com/samchon
210
+ */
211
+ export declare function isQuery<T extends object>(input: string | IReadableURLSearchParams): Resolved<T> | null;
212
+ /**
213
+ * URL query decoder with type validation.
214
+ *
215
+ * `typia.http.validateQuery()` is a function decoding a query string or an
216
+ * `URLSearchParams` instance, with automatic type casting to the expected type.
217
+ * When property type be defined as `boolean` or `number` type,
218
+ * `typia.http.validateQuery()` will cast the value to the expected type when decoding.
219
+ *
220
+ * Also, after decoding, `typia.http.validateQuery()` performs type validation to the
221
+ * decoded value by combining with {@link validate} function. Therefore, when the
222
+ * decoded value is not following the `T` type, {@link IValidation.IFailure} would
223
+ * be returned. Otherwise, {@link IValidation.ISuccess} would be returned.
224
+ *
225
+ * By the way, as URL query is not enough to express complex data structures,
226
+ * `typia.http.validateQuery()` function has some limitations. If target type `T` is
227
+ * notfollowing those restrictions, compilation errors would be occurred.
228
+ *
229
+ * 1. Type `T` must be an object type
230
+ * 2. Do not allow dynamic property
231
+ * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
232
+ * 4. By the way, union type never be not allowed
233
+ *
234
+ * @template T Expected type of decoded value
235
+ * @param input Query string or URLSearchParams instance
236
+ * @returns Validation result with decoded query object
237
+ *
238
+ * @author Jeongho Nam - https://github.com/samchon
239
+ */
240
+ export declare function validateQuery<T extends object>(input: string | IReadableURLSearchParams): IValidation<Resolved<T>>;
241
+ /**
242
+ * Headers decoder (for express and fastify).
243
+ *
244
+ * `typia.http.headers()` is a function decoding an header instance, with automatic
245
+ * type casting to the expected type. When property type be defined as `boolean` or
246
+ * `number` type, `typia.http.headers()` will cast the value to the expected type.
247
+ *
248
+ * By the way, as HTTP headers are not enough to express complex data structures,
249
+ * `typia.http.headers()` function has some limitations. If target type `T` is not
250
+ * following those restrictions, compilation errors would be occurred.
251
+ *
252
+ * 1. Type `T` must be an object type
253
+ * 2. Do not allow dynamic property
254
+ * 3. Property key must be lower case
255
+ * 4. Property value cannot be `null`, but `undefined` is possible
256
+ * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
257
+ * 6. By the way, union type never be not allowed
258
+ * 7. Property `set-cookie` must be array type
259
+ * 8. Those properties cannot be array type
260
+ * - age
261
+ * - authorization
262
+ * - content-length
263
+ * - content-type
264
+ * - etag
265
+ * - expires
266
+ * - from
267
+ * - host
268
+ * - if-modified-since
269
+ * - if-unmodified-since
270
+ * - last-modified
271
+ * - location
272
+ * - max-forwards
273
+ * - proxy-authorization
274
+ * - referer
275
+ * - retry-after
276
+ * - server
277
+ * - user-agent
278
+ *
279
+ * Also, `typia.http.headers()` function does not perform validation about the decoded
280
+ * value. Therefore, if you can't sure that input data is following the `T` type,
281
+ * it would better to call one of below functions instead.
282
+ *
283
+ * - {@link assertHeaders}
284
+ * - {@link isHeaders}
285
+ * - {@link validateHeaders}
286
+ *
287
+ * @template T Expected type of decoded value
288
+ * @param input Query string or URLSearchParams instance
289
+ * @returns Decoded headers object
290
+ *
291
+ * @author Jeongho Nam - https://github.com/samchon
292
+ */
293
+ export declare function headers<T extends object>(input: Record<string, string | string[] | undefined>): Resolved<T>;
294
+ /**
295
+ * Headers decoder with type assertion (for express and fastify).
296
+ *
297
+ * `typia.http.assertHeaders()` is a function decoding an header instance, with
298
+ * automatic type casting to the expected type. When property type be defined as
299
+ * `boolean` or `number` type, `typia.http.headers()` will cast the value to the
300
+ * expected type.
301
+ *
302
+ * Also, after decoding, `typia.http.assertHeaders()` performs type assertion to the
303
+ * decoded value by combining with {@link assert} function. Therefore, when the
304
+ * decoded value is not following the `T` type, {@link TypeGuardError} or custom
305
+ * error generated by *errorFactory* would be thrown.
306
+ *
307
+ * By the way, as HTTP headers are not enough to express complex data structures,
308
+ * `typia.http.headers()` function has some limitations. If target type `T` is not
309
+ * following those restrictions, compilation errors would be occurred.
310
+ *
311
+ * 1. Type `T` must be an object type
312
+ * 2. Do not allow dynamic property
313
+ * 3. Property key must be lower case
314
+ * 4. Property value cannot be `null`, but `undefined` is possible
315
+ * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
316
+ * 6. By the way, union type never be not allowed
317
+ * 7. Property `set-cookie` must be array type
318
+ * 8. Those properties cannot be array type
319
+ * - age
320
+ * - authorization
321
+ * - content-length
322
+ * - content-type
323
+ * - etag
324
+ * - expires
325
+ * - from
326
+ * - host
327
+ * - if-modified-since
328
+ * - if-unmodified-since
329
+ * - last-modified
330
+ * - location
331
+ * - max-forwards
332
+ * - proxy-authorization
333
+ * - referer
334
+ * - retry-after
335
+ * - server
336
+ * - user-agent
337
+ *
338
+ * @template T Expected type of decoded value
339
+ * @param input Query string or URLSearchParams instance
340
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
341
+ * @returns Decoded headers object
342
+ *
343
+ * @author Jeongho Nam - https://github.com/samchon
344
+ */
345
+ export declare function assertHeaders<T extends object>(input: Record<string, string | string[] | undefined>, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): Resolved<T>;
346
+ /**
347
+ * > You must configure the generic argument `T`.
348
+ *
349
+ * Headers decoder with type checking (for express and fastify).
350
+ *
351
+ * `typia.http.isHeaders()` is a function decoding an header instance, with
352
+ * automatic type casting to the expected type. When property type be defined as
353
+ * `boolean` or `number` type, `typia.http.headers()` will cast the value to the
354
+ * expected type.
355
+ *
356
+ * Also, after decoding, `typia.http.isHeaders()` performs type checking to the
357
+ * decoded value by combining with {@link is} function. Therefore, when the
358
+ * decoded value is not following the `T` type, `null` value would be returned.
359
+ *
360
+ * By the way, as HTTP headers are not enough to express complex data structures,
361
+ * `typia.http.headers()` function has some limitations. If target type `T` is not
362
+ * following those restrictions, compilation errors would be occurred.
363
+ *
364
+ * 1. Type `T` must be an object type
365
+ * 2. Do not allow dynamic property
366
+ * 3. Property key must be lower case
367
+ * 4. Property value cannot be `null`, but `undefined` is possible
368
+ * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
369
+ * 6. By the way, union type never be not allowed
370
+ * 7. Property `set-cookie` must be array type
371
+ * 8. Those properties cannot be array type
372
+ * - age
373
+ * - authorization
374
+ * - content-length
375
+ * - content-type
376
+ * - etag
377
+ * - expires
378
+ * - from
379
+ * - host
380
+ * - if-modified-since
381
+ * - if-unmodified-since
382
+ * - last-modified
383
+ * - location
384
+ * - max-forwards
385
+ * - proxy-authorization
386
+ * - referer
387
+ * - retry-after
388
+ * - server
389
+ * - user-agent
390
+ *
391
+ * @template T Expected type of decoded value
392
+ * @param input Query string or URLSearchParams instance
393
+ * @returns Decoded headers object or `null` value
394
+ *
395
+ * @author Jeongho Nam - https://github.com/samchon
396
+ */
397
+ export declare function isHeaders<T extends object>(input: Record<string, string | string[] | undefined>): Resolved<T> | null;
398
+ /**
399
+ * Headers decoder with type validation (for express and fastify).
400
+ *
401
+ * `typia.http.validateHeaders()` is a function decoding an header instance, with
402
+ * automatic type casting to the expected type. When property type be defined as
403
+ * `boolean` or `number` type, `typia.http.headers()` will cast the value to the
404
+ * expected type.
405
+ *
406
+ * Also, after decoding, `typia.http.validateHeaders()` performs type assertion to the
407
+ * decoded value by combining with {@link validate} function. Therefore, when the
408
+ * decoded value is not following the `T` type, {@link IValidation.IError} would be
409
+ * returned. Otherwise, {@link IValidation.ISuccess} be returned.
410
+ *
411
+ * By the way, as HTTP headers are not enough to express complex data structures,
412
+ * `typia.http.headers()` function has some limitations. If target type `T` is not
413
+ * following those restrictions, compilation errors would be occurred.
414
+ *
415
+ * 1. Type `T` must be an object type
416
+ * 2. Do not allow dynamic property
417
+ * 3. Property key must be lower case
418
+ * 4. Property value cannot be `null`, but `undefined` is possible
419
+ * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
420
+ * 6. By the way, union type never be not allowed
421
+ * 7. Property `set-cookie` must be array type
422
+ * 8. Those properties cannot be array type
423
+ * - age
424
+ * - authorization
425
+ * - content-length
426
+ * - content-type
427
+ * - etag
428
+ * - expires
429
+ * - from
430
+ * - host
431
+ * - if-modified-since
432
+ * - if-unmodified-since
433
+ * - last-modified
434
+ * - location
435
+ * - max-forwards
436
+ * - proxy-authorization
437
+ * - referer
438
+ * - retry-after
439
+ * - server
440
+ * - user-agent
441
+ *
442
+ * @template T Expected type of decoded value
443
+ * @param input Query string or URLSearchParams instance
444
+ * @returns Decoded headers object
445
+ *
446
+ * @author Jeongho Nam - https://github.com/samchon
447
+ */
448
+ export declare function validateHeaders<T extends object>(input: Record<string, string | string[] | undefined>): IValidation<Resolved<T>>;
449
+ /**
450
+ * URL path parameter decoder.
451
+ *
452
+ * `typia.http.parameter()` is a function decoding a path parameter, with automatic
453
+ * type casting to the expected type. When type `T` has been defined as `boolean` or
454
+ * `number` type, `typia.http.parameter()` will cast the value to the expected type.
455
+ *
456
+ * Also, `typia.http.parameter()` performs type assertion to the decoded value by
457
+ * combining with {@link assert} function. Therefore, when the decoded value is not
458
+ * following the `T` type, {@link TypeGuardError} would be thrown.
459
+ *
460
+ * @template T Expected type of decoded value
461
+ * @param input Path parameter string
462
+ * @returns Decoded path parameter value
463
+ */
464
+ export declare function parameter<T extends Atomic.Type | null>(input: string): Resolved<T>;
465
+ /**
466
+ * Creates a reusable {@link formdata} function.
467
+ *
468
+ * @danger You must configure the generic argument `T`
469
+ * @template T The type of the formdata object
470
+ * @throws compile error
471
+ *
472
+ * @author Jeongho Nam - https://github.com/samchon
473
+ */
474
+ export declare function createFormData(): never;
475
+ /**
476
+ * Creates a reusable {@link formdata} function.
477
+ *
478
+ * @template T The type of the formdata object
479
+ * @returns A reusable `formdata` function
480
+ *
481
+ * @author Jeongho Nam - https://github.com/samchon
482
+ */
483
+ export declare function createFormData<T extends object>(): (input: FormData) => T;
484
+ /**
485
+ * Creates a reusable {@link assertFormData} function.
486
+ *
487
+ * @danger You must configure the generic argument `T`
488
+ * @template T The type of the formdata object
489
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
490
+ * @throws compile error
491
+ *
492
+ * @author Jeongho Nam - https://github.com/samchon
493
+ */
494
+ export declare function createAssertFormData(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never;
495
+ /**
496
+ * Creates a reusable {@link assertFormData} function.
497
+ *
498
+ * @template T The type of the formdata object
499
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
500
+ * @returns A reusable `assertFormData` function
501
+ *
502
+ * @author Jeongho Nam - https://github.com/samchon
503
+ */
504
+ export declare function createAssertFormData<T extends object>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: FormData) => T;
505
+ /**
506
+ * Creates a reusable {@link isFormData} function.
507
+ *
508
+ * @danger You must configure the generic argument `T`
509
+ * @template T The type of the formdata object
510
+ * @throws compile error
511
+ *
512
+ * @author Jeongho Nam - https://github.com/samchon
513
+ */
514
+ export declare function createIsFormData(): never;
515
+ /**
516
+ * Creates a reusable {@link isFormData} function.
517
+ *
518
+ * @template T The type of the formdata object
519
+ * @returns A reusable `isFormData` function
520
+ *
521
+ * @author Jeongho Nam - https://github.com/samchon
522
+ */
523
+ export declare function createIsFormData<T extends object>(): (input: FormData) => T | null;
524
+ /**
525
+ * Creates a reusable {@link validateFormData} function.
526
+ *
527
+ * @danger You must configure the generic argument `T`
528
+ * @template T The type of the formdata object
529
+ * @throws compile error
530
+ *
531
+ * @author Jeongho Nam - https://github.com/samchon
532
+ */
533
+ export declare function createValidateFormData(): never;
534
+ /**
535
+ * Creates a reusable {@link validateFormData} function.
536
+ *
537
+ * @template T The type of the formdata object
538
+ * @returns A reusable `validateFormData` function
539
+ *
540
+ * @author Jeongho Nam - https://github.com/samchon
541
+ */
542
+ export declare function createValidateFormData<T extends object>(): (input: FormData) => IValidation<Resolved<T>>;
543
+ /**
544
+ * Creates a reusable {@link query} function.
545
+ *
546
+ * @danger You must configure the generic argument `T`
547
+ * @template T The type of the query object
548
+ * @throws compile error
549
+ *
550
+ * @author Jeongho Nam - https://github.com/samchon
551
+ */
552
+ export declare function createQuery(): never;
553
+ /**
554
+ * Creates a reusable {@link query} function.
555
+ *
556
+ * @template T The type of the query object
557
+ * @returns A reusable `query` function
558
+ *
559
+ * @author Jeongho Nam - https://github.com/samchon
560
+ */
561
+ export declare function createQuery<T extends object>(): (input: string | IReadableURLSearchParams) => T;
562
+ /**
563
+ * Creates a reusable {@link assertQuery} function.
564
+ *
565
+ * @danger You must configure the generic argument `T`
566
+ * @template T The type of the query object
567
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
568
+ * @throws compile error
569
+ *
570
+ * @author Jeongho Nam - https://github.com/samchon
571
+ */
572
+ export declare function createAssertQuery(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never;
573
+ /**
574
+ * Creates a reusable {@link assertQuery} function.
575
+ *
576
+ * @template T The type of the query object
577
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
578
+ * @returns A reusable `assertQuery` function
579
+ *
580
+ * @author Jeongho Nam - https://github.com/samchon
581
+ */
582
+ export declare function createAssertQuery<T extends object>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: string | IReadableURLSearchParams) => T;
583
+ /**
584
+ * Creates a reusable {@link isQuery} function.
585
+ *
586
+ * @danger You must configure the generic argument `T`
587
+ * @template T The type of the query object
588
+ * @throws compile error
589
+ *
590
+ * @author Jeongho Nam - https://github.com/samchon
591
+ */
592
+ export declare function createIsQuery(): never;
593
+ /**
594
+ * Creates a reusable {@link isQuery} function.
595
+ *
596
+ * @template T The type of the query object
597
+ * @returns A reusable `isQuery` function
598
+ *
599
+ * @author Jeongho Nam - https://github.com/samchon
600
+ */
601
+ export declare function createIsQuery<T extends object>(): (input: string | IReadableURLSearchParams) => T | null;
602
+ /**
603
+ * Creates a reusable {@link validateQuery} function.
604
+ *
605
+ * @danger You must configure the generic argument `T`
606
+ * @template T The type of the query object
607
+ * @throws compile error
608
+ *
609
+ * @author Jeongho Nam - https://github.com/samchon
610
+ */
611
+ export declare function createValidateQuery(): never;
612
+ /**
613
+ * Creates a reusable {@link validateQuery} function.
614
+ *
615
+ * @template T The type of the query object
616
+ * @returns A reusable `validateQuery` function
617
+ *
618
+ * @author Jeongho Nam - https://github.com/samchon
619
+ */
620
+ export declare function createValidateQuery<T extends object>(): (input: string | IReadableURLSearchParams) => IValidation<Resolved<T>>;
621
+ /**
622
+ * Creates a reusable {@link headers} function.
623
+ *
624
+ * @danger You must configure the generic argument `T`
625
+ * @template T The type of the headers object
626
+ * @throws compile error
627
+ *
628
+ * @author Jeongho Nam - https://github.com/samchon
629
+ */
630
+ export declare function createHeaders(): never;
631
+ /**
632
+ * Creates a reusable {@link headers} function.
633
+ *
634
+ * @template T The type of the headers object
635
+ * @returns A reusable `headers` function
636
+ *
637
+ * @author Jeongho Nam - https://github.com/samchon
638
+ */
639
+ export declare function createHeaders<T extends object>(): (input: Record<string, string | string[] | undefined>) => T;
640
+ /**
641
+ * Creates a reusable {@link assertHeaders} function.
642
+ *
643
+ * @danger You must configure the generic argument `T`
644
+ * @template T The type of the headers object
645
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
646
+ * @throws compile error
647
+ *
648
+ * @author Jeongho Nam - https://github.com/samchon
649
+ */
650
+ export declare function createAssertHeaders(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never;
651
+ /**
652
+ * Creates a reusable {@link assertHeaders} function.
653
+ *
654
+ * @template T The type of the headers object
655
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
656
+ * @returns A reusable `assertHeaders` function
657
+ *
658
+ * @author Jeongho Nam - https://github.com/samchon
659
+ */
660
+ export declare function createAssertHeaders<T extends object>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: Record<string, string | string[] | undefined>) => T;
661
+ /**
662
+ * Creates a reusable {@link isHeaders} function.
663
+ *
664
+ * @danger You must configure the generic argument `T`
665
+ * @template T The type of the headers object
666
+ * @throws compile error
667
+ *
668
+ * @author Jeongho Nam - https://github.com/samchon
669
+ */
670
+ export declare function createIsHeaders(): never;
671
+ /**
672
+ * Creates a reusable {@link isHeaders} function.
673
+ *
674
+ * @template T The type of the headers object
675
+ * @returns A reusable `isHeaders` function
676
+ *
677
+ * @author Jeongho Nam - https://github.com/samchon
678
+ */
679
+ export declare function createIsHeaders<T extends object>(): (input: Record<string, string | string[] | undefined>) => T | null;
680
+ /**
681
+ * Creates a reusable {@link validateHeaders} function.
682
+ *
683
+ * @danger You must configure the generic argument `T`
684
+ * @template T The type of the headers object
685
+ * @throws compile error
686
+ *
687
+ * @author Jeongho Nam - https://github.com/samchon
688
+ */
689
+ export declare function createValidateHeaders(): never;
690
+ /**
691
+ * Creates a reusable {@link validateHeaders} function.
692
+ *
693
+ * @template T The type of the headers object
694
+ * @returns A reusable `validateHeaders` function
695
+ *
696
+ * @author Jeongho Nam - https://github.com/samchon
697
+ */
698
+ export declare function createValidateHeaders<T extends object>(): (input: Record<string, string | string[] | undefined>) => IValidation<Resolved<T>>;
699
+ /**
700
+ * Creates a reusable {@link parameter} function.
701
+ *
702
+ * @danger You must configure the generic argument `T`
703
+ * @template T The type of the parameter value
704
+ * @throws compile error
705
+ *
706
+ * @author Jeongho Nam - https://github.com/samchon
707
+ */
708
+ export declare function createParameter(): never;
709
+ /**
710
+ * Creates a reusable {@link parameter} function.
711
+ *
712
+ * @template T The type of the parameter value
713
+ * @returns A reusable `parameter` function
714
+ *
715
+ * @author Jeongho Nam - https://github.com/samchon
716
+ */
717
+ export declare function createParameter<T extends Atomic.Type | null>(): (input: string) => T;