codify-plugin-lib 1.0.75 → 1.0.76

package/dist/entities/plugin.d.ts

@@ -1,6 +1,6 @@
-import { Resource } from './resource.js';
 import { ApplyRequestData, InitializeResponseData, PlanRequestData, PlanResponseData, ResourceConfig, ValidateRequestData, ValidateResponseData } from 'codify-schemas';
 import { Plan } from './plan.js';
+import { Resource } from './resource.js';
 export declare class Plugin {
     name: string;
     resources: Map<string, Resource<ResourceConfig>>;

package/dist/entities/plugin.js

@@ -1,5 +1,5 @@
-import { Plan } from './plan.js';
 import { splitUserConfig } from '../utils/utils.js';
+import { Plan } from './plan.js';
 export class Plugin {
     name;
     resources;
@@ -20,8 +20,8 @@ export class Plugin {
         return {
             resourceDefinitions: [...this.resources.values()]
                 .map((r) => ({
-                type: r.typeId,
                 dependencies: r.dependencies,
+                type: r.typeId,
             }))
         };
     }
@@ -53,7 +53,7 @@ export class Plugin {
     }
     async apply(data) {
         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);
         const resource = this.resources.get(plan.getResourceType());
@@ -63,7 +63,7 @@ export class Plugin {
         await resource.apply(plan);
     }
     resolvePlan(data) {
-        const { planId, plan: planRequest } = data;
+        const { plan: planRequest, planId } = data;
         if (planId) {
             if (!this.planStorage.has(planId)) {
                 throw new Error(`Plan with id: ${planId} was not found`);
@@ -74,7 +74,7 @@ export class Plugin {
             throw new Error('Malformed plan. Resource type must be supplied or resource type was not found');
         }
         const resource = this.resources.get(planRequest.resourceType);
-        return Plan.fromResponse(data.plan, resource.defaultValues);
+        return Plan.fromResponse(planRequest, resource.defaultValues);
     }
     async crossValidateResources(configs) { }
 }

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

@@ -1,22 +1,22 @@
 import { StringIndexedObject } from 'codify-schemas';
+import { ParameterOptions } from './plan-types.js';
+import { ResourceParameterOptions } from './resource-types.js';
 import { StatefulParameter } from './stateful-parameter.js';
 import { TransformParameter } from './transform-parameter.js';
-import { ResourceParameterOptions } from './resource-types.js';
-import { ParameterOptions } from './plan-types.js';
 export interface ResourceOptions<T extends StringIndexedObject> {
-    type: string;
-    schema?: unknown;
     callStatefulParameterRemoveOnDestroy?: boolean;
     dependencies?: string[];
     parameterOptions?: Partial<Record<keyof T, ResourceParameterOptions | ResourceStatefulParameterOptions<T> | ResourceTransformParameterOptions<T>>>;
+    schema?: unknown;
+    type: string;
 }
 export interface ResourceStatefulParameterOptions<T extends StringIndexedObject> {
-    statefulParameter: StatefulParameter<T, T[keyof T]>;
     order?: number;
+    statefulParameter: StatefulParameter<T, T[keyof T]>;
 }
 export interface ResourceTransformParameterOptions<T extends StringIndexedObject> {
-    transformParameter: TransformParameter<T>;
     order?: number;
+    transformParameter: TransformParameter<T>;
 }
 export declare class ResourceOptionsParser<T extends StringIndexedObject> {
     private options;

package/dist/entities/resource-options.js

@@ -27,15 +27,13 @@ export class ResourceOptionsParser {
         const resourceParameters = Object.fromEntries([...this.resourceParameters.entries()]
             .map(([name, value]) => ([name, { ...value, isStatefulParameter: false }])));
         const statefulParameters = [...this.statefulParameters.entries()]
-            ?.reduce((obj, sp) => {
-            return {
-                ...obj,
-                [sp[0]]: {
-                    ...sp[1].options,
-                    isStatefulParameter: true,
-                }
-            };
-        }, {});
+            ?.reduce((obj, sp) => ({
+            ...obj,
+            [sp[0]]: {
+                ...sp[1].options,
+                isStatefulParameter: true,
+            }
+        }), {});
         return {
             ...resourceParameters,
             ...statefulParameters,

package/dist/entities/resource.d.ts

@@ -1,5 +1,4 @@
-import Ajv from 'ajv';
-import { ValidateFunction } from 'ajv/dist/2020.js';
+import { Ajv, ValidateFunction } from 'ajv';
 import { ResourceConfig, StringIndexedObject, ValidateResponseData } from 'codify-schemas';
 import { ParameterChange } from './change-set.js';
 import { Plan } from './plan.js';
@@ -19,7 +18,7 @@ export declare abstract class Resource<T extends StringIndexedObject> {
     readonly parameterOptions: Record<keyof T, ParameterOptions>;
     readonly options: ResourceOptions<T>;
     readonly defaultValues: Partial<Record<keyof T, unknown>>;
-    protected ajv?: Ajv.default;
+    protected ajv?: Ajv;
     protected schemaValidator?: ValidateFunction;
     protected constructor(options: ResourceOptions<T>);
     onInitialize(): Promise<void>;

package/dist/entities/resource.js

@@ -1,4 +1,4 @@
-import Ajv2020 from 'ajv/dist/2020.js';
+import { Ajv } from 'ajv';
 import { ParameterOperation, ResourceOperation, } from 'codify-schemas';
 import { setsEqual, splitUserConfig } from '../utils/utils.js';
 import { Plan } from './plan.js';
@@ -21,7 +21,7 @@ export class Resource {
         this.dependencies = options.dependencies ?? [];
         this.options = options;
         if (this.options.schema) {
-            this.ajv = new Ajv2020.default({
+            this.ajv = new Ajv({
                 allErrors: true,
                 strict: true,
                 strictRequired: false,

package/dist/messages/handlers.js

@@ -1,30 +1,30 @@
+import { Ajv } from 'ajv';
 import addFormats from 'ajv-formats';
 import { ApplyRequestDataSchema, ApplyResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, IpcMessageSchema, MessageStatus, PlanRequestDataSchema, PlanResponseDataSchema, ResourceSchema, ValidateRequestDataSchema, ValidateResponseDataSchema } from 'codify-schemas';
-import Ajv2020 from 'ajv/dist/2020.js';
 import { SudoError } from '../entities/errors.js';
 const SupportedRequests = {
+    'apply': {
+        async handler(plugin, data) {
+            await plugin.apply(data);
+            return null;
+        },
+        requestValidator: ApplyRequestDataSchema,
+        responseValidator: ApplyResponseDataSchema
+    },
     'initialize': {
+        handler: async (plugin) => plugin.initialize(),
         requestValidator: InitializeRequestDataSchema,
-        responseValidator: InitializeResponseDataSchema,
-        handler: async (plugin) => plugin.initialize()
-    },
-    'validate': {
-        requestValidator: ValidateRequestDataSchema,
-        responseValidator: ValidateResponseDataSchema,
-        handler: async (plugin, data) => plugin.validate(data)
+        responseValidator: InitializeResponseDataSchema
     },
     'plan': {
+        handler: async (plugin, data) => plugin.plan(data),
         requestValidator: PlanRequestDataSchema,
-        responseValidator: PlanResponseDataSchema,
-        handler: async (plugin, data) => plugin.plan(data)
+        responseValidator: PlanResponseDataSchema
     },
-    'apply': {
-        requestValidator: ApplyRequestDataSchema,
-        responseValidator: ApplyResponseDataSchema,
-        handler: async (plugin, data) => {
-            await plugin.apply(data);
-            return null;
-        }
+    'validate': {
+        handler: async (plugin, data) => plugin.validate(data),
+        requestValidator: ValidateRequestDataSchema,
+        responseValidator: ValidateResponseDataSchema
     }
 };
 export class MessageHandler {
@@ -34,7 +34,7 @@ export class MessageHandler {
     requestValidators;
     responseValidators;
     constructor(plugin) {
-        this.ajv = new Ajv2020.default({ strict: true, strictRequired: false });
+        this.ajv = new Ajv({ strict: true, strictRequired: false });
         addFormats.default(this.ajv);
         this.ajv.addSchema(ResourceSchema);
         this.plugin = plugin;
@@ -63,12 +63,12 @@ export class MessageHandler {
             }
             process.send({
                 cmd: message.cmd + '_Response',
-                status: MessageStatus.SUCCESS,
                 data: result,
+                status: MessageStatus.SUCCESS,
             });
         }
-        catch (e) {
-            this.handleErrors(message, e);
+        catch (error) {
+            this.handleErrors(message, error);
         }
     }
     validateMessage(message) {
@@ -85,15 +85,15 @@ 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,
         });
     }
 }

package/package.json

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

package/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,
         }))
     }
   }
@@ -83,7 +84,7 @@ export class Plugin {
 
   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);
@@ -97,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)) {
@@ -112,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> {}

package/src/entities/resource-options.ts

@@ -1,21 +1,12 @@
 import { StringIndexedObject } from 'codify-schemas';
+
+import { ParameterOptions } from './plan-types.js';
+import { ResourceParameterOptions } from './resource-types.js';
 import { StatefulParameter } from './stateful-parameter.js';
 import { TransformParameter } from './transform-parameter.js';
-import { ResourceParameterOptions } from './resource-types.js';
-import { ParameterOptions } from './plan-types.js';
 
 export interface ResourceOptions<T extends StringIndexedObject> {
 
-  /**
-   * The id of the resource.
-   */
-  type: string;
-
-  /**
-   * Schema to validate user configs with. Must be in the format JSON Schema 2020-12
-   */
-  schema?: unknown
-
   /**
    * If true, statefulParameter.applyRemove() will be called before resource destruction.
    * Defaults to false.
@@ -36,16 +27,26 @@ export interface ResourceOptions<T extends StringIndexedObject> {
     | ResourceStatefulParameterOptions<T>
     | ResourceTransformParameterOptions<T>
   >>
+
+  /**
+   * Schema to validate user configs with. Must be in the format JSON Schema draft07
+   */
+  schema?: unknown
+
+  /**
+   * The id of the resource.
+   */
+  type: string;
 }
 
 export interface ResourceStatefulParameterOptions<T extends StringIndexedObject> {
-  statefulParameter: StatefulParameter<T, T[keyof T]>;
   order?: number;
+  statefulParameter: StatefulParameter<T, T[keyof T]>;
 }
 
 export interface ResourceTransformParameterOptions<T extends StringIndexedObject> {
-  transformParameter: TransformParameter<T>;
   order?: number;
+  transformParameter: TransformParameter<T>;
 }
 
 export class ResourceOptionsParser<T extends StringIndexedObject> {
@@ -90,15 +91,13 @@ export class ResourceOptionsParser<T extends StringIndexedObject> {
     );
 
     const statefulParameters = [...this.statefulParameters.entries()]
-      ?.reduce((obj, sp) => {
-        return {
+      ?.reduce((obj, sp) => ({
           ...obj,
           [sp[0]]: {
             ...sp[1].options,
             isStatefulParameter: true,
           }
-        }
-      }, {} as Record<keyof T, ParameterOptions>)
+        }), {} as Record<keyof T, ParameterOptions>)
 
     return {
       ...resourceParameters,

package/src/entities/resource.ts

@@ -1,5 +1,4 @@
-import Ajv from 'ajv';
-import Ajv2020, { ValidateFunction } from 'ajv/dist/2020.js';
+import { Ajv, ValidateFunction } from 'ajv';
 import {
   ParameterOperation,
   ResourceConfig,
@@ -38,7 +37,7 @@ export abstract class Resource<T extends StringIndexedObject> {
   readonly options: ResourceOptions<T>;
   readonly defaultValues: Partial<Record<keyof T, unknown>>;
 
-  protected ajv?: Ajv.default;
+  protected ajv?: Ajv;
   protected schemaValidator?: ValidateFunction;
 
   protected constructor(options: ResourceOptions<T>) {
@@ -47,7 +46,7 @@ export abstract class Resource<T extends StringIndexedObject> {
     this.options = options;
 
     if (this.options.schema) {
-      this.ajv = new Ajv2020.default({
+      this.ajv = new Ajv({
         allErrors: true,
         strict: true,
         strictRequired: false,

package/src/messages/handlers.test.ts

@@ -25,10 +25,13 @@ describe('Message handler tests', () => {
       await handler.onMessage({
         cmd: 'plan',
         data: {
-          type: 'resourceType',
-          name: 'name',
-          prop1: 'A',
-          prop2: 'B',
+          desired: {
+            type: 'resourceType',
+            name: 'name',
+            prop1: 'A',
+            prop2: 'B',
+          },
+          isStateful: false,
         }
       })
     } catch (e) {}
@@ -165,7 +168,10 @@ describe('Message handler tests', () => {
     expect(async () => await handler.onMessage({
       cmd: 'plan',
       data: {
-        type: 'resourceA'
+        desired: {
+          type: 'resourceA'
+        },
+        isStateful: false,
       }
     })).rejects.to.not.throw;
 

package/src/messages/handlers.ts

@@ -1,4 +1,4 @@
-import { Plugin } from '../entities/plugin.js';
+import { Ajv, SchemaObject, ValidateFunction } from 'ajv';
 import addFormats from 'ajv-formats';
 import {
   ApplyRequestDataSchema,
@@ -14,44 +14,45 @@ 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
   }
 }
 
 export class MessageHandler {
-  private ajv: Ajv2020.default;
+  private ajv: Ajv;
   private readonly plugin: Plugin;
   private messageSchemaValidator: ValidateFunction;
   private requestValidators: Map<string, ValidateFunction>;
   private responseValidators: Map<string, ValidateFunction>;
 
   constructor(plugin: Plugin) {
-    this.ajv = new Ajv2020.default({ strict: true, strictRequired: false });
+    this.ajv = new Ajv({ 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,8 +120,8 @@ 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,
       })
     }
 
@@ -128,8 +129,8 @@ export class MessageHandler {
 
     process.send?.({
       cmd,
-      status: MessageStatus.ERROR,
       data: isDebug ? e.stack : e.message,
+      status: MessageStatus.ERROR,
     })
   }
 }