feat: normalise validations across the codebase so that they return v…

…alid and reason properties (#381)

development/src/index.ts

@@ -149,18 +149,7 @@ const getModes = () => {
 				circle: {
 					feature: {
 						validation: (feature) => {
-							if (feature.geometry.type !== "Polygon") {
-								return {
-									valid: false,
-									reason: "Feature is not a valid Polygon feature",
-								};
-							}
-
-							const result = ValidateMinAreaSquareMeters(feature, 1000);
-							return {
-								valid: result,
-								reason: result ? undefined : "Area too small",
-							};
+							return ValidateMinAreaSquareMeters(feature, 1000);
 						},
 						draggable: true,
 						coordinates: {
@@ -189,11 +178,7 @@ const getModes = () => {
 			snapping: true,
 			validation: (feature, { updateType }) => {
 				if (updateType === "finish" || updateType === "commit") {
-					const valid = ValidateNotSelfIntersecting(feature);
-					return {
-						valid,
-						reason: valid ? undefined : "Polygon must not self-intersect",
-					};
+					return ValidateNotSelfIntersecting(feature);
 				}
 				return { valid: true };
 			},

e2e/src/index.ts

@@ -71,16 +71,12 @@ const example = {
 									this.config?.includes("validationSuccess") ||
 									this.config?.includes("validationFailure")
 										? (feature) => {
-												const result = ValidateMaxAreaSquareMeters(
+												return ValidateMaxAreaSquareMeters(
 													feature,
 													this.config?.includes("validationFailure")
 														? 1000000
 														: 2000000,
 												);
-												return {
-													valid: result,
-													reason: result ? undefined : "Area too large",
-												};
 										  }
 										: undefined,
 								draggable: true,
@@ -155,16 +151,12 @@ const example = {
 						this.config?.includes("validationSuccess") ||
 						this.config?.includes("validationFailure")
 							? (feature) => {
-									const result = ValidateMaxAreaSquareMeters(
+									return ValidateMaxAreaSquareMeters(
 										feature,
 										this.config?.includes("validationFailure")
 											? 1000000
 											: 2000000,
 									);
-									return {
-										valid: result,
-										reason: "Area too large",
-									};
 							  }
 							: undefined,
 				}),

src/modes/angled-rectangle/angled-rectangle.mode.ts

@@ -12,7 +12,6 @@ import {
 	TerraDrawBaseDrawMode,
 	BaseModeOptions,
 	CustomStyling,
-	ModeMismatchValidationFailure,
 } from "../base.mode";
 import { coordinatesIdentical } from "../../geometry/coordinates-identical";
 import { getDefaultStyling } from "../../util/styling";
@@ -21,10 +20,7 @@ import {
 	GeoJSONStoreFeatures,
 	StoreValidation,
 } from "../../store/store";
-import {
-	ValidateNonIntersectingPolygonFeature,
-	ValidatePolygonFeature,
-} from "../../validations/polygon.validation";
+import { ValidateNonIntersectingPolygonFeature } from "../../validations/polygon.validation";
 import { webMercatorDestination } from "../../geometry/measure/destination";
 import { webMercatorBearing } from "../../geometry/measure/bearing";
 import { midpointCoordinate } from "../../geometry/midpoint-coordinate";
@@ -253,7 +249,7 @@ export class TerraDrawAngledRectangleMode extends TerraDrawBaseDrawMode<PolygonS
 		} as Polygon;
 
 		if (this.validate) {
-			const valid = this.validate(
+			const validationResult = this.validate(
 				{
 					type: "Feature",
 					geometry: updatedGeometry,
@@ -266,7 +262,7 @@ export class TerraDrawAngledRectangleMode extends TerraDrawBaseDrawMode<PolygonS
 				},
 			);
 
-			if (!valid.valid) {
+			if (!validationResult.valid) {
 				return false;
 			}
 		}
@@ -418,14 +414,11 @@ export class TerraDrawAngledRectangleMode extends TerraDrawBaseDrawMode<PolygonS
 	}
 
 	validateFeature(feature: unknown): StoreValidation {
-		return this.validateModeFeature(
-			feature,
-			(baseValidatedFeature) =>
-				ValidateNonIntersectingPolygonFeature(
-					baseValidatedFeature,
-					this.coordinatePrecision,
-				),
-			"Feature is not a valid simple Polygon feature",
+		return this.validateModeFeature(feature, (baseValidatedFeature) =>
+			ValidateNonIntersectingPolygonFeature(
+				baseValidatedFeature,
+				this.coordinatePrecision,
+			),
 		);
 	}
 }

src/modes/base.mode.ts

@@ -34,8 +34,6 @@ export enum ModeTypes {
 	Render = "render",
 }
 
-type BaseValidationResult = { valid: boolean; reason?: string };
-
 export type BaseModeOptions<T extends CustomStyling> = {
 	styles?: Partial<T>;
 	pointerDistance?: number;
@@ -157,11 +155,11 @@ export abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
 		}
 	}
 
-	validateFeature(feature: unknown): BaseValidationResult {
+	validateFeature(feature: unknown): ReturnType<Validation> {
 		return this.performFeatureValidation(feature);
 	}
 
-	private performFeatureValidation(feature: unknown): BaseValidationResult {
+	private performFeatureValidation(feature: unknown): ReturnType<Validation> {
 		if (this._state === "unregistered") {
 			throw new Error("Mode must be registered");
 		}
@@ -196,9 +194,8 @@ export abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
 
 	protected validateModeFeature(
 		feature: unknown,
-		modeValidationFn: (feature: GeoJSONStoreFeatures) => boolean,
-		defaultError: string,
-	): BaseValidationResult {
+		modeValidationFn: (feature: GeoJSONStoreFeatures) => ReturnType<Validation>,
+	): ReturnType<Validation> {
 		const validation = this.performFeatureValidation(feature);
 		if (validation.valid) {
 			const validatedFeature = feature as GeoJSONStoreFeatures;
@@ -207,10 +204,7 @@ export abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
 				return ModeMismatchValidationFailure;
 			}
 			const modeValidation = modeValidationFn(validatedFeature);
-			return {
-				valid: modeValidation,
-				reason: modeValidation ? undefined : defaultError,
-			};
+			return modeValidation;
 		}
 
 		return {

src/modes/circle/circle.mode.spec.ts

@@ -571,7 +571,7 @@ describe("TerraDrawCircleMode", () => {
 					},
 				}),
 			).toEqual({
-				reason: "Feature is not a valid simple Polygon feature",
+				reason: "Feature has less than 4 coordinates",
 				valid: false,
 			});
 		});

src/modes/circle/circle.mode.ts

@@ -20,7 +20,6 @@ import { getDefaultStyling } from "../../util/styling";
 import {
 	BaseModeOptions,
 	CustomStyling,
-	ModeMismatchValidationFailure,
 	TerraDrawBaseDrawMode,
 } from "../base.mode";
 import { ValidateNonIntersectingPolygonFeature } from "../../validations/polygon.validation";
@@ -280,14 +279,11 @@ export class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePolygonStyl
 	}
 
 	validateFeature(feature: unknown): StoreValidation {
-		return this.validateModeFeature(
-			feature,
-			(baseValidatedFeature) =>
-				ValidateNonIntersectingPolygonFeature(
-					baseValidatedFeature,
-					this.coordinatePrecision,
-				),
-			"Feature is not a valid simple Polygon feature",
+		return this.validateModeFeature(feature, (baseValidatedFeature) =>
+			ValidateNonIntersectingPolygonFeature(
+				baseValidatedFeature,
+				this.coordinatePrecision,
+			),
 		);
 	}
 

src/modes/freehand/freehand.mode.ts

@@ -122,7 +122,7 @@ export class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<FreehandPolygon
 		if (this.validate && finishedId) {
 			const currentGeometry = this.store.getGeometryCopy<Polygon>(finishedId);
 
-			const valid = this.validate(
+			const validationResult = this.validate(
 				{
 					type: "Feature",
 					id: finishedId,
@@ -137,7 +137,7 @@ export class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<FreehandPolygon
 				},
 			);
 
-			if (!valid.valid) {
+			if (!validationResult.valid) {
 				return;
 			}
 		}
@@ -243,7 +243,7 @@ export class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<FreehandPolygon
 		} as Polygon;
 
 		if (this.validate) {
-			const valid = this.validate(
+			const validationResult = this.validate(
 				{
 					type: "Feature",
 					id: this.currentId,
@@ -258,7 +258,7 @@ export class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<FreehandPolygon
 				},
 			);
 
-			if (!valid.valid) {
+			if (!validationResult.valid) {
 				return;
 			}
 		}
@@ -433,11 +433,8 @@ export class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<FreehandPolygon
 	}
 
 	validateFeature(feature: unknown): StoreValidation {
-		return this.validateModeFeature(
-			feature,
-			(baseValidatedFeature) =>
-				ValidatePolygonFeature(baseValidatedFeature, this.coordinatePrecision),
-			"Feature is not a valid Polygon feature",
+		return this.validateModeFeature(feature, (baseValidatedFeature) =>
+			ValidatePolygonFeature(baseValidatedFeature, this.coordinatePrecision),
 		);
 	}
 }

src/modes/linestring/linestring.mode.spec.ts

@@ -311,7 +311,7 @@ describe("TerraDrawLineStringMode", () => {
 				lineStringMode = new TerraDrawLineStringMode({
 					validation: (feature, { updateType }) => {
 						if (updateType === "finish" || updateType === "commit") {
-							return { valid: ValidateNotSelfIntersecting(feature) };
+							return ValidateNotSelfIntersecting(feature);
 						}
 						return { valid: true };
 					},
@@ -385,7 +385,7 @@ describe("TerraDrawLineStringMode", () => {
 				lineStringMode = new TerraDrawLineStringMode({
 					validation: (feature, { updateType }) => {
 						if (updateType === "finish" || updateType === "commit") {
-							return { valid: ValidateNotSelfIntersecting(feature) };
+							return ValidateNotSelfIntersecting(feature);
 						}
 						return { valid: true };
 					},
@@ -828,7 +828,7 @@ describe("TerraDrawLineStringMode", () => {
 					},
 				}),
 			).toEqual({
-				reason: "Feature is not a valid LineString feature",
+				reason: "Feature has less than 2 coordinates",
 				valid: false,
 			});
 		});

src/modes/linestring/linestring.mode.ts

@@ -11,7 +11,6 @@ import { LineString, Point, Position } from "geojson";
 import {
 	BaseModeOptions,
 	CustomStyling,
-	ModeMismatchValidationFailure,
 	TerraDrawBaseDrawMode,
 } from "../base.mode";
 import { cartesianDistance } from "../../geometry/measure/pixel-distance";
@@ -574,14 +573,8 @@ export class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineStringSty
 	}
 
 	validateFeature(feature: unknown): StoreValidation {
-		return this.validateModeFeature(
-			feature,
-			(baseValidatedFeature) =>
-				ValidateLineStringFeature(
-					baseValidatedFeature,
-					this.coordinatePrecision,
-				),
-			"Feature is not a valid LineString feature",
+		return this.validateModeFeature(feature, (baseValidatedFeature) =>
+			ValidateLineStringFeature(baseValidatedFeature, this.coordinatePrecision),
 		);
 	}
 }

src/modes/point/point.mode.ts

@@ -11,7 +11,6 @@ import { getDefaultStyling } from "../../util/styling";
 import {
 	BaseModeOptions,
 	CustomStyling,
-	ModeMismatchValidationFailure,
 	TerraDrawBaseDrawMode,
 } from "../base.mode";
 import { ValidatePointFeature } from "../../validations/point.validation";
@@ -78,7 +77,7 @@ export class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeStyling>
 		const properties = { mode: this.mode };
 
 		if (this.validate) {
-			const valid = this.validate(
+			const validationResult = this.validate(
 				{
 					type: "Feature",
 					geometry,
@@ -92,7 +91,7 @@ export class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeStyling>
 				},
 			);
 
-			if (!valid.valid) {
+			if (!validationResult.valid) {
 				return;
 			}
 		}
@@ -164,11 +163,8 @@ export class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeStyling>
 	}
 
 	validateFeature(feature: unknown): StoreValidation {
-		return this.validateModeFeature(
-			feature,
-			(baseValidatedFeature) =>
-				ValidatePointFeature(baseValidatedFeature, this.coordinatePrecision),
-			"Feature is not a valid Point feature",
+		return this.validateModeFeature(feature, (baseValidatedFeature) =>
+			ValidatePointFeature(baseValidatedFeature, this.coordinatePrecision),
 		);
 	}
 }

src/modes/polygon/polygon.mode.spec.ts

@@ -229,11 +229,7 @@ describe("TerraDrawPolygonMode", () => {
 
 		const validation: Validation = (feature, { updateType }) => {
 			if (updateType === "finish" || updateType === "commit") {
-				const validation = ValidateNotSelfIntersecting(feature);
-				return {
-					valid: validation,
-					reason: validation ? undefined : "Self intersecting",
-				};
+				return ValidateNotSelfIntersecting(feature);
 			}
 			return { valid: true };
 		};
@@ -544,11 +540,7 @@ describe("TerraDrawPolygonMode", () => {
 				polygonMode = new TerraDrawPolygonMode({
 					validation: (feature, { updateType }) => {
 						if (updateType === "finish" || updateType === "commit") {
-							const validation = ValidateNotSelfIntersecting(feature);
-							return {
-								valid: validation,
-								reason: validation ? undefined : "Self intersecting",
-							};
+							return ValidateNotSelfIntersecting(feature);
 						}
 						return { valid: true };
 					},