@fgv/ts-utils 4.2.2 → 4.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (89) hide show
  1. package/CHANGELOG.json +12 -0
  2. package/CHANGELOG.md +8 -1
  3. package/dist/ts-utils.d.ts +3085 -2658
  4. package/lib/index.d.ts +2 -2
  5. package/lib/index.d.ts.map +1 -1
  6. package/lib/index.js +4 -2
  7. package/lib/index.js.map +1 -1
  8. package/lib/packlets/base/result.d.ts +33 -0
  9. package/lib/packlets/base/result.d.ts.map +1 -1
  10. package/lib/packlets/base/result.js +24 -0
  11. package/lib/packlets/base/result.js.map +1 -1
  12. package/lib/packlets/collections/collectible.d.ts +48 -0
  13. package/lib/packlets/collections/collectible.d.ts.map +1 -0
  14. package/lib/packlets/collections/collectible.js +59 -0
  15. package/lib/packlets/collections/collectible.js.map +1 -0
  16. package/lib/packlets/collections/collector.d.ts +130 -0
  17. package/lib/packlets/collections/collector.d.ts.map +1 -0
  18. package/lib/packlets/collections/collector.js +147 -0
  19. package/lib/packlets/collections/collector.js.map +1 -0
  20. package/lib/packlets/collections/collectorConverter.d.ts +59 -0
  21. package/lib/packlets/collections/collectorConverter.d.ts.map +1 -0
  22. package/lib/packlets/collections/collectorConverter.js +86 -0
  23. package/lib/packlets/collections/collectorConverter.js.map +1 -0
  24. package/lib/packlets/collections/collectors.d.ts +32 -0
  25. package/lib/packlets/collections/collectors.d.ts.map +1 -0
  26. package/lib/packlets/collections/collectors.js +57 -0
  27. package/lib/packlets/collections/collectors.js.map +1 -0
  28. package/lib/packlets/collections/convertingCollector.d.ts +67 -0
  29. package/lib/packlets/collections/convertingCollector.d.ts.map +1 -0
  30. package/lib/packlets/collections/convertingCollector.js +77 -0
  31. package/lib/packlets/collections/convertingCollector.js.map +1 -0
  32. package/lib/packlets/collections/{validatingResultMap.d.ts → convertingResultMap.d.ts} +18 -18
  33. package/lib/packlets/collections/convertingResultMap.d.ts.map +1 -0
  34. package/lib/packlets/collections/{validatingResultMap.js → convertingResultMap.js} +18 -18
  35. package/lib/packlets/collections/convertingResultMap.js.map +1 -0
  36. package/lib/packlets/collections/index.d.ts +8 -2
  37. package/lib/packlets/collections/index.d.ts.map +1 -1
  38. package/lib/packlets/collections/index.js +8 -2
  39. package/lib/packlets/collections/index.js.map +1 -1
  40. package/lib/packlets/collections/keyValueConverters.d.ts +90 -0
  41. package/lib/packlets/collections/keyValueConverters.d.ts.map +1 -0
  42. package/lib/packlets/collections/keyValueConverters.js +111 -0
  43. package/lib/packlets/collections/keyValueConverters.js.map +1 -0
  44. package/lib/packlets/collections/readonlyResultMap.d.ts +1 -1
  45. package/lib/packlets/collections/readonlyResultMap.d.ts.map +1 -1
  46. package/lib/packlets/collections/readonlyResultMap.js.map +1 -1
  47. package/lib/packlets/collections/{resultMapValidator.d.ts → resultMapConverter.d.ts} +14 -18
  48. package/lib/packlets/collections/resultMapConverter.d.ts.map +1 -0
  49. package/lib/packlets/collections/{resultMapValidator.js → resultMapConverter.js} +15 -15
  50. package/lib/packlets/collections/resultMapConverter.js.map +1 -0
  51. package/lib/packlets/collections/utils.d.ts +0 -61
  52. package/lib/packlets/collections/utils.d.ts.map +1 -1
  53. package/lib/packlets/collections/utils.js +0 -82
  54. package/lib/packlets/collections/utils.js.map +1 -1
  55. package/lib/packlets/conversion/baseConverter.d.ts +12 -7
  56. package/lib/packlets/conversion/baseConverter.d.ts.map +1 -1
  57. package/lib/packlets/conversion/baseConverter.js +12 -8
  58. package/lib/packlets/conversion/baseConverter.js.map +1 -1
  59. package/lib/packlets/conversion/converter.d.ts +6 -6
  60. package/lib/packlets/conversion/converter.d.ts.map +1 -1
  61. package/lib/packlets/conversion/converter.js.map +1 -1
  62. package/lib/packlets/conversion/converters.d.ts +8 -0
  63. package/lib/packlets/conversion/converters.d.ts.map +1 -1
  64. package/lib/packlets/conversion/converters.js +11 -0
  65. package/lib/packlets/conversion/converters.js.map +1 -1
  66. package/lib/packlets/conversion/objectConverter.d.ts +1 -1
  67. package/lib/packlets/conversion/objectConverter.d.ts.map +1 -1
  68. package/lib/packlets/conversion/objectConverter.js.map +1 -1
  69. package/lib/packlets/validation/common.d.ts +8 -0
  70. package/lib/packlets/validation/common.d.ts.map +1 -1
  71. package/lib/packlets/validation/common.js.map +1 -1
  72. package/lib/packlets/validation/genericValidator.d.ts +4 -6
  73. package/lib/packlets/validation/genericValidator.d.ts.map +1 -1
  74. package/lib/packlets/validation/genericValidator.js.map +1 -1
  75. package/lib/packlets/validation/number.d.ts.map +1 -1
  76. package/lib/packlets/validation/number.js +3 -1
  77. package/lib/packlets/validation/number.js.map +1 -1
  78. package/lib/packlets/validation/string.d.ts.map +1 -1
  79. package/lib/packlets/validation/string.js +3 -1
  80. package/lib/packlets/validation/string.js.map +1 -1
  81. package/lib/packlets/validation/validators.d.ts +12 -2
  82. package/lib/packlets/validation/validators.d.ts.map +1 -1
  83. package/lib/packlets/validation/validators.js +13 -0
  84. package/lib/packlets/validation/validators.js.map +1 -1
  85. package/package.json +1 -1
  86. package/lib/packlets/collections/resultMapValidator.d.ts.map +0 -1
  87. package/lib/packlets/collections/resultMapValidator.js.map +0 -1
  88. package/lib/packlets/collections/validatingResultMap.d.ts.map +0 -1
  89. package/lib/packlets/collections/validatingResultMap.js.map +0 -1
@@ -21,30 +21,30 @@
21
21
  * SOFTWARE.
22
22
  */
23
23
  Object.defineProperty(exports, "__esModule", { value: true });
24
- exports.ResultMapValidator = void 0;
24
+ exports.ResultMapConverter = void 0;
25
25
  const base_1 = require("../base");
26
26
  /**
27
27
  * A {@link Collections.ResultMap | ResultMap} wrapper which validates weakly-typed keys
28
28
  * before calling the wrapped result map.
29
29
  * @public
30
30
  */
