@fgv/ts-utils 5.0.0-2 → 5.0.0-21

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 (311) hide show
  1. package/.vscode/launch.json +16 -0
  2. package/.vscode/settings.json +36 -0
  3. package/config/api-extractor.json +343 -0
  4. package/config/rig.json +16 -0
  5. package/dist/ts-utils.d.ts +20 -8
  6. package/dist/tsdoc-metadata.json +1 -1
  7. package/lib/packlets/base/result.d.ts +8 -0
  8. package/lib/packlets/base/result.js +11 -0
  9. package/lib/packlets/hash/crcNormalizer.js +3 -1
  10. package/lib/packlets/validation/array.d.ts +2 -1
  11. package/lib/packlets/validation/array.js +2 -1
  12. package/lib/packlets/validation/common.d.ts +0 -8
  13. package/lib/packlets/validation/field.d.ts +1 -1
  14. package/lib/packlets/validation/field.js +1 -1
  15. package/lib/packlets/validation/genericValidator.d.ts +1 -6
  16. package/lib/packlets/validation/genericValidator.js +11 -11
  17. package/lib/packlets/validation/object.d.ts +1 -1
  18. package/lib/packlets/validation/object.js +1 -1
  19. package/lib/packlets/validation/oneOf.d.ts +2 -1
  20. package/lib/packlets/validation/oneOf.js +2 -1
  21. package/lib/packlets/validation/typeGuard.d.ts +3 -2
  22. package/lib/packlets/validation/typeGuard.js +2 -1
  23. package/lib/packlets/validation/validator.d.ts +7 -0
  24. package/lib/packlets/validation/validatorBase.d.ts +2 -1
  25. package/lib/packlets/validation/validatorBase.js +1 -1
  26. package/lib/packlets/validation/validators.d.ts +2 -2
  27. package/lib/packlets/validation/validators.js +3 -3
  28. package/lib/test/helpers/jest/helpers/fsHelpers.d.ts +52 -0
  29. package/lib/test/helpers/jest/helpers/fsHelpers.js +180 -0
  30. package/lib/test/helpers/jest/helpers/index.d.ts +2 -0
  31. package/lib/test/helpers/jest/helpers/index.js +18 -0
  32. package/lib/test/helpers/jest/index.d.ts +3 -0
  33. package/lib/test/helpers/jest/index.js +27 -0
  34. package/lib/test/helpers/jest/matchers/index.d.ts +16 -0
  35. package/lib/test/helpers/jest/matchers/index.js +19 -0
  36. package/lib/test/helpers/jest/matchers/toFail/index.d.ts +16 -0
  37. package/lib/test/helpers/jest/matchers/toFail/index.js +25 -0
  38. package/lib/test/helpers/jest/matchers/toFail/predicate.d.ts +4 -0
  39. package/lib/test/helpers/jest/matchers/toFail/predicate.js +9 -0
  40. package/lib/test/helpers/jest/matchers/toFailTest/index.d.ts +16 -0
  41. package/lib/test/helpers/jest/matchers/toFailTest/index.js +30 -0
  42. package/lib/test/helpers/jest/matchers/toFailTest/predicate.d.ts +3 -0
  43. package/lib/test/helpers/jest/matchers/toFailTest/predicate.js +12 -0
  44. package/lib/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/index.d.ts +17 -0
  45. package/lib/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/index.js +26 -0
  46. package/lib/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/predicate.d.ts +4 -0
  47. package/lib/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/predicate.js +15 -0
  48. package/lib/test/helpers/jest/matchers/toFailTestWith/index.d.ts +18 -0
  49. package/lib/test/helpers/jest/matchers/toFailTestWith/index.js +31 -0
  50. package/lib/test/helpers/jest/matchers/toFailTestWith/predicate.d.ts +4 -0
  51. package/lib/test/helpers/jest/matchers/toFailTestWith/predicate.js +30 -0
  52. package/lib/test/helpers/jest/matchers/toFailWith/index.d.ts +18 -0
  53. package/lib/test/helpers/jest/matchers/toFailWith/index.js +29 -0
  54. package/lib/test/helpers/jest/matchers/toFailWith/predicate.d.ts +4 -0
  55. package/lib/test/helpers/jest/matchers/toFailWith/predicate.js +20 -0
  56. package/lib/test/helpers/jest/matchers/toFailWithDetail/index.d.ts +19 -0
  57. package/lib/test/helpers/jest/matchers/toFailWithDetail/index.js +29 -0
  58. package/lib/test/helpers/jest/matchers/toFailWithDetail/predicate.d.ts +4 -0
  59. package/lib/test/helpers/jest/matchers/toFailWithDetail/predicate.js +26 -0
  60. package/lib/test/helpers/jest/matchers/toSucceed/index.d.ts +16 -0
  61. package/lib/test/helpers/jest/matchers/toSucceed/index.js +25 -0
  62. package/lib/test/helpers/jest/matchers/toSucceed/predicate.d.ts +4 -0
  63. package/lib/test/helpers/jest/matchers/toSucceed/predicate.js +9 -0
  64. package/lib/test/helpers/jest/matchers/toSucceedAndMatchInlineSnapshot/index.d.ts +17 -0
  65. package/lib/test/helpers/jest/matchers/toSucceedAndMatchInlineSnapshot/index.js +26 -0
  66. package/lib/test/helpers/jest/matchers/toSucceedAndMatchSnapshot/index.d.ts +17 -0
  67. package/lib/test/helpers/jest/matchers/toSucceedAndMatchSnapshot/index.js +26 -0
  68. package/lib/test/helpers/jest/matchers/toSucceedAndSatisfy/index.d.ts +19 -0
  69. package/lib/test/helpers/jest/matchers/toSucceedAndSatisfy/index.js +55 -0
  70. package/lib/test/helpers/jest/matchers/toSucceedAndSatisfy/predicate.d.ts +4 -0
  71. package/lib/test/helpers/jest/matchers/toSucceedAndSatisfy/predicate.js +21 -0
  72. package/lib/test/helpers/jest/matchers/toSucceedWith/index.d.ts +18 -0
  73. package/lib/test/helpers/jest/matchers/toSucceedWith/index.js +29 -0
  74. package/lib/test/helpers/jest/matchers/toSucceedWith/predicate.d.ts +4 -0
  75. package/lib/test/helpers/jest/matchers/toSucceedWith/predicate.js +16 -0
  76. package/lib/test/helpers/jest/matchers/toSucceedWithDetail/index.d.ts +18 -0
  77. package/lib/test/helpers/jest/matchers/toSucceedWithDetail/index.js +29 -0
  78. package/lib/test/helpers/jest/matchers/toSucceedWithDetail/predicate.d.ts +4 -0
  79. package/lib/test/helpers/jest/matchers/toSucceedWithDetail/predicate.js +21 -0
  80. package/lib/test/helpers/jest/resolvers/cli.d.ts +5 -0
  81. package/lib/test/helpers/jest/resolvers/cli.js +48 -0
  82. package/lib/test/helpers/jest/resolvers/ide.d.ts +5 -0
  83. package/lib/test/helpers/jest/resolvers/ide.js +48 -0
  84. package/lib/test/helpers/jest/ts-utils.d.ts +2 -0
  85. package/lib/test/helpers/jest/ts-utils.js +18 -0
  86. package/lib/test/helpers/jest/types/index.d.ts +79 -0
  87. package/lib/test/helpers/jest/types/index.js +4 -0
  88. package/lib/test/helpers/jest/utils/matcherHelpers.d.ts +6 -0
  89. package/lib/test/helpers/jest/utils/matcherHelpers.js +53 -0
  90. package/lib/test/helpers/jest/utils/snapshotResolver.d.ts +4 -0
  91. package/lib/test/helpers/jest/utils/snapshotResolver.js +19 -0
  92. package/lib/test/unit/collections/collectible.test.d.ts +2 -0
  93. package/lib/test/unit/collections/collector.test.d.ts +2 -0
  94. package/lib/test/unit/collections/collectors.test.d.ts +2 -0
  95. package/lib/test/unit/collections/convertingCollector.test.d.ts +2 -0
  96. package/lib/test/unit/collections/helpers.d.ts +44 -0
  97. package/lib/test/unit/collections/helpers.js +115 -0
  98. package/lib/test/unit/collections/resultMap.test.d.ts +2 -0
  99. package/lib/test/unit/collections/validatingCollector.test.d.ts +2 -0
  100. package/lib/test/unit/collections/validatingConvertingCollector.test.d.ts +2 -0
  101. package/lib/test/unit/collections/validatingResultMap.test.d.ts +2 -0
  102. package/lib/test/unit/converter.test.d.ts +2 -0
  103. package/lib/test/unit/converters.test.d.ts +2 -0
  104. package/lib/test/unit/defaultingConverter.test.d.ts +2 -0
  105. package/lib/test/unit/file-tree/fileItem.test.d.ts +2 -0
  106. package/lib/test/unit/file-tree/fileTree.test.d.ts +2 -0
  107. package/lib/test/unit/file-tree/fsTree.test.d.ts +2 -0
  108. package/lib/test/unit/file-tree/inMemoryTree.test.d.ts +2 -0
  109. package/lib/test/unit/file-tree/sample/rootFile.json +1 -0
  110. package/lib/test/unit/file-tree/sample/some/other/path/file2.json +1 -0
  111. package/lib/test/unit/file-tree/sample/some/path/below/file4.json +1 -0
  112. package/lib/test/unit/file-tree/sample/some/path/file1.json +1 -0
  113. package/lib/test/unit/file-tree/sample/some/path/file3.json +1 -0
  114. package/lib/test/unit/hash.test.d.ts +2 -0
  115. package/lib/test/unit/logger.test.d.ts +2 -0
  116. package/lib/test/unit/mapResults.test.d.ts +3 -0
  117. package/lib/test/unit/messageAggregator.test.d.ts +3 -0
  118. package/lib/test/unit/normalize.test.d.ts +2 -0
  119. package/lib/test/unit/result.test.d.ts +3 -0
  120. package/lib/test/unit/utils.test.d.ts +3 -0
  121. package/lib/test/unit/validation/array.test.d.ts +2 -0
  122. package/lib/test/unit/validation/boolean.test.d.ts +2 -0
  123. package/lib/test/unit/validation/genericValidator.test.d.ts +2 -0
  124. package/lib/test/unit/validation/number.test.d.ts +2 -0
  125. package/lib/test/unit/validation/object.test.d.ts +2 -0
  126. package/lib/test/unit/validation/oneOf.test.d.ts +2 -0
  127. package/lib/test/unit/validation/recordOf.test.d.ts +2 -0
  128. package/lib/test/unit/validation/recursiveValidation.test.d.ts +2 -0
  129. package/lib/test/unit/validation/string.test.d.ts +2 -0
  130. package/lib/test/unit/validation/traits.test.d.ts +2 -0
  131. package/lib/test/unit/validation/typeGuard.test.d.ts +2 -0
  132. package/lib/test/unit/validation/validators.test.d.ts +2 -0
  133. package/package.json +9 -9
  134. package/src/index.ts +63 -0
  135. package/src/packlets/base/brand.ts +28 -0
  136. package/src/packlets/base/index.ts +31 -0
  137. package/src/packlets/base/logger.ts +156 -0
  138. package/src/packlets/base/mapResults.ts +302 -0
  139. package/src/packlets/base/messageAggregator.ts +120 -0
  140. package/src/packlets/base/normalize.ts +144 -0
  141. package/src/packlets/base/result.ts +961 -0
  142. package/src/packlets/base/utils.ts +236 -0
  143. package/src/packlets/collections/collectible.ts +238 -0
  144. package/src/packlets/collections/collector.ts +273 -0
  145. package/src/packlets/collections/collectorValidator.ts +178 -0
  146. package/src/packlets/collections/common.ts +27 -0
  147. package/src/packlets/collections/convertingCollector.ts +223 -0
  148. package/src/packlets/collections/convertingCollectorValidator.ts +164 -0
  149. package/src/packlets/collections/index.ts +39 -0
  150. package/src/packlets/collections/keyValueConverters.ts +142 -0
  151. package/src/packlets/collections/readonlyResultMap.ts +99 -0
  152. package/src/packlets/collections/resultMap.ts +322 -0
  153. package/src/packlets/collections/resultMapValidator.ts +188 -0
  154. package/src/packlets/collections/utils.ts +33 -0
  155. package/src/packlets/collections/validatingCollector.ts +123 -0
  156. package/src/packlets/collections/validatingConvertingCollector.ts +113 -0
  157. package/src/packlets/collections/validatingResultMap.ts +94 -0
  158. package/src/packlets/conversion/baseConverter.ts +330 -0
  159. package/src/packlets/conversion/converter.ts +260 -0
  160. package/src/packlets/conversion/converters.ts +1039 -0
  161. package/src/packlets/conversion/defaultingConverter.ts +188 -0
  162. package/src/packlets/conversion/index.ts +30 -0
  163. package/src/packlets/conversion/objectConverter.ts +259 -0
  164. package/src/packlets/conversion/stringConverter.ts +165 -0
  165. package/src/packlets/file-tree/directoryItem.ts +84 -0
  166. package/src/packlets/file-tree/fileItem.ts +119 -0
  167. package/src/packlets/file-tree/fileTree.ts +152 -0
  168. package/src/packlets/file-tree/fileTreeAccessors.ts +176 -0
  169. package/src/packlets/file-tree/fsTree.ts +118 -0
  170. package/src/packlets/file-tree/in-memory/inMemoryTree.ts +171 -0
  171. package/src/packlets/file-tree/in-memory/index.ts +23 -0
  172. package/src/packlets/file-tree/in-memory/treeBuilder.ts +203 -0
  173. package/src/packlets/file-tree/index.ts +31 -0
  174. package/src/packlets/hash/crcNormalizer.ts +81 -0
  175. package/src/packlets/hash/hashingNormalizer.ts +102 -0
  176. package/src/packlets/hash/index.ts +24 -0
  177. package/src/packlets/validation/array.ts +84 -0
  178. package/src/packlets/validation/boolean.ts +63 -0
  179. package/src/packlets/validation/classes.ts +38 -0
  180. package/src/packlets/validation/common.ts +28 -0
  181. package/src/packlets/validation/field.ts +99 -0
  182. package/src/packlets/validation/genericValidator.ts +204 -0
  183. package/src/packlets/validation/index.ts +31 -0
  184. package/src/packlets/validation/number.ts +66 -0
  185. package/src/packlets/validation/object.ts +208 -0
  186. package/src/packlets/validation/oneOf.ts +78 -0
  187. package/src/packlets/validation/string.ts +66 -0
  188. package/src/packlets/validation/traits.ts +113 -0
  189. package/src/packlets/validation/typeGuard.ts +83 -0
  190. package/src/packlets/validation/validator.ts +157 -0
  191. package/src/packlets/validation/validatorBase.ts +66 -0
  192. package/src/packlets/validation/validators.ts +254 -0
  193. package/CHANGELOG.md +0 -135
  194. package/lib/index.d.ts.map +0 -1
  195. package/lib/index.js.map +0 -1
  196. package/lib/packlets/base/brand.d.ts.map +0 -1
  197. package/lib/packlets/base/brand.js.map +0 -1
  198. package/lib/packlets/base/index.d.ts.map +0 -1
  199. package/lib/packlets/base/index.js.map +0 -1
  200. package/lib/packlets/base/logger.d.ts.map +0 -1
  201. package/lib/packlets/base/logger.js.map +0 -1
  202. package/lib/packlets/base/mapResults.d.ts.map +0 -1
  203. package/lib/packlets/base/mapResults.js.map +0 -1
  204. package/lib/packlets/base/messageAggregator.d.ts.map +0 -1
  205. package/lib/packlets/base/messageAggregator.js.map +0 -1
  206. package/lib/packlets/base/normalize.d.ts.map +0 -1
  207. package/lib/packlets/base/normalize.js.map +0 -1
  208. package/lib/packlets/base/result.d.ts.map +0 -1
  209. package/lib/packlets/base/result.js.map +0 -1
  210. package/lib/packlets/base/utils.d.ts.map +0 -1
  211. package/lib/packlets/base/utils.js.map +0 -1
  212. package/lib/packlets/collections/collectible.d.ts.map +0 -1
  213. package/lib/packlets/collections/collectible.js.map +0 -1
  214. package/lib/packlets/collections/collector.d.ts.map +0 -1
  215. package/lib/packlets/collections/collector.js.map +0 -1
  216. package/lib/packlets/collections/collectorValidator.d.ts.map +0 -1
  217. package/lib/packlets/collections/collectorValidator.js.map +0 -1
  218. package/lib/packlets/collections/common.d.ts.map +0 -1
  219. package/lib/packlets/collections/common.js.map +0 -1
  220. package/lib/packlets/collections/convertingCollector.d.ts.map +0 -1
  221. package/lib/packlets/collections/convertingCollector.js.map +0 -1
  222. package/lib/packlets/collections/convertingCollectorValidator.d.ts.map +0 -1
  223. package/lib/packlets/collections/convertingCollectorValidator.js.map +0 -1
  224. package/lib/packlets/collections/index.d.ts.map +0 -1
  225. package/lib/packlets/collections/index.js.map +0 -1
  226. package/lib/packlets/collections/keyValueConverters.d.ts.map +0 -1
  227. package/lib/packlets/collections/keyValueConverters.js.map +0 -1
  228. package/lib/packlets/collections/readonlyResultMap.d.ts.map +0 -1
  229. package/lib/packlets/collections/readonlyResultMap.js.map +0 -1
  230. package/lib/packlets/collections/resultMap.d.ts.map +0 -1
  231. package/lib/packlets/collections/resultMap.js.map +0 -1
  232. package/lib/packlets/collections/resultMapValidator.d.ts.map +0 -1
  233. package/lib/packlets/collections/resultMapValidator.js.map +0 -1
  234. package/lib/packlets/collections/utils.d.ts.map +0 -1
  235. package/lib/packlets/collections/utils.js.map +0 -1
  236. package/lib/packlets/collections/validatingCollector.d.ts.map +0 -1
  237. package/lib/packlets/collections/validatingCollector.js.map +0 -1
  238. package/lib/packlets/collections/validatingConvertingCollector.d.ts.map +0 -1
  239. package/lib/packlets/collections/validatingConvertingCollector.js.map +0 -1
  240. package/lib/packlets/collections/validatingResultMap.d.ts.map +0 -1
  241. package/lib/packlets/collections/validatingResultMap.js.map +0 -1
  242. package/lib/packlets/conversion/baseConverter.d.ts.map +0 -1
  243. package/lib/packlets/conversion/baseConverter.js.map +0 -1
  244. package/lib/packlets/conversion/converter.d.ts.map +0 -1
  245. package/lib/packlets/conversion/converter.js.map +0 -1
  246. package/lib/packlets/conversion/converters.d.ts.map +0 -1
  247. package/lib/packlets/conversion/converters.js.map +0 -1
  248. package/lib/packlets/conversion/defaultingConverter.d.ts.map +0 -1
  249. package/lib/packlets/conversion/defaultingConverter.js.map +0 -1
  250. package/lib/packlets/conversion/index.d.ts.map +0 -1
  251. package/lib/packlets/conversion/index.js.map +0 -1
  252. package/lib/packlets/conversion/objectConverter.d.ts.map +0 -1
  253. package/lib/packlets/conversion/objectConverter.js.map +0 -1
  254. package/lib/packlets/conversion/stringConverter.d.ts.map +0 -1
  255. package/lib/packlets/conversion/stringConverter.js.map +0 -1
  256. package/lib/packlets/file-tree/directoryItem.d.ts.map +0 -1
  257. package/lib/packlets/file-tree/directoryItem.js.map +0 -1
  258. package/lib/packlets/file-tree/fileItem.d.ts.map +0 -1
  259. package/lib/packlets/file-tree/fileItem.js.map +0 -1
  260. package/lib/packlets/file-tree/fileTree.d.ts.map +0 -1
  261. package/lib/packlets/file-tree/fileTree.js.map +0 -1
  262. package/lib/packlets/file-tree/fileTreeAccessors.d.ts.map +0 -1
  263. package/lib/packlets/file-tree/fileTreeAccessors.js.map +0 -1
  264. package/lib/packlets/file-tree/fsTree.d.ts.map +0 -1
  265. package/lib/packlets/file-tree/fsTree.js.map +0 -1
  266. package/lib/packlets/file-tree/in-memory/inMemoryTree.d.ts.map +0 -1
  267. package/lib/packlets/file-tree/in-memory/inMemoryTree.js.map +0 -1
  268. package/lib/packlets/file-tree/in-memory/index.d.ts.map +0 -1
  269. package/lib/packlets/file-tree/in-memory/index.js.map +0 -1
  270. package/lib/packlets/file-tree/in-memory/treeBuilder.d.ts.map +0 -1
  271. package/lib/packlets/file-tree/in-memory/treeBuilder.js.map +0 -1
  272. package/lib/packlets/file-tree/index.d.ts.map +0 -1
  273. package/lib/packlets/file-tree/index.js.map +0 -1
  274. package/lib/packlets/hash/crcNormalizer.d.ts.map +0 -1
  275. package/lib/packlets/hash/crcNormalizer.js.map +0 -1
  276. package/lib/packlets/hash/hashingNormalizer.d.ts.map +0 -1
  277. package/lib/packlets/hash/hashingNormalizer.js.map +0 -1
  278. package/lib/packlets/hash/index.d.ts.map +0 -1
  279. package/lib/packlets/hash/index.js.map +0 -1
  280. package/lib/packlets/validation/array.d.ts.map +0 -1
  281. package/lib/packlets/validation/array.js.map +0 -1
  282. package/lib/packlets/validation/boolean.d.ts.map +0 -1
  283. package/lib/packlets/validation/boolean.js.map +0 -1
  284. package/lib/packlets/validation/classes.d.ts.map +0 -1
  285. package/lib/packlets/validation/classes.js.map +0 -1
  286. package/lib/packlets/validation/common.d.ts.map +0 -1
  287. package/lib/packlets/validation/common.js.map +0 -1
  288. package/lib/packlets/validation/field.d.ts.map +0 -1
  289. package/lib/packlets/validation/field.js.map +0 -1
  290. package/lib/packlets/validation/genericValidator.d.ts.map +0 -1
  291. package/lib/packlets/validation/genericValidator.js.map +0 -1
  292. package/lib/packlets/validation/index.d.ts.map +0 -1
  293. package/lib/packlets/validation/index.js.map +0 -1
  294. package/lib/packlets/validation/number.d.ts.map +0 -1
  295. package/lib/packlets/validation/number.js.map +0 -1
  296. package/lib/packlets/validation/object.d.ts.map +0 -1
  297. package/lib/packlets/validation/object.js.map +0 -1
  298. package/lib/packlets/validation/oneOf.d.ts.map +0 -1
  299. package/lib/packlets/validation/oneOf.js.map +0 -1
  300. package/lib/packlets/validation/string.d.ts.map +0 -1
  301. package/lib/packlets/validation/string.js.map +0 -1
  302. package/lib/packlets/validation/traits.d.ts.map +0 -1
  303. package/lib/packlets/validation/traits.js.map +0 -1
  304. package/lib/packlets/validation/typeGuard.d.ts.map +0 -1
  305. package/lib/packlets/validation/typeGuard.js.map +0 -1
  306. package/lib/packlets/validation/validator.d.ts.map +0 -1
  307. package/lib/packlets/validation/validator.js.map +0 -1
  308. package/lib/packlets/validation/validatorBase.d.ts.map +0 -1
  309. package/lib/packlets/validation/validatorBase.js.map +0 -1
  310. package/lib/packlets/validation/validators.d.ts.map +0 -1
  311. package/lib/packlets/validation/validators.js.map +0 -1
