codify-schemas 1.0.85 → 1.0.86-beta2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/dist/index.d.ts +3 -3
  2. package/dist/index.js +3 -3
  3. package/dist/index.js.map +1 -1
  4. package/dist/messages/apply-request-data-schema.json +1 -2
  5. package/dist/messages/command-request-data-schema.json +34 -0
  6. package/dist/messages/command-response-data-schema.json +22 -0
  7. package/dist/messages/error-response-data-schema.json +1 -2
  8. package/dist/messages/initialize-request-data-schema.json +1 -2
  9. package/dist/messages/plan-request-data-schema.json +0 -1
  10. package/dist/messages/plan-response-data-schema.json +1 -2
  11. package/dist/messages/press-key-to-continue-request-data-schema.json +1 -2
  12. package/dist/messages/press-key-to-continue-response-data-schema.json +2 -3
  13. package/dist/messages/validate-request-data-schema.json +1 -2
  14. package/dist/messages/validate-response-data-schema.json +1 -2
  15. package/dist/types/index.d.ts +10 -4
  16. package/dist/types/index.js +5 -0
  17. package/dist/types/index.js.map +1 -1
  18. package/package.json +1 -1
  19. package/src/index.ts +4 -4
  20. package/src/messages/apply-request-data-schema.json +1 -2
  21. package/src/messages/{sudo-request-data-schema.json → command-request-data-schema.json} +7 -3
  22. package/src/messages/{sudo-request-data-schema.test.ts → command-request-data-schema.test.ts} +6 -2
  23. package/src/messages/{sudo-response-data-schema.json → command-response-data-schema.json} +6 -3
  24. package/src/messages/{sudo-response-data-schema.test.ts → command-response-data-schema.test.ts} +3 -1
  25. package/src/messages/error-response-data-schema.json +1 -2
  26. package/src/messages/initialize-request-data-schema.json +1 -2
  27. package/src/messages/plan-request-data-schema.json +0 -1
  28. package/src/messages/plan-response-data-schema.json +1 -2
  29. package/src/messages/press-key-to-continue-request-data-schema.json +1 -2
  30. package/src/messages/press-key-to-continue-response-data-schema.json +2 -3
  31. package/src/messages/validate-request-data-schema.json +1 -2
  32. package/src/messages/validate-response-data-schema.json +1 -2
  33. package/src/types/index.ts +11 -4
package/dist/index.d.ts CHANGED
@@ -18,10 +18,10 @@ import ValidateRequestDataSchema from './messages/validate-request-data-schema.j
18
18
  import ValidateResponseDataSchema from './messages/validate-response-data-schema.json';
19
19
  import InitializeRequestDataSchema from './messages/initialize-request-data-schema.json';
20
20
  import InitializeResponseDataSchema from './messages/initialize-response-data-schema.json';
21
- import SudoRequestDataSchema from './messages/sudo-request-data-schema.json';
22
- import SudoRequestResponseDataSchema from './messages/sudo-response-data-schema.json';
21
+ import CommandRequestDataSchema from './messages/command-request-data-schema.json';
22
+ import CommandRequestResponseDataSchema from './messages/command-response-data-schema.json';
23
23
  import PressKeyToContinueRequestDataSchema from './messages/press-key-to-continue-request-data-schema.json';
24
24
  import PressKeyToContinueResponseDataSchema from './messages/press-key-to-continue-response-data-schema.json';
25
- export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, IpcMessageV2Schema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, MatchRequestDataSchema, MatchResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, SudoRequestDataSchema, SudoRequestResponseDataSchema, PressKeyToContinueRequestDataSchema, PressKeyToContinueResponseDataSchema, };
25
+ export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, IpcMessageV2Schema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, MatchRequestDataSchema, MatchResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, CommandRequestDataSchema, CommandRequestResponseDataSchema, PressKeyToContinueRequestDataSchema, PressKeyToContinueResponseDataSchema, };
26
26
  export * from './types/index.js';
27
27
  export * from './messages/commands.js';
package/dist/index.js CHANGED
@@ -18,11 +18,11 @@ import ValidateRequestDataSchema from './messages/validate-request-data-schema.j
18
18
  import ValidateResponseDataSchema from './messages/validate-response-data-schema.json' with { type: 'json' };
19
19
  import InitializeRequestDataSchema from './messages/initialize-request-data-schema.json' with { type: 'json' };
