codify-schemas 1.0.37 → 1.0.38

package/dist/messages/sudo-request-data-schema.json

@@ -8,6 +8,21 @@
         "command": {
             "type": "string",
             "description": "The command that is requesting sudo"
+        },
+        "options": {
+            "type": "object",
+            "description": "The options for codifySpawn that is needed to run the command",
+            "properties": {
+                "cwd": {
+                    "type": "string",
+                    "description": "Current working directory to run codifySpawn in"
+                },
+                "argv0": {
+                    "type": "string",
+                    "description": "Arguments to pass in"
+                }
+            },
+            "additionalProperties": true
         }
     },
     "required": ["command"],

package/dist/messages/sudo-response-data-schema.json

@@ -4,6 +4,16 @@
     "title": "Sudo request response",
     "description": "Response for a sudo request",
     "type": "object",
-    "properties": {},
+    "properties": {
+        "status": {
+            "enum": ["success", "error"],
+            "description": "Reports if the operation was successful"
+        },
+        "data": {
+            "type": "string",
+            "description": "Data returned by the operation"
+        }
+    },
+    "required": ["status", "data"],
     "additionalProperties": false
 }

package/dist/types/index.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" resolution-mode="require"/>
+import { SpawnOptions } from "node:child_process";
 export interface StringIndexedObject {
     [x: string]: unknown;
 }
@@ -88,6 +90,15 @@ export interface InitializeResponseData {
 }
 export interface SudoRequestData {
     command: string;
+    options: {
+        cwd?: string;
+    } & Omit<SpawnOptions, 'stdio' | 'shell' | 'detached'>;
+}
+export declare enum SpawnStatus {
+    SUCCESS = "success",
+    ERROR = "error"
 }
 export interface SudoRequestResponseData {
+    status: SpawnStatus;
+    data: string;
 }

package/dist/types/index.js

@@ -18,4 +18,9 @@ export var ParameterOperation;
     ParameterOperation["MODIFY"] = "modify";
     ParameterOperation["NOOP"] = "noop";
 })(ParameterOperation || (ParameterOperation = {}));
+export var SpawnStatus;
+(function (SpawnStatus) {
+    SpawnStatus["SUCCESS"] = "success";
+    SpawnStatus["ERROR"] = "error";
+})(SpawnStatus || (SpawnStatus = {}));
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAmBA,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACjB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAuBD,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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAqBA,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACjB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAuBD,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;AAmDD,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.37",
+  "version": "1.0.38",
   "description": "",
   "type": "module",
   "main": "dist/index.js",

package/src/messages/sudo-request-data-schema.json

@@ -8,6 +8,21 @@
     "command": {
       "type": "string",
       "description": "The command that is requesting sudo"
+    },
+    "options": {
+      "type": "object",
+      "description": "The options for codifySpawn that is needed to run the command",
+      "properties": {
+        "cwd": {
+          "type": "string",
+          "description": "Current working directory to run codifySpawn in"
+        },
+        "argv0": {
+          "type": "string",
+          "description": "Arguments to pass in"
+        }
+      },
+      "additionalProperties": true
     }
   },
   "required": ["command"],

package/src/messages/sudo-request-data-schema.test.ts

@@ -11,11 +11,43 @@ describe('Get resources response data schema', () => {
     ajv.compile(schema);
   })
 
-  it("requires an empty object", () => {
+  it("Passes a command in the body", () => {
     const validate = ajv.compile(schema);
     expect(validate({
       command: 'abc def'
     })).to.be.true;
   })
 
+  it("Allows options to be set for the command", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      command: 'abc def',
+      options: {
+        cwd: '.',
+      }
+    })).to.be.true;
+  })
+
+  it("Allows additional options to be set for options", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      command: 'abc def',
+      options: {
+        cwd: '.',
+        requiresRoot: true,
+        throws: false,
+      }
+    })).to.be.true;
+  })
+
+  it("Prevent additional options to be set for the top level object", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      command: 'abc def',
+      options: {
+        cwd: '.',
+      },
+      additional: {}
+    })).to.be.false;
+  })
 })

package/src/messages/sudo-response-data-schema.json

@@ -4,6 +4,16 @@
   "title": "Sudo request response",
   "description": "Response for a sudo request",
   "type": "object",
-  "properties": {},
+  "properties": {
+    "status": {
+      "enum": ["success", "error"],
+      "description": "Reports if the operation was successful"
+    },
+    "data": {
+      "type": "string",
+      "description": "Data returned by the operation"
+    }
+  },
+  "required": ["status", "data"],
   "additionalProperties": false
 }

package/src/messages/sudo-response-data-schema.test.ts

@@ -1,4 +1,4 @@
-import schema from './sudo-request-data-schema.json';
+import schema from './sudo-response-data-schema.json';
 import {describe, expect, it} from 'vitest'
 import Ajv2020 from 'ajv/dist/2020.js'
 
@@ -11,11 +11,19 @@ describe('Get resources response data schema', () => {
     ajv.compile(schema);
   })
 
-  it("requires an empty object", () => {
+  it("Validates a successful sudo request response", () => {
     const validate = ajv.compile(schema);
     expect(validate({
-      command: 'abc def'
+      status: 'success',
+      data: 'sudo: was a success'
     })).to.be.true;
   })
 
+  it("Validates a sudo request error response", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      status: 'error',
+      data: 'sudo: failed'
+    })).to.be.true;
+  })
 })

package/src/types/index.ts

@@ -1,3 +1,5 @@
+import { SpawnOptions } from "node:child_process";
+
 export interface StringIndexedObject {
   [x: string]: unknown;
 }
@@ -102,6 +104,17 @@ export interface InitializeResponseData {
 
 export interface SudoRequestData {
   command: string;
+  options: {
+    cwd?: string;
+  } & Omit<SpawnOptions, 'stdio' | 'shell' | 'detached'>
+}
+
+export enum SpawnStatus {
+  SUCCESS = 'success',
+  ERROR = 'error',
 }
 
-export interface SudoRequestResponseData {}
+export interface SudoRequestResponseData {
+  status: SpawnStatus,
+  data: string;
+}