feat: Improved transformations by providing the original back in from, that way the user has the option to return the original if they are the same. Added a custom refreshMapper to apply logic for generating the refresh keys

Author: kevinwang5658

package.json

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

src/resource/resource-controller.ts

@@ -274,29 +274,7 @@ export class ResourceController<T extends StringIndexedObject> {
     await this.applyTransformParameters(parameters);
 
     // Use refresh parameters if specified, otherwise try to refresh as many parameters as possible here
-    const parametersToRefresh = this.settings.importAndDestroy?.refreshKeys
-      ? {
-        ...Object.fromEntries(
-          this.settings.importAndDestroy?.refreshKeys.map((k) => [k, null])
-        ),
-        ...this.settings.importAndDestroy?.defaultRefreshValues,
-        ...parameters,
-        ...(Object.fromEntries( // If a default value was used, but it was also declared in the defaultRefreshValues, prefer the defaultRefreshValue instead
-          Object.entries(parameters).filter(([k, v]) =>
-            this.parsedSettings.defaultValues[k] !== undefined
-            && v === this.parsedSettings.defaultValues[k]
-            && context.originalDesiredConfig?.[k] === undefined
-            && this.settings.importAndDestroy?.defaultRefreshValues?.[k] !== undefined
-          ).map(([k]) => [k, this.settings.importAndDestroy!.defaultRefreshValues![k]])
-        ))
-      }
-      : {
-        ...Object.fromEntries(
-          this.getAllParameterKeys().map((k) => [k, null])
-        ),
-        ...this.settings.importAndDestroy?.defaultRefreshValues,
-        ...parameters,
-      };
+    const parametersToRefresh = this.getParametersToRefreshForImport(parameters, context);
 
     // Parse data from the user supplied config
     const parsedConfig = new ConfigParser(parametersToRefresh, null, this.parsedSettings.statefulParameters)
@@ -320,7 +298,7 @@ export class ResourceController<T extends StringIndexedObject> {
       ?.map((r, idx) => ({ ...r, ...statefulCurrentParameters[idx] }))
 
     for (const result of resultParametersArray) {
-      await this.applyTransformParameters(result, true);
+      await this.applyTransformParameters(result, { original: parameters });
       this.removeDefaultValues(result, parameters);
     }
 
@@ -403,7 +381,7 @@ ${JSON.stringify(refresh, null, 2)}
     }
   }
 
-  private async applyTransformParameters(config: Partial<T> | null, reverse = false): Promise<void> {
+  private async applyTransformParameters(config: Partial<T> | null, reverse?: { original: Partial<T> }): Promise<void> {
     if (!config) {
       return;
     }
@@ -414,13 +392,13 @@ ${JSON.stringify(refresh, null, 2)}
       }
 
       (config as Record<string, unknown>)[key] = reverse
-        ? await inputTransformation.from(config[key])
+        ? await inputTransformation.from(config[key], reverse.original?.[key])
         : await inputTransformation.to(config[key]);
     }
 
     if (this.settings.transformation) {
       const transformed = reverse
-        ? await this.settings.transformation.from({ ...config })
+        ? await this.settings.transformation.from({ ...config }, reverse.original)
         : await this.settings.transformation.to({ ...config })
 
       Object.keys(config).forEach((k) => delete config[k])
@@ -523,5 +501,35 @@ ${JSON.stringify(refresh, null, 2)}
       ? Object.keys((this.settings.schema as any)?.properties)
       : Object.keys(this.parsedSettings.parameterSettings);
   }
+
+  private getParametersToRefreshForImport(parameters: Partial<T>, context: RefreshContext<T>): Partial<T> {
+    if (this.settings.importAndDestroy?.refreshMapper) {
+      return this.settings.importAndDestroy?.refreshMapper(parameters, context);
+    }
+
+    return this.settings.importAndDestroy?.refreshKeys
+      ? {
+        ...Object.fromEntries(
+          this.settings.importAndDestroy?.refreshKeys.map((k) => [k, null])
+        ),
+        ...this.settings.importAndDestroy?.defaultRefreshValues,
+        ...parameters,
+        ...(Object.fromEntries( // If a default value was used, but it was also declared in the defaultRefreshValues, prefer the defaultRefreshValue instead
+          Object.entries(parameters).filter(([k, v]) =>
+            this.parsedSettings.defaultValues[k] !== undefined
+            && v === this.parsedSettings.defaultValues[k]
+            && context.originalDesiredConfig?.[k] === undefined
+            && this.settings.importAndDestroy?.defaultRefreshValues?.[k] !== undefined
+          ).map(([k]) => [k, this.settings.importAndDestroy!.defaultRefreshValues![k]])
+        ))
+      }
+      : {
+        ...Object.fromEntries(
+          this.getAllParameterKeys().map((k) => [k, null])
+        ),
+        ...this.settings.importAndDestroy?.defaultRefreshValues,
+        ...parameters,
+      };
+  }
 }
 

src/resource/resource-settings.ts

@@ -5,10 +5,11 @@ import path from 'node:path';
 
 import { ArrayStatefulParameter, StatefulParameter } from '../stateful-parameter/stateful-parameter.js';
 import { addVariablesToPath, areArraysEqual, resolvePathWithVariables, tildify, untildify } from '../utils/utils.js';
+import { RefreshContext } from './resource.js';
 
 export interface InputTransformation {
   to: (input: any) => Promise<any> | any;
-  from: (current: any) => Promise<any> | any;
+  from: (current: any, original: any) => Promise<any> | any;
 }
 
 /**
@@ -141,6 +142,15 @@ export interface ResourceSettings<T extends StringIndexedObject> {
      * See {@link importAndDestroy} for more information on how importing works.
      */
     defaultRefreshValues?: Partial<T>;
+
+    /**
+     * A custom function that maps the input to what gets passed to refresh for imports. If this is set, then refreshKeys and
+     * defaultRefreshValues are ignored.
+     *
+     * @param input
+     * @param context
+     */
+    refreshMapper?: (input: Partial<T>, context: RefreshContext<T>) => Partial<T>
   }
 }
 
@@ -369,7 +379,13 @@ export function resolveFnFromEqualsFnOrString(
 const ParameterTransformationDefaults: Partial<Record<ParameterSettingType, InputTransformation>> = {
   'directory': {
     to: (a: unknown) => path.resolve(resolvePathWithVariables((untildify(String(a))))),
-    from: (a: unknown) => addVariablesToPath(tildify(String(a))),
+    from: (a: unknown, original) => {
+      if (ParameterEqualsDefaults.directory!(a, original)) {
+        return original;
+      }
+
+      return tildify(addVariablesToPath(String(a)))
+    },
   },
   'string': {
     to: String,
@@ -406,8 +422,8 @@ export function resolveParameterTransformFn(
       to(input: unknown[]) {
         return input.map((i) => itemTransformation.to(i))
       },
-      from(input: unknown[]) {
-        return input.map((i) => itemTransformation.from(i))
+      from(input: unknown[], original) {
+        return input.map((i) => itemTransformation.from(i, original))
       }
     }
   }

src/utils/utils.ts

@@ -46,7 +46,7 @@ export function resolvePathWithVariables(pathWithVariables: string) {
 export function addVariablesToPath(pathWithoutVariables: string) {
   let result = pathWithoutVariables;
   for (const [key, value] of Object.entries(process.env)) {
-    if (!value || !path.isAbsolute(value) || value === '/') {
+    if (!value || !path.isAbsolute(value) || value === '/' || key === 'HOME' || key === 'PATH' || key === 'SHELL' || key === 'PWD') {
       continue;
     }