codify-plugin-lib 1.0.66 → 1.0.67

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

@@ -1,3 +1,5 @@
+import { Plan } from './plan.js';
+import { StringIndexedObject } from 'codify-schemas';
 export interface ParameterOptions {
     modifyOnChange?: boolean;
     isEqual?: (desired: any, current: any) => boolean;
@@ -9,3 +11,9 @@ export interface PlanOptions<T> {
     statefulMode: boolean;
     parameterOptions?: Record<keyof T, ParameterOptions>;
 }
+export type WithRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+export type CreatePlan<T extends StringIndexedObject> = WithRequired<Plan<T>, 'desiredConfig'>;
+export type DestroyPlan<T extends StringIndexedObject> = WithRequired<Plan<T>, 'currentConfig'>;
+export type ModifyPlan<T extends StringIndexedObject> = WithRequired<Plan<T>, 'currentConfig' | 'desiredConfig'>;

package/dist/entities/resource.d.ts

@@ -3,7 +3,7 @@ import { ParameterChange } from './change-set.js';
 import { Plan } from './plan.js';
 import { StatefulParameter } from './stateful-parameter.js';
 import { ResourceParameterOptions, ValidationResult } from './resource-types.js';
-import { ParameterOptions } from './plan-types.js';
+import { CreatePlan, DestroyPlan, ModifyPlan, ParameterOptions } from './plan-types.js';
 import { TransformParameter } from './transform-parameter.js';
 import { ResourceOptions } from './resource-options.js';
 import Ajv from 'ajv';
@@ -36,8 +36,8 @@ export declare abstract class Resource<T extends StringIndexedObject> {
     private refreshStatefulParameters;
     private validatePlanInputs;
     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(pc: ParameterChange<T>, plan: Plan<T>): Promise<void>;
-    abstract applyDestroy(plan: Plan<T>): Promise<void>;
+    abstract refresh(values: Map<keyof T, T[keyof T]>): Promise<Partial<T> | null>;
+    abstract applyCreate(plan: CreatePlan<T>): Promise<void>;
+    applyModify(pc: ParameterChange<T>, plan: ModifyPlan<T>): Promise<void>;
+    abstract applyDestroy(plan: DestroyPlan<T>): Promise<void>;
 }

package/package.json

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

package/src/entities/plan-types.ts

@@ -1,3 +1,6 @@
+import { Plan } from './plan.js';
+import { StringIndexedObject } from 'codify-schemas';
+
 /**
  * Customize properties for specific parameters. This will alter the way the library process changes to the parameter.
  */
@@ -24,3 +27,8 @@ export interface PlanOptions<T> {
   statefulMode: boolean;
   parameterOptions?: Record<keyof T, ParameterOptions>;
 }
+
+export type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] }
+export type CreatePlan<T extends StringIndexedObject> = WithRequired<Plan<T>, 'desiredConfig'>
+export type DestroyPlan<T extends StringIndexedObject> = WithRequired<Plan<T>, 'currentConfig'>
+export type ModifyPlan<T extends StringIndexedObject> = WithRequired<Plan<T>, 'currentConfig' | 'desiredConfig'>

package/src/entities/resource.ts

@@ -4,7 +4,7 @@ import { Plan } from './plan.js';
 import { StatefulParameter } from './stateful-parameter.js';
 import { ResourceParameterOptions, ValidationResult } from './resource-types.js';
 import { setsEqual, splitUserConfig } from '../utils/utils.js';
-import { ParameterOptions, PlanOptions } from './plan-types.js';
+import { CreatePlan, DestroyPlan, ModifyPlan, ParameterOptions, PlanOptions } from './plan-types.js';
 import { TransformParameter } from './transform-parameter.js';
 import { ResourceOptions, ResourceOptionsParser } from './resource-options.js';
 import Ajv from 'ajv';
@@ -346,13 +346,13 @@ Additional: ${[...refreshKeys].filter(k => !desiredKeys.has(k))};`
     }
   };
 
-  abstract refresh(keys: Map<keyof T, T[keyof T]>): Promise<Partial<T> | null>;
+  abstract refresh(values: Map<keyof T, T[keyof T]>): Promise<Partial<T> | null>;
 
-  abstract applyCreate(plan: Plan<T>): Promise<void>;
+  abstract applyCreate(plan: CreatePlan<T>): Promise<void>;
 
-  async applyModify(pc: ParameterChange<T>, plan: Plan<T>): Promise<void> {};
+  async applyModify(pc: ParameterChange<T>, plan: ModifyPlan<T>): Promise<void> {};
 
-  abstract applyDestroy(plan: Plan<T>): Promise<void>;
+  abstract applyDestroy(plan: DestroyPlan<T>): Promise<void>;
 }
 
 class ConfigParser<T extends StringIndexedObject> {