codify-plugin-lib 1.0.128 → 1.0.129

package/dist/plan/plan.d.ts

@@ -16,8 +16,8 @@ export declare class Plan<T extends StringIndexedObject> {
      * Ex: name, type, dependsOn etc. Metadata parameters
      */
     coreParameters: ResourceConfig;
-    statefulMode: boolean;
-    constructor(id: string, changeSet: ChangeSet<T>, resourceMetadata: ResourceConfig, statefulMode: boolean);
+    isStateful: boolean;
+    constructor(id: string, changeSet: ChangeSet<T>, resourceMetadata: ResourceConfig, isStateful: boolean);
     /**
      * The desired config that a plan will achieve after executing all the actions.
      */
@@ -33,7 +33,7 @@ export declare class Plan<T extends StringIndexedObject> {
         stateParameters: Partial<T> | null;
         coreParameters: ResourceConfig;
         settings: ParsedResourceSettings<T>;
-        statefulMode: boolean;
+        isStateful: boolean;
     }): Plan<T>;
     /**
      * When multiples of the same resource are allowed, this matching function will match a given config with one of the

package/dist/plan/plan.js

@@ -16,12 +16,12 @@ export class Plan {
      * Ex: name, type, dependsOn etc. Metadata parameters
      */
     coreParameters;
