@sprucelabs/test-utils 7.0.21 → 7.1.0

package/build/MockFetch.d.ts

@@ -0,0 +1,18 @@
+export default class MockFetch {
+    private requestLog;
+    private responses;
+    buildFetch(): typeof fetch;
+    assertWasCalled(url?: string | URL, init?: RequestInit): void;
+    private get lastInit();
+    private get wasCalled();
+    private get urlsCalled();
+    private get lastUrl();
+    assertMadeRequests(expected: ExpectedRequest[]): void;
+    setResponse(response: Response, url?: string | URL | Request, init?: RequestInit): void;
+    private generateResponseKey;
+}
+export interface RequestObject {
+    url: string | URL | Request;
+    init?: RequestInit;
+}
+export type ExpectedRequest = string | URL | RequestObject;

package/build/MockFetch.js

@@ -0,0 +1,62 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = __importDefault(require("./assert/assert"));
+class MockFetch {
+    constructor() {
+        this.requestLog = [];
+        this.responses = {
+            '*': new Response(JSON.stringify({
+                success: true,
+            }), { status: 200 }),
+        };
+    }
+    buildFetch() {
+        return async (url, init) => {
+            this.requestLog.push({ url, init });
+            const key = this.generateResponseKey(url, init);
+            return (this.responses[key] ?? this.responses['*']).clone();
+        };
+    }
+    assertWasCalled(url, init) {
+        assert_1.default.isTruthy(this.wasCalled, 'Expected fetch() to have been called.');
+        if (url) {
+            const lastUrl = this.lastUrl;
+            assert_1.default.isEqual(lastUrl, url, `Expected fetch() to have been called with URL "${url}", but it was called with "${lastUrl}".`);
+        }
+        if (init) {
+            assert_1.default.isEqualDeep(this.lastInit, init, `Expected fetch() to have been called with init "${JSON.stringify(init)}", but it was called with "${JSON.stringify(this.lastInit)}".`);
+        }
+    }
+    get lastInit() {
+        return this.requestLog[this.requestLog.length - 1].init;
+    }
+    get wasCalled() {
+        return this.requestLog.length > 0;
+    }
+    get urlsCalled() {
+        return this.requestLog.map((req) => req.url);
+    }
+    get lastUrl() {
+        return this.urlsCalled[this.urlsCalled.length - 1];
+    }
+    assertMadeRequests(expected) {
+        const expectedAsObjects = expected.map((req) => {
+            if (typeof req === 'string' || req instanceof URL) {
+                return { url: req, init: undefined };
+            }
+            return req;
+        });
+        assert_1.default.isEqualDeep(this.requestLog, expectedAsObjects, `Expected fetch() to have been called with URL and init combinations as specified.`);
+    }
+    setResponse(response, url, init) {
+        const key = this.generateResponseKey(url, init);
+        this.responses[key] = response;
+    }
+    generateResponseKey(url, init) {
+        return `${url?.toString() ?? '*'}${init ? JSON.stringify(init) : ''}`;
+    }
+}
+exports.default = MockFetch;

package/build/esm/MockFetch.d.ts

@@ -0,0 +1,18 @@
+export default class MockFetch {
+    private requestLog;
+    private responses;
+    buildFetch(): typeof fetch;
+    assertWasCalled(url?: string | URL, init?: RequestInit): void;
+    private get lastInit();
+    private get wasCalled();
+    private get urlsCalled();
+    private get lastUrl();
+    assertMadeRequests(expected: ExpectedRequest[]): void;
+    setResponse(response: Response, url?: string | URL | Request, init?: RequestInit): void;
+    private generateResponseKey;
+}
+export interface RequestObject {
+    url: string | URL | Request;
+    init?: RequestInit;
+}
+export type ExpectedRequest = string | URL | RequestObject;

package/build/esm/MockFetch.js

