codify-plugin-lib 1.0.157 → 1.0.159

package/dist/plan/plan.js

@@ -189,8 +189,8 @@ export class Plan {
             return null;
         }
         // For stateful mode, we're done after filtering by the keys of desired + state. Stateless mode
-        // requires additional filtering for stateful parameter arrays and objects. Use this for stateful destroys as well.
-        if (isStateful && desired !== null) {
+        // requires additional filtering for stateful parameter arrays and objects.
+        if (isStateful) {
             return filteredCurrent;
         }
         // TODO: Add object handling here in addition to arrays in the future

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

@@ -32,4 +32,5 @@ export declare class ResourceController<T extends StringIndexedObject> {
     private validatePlanInputs;
     private getSortedStatefulParameterChanges;
     private getAllParameterKeys;
+    private getParametersToRefreshForImport;
 }

package/dist/resource/resource-controller.js

@@ -193,22 +193,7 @@ export class ResourceController {
         this.addDefaultValues(parameters);
         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);
         const { allParameters, allNonStatefulParameters, allStatefulParameters, } = parsedConfig;
@@ -222,7 +207,7 @@ export class ResourceController {
         const resultParametersArray = currentParametersArray
             ?.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);
         }
         return resultParametersArray?.map((r) => ({ core, parameters: r }));
@@ -287,7 +272,7 @@ ${JSON.stringify(refresh, null, 2)}
 `);
         }
     }
-    async applyTransformParameters(config, reverse = false) {
+    async applyTransformParameters(config, reverse) {
         if (!config) {
             return;
         }
@@ -296,12 +281,12 @@ ${JSON.stringify(refresh, null, 2)}
                 continue;
             }
             config[key] = reverse
-                ? await inputTransformation.from(config[key])
+                ? await inputTransformation.from(config[key], reverse.original)
                 : 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]);
             Object.assign(config, transformed);
@@ -373,4 +358,25 @@ ${JSON.stringify(refresh, null, 2)}
             ? Object.keys(this.settings.schema?.properties)
             : Object.keys(this.parsedSettings.parameterSettings);
     }
+    getParametersToRefreshForImport(parameters, context) {
+        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,
+            };
+    }
 }

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

@@ -1,9 +1,10 @@
 import { JSONSchemaType } from 'ajv';
 import { StringIndexedObject } from 'codify-schemas';
 import { ArrayStatefulParameter, StatefulParameter } from '../stateful-parameter/stateful-parameter.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;
 }
 /**
  * The configuration and settings for a resource.
@@ -122,6 +123,14 @@ 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>;
     };
 }
 /**

package/dist/resource/resource-settings.js

@@ -1,6 +1,6 @@
 import isObjectsEqual from 'lodash.isequal';
 import path from 'node:path';
-import { addVariablesToPath, areArraysEqual, resolvePathWithVariables, tildify, untildify } from '../utils/utils.js';
+import { addVariablesToPath, areArraysEqual, resolvePathWithVariables, untildify } from '../utils/utils.js';
 const ParameterEqualsDefaults = {
     'boolean': (a, b) => Boolean(a) === Boolean(b),
     'directory': (a, b) => {
@@ -54,7 +54,12 @@ export function resolveFnFromEqualsFnOrString(fnOrString) {
 const ParameterTransformationDefaults = {
     'directory': {
         to: (a) => path.resolve(resolvePathWithVariables((untildify(String(a))))),
-        from: (a) => addVariablesToPath(tildify(String(a))),
+        from: (a, original) => {
+            if (ParameterEqualsDefaults.directory(a, original)) {
+                return original;
+            }
+            return addVariablesToPath(String(a));
+        },
     },
     'string': {
         to: String,
@@ -83,8 +88,8 @@ export function resolveParameterTransformFn(parameter) {
             to(input) {
                 return input.map((i) => itemTransformation.to(i));
             },
-            from(input) {
-                return input.map((i) => itemTransformation.from(i));
+            from(input, original) {
+                return input.map((i) => itemTransformation.from(i, original));
             }
         };
     }

package/package.json

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

package/src/plan/plan.ts

@@ -312,8 +312,8 @@ export class Plan<T extends StringIndexedObject> {
     }
 
     // For stateful mode, we're done after filtering by the keys of desired + state. Stateless mode
-    // requires additional filtering for stateful parameter arrays and objects. Use this for stateful destroys as well.
-    if (isStateful && desired !== null) {
+    // requires additional filtering for stateful parameter arrays and objects.
+    if (isStateful) {
       return filteredCurrent;
     }
 

package/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,11 +298,13 @@ 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);
     }
 
     return resultParametersArray?.map((r) => ({ core, parameters: r }))
+
+
   }
 
   private async applyCreate(plan: Plan<T>): Promise<void> {
@@ -403,7 +383,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 +394,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)
         : 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 +503,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,
+      };
+  }
 }
 

package/src/resource/resource-settings.ts

@@ -5,10 +5,12 @@ 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 { or } from 'ajv/dist/compile/codegen/index.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 +143,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 +380,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 addVariablesToPath(String(a))
+    },
   },
   'string': {
     to: String,
@@ -406,8 +423,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))
       }
     }
   }