typia 9.0.0 → 9.1.0-dev.20250408

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 (577) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +149 -150
  3. package/lib/executable/setup/PluginConfigurator.js +3 -3
  4. package/lib/executable/setup/PluginConfigurator.mjs +3 -3
  5. package/lib/executable/typia.js +15 -15
  6. package/lib/executable/typia.mjs +15 -15
  7. package/lib/factories/MetadataCommentTagFactory.js +8 -10
  8. package/lib/factories/MetadataCommentTagFactory.js.map +1 -1
  9. package/lib/factories/MetadataCommentTagFactory.mjs +8 -10
  10. package/lib/functional.js +19 -27
  11. package/lib/functional.js.map +1 -1
  12. package/lib/functional.mjs +20 -27
  13. package/lib/http.js +27 -32
  14. package/lib/http.js.map +1 -1
  15. package/lib/http.mjs +28 -32
  16. package/lib/json.d.mts +66 -4
  17. package/lib/json.d.ts +66 -4
  18. package/lib/json.js +23 -21
  19. package/lib/json.js.map +1 -1
  20. package/lib/json.mjs +24 -22
  21. package/lib/llm.js +4 -9
  22. package/lib/llm.js.map +1 -1
  23. package/lib/llm.mjs +5 -9
  24. package/lib/misc.js +27 -23
  25. package/lib/misc.js.map +1 -1
  26. package/lib/misc.mjs +28 -23
  27. package/lib/module.d.mts +1 -0
  28. package/lib/module.d.ts +1 -0
  29. package/lib/module.js +20 -24
  30. package/lib/module.js.map +1 -1
  31. package/lib/module.mjs +19 -24
  32. package/lib/notations.js +25 -30
  33. package/lib/notations.js.map +1 -1
  34. package/lib/notations.mjs +26 -30
  35. package/lib/programmers/json/JsonSchemaProgrammer.d.mts +9 -0
  36. package/lib/programmers/json/JsonSchemaProgrammer.d.ts +9 -0
  37. package/lib/programmers/json/JsonSchemaProgrammer.js +20 -0
  38. package/lib/programmers/json/JsonSchemaProgrammer.js.map +1 -0
  39. package/lib/programmers/json/JsonSchemaProgrammer.mjs +20 -0
  40. package/lib/programmers/json/JsonSchemaProgrammer.mjs.map +1 -0
  41. package/lib/programmers/json/JsonSchemasProgrammer.js +1 -1
  42. package/lib/programmers/json/JsonSchemasProgrammer.js.map +1 -1
  43. package/lib/programmers/json/JsonSchemasProgrammer.mjs +1 -1
  44. package/lib/protobuf.js +18 -23
  45. package/lib/protobuf.js.map +1 -1
  46. package/lib/protobuf.mjs +19 -23
  47. package/lib/reflect.js +3 -8
  48. package/lib/reflect.js.map +1 -1
  49. package/lib/reflect.mjs +4 -8
  50. package/lib/schemas/json/IJsonSchemaUnit.d.mts +26 -0
  51. package/lib/schemas/json/IJsonSchemaUnit.d.ts +26 -0
  52. package/lib/schemas/json/IJsonSchemaUnit.js +3 -0
  53. package/lib/schemas/json/IJsonSchemaUnit.js.map +1 -0
  54. package/lib/schemas/json/IJsonSchemaUnit.mjs +2 -0
  55. package/lib/schemas/json/IJsonSchemaUnit.mjs.map +1 -0
  56. package/lib/transformers/CallExpressionTransformer.js +2 -2
  57. package/lib/transformers/CallExpressionTransformer.js.map +1 -1
  58. package/lib/transformers/CallExpressionTransformer.mjs +2 -2
  59. package/lib/transformers/NoTransformConfigurationError.d.mts +1 -0
  60. package/lib/transformers/NoTransformConfigurationError.d.ts +1 -0
  61. package/lib/transformers/NoTransformConfigurationError.js +20 -0
  62. package/lib/transformers/NoTransformConfigurationError.js.map +1 -0
  63. package/lib/transformers/NoTransformConfigurationError.mjs +19 -0
  64. package/lib/transformers/NoTransformConfigurationError.mjs.map +1 -0
  65. package/lib/transformers/features/json/JsonSchemaTransformer.d.mts +5 -0
  66. package/lib/transformers/features/json/JsonSchemaTransformer.d.ts +5 -0
  67. package/lib/transformers/features/json/JsonSchemaTransformer.js +108 -0
  68. package/lib/transformers/features/json/JsonSchemaTransformer.js.map +1 -0
  69. package/lib/transformers/features/json/JsonSchemaTransformer.mjs +104 -0
  70. package/lib/transformers/features/json/JsonSchemaTransformer.mjs.map +1 -0
  71. package/lib/transformers/features/json/JsonSchemasTransformer.js +9 -9
  72. package/lib/transformers/features/json/JsonSchemasTransformer.js.map +1 -1
  73. package/lib/transformers/features/json/JsonSchemasTransformer.mjs +9 -9
  74. package/package.json +1 -4
  75. package/src/AssertionGuard.ts +1 -1
  76. package/src/CamelCase.ts +75 -75
  77. package/src/IRandomGenerator.ts +49 -49
  78. package/src/IReadableURLSearchParams.ts +9 -9
  79. package/src/IValidation.ts +1 -1
  80. package/src/PascalCase.ts +71 -71
  81. package/src/Primitive.ts +92 -92
  82. package/src/Resolved.ts +74 -74
  83. package/src/SnakeCase.ts +126 -126
  84. package/src/TypeGuardError.ts +37 -37
  85. package/src/executable/TypiaGenerateWizard.ts +83 -83
  86. package/src/executable/TypiaPatchWizard.ts +45 -45
  87. package/src/executable/TypiaSetupWizard.ts +171 -171
  88. package/src/executable/setup/ArgumentParser.ts +42 -42
  89. package/src/executable/setup/CommandExecutor.ts +8 -8
  90. package/src/executable/setup/FileRetriever.ts +19 -19
  91. package/src/executable/setup/PackageManager.ts +87 -87
  92. package/src/executable/setup/PluginConfigurator.ts +69 -69
  93. package/src/executable/typia.ts +55 -55
  94. package/src/factories/CommentFactory.ts +79 -79
  95. package/src/factories/ExpressionFactory.ts +216 -216
  96. package/src/factories/IdentifierFactory.ts +89 -89
  97. package/src/factories/JsonMetadataFactory.ts +83 -83
  98. package/src/factories/LiteralFactory.ts +52 -52
  99. package/src/factories/MetadataCollection.ts +278 -278
  100. package/src/factories/MetadataCommentTagFactory.ts +648 -650
  101. package/src/factories/MetadataFactory.ts +404 -404
  102. package/src/factories/MetadataTypeTagFactory.ts +413 -413
  103. package/src/factories/MetadataTypeTagSchemaFactory.ts +82 -82
  104. package/src/factories/NumericRangeFactory.ts +72 -72
  105. package/src/factories/ProtobufFactory.ts +875 -875
  106. package/src/factories/StatementFactory.ts +90 -90
  107. package/src/factories/TemplateFactory.ts +64 -64
  108. package/src/factories/TypeFactory.ts +140 -140
  109. package/src/factories/ValueFactory.ts +12 -12
  110. package/src/factories/internal/metadata/IMetadataIteratorProps.ts +17 -17
  111. package/src/factories/internal/metadata/MetadataHelper.ts +21 -21
  112. package/src/factories/internal/metadata/emend_metadata_atomics.ts +45 -45
  113. package/src/factories/internal/metadata/emplace_metadata_alias.ts +33 -33
  114. package/src/factories/internal/metadata/emplace_metadata_array_type.ts +39 -39
  115. package/src/factories/internal/metadata/emplace_metadata_object.ts +212 -212
  116. package/src/factories/internal/metadata/emplace_metadata_tuple.ts +57 -57
  117. package/src/factories/internal/metadata/explore_metadata.ts +31 -31
  118. package/src/factories/internal/metadata/iterate_metadata.ts +54 -54
  119. package/src/factories/internal/metadata/iterate_metadata_alias.ts +33 -33
  120. package/src/factories/internal/metadata/iterate_metadata_array.ts +63 -63
  121. package/src/factories/internal/metadata/iterate_metadata_atomic.ts +62 -62
  122. package/src/factories/internal/metadata/iterate_metadata_coalesce.ts +28 -28
  123. package/src/factories/internal/metadata/iterate_metadata_collection.ts +146 -146
  124. package/src/factories/internal/metadata/iterate_metadata_comment_tags.ts +32 -32
  125. package/src/factories/internal/metadata/iterate_metadata_constant.ts +76 -76
  126. package/src/factories/internal/metadata/iterate_metadata_escape.ts +49 -49
  127. package/src/factories/internal/metadata/iterate_metadata_function.ts +91 -91
  128. package/src/factories/internal/metadata/iterate_metadata_intersection.ts +212 -212
  129. package/src/factories/internal/metadata/iterate_metadata_map.ts +57 -57
  130. package/src/factories/internal/metadata/iterate_metadata_native.ts +255 -255
  131. package/src/factories/internal/metadata/iterate_metadata_object.ts +35 -35
  132. package/src/factories/internal/metadata/iterate_metadata_set.ts +57 -57
  133. package/src/factories/internal/metadata/iterate_metadata_sort.ts +87 -87
  134. package/src/factories/internal/metadata/iterate_metadata_template.ts +41 -41
  135. package/src/factories/internal/metadata/iterate_metadata_tuple.ts +26 -26
  136. package/src/factories/internal/metadata/iterate_metadata_union.ts +19 -19
  137. package/src/functional.ts +740 -750
  138. package/src/http.ts +1040 -1047
  139. package/src/index.ts +4 -4
  140. package/src/internal/_IProtobufWriter.ts +18 -18
  141. package/src/internal/_ProtobufReader.ts +194 -194
  142. package/src/internal/_ProtobufSizer.ts +145 -145
  143. package/src/internal/_ProtobufWriter.ts +145 -145
  144. package/src/internal/_accessExpressionAsString.ts +46 -46
  145. package/src/internal/_assertGuard.ts +13 -13
  146. package/src/internal/_functionalTypeGuardErrorFactory.ts +4 -4
  147. package/src/internal/_httpFormDataReadArray.ts +4 -4
  148. package/src/internal/_httpFormDataReadBigint.ts +18 -18
  149. package/src/internal/_httpFormDataReadBlob.ts +10 -10
  150. package/src/internal/_httpFormDataReadBoolean.ts +16 -16
  151. package/src/internal/_httpFormDataReadFile.ts +10 -10
  152. package/src/internal/_httpFormDataReadNumber.ts +15 -15
  153. package/src/internal/_httpFormDataReadString.ts +10 -10
  154. package/src/internal/_httpHeaderReadBigint.ts +10 -10
  155. package/src/internal/_httpHeaderReadBoolean.ts +8 -8
  156. package/src/internal/_httpHeaderReadNumber.ts +7 -7
  157. package/src/internal/_httpParameterReadBigint.ts +10 -10
  158. package/src/internal/_httpParameterReadBoolean.ts +8 -8
  159. package/src/internal/_httpParameterReadNumber.ts +7 -7
  160. package/src/internal/_httpParameterReadString.ts +2 -2
  161. package/src/internal/_httpQueryParseURLSearchParams.ts +12 -12
  162. package/src/internal/_httpQueryReadArray.ts +4 -4
  163. package/src/internal/_httpQueryReadBigint.ts +12 -12
  164. package/src/internal/_httpQueryReadBoolean.ts +14 -14
  165. package/src/internal/_httpQueryReadNumber.ts +9 -9
  166. package/src/internal/_httpQueryReadString.ts +4 -4
  167. package/src/internal/_isBetween.ts +2 -2
  168. package/src/internal/_isBigintString.ts +8 -8
  169. package/src/internal/_isFormatByte.ts +7 -7
  170. package/src/internal/_isFormatDate.ts +3 -3
  171. package/src/internal/_isFormatDateTime.ts +4 -4
  172. package/src/internal/_isFormatDuration.ts +4 -4
  173. package/src/internal/_isFormatEmail.ts +4 -4
  174. package/src/internal/_isFormatHostname.ts +4 -4
  175. package/src/internal/_isFormatIdnEmail.ts +4 -4
  176. package/src/internal/_isFormatIdnHostname.ts +4 -4
  177. package/src/internal/_isFormatIpv4.ts +4 -4
  178. package/src/internal/_isFormatIpv6.ts +4 -4
  179. package/src/internal/_isFormatIri.ts +3 -3
  180. package/src/internal/_isFormatIriReference.ts +4 -4
  181. package/src/internal/_isFormatJsonPointer.ts +3 -3
  182. package/src/internal/_isFormatPassword.ts +1 -1
  183. package/src/internal/_isFormatRegex.ts +8 -8
  184. package/src/internal/_isFormatRelativeJsonPointer.ts +4 -4
  185. package/src/internal/_isFormatTime.ts +4 -4
  186. package/src/internal/_isFormatUri.ts +6 -6
  187. package/src/internal/_isFormatUriReference.ts +5 -5
  188. package/src/internal/_isFormatUriTemplate.ts +4 -4
  189. package/src/internal/_isFormatUrl.ts +4 -4
  190. package/src/internal/_isFormatUuid.ts +3 -3
  191. package/src/internal/_isTypeFloat.ts +5 -5
  192. package/src/internal/_isTypeInt32.ts +5 -5
  193. package/src/internal/_isTypeInt64.ts +5 -5
  194. package/src/internal/_isTypeUint32.ts +5 -5
  195. package/src/internal/_isTypeUint64.ts +5 -5
  196. package/src/internal/_isUniqueItems.ts +159 -159
  197. package/src/internal/_jsonStringifyNumber.ts +12 -12
  198. package/src/internal/_jsonStringifyRest.ts +3 -3
  199. package/src/internal/_jsonStringifyString.ts +42 -42
  200. package/src/internal/_jsonStringifyTail.ts +2 -2
  201. package/src/internal/_llmApplicationFinalize.ts +20 -20
  202. package/src/internal/_miscCloneAny.ts +46 -46
  203. package/src/internal/_notationAny.ts +37 -37
  204. package/src/internal/_notationCamel.ts +13 -13
  205. package/src/internal/_notationPascal.ts +8 -8
  206. package/src/internal/_notationSnake.ts +43 -43
  207. package/src/internal/_randomArray.ts +21 -21
  208. package/src/internal/_randomBigint.ts +6 -6
  209. package/src/internal/_randomBoolean.ts +1 -1
  210. package/src/internal/_randomFormatByte.ts +3 -3
  211. package/src/internal/_randomFormatDate.ts +18 -18
  212. package/src/internal/_randomFormatDatetime.ts +16 -16
  213. package/src/internal/_randomFormatDuration.ts +27 -27
  214. package/src/internal/_randomFormatEmail.ts +11 -11
  215. package/src/internal/_randomFormatHostname.ts +6 -6
  216. package/src/internal/_randomFormatIdnEmail.ts +3 -3
  217. package/src/internal/_randomFormatIdnHostname.ts +3 -3
  218. package/src/internal/_randomFormatIpv4.ts +11 -11
  219. package/src/internal/_randomFormatIpv6.ts +11 -11
  220. package/src/internal/_randomFormatIri.ts +3 -3
  221. package/src/internal/_randomFormatIriReference.ts +3 -3
  222. package/src/internal/_randomFormatJsonPointer.ts +7 -7
  223. package/src/internal/_randomFormatPassword.ts +8 -8
  224. package/src/internal/_randomFormatRegex.ts +4 -4
  225. package/src/internal/_randomFormatRelativeJsonPointer.ts +8 -8
  226. package/src/internal/_randomFormatTime.ts +14 -14
  227. package/src/internal/_randomFormatUri.ts +3 -3
  228. package/src/internal/_randomFormatUriReference.ts +3 -3
  229. package/src/internal/_randomFormatUriTemplate.ts +3 -3
  230. package/src/internal/_randomFormatUrl.ts +11 -11
  231. package/src/internal/_randomFormatUuid.ts +6 -6
  232. package/src/internal/_randomInteger.ts +53 -53
  233. package/src/internal/_randomNumber.ts +80 -80
  234. package/src/internal/_randomPattern.ts +10 -10
  235. package/src/internal/_randomPick.ts +9 -9
  236. package/src/internal/_randomString.ts +24 -24
  237. package/src/internal/_throwTypeGuardError.ts +5 -5
  238. package/src/internal/_validateReport.ts +13 -13
  239. package/src/internal/private/__notationCapitalize.ts +2 -2
  240. package/src/internal/private/__notationUnsnake.ts +24 -24
  241. package/src/json.ts +696 -696
  242. package/src/llm.ts +335 -342
  243. package/src/misc.ts +651 -658
  244. package/src/module.ts +929 -935
  245. package/src/notations.ts +820 -827
  246. package/src/programmers/AssertProgrammer.ts +454 -454
  247. package/src/programmers/CheckerProgrammer.ts +1617 -1617
  248. package/src/programmers/FeatureProgrammer.ts +622 -622
  249. package/src/programmers/ImportProgrammer.ts +185 -185
  250. package/src/programmers/IsProgrammer.ts +273 -273
  251. package/src/programmers/RandomProgrammer.ts +1190 -1190
  252. package/src/programmers/TypiaProgrammer.ts +175 -175
  253. package/src/programmers/ValidateProgrammer.ts +439 -439
  254. package/src/programmers/functional/FunctionalAssertFunctionProgrammer.ts +153 -153
  255. package/src/programmers/functional/FunctionalAssertParametersProgrammer.ts +125 -125
  256. package/src/programmers/functional/FunctionalAssertReturnProgrammer.ts +115 -115
  257. package/src/programmers/functional/FunctionalIsFunctionProgrammer.ts +72 -72
  258. package/src/programmers/functional/FunctionalIsParametersProgrammer.ts +113 -113
  259. package/src/programmers/functional/FunctionalIsReturnProgrammer.ts +116 -116
  260. package/src/programmers/functional/FunctionalValidateFunctionProgrammer.ts +119 -119
  261. package/src/programmers/functional/FunctionalValidateParametersProgrammer.ts +274 -274
  262. package/src/programmers/functional/FunctionalValidateReturnProgrammer.ts +135 -135
  263. package/src/programmers/functional/internal/FunctionalGeneralProgrammer.ts +34 -34
  264. package/src/programmers/helpers/AtomicPredicator.ts +35 -35
  265. package/src/programmers/helpers/CloneJoiner.ts +143 -143
  266. package/src/programmers/helpers/FunctionProgrammer.ts +67 -67
  267. package/src/programmers/helpers/HttpMetadataUtil.ts +21 -21
  268. package/src/programmers/helpers/ICheckEntry.ts +13 -13
  269. package/src/programmers/helpers/IExpressionEntry.ts +12 -12
  270. package/src/programmers/helpers/NotationJoiner.ts +144 -144
  271. package/src/programmers/helpers/OptionPredicator.ts +15 -15
  272. package/src/programmers/helpers/ProtobufUtil.ts +228 -228
  273. package/src/programmers/helpers/ProtobufWire.ts +34 -34
  274. package/src/programmers/helpers/PruneJoiner.ts +148 -148
  275. package/src/programmers/helpers/RandomJoiner.ts +168 -168
  276. package/src/programmers/helpers/StringifyJoinder.ts +115 -115
  277. package/src/programmers/helpers/StringifyPredicator.ts +13 -13
  278. package/src/programmers/helpers/UnionExplorer.ts +372 -372
  279. package/src/programmers/helpers/UnionPredicator.ts +79 -79
  280. package/src/programmers/helpers/disable_function_programmer_declare.ts +32 -32
  281. package/src/programmers/http/HttpAssertFormDataProgrammer.ts +99 -99
  282. package/src/programmers/http/HttpAssertHeadersProgrammer.ts +99 -99
  283. package/src/programmers/http/HttpAssertQueryProgrammer.ts +105 -105
  284. package/src/programmers/http/HttpFormDataProgrammer.ts +308 -308
  285. package/src/programmers/http/HttpHeadersProgrammer.ts +400 -400
  286. package/src/programmers/http/HttpIsFormDataProgrammer.ts +108 -108
  287. package/src/programmers/http/HttpIsHeadersProgrammer.ts +108 -108
  288. package/src/programmers/http/HttpIsQueryProgrammer.ts +114 -114
  289. package/src/programmers/http/HttpParameterProgrammer.ts +115 -115
  290. package/src/programmers/http/HttpQueryProgrammer.ts +336 -336
  291. package/src/programmers/http/HttpValidateFormDataProgrammer.ts +92 -92
  292. package/src/programmers/http/HttpValidateHeadersProgrammer.ts +92 -92
  293. package/src/programmers/http/HttpValidateQueryProgrammer.ts +98 -98
  294. package/src/programmers/internal/check_array_length.ts +47 -47
  295. package/src/programmers/internal/check_bigint.ts +50 -50
  296. package/src/programmers/internal/check_dynamic_key.ts +201 -201
  297. package/src/programmers/internal/check_dynamic_properties.ts +208 -208
  298. package/src/programmers/internal/check_everything.ts +23 -23
  299. package/src/programmers/internal/check_native.ts +27 -27
  300. package/src/programmers/internal/check_number.ts +112 -112
  301. package/src/programmers/internal/check_object.ts +75 -75
  302. package/src/programmers/internal/check_string.ts +50 -50
  303. package/src/programmers/internal/check_template.ts +48 -48
  304. package/src/programmers/internal/check_union_array_like.ts +335 -335
  305. package/src/programmers/internal/decode_union_object.ts +116 -116
  306. package/src/programmers/internal/feature_object_entries.ts +61 -61
  307. package/src/programmers/internal/json_schema_alias.ts +47 -47
  308. package/src/programmers/internal/json_schema_array.ts +45 -45
  309. package/src/programmers/internal/json_schema_bigint.ts +15 -15
  310. package/src/programmers/internal/json_schema_boolean.ts +15 -15
  311. package/src/programmers/internal/json_schema_constant.ts +26 -26
  312. package/src/programmers/internal/json_schema_description.ts +12 -12
  313. package/src/programmers/internal/json_schema_discriminator.ts +35 -35
  314. package/src/programmers/internal/json_schema_escaped.ts +82 -82
  315. package/src/programmers/internal/json_schema_native.ts +33 -33
  316. package/src/programmers/internal/json_schema_number.ts +15 -15
  317. package/src/programmers/internal/json_schema_object.ts +158 -158
  318. package/src/programmers/internal/json_schema_plugin.ts +18 -18
  319. package/src/programmers/internal/json_schema_station.ts +185 -185
  320. package/src/programmers/internal/json_schema_string.ts +15 -15
  321. package/src/programmers/internal/json_schema_template.ts +55 -55
  322. package/src/programmers/internal/json_schema_title.ts +20 -20
  323. package/src/programmers/internal/json_schema_tuple.ts +35 -35
  324. package/src/programmers/internal/metadata_to_pattern.ts +42 -42
  325. package/src/programmers/internal/postfix_of_tuple.ts +5 -5
  326. package/src/programmers/internal/prune_object_properties.ts +71 -71
  327. package/src/programmers/internal/stringify_dynamic_properties.ts +162 -162
  328. package/src/programmers/internal/stringify_native.ts +7 -7
  329. package/src/programmers/internal/stringify_regular_properties.ts +81 -81
  330. package/src/programmers/internal/template_to_pattern.ts +23 -23
  331. package/src/programmers/internal/wrap_metadata_rest_tuple.ts +23 -23
  332. package/src/programmers/json/JsonApplicationProgrammer.ts +266 -266
  333. package/src/programmers/json/JsonAssertParseProgrammer.ts +113 -113
  334. package/src/programmers/json/JsonAssertStringifyProgrammer.ts +115 -115
  335. package/src/programmers/json/JsonIsParseProgrammer.ts +114 -114
  336. package/src/programmers/json/JsonIsStringifyProgrammer.ts +108 -108
  337. package/src/programmers/json/JsonSchemaProgrammer.ts +26 -0
  338. package/src/programmers/json/JsonSchemasProgrammer.ts +91 -91
  339. package/src/programmers/json/JsonStringifyProgrammer.ts +1124 -1124
  340. package/src/programmers/json/JsonValidateParseProgrammer.ts +105 -105
  341. package/src/programmers/json/JsonValidateStringifyProgrammer.ts +124 -124
  342. package/src/programmers/llm/LlmApplicationProgrammer.ts +401 -401
  343. package/src/programmers/llm/LlmModelPredicator.ts +127 -127
  344. package/src/programmers/llm/LlmParametersProgrammer.ts +93 -93
  345. package/src/programmers/llm/LlmSchemaProgrammer.ts +192 -192
  346. package/src/programmers/misc/MiscAssertCloneProgrammer.ts +95 -95
  347. package/src/programmers/misc/MiscAssertPruneProgrammer.ts +116 -116
  348. package/src/programmers/misc/MiscCloneProgrammer.ts +1032 -1032
  349. package/src/programmers/misc/MiscIsCloneProgrammer.ts +99 -99
  350. package/src/programmers/misc/MiscIsPruneProgrammer.ts +97 -97
  351. package/src/programmers/misc/MiscLiteralsProgrammer.ts +80 -80
  352. package/src/programmers/misc/MiscPruneProgrammer.ts +728 -728
  353. package/src/programmers/misc/MiscValidateCloneProgrammer.ts +111 -111
  354. package/src/programmers/misc/MiscValidatePruneProgrammer.ts +113 -113
  355. package/src/programmers/notations/NotationAssertGeneralProgrammer.ts +101 -101
  356. package/src/programmers/notations/NotationGeneralProgrammer.ts +984 -984
  357. package/src/programmers/notations/NotationIsGeneralProgrammer.ts +105 -105
  358. package/src/programmers/notations/NotationValidateGeneralProgrammer.ts +119 -119
  359. package/src/programmers/protobuf/ProtobufAssertDecodeProgrammer.ts +98 -98
  360. package/src/programmers/protobuf/ProtobufAssertEncodeProgrammer.ts +102 -102
  361. package/src/programmers/protobuf/ProtobufDecodeProgrammer.ts +654 -654
  362. package/src/programmers/protobuf/ProtobufEncodeProgrammer.ts +945 -945
  363. package/src/programmers/protobuf/ProtobufIsDecodeProgrammer.ts +109 -109
  364. package/src/programmers/protobuf/ProtobufIsEncodeProgrammer.ts +98 -98
  365. package/src/programmers/protobuf/ProtobufMessageProgrammer.ts +179 -179
  366. package/src/programmers/protobuf/ProtobufValidateDecodeProgrammer.ts +92 -92
  367. package/src/programmers/protobuf/ProtobufValidateEncodeProgrammer.ts +119 -119
  368. package/src/protobuf.ts +861 -868
  369. package/src/reflect.ts +50 -57
  370. package/src/schemas/json/IJsonApplication.ts +73 -73
  371. package/src/schemas/json/IJsonSchemaCollection.ts +29 -29
  372. package/src/schemas/json/IJsonSchemaUnit.ts +32 -0
  373. package/src/schemas/json/__IJsonApplication.ts +63 -63
  374. package/src/schemas/metadata/IJsDocTagInfo.ts +10 -10
  375. package/src/schemas/metadata/IMetadata.ts +35 -35
  376. package/src/schemas/metadata/IMetadataAlias.ts +6 -6
  377. package/src/schemas/metadata/IMetadataAliasType.ts +12 -12
  378. package/src/schemas/metadata/IMetadataApplication.ts +7 -7
  379. package/src/schemas/metadata/IMetadataArray.ts +6 -6
  380. package/src/schemas/metadata/IMetadataArrayType.ts +10 -10
  381. package/src/schemas/metadata/IMetadataAtomic.ts +6 -6
  382. package/src/schemas/metadata/IMetadataComponents.ts +11 -11
  383. package/src/schemas/metadata/IMetadataConstant.ts +18 -18
  384. package/src/schemas/metadata/IMetadataConstantValue.ts +11 -11
  385. package/src/schemas/metadata/IMetadataDictionary.ts +11 -11
  386. package/src/schemas/metadata/IMetadataEscaped.ts +6 -6
  387. package/src/schemas/metadata/IMetadataFunction.ts +8 -8
  388. package/src/schemas/metadata/IMetadataMap.ts +8 -8
  389. package/src/schemas/metadata/IMetadataNative.ts +6 -6
  390. package/src/schemas/metadata/IMetadataObject.ts +6 -6
  391. package/src/schemas/metadata/IMetadataObjectType.ts +13 -13
  392. package/src/schemas/metadata/IMetadataParameter.ts +9 -9
  393. package/src/schemas/metadata/IMetadataProperty.ts +9 -9
  394. package/src/schemas/metadata/IMetadataSet.ts +7 -7
  395. package/src/schemas/metadata/IMetadataTemplate.ts +7 -7
  396. package/src/schemas/metadata/IMetadataTuple.ts +6 -6
  397. package/src/schemas/metadata/IMetadataTupleType.ts +10 -10
  398. package/src/schemas/metadata/IMetadataTypeTag.ts +16 -16
  399. package/src/schemas/metadata/Metadata.ts +687 -687
  400. package/src/schemas/metadata/MetadataAlias.ts +46 -46
  401. package/src/schemas/metadata/MetadataAliasType.ts +63 -63
  402. package/src/schemas/metadata/MetadataApplication.ts +44 -44
  403. package/src/schemas/metadata/MetadataArray.ts +49 -49
  404. package/src/schemas/metadata/MetadataArrayType.ts +57 -57
  405. package/src/schemas/metadata/MetadataAtomic.ts +87 -87
  406. package/src/schemas/metadata/MetadataComponents.ts +98 -98
  407. package/src/schemas/metadata/MetadataConstant.ts +34 -34
  408. package/src/schemas/metadata/MetadataConstantValue.ts +62 -62
  409. package/src/schemas/metadata/MetadataEscaped.ts +51 -51
  410. package/src/schemas/metadata/MetadataFunction.ts +49 -49
  411. package/src/schemas/metadata/MetadataMap.ts +48 -48
  412. package/src/schemas/metadata/MetadataNative.ts +44 -44
  413. package/src/schemas/metadata/MetadataObject.ts +48 -48
  414. package/src/schemas/metadata/MetadataObjectType.ts +149 -149
  415. package/src/schemas/metadata/MetadataParameter.ts +54 -54
  416. package/src/schemas/metadata/MetadataProperty.ts +59 -59
  417. package/src/schemas/metadata/MetadataSet.ts +45 -45
  418. package/src/schemas/metadata/MetadataTemplate.ts +80 -80
  419. package/src/schemas/metadata/MetadataTuple.ts +32 -32
  420. package/src/schemas/metadata/MetadataTupleType.ts +67 -67
  421. package/src/schemas/protobuf/IProtobufProperty.ts +6 -6
  422. package/src/schemas/protobuf/IProtobufPropertyType.ts +37 -37
  423. package/src/schemas/protobuf/IProtobufSchema.ts +50 -50
  424. package/src/tags/Constant.ts +15 -15
  425. package/src/tags/ContentMediaType.ts +10 -10
  426. package/src/tags/Default.ts +22 -22
  427. package/src/tags/Example.ts +24 -24
  428. package/src/tags/Examples.ts +16 -16
  429. package/src/tags/ExclusiveMaximum.ts +23 -23
  430. package/src/tags/ExclusiveMinimum.ts +23 -23
  431. package/src/tags/Format.ts +50 -50
  432. package/src/tags/JsonSchemaPlugin.ts +8 -8
  433. package/src/tags/MaxItems.ts +12 -12
  434. package/src/tags/MaxLength.ts +12 -12
  435. package/src/tags/Maximum.ts +19 -19
  436. package/src/tags/MinItems.ts +12 -12
  437. package/src/tags/MinLength.ts +12 -12
  438. package/src/tags/Minimum.ts +19 -19
  439. package/src/tags/MultipleOf.ts +21 -21
  440. package/src/tags/Pattern.ts +31 -31
  441. package/src/tags/Sequence.ts +10 -10
  442. package/src/tags/TagBase.ts +82 -82
  443. package/src/tags/Type.ts +37 -37
  444. package/src/tags/UniqueItems.ts +14 -14
  445. package/src/tags/index.ts +21 -21
  446. package/src/tags/internal/FormatCheatSheet.ts +73 -73
  447. package/src/transform.ts +35 -35
  448. package/src/transformers/CallExpressionTransformer.ts +546 -546
  449. package/src/transformers/FileTransformer.ts +136 -136
  450. package/src/transformers/IProgrammerProps.ts +11 -11
  451. package/src/transformers/ITransformOptions.ts +62 -62
  452. package/src/transformers/ITransformProps.ts +9 -9
  453. package/src/transformers/ITypiaContext.ts +18 -18
  454. package/src/transformers/ImportTransformer.ts +81 -81
  455. package/src/transformers/NoTransformConfigurationError.ts +18 -0
  456. package/src/transformers/NodeTransformer.ts +17 -17
  457. package/src/transformers/TransformerError.ts +60 -60
  458. package/src/transformers/features/AssertTransformer.ts +24 -24
  459. package/src/transformers/features/CreateAssertTransformer.ts +24 -24
  460. package/src/transformers/features/CreateIsTransformer.ts +18 -18
  461. package/src/transformers/features/CreateRandomTransformer.ts +43 -43
  462. package/src/transformers/features/CreateValidateTransformer.ts +18 -18
  463. package/src/transformers/features/IsTransformer.ts +18 -18
  464. package/src/transformers/features/RandomTransformer.ts +41 -41
  465. package/src/transformers/features/ValidateTransformer.ts +18 -18
  466. package/src/transformers/features/functional/FunctionalGenericTransformer.ts +57 -57
  467. package/src/transformers/features/http/CreateHttpAssertFormDataTransformer.ts +13 -13
  468. package/src/transformers/features/http/CreateHttpAssertHeadersTransformer.ts +13 -13
  469. package/src/transformers/features/http/CreateHttpAssertQueryTransformer.ts +13 -13
  470. package/src/transformers/features/http/CreateHttpFormDataTransformer.ts +13 -13
  471. package/src/transformers/features/http/CreateHttpHeadersTransformer.ts +13 -13
  472. package/src/transformers/features/http/CreateHttpIsFormDataTransformer.ts +13 -13
  473. package/src/transformers/features/http/CreateHttpIsHeadersTransformer.ts +13 -13
  474. package/src/transformers/features/http/CreateHttpIsQueryTransformer.ts +13 -13
  475. package/src/transformers/features/http/CreateHttpParameterTransformer.ts +13 -13
  476. package/src/transformers/features/http/CreateHttpQueryTransformer.ts +13 -13
  477. package/src/transformers/features/http/CreateHttpValidateFormDataTransformer.ts +13 -13
  478. package/src/transformers/features/http/CreateHttpValidateHeadersTransformer.ts +13 -13
  479. package/src/transformers/features/http/CreateHttpValidateQueryTransformer.ts +13 -13
  480. package/src/transformers/features/http/HttpAssertFormDataTransformer.ts +13 -13
  481. package/src/transformers/features/http/HttpAssertHeadersTransformer.ts +13 -13
  482. package/src/transformers/features/http/HttpAssertQueryTransformer.ts +13 -13
  483. package/src/transformers/features/http/HttpFormDataTransformer.ts +13 -13
  484. package/src/transformers/features/http/HttpHeadersTransformer.ts +13 -13
  485. package/src/transformers/features/http/HttpIsFormDataTransformer.ts +13 -13
  486. package/src/transformers/features/http/HttpIsHeadersTransformer.ts +13 -13
  487. package/src/transformers/features/http/HttpIsQueryTransformer.ts +13 -13
  488. package/src/transformers/features/http/HttpParameterTransformer.ts +13 -13
  489. package/src/transformers/features/http/HttpQueryTransformer.ts +13 -13
  490. package/src/transformers/features/http/HttpValidateFormDataTransformer.ts +13 -13
  491. package/src/transformers/features/http/HttpValidateHeadersTransformer.ts +13 -13
  492. package/src/transformers/features/http/HttpValidateQueryTransformer.ts +13 -13
  493. package/src/transformers/features/json/JsonApplicationTransformer.ts +105 -105
  494. package/src/transformers/features/json/JsonAssertParseTransformer.ts +13 -13
  495. package/src/transformers/features/json/JsonAssertStringifyTransformer.ts +13 -13
  496. package/src/transformers/features/json/JsonCreateAssertParseTransformer.ts +13 -13
  497. package/src/transformers/features/json/JsonCreateAssertStringifyTransformer.ts +13 -13
  498. package/src/transformers/features/json/JsonCreateIsParseTransformer.ts +13 -13
  499. package/src/transformers/features/json/JsonCreateIsStringifyTransformer.ts +13 -13
  500. package/src/transformers/features/json/JsonCreateStringifyTransformer.ts +13 -13
  501. package/src/transformers/features/json/JsonCreateValidateParseTransformer.ts +13 -13
  502. package/src/transformers/features/json/JsonCreateValidateStringifyProgrammer.ts +13 -13
  503. package/src/transformers/features/json/JsonIsParseTransformer.ts +13 -13
  504. package/src/transformers/features/json/JsonIsStringifyTransformer.ts +13 -13
  505. package/src/transformers/features/json/JsonSchemaTransformer.ts +135 -0
  506. package/src/transformers/features/json/JsonSchemasTransformer.ts +145 -145
  507. package/src/transformers/features/json/JsonStringifyTransformer.ts +13 -13
  508. package/src/transformers/features/json/JsonValidateParseTransformer.ts +13 -13
  509. package/src/transformers/features/json/JsonValidateStringifyTransformer.ts +13 -13
  510. package/src/transformers/features/llm/LlmApplicationTransformer.ts +128 -128
  511. package/src/transformers/features/llm/LlmParametersTransformer.ts +102 -102
  512. package/src/transformers/features/llm/LlmSchemaTransformer.ts +170 -170
  513. package/src/transformers/features/misc/MiscAssertCloneTransformer.ts +13 -13
  514. package/src/transformers/features/misc/MiscAssertPruneTransformer.ts +13 -13
  515. package/src/transformers/features/misc/MiscCloneTransformer.ts +13 -13
  516. package/src/transformers/features/misc/MiscCreateAssertCloneTransformer.ts +13 -13
  517. package/src/transformers/features/misc/MiscCreateAssertPruneTransformer.ts +13 -13
  518. package/src/transformers/features/misc/MiscCreateCloneTransformer.ts +13 -13
  519. package/src/transformers/features/misc/MiscCreateIsCloneTransformer.ts +13 -13
  520. package/src/transformers/features/misc/MiscCreateIsPruneTransformer.ts +13 -13
  521. package/src/transformers/features/misc/MiscCreatePruneTransformer.ts +13 -13
  522. package/src/transformers/features/misc/MiscCreateValidateCloneTransformer.ts +13 -13
  523. package/src/transformers/features/misc/MiscCreateValidatePruneTransformer.ts +13 -13
  524. package/src/transformers/features/misc/MiscIsCloneTransformer.ts +13 -13
  525. package/src/transformers/features/misc/MiscIsPruneTransformer.ts +13 -13
  526. package/src/transformers/features/misc/MiscLiteralsTransformer.ts +35 -35
  527. package/src/transformers/features/misc/MiscPruneTransformer.ts +13 -13
  528. package/src/transformers/features/misc/MiscValidateCloneTransformer.ts +13 -13
  529. package/src/transformers/features/misc/MiscValidatePruneTransformer.ts +13 -13
  530. package/src/transformers/features/notations/NotationAssertGeneralTransformer.ts +20 -20
  531. package/src/transformers/features/notations/NotationCreateAssertGeneralTransformer.ts +20 -20
  532. package/src/transformers/features/notations/NotationCreateGeneralTransformer.ts +20 -20
  533. package/src/transformers/features/notations/NotationCreateIsGeneralTransformer.ts +20 -20
  534. package/src/transformers/features/notations/NotationCreateValidateGeneralTransformer.ts +20 -20
  535. package/src/transformers/features/notations/NotationGeneralTransformer.ts +18 -18
  536. package/src/transformers/features/notations/NotationIsGeneralTransformer.ts +20 -20
  537. package/src/transformers/features/notations/NotationValidateGeneralTransformer.ts +20 -20
  538. package/src/transformers/features/protobuf/ProtobufAssertDecodeTransformer.ts +13 -13
  539. package/src/transformers/features/protobuf/ProtobufAssertEncodeTransformer.ts +13 -13
  540. package/src/transformers/features/protobuf/ProtobufCreateAssertDecodeTransformer.ts +13 -13
  541. package/src/transformers/features/protobuf/ProtobufCreateAssertEncodeTransformer.ts +13 -13
  542. package/src/transformers/features/protobuf/ProtobufCreateDecodeTransformer.ts +13 -13
  543. package/src/transformers/features/protobuf/ProtobufCreateEncodeTransformer.ts +13 -13
  544. package/src/transformers/features/protobuf/ProtobufCreateIsDecodeTransformer.ts +13 -13
  545. package/src/transformers/features/protobuf/ProtobufCreateIsEncodeTransformer.ts +13 -13
  546. package/src/transformers/features/protobuf/ProtobufCreateValidateDecodeTransformer.ts +13 -13
  547. package/src/transformers/features/protobuf/ProtobufCreateValidateEncodeTransformer.ts +13 -13
  548. package/src/transformers/features/protobuf/ProtobufDecodeTransformer.ts +13 -13
  549. package/src/transformers/features/protobuf/ProtobufEncodeTransformer.ts +13 -13
  550. package/src/transformers/features/protobuf/ProtobufIsDecodeTransformer.ts +13 -13
  551. package/src/transformers/features/protobuf/ProtobufIsEncodeTransformer.ts +13 -13
  552. package/src/transformers/features/protobuf/ProtobufMessageTransformer.ts +35 -35
  553. package/src/transformers/features/protobuf/ProtobufValidateDecodeTransformer.ts +13 -13
  554. package/src/transformers/features/protobuf/ProtobufValidateEncodeTransformer.ts +13 -13
  555. package/src/transformers/features/reflect/ReflectMetadataTransformer.ts +69 -69
  556. package/src/transformers/features/reflect/ReflectNameTransformer.ts +82 -82
  557. package/src/transformers/internal/GenericTransformer.ts +101 -101
  558. package/src/typings/Atomic.ts +13 -13
  559. package/src/typings/ClassProperties.ts +5 -5
  560. package/src/typings/Customizable.ts +5 -5
  561. package/src/typings/Equal.ts +18 -18
  562. package/src/typings/IsTuple.ts +9 -9
  563. package/src/typings/NativeClass.ts +23 -23
  564. package/src/typings/OmitNever.ts +3 -3
  565. package/src/typings/ProtobufAtomic.ts +19 -19
  566. package/src/typings/SpecialFields.ts +3 -3
  567. package/src/typings/ValidationPipe.ts +9 -9
  568. package/src/typings/ValueOf.ts +20 -20
  569. package/src/typings/Writable.ts +11 -11
  570. package/src/utils/ArrayUtil.ts +41 -41
  571. package/src/utils/Escaper.ts +50 -50
  572. package/src/utils/MapUtil.ts +14 -14
  573. package/src/utils/NamingConvention.ts +94 -94
  574. package/src/utils/PatternUtil.ts +29 -29
  575. package/src/utils/ProtobufNameEncoder.ts +32 -32
  576. package/src/utils/Singleton.ts +16 -16
  577. package/src/utils/StringUtil.ts +16 -16
