@codifycli/plugin-core 1.0.1 → 1.1.0-beta1

package/.claude/settings.local.json

@@ -0,0 +1,5 @@
+{
+  "disabledMcpjsonServers": [
+    "supabase"
+  ]
+}

package/dist/plugin/plugin.d.ts

@@ -11,7 +11,10 @@ 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): GetResourceInfoResponseData;
+    getResourceInfo(data: GetResourceInfoRequestData): {
+        defaultConfig: unknown;
+        exampleConfigs: unknown;
+    } & GetResourceInfoResponseData;
     match(data: MatchRequestData): Promise<MatchResponseData>;
     import(data: ImportRequestData): Promise<ImportResponseData>;
     validate(data: ValidateRequestData): Promise<ValidateResponseData>;

package/dist/plugin/plugin.js

@@ -87,7 +87,9 @@ export class Plugin {
             operatingSystems: resource.settings.operatingSystems,
             linuxDistros: resource.settings.linuxDistros,
             sensitiveParameters,
-            allowMultiple
+            allowMultiple,
+            defaultConfig: resource.settings.defaultConfig,
+            exampleConfigs: resource.settings.exampleConfigs,
         };
     }
     async match(data) {

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

@@ -1,7 +1,7 @@
 import { LinuxDistro, OS, StringIndexedObject } from '@codifycli/schemas';
 import { JSONSchemaType } from 'ajv';
 import { StatefulParameterController } from '../stateful-parameter/stateful-parameter-controller.js';
-import { ArrayParameterSetting, DefaultParameterSetting, InputTransformation, ResourceSettings } from './resource-settings.js';
+import { ArrayParameterSetting, DefaultParameterSetting, ExampleConfigs, InputTransformation, ResourceSettings } from './resource-settings.js';
 export interface ParsedStatefulParameterSetting extends DefaultParameterSetting {
     type: 'stateful';
     controller: StatefulParameterController<any, unknown>;
@@ -31,6 +31,8 @@ export declare class ParsedResourceSettings<T extends StringIndexedObject> imple
     operatingSystems: Array<OS>;
     linuxDistros?: Array<LinuxDistro>;
     isSensitive?: boolean;
+    defaultConfig: Partial<T>;
+    exampleConfigs: ExampleConfigs;
     private settings;
     constructor(settings: ResourceSettings<T>);
     get typeId(): string;

package/dist/resource/parsed-resource-settings.js

@@ -13,6 +13,8 @@ export class ParsedResourceSettings {
     operatingSystems;
     linuxDistros;
     isSensitive;
+    defaultConfig;
+    exampleConfigs;
     settings;
     constructor(settings) {
         this.settings = settings;

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

@@ -4,6 +4,14 @@ 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 {
+    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;
@@ -162,6 +170,17 @@ 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;
 }
 /**
  * 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.0.1",
+  "version": "1.1.0-beta1",
   "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",

package/src/plugin/plugin.ts

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

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

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

package/src/resource/resource-settings.ts

@@ -15,6 +15,16 @@ import {
 import { ParsedResourceSettings } from './parsed-resource-settings.js';
 import { RefreshContext } from './resource.js';
 
+export interface ExampleConfig {
+  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 +204,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
 }
 
 /**