@fgv/ts-utils 5.0.0-9 → 5.0.1-0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (182) hide show
  1. package/CHANGELOG.json +10 -7
  2. package/dist/ts-utils.d.ts +3042 -3133
  3. package/dist/tsdoc-metadata.json +1 -1
  4. package/eslint.config.js +37 -0
  5. package/lib/index.d.ts +2 -2
  6. package/lib/index.js +3 -3
  7. package/lib/packlets/base/index.d.ts +0 -2
  8. package/lib/packlets/base/index.js +1 -25
  9. package/lib/packlets/base/mapResults.d.ts +8 -1
  10. package/lib/packlets/base/mapResults.js +19 -0
  11. package/lib/packlets/base/result.d.ts +81 -3
  12. package/lib/packlets/base/result.js +71 -3
  13. package/lib/packlets/collections/collector.d.ts +9 -0
  14. package/lib/packlets/collections/collector.js +16 -1
  15. package/lib/packlets/collections/validatingCollector.d.ts +5 -1
  16. package/lib/packlets/conversion/baseConverter.js +0 -1
  17. package/lib/packlets/conversion/converters.js +0 -2
  18. package/lib/packlets/conversion/objectConverter.js +1 -2
  19. package/lib/packlets/hash/hashingNormalizer.js +4 -3
  20. package/lib/packlets/logging/index.d.ts +3 -0
  21. package/lib/packlets/{file-tree/in-memory → logging}/index.js +3 -2
  22. package/lib/packlets/logging/logReporter.d.ts +88 -0
  23. package/lib/packlets/logging/logReporter.js +105 -0
  24. package/lib/packlets/logging/logger.d.ts +205 -0
  25. package/lib/packlets/logging/logger.js +267 -0
  26. package/lib/packlets/validation/array.d.ts +2 -1
  27. package/lib/packlets/validation/array.js +2 -1
  28. package/lib/packlets/validation/common.d.ts +0 -8
  29. package/lib/packlets/validation/field.d.ts +1 -1
  30. package/lib/packlets/validation/field.js +1 -1
  31. package/lib/packlets/validation/genericValidator.d.ts +1 -6
  32. package/lib/packlets/validation/genericValidator.js +11 -11
  33. package/lib/packlets/validation/object.d.ts +1 -1
  34. package/lib/packlets/validation/object.js +1 -2
  35. package/lib/packlets/validation/oneOf.d.ts +2 -1
  36. package/lib/packlets/validation/oneOf.js +2 -1
  37. package/lib/packlets/validation/typeGuard.d.ts +3 -2
  38. package/lib/packlets/validation/typeGuard.js +2 -1
  39. package/lib/packlets/validation/validator.d.ts +7 -0
  40. package/lib/packlets/validation/validatorBase.d.ts +2 -1
  41. package/lib/packlets/validation/validatorBase.js +1 -1
  42. package/lib/packlets/validation/validators.d.ts +2 -2
  43. package/lib/packlets/validation/validators.js +3 -3
  44. package/package.json +16 -16
  45. package/CHANGELOG.md +0 -135
  46. package/lib/index.d.ts.map +0 -1
  47. package/lib/index.js.map +0 -1
  48. package/lib/packlets/base/brand.d.ts.map +0 -1
  49. package/lib/packlets/base/brand.js.map +0 -1
  50. package/lib/packlets/base/index.d.ts.map +0 -1
  51. package/lib/packlets/base/index.js.map +0 -1
  52. package/lib/packlets/base/logger.d.ts +0 -52
  53. package/lib/packlets/base/logger.d.ts.map +0 -1
  54. package/lib/packlets/base/logger.js +0 -128
  55. package/lib/packlets/base/logger.js.map +0 -1
  56. package/lib/packlets/base/mapResults.d.ts.map +0 -1
  57. package/lib/packlets/base/mapResults.js.map +0 -1
  58. package/lib/packlets/base/messageAggregator.d.ts.map +0 -1
  59. package/lib/packlets/base/messageAggregator.js.map +0 -1
  60. package/lib/packlets/base/normalize.d.ts.map +0 -1
  61. package/lib/packlets/base/normalize.js.map +0 -1
  62. package/lib/packlets/base/result.d.ts.map +0 -1
  63. package/lib/packlets/base/result.js.map +0 -1
  64. package/lib/packlets/base/utils.d.ts.map +0 -1
  65. package/lib/packlets/base/utils.js.map +0 -1
  66. package/lib/packlets/collections/collectible.d.ts.map +0 -1
  67. package/lib/packlets/collections/collectible.js.map +0 -1
  68. package/lib/packlets/collections/collector.d.ts.map +0 -1
  69. package/lib/packlets/collections/collector.js.map +0 -1
  70. package/lib/packlets/collections/collectorValidator.d.ts.map +0 -1
  71. package/lib/packlets/collections/collectorValidator.js.map +0 -1
  72. package/lib/packlets/collections/common.d.ts.map +0 -1
  73. package/lib/packlets/collections/common.js.map +0 -1
  74. package/lib/packlets/collections/convertingCollector.d.ts.map +0 -1
  75. package/lib/packlets/collections/convertingCollector.js.map +0 -1
  76. package/lib/packlets/collections/convertingCollectorValidator.d.ts.map +0 -1
  77. package/lib/packlets/collections/convertingCollectorValidator.js.map +0 -1
  78. package/lib/packlets/collections/index.d.ts.map +0 -1
  79. package/lib/packlets/collections/index.js.map +0 -1
  80. package/lib/packlets/collections/keyValueConverters.d.ts.map +0 -1
  81. package/lib/packlets/collections/keyValueConverters.js.map +0 -1
  82. package/lib/packlets/collections/readonlyResultMap.d.ts.map +0 -1
  83. package/lib/packlets/collections/readonlyResultMap.js.map +0 -1
  84. package/lib/packlets/collections/resultMap.d.ts.map +0 -1
  85. package/lib/packlets/collections/resultMap.js.map +0 -1
  86. package/lib/packlets/collections/resultMapValidator.d.ts.map +0 -1
  87. package/lib/packlets/collections/resultMapValidator.js.map +0 -1
  88. package/lib/packlets/collections/utils.d.ts.map +0 -1
  89. package/lib/packlets/collections/utils.js.map +0 -1
  90. package/lib/packlets/collections/validatingCollector.d.ts.map +0 -1
  91. package/lib/packlets/collections/validatingCollector.js.map +0 -1
  92. package/lib/packlets/collections/validatingConvertingCollector.d.ts.map +0 -1
  93. package/lib/packlets/collections/validatingConvertingCollector.js.map +0 -1
  94. package/lib/packlets/collections/validatingResultMap.d.ts.map +0 -1
  95. package/lib/packlets/collections/validatingResultMap.js.map +0 -1
  96. package/lib/packlets/conversion/baseConverter.d.ts.map +0 -1
  97. package/lib/packlets/conversion/baseConverter.js.map +0 -1
  98. package/lib/packlets/conversion/converter.d.ts.map +0 -1
  99. package/lib/packlets/conversion/converter.js.map +0 -1
  100. package/lib/packlets/conversion/converters.d.ts.map +0 -1
  101. package/lib/packlets/conversion/converters.js.map +0 -1
  102. package/lib/packlets/conversion/defaultingConverter.d.ts.map +0 -1
  103. package/lib/packlets/conversion/defaultingConverter.js.map +0 -1
  104. package/lib/packlets/conversion/index.d.ts.map +0 -1
  105. package/lib/packlets/conversion/index.js.map +0 -1
  106. package/lib/packlets/conversion/objectConverter.d.ts.map +0 -1
  107. package/lib/packlets/conversion/objectConverter.js.map +0 -1
  108. package/lib/packlets/conversion/stringConverter.d.ts.map +0 -1
  109. package/lib/packlets/conversion/stringConverter.js.map +0 -1
  110. package/lib/packlets/file-tree/directoryItem.d.ts +0 -47
  111. package/lib/packlets/file-tree/directoryItem.d.ts.map +0 -1
  112. package/lib/packlets/file-tree/directoryItem.js +0 -71
  113. package/lib/packlets/file-tree/directoryItem.js.map +0 -1
  114. package/lib/packlets/file-tree/fileItem.d.ts +0 -64
  115. package/lib/packlets/file-tree/fileItem.d.ts.map +0 -1
  116. package/lib/packlets/file-tree/fileItem.js +0 -93
  117. package/lib/packlets/file-tree/fileItem.js.map +0 -1
  118. package/lib/packlets/file-tree/fileTree.d.ts +0 -84
  119. package/lib/packlets/file-tree/fileTree.d.ts.map +0 -1
  120. package/lib/packlets/file-tree/fileTree.js +0 -135
  121. package/lib/packlets/file-tree/fileTree.js.map +0 -1
  122. package/lib/packlets/file-tree/fileTreeAccessors.d.ts +0 -134
  123. package/lib/packlets/file-tree/fileTreeAccessors.d.ts.map +0 -1
  124. package/lib/packlets/file-tree/fileTreeAccessors.js +0 -24
  125. package/lib/packlets/file-tree/fileTreeAccessors.js.map +0 -1
  126. package/lib/packlets/file-tree/fsTree.d.ts +0 -45
  127. package/lib/packlets/file-tree/fsTree.d.ts.map +0 -1
  128. package/lib/packlets/file-tree/fsTree.js +0 -116
  129. package/lib/packlets/file-tree/fsTree.js.map +0 -1
  130. package/lib/packlets/file-tree/in-memory/inMemoryTree.d.ts +0 -67
  131. package/lib/packlets/file-tree/in-memory/inMemoryTree.d.ts.map +0 -1
  132. package/lib/packlets/file-tree/in-memory/inMemoryTree.js +0 -150
  133. package/lib/packlets/file-tree/in-memory/inMemoryTree.js.map +0 -1
  134. package/lib/packlets/file-tree/in-memory/index.d.ts +0 -2
  135. package/lib/packlets/file-tree/in-memory/index.d.ts.map +0 -1
  136. package/lib/packlets/file-tree/in-memory/index.js.map +0 -1
  137. package/lib/packlets/file-tree/in-memory/treeBuilder.d.ts +0 -106
  138. package/lib/packlets/file-tree/in-memory/treeBuilder.d.ts.map +0 -1
  139. package/lib/packlets/file-tree/in-memory/treeBuilder.js +0 -170
  140. package/lib/packlets/file-tree/in-memory/treeBuilder.js.map +0 -1
  141. package/lib/packlets/file-tree/index.d.ts +0 -8
  142. package/lib/packlets/file-tree/index.d.ts.map +0 -1
  143. package/lib/packlets/file-tree/index.js +0 -46
  144. package/lib/packlets/file-tree/index.js.map +0 -1
  145. package/lib/packlets/hash/crcNormalizer.d.ts.map +0 -1
  146. package/lib/packlets/hash/crcNormalizer.js.map +0 -1
  147. package/lib/packlets/hash/hashingNormalizer.d.ts.map +0 -1
  148. package/lib/packlets/hash/hashingNormalizer.js.map +0 -1
  149. package/lib/packlets/hash/index.d.ts.map +0 -1
  150. package/lib/packlets/hash/index.js.map +0 -1
  151. package/lib/packlets/validation/array.d.ts.map +0 -1
  152. package/lib/packlets/validation/array.js.map +0 -1
  153. package/lib/packlets/validation/boolean.d.ts.map +0 -1
  154. package/lib/packlets/validation/boolean.js.map +0 -1
  155. package/lib/packlets/validation/classes.d.ts.map +0 -1
  156. package/lib/packlets/validation/classes.js.map +0 -1
  157. package/lib/packlets/validation/common.d.ts.map +0 -1
  158. package/lib/packlets/validation/common.js.map +0 -1
  159. package/lib/packlets/validation/field.d.ts.map +0 -1
  160. package/lib/packlets/validation/field.js.map +0 -1
  161. package/lib/packlets/validation/genericValidator.d.ts.map +0 -1
  162. package/lib/packlets/validation/genericValidator.js.map +0 -1
  163. package/lib/packlets/validation/index.d.ts.map +0 -1
  164. package/lib/packlets/validation/index.js.map +0 -1
  165. package/lib/packlets/validation/number.d.ts.map +0 -1
  166. package/lib/packlets/validation/number.js.map +0 -1
  167. package/lib/packlets/validation/object.d.ts.map +0 -1
  168. package/lib/packlets/validation/object.js.map +0 -1
  169. package/lib/packlets/validation/oneOf.d.ts.map +0 -1
  170. package/lib/packlets/validation/oneOf.js.map +0 -1
  171. package/lib/packlets/validation/string.d.ts.map +0 -1
  172. package/lib/packlets/validation/string.js.map +0 -1
  173. package/lib/packlets/validation/traits.d.ts.map +0 -1
  174. package/lib/packlets/validation/traits.js.map +0 -1
  175. package/lib/packlets/validation/typeGuard.d.ts.map +0 -1
  176. package/lib/packlets/validation/typeGuard.js.map +0 -1
  177. package/lib/packlets/validation/validator.d.ts.map +0 -1
  178. package/lib/packlets/validation/validator.js.map +0 -1
  179. package/lib/packlets/validation/validatorBase.d.ts.map +0 -1
  180. package/lib/packlets/validation/validatorBase.js.map +0 -1
  181. package/lib/packlets/validation/validators.d.ts.map +0 -1
  182. package/lib/packlets/validation/validators.js.map +0 -1