@@ -0,0 +1,157 @@
1
+ /*
2
+ * Copyright (c) 2021 Erik Fortune
3
+ *
4
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
5
+ * of this software and associated documentation files (the "Software"), to deal
6
+ * in the Software without restriction, including without limitation the rights
7
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+ * copies of the Software, and to permit persons to whom the Software is
9
+ * furnished to do so, subject to the following conditions:
10
+ *
11
+ * The above copyright notice and this permission notice shall be included in all
12
+ * copies or substantial portions of the Software.
13
+ *
14
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20
+ * SOFTWARE.
21
+ */
22
+
23
+ import { Brand, Failure, Result } from '../base';
24
+ import { ConstraintTrait, ValidatorTraits } from './traits';
25
+
26
+ /**
27
+ * Type for a validation function, which validates that a supplied `unknown`
28
+ * value is a valid value of type `<T>`, possibly as influenced by
29
+ * an optionally-supplied validation context of type `<TC>`.
30
+ * @public
31
+ */
32
+ export type ValidatorFunc<T, TC> = (
33
+ from: unknown,
34
+ context?: TC,
35
+ self?: Validator<T, TC>
36
+ ) => boolean | Failure<T>;
37
+
38
+ /**
39
+ * Options that apply to any {@link Validation.Validator | Validator}.
40
+ * @public
41
+ */
42
+ // eslint-disable-next-line @typescript-eslint/naming-convention
43
+ export interface ValidatorOptions<TC> {
44
+ defaultContext?: TC;
45
+ }
46
+
47
+ /**
48
+ * A {@link Validation.Constraint | Constraint<T>} function returns
49
+ * `true` if the supplied value meets the constraint. Can return
50
+ * {@link Failure} with an error message or simply return `false`
51
+ * for a default message.
52
+ * @public
53
+ */
54
+ export type Constraint<T> = (val: T) => boolean | Failure<T>;
55
+
56
+ /**
57
+ * Formats an incoming error message and value that failed validation.
58
+ * @param val - The value that failed validation.
59
+ * @param message - The default error message, if any.
60
+ * @param context - Optional validation context.
61
+ * @returns The formatted error message.
62
+ * @public
63
+ */
64
+ export type ValidationErrorFormatter<TC = unknown> = (val: unknown, message?: string, context?: TC) => string;
65
+
66
+ /**
67
+ * In-place validation that a supplied unknown matches some
68
+ * required characteristics (type, values, etc).
69
+ * @public
70
+ */
71
+ // eslint-disable-next-line @typescript-eslint/naming-convention
72
+ export interface Validator<T, TC = unknown> {
73
+ /**
74
+ * {@link Validation.ValidatorTraits | Traits} describing this validation.
75
+ */
76
+ readonly traits: ValidatorTraits;
77
+
78
+ /**
79
+ * Indicates whether this element is explicitly optional.
80
+ */
81
+ readonly isOptional: boolean;
82
+
83
+ /**
84
+ * The brand for a branded type.
85
+ */
86
+ readonly brand: string | undefined;
87
+
88
+ /**
89
+ * Tests to see if a supplied `unknown` value matches this validation. All
90
+ * validate calls are guaranteed to return the entity passed in on Success.
91
+ * @param from - The `unknown` value to be tested.
92
+ * @param context - Optional validation context.
93
+ * @returns {@link Success} with the typed, validated value,
94
+ * or {@link Failure} with an error message if validation fails.
95
+ */
96
+ validate(from: unknown, context?: TC): Result<T>;
97
+
98
+ /**
99
+ * Tests to see if a supplied 'unknown' value matches this validation. In
100
+ * contrast to {@link Validator.validate | validate}, makes no guarantees
101
+ * about the identity of the returned value.
102
+ * @param from - The `unknown` value to be tested.
103
+ * @param context - Optional validation context.
104
+ * @returns {@link Success} with the typed, conversion value,
105
+ * or {@link Failure} with an error message if conversion fails.
106
+ */
107
+ convert(from: unknown, context?: TC): Result<T>;
108
+
109
+ /**
110
+ * Tests to see if a supplied `unknown` value matches this
111
+ * validation. Accepts `undefined`.
112
+ * @param from - The `unknown` value to be tested.
113
+ * @param context - Optional validation context.
114
+ * @returns {@link Success} with the typed, validated value,
115
+ * or {@link Failure} with an error message if validation fails.
116
+ */
117
+ validateOptional(from: unknown, context?: TC): Result<T | undefined>;
118
+
119
+ /**
120
+ * Non-throwing type guard
121
+ * @param from - The value to be tested.
122
+ * @param context - Optional validation context.
123
+ */
124
+ guard(from: unknown, context?: TC): from is T;
125
+
126
+ /**
127
+ * Creates an {@link Validation.Validator | in-place validator}
128
+ * which is derived from this one but which also matches `undefined`.
129
+ */
130
+ optional(): Validator<T | undefined, TC>;
131
+
132
+ /**
133
+ * Creates an {@link Validation.Validator | in-place validator}
134
+ * which is derived from this one but which applies additional constraints.
135
+ * @param constraint - the constraint to be applied
136
+ * @param trait - As optional {@link Validation.ConstraintTrait | ConstraintTrait}
137
+ * to be applied to the resulting {@link Validation.Validator | Validator}.
138
+ * @returns A new {@link Validation.Validator | Validator}.
139
+ */
140
+ withConstraint(constraint: Constraint<T>, trait?: ConstraintTrait): Validator<T, TC>;
141
+
142
+ /**
143
+ * Creates a new {@link Validation.Validator | in-place validator} which
144
+ * is derived from this one but which matches a branded result.
145
+ * @param brand - The brand to be applied.
146
+ */
147
+ withBrand<B extends string>(brand: B): Validator<Brand<T, B>, TC>;
148
+
149
+ /**
150
+ * Creates a new {@link Validation.Validator | in-place validator} which
151
+ * is derived from this one but which returns an error message supplied
152
+ * by the provided formatter if an error occurs.
153
+ * @param formatter - The error message formatter to be applied.
154
+ * @returns A new {@link Validation.Validator | Validator}.
155
+ */
156
+ withFormattedError(formatter: ValidationErrorFormatter<TC>): Validator<T, TC>;
157
+ }
@@ -0,0 +1,66 @@
1
+ /*
2
+ * Copyright (c) 2021 Erik Fortune
3
+ *
4
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
5
+ * of this software and associated documentation files (the "Software"), to deal
6
+ * in the Software without restriction, including without limitation the rights
7
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+ * copies of the Software, and to permit persons to whom the Software is
9
+ * furnished to do so, subject to the following conditions:
10
+ *
11
+ * The above copyright notice and this permission notice shall be included in all
12
+ * copies or substantial portions of the Software.
13
+ *
14
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20
+ * SOFTWARE.
21
+ */
22
+
23
+ import { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';
24
+
25
+ import { Failure } from '../base';
26
+
27
+ /**
28
+ * @internal
29
+ */
30
+ export type ValidatorBaseConstructorParams<T, TC> = Omit<
31
+ GenericValidatorConstructorParams<T, TC>,
32
+ 'validator'
33
+ >;
34
+
35
+ /**
36
+ * Abstract base helper class for specific validator implementations
37
+ * @internal
38
+ */
39
+ export abstract class ValidatorBase<T, TC = unknown> extends GenericValidator<T, TC> {
40
+ /**
41
+ * Inner constructor
42
+ * @param params - Initialization params.
43
+ * @internal
44
+ */
45
+ protected constructor(params: Partial<ValidatorBaseConstructorParams<T, TC>>) {
46
+ super({
47
+ validator: (from, context, self) => this._validate(from, context, self),
48
+ ...params
49
+ });
50
+ }
51
+
52
+ /**
53
+ * Abstract validation method to me implemented by derived classes.
54
+ * @param from - Value to be converted.
55
+ * @param context - Optional validation context.
56
+ * @param self - Optional self-reference for recursive validation.
57
+ * @returns `true` if `from` is valid, {@link Failure | Failure<T>}
58
+ * with an error message if `from` is invalid.
59
+ * @internal
60
+ */
61
+ protected abstract _validate(
62
+ from: unknown,
63
+ context?: TC,
64
+ self?: import('./validator').Validator<T, TC>
65
+ ): boolean | Failure<T>;
66
+ }
@@ -0,0 +1,254 @@
1
+ /*
2
+ * Copyright (c) 2023 Erik Fortune
3
+ *
4
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
5
+ * of this software and associated documentation files (the "Software"), to deal
6
+ * in the Software without restriction, including without limitation the rights
7
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+ * copies of the Software, and to permit persons to whom the Software is
9
+ * furnished to do so, subject to the following conditions:
10
+ *
11
+ * The above copyright notice and this permission notice shall be included in all
12
+ * copies or substantial portions of the Software.
13
+ *
14
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20
+ * SOFTWARE.
21
+ */
22
+
23
+ import { Failure, fail, isKeyOf, MessageAggregator } from '../base';
24
+ import { ArrayValidator, ArrayValidatorConstructorParams } from './array';
25
+ import { FieldValidators, ObjectValidator, ObjectValidatorConstructorParams } from './object';
26
+ import { TypeGuardValidator, TypeGuardValidatorConstructorParams } from './typeGuard';
27
+
28
+ import { BooleanValidator } from './boolean';
29
+ import { TypeGuardWithContext } from './common';
30
+ import { GenericValidator } from './genericValidator';
31
+ import { NumberValidator } from './number';
32
+ import { OneOfValidator, OneOfValidatorConstructorParams } from './oneOf';
33
+ import { StringValidator } from './string';
34
+ import { Validator, ValidatorFunc } from './validator';
35
+
36
+ /**
37
+ * A {@link Validation.Classes.StringValidator | StringValidator} which validates a string in place.
38
+ * @public
39
+ */
40
+ export const string: Validator<string> = new StringValidator();
41
+
42
+ /**
43
+ * A {@link Validation.Classes.NumberValidator | NumberValidator} which validates a number in place.
44
+ * @public
45
+ */
46
+ export const number: Validator<number> = new NumberValidator();
47
+
48
+ /**
49
+ * A {@link Validation.Classes.BooleanValidator | BooleanValidator} which validates a boolean in place.
50
+ * @public
51
+ */
52
+ export const boolean: Validator<boolean> = new BooleanValidator();
53
+
54
+ /**
55
+ * Helper function to create a {@link Validation.Classes.ObjectValidator | ObjectValidator} which validates
56
+ * an object in place.
57
+ * @param fields - A {@link Validation.Classes.FieldValidators | field validator definition}
58
+ * describing the validations to be applied.
59
+ * @param params - Optional {@link Validation.Classes.ObjectValidatorConstructorParams | parameters}
60
+ * to refine the behavior of the resulting {@link Validation.Validator | validator}.
61
+ * @returns A new {@link Validation.Validator | Validator} which validates the desired
62
+ * object in place.
63
+ * @public
64
+ */
65
+ export function object<T, TC = unknown>(
66
+ fields: FieldValidators<T, TC>,
67
+ params?: Omit<ObjectValidatorConstructorParams<T, TC>, 'fields'>
68
+ ): ObjectValidator<T, TC> {
69
+ return new ObjectValidator({ fields, ...(params ?? {}) });
70
+ }
71
+
72
+ /**
73
+ * Helper function to create a {@link Validation.Classes.ArrayValidator | ArrayValidator} which
74
+ * validates an array in place.
75
+ * @param validateElement - A {@link Validation.Validator | validator} which validates each element.
76
+ * @returns A new {@link Validation.Classes.ArrayValidator | ArrayValidator } which validates the desired
77
+ * array in place.
78
+ * @public
79
+ */
80
+ export function arrayOf<T, TC>(
81
+ validateElement: Validator<T, TC>,
82
+ params?: Omit<ArrayValidatorConstructorParams<T, TC>, 'validateElement'>
83
+ ): ArrayValidator<T, TC> {
84
+ return new ArrayValidator({ validateElement, ...(params ?? {}) });
85
+ }
86
+
87
+ /**
88
+ * Options for {@link Validators.recordOf} helper function.
89
+ * @public
90
+ */
91
+ export interface IRecordOfValidatorOptions<TK extends string = string, TC = unknown> {
92
+ /**
93
+ * If `onError` is `'fail'` (default), then the entire validation fails if any key or element
94
+ * cannot be validated. If `onError` is `'ignore'`, failing elements are silently ignored.
95
+ */
96
+ onError?: 'fail' | 'ignore';
97
+ /**
98
+ * If present, `keyValidator` is used to validate the source object property names.
99
+ * @remarks
100
+ * Can be used to validate key names to supported values and/or strong types.
101
+ */
102
+ keyValidator?: Validator<TK, TC>;
103
+ }
104
+
105
+ /**
106
+ * A helper function to create a {@link Validation.Validator | Validator} which validates the `string`-keyed properties
107
+ * using a supplied {@link Validation.Validator | Validator<T, TC>} to produce a `Record<TK, T>`.
108
+ * @remarks
109
+ * If present, the supplied {@link Validators.IRecordOfValidatorOptions | options} can provide a strongly-typed
110
+ * validator for keys and/or control the handling of elements that fail validation.
111
+ * @param validator - {@link Validation.Validator | Validator} used for each item in the source object.
112
+ * @param options - Optional {@link Validators.IRecordOfValidatorOptions | IRecordOfValidatorOptions<TK, TC>} which
113
+ * supplies a key validator and/or error-handling options.
114
+ * @returns A {@link Validation.Validator | Validator} which validates `Record<TK, T>`.
115
+ * @public
116
+ */
117
+ export function recordOf<T, TC = unknown, TK extends string = string>(
118
+ validator: Validator<T, TC>,
119
+ options?: IRecordOfValidatorOptions<TK, TC>
120
+ ): Validator<Record<TK, T>, TC> {
121
+ const opts: IRecordOfValidatorOptions<TK, TC> = { onError: 'fail', ...options };
122
+
123
+ return new GenericValidator({
124
+ validator: (
125
+ from: unknown,
126
+ context?: TC,
127
+ self?: Validator<Record<TK, T>, TC>
128
+ ): boolean | Failure<Record<TK, T>> => {
129
+ if (typeof from !== 'object' || from === null || Array.isArray(from)) {
130
+ return fail(`Not a string-keyed object: ${JSON.stringify(from)}`);
131
+ }
132
+
133
+ const errors = new MessageAggregator();
134
+
135
+ for (const key in from) {
136
+ if (isKeyOf(key, from)) {
137
+ // Validate key if keyValidator is provided
138
+ if (opts.keyValidator) {
139
+ const keyResult = opts.keyValidator.validate(key, context);
140
+ if (!keyResult.isSuccess()) {
141
+ if (opts.onError === 'ignore') {
142
+ continue;
143
+ }
144
+ errors.addMessage(`Key "${key}": ${keyResult.message}`);
145
+ if (opts.onError === 'fail') {
146
+ return fail(keyResult.message);
147
+ }
148
+ }
149
+ }
150
+
151
+ // Validate value
152
+ const valueResult = validator.validate(from[key] as unknown, context);
153
+ if (!valueResult.isSuccess()) {
154
+ if (opts.onError === 'ignore') {
155
+ continue;
156
+ }
157
+ errors.addMessage(`Property "${key}": ${valueResult.message}`);
158
+ if (opts.onError === 'fail') {
159
+ return fail(valueResult.message);
160
+ }
161
+ }
162
+ }
163
+ }
164
+
165
+ /* c8 ignore next 1 - defense in depth */
166
+ return errors.hasMessages ? fail(errors.toString()) : true;
167
+ }
168
+ });
169
+ }
170
+
171
+ /**
172
+ * Helper function to create a {@link Validation.Validator} which validates an enumerated
173
+ * value in place.
174
+ * @public
175
+ */
176
+ export function enumeratedValue<T extends string>(values: ReadonlyArray<T>): Validator<T, ReadonlyArray<T>> {
177
+ return new GenericValidator({
178
+ validator: (
179
+ from: unknown,
180
+ context?: ReadonlyArray<T>,
181
+ self?: Validator<T, ReadonlyArray<T>>
182
+ ): boolean | Failure<T> => {
183
+ if (typeof from === 'string') {
184
+ const v = context ?? values;
185
+ const index = v.indexOf(from as T);
186
+ return index >= 0 ? true : fail(`Invalid enumerated value "${from}" - expected: (${v.join(', ')})`);
187
+ }
188
+ return fail(`Not a string: "${JSON.stringify(from, undefined, 2)}`);
189
+ }
190
+ });
191
+ }
192
+
193
+ /**
194
+ * Helper function to create a {@link Validation.Validator} which validates a literal value.
195
+ * @param value - the literal value to be validated
196
+ * @public
197
+ */
198
+ export function literal<T extends string | number | boolean | symbol | null | undefined>(
199
+ value: T
200
+ ): Validator<T> {
201
+ return new GenericValidator({
202
+ validator: (from: unknown, context?: unknown, self?: Validator<T>): boolean | Failure<T> => {
203
+ return from === value
204
+ ? true
205
+ : fail(`Expected literal ${String(value)}, found "${JSON.stringify(from, undefined, 2)}`);
206
+ }
207
+ });
208
+ }
209
+
210
+ /**
211
+ * Helper function to create a {@link Validation.Validator | Validator} which validates one
212
+ * of several possible validated values.
213
+ * @param validators - the {@link Validation.Validator | validators} to be considered.
214
+ * @param params - Optional {@link Validation.Classes.OneOfValidatorConstructorParams | params} used to construct the validator.
215
+ * @returns A new {@link Validator | Validator} which validates values that match any of
216
+ * the supplied validators.
217
+ * @public
218
+ */
219
+ export function oneOf<T, TC = unknown>(
220
+ validators: Array<Validator<T, TC>>,
221
+ params?: Omit<OneOfValidatorConstructorParams<T, TC>, 'validators'>
222
+ ): OneOfValidator<T, TC> {
223
+ return new OneOfValidator<T, TC>({ ...(params ?? {}), validators });
224
+ }
225
+
226
+ /**
227
+ * Helper function to create a {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator} which
228
+ * validates a value or object in place.
229
+ * @param description - a description of the thing to be validated for use in error messages
230
+ * @param guard - a {@link Validation.TypeGuardWithContext} which performs the validation.
231
+ * @returns A new {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator } which validates
232
+ * the values using the supplied type guard.
233
+ * @public
234
+ */
235
+ export function isA<T, TC = unknown>(
236
+ description: string,
237
+ guard: TypeGuardWithContext<T, TC>,
238
+ params?: Omit<TypeGuardValidatorConstructorParams<T, TC>, 'description' | 'guard'>
239
+ ): TypeGuardValidator<T, TC> {
240
+ return new TypeGuardValidator({ description, guard, ...(params ?? {}) });
241
+ }
242
+
243
+ /**
244
+ * Helper function to create a {@link Validation.Validator | Validator} using a
245
+ * supplied {@link Validation.ValidatorFunc | validator function}.
246
+ * @param validator - A {@link Validation.ValidatorFunc | validator function} that a
247
+ * supplied unknown value matches some condition.
248
+ * @returns A new {@link Validation.Validator | Validator} which validates the desired
249
+ * value using the supplied function.
250
+ * @public
251
+ */
252
+ export function generic<T, TC = unknown>(validator: ValidatorFunc<T, TC>): Validator<T, TC> {
253
+ return new GenericValidator({ validator });
254
+ }
package/CHANGELOG.md DELETED
@@ -1,135 +0,0 @@
1
- # Change Log - @fgv/ts-utils
2
-
3
- This log was last generated on Thu, 17 Jul 2025 00:13:24 GMT and should not be manually modified.
4
-
5
- ## 5.0.0
6
- Thu, 17 Jul 2025 00:13:24 GMT
7
-
8
- ### Updates
9
-
10
- - add result helpers, clean up object converter
11
- - object converter partial/required helpers
12
- - add Result.withErrorFormat
13
- - bump version
14
-
15
- ## 4.6.0
16
- Wed, 02 Jul 2025 05:48:16 GMT
17
-
18
- _Version update only_
19
-
20
- ## 4.5.1
21
- Wed, 02 Jul 2025 05:47:11 GMT
22
-
23
- ### Updates
24
-
25
- - use IterableIterator instead of MapIterator
26
- - update rushstack
27
-
28
- ## 4.5.0
29
- Tue, 01 Jul 2025 03:26:11 GMT
30
-
31
- ### Minor changes
32
-
33
- - add recordOf validator for validating Record<string, T> objects
34
-
35
- ### Updates
36
-
37
- - update collectors
38
- - rework collections for better usability
39
-
40
- ## 4.4.0
41
- Sat, 01 Feb 2025 17:13:10 GMT
42
-
43
- _Version update only_
44
-
45
- ## 4.3.0
46
- Thu, 30 Jan 2025 00:35:17 GMT
47
-
48
- ### Updates
49
-
50
- - add collector, convertingResultMap, convertingCollector
51
-
52
- ## 4.2.2
53
- Thu, 23 Jan 2025 06:19:32 GMT
54
-
55
- ### Updates
56
-
57
- - QoL improvements to Success/Failure
58
-
59
- ## 4.2.1
60
- Tue, 21 Jan 2025 04:19:21 GMT
61
-
62
- ### Updates
63
-
64
- - allow factories in getOrAdd
65
-
66
- ## 4.2.0
67
- Mon, 20 Jan 2025 09:46:53 GMT
68
-
69
- ### Updates
70
-
71
- - add collections packlet and ResultMap class
72
- - add withFormattedError on validator and converter
73
- - clean up type inconsistencies, relax some constraints
74
-
75
- ## 4.1.0
76
- Thu, 09 Jan 2025 05:33:39 GMT
77
-
78
- ### Updates
79
-
80
- - update dependencies
81
-
82
- ## 4.0.2
83
- Tue, 14 May 2024 14:45:53 GMT
84
-
85
- _Version update only_
86
-
87
- ## 4.0.1
88
- Tue, 14 May 2024 05:02:20 GMT
89
-
90
- ### Updates
91
-
92
- - publish
93
- - import TextEncoder to avoid globals race
94
-
95
- ## 4.0.0
96
- Tue, 14 May 2024 03:09:27 GMT
97
-
98
- ### Updates
99
-
100
- - rework validation/converter compatibility a bit
101
- - QoL improvement to simplify error aggregation
102
- - factor optional converters out to ts-extras package to eliminate large dependencies
103
- - update generated api docs
104
- - add convalidate helper
105
- - add defaulting converter
106
- - extend conversion to accept validators
107
- - export StringConverter at top level
108
-
109
- ## 3.0.0
110
- Mon, 22 Jan 2024 07:00:18 GMT
111
-
112
- ### Updates
113
-
114
- - gitignore tweaks
115
- - refactor hash implementation
116
- - bump versions
117
- - refactor and cleanup
118
- - build changes
119
- - Factor out extras, enable shaking
120
- - bump dependencies
121
- - version upgrades
122
- - relax mapToRecord from Map to ReadonlyMap
123
- - bump version
124
- - add oneOf validator
125
-
126
- ## 2.0.0
127
- Mon, 10 Apr 2023 03:33:11 GMT
128
-
129
- ### Breaking changes
130
-
131
- - refactor and cleanup
132
- - reorganization and cleanup
133
- - more refactoring
134
- - refactor
135
-
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,WAAW,MAAM,wBAAwB,CAAC;AACtD,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EACL,SAAS,EACT,YAAY,EACZ,mBAAmB,EACnB,kBAAkB,EAClB,SAAS,EACT,mBAAmB,EACnB,6BAA6B,EAC7B,mBAAmB,EACpB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAChG,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAE9D,cAAc,iBAAiB,CAAC;AAChC,OAAO,EACL,WAAW,EACX,SAAS,EACT,mBAAmB,EACnB,UAAU,EACV,SAAS,EACT,UAAU,EACV,QAAQ,EACR,IAAI,EACJ,YAAY,EACZ,kBAAkB,EAClB,eAAe,EACf,SAAS,EACT,eAAe,EACf,mBAAmB,EACnB,6BAA6B,EAC7B,mBAAmB,EACnB,UAAU,EACV,SAAS,EACT,UAAU,EACX,CAAC"}
package/lib/index.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,oEAAsD;AAqBpD,kCAAW;AApBb,kEAAoD;AAuBlD,gCAAU;AAtBZ,sDAAwC;AA0BtC,oBAAI;AAzBN,+DAAiD;AAwB/C,4BAAQ;AAvBV,kEAAoD;AAiClD,gCAAU;AA/BZ,wDASgC;AAO9B,0FAfA,uBAAS,OAeA;AACT,oGAdA,iCAAmB,OAcA;AASnB,0FArBA,uBAAS,OAqBA;AAET,oGAtBA,iCAAmB,OAsBA;AACnB,8GAtBA,2CAA6B,OAsBA;AAC7B,oGAtBA,iCAAmB,OAsBA;AApBrB,sDAAgG;AAU9F,2FAVkB,uBAAU,OAUlB;AAKV,gGAf8B,4BAAe,OAe9B;AAEf,gGAjB+C,4BAAe,OAiB/C;AAhBjB,sDAA8D;AAsB5D,2FAtBkB,uBAAU,OAsBlB;AApBZ,kDAAgC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as Collections from './packlets/collections';\nimport * as Conversion from './packlets/conversion';\nimport * as Hash from './packlets/hash';\nimport * as FileTree from './packlets/file-tree';\nimport * as Validation from './packlets/validation';\n\nimport {\n Collector,\n ICollectible,\n ConvertingCollector,\n IReadOnlyResultMap,\n ResultMap,\n ValidatingCollector,\n ValidatingConvertingCollector,\n ValidatingResultMap\n} from './packlets/collections';\nimport { Converter, Converters, ObjectConverter, StringConverter } from './packlets/conversion';\nimport { Validator, Validators } from './packlets/validation';\n\nexport * from './packlets/base';\nexport {\n Collections,\n Collector,\n ConvertingCollector,\n Conversion,\n Converter,\n Converters,\n FileTree,\n Hash,\n ICollectible,\n IReadOnlyResultMap,\n ObjectConverter,\n ResultMap,\n StringConverter,\n ValidatingCollector,\n ValidatingConvertingCollector,\n ValidatingResultMap,\n Validation,\n Validator,\n Validators\n};\n"]}
@@ -1 +0,0 @@
1
- {"version":3,"file":"brand.d.ts","sourceRoot":"","sources":["../../../src/packlets/base/brand.ts"],"names":[],"mappings":"AAsBA;;;GAGG;AAEH,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,OAAO,EAAE,CAAC,CAAA;CAAE,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"brand.js","sourceRoot":"","sources":["../../../src/packlets/base/brand.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\n/**\n * Helper type to brand a simple type to prevent inappropriate use\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport type Brand<T, B> = T & { __brand: B };\n"]}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/base/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,OAAO,MAAM,UAAU,CAAC;AAEpC,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/base/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kDAAoC;AAQ3B,0BAAO;AANhB,0CAAwB;AACxB,+CAA6B;AAC7B,sDAAoC;AACpC,yCAAyC;AAAhC,uGAAA,UAAU,OAAA;AACnB,2CAAyB;AACzB,0CAAwB","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as Logging from './logger';\n\nexport * from './brand';\nexport * from './mapResults';\nexport * from './messageAggregator';\nexport { Normalizer } from './normalize';\nexport * from './result';\nexport * from './utils';\nexport { Logging };\n"]}
@@ -1 +0,0 @@
1
- {"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../src/packlets/base/logger.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAiB,MAAM,UAAU,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE1E;;GAEG;AAEH,MAAM,WAAW,MAAM;IACrB,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC9E,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACjF,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC/E,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC/E,WAAW,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACxE,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CACnE;AAED;;GAEG;AACH,8BAAsB,UAAU;IACvB,QAAQ,EAAE,QAAQ,CAAU;gBAEhB,QAAQ,CAAC,EAAE,QAAQ;IAI/B,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAOhF,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAO9E,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAO9E,WAAW,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IASvE,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IASjE,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAQpF,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM;IAQtE,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAItE,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAC3E;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,UAAU;IAC5C,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,CAAM;IACnC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,CAAM;gBAEd,QAAQ,CAAC,EAAE,QAAQ;IAItC,IAAW,QAAQ,IAAI,MAAM,EAAE,CAE9B;IACD,IAAW,MAAM,IAAI,MAAM,EAAE,CAE5B;IAEM,KAAK,IAAI,IAAI;IAKpB,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAKjE,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAIrE;AAED;;GAEG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACxC,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAIlE"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../src/packlets/base/logger.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qCAA2D;AAoB3D;;GAEG;AACH,MAAsB,UAAU;IAG9B,YAAmB,QAAmB;QAF/B,aAAQ,GAAa,MAAM,CAAC;QAGjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,MAAM,CAAC;IACrC,CAAC;IAEM,MAAM,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACvD,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,IAAA,gBAAO,EAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;IAEM,IAAI,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACrD,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;YAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,IAAA,gBAAO,EAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;IAEM,IAAI,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACrD,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC5D,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,IAAA,gBAAO,EAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;IAEM,WAAW,CAAI,OAAiB,EAAE,GAAG,UAAqB;;QAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;QACvD,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC5D,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACnC,OAAO,IAAA,aAAI,EAAC,MAAA,MAAM,CAAC,KAAK,mCAAI,SAAS,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAA,aAAI,EAAC,SAAS,CAAC,CAAC;IACzB,CAAC;IAEM,KAAK,CAAI,OAAiB,EAAE,GAAG,UAAqB;;QACzD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;QACvD,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACnC,OAAO,IAAA,aAAI,EAAC,MAAA,MAAM,CAAC,KAAK,mCAAI,SAAS,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAA,aAAI,EAAC,SAAS,CAAC,CAAC;IACzB,CAAC;IAEM,GAAG,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACpD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;QAC3D,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAES,OAAO,CAAC,OAAiB,EAAE,GAAG,UAAqB;QAC3D,MAAM,GAAG,GAAG,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;QACjE,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChC,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,YAAY,CAAC,SAAiB;QACtC,OAAO,IAAA,gBAAO,EAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;CAGF;AAnED,gCAmEC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,UAAU;IAI5C,YAAmB,QAAmB;QACpC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAJR,cAAS,GAAa,EAAE,CAAC;QACzB,YAAO,GAAa,EAAE,CAAC;IAIjC,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IACD,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;IACpB,CAAC;IAES,SAAS,CAAC,OAAe;QACjC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7B,OAAO,IAAA,gBAAO,EAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAES,YAAY,CAAC,OAAe;QACpC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3B,OAAO,IAAA,gBAAO,EAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;CACF;AA7BD,wCA6BC;AAED;;GAEG;AACH,MAAa,UAAW,SAAQ,UAAU;IAC9B,SAAS,CAAC,OAAe;QACjC,QAAQ;QACR,OAAO,IAAA,gBAAO,EAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;CACF;AALD,gCAKC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\nimport { Failure, Success, fail, succeed } from './result';\n\n/**\n * @public\n */\nexport type LogLevel = 'detail' | 'info' | 'warning' | 'error' | 'silent';\n\n/**\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface Logger {\n log(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n info(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n warnAndFail<T>(message?: unknown, ...parameters: unknown[]): Failure<T>;\n error<T>(message?: unknown, ...parameters: unknown[]): Failure<T>;\n}\n\n/**\n * @public\n */\nexport abstract class LoggerBase {\n public logLevel: LogLevel = 'info';\n\n public constructor(logLevel?: LogLevel) {\n this.logLevel = logLevel ?? 'info';\n }\n\n public detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n if (this.logLevel === 'detail') {\n return this.log(message, parameters);\n }\n return succeed(undefined);\n }\n\n public info(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n if (this.logLevel === 'detail' || this.logLevel === 'info') {\n return this.log(message, parameters);\n }\n return succeed(undefined);\n }\n\n public warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n if (this.logLevel !== 'error' && this.logLevel !== 'silent') {\n return this.log(message, parameters);\n }\n return succeed(undefined);\n }\n\n public warnAndFail<T>(message?: unknown, ...parameters: unknown[]): Failure<T> {\n const formatted = this._format(message, ...parameters);\n if (this.logLevel !== 'error' && this.logLevel !== 'silent') {\n const result = this.log(formatted);\n return fail(result.value ?? formatted);\n }\n return fail(formatted);\n }\n\n public error<T>(message?: unknown, ...parameters: unknown[]): Failure<T> {\n const formatted = this._format(message, ...parameters);\n if (this.logLevel !== 'silent') {\n const result = this.log(formatted);\n return fail(result.value ?? formatted);\n }\n return fail(formatted);\n }\n\n public log(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n const messageString = this._format(message, ...parameters);\n if (this.logLevel === 'silent') {\n return this._innerSilent(messageString);\n }\n return this._innerLog(messageString);\n }\n\n protected _format(message?: unknown, ...parameters: unknown[]): string {\n const raw = [message, ...parameters];\n const filtered = raw.filter((m): m is string => m !== undefined);\n const strings = filtered.map((m) => m.toString());\n const joined = strings.join('');\n return joined;\n }\n\n protected _innerSilent(__message: string): Success<string | undefined> {\n return succeed(undefined);\n }\n\n protected abstract _innerLog(message: string): Success<string | undefined>;\n}\n\n/**\n * @public\n */\nexport class InMemoryLogger extends LoggerBase {\n protected _messages: string[] = [];\n protected _silent: string[] = [];\n\n public constructor(logLevel?: LogLevel) {\n super(logLevel);\n }\n\n public get messages(): string[] {\n return this._messages;\n }\n public get silent(): string[] {\n return this._silent;\n }\n\n public clear(): void {\n this._messages = [];\n this._silent = [];\n }\n\n protected _innerLog(message: string): Success<string | undefined> {\n this._messages.push(message);\n return succeed(message);\n }\n\n protected _innerSilent(message: string): Success<string | undefined> {\n this._silent.push(message);\n return succeed(undefined);\n }\n}\n\n/**\n * @public\n */\nexport class NoOpLogger extends LoggerBase {\n protected _innerLog(message: string): Success<string | undefined> {\n // no-op\n return succeed(message);\n }\n}\n"]}