codify-schemas 1.0.52 → 1.0.53

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import ConfigFileSchema from './config-file-schema.json';
 import ProjectSchema from './project-schema.json';
 import ResourceSchema from './resource-schema.json';
 import IpcMessageSchema from './ipc-message-schema.json';
+import IpcMessageV2Schema from './ipc-message-schema-v2.json';
 import ApplyRequestDataSchema from './messages/apply-request-data-schema.json';
 import ApplyResponseDataSchema from './messages/apply-response-data-schema.json';
 import ErrorResponseDataSchema from './messages/error-response-data-schema.json';
@@ -17,6 +18,6 @@ import InitializeRequestDataSchema from './messages/initialize-request-data-sche
 import InitializeResponseDataSchema from './messages/initialize-response-data-schema.json';
 import SudoRequestDataSchema from './messages/sudo-request-data-schema.json';
 import SudoRequestResponseDataSchema from './messages/sudo-response-data-schema.json';
-export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, SudoRequestDataSchema, SudoRequestResponseDataSchema, };
+export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, IpcMessageV2Schema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, SudoRequestDataSchema, SudoRequestResponseDataSchema, };
 export * from './types/index.js';
 export * from './messages/commands.js';

package/dist/index.js

@@ -2,6 +2,7 @@ import ConfigFileSchema from './config-file-schema.json' assert { type: 'json' }
 import ProjectSchema from './project-schema.json' assert { type: 'json' };
 import ResourceSchema from './resource-schema.json' assert { type: 'json' };
 import IpcMessageSchema from './ipc-message-schema.json' assert { type: 'json' };
+import IpcMessageV2Schema from './ipc-message-schema-v2.json' assert { type: 'json' };
 import ApplyRequestDataSchema from './messages/apply-request-data-schema.json' assert { type: 'json' };
 import ApplyResponseDataSchema from './messages/apply-response-data-schema.json' assert { type: 'json' };
 import ErrorResponseDataSchema from './messages/error-response-data-schema.json' assert { type: 'json' };
@@ -17,7 +18,7 @@ import InitializeRequestDataSchema from './messages/initialize-request-data-sche
 import InitializeResponseDataSchema from './messages/initialize-response-data-schema.json' assert { type: 'json' };
 import SudoRequestDataSchema from './messages/sudo-request-data-schema.json' assert { type: 'json' };
 import SudoRequestResponseDataSchema from './messages/sudo-response-data-schema.json' assert { type: 'json' };
-export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, SudoRequestDataSchema, SudoRequestResponseDataSchema, };
+export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, IpcMessageV2Schema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, SudoRequestDataSchema, SudoRequestResponseDataSchema, };
 export * from './types/index.js';
 export * from './messages/commands.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC9E,OAAO,aAAa,MAAM,uBAAuB,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACvE,OAAO,cAAc,MAAM,wBAAwB,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACzE,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC9E,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACtG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACtG,OAAO,gCAAgC,MAAM,uDAAuD,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1H,OAAO,iCAAiC,MAAM,wDAAwD,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5H,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACtG,OAAO,wBAAwB,MAAM,6CAA6C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACxG,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,yBAAyB,MAAM,8CAA8C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1G,OAAO,0BAA0B,MAAM,+CAA+C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5G,OAAO,2BAA2B,MAAM,gDAAgD,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC9G,OAAO,4BAA4B,MAAM,iDAAiD,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAChH,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAC;AACnG,OAAO,6BAA6B,MAAM,2CAA2C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAC;AAE5G,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,gCAAgC,EAChC,iCAAiC,EACjC,uBAAuB,EACvB,wBAAwB,EACxB,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,6BAA6B,GAC9B,CAAA;AAED,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC9E,OAAO,aAAa,MAAM,uBAAuB,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACvE,OAAO,cAAc,MAAM,wBAAwB,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACzE,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC9E,OAAO,kBAAkB,MAAM,8BAA8B,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACnF,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACtG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACtG,OAAO,gCAAgC,MAAM,uDAAuD,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1H,OAAO,iCAAiC,MAAM,wDAAwD,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5H,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACtG,OAAO,wBAAwB,MAAM,6CAA6C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACxG,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,yBAAyB,MAAM,8CAA8C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1G,OAAO,0BAA0B,MAAM,+CAA+C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5G,OAAO,2BAA2B,MAAM,gDAAgD,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC9G,OAAO,4BAA4B,MAAM,iDAAiD,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAChH,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAC;AACnG,OAAO,6BAA6B,MAAM,2CAA2C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAC;AAE5G,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,gCAAgC,EAChC,iCAAiC,EACjC,uBAAuB,EACvB,wBAAwB,EACxB,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,6BAA6B,GAC9B,CAAA;AAED,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC"}

package/dist/ipc-message-schema-v2.json

@@ -0,0 +1,25 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "https://www.codifycli.com/ipc-message-schema-v2.json",
+    "title": "IPC Message Schema V2",
+    "type": "object",
+    "properties": {
+        "cmd": {
+            "description": "The uri for the message. Like an http url",
+            "type": "string"
+        },
+        "requestId": {
+            "type": "string",
+            "description": "Unique identifier to identify a request and it's corresponding response"
+        },
+        "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": ["cmd", "data", "requestId"]
+}