-    statefulMode;
-    constructor(id, changeSet, resourceMetadata, statefulMode) {
+    isStateful;
+    constructor(id, changeSet, resourceMetadata, isStateful) {
         this.id = id;
         this.changeSet = changeSet;
         this.coreParameters = resourceMetadata;
-        this.statefulMode = statefulMode;
+        this.isStateful = isStateful;
     }
     /**
      * The desired config that a plan will achieve after executing all the actions.
@@ -53,36 +53,36 @@ export class Plan {
             : this.coreParameters.type;
     }
     static calculate(params) {
-        const { desiredParameters, currentParametersArray, stateParameters, coreParameters, settings, statefulMode } = params;
+        const { desiredParameters, currentParametersArray, stateParameters, coreParameters, settings, isStateful } = params;
         const currentParameters = Plan.matchCurrentParameters({
             desiredParameters,
             currentParametersArray,
             stateParameters,
             settings,
-            statefulMode
+            isStateful
         });
         const filteredCurrentParameters = Plan.filterCurrentParams({
             desiredParameters,
             currentParameters,
             stateParameters,
             settings,
-            statefulMode
+            isStateful
         });
         // Empty
         if (!filteredCurrentParameters && !desiredParameters) {
-            return new Plan(uuidV4(), ChangeSet.empty(), coreParameters, statefulMode);
+            return new Plan(uuidV4(), ChangeSet.empty(), coreParameters, isStateful);
         }
         // CREATE
         if (!filteredCurrentParameters && desiredParameters) {
-            return new Plan(uuidV4(), ChangeSet.create(desiredParameters), coreParameters, statefulMode);
+            return new Plan(uuidV4(), ChangeSet.create(desiredParameters), coreParameters, isStateful);
         }
         // DESTROY
         if (filteredCurrentParameters && !desiredParameters) {
-            return new Plan(uuidV4(), ChangeSet.destroy(filteredCurrentParameters), coreParameters, statefulMode);
+            return new Plan(uuidV4(), ChangeSet.destroy(filteredCurrentParameters), coreParameters, isStateful);
         }
         // NO-OP, MODIFY or RE-CREATE
         const changeSet = ChangeSet.calculateModification(desiredParameters, filteredCurrentParameters, settings.parameterSettings);
-        return new Plan(uuidV4(), changeSet, coreParameters, statefulMode);
+        return new Plan(uuidV4(), changeSet, coreParameters, isStateful);
     }
     /**
      * When multiples of the same resource are allowed, this matching function will match a given config with one of the
@@ -93,14 +93,14 @@ export class Plan {
      * @private
      */
     static matchCurrentParameters(params) {
-        const { desiredParameters, currentParametersArray, stateParameters, settings, statefulMode } = params;
+        const { desiredParameters, currentParametersArray, stateParameters, settings, isStateful } = params;
         if (!settings.allowMultiple) {
             return currentParametersArray?.[0] ?? null;
         }
         if (!currentParametersArray) {
             return null;
         }
-        if (statefulMode) {
+        if (isStateful) {
             return stateParameters
                 ? settings.allowMultiple.matcher(stateParameters, currentParametersArray)
                 : null;
@@ -124,7 +124,7 @@ export class Plan {
         return new Plan(uuidV4(), new ChangeSet(data.operation, data.parameters), {
             type: data.resourceType,
             name: data.resourceName,
-        }, data.statefulMode);
+        }, data.isStateful);
         function addDefaultValues() {
             Object.entries(defaultValues ?? {})
                 .forEach(([key, defaultValue]) => {
@@ -178,7 +178,7 @@ export class Plan {
      *  or wants to set. If a parameter is not specified then it's not managed by Codify.
      */
     static filterCurrentParams(params) {
-        const { desiredParameters: desired, currentParameters: current, stateParameters: state, settings, statefulMode } = params;
+        const { desiredParameters: desired, currentParameters: current, stateParameters: state, settings, isStateful } = params;
         if (!current) {
             return null;
         }
@@ -188,7 +188,7 @@ export class Plan {
         }
         // 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.
-        if (statefulMode) {
+        if (isStateful) {
             return filteredCurrent;
         }
         // TODO: Add object handling here in addition to arrays in the future
@@ -200,7 +200,7 @@ export class Plan {
             if (!current) {
                 return null;
             }
-            if (statefulMode) {
+            if (isStateful) {
                 const keys = new Set([...Object.keys(state ?? {}), ...Object.keys(desired ?? {})]);
                 return Object.fromEntries(Object.entries(current)
                     .filter(([k]) => keys.has(k)));
@@ -276,7 +276,7 @@ export class Plan {
         return {
             planId: this.id,
             operation: this.changeSet.operation,
-            statefulMode: this.statefulMode,
+            isStateful: this.isStateful,
             resourceName: this.coreParameters.name,
             resourceType: this.coreParameters.type,
             parameters: this.changeSet.parameterChanges,

package/dist/plugin/plugin.js

@@ -101,7 +101,7 @@ export class Plugin {
         // Validate using desired/desired. If the apply was successful, no changes should be reported back.
         // Default back desired back to current if it is not defined (for destroys only)
         const validationPlan = await ptyLocalStorage.run(new BackgroundPty(), async () => {
-            const result = await resource.plan(plan.desiredConfig, plan.desiredConfig ?? plan.currentConfig, plan.statefulMode);
+            const result = await resource.plan(plan.desiredConfig, plan.desiredConfig ?? plan.currentConfig, plan.isStateful);
             await getPty().kill();
             return result;
         });

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

@@ -15,7 +15,7 @@ export declare class ResourceController<T extends StringIndexedObject> {
     constructor(resource: Resource<T>);
     initialize(): Promise<void>;
     validate(desiredConfig: Partial<T> & ResourceConfig): Promise<ValidateResponseData['resourceValidations'][0]>;
-    plan(desiredConfig: Partial<T> & ResourceConfig | null, stateConfig?: Partial<T> & ResourceConfig | null, statefulMode?: boolean): Promise<Plan<T>>;
+    plan(desiredConfig: Partial<T> & ResourceConfig | null, stateConfig?: Partial<T> & ResourceConfig | null, isStateful?: boolean): Promise<Plan<T>>;
     apply(plan: Plan<T>): Promise<void>;
     import(config: Partial<T> & ResourceConfig): Promise<(Partial<T> & ResourceConfig)[] | null>;
     private applyCreate;

package/dist/resource/resource-controller.js

@@ -73,8 +73,8 @@ export class ResourceController {
             schemaValidationErrors: [],
         };
     }
-    async plan(desiredConfig, stateConfig = null, statefulMode = false) {
-        this.validatePlanInputs(desiredConfig, stateConfig, statefulMode);
+    async plan(desiredConfig, stateConfig = null, isStateful = false) {
+        this.validatePlanInputs(desiredConfig, stateConfig, isStateful);
         this.addDefaultValues(desiredConfig);
         await this.applyTransformParameters(desiredConfig);
         this.addDefaultValues(stateConfig);
@@ -96,7 +96,7 @@ export class ResourceController {
                 stateParameters,
                 coreParameters,
                 settings: this.parsedSettings,
-                statefulMode,
+                isStateful,
             });
         }
         // Refresh stateful parameters. These parameters have state external to the resource. allowMultiple
@@ -108,7 +108,7 @@ export class ResourceController {
             stateParameters,
             coreParameters,
             settings: this.parsedSettings,
-            statefulMode
+            isStateful
         });
     }
     async apply(plan) {
@@ -272,11 +272,11 @@ ${JSON.stringify(refresh, null, 2)}
         }));
         return result;
     }
-    validatePlanInputs(desired, current, statefulMode) {
+    validatePlanInputs(desired, current, isStateful) {
         if (!desired && !current) {
             throw new Error('Desired config and current config cannot both be missing');
         }
-        if (!statefulMode && !desired) {
+        if (!isStateful && !desired) {
             throw new Error('Desired config must be provided in non-stateful mode');
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.128",
+  "version": "1.0.129",
   "description": "Library plugin library",
   "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.58",
+    "codify-schemas": "1.0.60",
     "@npmcli/promise-spawn": "^7.0.1",
     "@homebridge/node-pty-prebuilt-multiarch": "^0.12.0-beta.5",
     "uuid": "^10.0.0",

package/src/common/errors.test.ts

@@ -12,7 +12,7 @@ describe('Test file for errors file', () => {
         type: 'homebrew',
         name: 'first'
       },
-      statefulMode: true,
+      isStateful: true,
     })
 
     try {

package/src/plan/plan.test.ts

@@ -20,7 +20,7 @@ describe('Plan entity tests', () => {
         previousValue: null,
         newValue: 'propBValue'
       }],
-      statefulMode: false,
+      isStateful: false,
     }, controller.parsedSettings.defaultValues);
 
     expect(plan.currentConfig).to.be.null;
@@ -49,7 +49,7 @@ describe('Plan entity tests', () => {
         previousValue: 'propBValue',
         newValue: null,
       }],
-      statefulMode: false,
+      isStateful: false,
     }, controller.parsedSettings.defaultValues);
 
     expect(plan.currentConfig).toMatchObject({
@@ -78,7 +78,7 @@ describe('Plan entity tests', () => {
         previousValue: 'propBValue',
         newValue: 'propBValue',
       }],
-      statefulMode: false,
+      isStateful: false,
     }, controller.parsedSettings.defaultValues);
 
     expect(plan.currentConfig).toMatchObject({
@@ -116,7 +116,7 @@ describe('Plan entity tests', () => {
         previousValue: null,
         newValue: 'propAValue',
       }],
-      statefulMode: false,
+      isStateful: false,
     }, controller.parsedSettings.defaultValues);
 
     expect(plan.currentConfig).to.be.null
@@ -142,7 +142,7 @@ describe('Plan entity tests', () => {
         name: 'name1'
       },
       settings: new ParsedResourceSettings<TestConfig>({ id: 'type' }),
-      statefulMode: false,
+      isStateful: false,
     });
 
     expect(plan.toResponse()).toMatchObject({

package/src/plan/plan.ts

@@ -34,13 +34,13 @@ export class Plan<T extends StringIndexedObject> {
    */
   coreParameters: ResourceConfig;
 
-  statefulMode: boolean;
+  isStateful: boolean;
 
-  constructor(id: string, changeSet: ChangeSet<T>, resourceMetadata: ResourceConfig, statefulMode: boolean) {
+  constructor(id: string, changeSet: ChangeSet<T>, resourceMetadata: ResourceConfig, isStateful: boolean) {
     this.id = id;
     this.changeSet = changeSet;
     this.coreParameters = resourceMetadata;
-    this.statefulMode = statefulMode;
+    this.isStateful = isStateful;
   }
 
   /**
@@ -83,7 +83,7 @@ export class Plan<T extends StringIndexedObject> {
     stateParameters: Partial<T> | null,
     coreParameters: ResourceConfig,
     settings: ParsedResourceSettings<T>,
-    statefulMode: boolean,
+    isStateful: boolean,
   }): Plan<T> {
     const {
       desiredParameters,
@@ -91,7 +91,7 @@ export class Plan<T extends StringIndexedObject> {
       stateParameters,
       coreParameters,
       settings,
-      statefulMode
+      isStateful
     } = params
 
     const currentParameters = Plan.matchCurrentParameters<T>({
@@ -99,7 +99,7 @@ export class Plan<T extends StringIndexedObject> {
       currentParametersArray,
       stateParameters,
       settings,
-      statefulMode
+      isStateful
     });
 
     const filteredCurrentParameters = Plan.filterCurrentParams<T>({
@@ -107,7 +107,7 @@ export class Plan<T extends StringIndexedObject> {
       currentParameters,
       stateParameters,
       settings,
-      statefulMode
+      isStateful
     });
 
     // Empty
@@ -116,7 +116,7 @@ export class Plan<T extends StringIndexedObject> {
         uuidV4(),
         ChangeSet.empty<T>(),
         coreParameters,
-        statefulMode,
+        isStateful,
       )
     }
 
@@ -126,7 +126,7 @@ export class Plan<T extends StringIndexedObject> {
         uuidV4(),
         ChangeSet.create(desiredParameters),
         coreParameters,
-        statefulMode,
+        isStateful,
       )
     }
 
@@ -136,7 +136,7 @@ export class Plan<T extends StringIndexedObject> {
         uuidV4(),
         ChangeSet.destroy(filteredCurrentParameters),
         coreParameters,
-        statefulMode,
+        isStateful,
       )
     }
 
@@ -151,7 +151,7 @@ export class Plan<T extends StringIndexedObject> {
       uuidV4(),
       changeSet,
       coreParameters,
-      statefulMode,
+      isStateful,
     );
   }
 
@@ -168,14 +168,14 @@ export class Plan<T extends StringIndexedObject> {
     currentParametersArray: Partial<T>[] | null,
     stateParameters: Partial<T> | null,
     settings: ResourceSettings<T>,
-    statefulMode: boolean,
+    isStateful: boolean,
   }): Partial<T> | null {
     const {
       desiredParameters,
       currentParametersArray,
       stateParameters,
       settings,
-      statefulMode
+      isStateful
     } = params;
 
     if (!settings.allowMultiple) {
@@ -186,7 +186,7 @@ export class Plan<T extends StringIndexedObject> {
       return null;
     }
 
-    if (statefulMode) {
+    if (isStateful) {
       return stateParameters
         ? settings.allowMultiple.matcher(stateParameters, currentParametersArray)
         : null
@@ -222,7 +222,7 @@ export class Plan<T extends StringIndexedObject> {
         type: data.resourceType,
         name: data.resourceName,
       },
-      data.statefulMode
+      data.isStateful
     );
 
    function addDefaultValues(): void {
@@ -288,14 +288,14 @@ export class Plan<T extends StringIndexedObject> {
     currentParameters: Partial<T> | null,
     stateParameters: Partial<T> | null,
     settings: ResourceSettings<T>,
-    statefulMode: boolean,
+    isStateful: boolean,
   }): Partial<T> | null {
     const {
       desiredParameters: desired,
       currentParameters: current,
       stateParameters: state,
       settings,
-      statefulMode
+      isStateful
     } = params;
 
     if (!current) {
@@ -309,7 +309,7 @@ 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.
-    if (statefulMode) {
+    if (isStateful) {
       return filteredCurrent;
     }
 
@@ -327,7 +327,7 @@ export class Plan<T extends StringIndexedObject> {
         return null;
       }
 
-      if (statefulMode) {
+      if (isStateful) {
         const keys = new Set([...Object.keys(state ?? {}), ...Object.keys(desired ?? {})]);
         return Object.fromEntries(
           Object.entries(current)
@@ -426,7 +426,7 @@ export class Plan<T extends StringIndexedObject> {
     return {
       planId: this.id,
       operation: this.changeSet.operation,
-      statefulMode: this.statefulMode,
+      isStateful: this.isStateful,
       resourceName: this.coreParameters.name,
       resourceType: this.coreParameters.type,
       parameters: this.changeSet.parameterChanges,

package/src/plugin/plugin.test.ts

@@ -56,7 +56,7 @@ describe('Plugin tests', () => {
       parameters: [
         { name: 'propA', operation: ParameterOperation.ADD, newValue: 'abc', previousValue: null },
       ],
-      statefulMode: false,
+      isStateful: false,
     };
 
     await plugin.apply({ plan });
@@ -77,7 +77,7 @@ describe('Plugin tests', () => {
       parameters: [
         { name: 'propA', operation: ParameterOperation.REMOVE, newValue: null, previousValue: 'abc' },
       ],
-      statefulMode: true,
+      isStateful: true,
     };
 
     await testPlugin.apply({ plan })
@@ -100,7 +100,7 @@ describe('Plugin tests', () => {
       parameters: [
         { name: 'propA', operation: ParameterOperation.MODIFY, newValue: 'def', previousValue: 'abc' },
       ],
-      statefulMode: false,
+      isStateful: false,
     };
 
     await testPlugin.apply({ plan })
@@ -124,7 +124,7 @@ describe('Plugin tests', () => {
       parameters: [
         { name: 'propA', operation: ParameterOperation.MODIFY, newValue: 'def', previousValue: 'abc' },
       ],
-      statefulMode: false,
+      isStateful: false,
     };
 
     await testPlugin.apply({ plan })
@@ -224,7 +224,7 @@ describe('Plugin tests', () => {
       parameters: [
         { name: 'propA', operation: ParameterOperation.MODIFY, newValue: 'def', previousValue: 'abc' },
       ],
-      statefulMode: false,
+      isStateful: false,
     };
 
     await expect(() => testPlugin.apply({ plan }))
@@ -275,7 +275,7 @@ describe('Plugin tests', () => {
       parameters: [
         { name: 'propA', operation: ParameterOperation.ADD, newValue: 'abc', previousValue: null },
       ],
-      statefulMode: false,
+      isStateful: false,
     };
 
     await testPlugin.apply({ plan })

package/src/plugin/plugin.ts

@@ -157,7 +157,7 @@ export class Plugin {
       const result = await resource.plan(
         plan.desiredConfig,
         plan.desiredConfig ?? plan.currentConfig,
-        plan.statefulMode
+        plan.isStateful
       );
 
       await getPty().kill();

package/src/resource/resource-controller.test.ts

@@ -150,7 +150,7 @@ describe('Resource tests', () => {
       testPlan({
         current: [{ propA: 'a', propB: 0 }],
         state: { propA: 'a', propB: 0 },
-        statefulMode: true,
+        isStateful: true,
       })
     )
 
@@ -169,7 +169,7 @@ describe('Resource tests', () => {
       testPlan({
         desired: { propA: 'a', propB: 0 },
         current: [{ propA: 'b', propB: -1 }],
-        statefulMode: true
+        isStateful: true
       })
     );
 

package/src/resource/resource-controller.ts

@@ -106,9 +106,9 @@ export class ResourceController<T extends StringIndexedObject> {
   async plan(
     desiredConfig: Partial<T> & ResourceConfig | null,
     stateConfig: Partial<T> & ResourceConfig | null = null,
-    statefulMode = false,
+    isStateful = false,
   ): Promise<Plan<T>> {
-    this.validatePlanInputs(desiredConfig, stateConfig, statefulMode);
+    this.validatePlanInputs(desiredConfig, stateConfig, isStateful);
 
     this.addDefaultValues(desiredConfig);
     await this.applyTransformParameters(desiredConfig);
@@ -143,7 +143,7 @@ export class ResourceController<T extends StringIndexedObject> {
         stateParameters,
         coreParameters,
         settings: this.parsedSettings,
-        statefulMode,
+        isStateful,
       });
     }
 
@@ -157,7 +157,7 @@ export class ResourceController<T extends StringIndexedObject> {
       stateParameters,
       coreParameters,
       settings: this.parsedSettings,
-      statefulMode
+      isStateful
     })
   }
 
@@ -377,13 +377,13 @@ ${JSON.stringify(refresh, null, 2)}
   private validatePlanInputs(
     desired: Partial<T> & ResourceConfig | null,
     current: Partial<T> & ResourceConfig | null,
-    statefulMode: boolean,
+    isStateful: boolean,
   ) {
     if (!desired && !current) {
       throw new Error('Desired config and current config cannot both be missing')
     }
 
-    if (!statefulMode && !desired) {
+    if (!isStateful && !desired) {
       throw new Error('Desired config must be provided in non-stateful mode')
     }
   }

package/src/resource/resource-settings.test.ts

@@ -500,7 +500,7 @@ describe('Resource parameter tests', () => {
           { name: 'propB', operation: ParameterOperation.ADD, previousValue: null, newValue: null },
           { name: 'propC', operation: ParameterOperation.ADD, previousValue: null, newValue: null },
         ],
-        statefulMode: false,
+        isStateful: false,
       }, {}) as any
     );
 
@@ -523,7 +523,7 @@ describe('Resource parameter tests', () => {
           { name: 'propB', operation: ParameterOperation.MODIFY, previousValue: null, newValue: null },
           { name: 'propC', operation: ParameterOperation.MODIFY, previousValue: null, newValue: null },
         ],
-        statefulMode: false,
+        isStateful: false,
       }, {}) as any
     );
 
@@ -542,7 +542,7 @@ describe('Resource parameter tests', () => {
           { name: 'propB', operation: ParameterOperation.REMOVE, previousValue: null, newValue: null },
           { name: 'propC', operation: ParameterOperation.REMOVE, previousValue: null, newValue: null },
         ],
-        statefulMode: false,
+        isStateful: false,
       }, {}) as any
     );
 

package/src/stateful-parameter/stateful-parameter-controller.test.ts

@@ -34,7 +34,7 @@ describe('Stateful parameter tests', () => {
       desired: null,
       current: [{ propZ: ['a', 'b', 'c'] }],
       state: { propZ: ['a', 'b', 'c'] },
-      statefulMode: true,
+      isStateful: true,
     });
 
     expect(plan.changeSet.operation).to.eq(ResourceOperation.DESTROY);

package/src/utils/test-utils.test.ts

@@ -12,7 +12,7 @@ export function testPlan<T extends StringIndexedObject>(params: {
   state?: Partial<T> | null;
   core?: ResourceConfig;
   settings?: ResourceSettings<T>;
-  statefulMode?: boolean;
+  isStateful?: boolean;
 }) {
   return Plan.calculate({
     desiredParameters: params.desired ?? null,
@@ -22,7 +22,7 @@ export function testPlan<T extends StringIndexedObject>(params: {
     settings: params.settings ?
       new ParsedResourceSettings<T>(params.settings)
       : new ParsedResourceSettings<T>({ id: 'type' }),
-    statefulMode: params.statefulMode ?? false,
+    isStateful: params.isStateful ?? false,
   })
 }