codify-schemas 1.0.28 → 1.0.29

package/dist/messages/apply-request-data-schema.json

@@ -6,11 +6,66 @@
     "type": "object",
     "properties": {
         "planId": {
-            "description": "The plan uuid. This id is used to look up the generated plan on the plugin side",
+            "description": "The plan uuid. This id is used to look up the generated plan on the plugin side.",
             "type": "string",
             "format": "uuid"
+        },
+        "plan": {
+            "description": "Alternatively, the client can supply a complete plan instead of a planId",
+            "type": "object",
+            "properties": {
+                "operation": {
+                    "description": "The plan operation",
+                    "type": "string",
+                    "enum": ["create", "destroy", "modify", "recreate", "noop"]
+                },
+                "resourceType": {
+                    "description": "The resource type",
+                    "type": "string"
+                },
+                "resourceName": {
+                    "description": "The resource name",
+                    "type": ["string", "null"]
+                },
+                "parameters": {
+                    "description": "The properties come from the provided config and is not necessarily every parameter on the ",
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "description": "The property name",
+                                "type": "string"
+                            },
+                            "operation": {
+                                "description": "The operation to be performed on the parameter",
+                                "type": "string",
+                                "enum": [
+                                    "remove",
+                                    "add",
+                                    "modify",
+                                    "noop"
+                                ]
+                            },
+                            "previousValue": {
+                                "description": "The value before the change"
+                            },
+                            "newValue": {
+                                "description": "The new value"
+                            }
+                        },
+                        "required": [
+                            "name",
+                            "operation",
+                            "previousValue",
+                            "newValue"
+                        ]
+                    }
+                }
+            },
+            "required": ["operation", "resourceType", "parameters"]
         }
     },
-    "required": ["planId"],
+    "required": [],
     "additionalProperties": false
 }

package/dist/types/index.d.ts

@@ -54,7 +54,18 @@ export interface PlanResponseData {
     }>;
 }
 export interface ApplyRequestData {
-    planId: string;
+    planId?: string;
+    plan?: {
+        operation: ResourceOperation;
+        resourceName?: string;
+        resourceType: string;
+        parameters: Array<{
+            name: string;
+            operation: ParameterOperation;
+            previousValue: unknown | null;
+            newValue: unknown | null;
+        }>;
+    };
 }
 export interface ResourceDefinition {
     type: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-schemas",
-  "version": "1.0.28",
+  "version": "1.0.29",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -17,6 +17,7 @@
   },
   "devDependencies": {
     "vitest": "^1.4.0",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "ajv-formats": "^3.0.1"
   }
 }

package/src/messages/apply-request-data-schema.json

@@ -6,11 +6,66 @@
   "type": "object",
   "properties": {
     "planId": {
-      "description": "The plan uuid. This id is used to look up the generated plan on the plugin side",
+      "description": "The plan uuid. This id is used to look up the generated plan on the plugin side.",
       "type": "string",
       "format": "uuid"
+    },
+    "plan": {
+      "description": "Alternatively, the client can supply a complete plan instead of a planId",
+      "type": "object",
+      "properties": {
+        "operation": {
+          "description": "The plan operation",
+          "type": "string",
+          "enum" : ["create", "destroy", "modify", "recreate", "noop"]
+        },
+        "resourceType": {
+          "description": "The resource type",
+          "type": "string"
+        },
+        "resourceName": {
+          "description": "The resource name",
+          "type": ["string", "null"]
+        },
+        "parameters": {
+          "description": "The properties come from the provided config and is not necessarily every parameter on the ",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "description": "The property name",
+                "type": "string"
+              },
+              "operation": {
+                "description": "The operation to be performed on the parameter",
+                "type": "string",
+                "enum": [
+                  "remove",
+                  "add",
+                  "modify",
+                  "noop"
+                ]
+              },
+              "previousValue": {
+                "description": "The value before the change"
+              },
+              "newValue": {
+                "description": "The new value"
+              }
+            },
+            "required": [
+              "name",
+              "operation",
+              "previousValue",
+              "newValue"
+            ]
+          }
+        }
+      },
+      "required": ["operation", "resourceType", "parameters"]
     }
   },
-  "required": ["planId"],
+  "required": [],
   "additionalProperties": false
 }

package/src/messages/apply-request-data-schema.test.ts

@@ -0,0 +1,41 @@
+import schema from './apply-request-data-schema.json';
+import resourceSchema from '../resource-schema.json'
+import {describe, expect, it} from 'vitest'
+import Ajv2020 from 'ajv/dist/2020.js'
+import addFormats from 'ajv-formats';
+import {ApplyRequestData, ParameterOperation, ResourceOperation} from "../types/index.js";
+
+const ajv = new Ajv2020.default({
+  strict: true,
+})
+addFormats.default(ajv);
+ajv.addSchema(resourceSchema);
+
+describe('Apply request data schema', () => {
+  it('compiles', () => {
+    ajv.compile(schema);
+  })
+
+  it("validates correct config (planId)", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      planId: 'eb367e53-21a8-4c9e-a38b-c99e7c821344',
+    } as ApplyRequestData)).to.be.true;
+  })
+
+  it("validates correct config (plan)", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      plan: {
+        operation: ResourceOperation.CREATE,
+        resourceType: 'type1',
+        parameters: [{
+          name: 'parameter1',
+          operation: ParameterOperation.ADD,
+          previousValue: null,
+          newValue: 'abc'
+        }]
+      }
+    } as ApplyRequestData)).to.be.true;
+  })
+})

package/src/messages/plan-response-data-schema.test.ts

@@ -0,0 +1,42 @@
+import schema from './plan-response-data-schema.json';
+import resourceSchema from '../resource-schema.json'
+import {describe, expect, it} from 'vitest'
+import Ajv2020 from 'ajv/dist/2020.js'
+import addFormats from 'ajv-formats';
+import {ParameterOperation, PlanResponseData, ResourceOperation} from "../types/index.js";
+
+const ajv = new Ajv2020.default({
+  strict: true,
+})
+addFormats.default(ajv);
+ajv.addSchema(resourceSchema);
+
+describe('Plan response data schema', () => {
+  it('compiles', () => {
+    ajv.compile(schema);
+  })
+
+  it("validates correct config", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      planId: 'eb367e53-21a8-4c9e-a38b-c99e7c821344',
+      operation: ResourceOperation.CREATE,
+      resourceType: 'type1',
+      parameters: [{
+        name: 'parameter1',
+        operation: ParameterOperation.ADD,
+        previousValue: null,
+        newValue: 'abc'
+      }]
+    } as PlanResponseData)).to.be.true;
+  })
+
+  it ("validates incorrect config", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      planId: 'eb367e53-21a8-4c9e-a38b-c99e7c821344',
+      parameters: []
+    })).to.be.false;
+  });
+
+})

package/src/types/index.ts

@@ -64,7 +64,18 @@ export interface PlanResponseData {
 }
 
 export interface ApplyRequestData {
-  planId: string;
+  planId?: string;
+  plan?: {
+    operation: ResourceOperation;
+    resourceName?: string;
+    resourceType: string;
+    parameters: Array<{
+      name: string;
+      operation: ParameterOperation;
+      previousValue: unknown | null;
+      newValue: unknown | null;
+    }>
+  }
 }
 
 export interface ResourceDefinition {