@fgv/ts-utils 5.0.0-11 → 5.0.0-14

package/lib/test/helpers/jest/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockFileSystem = void 0;
+const matchers_1 = __importDefault(require("./matchers"));
+require("./types");
+var helpers_1 = require("./helpers");
+Object.defineProperty(exports, "MockFileSystem", { enumerable: true, get: function () { return helpers_1.MockFileSystem; } });
+// eslint-disable-next-line no-undef
+function isJestGlobal(g) {
+    return g.hasOwnProperty('expect');
+}
+/* c8 ignore else */
+if (isJestGlobal(global)) {
+    global.expect.extend(matchers_1.default);
+}
+else {
+    /* eslint-disable no-console */
+    console.error([
+        "Unable to find Jest's global expect",
+        'Please check that you have added ts-utils-jest correctly to your jest configuration.'
+    ].join('\n'));
+    /* eslint-enable no-console */
+}
+//# sourceMappingURL=index.js.map

package/lib/test/helpers/jest/matchers/index.d.ts

@@ -0,0 +1,16 @@
+declare const _default: {
+    toSucceedWithDetail: <T extends import("../ts-utils").DetailedResult<unknown, unknown>>(received: T, expected: import("../ts-utils").ResultValueType<T> | RegExp, detail: import("../ts-utils").ResultDetailType<T> | undefined) => jest.CustomMatcherResult;
+    toSucceedWith: <T extends import("../ts-utils").Result<unknown>>(received: T, expected: import("../ts-utils").ResultValueType<T> | RegExp) => jest.CustomMatcherResult;
+    toSucceedAndSatisfy: <T>(this: jest.MatcherContext, received: import("../ts-utils").Result<T>, test: (value: T) => boolean | void) => jest.CustomMatcherResult;
+    toSucceedAndMatchSnapshot: <T>(this: jest.MatcherContext, received: import("../ts-utils").Result<T>) => jest.CustomMatcherResult;
+    toSucceedAndMatchInlineSnapshot: <T>(this: jest.MatcherContext, received: import("../ts-utils").Result<T>, snapshot: string | undefined) => jest.CustomMatcherResult;
+    toSucceed: <T>(received: import("../ts-utils").Result<T>) => jest.CustomMatcherResult;
+    toFailWithDetail: <T extends import("../ts-utils").DetailedResult<unknown, unknown>>(received: T, expectedMessage: string | RegExp | undefined, expectedDetail: import("../ts-utils").ResultDetailType<T>) => jest.CustomMatcherResult;
+    toFailWith: <T>(received: import("../ts-utils").Result<T>, expected: string | RegExp | undefined) => jest.CustomMatcherResult;
+    toFailTestWith: <T>(cb: () => void, expected: RegExp | string | string[]) => jest.CustomMatcherResult;
+    toFailTestAndMatchSnapshot: <T>(this: jest.MatcherContext, cb: () => void) => jest.CustomMatcherResult;
+    toFailTest: <T>(cb: () => void) => jest.CustomMatcherResult;
+    toFail: <T extends import("../ts-utils").Result<unknown>>(received: T) => jest.CustomMatcherResult;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/test/helpers/jest/matchers/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const toFail_1 = __importDefault(require("./toFail"));
+const toFailTest_1 = __importDefault(require("./toFailTest"));
+const toFailTestAndMatchSnapshot_1 = __importDefault(require("./toFailTestAndMatchSnapshot"));
+const toFailTestWith_1 = __importDefault(require("./toFailTestWith"));
+const toFailWith_1 = __importDefault(require("./toFailWith"));
+const toFailWithDetail_1 = __importDefault(require("./toFailWithDetail"));
+const toSucceed_1 = __importDefault(require("./toSucceed"));
+const toSucceedAndMatchInlineSnapshot_1 = __importDefault(require("./toSucceedAndMatchInlineSnapshot"));
+const toSucceedAndMatchSnapshot_1 = __importDefault(require("./toSucceedAndMatchSnapshot"));
+const toSucceedAndSatisfy_1 = __importDefault(require("./toSucceedAndSatisfy"));
+const toSucceedWith_1 = __importDefault(require("./toSucceedWith"));
+const toSucceedWithDetail_1 = __importDefault(require("./toSucceedWithDetail"));
+exports.default = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, toFail_1.default), toFailTest_1.default), toFailTestAndMatchSnapshot_1.default), toFailTestWith_1.default), toFailWith_1.default), toFailWithDetail_1.default), toSucceed_1.default), toSucceedAndMatchInlineSnapshot_1.default), toSucceedAndMatchSnapshot_1.default), toSucceedAndSatisfy_1.default), toSucceedWith_1.default), toSucceedWithDetail_1.default);
+//# sourceMappingURL=index.js.map

