@fgv/ts-utils 5.0.0-22 → 5.0.0-24

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 (187) hide show
  1. package/CHANGELOG.json +0 -21
  2. package/lib/index.d.ts +2 -1
  3. package/lib/index.js +3 -1
  4. package/lib/packlets/base/index.d.ts +0 -2
  5. package/lib/packlets/base/index.js +1 -25
  6. package/lib/packlets/base/result.d.ts +49 -0
  7. package/lib/packlets/base/result.js +36 -0
  8. package/lib/packlets/collections/collector.d.ts +9 -0
  9. package/lib/packlets/collections/collector.js +6 -0
  10. package/lib/packlets/collections/validatingCollector.d.ts +5 -1
  11. package/lib/packlets/hash/hashingNormalizer.js +4 -3
  12. package/lib/packlets/logging/index.d.ts +3 -0
  13. package/{src/packlets/base/index.ts → lib/packlets/logging/index.js} +19 -10
  14. package/lib/packlets/logging/logReporter.d.ts +69 -0
  15. package/lib/packlets/logging/logReporter.js +72 -0
  16. package/lib/packlets/logging/logger.d.ts +183 -0
  17. package/lib/packlets/logging/logger.js +237 -0
  18. package/package.json +6 -6
  19. package/.vscode/launch.json +0 -16
  20. package/.vscode/settings.json +0 -36
  21. package/dist/ts-utils.d.ts +0 -4832
  22. package/dist/tsdoc-metadata.json +0 -11
  23. package/lib/packlets/base/logger.d.ts +0 -52
  24. package/lib/packlets/base/logger.js +0 -128
  25. package/lib/test/helpers/jest/helpers/fsHelpers.d.ts +0 -52
  26. package/lib/test/helpers/jest/helpers/fsHelpers.js +0 -180
  27. package/lib/test/helpers/jest/helpers/index.d.ts +0 -2
  28. package/lib/test/helpers/jest/helpers/index.js +0 -18
  29. package/lib/test/helpers/jest/index.d.ts +0 -3
  30. package/lib/test/helpers/jest/index.js +0 -27
  31. package/lib/test/helpers/jest/matchers/index.d.ts +0 -16
  32. package/lib/test/helpers/jest/matchers/index.js +0 -19
  33. package/lib/test/helpers/jest/matchers/toFail/index.d.ts +0 -16
  34. package/lib/test/helpers/jest/matchers/toFail/index.js +0 -25
  35. package/lib/test/helpers/jest/matchers/toFail/predicate.d.ts +0 -4
  36. package/lib/test/helpers/jest/matchers/toFail/predicate.js +0 -9
  37. package/lib/test/helpers/jest/matchers/toFailTest/index.d.ts +0 -16
  38. package/lib/test/helpers/jest/matchers/toFailTest/index.js +0 -30
  39. package/lib/test/helpers/jest/matchers/toFailTest/predicate.d.ts +0 -3
  40. package/lib/test/helpers/jest/matchers/toFailTest/predicate.js +0 -12
  41. package/lib/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/index.d.ts +0 -17
  42. package/lib/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/index.js +0 -26
  43. package/lib/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/predicate.d.ts +0 -4
  44. package/lib/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/predicate.js +0 -15
  45. package/lib/test/helpers/jest/matchers/toFailTestWith/index.d.ts +0 -18
  46. package/lib/test/helpers/jest/matchers/toFailTestWith/index.js +0 -31
  47. package/lib/test/helpers/jest/matchers/toFailTestWith/predicate.d.ts +0 -4
  48. package/lib/test/helpers/jest/matchers/toFailTestWith/predicate.js +0 -30
  49. package/lib/test/helpers/jest/matchers/toFailWith/index.d.ts +0 -18
  50. package/lib/test/helpers/jest/matchers/toFailWith/index.js +0 -29
  51. package/lib/test/helpers/jest/matchers/toFailWith/predicate.d.ts +0 -4
  52. package/lib/test/helpers/jest/matchers/toFailWith/predicate.js +0 -20
  53. package/lib/test/helpers/jest/matchers/toFailWithDetail/index.d.ts +0 -19
  54. package/lib/test/helpers/jest/matchers/toFailWithDetail/index.js +0 -29
  55. package/lib/test/helpers/jest/matchers/toFailWithDetail/predicate.d.ts +0 -4
  56. package/lib/test/helpers/jest/matchers/toFailWithDetail/predicate.js +0 -26
  57. package/lib/test/helpers/jest/matchers/toSucceed/index.d.ts +0 -16
  58. package/lib/test/helpers/jest/matchers/toSucceed/index.js +0 -25
  59. package/lib/test/helpers/jest/matchers/toSucceed/predicate.d.ts +0 -4
  60. package/lib/test/helpers/jest/matchers/toSucceed/predicate.js +0 -9
  61. package/lib/test/helpers/jest/matchers/toSucceedAndMatchInlineSnapshot/index.d.ts +0 -17
  62. package/lib/test/helpers/jest/matchers/toSucceedAndMatchInlineSnapshot/index.js +0 -26
  63. package/lib/test/helpers/jest/matchers/toSucceedAndMatchSnapshot/index.d.ts +0 -17
  64. package/lib/test/helpers/jest/matchers/toSucceedAndMatchSnapshot/index.js +0 -26
  65. package/lib/test/helpers/jest/matchers/toSucceedAndSatisfy/index.d.ts +0 -19
  66. package/lib/test/helpers/jest/matchers/toSucceedAndSatisfy/index.js +0 -55
  67. package/lib/test/helpers/jest/matchers/toSucceedAndSatisfy/predicate.d.ts +0 -4
  68. package/lib/test/helpers/jest/matchers/toSucceedAndSatisfy/predicate.js +0 -21
  69. package/lib/test/helpers/jest/matchers/toSucceedWith/index.d.ts +0 -18
  70. package/lib/test/helpers/jest/matchers/toSucceedWith/index.js +0 -29
  71. package/lib/test/helpers/jest/matchers/toSucceedWith/predicate.d.ts +0 -4
  72. package/lib/test/helpers/jest/matchers/toSucceedWith/predicate.js +0 -16
  73. package/lib/test/helpers/jest/matchers/toSucceedWithDetail/index.d.ts +0 -18
  74. package/lib/test/helpers/jest/matchers/toSucceedWithDetail/index.js +0 -29
  75. package/lib/test/helpers/jest/matchers/toSucceedWithDetail/predicate.d.ts +0 -4
  76. package/lib/test/helpers/jest/matchers/toSucceedWithDetail/predicate.js +0 -21
  77. package/lib/test/helpers/jest/resolvers/cli.d.ts +0 -5
  78. package/lib/test/helpers/jest/resolvers/cli.js +0 -48
  79. package/lib/test/helpers/jest/resolvers/ide.d.ts +0 -5
  80. package/lib/test/helpers/jest/resolvers/ide.js +0 -48
  81. package/lib/test/helpers/jest/ts-utils.d.ts +0 -2
  82. package/lib/test/helpers/jest/ts-utils.js +0 -18
  83. package/lib/test/helpers/jest/types/index.d.ts +0 -79
  84. package/lib/test/helpers/jest/types/index.js +0 -4
  85. package/lib/test/helpers/jest/utils/matcherHelpers.d.ts +0 -6
  86. package/lib/test/helpers/jest/utils/matcherHelpers.js +0 -53
  87. package/lib/test/helpers/jest/utils/snapshotResolver.d.ts +0 -4
  88. package/lib/test/helpers/jest/utils/snapshotResolver.js +0 -19
  89. package/lib/test/unit/collections/collectible.test.d.ts +0 -2
  90. package/lib/test/unit/collections/collector.test.d.ts +0 -2
  91. package/lib/test/unit/collections/collectors.test.d.ts +0 -2
  92. package/lib/test/unit/collections/convertingCollector.test.d.ts +0 -2
  93. package/lib/test/unit/collections/helpers.d.ts +0 -44
  94. package/lib/test/unit/collections/helpers.js +0 -115
  95. package/lib/test/unit/collections/resultMap.test.d.ts +0 -2
  96. package/lib/test/unit/collections/validatingCollector.test.d.ts +0 -2
  97. package/lib/test/unit/collections/validatingConvertingCollector.test.d.ts +0 -2
  98. package/lib/test/unit/collections/validatingResultMap.test.d.ts +0 -2
  99. package/lib/test/unit/converter.test.d.ts +0 -2
  100. package/lib/test/unit/converters.test.d.ts +0 -2
  101. package/lib/test/unit/defaultingConverter.test.d.ts +0 -2
  102. package/lib/test/unit/file-tree/fileItem.test.d.ts +0 -2
  103. package/lib/test/unit/file-tree/fileTree.test.d.ts +0 -2
  104. package/lib/test/unit/file-tree/fsTree.test.d.ts +0 -2
  105. package/lib/test/unit/file-tree/inMemoryTree.test.d.ts +0 -2
  106. package/lib/test/unit/file-tree/sample/rootFile.json +0 -1
  107. package/lib/test/unit/file-tree/sample/some/other/path/file2.json +0 -1
  108. package/lib/test/unit/file-tree/sample/some/path/below/file4.json +0 -1
  109. package/lib/test/unit/file-tree/sample/some/path/file1.json +0 -1
  110. package/lib/test/unit/file-tree/sample/some/path/file3.json +0 -1
  111. package/lib/test/unit/hash.test.d.ts +0 -2
  112. package/lib/test/unit/logger.test.d.ts +0 -2
  113. package/lib/test/unit/mapResults.test.d.ts +0 -3
  114. package/lib/test/unit/messageAggregator.test.d.ts +0 -3
  115. package/lib/test/unit/normalize.test.d.ts +0 -2
  116. package/lib/test/unit/result.test.d.ts +0 -3
  117. package/lib/test/unit/utils.test.d.ts +0 -3
  118. package/lib/test/unit/validation/array.test.d.ts +0 -2
  119. package/lib/test/unit/validation/boolean.test.d.ts +0 -2
  120. package/lib/test/unit/validation/genericValidator.test.d.ts +0 -2
  121. package/lib/test/unit/validation/number.test.d.ts +0 -2
  122. package/lib/test/unit/validation/object.test.d.ts +0 -2
  123. package/lib/test/unit/validation/oneOf.test.d.ts +0 -2
  124. package/lib/test/unit/validation/recordOf.test.d.ts +0 -2
  125. package/lib/test/unit/validation/recursiveValidation.test.d.ts +0 -2
  126. package/lib/test/unit/validation/string.test.d.ts +0 -2
  127. package/lib/test/unit/validation/traits.test.d.ts +0 -2
  128. package/lib/test/unit/validation/typeGuard.test.d.ts +0 -2
  129. package/lib/test/unit/validation/validators.test.d.ts +0 -2
  130. package/src/index.ts +0 -63
  131. package/src/packlets/base/brand.ts +0 -28
  132. package/src/packlets/base/logger.ts +0 -156
  133. package/src/packlets/base/mapResults.ts +0 -302
  134. package/src/packlets/base/messageAggregator.ts +0 -120
  135. package/src/packlets/base/normalize.ts +0 -144
  136. package/src/packlets/base/result.ts +0 -961
  137. package/src/packlets/base/utils.ts +0 -236
  138. package/src/packlets/collections/collectible.ts +0 -238
  139. package/src/packlets/collections/collector.ts +0 -273
  140. package/src/packlets/collections/collectorValidator.ts +0 -178
  141. package/src/packlets/collections/common.ts +0 -27
  142. package/src/packlets/collections/convertingCollector.ts +0 -223
  143. package/src/packlets/collections/convertingCollectorValidator.ts +0 -164
  144. package/src/packlets/collections/index.ts +0 -39
  145. package/src/packlets/collections/keyValueConverters.ts +0 -142
  146. package/src/packlets/collections/readonlyResultMap.ts +0 -99
  147. package/src/packlets/collections/resultMap.ts +0 -322
  148. package/src/packlets/collections/resultMapValidator.ts +0 -188
  149. package/src/packlets/collections/utils.ts +0 -33
  150. package/src/packlets/collections/validatingCollector.ts +0 -123
  151. package/src/packlets/collections/validatingConvertingCollector.ts +0 -113
  152. package/src/packlets/collections/validatingResultMap.ts +0 -94
  153. package/src/packlets/conversion/baseConverter.ts +0 -330
  154. package/src/packlets/conversion/converter.ts +0 -260
  155. package/src/packlets/conversion/converters.ts +0 -1039
  156. package/src/packlets/conversion/defaultingConverter.ts +0 -188
  157. package/src/packlets/conversion/index.ts +0 -30
  158. package/src/packlets/conversion/objectConverter.ts +0 -259
  159. package/src/packlets/conversion/stringConverter.ts +0 -165
  160. package/src/packlets/file-tree/directoryItem.ts +0 -84
  161. package/src/packlets/file-tree/fileItem.ts +0 -119
  162. package/src/packlets/file-tree/fileTree.ts +0 -152
  163. package/src/packlets/file-tree/fileTreeAccessors.ts +0 -176
  164. package/src/packlets/file-tree/fsTree.ts +0 -118
  165. package/src/packlets/file-tree/in-memory/inMemoryTree.ts +0 -171
  166. package/src/packlets/file-tree/in-memory/index.ts +0 -23
  167. package/src/packlets/file-tree/in-memory/treeBuilder.ts +0 -203
  168. package/src/packlets/file-tree/index.ts +0 -31
  169. package/src/packlets/hash/crcNormalizer.ts +0 -81
  170. package/src/packlets/hash/hashingNormalizer.ts +0 -102
  171. package/src/packlets/hash/index.ts +0 -24
  172. package/src/packlets/validation/array.ts +0 -84
  173. package/src/packlets/validation/boolean.ts +0 -63
  174. package/src/packlets/validation/classes.ts +0 -38
  175. package/src/packlets/validation/common.ts +0 -28
  176. package/src/packlets/validation/field.ts +0 -99
  177. package/src/packlets/validation/genericValidator.ts +0 -204
  178. package/src/packlets/validation/index.ts +0 -31
  179. package/src/packlets/validation/number.ts +0 -66
  180. package/src/packlets/validation/object.ts +0 -208
  181. package/src/packlets/validation/oneOf.ts +0 -78
  182. package/src/packlets/validation/string.ts +0 -66
  183. package/src/packlets/validation/traits.ts +0 -113
  184. package/src/packlets/validation/typeGuard.ts +0 -83
  185. package/src/packlets/validation/validator.ts +0 -157
  186. package/src/packlets/validation/validatorBase.ts +0 -66
  187. package/src/packlets/validation/validators.ts +0 -254