20
20
  import InitializeResponseDataSchema from './messages/initialize-response-data-schema.json' with { type: 'json' };
21
- import SudoRequestDataSchema from './messages/sudo-request-data-schema.json' with { type: 'json' };
22
- import SudoRequestResponseDataSchema from './messages/sudo-response-data-schema.json' with { type: 'json' };
21
+ import CommandRequestDataSchema from './messages/command-request-data-schema.json' with { type: 'json' };
22
+ import CommandRequestResponseDataSchema from './messages/command-response-data-schema.json' with { type: 'json' };
23
23
  import PressKeyToContinueRequestDataSchema from './messages/press-key-to-continue-request-data-schema.json' with { type: 'json' };
24
24
  import PressKeyToContinueResponseDataSchema from './messages/press-key-to-continue-response-data-schema.json' with { type: 'json' };
25
- export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, IpcMessageV2Schema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, MatchRequestDataSchema, MatchResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, SudoRequestDataSchema, SudoRequestResponseDataSchema, PressKeyToContinueRequestDataSchema, PressKeyToContinueResponseDataSchema, };
25
+ export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, IpcMessageV2Schema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, MatchRequestDataSchema, MatchResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, CommandRequestDataSchema, CommandRequestResponseDataSchema, PressKeyToContinueRequestDataSchema, PressKeyToContinueResponseDataSchema, };
26
26
  export * from './types/index.js';
27
27
  export * from './messages/commands.js';
28
28
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5E,OAAO,aAAa,MAAM,uBAAuB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACrE,OAAO,cAAc,MAAM,wBAAwB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACvE,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5E,OAAO,kBAAkB,MAAM,8BAA8B,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACjF,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,gCAAgC,MAAM,uDAAuD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACxH,OAAO,iCAAiC,MAAM,wDAAwD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1H,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,wBAAwB,MAAM,6CAA6C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACtG,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAChG,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,yBAAyB,MAAM,8CAA8C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACxG,OAAO,0BAA0B,MAAM,+CAA+C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1G,OAAO,2BAA2B,MAAM,gDAAgD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5G,OAAO,4BAA4B,MAAM,iDAAiD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC9G,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AACjG,OAAO,6BAA6B,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AAC1G,OAAO,mCAAmC,MAAM,2DAA2D,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AAChI,OAAO,oCAAoC,MAAM,4DAA4D,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AAElI,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,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,6BAA6B,EAC7B,mCAAmC,EACnC,oCAAoC,GACrC,CAAA;AAED,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5E,OAAO,aAAa,MAAM,uBAAuB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACrE,OAAO,cAAc,MAAM,wBAAwB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACvE,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5E,OAAO,kBAAkB,MAAM,8BAA8B,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACjF,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,gCAAgC,MAAM,uDAAuD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACxH,OAAO,iCAAiC,MAAM,wDAAwD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1H,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,wBAAwB,MAAM,6CAA6C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACtG,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAChG,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,yBAAyB,MAAM,8CAA8C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACxG,OAAO,0BAA0B,MAAM,+CAA+C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1G,OAAO,2BAA2B,MAAM,gDAAgD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5G,OAAO,4BAA4B,MAAM,iDAAiD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC9G,OAAO,wBAAwB,MAAM,6CAA6C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AACvG,OAAO,gCAAgC,MAAM,8CAA8C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AAChH,OAAO,mCAAmC,MAAM,2DAA2D,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AAChI,OAAO,oCAAoC,MAAM,4DAA4D,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AAElI,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,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,wBAAwB,EACxB,gCAAgC,EAChC,mCAAmC,EACnC,oCAAoC,GACrC,CAAA;AAED,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC"}
@@ -82,8 +82,7 @@
82
82
  "required": ["operation", "resourceType", "parameters", "isStateful"]
83
83
  }
84
84
  },
85
- "required": ["plan"],
86
- "additionalProperties": false
85
+ "required": ["plan"]
87
86
  }
88
87
  ]
89
88
  }
