@fgv/ts-utils 4.2.2 → 4.4.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.
- package/CHANGELOG.json +18 -0
- package/CHANGELOG.md +13 -1
- package/dist/ts-utils.d.ts +3177 -2645
- package/lib/index.d.ts +2 -2
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +5 -2
- package/lib/index.js.map +1 -1
- package/lib/packlets/base/result.d.ts +33 -0
- package/lib/packlets/base/result.d.ts.map +1 -1
- package/lib/packlets/base/result.js +24 -0
- package/lib/packlets/base/result.js.map +1 -1
- package/lib/packlets/collections/collectible.d.ts +80 -0
- package/lib/packlets/collections/collectible.d.ts.map +1 -0
- package/lib/packlets/collections/collectible.js +93 -0
- package/lib/packlets/collections/collectible.js.map +1 -0
- package/lib/packlets/collections/collector.d.ts +194 -0
- package/lib/packlets/collections/collector.d.ts.map +1 -0
- package/lib/packlets/collections/collector.js +189 -0
- package/lib/packlets/collections/collector.js.map +1 -0
- package/lib/packlets/collections/collectorConverter.d.ts +86 -0
- package/lib/packlets/collections/collectorConverter.d.ts.map +1 -0
- package/lib/packlets/collections/collectorConverter.js +98 -0
- package/lib/packlets/collections/collectorConverter.js.map +1 -0
- package/lib/packlets/collections/collectors.d.ts +31 -0
- package/lib/packlets/collections/collectors.d.ts.map +1 -0
- package/lib/packlets/collections/collectors.js +54 -0
- package/lib/packlets/collections/collectors.js.map +1 -0
- package/lib/packlets/collections/convertingCollector.d.ts +73 -0
- package/lib/packlets/collections/convertingCollector.d.ts.map +1 -0
- package/lib/packlets/collections/convertingCollector.js +67 -0
- package/lib/packlets/collections/convertingCollector.js.map +1 -0
- package/lib/packlets/collections/convertingResultMap.d.ts +53 -0
- package/lib/packlets/collections/convertingResultMap.d.ts.map +1 -0
- package/lib/packlets/collections/convertingResultMap.js +61 -0
- package/lib/packlets/collections/convertingResultMap.js.map +1 -0
- package/lib/packlets/collections/index.d.ts +8 -2
- package/lib/packlets/collections/index.d.ts.map +1 -1
- package/lib/packlets/collections/index.js +8 -2
- package/lib/packlets/collections/index.js.map +1 -1
- package/lib/packlets/collections/keyValueConverters.d.ts +74 -0
- package/lib/packlets/collections/keyValueConverters.d.ts.map +1 -0
- package/lib/packlets/collections/keyValueConverters.js +104 -0
- package/lib/packlets/collections/keyValueConverters.js.map +1 -0
- package/lib/packlets/collections/readonlyResultMap.d.ts +1 -1
- package/lib/packlets/collections/readonlyResultMap.d.ts.map +1 -1
- package/lib/packlets/collections/readonlyResultMap.js.map +1 -1
- package/lib/packlets/collections/{resultMapValidator.d.ts → resultMapConverter.d.ts} +14 -18
- package/lib/packlets/collections/resultMapConverter.d.ts.map +1 -0
- package/lib/packlets/collections/{resultMapValidator.js → resultMapConverter.js} +15 -15
- package/lib/packlets/collections/resultMapConverter.js.map +1 -0
- package/lib/packlets/collections/utils.d.ts +0 -61
- package/lib/packlets/collections/utils.d.ts.map +1 -1
- package/lib/packlets/collections/utils.js +0 -82
- package/lib/packlets/collections/utils.js.map +1 -1
- package/lib/packlets/conversion/baseConverter.d.ts +12 -7
- package/lib/packlets/conversion/baseConverter.d.ts.map +1 -1
- package/lib/packlets/conversion/baseConverter.js +12 -8
- package/lib/packlets/conversion/baseConverter.js.map +1 -1
- package/lib/packlets/conversion/converter.d.ts +6 -6
- package/lib/packlets/conversion/converter.d.ts.map +1 -1
- package/lib/packlets/conversion/converter.js.map +1 -1
- package/lib/packlets/conversion/converters.d.ts +8 -0
- package/lib/packlets/conversion/converters.d.ts.map +1 -1
- package/lib/packlets/conversion/converters.js +11 -0
- package/lib/packlets/conversion/converters.js.map +1 -1
- package/lib/packlets/conversion/objectConverter.d.ts +1 -1
- package/lib/packlets/conversion/objectConverter.d.ts.map +1 -1
- package/lib/packlets/conversion/objectConverter.js.map +1 -1
- package/lib/packlets/validation/common.d.ts +8 -0
- package/lib/packlets/validation/common.d.ts.map +1 -1
- package/lib/packlets/validation/common.js.map +1 -1
- package/lib/packlets/validation/genericValidator.d.ts +4 -6
- package/lib/packlets/validation/genericValidator.d.ts.map +1 -1
- package/lib/packlets/validation/genericValidator.js.map +1 -1
- package/lib/packlets/validation/number.d.ts.map +1 -1
- package/lib/packlets/validation/number.js +3 -1
- package/lib/packlets/validation/number.js.map +1 -1
- package/lib/packlets/validation/string.d.ts.map +1 -1
- package/lib/packlets/validation/string.js +3 -1
- package/lib/packlets/validation/string.js.map +1 -1
- package/lib/packlets/validation/validators.d.ts +12 -2
- package/lib/packlets/validation/validators.d.ts.map +1 -1
- package/lib/packlets/validation/validators.js +13 -0
- package/lib/packlets/validation/validators.js.map +1 -1
- package/package.json +1 -1
- package/lib/packlets/collections/resultMapValidator.d.ts.map +0 -1
- package/lib/packlets/collections/resultMapValidator.js.map +0 -1
- package/lib/packlets/collections/validatingResultMap.d.ts +0 -73
- package/lib/packlets/collections/validatingResultMap.d.ts.map +0 -1
- package/lib/packlets/collections/validatingResultMap.js +0 -102
- package/lib/packlets/collections/validatingResultMap.js.map +0 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"converters.js","sourceRoot":"","sources":["../../../src/packlets/conversion/converters.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAiCH,0CAMC;AAeD,sDAgBC;AASD,0BAQC;AA8DD,0CAiBC;AAQD,8BAIC;AAUD,kBAUC;AAuCD,sBAqBC;AAaD,0BAsBC;AAqGD,4BAkCC;AA8DD,sBAiCC;AAcD,oCAUC;AAYD,0BAcC;AAcD,0CAcC;AAcD,sBAeC;AAcD,sCA0BC;AAyDD,wBAKC;AA4DD,oCAOC;AA4BD,kDAmBC;AAqBD,8BAoBC;AAqED,0CA8CC;AAx+BD,kCAAyD;AAEzD,mDAAgD;AAEhD,uDAA6F;AAC7F,uDAAoD;AASpD;;;;GAIG;AACU,QAAA,MAAM,GAAoB,IAAI,iCAAe,EAAE,CAAC;AAE7D;;;;;;;;;GASG;AACH,SAAgB,eAAe,CAAI,MAAW;IAC5C,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAa,EAAa,EAAE;QAC9F,MAAM,CAAC,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,MAAM,CAAC;QAC5B,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,IAAS,CAAC,CAAC;QACnC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,4BAA4B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnG,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,qBAAqB,CACnC,GAAqB,EACrB,OAAgB;IAEhB,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAwB,EAAE,SAAc,EAAE,EAAE;QACnF,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;YACvB,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC3B,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;QACD,OAAO,IAAA,WAAI,EACT,OAAO;YACL,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE;YACvC,CAAC,CAAC,eAAe,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,wBAAwB,CAChE,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,OAAO,CAAkB,KAAQ;IAC/C,OAAO,IAAI,6BAAa,CACtB,CAAC,IAAa,EAAE,MAAwB,EAAE,SAAmB,EAAa,EAAE;QAC1E,OAAO,IAAI,KAAK,KAAK;YACnB,CAAC,CAAC,IAAA,cAAO,EAAC,KAAK,CAAC;YAChB,CAAC,CAAC,IAAA,WAAI,EAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC/E,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,kDAAkD;AACrC,QAAA,KAAK,GAAG,OAAO,CAAC;AAE7B;;;;;GAKG;AACU,QAAA,MAAM,GAA+B,IAAI,6BAAa,CAAkB,CAAC,IAAa,EAAE,EAAE;IACrG,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAW,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAClE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,GAAG,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC;AAEH;;;;;;GAMG;AACU,QAAA,OAAO,GAAgC,IAAI,6BAAa,CAAmB,CAAC,IAAa,EAAE,EAAE;IACxG,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,IAAA,cAAO,EAAC,IAAe,CAAC,CAAC;IAClC,CAAC;SAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpC,QAAQ,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YAC3B,KAAK,MAAM;gBACT,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;YACvB,KAAK,OAAO;gBACV,OAAO,IAAA,cAAO,EAAC,KAAK,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IACD,OAAO,IAAA,WAAI,EAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,cAAc,GAA2C,cAAM,CAAC,QAAQ,EAAE,CAAC;AAExF;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,SAAiB,EACjB,UAA8B,UAAU;IAExC,OAAO,IAAI,6BAAa,CACtB,CAAC,IAAa,EAAE,MAAmC,EAAE,OAAgB,EAAE,EAAE;QACvE,MAAM,MAAM,GAAG,cAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACvB,IAAI,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,SAAS,CAAC,CAAC;YACvD,IAAI,OAAO,KAAK,KAAK,EAAE,CAAC;gBACtB,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACvD,CAAC;YACD,OAAO,IAAA,cAAO,EAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,SAAS,CAAkB,SAA2B;IACpE,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;QAClF,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,GAAG,CACjB,WAAmB,EACnB,KAAkC;IAElC,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;QAClF,IAAI,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;YACzB,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,WAAW,WAAW,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACU,QAAA,cAAc,GAA2C,cAAM,CAAC,QAAQ,EAAE,CAAC;AAExF;;;;;;;GAOG;AACU,QAAA,eAAe,GAA4C,eAAO,CAAC,QAAQ,EAAE,CAAC;AAE3F;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,KAAK,CACnB,UAAsD,EACtD,UAAmB,cAAc;IAEjC,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAM,EAAE,OAAY,EAAE,EAAE;QAC/D,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAChD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACrD,OAAO,MAAM,CAAC;YAChB,CAAC;YAED,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvB,IAAI,OAAO,KAAK,aAAa,EAAE,CAAC;oBAC9B,OAAO,MAAM,CAAC;gBAChB,CAAC;gBACD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,6BAA6B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,OAAO,CACrB,SAA8C,EAC9C,UAAmB,aAAa;IAEhC,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAA0B,EAAE,OAAY,EAAE,EAAE;QACnF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,OAAO,IAAA,WAAI,EAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvD,CAAC;QAED,MAAM,SAAS,GAAQ,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAChD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACrD,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC/B,CAAC;iBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,KAAK,cAAc,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1G,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACU,QAAA,WAAW,GAAiC,OAAO,CAAC,cAAM,CAAC,CAAC;AAEzE;;;;;;GAMG;AACU,QAAA,WAAW,GAAiC,OAAO,CAAC,cAAM,CAAC,CAAC;AA6EzE;;;;;GAKG;AACH,SAAgB,QAAQ,CACtB,SAA8C,EAC9C,SAA4D,MAAM;IAElE,MAAM,OAAO,GACX,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,iBAAG,OAAO,EAAE,MAAM,IAAK,MAAM,CAAE,CAAC;IACpF,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAoC,EAAE,OAAY,EAAE,EAAE;;QAC7F,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACrE,OAAO,IAAA,WAAI,EAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,IAAA,cAAO,EAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,cAAc,GAAG,MAAA,MAAA,OAAO,CAAC,YAAY,0CAAE,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,mCAAI,IAAA,cAAO,EAAC,GAAG,CAAC,CAAC;gBAEnF,cAAc;qBACX,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;oBACtB,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAY,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;wBAC1E,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;wBACzB,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;oBACvB,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC;qBACD,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBACrB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBACrB,OAAO,IAAA,WAAI,EAAC,OAAO,CAAC,CAAC;gBACvB,CAAC,CAAC,CAAC;YACP,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACzG,CAAC,CAAC,CAAC;AACL,CAAC;AAwDD;;;;;GAKG;AACH,SAAgB,KAAK,CACnB,SAA8C,EAC9C,SAA4D,MAAM;IAElE,MAAM,OAAO,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,iBAAG,OAAO,EAAE,MAAM,IAAK,MAAM,CAAE,CAAC;IAClG,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAiC,EAAE,OAAY,EAAE,EAAE;;QAC1F,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACrE,OAAO,IAAA,WAAI,EAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,GAAG,EAAS,CAAC;QAC7B,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,IAAA,cAAO,EAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,cAAc,GAAG,MAAA,MAAA,OAAO,CAAC,YAAY,0CAAE,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,mCAAI,IAAA,cAAO,EAAC,GAAG,CAAC,CAAC;gBAEnF,cAAc;qBACX,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;oBACtB,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAY,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;wBAC1E,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;wBACzB,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;oBACvB,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC;qBACD,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBACrB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBACrB,OAAO,IAAA,WAAI,EAAC,OAAO,CAAC,CAAC;gBACvB,CAAC,CAAC,CAAC;YACP,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACtG,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,YAAY,CAC1B,SAAuC,EACvC,WAAoB;IAEpB,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAwB,EAAE,SAAc,EAAE,EAAE;QACnF,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACpB,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,OAAO,CACrB,KAAa,EACb,SAA8C;IAE9C,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAwB,EAAE,OAAY,EAAE,EAAE;QACjF,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,OAAO,IAAA,WAAI,EAAC,GAAG,KAAK,+CAA+C,CAAC,CAAC;QACvE,CAAC;aAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,OAAO,IAAA,WAAI,EAAC,2CAA2C,CAAC,CAAC;QAC3D,CAAC;aAAM,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,OAAO,IAAA,WAAI,EAAC,GAAG,KAAK,8CAA8C,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;QACxF,CAAC;QACD,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,eAAe,CAC7B,KAAa,EACb,SAA8C;IAE9C,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAoC,EAAE,OAAY,EAAE,EAAE;QAC7F,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,OAAO,IAAA,WAAI,EAAC,GAAG,KAAK,+CAA+C,CAAC,CAAC;QACvE,CAAC;aAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,OAAO,IAAA,WAAI,EAAC,2CAA2C,CAAC,CAAC;QAC3D,CAAC;aAAM,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,OAAO,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,KAAK,CACnB,IAAY,EACZ,SAA8C;IAE9C,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAwB,EAAE,OAAY,EAAE,EAAE;QACjF,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACtE,IAAI,IAAA,cAAO,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;gBACxB,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBAClE,OAAO,IAAA,WAAI,EAAC,SAAS,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;gBAC3C,CAAC,CAAC,CAAC;YACL,CAAC;YACD,OAAO,IAAA,WAAI,EAAC,SAAS,IAAI,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,yBAAyB,IAAI,qBAAqB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,aAAa,CAC3B,IAAY,EACZ,SAA8C;IAE9C,OAAO,IAAI,6BAAa,CACtB,CAAC,IAAa,EAAE,MAAoC,EAAE,OAAY,EAAE,EAAE;QACpE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACtE,IAAI,IAAA,cAAO,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;gBACxB,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBAC1E,OAAO,IAAA,WAAI,EAAC,GAAG,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;gBACrC,CAAC,CAAC,CAAC;gBAEH,yDAAyD;gBACzD,oDAAoD;gBACpD,YAAY;gBACZ,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;oBACnD,OAAO,MAAM,CAAC;gBAChB,CAAC;YACH,CAAC;YACD,OAAO,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,yBAAyB,IAAI,qBAAqB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxF,CAAC,EACD,SAAS,EACT,EAAE,UAAU,EAAE,IAAI,EAAE,CACrB,CAAC;AACJ,CAAC;AAoDD;;;;GAIG;AACH,SAAgB,MAAM,CACpB,UAAkC,EAClC,OAAiD;IAEjD,OAAO,IAAI,iCAAe,CAAC,UAAU,EAAE,OAAoC,CAAC,CAAC;AAC/E,CAAC;AAuDD;;;;GAIG;AACH,SAAgB,YAAY,CAC1B,UAAkC,EAClC,GAAmD;IAEnD,MAAM,OAAO,GACX,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC,iCAAM,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,CAAC,KAAE,MAAM,EAAE,IAAI,GAAE,CAAC;IACvG,OAAO,IAAI,iCAAe,CAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;AACzD,CAAC;AAYD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,mBAAmB,CACjC,iBAAyB,EACzB,UAAgD;IAEhD,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,EAAE;QACzC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACrE,OAAO,IAAA,WAAI,EAAC,gCAAgC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,CAAC,IAAA,cAAO,EAAC,iBAAiB,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAClE,OAAO,IAAA,WAAI,EAAC,0BAA0B,iBAAiB,oBAAoB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtG,CAAC;QAED,MAAM,kBAAkB,GAAG,IAAI,CAAC,iBAAiB,CAAO,CAAC;QACzD,MAAM,SAAS,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;QACjD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,IAAA,WAAI,EAAC,kCAAkC,iBAAiB,KAAK,kBAAkB,GAAG,CAAC,CAAC;QAC7F,CAAC;QACD,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,SAAS,CAAkB,UAAkC;IAC3E,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAM,EAAE,OAAY,EAAE,EAAE;QAC/D,+CAA+C;QAC/C,gDAAgD;QAChD,MAAM,SAAS,GAAG,EAAkC,CAAC;QACrD,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAC7B,IAAI,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACpB,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBACtD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBACrD,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;gBAChC,CAAC;qBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;oBAC9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC;AAiDD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,eAAe,CAC7B,iBAAqD,EACrD,OAAsC;IAEtC,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAM,EAAE,OAAY,EAAE,EAAE;QAC/D,+CAA+C;QAC/C,gDAAgD;QAChD,MAAM,SAAS,GAAG,EAA0C,CAAC;QAC7D,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAoB,IAAI,GAAG,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC,CAAC;QAEvD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACtE,KAAK,MAAM,cAAc,IAAI,iBAAiB,EAAE,CAAC;gBAC/C,IAAI,iBAAiB,CAAC,cAAc,CAAC,EAAE,CAAC;oBACtC,MAAM,MAAM,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC;oBACtD,MAAM,SAAS,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC;oBAE9D,IAAI,IAAA,cAAO,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;wBAC1B,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;wBACxD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;4BACrD,SAAS,CAAC,cAAc,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;wBAC3C,CAAC;6BAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;4BAC9B,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,KAAK,cAAc,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;wBACjE,CAAC;wBACD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;oBACnB,CAAC;yBAAM,IAAI,iBAAiB,CAAC,cAAc,CAAC,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;wBAC/D,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,+CAA+C,CAAC,CAAC;oBAChF,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,MAAK,IAAI,EAAE,CAAC;gBAC7B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oBACvB,IAAI,IAAA,cAAO,EAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAiB,CAAC,EAAE,CAAC;wBACvD,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,wCAAwC,CAAC,CAAC;oBAC9D,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QACzC,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC;YACxB,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC;YACpB,CAAC,CAAC,IAAA,WAAI,EAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,EAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,QAAQ,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3G,CAAC,CAAC,CAAC;AACL,CAAC","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 { Result, fail, isKeyOf, succeed } from '../base';\nimport { TypeGuardWithContext, Validator } from '../validation';\nimport { BaseConverter } from './baseConverter';\nimport { Converter, OnError } from './converter';\nimport { FieldConverters, ObjectConverter, ObjectConverterOptions } from './objectConverter';\nimport { StringConverter } from './stringConverter';\n\n/**\n * Action to take on conversion failures (deprecated - use Conversion.OnError)\n * @public\n * @deprecated use Conversion.OnError.\n */\nexport { OnError };\n\n/**\n * A converter to convert unknown to string. Values of type\n * string succeed. Anything else fails.\n * @public\n */\nexport const string: StringConverter = new StringConverter();\n\n/**\n * Helper function to create a {@link Converter | Converter} which converts `unknown` to one of a set of supplied\n * enumerated values. Anything else fails.\n *\n * @remarks\n * Allowed enumerated values can also be supplied as context at conversion time.\n * @param values - Array of allowed values.\n * @returns A new {@link Converter | Converter} returning `<T>`.\n * @public\n */\nexport function enumeratedValue<T>(values: T[]): Converter<T, T[]> {\n return new BaseConverter((from: unknown, __self: Converter<T, T[]>, context?: T[]): Result<T> => {\n const v = context ?? values;\n const index = v.indexOf(from as T);\n return index >= 0 ? succeed(v[index]) : fail(`Invalid enumerated value ${JSON.stringify(from)}`);\n });\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} which converts `unknown` to one of a set of supplied enumerated\n * values, mapping any of multiple supplied values to the enumeration.\n * @remarks\n * Enables mapping of multiple input values to a consistent internal representation (so e.g. `'y'`, `'yes'`,\n * `'true'`, `1` and `true` can all map to boolean `true`)\n * @param map - An array of tuples describing the mapping. The first element of each tuple is the result\n * value, the second is the set of values that map to the result. Tuples are evaluated in the order\n * supplied and are not checked for duplicates.\n * @param message - An optional error message.\n * @returns A {@link Converter | Converter} which applies the mapping and yields `<T>` on success.\n * @public\n */\nexport function mappedEnumeratedValue<T, TC = unknown>(\n map: [T, unknown[]][],\n message?: string\n): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self: Converter<T, TC>, __context?: TC) => {\n for (const item of map) {\n if (item[1].includes(from)) {\n return succeed(item[0]);\n }\n }\n return fail(\n message\n ? `${JSON.stringify(from)}: ${message}`\n : `Cannot map '${JSON.stringify(from)}' to a supported value`\n );\n });\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} which converts `unknown` to some supplied literal value. Succeeds with\n * the supplied value if an identity comparison succeeds, fails otherwise.\n * @param value - The value to be compared.\n * @returns A {@link Converter | Converter} which returns the supplied value on success.\n * @public\n */\nexport function literal<T, TC = unknown>(value: T): Converter<T, TC> {\n return new BaseConverter<T, TC>(\n (from: unknown, __self: Converter<T, TC>, __context?: unknown): Result<T> => {\n return from === value\n ? succeed(value)\n : fail(`${JSON.stringify(from)}: does not match ${JSON.stringify(value)}`);\n }\n );\n}\n\n/**\n * Deprecated alias for @see literal\n * @param value - The value to be compared.\n * @deprecated Use {@link Converters.literal} instead.\n * @internal\n */\n// eslint-disable-next-line @rushstack/typedef-var\nexport const value = literal;\n\n/**\n * A {@link Converter | Converter} which converts `unknown` to a `number`.\n * @remarks\n * Numbers and strings with a numeric format succeed. Anything else fails.\n * @public\n */\nexport const number: Converter<number, unknown> = new BaseConverter<number, unknown>((from: unknown) => {\n if (typeof from !== 'number') {\n const num: number = typeof from === 'string' ? Number(from) : NaN;\n return isNaN(num) ? fail(`Not a number: ${JSON.stringify(from)}`) : succeed(num);\n }\n return succeed(from);\n});\n\n/**\n * A {@link Converter | Converter} which converts `unknown` to `boolean`.\n * @remarks\n * Boolean values or the case-insensitive strings `'true'` and `'false'` succeed.\n * Anything else fails.\n * @public\n */\nexport const boolean: Converter<boolean, unknown> = new BaseConverter<boolean, unknown>((from: unknown) => {\n if (typeof from === 'boolean') {\n return succeed(from as boolean);\n } else if (typeof from === 'string') {\n switch (from.toLowerCase()) {\n case 'true':\n return succeed(true);\n case 'false':\n return succeed(false);\n }\n }\n return fail(`Not a boolean: ${JSON.stringify(from)}`);\n});\n\n/**\n * A {@link Converter | Converter} which converts an optional `string` value. Values of type\n * `string` are returned. Anything else returns {@link Success | Success} with value `undefined`.\n * @public\n */\nexport const optionalString: Converter<string | undefined, unknown> = string.optional();\n\n/**\n * Helper function to create a {@link Converter | Converter} which converts any `string` into an\n * array of `string`, by separating at a supplied delimiter.\n * @remarks\n * Delimiter may also be supplied as context at conversion time.\n * @param delimiter - The delimiter at which to split.\n * @returns A new {@link Converter | Converter} returning `string[]`.\n * @public\n */\nexport function delimitedString(\n delimiter: string,\n options: 'filtered' | 'all' = 'filtered'\n): Converter<string[], string> {\n return new BaseConverter<string[], string>(\n (from: unknown, __self: Converter<string[], string>, context?: string) => {\n const result = string.convert(from);\n if (result.isSuccess()) {\n let strings = result.value.split(context ?? delimiter);\n if (options !== 'all') {\n strings = strings.filter((s) => s.trim().length > 0);\n }\n return succeed(strings);\n }\n return fail(result.message);\n }\n );\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} from any {@link Validation.Validator}\n * @param validator - the validator to be wrapped\n * @returns A {@link Converter | Converter} which uses the supplied validator.\n * @public\n */\nexport function validated<T, TC = unknown>(validator: Validator<T, TC>): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self?: Converter<T, TC>, context?: TC) => {\n return validator.validate(from, context);\n });\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} from a supplied type guard function.\n * @param description - a description of the thing to be validated for use in error messages\n * @param guard - a {@link Validation.TypeGuardWithContext} which performs the validation.\n * @returns A new {@link Converter | Converter} which validates the values using the supplied type guard\n * and returns them in place.\n * @public\n */\nexport function isA<T, TC = unknown>(\n description: string,\n guard: TypeGuardWithContext<T, TC>\n): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self?: Converter<T, TC>, context?: TC) => {\n if (guard(from, context)) {\n return succeed(from);\n }\n return fail(`invalid ${description} (${JSON.stringify(from)})`);\n });\n}\n\n/**\n * A {@link Converter | Converter} which converts an optional `number` value.\n * @remarks\n * Values of type `number` or numeric strings are converted and returned.\n * Anything else returns {@link Success | Success} with value `undefined`.\n * @public\n */\nexport const optionalNumber: Converter<number | undefined, unknown> = number.optional();\n\n/**\n * A {@link Converter | Converter} to convert an optional `boolean` value.\n * @remarks\n * Values of type `boolean` or strings that match (case-insensitive) `'true'`\n * or `'false'` are converted and returned. Anything else returns {@link Success | Success}\n * with value `undefined`.\n * @public\n */\nexport const optionalBoolean: Converter<boolean | undefined, unknown> = boolean.optional();\n\n/**\n * A helper function to create a {@link Converter | Converter} for polymorphic values.\n * Returns a converter which invokes the wrapped converters in sequence, returning the\n * first successful result. Returns an error if none of the supplied converters can\n * convert the value.\n * @remarks\n * If `onError` is `ignoreErrors` (default), then errors from any of the\n * converters are ignored provided that some converter succeeds. If\n * onError is `failOnError`, then an error from any converter fails the entire\n * conversion.\n *\n * @param converters - An ordered list of {@link Converter | converters} or {@link Validator | validators}\n * to be considered.\n * @param onError - Specifies treatment of unconvertible elements.\n * @returns A new {@link Converter | Converter} which yields a value from the union of the types returned\n * by the wrapped converters.\n * @public\n */\nexport function oneOf<T, TC = unknown>(\n converters: Array<Converter<T, TC> | Validator<T, TC>>,\n onError: OnError = 'ignoreErrors'\n): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self, context?: TC) => {\n const errors: string[] = [];\n for (const converter of converters) {\n const result = converter.convert(from, context);\n if (result.isSuccess() && result.value !== undefined) {\n return result;\n }\n\n if (result.isFailure()) {\n if (onError === 'failOnError') {\n return result;\n }\n errors.push(result.message);\n }\n }\n return fail(`No matching converter for ${JSON.stringify(from)}: ${errors.join('\\n')}`);\n });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts `unknown` to an array of `<T>`.\n * @remarks\n * If `onError` is `'failOnError'` (default), then the entire conversion fails if any element cannot\n * be converted. If `onError` is `'ignoreErrors'`, then failing elements are silently ignored.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used to convert each\n * item in the array.\n * @param ignoreErrors - Specifies treatment of unconvertible elements.\n * @returns A {@link Converter | Converter} which returns an array of `<T>`.\n * @public\n */\nexport function arrayOf<T, TC = unknown>(\n converter: Converter<T, TC> | Validator<T, TC>,\n onError: OnError = 'failOnError'\n): Converter<T[], TC> {\n return new BaseConverter((from: unknown, __self: Converter<T[], TC>, context?: TC) => {\n if (!Array.isArray(from)) {\n return fail(`Not an array: ${JSON.stringify(from)}`);\n }\n\n const successes: T[] = [];\n const errors: string[] = [];\n for (const item of from) {\n const result = converter.convert(item, context);\n if (result.isSuccess() && result.value !== undefined) {\n successes.push(result.value);\n } else if (result.isFailure()) {\n errors.push(result.message);\n }\n }\n\n return errors.length === 0 || onError === 'ignoreErrors' ? succeed(successes) : fail(errors.join('\\n'));\n });\n}\n\n/**\n * {@link Converter | Converter} to convert an `unknown` to an array of `string`.\n * @remarks\n * Returns {@link Success | Success} with the the supplied value if it as an array\n * of strings, returns {@link Failure | Failure} with an error message otherwise.\n * @public\n */\nexport const stringArray: Converter<string[], unknown> = arrayOf(string);\n\n/**\n * {@link Converter | Converter} to convert an `unknown` to an array of `number`.\n * @remarks\n * Returns {@link Success | Success} with the the supplied value if it as an array\n * of numbers, returns {@link Failure | Failure} with an error message otherwise.\n * @public\n */\nexport const numberArray: Converter<number[], unknown> = arrayOf(number);\n\n/**\n * Options for {@link Converters.(recordOf:3) | Converters.recordOf} and\n * {@link Converters.(mapOf:3) | Converters.mapOf}\n * helper functions.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface KeyedConverterOptions<T extends string = string, TC = unknown> {\n /**\n * if `onError` is `'fail'` (default), then the entire conversion fails if any key or element\n * cannot be converted. If `onError` is `'ignore'`, failing elements are silently ignored.\n */\n onError?: 'fail' | 'ignore';\n /**\n * If present, `keyConverter` is used to convert the source object property names to\n * keys in the resulting map or record.\n * @remarks\n * Can be used to coerce key names to supported values and/or strong types.\n */\n keyConverter?: Converter<T, TC> | Validator<T, TC>;\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed\n * properties using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to\n * produce a `Record<string, T>`.\n * @remarks\n * The resulting converter fails conversion if any element cannot be converted.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used for each\n * item in the source object.\n * @returns A {@link Converter | Converter} which returns `Record<string, T>`.\n * {@label WITH_DEFAULT}\n * @public\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>\n): Converter<Record<TK, T>, TC>;\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce a\n * `Record<string, T>` and optionally specified handling of elements that cannot be converted.\n * @remarks\n * if `onError` is `'fail'` (default), then the entire conversion fails if any key or element\n * cannot be converted. If `onError` is `'ignore'`, failing elements are silently ignored.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} for each item in\n * the source object.\n * @returns A {@link Converter | Converter} which returns `Record<string, T>`.\n * {@label WITH_ON_ERROR}\n * @public\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>,\n onError: 'fail' | 'ignore'\n): Converter<Record<TK, T>, TC>;\n\n/**\n * A helper function to create a {@link Converter | Converter} or which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce a\n * `Record<TK, T>`.\n * @remarks\n * If present, the supplied {@link Converters.KeyedConverterOptions | options} can provide a strongly-typed\n * converter for keys and/or control the handling of elements that fail conversion.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used for each item in the source object.\n * @param options - Optional {@link Converters.KeyedConverterOptions | KeyedConverterOptions<TK, TC>} which\n * supplies a key converter and/or error-handling options.\n * @returns A {@link Converter | Converter} which returns `Record<TK, T>`.\n * {@label WITH_OPTIONS}\n * @public\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>,\n options: KeyedConverterOptions<TK, TC>\n): Converter<Record<TK, T>, TC>;\n\n/**\n * Concrete implementation of {@link Converters.(recordOf:1) | Converters.recordOf(Converter<T, TC>)},\n * {@link Converters.(recordOf:2) | Converters.recordOf(Converter<T, TC>, 'fail' or 'ignore')}, and\n * {@link Converters.(recordOf:3) | Converters.recordOf(Converter<T, TC>, KeyedConverterOptions)}.\n * @internal\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>,\n option: 'fail' | 'ignore' | KeyedConverterOptions<TK, TC> = 'fail'\n): Converter<Record<TK, T>, TC> {\n const options: KeyedConverterOptions<TK, TC> =\n typeof option === 'string' ? { onError: option } : { onError: 'fail', ...option };\n return new BaseConverter((from: unknown, __self: Converter<Record<TK, T>, TC>, context?: TC) => {\n if (typeof from !== 'object' || from === null || Array.isArray(from)) {\n return fail(`Not a string-keyed object: ${JSON.stringify(from)}`);\n }\n\n const record: Record<string, T> = {};\n const errors: string[] = [];\n\n for (const key in from) {\n if (isKeyOf(key, from)) {\n const writeKeyResult = options.keyConverter?.convert(key, context) ?? succeed(key);\n\n writeKeyResult\n .onSuccess((writeKey) => {\n return converter.convert(from[key] as unknown, context).onSuccess((value) => {\n record[writeKey] = value;\n return succeed(true);\n });\n })\n .onFailure((message) => {\n errors.push(message);\n return fail(message);\n });\n }\n }\n\n return errors.length === 0 || options.onError === 'ignore' ? succeed(record) : fail(errors.join('\\n'));\n });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce a\n * `Map<string, T>`.\n * @remarks\n * The resulting converter fails conversion if any element cannot be converted.\n * @param converter - {@link Converter | Converter} | {@link Validator | Validator} used for each item in\n * the source object.\n * @returns A {@link Converter | Converter} which returns `Map<string, T>`.\n * {@label WITH_DEFAULT}\n * @public\n */\nexport function mapOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>\n): Converter<Map<TK, T>, TC>;\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce a\n * `Map<string, T>` and specified handling of elements that cannot be converted.\n * @remarks\n * if `onError` is `'fail'` (default), then the entire conversion fails if any key or element\n * cannot be converted. If `onError` is `'ignore'`, failing elements are silently ignored.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used for\n * each item in the source object.\n * @returns A {@link Converter | Converter} which returns `Map<string, T>`.\n * {@label WITH_ON_ERROR}\n * @public\n */\nexport function mapOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>,\n onError: 'fail' | 'ignore'\n): Converter<Map<TK, T>, TC>;\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce\n * a `Map<TK,T>`.\n * @remarks\n * If present, the supplied {@link Converters.KeyedConverterOptions | options} can provide a strongly-typed\n * converter for keys and/or control the handling of elements that fail conversion.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used for each item\n * in the source object.\n * @param options - Optional {@link Converters.KeyedConverterOptions | KeyedConverterOptions<TK, TC>} which\n * supplies a key converter and/or error-handling options.\n * @returns A {@link Converter | Converter} which returns `Map<TK,T>`.\n * {@label WITH_OPTIONS}\n * @public\n */\nexport function mapOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>,\n options: KeyedConverterOptions<TK, TC>\n): Converter<Map<TK, T>, TC>;\n\n/**\n * Concrete implementation of {@link Converters.(mapOf:1) | Converters.mapOf(Converter<T, TC>)},\n * {@link Converters.(mapOf:2) | Converters.mapOf(Converter<T, TC>, 'fail' or 'ignore')}, and\n * {@link Converters.(mapOf:3) | Converters.mapOf(Converter<T, TC>, KeyedConverterOptions)}.\n * @internal\n */\nexport function mapOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>,\n option: 'fail' | 'ignore' | KeyedConverterOptions<TK, TC> = 'fail'\n): Converter<Map<TK, T>, TC> {\n const options = typeof option === 'string' ? { onError: option } : { onError: 'fail', ...option };\n return new BaseConverter((from: unknown, __self: Converter<Map<TK, T>, TC>, context?: TC) => {\n if (typeof from !== 'object' || from === null || Array.isArray(from)) {\n return fail(`Not a string-keyed object: ${JSON.stringify(from)}`);\n }\n\n const map = new Map<TK, T>();\n const errors: string[] = [];\n\n for (const key in from) {\n if (isKeyOf(key, from)) {\n const writeKeyResult = options.keyConverter?.convert(key, context) ?? succeed(key);\n\n writeKeyResult\n .onSuccess((writeKey) => {\n return converter.convert(from[key] as unknown, context).onSuccess((value) => {\n map.set(writeKey, value);\n return succeed(true);\n });\n })\n .onFailure((message) => {\n errors.push(message);\n return fail(message);\n });\n }\n }\n\n return errors.length === 0 || options.onError === 'ignore' ? succeed(map) : fail(errors.join('\\n'));\n });\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} which validates that a supplied value is\n * of a type validated by a supplied validator function and returns it.\n * @remarks\n * If `validator` succeeds, this {@link Converter | Converter} returns {@link Success | Success} with the supplied\n * value of `from` coerced to type `<T>`. Returns a {@link Failure | Failure} with additional\n * information otherwise.\n * @param validator - A validator function to determine if the converted value is valid.\n * @param description - A description of the validated type for use in error messages.\n * @returns A new {@link Converter | Converter<T, TC>} which applies the supplied validation.\n * @public\n */\nexport function validateWith<T, TC = unknown>(\n validator: (from: unknown) => from is T,\n description?: string\n): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self: Converter<T, TC>, __context?: TC) => {\n if (validator(from)) {\n return succeed(from);\n }\n return fail(`${JSON.stringify(from)}: invalid ${description ?? 'value'}`);\n });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which extracts and converts an element from an array.\n * @remarks\n * The returned {@link Converter | Converter} returns {@link Success | Success} with the converted value if the element exists\n * in the supplied array and can be converted. Returns {@link Failure | Failure} with an error message otherwise.\n * @param index - The index of the element to be extracted.\n * @param converter - A {@link Converter | Converter} or {@link Validator | Validator} for the extracted element.\n * @returns A {@link Converter | Converter<T, TC>} which extracts the specified element from an array.\n * @public\n */\nexport function element<T, TC = unknown>(\n index: number,\n converter: Converter<T, TC> | Validator<T, TC>\n): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self: Converter<T, TC>, context?: TC) => {\n if (index < 0) {\n return fail(`${index}: cannot convert for a negative element index`);\n } else if (!Array.isArray(from)) {\n return fail('element converter: source is not an array');\n } else if (index >= from.length) {\n return fail(`${index}: element converter index out of range (0..${from.length - 1})`);\n }\n return converter.convert(from[index], context);\n });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which extracts and converts an optional element from an array.\n * @remarks\n * The resulting {@link Converter | Converter} returns {@link Success | Success} with the converted value if the element exists\n * in the supplied array and can be converted. Returns {@link Success | Success} with value `undefined` if the parameter\n * is an array but the index is out of range. Returns {@link Failure | Failure} with a message if the supplied parameter\n * is not an array, if the requested index is negative, or if the element cannot be converted.\n * @param index - The index of the element to be extracted.\n * @param converter - A {@link Converter | Converter} or {@link Validator | Validator} used for the extracted element.\n * @returns A {@link Converter | Converter<T, TC>} which extracts the specified element from an array.\n * @public\n */\nexport function optionalElement<T, TC = unknown>(\n index: number,\n converter: Converter<T, TC> | Validator<T, TC>\n): Converter<T | undefined, TC> {\n return new BaseConverter((from: unknown, __self: Converter<T | undefined, TC>, context?: TC) => {\n if (index < 0) {\n return fail(`${index}: cannot convert for a negative element index`);\n } else if (!Array.isArray(from)) {\n return fail('element converter: source is not an array');\n } else if (index >= from.length) {\n return succeed(undefined);\n }\n return converter.convert(from[index], context);\n });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which extracts and convert a property specified\n * by name from an object.\n * @remarks\n * The resulting {@link Converter | Converter} returns {@link Success | Success} with the converted value of the corresponding\n * object property if the field exists and can be converted. Returns {@link Failure | Failure} with an error message\n * otherwise.\n * @param name - The name of the field to be extracted.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} to use for the extracted\n * field.\n * @public\n */\nexport function field<T, TC = unknown>(\n name: string,\n converter: Converter<T, TC> | Validator<T, TC>\n): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self: Converter<T, TC>, context?: TC) => {\n if (typeof from === 'object' && !Array.isArray(from) && from !== null) {\n if (isKeyOf(name, from)) {\n return converter.convert(from[name], context).onFailure((message) => {\n return fail(`Field ${name}: ${message}`);\n });\n }\n return fail(`Field ${name} not found in: ${JSON.stringify(from)}`);\n }\n return fail(`Cannot convert field \"${name}\" from non-object ${JSON.stringify(from)}`);\n });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which extracts and convert a property specified\n * by name from an object.\n * @remarks\n * The resulting {@link Converter | Converter} returns {@link Success | Success} with the converted value of\n * the corresponding object property if the field exists and can be converted. Returns {@link Success | Success}\n * with `undefined` if the supplied parameter is an object but the named field is not present.\n * Returns {@link Failure | Failure} with an error message otherwise.\n * @param name - The name of the field to be extracted.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} to use for the extracted field.\n * @public\n */\nexport function optionalField<T, TC = unknown>(\n name: string,\n converter: Converter<T, TC> | Validator<T, TC>\n): Converter<T | undefined, TC> {\n return new BaseConverter(\n (from: unknown, __self: Converter<T | undefined, TC>, context?: TC) => {\n if (typeof from === 'object' && !Array.isArray(from) && from !== null) {\n if (isKeyOf(name, from)) {\n const result = converter.convert(from[name], context).onFailure((message) => {\n return fail(`${name}: ${message}`);\n });\n\n // if conversion was successful or input was undefined we\n // succeed with 'undefined', but we propagate actual\n // failures.\n if (result.isSuccess() || from[name] !== undefined) {\n return result;\n }\n }\n return succeed(undefined);\n }\n return fail(`Cannot convert field \"${name}\" from non-object ${JSON.stringify(from)}`);\n },\n undefined,\n { isOptional: true }\n );\n}\n\n/**\n * Helper function to create a {@link Conversion.ObjectConverter | ObjectConverter<T, TC>} which converts an object\n * without changing shape, given a {@link Conversion.FieldConverters | FieldConverters<T, TC>} and an optional\n * {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>} to further refine conversion behavior.\n * @remarks\n * By default, if all of the requested fields exist and can be converted, returns {@link Success | Success}\n * with a new object that contains the converted values under the original key names. If any required properties\n * do not exist or cannot be converted, the entire conversion fails, returning {@link Failure | Failure} with additional\n * error information.\n *\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n * @param properties - An {@link Conversion.FieldConverters | FieldConverters<T, TC>} defining the shape of the\n * source object and {@link Converter | converters} to be applied to each properties.\n * @param options - An {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>} containing options\n * for the object converter.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} which applies the specified conversions.\n * {@label WITH_OPTIONS}\n * @public\n */\nexport function object<T, TC = unknown>(\n properties: FieldConverters<T, TC>,\n options?: ObjectConverterOptions<T>\n): ObjectConverter<T, TC>;\n\n/**\n * Helper function to create a {@link Conversion.ObjectConverter | ObjectConverter<T, TC>} which converts an object\n * without changing shape, given a {@link Conversion.FieldConverters | FieldConverters<T, TC>} and a set of\n * optional properties.\n * @remarks\n * By default, if all of the requested fields exist and can be converted, returns {@link Success | Success}\n * with a new object that contains the converted values under the original key names. If any required properties\n * do not exist or cannot be converted, the entire conversion fails, returning {@link Failure | Failure} with additional\n * error information.\n *\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n * @param properties - An {@link Conversion.FieldConverters | FieldConverters<T, TC>} defining the shape of the\n * source object and {@link Converter | converters} to be applied to each properties.\n * @param optional - An array of `(keyof T)` listing the keys to be considered optional.\n * {@label WITH_KEYS}\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} which applies the specified conversions.\n * @public\n * @deprecated Use {@link Converters.(object:1) | Converters.object(fields, options)} instead.\n */\n\nexport function object<T, TC = unknown>(\n properties: FieldConverters<T, TC>,\n optional: (keyof T)[]\n): ObjectConverter<T, TC>;\n/**\n * Concrete implementation of {@link Converters.(object:1) | Converters.object(fields, options)}\n * and {@link Converters.(object:2) | Converters.objects(fields, optionalKeys)}.\n * @internal\n */\nexport function object<T, TC>(\n properties: FieldConverters<T, TC>,\n options?: (keyof T)[] | ObjectConverterOptions<T>\n): ObjectConverter<T, TC> {\n return new ObjectConverter(properties, options as ObjectConverterOptions<T>);\n}\n\n/**\n * Options for the {@link Converters.(strictObject:1)} helper function.\n * @public\n */\nexport type StrictObjectConverterOptions<T> = Omit<ObjectConverterOptions<T>, 'strict'>;\n\n/**\n * Helper function to create a {@link Conversion.ObjectConverter | ObjectConverter} which converts an object\n * without changing shape, a {@link Conversion.FieldConverters | FieldConverters<T, TC>} and an optional\n * {@link Converters.StrictObjectConverterOptions | StrictObjectConverterOptions<T>} to further refine\n * conversion behavior.\n *\n * @remarks\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n *\n * The conversion fails if any unexpected fields are encountered.\n *\n * @param properties - An object containing defining the shape and converters to be applied.\n * @param options - An optional @see StrictObjectConverterOptions<T> containing options for the object converter.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} which applies the specified conversions.\n * {@label WITH_OPTIONS}\n * @public\n */\nexport function strictObject<T, TC = unknown>(\n properties: FieldConverters<T, TC>,\n options?: StrictObjectConverterOptions<T>\n): ObjectConverter<T, TC>;\n\n/**\n * Helper function to create a {@link Conversion.ObjectConverter | ObjectConverter} which converts an object\n * without changing shape, a {@link Conversion.FieldConverters | FieldConverters<T, TC>} and an optional\n * {@link Converters.StrictObjectConverterOptions | StrictObjectConverterOptions<T>} to further refine\n * conversion behavior.\n *\n * @remarks\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n *\n * The conversion fails if any unexpected fields are encountered.\n *\n * @param properties - An object containing defining the shape and converters to be applied.\n * @param optional - An array of `keyof T` containing keys to be considered optional.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} which applies the specified conversions.\n * {@label WITH_KEYS}\n * @deprecated Use {@link Converters.(strictObject:1) | Converters.strictObject(options)} instead.\n * @public\n */\nexport function strictObject<T, TC = unknown>(\n properties: FieldConverters<T, TC>,\n optional: (keyof T)[]\n): ObjectConverter<T, TC>;\n\n/**\n * Concrete implementation for {@link Converters.(strictObject:1) | Converters.strictObject(fields, options)}\n * and {@link Converters.strictObject | Converters.strictObject(fields, optional)}.\n * @internal\n */\nexport function strictObject<T, TC = unknown>(\n properties: FieldConverters<T, TC>,\n opt?: (keyof T)[] | StrictObjectConverterOptions<T>\n): ObjectConverter<T, TC> {\n const options: ObjectConverterOptions<T> =\n opt && Array.isArray(opt) ? { strict: true, optionalFields: opt } : { ...(opt ?? {}), strict: true };\n return new ObjectConverter<T, TC>(properties, options);\n}\n\n/**\n * A string-keyed `Record<string, Converter>` which maps specific {@link Converter | converters} or\n * {@link Validator | Validators} to the value of a discriminator property.\n * @public\n */\nexport type DiscriminatedObjectConverters<T, TD extends string = string, TC = unknown> = Record<\n TD,\n Converter<T, TC> | Validator<T, TC>\n>;\n\n/**\n * Helper to create a {@link Converter | Converter} which converts a discriminated object without changing shape.\n * @remarks\n * Takes the name of the discriminator property and a\n * {@link Converters.DiscriminatedObjectConverters | string-keyed Record of converters and validators}. During conversion,\n * the resulting {@link Converter | Converter} invokes the converter from `converters` that corresponds to the value of\n * the discriminator property in the source object.\n *\n * If the source is not an object, the discriminator property is missing, or the discriminator has\n * a value not present in the converters, conversion fails and returns {@link Failure | Failure} with more information.\n * @param discriminatorProp - Name of the property used to discriminate types.\n * @param converters - {@link Converters.DiscriminatedObjectConverters | String-keyed record of converters and validators}\n * to invoke, where each key corresponds to a value of the discriminator property.\n * @returns A {@link Converter | Converter} which converts the corresponding discriminated object.\n * @public\n */\nexport function discriminatedObject<T, TD extends string = string, TC = unknown>(\n discriminatorProp: string,\n converters: DiscriminatedObjectConverters<T, TD>\n): Converter<T, TC> {\n return new BaseConverter((from: unknown) => {\n if (typeof from !== 'object' || Array.isArray(from) || from === null) {\n return fail(`Not a discriminated object: \"${JSON.stringify(from)}\"`);\n }\n if (!isKeyOf(discriminatorProp, from) || !from[discriminatorProp]) {\n return fail(`Discriminator property ${discriminatorProp} not present in \"${JSON.stringify(from)}\"`);\n }\n\n const discriminatorValue = from[discriminatorProp] as TD;\n const converter = converters[discriminatorValue];\n if (converter === undefined) {\n return fail(`No converter for discriminator ${discriminatorProp}=\"${discriminatorValue}\"`);\n }\n return converter.convert(from);\n });\n}\n\n/**\n * Helper to create a {@link Converter | Converter} which converts a source object to a new object with a\n * different shape.\n *\n * @remarks\n * On successful conversion, the resulting {@link Converter | Converter} returns {@link Success | Success} with a new\n * object, which contains the converted values under the key names specified at initialization time.\n * It returns {@link Failure | Failure} with an error message if any fields to be extracted do not exist\n * or cannot be converted.\n *\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n *\n * @param properties - An object with key names that correspond to the target object and an\n * appropriate {@link Conversion.FieldConverters | FieldConverter} which extracts and converts\n * a single filed from the source object.\n * @returns A {@link Converter | Converter} with the specified conversion behavior.\n * @public\n */\nexport function transform<T, TC = unknown>(properties: FieldConverters<T, TC>): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self, context?: TC) => {\n // eslint bug thinks key is used before defined\n // eslint-disable-next-line no-use-before-define\n const converted = {} as { [key in keyof T]: T[key] };\n const errors: string[] = [];\n\n for (const key in properties) {\n if (properties[key]) {\n const result = properties[key].convert(from, context);\n if (result.isSuccess() && result.value !== undefined) {\n converted[key] = result.value;\n } else if (result.isFailure()) {\n errors.push(result.message);\n }\n }\n }\n\n return errors.length === 0 ? succeed(converted) : fail(errors.join('\\n'));\n });\n}\n\n/**\n * Per-property converters and configuration for each field in the destination object of\n * a {@link Converters.transformObject} call.\n * @public\n */\nexport type FieldTransformers<TSRC, TDEST, TC = unknown> = {\n [key in keyof TDEST]: {\n /**\n * The name of the property in the source object to be converted.\n */\n from: keyof TSRC;\n /**\n * The converter or validator used to convert the property.\n */\n converter: Converter<TDEST[key], TC> | Validator<TDEST[key], TC>;\n /**\n * If `true` then a missing source property is ignored. If `false` or omitted\n * then a missing source property causes an error.\n */\n optional?: boolean;\n };\n};\n\n/**\n * Options for a {@link Converters.transformObject} call.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface TransformObjectOptions<TSRC> {\n /**\n * If `strict` is `true` then unused properties in the source object cause\n * an error, otherwise they are ignored.\n */\n strict: true;\n\n /**\n * An optional list of source properties to be ignored when strict mode\n * is enabled.\n */\n ignore?: (keyof TSRC)[];\n\n /**\n * An optional description of this transform to be used for error messages.\n */\n description?: string;\n}\n\n/**\n * Helper to create a strongly-typed {@link Converter | Converter} which converts a source object to a\n * new object with a different shape.\n *\n * @remarks\n * On successful conversion, the resulting {@link Converter | Converter} returns {@link Success | Success} with a new\n * object, which contains the converted values under the key names specified at initialization time.\n *\n * It returns {@link Failure | Failure} with an error message if any fields to be extracted do not exist\n * or cannot be converted.\n *\n * @param destinationFields - An object with key names that correspond to the target object and an\n * appropriate {@link Converters.FieldTransformers | FieldTransformers} which specifies the name\n * of the corresponding property in the source object, the converter or validator used for each source\n * property and any other configuration to guide the conversion.\n * @param options - Options which affect the transformation.\n *\n * @returns A {@link Converter | Converter} with the specified conversion behavior.\n * @public\n */\nexport function transformObject<TSRC, TDEST, TC = unknown>(\n destinationFields: FieldTransformers<TSRC, TDEST, TC>,\n options?: TransformObjectOptions<TSRC>\n): Converter<TDEST, TC> {\n return new BaseConverter((from: unknown, __self, context?: TC) => {\n // eslint bug thinks key is used before defined\n // eslint-disable-next-line no-use-before-define\n const converted = {} as { [key in keyof TDEST]: TDEST[key] };\n const errors: string[] = [];\n const used: Set<keyof TSRC> = new Set(options?.ignore);\n\n if (typeof from === 'object' && !Array.isArray(from) && from !== null) {\n for (const destinationKey in destinationFields) {\n if (destinationFields[destinationKey]) {\n const srcKey = destinationFields[destinationKey].from;\n const converter = destinationFields[destinationKey].converter;\n\n if (isKeyOf(srcKey, from)) {\n const result = converter.convert(from[srcKey], context);\n if (result.isSuccess() && result.value !== undefined) {\n converted[destinationKey] = result.value;\n } else if (result.isFailure()) {\n errors.push(`${srcKey}->${destinationKey}: ${result.message}`);\n }\n used.add(srcKey);\n } else if (destinationFields[destinationKey].optional !== true) {\n errors.push(`${String(srcKey)}: required property missing in source object.`);\n }\n }\n }\n\n if (options?.strict === true) {\n for (const key in from) {\n if (isKeyOf(key, from) && !used.has(key as keyof TSRC)) {\n errors.push(`${key}: unexpected property in source object`);\n }\n }\n }\n } else {\n errors.push('source is not an object');\n }\n\n return errors.length === 0\n ? succeed(converted)\n : fail(options?.description ? `${options.description}:\\n ${errors.join('\\n ')}` : errors.join('\\n'));\n });\n}\n"]}
|
|
1
|
+
{"version":3,"file":"converters.js","sourceRoot":"","sources":["../../../src/packlets/conversion/converters.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAiCH,0CAMC;AAeD,sDAgBC;AASD,0BAQC;AA8DD,0CAiBC;AAQD,8BAIC;AAQD,0BAEC;AAUD,kBAUC;AAuCD,sBAqBC;AAaD,0BAsBC;AAqGD,4BAkCC;AA8DD,sBAiCC;AAcD,oCAUC;AAYD,0BAcC;AAcD,0CAcC;AAcD,sBAeC;AAcD,sCA0BC;AAyDD,wBAKC;AA4DD,oCAQC;AA4BD,kDAmBC;AAqBD,8BAoBC;AAqED,0CA8CC;AAn/BD,kCAAyD;AAEzD,mDAA+D;AAE/D,uDAA6F;AAC7F,uDAAoD;AASpD;;;;GAIG;AACU,QAAA,MAAM,GAAoB,IAAI,iCAAe,EAAE,CAAC;AAE7D;;;;;;;;;GASG;AACH,SAAgB,eAAe,CAAI,MAAW;IAC5C,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAa,EAAa,EAAE;QAC9F,MAAM,CAAC,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,MAAM,CAAC;QAC5B,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,IAAS,CAAC,CAAC;QACnC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,4BAA4B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnG,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,qBAAqB,CACnC,GAAqB,EACrB,OAAgB;IAEhB,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAwB,EAAE,SAAc,EAAE,EAAE;QACnF,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;YACvB,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC3B,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;QACD,OAAO,IAAA,WAAI,EACT,OAAO;YACL,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE;YACvC,CAAC,CAAC,eAAe,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,wBAAwB,CAChE,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,OAAO,CAAkB,KAAQ;IAC/C,OAAO,IAAI,6BAAa,CACtB,CAAC,IAAa,EAAE,MAAwB,EAAE,SAAmB,EAAa,EAAE;QAC1E,OAAO,IAAI,KAAK,KAAK;YACnB,CAAC,CAAC,IAAA,cAAO,EAAC,KAAK,CAAC;YAChB,CAAC,CAAC,IAAA,WAAI,EAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC/E,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,kDAAkD;AACrC,QAAA,KAAK,GAAG,OAAO,CAAC;AAE7B;;;;;GAKG;AACU,QAAA,MAAM,GAA+B,IAAI,6BAAa,CAAkB,CAAC,IAAa,EAAE,EAAE;IACrG,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAW,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAClE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,GAAG,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC;AAEH;;;;;;GAMG;AACU,QAAA,OAAO,GAAgC,IAAI,6BAAa,CAAmB,CAAC,IAAa,EAAE,EAAE;IACxG,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,IAAA,cAAO,EAAC,IAAe,CAAC,CAAC;IAClC,CAAC;SAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpC,QAAQ,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YAC3B,KAAK,MAAM;gBACT,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;YACvB,KAAK,OAAO;gBACV,OAAO,IAAA,cAAO,EAAC,KAAK,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IACD,OAAO,IAAA,WAAI,EAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,cAAc,GAA2C,cAAM,CAAC,QAAQ,EAAE,CAAC;AAExF;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,SAAiB,EACjB,UAA8B,UAAU;IAExC,OAAO,IAAI,6BAAa,CACtB,CAAC,IAAa,EAAE,MAAmC,EAAE,OAAgB,EAAE,EAAE;QACvE,MAAM,MAAM,GAAG,cAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACvB,IAAI,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,SAAS,CAAC,CAAC;YACvD,IAAI,OAAO,KAAK,KAAK,EAAE,CAAC;gBACtB,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACvD,CAAC;YACD,OAAO,IAAA,cAAO,EAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,SAAS,CAAkB,SAA2B;IACpE,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;QAClF,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAgB,OAAO,CAAkB,OAA6B;IACpE,OAAO,IAAI,6BAAa,CAAC,OAAO,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,GAAG,CACjB,WAAmB,EACnB,KAAkC;IAElC,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;QAClF,IAAI,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;YACzB,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,WAAW,WAAW,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACU,QAAA,cAAc,GAA2C,cAAM,CAAC,QAAQ,EAAE,CAAC;AAExF;;;;;;;GAOG;AACU,QAAA,eAAe,GAA4C,eAAO,CAAC,QAAQ,EAAE,CAAC;AAE3F;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,KAAK,CACnB,UAAsD,EACtD,UAAmB,cAAc;IAEjC,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAM,EAAE,OAAY,EAAE,EAAE;QAC/D,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAChD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACrD,OAAO,MAAM,CAAC;YAChB,CAAC;YAED,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvB,IAAI,OAAO,KAAK,aAAa,EAAE,CAAC;oBAC9B,OAAO,MAAM,CAAC;gBAChB,CAAC;gBACD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,6BAA6B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,OAAO,CACrB,SAA8C,EAC9C,UAAmB,aAAa;IAEhC,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAA0B,EAAE,OAAY,EAAE,EAAE;QACnF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,OAAO,IAAA,WAAI,EAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvD,CAAC;QAED,MAAM,SAAS,GAAQ,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAChD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACrD,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC/B,CAAC;iBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,KAAK,cAAc,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1G,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACU,QAAA,WAAW,GAAiC,OAAO,CAAC,cAAM,CAAC,CAAC;AAEzE;;;;;;GAMG;AACU,QAAA,WAAW,GAAiC,OAAO,CAAC,cAAM,CAAC,CAAC;AA6EzE;;;;;GAKG;AACH,SAAgB,QAAQ,CACtB,SAA8C,EAC9C,SAA4D,MAAM;IAElE,MAAM,OAAO,GACX,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,iBAAG,OAAO,EAAE,MAAM,IAAK,MAAM,CAAE,CAAC;IACpF,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAoC,EAAE,OAAY,EAAE,EAAE;;QAC7F,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACrE,OAAO,IAAA,WAAI,EAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,IAAA,cAAO,EAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,cAAc,GAAG,MAAA,MAAA,OAAO,CAAC,YAAY,0CAAE,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,mCAAI,IAAA,cAAO,EAAC,GAAG,CAAC,CAAC;gBAEnF,cAAc;qBACX,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;oBACtB,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAY,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;wBAC1E,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;wBACzB,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;oBACvB,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC;qBACD,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBACrB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBACrB,OAAO,IAAA,WAAI,EAAC,OAAO,CAAC,CAAC;gBACvB,CAAC,CAAC,CAAC;YACP,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACzG,CAAC,CAAC,CAAC;AACL,CAAC;AAwDD;;;;;GAKG;AACH,SAAgB,KAAK,CACnB,SAA8C,EAC9C,SAA4D,MAAM;IAElE,MAAM,OAAO,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,iBAAG,OAAO,EAAE,MAAM,IAAK,MAAM,CAAE,CAAC;IAClG,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAiC,EAAE,OAAY,EAAE,EAAE;;QAC1F,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACrE,OAAO,IAAA,WAAI,EAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,GAAG,EAAS,CAAC;QAC7B,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,IAAA,cAAO,EAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,cAAc,GAAG,MAAA,MAAA,OAAO,CAAC,YAAY,0CAAE,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,mCAAI,IAAA,cAAO,EAAC,GAAG,CAAC,CAAC;gBAEnF,cAAc;qBACX,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;oBACtB,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAY,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;wBAC1E,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;wBACzB,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;oBACvB,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC;qBACD,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBACrB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBACrB,OAAO,IAAA,WAAI,EAAC,OAAO,CAAC,CAAC;gBACvB,CAAC,CAAC,CAAC;YACP,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACtG,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,YAAY,CAC1B,SAAuC,EACvC,WAAoB;IAEpB,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAwB,EAAE,SAAc,EAAE,EAAE;QACnF,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACpB,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,OAAO,CACrB,KAAa,EACb,SAA8C;IAE9C,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAwB,EAAE,OAAY,EAAE,EAAE;QACjF,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,OAAO,IAAA,WAAI,EAAC,GAAG,KAAK,+CAA+C,CAAC,CAAC;QACvE,CAAC;aAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,OAAO,IAAA,WAAI,EAAC,2CAA2C,CAAC,CAAC;QAC3D,CAAC;aAAM,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,OAAO,IAAA,WAAI,EAAC,GAAG,KAAK,8CAA8C,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;QACxF,CAAC;QACD,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,eAAe,CAC7B,KAAa,EACb,SAA8C;IAE9C,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAoC,EAAE,OAAY,EAAE,EAAE;QAC7F,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,OAAO,IAAA,WAAI,EAAC,GAAG,KAAK,+CAA+C,CAAC,CAAC;QACvE,CAAC;aAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,OAAO,IAAA,WAAI,EAAC,2CAA2C,CAAC,CAAC;QAC3D,CAAC;aAAM,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,OAAO,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,KAAK,CACnB,IAAY,EACZ,SAA8C;IAE9C,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAwB,EAAE,OAAY,EAAE,EAAE;QACjF,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACtE,IAAI,IAAA,cAAO,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;gBACxB,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBAClE,OAAO,IAAA,WAAI,EAAC,SAAS,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;gBAC3C,CAAC,CAAC,CAAC;YACL,CAAC;YACD,OAAO,IAAA,WAAI,EAAC,SAAS,IAAI,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,yBAAyB,IAAI,qBAAqB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,aAAa,CAC3B,IAAY,EACZ,SAA8C;IAE9C,OAAO,IAAI,6BAAa,CACtB,CAAC,IAAa,EAAE,MAAoC,EAAE,OAAY,EAAE,EAAE;QACpE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACtE,IAAI,IAAA,cAAO,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;gBACxB,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBAC1E,OAAO,IAAA,WAAI,EAAC,GAAG,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;gBACrC,CAAC,CAAC,CAAC;gBAEH,yDAAyD;gBACzD,oDAAoD;gBACpD,YAAY;gBACZ,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;oBACnD,OAAO,MAAM,CAAC;gBAChB,CAAC;YACH,CAAC;YACD,OAAO,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,yBAAyB,IAAI,qBAAqB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxF,CAAC,EACD,SAAS,EACT,EAAE,UAAU,EAAE,IAAI,EAAE,CACrB,CAAC;AACJ,CAAC;AAoDD;;;;GAIG;AACH,SAAgB,MAAM,CACpB,UAAkC,EAClC,OAAiD;IAEjD,OAAO,IAAI,iCAAe,CAAC,UAAU,EAAE,OAAoC,CAAC,CAAC;AAC/E,CAAC;AAuDD;;;;GAIG;AACH,SAAgB,YAAY,CAC1B,UAAkC,EAClC,GAAmD;IAEnD,sBAAsB;IACtB,MAAM,OAAO,GACX,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC,iCAAM,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,CAAC,KAAE,MAAM,EAAE,IAAI,GAAE,CAAC;IACvG,OAAO,IAAI,iCAAe,CAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;AACzD,CAAC;AAYD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,mBAAmB,CACjC,iBAAyB,EACzB,UAAgD;IAEhD,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,EAAE;QACzC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACrE,OAAO,IAAA,WAAI,EAAC,gCAAgC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,CAAC,IAAA,cAAO,EAAC,iBAAiB,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAClE,OAAO,IAAA,WAAI,EAAC,0BAA0B,iBAAiB,oBAAoB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtG,CAAC;QAED,MAAM,kBAAkB,GAAG,IAAI,CAAC,iBAAiB,CAAO,CAAC;QACzD,MAAM,SAAS,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;QACjD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,IAAA,WAAI,EAAC,kCAAkC,iBAAiB,KAAK,kBAAkB,GAAG,CAAC,CAAC;QAC7F,CAAC;QACD,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,SAAS,CAAkB,UAAkC;IAC3E,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAM,EAAE,OAAY,EAAE,EAAE;QAC/D,+CAA+C;QAC/C,gDAAgD;QAChD,MAAM,SAAS,GAAG,EAAkC,CAAC;QACrD,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAC7B,IAAI,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACpB,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBACtD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBACrD,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;gBAChC,CAAC;qBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;oBAC9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC;AAiDD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,eAAe,CAC7B,iBAAqD,EACrD,OAAsC;IAEtC,OAAO,IAAI,6BAAa,CAAC,CAAC,IAAa,EAAE,MAAM,EAAE,OAAY,EAAE,EAAE;QAC/D,+CAA+C;QAC/C,gDAAgD;QAChD,MAAM,SAAS,GAAG,EAA0C,CAAC;QAC7D,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAoB,IAAI,GAAG,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC,CAAC;QAEvD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACtE,KAAK,MAAM,cAAc,IAAI,iBAAiB,EAAE,CAAC;gBAC/C,IAAI,iBAAiB,CAAC,cAAc,CAAC,EAAE,CAAC;oBACtC,MAAM,MAAM,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC;oBACtD,MAAM,SAAS,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC;oBAE9D,IAAI,IAAA,cAAO,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;wBAC1B,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;wBACxD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;4BACrD,SAAS,CAAC,cAAc,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;wBAC3C,CAAC;6BAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;4BAC9B,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,KAAK,cAAc,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;wBACjE,CAAC;wBACD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;oBACnB,CAAC;yBAAM,IAAI,iBAAiB,CAAC,cAAc,CAAC,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;wBAC/D,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,+CAA+C,CAAC,CAAC;oBAChF,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,MAAK,IAAI,EAAE,CAAC;gBAC7B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oBACvB,IAAI,IAAA,cAAO,EAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAiB,CAAC,EAAE,CAAC;wBACvD,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,wCAAwC,CAAC,CAAC;oBAC9D,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QACzC,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC;YACxB,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC;YACpB,CAAC,CAAC,IAAA,WAAI,EAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,EAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,QAAQ,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3G,CAAC,CAAC,CAAC;AACL,CAAC","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 { Result, fail, isKeyOf, succeed } from '../base';\nimport { TypeGuardWithContext, Validator } from '../validation';\nimport { BaseConverter, ConverterFunc } from './baseConverter';\nimport { Converter, OnError } from './converter';\nimport { FieldConverters, ObjectConverter, ObjectConverterOptions } from './objectConverter';\nimport { StringConverter } from './stringConverter';\n\n/**\n * Action to take on conversion failures (deprecated - use Conversion.OnError)\n * @public\n * @deprecated use Conversion.OnError.\n */\nexport { OnError };\n\n/**\n * A converter to convert unknown to string. Values of type\n * string succeed. Anything else fails.\n * @public\n */\nexport const string: StringConverter = new StringConverter();\n\n/**\n * Helper function to create a {@link Converter | Converter} which converts `unknown` to one of a set of supplied\n * enumerated values. Anything else fails.\n *\n * @remarks\n * Allowed enumerated values can also be supplied as context at conversion time.\n * @param values - Array of allowed values.\n * @returns A new {@link Converter | Converter} returning `<T>`.\n * @public\n */\nexport function enumeratedValue<T>(values: T[]): Converter<T, T[]> {\n return new BaseConverter((from: unknown, __self: Converter<T, T[]>, context?: T[]): Result<T> => {\n const v = context ?? values;\n const index = v.indexOf(from as T);\n return index >= 0 ? succeed(v[index]) : fail(`Invalid enumerated value ${JSON.stringify(from)}`);\n });\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} which converts `unknown` to one of a set of supplied enumerated\n * values, mapping any of multiple supplied values to the enumeration.\n * @remarks\n * Enables mapping of multiple input values to a consistent internal representation (so e.g. `'y'`, `'yes'`,\n * `'true'`, `1` and `true` can all map to boolean `true`)\n * @param map - An array of tuples describing the mapping. The first element of each tuple is the result\n * value, the second is the set of values that map to the result. Tuples are evaluated in the order\n * supplied and are not checked for duplicates.\n * @param message - An optional error message.\n * @returns A {@link Converter | Converter} which applies the mapping and yields `<T>` on success.\n * @public\n */\nexport function mappedEnumeratedValue<T, TC = unknown>(\n map: [T, unknown[]][],\n message?: string\n): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self: Converter<T, TC>, __context?: TC) => {\n for (const item of map) {\n if (item[1].includes(from)) {\n return succeed(item[0]);\n }\n }\n return fail(\n message\n ? `${JSON.stringify(from)}: ${message}`\n : `Cannot map '${JSON.stringify(from)}' to a supported value`\n );\n });\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} which converts `unknown` to some supplied literal value. Succeeds with\n * the supplied value if an identity comparison succeeds, fails otherwise.\n * @param value - The value to be compared.\n * @returns A {@link Converter | Converter} which returns the supplied value on success.\n * @public\n */\nexport function literal<T, TC = unknown>(value: T): Converter<T, TC> {\n return new BaseConverter<T, TC>(\n (from: unknown, __self: Converter<T, TC>, __context?: unknown): Result<T> => {\n return from === value\n ? succeed(value)\n : fail(`${JSON.stringify(from)}: does not match ${JSON.stringify(value)}`);\n }\n );\n}\n\n/**\n * Deprecated alias for @see literal\n * @param value - The value to be compared.\n * @deprecated Use {@link Converters.literal} instead.\n * @internal\n */\n// eslint-disable-next-line @rushstack/typedef-var\nexport const value = literal;\n\n/**\n * A {@link Converter | Converter} which converts `unknown` to a `number`.\n * @remarks\n * Numbers and strings with a numeric format succeed. Anything else fails.\n * @public\n */\nexport const number: Converter<number, unknown> = new BaseConverter<number, unknown>((from: unknown) => {\n if (typeof from !== 'number') {\n const num: number = typeof from === 'string' ? Number(from) : NaN;\n return isNaN(num) ? fail(`Not a number: ${JSON.stringify(from)}`) : succeed(num);\n }\n return succeed(from);\n});\n\n/**\n * A {@link Converter | Converter} which converts `unknown` to `boolean`.\n * @remarks\n * Boolean values or the case-insensitive strings `'true'` and `'false'` succeed.\n * Anything else fails.\n * @public\n */\nexport const boolean: Converter<boolean, unknown> = new BaseConverter<boolean, unknown>((from: unknown) => {\n if (typeof from === 'boolean') {\n return succeed(from as boolean);\n } else if (typeof from === 'string') {\n switch (from.toLowerCase()) {\n case 'true':\n return succeed(true);\n case 'false':\n return succeed(false);\n }\n }\n return fail(`Not a boolean: ${JSON.stringify(from)}`);\n});\n\n/**\n * A {@link Converter | Converter} which converts an optional `string` value. Values of type\n * `string` are returned. Anything else returns {@link Success | Success} with value `undefined`.\n * @public\n */\nexport const optionalString: Converter<string | undefined, unknown> = string.optional();\n\n/**\n * Helper function to create a {@link Converter | Converter} which converts any `string` into an\n * array of `string`, by separating at a supplied delimiter.\n * @remarks\n * Delimiter may also be supplied as context at conversion time.\n * @param delimiter - The delimiter at which to split.\n * @returns A new {@link Converter | Converter} returning `string[]`.\n * @public\n */\nexport function delimitedString(\n delimiter: string,\n options: 'filtered' | 'all' = 'filtered'\n): Converter<string[], string> {\n return new BaseConverter<string[], string>(\n (from: unknown, __self: Converter<string[], string>, context?: string) => {\n const result = string.convert(from);\n if (result.isSuccess()) {\n let strings = result.value.split(context ?? delimiter);\n if (options !== 'all') {\n strings = strings.filter((s) => s.trim().length > 0);\n }\n return succeed(strings);\n }\n return fail(result.message);\n }\n );\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} from any {@link Validation.Validator}\n * @param validator - the validator to be wrapped\n * @returns A {@link Converter | Converter} which uses the supplied validator.\n * @public\n */\nexport function validated<T, TC = unknown>(validator: Validator<T, TC>): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self?: Converter<T, TC>, context?: TC) => {\n return validator.validate(from, context);\n });\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} from a supplied {@link Conversion.ConverterFunc | ConverterFunc}.\n * @param convert - the function to be wrapped\n * @returns A {@link Converter | Converter} which uses the supplied function.\n * @public\n */\nexport function generic<T, TC = unknown>(convert: ConverterFunc<T, TC>): Converter<T, TC> {\n return new BaseConverter(convert);\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} from a supplied type guard function.\n * @param description - a description of the thing to be validated for use in error messages\n * @param guard - a {@link Validation.TypeGuardWithContext} which performs the validation.\n * @returns A new {@link Converter | Converter} which validates the values using the supplied type guard\n * and returns them in place.\n * @public\n */\nexport function isA<T, TC = unknown>(\n description: string,\n guard: TypeGuardWithContext<T, TC>\n): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self?: Converter<T, TC>, context?: TC) => {\n if (guard(from, context)) {\n return succeed(from);\n }\n return fail(`invalid ${description} (${JSON.stringify(from)})`);\n });\n}\n\n/**\n * A {@link Converter | Converter} which converts an optional `number` value.\n * @remarks\n * Values of type `number` or numeric strings are converted and returned.\n * Anything else returns {@link Success | Success} with value `undefined`.\n * @public\n */\nexport const optionalNumber: Converter<number | undefined, unknown> = number.optional();\n\n/**\n * A {@link Converter | Converter} to convert an optional `boolean` value.\n * @remarks\n * Values of type `boolean` or strings that match (case-insensitive) `'true'`\n * or `'false'` are converted and returned. Anything else returns {@link Success | Success}\n * with value `undefined`.\n * @public\n */\nexport const optionalBoolean: Converter<boolean | undefined, unknown> = boolean.optional();\n\n/**\n * A helper function to create a {@link Converter | Converter} for polymorphic values.\n * Returns a converter which invokes the wrapped converters in sequence, returning the\n * first successful result. Returns an error if none of the supplied converters can\n * convert the value.\n * @remarks\n * If `onError` is `ignoreErrors` (default), then errors from any of the\n * converters are ignored provided that some converter succeeds. If\n * onError is `failOnError`, then an error from any converter fails the entire\n * conversion.\n *\n * @param converters - An ordered list of {@link Converter | converters} or {@link Validator | validators}\n * to be considered.\n * @param onError - Specifies treatment of unconvertible elements.\n * @returns A new {@link Converter | Converter} which yields a value from the union of the types returned\n * by the wrapped converters.\n * @public\n */\nexport function oneOf<T, TC = unknown>(\n converters: Array<Converter<T, TC> | Validator<T, TC>>,\n onError: OnError = 'ignoreErrors'\n): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self, context?: TC) => {\n const errors: string[] = [];\n for (const converter of converters) {\n const result = converter.convert(from, context);\n if (result.isSuccess() && result.value !== undefined) {\n return result;\n }\n\n if (result.isFailure()) {\n if (onError === 'failOnError') {\n return result;\n }\n errors.push(result.message);\n }\n }\n return fail(`No matching converter for ${JSON.stringify(from)}: ${errors.join('\\n')}`);\n });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts `unknown` to an array of `<T>`.\n * @remarks\n * If `onError` is `'failOnError'` (default), then the entire conversion fails if any element cannot\n * be converted. If `onError` is `'ignoreErrors'`, then failing elements are silently ignored.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used to convert each\n * item in the array.\n * @param ignoreErrors - Specifies treatment of unconvertible elements.\n * @returns A {@link Converter | Converter} which returns an array of `<T>`.\n * @public\n */\nexport function arrayOf<T, TC = unknown>(\n converter: Converter<T, TC> | Validator<T, TC>,\n onError: OnError = 'failOnError'\n): Converter<T[], TC> {\n return new BaseConverter((from: unknown, __self: Converter<T[], TC>, context?: TC) => {\n if (!Array.isArray(from)) {\n return fail(`Not an array: ${JSON.stringify(from)}`);\n }\n\n const successes: T[] = [];\n const errors: string[] = [];\n for (const item of from) {\n const result = converter.convert(item, context);\n if (result.isSuccess() && result.value !== undefined) {\n successes.push(result.value);\n } else if (result.isFailure()) {\n errors.push(result.message);\n }\n }\n\n return errors.length === 0 || onError === 'ignoreErrors' ? succeed(successes) : fail(errors.join('\\n'));\n });\n}\n\n/**\n * {@link Converter | Converter} to convert an `unknown` to an array of `string`.\n * @remarks\n * Returns {@link Success | Success} with the the supplied value if it as an array\n * of strings, returns {@link Failure | Failure} with an error message otherwise.\n * @public\n */\nexport const stringArray: Converter<string[], unknown> = arrayOf(string);\n\n/**\n * {@link Converter | Converter} to convert an `unknown` to an array of `number`.\n * @remarks\n * Returns {@link Success | Success} with the the supplied value if it as an array\n * of numbers, returns {@link Failure | Failure} with an error message otherwise.\n * @public\n */\nexport const numberArray: Converter<number[], unknown> = arrayOf(number);\n\n/**\n * Options for {@link Converters.(recordOf:3) | Converters.recordOf} and\n * {@link Converters.(mapOf:3) | Converters.mapOf}\n * helper functions.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface KeyedConverterOptions<T extends string = string, TC = unknown> {\n /**\n * if `onError` is `'fail'` (default), then the entire conversion fails if any key or element\n * cannot be converted. If `onError` is `'ignore'`, failing elements are silently ignored.\n */\n onError?: 'fail' | 'ignore';\n /**\n * If present, `keyConverter` is used to convert the source object property names to\n * keys in the resulting map or record.\n * @remarks\n * Can be used to coerce key names to supported values and/or strong types.\n */\n keyConverter?: Converter<T, TC> | Validator<T, TC>;\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed\n * properties using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to\n * produce a `Record<string, T>`.\n * @remarks\n * The resulting converter fails conversion if any element cannot be converted.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used for each\n * item in the source object.\n * @returns A {@link Converter | Converter} which returns `Record<string, T>`.\n * {@label WITH_DEFAULT}\n * @public\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>\n): Converter<Record<TK, T>, TC>;\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce a\n * `Record<string, T>` and optionally specified handling of elements that cannot be converted.\n * @remarks\n * if `onError` is `'fail'` (default), then the entire conversion fails if any key or element\n * cannot be converted. If `onError` is `'ignore'`, failing elements are silently ignored.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} for each item in\n * the source object.\n * @returns A {@link Converter | Converter} which returns `Record<string, T>`.\n * {@label WITH_ON_ERROR}\n * @public\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>,\n onError: 'fail' | 'ignore'\n): Converter<Record<TK, T>, TC>;\n\n/**\n * A helper function to create a {@link Converter | Converter} or which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce a\n * `Record<TK, T>`.\n * @remarks\n * If present, the supplied {@link Converters.KeyedConverterOptions | options} can provide a strongly-typed\n * converter for keys and/or control the handling of elements that fail conversion.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used for each item in the source object.\n * @param options - Optional {@link Converters.KeyedConverterOptions | KeyedConverterOptions<TK, TC>} which\n * supplies a key converter and/or error-handling options.\n * @returns A {@link Converter | Converter} which returns `Record<TK, T>`.\n * {@label WITH_OPTIONS}\n * @public\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>,\n options: KeyedConverterOptions<TK, TC>\n): Converter<Record<TK, T>, TC>;\n\n/**\n * Concrete implementation of {@link Converters.(recordOf:1) | Converters.recordOf(Converter<T, TC>)},\n * {@link Converters.(recordOf:2) | Converters.recordOf(Converter<T, TC>, 'fail' or 'ignore')}, and\n * {@link Converters.(recordOf:3) | Converters.recordOf(Converter<T, TC>, KeyedConverterOptions)}.\n * @internal\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>,\n option: 'fail' | 'ignore' | KeyedConverterOptions<TK, TC> = 'fail'\n): Converter<Record<TK, T>, TC> {\n const options: KeyedConverterOptions<TK, TC> =\n typeof option === 'string' ? { onError: option } : { onError: 'fail', ...option };\n return new BaseConverter((from: unknown, __self: Converter<Record<TK, T>, TC>, context?: TC) => {\n if (typeof from !== 'object' || from === null || Array.isArray(from)) {\n return fail(`Not a string-keyed object: ${JSON.stringify(from)}`);\n }\n\n const record: Record<string, T> = {};\n const errors: string[] = [];\n\n for (const key in from) {\n if (isKeyOf(key, from)) {\n const writeKeyResult = options.keyConverter?.convert(key, context) ?? succeed(key);\n\n writeKeyResult\n .onSuccess((writeKey) => {\n return converter.convert(from[key] as unknown, context).onSuccess((value) => {\n record[writeKey] = value;\n return succeed(true);\n });\n })\n .onFailure((message) => {\n errors.push(message);\n return fail(message);\n });\n }\n }\n\n return errors.length === 0 || options.onError === 'ignore' ? succeed(record) : fail(errors.join('\\n'));\n });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce a\n * `Map<string, T>`.\n * @remarks\n * The resulting converter fails conversion if any element cannot be converted.\n * @param converter - {@link Converter | Converter} | {@link Validator | Validator} used for each item in\n * the source object.\n * @returns A {@link Converter | Converter} which returns `Map<string, T>`.\n * {@label WITH_DEFAULT}\n * @public\n */\nexport function mapOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>\n): Converter<Map<TK, T>, TC>;\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce a\n * `Map<string, T>` and specified handling of elements that cannot be converted.\n * @remarks\n * if `onError` is `'fail'` (default), then the entire conversion fails if any key or element\n * cannot be converted. If `onError` is `'ignore'`, failing elements are silently ignored.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used for\n * each item in the source object.\n * @returns A {@link Converter | Converter} which returns `Map<string, T>`.\n * {@label WITH_ON_ERROR}\n * @public\n */\nexport function mapOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>,\n onError: 'fail' | 'ignore'\n): Converter<Map<TK, T>, TC>;\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce\n * a `Map<TK,T>`.\n * @remarks\n * If present, the supplied {@link Converters.KeyedConverterOptions | options} can provide a strongly-typed\n * converter for keys and/or control the handling of elements that fail conversion.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used for each item\n * in the source object.\n * @param options - Optional {@link Converters.KeyedConverterOptions | KeyedConverterOptions<TK, TC>} which\n * supplies a key converter and/or error-handling options.\n * @returns A {@link Converter | Converter} which returns `Map<TK,T>`.\n * {@label WITH_OPTIONS}\n * @public\n */\nexport function mapOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>,\n options: KeyedConverterOptions<TK, TC>\n): Converter<Map<TK, T>, TC>;\n\n/**\n * Concrete implementation of {@link Converters.(mapOf:1) | Converters.mapOf(Converter<T, TC>)},\n * {@link Converters.(mapOf:2) | Converters.mapOf(Converter<T, TC>, 'fail' or 'ignore')}, and\n * {@link Converters.(mapOf:3) | Converters.mapOf(Converter<T, TC>, KeyedConverterOptions)}.\n * @internal\n */\nexport function mapOf<T, TC = unknown, TK extends string = string>(\n converter: Converter<T, TC> | Validator<T, TC>,\n option: 'fail' | 'ignore' | KeyedConverterOptions<TK, TC> = 'fail'\n): Converter<Map<TK, T>, TC> {\n const options = typeof option === 'string' ? { onError: option } : { onError: 'fail', ...option };\n return new BaseConverter((from: unknown, __self: Converter<Map<TK, T>, TC>, context?: TC) => {\n if (typeof from !== 'object' || from === null || Array.isArray(from)) {\n return fail(`Not a string-keyed object: ${JSON.stringify(from)}`);\n }\n\n const map = new Map<TK, T>();\n const errors: string[] = [];\n\n for (const key in from) {\n if (isKeyOf(key, from)) {\n const writeKeyResult = options.keyConverter?.convert(key, context) ?? succeed(key);\n\n writeKeyResult\n .onSuccess((writeKey) => {\n return converter.convert(from[key] as unknown, context).onSuccess((value) => {\n map.set(writeKey, value);\n return succeed(true);\n });\n })\n .onFailure((message) => {\n errors.push(message);\n return fail(message);\n });\n }\n }\n\n return errors.length === 0 || options.onError === 'ignore' ? succeed(map) : fail(errors.join('\\n'));\n });\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} which validates that a supplied value is\n * of a type validated by a supplied validator function and returns it.\n * @remarks\n * If `validator` succeeds, this {@link Converter | Converter} returns {@link Success | Success} with the supplied\n * value of `from` coerced to type `<T>`. Returns a {@link Failure | Failure} with additional\n * information otherwise.\n * @param validator - A validator function to determine if the converted value is valid.\n * @param description - A description of the validated type for use in error messages.\n * @returns A new {@link Converter | Converter<T, TC>} which applies the supplied validation.\n * @public\n */\nexport function validateWith<T, TC = unknown>(\n validator: (from: unknown) => from is T,\n description?: string\n): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self: Converter<T, TC>, __context?: TC) => {\n if (validator(from)) {\n return succeed(from);\n }\n return fail(`${JSON.stringify(from)}: invalid ${description ?? 'value'}`);\n });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which extracts and converts an element from an array.\n * @remarks\n * The returned {@link Converter | Converter} returns {@link Success | Success} with the converted value if the element exists\n * in the supplied array and can be converted. Returns {@link Failure | Failure} with an error message otherwise.\n * @param index - The index of the element to be extracted.\n * @param converter - A {@link Converter | Converter} or {@link Validator | Validator} for the extracted element.\n * @returns A {@link Converter | Converter<T, TC>} which extracts the specified element from an array.\n * @public\n */\nexport function element<T, TC = unknown>(\n index: number,\n converter: Converter<T, TC> | Validator<T, TC>\n): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self: Converter<T, TC>, context?: TC) => {\n if (index < 0) {\n return fail(`${index}: cannot convert for a negative element index`);\n } else if (!Array.isArray(from)) {\n return fail('element converter: source is not an array');\n } else if (index >= from.length) {\n return fail(`${index}: element converter index out of range (0..${from.length - 1})`);\n }\n return converter.convert(from[index], context);\n });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which extracts and converts an optional element from an array.\n * @remarks\n * The resulting {@link Converter | Converter} returns {@link Success | Success} with the converted value if the element exists\n * in the supplied array and can be converted. Returns {@link Success | Success} with value `undefined` if the parameter\n * is an array but the index is out of range. Returns {@link Failure | Failure} with a message if the supplied parameter\n * is not an array, if the requested index is negative, or if the element cannot be converted.\n * @param index - The index of the element to be extracted.\n * @param converter - A {@link Converter | Converter} or {@link Validator | Validator} used for the extracted element.\n * @returns A {@link Converter | Converter<T, TC>} which extracts the specified element from an array.\n * @public\n */\nexport function optionalElement<T, TC = unknown>(\n index: number,\n converter: Converter<T, TC> | Validator<T, TC>\n): Converter<T | undefined, TC> {\n return new BaseConverter((from: unknown, __self: Converter<T | undefined, TC>, context?: TC) => {\n if (index < 0) {\n return fail(`${index}: cannot convert for a negative element index`);\n } else if (!Array.isArray(from)) {\n return fail('element converter: source is not an array');\n } else if (index >= from.length) {\n return succeed(undefined);\n }\n return converter.convert(from[index], context);\n });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which extracts and convert a property specified\n * by name from an object.\n * @remarks\n * The resulting {@link Converter | Converter} returns {@link Success | Success} with the converted value of the corresponding\n * object property if the field exists and can be converted. Returns {@link Failure | Failure} with an error message\n * otherwise.\n * @param name - The name of the field to be extracted.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} to use for the extracted\n * field.\n * @public\n */\nexport function field<T, TC = unknown>(\n name: string,\n converter: Converter<T, TC> | Validator<T, TC>\n): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self: Converter<T, TC>, context?: TC) => {\n if (typeof from === 'object' && !Array.isArray(from) && from !== null) {\n if (isKeyOf(name, from)) {\n return converter.convert(from[name], context).onFailure((message) => {\n return fail(`Field ${name}: ${message}`);\n });\n }\n return fail(`Field ${name} not found in: ${JSON.stringify(from)}`);\n }\n return fail(`Cannot convert field \"${name}\" from non-object ${JSON.stringify(from)}`);\n });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which extracts and convert a property specified\n * by name from an object.\n * @remarks\n * The resulting {@link Converter | Converter} returns {@link Success | Success} with the converted value of\n * the corresponding object property if the field exists and can be converted. Returns {@link Success | Success}\n * with `undefined` if the supplied parameter is an object but the named field is not present.\n * Returns {@link Failure | Failure} with an error message otherwise.\n * @param name - The name of the field to be extracted.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} to use for the extracted field.\n * @public\n */\nexport function optionalField<T, TC = unknown>(\n name: string,\n converter: Converter<T, TC> | Validator<T, TC>\n): Converter<T | undefined, TC> {\n return new BaseConverter(\n (from: unknown, __self: Converter<T | undefined, TC>, context?: TC) => {\n if (typeof from === 'object' && !Array.isArray(from) && from !== null) {\n if (isKeyOf(name, from)) {\n const result = converter.convert(from[name], context).onFailure((message) => {\n return fail(`${name}: ${message}`);\n });\n\n // if conversion was successful or input was undefined we\n // succeed with 'undefined', but we propagate actual\n // failures.\n if (result.isSuccess() || from[name] !== undefined) {\n return result;\n }\n }\n return succeed(undefined);\n }\n return fail(`Cannot convert field \"${name}\" from non-object ${JSON.stringify(from)}`);\n },\n undefined,\n { isOptional: true }\n );\n}\n\n/**\n * Helper function to create a {@link Conversion.ObjectConverter | ObjectConverter<T, TC>} which converts an object\n * without changing shape, given a {@link Conversion.FieldConverters | FieldConverters<T, TC>} and an optional\n * {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>} to further refine conversion behavior.\n * @remarks\n * By default, if all of the requested fields exist and can be converted, returns {@link Success | Success}\n * with a new object that contains the converted values under the original key names. If any required properties\n * do not exist or cannot be converted, the entire conversion fails, returning {@link Failure | Failure} with additional\n * error information.\n *\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n * @param properties - An {@link Conversion.FieldConverters | FieldConverters<T, TC>} defining the shape of the\n * source object and {@link Converter | converters} to be applied to each properties.\n * @param options - An {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>} containing options\n * for the object converter.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} which applies the specified conversions.\n * {@label WITH_OPTIONS}\n * @public\n */\nexport function object<T, TC = unknown>(\n properties: FieldConverters<T, TC>,\n options?: ObjectConverterOptions<T>\n): ObjectConverter<T, TC>;\n\n/**\n * Helper function to create a {@link Conversion.ObjectConverter | ObjectConverter<T, TC>} which converts an object\n * without changing shape, given a {@link Conversion.FieldConverters | FieldConverters<T, TC>} and a set of\n * optional properties.\n * @remarks\n * By default, if all of the requested fields exist and can be converted, returns {@link Success | Success}\n * with a new object that contains the converted values under the original key names. If any required properties\n * do not exist or cannot be converted, the entire conversion fails, returning {@link Failure | Failure} with additional\n * error information.\n *\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n * @param properties - An {@link Conversion.FieldConverters | FieldConverters<T, TC>} defining the shape of the\n * source object and {@link Converter | converters} to be applied to each properties.\n * @param optional - An array of `(keyof T)` listing the keys to be considered optional.\n * {@label WITH_KEYS}\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} which applies the specified conversions.\n * @public\n * @deprecated Use {@link Converters.(object:1) | Converters.object(fields, options)} instead.\n */\n\nexport function object<T, TC = unknown>(\n properties: FieldConverters<T, TC>,\n optional: (keyof T)[]\n): ObjectConverter<T, TC>;\n/**\n * Concrete implementation of {@link Converters.(object:1) | Converters.object(fields, options)}\n * and {@link Converters.(object:2) | Converters.objects(fields, optionalKeys)}.\n * @internal\n */\nexport function object<T, TC>(\n properties: FieldConverters<T, TC>,\n options?: (keyof T)[] | ObjectConverterOptions<T>\n): ObjectConverter<T, TC> {\n return new ObjectConverter(properties, options as ObjectConverterOptions<T>);\n}\n\n/**\n * Options for the {@link Converters.(strictObject:1)} helper function.\n * @public\n */\nexport type StrictObjectConverterOptions<T> = Omit<ObjectConverterOptions<T>, 'strict'>;\n\n/**\n * Helper function to create a {@link Conversion.ObjectConverter | ObjectConverter} which converts an object\n * without changing shape, a {@link Conversion.FieldConverters | FieldConverters<T, TC>} and an optional\n * {@link Converters.StrictObjectConverterOptions | StrictObjectConverterOptions<T>} to further refine\n * conversion behavior.\n *\n * @remarks\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n *\n * The conversion fails if any unexpected fields are encountered.\n *\n * @param properties - An object containing defining the shape and converters to be applied.\n * @param options - An optional @see StrictObjectConverterOptions<T> containing options for the object converter.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} which applies the specified conversions.\n * {@label WITH_OPTIONS}\n * @public\n */\nexport function strictObject<T, TC = unknown>(\n properties: FieldConverters<T, TC>,\n options?: StrictObjectConverterOptions<T>\n): ObjectConverter<T, TC>;\n\n/**\n * Helper function to create a {@link Conversion.ObjectConverter | ObjectConverter} which converts an object\n * without changing shape, a {@link Conversion.FieldConverters | FieldConverters<T, TC>} and an optional\n * {@link Converters.StrictObjectConverterOptions | StrictObjectConverterOptions<T>} to further refine\n * conversion behavior.\n *\n * @remarks\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n *\n * The conversion fails if any unexpected fields are encountered.\n *\n * @param properties - An object containing defining the shape and converters to be applied.\n * @param optional - An array of `keyof T` containing keys to be considered optional.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} which applies the specified conversions.\n * {@label WITH_KEYS}\n * @deprecated Use {@link Converters.(strictObject:1) | Converters.strictObject(options)} instead.\n * @public\n */\nexport function strictObject<T, TC = unknown>(\n properties: FieldConverters<T, TC>,\n optional: (keyof T)[]\n): ObjectConverter<T, TC>;\n\n/**\n * Concrete implementation for {@link Converters.(strictObject:1) | Converters.strictObject(fields, options)}\n * and {@link Converters.strictObject | Converters.strictObject(fields, optional)}.\n * @internal\n */\nexport function strictObject<T, TC = unknown>(\n properties: FieldConverters<T, TC>,\n opt?: (keyof T)[] | StrictObjectConverterOptions<T>\n): ObjectConverter<T, TC> {\n /* c8 ignore next 2 */\n const options: ObjectConverterOptions<T> =\n opt && Array.isArray(opt) ? { strict: true, optionalFields: opt } : { ...(opt ?? {}), strict: true };\n return new ObjectConverter<T, TC>(properties, options);\n}\n\n/**\n * A string-keyed `Record<string, Converter>` which maps specific {@link Converter | converters} or\n * {@link Validator | Validators} to the value of a discriminator property.\n * @public\n */\nexport type DiscriminatedObjectConverters<T, TD extends string = string, TC = unknown> = Record<\n TD,\n Converter<T, TC> | Validator<T, TC>\n>;\n\n/**\n * Helper to create a {@link Converter | Converter} which converts a discriminated object without changing shape.\n * @remarks\n * Takes the name of the discriminator property and a\n * {@link Converters.DiscriminatedObjectConverters | string-keyed Record of converters and validators}. During conversion,\n * the resulting {@link Converter | Converter} invokes the converter from `converters` that corresponds to the value of\n * the discriminator property in the source object.\n *\n * If the source is not an object, the discriminator property is missing, or the discriminator has\n * a value not present in the converters, conversion fails and returns {@link Failure | Failure} with more information.\n * @param discriminatorProp - Name of the property used to discriminate types.\n * @param converters - {@link Converters.DiscriminatedObjectConverters | String-keyed record of converters and validators}\n * to invoke, where each key corresponds to a value of the discriminator property.\n * @returns A {@link Converter | Converter} which converts the corresponding discriminated object.\n * @public\n */\nexport function discriminatedObject<T, TD extends string = string, TC = unknown>(\n discriminatorProp: string,\n converters: DiscriminatedObjectConverters<T, TD>\n): Converter<T, TC> {\n return new BaseConverter((from: unknown) => {\n if (typeof from !== 'object' || Array.isArray(from) || from === null) {\n return fail(`Not a discriminated object: \"${JSON.stringify(from)}\"`);\n }\n if (!isKeyOf(discriminatorProp, from) || !from[discriminatorProp]) {\n return fail(`Discriminator property ${discriminatorProp} not present in \"${JSON.stringify(from)}\"`);\n }\n\n const discriminatorValue = from[discriminatorProp] as TD;\n const converter = converters[discriminatorValue];\n if (converter === undefined) {\n return fail(`No converter for discriminator ${discriminatorProp}=\"${discriminatorValue}\"`);\n }\n return converter.convert(from);\n });\n}\n\n/**\n * Helper to create a {@link Converter | Converter} which converts a source object to a new object with a\n * different shape.\n *\n * @remarks\n * On successful conversion, the resulting {@link Converter | Converter} returns {@link Success | Success} with a new\n * object, which contains the converted values under the key names specified at initialization time.\n * It returns {@link Failure | Failure} with an error message if any fields to be extracted do not exist\n * or cannot be converted.\n *\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n *\n * @param properties - An object with key names that correspond to the target object and an\n * appropriate {@link Conversion.FieldConverters | FieldConverter} which extracts and converts\n * a single filed from the source object.\n * @returns A {@link Converter | Converter} with the specified conversion behavior.\n * @public\n */\nexport function transform<T, TC = unknown>(properties: FieldConverters<T, TC>): Converter<T, TC> {\n return new BaseConverter((from: unknown, __self, context?: TC) => {\n // eslint bug thinks key is used before defined\n // eslint-disable-next-line no-use-before-define\n const converted = {} as { [key in keyof T]: T[key] };\n const errors: string[] = [];\n\n for (const key in properties) {\n if (properties[key]) {\n const result = properties[key].convert(from, context);\n if (result.isSuccess() && result.value !== undefined) {\n converted[key] = result.value;\n } else if (result.isFailure()) {\n errors.push(result.message);\n }\n }\n }\n\n return errors.length === 0 ? succeed(converted) : fail(errors.join('\\n'));\n });\n}\n\n/**\n * Per-property converters and configuration for each field in the destination object of\n * a {@link Converters.transformObject} call.\n * @public\n */\nexport type FieldTransformers<TSRC, TDEST, TC = unknown> = {\n [key in keyof TDEST]: {\n /**\n * The name of the property in the source object to be converted.\n */\n from: keyof TSRC;\n /**\n * The converter or validator used to convert the property.\n */\n converter: Converter<TDEST[key], TC> | Validator<TDEST[key], TC>;\n /**\n * If `true` then a missing source property is ignored. If `false` or omitted\n * then a missing source property causes an error.\n */\n optional?: boolean;\n };\n};\n\n/**\n * Options for a {@link Converters.transformObject} call.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface TransformObjectOptions<TSRC> {\n /**\n * If `strict` is `true` then unused properties in the source object cause\n * an error, otherwise they are ignored.\n */\n strict: true;\n\n /**\n * An optional list of source properties to be ignored when strict mode\n * is enabled.\n */\n ignore?: (keyof TSRC)[];\n\n /**\n * An optional description of this transform to be used for error messages.\n */\n description?: string;\n}\n\n/**\n * Helper to create a strongly-typed {@link Converter | Converter} which converts a source object to a\n * new object with a different shape.\n *\n * @remarks\n * On successful conversion, the resulting {@link Converter | Converter} returns {@link Success | Success} with a new\n * object, which contains the converted values under the key names specified at initialization time.\n *\n * It returns {@link Failure | Failure} with an error message if any fields to be extracted do not exist\n * or cannot be converted.\n *\n * @param destinationFields - An object with key names that correspond to the target object and an\n * appropriate {@link Converters.FieldTransformers | FieldTransformers} which specifies the name\n * of the corresponding property in the source object, the converter or validator used for each source\n * property and any other configuration to guide the conversion.\n * @param options - Options which affect the transformation.\n *\n * @returns A {@link Converter | Converter} with the specified conversion behavior.\n * @public\n */\nexport function transformObject<TSRC, TDEST, TC = unknown>(\n destinationFields: FieldTransformers<TSRC, TDEST, TC>,\n options?: TransformObjectOptions<TSRC>\n): Converter<TDEST, TC> {\n return new BaseConverter((from: unknown, __self, context?: TC) => {\n // eslint bug thinks key is used before defined\n // eslint-disable-next-line no-use-before-define\n const converted = {} as { [key in keyof TDEST]: TDEST[key] };\n const errors: string[] = [];\n const used: Set<keyof TSRC> = new Set(options?.ignore);\n\n if (typeof from === 'object' && !Array.isArray(from) && from !== null) {\n for (const destinationKey in destinationFields) {\n if (destinationFields[destinationKey]) {\n const srcKey = destinationFields[destinationKey].from;\n const converter = destinationFields[destinationKey].converter;\n\n if (isKeyOf(srcKey, from)) {\n const result = converter.convert(from[srcKey], context);\n if (result.isSuccess() && result.value !== undefined) {\n converted[destinationKey] = result.value;\n } else if (result.isFailure()) {\n errors.push(`${srcKey}->${destinationKey}: ${result.message}`);\n }\n used.add(srcKey);\n } else if (destinationFields[destinationKey].optional !== true) {\n errors.push(`${String(srcKey)}: required property missing in source object.`);\n }\n }\n }\n\n if (options?.strict === true) {\n for (const key in from) {\n if (isKeyOf(key, from) && !used.has(key as keyof TSRC)) {\n errors.push(`${key}: unexpected property in source object`);\n }\n }\n }\n } else {\n errors.push('source is not an object');\n }\n\n return errors.length === 0\n ? succeed(converted)\n : fail(options?.description ? `${options.description}:\\n ${errors.join('\\n ')}` : errors.join('\\n'));\n });\n}\n"]}
|
|
@@ -27,7 +27,7 @@ export interface ObjectConverterOptions<T> {
|
|
|
27
27
|
* @public
|
|
28
28
|
*/
|
|
29
29
|
export type FieldConverters<T, TC = unknown> = {
|
|
30
|
-
[key in keyof T]: Converter<T[key], TC> | Validator<T[key], TC>;
|
|
30
|
+
[key in keyof T]: Converter<T[key], TC | unknown> | Validator<T[key], TC>;
|
|
31
31
|
};
|
|
32
32
|
/**
|
|
33
33
|
* A {@link Converter} which converts an object of type `<T>` without changing shape, given
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"objectConverter.d.ts","sourceRoot":"","sources":["../../../src/packlets/conversion/objectConverter.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;;GAGG;AAEH,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,IAAI;KAC5C,GAAG,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"objectConverter.d.ts","sourceRoot":"","sources":["../../../src/packlets/conversion/objectConverter.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;;GAGG;AAEH,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,IAAI;KAC5C,GAAG,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;CAC1E,CAAC;AAEF;;;;;;;;;GASG;AACH,qBAAa,eAAe,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC;IACxE;;OAEG;IACH,SAAgB,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC/C;;OAEG;IACH,SAAgB,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAEnD;;;;;;;OAOG;gBACgB,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC;IAEtF;;;;;;;OAOG;gBACgB,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE;IAmDzE;;;;;;;OAOG;IACI,OAAO,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAEnF;;;;;;;OAOG;IACI,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAcvE;;;;;;OAMG;IACI,UAAU,CAAC,qBAAqB,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;CAKvF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"objectConverter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/objectConverter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAiD;AAEjD,mDAAgD;AAEhD,6CAAoD;AAiCpD;;;;;;;;;GASG;AACH,MAAa,eAAiC,SAAQ,6BAAoB;IA6BxE;;;OAGG;IACH,YAAmB,MAA8B,EAAE,GAA6C;QAC9F,KAAK,CAAC,CAAC,IAAa,EAAE,MAAM,EAAE,OAAY,EAAE,EAAE;;YAC5C,+CAA+C;YAC/C,gDAAgD;YAChD,MAAM,SAAS,GAAG,EAAkC,CAAC;YACrD,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;gBACzB,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;oBAChB,MAAM,UAAU,GAAG,MAAA,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,KAAI,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,0CAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,CAAC,mCAAI,KAAK,CAAC;oBACnG,MAAM,MAAM,GAAG,UAAU;wBACvB,CAAC,CAAC,IAAA,0BAAa,EAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;wBACxD,CAAC,CAAC,IAAA,kBAAK,EAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;oBACnD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;wBACrD,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;oBAChC,CAAC;yBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;wBAC9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;oBAC9B,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;gBACjC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACrD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;wBACvB,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAA,cAAO,EAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,EAAE,CAAC;4BACrF,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,wCAAwC,CAAC,CAAC;wBAC9D,CAAC;oBACH,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;YACD,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC;gBACxB,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC;gBACpB,CAAC,CAAC,IAAA,WAAI,EACF,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CACnG,CAAC;QACR,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,OAAO,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,GAAG,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAqBD;;;;;OAKG;IACI,OAAO,CAAC,GAA6C;QAC1D,OAAO,IAAI,eAAe,CACxB,IAAI,CAAC,MAAyC,EAC9C,GAAyC,CAC1C,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAAC,qBAAkC;;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,mCAAI,EAAE,CAAC,EAAE,GAAG,qBAAqB,CAAC,CAAC,CAAC,KAAK,CAC3F,IAAI,CAAC,OAAO,EAAE,CACf,CAAC;IACJ,CAAC;CACF;AA3HD,0CA2HC","sourcesContent":["/*\n * Copyright (c) 2023 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 { fail, isKeyOf, succeed } from '../base';\nimport { Validator } from '../validation';\nimport { BaseConverter } from './baseConverter';\nimport { Converter } from './converter';\nimport { field, optionalField } from './converters';\n\n/**\n * Options for an {@link Conversion.ObjectConverter | ObjectConverter}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectConverterOptions<T> {\n /**\n * If present, lists optional fields. Missing non-optional fields cause an error.\n */\n optionalFields?: (keyof T)[];\n /**\n * If true, unrecognized fields yield an error. If false or undefined (default),\n * unrecognized fields are ignored.\n */\n strict?: boolean;\n /**\n * Optional description to be included in error messages.\n */\n description?: string;\n}\n\n/**\n * Per-property converters or validators for each of the properties in type T.\n * @remarks\n * Used to construct a {@link Conversion.ObjectConverter | ObjectConverter}\n * @public\n */\nexport type FieldConverters<T, TC = unknown> = {\n [key in keyof T]: Converter<T[key], TC> | Validator<T[key], TC>;\n};\n\n/**\n * A {@link Converter} which converts an object of type `<T>` without changing shape, given\n * a {@link Conversion.FieldConverters | FieldConverters<T>} for the fields in the object.\n * @remarks\n * By default, if all of the required fields exist and can be converted, returns a new object with\n * the converted values under the original key names. If any required fields do not exist or cannot\n * be converted, the entire conversion fails. See {@link Conversion.ObjectConverterOptions | ObjectConverterOptions}\n * for other conversion options.\n * @public\n */\nexport class ObjectConverter<T, TC = unknown> extends BaseConverter<T, TC> {\n /**\n * Fields converted by this {@link Conversion.ObjectConverter | ObjectConverter}.\n */\n public readonly fields: FieldConverters<T, TC>;\n /**\n * Options used to initialize this {@link Conversion.ObjectConverter | ObjectConverter}.\n */\n public readonly options: ObjectConverterOptions<T>;\n\n /**\n * Constructs a new {@link Conversion.ObjectConverter | ObjectConverter<T, TC>} using options\n * supplied in a {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>}.\n * @param fields - A {@link Conversion.FieldConverters | FieldConverters<T>} containing\n * a {@link Converter} for each field\n * @param options - An optional @see ObjectConverterOptions to configure the conversion\n * {@label WITH_OPTIONS}\n */\n public constructor(fields: FieldConverters<T, TC>, options?: ObjectConverterOptions<T>);\n\n /**\n * Constructs a new {@link Conversion.ObjectConverter | ObjectConverter<T, TC>} with optional\n * properties specified as an array of `keyof T`.\n * @param fields - A {@link Conversion.FieldConverters | FieldConverters<T>} containing\n * a {@link Converter} for each field.\n * @param optional - An array of `keyof T` listing fields that are not required.\n * {@label WITH_KEYS}\n */\n public constructor(fields: FieldConverters<T, TC>, optional?: (keyof T)[]);\n /**\n * Concrete implementation of {@link Converters.(ObjectConverter:constructor)}\n * @internal\n */\n public constructor(fields: FieldConverters<T, TC>, opt?: ObjectConverterOptions<T> | (keyof T)[]) {\n super((from: unknown, __self, context?: TC) => {\n // eslint bug thinks key is used before defined\n // eslint-disable-next-line no-use-before-define\n const converted = {} as { [key in keyof T]: T[key] };\n const errors: string[] = [];\n for (const key in fields) {\n if (fields[key]) {\n const isOptional = (fields[key].isOptional || this.options.optionalFields?.includes(key)) ?? false;\n const result = isOptional\n ? optionalField(key, fields[key]).convert(from, context)\n : field(key, fields[key]).convert(from, context);\n if (result.isSuccess() && result.value !== undefined) {\n converted[key] = result.value;\n } else if (result.isFailure()) {\n errors.push(result.message);\n }\n }\n }\n\n if (this.options.strict === true) {\n if (typeof from === 'object' && !Array.isArray(from)) {\n for (const key in from) {\n if (from.hasOwnProperty(key) && (!isKeyOf(key, fields) || fields[key] === undefined)) {\n errors.push(`${key}: unexpected property in source object`);\n }\n }\n } else {\n errors.push('source is not an object');\n }\n }\n return errors.length === 0\n ? succeed(converted)\n : fail(\n this.options.description ? `${this.options.description}: ${errors.join('\\n')}` : errors.join('\\n')\n );\n });\n\n this.fields = fields;\n if (Array.isArray(opt)) {\n this.options = { optionalFields: opt };\n } else {\n this.options = opt ?? {};\n }\n }\n\n /**\n * Creates a new {@link Conversion.ObjectConverter | ObjectConverter} derived from this one but with\n * new optional properties as specified by a supplied {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>}.\n * @param options - The {@link Conversion.ObjectConverterOptions | options} to be applied to the new\n * converter.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} with the additional optional source properties.\n * {@label WITH_OPTIONS}\n */\n public partial(options: ObjectConverterOptions<T>): ObjectConverter<Partial<T>, TC>;\n\n /**\n * Creates a new {@link Conversion.ObjectConverter | ObjectConverter} derived from this one but with\n * new optional properties as specified by a supplied array of `keyof T`.\n * @param optional - The keys of the source object properties to be made optional.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} with the additional optional source\n * properties.\n * {@label WITH_KEYS}\n */\n public partial(optional?: (keyof T)[]): ObjectConverter<Partial<T>, TC>;\n /**\n * Concrete implementation of\n * {@link Conversion.ObjectConverter.(partial:1) | ObjectConverter.partial(ObjectConverterOptions)} and\n * {@link Conversion.ObjectConverter.(partial:2) | ObjectConverter.partial((keyof T))[]}.\n * @internal\n */\n public partial(opt?: ObjectConverterOptions<T> | (keyof T)[]): ObjectConverter<Partial<T>, TC> {\n return new ObjectConverter<Partial<T>, TC>(\n this.fields as FieldConverters<Partial<T>, TC>,\n opt as ObjectConverterOptions<Partial<T>>\n )._with(this._traits());\n }\n\n /**\n * Creates a new {@link Conversion.ObjectConverter | ObjectConverter} derived from this one but with\n * new optional properties as specified by a supplied array of `keyof T`.\n * @param addOptionalProperties - The keys to be made optional.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} with the additional optional source\n * properties.\n */\n public addPartial(addOptionalProperties: (keyof T)[]): ObjectConverter<Partial<T>, TC> {\n return this.partial([...(this.options.optionalFields ?? []), ...addOptionalProperties])._with(\n this._traits()\n );\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"objectConverter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/objectConverter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAiD;AAEjD,mDAAgD;AAEhD,6CAAoD;AAiCpD;;;;;;;;;GASG;AACH,MAAa,eAAiC,SAAQ,6BAAoB;IA6BxE;;;OAGG;IACH,YAAmB,MAA8B,EAAE,GAA6C;QAC9F,KAAK,CAAC,CAAC,IAAa,EAAE,MAAM,EAAE,OAAY,EAAE,EAAE;;YAC5C,+CAA+C;YAC/C,gDAAgD;YAChD,MAAM,SAAS,GAAG,EAAkC,CAAC;YACrD,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;gBACzB,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;oBAChB,MAAM,UAAU,GAAG,MAAA,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,KAAI,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,0CAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,CAAC,mCAAI,KAAK,CAAC;oBACnG,MAAM,MAAM,GAAG,UAAU;wBACvB,CAAC,CAAC,IAAA,0BAAa,EAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;wBACxD,CAAC,CAAC,IAAA,kBAAK,EAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;oBACnD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;wBACrD,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;oBAChC,CAAC;yBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;wBAC9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;oBAC9B,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;gBACjC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACrD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;wBACvB,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAA,cAAO,EAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,EAAE,CAAC;4BACrF,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,wCAAwC,CAAC,CAAC;wBAC9D,CAAC;oBACH,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;YACD,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC;gBACxB,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC;gBACpB,CAAC,CAAC,IAAA,WAAI,EACF,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CACnG,CAAC;QACR,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,OAAO,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,GAAG,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAqBD;;;;;OAKG;IACI,OAAO,CAAC,GAA6C;QAC1D,OAAO,IAAI,eAAe,CACxB,IAAI,CAAC,MAAyC,EAC9C,GAAyC,CAC1C,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAAC,qBAAkC;;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,mCAAI,EAAE,CAAC,EAAE,GAAG,qBAAqB,CAAC,CAAC,CAAC,KAAK,CAC3F,IAAI,CAAC,OAAO,EAAE,CACf,CAAC;IACJ,CAAC;CACF;AA3HD,0CA2HC","sourcesContent":["/*\n * Copyright (c) 2023 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 { fail, isKeyOf, succeed } from '../base';\nimport { Validator } from '../validation';\nimport { BaseConverter } from './baseConverter';\nimport { Converter } from './converter';\nimport { field, optionalField } from './converters';\n\n/**\n * Options for an {@link Conversion.ObjectConverter | ObjectConverter}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectConverterOptions<T> {\n /**\n * If present, lists optional fields. Missing non-optional fields cause an error.\n */\n optionalFields?: (keyof T)[];\n /**\n * If true, unrecognized fields yield an error. If false or undefined (default),\n * unrecognized fields are ignored.\n */\n strict?: boolean;\n /**\n * Optional description to be included in error messages.\n */\n description?: string;\n}\n\n/**\n * Per-property converters or validators for each of the properties in type T.\n * @remarks\n * Used to construct a {@link Conversion.ObjectConverter | ObjectConverter}\n * @public\n */\nexport type FieldConverters<T, TC = unknown> = {\n [key in keyof T]: Converter<T[key], TC | unknown> | Validator<T[key], TC>;\n};\n\n/**\n * A {@link Converter} which converts an object of type `<T>` without changing shape, given\n * a {@link Conversion.FieldConverters | FieldConverters<T>} for the fields in the object.\n * @remarks\n * By default, if all of the required fields exist and can be converted, returns a new object with\n * the converted values under the original key names. If any required fields do not exist or cannot\n * be converted, the entire conversion fails. See {@link Conversion.ObjectConverterOptions | ObjectConverterOptions}\n * for other conversion options.\n * @public\n */\nexport class ObjectConverter<T, TC = unknown> extends BaseConverter<T, TC> {\n /**\n * Fields converted by this {@link Conversion.ObjectConverter | ObjectConverter}.\n */\n public readonly fields: FieldConverters<T, TC>;\n /**\n * Options used to initialize this {@link Conversion.ObjectConverter | ObjectConverter}.\n */\n public readonly options: ObjectConverterOptions<T>;\n\n /**\n * Constructs a new {@link Conversion.ObjectConverter | ObjectConverter<T, TC>} using options\n * supplied in a {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>}.\n * @param fields - A {@link Conversion.FieldConverters | FieldConverters<T>} containing\n * a {@link Converter} for each field\n * @param options - An optional @see ObjectConverterOptions to configure the conversion\n * {@label WITH_OPTIONS}\n */\n public constructor(fields: FieldConverters<T, TC>, options?: ObjectConverterOptions<T>);\n\n /**\n * Constructs a new {@link Conversion.ObjectConverter | ObjectConverter<T, TC>} with optional\n * properties specified as an array of `keyof T`.\n * @param fields - A {@link Conversion.FieldConverters | FieldConverters<T>} containing\n * a {@link Converter} for each field.\n * @param optional - An array of `keyof T` listing fields that are not required.\n * {@label WITH_KEYS}\n */\n public constructor(fields: FieldConverters<T, TC>, optional?: (keyof T)[]);\n /**\n * Concrete implementation of {@link Converters.(ObjectConverter:constructor)}\n * @internal\n */\n public constructor(fields: FieldConverters<T, TC>, opt?: ObjectConverterOptions<T> | (keyof T)[]) {\n super((from: unknown, __self, context?: TC) => {\n // eslint bug thinks key is used before defined\n // eslint-disable-next-line no-use-before-define\n const converted = {} as { [key in keyof T]: T[key] };\n const errors: string[] = [];\n for (const key in fields) {\n if (fields[key]) {\n const isOptional = (fields[key].isOptional || this.options.optionalFields?.includes(key)) ?? false;\n const result = isOptional\n ? optionalField(key, fields[key]).convert(from, context)\n : field(key, fields[key]).convert(from, context);\n if (result.isSuccess() && result.value !== undefined) {\n converted[key] = result.value;\n } else if (result.isFailure()) {\n errors.push(result.message);\n }\n }\n }\n\n if (this.options.strict === true) {\n if (typeof from === 'object' && !Array.isArray(from)) {\n for (const key in from) {\n if (from.hasOwnProperty(key) && (!isKeyOf(key, fields) || fields[key] === undefined)) {\n errors.push(`${key}: unexpected property in source object`);\n }\n }\n } else {\n errors.push('source is not an object');\n }\n }\n return errors.length === 0\n ? succeed(converted)\n : fail(\n this.options.description ? `${this.options.description}: ${errors.join('\\n')}` : errors.join('\\n')\n );\n });\n\n this.fields = fields;\n if (Array.isArray(opt)) {\n this.options = { optionalFields: opt };\n } else {\n this.options = opt ?? {};\n }\n }\n\n /**\n * Creates a new {@link Conversion.ObjectConverter | ObjectConverter} derived from this one but with\n * new optional properties as specified by a supplied {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>}.\n * @param options - The {@link Conversion.ObjectConverterOptions | options} to be applied to the new\n * converter.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} with the additional optional source properties.\n * {@label WITH_OPTIONS}\n */\n public partial(options: ObjectConverterOptions<T>): ObjectConverter<Partial<T>, TC>;\n\n /**\n * Creates a new {@link Conversion.ObjectConverter | ObjectConverter} derived from this one but with\n * new optional properties as specified by a supplied array of `keyof T`.\n * @param optional - The keys of the source object properties to be made optional.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} with the additional optional source\n * properties.\n * {@label WITH_KEYS}\n */\n public partial(optional?: (keyof T)[]): ObjectConverter<Partial<T>, TC>;\n /**\n * Concrete implementation of\n * {@link Conversion.ObjectConverter.(partial:1) | ObjectConverter.partial(ObjectConverterOptions)} and\n * {@link Conversion.ObjectConverter.(partial:2) | ObjectConverter.partial((keyof T))[]}.\n * @internal\n */\n public partial(opt?: ObjectConverterOptions<T> | (keyof T)[]): ObjectConverter<Partial<T>, TC> {\n return new ObjectConverter<Partial<T>, TC>(\n this.fields as FieldConverters<Partial<T>, TC>,\n opt as ObjectConverterOptions<Partial<T>>\n )._with(this._traits());\n }\n\n /**\n * Creates a new {@link Conversion.ObjectConverter | ObjectConverter} derived from this one but with\n * new optional properties as specified by a supplied array of `keyof T`.\n * @param addOptionalProperties - The keys to be made optional.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} with the additional optional source\n * properties.\n */\n public addPartial(addOptionalProperties: (keyof T)[]): ObjectConverter<Partial<T>, TC> {\n return this.partial([...(this.options.optionalFields ?? []), ...addOptionalProperties])._with(\n this._traits()\n );\n }\n}\n"]}
|
|
@@ -1,7 +1,15 @@
|
|
|
1
|
+
import { Failure } from '../base';
|
|
1
2
|
/**
|
|
2
3
|
* A type guard function which validates a specific type, with an optional context
|
|
3
4
|
* that can be used to shape the validation.
|
|
4
5
|
* @public
|
|
5
6
|
*/
|
|
6
7
|
export type TypeGuardWithContext<T, TC = unknown> = (from: unknown, context?: TC) => from is T;
|
|
8
|
+
/**
|
|
9
|
+
* Type for a validation function, which validates that a supplied `unknown`
|
|
10
|
+
* value is a valid value of type `<T>`, possibly as influenced by
|
|
11
|
+
* an optionally-supplied validation context of type `<TC>`.
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
export type ValidatorFunc<T, TC> = (from: unknown, context?: TC) => boolean | Failure<T>;
|
|
7
15
|
//# sourceMappingURL=common.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/common.ts"],"names":[],"mappings":"AAsBA;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/common.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC;AAE/F;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/packlets/validation/common.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG","sourcesContent":["/*\n * Copyright (c) 2022 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 * A type guard function which validates a specific type, with an optional context\n * that can be used to shape the validation.\n * @public\n */\nexport type TypeGuardWithContext<T, TC = unknown> = (from: unknown, context?: TC) => from is T;\n"]}
|
|
1
|
+
{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/packlets/validation/common.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG","sourcesContent":["/*\n * Copyright (c) 2022 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 { Failure } from '../base';\n\n/**\n * A type guard function which validates a specific type, with an optional context\n * that can be used to shape the validation.\n * @public\n */\nexport type TypeGuardWithContext<T, TC = unknown> = (from: unknown, context?: TC) => from is T;\n\n/**\n * Type for a validation function, which validates that a supplied `unknown`\n * value is a valid value of type `<T>`, possibly as influenced by\n * an optionally-supplied validation context of type `<TC>`.\n * @public\n */\nexport type ValidatorFunc<T, TC> = (from: unknown, context?: TC) => boolean | Failure<T>;\n"]}
|
|
@@ -1,13 +1,11 @@
|
|
|
1
|
-
import { Brand,
|
|
1
|
+
import { Brand, Result } from '../base';
|
|
2
2
|
import { ConstraintTrait, ValidatorTraits } from './traits';
|
|
3
3
|
import { Constraint, ValidationErrorFormatter, Validator, ValidatorOptions } from './validator';
|
|
4
|
+
import { ValidatorFunc } from './common';
|
|
4
5
|
/**
|
|
5
|
-
*
|
|
6
|
-
* value is a valid value of type `<T>`, possibly as influenced by
|
|
7
|
-
* an optionally-supplied validation context of type `<TC>`.
|
|
8
|
-
* @public
|
|
6
|
+
* @deprecated Use {@link Validation.Common.ValidatorFunc | Validation.Common.ValidatorFunc} instead.
|
|
9
7
|
*/
|
|
10
|
-
export
|
|
8
|
+
export { ValidatorFunc };
|
|
11
9
|
/**
|
|
12
10
|
* Options used to initialize a {@link Validation.Base.GenericValidator | GenericValidator}.
|
|
13
11
|
* @public
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"genericValidator.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/genericValidator.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,KAAK,
|
|
1
|
+
{"version":3,"file":"genericValidator.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/genericValidator.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,KAAK,EAAW,MAAM,EAAiB,MAAM,SAAS,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEhG,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC;;GAEG;AACH,OAAO,EAAE,aAAa,EAAE,CAAC;AAEzB;;;GAGG;AAEH,MAAM,WAAW,iCAAiC,CAAC,CAAC,EAAE,EAAE;IACtD,OAAO,CAAC,EAAE,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAC/B,MAAM,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAClC,SAAS,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CAClC;AAED;;;GAGG;AACH,qBAAa,gBAAgB,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAE,YAAW,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IACxE;;OAEG;IACH,SAAgB,MAAM,EAAE,eAAe,CAAC;IAExC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACpD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAElD;;;;OAIG;gBACgB,MAAM,EAAE,OAAO,CAAC,iCAAiC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAS5E;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAErC;IAED;;OAEG;IACI,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC;IAQvD;;OAEG;IACI,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC;IAQtD;;OAEG;IACI,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;IAI3E;;OAEG;IACI,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,IAAI,IAAI,CAAC;IAIpD;;OAEG;IACI,QAAQ,IAAI,SAAS,CAAC,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC;IAS/C;;OAEG;IACI,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IAoB3F;;OAEG;IACI,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC;IAaxE;;OAEG;IACI,kBAAkB,CAAC,SAAS,EAAE,wBAAwB,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IAcpF;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,SAAS;CAGzD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"genericValidator.js","sourceRoot":"","sources":["../../../src/packlets/validation/genericValidator.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgE;AAChE,qCAA4D;AAsB5D;;;GAGG;AACH,MAAa,gBAAgB;IAe3B;;;;OAIG;IACH,YAAmB,MAAyD;;QAC1E,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,IAAa,EAAE,OAAY;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7D,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,MAAM,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAI,eAAe,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,IAAa,EAAE,OAAY;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7D,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,MAAM,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAI,eAAe,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,IAAa,EAAE,OAAY;QACjD,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAa,EAAE,OAAY;QACtC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,OAAO,IAAI,gBAAgB,CAAC;YAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACzC,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAC7E,CAAC;YACD,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE;SAC7B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,UAAyB,EAAE,KAAuB;QACtE,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;QACtC,OAAO,IAAI,gBAAgB,CAAC;YAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAwB,EAAE;gBAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC7D,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;oBACpB,MAAM,gBAAgB,GAAG,UAAU,CAAC,IAAS,CAAC,CAAC;oBAC/C,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE,CAAC;wBAC1C,OAAO,gBAAgB;4BACrB,CAAC,CAAC,IAAI;4BACN,CAAC,CAAC,IAAA,WAAI,EAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;oBAClF,CAAC;oBACD,OAAO,gBAAgB,CAAC;gBAC1B,CAAC;gBACD,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,MAAM,EAAE,EAAE,WAAW,EAAE,CAAC,KAAK,CAAC,EAAE;SACjC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,SAAS,CAAmB,KAAQ;QACzC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,CAAC,KAAK,WAAW,KAAK,IAAI,CAAC,CAAC;QACpF,CAAC;QAED,OAAO,IAAI,gBAAgB,CAAkB;YAC3C,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACzC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAmC,CAAC;YACzF,CAAC;YACD,MAAM,EAAE,EAAE,KAAK,EAAE;SAClB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,SAAuC;QAC/D,OAAO,IAAI,gBAAgB,CAAQ;YACjC,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACzC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC7D,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;oBACpB,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,uCAAuC;gBACvC,MAAM,OAAO,GAAG,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;gBAC9D,OAAO,IAAA,WAAI,EAAC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAChE,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACO,QAAQ,CAAC,eAAoB;QACrC,OAAO,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;IACzD,CAAC;CACF;AA5JD,4CA4JC","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\nimport { Brand, Failure, Result, fail, succeed } from '../base';\nimport { ConstraintTrait, ValidatorTraits } from './traits';\nimport { Constraint, ValidationErrorFormatter, Validator, ValidatorOptions } from './validator';\n\n/**\n * Type for a validation function, which validates that a supplied `unknown`\n * value is a valid value of type `<T>`, possibly as influenced by\n * an optionally-supplied validation context of type `<TC>`.\n * @public\n */\nexport type ValidatorFunc<T, TC> = (from: unknown, context?: TC) => boolean | Failure<T>;\n\n/**\n * Options used to initialize a {@link Validation.Base.GenericValidator | GenericValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface GenericValidatorConstructorParams<T, TC> {\n options?: ValidatorOptions<TC>;\n traits?: Partial<ValidatorTraits>;\n validator?: ValidatorFunc<T, TC>;\n}\n\n/**\n * Generic base implementation for an in-place {@link Validation.Validator | Validator}.\n * @public\n */\nexport class GenericValidator<T, TC = unknown> implements Validator<T, TC> {\n /**\n * {@inheritdoc Validation.Validator.traits}\n */\n public readonly traits: ValidatorTraits;\n\n /**\n * @internal\n */\n protected readonly _validator: ValidatorFunc<T, TC>;\n /**\n * @internal\n */\n protected readonly _options: ValidatorOptions<TC>;\n\n /**\n * Constructs a new {@link Validation.Base.GenericValidator | GenericValidator<T>}.\n * @param params - The {@link Validation.Base.GenericValidatorConstructorParams | constructor params}\n * used to configure validation.\n */\n public constructor(params: Partial<GenericValidatorConstructorParams<T, TC>>) {\n if (!params.validator) {\n throw new Error('No validator function supplied');\n }\n this._validator = params.validator;\n this._options = params.options ?? {};\n this.traits = new ValidatorTraits(params.traits);\n }\n\n /**\n * {@inheritdoc Validation.Validator.isOptional}\n */\n public get isOptional(): boolean {\n return this.traits.isOptional;\n }\n\n /**\n * {@inheritdoc Validation.Validator.brand}\n */\n public get brand(): string | undefined {\n return this.traits.brand;\n }\n\n /**\n * {@inheritdoc Validation.Validator.validate}\n */\n public validate(from: unknown, context?: TC): Result<T> {\n const result = this._validator(from, this._context(context));\n if (typeof result === 'boolean') {\n return result ? succeed(from as T) : fail<T>('Invalid value');\n }\n return result;\n }\n\n /**\n * {@inheritdoc Validation.Validator.convert}\n */\n public convert(from: unknown, context?: TC): Result<T> {\n const result = this._validator(from, this._context(context));\n if (typeof result === 'boolean') {\n return result ? succeed(from as T) : fail<T>('Invalid value');\n }\n return result;\n }\n\n /**\n * {@inheritdoc Validation.Validator.validateOptional}\n */\n public validateOptional(from: unknown, context?: TC): Result<T | undefined> {\n return from === undefined ? succeed(undefined) : this.validate(from, context);\n }\n\n /**\n * {@inheritdoc Validation.Validator.guard}\n */\n public guard(from: unknown, context?: TC): from is T {\n return this._validator(from, this._context(context)) === true;\n }\n\n /**\n * {@inheritdoc Validation.Validator.optional}\n */\n public optional(): Validator<T | undefined, TC> {\n return new GenericValidator({\n validator: (from: unknown, context?: TC) => {\n return from === undefined || this._validator(from, this._context(context));\n },\n traits: { isOptional: true }\n });\n }\n\n /**\n * {@inheritdoc Validation.Validator.withConstraint}\n */\n public withConstraint(constraint: Constraint<T>, trait?: ConstraintTrait): Validator<T, TC> {\n trait = trait ?? { type: 'function' };\n return new GenericValidator({\n validator: (from: unknown, context?: TC): boolean | Failure<T> => {\n const result = this._validator(from, this._context(context));\n if (result === true) {\n const constraintResult = constraint(from as T);\n if (typeof constraintResult === 'boolean') {\n return constraintResult\n ? true\n : fail(`Invalid value \"${JSON.stringify(from)}\": does not meet constraint.`);\n }\n return constraintResult;\n }\n return result;\n },\n traits: { constraints: [trait] }\n });\n }\n\n /**\n * {@inheritdoc Validation.Validator.brand}\n */\n public withBrand<B extends string>(brand: B): Validator<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 GenericValidator<Brand<T, B>, TC>({\n validator: (from: unknown, context?: TC) => {\n return this._validator(from, this._context(context)) as boolean | Failure<Brand<T, B>>;\n },\n traits: { brand }\n });\n }\n\n /**\n * {@inheritdoc Validation.Validator.withFormattedError}\n */\n public withFormattedError(formatter: ValidationErrorFormatter<TC>): Validator<T, TC> {\n return new GenericValidator<T, TC>({\n validator: (from: unknown, context?: TC) => {\n const result = this._validator(from, this._context(context));\n if (result === true) {\n return true;\n }\n /* c8 ignore next - defense in depth */\n const message = result === false ? undefined : result.message;\n return fail(formatter(from, message, this._context(context)));\n }\n });\n }\n\n /**\n * Gets a default or explicit context.\n * @param explicitContext - Optional explicit context.\n * @returns The appropriate context to use.\n * @internal\n */\n protected _context(explicitContext?: TC): TC | undefined {\n return explicitContext ?? this._options.defaultContext;\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"genericValidator.js","sourceRoot":"","sources":["../../../src/packlets/validation/genericValidator.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgE;AAChE,qCAA4D;AAqB5D;;;GAGG;AACH,MAAa,gBAAgB;IAe3B;;;;OAIG;IACH,YAAmB,MAAyD;;QAC1E,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,IAAa,EAAE,OAAY;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7D,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,MAAM,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAI,eAAe,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,IAAa,EAAE,OAAY;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7D,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,MAAM,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAI,eAAe,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,IAAa,EAAE,OAAY;QACjD,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAa,EAAE,OAAY;QACtC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,OAAO,IAAI,gBAAgB,CAAC;YAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACzC,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAC7E,CAAC;YACD,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE;SAC7B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,UAAyB,EAAE,KAAuB;QACtE,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;QACtC,OAAO,IAAI,gBAAgB,CAAC;YAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAwB,EAAE;gBAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC7D,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;oBACpB,MAAM,gBAAgB,GAAG,UAAU,CAAC,IAAS,CAAC,CAAC;oBAC/C,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE,CAAC;wBAC1C,OAAO,gBAAgB;4BACrB,CAAC,CAAC,IAAI;4BACN,CAAC,CAAC,IAAA,WAAI,EAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;oBAClF,CAAC;oBACD,OAAO,gBAAgB,CAAC;gBAC1B,CAAC;gBACD,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,MAAM,EAAE,EAAE,WAAW,EAAE,CAAC,KAAK,CAAC,EAAE;SACjC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,SAAS,CAAmB,KAAQ;QACzC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,CAAC,KAAK,WAAW,KAAK,IAAI,CAAC,CAAC;QACpF,CAAC;QAED,OAAO,IAAI,gBAAgB,CAAkB;YAC3C,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACzC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAmC,CAAC;YACzF,CAAC;YACD,MAAM,EAAE,EAAE,KAAK,EAAE;SAClB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,SAAuC;QAC/D,OAAO,IAAI,gBAAgB,CAAQ;YACjC,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACzC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC7D,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;oBACpB,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,uCAAuC;gBACvC,MAAM,OAAO,GAAG,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;gBAC9D,OAAO,IAAA,WAAI,EAAC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAChE,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACO,QAAQ,CAAC,eAAoB;QACrC,OAAO,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;IACzD,CAAC;CACF;AA5JD,4CA4JC","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\nimport { Brand, Failure, Result, fail, succeed } from '../base';\nimport { ConstraintTrait, ValidatorTraits } from './traits';\nimport { Constraint, ValidationErrorFormatter, Validator, ValidatorOptions } from './validator';\n\nimport { ValidatorFunc } from './common';\n\n/**\n * @deprecated Use {@link Validation.Common.ValidatorFunc | Validation.Common.ValidatorFunc} instead.\n */\nexport { ValidatorFunc };\n\n/**\n * Options used to initialize a {@link Validation.Base.GenericValidator | GenericValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface GenericValidatorConstructorParams<T, TC> {\n options?: ValidatorOptions<TC>;\n traits?: Partial<ValidatorTraits>;\n validator?: ValidatorFunc<T, TC>;\n}\n\n/**\n * Generic base implementation for an in-place {@link Validation.Validator | Validator}.\n * @public\n */\nexport class GenericValidator<T, TC = unknown> implements Validator<T, TC> {\n /**\n * {@inheritdoc Validation.Validator.traits}\n */\n public readonly traits: ValidatorTraits;\n\n /**\n * @internal\n */\n protected readonly _validator: ValidatorFunc<T, TC>;\n /**\n * @internal\n */\n protected readonly _options: ValidatorOptions<TC>;\n\n /**\n * Constructs a new {@link Validation.Base.GenericValidator | GenericValidator<T>}.\n * @param params - The {@link Validation.Base.GenericValidatorConstructorParams | constructor params}\n * used to configure validation.\n */\n public constructor(params: Partial<GenericValidatorConstructorParams<T, TC>>) {\n if (!params.validator) {\n throw new Error('No validator function supplied');\n }\n this._validator = params.validator;\n this._options = params.options ?? {};\n this.traits = new ValidatorTraits(params.traits);\n }\n\n /**\n * {@inheritdoc Validation.Validator.isOptional}\n */\n public get isOptional(): boolean {\n return this.traits.isOptional;\n }\n\n /**\n * {@inheritdoc Validation.Validator.brand}\n */\n public get brand(): string | undefined {\n return this.traits.brand;\n }\n\n /**\n * {@inheritdoc Validation.Validator.validate}\n */\n public validate(from: unknown, context?: TC): Result<T> {\n const result = this._validator(from, this._context(context));\n if (typeof result === 'boolean') {\n return result ? succeed(from as T) : fail<T>('Invalid value');\n }\n return result;\n }\n\n /**\n * {@inheritdoc Validation.Validator.convert}\n */\n public convert(from: unknown, context?: TC): Result<T> {\n const result = this._validator(from, this._context(context));\n if (typeof result === 'boolean') {\n return result ? succeed(from as T) : fail<T>('Invalid value');\n }\n return result;\n }\n\n /**\n * {@inheritdoc Validation.Validator.validateOptional}\n */\n public validateOptional(from: unknown, context?: TC): Result<T | undefined> {\n return from === undefined ? succeed(undefined) : this.validate(from, context);\n }\n\n /**\n * {@inheritdoc Validation.Validator.guard}\n */\n public guard(from: unknown, context?: TC): from is T {\n return this._validator(from, this._context(context)) === true;\n }\n\n /**\n * {@inheritdoc Validation.Validator.optional}\n */\n public optional(): Validator<T | undefined, TC> {\n return new GenericValidator({\n validator: (from: unknown, context?: TC) => {\n return from === undefined || this._validator(from, this._context(context));\n },\n traits: { isOptional: true }\n });\n }\n\n /**\n * {@inheritdoc Validation.Validator.withConstraint}\n */\n public withConstraint(constraint: Constraint<T>, trait?: ConstraintTrait): Validator<T, TC> {\n trait = trait ?? { type: 'function' };\n return new GenericValidator({\n validator: (from: unknown, context?: TC): boolean | Failure<T> => {\n const result = this._validator(from, this._context(context));\n if (result === true) {\n const constraintResult = constraint(from as T);\n if (typeof constraintResult === 'boolean') {\n return constraintResult\n ? true\n : fail(`Invalid value \"${JSON.stringify(from)}\": does not meet constraint.`);\n }\n return constraintResult;\n }\n return result;\n },\n traits: { constraints: [trait] }\n });\n }\n\n /**\n * {@inheritdoc Validation.Validator.brand}\n */\n public withBrand<B extends string>(brand: B): Validator<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 GenericValidator<Brand<T, B>, TC>({\n validator: (from: unknown, context?: TC) => {\n return this._validator(from, this._context(context)) as boolean | Failure<Brand<T, B>>;\n },\n traits: { brand }\n });\n }\n\n /**\n * {@inheritdoc Validation.Validator.withFormattedError}\n */\n public withFormattedError(formatter: ValidationErrorFormatter<TC>): Validator<T, TC> {\n return new GenericValidator<T, TC>({\n validator: (from: unknown, context?: TC) => {\n const result = this._validator(from, this._context(context));\n if (result === true) {\n return true;\n }\n /* c8 ignore next - defense in depth */\n const message = result === false ? undefined : result.message;\n return fail(formatter(from, message, this._context(context)));\n }\n });\n }\n\n /**\n * Gets a default or explicit context.\n * @param explicitContext - Optional explicit context.\n * @returns The appropriate context to use.\n * @internal\n */\n protected _context(explicitContext?: TC): TC | undefined {\n return explicitContext ?? this._options.defaultContext;\n }\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/number.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAQ,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,iCAAiC,EAAE,MAAM,oBAAoB,CAAC;AAEzF;;;GAGG;AACH,MAAM,MAAM,gCAAgC,CAC1C,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,EAAE,GAAG,OAAO,IACV,iCAAiC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAE7C;;;GAGG;AACH,qBAAa,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC;IACnG;;;;OAIG;gBACgB,MAAM,CAAC,EAAE,gCAAgC,CAAC,CAAC,EAAE,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/number.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAQ,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,iCAAiC,EAAE,MAAM,oBAAoB,CAAC;AAEzF;;;GAGG;AACH,MAAM,MAAM,gCAAgC,CAC1C,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,EAAE,GAAG,OAAO,IACV,iCAAiC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAE7C;;;GAGG;AACH,qBAAa,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC;IACnG;;;;OAIG;gBACgB,MAAM,CAAC,EAAE,gCAAgC,CAAC,CAAC,EAAE,EAAE,CAAC;IASnE;;;;;OAKG;WACW,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;CAMpF"}
|
|
@@ -35,7 +35,9 @@ class NumberValidator extends genericValidator_1.GenericValidator {
|
|
|
35
35
|
* new {@link Validation.Classes.NumberValidator | NumberValidator}.
|
|
36
36
|
*/
|
|
37
37
|
constructor(params) {
|
|
38
|
-
|
|
38
|
+
/* c8 ignore next 1 */
|
|
39
|
+
params = params !== null && params !== void 0 ? params : {};
|
|
40
|
+
super(Object.assign({ validator: NumberValidator.validateNumber }, params));
|
|
39
41
|
}
|
|
40
42
|
/**
|
|
41
43
|
* Static method which validates that a supplied `unknown` value is a `number`.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"number.js","sourceRoot":"","sources":["../../../src/packlets/validation/number.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAWzF;;;GAGG;AACH,MAAa,eAAyD,SAAQ,mCAAuB;IACnG;;;;OAIG;IACH,YAAmB,MAAgD;QACjE,
|
|
1
|
+
{"version":3,"file":"number.js","sourceRoot":"","sources":["../../../src/packlets/validation/number.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAWzF;;;GAGG;AACH,MAAa,eAAyD,SAAQ,mCAAuB;IACnG;;;;OAIG;IACH,YAAmB,MAAgD;QACjE,sBAAsB;QACtB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QACtB,KAAK,iBACH,SAAS,EAAE,eAAe,CAAC,cAAc,IACtC,MAAM,EACT,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAmB,IAAa;QAC1D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAA,WAAI,EAAI,IAAI,IAAI,iBAAiB,CAAC,CAAC;IAC5C,CAAC;CACF;AA3BD,0CA2BC","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\nimport { Failure, fail } from '../base';\nimport { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.NumberValidator | NumberValidator}.\n * @public\n */\nexport type NumberValidatorConstructorParams<\n T extends number = number,\n TC = unknown\n> = GenericValidatorConstructorParams<T, TC>;\n\n/**\n * An in-place {@link Validation.Validator | Validator} for `number` values.\n * @public\n */\nexport class NumberValidator<T extends number = number, TC = unknown> extends GenericValidator<T, TC> {\n /**\n * Constructs a new {@link Validation.Classes.NumberValidator | NumberValidator}.\n * @param params - Optional {@link Validation.Classes.NumberValidatorConstructorParams | init params} for the\n * new {@link Validation.Classes.NumberValidator | NumberValidator}.\n */\n public constructor(params?: NumberValidatorConstructorParams<T, TC>) {\n /* c8 ignore next 1 */\n params = params ?? {};\n super({\n validator: NumberValidator.validateNumber,\n ...params\n });\n }\n\n /**\n * Static method which validates that a supplied `unknown` value is a `number`.\n * @param from - The `unknown` value to be tested.\n * @returns Returns `true` if `from` is a `number`, or {@link Failure} with an error\n * message if not.\n */\n public static validateNumber<T extends number>(from: unknown): boolean | Failure<T> {\n if (typeof from === 'number') {\n return true;\n }\n return fail<T>(`\"${from}\": not a number`);\n }\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/string.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAQ,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,iCAAiC,EAAE,MAAM,oBAAoB,CAAC;AAEzF;;;GAGG;AACH,MAAM,MAAM,gCAAgC,CAC1C,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,EAAE,GAAG,OAAO,IACV,iCAAiC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAE7C;;;GAGG;AACH,qBAAa,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC;IACnG;;;;OAIG;gBACgB,MAAM,CAAC,EAAE,gCAAgC,CAAC,CAAC,EAAE,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/string.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAQ,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,iCAAiC,EAAE,MAAM,oBAAoB,CAAC;AAEzF;;;GAGG;AACH,MAAM,MAAM,gCAAgC,CAC1C,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,EAAE,GAAG,OAAO,IACV,iCAAiC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAE7C;;;GAGG;AACH,qBAAa,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC;IACnG;;;;OAIG;gBACgB,MAAM,CAAC,EAAE,gCAAgC,CAAC,CAAC,EAAE,EAAE,CAAC;IASnE;;;;;OAKG;WACW,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;CAMpF"}
|
|
@@ -35,7 +35,9 @@ class StringValidator extends genericValidator_1.GenericValidator {
|
|
|
35
35
|
* for the new {@link Validation.Classes.StringValidator | StringValidator}.
|
|
36
36
|
*/
|
|
37
37
|
constructor(params) {
|
|
38
|
-
|
|
38
|
+
/* c8 ignore next */
|
|
39
|
+
params = params !== null && params !== void 0 ? params : {};
|
|
40
|
+
super(Object.assign({ validator: StringValidator.validateString }, params));
|
|
39
41
|
}
|
|
40
42
|
/**
|
|
41
43
|
* Static method which validates that a supplied `unknown` value is a `string`.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../src/packlets/validation/string.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAWzF;;;GAGG;AACH,MAAa,eAAyD,SAAQ,mCAAuB;IACnG;;;;OAIG;IACH,YAAmB,MAAgD;QACjE,
|
|
1
|
+
{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../src/packlets/validation/string.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAWzF;;;GAGG;AACH,MAAa,eAAyD,SAAQ,mCAAuB;IACnG;;;;OAIG;IACH,YAAmB,MAAgD;QACjE,oBAAoB;QACpB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QACtB,KAAK,iBACH,SAAS,EAAE,eAAe,CAAC,cAAc,IACtC,MAAM,EACT,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAmB,IAAa;QAC1D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAA,WAAI,EAAI,IAAI,IAAI,iBAAiB,CAAC,CAAC;IAC5C,CAAC;CACF;AA3BD,0CA2BC","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\nimport { Failure, fail } from '../base';\nimport { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.StringValidator | StringValidator}.\n * @public\n */\nexport type StringValidatorConstructorParams<\n T extends string = string,\n TC = unknown\n> = GenericValidatorConstructorParams<T, TC>;\n\n/**\n * An in-place {@link Validation.Validator | Validator} for `string` values.\n * @public\n */\nexport class StringValidator<T extends string = string, TC = unknown> extends GenericValidator<T, TC> {\n /**\n * Constructs a new {@link Validation.Classes.StringValidator | StringValidator}.\n * @param params - Optional {@link Validation.Classes.StringValidatorConstructorParams | init params}\n * for the new {@link Validation.Classes.StringValidator | StringValidator}.\n */\n public constructor(params?: StringValidatorConstructorParams<T, TC>) {\n /* c8 ignore next */\n params = params ?? {};\n super({\n validator: StringValidator.validateString,\n ...params\n });\n }\n\n /**\n * Static method which validates that a supplied `unknown` value is a `string`.\n * @param from - The `unknown` value to be tested.\n * @returns Returns `true` if `from` is a `string`, or {@link Failure} with an error\n * message if not.\n */\n public static validateString<T extends string>(from: unknown): boolean | Failure<T> {\n if (typeof from === 'string') {\n return true;\n }\n return fail<T>(`\"${from}\": not a string`);\n }\n}\n"]}
|