@codifycli/plugin-core 1.1.0-beta1 → 1.1.0-beta4

package/dist/plugin/plugin.d.ts

@@ -11,10 +11,7 @@ export declare class Plugin {
     constructor(name: string, resourceControllers: Map<string, ResourceController<ResourceConfig>>);
     static create(name: string, resources: Resource<any>[]): Plugin;
     initialize(data: InitializeRequestData): Promise<InitializeResponseData>;
-    getResourceInfo(data: GetResourceInfoRequestData): {
-        defaultConfig: unknown;
-        exampleConfigs: unknown;
-    } & GetResourceInfoResponseData;
+    getResourceInfo(data: GetResourceInfoRequestData): GetResourceInfoResponseData;
     match(data: MatchRequestData): Promise<MatchResponseData>;
     import(data: ImportRequestData): Promise<ImportResponseData>;
     validate(data: ValidateRequestData): Promise<ValidateResponseData>;

package/dist/resource/resource-settings.d.ts

@@ -4,9 +4,10 @@ import { ZodObject } from 'zod';
 import { ArrayStatefulParameter, StatefulParameter } from '../stateful-parameter/stateful-parameter.js';
 import { ParsedResourceSettings } from './parsed-resource-settings.js';
 import { RefreshContext } from './resource.js';
-export interface ExampleConfig {
+export interface ExampleConfig extends Record<string, unknown> {
+    title: string;
     configs: Array<Record<string, unknown>>;
-    description: string;
+    description?: string;
 }
 export interface ExampleConfigs {
     example1: ExampleConfig;
@@ -180,7 +181,7 @@ export interface ResourceSettings<T extends StringIndexedObject> {
      * 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;
+    exampleConfigs?: ExampleConfigs;
 }
 /**
  * The type of parameter. This value is mainly used to determine a pre-set equality method for comparing the current

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codifycli/plugin-core",
-  "version": "1.1.0-beta1",
+  "version": "1.1.0-beta4",
   "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-beta2",
     "@homebridge/node-pty-prebuilt-multiarch": "^0.13.1",
     "ajv": "^8.18.0",
     "ajv-formats": "^2.1.1",

package/src/plugin/plugin.ts

@@ -83,7 +83,7 @@ export class Plugin {
     }
   }
 
-  getResourceInfo(data: GetResourceInfoRequestData): { defaultConfig: unknown; exampleConfigs: unknown } & GetResourceInfoResponseData {
+  getResourceInfo(data: GetResourceInfoRequestData): GetResourceInfoResponseData {
     if (!this.resourceControllers.has(data.type)) {
       throw new Error(`Cannot get info for resource ${data.type}, resource doesn't exist`);
     }

package/src/resource/parsed-resource-settings.ts

@@ -5,7 +5,8 @@ import { z, ZodObject } from 'zod';
 import { StatefulParameterController } from '../stateful-parameter/stateful-parameter-controller.js';
 import {
   ArrayParameterSetting,
-  DefaultParameterSetting, ExampleConfigs,
+  DefaultParameterSetting,
+  ExampleConfigs,
   InputTransformation,
   ParameterSetting,
   resolveElementEqualsFn,

package/src/resource/resource-settings.ts

@@ -15,9 +15,10 @@ import {
 import { ParsedResourceSettings } from './parsed-resource-settings.js';
 import { RefreshContext } from './resource.js';
 
-export interface ExampleConfig {
+export interface ExampleConfig extends Record<string, unknown> {
+  title: string;
   configs: Array<Record<string, unknown>>;
-  description: string;
+  description?: string;
 }
 
 export interface ExampleConfigs {
@@ -216,7 +217,7 @@ export interface ResourceSettings<T extends StringIndexedObject> {
    * 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
+  exampleConfigs?: ExampleConfigs
 }
 
 /**