feat: Removed additionalProperties: false (which break backwards compat). Switched sudo request to general request for running commands on the base CLI.

Author: kevinwang5658

package.json

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

src/index.ts

@@ -18,8 +18,8 @@ import ValidateRequestDataSchema from './messages/validate-request-data-schema.j
 import ValidateResponseDataSchema from './messages/validate-response-data-schema.json' with {type: 'json'}
 import InitializeRequestDataSchema from './messages/initialize-request-data-schema.json' with {type: 'json'}
 import InitializeResponseDataSchema from './messages/initialize-response-data-schema.json' with {type: 'json'}
-import SudoRequestDataSchema from './messages/sudo-request-data-schema.json' with {type: 'json'};
-import SudoRequestResponseDataSchema from './messages/sudo-response-data-schema.json' with {type: 'json'};
+import SudoRequestDataSchema from './messages/command-request-data-schema.json' with {type: 'json'};
+import SudoRequestResponseDataSchema from './messages/command-response-data-schema.json' with {type: 'json'};
 import PressKeyToContinueRequestDataSchema from './messages/press-key-to-continue-request-data-schema.json' with {type: 'json'};
 import PressKeyToContinueResponseDataSchema from './messages/press-key-to-continue-response-data-schema.json' with {type: 'json'};
 

src/messages/apply-request-data-schema.json

@@ -82,8 +82,7 @@
           "required": ["operation", "resourceType", "parameters", "isStateful"]
         }
       },
-      "required": ["plan"],
-      "additionalProperties": false
+      "required": ["plan"]
     }
   ]
 }

…c/messages/sudo-request-data-schema.json …essages/command-request-data-schema.jsonsrc/messages/sudo-request-data-schema.json renamed to src/messages/command-request-data-schema.json src/messages/sudo-request-data-schema.json renamed to src/messages/command-request-data-schema.json

@@ -1,14 +1,18 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/sudo-request.json",
-  "title": "Sudo request",
-  "description": "Request sudo from the core CLI",
+  "title": "Command request",
+  "description": "Request the core CLI to perform a command. This is required for sudo and interactive",
   "type": "object",
   "properties": {
     "command": {
       "type": "string",
       "description": "The command that is requesting sudo"
     },
+    "type": {
+      "enum": ["sudo", "interactive"],
+      "description": "The request type. Right now only sudo and interactive are supported"
+    },
     "options": {
       "type": "object",
       "description": "The options for codifySpawn that is needed to run the command",
@@ -25,6 +29,6 @@
       "additionalProperties": true
     }
   },
-  "required": ["command"],
+  "required": ["command", "type"],
   "additionalProperties": false
 }

…essages/sudo-request-data-schema.test.ts …ages/command-request-data-schema.test.tssrc/messages/sudo-request-data-schema.test.ts renamed to src/messages/command-request-data-schema.test.ts src/messages/sudo-request-data-schema.test.ts renamed to src/messages/command-request-data-schema.test.ts

@@ -1,4 +1,4 @@
-import schema from './sudo-request-data-schema.json';
+import schema from './command-request-data-schema.json';
 import {describe, expect, it} from 'vitest'
 import Ajv from 'ajv'
 
@@ -14,14 +14,16 @@ describe('Get resources response data schema', () => {
   it("Passes a command in the body", () => {
     const validate = ajv.compile(schema);
     expect(validate({
-      command: 'abc def'
+      command: 'abc def',
+      type: 'sudo'
     })).to.be.true;
   })
 
   it("Allows options to be set for the command", () => {
     const validate = ajv.compile(schema);
     expect(validate({
       command: 'abc def',
+      type: 'interactive',
       options: {
         cwd: '.',
       }
@@ -32,6 +34,7 @@ describe('Get resources response data schema', () => {
     const validate = ajv.compile(schema);
     expect(validate({
       command: 'abc def',
+      type: 'sudo',
       options: {
         cwd: '.',
         requiresRoot: true,
@@ -44,6 +47,7 @@ describe('Get resources response data schema', () => {
     const validate = ajv.compile(schema);
     expect(validate({
       command: 'abc def',
+      type: 'interactive',
       options: {
         cwd: '.',
       },

…/messages/sudo-response-data-schema.json …ssages/command-response-data-schema.jsonsrc/messages/sudo-response-data-schema.json renamed to src/messages/command-response-data-schema.json src/messages/sudo-response-data-schema.json renamed to src/messages/command-response-data-schema.json

@@ -2,18 +2,21 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/sudo-request-response.json",
   "title": "Sudo request response",
-  "description": "Response for a sudo request",
+  "description": "Response for a request to run a command on the base CLI (sudo, interactive, etc)",
   "type": "object",
   "properties": {
     "status": {
       "enum": ["success", "error"],
       "description": "Reports if the operation was successful"
     },
+    "exitCode": {
+      "type": "integer",
+      "description": "The exit code of running the command"
+    },
     "data": {
       "type": "string",
       "description": "Data returned by the operation"
     }
   },
-  "required": ["status", "data"],
-  "additionalProperties": false
+  "required": ["status", "exitCode", "data"]
 }

…ssages/sudo-response-data-schema.test.ts …ges/command-response-data-schema.test.tssrc/messages/sudo-response-data-schema.test.ts renamed to src/messages/command-response-data-schema.test.ts src/messages/sudo-response-data-schema.test.ts renamed to src/messages/command-response-data-schema.test.ts

@@ -1,4 +1,4 @@
-import schema from './sudo-response-data-schema.json';
+import schema from './command-response-data-schema.json';
 import {describe, expect, it} from 'vitest'
 import Ajv from 'ajv'
 
@@ -15,6 +15,7 @@ describe('Get resources response data schema', () => {
     const validate = ajv.compile(schema);
     expect(validate({
       status: 'success',
+      exitCode: 0,
       data: 'sudo: was a success'
     })).to.be.true;
   })
@@ -23,6 +24,7 @@ describe('Get resources response data schema', () => {
     const validate = ajv.compile(schema);
     expect(validate({
       status: 'error',
+      exitCode: 100,
       data: 'sudo: failed'
     })).to.be.true;
   })

src/messages/error-response-data-schema.json

@@ -9,6 +9,5 @@
       "type": "string"
     }
   },
-  "required": ["reason"],
-  "additionalProperties": false
+  "required": ["reason"]
 }

src/messages/get-resource-info-response-data-schema.json

@@ -22,6 +22,12 @@
         "type": "string"
       }
     },
+    "operatingSystems": {
+      "type": "array",
+      "items": {
+        "enum": ["Darwin", "Linux", "Windows_NT"]
+      }
+    },
     "import": {
       "type": "object",
       "properties": {

src/messages/initialize-request-data-schema.json

@@ -10,6 +10,5 @@
       "default": 0,
       "description": "Initializes the plugin to return logs at a specified verbosity level with 0 being the lowest"
     }
-  },
-  "additionalProperties": false
+  }
 }