Updated codify schemas version to the latest. Updated to the latest plan schema.

Author: kevinwang5658

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": {

src/entities/plugin.ts

@@ -1,4 +1,3 @@
-import { Resource } from './resource.js';
 import {
   ApplyRequestData,
   InitializeResponseData,
@@ -8,8 +7,10 @@ import {
   ValidateRequestData,
   ValidateResponseData
 } from 'codify-schemas';
-import { Plan } from './plan.js';
+
 import { splitUserConfig } from '../utils/utils.js';
+import { Plan } from './plan.js';
+import { Resource } from './resource.js';
 
 export class Plugin {
   planStorage: Map<string, Plan<any>>;
@@ -37,8 +38,8 @@ export class Plugin {
     return {
       resourceDefinitions: [...this.resources.values()]
         .map((r) => ({
-          type: r.typeId,
           dependencies: r.dependencies,
+          type: r.typeId,
         }))
     }
   }
@@ -65,19 +66,25 @@ 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();
   }
 
   async apply(data: ApplyRequestData): Promise<void> {
     if (!data.planId && !data.plan) {
-      throw new Error(`For applies either plan or planId must be supplied`);
+      throw new Error('For applies either plan or planId must be supplied');
     }
 
     const plan = this.resolvePlan(data);
@@ -91,7 +98,7 @@ export class Plugin {
   }
 
   private resolvePlan(data: ApplyRequestData): Plan<ResourceConfig> {
-    const { planId, plan: planRequest } = data;
+    const { plan: planRequest, planId } = data;
 
     if (planId) {
       if (!this.planStorage.has(planId)) {
@@ -106,7 +113,7 @@ export class Plugin {
     }
 
     const resource = this.resources.get(planRequest.resourceType)!;
-    return Plan.fromResponse(data.plan, resource.defaultValues);
+    return Plan.fromResponse(planRequest, resource.defaultValues);
   }
 
   protected async crossValidateResources(configs: ResourceConfig[]): Promise<void> {}

src/messages/handlers.ts

@@ -1,4 +1,4 @@
-import { Plugin } from '../entities/plugin.js';
+import Ajv2020, { SchemaObject, ValidateFunction } from 'ajv/dist/2020.js';
 import addFormats from 'ajv-formats';
 import {
   ApplyRequestDataSchema,
@@ -14,32 +14,33 @@ import {
   ValidateRequestDataSchema,
   ValidateResponseDataSchema
 } from 'codify-schemas';
-import Ajv2020, { SchemaObject, ValidateFunction } from 'ajv/dist/2020.js';
+
 import { SudoError } from '../entities/errors.js';
+import { Plugin } from '../entities/plugin.js';
 
-const SupportedRequests: Record<string, { requestValidator: SchemaObject; responseValidator: SchemaObject; handler: (plugin: Plugin, data: any) => Promise<unknown> }> = {
+const SupportedRequests: Record<string, { handler: (plugin: Plugin, data: any) => Promise<unknown>; requestValidator: SchemaObject; responseValidator: SchemaObject }> = {
+  'apply': {
+    async handler(plugin: Plugin, data: any) {
+      await plugin.apply(data);
+      return null;
+    },
+    requestValidator: ApplyRequestDataSchema,
+    responseValidator: ApplyResponseDataSchema
+  },
   'initialize': {
+    handler: async (plugin: Plugin) => plugin.initialize(),
     requestValidator: InitializeRequestDataSchema,
-    responseValidator: InitializeResponseDataSchema,
-    handler: async (plugin: Plugin) => plugin.initialize()
-  },
-  'validate': {
-    requestValidator: ValidateRequestDataSchema,
-    responseValidator: ValidateResponseDataSchema,
-    handler: async (plugin: Plugin, data: any) => plugin.validate(data)
+    responseValidator: InitializeResponseDataSchema
   },
   'plan': {
+    handler: async (plugin: Plugin, data: any) => plugin.plan(data),
     requestValidator: PlanRequestDataSchema,
-    responseValidator: PlanResponseDataSchema,
-    handler: async (plugin: Plugin, data: any) => plugin.plan(data)
+    responseValidator: PlanResponseDataSchema
   },
-  'apply': {
-    requestValidator: ApplyRequestDataSchema,
-    responseValidator: ApplyResponseDataSchema,
-    handler: async (plugin: Plugin, data: any) => {
-      await plugin.apply(data);
-      return null;
-    }
+  'validate': {
+    handler: async (plugin: Plugin, data: any) => plugin.validate(data),
+    requestValidator: ValidateRequestDataSchema,
+    responseValidator: ValidateResponseDataSchema
   }
 }
 
@@ -51,7 +52,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;
@@ -91,12 +92,12 @@ export class MessageHandler {
 
       process.send!({
         cmd: message.cmd + '_Response',
-        status: MessageStatus.SUCCESS,
         data: result,
+        status: MessageStatus.SUCCESS,
       })
 
-    } catch (e: unknown) {
-      this.handleErrors(message, e as Error);
+    } catch (error: unknown) {
+      this.handleErrors(message, error as Error);
     }
   }
 
@@ -119,17 +120,17 @@ export class MessageHandler {
     if (e instanceof SudoError) {
       return process.send?.({
         cmd,
-        status: MessageStatus.ERROR,
         data: `Plugin: '${this.plugin.name}'. Forbidden usage of sudo for command '${e.command}'. Please contact the plugin developer to fix this.`,
+        status: MessageStatus.ERROR,
       })
     }
 
     const isDebug = process.env.DEBUG?.includes('*') ?? false;
 
     process.send?.({
       cmd,
-      status: MessageStatus.ERROR,
       data: isDebug ? e.stack : e.message,
+      status: MessageStatus.ERROR,
     })
   }
 }