@platecms/delta-validation 0.13.0 → 1.3.0

package/src/lib/validation-rules/value-type.validation-rule.spec.ts

@@ -1,108 +1,138 @@
 import { PRN } from "@platecms/delta-plate-resource-notation";
-import { ContentValueType, ContentValueTypeNames } from "@platecms/delta-types";
+import { ContentValueType, ContentValueTypeName, ContentValueTypeNames } from "@platecms/delta-types";
+import { ValidationRuleUpdateImpact } from "../enums/validation-rule-update-impact.enum";
 import { ValueTypeValidationRule, ValueTypeValidationRuleSettings } from "./value-type.validation-rule";
 
 describe("ValueTypeValidationRule", () => {
-  const rulePrn = PRN.fromString("prn:plate:-1:cxc:validation-rule:value-type");
+  const rulePrn = PRN.fromString("prn:plate:-1:cms:validation-rule:value-type");
 
-  describe.each([
-    [
-      "with allowed string type",
-      { allowedTypes: [ContentValueTypeNames.STRING] },
+  describe("validate", () => {
+    describe.each([
       [
-        ["foo", true],
-        [123, false],
+        "with allowed string type",
+        { allowedTypes: [ContentValueTypeNames.STRING] },
+        [
+          ["foo", true],
+          [123, false],
+        ],
       ],
-    ],
-    [
-      "with allowed number type",
-      { allowedTypes: [ContentValueTypeNames.NUMBER] },
       [
-        [123, true],
-        ["foo", false],
+        "with allowed number type",
+        { allowedTypes: [ContentValueTypeNames.NUMBER] },
+        [
+          [123, true],
+          ["foo", false],
+        ],
       ],
-    ],
-    [
-      "with allowed boolean type",
-      { allowedTypes: [ContentValueTypeNames.BOOLEAN] },
       [
-        [true, true],
-        ["foo", false],
+        "with allowed boolean type",
+        { allowedTypes: [ContentValueTypeNames.BOOLEAN] },
+        [
+          [true, true],
+          ["foo", false],
+        ],
       ],
-    ],
-    [
-      "with allowed date type",
-      { allowedTypes: [ContentValueTypeNames.DATE] },
       [
-        [new Date(), true],
-        ["foo", false],
+        "with allowed date type",
+        { allowedTypes: [ContentValueTypeNames.DATE] },
+        [
+          [new Date(), true],
+          ["foo", false],
+        ],
       ],
-    ],
-    [
-      "with allowed content item type",
-      { allowedTypes: [ContentValueTypeNames.CONTENT_ITEM] },
       [
-        [PRN.fromString("prn:plate:-1:cxc:content-item:1"), true],
-        ["foo", false],
+        "with allowed content item type",
+        { allowedTypes: [ContentValueTypeNames.CONTENT_ITEM] },
+        [
+          [PRN.fromString("prn:plate:-1:cms:content-item:1"), true],
+          ["foo", false],
+        ],
       ],
-    ],
-    [
-      "with allowed asset type",
-      { allowedTypes: [ContentValueTypeNames.ASSET] },
       [
-        [PRN.fromString("prn:plate:-1:am:asset:1"), true],
-        ["foo", false],
+        "with allowed asset type",
+        { allowedTypes: [ContentValueTypeNames.ASSET] },
+        [
+          [PRN.fromString("prn:plate:-1:ps:asset:1"), true],
+          ["foo", false],
+        ],
       ],
-    ],
-    [
-      "with allowed path part type",
-      { allowedTypes: [ContentValueTypeNames.PATH_PART] },
       [
-        [PRN.fromString("prn:plate:-1:cxc:path-part:1"), true],
-        ["foo", false],
+        "with allowed path part type",
+        { allowedTypes: [ContentValueTypeNames.PATH_PART] },
+        [
+          [PRN.fromString("prn:plate:-1:cms:path-part:1"), true],
+          ["foo", false],
+        ],
       ],
-    ],
-    [
-      "with allowed grid placement type",
-      { allowedTypes: [ContentValueTypeNames.GRID_PLACEMENT] },
       [
-        [PRN.fromString("prn:plate:-1:cxc:grid-placement:1"), true],
-        ["foo", false],
+        "with allowed grid placement type",
+        { allowedTypes: [ContentValueTypeNames.GRID_PLACEMENT] },
+        [
+          [PRN.fromString("prn:plate:-1:cms:grid-placement:1"), true],
+          ["foo", false],
+        ],
       ],
-    ],
-    [
-      "with allowed smart text type",
-      { allowedTypes: [ContentValueTypeNames.SMART_TEXT] },
       [
-        [{ type: "root", children: [] }, true],
-        [PRN.fromString("prn:plate:-1:cxc:grid-placement:1"), false],
+        "with allowed smart text type",
+        { allowedTypes: [ContentValueTypeNames.SMART_TEXT] },
+        [
+          [{ type: "root", children: [] }, true],
+          [PRN.fromString("prn:plate:-1:cms:grid-placement:1"), false],
+        ],
       ],
-    ],
-    [
-      "with incorrect prn",
-      { allowedTypes: [ContentValueTypeNames.CONTENT_ITEM] },
-      [[PRN.fromString("prn:plate:-1:am:asset:1"), false]],
-    ],
-    [
-      "with multiple types",
-      {
-        allowedTypes: [ContentValueTypeNames.STRING, ContentValueTypeNames.CONTENT_ITEM],
-      },
       [
-        ["foo", true],
-        [PRN.fromString("prn:plate:-1:cxc:content-item:1"), true],
-        [new Date(), false],
+        "with incorrect prn",
+        { allowedTypes: [ContentValueTypeNames.CONTENT_ITEM] },
+        [[PRN.fromString("prn:plate:-1:ps:asset:1"), false]],
       ],
-    ],
-  ])("%s", (_, ruleConfig, testCases: unknown[]) => {
+      [
+        "with multiple types",
+        {
+          allowedTypes: [ContentValueTypeNames.STRING, ContentValueTypeNames.CONTENT_ITEM],
+        },
+        [
+          ["foo", true],
+          [PRN.fromString("prn:plate:-1:cms:content-item:1"), true],
+          [new Date(), false],
+        ],
+      ],
+    ])("%s", (_, ruleConfig, testCases: unknown[]) => {
+      let rule: ValueTypeValidationRule;
+
+      beforeEach(() => {
+        rule = new ValueTypeValidationRule(rulePrn, ruleConfig as ValueTypeValidationRuleSettings);
+      });
+
+      it.each(testCases)("returns %s for the provided value", (value, expected) => {
+        expect(rule.validate([value as ContentValueType])).toBeContentValidationResult([expected as boolean]);
+      });
+    });
+  });
+
+  describe("classifyUpdate", () => {
     let rule: ValueTypeValidationRule;
+    const allowedTypes: ContentValueTypeName<ContentValueType>[] = [
+      ContentValueTypeNames.STRING,
+      ContentValueTypeNames.NUMBER,
+    ];
 
     beforeEach(() => {
-      rule = new ValueTypeValidationRule(rulePrn, ruleConfig as ValueTypeValidationRuleSettings);
+      rule = new ValueTypeValidationRule(rulePrn, { allowedTypes });
     });
 
-    it.each(testCases)("returns %s for the provided value", (value, expected) => {
-      expect(rule.validate([value as ContentValueType])).toBeContentValidationResult([expected]);
+    it.each([
+      [ValidationRuleUpdateImpact.NONE, { allowedTypes: [...allowedTypes, ContentValueTypeNames.BOOLEAN] }], // extending
+      [ValidationRuleUpdateImpact.NONE, { allowedTypes: [...allowedTypes] }], // unchanged
+      [ValidationRuleUpdateImpact.BREAKS, { allowedTypes: [ContentValueTypeNames.BOOLEAN] }], // tightening
+    ])("returns %s when the new allowed types are %s", (expected, newSettings) => {
+      expect(rule.classifyUpdate(newSettings as ValueTypeValidationRuleSettings)).toBe(expected);
+    });
+  });
+
+  describe("classifyCreate", () => {
+    it("returns BREAKS", () => {
+      const rule = new ValueTypeValidationRule(rulePrn, { allowedTypes: [ContentValueTypeNames.STRING] });
+      expect(rule.classifyCreate()).toBe(ValidationRuleUpdateImpact.BREAKS);
     });
   });
 });

package/src/lib/validation-rules/value-type.validation-rule.ts

@@ -1,16 +1,18 @@
 import { InvalidCastError, validateCast } from "@platecms/delta-cast";
 import { PRN } from "@platecms/delta-plate-resource-notation";
 import { ContentValueType, ContentValueTypeName, ContentValueTypeNames } from "@platecms/delta-types";
+import { RuleType } from "../enums/rule-types.enum";
+import { ValidationRuleUpdateImpact } from "../enums/validation-rule-update-impact.enum";
 import { ValidationErrorDetails } from "../errors/validation-error-details";
+import { isSuperset } from "../helpers/is-superset.helper";
 import { RuleInstance } from "../types/rule-instance.interface";
-import { RuleType } from "../enums/rule-types.enum";
 import { BaseValidationRule, ContentValidationResultType } from "./base.validation-rule";
 import { validationFunctionFromValidateValue } from "./validation-rule-function.factory";
 
 /**
  * Mapping of PRN resource type to Content Value Type Name.
  */
-const prnResourceTypeToContentValueTypeNameMap: Record<string, ContentValueTypeNames> = {
+const prnResourceTypeToContentValueTypeNameMap: Record<string, ContentValueTypeName<PRN>> = {
   /* eslint-disable @typescript-eslint/naming-convention */
   "content-item": ContentValueTypeNames.CONTENT_ITEM,
   asset: ContentValueTypeNames.ASSET,
@@ -68,6 +70,19 @@ export class ValueTypeValidationRule extends BaseValidationRule<ValueTypeValidat
   public override validate(values: ContentValueType[]): ContentValidationResultType[] {
     return validateValueType(values, this);
   }
+
+  public override classifyCreate(): ValidationRuleUpdateImpact {
+    return ValidationRuleUpdateImpact.BREAKS;
+  }
+
+  public override classifyUpdate(newSettings: ValueTypeValidationRuleSettings): ValidationRuleUpdateImpact {
+    const oldAllowedTypes = this.settings.allowedTypes;
+    const newAllowedTypes = newSettings.allowedTypes;
+
+    return isSuperset(newAllowedTypes, oldAllowedTypes)
+      ? ValidationRuleUpdateImpact.NONE
+      : ValidationRuleUpdateImpact.BREAKS;
+  }
 }
 
 // The value type can be one or more of the types specified in the ContentValueType type