codify-plugin-lib 1.0.56 → 1.0.57

package/dist/entities/plan-types.d.ts

@@ -1,6 +1,5 @@
-import { ResourceOperation } from 'codify-schemas';
 export interface ParameterOptions {
-    planOperation?: ResourceOperation.MODIFY | ResourceOperation.RECREATE;
+    canModify?: boolean;
     isEqual?: (desired: any, current: any) => boolean;
     isElementEqual?: (desired: any, current: any) => boolean;
     default?: unknown;

package/dist/entities/plan.js

@@ -31,8 +31,8 @@ export class Plan {
                 if (statefulParameterNames.has(curr.name)) {
                     newOperation = ResourceOperation.MODIFY;
                 }
-                else if (parameterOptions[curr.name]?.planOperation) {
-                    newOperation = parameterOptions[curr.name].planOperation;
+                else if (parameterOptions[curr.name]?.canModify) {
+                    newOperation = parameterOptions[curr.name].canModify ? ResourceOperation.MODIFY : ResourceOperation.RECREATE;
                 }
                 else {
                     newOperation = ResourceOperation.RECREATE;

package/dist/entities/resource-types.d.ts

@@ -1,7 +1,6 @@
-import { ResourceOperation } from 'codify-schemas';
 export type ErrorMessage = string;
 export interface ResourceParameterOptions {
-    planOperation?: ResourceOperation.MODIFY | ResourceOperation.RECREATE;
+    canModify?: boolean;
     isEqual?: (desired: any, current: any) => boolean;
     default?: unknown;
 }

package/dist/entities/resource.d.ts

@@ -1,4 +1,5 @@
 import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
+import { ParameterChange } from './change-set.js';
 import { Plan } from './plan.js';
 import { StatefulParameter } from './stateful-parameter.js';
 import { ResourceParameterOptions, ValidationResult } from './resource-types.js';
@@ -36,6 +37,6 @@ export declare abstract class Resource<T extends StringIndexedObject> {
     validate(parameters: unknown): Promise<ValidationResult>;
     abstract refresh(keys: Map<keyof T, T[keyof T]>): Promise<Partial<T> | null>;
     abstract applyCreate(plan: Plan<T>): Promise<void>;
-    applyModify(parameterName: keyof T, newValue: unknown, previousValue: unknown, allowDeletes: boolean, plan: Plan<T>): Promise<void>;
+    applyModify(pc: ParameterChange<T>, plan: Plan<T>): Promise<void>;
     abstract applyDestroy(plan: Plan<T>): Promise<void>;
 }

package/dist/entities/resource.js

@@ -103,7 +103,7 @@ export class Resource {
         const statelessParameterChanges = parameterChanges
             .filter((pc) => !this.statefulParameters.has(pc.name));
         for (const pc of statelessParameterChanges) {
-            await this.applyModify(pc.name, pc.newValue, pc.previousValue, false, plan);
+            await this.applyModify(pc, plan);
         }
         const statefulParameterChanges = parameterChanges
             .filter((pc) => this.statefulParameters.has(pc.name))
@@ -210,7 +210,7 @@ Additional: ${[...refreshKeys].filter(k => !desiredKeys.has(k))};`);
         };
     }
     ;
-    async applyModify(parameterName, newValue, previousValue, allowDeletes, plan) { }
+    async applyModify(pc, plan) { }
     ;
 }
 class ConfigParser {

package/package.json

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

package/src/entities/plan-types.ts

@@ -1,13 +1,11 @@
-import { ResourceOperation } from 'codify-schemas';
-
 /**
  * Customize properties for specific parameters. This will alter the way the library process changes to the parameter.
  */
 export interface ParameterOptions {
   /**
-   * Chose if the resource should be re-created or modified if this parameter is changed. Defaults to re-create.
+   * Chose if the resource should be re-created or modified if this parameter is changed. Defaults to false (re-creates resource on change).
    */
-  planOperation?: ResourceOperation.MODIFY | ResourceOperation.RECREATE;
+  canModify?: boolean;
   /**
    * Customize the equality comparison for a parameter.
    * @param a

package/src/entities/plan.ts

@@ -55,8 +55,8 @@ export class Plan<T extends StringIndexedObject> {
           let newOperation: ResourceOperation;
           if (statefulParameterNames.has(curr.name)) {
             newOperation = ResourceOperation.MODIFY // All stateful parameters are modify only
-          } else if (parameterOptions[curr.name]?.planOperation) {
-            newOperation = parameterOptions[curr.name].planOperation!;
+          } else if (parameterOptions[curr.name]?.canModify) {
+            newOperation = parameterOptions[curr.name].canModify ? ResourceOperation.MODIFY : ResourceOperation.RECREATE;
           } else {
             newOperation = ResourceOperation.RECREATE; // Default to Re-create. Should handle the majority of use cases
           }

package/src/entities/resource-parameters.test.ts

@@ -80,7 +80,7 @@ describe('Resource parameter tests', () => {
           type: 'resource',
           parameterOptions: {
             propA: { statefulParameter: statefulParameterSpy },
-            propB: { planOperation: ResourceOperation.MODIFY },
+            propB: { canModify: true },
           }
         });
       }

package/src/entities/resource-types.ts

@@ -1,5 +1,3 @@
-import { ResourceOperation } from 'codify-schemas';
-
 export type ErrorMessage = string;
 
 /**
@@ -7,9 +5,9 @@ export type ErrorMessage = string;
  */
 export interface ResourceParameterOptions {
   /**
-   * Chose if the resource should be re-created or modified if this parameter is changed. Defaults to re-create.
+   * Chose if the resource should be re-created or modified if this parameter is changed. Defaults to false (re-create).
    */
-  planOperation?: ResourceOperation.MODIFY | ResourceOperation.RECREATE;
+  canModify?: boolean;
   /**
    * Customize the equality comparison for a parameter.
    * @param desired
@@ -19,7 +17,7 @@ export interface ResourceParameterOptions {
   /**
    * Default value for the parameter. If a value is not provided in the config, the library will use this value.
    */
-  default?: unknown,
+  default?: unknown;
 }
 
 /**

package/src/entities/resource.test.ts

@@ -195,8 +195,8 @@ describe('Resource tests', () => {
         super({
           type: 'resource',
           parameterOptions: {
-            propA: { planOperation: ResourceOperation.MODIFY },
-            propB: { planOperation: ResourceOperation.MODIFY },
+            propA: { canModify: true },
+            propB: { canModify: true },
           }
         });
       }
@@ -244,7 +244,7 @@ describe('Resource tests', () => {
           type: 'type',
           dependencies: ['homebrew', 'python'],
           parameterOptions: {
-            propA: { planOperation: ResourceOperation.MODIFY },
+            propA: { canModify: true },
             propB: { statefulParameter },
             propC: { isEqual: (a, b) => true },
           }
@@ -281,7 +281,7 @@ describe('Resource tests', () => {
           type: 'type',
           dependencies: ['homebrew', 'python'],
           parameterOptions: {
-            propA: { planOperation: ResourceOperation.MODIFY },
+            propA: { canModify: true },
             propB: { statefulParameter },
             propC: { isEqual: (a, b) => true },
           }

package/src/entities/resource.ts

@@ -161,7 +161,7 @@ export abstract class Resource<T extends StringIndexedObject> {
 
     for (const pc of statelessParameterChanges) {
       // TODO: When stateful mode is added in the future. Dynamically choose if deletes are allowed
-      await this.applyModify(pc.name, pc.newValue, pc.previousValue, false, plan);
+      await this.applyModify(pc, plan);
     }
 
     const statefulParameterChanges = parameterChanges
@@ -310,7 +310,7 @@ Additional: ${[...refreshKeys].filter(k => !desiredKeys.has(k))};`
 
   abstract applyCreate(plan: Plan<T>): Promise<void>;
 
-  async applyModify(parameterName: keyof T, newValue: unknown, previousValue: unknown, allowDeletes: boolean, plan: Plan<T>): Promise<void> {};
+  async applyModify(pc: ParameterChange<T>, plan: Plan<T>): Promise<void> {};
 
   abstract applyDestroy(plan: Plan<T>): Promise<void>;
 }