codify-schemas 1.0.42 → 1.0.44

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

@@ -2,5 +2,22 @@
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "https://www.codifycli.com/plan-request-data-schema.json",
     "title": "Plan Request Schema Data",
-    "$ref": "resource-schema.json"
+    "type": "object",
+    "properties": {
+        "desired": {
+            "$ref": "resource-schema.json"
+        },
+        "state": {
+            "$ref": "resource-schema.json"
+        },
+        "isStateful": {
+            "type": "boolean",
+            "description": "If the plan is stateful"
+        }
+    },
+    "additionalProperties": false,
+    "anyOf": [
+        { "required": ["desired", "isStateful"] },
+        { "required": ["state", "isStateful"] }
+    ]
 }

package/dist/types/index.d.ts

@@ -37,7 +37,10 @@ export interface ValidateResponseData {
         isValid: boolean;
     }>;
 }
-export interface PlanRequestData extends ResourceConfig {
+export interface PlanRequestData {
+    desired: ResourceConfig | undefined;
+    state: ResourceConfig | undefined;
+    isStateful: boolean;
 }
 export declare enum ResourceOperation {
     CREATE = "create",

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACjB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAwBD,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;IACnB,sCAAiB,CAAA;IACjB,0CAAqB,CAAA;IACrB,kCAAa,CAAA;AACf,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B;AAED,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,iCAAW,CAAA;IACX,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,mCAAa,CAAA;AACf,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAmDD,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,8BAAe,CAAA;AACjB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACjB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AA4BD,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;IACnB,sCAAiB,CAAA;IACjB,0CAAqB,CAAA;IACrB,kCAAa,CAAA;AACf,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B;AAED,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,iCAAW,CAAA;IACX,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,mCAAa,CAAA;AACf,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAmDD,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,8BAAe,CAAA;AACjB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-schemas",
-  "version": "1.0.42",
+  "version": "1.0.44",
   "description": "",
   "type": "module",
   "main": "dist/index.js",

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

@@ -2,5 +2,22 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://www.codifycli.com/plan-request-data-schema.json",
   "title": "Plan Request Schema Data",
-  "$ref": "resource-schema.json"
+  "type": "object",
+  "properties": {
+    "desired": {
+      "$ref": "resource-schema.json"
+    },
+    "state": {
+      "$ref": "resource-schema.json"
+    },
+    "isStateful": {
+      "type": "boolean",
+      "description": "If the plan is stateful"
+    }
+  },
+  "additionalProperties": false,
+  "anyOf": [
+    { "required": ["desired", "isStateful"] },
+    { "required": ["state", "isStateful"] }
+  ]
 }

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

@@ -5,6 +5,7 @@ import Ajv2020 from 'ajv/dist/2020.js'
 
 const ajv = new Ajv2020.default({
   strict: true,
+  strictRequired: false,
 })
 ajv.addSchema(resourceSchema);
 
@@ -13,21 +14,55 @@ describe('Plan request data schema', () => {
     ajv.compile(schema);
   })
 
-  it("requires a type field to be specified", () => {
+  it("It accepts either state, desired or both", () => {
     const validate = ajv.compile(schema);
-    expect(validate({ type: "type" })).to.be.true;
+    expect(validate({
+      desired: {
+        type: "type"
+      },
+      isStateful: false
+    })).to.be.true;
+    expect(validate({
+      state: {
+        type: "type"
+      },
+      isStateful: false
+    })).to.be.true;
+    expect(validate({
+      desired: {
+        type: "type"
+      },
+      state: {
+        type: "type"
+      },
+      isStateful: false
+    })).to.be.true;
     expect(validate({})).to.be.false;
   })
 
   it ("name and type are alpha-numeric and follow variable naming conventions", () => {
     const validate = ajv.compile(schema);
-    expect(validate({ type: "a234abcDEF_-"})).to.be.true;
-    expect(validate({ type: "234"})).to.be.false;
-    expect(validate({ type: "ABCDEF$"})).to.be.false;
+    expect(validate({
+      desired: { type: "a234abcDEF_-" },
+      isStateful: false
+    })).to.be.true;
+    expect(validate({
+      desired: { type: "234" },
+      isStateful: false
+    })).to.be.false;
+    expect(validate({
+      desired: { type: "ABCDEF$" },
+      isStateful: false
+    })).to.be.false;
 
-    expect(validate({ type: "type", name: "a234abcDEF_-"})).to.be.true;
-    expect(validate({ type: "type", name: "234"})).to.be.false;
-    expect(validate({ type: "type", name: "ABCDEF$"})).to.be.false;
+    expect(validate({
+      desired: { type: "type", name: "a234abcDEF_-" },
+      isStateful: false
+    })).to.be.true;
+    expect(validate({
+      desired: { type: "type", name: "ABCDEF$" },
+      isStateful: false
+    })).to.be.false;
   });
 
 })

package/src/types/index.ts

@@ -45,7 +45,11 @@ export interface ValidateResponseData {
   }>;
 }
 
-export interface PlanRequestData extends ResourceConfig {}
+export interface PlanRequestData {
+  desired: ResourceConfig | undefined
+  state: ResourceConfig | undefined
+  isStateful: boolean
+}
 
 export enum ResourceOperation {
   CREATE = "create",