codify-plugin-lib 1.0.182-beta27 → 1.0.182-beta29

package/dist/plugin/plugin.js

@@ -55,7 +55,7 @@ export class Plugin {
             throw new Error(`Cannot get info for resource ${data.type}, resource doesn't exist`);
         }
         const resource = this.resourceControllers.get(data.type);
-        const schema = resource.settings.schema;
+        const schema = resource.parsedSettings.schema;
         const requiredPropertyNames = (resource.settings.importAndDestroy?.requiredParameters
             ?? (typeof resource.settings.allowMultiple === 'object' ? resource.settings.allowMultiple.identifyingParameters : null)
             ?? schema?.required

package/dist/pty/background-pty.js

@@ -30,12 +30,12 @@ export class BackgroundPty {
     async spawn(cmd, options) {
         const spawnResult = await this.spawnSafe(cmd, options);
         if (spawnResult.status !== 'success') {
-            throw new SpawnError(Array.isArray(cmd) ? cmd.join('\n') : cmd, spawnResult.exitCode, spawnResult.data);
+            throw new SpawnError(Array.isArray(cmd) ? cmd.join(' ') : cmd, spawnResult.exitCode, spawnResult.data);
         }
         return spawnResult;
     }
     async spawnSafe(cmd, options) {
-        cmd = Array.isArray(cmd) ? cmd.join('\n') : cmd;
+        cmd = Array.isArray(cmd) ? cmd.join('\\\n') : cmd;
         // cid is command id
         const cid = nanoid(10);
         debugLog(cid);

package/dist/pty/seqeuntial-pty.js

@@ -35,7 +35,7 @@ export class SequentialPty {
         if (options?.stdin || options?.requiresRoot) {
             return this.externalSpawn(cmd, options);
         }
-        console.log(`Running command: ${Array.isArray(cmd) ? cmd.join('\n') : cmd}` + (options?.cwd ? `(${options?.cwd})` : ''));
+        console.log(`Running command: ${Array.isArray(cmd) ? cmd.join('\\\n') : cmd}` + (options?.cwd ? `(${options?.cwd})` : ''));
         return new Promise((resolve) => {
             const output = [];
             const historyIgnore = Utils.getShell() === Shell.ZSH ? { HISTORY_IGNORE: '*' } : { HISTIGNORE: '*' };

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

@@ -18,10 +18,12 @@ export type ParsedParameterSetting = {
 export declare class ParsedResourceSettings<T extends StringIndexedObject> implements ResourceSettings<T> {
     private cache;
     id: string;
+    description?: string;
     schema?: Partial<JSONSchemaType<T | any>>;
     allowMultiple?: {
+        identifyingParameters?: string[];
         matcher?: (desired: Partial<T>, current: Partial<T>) => boolean;
-        requiredParameters?: string[];
+        findAllParameters?: () => Promise<Array<Partial<T>>>;
     } | boolean;
     removeStatefulParametersBeforeDestroy?: boolean | undefined;
     dependencies?: string[] | undefined;

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

@@ -1,8 +1,10 @@
+import { ZodObject, z } from 'zod';
 import { StatefulParameterController } from '../stateful-parameter/stateful-parameter-controller.js';
 import { resolveElementEqualsFn, resolveEqualsFn, resolveMatcher, resolveParameterTransformFn } from './resource-settings.js';
 export class ParsedResourceSettings {
     cache = new Map();
     id;
+    description;
     schema;
     allowMultiple;
     removeStatefulParametersBeforeDestroy;
@@ -13,8 +15,17 @@ export class ParsedResourceSettings {
     settings;
     constructor(settings) {
         this.settings = settings;
-        const { parameterSettings, ...rest } = settings;
+        const { parameterSettings, schema, ...rest } = settings;
         Object.assign(this, rest);
+        this.schema = schema instanceof ZodObject
+            ? z.toJSONSchema(schema, {
+                target: 'draft-7',
+                override(ctx) {
+                    ctx.jsonSchema.title = settings.id;
+                    ctx.jsonSchema.description = settings.description ?? `${settings.id} resource. Can be used to manage ${settings.id}`;
+                }
+            })
+            : schema;
         this.validateSettings();
     }
     get typeId() {
@@ -118,7 +129,7 @@ export class ParsedResourceSettings {
             && typeof this.settings.allowMultiple === 'object' && this.settings.allowMultiple?.identifyingParameters?.includes(k))) {
             throw new Error(`Resource: ${this.id}. Stateful parameters are not allowed to be identifying parameters for allowMultiple.`);
         }
-        const schema = this.settings.schema;
+        const schema = this.schema;
         if (!this.settings.importAndDestroy && (schema?.oneOf
             && Array.isArray(schema.oneOf)
             && schema.oneOf.some((s) => s.required))

package/dist/resource/resource-controller.js

@@ -17,16 +17,16 @@ export class ResourceController {
         this.settings = resource.getSettings();
         this.typeId = this.settings.id;
         this.dependencies = this.settings.dependencies ?? [];
-        if (this.settings.schema) {
+        this.parsedSettings = new ParsedResourceSettings(this.settings);
+        if (this.parsedSettings.schema) {
             this.ajv = new Ajv({
                 allErrors: true,
                 strict: true,
                 strictRequired: false,
                 allowUnionTypes: true
             });
-            this.schemaValidator = this.ajv.compile(this.settings.schema);
+            this.schemaValidator = this.ajv.compile(this.parsedSettings.schema);
         }
-        this.parsedSettings = new ParsedResourceSettings(this.settings);
     }
     async initialize() {
         return this.resource.initialize();

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

@@ -1,7 +1,9 @@
 import { JSONSchemaType } from 'ajv';
 import { OS, StringIndexedObject } from 'codify-schemas';
+import { ZodObject } from 'zod';
 import { ArrayStatefulParameter, StatefulParameter } from '../stateful-parameter/stateful-parameter.js';
 import { RefreshContext } from './resource.js';
+import { ParsedResourceSettings } from './parsed-resource-settings.js';
 export interface InputTransformation {
     to: (input: any) => Promise<any> | any;
     from: (current: any, original: any) => Promise<any> | any;
@@ -21,12 +23,16 @@ export interface ResourceSettings<T extends StringIndexedObject> {
     /**
      * Schema to validate user configs with. Must be in the format JSON Schema draft07
      */
-    schema?: Partial<JSONSchemaType<T | any>>;
+    schema?: Partial<JSONSchemaType<T | any>> | ZodObject;
     /**
      * Mark the resource as sensitive. Defaults to false. This prevents the resource from automatically being imported by init and import.
      * This differs from the parameter level sensitivity which also prevents the parameter value from being displayed in the plan.
      */
     isSensitive?: boolean;
+    /**
+     * An optional description of the resource. This does not affect the behavior of the resource.
+     */
+    description?: string;
     /**
      * Allow multiple of the same resource to unique. Set truthy if
      * multiples are allowed, for example for applications, there can be multiple copy of the same application installed
@@ -290,4 +296,4 @@ export declare function resolveEqualsFn(parameter: ParameterSetting): (desired:
 export declare function resolveElementEqualsFn(parameter: ArrayParameterSetting): (desired: unknown, current: unknown) => boolean;
 export declare function resolveFnFromEqualsFnOrString(fnOrString: ((a: unknown, b: unknown) => boolean) | ParameterSettingType | undefined): ((a: unknown, b: unknown) => boolean) | undefined;
 export declare function resolveParameterTransformFn(parameter: ParameterSetting): InputTransformation | undefined;
-export declare function resolveMatcher<T extends StringIndexedObject>(settings: ResourceSettings<T>): (desired: Partial<T>, current: Partial<T>) => boolean;
+export declare function resolveMatcher<T extends StringIndexedObject>(settings: ParsedResourceSettings<T>): (desired: Partial<T>, current: Partial<T>) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.182-beta27",
+  "version": "1.0.182-beta29",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -26,7 +26,8 @@
     "lodash.isequal": "^4.5.0",
     "nanoid": "^5.0.9",
     "strip-ansi": "^7.1.0",
-    "uuid": "^10.0.0"
+    "uuid": "^10.0.0",
+    "zod": "4.1.13"
   },
   "devDependencies": {
     "@apidevtools/json-schema-ref-parser": "^11.7.2",

package/src/plugin/plugin.ts

@@ -89,7 +89,7 @@ export class Plugin {
 
     const resource = this.resourceControllers.get(data.type)!;
 
-    const schema = resource.settings.schema as JSONSchemaType<any> | undefined;
+    const schema = resource.parsedSettings.schema as JSONSchemaType<any> | undefined;
     const requiredPropertyNames = (
       resource.settings.importAndDestroy?.requiredParameters
       ?? (typeof resource.settings.allowMultiple === 'object' ? resource.settings.allowMultiple.identifyingParameters : null)

package/src/pty/background-pty.ts

@@ -37,14 +37,14 @@ export class BackgroundPty implements IPty {
     const spawnResult = await this.spawnSafe(cmd, options);
 
     if (spawnResult.status !== 'success') {
-      throw new SpawnError(Array.isArray(cmd) ? cmd.join('\n') : cmd, spawnResult.exitCode, spawnResult.data);
+      throw new SpawnError(Array.isArray(cmd) ? cmd.join(' ') : cmd, spawnResult.exitCode, spawnResult.data);
     }
 
     return spawnResult;
   }
 
   async spawnSafe(cmd: string | string[], options?: SpawnOptions): Promise<SpawnResult> {
-    cmd = Array.isArray(cmd) ? cmd.join('\n') : cmd;
+    cmd = Array.isArray(cmd) ? cmd.join('\\\n') : cmd;
 
     // cid is command id
     const cid = nanoid(10);

package/src/pty/seqeuntial-pty.ts

@@ -45,7 +45,7 @@ export class SequentialPty implements IPty {
       return this.externalSpawn(cmd, options);
     }
 
-    console.log(`Running command: ${Array.isArray(cmd) ? cmd.join('\n') : cmd}` + (options?.cwd ? `(${options?.cwd})` : ''))
+    console.log(`Running command: ${Array.isArray(cmd) ? cmd.join('\\\n') : cmd}` + (options?.cwd ? `(${options?.cwd})` : ''))
 
     return new Promise((resolve) => {
       const output: string[] = [];

package/src/pty/sequential-pty.test.ts

@@ -51,6 +51,21 @@ describe('SequentialPty tests', () => {
     })
   });
 
+
+  it('Can use multi-line commands', async () => {
+    const pty = new SequentialPty();
+
+    const resultSuccess = await pty.spawnSafe([
+      'pwd',
+      '&& ls',
+    ], { cwd: '/tmp' });
+    expect(resultSuccess).toMatchObject({
+      status: 'success',
+      exitCode: 0,
+    })
+  });
+
+
   it('It can launch a command in interactive mode', async () => {
     const originalSend = process.send;
     process.send = (req: IpcMessageV2) => {

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

@@ -2,6 +2,8 @@ import { describe, expect, it } from 'vitest';
 import { ResourceSettings } from './resource-settings.js';
 import { ParsedResourceSettings } from './parsed-resource-settings.js';
 import { TestConfig } from '../utils/test-utils.test.js';
+import { z } from 'zod';
+import { OS, ResourceConfig, ResourceSchema } from 'codify-schemas';
 
 describe('Resource options parser tests', () => {
   it('Parses default values from options', () => {
@@ -159,4 +161,26 @@ describe('Resource options parser tests', () => {
 
     expect(() => new ParsedResourceSettings(option)).toThrowError()
   })
+
+  it('Can handle a zod schema', () => {
+
+    const schema = z.object({
+      propA: z.string(),
+      repository: z.string(),
+    })
+
+    const option: ResourceSettings<z.infer<typeof schema>> = {
+      id: 'typeId',
+      operatingSystems: [OS.Darwin],
+      schema,
+      importAndDestroy: {
+        defaultRefreshValues: {
+          repository: 'abc'
+        }
+      }
+    }
+
+    console.log(new ParsedResourceSettings(option))
+
+  })
 })

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

@@ -1,5 +1,6 @@
 import { JSONSchemaType } from 'ajv';
 import { OS, StringIndexedObject } from 'codify-schemas';
+import { ZodObject, z } from 'zod';
 
 import { StatefulParameterController } from '../stateful-parameter/stateful-parameter-controller.js';
 import {
@@ -7,13 +8,14 @@ import {
   DefaultParameterSetting,
   InputTransformation,
   ParameterSetting,
+  ResourceSettings,
+  StatefulParameterSetting,
   resolveElementEqualsFn,
   resolveEqualsFn,
   resolveMatcher,
-  resolveParameterTransformFn,
-  ResourceSettings,
-  StatefulParameterSetting
+  resolveParameterTransformFn
 } from './resource-settings.js';
+import { JSONSchema } from '@apidevtools/json-schema-ref-parser';
 
 export interface ParsedStatefulParameterSetting extends DefaultParameterSetting {
   type: 'stateful',
@@ -29,7 +31,7 @@ export type ParsedArrayParameterSetting = {
 
 export type ParsedParameterSetting =
   {
-  isEqual: (desired: unknown, current: unknown) => boolean;
+    isEqual: (desired: unknown, current: unknown) => boolean;
   } & (DefaultParameterSetting
   | ParsedArrayParameterSetting
   | ParsedStatefulParameterSetting)
@@ -37,10 +39,13 @@ export type ParsedParameterSetting =
 export class ParsedResourceSettings<T extends StringIndexedObject> implements ResourceSettings<T> {
   private cache = new Map<string, unknown>();
   id!: string;
+  description?: string;
+
   schema?: Partial<JSONSchemaType<T | any>>;
   allowMultiple?: {
+    identifyingParameters?: string[];
     matcher?: (desired: Partial<T>, current: Partial<T>) => boolean;
-    requiredParameters?: string[]
+    findAllParameters?: () => Promise<Array<Partial<T>>>
   } | boolean;
 
   removeStatefulParametersBeforeDestroy?: boolean | undefined;
@@ -54,9 +59,18 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
 
   constructor(settings: ResourceSettings<T>) {
     this.settings = settings;
+    const { parameterSettings, schema, ...rest } = settings;
 
-    const { parameterSettings, ...rest } = settings;
     Object.assign(this, rest);
+    this.schema = schema instanceof ZodObject
+      ? z.toJSONSchema(schema, {
+        target: 'draft-7',
+        override(ctx) {
+          ctx.jsonSchema.title = settings.id;
+          ctx.jsonSchema.description = settings.description ?? `${settings.id} resource. Can be used to manage ${settings.id}`;
+        }
+      }) as JSONSchemaType<T>
+      : schema;
 
     this.validateSettings();
   }
@@ -199,7 +213,7 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
       throw new Error(`Resource: ${this.id}. Stateful parameters are not allowed to be identifying parameters for allowMultiple.`)
     }
 
-    const schema = this.settings.schema as JSONSchemaType<any>;
+    const schema = this.schema as JSONSchemaType<any>;
     if (!this.settings.importAndDestroy && (schema?.oneOf
         && Array.isArray(schema.oneOf)
         && schema.oneOf.some((s) => s.required)

package/src/resource/resource-controller.ts

@@ -36,18 +36,17 @@ export class ResourceController<T extends StringIndexedObject> {
 
     this.typeId = this.settings.id;
     this.dependencies = this.settings.dependencies ?? [];
+    this.parsedSettings = new ParsedResourceSettings<T>(this.settings);
 
-    if (this.settings.schema) {
+    if (this.parsedSettings.schema) {
       this.ajv = new Ajv({
         allErrors: true,
         strict: true,
         strictRequired: false,
         allowUnionTypes: true
       })
-      this.schemaValidator = this.ajv.compile(this.settings.schema);
+      this.schemaValidator = this.ajv.compile(this.parsedSettings.schema);
     }
-
-    this.parsedSettings = new ParsedResourceSettings<T>(this.settings);
   }
 
   async initialize(): Promise<void> {

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

@@ -13,6 +13,7 @@ import { ArrayParameterSetting, ParameterSetting, ResourceSettings } from './res
 import { ResourceController } from './resource-controller.js';
 import os from 'node:os';
 import path from 'node:path';
+import { z } from 'zod';
 
 describe('Resource parameter tests', () => {
   it('Generates a resource plan that includes stateful parameters (create)', async () => {
@@ -1174,4 +1175,39 @@ describe('Resource parameter tests', () => {
     expect(from2).to.eq('$HOME/abc/def')
 
   })
+
+  it('Can match directories 2', async () => {
+
+    const schema = z.object({
+      propA: z.string(),
+      propB: z.number(),
+    });
+
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<z.infer<typeof schema>> {
+        return {
+          id: 'resourceType',
+          schema,
+          operatingSystems: [OS.Darwin],
+          parameterSettings: {
+            propA: { type: 'directory' }
+          },
+        }
+      }
+    };
+
+    const controller = new ResourceController(resource);
+    const transformations = controller.parsedSettings.inputTransformations.propA;
+
+    const to = transformations!.to('$HOME/abc/def')
+    expect(to).to.eq(os.homedir() + '/abc/def')
+
+    const from = transformations!.from(os.homedir() + '/abc/def')
+    expect(from).to.eq('~/abc/def')
+
+    const from2 = transformations!.from(os.homedir() + '/abc/def', '$HOME/abc/def')
+    expect(from2).to.eq('$HOME/abc/def')
+
+  })
+
 })

package/src/resource/resource-settings.ts

@@ -2,6 +2,7 @@ import { JSONSchemaType } from 'ajv';
 import { OS, StringIndexedObject } from 'codify-schemas';
 import isObjectsEqual from 'lodash.isequal'
 import path from 'node:path';
+import { ZodObject } from 'zod';
 
 import { ArrayStatefulParameter, StatefulParameter } from '../stateful-parameter/stateful-parameter.js';
 import {
@@ -12,6 +13,7 @@ import {
   untildify
 } from '../utils/functions.js';
 import { RefreshContext } from './resource.js';
+import { ParsedResourceSettings } from './parsed-resource-settings.js';
 
 export interface InputTransformation {
   to: (input: any) => Promise<any> | any;
@@ -36,7 +38,7 @@ export interface ResourceSettings<T extends StringIndexedObject> {
   /**
    * Schema to validate user configs with. Must be in the format JSON Schema draft07
    */
-  schema?: Partial<JSONSchemaType<T | any>>;
+  schema?: Partial<JSONSchemaType<T | any>> | ZodObject;
 
   /**
    * Mark the resource as sensitive. Defaults to false. This prevents the resource from automatically being imported by init and import.
@@ -44,6 +46,11 @@ export interface ResourceSettings<T extends StringIndexedObject> {
    */
   isSensitive?: boolean;
 
+  /**
+   * An optional description of the resource. This does not affect the behavior of the resource.
+   */
+  description?: string;
+
   /**
    * Allow multiple of the same resource to unique. Set truthy if
    * multiples are allowed, for example for applications, there can be multiple copy of the same application installed
@@ -489,7 +496,7 @@ export function resolveParameterTransformFn(
 }
 
 export function resolveMatcher<T extends StringIndexedObject>(
-  settings: ResourceSettings<T>
+  settings: ParsedResourceSettings<T>
 ): (desired: Partial<T>, current: Partial<T>) => boolean {
   return typeof settings.allowMultiple === 'boolean' || !settings.allowMultiple?.matcher
     ? ((desired: Partial<T>, current: Partial<T>) => {