@codifycli/plugin-core 1.0.1 → 1.1.0-beta10

package/.claude/settings.local.json

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

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) {
@@ -119,9 +121,9 @@ export class Plugin {
             if (!this.resourceControllers.has(core.type)) {
                 throw new Error(`Resource type not found: ${core.type}`);
             }
-            const validation = await this.resourceControllers
+            const validation = await ptyLocalStorage.run(this.planPty, () => this.resourceControllers
                 .get(core.type)
-                .validate(core, parameters);
+                .validate(core, parameters));
             validationResults.push(validation);
         }
         // Validate that if allow multiple is false, then only 1 of each resource exists

package/dist/pty/seqeuntial-pty.js

@@ -74,10 +74,11 @@ export class SequentialPty {
             process.stdout.on('resize', resizeListener);
             mPty.onExit((result) => {
                 process.stdout.off('resize', resizeListener);
+                const raw = stripAnsi(output.join('')).replace(/\r\n/g, '\n').replace(/\r/g, '\n').trim();
                 resolve({
                     status: result.exitCode === 0 ? SpawnStatus.SUCCESS : SpawnStatus.ERROR,
                     exitCode: result.exitCode,
-                    data: stripAnsi(output.join('\n').trim()),
+                    data: raw,
                 });
             });
         });

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,15 @@ 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 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;
@@ -162,6 +171,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/dist/utils/file-utils.d.ts

@@ -20,4 +20,5 @@ export declare class FileUtils {
     static checkDirExistsOrThrowIfFile(path: string): Promise<boolean>;
     static createDirIfNotExists(path: string): Promise<void>;
     private static calculateEndingNewLines;
+    static createShellRcIfNotExists(): Promise<void>;
 }

package/dist/utils/file-utils.js

