Improve validate typings

Change-type: patch
balena-io-modules · Mar 12, 2024 · 6ed4746 · 6ed4746
1 parent 786e3d6
commit 6ed4746
Show file tree

Hide file tree

Showing 22 changed files with 225 additions and 136 deletions.
diff --git a/src/type-utils.ts b/src/type-utils.ts
@@ -3,7 +3,7 @@ export interface DatabaseTypeFn {
 	castType: string;
 }
 export type DatabaseType = string | DatabaseTypeFn;
-export interface SbvrType<Read = unknown> {
+export interface SbvrType<Read = unknown, Write = any, DbWrite = unknown> {
 	types: {
 		odata: {
 			name: string;
@@ -14,16 +14,24 @@ export interface SbvrType<Read = unknown> {
 		websql: DatabaseType;
 	};
 	fetchProcessing?: FetchProcessing<Read>;
-	validate: (value: any, required: boolean) => Promise<any>;
+	validate: Validate<Write, DbWrite>;
 }
 
 export type FetchProcessing<Read> = (data: unknown) => Read | null | undefined;
+export interface Validate<Write, DbWrite> {
+	(value: Write, required: true): Promise<DbWrite>;
+	(value: Write, required: false): Promise<DbWrite | null>;
+	(value: Write, required: boolean): Promise<DbWrite | null>;
+}
 
-const checkRequired = <T>(validateFn: (value: any) => T) => {
-	function runCheck(value: any, required: true): Promise<T>;
+const checkRequired = <T>(validateFn: (value: any) => T | Promise<T>) => {
+	function runCheck(value: unknown, required: true): Promise<T>;
 	function runCheck(value: undefined | null, required: false): Promise<null>;
-	function runCheck(value: any, required: boolean): Promise<T | null>;
-	async function runCheck(value: any, required: boolean): Promise<T | null> {
+	function runCheck(value: unknown, required: boolean): Promise<T | null>;
+	async function runCheck(
+		value: unknown,
+		required: boolean,
+	): Promise<T | null> {
 		if (value == null) {
 			if (required) {
 				throw new Error('cannot be null');
@@ -53,15 +61,15 @@ export const nativeFactTypeTemplates = {
 
 export const validate = {
 	checkRequired,
-	integer: checkRequired((value: any) => {
+	integer: checkRequired((value) => {
 		const processedValue = parseInt(value, 10);
 		if (Number.isNaN(processedValue)) {
 			throw new Error('is not a number: ' + value);
 		}
 		return processedValue;
 	}),
 	text: (length?: number) =>
-		checkRequired((value: any) => {
+		checkRequired((value) => {
 			if (typeof value !== 'string') {
 				throw new Error('is not a string: ' + value);
 			}
@@ -72,7 +80,7 @@ export const validate = {
 			}
 			return value;
 		}),
-	date: checkRequired((value: any) => {
+	date: checkRequired((value) => {
 		let processedValue = Number(value);
 		if (Number.isNaN(processedValue)) {
 			processedValue = value;

diff --git a/src/types/big-integer.ts b/src/types/big-integer.ts
@@ -9,9 +9,13 @@ export const types = {
 	},
 };
 
+type WriteType = number;
+type DbWriteType = number;
+
 export const nativeFactTypes = {
 	Integer: TypeUtils.nativeFactTypeTemplates.comparison,
 	Real: TypeUtils.nativeFactTypeTemplates.comparison,
 };
 
-export const validate = TypeUtils.validate.integer;
+export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+	TypeUtils.validate.integer;
diff --git a/src/types/big-serial.ts b/src/types/big-serial.ts
@@ -23,4 +23,8 @@ export const types = {
 	},
 };
 
-export const validate = TypeUtils.validate.integer;
+type WriteType = number;
+type DbWriteType = number;
+
+export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+	TypeUtils.validate.integer;
diff --git a/src/types/boolean.ts b/src/types/boolean.ts
@@ -17,20 +17,23 @@ export const types = {
 };
 
 type ReadType = boolean;
+type WriteType = boolean | 0 | 1;
+type DbWriteType = boolean;
 
 // `BOOLEAN` on sqlite/websql is just an alias for `INTEGER` hence the `=== 1` check
 export const fetchProcessing: TypeUtils.FetchProcessing<ReadType> = (data) =>
 	data === true || data === 1;
 
-export const validate = TypeUtils.validate.checkRequired((originalValue) => {
-	// We use Number rather than parseInt as it deals with booleans and will return NaN for things like "a1"
-	const value = Number(originalValue);
-	if (value !== 0 && value !== 1) {
-		throw new Error(
-			`is not a boolean: ${JSON.stringify(
-				originalValue,
-			)} (${typeof originalValue})`,
-		);
-	}
-	return value === 1;
-});
+export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+	TypeUtils.validate.checkRequired((originalValue) => {
+		// We use Number rather than parseInt as it deals with booleans and will return NaN for things like "a1"
+		const value = Number(originalValue);
+		if (value !== 0 && value !== 1) {
+			throw new Error(
+				`is not a boolean: ${JSON.stringify(
+					originalValue,
+				)} (${typeof originalValue})`,
+			);
+		}
+		return value === 1;
+	});
diff --git a/src/types/case-insensitive-text.ts b/src/types/case-insensitive-text.ts
@@ -9,4 +9,8 @@ export const types = {
 	},
 };
 
-export const validate = TypeUtils.validate.text();
+type WriteType = string;
+type DbWriteType = string;
+
+export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+	TypeUtils.validate.text();
diff --git a/src/types/color.ts b/src/types/color.ts
@@ -22,6 +22,8 @@ type ReadType = {
 	b: number;
 	a: number;
 };
+type WriteType = number | ReadType;
+type DbWriteType = number;
 
 export const nativeProperties = {
 	has: {
@@ -58,48 +60,49 @@ export const fetchProcessing: TypeUtils.FetchProcessing<ReadType> = (data) => {
 	/* eslint-enable no-bitwise */
 };
 
-export const validate = TypeUtils.validate.checkRequired((value) => {
-	let processedValue: number;
-	if (typeof value !== 'object') {
-		processedValue = parseInt(value, 10);
-		if (Number.isNaN(processedValue)) {
-			throw new Error('is neither an integer or color object: ' + value);
-		}
-	} else {
-		processedValue = 0;
-		Object.keys(value).forEach((component) => {
-			const componentValue = value[component];
-			if (Number.isNaN(componentValue) || componentValue > 255) {
-				throw new Error(
-					'has invalid component value of ' +
-						componentValue +
-						' for component ' +
-						component,
-				);
-			}
-			/* eslint-disable no-bitwise */
-			switch (component.toLowerCase()) {
-				case 'r':
-				case 'red':
-					processedValue |= componentValue << 16;
-					break;
-				case 'g':
-				case 'green':
-					processedValue |= componentValue << 8;
-					break;
-				case 'b':
-				case 'blue':
-					processedValue |= componentValue;
-					break;
-				case 'a':
-				case 'alpha':
-					processedValue |= componentValue << 24;
-					break;
-				default:
-					throw new Error('has an unknown component: ' + component);
+export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+	TypeUtils.validate.checkRequired((value) => {
+		let processedValue: number;
+		if (typeof value !== 'object') {
+			processedValue = parseInt(value, 10);
+			if (Number.isNaN(processedValue)) {
+				throw new Error('is neither an integer or color object: ' + value);
 			}
-			/* eslint-enable no-bitwise */
-		});
-	}
-	return processedValue;
-});
+		} else {
+			processedValue = 0;
+			Object.keys(value).forEach((component) => {
+				const componentValue = value[component];
+				if (Number.isNaN(componentValue) || componentValue > 255) {
+					throw new Error(
+						'has invalid component value of ' +
+							componentValue +
+							' for component ' +
+							component,
+					);
+				}
+				/* eslint-disable no-bitwise */
+				switch (component.toLowerCase()) {
+					case 'r':
+					case 'red':
+						processedValue |= componentValue << 16;
+						break;
+					case 'g':
+					case 'green':
+						processedValue |= componentValue << 8;
+						break;
+					case 'b':
+					case 'blue':
+						processedValue |= componentValue;
+						break;
+					case 'a':
+					case 'alpha':
+						processedValue |= componentValue << 24;
+						break;
+					default:
+						throw new Error('has an unknown component: ' + component);
+				}
+				/* eslint-enable no-bitwise */
+			});
+		}
+		return processedValue;
+	});
diff --git a/src/types/concept-type.ts b/src/types/concept-type.ts
@@ -9,9 +9,13 @@ export const types = {
 	},
 };
 
+type WriteType = number;
+type DbWriteType = number;
+
 export const nativeFactTypes = {
 	Integer: TypeUtils.nativeFactTypeTemplates.comparison,
 	Real: TypeUtils.nativeFactTypeTemplates.comparison,
 };
 
-export const validate = TypeUtils.validate.integer;
+export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+	TypeUtils.validate.integer;
diff --git a/src/types/date-time.ts b/src/types/date-time.ts
@@ -10,6 +10,8 @@ export const types = {
 };
 
 type ReadType = string;
+type WriteType = string | number;
+type DbWriteType = Date;
 
 export const fetchProcessing: TypeUtils.FetchProcessing<ReadType> = (data) => {
 	if (data == null) {
@@ -37,4 +39,5 @@ export const nativeNames = {
 	'Current Time': ['Now'],
 };
 
-export const validate = TypeUtils.validate.date;
+export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+	TypeUtils.validate.date;
diff --git a/src/types/date.ts b/src/types/date.ts
@@ -10,6 +10,8 @@ export const types = {
 };
 
 type ReadType = string;
+type WriteType = string | number;
+type DbWriteType = Date;
 
 export const fetchProcessing: TypeUtils.FetchProcessing<ReadType> = (data) => {
 	if (data == null) {
@@ -33,4 +35,5 @@ export const nativeFactTypes = {
 	},
 };
 
-export const validate = TypeUtils.validate.date;
+export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+	TypeUtils.validate.date;
diff --git a/src/types/file.ts b/src/types/file.ts
@@ -8,26 +8,30 @@ export const types = {
 	},
 };
 
-export const validate = TypeUtils.validate.checkRequired((value) => {
-	if (Buffer.isBuffer(value)) {
-		return value;
-	}
-	if (typeof value !== 'string') {
-		throw new Error(`could not be converted to binary: ${typeof value}`);
-	}
-	if (value.length % 2 !== 0) {
-		throw new Error(
-			'could not be converted to binary: hex string must have an even length',
-		);
-	}
-	if (!/^[a-fA-F0-9]*$/.test(value)) {
-		throw new Error(
-			'could not be converted to binary: hex string must contain only hex characters',
-		);
-	}
-	try {
-		return Buffer.from(value, 'hex');
-	} catch (e: any) {
-		throw new Error(`could not be converted to binary: ${e.message}`);
-	}
-});
+type WriteType = Buffer | string;
+type DbWriteType = Buffer;
+
+export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+	TypeUtils.validate.checkRequired((value) => {
+		if (Buffer.isBuffer(value)) {
+			return value;
+		}
+		if (typeof value !== 'string') {
+			throw new Error(`could not be converted to binary: ${typeof value}`);
+		}
+		if (value.length % 2 !== 0) {
+			throw new Error(
+				'could not be converted to binary: hex string must have an even length',
+			);
+		}
+		if (!/^[a-fA-F0-9]*$/.test(value)) {
+			throw new Error(
+				'could not be converted to binary: hex string must contain only hex characters',
+			);
+		}
+		try {
+			return Buffer.from(value, 'hex');
+		} catch (e: any) {
+			throw new Error(`could not be converted to binary: ${e.message}`);
+		}
+	});
diff --git a/src/types/foreign-key.ts b/src/types/foreign-key.ts
@@ -9,9 +9,13 @@ export const types = {
 	},
 };
 
+type WriteType = number;
+type DbWriteType = number;
+
 export const nativeFactTypes = {
 	Integer: TypeUtils.nativeFactTypeTemplates.comparison,
 	Real: TypeUtils.nativeFactTypeTemplates.comparison,
 };
 
-export const validate = TypeUtils.validate.integer;
+export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+	TypeUtils.validate.integer;
diff --git a/src/types/hashed.ts b/src/types/hashed.ts
@@ -18,12 +18,16 @@ export const types = {
 	},
 };
 
-export const validate = TypeUtils.validate.checkRequired(async (value) => {
-	if (typeof value !== 'string') {
-		throw new Error('is not a string');
-	}
-	const salt = await bcrypt.genSalt();
-	return bcrypt.hash(value, salt);
-});
+type WriteType = string;
+type DbWriteType = string;
+
+export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+	TypeUtils.validate.checkRequired(async (value) => {
+		if (typeof value !== 'string') {
+			throw new Error('is not a string');
+		}
+		const salt = await bcrypt.genSalt();
+		return bcrypt.hash(value, salt);
+	});
 
 export const compare = bcrypt.compare.bind(bcrypt);
diff --git a/src/types/integer.ts b/src/types/integer.ts
@@ -9,9 +9,13 @@ export const types = {
 	},
 };
 
+type WriteType = number;
+type DbWriteType = number;
+
 export const nativeFactTypes = {
 	Integer: TypeUtils.nativeFactTypeTemplates.comparison,
 	Real: TypeUtils.nativeFactTypeTemplates.comparison,
 };
 
-export const validate = TypeUtils.validate.integer;
+export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+	TypeUtils.validate.integer;