feat: Add defaultConfig and exampleConfigs and distro

Author: kevinwang5658

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codifycli/schemas",
-  "version": "1.0.0",
+  "version": "1.1.0-beta4",
   "description": "JSON Schemas and types that govern the message format and Codify config formats for Codify",
   "type": "module",
   "main": "dist/index.js",

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

@@ -70,6 +70,14 @@
     },
     "allowMultiple": {
       "type": "boolean"
+    },
+    "defaultConfig": {
+      "type": "object",
+      "description": "The default config that should be added. This prefills some parameters for the user to make it easier for them"
+    },
+    "exampleConfigs": {
+      "type": "object",
+      "description": "Some example configs. This makes it for the user."
     }
   },
   "required": ["type", "plugin"]

src/resource-schema.json

@@ -9,13 +9,6 @@
       "type": "string",
       "pattern": "^[a-zA-Z][\\w-]+$"
     },
-    "os": {
-      "type": "array",
-      "items": {
-        "enum": ["linux", "macOS", "windows"]
-      },
-      "uniqueItems": true
-    },
     "name": {
       "description": "Optional name. Useful for specifying multiple resources of the same type",
       "type": "string",
@@ -27,6 +20,40 @@
         "type": "string"
       },
       "uniqueItems": true
+    },
+    "os": {
+      "type": "array",
+      "items": {
+        "enum": ["linux", "macOS", "windows"]
+      },
+      "uniqueItems": true
+    },
+    "distro": {
+      "type": "array",
+      "items": {
+        "enum": [
+          "debian-based",
+          "rpm-based",
+          "arch",
+          "centos",
+          "debian",
+          "fedora",
+          "rhel",
+          "ubuntu",
+          "alpine",
+          "amzn",
+          "opensuse",
+          "sles",
+          "manjaro",
+          "linuxmint",
+          "pop",
+          "elementary",
+          "kali",
+          "gentoo",
+          "slackware"
+        ]
+      },
+      "uniqueItems": true
     }
   },
   "required": ["type"]

src/types/index.ts

@@ -25,6 +25,7 @@ export interface ResourceConfig extends Config {
   name?: string;
   dependsOn?: string[];
   os?: Array<ResourceOs>;
+  distro?: Array<LinuxDistro>
 }
 
 export enum MessageStatus {
@@ -128,6 +129,11 @@ export interface GetResourceInfoResponseData {
   },
   sensitiveParameters?: string[];
   allowMultiple: boolean;
+  defaultConfig?: Record<string, unknown>;
+  exampleConfigs?: {
+    example1?: Record<string, unknown>;
+    example2?: Record<string, unknown>;
+  };
 }
 
 export interface MatchRequestData {
@@ -198,6 +204,7 @@ export interface CommandRequestData {
     cwd?: string;
     interactive?: boolean;
     requiresRoot?: boolean;
+    requiresSudoAskpass?: boolean;
     stdin?: boolean;
   } & Omit<SpawnOptions, 'stdio' | 'shell' | 'detached'>
 }