@efebia/jest-match-response 0.0.1

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { buildToMatchJson, type Options } from "./toMatchJson";
+export { toMatchResponse } from "./toMatchResponse";

package/lib/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toMatchResponse = exports.buildToMatchJson = void 0;
+var toMatchJson_1 = require("./toMatchJson");
+Object.defineProperty(exports, "buildToMatchJson", { enumerable: true, get: function () { return toMatchJson_1.buildToMatchJson; } });
+var toMatchResponse_1 = require("./toMatchResponse");
+Object.defineProperty(exports, "toMatchResponse", { enumerable: true, get: function () { return toMatchResponse_1.toMatchResponse; } });

package/lib/toMatchJson.d.ts

@@ -0,0 +1,14 @@
+import Ajv from "ajv";
+import type { MatcherFunction } from "expect";
+export type Options = {
+    ajv: Ajv;
+};
+export declare const buildToMatchJson: (opts: Options) => MatcherFunction<[any]>;
+declare module "expect" {
+    interface AsymmetricMatchers {
+        toMatchJson(model: any): void;
+    }
+    interface Matchers<R> {
+        toMatchJson(model: any): R;
+    }
+}

package/lib/toMatchJson.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildToMatchJson = void 0;
+const buildToMatchJson = (opts) => {
+    const { ajv } = opts;
+    const toMatchJson = function (json, model) {
+        const validate = ajv.compile(model);
+        const validation = validate(json);
+        const pass = this.equals(validation, !this.isNot);
+        const showErrors = (!pass && !this.isNot) || (pass && this.isNot);
+        const message = () => this.utils.matcherHint("toMatchJson", undefined, undefined, {
+            comment: "Match JSON equality",
+            isNot: this.isNot,
+            promise: this.promise,
+        }) +
+            "\n\n" +
+            `Expected JSON Schema: ${this.utils.printExpected(model)}\n` +
+            `Received JSON: ${this.utils.printReceived(json)}` +
+            showErrors
+            ? `\nValidation errors: ${this.utils.printReceived(JSON.stringify(validate.errors))}`
+            : "";
+        return { actual: json, message, name: "toMatchJson", pass };
+    };
+    return toMatchJson;
+};
+exports.buildToMatchJson = buildToMatchJson;

package/lib/toMatchResponse.d.ts

@@ -0,0 +1,14 @@
+export declare const toMatchResponse: (received: any, statusCode: any, model: any) => Promise<void | {
+    actual: number;
+    message: () => string;
+    name: string;
+    pass: boolean;
+}>;
+declare module "expect" {
+    interface AsymmetricMatchers {
+        toMatchResponse(statusCode: number, model: any): void;
+    }
+    interface Matchers<R> {
+        toMatchResponse(statusCode: number, model: any): R;
+    }
+}

package/lib/toMatchResponse.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toMatchResponse = void 0;
+const globals_1 = require("@jest/globals");
+const toMatchResponse = async function (received, statusCode, model) {
+    if (!(received instanceof Response))
+        throw new Error('toMatchResponse: the received value has to be a fetch Response object');
+    const jsonResponse = await received.json();
+    const statusCodePass = this.isNot ? received.status !== statusCode : received.status === statusCode;
+    if (!statusCodePass) {
+        const message = () => (this.utils.matcherHint('toMatchResponse', undefined, undefined, { comment: 'Match response equality', isNot: this.isNot, promise: this.promise }) +
+            '\n\n' +
+            `Expected Status Code: ${this.utils.printExpected(statusCode)}\n` +
+            `Received Status Code: ${this.utils.printReceived(received.status)}\n` +
+            `Received Body: ${this.utils.printReceived(jsonResponse)}`);
+        return { actual: received.status, message, name: 'toMatchResponse', pass: false };
+    }
+    if (this.isNot)
+        return (0, globals_1.expect)(jsonResponse).not.toMatchJson(model);
+    return (0, globals_1.expect)(jsonResponse).toMatchJson(model);
+};
+exports.toMatchResponse = toMatchResponse;

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@efebia/jest-match-response",
+  "version": "0.0.1",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.2.5",
+    "@types/js-yaml": "^4.0.5",
+    "@types/node": "^18.11.18",
+    "jest": "^29.3.1",
+    "ts-jest": "^29.0.3",
+    "typescript": "^4.9.4",
+    "undici": "^5.24.0"
+  },
+  "dependencies": {
+    "@jest/globals": ">=28.0.0",
+    "ajv": "^8.12.0",
+    "jest": ">=28.0.0"
+  },
+  "files": [
+    "/lib"
+  ],
+  "scripts": {
+    "build": "tsc"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "main": "./lib"
+}