feat: Changed sudo request to command request to support additional options

Author: kevinwang5658

package.json

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

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

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://www.codifycli.com/sudo-request.json",
+  "$id": "https://www.codifycli.com/command-request.json",
   "title": "Command request",
   "description": "Request the core CLI to perform a command. This is required for sudo and interactive",
   "type": "object",
@@ -9,10 +9,6 @@
       "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",
@@ -24,11 +20,23 @@
         "argv0": {
           "type": "string",
           "description": "Arguments to pass in"
+        },
+        "requiresRoot": {
+          "type": "boolean",
+          "description": "Whether or not this command needs to be run in root"
+        },
+        "interactive": {
+          "type": "boolean",
+          "description": "Whether or not this command needs to be run in interactive mode"
+        },
+        "stdin": {
+          "type": "boolean",
+          "description": "Whether or not this command requires stdin"
         }
       },
       "additionalProperties": true
     }
   },
-  "required": ["command", "type"],
+  "required": ["command"],
   "additionalProperties": false
 }

src/messages/command-request-data-schema.test.ts

@@ -15,17 +15,16 @@ describe('Get resources response data schema', () => {
     const validate = ajv.compile(schema);
     expect(validate({
       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: '.',
+        interactive: true,
       }
     })).to.be.true;
   })
@@ -34,7 +33,6 @@ describe('Get resources response data schema', () => {
     const validate = ajv.compile(schema);
     expect(validate({
       command: 'abc def',
-      type: 'sudo',
       options: {
         cwd: '.',
         requiresRoot: true,
@@ -47,9 +45,9 @@ describe('Get resources response data schema', () => {
     const validate = ajv.compile(schema);
     expect(validate({
       command: 'abc def',
-      type: 'interactive',
       options: {
         cwd: '.',
+        requiresRoot: true,
       },
       additional: {}
     })).to.be.false;

src/messages/commands.ts

@@ -3,7 +3,7 @@ export enum MessageCmd {
   VALIDATE = 'validate',
   PLAN = 'plan',
   APPLY = 'apply',
-  SUDO_REQUEST = 'sudo_request',
+  COMMAND_REQUEST = 'command_request',
   PRESS_KEY_TO_CONTINUE_REQUEST = 'press_key_to_continue_request',
   CODIFY_CREDENTIALS_REQUEST = 'codify_credentials_request'
 }

src/types/index.ts

@@ -183,16 +183,13 @@ export interface InitializeResponseData {
   resourceDefinitions: Array<ResourceDefinition>;
 }
 
-export enum CommandRequestType {
-  SUDO = 'sudo',
-  INTERACTIVE = 'interactive'
-}
-
 export interface CommandRequestData {
   command: string;
-  type: CommandRequestType,
   options: {
     cwd?: string;
+    interactive?: boolean;
+    requiresRoot?: boolean;
+    stdin?: boolean;
   } & Omit<SpawnOptions, 'stdio' | 'shell' | 'detached'>
 }