codify-plugin-lib 1.0.106 → 1.0.107

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

@@ -1,6 +1,6 @@
 import { StringIndexedObject } from 'codify-schemas';
 import { StatefulParameterController } from '../stateful-parameter/stateful-parameter-controller.js';
-import { ArrayParameterSetting, DefaultParameterSetting, ResourceSettings } from './resource-settings.js';
+import { ArrayParameterSetting, DefaultParameterSetting, ParameterSetting, ResourceSettings } from './resource-settings.js';
 export interface ParsedStatefulParameterSetting extends DefaultParameterSetting {
     type: 'stateful';
     controller: StatefulParameterController<any, unknown>;
@@ -30,7 +30,7 @@ export declare class ParsedResourceSettings<T extends StringIndexedObject> imple
     get statefulParameters(): Map<keyof T, StatefulParameterController<T, T[keyof T]>>;
     get parameterSettings(): Record<keyof T, ParsedParameterSetting>;
     get defaultValues(): Partial<Record<keyof T, unknown>>;
-    get inputTransformations(): Partial<Record<keyof T, (a: unknown) => unknown>>;
+    get inputTransformations(): Partial<Record<keyof T, (a: unknown, parameter: ParameterSetting) => unknown>>;
     get statefulParameterOrder(): Map<keyof T, number>;
     private validateSettings;
     private validateParameterEqualsFn;

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

@@ -83,7 +83,7 @@ export class ParsedResourceSettings {
                 return {};
             }
             return Object.fromEntries(Object.entries(this.settings.parameterSettings)
-                .filter(([, v]) => resolveParameterTransformFn(v) !== undefined)
+                .filter(([_, v]) => resolveParameterTransformFn(v) !== undefined)
                 .map(([k, v]) => [k, resolveParameterTransformFn(v)]));
         });
     }

package/dist/resource/resource-controller.js

@@ -230,7 +230,7 @@ ${JSON.stringify(refresh, null, 2)}
             if (config[key] === undefined || !inputTransformation) {
                 continue;
             }