31
- class ResultMapValidator {
31
+ class ResultMapConverter {
32
32
  get map() {
33
33
  return this._map;
34
34
  }
35
35
  /**
36
- * Constructs a new {@link Collections.ValidatingResultMap | ValidatingResultMap}.
37
- * @param params - Required parameters for constructing the map.
36
+ * Constructs a new {@link Collections.ResultMapConverter | ResultMapConverter}.
37
+ * @param params - Required parameters for constructing the result map converter.
38
38
  */
39
39
  constructor(params) {
40
40
  this._map = params.map;
41
- this.validators = params.validators;
41
+ this.converters = params.converters;
42
42
  }
43
43
  /**
44
44
  * {@inheritdoc Collections.ResultMap.add}
45
45
  */
46
46
  add(key, value) {
47
- return this.validators.validateEntry([key, value]).onSuccess(([vk, vv]) => {
47
+ return this.converters.convertEntry([key, value]).onSuccess(([vk, vv]) => {
48
48
  return this._map.add(vk, vv);
49
49
  });
50
50
  }
@@ -52,7 +52,7 @@ class ResultMapValidator {
52
52
  * {@inheritdoc Collections.ResultMap.delete}
53
53
  */
54
54
  delete(key) {
55
- return this.validators.validateKey(key).onSuccess((k) => {
55
+ return this.converters.convertKey(key).onSuccess((k) => {
56
56
  return this._map.delete(k);
57
57
  });
58
58
  }
@@ -60,21 +60,21 @@ class ResultMapValidator {
60
60
  * {@inheritdoc Collections.ResultMap.get}
61
61
  */
62
62
  get(key) {
63
- return this.validators.validateKey(key).onSuccess((k) => {
63
+ return this.converters.convertKey(key).onSuccess((k) => {
64
64
  return this._map.get(k);
65
65
  });
66
66
  }
67
67
  getOrAdd(key, valueOrFactory) {
68
68
  if (!this._isResultMapValueFactory(valueOrFactory)) {
69
- return this.validators.validateEntry([key, valueOrFactory]).onSuccess(([vk, vv]) => {
69
+ return this.converters.convertEntry([key, valueOrFactory]).onSuccess(([vk, vv]) => {
70
70
  return this._map.getOrAdd(vk, vv);
71
71
  });
72
72
  }
73
73
  else {
74
- return this.validators.validateKey(key).onSuccess((k) => {
74
+ return this.converters.convertKey(key).onSuccess((k) => {
75
75
  return this._map.get(k).onFailure(() => {
76
76
  const value = valueOrFactory(k)
77
- .onSuccess((value) => this.validators.validateEntry([k, value]))
77
+ .onSuccess((value) => this.converters.convertEntry([k, value]))
78
78
  .onSuccess(([__key, value]) => (0, base_1.succeedWithDetail)(value, 'added'));
79
79
  return value.success
80
80
  ? this._map.add(k, value.value)
@@ -93,7 +93,7 @@ class ResultMapValidator {
93
93
  * {@inheritdoc Collections.ResultMap.set}
94
94
  */
95
95
  set(key, value) {
96
- return this.validators.validateEntry([key, value]).onSuccess(([vk, vv]) => {
96
+ return this.converters.convertEntry([key, value]).onSuccess(([vk, vv]) => {
97
97
  return this._map.set(vk, vv);
98
98
  });
99
99
  }
@@ -101,7 +101,7 @@ class ResultMapValidator {
101
101
  * {@inheritdoc Collections.ResultMap.update}
102
102
  */
103
103
  update(key, value) {
104
- return this.validators.validateEntry([key, value]).onSuccess(([vk, vv]) => {
104
+ return this.converters.convertEntry([key, value]).onSuccess(([vk, vv]) => {
105
105
  return this._map.update(vk, vv);
106
106
  });
107
107
  }
@@ -122,5 +122,5 @@ class ResultMapValidator {
122
122
  return typeof value === 'function';
123
123
  }
124
124
  }
125
- exports.ResultMapValidator = ResultMapValidator;
126
- //# sourceMappingURL=resultMapValidator.js.map
125
+ exports.ResultMapConverter = ResultMapConverter;
126
+ //# sourceMappingURL=resultMapConverter.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"resultMapConverter.js","sourceRoot":"","sources":["../../../src/packlets/collections/resultMapConverter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAA4E;AAmC5E;;;;GAIG;AACH,MAAa,kBAAkB;IAI7B,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAID;;;OAGG;IACH,YAAmB,MAA+C;QAChE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW,EAAE,KAAc;QACpC,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE;YACvE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,GAAW;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACrD,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW;QACpB,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACrD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAcM,QAAQ,CACb,GAAW,EACX,cAAuD;QAEvD,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,cAAc,CAAC,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE;gBAChF,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;gBACrD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE;oBACrC,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC;yBAC5B,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;yBAC9D,SAAS,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,IAAA,wBAAiB,EAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;oBAEpE,OAAO,KAAK,CAAC,OAAO;wBAClB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;wBAC/B,CAAC,CAAC,IAAA,qBAAc,EAA4B,KAAK,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;gBAChF,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW;QACpB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAS,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW,EAAE,KAAc;QACpC,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE;YACvE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,GAAW,EAAE,KAAc;QACvC,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE;YACvE,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACO,wBAAwB,CAChC,KAAyC;QAEzC,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;IACrC,CAAC;CACF;AA7HD,gDA6HC","sourcesContent":["/*\n * Copyright (c) 2025 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 { DetailedResult, failWithDetail, succeedWithDetail } from '../base';\nimport { IReadOnlyResultMap, ResultMapResultDetail } from './readonlyResultMap';\nimport { ResultMap, ResultMapValueFactory } from './resultMap';\nimport { KeyValueConverters } from './keyValueConverters';\n\n/**\n * A read-only interface exposing non-mutating methods of a {@link Collections.ResultMapConverter | ResultMapConverter}.\n * @public\n */\nexport interface IReadOnlyResultMapConverter<TK extends string = string, TV = unknown> {\n /**\n * {@inheritdoc Collections.ResultMapConverter.map}\n */\n readonly map: IReadOnlyResultMap<TK, TV>;\n\n /**\n * {@inheritdoc Collections.ResultMap.get}\n */\n get(key: string): DetailedResult<TV, ResultMapResultDetail>;\n\n /**\n * {@inheritdoc Collections.ResultMap.has}\n */\n has(key: string): boolean;\n}\n\n/**\n * Parameters for constructing a {@link Collections.ResultMapConverter | ResultMapConverter}.\n * @public\n */\nexport interface IResultMapConverterCreateParams<TK extends string = string, TV = unknown> {\n map: ResultMap<TK, TV>;\n converters: KeyValueConverters<TK, TV>;\n}\n\n/**\n * A {@link Collections.ResultMap | ResultMap} wrapper which validates weakly-typed keys\n * before calling the wrapped result map.\n * @public\n */\nexport class ResultMapConverter<TK extends string = string, TV = unknown>\n implements IReadOnlyResultMapConverter<TK, TV>\n{\n public readonly converters: KeyValueConverters<TK, TV>;\n public get map(): IReadOnlyResultMap<TK, TV> {\n return this._map;\n }\n\n protected _map: ResultMap<TK, TV>;\n\n /**\n * Constructs a new {@link Collections.ResultMapConverter | ResultMapConverter}.\n * @param params - Required parameters for constructing the result map converter.\n */\n public constructor(params: IResultMapConverterCreateParams<TK, TV>) {\n this._map = params.map;\n this.converters = params.converters;\n }\n\n /**\n * {@inheritdoc Collections.ResultMap.add}\n */\n public add(key: string, value: unknown): DetailedResult<TV, ResultMapResultDetail> {\n return this.converters.convertEntry([key, value]).onSuccess(([vk, vv]) => {\n return this._map.add(vk, vv);\n });\n }\n\n /**\n * {@inheritdoc Collections.ResultMap.delete}\n */\n public delete(key: string): DetailedResult<TV, ResultMapResultDetail> {\n return this.converters.convertKey(key).onSuccess((k) => {\n return this._map.delete(k);\n });\n }\n\n /**\n * {@inheritdoc Collections.ResultMap.get}\n */\n public get(key: string): DetailedResult<TV, ResultMapResultDetail> {\n return this.converters.convertKey(key).onSuccess((k) => {\n return this._map.get(k);\n });\n }\n\n /**\n * {@inheritdoc Collections.ResultMap.(getOrAdd:1)}\n */\n public getOrAdd(key: string, value: unknown): DetailedResult<TV, ResultMapResultDetail>;\n\n /**\n * {@inheritdoc Collections.ResultMap.(getOrAdd:2)}\n */\n public getOrAdd(\n key: string,\n factory: ResultMapValueFactory<TK, TV>\n ): DetailedResult<TV, ResultMapResultDetail>;\n public getOrAdd(\n key: string,\n valueOrFactory: unknown | ResultMapValueFactory<TK, TV>\n ): DetailedResult<TV, ResultMapResultDetail> {\n if (!this._isResultMapValueFactory(valueOrFactory)) {\n return this.converters.convertEntry([key, valueOrFactory]).onSuccess(([vk, vv]) => {\n return this._map.getOrAdd(vk, vv);\n });\n } else {\n return this.converters.convertKey(key).onSuccess((k) => {\n return this._map.get(k).onFailure(() => {\n const value = valueOrFactory(k)\n .onSuccess((value) => this.converters.convertEntry([k, value]))\n .onSuccess(([__key, value]) => succeedWithDetail(value, 'added'));\n\n return value.success\n ? this._map.add(k, value.value)\n : failWithDetail<TV, ResultMapResultDetail>(value.message, 'invalid-value');\n });\n });\n }\n }\n\n /**\n * {@inheritdoc Collections.ResultMap.has}\n */\n public has(key: string): boolean {\n return this._map.has(key as TK);\n }\n\n /**\n * {@inheritdoc Collections.ResultMap.set}\n */\n public set(key: string, value: unknown): DetailedResult<TV, ResultMapResultDetail> {\n return this.converters.convertEntry([key, value]).onSuccess(([vk, vv]) => {\n return this._map.set(vk, vv);\n });\n }\n\n /**\n * {@inheritdoc Collections.ResultMap.update}\n */\n public update(key: string, value: unknown): DetailedResult<TV, ResultMapResultDetail> {\n return this.converters.convertEntry([key, value]).onSuccess(([vk, vv]) => {\n return this._map.update(vk, vv);\n });\n }\n\n /**\n * Gets a read-only version of this validator.\n */\n public toReadOnly(): IReadOnlyResultMapConverter<TK, TV> {\n return this;\n }\n\n /**\n * Determines if a value is a {@link Collections.ResultMapValueFactory | ResultMapValueFactory}.\n * @param value - The value to check.\n * @returns `true` if the value is a {@link Collections.ResultMapValueFactory | ResultMapValueFactory},\n * `false` otherwise.\n * @public\n */\n protected _isResultMapValueFactory<TK extends string, TV>(\n value: TV | ResultMapValueFactory<TK, TV>\n ): value is ResultMapValueFactory<TK, TV> {\n return typeof value === 'function';\n }\n}\n"]}
@@ -1,8 +1,3 @@
1
- import { DetailedResult, Result } from '../base';
2
- import { Converter } from '../conversion';
3
- import { Validator } from '../validation';
4
- import { KeyValueEntry } from './common';
5
- import { ResultMapResultDetail } from './readonlyResultMap';
6
1
  /**
7
2
  * Determines if a supplied value is an iterable object or some other type.
8
3
  * @param value - The value to be tested.
@@ -10,60 +5,4 @@ import { ResultMapResultDetail } from './readonlyResultMap';
10
5
  * @public
11
6
  */
12
7
  export declare function isIterable<TE = unknown, TI extends Iterable<TE> = Iterable<TE>, TO = unknown>(value: TI | TO): value is TI;
13
- /**
14
- * Helper class for validating key-value pairs.
15
- * @public
16
- */
17
- export declare class KeyValueValidators<TK extends string = string, TV = unknown> {
18
- /**
19
- * Required key validator or converter.
20
- */
21
- readonly key: Validator<TK, unknown> | Converter<TK, unknown>;
22
- /**
23
- * Required value validator or converter.
24
- */
25
- readonly value: Validator<TV, unknown> | Converter<TV, unknown>;
26
- /**
27
- * Optional entry validator or converter. If no entry validator is provided,
28
- * an entry is considered valid if both key and value are valid.
29
- */
30
- readonly entry?: Validator<KeyValueEntry<TK, TV>, unknown> | Converter<KeyValueEntry<TK, TV>, unknown>;
31
- /**
32
- * Constructs a new key-value validator.
33
- * @param key - Required key validator or converter.
34
- * @param value - Required value validator or converter.
35
- * @param entry - Optional entry validator or converter. If no entry validator is provided,
36
- * an entry is considered valid if both key and value are valid.
37
- */
38
- constructor(key: Validator<TK, unknown> | Converter<TK, unknown>, value: Validator<TV, unknown> | Converter<TV, unknown>, entry?: Validator<KeyValueEntry<TK, TV>, unknown> | Converter<KeyValueEntry<TK, TV>, unknown>);
39
- /**
40
- * Validates a supplied unknown as a valid key value.
41
- * @param key - The unknown to be validated.
42
- * @returns `Success` with the validated key value and 'success' detail if the key is valid,
43
- * or `Failure` with an error message and 'invalid-key' detail if the key is invalid.
44
- */
45
- validateKey(key: unknown): DetailedResult<TK, ResultMapResultDetail>;
46
- /**
47
- * Validates a supplied unknown as a valid value.
48
- * @param key - The unknown to be validated.
49
- * @returns `Success` with the validated value and 'success' detail if the value is valid,
50
- * or `Failure` with an error message and 'invalid-value' detail if the value is invalid.
51
- */
52
- validateValue(key: unknown): DetailedResult<TV, ResultMapResultDetail>;
53
- /**
54
- * Validates a supplied unknown as a valid key-value pair.
55
- * @param entry - The unknown to be validated.
56
- * @returns `Success` with the validated key-value pair and 'success' detail if the entry
57
- * is valid, or `Failure` with an error message and 'invalid-key' or 'invalid-value' detail if
58
- * the entry is invalid
59
- */
60
- validateEntry(entry: unknown): DetailedResult<KeyValueEntry<TK, TV>, ResultMapResultDetail>;
61
- /**
62
- * Validates a supplied iterable of unknowns as valid key-value pairs.
63
- * @param entries - The iterable of unknowns to be validated.
64
- * @returns `Success` with an array of validated key-value pairs if all entries are valid,
65
- * or `Failure` with an error message if any entry is invalid.
66
- */
67
- validateEntries(entries: Iterable<unknown>): Result<KeyValueEntry<TK, TV>[]>;
68
- }
69
8
  //# sourceMappingURL=utils.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/utils.ts"],"names":[],"mappings":"AAsBA,OAAO,EACL,cAAc,EAGd,MAAM,EAGP,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAE5D;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,EAAE,GAAG,OAAO,EAAE,EAAE,SAAS,QAAQ,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,OAAO,EAC3F,KAAK,EAAE,EAAE,GAAG,EAAE,GACb,KAAK,IAAI,EAAE,CAEb;AAED;;;GAGG;AACH,qBAAa,kBAAkB,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO;IACtE;;OAEG;IACH,SAAgB,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAErE;;OAEG;IACH,SAAgB,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAEvE;;;OAGG;IACH,SAAgB,KAAK,CAAC,EAClB,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,GACzC,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAE9C;;;;;;OAMG;gBAED,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,EACpD,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,EACtD,KAAK,CAAC,EAAE,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC;IAO/F;;;;;OAKG;IACI,WAAW,CAAC,GAAG,EAAE,OAAO,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAI3E;;;;;OAKG;IACI,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAI7E;;;;;;OAMG;IACI,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,qBAAqB,CAAC;IAkBlG;;;;;OAKG;IACI,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;CAapF"}
1
+ {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/utils.ts"],"names":[],"mappings":"AAsBA;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,EAAE,GAAG,OAAO,EAAE,EAAE,SAAS,QAAQ,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,OAAO,EAC3F,KAAK,EAAE,EAAE,GAAG,EAAE,GACb,KAAK,IAAI,EAAE,CAEb"}
@@ -21,9 +21,7 @@
21
21
  * SOFTWARE.
22
22
  */
23
23
  Object.defineProperty(exports, "__esModule", { value: true });
24
- exports.KeyValueValidators = void 0;
25
24
  exports.isIterable = isIterable;
26
- const base_1 = require("../base");
27
25
  /**
28
26
  * Determines if a supplied value is an iterable object or some other type.
29
27
  * @param value - The value to be tested.
@@ -33,84 +31,4 @@ const base_1 = require("../base");
33
31
  function isIterable(value) {
34
32
  return (value && typeof value === 'object' && Symbol.iterator in value) === true;
35
33
  }
36
- /**
37
- * Helper class for validating key-value pairs.
38
- * @public
39
- */
40
- class KeyValueValidators {
41
- /**
42
- * Constructs a new key-value validator.
43
- * @param key - Required key validator or converter.
44
- * @param value - Required value validator or converter.
45
- * @param entry - Optional entry validator or converter. If no entry validator is provided,
46
- * an entry is considered valid if both key and value are valid.
47
- */
48
- constructor(key, value, entry) {
49
- this.key = key;
50
- this.value = value;
51
- this.entry = entry;
52
- }
53
- /**
54
- * Validates a supplied unknown as a valid key value.
55
- * @param key - The unknown to be validated.
56
- * @returns `Success` with the validated key value and 'success' detail if the key is valid,
57
- * or `Failure` with an error message and 'invalid-key' detail if the key is invalid.
58
- */
59
- validateKey(key) {
60
- return this.key.convert(key).withFailureDetail('invalid-key');
61
- }
62
- /**
63
- * Validates a supplied unknown as a valid value.
64
- * @param key - The unknown to be validated.
65
- * @returns `Success` with the validated value and 'success' detail if the value is valid,
66
- * or `Failure` with an error message and 'invalid-value' detail if the value is invalid.
67
- */
68
- validateValue(key) {
69
- return this.value.convert(key).withFailureDetail('invalid-value');
70
- }
71
- /**
72
- * Validates a supplied unknown as a valid key-value pair.
73
- * @param entry - The unknown to be validated.
74
- * @returns `Success` with the validated key-value pair and 'success' detail if the entry
75
- * is valid, or `Failure` with an error message and 'invalid-key' or 'invalid-value' detail if
76
- * the entry is invalid
77
- */
78
- validateEntry(entry) {
79
- if (this.entry) {
80
- return this.entry.convert(entry).withFailureDetail('invalid-value');
81
- }
82
- if (Array.isArray(entry) && entry.length === 2) {
83
- const errors = new base_1.MessageAggregator();
84
- const key = this.validateKey(entry[0]).aggregateError(errors).orDefault();
85
- const value = this.validateValue(entry[1]).aggregateError(errors).orDefault();
86
- if (key && value) {
87
- return (0, base_1.succeedWithDetail)([key, value], 'success');
88
- }
89
- const detail = key ? 'invalid-value' : 'invalid-key';
90
- return (0, base_1.failWithDetail)(`invalid entry: ${errors.toString()}`, detail);
91
- }
92
- /* c8 ignore next 2 */
93
- return (0, base_1.failWithDetail)(`malformed entry: "${JSON.stringify(entry)}"`, 'invalid-value');
94
- }
95
- /**
96
- * Validates a supplied iterable of unknowns as valid key-value pairs.
97
- * @param entries - The iterable of unknowns to be validated.
98
- * @returns `Success` with an array of validated key-value pairs if all entries are valid,
99
- * or `Failure` with an error message if any entry is invalid.
100
- */
101
- validateEntries(entries) {
102
- const errors = new base_1.MessageAggregator();
103
- const validated = [];
104
- for (const element of entries) {
105
- this.validateEntry(element)
106
- .onSuccess((e) => {
107
- validated.push(e);
108
- return (0, base_1.succeedWithDetail)(e, 'success');
109
- })
110
- .aggregateError(errors);
111
- }
112
- return errors.returnOrReport((0, base_1.succeed)(validated));
113
- }
114
- }
115
- exports.KeyValueValidators = KeyValueValidators;
116
34
  //# sourceMappingURL=utils.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/packlets/collections/utils.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAqBH,gCAIC;AAvBD,kCAOiB;AAMjB;;;;;GAKG;AACH,SAAgB,UAAU,CACxB,KAAc;IAEd,OAAO,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,KAAK,CAAC,KAAK,IAAI,CAAC;AACnF,CAAC;AAED;;;GAGG;AACH,MAAa,kBAAkB;IAmB7B;;;;;;OAMG;IACH,YACE,GAAoD,EACpD,KAAsD,EACtD,KAA6F;QAE7F,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,GAAY;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,GAAY;QAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAC,KAAc;QACjC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QACtE,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,MAAM,MAAM,GAAG,IAAI,wBAAiB,EAAE,CAAC;YACvC,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,CAAC;YAC1E,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,CAAC;YAC9E,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;gBACjB,OAAO,IAAA,wBAAiB,EAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;YACpD,CAAC;YACD,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC;YACrD,OAAO,IAAA,qBAAc,EAAC,kBAAkB,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;QACvE,CAAC;QACD,sBAAsB;QACtB,OAAO,IAAA,qBAAc,EAAC,qBAAqB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;IACxF,CAAC;IAED;;;;;OAKG;IACI,eAAe,CAAC,OAA0B;QAC/C,MAAM,MAAM,GAAG,IAAI,wBAAiB,EAAE,CAAC;QACvC,MAAM,SAAS,GAA4B,EAAE,CAAC;QAC9C,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE,CAAC;YAC9B,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;iBACxB,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;gBACf,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAClB,OAAO,IAAA,wBAAiB,EAAC,CAAC,EAAE,SAAS,CAAC,CAAC;YACzC,CAAC,CAAC;iBACD,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,MAAM,CAAC,cAAc,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC,CAAC;IACnD,CAAC;CACF;AApGD,gDAoGC","sourcesContent":["/*\n * Copyright (c) 2025 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 {\n DetailedResult,\n failWithDetail,\n MessageAggregator,\n Result,\n succeed,\n succeedWithDetail\n} from '../base';\nimport { Converter } from '../conversion';\nimport { Validator } from '../validation';\nimport { KeyValueEntry } from './common';\nimport { ResultMapResultDetail } from './readonlyResultMap';\n\n/**\n * Determines if a supplied value is an iterable object or some other type.\n * @param value - The value to be tested.\n * @returns `true` if the value is an iterable object, `false` otherwise.\n * @public\n */\nexport function isIterable<TE = unknown, TI extends Iterable<TE> = Iterable<TE>, TO = unknown>(\n value: TI | TO\n): value is TI {\n return (value && typeof value === 'object' && Symbol.iterator in value) === true;\n}\n\n/**\n * Helper class for validating key-value pairs.\n * @public\n */\nexport class KeyValueValidators<TK extends string = string, TV = unknown> {\n /**\n * Required key validator or converter.\n */\n public readonly key: Validator<TK, unknown> | Converter<TK, unknown>;\n\n /**\n * Required value validator or converter.\n */\n public readonly value: Validator<TV, unknown> | Converter<TV, unknown>;\n\n /**\n * Optional entry validator or converter. If no entry validator is provided,\n * an entry is considered valid if both key and value are valid.\n */\n public readonly entry?:\n | Validator<KeyValueEntry<TK, TV>, unknown>\n | Converter<KeyValueEntry<TK, TV>, unknown>;\n\n /**\n * Constructs a new key-value validator.\n * @param key - Required key validator or converter.\n * @param value - Required value validator or converter.\n * @param entry - Optional entry validator or converter. If no entry validator is provided,\n * an entry is considered valid if both key and value are valid.\n */\n public constructor(\n key: Validator<TK, unknown> | Converter<TK, unknown>,\n value: Validator<TV, unknown> | Converter<TV, unknown>,\n entry?: Validator<KeyValueEntry<TK, TV>, unknown> | Converter<KeyValueEntry<TK, TV>, unknown>\n ) {\n this.key = key;\n this.value = value;\n this.entry = entry;\n }\n\n /**\n * Validates a supplied unknown as a valid key value.\n * @param key - The unknown to be validated.\n * @returns `Success` with the validated key value and 'success' detail if the key is valid,\n * or `Failure` with an error message and 'invalid-key' detail if the key is invalid.\n */\n public validateKey(key: unknown): DetailedResult<TK, ResultMapResultDetail> {\n return this.key.convert(key).withFailureDetail('invalid-key');\n }\n\n /**\n * Validates a supplied unknown as a valid value.\n * @param key - The unknown to be validated.\n * @returns `Success` with the validated value and 'success' detail if the value is valid,\n * or `Failure` with an error message and 'invalid-value' detail if the value is invalid.\n */\n public validateValue(key: unknown): DetailedResult<TV, ResultMapResultDetail> {\n return this.value.convert(key).withFailureDetail('invalid-value');\n }\n\n /**\n * Validates a supplied unknown as a valid key-value pair.\n * @param entry - The unknown to be validated.\n * @returns `Success` with the validated key-value pair and 'success' detail if the entry\n * is valid, or `Failure` with an error message and 'invalid-key' or 'invalid-value' detail if\n * the entry is invalid\n */\n public validateEntry(entry: unknown): DetailedResult<KeyValueEntry<TK, TV>, ResultMapResultDetail> {\n if (this.entry) {\n return this.entry.convert(entry).withFailureDetail('invalid-value');\n }\n if (Array.isArray(entry) && entry.length === 2) {\n const errors = new MessageAggregator();\n const key = this.validateKey(entry[0]).aggregateError(errors).orDefault();\n const value = this.validateValue(entry[1]).aggregateError(errors).orDefault();\n if (key && value) {\n return succeedWithDetail([key, value], 'success');\n }\n const detail = key ? 'invalid-value' : 'invalid-key';\n return failWithDetail(`invalid entry: ${errors.toString()}`, detail);\n }\n /* c8 ignore next 2 */\n return failWithDetail(`malformed entry: \"${JSON.stringify(entry)}\"`, 'invalid-value');\n }\n\n /**\n * Validates a supplied iterable of unknowns as valid key-value pairs.\n * @param entries - The iterable of unknowns to be validated.\n * @returns `Success` with an array of validated key-value pairs if all entries are valid,\n * or `Failure` with an error message if any entry is invalid.\n */\n public validateEntries(entries: Iterable<unknown>): Result<KeyValueEntry<TK, TV>[]> {\n const errors = new MessageAggregator();\n const validated: KeyValueEntry<TK, TV>[] = [];\n for (const element of entries) {\n this.validateEntry(element)\n .onSuccess((e) => {\n validated.push(e);\n return succeedWithDetail(e, 'success');\n })\n .aggregateError(errors);\n }\n return errors.returnOrReport(succeed(validated));\n }\n}\n"]}
1
+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/packlets/collections/utils.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;AAQH,gCAIC;AAVD;;;;;GAKG;AACH,SAAgB,UAAU,CACxB,KAAc;IAEd,OAAO,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,KAAK,CAAC,KAAK,IAAI,CAAC;AACnF,CAAC","sourcesContent":["/*\n * Copyright (c) 2025 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 * Determines if a supplied value is an iterable object or some other type.\n * @param value - The value to be tested.\n * @returns `true` if the value is an iterable object, `false` otherwise.\n * @public\n */\nexport function isIterable<TE = unknown, TI extends Iterable<TE> = Iterable<TE>, TO = unknown>(\n value: TI | TO\n): value is TI {\n return (value && typeof value === 'object' && Symbol.iterator in value) === true;\n}\n"]}
@@ -17,6 +17,11 @@ export type Infer<TCONV> = TCONV extends Converter<infer TTO, unknown> ? InnerIn
17
17
  * @internal
18
18
  */
19
19
  export type ConvertedToType<TCONV> = Infer<TCONV>;
20
+ /**
21
+ * Function signature for a converter function.
22
+ * @public
23
+ */
24
+ export type ConverterFunc<T, TC> = (from: unknown, self: Converter<T, TC>, context?: TC) => Result<T>;
20
25
  /**
21
26
  * Base templated wrapper to simplify creation of new {@link Converter}s.
22
27
  * @public
@@ -42,7 +47,7 @@ export declare class BaseConverter<T, TC = unknown> implements Converter<T, TC>
42
47
  * @param traits - Optional {@link Conversion.ConverterTraits | traits} to be assigned to the resulting
43
48
  * converter.
44
49
  */
45
- constructor(converter: (from: unknown, self: Converter<T, TC>, context?: TC) => Result<T>, defaultContext?: TC, traits?: ConverterTraits);
50
+ constructor(converter: ConverterFunc<T, TC>, defaultContext?: TC, traits?: ConverterTraits);
46
51
  /**
47
52
  * {@inheritdoc Converter.isOptional}
48
53
  */
@@ -66,7 +71,7 @@ export declare class BaseConverter<T, TC = unknown> implements Converter<T, TC>
66
71
  /**
67
72
  * {@inheritdoc Converter.map}
68
73
  */
69
- map<T2>(mapper: (from: T) => Result<T2>): Converter<T2, TC>;
74
+ map<T2>(mapper: (from: T, context?: TC) => Result<T2>): Converter<T2, TC>;
70
75
  /**
71
76
  * {@inheritdoc Converter.mapConvert}
72
77
  */
@@ -74,7 +79,7 @@ export declare class BaseConverter<T, TC = unknown> implements Converter<T, TC>
74
79
  /**
75
80
  * {@inheritdoc Converter.mapItems}
76
81
  */
77
- mapItems<TI>(mapper: (from: unknown) => Result<TI>): Converter<TI[], TC>;
82
+ mapItems<TI>(mapper: (from: unknown, context?: TC) => Result<TI>): Converter<TI[], TC>;
78
83
  /**
79
84
  * {@inheritdoc Converter.mapConvertItems}
80
85
  */
@@ -82,19 +87,19 @@ export declare class BaseConverter<T, TC = unknown> implements Converter<T, TC>
82
87
  /**
83
88
  * {@inheritdoc Converter.withAction}
84
89
  */
85
- withAction<TI>(action: (result: Result<T>) => Result<TI>): Converter<TI, TC>;
90
+ withAction<TI>(action: (result: Result<T>, context?: TC) => Result<TI>): Converter<TI, TC>;
86
91
  /**
87
92
  * {@inheritdoc Converter.withTypeGuard}
88
93
  */
89
- withTypeGuard<TI>(guard: (from: unknown) => from is TI, message?: string): Converter<TI, TC>;
94
+ withTypeGuard<TI>(guard: (from: unknown, context?: TC) => from is TI, message?: string): Converter<TI, TC>;
90
95
  /**
91
96
  * {@inheritdoc Converter.withItemTypeGuard}
92
97
  */
93
- withItemTypeGuard<TI>(guard: (from: unknown) => from is TI, message?: string): Converter<TI[], TC>;
98
+ withItemTypeGuard<TI>(guard: (from: unknown, context?: TC) => from is TI, message?: string): Converter<TI[], TC>;
94
99
  /**
95
100
  * {@inheritdoc Converter.withConstraint}
96
101
  */
97
- withConstraint(constraint: (val: T) => boolean | Result<T>, options?: ConstraintOptions): Converter<T, TC>;
102
+ withConstraint(constraint: (val: T, context?: TC) => boolean | Result<T>, options?: ConstraintOptions): Converter<T, TC>;
98
103
  /**
99
104
  * {@inheritdoc Converter.withBrand}
100
105
  */
@@ -1 +1 @@
1
- {"version":3,"file":"baseConverter.d.ts","sourceRoot":"","sources":["../../../src/packlets/conversion/baseConverter.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,KAAK,EAAE,MAAM,EAA6B,MAAM,SAAS,CAAC;AACnE,OAAO,EACL,iBAAiB,EACjB,wBAAwB,EACxB,SAAS,EACT,eAAe,EACf,mBAAmB,EACnB,OAAO,EACR,MAAM,aAAa,CAAC;AAGrB;;GAEG;AACH,KAAK,iBAAiB,CAAC,KAAK,IAAI,KAAK,SAAS,SAAS,CAAC,MAAM,GAAG,CAAC,GAC9D,GAAG,SAAS,KAAK,CAAC,MAAM,OAAO,CAAC,GAC9B,iBAAiB,CAAC,OAAO,CAAC,EAAE,GAC5B,GAAG,GACL,KAAK,SAAS,KAAK,CAAC,MAAM,KAAK,CAAC,GAChC,iBAAiB,CAAC,KAAK,CAAC,EAAE,GAC1B,KAAK,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,KAAK,CAAC,KAAK,IAAI,KAAK,SAAS,SAAS,CAAC,MAAM,GAAG,EAAE,OAAO,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAExG;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;AAElD;;;GAGG;AACH,qBAAa,aAAa,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAE,YAAW,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IACrE;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC;IACxC;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,OAAO,CAAS;IACvC;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAE1B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqE;IAEhG;;;;;;OAMG;gBAED,SAAS,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,EAC7E,cAAc,CAAC,EAAE,EAAE,EACnB,MAAM,CAAC,EAAE,eAAe;IAQ1B;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAErC;IAED;;OAEG;IACI,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC;IAItD;;OAEG;IACI,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;IAS7F;;OAEG;IACI,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC;IAOhE;;OAEG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC;IAUlE;;OAEG;IACI,UAAU,CAAC,EAAE,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC;IAWrE;;OAEG;IACI,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAW/E;;OAEG;IACI,eAAe,CAAC,EAAE,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAWrF;;OAEG;IACI,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC;IAMnF;;OAEG;IACI,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC;IASnG;;OAEG;IACI,iBAAiB,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAgBzG;;OAEG;IACI,cAAc,CACnB,UAAU,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,EAC3C,OAAO,CAAC,EAAE,iBAAiB,GAC1B,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IAkBnB;;OAEG;IACI,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC;IAYxE;;OAEG;IACI,WAAW,CAAC,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,mBAAmB,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAI5E;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,SAAS;IAIjD;;OAEG;IACI,kBAAkB,CAAC,SAAS,EAAE,wBAAwB,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IAQpF;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,eAAe;IAQrE;;OAEG;IACH,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI;CAKxD"}
1
+ {"version":3,"file":"baseConverter.d.ts","sourceRoot":"","sources":["../../../src/packlets/conversion/baseConverter.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,KAAK,EAAE,MAAM,EAA6B,MAAM,SAAS,CAAC;AACnE,OAAO,EACL,iBAAiB,EACjB,wBAAwB,EACxB,SAAS,EACT,eAAe,EACf,mBAAmB,EACnB,OAAO,EACR,MAAM,aAAa,CAAC;AAGrB;;GAEG;AACH,KAAK,iBAAiB,CAAC,KAAK,IAAI,KAAK,SAAS,SAAS,CAAC,MAAM,GAAG,CAAC,GAC9D,GAAG,SAAS,KAAK,CAAC,MAAM,OAAO,CAAC,GAC9B,iBAAiB,CAAC,OAAO,CAAC,EAAE,GAC5B,GAAG,GACL,KAAK,SAAS,KAAK,CAAC,MAAM,KAAK,CAAC,GAChC,iBAAiB,CAAC,KAAK,CAAC,EAAE,GAC1B,KAAK,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,KAAK,CAAC,KAAK,IAAI,KAAK,SAAS,SAAS,CAAC,MAAM,GAAG,EAAE,OAAO,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAExG;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;AAElD;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC;AAEtG;;;GAGG;AACH,qBAAa,aAAa,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAE,YAAW,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IACrE;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC;IACxC;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,OAAO,CAAS;IACvC;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAE1B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqE;IAEhG;;;;;;OAMG;gBACgB,SAAS,EAAE,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,eAAe;IAOjG;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAErC;IAED;;OAEG;IACI,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC;IAItD;;OAEG;IACI,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;IAS7F;;OAEG;IACI,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC;IAOhE;;OAEG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC;IAUhF;;OAEG;IACI,UAAU,CAAC,EAAE,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC;IAWrE;;OAEG;IACI,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAW7F;;OAEG;IACI,eAAe,CAAC,EAAE,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAWrF;;OAEG;IACI,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC;IAMjG;;OAEG;IACI,aAAa,CAAC,EAAE,EACrB,KAAK,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,IAAI,IAAI,EAAE,EAClD,OAAO,CAAC,EAAE,MAAM,GACf,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC;IAWpB;;OAEG;IACI,iBAAiB,CAAC,EAAE,EACzB,KAAK,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,IAAI,IAAI,EAAE,EAClD,OAAO,CAAC,EAAE,MAAM,GACf,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAkBtB;;OAEG;IACI,cAAc,CACnB,UAAU,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,EACzD,OAAO,CAAC,EAAE,iBAAiB,GAC1B,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IAkBnB;;OAEG;IACI,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC;IAYxE;;OAEG;IACI,WAAW,CAAC,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,mBAAmB,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAI5E;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,SAAS;IAIjD;;OAEG;IACI,kBAAkB,CAAC,SAAS,EAAE,wBAAwB,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IAQpF;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,eAAe;IAQrE;;OAEG;IACH,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI;CAKxD"}
@@ -91,7 +91,7 @@ class BaseConverter {
91
91
  return new BaseConverter((from, __self, context) => {
92
92
  const innerResult = this._converter(from, this, this._context(context));
93
93
  if (innerResult.isSuccess()) {
94
- return mapper(innerResult.value);
94
+ return mapper(innerResult.value, this._context(context));
95
95
  }
96
96
  return (0, base_1.fail)(innerResult.message);
97
97
  })._with(this._traits());
@@ -103,7 +103,7 @@ class BaseConverter {
103
103
  return new BaseConverter((from, __self, context) => {
104
104
  const innerResult = this._converter(from, this, this._context(context));
105
105
  if (innerResult.isSuccess()) {
106
- return mapConverter.convert(innerResult.value);
106
+ return mapConverter.convert(innerResult.value, this._context(context));
107
107
  }
108
108
  return (0, base_1.fail)(innerResult.message);
109
109
  // eslint-disable-next-line no-return-assign
@@ -116,7 +116,7 @@ class BaseConverter {
116
116
  return new BaseConverter((from, __self, context) => {
117
117
  return this._converter(from, this, this._context(context)).onSuccess((items) => {
118
118
  if (Array.isArray(items)) {
119
- return (0, base_1.mapResults)(items.map((i) => mapper(i)));
119
+ return (0, base_1.mapResults)(items.map((i) => mapper(i, this._context(context))));
120
120
  }
121
121
  return (0, base_1.fail)('Cannot map items - not an array');
122
122
  });
@@ -129,7 +129,7 @@ class BaseConverter {
129
129
  return new BaseConverter((from, __self, context) => {
130
130
  return this._converter(from, this, this._context(context)).onSuccess((items) => {
131
131
  if (Array.isArray(items)) {
132
- return (0, base_1.mapResults)(items.map((i) => mapConverter.convert(i)));
132
+ return (0, base_1.mapResults)(items.map((i) => mapConverter.convert(i, this._context(context))));
133
133
  }
134
134
  return (0, base_1.fail)('Cannot map items - not an array');
135
135
  });
@@ -140,7 +140,7 @@ class BaseConverter {
140
140
  */
141
141
  withAction(action) {
142
142
  return new BaseConverter((from, __self, context) => {
143
- return action(this._converter(from, this, this._context(context)));
143
+ return action(this._converter(from, this, this._context(context)), this._context(context));
144
144
  })._with(this._traits());
145
145
  }
146
146
  /**
@@ -150,7 +150,9 @@ class BaseConverter {
150
150
  return new BaseConverter((from, __self, context) => {
151
151
  return this._converter(from, this, this._context(context)).onSuccess((inner) => {
152
152
  message = message !== null && message !== void 0 ? message : 'invalid type';
153
- return guard(inner) ? (0, base_1.succeed)(inner) : (0, base_1.fail)(`${message}: ${JSON.stringify(from)}`);
153
+ return guard(inner, this._context(context))
154
+ ? (0, base_1.succeed)(inner)
155
+ : (0, base_1.fail)(`${message}: ${JSON.stringify(from)}`);
154
156
  });
155
157
  })._with(this._traits());
156
158
  }
@@ -163,7 +165,9 @@ class BaseConverter {
163
165
  if (Array.isArray(items)) {
164
166
  return (0, base_1.mapResults)(items.map((i) => {
165
167
  message = message !== null && message !== void 0 ? message : 'invalid type';
166
- return guard(i) ? (0, base_1.succeed)(i) : (0, base_1.fail)(`${message}: ${JSON.stringify(from)}`);
168
+ return guard(i, this._context(context))
169
+ ? (0, base_1.succeed)(i)
170
+ : (0, base_1.fail)(`${message}: ${JSON.stringify(from)}`);
167
171
  }));
168
172
  }
169
173
  return (0, base_1.fail)('Cannot guard item type - not an array');
@@ -178,7 +182,7 @@ class BaseConverter {
178
182
  var _a;
179
183
  const result = this._converter(from, this, this._context(context));
180
184
  if (result.isSuccess()) {
181
- const constraintResult = constraint(result.value);
185
+ const constraintResult = constraint(result.value, this._context(context));
182
186
  if (typeof constraintResult === 'boolean') {
183
187
  return constraintResult
184
188
  ? result
@@ -1 +1 @@
1
- {"version":3,"file":"baseConverter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/baseConverter.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,kCAAmE;AASnE,+DAAmE;AA4BnE;;;GAGG;AACH,MAAa,aAAa;IAgBxB;;;;;;OAMG;IACH,YACE,SAA6E,EAC7E,cAAmB,EACnB,MAAwB;QArB1B;;WAEG;QACO,gBAAW,GAAY,KAAK,CAAC;QAoBrC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,MAAK,IAAI,CAAC;QAC/C,IAAI,CAAC,MAAM,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,IAAa,EAAE,OAAY;QACxC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,eAAe,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,IAAa,EAAE,OAAY,EAAE,OAAiB;QACnE,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QACnE,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACvB,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,cAAc,CAAC;YACpC,OAAO,IAAI,KAAK,SAAS,IAAI,OAAO,KAAK,cAAc,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QACxF,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,OAAiB;QAC/B,OAAO,IAAI,aAAa,CAAC,CAAC,IAAa,EAAE,MAAoC,EAAE,OAAY,EAAE,EAAE;YAC7F,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,aAAa,CAAC;YACnC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,GAAG,CAAK,MAA+B;QAC5C,OAAO,IAAI,aAAa,CAAS,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;YAC1F,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YACxE,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC5B,OAAO,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,IAAA,WAAI,EAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,UAAU,CAAK,YAA2B;QAC/C,OAAO,IAAI,aAAa,CAAS,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;YAC1F,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YACxE,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC5B,OAAO,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YACjD,CAAC;YACD,OAAO,IAAA,WAAI,EAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACjC,4CAA4C;QAC9C,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAK,MAAqC;QACvD,OAAO,IAAI,aAAa,CAAW,CAAC,IAAa,EAAE,MAA2B,EAAE,OAAY,EAAE,EAAE;YAC9F,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC7E,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,IAAA,iBAAU,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACjD,CAAC;gBACD,OAAO,IAAA,WAAI,EAAC,iCAAiC,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,eAAe,CAAK,YAAoC;QAC7D,OAAO,IAAI,aAAa,CAAW,CAAC,IAAa,EAAE,MAA2B,EAAE,OAAY,EAAE,EAAE;YAC9F,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC7E,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,IAAA,iBAAU,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC/D,CAAC;gBACD,OAAO,IAAA,WAAI,EAAC,iCAAiC,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,UAAU,CAAK,MAAyC;QAC7D,OAAO,IAAI,aAAa,CAAS,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;YAC1F,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,aAAa,CAAK,KAAoC,EAAE,OAAgB;QAC7E,OAAO,IAAI,aAAa,CAAS,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;YAC1F,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC7E,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,cAAc,CAAC;gBACpC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,GAAG,OAAO,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACrF,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAK,KAAoC,EAAE,OAAgB;QACjF,OAAO,IAAI,aAAa,CAAW,CAAC,IAAa,EAAE,MAA2B,EAAE,OAAY,EAAE,EAAE;YAC9F,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC7E,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,IAAA,iBAAU,EACf,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;wBACd,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,cAAc,CAAC;wBACpC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,GAAG,OAAO,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBAC7E,CAAC,CAAC,CACH,CAAC;gBACJ,CAAC;gBACD,OAAO,IAAA,WAAI,EAAC,uCAAuC,CAAC,CAAC;YACvD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,cAAc,CACnB,UAA2C,EAC3C,OAA2B;QAE3B,OAAO,IAAI,aAAa,CAAQ,CAAC,IAAa,EAAE,MAAwB,EAAE,OAAY,EAAE,EAAE;;YACxF,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YACnE,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvB,MAAM,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBAClD,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE,CAAC;oBAC1C,OAAO,gBAAgB;wBACrB,CAAC,CAAC,MAAM;wBACR,CAAC,CAAC,IAAA,WAAI,EACF,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,mCAAI,0BAA0B,EAAE,CAC3F,CAAC;gBACR,CAAC;gBACD,OAAO,gBAAgB,CAAC;YAC1B,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,SAAS,CAAmB,KAAQ;QACzC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,CAAC,MAAM,WAAW,KAAK,IAAI,CAAC,CAAC;QACrF,CAAC;QAED,OAAO,IAAI,aAAa,CAAkB,CAAC,IAAa,EAAE,MAAwB,EAAE,OAAY,EAAE,EAAE;YAClG,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;gBACzE,OAAO,IAAA,cAAO,EAAC,CAAgB,CAAC,CAAC;YACnC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACI,WAAW,CAAS,YAAgB;QACzC,OAAO,IAAI,gDAA0B,CAAY,IAAI,EAAE,YAAY,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,QAAa;QAC9B,OAAO,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,IAAI,CAAC,eAAe,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,SAAuC;QAC/D,OAAO,IAAI,aAAa,CAAQ,CAAC,IAAa,EAAE,MAAwB,EAAE,OAAY,EAAE,EAAE;YACxF,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC3E,OAAO,IAAA,WAAI,EAAC,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAC5D,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACO,OAAO,CAAC,MAAiC;QACjD,uBACE,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,KAAK,EAAE,IAAI,CAAC,KAAK,IACd,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EACjB;IACJ,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,MAAgC;QAC9C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,KAAK,IAAI,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA/PD,sCA+PC","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 { Brand, Result, fail, mapResults, succeed } from '../base';\nimport {\n ConstraintOptions,\n ConversionErrorFormatter,\n Converter,\n ConverterTraits,\n DefaultingConverter,\n OnError\n} from './converter';\nimport { GenericDefaultingConverter } from './defaultingConverter';\n\n/**\n * internal\n */\ntype InnerInferredType<TCONV> = TCONV extends Converter<infer TTO>\n ? TTO extends Array<infer TTOELEM>\n ? InnerInferredType<TTOELEM>[]\n : TTO\n : TCONV extends Array<infer TELEM>\n ? InnerInferredType<TELEM>[]\n : TCONV;\n\n/**\n * Infers the type that will be returned by an instantiated converter. Works\n * for complex as well as simple types.\n * @example `Infer<typeof Converters.mapOf(Converters.stringArray)>` is `Map<string, string[]>`\n * @beta\n */\nexport type Infer<TCONV> = TCONV extends Converter<infer TTO, unknown> ? InnerInferredType<TTO> : never;\n\n/**\n * Deprecated name for Infer<T> retained for compatibility\n * @deprecated use @see Infer instead\n * @internal\n */\nexport type ConvertedToType<TCONV> = Infer<TCONV>;\n\n/**\n * Base templated wrapper to simplify creation of new {@link Converter}s.\n * @public\n */\nexport class BaseConverter<T, TC = unknown> implements Converter<T, TC> {\n /**\n * @internal\n */\n protected readonly _defaultContext?: TC;\n /**\n * @internal\n */\n protected _isOptional: boolean = false;\n /**\n * @internal\n */\n protected _brand?: string;\n\n private readonly _converter: (from: unknown, self: Converter<T, TC>, context?: TC) => Result<T>;\n\n /**\n * Constructs a new {@link Converter} which uses the supplied function to perform the conversion.\n * @param converter - The conversion function to be applied.\n * @param defaultContext - Optional conversion context to be used by default.\n * @param traits - Optional {@link Conversion.ConverterTraits | traits} to be assigned to the resulting\n * converter.\n */\n public constructor(\n converter: (from: unknown, self: Converter<T, TC>, context?: TC) => Result<T>,\n defaultContext?: TC,\n traits?: ConverterTraits\n ) {\n this._converter = converter;\n this._defaultContext = defaultContext;\n this._isOptional = traits?.isOptional === true;\n this._brand = traits?.brand;\n }\n\n /**\n * {@inheritdoc Converter.isOptional}\n */\n public get isOptional(): boolean {\n return this._isOptional;\n }\n\n /**\n * {@inheritdoc Converter.brand}\n */\n public get brand(): string | undefined {\n return this._brand;\n }\n\n /**\n * {@inheritdoc Converter.convert}\n */\n public convert(from: unknown, context?: TC): Result<T> {\n return this._converter(from, this, context ?? this._defaultContext);\n }\n\n /**\n * {@inheritdoc Converter.convertOptional}\n */\n public convertOptional(from: unknown, context?: TC, onError?: OnError): Result<T | undefined> {\n const result = this._converter(from, this, this._context(context));\n if (result.isFailure()) {\n onError = onError ?? 'ignoreErrors';\n return from === undefined || onError === 'ignoreErrors' ? succeed(undefined) : result;\n }\n return result;\n }\n\n /**\n * {@inheritdoc Converter.optional}\n */\n public optional(onError?: OnError): Converter<T | undefined, TC> {\n return new BaseConverter((from: unknown, __self: Converter<T | undefined, TC>, context?: TC) => {\n onError = onError ?? 'failOnError';\n return this.convertOptional(from, this._context(context), onError);\n })._with(this._traits({ isOptional: true }));\n }\n\n /**\n * {@inheritdoc Converter.map}\n */\n public map<T2>(mapper: (from: T) => Result<T2>): Converter<T2, TC> {\n return new BaseConverter<T2, TC>((from: unknown, __self: Converter<T2, TC>, context?: TC) => {\n const innerResult = this._converter(from, this, this._context(context));\n if (innerResult.isSuccess()) {\n return mapper(innerResult.value);\n }\n return fail(innerResult.message);\n })._with(this._traits());\n }\n\n /**\n * {@inheritdoc Converter.mapConvert}\n */\n public mapConvert<T2>(mapConverter: Converter<T2>): Converter<T2, TC> {\n return new BaseConverter<T2, TC>((from: unknown, __self: Converter<T2, TC>, context?: TC) => {\n const innerResult = this._converter(from, this, this._context(context));\n if (innerResult.isSuccess()) {\n return mapConverter.convert(innerResult.value);\n }\n return fail(innerResult.message);\n // eslint-disable-next-line no-return-assign\n })._with(this._traits());\n }\n\n /**\n * {@inheritdoc Converter.mapItems}\n */\n public mapItems<TI>(mapper: (from: unknown) => Result<TI>): Converter<TI[], TC> {\n return new BaseConverter<TI[], TC>((from: unknown, __self: Converter<TI[], TC>, context?: TC) => {\n return this._converter(from, this, this._context(context)).onSuccess((items) => {\n if (Array.isArray(items)) {\n return mapResults(items.map((i) => mapper(i)));\n }\n return fail('Cannot map items - not an array');\n });\n });\n }\n\n /**\n * {@inheritdoc Converter.mapConvertItems}\n */\n public mapConvertItems<TI>(mapConverter: Converter<TI, unknown>): Converter<TI[], TC> {\n return new BaseConverter<TI[], TC>((from: unknown, __self: Converter<TI[], TC>, context?: TC) => {\n return this._converter(from, this, this._context(context)).onSuccess((items) => {\n if (Array.isArray(items)) {\n return mapResults(items.map((i) => mapConverter.convert(i)));\n }\n return fail('Cannot map items - not an array');\n });\n });\n }\n\n /**\n * {@inheritdoc Converter.withAction}\n */\n public withAction<TI>(action: (result: Result<T>) => Result<TI>): Converter<TI, TC> {\n return new BaseConverter<TI, TC>((from: unknown, __self: Converter<TI, TC>, context?: TC) => {\n return action(this._converter(from, this, this._context(context)));\n })._with(this._traits());\n }\n\n /**\n * {@inheritdoc Converter.withTypeGuard}\n */\n public withTypeGuard<TI>(guard: (from: unknown) => from is TI, message?: string): Converter<TI, TC> {\n return new BaseConverter<TI, TC>((from: unknown, __self: Converter<TI, TC>, context?: TC) => {\n return this._converter(from, this, this._context(context)).onSuccess((inner) => {\n message = message ?? 'invalid type';\n return guard(inner) ? succeed(inner) : fail(`${message}: ${JSON.stringify(from)}`);\n });\n })._with(this._traits());\n }\n\n /**\n * {@inheritdoc Converter.withItemTypeGuard}\n */\n public withItemTypeGuard<TI>(guard: (from: unknown) => from is TI, message?: string): Converter<TI[], TC> {\n return new BaseConverter<TI[], TC>((from: unknown, __self: Converter<TI[], TC>, context?: TC) => {\n return this._converter(from, this, this._context(context)).onSuccess((items) => {\n if (Array.isArray(items)) {\n return mapResults(\n items.map((i) => {\n message = message ?? 'invalid type';\n return guard(i) ? succeed(i) : fail(`${message}: ${JSON.stringify(from)}`);\n })\n );\n }\n return fail('Cannot guard item type - not an array');\n });\n })._with(this._traits());\n }\n\n /**\n * {@inheritdoc Converter.withConstraint}\n */\n public withConstraint(\n constraint: (val: T) => boolean | Result<T>,\n options?: ConstraintOptions\n ): Converter<T, TC> {\n return new BaseConverter<T, TC>((from: unknown, __self: Converter<T, TC>, context?: TC) => {\n const result = this._converter(from, this, this._context(context));\n if (result.isSuccess()) {\n const constraintResult = constraint(result.value);\n if (typeof constraintResult === 'boolean') {\n return constraintResult\n ? result\n : fail(\n `\"${JSON.stringify(result.value)}\": ${options?.description ?? 'does not meet constraint'}`\n );\n }\n return constraintResult;\n }\n return result;\n })._with(this._traits());\n }\n\n /**\n * {@inheritdoc Converter.withBrand}\n */\n public withBrand<B extends string>(brand: B): Converter<Brand<T, B>, TC> {\n if (this._brand) {\n throw new Error(`Cannot replace existing brand \"${this._brand}\" with \"${brand}\".`);\n }\n\n return new BaseConverter<Brand<T, B>, TC>((from: unknown, __self: Converter<T, TC>, context?: TC) => {\n return this._converter(from, this, this._context(context)).onSuccess((v) => {\n return succeed(v as Brand<T, B>);\n });\n })._with(this._traits({ brand }));\n }\n\n /**\n * {@inheritdoc Converter.withDefault}\n */\n public withDefault<TD = T>(defaultValue: TD): DefaultingConverter<T, TD, TC> {\n return new GenericDefaultingConverter<T, TD, TC>(this, defaultValue);\n }\n\n /**\n * @internal\n */\n protected _context(supplied?: TC): TC | undefined {\n return supplied ?? this._defaultContext;\n }\n\n /**\n * {@inheritdoc Converter.withFormattedError}\n */\n public withFormattedError(formatter: ConversionErrorFormatter<TC>): Converter<T, TC> {\n return new BaseConverter<T, TC>((from: unknown, __self: Converter<T, TC>, context?: TC) => {\n return this._converter(from, this, this._context(context)).onFailure((msg) => {\n return fail(formatter(from, msg, this._context(context)));\n });\n })._with(this._traits());\n }\n\n /**\n * @internal\n */\n protected _traits(traits?: Partial<ConverterTraits>): ConverterTraits {\n return {\n isOptional: this.isOptional,\n brand: this.brand,\n ...(traits ?? {})\n };\n }\n\n /**\n * @internal\n */\n protected _with(traits: Partial<ConverterTraits>): this {\n this._isOptional = traits.isOptional === true;\n this._brand = traits.brand;\n return this;\n }\n}\n"]}
1
+ {"version":3,"file":"baseConverter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/baseConverter.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,kCAAmE;AASnE,+DAAmE;AAkCnE;;;GAGG;AACH,MAAa,aAAa;IAgBxB;;;;;;OAMG;IACH,YAAmB,SAA+B,EAAE,cAAmB,EAAE,MAAwB;QAlBjG;;WAEG;QACO,gBAAW,GAAY,KAAK,CAAC;QAgBrC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,MAAK,IAAI,CAAC;QAC/C,IAAI,CAAC,MAAM,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,IAAa,EAAE,OAAY;QACxC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,eAAe,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,IAAa,EAAE,OAAY,EAAE,OAAiB;QACnE,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QACnE,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACvB,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,cAAc,CAAC;YACpC,OAAO,IAAI,KAAK,SAAS,IAAI,OAAO,KAAK,cAAc,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QACxF,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,OAAiB;QAC/B,OAAO,IAAI,aAAa,CAAC,CAAC,IAAa,EAAE,MAAoC,EAAE,OAAY,EAAE,EAAE;YAC7F,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,aAAa,CAAC;YACnC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,GAAG,CAAK,MAA6C;QAC1D,OAAO,IAAI,aAAa,CAAS,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;YAC1F,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YACxE,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC5B,OAAO,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAC3D,CAAC;YACD,OAAO,IAAA,WAAI,EAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,UAAU,CAAK,YAA2B;QAC/C,OAAO,IAAI,aAAa,CAAS,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;YAC1F,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YACxE,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC5B,OAAO,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YACzE,CAAC;YACD,OAAO,IAAA,WAAI,EAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACjC,4CAA4C;QAC9C,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAK,MAAmD;QACrE,OAAO,IAAI,aAAa,CAAW,CAAC,IAAa,EAAE,MAA2B,EAAE,OAAY,EAAE,EAAE;YAC9F,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC7E,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,IAAA,iBAAU,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;gBACzE,CAAC;gBACD,OAAO,IAAA,WAAI,EAAC,iCAAiC,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,eAAe,CAAK,YAAoC;QAC7D,OAAO,IAAI,aAAa,CAAW,CAAC,IAAa,EAAE,MAA2B,EAAE,OAAY,EAAE,EAAE;YAC9F,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC7E,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,IAAA,iBAAU,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvF,CAAC;gBACD,OAAO,IAAA,WAAI,EAAC,iCAAiC,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,UAAU,CAAK,MAAuD;QAC3E,OAAO,IAAI,aAAa,CAAS,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;YAC1F,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,aAAa,CAClB,KAAkD,EAClD,OAAgB;QAEhB,OAAO,IAAI,aAAa,CAAS,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;YAC1F,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC7E,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,cAAc,CAAC;gBACpC,OAAO,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;oBACzC,CAAC,CAAC,IAAA,cAAO,EAAC,KAAK,CAAC;oBAChB,CAAC,CAAC,IAAA,WAAI,EAAC,GAAG,OAAO,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,iBAAiB,CACtB,KAAkD,EAClD,OAAgB;QAEhB,OAAO,IAAI,aAAa,CAAW,CAAC,IAAa,EAAE,MAA2B,EAAE,OAAY,EAAE,EAAE;YAC9F,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC7E,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,IAAA,iBAAU,EACf,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;wBACd,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,cAAc,CAAC;wBACpC,OAAO,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;4BACrC,CAAC,CAAC,IAAA,cAAO,EAAC,CAAC,CAAC;4BACZ,CAAC,CAAC,IAAA,WAAI,EAAC,GAAG,OAAO,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBAClD,CAAC,CAAC,CACH,CAAC;gBACJ,CAAC;gBACD,OAAO,IAAA,WAAI,EAAC,uCAAuC,CAAC,CAAC;YACvD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,cAAc,CACnB,UAAyD,EACzD,OAA2B;QAE3B,OAAO,IAAI,aAAa,CAAQ,CAAC,IAAa,EAAE,MAAwB,EAAE,OAAY,EAAE,EAAE;;YACxF,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YACnE,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvB,MAAM,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC1E,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE,CAAC;oBAC1C,OAAO,gBAAgB;wBACrB,CAAC,CAAC,MAAM;wBACR,CAAC,CAAC,IAAA,WAAI,EACF,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,mCAAI,0BAA0B,EAAE,CAC3F,CAAC;gBACR,CAAC;gBACD,OAAO,gBAAgB,CAAC;YAC1B,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,SAAS,CAAmB,KAAQ;QACzC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,CAAC,MAAM,WAAW,KAAK,IAAI,CAAC,CAAC;QACrF,CAAC;QAED,OAAO,IAAI,aAAa,CAAkB,CAAC,IAAa,EAAE,MAAwB,EAAE,OAAY,EAAE,EAAE;YAClG,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;gBACzE,OAAO,IAAA,cAAO,EAAC,CAAgB,CAAC,CAAC;YACnC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACI,WAAW,CAAS,YAAgB;QACzC,OAAO,IAAI,gDAA0B,CAAY,IAAI,EAAE,YAAY,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,QAAa;QAC9B,OAAO,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,IAAI,CAAC,eAAe,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,SAAuC;QAC/D,OAAO,IAAI,aAAa,CAAQ,CAAC,IAAa,EAAE,MAAwB,EAAE,OAAY,EAAE,EAAE;YACxF,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC3E,OAAO,IAAA,WAAI,EAAC,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAC5D,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACO,OAAO,CAAC,MAAiC;QACjD,uBACE,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,KAAK,EAAE,IAAI,CAAC,KAAK,IACd,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EACjB;IACJ,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,MAAgC;QAC9C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,KAAK,IAAI,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AArQD,sCAqQC","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 { Brand, Result, fail, mapResults, succeed } from '../base';\nimport {\n ConstraintOptions,\n ConversionErrorFormatter,\n Converter,\n ConverterTraits,\n DefaultingConverter,\n OnError\n} from './converter';\nimport { GenericDefaultingConverter } from './defaultingConverter';\n\n/**\n * internal\n */\ntype InnerInferredType<TCONV> = TCONV extends Converter<infer TTO>\n ? TTO extends Array<infer TTOELEM>\n ? InnerInferredType<TTOELEM>[]\n : TTO\n : TCONV extends Array<infer TELEM>\n ? InnerInferredType<TELEM>[]\n : TCONV;\n\n/**\n * Infers the type that will be returned by an instantiated converter. Works\n * for complex as well as simple types.\n * @example `Infer<typeof Converters.mapOf(Converters.stringArray)>` is `Map<string, string[]>`\n * @beta\n */\nexport type Infer<TCONV> = TCONV extends Converter<infer TTO, unknown> ? InnerInferredType<TTO> : never;\n\n/**\n * Deprecated name for Infer<T> retained for compatibility\n * @deprecated use @see Infer instead\n * @internal\n */\nexport type ConvertedToType<TCONV> = Infer<TCONV>;\n\n/**\n * Function signature for a converter function.\n * @public\n */\nexport type ConverterFunc<T, TC> = (from: unknown, self: Converter<T, TC>, context?: TC) => Result<T>;\n\n/**\n * Base templated wrapper to simplify creation of new {@link Converter}s.\n * @public\n */\nexport class BaseConverter<T, TC = unknown> implements Converter<T, TC> {\n /**\n * @internal\n */\n protected readonly _defaultContext?: TC;\n /**\n * @internal\n */\n protected _isOptional: boolean = false;\n /**\n * @internal\n */\n protected _brand?: string;\n\n private readonly _converter: (from: unknown, self: Converter<T, TC>, context?: TC) => Result<T>;\n\n /**\n * Constructs a new {@link Converter} which uses the supplied function to perform the conversion.\n * @param converter - The conversion function to be applied.\n * @param defaultContext - Optional conversion context to be used by default.\n * @param traits - Optional {@link Conversion.ConverterTraits | traits} to be assigned to the resulting\n * converter.\n */\n public constructor(converter: ConverterFunc<T, TC>, defaultContext?: TC, traits?: ConverterTraits) {\n this._converter = converter;\n this._defaultContext = defaultContext;\n this._isOptional = traits?.isOptional === true;\n this._brand = traits?.brand;\n }\n\n /**\n * {@inheritdoc Converter.isOptional}\n */\n public get isOptional(): boolean {\n return this._isOptional;\n }\n\n /**\n * {@inheritdoc Converter.brand}\n */\n public get brand(): string | undefined {\n return this._brand;\n }\n\n /**\n * {@inheritdoc Converter.convert}\n */\n public convert(from: unknown, context?: TC): Result<T> {\n return this._converter(from, this, context ?? this._defaultContext);\n }\n\n /**\n * {@inheritdoc Converter.convertOptional}\n */\n public convertOptional(from: unknown, context?: TC, onError?: OnError): Result<T | undefined> {\n const result = this._converter(from, this, this._context(context));\n if (result.isFailure()) {\n onError = onError ?? 'ignoreErrors';\n return from === undefined || onError === 'ignoreErrors' ? succeed(undefined) : result;\n }\n return result;\n }\n\n /**\n * {@inheritdoc Converter.optional}\n */\n public optional(onError?: OnError): Converter<T | undefined, TC> {\n return new BaseConverter((from: unknown, __self: Converter<T | undefined, TC>, context?: TC) => {\n onError = onError ?? 'failOnError';\n return this.convertOptional(from, this._context(context), onError);\n })._with(this._traits({ isOptional: true }));\n }\n\n /**\n * {@inheritdoc Converter.map}\n */\n public map<T2>(mapper: (from: T, context?: TC) => Result<T2>): Converter<T2, TC> {\n return new BaseConverter<T2, TC>((from: unknown, __self: Converter<T2, TC>, context?: TC) => {\n const innerResult = this._converter(from, this, this._context(context));\n if (innerResult.isSuccess()) {\n return mapper(innerResult.value, this._context(context));\n }\n return fail(innerResult.message);\n })._with(this._traits());\n }\n\n /**\n * {@inheritdoc Converter.mapConvert}\n */\n public mapConvert<T2>(mapConverter: Converter<T2>): Converter<T2, TC> {\n return new BaseConverter<T2, TC>((from: unknown, __self: Converter<T2, TC>, context?: TC) => {\n const innerResult = this._converter(from, this, this._context(context));\n if (innerResult.isSuccess()) {\n return mapConverter.convert(innerResult.value, this._context(context));\n }\n return fail(innerResult.message);\n // eslint-disable-next-line no-return-assign\n })._with(this._traits());\n }\n\n /**\n * {@inheritdoc Converter.mapItems}\n */\n public mapItems<TI>(mapper: (from: unknown, context?: TC) => Result<TI>): Converter<TI[], TC> {\n return new BaseConverter<TI[], TC>((from: unknown, __self: Converter<TI[], TC>, context?: TC) => {\n return this._converter(from, this, this._context(context)).onSuccess((items) => {\n if (Array.isArray(items)) {\n return mapResults(items.map((i) => mapper(i, this._context(context))));\n }\n return fail('Cannot map items - not an array');\n });\n });\n }\n\n /**\n * {@inheritdoc Converter.mapConvertItems}\n */\n public mapConvertItems<TI>(mapConverter: Converter<TI, unknown>): Converter<TI[], TC> {\n return new BaseConverter<TI[], TC>((from: unknown, __self: Converter<TI[], TC>, context?: TC) => {\n return this._converter(from, this, this._context(context)).onSuccess((items) => {\n if (Array.isArray(items)) {\n return mapResults(items.map((i) => mapConverter.convert(i, this._context(context))));\n }\n return fail('Cannot map items - not an array');\n });\n });\n }\n\n /**\n * {@inheritdoc Converter.withAction}\n */\n public withAction<TI>(action: (result: Result<T>, context?: TC) => Result<TI>): Converter<TI, TC> {\n return new BaseConverter<TI, TC>((from: unknown, __self: Converter<TI, TC>, context?: TC) => {\n return action(this._converter(from, this, this._context(context)), this._context(context));\n })._with(this._traits());\n }\n\n /**\n * {@inheritdoc Converter.withTypeGuard}\n */\n public withTypeGuard<TI>(\n guard: (from: unknown, context?: TC) => from is TI,\n message?: string\n ): Converter<TI, TC> {\n return new BaseConverter<TI, TC>((from: unknown, __self: Converter<TI, TC>, context?: TC) => {\n return this._converter(from, this, this._context(context)).onSuccess((inner) => {\n message = message ?? 'invalid type';\n return guard(inner, this._context(context))\n ? succeed(inner)\n : fail(`${message}: ${JSON.stringify(from)}`);\n });\n })._with(this._traits());\n }\n\n /**\n * {@inheritdoc Converter.withItemTypeGuard}\n */\n public withItemTypeGuard<TI>(\n guard: (from: unknown, context?: TC) => from is TI,\n message?: string\n ): Converter<TI[], TC> {\n return new BaseConverter<TI[], TC>((from: unknown, __self: Converter<TI[], TC>, context?: TC) => {\n return this._converter(from, this, this._context(context)).onSuccess((items) => {\n if (Array.isArray(items)) {\n return mapResults(\n items.map((i) => {\n message = message ?? 'invalid type';\n return guard(i, this._context(context))\n ? succeed(i)\n : fail(`${message}: ${JSON.stringify(from)}`);\n })\n );\n }\n return fail('Cannot guard item type - not an array');\n });\n })._with(this._traits());\n }\n\n /**\n * {@inheritdoc Converter.withConstraint}\n */\n public withConstraint(\n constraint: (val: T, context?: TC) => boolean | Result<T>,\n options?: ConstraintOptions\n ): Converter<T, TC> {\n return new BaseConverter<T, TC>((from: unknown, __self: Converter<T, TC>, context?: TC) => {\n const result = this._converter(from, this, this._context(context));\n if (result.isSuccess()) {\n const constraintResult = constraint(result.value, this._context(context));\n if (typeof constraintResult === 'boolean') {\n return constraintResult\n ? result\n : fail(\n `\"${JSON.stringify(result.value)}\": ${options?.description ?? 'does not meet constraint'}`\n );\n }\n return constraintResult;\n }\n return result;\n })._with(this._traits());\n }\n\n /**\n * {@inheritdoc Converter.withBrand}\n */\n public withBrand<B extends string>(brand: B): Converter<Brand<T, B>, TC> {\n if (this._brand) {\n throw new Error(`Cannot replace existing brand \"${this._brand}\" with \"${brand}\".`);\n }\n\n return new BaseConverter<Brand<T, B>, TC>((from: unknown, __self: Converter<T, TC>, context?: TC) => {\n return this._converter(from, this, this._context(context)).onSuccess((v) => {\n return succeed(v as Brand<T, B>);\n });\n })._with(this._traits({ brand }));\n }\n\n /**\n * {@inheritdoc Converter.withDefault}\n */\n public withDefault<TD = T>(defaultValue: TD): DefaultingConverter<T, TD, TC> {\n return new GenericDefaultingConverter<T, TD, TC>(this, defaultValue);\n }\n\n /**\n * @internal\n */\n protected _context(supplied?: TC): TC | undefined {\n return supplied ?? this._defaultContext;\n }\n\n /**\n * {@inheritdoc Converter.withFormattedError}\n */\n public withFormattedError(formatter: ConversionErrorFormatter<TC>): Converter<T, TC> {\n return new BaseConverter<T, TC>((from: unknown, __self: Converter<T, TC>, context?: TC) => {\n return this._converter(from, this, this._context(context)).onFailure((msg) => {\n return fail(formatter(from, msg, this._context(context)));\n });\n })._with(this._traits());\n }\n\n /**\n * @internal\n */\n protected _traits(traits?: Partial<ConverterTraits>): ConverterTraits {\n return {\n isOptional: this.isOptional,\n brand: this.brand,\n ...(traits ?? {})\n };\n }\n\n /**\n * @internal\n */\n protected _with(traits: Partial<ConverterTraits>): this {\n this._isOptional = traits.isOptional === true;\n this._brand = traits.brand;\n return this;\n }\n}\n"]}
@@ -97,7 +97,7 @@ export interface Converter<T, TC = unknown> extends ConverterTraits {
97
97
  * converter to a new result type `<T2>`.
98
98
  * @returns A new {@link Converter} returning `<T2>`.
99
99
  */
100
- map<T2>(mapper: (from: T) => Result<T2>): Converter<T2, TC>;
100
+ map<T2>(mapper: (from: T, context?: TC) => Result<T2>): Converter<T2, TC>;
101
101
  /**
102
102
  * Creates a {@link Converter} which applies an additional supplied
103
103
  * converter to the result of this converter.
@@ -118,7 +118,7 @@ export interface Converter<T, TC = unknown> extends ConverterTraits {
118
118
  * result of this {@link Converter}.
119
119
  * @returns A new {@link Converter} returning `<TI[]>`.
120
120
  */
121
- mapItems<TI>(mapper: (from: unknown) => Result<TI>): Converter<TI[], TC>;
121
+ mapItems<TI>(mapper: (from: unknown, context?: TC) => Result<TI>): Converter<TI[], TC>;
122
122
  /**
123
123
  * Creates a {@link Converter} which maps the individual items of a collection
124
124
  * resulting from this {@link Converter} using the supplied {@link Converter}.
@@ -137,7 +137,7 @@ export interface Converter<T, TC = unknown> extends ConverterTraits {
137
137
  * of the base conversion and is allowed to mutate the return type.
138
138
  * @param action - The action to be applied.
139
139
  */
140
- withAction<T2>(action: (result: Result<T>) => Result<T2>): Converter<T2, TC>;
140
+ withAction<T2>(action: (result: Result<T>, context?: TC) => Result<T2>): Converter<T2, TC>;
141
141
  /**
142
142
  * Creates a {@link Converter} which applies a supplied type guard to the conversion
143
143
  * result.
@@ -145,7 +145,7 @@ export interface Converter<T, TC = unknown> extends ConverterTraits {
145
145
  * @param message - Optional message to be reported if the type guard fails.
146
146
  * @returns A new {@link Converter} returning `<TI>`.
147
147
  */
148
- withTypeGuard<TI>(guard: (from: unknown) => from is TI, message?: string): Converter<TI, TC>;
148
+ withTypeGuard<TI>(guard: (from: unknown, context?: TC) => from is TI, message?: string): Converter<TI, TC>;
149
149
  /**
150
150
  * Creates a {@link Converter} which applies a supplied type guard to each member of
151
151
  * the conversion result from this converter.
@@ -157,7 +157,7 @@ export interface Converter<T, TC = unknown> extends ConverterTraits {
157
157
  * @param message - Optional message to be reported if the type guard fails.
158
158
  * @returns A new {@link Converter} returning `<TI>`.
159
159
  */
160
- withItemTypeGuard<TI>(guard: (from: unknown) => from is TI, message?: string): Converter<TI[], TC>;
160
+ withItemTypeGuard<TI>(guard: (from: unknown, context?: TC) => from is TI, message?: string): Converter<TI[], TC>;
161
161
  /**
162
162
  * Creates a {@link Converter} which applies an optional constraint to the result
163
163
  * of this conversion. If this {@link Converter} (the base converter) succeeds, the new
@@ -169,7 +169,7 @@ export interface Converter<T, TC = unknown> extends ConverterTraits {
169
169
  * @param options - {@link Conversion.ConstraintOptions | Options} for constraint evaluation.
170
170
  * @returns A new {@link Converter} returning `<T>`.
171
171
  */
172
- withConstraint(constraint: (val: T) => boolean | Result<T>, options?: ConstraintOptions): Converter<T, TC>;
172
+ withConstraint(constraint: (val: T, context?: TC) => boolean | Result<T>, options?: ConstraintOptions): Converter<T, TC>;
173
173
  /**
174
174
  * Creates a new {@link Converter} which is derived from this one but which returns an
175
175
  * error message formatted by the supplied formatter if the conversion fails.