fix: Added example and default configs

Author: kevinwang5658

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@codifycli/plugin-core",
-  "version": "1.0.1",
+  "version": "1.1.0-beta5",
   "description": "TypeScript library for building Codify plugins to manage system resources (applications, CLI tools, settings) through infrastructure-as-code",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -35,7 +35,7 @@
   },
   "license": "ISC",
   "dependencies": {
-    "@codifycli/schemas": "1.0.0",
+    "@codifycli/schemas": "1.1.0-beta3",
     "@homebridge/node-pty-prebuilt-multiarch": "^0.13.1",
     "ajv": "^8.18.0",
     "ajv-formats": "^2.1.1",

package.json

@@ -11,7 +11,8 @@ import {
   PlanRequestData,
   PlanResponseData,
   ResourceConfig,
-  ResourceJson, SetVerbosityRequestData,
+  ResourceJson,
+  SetVerbosityRequestData,
   ValidateRequestData,
   ValidateResponseData
 } from '@codifycli/schemas';
@@ -127,7 +128,9 @@ export class Plugin {
       operatingSystems: resource.settings.operatingSystems,
       linuxDistros: resource.settings.linuxDistros,
       sensitiveParameters,
-      allowMultiple
+      allowMultiple,
+      defaultConfig: resource.settings.defaultConfig,
+      exampleConfigs: resource.settings.exampleConfigs,
     }
   }
 

src/plugin/plugin.ts

@@ -6,6 +6,7 @@ import { StatefulParameterController } from '../stateful-parameter/stateful-para
 import {
   ArrayParameterSetting,
   DefaultParameterSetting,
+  ExampleConfigs,
   InputTransformation,
   ParameterSetting,
   resolveElementEqualsFn,
@@ -56,6 +57,9 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
 
   isSensitive?: boolean;
 
+  defaultConfig!: Partial<T>;
+  exampleConfigs!: ExampleConfigs;
+
   private settings: ResourceSettings<T>;
 
   constructor(settings: ResourceSettings<T>) {

src/resource/parsed-resource-settings.ts

@@ -15,6 +15,17 @@ import {
 import { ParsedResourceSettings } from './parsed-resource-settings.js';
 import { RefreshContext } from './resource.js';
 
+export interface ExampleConfig extends Record<string, unknown> {
+  title: string;
+  configs: Array<Record<string, unknown>>;
+  description?: string;
+}
+
+export interface ExampleConfigs {
+  example1?: ExampleConfig;
+  example2?: ExampleConfig;
+}
+
 export interface InputTransformation {
   to: (input: any) => Promise<any> | any;
   from: (current: any, original: any) => Promise<any> | any;
@@ -194,6 +205,19 @@ export interface ResourceSettings<T extends StringIndexedObject> {
      */
     refreshMapper?: (input: Partial<T>, context: RefreshContext<T>) => Partial<T>;
   }
+
+  /**
+   * Represents the default config that is added to the editor with prefilled properties. For some resources
+   *
+   * @type {Partial<T>}
+   */
+  defaultConfig?: Partial<T>
+
+  /**
+   * A collection of example configs used to give users an idea on how to use this specific resource. These examples
+   * don't need to be limited to just the current resource. They can include other resources as well
+   */
+  exampleConfigs?: ExampleConfigs
 }
 
 /**