package/lib/test/helpers/jest/matchers/toFail/index.d.ts

@@ -0,0 +1,16 @@
+import { Result } from '../../../../../index';
+declare global {
+    namespace jest {
+        interface Matchers<R, T> {
+            /**
+             * Use .toFail to verify that a Result<T> is a failure
+             */
+            toFail(): R;
+        }
+    }
+}
+declare const _default: {
+    toFail: <T extends Result<unknown>>(received: T) => jest.CustomMatcherResult;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/test/helpers/jest/matchers/toFail/index.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const matcherHelpers_1 = require("../../utils/matcherHelpers");
+const predicate_1 = require("./predicate");
+const jest_matcher_utils_1 = require("jest-matcher-utils");
+function passMessage(received) {
+    return () => [
+        (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`),
+        (0, matcherHelpers_1.printExpectedResult)('failure', false),
+        (0, matcherHelpers_1.printReceivedResult)(received)
+    ].join('\n');
+}
+function failMessage(received) {
+    return () => [(0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`), (0, matcherHelpers_1.printExpectedResult)('failure', true), (0, matcherHelpers_1.printReceivedResult)(received)].join('\n');
+}
+exports.default = {
+    toFail: function (received) {
+        const pass = (0, predicate_1.predicate)(received);
+        if (pass) {
+            return { pass: true, message: passMessage(received) };
+        }
+        return { pass: false, message: failMessage(received) };
+    }
+};
+//# sourceMappingURL=index.js.map

package/lib/test/helpers/jest/matchers/toFail/predicate.d.ts

@@ -0,0 +1,4 @@
+import { Result } from '../../../../../index';
+export declare const matcherName: string;
+export declare function predicate<T>(received: Result<T>): boolean;
+//# sourceMappingURL=predicate.d.ts.map

package/lib/test/helpers/jest/matchers/toFail/predicate.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matcherName = void 0;
+exports.predicate = predicate;
+exports.matcherName = 'toFail';
+function predicate(received) {
+    return received.isFailure();
+}
+//# sourceMappingURL=predicate.js.map

package/lib/test/helpers/jest/matchers/toFailTest/index.d.ts

@@ -0,0 +1,16 @@
+declare global {
+    namespace jest {
+        interface Matchers<R, T> {
+            /**
+             * Use .toFailTest to test a custom matcher by
+             * verifying that a test case fails.
+             */
+            toFailTest<T>(): R;
+        }
+    }
+}
+declare const _default: {
+    toFailTest: <T>(cb: () => void) => jest.CustomMatcherResult;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/test/helpers/jest/matchers/toFailTest/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars,no-unused-vars */
+const predicate_1 = require("./predicate");
+const jest_matcher_utils_1 = require("jest-matcher-utils");
+const matcherHelpers_1 = require("../../utils/matcherHelpers");
+function passMessage() {
+    return () => [
+        (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`, 'callback'),
+        (0, matcherHelpers_1.printExpectedResult)('failure', false),
+        '  Received: Test failed'
+    ].join('\n');
+}
+function failMessage() {
+    return () => [
+        (0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`, 'callback'),
+        (0, matcherHelpers_1.printExpectedResult)('failure', true),
+        '  Received: Test passed'
+    ].join('\n');
+}
+exports.default = {
+    toFailTest: function (cb) {
+        const pass = (0, predicate_1.predicate)(cb);
+        if (pass) {
+            return { pass: true, message: passMessage() };
+        }
+        return { pass: false, message: failMessage() };
+    }
+};
+//# sourceMappingURL=index.js.map

package/lib/test/helpers/jest/matchers/toFailTest/predicate.d.ts

@@ -0,0 +1,3 @@
+export declare const matcherName: string;
+export declare function predicate<T>(cb: () => void): boolean;
+//# sourceMappingURL=predicate.d.ts.map

package/lib/test/helpers/jest/matchers/toFailTest/predicate.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matcherName = void 0;
+exports.predicate = predicate;
+/* eslint-disable @typescript-eslint/no-unused-vars,no-unused-vars */
+const ts_utils_1 = require("../../ts-utils");
+exports.matcherName = 'toFailTest';
+function predicate(cb) {
+    const cbResult = (0, ts_utils_1.captureResult)(() => cb());
+    return cbResult.isFailure();
+}
+//# sourceMappingURL=predicate.js.map

package/lib/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/index.d.ts

@@ -0,0 +1,17 @@
+declare global {
+    namespace jest {
+        interface Matchers<R, T> {
+            /**
+             * Use .toFailTestWith to test a custom matcher by
+             * verifying that a test case fails as expected and
+             * reports an error matching a stored snapshot.
+             */
+            toFailTestAndMatchSnapshot<T>(): R;
+        }
+    }
+}
+declare const _default: {
+    toFailTestAndMatchSnapshot: <T>(this: jest.MatcherContext, cb: () => void) => jest.CustomMatcherResult;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars,no-unused-vars */
+const predicate_1 = require("./predicate");
+const jest_matcher_utils_1 = require("jest-matcher-utils");
+const jest_snapshot_1 = require("jest-snapshot");
+exports.default = {
+    toFailTestAndMatchSnapshot: function (cb) {
+        const context = this;
+        const cbResult = (0, predicate_1.predicate)(cb);
+        if (cbResult.isFailure()) {
+            return {
+                pass: false,
+                message: () => {
+                    return [
+                        (0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`, 'callback'),
+                        '  Expected: Callback to fail with an error that matches snapshot',
+                        '  Received: Callback succeeded'
+                    ].join('\n');
+                }
+            };
+        }
+        return jest_snapshot_1.toMatchSnapshot.call(context, cbResult.value, 'toFailTestAndMatchSnapshot');
+    }
+};
+//# sourceMappingURL=index.js.map

package/lib/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/predicate.d.ts

@@ -0,0 +1,4 @@
+import { Result } from '../../ts-utils';
+export declare const matcherName: string;
+export declare function predicate<T>(cb: () => void): Result<string>;
+//# sourceMappingURL=predicate.d.ts.map

package/lib/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/predicate.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matcherName = void 0;
+exports.predicate = predicate;
+/* eslint-disable @typescript-eslint/no-unused-vars,no-unused-vars */
+const ts_utils_1 = require("../../ts-utils");
+exports.matcherName = 'toFailTestAndMatchSnapshot';
+function predicate(cb) {
+    const cbResult = (0, ts_utils_1.captureResult)(() => cb());
+    if (cbResult.isFailure()) {
+        return (0, ts_utils_1.succeed)(cbResult.message);
+    }
+    return (0, ts_utils_1.fail)('Callback did not fail');
+}
+//# sourceMappingURL=predicate.js.map

package/lib/test/helpers/jest/matchers/toFailTestWith/index.d.ts

@@ -0,0 +1,18 @@
+declare global {
+    namespace jest {
+        interface Matchers<R, T> {
+            /**
+             * Use .toFailTestWith to test a custom matcher by
+             * verifying that a test case fails as expected and
+             * reports an error matching a supplied value.
+             * @param expected -
+             */
+            toFailTestWith<T>(expected: string | string[] | RegExp): R;
+        }
+    }
+}
+declare const _default: {
+    toFailTestWith: <T>(cb: () => void, expected: RegExp | string | string[]) => jest.CustomMatcherResult;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/test/helpers/jest/matchers/toFailTestWith/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const predicate_1 = require("./predicate");
+const jest_matcher_utils_1 = require("jest-matcher-utils");
+const matcherHelpers_1 = require("../../utils/matcherHelpers");
+function passMessage(cbResult, expected) {
+    return () => [
+        (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`, 'callback', 'expectedMessage'),
+        (0, matcherHelpers_1.printExpectedResult)('failure', false, expected),
+        `  Received: Callback failed with:\n>>>>\n${cbResult.value}\n<<<<`
+    ].join('\n');
+}
+function failMessage(cbResult, expected) {
+    return () => [
+        (0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`, 'callback', 'expectedMessage'),
+        (0, matcherHelpers_1.printExpectedResult)('failure', true, expected),
+        cbResult.message === ''
+            ? '  Received: Callback succeeded'
+            : `  Received: Callback failed with:\n>>>>\n${cbResult.message}\n<<<<`
+    ].join('\n');
+}
+exports.default = {
+    toFailTestWith: function (cb, expected) {
+        const cbResult = (0, predicate_1.predicate)(cb, expected);
+        if (cbResult.isSuccess()) {
+            return { pass: true, message: passMessage(cbResult, expected) };
+        }
+        return { pass: false, message: failMessage(cbResult, expected) };
+    }
+};
+//# sourceMappingURL=index.js.map

package/lib/test/helpers/jest/matchers/toFailTestWith/predicate.d.ts

@@ -0,0 +1,4 @@
+import { Result } from '../../ts-utils';
+export declare const matcherName: string;
+export declare function predicate<T>(cb: () => void, expected: string | string[] | RegExp): Result<string>;
+//# sourceMappingURL=predicate.d.ts.map

package/lib/test/helpers/jest/matchers/toFailTestWith/predicate.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matcherName = void 0;
+exports.predicate = predicate;
+/* eslint-disable @typescript-eslint/no-unused-vars,no-unused-vars */
+const expect_utils_1 = require("@jest/expect-utils");
+const jest_matcher_utils_1 = require("jest-matcher-utils");
+const ts_utils_1 = require("../../ts-utils");
+exports.matcherName = 'toFailTestWith';
+function predicate(cb, expected) {
+    const cbResult = (0, ts_utils_1.captureResult)(() => cb());
+    if (cbResult.isFailure()) {
+        let success = false;
+        if (expected instanceof RegExp) {
+            success = cbResult.message.match(expected) !== null;
+        }
+        else if (typeof expected === 'string') {
+            success = cbResult.message === expected;
+        }
+        else if (Array.isArray(expected)) {
+            success = (0, expect_utils_1.equals)(cbResult.message.split('\n'), expected);
+        }
+        else {
+            return (0, ts_utils_1.fail)(`Unsupported expected value "${(0, jest_matcher_utils_1.stringify)(expected)}" for toFailTestWith`);
+        }
+        return success ? (0, ts_utils_1.succeed)(cbResult.message) : (0, ts_utils_1.fail)(cbResult.message);
+    }
+    return (0, ts_utils_1.fail)('');
+}
+//# sourceMappingURL=predicate.js.map

package/lib/test/helpers/jest/matchers/toFailWith/index.d.ts

@@ -0,0 +1,18 @@
+import { Result } from '../../../../../index';
+declare global {
+    namespace jest {
+        interface Matchers<R, T> {
+            /**
+             * Use .toFailWith to verify that a Result<T> is a failure
+             * that matches a supplied string, RegExp or undefined value
+             * @param message -
+             */
+            toFailWith(message: string | RegExp | undefined): R;
+        }
+    }
+}
+declare const _default: {
+    toFailWith: <T>(received: Result<T>, expected: string | RegExp | undefined) => jest.CustomMatcherResult;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/test/helpers/jest/matchers/toFailWith/index.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const matcherHelpers_1 = require("../../utils/matcherHelpers");
+const predicate_1 = require("./predicate");
+const jest_matcher_utils_1 = require("jest-matcher-utils");
+function passMessage(received, expected) {
+    return () => [
+        (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`),
+        (0, matcherHelpers_1.printExpectedResult)('failure', false, expected),
+        (0, matcherHelpers_1.printReceivedResult)(received)
+    ].join('\n');
+}
+function failMessage(received, expected) {
+    return () => [
+        (0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`),
+        (0, matcherHelpers_1.printExpectedResult)('failure', true, expected),
+        (0, matcherHelpers_1.printReceivedResult)(received)
+    ].join('\n');
+}
+exports.default = {
+    toFailWith: function (received, expected) {
+        const pass = (0, predicate_1.predicate)(received, expected);
+        if (pass) {
+            return { pass: true, message: passMessage(received, expected) };
+        }
+        return { pass: false, message: failMessage(received, expected) };
+    }
+};
+//# sourceMappingURL=index.js.map

package/lib/test/helpers/jest/matchers/toFailWith/predicate.d.ts

@@ -0,0 +1,4 @@
+import { Result } from '../../../../../index';
+export declare const matcherName: string;
+export declare function predicate<T>(received: Result<T>, expected: string | RegExp | undefined): boolean;
+//# sourceMappingURL=predicate.d.ts.map

package/lib/test/helpers/jest/matchers/toFailWith/predicate.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matcherName = void 0;
+exports.predicate = predicate;
+exports.matcherName = 'toFailWith';
+function predicate(received, expected) {
+    if (received.isFailure()) {
+        if (expected === undefined) {
+            return received.message === undefined;
+        }
+        else if (expected instanceof RegExp) {
+            return received.message.match(expected) !== null;
+        }
+        else {
+            return received.message === expected;
+        }
+    }
+    return false;
+}
+//# sourceMappingURL=predicate.js.map

package/lib/test/helpers/jest/matchers/toFailWithDetail/index.d.ts

@@ -0,0 +1,19 @@
+import { DetailedResult, ResultDetailType } from '../../ts-utils';
+declare global {
+    namespace jest {
+        interface Matchers<R, T> {
+            /**
+             * Use .toFailWithDetail to verify that a DetailedResult<T> is
+             * a failure that matches both a supplied expected failure message
+             * (string, RegExp or undefined) and a supplied failure detail.
+             * @param message -
+             */
+            toFailWithDetail(message: string | RegExp | undefined, detail: ResultDetailType<T>): R;
+        }
+    }
+}
+declare const _default: {
+    toFailWithDetail: <T extends DetailedResult<unknown, unknown>>(received: T, expectedMessage: string | RegExp | undefined, expectedDetail: ResultDetailType<T>) => jest.CustomMatcherResult;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/test/helpers/jest/matchers/toFailWithDetail/index.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const matcherHelpers_1 = require("../../utils/matcherHelpers");
+const predicate_1 = require("./predicate");
+const jest_matcher_utils_1 = require("jest-matcher-utils");
+function passMessage(received, expectedMessage, expectedDetail) {
+    return () => [
+        (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`),
+        (0, matcherHelpers_1.printExpectedDetailedResult)('failure', false, expectedMessage, expectedDetail),
+        (0, matcherHelpers_1.printReceivedDetailedResult)(received)
+    ].join('\n');
+}
+function failMessage(received, expectedMessage, expectedDetail) {
+    return () => [
+        (0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`),
+        (0, matcherHelpers_1.printExpectedDetailedResult)('failure', true, expectedMessage, expectedDetail),
+        (0, matcherHelpers_1.printReceivedDetailedResult)(received)
+    ].join('\n');
+}
+exports.default = {
+    toFailWithDetail: function (received, expectedMessage, expectedDetail) {
+        const pass = (0, predicate_1.predicate)(received, expectedMessage, expectedDetail);
+        if (pass) {
+            return { pass: true, message: passMessage(received, expectedMessage, expectedDetail) };
+        }
+        return { pass: false, message: failMessage(received, expectedMessage, expectedDetail) };
+    }
+};
+//# sourceMappingURL=index.js.map

package/lib/test/helpers/jest/matchers/toFailWithDetail/predicate.d.ts

@@ -0,0 +1,4 @@
+import { DetailedResult } from '../../ts-utils';
+export declare const matcherName: string;
+export declare function predicate<T, TD>(received: DetailedResult<T, TD>, expectedResult: string | RegExp | undefined, expectedDetail: TD): boolean;
+//# sourceMappingURL=predicate.d.ts.map

package/lib/test/helpers/jest/matchers/toFailWithDetail/predicate.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matcherName = void 0;
+exports.predicate = predicate;
+const expect_utils_1 = require("@jest/expect-utils");
+exports.matcherName = 'toFailWith';
+function predicate(received, expectedResult, expectedDetail) {
+    if (received.isFailure()) {
+        if (expectedResult === undefined) {
+            if (received.message !== undefined) {
+                return false;
+            }
+        }
+        else if (expectedResult instanceof RegExp) {
+            if (received.message.match(expectedResult) === null) {
+                return false;
+            }
+        }
+        else if (received.message !== expectedResult) {
+            return false;
+        }
+        return (0, expect_utils_1.equals)(received.detail, expectedDetail);
+    }
+    return false;
+}
+//# sourceMappingURL=predicate.js.map

package/lib/test/helpers/jest/matchers/toSucceed/index.d.ts

@@ -0,0 +1,16 @@
+import { Result } from '../../../../../index';
+declare global {
+    namespace jest {
+        interface Matchers<R, T> {
+            /**
+             * Use .toSucceed to verify that a Result<T> is a success
+             */
+            toSucceed(): R;
+        }
+    }
+}
+declare const _default: {
+    toSucceed: <T>(received: Result<T>) => jest.CustomMatcherResult;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/test/helpers/jest/matchers/toSucceed/index.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const matcherHelpers_1 = require("../../utils/matcherHelpers");
+const predicate_1 = require("./predicate");
+const jest_matcher_utils_1 = require("jest-matcher-utils");
+function passMessage(received) {
+    return () => [
+        (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`),
+        (0, matcherHelpers_1.printExpectedResult)('success', false),
+        (0, matcherHelpers_1.printReceivedResult)(received)
+    ].join('\n');
+}
+function failMessage(received) {
+    return () => [(0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`), (0, matcherHelpers_1.printExpectedResult)('success', true), (0, matcherHelpers_1.printReceivedResult)(received)].join('\n');
+}
+exports.default = {
+    toSucceed: function (received) {
+        const pass = (0, predicate_1.predicate)(received);
+        if (pass) {
+            return { pass: true, message: passMessage(received) };
+        }
+        return { pass: false, message: failMessage(received) };
+    }
+};
+//# sourceMappingURL=index.js.map

package/lib/test/helpers/jest/matchers/toSucceed/predicate.d.ts

@@ -0,0 +1,4 @@
+import { Result } from '../../../../../index';
+export declare const matcherName: string;
+export declare function predicate<T>(received: Result<T>): boolean;
+//# sourceMappingURL=predicate.d.ts.map

package/lib/test/helpers/jest/matchers/toSucceed/predicate.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matcherName = void 0;
+exports.predicate = predicate;
+exports.matcherName = 'toSucceed';
+function predicate(received) {
+    return received.isSuccess();
+}
+//# sourceMappingURL=predicate.js.map

package/lib/test/helpers/jest/matchers/toSucceedAndMatchInlineSnapshot/index.d.ts

@@ -0,0 +1,17 @@
+import { Result } from '../../../../../index';
+declare global {
+    namespace jest {
+        interface Matchers<R, T> {
+            /**
+             * Use .toSucceedAndMatchInlineSnapshot to verify that a Result<T> is a success
+             * and that the result value matches an inline snapshot
+             */
+            toSucceedAndMatchInlineSnapshot<T>(snapshot: string | undefined): R;
+        }
+    }
+}
+declare const _default: {
+    toSucceedAndMatchInlineSnapshot: <T>(this: jest.MatcherContext, received: Result<T>, snapshot: string | undefined) => jest.CustomMatcherResult;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/test/helpers/jest/matchers/toSucceedAndMatchInlineSnapshot/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars,no-unused-vars */
+const jest_matcher_utils_1 = require("jest-matcher-utils");
+const jest_snapshot_1 = require("jest-snapshot");
+const matcherHelpers_1 = require("../../utils/matcherHelpers");
+const matcherName = 'toSucceedAndMatchInlineSnapshot';
+exports.default = {
+    toSucceedAndMatchInlineSnapshot: function (received, snapshot) {
+        const context = this;
+        if (received.isFailure()) {
+            return {
+                pass: false,
+                message: () => {
+                    return [
+                        (0, jest_matcher_utils_1.matcherHint)(`${matcherName}`, 'callback'),
+                        'Expected:\n  Callback to succeed with a result that matches the snapshot',
+                        (0, matcherHelpers_1.printReceivedResult)(received)
+                    ].join('\n');
+                }
+            };
+        }
+        return jest_snapshot_1.toMatchInlineSnapshot.call(context, received.value, {}, snapshot);
+    }
+};
+//# sourceMappingURL=index.js.map

package/lib/test/helpers/jest/matchers/toSucceedAndMatchSnapshot/index.d.ts

@@ -0,0 +1,17 @@
+import { Result } from '../../../../../index';
+declare global {
+    namespace jest {
+        interface Matchers<R, T> {
+            /**
+             * Use .toSucceedAndMatchSnapshot to verify that a Result<T> is a success
+             * and that the result value matches a stored snapshot
+             */
+            toSucceedAndMatchSnapshot<T>(): R;
+        }
+    }
+}
+declare const _default: {
+    toSucceedAndMatchSnapshot: <T>(this: jest.MatcherContext, received: Result<T>) => jest.CustomMatcherResult;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map