Added an ipc message schema

Author: kevinwang5658

codify-schemas/src/index.ts

@@ -1,4 +1,5 @@
 export { default as ConfigFileSchema } from './config-file-schema.json';
 export { default as ProjectSchema } from './project-schema.json';
 export { default as ResourceMetaSchema } from './resource-meta-schema.json';
-export { default as ResourceSchema } from './resource-schema.json';
+export { default as ResourceSchema } from './resource-schema.json';
+export { default as IpcMessageSchema } from './ipc-message-schema.json';

codify-schemas/src/ipc-message-schema.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://www.codify.com/ipc-message-schema.json",
+  "title": "IPC Message Schema",
+  "type": "object",
+  "properties": {
+    "msg": {
+      "description": "The uri for the message. Like an http url",
+      "type": "string"
+    },
+    "status": {
+      "description": "The status of the request. Only used for responses. Can be either success or error",
+      "type": "string",
+      "enum": ["success", "error"]
+    },
+    "data": {
+      "description": "The data of the message."
+    }
+  },
+  "required": ["msg", "data"]
+}

codify-schemas/src/ipc-message-schema.test.ts

@@ -0,0 +1,37 @@
+import Ajv2020 from "ajv/dist/2020";
+import { describe, it } from 'mocha';
+import schema from './ipc-message-schema.json';
+import assert from "node:assert";
+
+const ajv = new Ajv2020({
+  strict: true,
+})
+
+describe("Ipc message schema tests", () => {
+  it("compiles", () => {
+    ajv.compile(schema);
+  })
+
+  it("requires a msg field to be specified", () => {
+    const validate = ajv.compile(schema);
+    assert.equal(validate({ msg: "doSomething", data: "data" }), true)
+    assert.equal(validate({ data: "data" }), false)
+  })
+
+  it("has an optional status field for responses", () => {
+    const validate = ajv.compile(schema);
+    assert.equal(validate({ msg: "doSomething", status: "success", data: "data" }), true)
+    assert.equal(validate({ msg: "doSomething", status: "error", data: "data" }), true)
+    assert.equal(validate({ msg: "doSomething", status: "other", data: "data" }), false)
+    assert.equal(validate({ msg: "doSomething", data: "data" }), true)
+  })
+
+  it ("accepts data or null", () => {
+    const validate = ajv.compile(schema);
+    assert.equal(validate({ msg: "doSomething", data: "data" }), true)
+    assert.equal(validate({ msg: "doSomething", data: null }), true)
+    assert.equal(validate({ msg: "doSomething" }), false)
+    assert.equal(validate({ msg: "doSomething", data: {} }), true)
+  });
+
+});