package/dist/project-schema.json

@@ -1,5 +1,5 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema",
+    "$schema": "http://json-schema.org/draft-07/schema#",
     "$id": "https://www.codifycli.com/project-schema.json",
     "title": "Project Schema",
     "type": "object",

package/dist/types/index.d.ts

@@ -25,6 +25,12 @@ export interface IpcMessage {
     status?: MessageStatus;
     data: unknown | null;
 }
+export interface IpcMessageV2 {
+    cmd: string;
+    requestId: string;
+    status?: MessageStatus;
+    data: unknown | null;
+}
 export interface ValidateRequestData {
     configs: ResourceConfig[];
 }

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACjB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AA4BD,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;IACnB,sCAAiB,CAAA;IACjB,0CAAqB,CAAA;IACrB,kCAAa,CAAA;AACf,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B;AAED,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,iCAAW,CAAA;IACX,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,mCAAa,CAAA;AACf,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AA0ED,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,8BAAe,CAAA;AACjB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACjB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAmCD,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;IACnB,sCAAiB,CAAA;IACjB,0CAAqB,CAAA;IACrB,kCAAa,CAAA;AACf,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B;AAED,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,iCAAW,CAAA;IACX,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,mCAAa,CAAA;AACf,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AA0ED,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,8BAAe,CAAA;AACjB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-schemas",
-  "version": "1.0.52",
+  "version": "1.0.53",
   "description": "",
   "type": "module",
   "main": "dist/index.js",

package/src/index.ts

@@ -2,6 +2,7 @@ import ConfigFileSchema from './config-file-schema.json' assert {type: 'json'}
 import ProjectSchema from './project-schema.json' assert {type: 'json'}
 import ResourceSchema from './resource-schema.json' assert {type: 'json'}
 import IpcMessageSchema from './ipc-message-schema.json' assert {type: 'json'}
+import IpcMessageV2Schema from './ipc-message-schema-v2.json' assert {type: 'json'}
 import ApplyRequestDataSchema from './messages/apply-request-data-schema.json' assert {type: 'json'}
 import ApplyResponseDataSchema from './messages/apply-response-data-schema.json' assert {type: 'json'}
 import ErrorResponseDataSchema from './messages/error-response-data-schema.json' assert {type: 'json'}
@@ -23,6 +24,7 @@ export {
   ProjectSchema,
   ResourceSchema,
   IpcMessageSchema,
+  IpcMessageV2Schema,
   ApplyRequestDataSchema,
   ApplyResponseDataSchema,
   ErrorResponseDataSchema,

package/src/ipc-message-schema-v2.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://www.codifycli.com/ipc-message-schema-v2.json",
+  "title": "IPC Message Schema V2",
+  "type": "object",
+  "properties": {
+    "cmd": {
+      "description": "The uri for the message. Like an http url",
+      "type": "string"
+    },
+    "requestId": {
+      "type": "string",
+      "description": "Unique identifier to identify a request and it's corresponding response"
+    },
+    "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": ["cmd", "data", "requestId"]
+}

package/src/ipc-message-schema-v2.test.ts

@@ -0,0 +1,42 @@
+import schema from './ipc-message-schema-v2.json';
+import { describe, it, expect } from 'vitest'
+import Ajv from 'ajv'
+
+const ajv = new Ajv({
+  strict: true,
+})
+
+describe("Ipc message schema tests V2", () => {
+  it("compiles", () => {
+    ajv.compile(schema);
+  })
+
+  it("requires a cmd field to be specified", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({ cmd: "doSomething", data: "data", requestId: "5d8x8ew" })).to.be.true;
+    expect(validate({ data: "data", requestId: "5d8x8ew" })).to.be.false;
+  })
+
+  it("has an optional status field for responses", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({ cmd: "doSomething", status: "success", data: "data", requestId: "5d8x8ew" })).to.be.true;
+    expect(validate({ cmd: "doSomething", status: "error", data: "data", requestId: "5d8x8ew" })).to.be.true;
+    expect(validate({ cmd: "doSomething", status: "other", data: "data", requestId: "5d8x8ew" })).to.be.false;
+    expect(validate({ cmd: "doSomething", data: "data", requestId: "5d8x8ew" })).to.be.true;
+  })
+
+  it ("accepts data or null", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({ cmd: "doSomething", data: "data", requestId: "5d8x8ew" })).to.be.true;
+    expect(validate({ cmd: "doSomething", data: null, requestId: "5d8x8ew" })).to.be.true;
+    expect(validate({ cmd: "doSomething", requestId: "5d8x8ew" })).to.be.false;
+    expect(validate({ cmd: "doSomething", data: {}, requestId: "5d8x8ew" })).to.be.true;
+  });
+
+  it('Requires a uid', () => {
+    const validate = ajv.compile(schema);
+    expect(validate({ cmd: "doSomething", data: "data", requestId: "5d8x8ew" })).to.be.true;
+    expect(validate({ cmd: "doSomething", data: "data" })).to.be.false;
+  })
+
+});

package/src/project-schema.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema",
+  "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "https://www.codifycli.com/project-schema.json",
   "title": "Project Schema",
   "type": "object",