@@ -0,0 +1,34 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema",
3
+ "$id": "https://www.codifycli.com/sudo-request.json",
4
+ "title": "Command request",
5
+ "description": "Request the core CLI to perform a command. This is required for sudo and interactive",
6
+ "type": "object",
7
+ "properties": {
8
+ "command": {
9
+ "type": "string",
10
+ "description": "The command that is requesting sudo"
11
+ },
12
+ "type": {
13
+ "enum": ["sudo", "interactive"],
14
+ "description": "The request type. Right now only sudo and interactive are supported"
15
+ },
16
+ "options": {
17
+ "type": "object",
18
+ "description": "The options for codifySpawn that is needed to run the command",
19
+ "properties": {
20
+ "cwd": {
21
+ "type": "string",
22
+ "description": "Current working directory to run codifySpawn in"
23
+ },
24
+ "argv0": {
25
+ "type": "string",
26
+ "description": "Arguments to pass in"
27
+ }
28
+ },
29
+ "additionalProperties": true
30
+ }
31
+ },
32
+ "required": ["command", "type"],
33
+ "additionalProperties": false
34
+ }
@@ -0,0 +1,22 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema",
3
+ "$id": "https://www.codifycli.com/sudo-request-response.json",
4
+ "title": "Sudo request response",
5
+ "description": "Response for a request to run a command on the base CLI (sudo, interactive, etc)",
6
+ "type": "object",
7
+ "properties": {
8
+ "status": {
9
+ "enum": ["success", "error"],
10
+ "description": "Reports if the operation was successful"
11
+ },
12
+ "exitCode": {
13
+ "type": "integer",
14
+ "description": "The exit code of running the command"
15
+ },
16
+ "data": {
17
+ "type": "string",
18
+ "description": "Data returned by the operation"
19
+ }
20
+ },
21
+ "required": ["status", "exitCode", "data"]
22
+ }
@@ -9,6 +9,5 @@
9
9
  "type": "string"
10
10
  }
11
11
  },
12
- "required": ["reason"],
13
- "additionalProperties": false
12
+ "required": ["reason"]
14
13
  }
@@ -10,6 +10,5 @@
10
10
  "default": 0,
11
11
  "description": "Initializes the plugin to return logs at a specified verbosity level with 0 being the lowest"
12
12
  }
13
- },
14
- "additionalProperties": false
13
+ }
15
14
  }
@@ -20,7 +20,6 @@
20
20
  "description": "If the plan is stateful"
21
21
  }
22
22
  },
23
- "additionalProperties": false,
24
23
  "anyOf": [
25
24
  { "required": ["core", "desired", "isStateful"] },
26
25
  { "required": ["core", "state", "isStateful"] }
@@ -56,6 +56,5 @@
56
56
  }
57
57
  }
58
58
  },
59
- "required": ["planId", "isStateful", "operation", "resourceType", "parameters"],
60
- "additionalProperties": false
59
+ "required": ["planId", "isStateful", "operation", "resourceType", "parameters"]
61
60
  }
@@ -9,6 +9,5 @@
9
9
  "type": "string",
10
10
  "description": "A message to display when prompting"
11
11
  }
12
- },
13
- "additionalProperties": false
12
+ }
14
13
  }
@@ -1,9 +1,8 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema",
3
3
  "$id": "https://www.codifycli.com/sudo-request-response.json",
4
- "title": "Sudo request response",
4
+ "title": "Press key to continue response",
5
5
  "description": "Response for press key to continue prompt",
6
6
  "type": "object",
7
- "properties": {},
8
- "additionalProperties": false
7
+ "properties": {}
9
8
  }
@@ -19,6 +19,5 @@
19
19
  }
20
20
  }
21
21
  },
22
- "required": [],
23
- "additionalProperties": false
22
+ "required": []
24
23
  }
@@ -34,6 +34,5 @@
34
34
  "required": ["resourceType", "isValid", "schemaValidationErrors"]
35
35
  }
36
36
  }
37
- },
38
- "additionalProperties": false
37
+ }
39
38
  }
