codify-plugin-lib 1.0.134 → 1.0.136

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

@@ -1,7 +1,7 @@
 import { JSONSchemaType } from 'ajv';
 import { StringIndexedObject } from 'codify-schemas';
 import { StatefulParameterController } from '../stateful-parameter/stateful-parameter-controller.js';
-import { ArrayParameterSetting, DefaultParameterSetting, ParameterSetting, ResourceSettings } from './resource-settings.js';
+import { ArrayParameterSetting, DefaultParameterSetting, InputTransformation, ResourceSettings } from './resource-settings.js';
 export interface ParsedStatefulParameterSetting extends DefaultParameterSetting {
     type: 'stateful';
     controller: StatefulParameterController<any, unknown>;
@@ -25,14 +25,14 @@ export declare class ParsedResourceSettings<T extends StringIndexedObject> imple
     } | boolean;
     removeStatefulParametersBeforeDestroy?: boolean | undefined;
     dependencies?: string[] | undefined;
-    inputTransformation?: ((desired: Partial<T>) => unknown) | undefined;
+    transformation?: InputTransformation;
     private settings;
     constructor(settings: ResourceSettings<T>);
     get typeId(): string;
     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, parameter: ParameterSetting) => unknown>>;
+    get inputTransformations(): Partial<Record<keyof T, InputTransformation>>;
     get statefulParameterOrder(): Map<keyof T, number>;
     private validateSettings;
     private validateParameterEqualsFn;

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