package/src/http.ts CHANGED
@@ -1,1047 +1,1040 @@
1
- import { Atomic } from "./typings/Atomic";
2
-
3
- import { IReadableURLSearchParams } from "./IReadableURLSearchParams";
4
- import { IValidation } from "./IValidation";
5
- import { Resolved } from "./Resolved";
6
- import { TypeGuardError } from "./TypeGuardError";
7
-
8
- /* ===========================================================
9
- HTTP
10
- - FORM-DATA
11
- - QUERY
12
- - HEADERS
13
- - PARAMETER
14
- - FACTORY FUNCTIONS
15
- ==============================================================
16
- FORM-DATA
17
- ----------------------------------------------------------- */
18
- /**
19
- * Form data decoder.
20
- *
21
- * `typia.http.formData()` is a function decoding `FormData` instance, with
22
- * automatic type casting to the expected type. When roperty type be defined
23
- * as `boolean` or `Blob` type, `typia.http.formData()` will cast the value to
24
- * the expected type when decoding.
25
- *
26
- * By the way, as `FormData` is not enough to express complex data structures,
27
- * `typia.http.formData()` function has some limitations. If target type `T` is
28
- * not following those restrictions, compilation errors would be occurred.
29
- *
30
- * 1. Type `T` must be an object type
31
- * 2. Do not allow dynamic property
32
- * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array types are allowed
33
- * 4. By the way, union type never be not allowed
34
- *
35
- * Also, `typia.http.formData()` function does not perform validation about the
36
- * decoded value. Therefore, if you can't sure that input data is following the
37
- * `T` type, it would better to call one of below functions instead.
38
- *
39
- * @template T Expected type of decoded value
40
- * @param input FormData instance
41
- * @returns Decoded form FormData
42
- *
43
- * @author Jeongho Nam - https://github.com/samchon
44
- */
45
- export function formData<T extends object>(input: FormData): Resolved<T>;
46
-
47
- /**
48
- * @internal
49
- */
50
- export function formData(): never {
51
- halt("formData");
52
- }
53
-
54
- /**
55
- * Form data decoder with type assertion.
56
- *
57
- * `typia.http.assertFormData()` is a function decoding `FormData` instance, with
58
- * automatic type casting to the expected type. When roperty type be defined
59
- * as `boolean` or `Blob` type, `typia.http.assertFormData()` will cast the value
60
- * to the expected type when decoding.
61
- *
62
- * Also, after decoding, `typia.http.assertFormData()` performs type assertion to
63
- * the decoded value by combining with {@link assert} function. Therefore, when
64
- * the decoded value is not following the `T` type, {@link TypeGuardError} or
65
- * custom error generated by *errorFactory* would be thrown.
66
- *
67
- * By the way, as `FormData` is not enough to express complex data structures,
68
- * `typia.http.assertFormData()` function has some limitations. If target type `T`
69
- * is not following those restrictions, compilation errors would be occurred.
70
- *
71
- * 1. Type `T` must be an object type
72
- * 2. Do not allow dynamic property
73
- * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array types are allowed
74
- * 4. By the way, union type never be not allowed
75
- *
76
- * @template T Expected type of decoded value
77
- * @param input FormData instance
78
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
79
- * @returns Decoded form FormData
80
- *
81
- * @author Jeongho Nam - https://github.com/samchon
82
- */
83
- export function assertFormData<T extends object>(
84
- input: FormData,
85
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
86
- ): Resolved<T>;
87
-
88
- /**
89
- * @internal
90
- */
91
- export function assertFormData(): never {
92
- halt("assertFormData");
93
- }
94
-
95
- /**
96
- * Form data decoder with type checking.
97
- *
98
- * `typia.http.isFormData()` is a function decoding `FormData` instance, with
99
- * automatic type casting to the expected type. When roperty type be defined
100
- * as `boolean` or `Blob` type, `typia.http.isFormData()` will cast the value
101
- * to the expected type when decoding.
102
- *
103
- * Also, after decoding, `typia.http.isFormData()` performs type checking to the
104
- * decoded value by combining with {@link is} function. Therefore, when the
105
- * decoded value is not following the `T` type, `null` value would be returned.
106
- *
107
- * By the way, as `FormData` is not enough to express complex data structures,
108
- * `typia.http.isFormData()` function has some limitations. If target type `T` is
109
- * not following those restrictions, compilation errors would be occurred.
110
- *
111
- * 1. Type `T` must be an object type
112
- * 2. Do not allow dynamic property
113
- * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array types are allowed
114
- * 4. By the way, union type never be not allowed
115
- *
116
- * @template T Expected type of decoded value
117
- * @param input FormData instance
118
- * @returns Decoded form FormData or `null` value
119
- *
120
- * @author Jeongho Nam - https://github.com/samchon
121
- */
122
- export function isFormData<T extends object>(
123
- input: FormData,
124
- ): Resolved<T> | null;
125
-
126
- /**
127
- * @internal
128
- */
129
- export function isFormData(): never {
130
- halt("isFormData");
131
- }
132
-
133
- /**
134
- * Form data decoder with type validation.
135
- *
136
- * `typia.http.validateFormData()` is a function decoding `FormData` instance,
137
- * with automatic type casting to the expected type. When roperty type be defined
138
- * as `boolean` or `Blob` type, `typia.http.validateFormData()` will cast the
139
- * value to the expected type when decoding.
140
- *
141
- * Also, after decoding, `typia.http.validateFormData()` performs type validation
142
- * to the decoded value by combining with {@link validate} function. Therefore,
143
- * when the decoded value is not following the `T` type,
144
- * {@link IValidation.IFailure} would be returned. Otherwise,
145
- * x@xxxx IValidation.ISuccess} would be returned.
146
- *
147
- * By the way, as `FormData` is not enough to express complex data structures,
148
- * `typia.http.validateFormData()` function has some limitations. If target type
149
- * `T` is not following those restrictions, compilation errors would be occurred.
150
- *
151
- * 1. Type `T` must be an object type
152
- * 2. Do not allow dynamic property
153
- * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array types are allowed
154
- * 4. By the way, union type never be not allowed
155
- *
156
- * @template T Expected type of decoded value
157
- * @param input FormData instance
158
- * @returns Validation result with decoded form FormData
159
- *
160
- * @author Jeongho Nam - https://github.com/samchon
161
- */
162
- export function validateFormData<T extends object>(
163
- input: FormData,
164
- ): IValidation<Resolved<T>>;
165
-
166
- /**
167
- * @internal
168
- */
169
- export function validateFormData(): never {
170
- halt("validateFormData");
171
- }
172
-
173
- /* -----------------------------------------------------------
174
- QUERY
175
- ----------------------------------------------------------- */
176
- /**
177
- * URL query decoder.
178
- *
179
- * `typia.http.query()` is a function decoding a query string or an `URLSearchParams`
180
- * instance, with automatic type casting to the expected type. When property type be
181
- * defined as `boolean` or `number` type, `typia.http.query()` will cast the value to
182
- * the expected type when decoding.
183
- *
184
- * By the way, as URL query is not enough to express complex data structures,
185
- * `typia.http.query()` function has some limitations. If target type `T` is not
186
- * following those restrictions, compilation errors would be occurred.
187
- *
188
- * 1. Type `T` must be an object type
189
- * 2. Do not allow dynamic property
190
- * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
191
- * 4. By the way, union type never be not allowed
192
- *
193
- * Also, `typia.http.query()` function does not perform validation about the decoded
194
- * value. Therefore, if you can't sure that input data is following the `T` type,
195
- * it would better to call one of below functions instead.
196
- *
197
- * - {@link assertQuery}
198
- * - {@link isQuery}
199
- * - {@link validateQuery}
200
- *
201
- * @template T Expected type of decoded value
202
- * @param input Query string or URLSearchParams instance
203
- * @returns Decoded query object
204
- *
205
- * @author Jeongho Nam - https://github.com/samchon
206
- */
207
- export function query<T extends object>(
208
- input: string | IReadableURLSearchParams,
209
- ): Resolved<T>;
210
-
211
- /**
212
- * @internal
213
- */
214
- export function query(): never {
215
- halt("query");
216
- }
217
-
218
- /**
219
- * URL query decoder with type assertion.
220
- *
221
- * `typia.http.assertQuery()` is a function decoding a query string or an
222
- * `URLSearchParams` instance, with automatic type casting to the expected type.
223
- * When property type be defined as `boolean` or `number` type,
224
- * `typia.http.assertQuery()` will cast the value to the expected type when decoding.
225
- *
226
- * Also, after decoding, `typia.http.assertQuery()` performs type assertion to the
227
- * decoded value by combining with {@link assert} function. Therefore, when the
228
- * decoded value is not following the `T` type, {@link TypeGuardError} or custom
229
- * error generated by *errorFactory* would be thrown.
230
- *
231
- * By the way, as URL query is not enough to express complex data structures,
232
- * `typia.http.assertQuery()` function has some limitations. If target type `T` is
233
- * notfollowing those restrictions, compilation errors would be occurred.
234
- *
235
- * 1. Type `T` must be an object type
236
- * 2. Do not allow dynamic property
237
- * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
238
- * 4. By the way, union type never be not allowed
239
- *
240
- * @template T Expected type of decoded value
241
- * @param input Query string or URLSearchParams instance
242
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
243
- * @returns Decoded query object
244
- *
245
- * @author Jeongho Nam - https://github.com/samchon
246
- */
247
- export function assertQuery<T extends object>(
248
- input: string | IReadableURLSearchParams,
249
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
250
- ): Resolved<T>;
251
-
252
- /**
253
- * @internal
254
- */
255
- export function assertQuery(): never {
256
- halt("assertQuery");
257
- }
258
-
259
- /**
260
- * URL query decoder with type checking.
261
- *
262
- * `typia.http.isQuery()` is a function decoding a query string or an
263
- * `URLSearchParams` instance, with automatic type casting to the expected type.
264
- * When property type be defined as `boolean` or `number` type,
265
- * `typia.http.isQuery()` will cast the value to the expected type when decoding.
266
- *
267
- * Also, after decoding, `typia.http.isQuery()` performs type checking to the
268
- * decoded value by combining with {@link is} function. Therefore, when the
269
- * decoded value is not following the `T` type, `null` value would be returned.
270
- *
271
- * By the way, as URL query is not enough to express complex data structures,
272
- * `typia.http.isQuery()` function has some limitations. If target type `T` is
273
- * notfollowing those restrictions, compilation errors would be occurred.
274
- *
275
- * 1. Type `T` must be an object type
276
- * 2. Do not allow dynamic property
277
- * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
278
- * 4. By the way, union type never be not allowed
279
- *
280
- * @template T Expected type of decoded value
281
- * @param input Query string or URLSearchParams instance
282
- * @returns Decoded query object or `null` value
283
- *
284
- * @author Jeongho Nam - https://github.com/samchon
285
- */
286
- export function isQuery<T extends object>(
287
- input: string | IReadableURLSearchParams,
288
- ): Resolved<T> | null;
289
-
290
- /**
291
- * @internal
292
- */
293
- export function isQuery(): never {
294
- halt("isQuery");
295
- }
296
-
297
- /**
298
- * URL query decoder with type validation.
299
- *
300
- * `typia.http.validateQuery()` is a function decoding a query string or an
301
- * `URLSearchParams` instance, with automatic type casting to the expected type.
302
- * When property type be defined as `boolean` or `number` type,
303
- * `typia.http.validateQuery()` will cast the value to the expected type when decoding.
304
- *
305
- * Also, after decoding, `typia.http.validateQuery()` performs type validation to the
306
- * decoded value by combining with {@link validate} function. Therefore, when the
307
- * decoded value is not following the `T` type, {@link IValidation.IFailure} would
308
- * be returned. Otherwise, {@link IValidation.ISuccess} would be returned.
309
- *
310
- * By the way, as URL query is not enough to express complex data structures,
311
- * `typia.http.validateQuery()` function has some limitations. If target type `T` is
312
- * notfollowing those restrictions, compilation errors would be occurred.
313
- *
314
- * 1. Type `T` must be an object type
315
- * 2. Do not allow dynamic property
316
- * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
317
- * 4. By the way, union type never be not allowed
318
- *
319
- * @template T Expected type of decoded value
320
- * @param input Query string or URLSearchParams instance
321
- * @returns Validation result with decoded query object
322
- *
323
- * @author Jeongho Nam - https://github.com/samchon
324
- */
325
- export function validateQuery<T extends object>(
326
- input: string | IReadableURLSearchParams,
327
- ): IValidation<Resolved<T>>;
328
-
329
- /**
330
- * @internal
331
- */
332
- export function validateQuery(): never {
333
- halt("validateQuery");
334
- }
335
-
336
- /* -----------------------------------------------------------
337
- HEADERS
338
- ----------------------------------------------------------- */
339
- /**
340
- * Headers decoder (for express and fastify).
341
- *
342
- * `typia.http.headers()` is a function decoding an header instance, with automatic
343
- * type casting to the expected type. When property type be defined as `boolean` or
344
- * `number` type, `typia.http.headers()` will cast the value to the expected type.
345
- *
346
- * By the way, as HTTP headers are not enough to express complex data structures,
347
- * `typia.http.headers()` function has some limitations. If target type `T` is not
348
- * following those restrictions, compilation errors would be occurred.
349
- *
350
- * 1. Type `T` must be an object type
351
- * 2. Do not allow dynamic property
352
- * 3. Property key must be lower case
353
- * 4. Property value cannot be `null`, but `undefined` is possible
354
- * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
355
- * 6. By the way, union type never be not allowed
356
- * 7. Property `set-cookie` must be array type
357
- * 8. Those properties cannot be array type
358
- * - age
359
- * - authorization
360
- * - content-length
361
- * - content-type
362
- * - etag
363
- * - expires
364
- * - from
365
- * - host
366
- * - if-modified-since
367
- * - if-unmodified-since
368
- * - last-modified
369
- * - location
370
- * - max-forwards
371
- * - proxy-authorization
372
- * - referer
373
- * - retry-after
374
- * - server
375
- * - user-agent
376
- *
377
- * Also, `typia.http.headers()` function does not perform validation about the decoded
378
- * value. Therefore, if you can't sure that input data is following the `T` type,
379
- * it would better to call one of below functions instead.
380
- *
381
- * - {@link assertHeaders}
382
- * - {@link isHeaders}
383
- * - {@link validateHeaders}
384
- *
385
- * @template T Expected type of decoded value
386
- * @param input Query string or URLSearchParams instance
387
- * @returns Decoded headers object
388
- *
389
- * @author Jeongho Nam - https://github.com/samchon
390
- */
391
- export function headers<T extends object>(
392
- input: Record<string, string | string[] | undefined>,
393
- ): Resolved<T>;
394
-
395
- /**
396
- * @internal
397
- */
398
- export function headers(): never {
399
- halt("headers");
400
- }
401
-
402
- /**
403
- * Headers decoder with type assertion (for express and fastify).
404
- *
405
- * `typia.http.assertHeaders()` is a function decoding an header instance, with
406
- * automatic type casting to the expected type. When property type be defined as
407
- * `boolean` or `number` type, `typia.http.headers()` will cast the value to the
408
- * expected type.
409
- *
410
- * Also, after decoding, `typia.http.assertHeaders()` performs type assertion to the
411
- * decoded value by combining with {@link assert} function. Therefore, when the
412
- * decoded value is not following the `T` type, {@link TypeGuardError} or custom
413
- * error generated by *errorFactory* would be thrown.
414
- *
415
- * By the way, as HTTP headers are not enough to express complex data structures,
416
- * `typia.http.headers()` function has some limitations. If target type `T` is not
417
- * following those restrictions, compilation errors would be occurred.
418
- *
419
- * 1. Type `T` must be an object type
420
- * 2. Do not allow dynamic property
421
- * 3. Property key must be lower case
422
- * 4. Property value cannot be `null`, but `undefined` is possible
423
- * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
424
- * 6. By the way, union type never be not allowed
425
- * 7. Property `set-cookie` must be array type
426
- * 8. Those properties cannot be array type
427
- * - age
428
- * - authorization
429
- * - content-length
430
- * - content-type
431
- * - etag
432
- * - expires
433
- * - from
434
- * - host
435
- * - if-modified-since
436
- * - if-unmodified-since
437
- * - last-modified
438
- * - location
439
- * - max-forwards
440
- * - proxy-authorization
441
- * - referer
442
- * - retry-after
443
- * - server
444
- * - user-agent
445
- *
446
- * @template T Expected type of decoded value
447
- * @param input Query string or URLSearchParams instance
448
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
449
- * @returns Decoded headers object
450
- *
451
- * @author Jeongho Nam - https://github.com/samchon
452
- */
453
- export function assertHeaders<T extends object>(
454
- input: Record<string, string | string[] | undefined>,
455
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
456
- ): Resolved<T>;
457
-
458
- /**
459
- * @internal
460
- */
461
- export function assertHeaders(): never {
462
- halt("assertHeaders");
463
- }
464
-
465
- /**
466
- * > You must configure the generic argument `T`.
467
- *
468
- * Headers decoder with type checking (for express and fastify).
469
- *
470
- * `typia.http.isHeaders()` is a function decoding an header instance, with
471
- * automatic type casting to the expected type. When property type be defined as
472
- * `boolean` or `number` type, `typia.http.headers()` will cast the value to the
473
- * expected type.
474
- *
475
- * Also, after decoding, `typia.http.isHeaders()` performs type checking to the
476
- * decoded value by combining with {@link is} function. Therefore, when the
477
- * decoded value is not following the `T` type, `null` value would be returned.
478
- *
479
- * By the way, as HTTP headers are not enough to express complex data structures,
480
- * `typia.http.headers()` function has some limitations. If target type `T` is not
481
- * following those restrictions, compilation errors would be occurred.
482
- *
483
- * 1. Type `T` must be an object type
484
- * 2. Do not allow dynamic property
485
- * 3. Property key must be lower case
486
- * 4. Property value cannot be `null`, but `undefined` is possible
487
- * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
488
- * 6. By the way, union type never be not allowed
489
- * 7. Property `set-cookie` must be array type
490
- * 8. Those properties cannot be array type
491
- * - age
492
- * - authorization
493
- * - content-length
494
- * - content-type
495
- * - etag
496
- * - expires
497
- * - from
498
- * - host
499
- * - if-modified-since
500
- * - if-unmodified-since
501
- * - last-modified
502
- * - location
503
- * - max-forwards
504
- * - proxy-authorization
505
- * - referer
506
- * - retry-after
507
- * - server
508
- * - user-agent
509
- *
510
- * @template T Expected type of decoded value
511
- * @param input Query string or URLSearchParams instance
512
- * @returns Decoded headers object or `null` value
513
- *
514
- * @author Jeongho Nam - https://github.com/samchon
515
- */
516
- export function isHeaders<T extends object>(
517
- input: Record<string, string | string[] | undefined>,
518
- ): Resolved<T> | null;
519
-
520
- /**
521
- * @internal
522
- */
523
- export function isHeaders(): never {
524
- halt("isHeaders");
525
- }
526
-
527
- /**
528
- * Headers decoder with type validation (for express and fastify).
529
- *
530
- * `typia.http.validateHeaders()` is a function decoding an header instance, with
531
- * automatic type casting to the expected type. When property type be defined as
532
- * `boolean` or `number` type, `typia.http.headers()` will cast the value to the
533
- * expected type.
534
- *
535
- * Also, after decoding, `typia.http.validateHeaders()` performs type assertion to the
536
- * decoded value by combining with {@link validate} function. Therefore, when the
537
- * decoded value is not following the `T` type, {@link IValidation.IError} would be
538
- * returned. Otherwise, {@link IValidation.ISuccess} be returned.
539
- *
540
- * By the way, as HTTP headers are not enough to express complex data structures,
541
- * `typia.http.headers()` function has some limitations. If target type `T` is not
542
- * following those restrictions, compilation errors would be occurred.
543
- *
544
- * 1. Type `T` must be an object type
545
- * 2. Do not allow dynamic property
546
- * 3. Property key must be lower case
547
- * 4. Property value cannot be `null`, but `undefined` is possible
548
- * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
549
- * 6. By the way, union type never be not allowed
550
- * 7. Property `set-cookie` must be array type
551
- * 8. Those properties cannot be array type
552
- * - age
553
- * - authorization
554
- * - content-length
555
- * - content-type
556
- * - etag
557
- * - expires
558
- * - from
559
- * - host
560
- * - if-modified-since
561
- * - if-unmodified-since
562
- * - last-modified
563
- * - location
564
- * - max-forwards
565
- * - proxy-authorization
566
- * - referer
567
- * - retry-after
568
- * - server
569
- * - user-agent
570
- *
571
- * @template T Expected type of decoded value
572
- * @param input Query string or URLSearchParams instance
573
- * @returns Decoded headers object
574
- *
575
- * @author Jeongho Nam - https://github.com/samchon
576
- */
577
- export function validateHeaders<T extends object>(
578
- input: Record<string, string | string[] | undefined>,
579
- ): IValidation<Resolved<T>>;
580
-
581
- /**
582
- * @internal
583
- */
584
- export function validateHeaders(): never {
585
- halt("validateHeaders");
586
- }
587
-
588
- /* -----------------------------------------------------------
589
- PARAMETER
590
- ----------------------------------------------------------- */
591
- /**
592
- * URL path parameter decoder.
593
- *
594
- * `typia.http.parameter()` is a function decoding a path parameter, with automatic
595
- * type casting to the expected type. When type `T` has been defined as `boolean` or
596
- * `number` type, `typia.http.parameter()` will cast the value to the expected type.
597
- *
598
- * Also, `typia.http.parameter()` performs type assertion to the decoded value by
599
- * combining with {@link assert} function. Therefore, when the decoded value is not
600
- * following the `T` type, {@link TypeGuardError} would be thrown.
601
- *
602
- * @template T Expected type of decoded value
603
- * @param input Path parameter string
604
- * @returns Decoded path parameter value
605
- */
606
- export function parameter<T extends Atomic.Type | null>(
607
- input: string,
608
- ): Resolved<T>;
609
-
610
- /**
611
- * @internal
612
- */
613
- export function parameter(): never {
614
- halt("parameter");
615
- }
616
-
617
- /* -----------------------------------------------------------
618
- FACTORY FUNCTIONS
619
- ----------------------------------------------------------- */
620
- /**
621
- * Creates a reusable {@link formdata} function.
622
- *
623
- * @danger You must configure the generic argument `T`
624
- * @template T The type of the formdata object
625
- * @throws compile error
626
- *
627
- * @author Jeongho Nam - https://github.com/samchon
628
- */
629
- export function createFormData(): never;
630
-
631
- /**
632
- * Creates a reusable {@link formdata} function.
633
- *
634
- * @template T The type of the formdata object
635
- * @returns A reusable `formdata` function
636
- *
637
- * @author Jeongho Nam - https://github.com/samchon
638
- */
639
- export function createFormData<T extends object>(): (input: FormData) => T;
640
-
641
- /**
642
- * @internal
643
- */
644
- export function createFormData<T>(): (input: FormData) => T {
645
- halt("createFormData");
646
- }
647
-
648
- /**
649
- * Creates a reusable {@link assertFormData} function.
650
- *
651
- * @danger You must configure the generic argument `T`
652
- * @template T The type of the formdata object
653
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
654
- * @throws compile error
655
- *
656
- * @author Jeongho Nam - https://github.com/samchon
657
- */
658
- export function createAssertFormData(
659
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
660
- ): never;
661
-
662
- /**
663
- * Creates a reusable {@link assertFormData} function.
664
- *
665
- * @template T The type of the formdata object
666
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
667
- * @returns A reusable `assertFormData` function
668
- *
669
- * @author Jeongho Nam - https://github.com/samchon
670
- */
671
- export function createAssertFormData<T extends object>(
672
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
673
- ): (input: FormData) => T;
674
-
675
- /**
676
- * @internal
677
- */
678
- export function createAssertFormData<T>(): (input: FormData) => T {
679
- halt("createAssertFormData");
680
- }
681
-
682
- /**
683
- * Creates a reusable {@link isFormData} function.
684
- *
685
- * @danger You must configure the generic argument `T`
686
- * @template T The type of the formdata object
687
- * @throws compile error
688
- *
689
- * @author Jeongho Nam - https://github.com/samchon
690
- */
691
- export function createIsFormData(): never;
692
-
693
- /**
694
- * Creates a reusable {@link isFormData} function.
695
- *
696
- * @template T The type of the formdata object
697
- * @returns A reusable `isFormData` function
698
- *
699
- * @author Jeongho Nam - https://github.com/samchon
700
- */
701
- export function createIsFormData<T extends object>(): (
702
- input: FormData,
703
- ) => T | null;
704
-
705
- /**
706
- * @internal
707
- */
708
- export function createIsFormData<T>(): (input: FormData) => T | null {
709
- halt("createIsFormData");
710
- }
711
-
712
- /**
713
- * Creates a reusable {@link validateFormData} function.
714
- *
715
- * @danger You must configure the generic argument `T`
716
- * @template T The type of the formdata object
717
- * @throws compile error
718
- *
719
- * @author Jeongho Nam - https://github.com/samchon
720
- */
721
- export function createValidateFormData(): never;
722
-
723
- /**
724
- * Creates a reusable {@link validateFormData} function.
725
- *
726
- * @template T The type of the formdata object
727
- * @returns A reusable `validateFormData` function
728
- *
729
- * @author Jeongho Nam - https://github.com/samchon
730
- */
731
- export function createValidateFormData<T extends object>(): (
732
- input: FormData,
733
- ) => IValidation<Resolved<T>>;
734
-
735
- /**
736
- * @internal
737
- */
738
- export function createValidateFormData<T>(): (
739
- input: FormData,
740
- ) => IValidation<Resolved<T>> {
741
- halt("createValidateFormData");
742
- }
743
-
744
- /**
745
- * Creates a reusable {@link query} function.
746
- *
747
- * @danger You must configure the generic argument `T`
748
- * @template T The type of the query object
749
- * @throws compile error
750
- *
751
- * @author Jeongho Nam - https://github.com/samchon
752
- */
753
- export function createQuery(): never;
754
-
755
- /**
756
- * Creates a reusable {@link query} function.
757
- *
758
- * @template T The type of the query object
759
- * @returns A reusable `query` function
760
- *
761
- * @author Jeongho Nam - https://github.com/samchon
762
- */
763
- export function createQuery<T extends object>(): (
764
- input: string | IReadableURLSearchParams,
765
- ) => T;
766
-
767
- /**
768
- * @internal
769
- */
770
- export function createQuery<T>(): (
771
- input: string | IReadableURLSearchParams,
772
- ) => T {
773
- halt("createQuery");
774
- }
775
-
776
- /**
777
- * Creates a reusable {@link assertQuery} function.
778
- *
779
- * @danger You must configure the generic argument `T`
780
- * @template T The type of the query object
781
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
782
- * @throws compile error
783
- *
784
- * @author Jeongho Nam - https://github.com/samchon
785
- */
786
- export function createAssertQuery(
787
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
788
- ): never;
789
-
790
- /**
791
- * Creates a reusable {@link assertQuery} function.
792
- *
793
- * @template T The type of the query object
794
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
795
- * @returns A reusable `assertQuery` function
796
- *
797
- * @author Jeongho Nam - https://github.com/samchon
798
- */
799
- export function createAssertQuery<T extends object>(
800
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
801
- ): (input: string | IReadableURLSearchParams) => T;
802
-
803
- /**
804
- * @internal
805
- */
806
- export function createAssertQuery<T>(): (
807
- input: string | IReadableURLSearchParams,
808
- ) => T {
809
- halt("createAssertQuery");
810
- }
811
-
812
- /**
813
- * Creates a reusable {@link isQuery} function.
814
- *
815
- * @danger You must configure the generic argument `T`
816
- * @template T The type of the query object
817
- * @throws compile error
818
- *
819
- * @author Jeongho Nam - https://github.com/samchon
820
- */
821
- export function createIsQuery(): never;
822
-
823
- /**
824
- * Creates a reusable {@link isQuery} function.
825
- *
826
- * @template T The type of the query object
827
- * @returns A reusable `isQuery` function
828
- *
829
- * @author Jeongho Nam - https://github.com/samchon
830
- */
831
- export function createIsQuery<T extends object>(): (
832
- input: string | IReadableURLSearchParams,
833
- ) => T | null;
834
-
835
- /**
836
- * @internal
837
- */
838
- export function createIsQuery<T>(): (
839
- input: string | IReadableURLSearchParams,
840
- ) => T | null {
841
- halt("createIsQuery");
842
- }
843
-
844
- /**
845
- * Creates a reusable {@link validateQuery} function.
846
- *
847
- * @danger You must configure the generic argument `T`
848
- * @template T The type of the query object
849
- * @throws compile error
850
- *
851
- * @author Jeongho Nam - https://github.com/samchon
852
- */
853
- export function createValidateQuery(): never;
854
-
855
- /**
856
- * Creates a reusable {@link validateQuery} function.
857
- *
858
- * @template T The type of the query object
859
- * @returns A reusable `validateQuery` function
860
- *
861
- * @author Jeongho Nam - https://github.com/samchon
862
- */
863
- export function createValidateQuery<T extends object>(): (
864
- input: string | IReadableURLSearchParams,
865
- ) => IValidation<Resolved<T>>;
866
-
867
- /**
868
- * @internal
869
- */
870
- export function createValidateQuery<T>(): (
871
- input: string | IReadableURLSearchParams,
872
- ) => IValidation<Resolved<T>> {
873
- halt("createValidateQuery");
874
- }
875
-
876
- /**
877
- * Creates a reusable {@link headers} function.
878
- *
879
- * @danger You must configure the generic argument `T`
880
- * @template T The type of the headers object
881
- * @throws compile error
882
- *
883
- * @author Jeongho Nam - https://github.com/samchon
884
- */
885
- export function createHeaders(): never;
886
-
887
- /**
888
- * Creates a reusable {@link headers} function.
889
- *
890
- * @template T The type of the headers object
891
- * @returns A reusable `headers` function
892
- *
893
- * @author Jeongho Nam - https://github.com/samchon
894
- */
895
- export function createHeaders<T extends object>(): (
896
- input: Record<string, string | string[] | undefined>,
897
- ) => T;
898
-
899
- /**
900
- * @internal
901
- */
902
- export function createHeaders<T>(): (
903
- input: Record<string, string | string[] | undefined>,
904
- ) => T {
905
- halt("createHeaders");
906
- }
907
-
908
- /**
909
- * Creates a reusable {@link assertHeaders} function.
910
- *
911
- * @danger You must configure the generic argument `T`
912
- * @template T The type of the headers object
913
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
914
- * @throws compile error
915
- *
916
- * @author Jeongho Nam - https://github.com/samchon
917
- */
918
- export function createAssertHeaders(
919
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
920
- ): never;
921
-
922
- /**
923
- * Creates a reusable {@link assertHeaders} function.
924
- *
925
- * @template T The type of the headers object
926
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
927
- * @returns A reusable `assertHeaders` function
928
- *
929
- * @author Jeongho Nam - https://github.com/samchon
930
- */
931
- export function createAssertHeaders<T extends object>(
932
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
933
- ): (input: Record<string, string | string[] | undefined>) => T;
934
-
935
- /**
936
- * @internal
937
- */
938
- export function createAssertHeaders<T>(): (
939
- input: Record<string, string | string[] | undefined>,
940
- ) => T {
941
- halt("createAssertHeaders");
942
- }
943
-
944
- /**
945
- * Creates a reusable {@link isHeaders} function.
946
- *
947
- * @danger You must configure the generic argument `T`
948
- * @template T The type of the headers object
949
- * @throws compile error
950
- *
951
- * @author Jeongho Nam - https://github.com/samchon
952
- */
953
- export function createIsHeaders(): never;
954
-
955
- /**
956
- * Creates a reusable {@link isHeaders} function.
957
- *
958
- * @template T The type of the headers object
959
- * @returns A reusable `isHeaders` function
960
- *
961
- * @author Jeongho Nam - https://github.com/samchon
962
- */
963
- export function createIsHeaders<T extends object>(): (
964
- input: Record<string, string | string[] | undefined>,
965
- ) => T | null;
966
-
967
- /**
968
- * @internal
969
- */
970
- export function createIsHeaders<T>(): (
971
- input: Record<string, string | string[] | undefined>,
972
- ) => T | null {
973
- halt("createIsHeaders");
974
- }
975
-
976
- /**
977
- * Creates a reusable {@link validateHeaders} function.
978
- *
979
- * @danger You must configure the generic argument `T`
980
- * @template T The type of the headers object
981
- * @throws compile error
982
- *
983
- * @author Jeongho Nam - https://github.com/samchon
984
- */
985
- export function createValidateHeaders(): never;
986
-
987
- /**
988
- * Creates a reusable {@link validateHeaders} function.
989
- *
990
- * @template T The type of the headers object
991
- * @returns A reusable `validateHeaders` function
992
- *
993
- * @author Jeongho Nam - https://github.com/samchon
994
- */
995
- export function createValidateHeaders<T extends object>(): (
996
- input: Record<string, string | string[] | undefined>,
997
- ) => IValidation<Resolved<T>>;
998
-
999
- /**
1000
- * @internal
1001
- */
1002
- export function createValidateHeaders<T>(): (
1003
- input: Record<string, string | string[] | undefined>,
1004
- ) => IValidation<Resolved<T>> {
1005
- halt("createValidateHeaders");
1006
- }
1007
-
1008
- /**
1009
- * Creates a reusable {@link parameter} function.
1010
- *
1011
- * @danger You must configure the generic argument `T`
1012
- * @template T The type of the parameter value
1013
- * @throws compile error
1014
- *
1015
- * @author Jeongho Nam - https://github.com/samchon
1016
- */
1017
- export function createParameter(): never;
1018
-
1019
- /**
1020
- * Creates a reusable {@link parameter} function.
1021
- *
1022
- * @template T The type of the parameter value
1023
- * @returns A reusable `parameter` function
1024
- *
1025
- * @author Jeongho Nam - https://github.com/samchon
1026
- */
1027
- export function createParameter<T extends Atomic.Type | null>(): (
1028
- input: string,
1029
- ) => T;
1030
-
1031
- /**
1032
- * @internal
1033
- */
1034
- export function createParameter<T extends Atomic.Type | null>(): (
1035
- input: string,
1036
- ) => T {
1037
- halt("createParameter");
1038
- }
1039
-
1040
- /**
1041
- * @internal
1042
- */
1043
- function halt(name: string): never {
1044
- throw new Error(
1045
- `Error on typia.http.${name}(): no transform has been configured. Read and follow https://typia.io/docs/setup please.`,
1046
- );
1047
- }
1
+ import { NoTransformConfigurationError } from "./transformers/NoTransformConfigurationError";
2
+
3
+ import { Atomic } from "./typings/Atomic";
4
+
5
+ import { IReadableURLSearchParams } from "./IReadableURLSearchParams";
6
+ import { IValidation } from "./IValidation";
7
+ import { Resolved } from "./Resolved";
8
+ import { TypeGuardError } from "./TypeGuardError";
9
+
10
+ /* ===========================================================
11
+ HTTP
12
+ - FORM-DATA
13
+ - QUERY
14
+ - HEADERS
15
+ - PARAMETER
16
+ - FACTORY FUNCTIONS
17
+ ==============================================================
18
+ FORM-DATA
19
+ ----------------------------------------------------------- */
20
+ /**
21
+ * Form data decoder.
22
+ *
23
+ * `typia.http.formData()` is a function decoding `FormData` instance, with
24
+ * automatic type casting to the expected type. When roperty type be defined
25
+ * as `boolean` or `Blob` type, `typia.http.formData()` will cast the value to
26
+ * the expected type when decoding.
27
+ *
28
+ * By the way, as `FormData` is not enough to express complex data structures,
29
+ * `typia.http.formData()` function has some limitations. If target type `T` is
30
+ * not following those restrictions, compilation errors would be occurred.
31
+ *
32
+ * 1. Type `T` must be an object type
33
+ * 2. Do not allow dynamic property
34
+ * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array types are allowed
35
+ * 4. By the way, union type never be not allowed
36
+ *
37
+ * Also, `typia.http.formData()` function does not perform validation about the
38
+ * decoded value. Therefore, if you can't sure that input data is following the
39
+ * `T` type, it would better to call one of below functions instead.
40
+ *
41
+ * @template T Expected type of decoded value
42
+ * @param input FormData instance
43
+ * @returns Decoded form FormData
44
+ *
45
+ * @author Jeongho Nam - https://github.com/samchon
46
+ */
47
+ export function formData<T extends object>(input: FormData): Resolved<T>;
48
+
49
+ /**
50
+ * @internal
51
+ */
52
+ export function formData(): never {
53
+ NoTransformConfigurationError("http.formData");
54
+ }
55
+
56
+ /**
57
+ * Form data decoder with type assertion.
58
+ *
59
+ * `typia.http.assertFormData()` is a function decoding `FormData` instance, with
60
+ * automatic type casting to the expected type. When roperty type be defined
61
+ * as `boolean` or `Blob` type, `typia.http.assertFormData()` will cast the value
62
+ * to the expected type when decoding.
63
+ *
64
+ * Also, after decoding, `typia.http.assertFormData()` performs type assertion to
65
+ * the decoded value by combining with {@link assert} function. Therefore, when
66
+ * the decoded value is not following the `T` type, {@link TypeGuardError} or
67
+ * custom error generated by *errorFactory* would be thrown.
68
+ *
69
+ * By the way, as `FormData` is not enough to express complex data structures,
70
+ * `typia.http.assertFormData()` function has some limitations. If target type `T`
71
+ * is not following those restrictions, compilation errors would be occurred.
72
+ *
73
+ * 1. Type `T` must be an object type
74
+ * 2. Do not allow dynamic property
75
+ * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array types are allowed
76
+ * 4. By the way, union type never be not allowed
77
+ *
78
+ * @template T Expected type of decoded value
79
+ * @param input FormData instance
80
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
81
+ * @returns Decoded form FormData
82
+ *
83
+ * @author Jeongho Nam - https://github.com/samchon
84
+ */
85
+ export function assertFormData<T extends object>(
86
+ input: FormData,
87
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
88
+ ): Resolved<T>;
89
+
90
+ /**
91
+ * @internal
92
+ */
93
+ export function assertFormData(): never {
94
+ NoTransformConfigurationError("http.assertFormData");
95
+ }
96
+
97
+ /**
98
+ * Form data decoder with type checking.
99
+ *
100
+ * `typia.http.isFormData()` is a function decoding `FormData` instance, with
101
+ * automatic type casting to the expected type. When roperty type be defined
102
+ * as `boolean` or `Blob` type, `typia.http.isFormData()` will cast the value
103
+ * to the expected type when decoding.
104
+ *
105
+ * Also, after decoding, `typia.http.isFormData()` performs type checking to the
106
+ * decoded value by combining with {@link is} function. Therefore, when the
107
+ * decoded value is not following the `T` type, `null` value would be returned.
108
+ *
109
+ * By the way, as `FormData` is not enough to express complex data structures,
110
+ * `typia.http.isFormData()` function has some limitations. If target type `T` is
111
+ * not following those restrictions, compilation errors would be occurred.
112
+ *
113
+ * 1. Type `T` must be an object type
114
+ * 2. Do not allow dynamic property
115
+ * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array types are allowed
116
+ * 4. By the way, union type never be not allowed
117
+ *
118
+ * @template T Expected type of decoded value
119
+ * @param input FormData instance
120
+ * @returns Decoded form FormData or `null` value
121
+ *
122
+ * @author Jeongho Nam - https://github.com/samchon
123
+ */
124
+ export function isFormData<T extends object>(
125
+ input: FormData,
126
+ ): Resolved<T> | null;
127
+
128
+ /**
129
+ * @internal
130
+ */
131
+ export function isFormData(): never {
132
+ NoTransformConfigurationError("http.isFormData");
133
+ }
134
+
135
+ /**
136
+ * Form data decoder with type validation.
137
+ *
138
+ * `typia.http.validateFormData()` is a function decoding `FormData` instance,
139
+ * with automatic type casting to the expected type. When roperty type be defined
140
+ * as `boolean` or `Blob` type, `typia.http.validateFormData()` will cast the
141
+ * value to the expected type when decoding.
142
+ *
143
+ * Also, after decoding, `typia.http.validateFormData()` performs type validation
144
+ * to the decoded value by combining with {@link validate} function. Therefore,
145
+ * when the decoded value is not following the `T` type,
146
+ * {@link IValidation.IFailure} would be returned. Otherwise,
147
+ * x@xxxx IValidation.ISuccess} would be returned.
148
+ *
149
+ * By the way, as `FormData` is not enough to express complex data structures,
150
+ * `typia.http.validateFormData()` function has some limitations. If target type
151
+ * `T` is not following those restrictions, compilation errors would be occurred.
152
+ *
153
+ * 1. Type `T` must be an object type
154
+ * 2. Do not allow dynamic property
155
+ * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array types are allowed
156
+ * 4. By the way, union type never be not allowed
157
+ *
158
+ * @template T Expected type of decoded value
159
+ * @param input FormData instance
160
+ * @returns Validation result with decoded form FormData
161
+ *
162
+ * @author Jeongho Nam - https://github.com/samchon
163
+ */
164
+ export function validateFormData<T extends object>(
165
+ input: FormData,
166
+ ): IValidation<Resolved<T>>;
167
+
168
+ /**
169
+ * @internal
170
+ */
171
+ export function validateFormData(): never {
172
+ NoTransformConfigurationError("http.validateFormData");
173
+ }
174
+
175
+ /* -----------------------------------------------------------
176
+ QUERY
177
+ ----------------------------------------------------------- */
178
+ /**
179
+ * URL query decoder.
180
+ *
181
+ * `typia.http.query()` is a function decoding a query string or an `URLSearchParams`
182
+ * instance, with automatic type casting to the expected type. When property type be
183
+ * defined as `boolean` or `number` type, `typia.http.query()` will cast the value to
184
+ * the expected type when decoding.
185
+ *
186
+ * By the way, as URL query is not enough to express complex data structures,
187
+ * `typia.http.query()` function has some limitations. If target type `T` is not
188
+ * following those restrictions, compilation errors would be occurred.
189
+ *
190
+ * 1. Type `T` must be an object type
191
+ * 2. Do not allow dynamic property
192
+ * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
193
+ * 4. By the way, union type never be not allowed
194
+ *
195
+ * Also, `typia.http.query()` function does not perform validation about the decoded
196
+ * value. Therefore, if you can't sure that input data is following the `T` type,
197
+ * it would better to call one of below functions instead.
198
+ *
199
+ * - {@link assertQuery}
200
+ * - {@link isQuery}
201
+ * - {@link validateQuery}
202
+ *
203
+ * @template T Expected type of decoded value
204
+ * @param input Query string or URLSearchParams instance
205
+ * @returns Decoded query object
206
+ *
207
+ * @author Jeongho Nam - https://github.com/samchon
208
+ */
209
+ export function query<T extends object>(
210
+ input: string | IReadableURLSearchParams,
211
+ ): Resolved<T>;
212
+
213
+ /**
214
+ * @internal
215
+ */
216
+ export function query(): never {
217
+ NoTransformConfigurationError("http.query");
218
+ }
219
+
220
+ /**
221
+ * URL query decoder with type assertion.
222
+ *
223
+ * `typia.http.assertQuery()` is a function decoding a query string or an
224
+ * `URLSearchParams` instance, with automatic type casting to the expected type.
225
+ * When property type be defined as `boolean` or `number` type,
226
+ * `typia.http.assertQuery()` will cast the value to the expected type when decoding.
227
+ *
228
+ * Also, after decoding, `typia.http.assertQuery()` performs type assertion to the
229
+ * decoded value by combining with {@link assert} function. Therefore, when the
230
+ * decoded value is not following the `T` type, {@link TypeGuardError} or custom
231
+ * error generated by *errorFactory* would be thrown.
232
+ *
233
+ * By the way, as URL query is not enough to express complex data structures,
234
+ * `typia.http.assertQuery()` function has some limitations. If target type `T` is
235
+ * notfollowing those restrictions, compilation errors would be occurred.
236
+ *
237
+ * 1. Type `T` must be an object type
238
+ * 2. Do not allow dynamic property
239
+ * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
240
+ * 4. By the way, union type never be not allowed
241
+ *
242
+ * @template T Expected type of decoded value
243
+ * @param input Query string or URLSearchParams instance
244
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
245
+ * @returns Decoded query object
246
+ *
247
+ * @author Jeongho Nam - https://github.com/samchon
248
+ */
249
+ export function assertQuery<T extends object>(
250
+ input: string | IReadableURLSearchParams,
251
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
252
+ ): Resolved<T>;
253
+
254
+ /**
255
+ * @internal
256
+ */
257
+ export function assertQuery(): never {
258
+ NoTransformConfigurationError("http.assertQuery");
259
+ }
260
+
261
+ /**
262
+ * URL query decoder with type checking.
263
+ *
264
+ * `typia.http.isQuery()` is a function decoding a query string or an
265
+ * `URLSearchParams` instance, with automatic type casting to the expected type.
266
+ * When property type be defined as `boolean` or `number` type,
267
+ * `typia.http.isQuery()` will cast the value to the expected type when decoding.
268
+ *
269
+ * Also, after decoding, `typia.http.isQuery()` performs type checking to the
270
+ * decoded value by combining with {@link is} function. Therefore, when the
271
+ * decoded value is not following the `T` type, `null` value would be returned.
272
+ *
273
+ * By the way, as URL query is not enough to express complex data structures,
274
+ * `typia.http.isQuery()` function has some limitations. If target type `T` is
275
+ * notfollowing those restrictions, compilation errors would be occurred.
276
+ *
277
+ * 1. Type `T` must be an object type
278
+ * 2. Do not allow dynamic property
279
+ * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
280
+ * 4. By the way, union type never be not allowed
281
+ *
282
+ * @template T Expected type of decoded value
283
+ * @param input Query string or URLSearchParams instance
284
+ * @returns Decoded query object or `null` value
285
+ *
286
+ * @author Jeongho Nam - https://github.com/samchon
287
+ */
288
+ export function isQuery<T extends object>(
289
+ input: string | IReadableURLSearchParams,
290
+ ): Resolved<T> | null;
291
+
292
+ /**
293
+ * @internal
294
+ */
295
+ export function isQuery(): never {
296
+ NoTransformConfigurationError("http.isQuery");
297
+ }
298
+
299
+ /**
300
+ * URL query decoder with type validation.
301
+ *
302
+ * `typia.http.validateQuery()` is a function decoding a query string or an
303
+ * `URLSearchParams` instance, with automatic type casting to the expected type.
304
+ * When property type be defined as `boolean` or `number` type,
305
+ * `typia.http.validateQuery()` will cast the value to the expected type when decoding.
306
+ *
307
+ * Also, after decoding, `typia.http.validateQuery()` performs type validation to the
308
+ * decoded value by combining with {@link validate} function. Therefore, when the
309
+ * decoded value is not following the `T` type, {@link IValidation.IFailure} would
310
+ * be returned. Otherwise, {@link IValidation.ISuccess} would be returned.
311
+ *
312
+ * By the way, as URL query is not enough to express complex data structures,
313
+ * `typia.http.validateQuery()` function has some limitations. If target type `T` is
314
+ * notfollowing those restrictions, compilation errors would be occurred.
315
+ *
316
+ * 1. Type `T` must be an object type
317
+ * 2. Do not allow dynamic property
318
+ * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
319
+ * 4. By the way, union type never be not allowed
320
+ *
321
+ * @template T Expected type of decoded value
322
+ * @param input Query string or URLSearchParams instance
323
+ * @returns Validation result with decoded query object
324
+ *
325
+ * @author Jeongho Nam - https://github.com/samchon
326
+ */
327
+ export function validateQuery<T extends object>(
328
+ input: string | IReadableURLSearchParams,
329
+ ): IValidation<Resolved<T>>;
330
+
331
+ /**
332
+ * @internal
333
+ */
334
+ export function validateQuery(): never {
335
+ NoTransformConfigurationError("http.validateQuery");
336
+ }
337
+
338
+ /* -----------------------------------------------------------
339
+ HEADERS
340
+ ----------------------------------------------------------- */
341
+ /**
342
+ * Headers decoder (for express and fastify).
343
+ *
344
+ * `typia.http.headers()` is a function decoding an header instance, with automatic
345
+ * type casting to the expected type. When property type be defined as `boolean` or
346
+ * `number` type, `typia.http.headers()` will cast the value to the expected type.
347
+ *
348
+ * By the way, as HTTP headers are not enough to express complex data structures,
349
+ * `typia.http.headers()` function has some limitations. If target type `T` is not
350
+ * following those restrictions, compilation errors would be occurred.
351
+ *
352
+ * 1. Type `T` must be an object type
353
+ * 2. Do not allow dynamic property
354
+ * 3. Property key must be lower case
355
+ * 4. Property value cannot be `null`, but `undefined` is possible
356
+ * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
357
+ * 6. By the way, union type never be not allowed
358
+ * 7. Property `set-cookie` must be array type
359
+ * 8. Those properties cannot be array type
360
+ * - age
361
+ * - authorization
362
+ * - content-length
363
+ * - content-type
364
+ * - etag
365
+ * - expires
366
+ * - from
367
+ * - host
368
+ * - if-modified-since
369
+ * - if-unmodified-since
370
+ * - last-modified
371
+ * - location
372
+ * - max-forwards
373
+ * - proxy-authorization
374
+ * - referer
375
+ * - retry-after
376
+ * - server
377
+ * - user-agent
378
+ *
379
+ * Also, `typia.http.headers()` function does not perform validation about the decoded
380
+ * value. Therefore, if you can't sure that input data is following the `T` type,
381
+ * it would better to call one of below functions instead.
382
+ *
383
+ * - {@link assertHeaders}
384
+ * - {@link isHeaders}
385
+ * - {@link validateHeaders}
386
+ *
387
+ * @template T Expected type of decoded value
388
+ * @param input Query string or URLSearchParams instance
389
+ * @returns Decoded headers object
390
+ *
391
+ * @author Jeongho Nam - https://github.com/samchon
392
+ */
393
+ export function headers<T extends object>(
394
+ input: Record<string, string | string[] | undefined>,
395
+ ): Resolved<T>;
396
+
397
+ /**
398
+ * @internal
399
+ */
400
+ export function headers(): never {
401
+ NoTransformConfigurationError("http.headers");
402
+ }
403
+
404
+ /**
405
+ * Headers decoder with type assertion (for express and fastify).
406
+ *
407
+ * `typia.http.assertHeaders()` is a function decoding an header instance, with
408
+ * automatic type casting to the expected type. When property type be defined as
409
+ * `boolean` or `number` type, `typia.http.headers()` will cast the value to the
410
+ * expected type.
411
+ *
412
+ * Also, after decoding, `typia.http.assertHeaders()` performs type assertion to the
413
+ * decoded value by combining with {@link assert} function. Therefore, when the
414
+ * decoded value is not following the `T` type, {@link TypeGuardError} or custom
415
+ * error generated by *errorFactory* would be thrown.
416
+ *
417
+ * By the way, as HTTP headers are not enough to express complex data structures,
418
+ * `typia.http.headers()` function has some limitations. If target type `T` is not
419
+ * following those restrictions, compilation errors would be occurred.
420
+ *
421
+ * 1. Type `T` must be an object type
422
+ * 2. Do not allow dynamic property
423
+ * 3. Property key must be lower case
424
+ * 4. Property value cannot be `null`, but `undefined` is possible
425
+ * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
426
+ * 6. By the way, union type never be not allowed
427
+ * 7. Property `set-cookie` must be array type
428
+ * 8. Those properties cannot be array type
429
+ * - age
430
+ * - authorization
431
+ * - content-length
432
+ * - content-type
433
+ * - etag
434
+ * - expires
435
+ * - from
436
+ * - host
437
+ * - if-modified-since
438
+ * - if-unmodified-since
439
+ * - last-modified
440
+ * - location
441
+ * - max-forwards
442
+ * - proxy-authorization
443
+ * - referer
444
+ * - retry-after
445
+ * - server
446
+ * - user-agent
447
+ *
448
+ * @template T Expected type of decoded value
449
+ * @param input Query string or URLSearchParams instance
450
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
451
+ * @returns Decoded headers object
452
+ *
453
+ * @author Jeongho Nam - https://github.com/samchon
454
+ */
455
+ export function assertHeaders<T extends object>(
456
+ input: Record<string, string | string[] | undefined>,
457
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
458
+ ): Resolved<T>;
459
+
460
+ /**
461
+ * @internal
462
+ */
463
+ export function assertHeaders(): never {
464
+ NoTransformConfigurationError("http.assertHeaders");
465
+ }
466
+
467
+ /**
468
+ * > You must configure the generic argument `T`.
469
+ *
470
+ * Headers decoder with type checking (for express and fastify).
471
+ *
472
+ * `typia.http.isHeaders()` is a function decoding an header instance, with
473
+ * automatic type casting to the expected type. When property type be defined as
474
+ * `boolean` or `number` type, `typia.http.headers()` will cast the value to the
475
+ * expected type.
476
+ *
477
+ * Also, after decoding, `typia.http.isHeaders()` performs type checking to the
478
+ * decoded value by combining with {@link is} function. Therefore, when the
479
+ * decoded value is not following the `T` type, `null` value would be returned.
480
+ *
481
+ * By the way, as HTTP headers are not enough to express complex data structures,
482
+ * `typia.http.headers()` function has some limitations. If target type `T` is not
483
+ * following those restrictions, compilation errors would be occurred.
484
+ *
485
+ * 1. Type `T` must be an object type
486
+ * 2. Do not allow dynamic property
487
+ * 3. Property key must be lower case
488
+ * 4. Property value cannot be `null`, but `undefined` is possible
489
+ * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
490
+ * 6. By the way, union type never be not allowed
491
+ * 7. Property `set-cookie` must be array type
492
+ * 8. Those properties cannot be array type
493
+ * - age
494
+ * - authorization
495
+ * - content-length
496
+ * - content-type
497
+ * - etag
498
+ * - expires
499
+ * - from
500
+ * - host
501
+ * - if-modified-since
502
+ * - if-unmodified-since
503
+ * - last-modified
504
+ * - location
505
+ * - max-forwards
506
+ * - proxy-authorization
507
+ * - referer
508
+ * - retry-after
509
+ * - server
510
+ * - user-agent
511
+ *
512
+ * @template T Expected type of decoded value
513
+ * @param input Query string or URLSearchParams instance
514
+ * @returns Decoded headers object or `null` value
515
+ *
516
+ * @author Jeongho Nam - https://github.com/samchon
517
+ */
518
+ export function isHeaders<T extends object>(
519
+ input: Record<string, string | string[] | undefined>,
520
+ ): Resolved<T> | null;
521
+
522
+ /**
523
+ * @internal
524
+ */
525
+ export function isHeaders(): never {
526
+ NoTransformConfigurationError("http.isHeaders");
527
+ }
528
+
529
+ /**
530
+ * Headers decoder with type validation (for express and fastify).
531
+ *
532
+ * `typia.http.validateHeaders()` is a function decoding an header instance, with
533
+ * automatic type casting to the expected type. When property type be defined as
534
+ * `boolean` or `number` type, `typia.http.headers()` will cast the value to the
535
+ * expected type.
536
+ *
537
+ * Also, after decoding, `typia.http.validateHeaders()` performs type assertion to the
538
+ * decoded value by combining with {@link validate} function. Therefore, when the
539
+ * decoded value is not following the `T` type, {@link IValidation.IError} would be
540
+ * returned. Otherwise, {@link IValidation.ISuccess} be returned.
541
+ *
542
+ * By the way, as HTTP headers are not enough to express complex data structures,
543
+ * `typia.http.headers()` function has some limitations. If target type `T` is not
544
+ * following those restrictions, compilation errors would be occurred.
545
+ *
546
+ * 1. Type `T` must be an object type
547
+ * 2. Do not allow dynamic property
548
+ * 3. Property key must be lower case
549
+ * 4. Property value cannot be `null`, but `undefined` is possible
550
+ * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
551
+ * 6. By the way, union type never be not allowed
552
+ * 7. Property `set-cookie` must be array type
553
+ * 8. Those properties cannot be array type
554
+ * - age
555
+ * - authorization
556
+ * - content-length
557
+ * - content-type
558
+ * - etag
559
+ * - expires
560
+ * - from
561
+ * - host
562
+ * - if-modified-since
563
+ * - if-unmodified-since
564
+ * - last-modified
565
+ * - location
566
+ * - max-forwards
567
+ * - proxy-authorization
568
+ * - referer
569
+ * - retry-after
570
+ * - server
571
+ * - user-agent
572
+ *
573
+ * @template T Expected type of decoded value
574
+ * @param input Query string or URLSearchParams instance
575
+ * @returns Decoded headers object
576
+ *
577
+ * @author Jeongho Nam - https://github.com/samchon
578
+ */
579
+ export function validateHeaders<T extends object>(
580
+ input: Record<string, string | string[] | undefined>,
581
+ ): IValidation<Resolved<T>>;
582
+
583
+ /**
584
+ * @internal
585
+ */
586
+ export function validateHeaders(): never {
587
+ NoTransformConfigurationError("http.validateHeaders");
588
+ }
589
+
590
+ /* -----------------------------------------------------------
591
+ PARAMETER
592
+ ----------------------------------------------------------- */
593
+ /**
594
+ * URL path parameter decoder.
595
+ *
596
+ * `typia.http.parameter()` is a function decoding a path parameter, with automatic
597
+ * type casting to the expected type. When type `T` has been defined as `boolean` or
598
+ * `number` type, `typia.http.parameter()` will cast the value to the expected type.
599
+ *
600
+ * Also, `typia.http.parameter()` performs type assertion to the decoded value by
601
+ * combining with {@link assert} function. Therefore, when the decoded value is not
602
+ * following the `T` type, {@link TypeGuardError} would be thrown.
603
+ *
604
+ * @template T Expected type of decoded value
605
+ * @param input Path parameter string
606
+ * @returns Decoded path parameter value
607
+ */
608
+ export function parameter<T extends Atomic.Type | null>(
609
+ input: string,
610
+ ): Resolved<T>;
611
+
612
+ /**
613
+ * @internal
614
+ */
615
+ export function parameter(): never {
616
+ NoTransformConfigurationError("http.parameter");
617
+ }
618
+
619
+ /* -----------------------------------------------------------
620
+ FACTORY FUNCTIONS
621
+ ----------------------------------------------------------- */
622
+ /**
623
+ * Creates a reusable {@link formdata} function.
624
+ *
625
+ * @danger You must configure the generic argument `T`
626
+ * @template T The type of the formdata object
627
+ * @throws compile error
628
+ *
629
+ * @author Jeongho Nam - https://github.com/samchon
630
+ */
631
+ export function createFormData(): never;
632
+
633
+ /**
634
+ * Creates a reusable {@link formdata} function.
635
+ *
636
+ * @template T The type of the formdata object
637
+ * @returns A reusable `formdata` function
638
+ *
639
+ * @author Jeongho Nam - https://github.com/samchon
640
+ */
641
+ export function createFormData<T extends object>(): (input: FormData) => T;
642
+
643
+ /**
644
+ * @internal
645
+ */
646
+ export function createFormData<T>(): (input: FormData) => T {
647
+ NoTransformConfigurationError("http.createFormData");
648
+ }
649
+
650
+ /**
651
+ * Creates a reusable {@link assertFormData} function.
652
+ *
653
+ * @danger You must configure the generic argument `T`
654
+ * @template T The type of the formdata object
655
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
656
+ * @throws compile error
657
+ *
658
+ * @author Jeongho Nam - https://github.com/samchon
659
+ */
660
+ export function createAssertFormData(
661
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
662
+ ): never;
663
+
664
+ /**
665
+ * Creates a reusable {@link assertFormData} function.
666
+ *
667
+ * @template T The type of the formdata object
668
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
669
+ * @returns A reusable `assertFormData` function
670
+ *
671
+ * @author Jeongho Nam - https://github.com/samchon
672
+ */
673
+ export function createAssertFormData<T extends object>(
674
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
675
+ ): (input: FormData) => T;
676
+
677
+ /**
678
+ * @internal
679
+ */
680
+ export function createAssertFormData<T>(): (input: FormData) => T {
681
+ NoTransformConfigurationError("http.createAssertFormData");
682
+ }
683
+
684
+ /**
685
+ * Creates a reusable {@link isFormData} function.
686
+ *
687
+ * @danger You must configure the generic argument `T`
688
+ * @template T The type of the formdata object
689
+ * @throws compile error
690
+ *
691
+ * @author Jeongho Nam - https://github.com/samchon
692
+ */
693
+ export function createIsFormData(): never;
694
+
695
+ /**
696
+ * Creates a reusable {@link isFormData} function.
697
+ *
698
+ * @template T The type of the formdata object
699
+ * @returns A reusable `isFormData` function
700
+ *
701
+ * @author Jeongho Nam - https://github.com/samchon
702
+ */
703
+ export function createIsFormData<T extends object>(): (
704
+ input: FormData,
705
+ ) => T | null;
706
+
707
+ /**
708
+ * @internal
709
+ */
710
+ export function createIsFormData<T>(): (input: FormData) => T | null {
711
+ NoTransformConfigurationError("http.createIsFormData");
712
+ }
713
+
714
+ /**
715
+ * Creates a reusable {@link validateFormData} function.
716
+ *
717
+ * @danger You must configure the generic argument `T`
718
+ * @template T The type of the formdata object
719
+ * @throws compile error
720
+ *
721
+ * @author Jeongho Nam - https://github.com/samchon
722
+ */
723
+ export function createValidateFormData(): never;
724
+
725
+ /**
726
+ * Creates a reusable {@link validateFormData} function.
727
+ *
728
+ * @template T The type of the formdata object
729
+ * @returns A reusable `validateFormData` function
730
+ *
731
+ * @author Jeongho Nam - https://github.com/samchon
732
+ */
733
+ export function createValidateFormData<T extends object>(): (
734
+ input: FormData,
735
+ ) => IValidation<Resolved<T>>;
736
+
737
+ /**
738
+ * @internal
739
+ */
740
+ export function createValidateFormData<T>(): (
741
+ input: FormData,
742
+ ) => IValidation<Resolved<T>> {
743
+ NoTransformConfigurationError("http.createValidateFormData");
744
+ }
745
+
746
+ /**
747
+ * Creates a reusable {@link query} function.
748
+ *
749
+ * @danger You must configure the generic argument `T`
750
+ * @template T The type of the query object
751
+ * @throws compile error
752
+ *
753
+ * @author Jeongho Nam - https://github.com/samchon
754
+ */
755
+ export function createQuery(): never;
756
+
757
+ /**
758
+ * Creates a reusable {@link query} function.
759
+ *
760
+ * @template T The type of the query object
761
+ * @returns A reusable `query` function
762
+ *
763
+ * @author Jeongho Nam - https://github.com/samchon
764
+ */
765
+ export function createQuery<T extends object>(): (
766
+ input: string | IReadableURLSearchParams,
767
+ ) => T;
768
+
769
+ /**
770
+ * @internal
771
+ */
772
+ export function createQuery<T>(): (
773
+ input: string | IReadableURLSearchParams,
774
+ ) => T {
775
+ NoTransformConfigurationError("http.createQuery");
776
+ }
777
+
778
+ /**
779
+ * Creates a reusable {@link assertQuery} function.
780
+ *
781
+ * @danger You must configure the generic argument `T`
782
+ * @template T The type of the query object
783
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
784
+ * @throws compile error
785
+ *
786
+ * @author Jeongho Nam - https://github.com/samchon
787
+ */
788
+ export function createAssertQuery(
789
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
790
+ ): never;
791
+
792
+ /**
793
+ * Creates a reusable {@link assertQuery} function.
794
+ *
795
+ * @template T The type of the query object
796
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
797
+ * @returns A reusable `assertQuery` function
798
+ *
799
+ * @author Jeongho Nam - https://github.com/samchon
800
+ */
801
+ export function createAssertQuery<T extends object>(
802
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
803
+ ): (input: string | IReadableURLSearchParams) => T;
804
+
805
+ /**
806
+ * @internal
807
+ */
808
+ export function createAssertQuery<T>(): (
809
+ input: string | IReadableURLSearchParams,
810
+ ) => T {
811
+ NoTransformConfigurationError("http.createAssertQuery");
812
+ }
813
+
814
+ /**
815
+ * Creates a reusable {@link isQuery} function.
816
+ *
817
+ * @danger You must configure the generic argument `T`
818
+ * @template T The type of the query object
819
+ * @throws compile error
820
+ *
821
+ * @author Jeongho Nam - https://github.com/samchon
822
+ */
823
+ export function createIsQuery(): never;
824
+
825
+ /**
826
+ * Creates a reusable {@link isQuery} function.
827
+ *
828
+ * @template T The type of the query object
829
+ * @returns A reusable `isQuery` function
830
+ *
831
+ * @author Jeongho Nam - https://github.com/samchon
832
+ */
833
+ export function createIsQuery<T extends object>(): (
834
+ input: string | IReadableURLSearchParams,
835
+ ) => T | null;
836
+
837
+ /**
838
+ * @internal
839
+ */
840
+ export function createIsQuery<T>(): (
841
+ input: string | IReadableURLSearchParams,
842
+ ) => T | null {
843
+ NoTransformConfigurationError("http.createIsQuery");
844
+ }
845
+
846
+ /**
847
+ * Creates a reusable {@link validateQuery} function.
848
+ *
849
+ * @danger You must configure the generic argument `T`
850
+ * @template T The type of the query object
851
+ * @throws compile error
852
+ *
853
+ * @author Jeongho Nam - https://github.com/samchon
854
+ */
855
+ export function createValidateQuery(): never;
856
+
857
+ /**
858
+ * Creates a reusable {@link validateQuery} function.
859
+ *
860
+ * @template T The type of the query object
861
+ * @returns A reusable `validateQuery` function
862
+ *
863
+ * @author Jeongho Nam - https://github.com/samchon
864
+ */
865
+ export function createValidateQuery<T extends object>(): (
866
+ input: string | IReadableURLSearchParams,
867
+ ) => IValidation<Resolved<T>>;
868
+
869
+ /**
870
+ * @internal
871
+ */
872
+ export function createValidateQuery<T>(): (
873
+ input: string | IReadableURLSearchParams,
874
+ ) => IValidation<Resolved<T>> {
875
+ NoTransformConfigurationError("http.createValidateQuery");
876
+ }
877
+
878
+ /**
879
+ * Creates a reusable {@link headers} function.
880
+ *
881
+ * @danger You must configure the generic argument `T`
882
+ * @template T The type of the headers object
883
+ * @throws compile error
884
+ *
885
+ * @author Jeongho Nam - https://github.com/samchon
886
+ */
887
+ export function createHeaders(): never;
888
+
889
+ /**
890
+ * Creates a reusable {@link headers} function.
891
+ *
892
+ * @template T The type of the headers object
893
+ * @returns A reusable `headers` function
894
+ *
895
+ * @author Jeongho Nam - https://github.com/samchon
896
+ */
897
+ export function createHeaders<T extends object>(): (
898
+ input: Record<string, string | string[] | undefined>,
899
+ ) => T;
900
+
901
+ /**
902
+ * @internal
903
+ */
904
+ export function createHeaders<T>(): (
905
+ input: Record<string, string | string[] | undefined>,
906
+ ) => T {
907
+ NoTransformConfigurationError("http.createHeaders");
908
+ }
909
+
910
+ /**
911
+ * Creates a reusable {@link assertHeaders} function.
912
+ *
913
+ * @danger You must configure the generic argument `T`
914
+ * @template T The type of the headers object
915
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
916
+ * @throws compile error
917
+ *
918
+ * @author Jeongho Nam - https://github.com/samchon
919
+ */
920
+ export function createAssertHeaders(
921
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
922
+ ): never;
923
+
924
+ /**
925
+ * Creates a reusable {@link assertHeaders} function.
926
+ *
927
+ * @template T The type of the headers object
928
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
929
+ * @returns A reusable `assertHeaders` function
930
+ *
931
+ * @author Jeongho Nam - https://github.com/samchon
932
+ */
933
+ export function createAssertHeaders<T extends object>(
934
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
935
+ ): (input: Record<string, string | string[] | undefined>) => T;
936
+
937
+ /**
938
+ * @internal
939
+ */
940
+ export function createAssertHeaders<T>(): (
941
+ input: Record<string, string | string[] | undefined>,
942
+ ) => T {
943
+ NoTransformConfigurationError("http.createAssertHeaders");
944
+ }
945
+
946
+ /**
947
+ * Creates a reusable {@link isHeaders} function.
948
+ *
949
+ * @danger You must configure the generic argument `T`
950
+ * @template T The type of the headers object
951
+ * @throws compile error
952
+ *
953
+ * @author Jeongho Nam - https://github.com/samchon
954
+ */
955
+ export function createIsHeaders(): never;
956
+
957
+ /**
958
+ * Creates a reusable {@link isHeaders} function.
959
+ *
960
+ * @template T The type of the headers object
961
+ * @returns A reusable `isHeaders` function
962
+ *
963
+ * @author Jeongho Nam - https://github.com/samchon
964
+ */
965
+ export function createIsHeaders<T extends object>(): (
966
+ input: Record<string, string | string[] | undefined>,
967
+ ) => T | null;
968
+
969
+ /**
970
+ * @internal
971
+ */
972
+ export function createIsHeaders<T>(): (
973
+ input: Record<string, string | string[] | undefined>,
974
+ ) => T | null {
975
+ NoTransformConfigurationError("http.createIsHeaders");
976
+ }
977
+
978
+ /**
979
+ * Creates a reusable {@link validateHeaders} function.
980
+ *
981
+ * @danger You must configure the generic argument `T`
982
+ * @template T The type of the headers object
983
+ * @throws compile error
984
+ *
985
+ * @author Jeongho Nam - https://github.com/samchon
986
+ */
987
+ export function createValidateHeaders(): never;
988
+
989
+ /**
990
+ * Creates a reusable {@link validateHeaders} function.
991
+ *
992
+ * @template T The type of the headers object
993
+ * @returns A reusable `validateHeaders` function
994
+ *
995
+ * @author Jeongho Nam - https://github.com/samchon
996
+ */
997
+ export function createValidateHeaders<T extends object>(): (
998
+ input: Record<string, string | string[] | undefined>,
999
+ ) => IValidation<Resolved<T>>;
1000
+
1001
+ /**
1002
+ * @internal
1003
+ */
1004
+ export function createValidateHeaders<T>(): (
1005
+ input: Record<string, string | string[] | undefined>,
1006
+ ) => IValidation<Resolved<T>> {
1007
+ NoTransformConfigurationError("http.createValidateHeaders");
1008
+ }
1009
+
1010
+ /**
1011
+ * Creates a reusable {@link parameter} function.
1012
+ *
1013
+ * @danger You must configure the generic argument `T`
1014
+ * @template T The type of the parameter value
1015
+ * @throws compile error
1016
+ *
1017
+ * @author Jeongho Nam - https://github.com/samchon
1018
+ */
1019
+ export function createParameter(): never;
1020
+
1021
+ /**
1022
+ * Creates a reusable {@link parameter} function.
1023
+ *
1024
+ * @template T The type of the parameter value
1025
+ * @returns A reusable `parameter` function
1026
+ *
1027
+ * @author Jeongho Nam - https://github.com/samchon
1028
+ */
1029
+ export function createParameter<T extends Atomic.Type | null>(): (
1030
+ input: string,
1031
+ ) => T;
1032
+
1033
+ /**
1034
+ * @internal
1035
+ */
1036
+ export function createParameter<T extends Atomic.Type | null>(): (
1037
+ input: string,
1038
+ ) => T {
1039
+ NoTransformConfigurationError("http.createParameter");
1040
+ }