codify-plugin-lib 1.0.133 → 1.0.135

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>;
@@ -18,21 +18,20 @@ export type ParsedParameterSetting = {
 export declare class ParsedResourceSettings<T extends StringIndexedObject> implements ResourceSettings<T> {
     private cache;
     id: string;
-    schema?: JSONSchemaType<T | any>;
+    schema?: Partial<JSONSchemaType<T | any>>;
     allowMultiple?: {
         matcher?: (desired: Partial<T>, current: Partial<T>[]) => Partial<T>;
         requiredParameters?: string[];
     } | boolean;
     removeStatefulParametersBeforeDestroy?: boolean | undefined;
     dependencies?: string[] | undefined;
-    inputTransformation?: ((desired: Partial<T>) => unknown) | undefined;
     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,6 @@ export class ParsedResourceSettings {
     allowMultiple;
     removeStatefulParametersBeforeDestroy;
     dependencies;
-    inputTransformation;
     settings;
     constructor(settings) {
         this.settings = settings;
@@ -16,7 +15,6 @@ export class ParsedResourceSettings {
         this.allowMultiple = settings.allowMultiple;
         this.removeStatefulParametersBeforeDestroy = settings.removeStatefulParametersBeforeDestroy;
         this.dependencies = settings.dependencies;
-        this.inputTransformation = settings.inputTransformation;
         this.validateSettings();
     }
     get typeId() {
@@ -83,7 +81,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,12 +246,9 @@ ${JSON.stringify(refresh, null, 2)}
             if (config[key] === undefined || !inputTransformation) {
                 continue;
             }
-            config[key] = await inputTransformation(config[key], this.settings.parameterSettings[key]);
-        }
-        if (this.settings.inputTransformation) {
-            const transformed = await this.settings.inputTransformation({ ...config });
-            Object.keys(config).forEach((k) => delete config[k]);
-            Object.assign(config, transformed);
+            config[key] = reverse
+                ? await inputTransformation.from(config[key])
+                : await inputTransformation.to(config[key]);
         }
     }
     addDefaultValues(config) {

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

@@ -16,7 +16,7 @@ export interface ResourceSettings<T extends StringIndexedObject> {
     /**
      * Schema to validate user configs with. Must be in the format JSON Schema draft07
      */
-    schema?: JSONSchemaType<T | any>;
+    schema?: Partial<JSONSchemaType<T | any>>;
     /**
      * 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
@@ -60,13 +60,6 @@ export interface ResourceSettings<T extends StringIndexedObject> {
      * and applying any input transformations. Use parameter settings to define stateful parameters as well.
      */
     parameterSettings?: Partial<Record<keyof T, ParameterSetting>>;
-    /**
-     * A config level transformation that is only applied to the user supplied desired config. This transformation is allowed
-     * to add, remove or modify keys as well as values. Changing this transformation for existing libraries will mess up existing states.
-     *
-     * @param desired
-     */
-    inputTransformation?: (desired: Partial<T>) => Promise<unknown> | unknown;
     /**
      * 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.133",
+  "version": "1.0.135",
   "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,
@@ -35,7 +36,7 @@ export type ParsedParameterSetting =
 export class ParsedResourceSettings<T extends StringIndexedObject> implements ResourceSettings<T> {
   private cache = new Map<string, unknown>();
   id!: string;
-  schema?: JSONSchemaType<T | any>;
+  schema?: Partial<JSONSchemaType<T | any>>;
   allowMultiple?: {
     matcher?: (desired: Partial<T>, current: Partial<T>[]) => Partial<T>;
     requiredParameters?: string[]
@@ -43,7 +44,6 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
 
   removeStatefulParametersBeforeDestroy?: boolean | undefined;
   dependencies?: string[] | undefined;
-  inputTransformation?: ((desired: Partial<T>) => unknown) | undefined;
   private settings: ResourceSettings<T>;
 
   constructor(settings: ResourceSettings<T>) {
@@ -53,7 +53,6 @@ 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.validateSettings();
   }
@@ -136,7 +135,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 +144,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, inputTransformation: { to: (input) => untildify(input), from: (input) => tildify(input) } },
           },
-          inputTransformation: (config) => ({ propA: config.propA, propC: config.propB }),
         }
       }
 
@@ -535,4 +534,88 @@ 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',
+              inputTransformation: {
+                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
+          }
+        ]
+      }
+    })
+  })
 });

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,13 +346,9 @@ ${JSON.stringify(refresh, null, 2)}
         continue;
       }
 
-      (config as Record<string, unknown>)[key] = await inputTransformation(config[key], this.settings.parameterSettings![key]!);
-    }
-
-    if (this.settings.inputTransformation) {
-      const transformed = await this.settings.inputTransformation({ ...config })
-      Object.keys(config).forEach((k) => delete config[k])
-      Object.assign(config, transformed);
+      (config as Record<string, unknown>)[key] = reverse
+        ? await inputTransformation.from(config[key])
+        : await inputTransformation.to(config[key]);
     }
   }
 

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

@@ -564,74 +564,6 @@ describe('Resource parameter tests', () => {
     expect(timestampC).to.be.lessThan(timestampA as any);
   })
 
-  it('Supports transform parameters', async () => {
-    const resource = spy(new class extends TestResource {
-      getSettings(): ResourceSettings<TestConfig> {
-        return {
-          id: 'resourceType',
-          inputTransformation: (desired) => ({
-            propA: 'propA',
-            propB: 10,
-          })
-        }
-      }
-
-      async refresh(): Promise<Partial<TestConfig> | null> {
-        return {
-          propA: 'propA',
-          propB: 10,
-        }
-      }
-    });
-
-    const controller = new ResourceController(resource);
-    const plan = await controller.plan({ type: 'resourceType' }, { propC: 'abc' } as any, null, false);
-
-    expect(resource.refresh.called).to.be.true;
-    expect(resource.refresh.getCall(0).firstArg['propA']).to.exist;
-    expect(resource.refresh.getCall(0).firstArg['propB']).to.exist;
-    expect(resource.refresh.getCall(0).firstArg['propC']).to.not.exist;
-
-    expect(plan.desiredConfig?.propA).to.eq('propA');
-    expect(plan.desiredConfig?.propB).to.eq(10);
-    expect(plan.desiredConfig?.propC).to.be.undefined;
-
-    expect(plan.changeSet.operation).to.eq(ResourceOperation.NOOP);
-  })
-
-  it('Supports transform parameters for state parameters', async () => {
-    const resource = spy(new class extends TestResource {
-      getSettings(): ResourceSettings<TestConfig> {
-        return {
-          id: 'resourceType',
-          inputTransformation: (desired) => ({
-            propA: 'propA',
-            propB: 10,
-          })
-        }
-      }
-
-      async refresh(): Promise<Partial<TestConfig> | null> {
-        return {
-          propA: 'propA',
-          propB: 10,
-        }
-      }
-    });
-
-    const controller = new ResourceController(resource);
-    const plan = await controller.plan({ type: 'resourceType' }, null, { propC: 'abc' }, true);
-
-    expect(resource.refresh.called).to.be.true;
-    expect(resource.refresh.getCall(0).firstArg['propA']).to.exist;
-    expect(resource.refresh.getCall(0).firstArg['propB']).to.exist;
-    expect(resource.refresh.getCall(0).firstArg['propC']).to.not.exist;
-
-    expect(plan.currentConfig?.propA).to.eq('propA');
-    expect(plan.currentConfig?.propB).to.eq(10);
-    expect(plan.currentConfig?.propC).to.be.undefined;
-  })
-
   it('Allows import required parameters customization', () => {
     const resource = new class extends TestResource {
       getSettings(): ResourceSettings<TestConfig> {

package/src/resource/resource-settings.ts

@@ -24,7 +24,7 @@ export interface ResourceSettings<T extends StringIndexedObject> {
   /**
    * Schema to validate user configs with. Must be in the format JSON Schema draft07
    */
-  schema?: JSONSchemaType<T | any>;
+  schema?: Partial<JSONSchemaType<T | any>>;
 
   /**
    * Allow multiple of the same resource to unique. Set truthy if
@@ -75,14 +75,6 @@ export interface ResourceSettings<T extends StringIndexedObject> {
    */
   parameterSettings?: Partial<Record<keyof T, ParameterSetting>>;
 
-  /**
-   * A config level transformation that is only applied to the user supplied desired config. This transformation is allowed
-   * to add, remove or modify keys as well as values. Changing this transformation for existing libraries will mess up existing states.
-   *
-   * @param desired
-   */
-  inputTransformation?: (desired: Partial<T>) => Promise<unknown> | unknown;
-
   /**
    * 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