@@ -1,26 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- /* eslint-disable @typescript-eslint/no-unused-vars,no-unused-vars */
4
- const predicate_1 = require("./predicate");
5
- const jest_matcher_utils_1 = require("jest-matcher-utils");
6
- const jest_snapshot_1 = require("jest-snapshot");
7
- exports.default = {
8
- toFailTestAndMatchSnapshot: function (cb) {
9
- const context = this;
10
- const cbResult = (0, predicate_1.predicate)(cb);
11
- if (cbResult.isFailure()) {
12
- return {
13
- pass: false,
14
- message: () => {
15
- return [
16
- (0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`, 'callback'),
17
- ' Expected: Callback to fail with an error that matches snapshot',
18
- ' Received: Callback succeeded'
19
- ].join('\n');
20
- }
21
- };
22
- }
23
- return jest_snapshot_1.toMatchSnapshot.call(context, cbResult.value, 'toFailTestAndMatchSnapshot');
24
- }
25
- };
26
- //# sourceMappingURL=index.js.map
@@ -1,4 +0,0 @@
1
- import { Result } from '../../ts-utils';
2
- export declare const matcherName: string;
3
- export declare function predicate<T>(cb: () => void): Result<string>;
4
- //# sourceMappingURL=predicate.d.ts.map
@@ -1,15 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.matcherName = void 0;
4
- exports.predicate = predicate;
5
- /* eslint-disable @typescript-eslint/no-unused-vars,no-unused-vars */
6
- const ts_utils_1 = require("../../ts-utils");
7
- exports.matcherName = 'toFailTestAndMatchSnapshot';
8
- function predicate(cb) {
9
- const cbResult = (0, ts_utils_1.captureResult)(() => cb());
10
- if (cbResult.isFailure()) {
11
- return (0, ts_utils_1.succeed)(cbResult.message);
12
- }
13
- return (0, ts_utils_1.fail)('Callback did not fail');
14
- }
15
- //# sourceMappingURL=predicate.js.map
@@ -1,18 +0,0 @@
1
- declare global {
2
- namespace jest {
3
- interface Matchers<R, T> {
4
- /**
5
- * Use .toFailTestWith to test a custom matcher by
6
- * verifying that a test case fails as expected and
7
- * reports an error matching a supplied value.
8
- * @param expected -
9
- */
10
- toFailTestWith<T>(expected: string | string[] | RegExp): R;
11
- }
12
- }
13
- }
14
- declare const _default: {
15
- toFailTestWith: <T>(cb: () => void, expected: RegExp | string | string[]) => jest.CustomMatcherResult;
16
- };
17
- export default _default;
18
- //# sourceMappingURL=index.d.ts.map
@@ -1,31 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const predicate_1 = require("./predicate");
4
- const jest_matcher_utils_1 = require("jest-matcher-utils");
5
- const matcherHelpers_1 = require("../../utils/matcherHelpers");
6
- function passMessage(cbResult, expected) {
7
- return () => [
8
- (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`, 'callback', 'expectedMessage'),
9
- (0, matcherHelpers_1.printExpectedResult)('failure', false, expected),
10
- ` Received: Callback failed with:\n>>>>\n${cbResult.value}\n<<<<`
11
- ].join('\n');
12
- }
13
- function failMessage(cbResult, expected) {
14
- return () => [
15
- (0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`, 'callback', 'expectedMessage'),
16
- (0, matcherHelpers_1.printExpectedResult)('failure', true, expected),
17
- cbResult.message === ''
18
- ? ' Received: Callback succeeded'
19
- : ` Received: Callback failed with:\n>>>>\n${cbResult.message}\n<<<<`
20
- ].join('\n');
21
- }
22
- exports.default = {
23
- toFailTestWith: function (cb, expected) {
24
- const cbResult = (0, predicate_1.predicate)(cb, expected);
25
- if (cbResult.isSuccess()) {
26
- return { pass: true, message: passMessage(cbResult, expected) };
27
- }
28
- return { pass: false, message: failMessage(cbResult, expected) };
29
- }
30
- };
31
- //# sourceMappingURL=index.js.map
@@ -1,4 +0,0 @@
1
- import { Result } from '../../ts-utils';
2
- export declare const matcherName: string;
3
- export declare function predicate<T>(cb: () => void, expected: string | string[] | RegExp): Result<string>;
4
- //# sourceMappingURL=predicate.d.ts.map
@@ -1,30 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.matcherName = void 0;
4
- exports.predicate = predicate;
5
- /* eslint-disable @typescript-eslint/no-unused-vars,no-unused-vars */
6
- const expect_utils_1 = require("@jest/expect-utils");
7
- const jest_matcher_utils_1 = require("jest-matcher-utils");
8
- const ts_utils_1 = require("../../ts-utils");
9
- exports.matcherName = 'toFailTestWith';
10
- function predicate(cb, expected) {
11
- const cbResult = (0, ts_utils_1.captureResult)(() => cb());
12
- if (cbResult.isFailure()) {
13
- let success = false;
14
- if (expected instanceof RegExp) {
15
- success = cbResult.message.match(expected) !== null;
16
- }
17
- else if (typeof expected === 'string') {
18
- success = cbResult.message === expected;
19
- }
20
- else if (Array.isArray(expected)) {
21
- success = (0, expect_utils_1.equals)(cbResult.message.split('\n'), expected);
22
- }
23
- else {
24
- return (0, ts_utils_1.fail)(`Unsupported expected value "${(0, jest_matcher_utils_1.stringify)(expected)}" for toFailTestWith`);
25
- }
26
- return success ? (0, ts_utils_1.succeed)(cbResult.message) : (0, ts_utils_1.fail)(cbResult.message);
27
- }
28
- return (0, ts_utils_1.fail)('');
29
- }
30
- //# sourceMappingURL=predicate.js.map
@@ -1,18 +0,0 @@
1
- import { Result } from '../../../../../index';
2
- declare global {
3
- namespace jest {
4
- interface Matchers<R, T> {
5
- /**
6
- * Use .toFailWith to verify that a Result<T> is a failure
7
- * that matches a supplied string, RegExp or undefined value
8
- * @param message -
9
- */
10
- toFailWith(message: string | RegExp | undefined): R;
11
- }
12
- }
13
- }
14
- declare const _default: {
15
- toFailWith: <T>(received: Result<T>, expected: string | RegExp | undefined) => jest.CustomMatcherResult;
16
- };
17
- export default _default;
18
- //# sourceMappingURL=index.d.ts.map
@@ -1,29 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const matcherHelpers_1 = require("../../utils/matcherHelpers");
4
- const predicate_1 = require("./predicate");
5
- const jest_matcher_utils_1 = require("jest-matcher-utils");
6
- function passMessage(received, expected) {
7
- return () => [
8
- (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`),
9
- (0, matcherHelpers_1.printExpectedResult)('failure', false, expected),
10
- (0, matcherHelpers_1.printReceivedResult)(received)
11
- ].join('\n');
12
- }
13
- function failMessage(received, expected) {
14
- return () => [
15
- (0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`),
16
- (0, matcherHelpers_1.printExpectedResult)('failure', true, expected),
17
- (0, matcherHelpers_1.printReceivedResult)(received)
18
- ].join('\n');
19
- }
20
- exports.default = {
21
- toFailWith: function (received, expected) {
22
- const pass = (0, predicate_1.predicate)(received, expected);
23
- if (pass) {
24
- return { pass: true, message: passMessage(received, expected) };
25
- }
26
- return { pass: false, message: failMessage(received, expected) };
27
- }
28
- };
29
- //# sourceMappingURL=index.js.map
@@ -1,4 +0,0 @@
1
- import { Result } from '../../../../../index';
2
- export declare const matcherName: string;
3
- export declare function predicate<T>(received: Result<T>, expected: string | RegExp | undefined): boolean;
4
- //# sourceMappingURL=predicate.d.ts.map
@@ -1,20 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.matcherName = void 0;
4
- exports.predicate = predicate;
5
- exports.matcherName = 'toFailWith';
6
- function predicate(received, expected) {
7
- if (received.isFailure()) {
8
- if (expected === undefined) {
9
- return received.message === undefined;
10
- }
11
- else if (expected instanceof RegExp) {
12
- return received.message.match(expected) !== null;
13
- }
14
- else {
15
- return received.message === expected;
16
- }
17
- }
18
- return false;
19
- }
20
- //# sourceMappingURL=predicate.js.map
@@ -1,19 +0,0 @@
1
- import { DetailedResult, ResultDetailType } from '../../ts-utils';
2
- declare global {
3
- namespace jest {
4
- interface Matchers<R, T> {
5
- /**
6
- * Use .toFailWithDetail to verify that a DetailedResult<T> is
7
- * a failure that matches both a supplied expected failure message
8
- * (string, RegExp or undefined) and a supplied failure detail.
9
- * @param message -
10
- */
11
- toFailWithDetail(message: string | RegExp | undefined, detail: ResultDetailType<T>): R;
12
- }
13
- }
14
- }
15
- declare const _default: {
16
- toFailWithDetail: <T extends DetailedResult<unknown, unknown>>(received: T, expectedMessage: string | RegExp | undefined, expectedDetail: ResultDetailType<T>) => jest.CustomMatcherResult;
17
- };
18
- export default _default;
19
- //# sourceMappingURL=index.d.ts.map
@@ -1,29 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const matcherHelpers_1 = require("../../utils/matcherHelpers");
4
- const predicate_1 = require("./predicate");
5
- const jest_matcher_utils_1 = require("jest-matcher-utils");
6
- function passMessage(received, expectedMessage, expectedDetail) {
7
- return () => [
8
- (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`),
9
- (0, matcherHelpers_1.printExpectedDetailedResult)('failure', false, expectedMessage, expectedDetail),
10
- (0, matcherHelpers_1.printReceivedDetailedResult)(received)
11
- ].join('\n');
12
- }
13
- function failMessage(received, expectedMessage, expectedDetail) {
14
- return () => [
15
- (0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`),
16
- (0, matcherHelpers_1.printExpectedDetailedResult)('failure', true, expectedMessage, expectedDetail),
17
- (0, matcherHelpers_1.printReceivedDetailedResult)(received)
18
- ].join('\n');
19
- }
20
- exports.default = {
21
- toFailWithDetail: function (received, expectedMessage, expectedDetail) {
22
- const pass = (0, predicate_1.predicate)(received, expectedMessage, expectedDetail);
23
- if (pass) {
24
- return { pass: true, message: passMessage(received, expectedMessage, expectedDetail) };
25
- }
26
- return { pass: false, message: failMessage(received, expectedMessage, expectedDetail) };
27
- }
28
- };
29
- //# sourceMappingURL=index.js.map
@@ -1,4 +0,0 @@
1
- import { DetailedResult } from '../../ts-utils';
2
- export declare const matcherName: string;
3
- export declare function predicate<T, TD>(received: DetailedResult<T, TD>, expectedResult: string | RegExp | undefined, expectedDetail: TD): boolean;
4
- //# sourceMappingURL=predicate.d.ts.map
@@ -1,26 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.matcherName = void 0;
4
- exports.predicate = predicate;
5
- const expect_utils_1 = require("@jest/expect-utils");
6
- exports.matcherName = 'toFailWith';
7
- function predicate(received, expectedResult, expectedDetail) {
8
- if (received.isFailure()) {
9
- if (expectedResult === undefined) {
10
- if (received.message !== undefined) {
11
- return false;
12
- }
13
- }
14
- else if (expectedResult instanceof RegExp) {
15
- if (received.message.match(expectedResult) === null) {
16
- return false;
17
- }
18
- }
19
- else if (received.message !== expectedResult) {
20
- return false;
21
- }
22
- return (0, expect_utils_1.equals)(received.detail, expectedDetail);
23
- }
24
- return false;
25
- }
26
- //# sourceMappingURL=predicate.js.map
@@ -1,16 +0,0 @@
1
- import { Result } from '../../../../../index';
2
- declare global {
3
- namespace jest {
4
- interface Matchers<R, T> {
5
- /**
6
- * Use .toSucceed to verify that a Result<T> is a success
7
- */
8
- toSucceed(): R;
9
- }
10
- }
11
- }
12
- declare const _default: {
13
- toSucceed: <T>(received: Result<T>) => jest.CustomMatcherResult;
14
- };
15
- export default _default;
16
- //# sourceMappingURL=index.d.ts.map
@@ -1,25 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const matcherHelpers_1 = require("../../utils/matcherHelpers");
4
- const predicate_1 = require("./predicate");
5
- const jest_matcher_utils_1 = require("jest-matcher-utils");
6
- function passMessage(received) {
7
- return () => [
8
- (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`),
9
- (0, matcherHelpers_1.printExpectedResult)('success', false),
10
- (0, matcherHelpers_1.printReceivedResult)(received)
11
- ].join('\n');
12
- }
13
- function failMessage(received) {
14
- return () => [(0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`), (0, matcherHelpers_1.printExpectedResult)('success', true), (0, matcherHelpers_1.printReceivedResult)(received)].join('\n');
15
- }
16
- exports.default = {
17
- toSucceed: function (received) {
18
- const pass = (0, predicate_1.predicate)(received);
19
- if (pass) {
20
- return { pass: true, message: passMessage(received) };
21
- }
22
- return { pass: false, message: failMessage(received) };
23
- }
24
- };
25
- //# sourceMappingURL=index.js.map
@@ -1,4 +0,0 @@
1
- import { Result } from '../../../../../index';
2
- export declare const matcherName: string;
3
- export declare function predicate<T>(received: Result<T>): boolean;
4
- //# sourceMappingURL=predicate.d.ts.map
@@ -1,9 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.matcherName = void 0;
4
- exports.predicate = predicate;
5
- exports.matcherName = 'toSucceed';
6
- function predicate(received) {
7
- return received.isSuccess();
8
- }
9
- //# sourceMappingURL=predicate.js.map
@@ -1,17 +0,0 @@
1
- import { Result } from '../../../../../index';
2
- declare global {
3
- namespace jest {
4
- interface Matchers<R, T> {
5
- /**
6
- * Use .toSucceedAndMatchInlineSnapshot to verify that a Result<T> is a success
7
- * and that the result value matches an inline snapshot
8
- */
9
- toSucceedAndMatchInlineSnapshot<T>(snapshot: string | undefined): R;
10
- }
11
- }
12
- }
13
- declare const _default: {
14
- toSucceedAndMatchInlineSnapshot: <T>(this: jest.MatcherContext, received: Result<T>, snapshot: string | undefined) => jest.CustomMatcherResult;
15
- };
16
- export default _default;
17
- //# sourceMappingURL=index.d.ts.map
@@ -1,26 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- /* eslint-disable @typescript-eslint/no-unused-vars,no-unused-vars */
4
- const jest_matcher_utils_1 = require("jest-matcher-utils");
5
- const jest_snapshot_1 = require("jest-snapshot");
6
- const matcherHelpers_1 = require("../../utils/matcherHelpers");
7
- const matcherName = 'toSucceedAndMatchInlineSnapshot';
8
- exports.default = {
9
- toSucceedAndMatchInlineSnapshot: function (received, snapshot) {
10
- const context = this;
11
- if (received.isFailure()) {
12
- return {
13
- pass: false,
14
- message: () => {
15
- return [
16
- (0, jest_matcher_utils_1.matcherHint)(`${matcherName}`, 'callback'),
17
- 'Expected:\n Callback to succeed with a result that matches the snapshot',
18
- (0, matcherHelpers_1.printReceivedResult)(received)
19
- ].join('\n');
20
- }
21
- };
22
- }
23
- return jest_snapshot_1.toMatchInlineSnapshot.call(context, received.value, {}, snapshot);
24
- }
25
- };
26
- //# sourceMappingURL=index.js.map
@@ -1,17 +0,0 @@
1
- import { Result } from '../../../../../index';
2
- declare global {
3
- namespace jest {
4
- interface Matchers<R, T> {
5
- /**
6
- * Use .toSucceedAndMatchSnapshot to verify that a Result<T> is a success
7
- * and that the result value matches a stored snapshot
8
- */
9
- toSucceedAndMatchSnapshot<T>(): R;
10
- }
11
- }
12
- }
13
- declare const _default: {
14
- toSucceedAndMatchSnapshot: <T>(this: jest.MatcherContext, received: Result<T>) => jest.CustomMatcherResult;
15
- };
16
- export default _default;
17
- //# sourceMappingURL=index.d.ts.map
@@ -1,26 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- /* eslint-disable @typescript-eslint/no-unused-vars,no-unused-vars */
4
- const jest_matcher_utils_1 = require("jest-matcher-utils");
5
- const jest_snapshot_1 = require("jest-snapshot");
6
- const matcherHelpers_1 = require("../../utils/matcherHelpers");
7
- const matcherName = 'toSucceedAndMatchSnapshot';
8
- exports.default = {
9
- toSucceedAndMatchSnapshot: function (received) {
10
- const context = this;
11
- if (received.isFailure()) {
12
- return {
13
- pass: false,
14
- message: () => {
15
- return [
16
- (0, jest_matcher_utils_1.matcherHint)(`${matcherName}`, 'callback'),
17
- 'Expected:\n Callback to succeed with a result that matches the snapshot',
18
- (0, matcherHelpers_1.printReceivedResult)(received)
19
- ].join('\n');
20
- }
21
- };
22
- }
23
- return jest_snapshot_1.toMatchSnapshot.call(context, received.value, 'toSucceedAndMatchSnapshot');
24
- }
25
- };
26
- //# sourceMappingURL=index.js.map
@@ -1,19 +0,0 @@
1
- import { Result, ResultValueType } from '../../ts-utils';
2
- declare global {
3
- namespace jest {
4
- interface Matchers<R, T> {
5
- /**
6
- * Use .toSucceedAndSatisfy to verify that a Result<T> is a success
7
- * and that the supplied test function returns true (or void)
8
- * for the resulting value
9
- * @param test -
10
- */
11
- toSucceedAndSatisfy(test: (value: ResultValueType<T>) => boolean | void): R;
12
- }
13
- }
14
- }
15
- declare const _default: {
16
- toSucceedAndSatisfy: <T>(this: jest.MatcherContext, received: Result<T>, test: (value: T) => boolean | void) => jest.CustomMatcherResult;
17
- };
18
- export default _default;
19
- //# sourceMappingURL=index.d.ts.map
@@ -1,55 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const matcherHelpers_1 = require("../../utils/matcherHelpers");
4
- const predicate_1 = require("./predicate");
5
- const jest_matcher_utils_1 = require("jest-matcher-utils");
6
- function passMessage(received) {
7
- const expected = 'successful callback';
8
- const got = [(0, matcherHelpers_1.printReceivedResult)(received)];
9
- got.push(' Callback returned true');
10
- return () => [
11
- (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`, 'result', 'callback'),
12
- (0, matcherHelpers_1.printExpectedResult)('success', false, expected),
13
- ...got
14
- ].join('\n');
15
- }
16
- function failMessage(received, cbResult) {
17
- const expected = 'successful callback';
18
- const got = [(0, matcherHelpers_1.printReceivedResult)(received)];
19
- /* c8 ignore else */
20
- if (cbResult.isFailure()) {
21
- got.push(cbResult.message);
22
- }
23
- else if (cbResult.value === false) {
24
- got.push(' Callback returned false');
25
- }
26
- else if (cbResult.value === undefined) {
27
- /* c8 ignore else */
28
- got.push(' Callback was not invoked');
29
- }
30
- else {
31
- /* c8 ignore next */
32
- throw new Error('Internal error: toSucceedAndSatisfy.failMessage passed success with true');
33
- }
34
- return () => [
35
- (0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`, 'result', 'callback'),
36
- (0, matcherHelpers_1.printExpectedResult)('success', true, expected),
37
- ...got
38
- ].join('\n');
39
- }
40
- exports.default = {
41
- toSucceedAndSatisfy: function (received, test) {
42
- // For the normal (not '.not') case, we do not want to capture exceptions
43
- // so that the IDE can display exactly the line on which the failure case.
44
- // For the .not case, we want to swallow exceptions or expect failures since
45
- // we're just testing failure and not the reason.
46
- const capture = this.isNot;
47
- const cbResult = (0, predicate_1.predicate)(received, test, !!capture);
48
- const pass = cbResult.isSuccess() && cbResult.value === true;
49
- if (pass) {
50
- return { pass: true, message: passMessage(received) };
51
- }
52
- return { pass: false, message: failMessage(received, cbResult) };
53
- }
54
- };
55
- //# sourceMappingURL=index.js.map
@@ -1,4 +0,0 @@
1
- import { Result } from '../../ts-utils';
2
- export declare const matcherName: string;
3
- export declare function predicate<T>(received: Result<T>, cb: (value: T) => boolean | void, capture: boolean): Result<boolean | undefined>;
4
- //# sourceMappingURL=predicate.d.ts.map
@@ -1,21 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.matcherName = void 0;
4
- exports.predicate = predicate;
5
- const ts_utils_1 = require("../../ts-utils");
6
- exports.matcherName = 'toSucceedAndSatisfy';
7
- // If the result is successful and callback does not throw, returns Success with the callback return value, or
8
- // true if the callback returns undefined
9
- // If the result is successful but the callback throws, returns Failure with the thrown error
10
- // If the result is failure, returns Success with undefined
11
- function predicate(received, cb, capture) {
12
- if (received.isSuccess()) {
13
- const cbResult = capture ? (0, ts_utils_1.captureResult)(() => cb(received.value)) : (0, ts_utils_1.succeed)(cb(received.value));
14
- if (cbResult.isSuccess()) {
15
- return (0, ts_utils_1.succeed)(cbResult.value === true || cbResult.value === undefined);
16
- }
17
- return (0, ts_utils_1.fail)(` Callback failed with:\n ${cbResult.message}`);
18
- }
19
- return (0, ts_utils_1.succeed)(undefined);
20
- }
21
- //# sourceMappingURL=predicate.js.map
@@ -1,18 +0,0 @@
1
- import { Result, ResultValueType } from '../../../../../index';
2
- declare global {
3
- namespace jest {
4
- interface Matchers<R, T> {
5
- /**
6
- * Use .toSucceedWith to verify that a Result\<T\> is a success
7
- * and that the result value matches the supplied value
8
- * @param expected -
9
- */
10
- toSucceedWith(expected: ResultValueType<T> | RegExp): R;
11
- }
12
- }
13
- }
14
- declare const _default: {
15
- toSucceedWith: <T extends Result<unknown>>(received: T, expected: ResultValueType<T> | RegExp) => jest.CustomMatcherResult;
16
- };
17
- export default _default;
18
- //# sourceMappingURL=index.d.ts.map
@@ -1,29 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const matcherHelpers_1 = require("../../utils/matcherHelpers");
4
- const predicate_1 = require("./predicate");
5
- const jest_matcher_utils_1 = require("jest-matcher-utils");
6
- function passMessage(received, expected) {
7
- return () => [
8
- (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`),
9
- (0, matcherHelpers_1.printExpectedResult)('success', false, expected),
10
- (0, matcherHelpers_1.printReceivedResult)(received)
11
- ].join('\n');
12
- }
13
- function failMessage(received, expected) {
14
- return () => [
15
- (0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`),
16
- (0, matcherHelpers_1.printExpectedResult)('success', true, expected),
17
- (0, matcherHelpers_1.printReceivedResult)(received)
18
- ].join('\n');
19
- }
20
- exports.default = {
21
- toSucceedWith: function (received, expected) {
22
- const pass = (0, predicate_1.predicate)(received, expected);
23
- if (pass) {
24
- return { pass: true, message: passMessage(received, expected) };
25
- }
26
- return { pass: false, message: failMessage(received, expected) };
27
- }
28
- };
29
- //# sourceMappingURL=index.js.map
@@ -1,4 +0,0 @@
1
- import { Result } from '../../../../../index';
2
- export declare const matcherName: string;
3
- export declare function predicate<T>(received: Result<T>, expected: unknown): boolean;
4
- //# sourceMappingURL=predicate.d.ts.map
@@ -1,16 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.matcherName = void 0;
4
- exports.predicate = predicate;
5
- const expect_utils_1 = require("@jest/expect-utils");
6
- exports.matcherName = 'toSucceedWith';
7
- function predicate(received, expected) {
8
- if (received.isSuccess()) {
9
- if (typeof received.value === 'string' && expected instanceof RegExp) {
10
- return expected.test(received.value);
11
- }
12
- return (0, expect_utils_1.equals)(received.value, expected);
13
- }
14
- return false;
15
- }
16
- //# sourceMappingURL=predicate.js.map
@@ -1,18 +0,0 @@
1
- import { DetailedResult, ResultDetailType, ResultValueType } from '../../ts-utils';
2
- declare global {
3
- namespace jest {
4
- interface Matchers<R, T> {
5
- /**
6
- * Use .toSucceedWithDetail to verify that a DetailedResult\<T, TD\> is
7
- * a success and that the result value and detail matches the supplied
8
- * values
9
- */
10
- toSucceedWithDetail(expected: ResultValueType<T> | RegExp, detail: ResultDetailType<T> | undefined): R;
11
- }
12
- }
13
- }
14
- declare const _default: {
15
- toSucceedWithDetail: <T extends DetailedResult<unknown, unknown>>(received: T, expected: ResultValueType<T> | RegExp, detail: ResultDetailType<T> | undefined) => jest.CustomMatcherResult;
16
- };
17
- export default _default;
18
- //# sourceMappingURL=index.d.ts.map