@@ -0,0 +1,88 @@
1
+ import { ILogger, ReporterLogLevel } from './logger';
2
+ import { IResultReporter, MessageLogLevel, Success } from '../base';
3
+ /**
4
+ * A function that formats a value for logging.
5
+ * @public
6
+ */
7
+ export type LogValueFormatter<T, TD = unknown> = (value: T, detail?: TD) => string;
8
+ /**
9
+ * A function that formats a message for logging.
10
+ * @public
11
+ */
12
+ export type LogMessageFormatter<TD = unknown> = (message: string, detail?: TD) => string;
13
+ /**
14
+ * Parameters for creating a {@link Logging.LogReporter | LogReporter}.
15
+ * @public
16
+ */
17
+ export interface ILogReporterCreateParams<T, TD = unknown> {
18
+ logger?: ILogger;
19
+ valueFormatter?: LogValueFormatter<T, TD>;
20
+ messageFormatter?: LogMessageFormatter<TD>;
21
+ }
22
+ /**
23
+ * Abstract base class which wraps an existing {@link Logging.ILogger | ILogger} to implement
24
+ * both {@link Logging.ILogger | ILogger} and {@link IResultReporter | IResultReporter}.
25
+ * @public
26
+ */
27
+ export declare class LogReporter<T, TD = unknown> implements ILogger, IResultReporter<T, TD> {
28
+ /**
29
+ * The logger to wrap.
30
+ * @internal
31
+ */
32
+ protected readonly _logger: ILogger;
33
+ /**
34
+ * The formatter to use for values.
35
+ * @internal
36
+ */
37
+ protected readonly _valueFormatter: LogValueFormatter<T, TD>;
38
+ /**
39
+ * The formatter to use for messages.
40
+ * @internal
41
+ */
42
+ protected readonly _messageFormatter: LogMessageFormatter<TD>;
43
+ /**
44
+ * Creates a new {@link Logging.LogReporter | LogReporter}.
45
+ * @param params - The parameters for creating the {@link Logging.LogReporter | LogReporter}.
46
+ */
47
+ constructor(params?: ILogReporterCreateParams<T, TD>);
48
+ /**
49
+ * {@inheritDoc Logging.ILogger.logLevel}
50
+ */
51
+ get logLevel(): ReporterLogLevel;
52
+ /**
53
+ * {@inheritDoc Logging.ILogger.detail}
54
+ */
55
+ detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
56
+ /**
57
+ * {@inheritDoc Logging.ILogger.info}
58
+ */
59
+ info(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
60
+ /**
61
+ * {@inheritDoc Logging.ILogger.warn}
62
+ */
63
+ warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
64
+ /**
65
+ * {@inheritDoc Logging.ILogger.error}
66
+ */
67
+ error(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
68
+ /**
69
+ * {@inheritDoc Logging.ILogger.log}
70
+ */
71
+ log(level: MessageLogLevel, message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
72
+ /**
73
+ * {@inheritDoc IResultReporter.reportSuccess}
74
+ */
75
+ reportSuccess(level: MessageLogLevel, value: T, detail?: TD): void;
76
+ /**
77
+ * {@inheritDoc IResultReporter.reportFailure}
78
+ */
79
+ reportFailure(level: MessageLogLevel, message: string, detail?: TD): void;
80
+ /**
81
+ * Generic method to try to format an object for logging.
82
+ * @param value - The value to format.
83
+ * @param detail - The detail to format.
84
+ * @returns
85
+ */
86
+ static tryFormatObject<T = unknown, TD = unknown>(value: T, detail?: TD): string;
87
+ }
88
+ //# sourceMappingURL=logReporter.d.ts.map
@@ -0,0 +1,105 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.LogReporter = void 0;
4
+ /*
5
+ * Copyright (c) 2020 Erik Fortune
6
+ *
7
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ * of this software and associated documentation files (the "Software"), to deal
9
+ * in the Software without restriction, including without limitation the rights
10
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ * copies of the Software, and to permit persons to whom the Software is
12
+ * furnished to do so, subject to the following conditions:
13
+ *
14
+ * The above copyright notice and this permission notice shall be included in all
15
+ * copies or substantial portions of the Software.
16
+ *
17
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23
+ * SOFTWARE.
24
+ */
25
+ const logger_1 = require("./logger");
26
+ /**
27
+ * Abstract base class which wraps an existing {@link Logging.ILogger | ILogger} to implement
28
+ * both {@link Logging.ILogger | ILogger} and {@link IResultReporter | IResultReporter}.
29
+ * @public
30
+ */
31
+ class LogReporter {
32
+ /**
33
+ * Creates a new {@link Logging.LogReporter | LogReporter}.
34
+ * @param params - The parameters for creating the {@link Logging.LogReporter | LogReporter}.
35
+ */
36
+ constructor(params) {
37
+ var _a, _b, _c;
38
+ /* c8 ignore next 1 */
39
+ params = params !== null && params !== void 0 ? params : {};
40
+ this._logger = (_a = params.logger) !== null && _a !== void 0 ? _a : new logger_1.NoOpLogger();
41
+ this._valueFormatter = (_b = params.valueFormatter) !== null && _b !== void 0 ? _b : LogReporter.tryFormatObject;
42
+ this._messageFormatter = (_c = params.messageFormatter) !== null && _c !== void 0 ? _c : ((message, __detail) => message);
43
+ }
44
+ /**
45
+ * {@inheritDoc Logging.ILogger.logLevel}
46
+ */
47
+ get logLevel() {
48
+ return this._logger.logLevel;
49
+ }
50
+ /**
51
+ * {@inheritDoc Logging.ILogger.detail}
52
+ */
53
+ detail(message, ...parameters) {
54
+ return this._logger.detail(message, ...parameters);
55
+ }
56
+ /**
57
+ * {@inheritDoc Logging.ILogger.info}
58
+ */
59
+ info(message, ...parameters) {
60
+ return this._logger.info(message, ...parameters);
61
+ }
62
+ /**
63
+ * {@inheritDoc Logging.ILogger.warn}
64
+ */
65
+ warn(message, ...parameters) {
66
+ return this._logger.warn(message, ...parameters);
67
+ }
68
+ /**
69
+ * {@inheritDoc Logging.ILogger.error}
70
+ */
71
+ error(message, ...parameters) {
72
+ return this._logger.error(message, ...parameters);
73
+ }
74
+ /**
75
+ * {@inheritDoc Logging.ILogger.log}
76
+ */
77
+ log(level, message, ...parameters) {
78
+ return this._logger.log(level, message, ...parameters);
79
+ }
80
+ /**
81
+ * {@inheritDoc IResultReporter.reportSuccess}
82
+ */
83
+ reportSuccess(level, value, detail) {
84
+ const formatted = this._valueFormatter(value, detail);
85
+ this.log(level, formatted);
86
+ }
87
+ /**
88
+ * {@inheritDoc IResultReporter.reportFailure}
89
+ */
90
+ reportFailure(level, message, detail) {
91
+ const formatted = this._messageFormatter(message, detail);
92
+ this.log(level, formatted);
93
+ }
94
+ /**
95
+ * Generic method to try to format an object for logging.
96
+ * @param value - The value to format.
97
+ * @param detail - The detail to format.
98
+ * @returns
99
+ */
100
+ static tryFormatObject(value, detail) {
101
+ return (0, logger_1.stringifyLogValue)(value);
102
+ }
103
+ }
104
+ exports.LogReporter = LogReporter;
105
+ //# sourceMappingURL=logReporter.js.map
@@ -0,0 +1,205 @@
1
+ import { MessageLogLevel, Success } from '../base';
2
+ /**
3
+ * The level of logging to be used.
4
+ * @public
5
+ */
6
+ export type ReporterLogLevel = 'all' | 'detail' | 'info' | 'warning' | 'error' | 'silent';
7
+ /**
8
+ * Compares two log levels.
9
+ * @param message - The first log level.
10
+ * @param reporter - The second log level.
11
+ * @returns `true` if the message should be logged, `false` if it should be suppressed.
12
+ * @public
13
+ */
14
+ export declare function shouldLog(message: MessageLogLevel, reporter: ReporterLogLevel): boolean;
15
+ /**
16
+ * Stringifies an arbitrary value for logging.
17
+ * @param value - The value to stringify.
18
+ * @returns The stringified value.
19
+ * @param maxLength - The maximum length of the stringified value.
20
+ * @public
21
+ */
22
+ export declare function stringifyLogValue(value: unknown, maxLength?: number): string;
23
+ /**
24
+ * Generic Result-aware logger interface with multiple levels of logging.
25
+ * @public
26
+ */
27
+ export interface ILogger {
28
+ /**
29
+ * The level of logging to be used.
30
+ */
31
+ readonly logLevel: ReporterLogLevel;
32
+ /**
33
+ * Logs a message at the given level.
34
+ * @param level - The level of the message.
35
+ * @param message - The message to log.
36
+ * @param parameters - The parameters to log.
37
+ * @returns `Success` with the logged message if the level is enabled, or
38
+ * `Success` with `undefined` if the message is suppressed.
39
+ */
40
+ log(level: MessageLogLevel, message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
41
+ /**
42
+ * Logs a detail message.
43
+ * @param message - The message to log.
44
+ * @param parameters - The parameters to log.
45
+ * @returns `Success` with the logged message if the level is enabled, or
46
+ * `Success` with `undefined` if the message is suppressed.
47
+ */
48
+ detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
49
+ /**
50
+ * Logs an info message.
51
+ * @param message - The message to log.
52
+ * @param parameters - The parameters to log.
53
+ * @returns `Success` with the logged message if the level is enabled, or
54
+ * `Success` with `undefined` if the message is suppressed.
55
+ */
56
+ info(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
57
+ /**
58
+ * Logs a warning message.
59
+ * @param message - The message to log.
60
+ * @param parameters - The parameters to log.
61
+ * @returns `Success` with the logged message if the level is enabled, or
62
+ * `Success` with `undefined` if the message is suppressed.
63
+ */
64
+ warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
65
+ /**
66
+ * Logs an error message.
67
+ * @param message - The message to log.
68
+ * @param parameters - The parameters to log.
69
+ * @returns `Success` with the logged message if the level is enabled, or
70
+ * `Success` with `undefined` if the message is suppressed.
71
+ */
72
+ error(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
73
+ }
74
+ /**
75
+ * Abstract base class which implements {@link Logging.ILogger | ILogger}.
76
+ * @public
77
+ */
78
+ export declare abstract class LoggerBase implements ILogger {
79
+ /**
80
+ * {@inheritDoc Logging.ILogger.logLevel}
81
+ */
82
+ logLevel: ReporterLogLevel;
83
+ protected constructor(logLevel?: ReporterLogLevel);
84
+ /**
85
+ * {@inheritDoc Logging.ILogger.detail}
86
+ */
87
+ detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
88
+ /**
89
+ * {@inheritDoc Logging.ILogger.info}
90
+ */
91
+ info(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
92
+ /**
93
+ * {@inheritDoc Logging.ILogger.warn}
94
+ */
95
+ warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
96
+ /**
97
+ * {@inheritDoc Logging.ILogger.error}
98
+ */
99
+ error(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
100
+ /**
101
+ * {@inheritDoc Logging.ILogger.log}
102
+ */
103
+ log(level: MessageLogLevel, message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
104
+ /**
105
+ * Formats a message and parameters into a string.
106
+ * @param message - The message to format.
107
+ * @param parameters - The parameters to format.
108
+ * @returns The formatted message.
109
+ * @public
110
+ */
111
+ protected _format(message?: unknown, ...parameters: unknown[]): string;
112
+ /**
113
+ * Inner method called for suppressed log messages.
114
+ * @public
115
+ */
116
+ protected _suppressLog(__level: MessageLogLevel, __message?: unknown, ...__parameters: unknown[]): Success<undefined>;
117
+ /**
118
+ * Inner method called for logged messages. Should be implemented by derived classes.
119
+ * @param message - The message to log.
120
+ * @param level - The {@link MessageLogLevel | level} of the message.
121
+ * @returns `Success` with the logged message, or `Success` with `undefined` if the message is suppressed.
122
+ * @public
123
+ */
124
+ protected abstract _log(message: string, level: MessageLogLevel): Success<string | undefined>;
125
+ }
126
+ /**
127
+ * An in-memory logger that stores logged and suppressed messages.
128
+ * @public
129
+ */
130
+ export declare class InMemoryLogger extends LoggerBase {
131
+ /**
132
+ * The messages that have been logged.
133
+ * @internal
134
+ */
135
+ private _logged;
136
+ /**
137
+ * The messages that have been suppressed.
138
+ * @internal
139
+ */
140
+ private _suppressed;
141
+ /**
142
+ * Creates a new in-memory logger.
143
+ * @param logLevel - The level of logging to be used.
144
+ */
145
+ constructor(logLevel?: ReporterLogLevel);
146
+ /**
147
+ * The messages that have been logged.
148
+ */
149
+ get logged(): string[];
150
+ /**
151
+ * The messages that have been suppressed.
152
+ */
153
+ get suppressed(): string[];
154
+ /**
155
+ * Clears the logged and suppressed messages.
156
+ */
157
+ clear(): void;
158
+ /**
159
+ * {@inheritDoc Logging.LoggerBase._log}
160
+ * @internal
161
+ */
162
+ protected _log(message: string, __level: MessageLogLevel): Success<string | undefined>;
163
+ /**
164
+ * {@inheritDoc Logging.LoggerBase._suppressLog}
165
+ * @param level - The level of the message.
166
+ * @param message - The message to suppress.
167
+ * @param parameters - The parameters to suppress.
168
+ * @returns `Success` with `undefined` if the message is suppressed.
169
+ * @internal
170
+ */
171
+ protected _suppressLog(level: MessageLogLevel, message?: unknown, ...parameters: unknown[]): Success<undefined>;
172
+ }
173
+ /**
174
+ * A console logger that outputs messages to the console.
175
+ * @public
176
+ */
177
+ export declare class ConsoleLogger extends LoggerBase {
178
+ /**
179
+ * Creates a new console logger.
180
+ * @param logLevel - The level of logging to be used.
181
+ */
182
+ constructor(logLevel?: ReporterLogLevel);
183
+ /**
184
+ * {@inheritDoc Logging.LoggerBase._log}
185
+ * @internal
186
+ */
187
+ protected _log(message: string, level: MessageLogLevel): Success<string | undefined>;
188
+ }
189
+ /**
190
+ * A no-op {@link Logging.LoggerBase | LoggerBase} that does not log anything.
191
+ * @public
192
+ */
193
+ export declare class NoOpLogger extends LoggerBase {
194
+ /**
195
+ * Creates a new no-op logger.
196
+ * @param logLevel - The level of logging to be used.
197
+ */
198
+ constructor(logLevel?: ReporterLogLevel);
199
+ /**
200
+ * {@inheritDoc Logging.LoggerBase._log}
201
+ * @internal
202
+ */
203
+ protected _log(message: string, __level: MessageLogLevel): Success<string | undefined>;
204
+ }
205
+ //# sourceMappingURL=logger.d.ts.map
@@ -0,0 +1,267 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.NoOpLogger = exports.ConsoleLogger = exports.InMemoryLogger = exports.LoggerBase = void 0;
4
+ exports.shouldLog = shouldLog;
5
+ exports.stringifyLogValue = stringifyLogValue;
6
+ /*
7
+ * Copyright (c) 2020 Erik Fortune
8
+ *
9
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
10
+ * of this software and associated documentation files (the "Software"), to deal
11
+ * in the Software without restriction, including without limitation the rights
12
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
+ * copies of the Software, and to permit persons to whom the Software is
14
+ * furnished to do so, subject to the following conditions:
15
+ *
16
+ * The above copyright notice and this permission notice shall be included in all
17
+ * copies or substantial portions of the Software.
18
+ *
19
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25
+ * SOFTWARE.
26
+ */
27
+ const base_1 = require("../base");
28
+ /**
29
+ * Compares two log levels.
30
+ * @param message - The first log level.
31
+ * @param reporter - The second log level.
32
+ * @returns `true` if the message should be logged, `false` if it should be suppressed.
33
+ * @public
34
+ */
35
+ function shouldLog(message, reporter) {
36
+ if (reporter === 'all') {
37
+ return true; // 'all' logs everything, including 'quiet'
38
+ }
39
+ if (reporter === 'silent') {
40
+ return false; // 'silent' suppresses everything
41
+ }
42
+ if (message === 'quiet') {
43
+ return false; // 'quiet' messages only show when reporter is 'all'
44
+ }
45
+ switch (reporter) {
46
+ case 'error':
47
+ return message === 'error';
48
+ case 'warning':
49
+ return message === 'warning' || message === 'error';
50
+ case 'info':
51
+ return message !== 'detail';
52
+ }
53
+ return true;
54
+ }
55
+ /**
56
+ * Stringifies an arbitrary value for logging.
57
+ * @param value - The value to stringify.
58
+ * @returns The stringified value.
59
+ * @param maxLength - The maximum length of the stringified value.
60
+ * @public
61
+ */
62
+ function stringifyLogValue(value, maxLength) {
63
+ maxLength = maxLength !== null && maxLength !== void 0 ? maxLength : 40;
64
+ if (typeof value === 'string') {
65
+ return value;
66
+ }
67
+ const str = String(value);
68
+ if (str === '[object Object]') {
69
+ return (0, base_1.captureResult)(() => JSON.stringify(value))
70
+ .onSuccess((s) => {
71
+ return (0, base_1.succeed)(s.length < maxLength ? s : s.substring(0, maxLength - 3) + '...');
72
+ })
73
+ .orDefault(str);
74
+ }
75
+ return str;
76
+ }
77
+ /**
78
+ * Abstract base class which implements {@link Logging.ILogger | ILogger}.
79
+ * @public
80
+ */
81
+ class LoggerBase {
82
+ constructor(logLevel) {
83
+ /**
84
+ * {@inheritDoc Logging.ILogger.logLevel}
85
+ */
86
+ this.logLevel = 'info';
87
+ this.logLevel = logLevel !== null && logLevel !== void 0 ? logLevel : 'info';
88
+ }
89
+ /**
90
+ * {@inheritDoc Logging.ILogger.detail}
91
+ */
92
+ detail(message, ...parameters) {
93
+ return this.log('detail', message, ...parameters);
94
+ }
95
+ /**
96
+ * {@inheritDoc Logging.ILogger.info}
97
+ */
98
+ info(message, ...parameters) {
99
+ return this.log('info', message, ...parameters);
100
+ }
101
+ /**
102
+ * {@inheritDoc Logging.ILogger.warn}
103
+ */
104
+ warn(message, ...parameters) {
105
+ return this.log('warning', message, ...parameters);
106
+ }
107
+ /**
108
+ * {@inheritDoc Logging.ILogger.error}
109
+ */
110
+ error(message, ...parameters) {
111
+ return this.log('error', message, ...parameters);
112
+ }
113
+ /**
114
+ * {@inheritDoc Logging.ILogger.log}
115
+ */
116
+ log(level, message, ...parameters) {
117
+ if (shouldLog(level, this.logLevel)) {
118
+ const formatted = this._format(message, ...parameters);
119
+ return this._log(formatted, level);
120
+ }
121
+ return this._suppressLog(level, message, ...parameters);
122
+ }
123
+ /**
124
+ * Formats a message and parameters into a string.
125
+ * @param message - The message to format.
126
+ * @param parameters - The parameters to format.
127
+ * @returns The formatted message.
128
+ * @public
129
+ */
130
+ _format(message, ...parameters) {
131
+ const raw = [message, ...parameters];
132
+ const filtered = raw.filter((m) => m !== undefined);
133
+ const strings = filtered.map((m) => stringifyLogValue(m));
134
+ const joined = strings.join('');
135
+ return joined;
136
+ }
137
+ /**
138
+ * Inner method called for suppressed log messages.
139
+ * @public
140
+ */
141
+ _suppressLog(__level, __message, ...__parameters) {
142
+ return (0, base_1.succeed)(undefined);
143
+ }
144
+ }
145
+ exports.LoggerBase = LoggerBase;
146
+ /**
147
+ * An in-memory logger that stores logged and suppressed messages.
148
+ * @public
149
+ */
150
+ class InMemoryLogger extends LoggerBase {
151
+ /**
152
+ * Creates a new in-memory logger.
153
+ * @param logLevel - The level of logging to be used.
154
+ */
155
+ constructor(logLevel) {
156
+ super(logLevel);
157
+ /**
158
+ * The messages that have been logged.
159
+ * @internal
160
+ */
161
+ this._logged = [];
162
+ /**
163
+ * The messages that have been suppressed.
164
+ * @internal
165
+ */
166
+ this._suppressed = [];
167
+ }
168
+ /**
169
+ * The messages that have been logged.
170
+ */
171
+ get logged() {
172
+ return this._logged;
173
+ }
174
+ /**
175
+ * The messages that have been suppressed.
176
+ */
177
+ get suppressed() {
178
+ return this._suppressed;
179
+ }
180
+ /**
181
+ * Clears the logged and suppressed messages.
182
+ */
183
+ clear() {
184
+ this._logged = [];
185
+ this._suppressed = [];
186
+ }
187
+ /**
188
+ * {@inheritDoc Logging.LoggerBase._log}
189
+ * @internal
190
+ */
191
+ _log(message, __level) {
192
+ this._logged.push(message);
193
+ return (0, base_1.succeed)(message);
194
+ }
195
+ /**
196
+ * {@inheritDoc Logging.LoggerBase._suppressLog}
197
+ * @param level - The level of the message.
198
+ * @param message - The message to suppress.
199
+ * @param parameters - The parameters to suppress.
200
+ * @returns `Success` with `undefined` if the message is suppressed.
201
+ * @internal
202
+ */
203
+ _suppressLog(level, message, ...parameters) {
204
+ const formatted = this._format(message, ...parameters);
205
+ this._suppressed.push(formatted);
206
+ return (0, base_1.succeed)(undefined);
207
+ }
208
+ }
209
+ exports.InMemoryLogger = InMemoryLogger;
210
+ /**
211
+ * A console logger that outputs messages to the console.
212
+ * @public
213
+ */
214
+ class ConsoleLogger extends LoggerBase {
215
+ /**
216
+ * Creates a new console logger.
217
+ * @param logLevel - The level of logging to be used.
218
+ */
219
+ constructor(logLevel) {
220
+ super(logLevel);
221
+ }
222
+ /**
223
+ * {@inheritDoc Logging.LoggerBase._log}
224
+ * @internal
225
+ */
226
+ _log(message, level) {
227
+ switch (level) {
228
+ case 'error':
229
+ console.error(message);
230
+ break;
231
+ case 'warning':
232
+ console.warn(message);
233
+ break;
234
+ case 'info':
235
+ console.info(message);
236
+ break;
237
+ default:
238
+ console.log(message);
239
+ break;
240
+ }
241
+ return (0, base_1.succeed)(message);
242
+ }
243
+ }
244
+ exports.ConsoleLogger = ConsoleLogger;
245
+ /**
246
+ * A no-op {@link Logging.LoggerBase | LoggerBase} that does not log anything.
247
+ * @public
248
+ */
249
+ class NoOpLogger extends LoggerBase {
250
+ /**
251
+ * Creates a new no-op logger.
252
+ * @param logLevel - The level of logging to be used.
253
+ */
254
+ constructor(logLevel) {
255
+ super(logLevel);
256
+ }
257
+ /**
258
+ * {@inheritDoc Logging.LoggerBase._log}
259
+ * @internal
260
+ */
261
+ _log(message, __level) {
262
+ // no-op
263
+ return (0, base_1.succeed)(message);
264
+ }
265
+ }
266
+ exports.NoOpLogger = NoOpLogger;
267
+ //# sourceMappingURL=logger.js.map
@@ -32,9 +32,10 @@ export declare class ArrayValidator<T, TC = unknown> extends ValidatorBase<T[],
32
32
  * validator.
33
33
  * @param from - The `unknown` value to be tested.
34
34
  * @param context - Optional validation context will be propagated to element validator.
35
+ * @param self - Optional self-reference for recursive validation.
35
36
  * @returns Returns `true` if `from` is an `array` of valid elements, or
36
37
  * {@link Failure} with an error message if not.
37
38
  */
38
- protected _validate<T>(from: unknown, context?: TC): boolean | Failure<T>;
39
+ protected _validate(from: unknown, context?: TC, self?: Validator<T[], TC>): boolean | Failure<T[]>;
39
40
  }
40
41
  //# sourceMappingURL=array.d.ts.map
@@ -47,10 +47,11 @@ class ArrayValidator extends validatorBase_1.ValidatorBase {
47
47
  * validator.
48
48
  * @param from - The `unknown` value to be tested.
49
49
  * @param context - Optional validation context will be propagated to element validator.
50
+ * @param self - Optional self-reference for recursive validation.
50
51
  * @returns Returns `true` if `from` is an `array` of valid elements, or
51
52
  * {@link Failure} with an error message if not.
52
53
  */
53
- _validate(from, context) {
54
+ _validate(from, context, self) {
54
55
  if (Array.isArray(from)) {
55
56
  for (const elem of from) {
56
57
  const result = this._validateElement.validate(elem, context);