@@ -7,7 +7,7 @@ export class ParsedResourceSettings {
     allowMultiple;
     removeStatefulParametersBeforeDestroy;
     dependencies;
-    inputTransformation;
+    transformation;
     settings;
     constructor(settings) {
         this.settings = settings;
@@ -16,7 +16,7 @@ export class ParsedResourceSettings {
         this.allowMultiple = settings.allowMultiple;
         this.removeStatefulParametersBeforeDestroy = settings.removeStatefulParametersBeforeDestroy;
         this.dependencies = settings.dependencies;
-        this.inputTransformation = settings.inputTransformation;
+        this.transformation = settings.transformation;
         this.validateSettings();
     }
     get typeId() {
@@ -83,7 +83,7 @@ export class ParsedResourceSettings {
             }
             return Object.fromEntries(Object.entries(this.settings.parameterSettings)
                 .filter(([_, v]) => resolveParameterTransformFn(v) !== undefined)
-                .map(([k, v]) => [k, resolveParameterTransformFn(v).to]));
+                .map(([k, v]) => [k, resolveParameterTransformFn(v)]));
         });
     }
     get statefulParameterOrder() {

package/dist/resource/resource-controller.js

@@ -174,7 +174,9 @@ export class ResourceController {
                 ?? null;
         }
         const statefulCurrentParameters = await this.refreshStatefulParameters(allStatefulParameters, parametersToRefresh);
-        return [{ core, parameters: { ...currentParametersArray[0], ...statefulCurrentParameters } }];
+        const resultParameters = { ...currentParametersArray[0], ...statefulCurrentParameters };
+        await this.applyTransformParameters(resultParameters, true);
+        return [{ core, parameters: resultParameters }];
     }
     async applyCreate(plan) {
         await this.resource.create(plan);
@@ -236,7 +238,7 @@ ${JSON.stringify(refresh, null, 2)}
 `);
         }
     }
-    async applyTransformParameters(config) {
+    async applyTransformParameters(config, reverse = false) {
         if (!config) {
             return;
         }
@@ -244,10 +246,14 @@ ${JSON.stringify(refresh, null, 2)}
             if (config[key] === undefined || !inputTransformation) {
                 continue;
             }
-            config[key] = await inputTransformation(config[key], this.settings.parameterSettings[key]);
+            config[key] = reverse
+                ? await inputTransformation.from(config[key])
+                : await inputTransformation.to(config[key]);
         }
-        if (this.settings.inputTransformation) {
-            const transformed = await this.settings.inputTransformation({ ...config });
+        if (this.settings.transformation) {
+            const transformed = reverse
+                ? await this.settings.transformation.from({ ...config })
+                : await this.settings.transformation.to({ ...config });
             Object.keys(config).forEach((k) => delete config[k]);
             Object.assign(config, transformed);
         }

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

@@ -66,7 +66,7 @@ export interface ResourceSettings<T extends StringIndexedObject> {
      *
      * @param desired
      */
-    inputTransformation?: (desired: Partial<T>) => Promise<unknown> | unknown;
+    transformation?: InputTransformation;
     /**
      * Customize the import and destory behavior of the resource. By default, <code>codify import</code> and <code>codify destroy</code> will call
      * `refresh()` with every parameter set to null and return the result of the refresh as the imported config. It looks for required parameters
@@ -151,7 +151,7 @@ export interface DefaultParameterSetting {
      *
      * @param input The original parameter value from the desired config.
      */
-    inputTransformation?: InputTransformation;
+    transformation?: InputTransformation;
     /**
      * Customize the equality comparison for a parameter. This is used in the diffing algorithm for generating the plan.
      * This value will override the pre-set equality function from the type. Return true if the desired value is

package/dist/resource/resource-settings.js

@@ -54,17 +54,17 @@ const ParameterTransformationDefaults = {
     }
 };
 export function resolveParameterTransformFn(parameter) {
-    if (parameter.type === 'stateful' && !parameter.inputTransformation) {
+    if (parameter.type === 'stateful' && !parameter.transformation) {
         const sp = parameter.definition.getSettings();
-        if (sp.inputTransformation) {
-            return parameter.definition?.getSettings()?.inputTransformation;
+        if (sp.transformation) {
+            return parameter.definition?.getSettings()?.transformation;
         }
         return sp.type ? ParameterTransformationDefaults[sp.type] : undefined;
     }
     if (parameter.type === 'array'
         && parameter.itemType
         && ParameterTransformationDefaults[parameter.itemType]
-        && !parameter.inputTransformation) {
+        && !parameter.transformation) {
         const itemType = parameter.itemType;
         const itemTransformation = ParameterTransformationDefaults[itemType];
         return {
@@ -76,5 +76,5 @@ export function resolveParameterTransformFn(parameter) {
             }
         };
     }
-    return parameter.inputTransformation ?? ParameterTransformationDefaults[parameter.type] ?? undefined;
+    return parameter.transformation ?? ParameterTransformationDefaults[parameter.type] ?? undefined;
 }

package/package.json

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

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

@@ -5,6 +5,7 @@ import { StatefulParameterController } from '../stateful-parameter/stateful-para
 import {
   ArrayParameterSetting,
   DefaultParameterSetting,
+  InputTransformation,
   ParameterSetting,
   resolveElementEqualsFn,
   resolveEqualsFn,
@@ -43,7 +44,7 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
 
   removeStatefulParametersBeforeDestroy?: boolean | undefined;
   dependencies?: string[] | undefined;
-  inputTransformation?: ((desired: Partial<T>) => unknown) | undefined;
+  transformation?: InputTransformation;
   private settings: ResourceSettings<T>;
 
   constructor(settings: ResourceSettings<T>) {
@@ -53,7 +54,7 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
     this.allowMultiple = settings.allowMultiple;
     this.removeStatefulParametersBeforeDestroy = settings.removeStatefulParametersBeforeDestroy;
     this.dependencies = settings.dependencies;
-    this.inputTransformation = settings.inputTransformation;
+    this.transformation = settings.transformation;
 
     this.validateSettings();
   }
@@ -136,7 +137,7 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
     });
   }
 
-  get inputTransformations(): Partial<Record<keyof T, (a: unknown, parameter: ParameterSetting) => unknown>> {
+  get inputTransformations(): Partial<Record<keyof T, InputTransformation>> {
     return this.getFromCacheOrCreate('inputTransformations', () => {
       if (!this.settings.parameterSettings) {
         return {};
@@ -145,8 +146,8 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
       return Object.fromEntries(
         Object.entries(this.settings.parameterSettings)
           .filter(([_, v]) => resolveParameterTransformFn(v!) !== undefined)
-          .map(([k, v]) => [k, resolveParameterTransformFn(v!)!.to] as const)
-      ) as Record<keyof T, (a: unknown) => unknown>;
+          .map(([k, v]) => [k, resolveParameterTransformFn(v!)] as const)
+      ) as Record<keyof T, InputTransformation>;
     });
   }
 

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

@@ -7,7 +7,7 @@ import { CreatePlan, DestroyPlan, ModifyPlan } from '../plan/plan-types.js';
 import { ParameterChange } from '../plan/change-set.js';
 import { ResourceController } from './resource-controller.js';
 import { TestConfig, testPlan, TestResource, TestStatefulParameter } from '../utils/test-utils.test.js';
-import { untildify } from '../utils/utils.js';
+import { tildify, untildify } from '../utils/utils.js';
 import { ArrayStatefulParameter, StatefulParameter } from '../stateful-parameter/stateful-parameter.js';
 import { Plan } from '../plan/plan.js';
 
@@ -20,9 +20,8 @@ describe('Resource tests', () => {
           id: 'type',
           dependencies: ['homebrew', 'python'],
           parameterSettings: {
-            propA: { canModify: true, inputTransformation: (input) => untildify(input) },
+            propA: { canModify: true, transformation: { to: (input) => untildify(input), from: (input) => tildify(input) } },
           },
-          inputTransformation: (config) => ({ propA: config.propA, propC: config.propB }),
         }
       }
 
@@ -535,4 +534,178 @@ describe('Resource tests', () => {
     expect(parameter1.modify.calledOnce).to.be.true;
     expect(parameter2.addItem.calledOnce).to.be.true;
   });
+
+  it('Applies reverse input transformations for imports', async () => {
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'resourceType',
+          parameterSettings: {
+            propD: {
+              type: 'array',
+              transformation: {
+                to: (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,
+                      ])
+                  )
+                ),
+                from: (hosts: Record<string, unknown>[]) => hosts.map((h) => Object.fromEntries(
+                  Object.entries(h)
+                    .map(([k, v]) => [
+                      k,
+                      v === 'yes' || v === 'no'
+                        ? (v === 'yes')
+                        : v,
+                    ])
+                ))
+              }
+            }
+          }
+        }
+      }
+
+      async refresh(parameters: Partial<TestConfig>): Promise<Partial<TestConfig> | null> {
+        return {
+          propD: [
+            {
+              Host: 'new.com',
+              AddKeysToAgent: true,
+              IdentityFile: 'id_ed25519'
+            },
+            {
+              Host: 'github.com',
+              AddKeysToAgent: true,
+              UseKeychain: true,
+            },
+            {
+              Match: 'User bob,joe,phil',
+              PasswordAuthentication: true,
+            }
+          ],
+        }
+      }
+    }
+
+    const controller = new ResourceController(resource);
+    const plan = await controller.import({ type: 'resourceType' }, {});
+
+    expect(plan![0]).toMatchObject({
+      'core': {
+        'type': 'resourceType'
+      },
+      'parameters': {
+        'propD': [
+          {
+            'Host': 'new.com',
+            'AddKeysToAgent': true,
+            'IdentityFile': 'id_ed25519'
+          },
+          {
+            'Host': 'github.com',
+            'AddKeysToAgent': true,
+            'UseKeychain': true
+          },
+          {
+            'Match': 'User bob,joe,phil',
+            'PasswordAuthentication': true
+          }
+        ]
+      }
+    })
+  })
+
+  it('Applies reverse input transformations for imports (object level)', async () => {
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'resourceType',
+          parameterSettings: {
+            propD: {
+              type: 'array',
+            }
+          },
+          transformation: {
+            to: (input: any) => ({
+              ...input,
+              propD: input.propD?.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,
+                    ])
+                )
+              )
+            }),
+            from: (output: any) => ({
+              ...output,
+              propD: output.propD?.map((h) => Object.fromEntries(
+                Object.entries(h)
+                  .map(([k, v]) => [
+                    k,
+                    v === 'yes' || v === 'no'
+                      ? (v === 'yes')
+                      : v,
+                  ])
+              ))
+            })
+          }
+        }
+      }
+
+      async refresh(parameters: Partial<TestConfig>): Promise<Partial<TestConfig> | null> {
+        return {
+          propD: [
+            {
+              Host: 'new.com',
+              AddKeysToAgent: true,
+              IdentityFile: 'id_ed25519'
+            },
+            {
+              Host: 'github.com',
+              AddKeysToAgent: true,
+              UseKeychain: true,
+            },
+            {
+              Match: 'User bob,joe,phil',
+              PasswordAuthentication: true,
+            }
+          ],
+        }
+      }
+    }
+
+    const controller = new ResourceController(resource);
+    const plan = await controller.import({ type: 'resourceType' }, {});
+
+    expect(plan![0]).toMatchObject({
+      'core': {
+        'type': 'resourceType'
+      },
+      'parameters': {
+        '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-controller.ts

@@ -254,7 +254,10 @@ export class ResourceController<T extends StringIndexedObject> {
     }
 
     const statefulCurrentParameters = await this.refreshStatefulParameters(allStatefulParameters, parametersToRefresh);
-    return [{ core, parameters: { ...currentParametersArray[0], ...statefulCurrentParameters } }];
+    const resultParameters = { ...currentParametersArray[0], ...statefulCurrentParameters };
+
+    await this.applyTransformParameters(resultParameters, true);
+    return [{ core, parameters: resultParameters }];
   }
 
   private async applyCreate(plan: Plan<T>): Promise<void> {
@@ -333,7 +336,7 @@ ${JSON.stringify(refresh, null, 2)}
     }
   }
 
-  private async applyTransformParameters(config: Partial<T> | null): Promise<void> {
+  private async applyTransformParameters(config: Partial<T> | null, reverse = false): Promise<void> {
     if (!config) {
       return;
     }
@@ -343,11 +346,16 @@ ${JSON.stringify(refresh, null, 2)}
         continue;
       }
 
-      (config as Record<string, unknown>)[key] = await inputTransformation(config[key], this.settings.parameterSettings![key]!);
+      (config as Record<string, unknown>)[key] = reverse
+        ? await inputTransformation.from(config[key])
+        : await inputTransformation.to(config[key]);
     }
 
-    if (this.settings.inputTransformation) {
-      const transformed = await this.settings.inputTransformation({ ...config })
+    if (this.settings.transformation) {
+      const transformed = reverse
+        ? await this.settings.transformation.from({ ...config })
+        : await this.settings.transformation.to({ ...config })
+
       Object.keys(config).forEach((k) => delete config[k])
       Object.assign(config, transformed);
     }

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

@@ -569,10 +569,16 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
-          inputTransformation: (desired) => ({
-            propA: 'propA',
-            propB: 10,
-          })
+          transformation: {
+            to: (desired) => ({
+              propA: 'propA',
+              propB: 10,
+            }),
+            from: (current) => ({
+              propA: 'propA',
+              propB: 10,
+            })
+          }
         }
       }
 
@@ -604,10 +610,16 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
-          inputTransformation: (desired) => ({
-            propA: 'propA',
-            propB: 10,
-          })
+          transformation: {
+            to: (desired) => ({
+              propA: 'propA',
+              propB: 10,
+            }),
+            from: (desired) => ({
+              propA: 'propA',
+              propB: 10,
+            })
+          }
         }
       }
 
@@ -852,7 +864,7 @@ describe('Resource parameter tests', () => {
           parameterSettings: {
             propD: {
               type: 'array',
-              inputTransformation: {
+              transformation: {
                 to: (hosts: Record<string, unknown>[]) => hosts.map((h) => Object.fromEntries(
                     Object.entries(h)
                       .map(([k, v]) => [
@@ -918,7 +930,7 @@ describe('Resource parameter tests', () => {
       getSettings(): any {
         return {
           type: 'array',
-          inputTransformation: {
+          transformation: {
             to: (hosts: Record<string, unknown>[]) => hosts.map((h) => Object.fromEntries(
                 Object.entries(h)
                   .map(([k, v]) => [

package/src/resource/resource-settings.ts

@@ -81,7 +81,7 @@ export interface ResourceSettings<T extends StringIndexedObject> {
    *
    * @param desired
    */
-  inputTransformation?: (desired: Partial<T>) => Promise<unknown> | unknown;
+  transformation?: InputTransformation;
 
   /**
    * Customize the import and destory behavior of the resource. By default, <code>codify import</code> and <code>codify destroy</code> will call
@@ -189,7 +189,7 @@ export interface DefaultParameterSetting {
    *
    * @param input The original parameter value from the desired config.
    */
-  inputTransformation?: InputTransformation;
+  transformation?: InputTransformation;
 
   /**
    * Customize the equality comparison for a parameter. This is used in the diffing algorithm for generating the plan.
@@ -354,10 +354,10 @@ export function resolveParameterTransformFn(
   parameter: ParameterSetting
 ): InputTransformation | undefined {
 
-  if (parameter.type === 'stateful' && !parameter.inputTransformation) {
+  if (parameter.type === 'stateful' && !parameter.transformation) {
     const sp = (parameter as StatefulParameterSetting).definition.getSettings();
-    if (sp.inputTransformation) {
-      return (parameter as StatefulParameterSetting).definition?.getSettings()?.inputTransformation
+    if (sp.transformation) {
+      return (parameter as StatefulParameterSetting).definition?.getSettings()?.transformation
     }
 
     return sp.type ? ParameterTransformationDefaults[sp.type] : undefined;
@@ -366,7 +366,7 @@ export function resolveParameterTransformFn(
   if (parameter.type === 'array'
     && (parameter as ArrayParameterSetting).itemType
     && ParameterTransformationDefaults[(parameter as ArrayParameterSetting).itemType!]
-    && !parameter.inputTransformation
+    && !parameter.transformation
   ) {
     const itemType = (parameter as ArrayParameterSetting).itemType!;
     const itemTransformation = ParameterTransformationDefaults[itemType]!;
@@ -381,5 +381,5 @@ export function resolveParameterTransformFn(
     }
   }
 
-  return parameter.inputTransformation ?? ParameterTransformationDefaults[parameter.type as ParameterSettingType] ?? undefined;
+  return parameter.transformation ?? ParameterTransformationDefaults[parameter.type as ParameterSettingType] ?? undefined;
 }