@@ -0,0 +1,58 @@
+import assert from './assert/assert.js';
+export default class MockFetch {
+    constructor() {
+        this.requestLog = [];
+        this.responses = {
+            '*': new Response(JSON.stringify({
+                success: true,
+            }), { status: 200 }),
+        };
+    }
+    buildFetch() {
+        return async (url, init) => {
+            var _a;
+            this.requestLog.push({ url, init });
+            const key = this.generateResponseKey(url, init);
+            return ((_a = this.responses[key]) !== null && _a !== void 0 ? _a : this.responses['*']).clone();
+        };
+    }
+    assertWasCalled(url, init) {
+        assert.isTruthy(this.wasCalled, 'Expected fetch() to have been called.');
+        if (url) {
+            const lastUrl = this.lastUrl;
+            assert.isEqual(lastUrl, url, `Expected fetch() to have been called with URL "${url}", but it was called with "${lastUrl}".`);
+        }
+        if (init) {
+            assert.isEqualDeep(this.lastInit, init, `Expected fetch() to have been called with init "${JSON.stringify(init)}", but it was called with "${JSON.stringify(this.lastInit)}".`);
+        }
+    }
+    get lastInit() {
+        return this.requestLog[this.requestLog.length - 1].init;
+    }
+    get wasCalled() {
+        return this.requestLog.length > 0;
+    }
+    get urlsCalled() {
+        return this.requestLog.map((req) => req.url);
+    }
+    get lastUrl() {
+        return this.urlsCalled[this.urlsCalled.length - 1];
+    }
+    assertMadeRequests(expected) {
+        const expectedAsObjects = expected.map((req) => {
+            if (typeof req === 'string' || req instanceof URL) {
+                return { url: req, init: undefined };
+            }
+            return req;
+        });
+        assert.isEqualDeep(this.requestLog, expectedAsObjects, `Expected fetch() to have been called with URL and init combinations as specified.`);
+    }
+    setResponse(response, url, init) {
+        const key = this.generateResponseKey(url, init);
+        this.responses[key] = response;
+    }
+    generateResponseKey(url, init) {
+        var _a;
+        return `${(_a = url === null || url === void 0 ? void 0 : url.toString()) !== null && _a !== void 0 ? _a : '*'}${init ? JSON.stringify(init) : ''}`;
+    }
+}

package/build/esm/index.d.ts

@@ -12,3 +12,5 @@ export { default as Spier } from './utilities/spies/Spier';
 export { default as Spy } from './utilities/spies/Spy';
 export { default as SpruceTestResolver } from './SpruceTestResolver';
 export * from './SpruceTestResolver';
+export { default as MockFetch } from './MockFetch';
+export * from './MockFetch';

package/build/esm/index.js

@@ -12,3 +12,5 @@ export { default as Spier } from './utilities/spies/Spier.js';
 export { default as Spy } from './utilities/spies/Spy.js';
 export { default as SpruceTestResolver } from './SpruceTestResolver.js';
 export * from './SpruceTestResolver.js';
+export { default as MockFetch } from './MockFetch.js';
+export * from './MockFetch.js';

package/build/index.d.ts

@@ -12,3 +12,5 @@ export { default as Spier } from './utilities/spies/Spier';
 export { default as Spy } from './utilities/spies/Spy';
 export { default as SpruceTestResolver } from './SpruceTestResolver';
 export * from './SpruceTestResolver';
+export { default as MockFetch } from './MockFetch';
+export * from './MockFetch';

package/build/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SpruceTestResolver = exports.Spy = exports.Spier = exports.StackCleaner = exports.assertUtil = exports.test = exports.assert = exports.default = exports.generateId = exports.errorAssertUtil = exports.errorAssert = void 0;
+exports.MockFetch = exports.SpruceTestResolver = exports.Spy = exports.Spier = exports.StackCleaner = exports.assertUtil = exports.test = exports.assert = exports.default = exports.generateId = exports.errorAssertUtil = exports.errorAssert = void 0;
 var errorAssert_1 = require("./utilities/errorAssert");
 Object.defineProperty(exports, "errorAssert", { enumerable: true, get: function () { return __importDefault(errorAssert_1).default; } });
 var errorAssert_utility_1 = require("./utilities/errorAssert.utility");
@@ -43,3 +43,6 @@ Object.defineProperty(exports, "Spy", { enumerable: true, get: function () { ret
 var SpruceTestResolver_1 = require("./SpruceTestResolver");
 Object.defineProperty(exports, "SpruceTestResolver", { enumerable: true, get: function () { return __importDefault(SpruceTestResolver_1).default; } });
 __exportStar(require("./SpruceTestResolver"), exports);
+var MockFetch_1 = require("./MockFetch");
+Object.defineProperty(exports, "MockFetch", { enumerable: true, get: function () { return __importDefault(MockFetch_1).default; } });
+__exportStar(require("./MockFetch"), exports);

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "7.0.21",
+  "version": "7.1.0",
   "files": [
     "build"
   ],