@@ -97,7 +97,7 @@ export interface GetResourceInfoResponseData {
97
97
  import?: {
98
98
  requiredParameters: string[] | null;
99
99
  };
100
- operatingSystems?: OS;
100
+ operatingSystems?: OS[];
101
101
  importAndDestroy?: {
102
102
  requiredParameters: string[] | null;
103
103
  preventImport?: boolean;
@@ -149,7 +149,7 @@ export interface ApplyRequestData {
149
149
  export interface ResourceDefinition {
150
150
  type: string;
151
151
  dependencies: string[];
152
- operatingSystems?: OS;
152
+ operatingSystems?: OS[];
153
153
  sensitiveParameters?: string[];
154
154
  }
155
155
  export interface InitializeRequestData {
@@ -158,14 +158,20 @@ export interface InitializeRequestData {
158
158
  export interface InitializeResponseData {
159
159
  resourceDefinitions: Array<ResourceDefinition>;
160
160
  }
161
- export interface SudoRequestData {
161
+ export declare enum CommandRequestType {
162
+ SUDO = "sudo",
163
+ INTERACTIVE = "interactive"
164
+ }
165
+ export interface CommandRequestData {
162
166
  command: string;
167
+ type: CommandRequestType;
163
168
  options: {
164
169
  cwd?: string;
165
170
  } & Omit<SpawnOptions, 'stdio' | 'shell' | 'detached'>;
166
171
  }
167
- export interface SudoRequestResponseData {
172
+ export interface CommandRequestResponseData {
168
173
  status: SpawnStatus;
174
+ exitCode: number;
169
175
  data: string;
170
176
  }
171
177
  export interface PressKeyToContinueRequestData {
@@ -18,6 +18,11 @@ export var ParameterOperation;
18
18
  ParameterOperation["MODIFY"] = "modify";
19
19
  ParameterOperation["NOOP"] = "noop";
20
20
  })(ParameterOperation || (ParameterOperation = {}));
21
+ export var CommandRequestType;
22
+ (function (CommandRequestType) {
23
+ CommandRequestType["SUDO"] = "sudo";
24
+ CommandRequestType["INTERACTIVE"] = "interactive";
25
+ })(CommandRequestType || (CommandRequestType = {}));
21
26
  export var SpawnStatus;
22
27
  (function (SpawnStatus) {
23
28
  SpawnStatus["SUCCESS"] = "success";
@@ -1 +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;AA6CD,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;AAwHD,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,8BAAe,CAAA;AACjB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB;AAED,MAAM,CAAN,IAAY,EAIX;AAJD,WAAY,EAAE;IACZ,uBAAiB,CAAA;IACjB,qBAAe,CAAA;IACf,4BAAsB,CAAA;AACxB,CAAC,EAJW,EAAE,KAAF,EAAE,QAIb"}
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;AA6CD,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;AAsGD,MAAM,CAAN,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,iDAA2B,CAAA;AAC7B,CAAC,EAHW,kBAAkB,KAAlB,kBAAkB,QAG7B;AAsBD,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,8BAAe,CAAA;AACjB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB;AAED,MAAM,CAAN,IAAY,EAIX;AAJD,WAAY,EAAE;IACZ,uBAAiB,CAAA;IACjB,qBAAe,CAAA;IACf,4BAAsB,CAAA;AACxB,CAAC,EAJW,EAAE,KAAF,EAAE,QAIb"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "codify-schemas",
3
- "version": "1.0.85",
3
+ "version": "1.0.86-beta2",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
package/src/index.ts CHANGED
@@ -18,8 +18,8 @@ import ValidateRequestDataSchema from './messages/validate-request-data-schema.j
18
18
  import ValidateResponseDataSchema from './messages/validate-response-data-schema.json' with {type: 'json'}
19
19
  import InitializeRequestDataSchema from './messages/initialize-request-data-schema.json' with {type: 'json'}
20
20
  import InitializeResponseDataSchema from './messages/initialize-response-data-schema.json' with {type: 'json'}
21
- import SudoRequestDataSchema from './messages/sudo-request-data-schema.json' with {type: 'json'};
22
- import SudoRequestResponseDataSchema from './messages/sudo-response-data-schema.json' with {type: 'json'};
21
+ import CommandRequestDataSchema from './messages/command-request-data-schema.json' with {type: 'json'};
22
+ import CommandRequestResponseDataSchema from './messages/command-response-data-schema.json' with {type: 'json'};
23
23
  import PressKeyToContinueRequestDataSchema from './messages/press-key-to-continue-request-data-schema.json' with {type: 'json'};
24
24
  import PressKeyToContinueResponseDataSchema from './messages/press-key-to-continue-response-data-schema.json' with {type: 'json'};
25
25
 
@@ -44,8 +44,8 @@ export {
44
44
  ValidateResponseDataSchema,
45
45
  InitializeRequestDataSchema,
46
46
  InitializeResponseDataSchema,
47
- SudoRequestDataSchema,
48
- SudoRequestResponseDataSchema,
47
+ CommandRequestDataSchema,
48
+ CommandRequestResponseDataSchema,
49
49
  PressKeyToContinueRequestDataSchema,
50
50
  PressKeyToContinueResponseDataSchema,
51
51
  }
@@ -82,8 +82,7 @@
82
82
  "required": ["operation", "resourceType", "parameters", "isStateful"]
83
83
  }
84
84
  },
85
- "required": ["plan"],
86
- "additionalProperties": false
85
+ "required": ["plan"]
87
86
  }
88
87
  ]
89
88
  }
@@ -1,14 +1,18 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema",
3
3
  "$id": "https://www.codifycli.com/sudo-request.json",
4
- "title": "Sudo request",
5
- "description": "Request sudo from the core CLI",
4
+ "title": "Command request",
5
+ "description": "Request the core CLI to perform a command. This is required for sudo and interactive",
6
6
  "type": "object",
7
7
  "properties": {
8
8
  "command": {
9
9
  "type": "string",
10
10
  "description": "The command that is requesting sudo"
11
11
  },
12
+ "type": {
13
+ "enum": ["sudo", "interactive"],
14
+ "description": "The request type. Right now only sudo and interactive are supported"
15
+ },
12
16
  "options": {
13
17
  "type": "object",
14
18
  "description": "The options for codifySpawn that is needed to run the command",
@@ -25,6 +29,6 @@
25
29
  "additionalProperties": true
26
30
  }
27
31
  },
28
- "required": ["command"],
32
+ "required": ["command", "type"],
29
33
  "additionalProperties": false
30
34
  }
@@ -1,4 +1,4 @@
1
- import schema from './sudo-request-data-schema.json';
1
+ import schema from './command-request-data-schema.json';
2
2
  import {describe, expect, it} from 'vitest'
3
3
  import Ajv from 'ajv'
4
4
 
@@ -14,7 +14,8 @@ describe('Get resources response data schema', () => {
14
14
  it("Passes a command in the body", () => {
15
15
  const validate = ajv.compile(schema);
16
16
  expect(validate({
17
- command: 'abc def'
17
+ command: 'abc def',
18
+ type: 'sudo'
18
19
  })).to.be.true;
19
20
  })
20
21
 
@@ -22,6 +23,7 @@ describe('Get resources response data schema', () => {
22
23
  const validate = ajv.compile(schema);
23
24
  expect(validate({
24
25
  command: 'abc def',
26
+ type: 'interactive',
25
27
  options: {
26
28
  cwd: '.',
27
29
  }
@@ -32,6 +34,7 @@ describe('Get resources response data schema', () => {
32
34
  const validate = ajv.compile(schema);
33
35
  expect(validate({
34
36
  command: 'abc def',
37
+ type: 'sudo',
35
38
  options: {
36
39
  cwd: '.',
37
40
  requiresRoot: true,
@@ -44,6 +47,7 @@ describe('Get resources response data schema', () => {
44
47
  const validate = ajv.compile(schema);
45
48
  expect(validate({
46
49
  command: 'abc def',
50
+ type: 'interactive',
47
51
  options: {
48
52
  cwd: '.',
49
53
  },
@@ -2,18 +2,21 @@
2
2
  "$schema": "http://json-schema.org/draft-07/schema",
3
3
  "$id": "https://www.codifycli.com/sudo-request-response.json",
4
4
  "title": "Sudo request response",
5
- "description": "Response for a sudo request",
5
+ "description": "Response for a request to run a command on the base CLI (sudo, interactive, etc)",
6
6
  "type": "object",
7
7
  "properties": {
8
8
  "status": {
9
9
  "enum": ["success", "error"],
10
10
  "description": "Reports if the operation was successful"
11
11
  },
12
+ "exitCode": {
13
+ "type": "integer",
14
+ "description": "The exit code of running the command"
15
+ },
12
16
  "data": {
13
17
  "type": "string",
14
18
  "description": "Data returned by the operation"
15
19
  }
16
20
  },
17
- "required": ["status", "data"],
18
- "additionalProperties": false
21
+ "required": ["status", "exitCode", "data"]
19
22
  }
@@ -1,4 +1,4 @@
1
- import schema from './sudo-response-data-schema.json';
1
+ import schema from './command-response-data-schema.json';
2
2
  import {describe, expect, it} from 'vitest'
3
3
  import Ajv from 'ajv'
4
4
 
@@ -15,6 +15,7 @@ describe('Get resources response data schema', () => {
15
15
  const validate = ajv.compile(schema);
16
16
  expect(validate({
17
17
  status: 'success',
18
+ exitCode: 0,
18
19
  data: 'sudo: was a success'
19
20
  })).to.be.true;
20
21
  })
@@ -23,6 +24,7 @@ describe('Get resources response data schema', () => {
23
24
  const validate = ajv.compile(schema);
24
25
  expect(validate({
25
26
  status: 'error',
27
+ exitCode: 100,
26
28
  data: 'sudo: failed'
27
29
  })).to.be.true;
28
30
  })
@@ -9,6 +9,5 @@
9
9
  "type": "string"
10
10
  }
11
11
  },
12
- "required": ["reason"],
13
- "additionalProperties": false
12
+ "required": ["reason"]
14
13
  }
@@ -10,6 +10,5 @@
10
10
  "default": 0,
11
11
  "description": "Initializes the plugin to return logs at a specified verbosity level with 0 being the lowest"
12
12
  }
13
- },
14
- "additionalProperties": false
13
+ }
15
14
  }
@@ -20,7 +20,6 @@
20
20
  "description": "If the plan is stateful"
21
21
  }
22
22
  },
23
- "additionalProperties": false,
24
23
  "anyOf": [
25
24
  { "required": ["core", "desired", "isStateful"] },
26
25
  { "required": ["core", "state", "isStateful"] }
@@ -56,6 +56,5 @@
56
56
  }
57
57
  }
58
58
  },
59
- "required": ["planId", "isStateful", "operation", "resourceType", "parameters"],
60
- "additionalProperties": false
59
+ "required": ["planId", "isStateful", "operation", "resourceType", "parameters"]
61
60
  }
@@ -9,6 +9,5 @@
9
9
  "type": "string",
10
10
  "description": "A message to display when prompting"
11
11
  }
12
- },
13
- "additionalProperties": false
12
+ }
14
13
  }
@@ -1,9 +1,8 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema",
3
3
  "$id": "https://www.codifycli.com/sudo-request-response.json",
4
- "title": "Sudo request response",
4
+ "title": "Press key to continue response",
5
5
  "description": "Response for press key to continue prompt",
6
6
  "type": "object",
7
- "properties": {},
8
- "additionalProperties": false
7
+ "properties": {}
9
8
  }
@@ -19,6 +19,5 @@
19
19
  }
20
20
  }