-            config[key] = await inputTransformation(config[key]);
+            config[key] = await inputTransformation(config[key], this.settings.parameterSettings[key]);
         }
         if (this.settings.inputTransformation) {
             const { parameters, coreParameters } = splitUserConfig(config);

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

@@ -216,4 +216,4 @@ export interface StatefulParameterSetting extends DefaultParameterSetting {
 }
 export declare function resolveEqualsFn(parameter: ParameterSetting): (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): ((input: any) => Promise<any> | any) | undefined;
+export declare function resolveParameterTransformFn(parameter: ParameterSetting): ((input: any, parameter: ParameterSetting) => Promise<any> | any) | undefined;

package/dist/resource/resource-settings.js

@@ -35,6 +35,12 @@ export function resolveFnFromEqualsFnOrString(fnOrString) {
 }
 const ParameterTransformationDefaults = {
     'directory': (a) => path.resolve(untildify(String(a))),
+    'stateful': (a, b) => {
+        const sp = b;
+        return (sp.definition?.getSettings()?.inputTransformation)
+            ? (sp.definition.getSettings().inputTransformation(a))
+            : a;
+    },
     'string': String,
 };
 export function resolveParameterTransformFn(parameter) {

package/dist/utils/utils.js

@@ -73,6 +73,9 @@ export function untildify(pathWithTilde) {
     return homeDirectory ? pathWithTilde.replace(/^~(?=$|\/|\\)/, homeDirectory) : pathWithTilde;
 }
 export function areArraysEqual(isElementEqual, desired, current) {
+    if (!desired || !current) {
+        return false;
+    }
     if (!Array.isArray(desired) || !Array.isArray(current)) {
         throw new Error(`A non-array value:
           

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.106",
+  "version": "1.0.107",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

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

@@ -133,7 +133,7 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
     });
   }
 
-  get inputTransformations(): Partial<Record<keyof T, (a: unknown) => unknown>> {
+  get inputTransformations(): Partial<Record<keyof T, (a: unknown, parameter: ParameterSetting) => unknown>> {
     return this.getFromCacheOrCreate('inputTransformations', () => {
       if (!this.settings.parameterSettings) {
         return {};
@@ -141,7 +141,7 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
 
       return Object.fromEntries(
         Object.entries(this.settings.parameterSettings)
-          .filter(([, v]) => resolveParameterTransformFn(v!) !== undefined)
+          .filter(([_, v]) => resolveParameterTransformFn(v!) !== undefined)
           .map(([k, v]) => [k, resolveParameterTransformFn(v!)] as const)
       ) as Record<keyof T, (a: unknown) => unknown>;
     });

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

@@ -401,12 +401,19 @@ describe('Resource tests', () => {
           type: 'version'
         }
       }
+
       override async refresh(desired: any, config: Partial<any>): Promise<any> {
         return null;
       }
-      override async add(valueToAdd: any, plan: Plan<any>): Promise<void> {}
-      override async modify(newValue: any, previousValue: any, plan: Plan<any>): Promise<void> {}
-      override async remove(valueToRemove: any, plan: Plan<any>): Promise<void> {}
+
+      override async add(valueToAdd: any, plan: Plan<any>): Promise<void> {
+      }
+
+      override async modify(newValue: any, previousValue: any, plan: Plan<any>): Promise<void> {
+      }
+
+      override async remove(valueToRemove: any, plan: Plan<any>): Promise<void> {
+      }
     }
 
     const parameter2 = new class extends ArrayStatefulParameter<any, any> {
@@ -420,8 +427,12 @@ describe('Resource tests', () => {
       override async refresh(desired: any[] | null, config: Partial<any>): Promise<any[] | null> {
         return null;
       }
-      override async addItem(item: any, plan: Plan<any>): Promise<void> {}
-      override async removeItem(item: any, plan: Plan<any>): Promise<void> {}
+
+      override async addItem(item: any, plan: Plan<any>): Promise<void> {
+      }
+
+      override async removeItem(item: any, plan: Plan<any>): Promise<void> {
+      }
     }
 
     const p1Spy = spy(parameter1);
@@ -471,8 +482,12 @@ describe('Resource tests', () => {
       async refresh(desired: any[] | null, config: Partial<any>): Promise<any[] | null> {
         return ['20']
       }
-      async addItem(item: any, plan: Plan<any>): Promise<void> {}
-      async removeItem(item: any, plan: Plan<any>): Promise<void> {}
+
+      async addItem(item: any, plan: Plan<any>): Promise<void> {
+      }
+
+      async removeItem(item: any, plan: Plan<any>): Promise<void> {
+      }
     })
 
     const resource = new class extends TestResource {

package/src/resource/resource-controller.ts

@@ -318,7 +318,7 @@ ${JSON.stringify(refresh, null, 2)}
         continue;
       }
 
-      (config as Record<string, unknown>)[key] = await inputTransformation(config[key]);
+      (config as Record<string, unknown>)[key] = await inputTransformation(config[key], this.settings.parameterSettings![key]!);
     }
 
     if (this.settings.inputTransformation) {

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

@@ -818,4 +818,122 @@ describe('Resource parameter tests', () => {
       operation: ResourceOperation.RECREATE,
     })
   });
+
+  it('Transforms input parameters', async () => {
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'resourceType',
+          parameterSettings: {
+            propD: {
+              type: 'array',
+              inputTransformation: (hosts: Record<string, unknown>[]) => hosts.map((h) => Object.fromEntries(
+                  Object.entries(h)
+                    .map(([k, v]) => [
+                      k,
+                      typeof v === 'boolean'
+                        ? (v ? 'yes' : 'no') // The file takes 'yes' or 'no' instead of booleans
+                        : v,
+                    ])
+                )
+              )
+            }
+          }
+        }
+      }
+
+      async refresh(parameters: Partial<TestConfig>): Promise<Partial<TestConfig> | null> {
+        expect(parameters.propD[0].AddKeysToAgent).to.eq('yes')
+        expect(parameters.propD[1].AddKeysToAgent).to.eq('yes')
+        expect(parameters.propD[1].UseKeychain).to.eq('yes')
+        expect(parameters.propD[2].PasswordAuthentication).to.eq('yes')
+
+        return null;
+      }
+    }
+
+    const controller = new ResourceController(resource);
+    await controller.plan({
+      type: 'resourceType',
+      propD: [
+        {
+          Host: 'new.com',
+          AddKeysToAgent: true,
+          IdentityFile: 'id_ed25519'
+        },
+        {
+          Host: 'github.com',
+          AddKeysToAgent: true,
+          UseKeychain: true,
+        },
+        {
+          Match: 'User bob,joe,phil',
+          PasswordAuthentication: true,
+        }
+      ]
+    });
+
+  })
+
+  it('Transforms input parameters for stateful parameters', async () => {
+    const sp = new class extends TestStatefulParameter {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          type: 'array',
+          inputTransformation: (hosts: Record<string, unknown>[]) => hosts.map((h) => Object.fromEntries(
+              Object.entries(h)
+                .map(([k, v]) => [
+                  k,
+                  typeof v === 'boolean'
+                    ? (v ? 'yes' : 'no') // The file takes 'yes' or 'no' instead of booleans
+                    : v,
+                ])
+            )
+          )
+        }
+      }
+
+      async refresh(desired: any): Promise<Partial<TestConfig> | null> {
+        expect(desired[0].AddKeysToAgent).to.eq('yes')
+        expect(desired[1].AddKeysToAgent).to.eq('yes')
+        expect(desired[1].UseKeychain).to.eq('yes')
+        expect(desired[2].PasswordAuthentication).to.eq('yes')
+
+        return null;
+      }
+    }
+
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'resourceType',
+          parameterSettings: {
+            propD: { type: 'stateful', definition: sp }
+          }
+        }
+      }
+    }
+
+    const controller = new ResourceController(resource);
+    await controller.plan({
+      type: 'resourceType',
+      propD: [
+        {
+          Host: 'new.com',
+          AddKeysToAgent: true,
+          IdentityFile: 'id_ed25519'
+        },
+        {
+          Host: 'github.com',
+          AddKeysToAgent: true,
+          UseKeychain: true,
+        },
+        {
+          Match: 'User bob,joe,phil',
+          PasswordAuthentication: true,
+        }
+      ]
+    });
+
+  })
 })

package/src/resource/resource-settings.ts

@@ -303,13 +303,19 @@ export function resolveFnFromEqualsFnOrString(
   return fnOrString as ((a: unknown, b: unknown) => boolean) | undefined;
 }
 
-const ParameterTransformationDefaults: Partial<Record<ParameterSettingType, (input: any) => Promise<any> | any>> = {
+const ParameterTransformationDefaults: Partial<Record<ParameterSettingType, (input: any, parameter: ParameterSetting) => Promise<any> | any>> = {
   'directory': (a: unknown) => path.resolve(untildify(String(a))),
+  'stateful': (a: unknown, b: ParameterSetting) => {
+    const sp = b as StatefulParameterSetting;
+    return (sp.definition?.getSettings()?.inputTransformation)
+      ? (sp.definition.getSettings().inputTransformation!(a))
+      : a;
+  },
   'string': String,
 }
 
 export function resolveParameterTransformFn(
   parameter: ParameterSetting
-): ((input: any) => Promise<any> | any) | undefined {
+): ((input: any, parameter: ParameterSetting) => Promise<any> | any) | undefined {
   return parameter.inputTransformation ?? ParameterTransformationDefaults[parameter.type as ParameterSettingType] ?? undefined;
 }

package/src/utils/utils.ts

@@ -114,6 +114,10 @@ export function areArraysEqual(
   desired: unknown,
   current: unknown
 ): boolean {
+  if (!desired || !current) {
+    return false;
+  }
+
   if (!Array.isArray(desired) || !Array.isArray(current)) {
     throw new Error(`A non-array value: