@jaypie/testkit 0.1.0 → 0.1.2

package/README.md

@@ -1,6 +1,6 @@
 # Jaypie Testkit 🐦‍⬛🫒
 
-TODO: update the project header and optionally write a description here
+Test utilities built for Jaypie
 
 ## 📋 Usage
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jaypie/testkit",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "author": "Finlayson Studio",
   "type": "module",
   "main": "src/index.js",
@@ -13,8 +13,13 @@
     "new": "hygen jaypie vite",
     "test": "vitest",
     "test:spec:index": "vitest run ./src/__tests__/index.spec.js",
+    "test:spec:jsonApiSchema.module": "vitest run ./src/__tests__/jsonApiSchema.module.spec.js",
+    "test:spec:matchers.module": "vitest run ./src/__tests__/matchers.module.spec.js",
     "test:spec:mockLog.module": "vitest run ./src/__tests__/mockLog.module.spec.js"
   },
+  "dependencies": {
+    "jest-json-schema": "^6.1.0"
+  },
   "devDependencies": {
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",

package/src/__tests__/index.spec.js

@@ -1,7 +1,14 @@
 import { describe, expect, it } from "vitest";
 
 // Subject
-import { mockLogFactory, restoreLog, spyLog } from "../index.js";
+import {
+  jsonApiErrorSchema,
+  jsonApiSchema,
+  matchers,
+  mockLogFactory,
+  restoreLog,
+  spyLog,
+} from "../index.js";
 
 //
 //
@@ -14,4 +21,9 @@ describe("Index", () => {
     expect(restoreLog).toBeFunction();
     expect(spyLog).toBeFunction();
   });
+  it("Exports matchers", () => {
+    expect(jsonApiErrorSchema).toBeObject();
+    expect(jsonApiSchema).toBeObject();
+    expect(matchers).toBeObject();
+  });
 });

package/src/__tests__/jsonApiSchema.module.spec.js

@@ -0,0 +1,17 @@
+// eslint-disable-next-line no-unused-vars
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+// Subject
+import { jsonApiErrorSchema, jsonApiSchema } from "../jsonApiSchema.module.js";
+
+//
+//
+// Run tests
+//
+
+describe("Json Api Schema Module", () => {
+  it("Exports objects", () => {
+    expect(jsonApiSchema).toBeObject();
+    expect(jsonApiErrorSchema).toBeObject();
+  });
+});

package/src/__tests__/matchers.module.spec.js

@@ -0,0 +1,39 @@
+// eslint-disable-next-line no-unused-vars
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+// Subject
+import matchers from "../matchers.module.js";
+
+//
+//
+// Mock constants
+//
+
+//
+//
+// Mock modules
+//
+
+//
+//
+// Mock environment
+//
+
+const DEFAULT_ENV = process.env;
+beforeEach(() => {
+  process.env = { ...process.env };
+});
+afterEach(() => {
+  process.env = DEFAULT_ENV;
+});
+
+//
+//
+// Run tests
+//
+
+describe("Matchers Module", () => {
+  it("Is an object", () => {
+    expect(matchers).toBeObject();
+  });
+});

package/src/index.js

@@ -3,4 +3,6 @@
 // Export
 //
 
+export { jsonApiErrorSchema, jsonApiSchema } from "./jsonApiSchema.module.js";
+export { default as matchers } from "./matchers.module.js";
 export { mockLogFactory, restoreLog, spyLog } from "./mockLog.module.js";

package/src/jsonApiSchema.module.js

@@ -0,0 +1,38 @@
+export const jsonApiErrorSchema = {
+  type: "object",
+  properties: {
+    errors: {
+      type: "array",
+      items: {
+        type: "object",
+        properties: {
+          status: { type: "number" },
+          title: { type: "string" },
+          detail: { type: "string" },
+        },
+        required: ["status", "title"],
+      },
+    },
+  },
+  required: ["errors"],
+};
+
+export const jsonApiSchema = {
+  type: "object",
+  properties: {
+    data: {
+      type: "object",
+      properties: {
+        id: { type: "string" },
+        type: { type: "string" },
+        attributes: { type: "object" },
+        links: { type: "object" },
+        meta: { type: "object" },
+        relationships: { type: "object" },
+      },
+      required: ["id", "type"],
+    },
+    meta: { type: "object" },
+  },
+  required: ["data"],
+};

package/src/matchers.module.js

@@ -0,0 +1,11 @@
+import { matchers as jsonSchemaMatchers } from "jest-json-schema";
+
+//
+//
+// Export
+//
+
+export default {
+  toBeValidSchema: jsonSchemaMatchers.toBeValidSchema,
+  toMatchSchema: jsonSchemaMatchers.toMatchSchema,
+};