codify-plugin-lib 1.0.45 → 1.0.47

package/dist/entities/plugin.js

@@ -1,4 +1,5 @@
 import { Plan } from './plan.js';
+import { splitUserConfig } from '../utils/utils.js';
 export class Plugin {
     resources;
     planStorage;
@@ -24,7 +25,8 @@ export class Plugin {
             if (!this.resources.has(config.type)) {
                 throw new Error(`Resource type not found: ${config.type}`);
             }
-            const validateResult = await this.resources.get(config.type).validate(config);
+            const { parameters } = splitUserConfig(config);
+            const validateResult = await this.resources.get(config.type).validate(parameters);
             validationResults.push({
                 ...validateResult,
                 resourceType: config.type,

package/dist/entities/resource.d.ts

@@ -19,8 +19,8 @@ export declare abstract class Resource<T extends StringIndexedObject> {
     private generateParameterConfigurations;
     private validateResourceConfiguration;
     private validateRefreshResults;
-    abstract validate(config: unknown): Promise<ValidationResult>;
-    abstract refresh(keys: Set<keyof T>): Promise<Partial<T> | null>;
+    abstract 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>;
     abstract applyDestroy(plan: Plan<T>): Promise<void>;

package/dist/entities/resource.js

@@ -27,15 +27,15 @@ export class Resource {
         ]);
         const statefulParameters = [...this.statefulParameters.values()]
             .filter((sp) => desiredParameters[sp.name] !== undefined);
-        const keysToRefresh = new Set(Object.keys(resourceParameters));
-        const currentParameters = await this.refresh(keysToRefresh);
+        const entriesToRefresh = new Map(Object.entries(resourceParameters));
+        const currentParameters = await this.refresh(entriesToRefresh);
         if (currentParameters == null) {
             return Plan.create(desiredParameters, null, resourceMetadata, planConfiguration);
         }
-        this.validateRefreshResults(currentParameters, keysToRefresh);
+        this.validateRefreshResults(currentParameters, entriesToRefresh);
         for (const statefulParameter of statefulParameters) {
             const desiredValue = desiredParameters[statefulParameter.name];
-            let currentValue = await statefulParameter.refresh() ?? undefined;
+            let currentValue = await statefulParameter.refresh(desiredValue ?? null) ?? undefined;
             if (Array.isArray(currentValue)
                 && Array.isArray(desiredValue)
                 && !planConfiguration.statefulMode
@@ -150,10 +150,11 @@ export class Resource {
             }
         }
     }
-    validateRefreshResults(refresh, desiredKeys) {
+    validateRefreshResults(refresh, desiredMap) {
         if (!refresh) {
             return;
         }
+        const desiredKeys = new Set(desiredMap.keys());
         const refreshKeys = new Set(Object.keys(refresh));
         if (!setsEqual(desiredKeys, refreshKeys)) {
             throw new Error(`Resource ${this.configuration.type}

package/dist/entities/stateful-parameter.d.ts

@@ -13,7 +13,7 @@ export declare abstract class StatefulParameter<T extends StringIndexedObject, V
     readonly name: keyof T;
     readonly configuration: StatefulParameterConfiguration<T>;
     protected constructor(configuration: StatefulParameterConfiguration<T>);
-    abstract refresh(): Promise<V | null>;
+    abstract refresh(desired: V | null): Promise<V | null>;
     abstract applyAdd(valueToAdd: V, plan: Plan<T>): Promise<void>;
     abstract applyModify(newValue: V, previousValue: V, allowDeletes: boolean, plan: Plan<T>): Promise<void>;
     abstract applyRemove(valueToRemove: V, plan: Plan<T>): Promise<void>;
@@ -24,7 +24,7 @@ export declare abstract class ArrayStatefulParameter<T extends StringIndexedObje
     applyAdd(valuesToAdd: V[], plan: Plan<T>): Promise<void>;
     applyModify(newValues: V[], previousValues: V[], allowDeletes: boolean, plan: Plan<T>): Promise<void>;
     applyRemove(valuesToRemove: V[], plan: Plan<T>): Promise<void>;
-    abstract refresh(): Promise<V[] | null>;
+    abstract refresh(desired: V[] | null): Promise<V[] | null>;
     abstract applyAddItem(item: V, plan: Plan<T>): Promise<void>;
     abstract applyRemoveItem(item: V, plan: Plan<T>): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.45",
+  "version": "1.0.47",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -14,7 +14,7 @@
   "dependencies": {
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
-    "codify-schemas": "1.0.32",
+    "codify-schemas": "1.0.33",
     "@npmcli/promise-spawn": "^7.0.1"
   },
   "devDependencies": {

package/src/entities/plugin.ts

@@ -9,6 +9,7 @@ import {
   ValidateResponseData
 } from 'codify-schemas';
 import { Plan } from './plan.js';
+import { splitUserConfig } from '../utils/utils.js';
 
 export class Plugin {
   planStorage: Map<string, Plan<ResourceConfig>>;
@@ -40,7 +41,8 @@ export class Plugin {
         throw new Error(`Resource type not found: ${config.type}`);
       }
 
-      const validateResult = await this.resources.get(config.type)!.validate(config);
+      const { parameters } = splitUserConfig(config);
+      const validateResult = await this.resources.get(config.type)!.validate(parameters);
 
       validationResults.push({
         ...validateResult,

package/src/entities/resource.ts

@@ -56,22 +56,22 @@ export abstract class Resource<T extends StringIndexedObject> {
 
     // Refresh resource parameters
     // This refreshes the parameters that configure the resource itself
-    const keysToRefresh = new Set(Object.keys(resourceParameters));
-    const currentParameters = await this.refresh(keysToRefresh);
+    const entriesToRefresh = new Map(Object.entries(resourceParameters));
+    const currentParameters = await this.refresh(entriesToRefresh);
 
     // Short circuit here. If resource is non-existent, then there's no point checking stateful parameters
     if (currentParameters == null) {
       return Plan.create(desiredParameters, null, resourceMetadata, planConfiguration);
     }
 
-    this.validateRefreshResults(currentParameters, keysToRefresh);
+    this.validateRefreshResults(currentParameters, entriesToRefresh);
 
     // Refresh stateful parameters
     // This refreshes parameters that are stateful (they can be added, deleted separately from the resource)
     for(const statefulParameter of statefulParameters) {
       const desiredValue = desiredParameters[statefulParameter.name];
 
-      let currentValue = await statefulParameter.refresh() ?? undefined;
+      let currentValue = await statefulParameter.refresh(desiredValue ?? null) ?? undefined;
 
       // In stateless mode, filter the refreshed parameters by the desired to ensure that no deletes happen
       if (Array.isArray(currentValue)
@@ -224,11 +224,12 @@ export abstract class Resource<T extends StringIndexedObject> {
 
   }
 
-  private validateRefreshResults(refresh: Partial<T> | null, desiredKeys: Set<keyof T>) {
+  private validateRefreshResults(refresh: Partial<T> | null, desiredMap: Map<keyof T, T[keyof T]>) {
     if (!refresh) {
       return;
     }
 
+    const desiredKeys = new Set<keyof T>(desiredMap.keys());
     const refreshKeys = new Set(Object.keys(refresh)) as Set<keyof T>;
 
     if (!setsEqual(desiredKeys, refreshKeys)) {
@@ -241,9 +242,9 @@ Additional: ${[...refreshKeys].filter(k => !desiredKeys.has(k))};`
     }
   }
 
-  abstract validate(config: unknown): Promise<ValidationResult>;
+  abstract validate(parameters: unknown): Promise<ValidationResult>;
 
-  abstract refresh(keys: Set<keyof T>): Promise<Partial<T> | null>;
+  abstract refresh(keys: Map<keyof T, T[keyof T]>): Promise<Partial<T> | null>;
 
   abstract applyCreate(plan: Plan<T>): Promise<void>;
 

package/src/entities/stateful-parameter.ts

@@ -32,7 +32,7 @@ export abstract class StatefulParameter<T extends StringIndexedObject, V extends
     this.configuration = configuration
   }
 
-  abstract refresh(): Promise<V | null>;
+  abstract refresh(desired: V | null): Promise<V | null>;
 
   // TODO: Add an additional parameter here for what has actually changed.
   abstract applyAdd(valueToAdd: V, plan: Plan<T>): Promise<void>;
@@ -88,7 +88,7 @@ export abstract class ArrayStatefulParameter<T extends StringIndexedObject, V> e
     }
   }
 
-  abstract refresh(): Promise<V[] | null>;
+  abstract refresh(desired: V[] | null): Promise<V[] | null>;
   abstract applyAddItem(item: V, plan: Plan<T>): Promise<void>;
   abstract applyRemoveItem(item: V, plan: Plan<T>): Promise<void>;
 }