@@ -19,6 +19,7 @@ export class FileUtils {
         console.log(`Finished downloading to ${destination}`);
     }
     static async addToShellRc(line) {
+        await FileUtils.createShellRcIfNotExists();
         const lineToInsert = addLeadingSpacer(addTrailingSpacer(line));
         await fs.appendFile(Utils.getPrimaryShellRc(), lineToInsert);
         function addLeadingSpacer(line) {
@@ -33,6 +34,7 @@ export class FileUtils {
         }
     }
     static async addAllToShellRc(lines) {
+        await FileUtils.createShellRcIfNotExists();
         const formattedLines = '\n' + lines.join('\n') + '\n';
         const shellRc = Utils.getPrimaryShellRc();
         console.log(`Adding to ${path.basename(shellRc)}:
@@ -46,6 +48,7 @@ ${lines.join('\n')}`);
      * @param prepend - Whether to prepend the path to the existing PATH variable.
      */
     static async addPathToShellRc(value, prepend) {
+        await FileUtils.createShellRcIfNotExists();
         if (await Utils.isDirectoryOnPath(value)) {
             return;
         }
@@ -183,4 +186,10 @@ ${lines.join('\n')}`);
             }
         }
     }
+    static async createShellRcIfNotExists() {
+        const shellRc = Utils.getPrimaryShellRc();
+        if (!await FileUtils.fileExists(shellRc)) {
+            await fs.writeFile(shellRc, '', 'utf8');
+        }
+    }
 }

package/dist/utils/index.js

@@ -3,7 +3,7 @@ import * as fsSync from 'node:fs';
 import * as fs from 'node:fs/promises';
 import os from 'node:os';
 import path from 'node:path';
-import { SpawnStatus, getPty } from '../pty/index.js';
+import { getPty, SpawnStatus } from '../pty/index.js';
 export function isDebug() {
     return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
 }
@@ -56,7 +56,7 @@ export const Utils = {
         return query.status === SpawnStatus.SUCCESS;
     },
     getShell() {
-        const shell = process.env.SHELL || '';
+        const shell = process.env.SHELL || os.userInfo().shell || '';
         if (shell.endsWith('bash')) {
             return Shell.BASH;
         }
@@ -81,7 +81,7 @@ export const Utils = {
         return this.getShellRcFiles()[0];
     },
     getShellRcFiles() {
-        const shell = process.env.SHELL || '';
+        const shell = process.env.SHELL || os.userInfo().shell || '';
         const homeDir = os.homedir();
         if (shell.endsWith('bash')) {
             // Linux typically uses .bashrc, macOS uses .bash_profile
@@ -167,9 +167,9 @@ Brew can be installed using Codify:
             const isAptInstalled = await $.spawnSafe('which apt');
             if (isAptInstalled.status === SpawnStatus.SUCCESS) {
                 await $.spawn('apt-get update', { requiresRoot: true });
-                const { status, data } = await $.spawnSafe(`apt-get -y install ${packageName}`, {
+                const { status, data } = await $.spawnSafe(`apt-get -y -qq install -o Dpkg::Use-Pty=0 -o Dpkg::Progress-Fancy=0 ${packageName}`, {
                     requiresRoot: true,
-                    env: { DEBIAN_FRONTEND: 'noninteractive', NEEDRESTART_MODE: 'a' }
+                    env: { DEBIAN_FRONTEND: 'noninteractive', NEEDRESTART_MODE: 'a', }
                 });
                 if (status === SpawnStatus.ERROR && data.includes('E: dpkg was interrupted, you must manually run \'sudo dpkg --configure -a\' to correct the problem.')) {
                     await $.spawn('dpkg --configure -a', { requiresRoot: true });
@@ -213,7 +213,7 @@ Brew can be installed using Codify:
         if (Utils.isLinux()) {
             const isAptInstalled = await $.spawnSafe('which apt');
             if (isAptInstalled.status === SpawnStatus.SUCCESS) {
-                const { status } = await $.spawnSafe(`apt-get autoremove -y --purge ${packageName}`, {
+                const { status } = await $.spawnSafe(`apt-get -qq autoremove -y -o Dpkg::Use-Pty=0 -o Dpkg::Progress-Fancy=0 --purge ${packageName}`, {
                     requiresRoot: true,
                     env: { DEBIAN_FRONTEND: 'noninteractive', NEEDRESTART_MODE: 'a' }
                 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codifycli/plugin-core",
-  "version": "1.0.1",
+  "version": "1.1.0-beta10",
   "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/src/plugin/plugin.ts

@@ -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,
     }
   }
 
@@ -171,9 +174,11 @@ export class Plugin {
         throw new Error(`Resource type not found: ${core.type}`);
       }
 
-      const validation = await this.resourceControllers
-        .get(core.type)!
-        .validate(core, parameters);
+      const validation = await ptyLocalStorage.run(this.planPty, () =>
+        this.resourceControllers
+          .get(core.type)!
+          .validate(core, parameters)
+      );
 
       validationResults.push(validation);
     }

package/src/pty/seqeuntial-pty.ts

@@ -100,10 +100,12 @@ export class SequentialPty implements IPty {
       mPty.onExit((result) => {
         process.stdout.off('resize', resizeListener);
 
+        const raw = stripAnsi(output.join('')).replace(/\r\n/g, '\n').replace(/\r/g, '\n').trim();
+        
         resolve({
           status: result.exitCode === 0 ? SpawnStatus.SUCCESS : SpawnStatus.ERROR,
           exitCode: result.exitCode,
-          data: stripAnsi(output.join('\n').trim()),
+          data: raw,
         })
       })
     })

package/src/resource/parsed-resource-settings.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>) {

package/src/resource/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
 }
 
 /**

package/src/utils/file-utils.ts

@@ -26,6 +26,8 @@ export class FileUtils {
   }
 
   static async addToShellRc(line: string): Promise<void> {
+    await FileUtils.createShellRcIfNotExists();
+
     const lineToInsert = addLeadingSpacer(
       addTrailingSpacer(line)
     );
@@ -46,6 +48,8 @@ export class FileUtils {
   }
 
   static async addAllToShellRc(lines: string[]): Promise<void> {
+    await FileUtils.createShellRcIfNotExists();
+
     const formattedLines = '\n' + lines.join('\n') + '\n';
     const shellRc = Utils.getPrimaryShellRc();
 
@@ -62,6 +66,8 @@ ${lines.join('\n')}`)
    * @param prepend - Whether to prepend the path to the existing PATH variable.
    */
   static async addPathToShellRc(value: string, prepend: boolean): Promise<void> {
+    await FileUtils.createShellRcIfNotExists();
+
     if (await Utils.isDirectoryOnPath(value)) {
       return;
     }
@@ -228,4 +234,11 @@ ${lines.join('\n')}`)
       }
     }
   }
+
+  static async createShellRcIfNotExists(): Promise<void> {
+    const shellRc = Utils.getPrimaryShellRc();
+    if (!await FileUtils.fileExists(shellRc)) {
+      await fs.writeFile(shellRc, '', 'utf8');
+    }
+  }
 }

package/src/utils/index.ts

@@ -4,7 +4,7 @@ import * as fs from 'node:fs/promises';
 import os from 'node:os';
 import path from 'node:path';
 
-import { SpawnStatus, getPty } from '../pty/index.js';
+import { getPty, SpawnStatus } from '../pty/index.js';
 
 export function isDebug(): boolean {
   return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
@@ -73,7 +73,7 @@ export const Utils = {
   },
 
   getShell(): Shell | undefined {
-    const shell = process.env.SHELL || '';
+    const shell = process.env.SHELL || os.userInfo().shell || '';
 
     if (shell.endsWith('bash')) {
       return Shell.BASH
@@ -108,7 +108,7 @@ export const Utils = {
   },
 
   getShellRcFiles(): string[] {
-    const shell = process.env.SHELL || '';
+    const shell = process.env.SHELL || os.userInfo().shell || '';
     const homeDir = os.homedir();
 
     if (shell.endsWith('bash')) {
@@ -209,9 +209,9 @@ Brew can be installed using Codify:
       const isAptInstalled = await $.spawnSafe('which apt');
       if (isAptInstalled.status === SpawnStatus.SUCCESS) {
         await $.spawn('apt-get update', { requiresRoot: true });
-        const { status, data } = await $.spawnSafe(`apt-get -y install ${packageName}`, {
+        const { status, data } = await $.spawnSafe(`apt-get -y -qq install -o Dpkg::Use-Pty=0 -o Dpkg::Progress-Fancy=0 ${packageName}`, {
           requiresRoot: true,
-          env: { DEBIAN_FRONTEND: 'noninteractive', NEEDRESTART_MODE: 'a' }
+          env: { DEBIAN_FRONTEND: 'noninteractive', NEEDRESTART_MODE: 'a',  }
         });
 
         if (status === SpawnStatus.ERROR && data.includes('E: dpkg was interrupted, you must manually run \'sudo dpkg --configure -a\' to correct the problem.')) {
@@ -265,7 +265,7 @@ Brew can be installed using Codify:
     if (Utils.isLinux()) {
       const isAptInstalled = await $.spawnSafe('which apt');
       if (isAptInstalled.status === SpawnStatus.SUCCESS) {
-        const { status } = await $.spawnSafe(`apt-get autoremove -y --purge ${packageName}`, {
+        const { status } = await $.spawnSafe(`apt-get -qq autoremove -y -o Dpkg::Use-Pty=0 -o Dpkg::Progress-Fancy=0 --purge ${packageName}`, {
           requiresRoot: true,
           env: { DEBIAN_FRONTEND: 'noninteractive', NEEDRESTART_MODE: 'a' }
         });