codify-plugin-lib 1.0.73 → 1.0.75

package/.eslintignore

@@ -1 +1,2 @@
 /dist
+/node_modules

package/dist/entities/plugin.js

@@ -43,10 +43,11 @@ export class Plugin {
         };
     }
     async plan(data) {
-        if (!this.resources.has(data.type)) {
-            throw new Error(`Resource type not found: ${data.type}`);
+        const type = data.desired?.type ?? data.state?.type;
+        if (!type || !this.resources.has(type)) {
+            throw new Error(`Resource type not found: ${type}`);
         }
-        const plan = await this.resources.get(data.type).plan(data);
+        const plan = await this.resources.get(type).plan(data.desired ?? null, data.state ?? null, data.isStateful);
         this.planStorage.set(plan.id, plan);
         return plan.toResponse();
     }

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

@@ -1,8 +1,8 @@
 export type ErrorMessage = string;
 export interface ResourceParameterOptions {
-    modifyOnChange?: boolean;
-    isEqual?: (desired: any, current: any) => boolean;
     default?: unknown;
+    isEqual?: (desired: any, current: any) => boolean;
+    modifyOnChange?: boolean;
 }
 export interface ResourceDefinition {
     [x: string]: {

package/dist/entities/resource.js

@@ -22,9 +22,9 @@ export class Resource {
         this.options = options;
         if (this.options.schema) {
             this.ajv = new Ajv2020.default({
+                allErrors: true,
                 strict: true,
                 strictRequired: false,
-                allErrors: true,
             });
             this.schemaValidator = this.ajv.compile(this.options.schema);
         }
@@ -43,36 +43,36 @@ export class Resource {
             const isValid = this.schemaValidator(parameters);
             if (!isValid) {
                 return {
-                    resourceType: resourceMetaData.type,
+                    isValid: false,
                     resourceName: resourceMetaData.name,
+                    resourceType: resourceMetaData.type,
                     schemaValidationErrors: this.schemaValidator?.errors ?? [],
-                    isValid: false,
                 };
             }
         }
         let isValid = true;
-        let customValidationErrorMessage = undefined;
+        let customValidationErrorMessage;
         try {
             await this.customValidation(parameters);
         }
-        catch (err) {
+        catch (error) {
             isValid = false;
-            customValidationErrorMessage = err.message;
+            customValidationErrorMessage = error.message;
         }
         if (!isValid) {
             return {
-                resourceType: resourceMetaData.type,
-                resourceName: resourceMetaData.name,
-                schemaValidationErrors: this.schemaValidator?.errors ?? [],
                 customValidationErrorMessage,
                 isValid: false,
+                resourceName: resourceMetaData.name,
+                resourceType: resourceMetaData.type,
+                schemaValidationErrors: this.schemaValidator?.errors ?? [],
             };
         }
         return {
-            resourceType: resourceMetaData.type,
+            isValid: true,
             resourceName: resourceMetaData.name,
+            resourceType: resourceMetaData.type,
             schemaValidationErrors: [],
-            isValid: true,
         };
     }
     async plan(desiredConfig, currentConfig = null, statefulMode = false) {
@@ -86,7 +86,7 @@ export class Resource {
         const parsedConfig = new ConfigParser(desiredConfig, currentConfig, this.statefulParameters, this.transformParameters);
         const { desiredParameters, nonStatefulParameters, resourceMetadata, statefulParameters, } = parsedConfig;
         const currentParameters = await this.refreshNonStatefulParameters(nonStatefulParameters);
-        if (currentParameters == null) {
+        if (currentParameters === null || currentParameters === undefined) {
             return Plan.create(desiredParameters, null, resourceMetadata, planOptions);
         }
         const statefulCurrentParameters = await this.refreshStatefulParameters(statefulParameters, planOptions.statefulMode);

package/dist/messages/handlers.js

@@ -34,7 +34,7 @@ export class MessageHandler {
     requestValidators;
     responseValidators;
     constructor(plugin) {
-        this.ajv = new Ajv2020.default({ strict: true });
+        this.ajv = new Ajv2020.default({ strict: true, strictRequired: false });
         addFormats.default(this.ajv);
         this.ajv.addSchema(ResourceSchema);
         this.plugin = plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.73",
+  "version": "1.0.75",
   "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.42",
+    "codify-schemas": "1.0.44",
     "@npmcli/promise-spawn": "^7.0.1"
   },
   "devDependencies": {

package/src/entities/plugin.ts

@@ -65,11 +65,17 @@ export class Plugin {
   }
 
   async plan(data: PlanRequestData): Promise<PlanResponseData> {
-    if (!this.resources.has(data.type)) {
-      throw new Error(`Resource type not found: ${data.type}`);
+    const type = data.desired?.type ?? data.state?.type
+
+    if (!type || !this.resources.has(type)) {
+      throw new Error(`Resource type not found: ${type}`);
     }
 
-    const plan = await this.resources.get(data.type)!.plan(data);
+    const plan = await this.resources.get(type)!.plan(
+      data.desired ?? null,
+      data.state ?? null,
+      data.isStateful
+    );
     this.planStorage.set(plan.id, plan);
 
     return plan.toResponse();

package/src/entities/resource-types.ts

@@ -5,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 false (re-create).
+   * Default value for the parameter. If a value is not provided in the config, the library will use this value.
    */
-  modifyOnChange?: boolean;
+  default?: unknown;
   /**
    * Customize the equality comparison for a parameter.
    * @param desired
@@ -15,9 +15,9 @@ export interface ResourceParameterOptions {
    */
   isEqual?: (desired: any, current: any) => boolean;
   /**
-   * Default value for the parameter. If a value is not provided in the config, the library will use this value.
+   * Chose if the resource should be re-created or modified if this parameter is changed. Defaults to false (re-create).
    */
-  default?: unknown;
+  modifyOnChange?: boolean;
 }
 
 /**

package/src/entities/resource.ts

@@ -48,9 +48,9 @@ export abstract class Resource<T extends StringIndexedObject> {
 
     if (this.options.schema) {
       this.ajv = new Ajv2020.default({
+        allErrors: true,
         strict: true,
         strictRequired: false,
-        allErrors: true,
       })
       this.schemaValidator = this.ajv.compile(this.options.schema);
     }
@@ -76,38 +76,38 @@ export abstract class Resource<T extends StringIndexedObject> {
 
       if (!isValid) {
         return {
-          resourceType: resourceMetaData.type,
+          isValid: false,
           resourceName: resourceMetaData.name,
+          resourceType: resourceMetaData.type,
           schemaValidationErrors: this.schemaValidator?.errors ?? [],
-          isValid: false,
         }
       }
     }
 
     let isValid = true;
-    let customValidationErrorMessage = undefined;
+    let customValidationErrorMessage;
     try {
       await this.customValidation(parameters);
-    } catch (err) {
+    } catch (error) {
       isValid = false;
-      customValidationErrorMessage = (err as Error).message;
+      customValidationErrorMessage = (error as Error).message;
     }
 
     if (!isValid) {
       return {
-        resourceType: resourceMetaData.type,
-        resourceName: resourceMetaData.name,
-        schemaValidationErrors: this.schemaValidator?.errors ?? [],
         customValidationErrorMessage,
         isValid: false,
+        resourceName: resourceMetaData.name,
+        resourceType: resourceMetaData.type,
+        schemaValidationErrors: this.schemaValidator?.errors ?? [],
       }
     }
 
     return {
-      resourceType: resourceMetaData.type,
+      isValid: true,
       resourceName: resourceMetaData.name,
+      resourceType: resourceMetaData.type,
       schemaValidationErrors: [],
-      isValid: true,
     }
   }
 
@@ -141,7 +141,7 @@ export abstract class Resource<T extends StringIndexedObject> {
     const currentParameters = await this.refreshNonStatefulParameters(nonStatefulParameters);
 
     // Short circuit here. If the resource is non-existent, there's no point checking stateful parameters
-    if (currentParameters == null) {
+    if (currentParameters === null || currentParameters === undefined) {
       return Plan.create(
         desiredParameters,
         null,

package/src/messages/handlers.ts

@@ -51,7 +51,7 @@ export class MessageHandler {
   private responseValidators: Map<string, ValidateFunction>;
 
   constructor(plugin: Plugin) {
-    this.ajv = new Ajv2020.default({ strict: true });
+    this.ajv = new Ajv2020.default({ strict: true, strictRequired: false });
     addFormats.default(this.ajv);
     this.ajv.addSchema(ResourceSchema);
     this.plugin = plugin;