21
21
  },
22
- "required": [],
23
- "additionalProperties": false
22
+ "required": []
24
23
  }
@@ -34,6 +34,5 @@
34
34
  "required": ["resourceType", "isValid", "schemaValidationErrors"]
35
35
  }
36
36
  }
37
- },
38
- "additionalProperties": false
37
+ }
39
38
  }
@@ -113,7 +113,7 @@ export interface GetResourceInfoResponseData {
113
113
  import?: {
114
114
  requiredParameters: string[] | null;
115
115
  },
116
- operatingSystems?: OS;
116
+ operatingSystems?: OS[];
117
117
  importAndDestroy?: {
118
118
  requiredParameters: string[] | null;
119
119
  preventImport?: boolean;
@@ -171,7 +171,7 @@ export interface ApplyRequestData {
171
171
  export interface ResourceDefinition {
172
172
  type: string;
173
173
  dependencies: string[];
174
- operatingSystems?: OS;
174
+ operatingSystems?: OS[];
175
175
  sensitiveParameters?: string[];
176
176
  }
177
177
 
@@ -183,15 +183,22 @@ export interface InitializeResponseData {
183
183
  resourceDefinitions: Array<ResourceDefinition>;
184
184
  }
185
185
 
186
- export interface SudoRequestData {
186
+ export enum CommandRequestType {
187
+ SUDO = 'sudo',
188
+ INTERACTIVE = 'interactive'
189
+ }
190
+
191
+ export interface CommandRequestData {
187
192
  command: string;
193
+ type: CommandRequestType,
188
194
  options: {
189
195
  cwd?: string;
190
196
  } & Omit<SpawnOptions, 'stdio' | 'shell' | 'detached'>
191
197
  }
192
198
 
193
- export interface SudoRequestResponseData {
199
+ export interface CommandRequestResponseData {
194
200
  status: SpawnStatus,
201
+ exitCode: number;
195
202
  data: string;
196
203
  }
197
204