Export typescript read/write types for each sbvr type

Change-type: minor
balena-io-modules · Apr 17, 2024 · 66b9a01 · 66b9a01
1 parent de47069
commit 66b9a01
Show file tree

Hide file tree

Showing 23 changed files with 109 additions and 71 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -26,6 +26,31 @@ import * as WebResource from './types/web-resource';
 
 export { WebResource as WebResourceType } from './types/web-resource';
 
+export type Types = {
+	'Big Integer': BigInteger.Types;
+	'Big Serial': BigSerial.Types;
+	// eslint-disable-next-line id-denylist
+	Boolean: Boolean.Types;
+	'Case Insensitive Text': CaseInsensitiveText.Types;
+	Color: Color.Types;
+	ConceptType: ConceptType.Types;
+	Date: Date.Types;
+	'Date Time': DateTime.Types;
+	File: File.Types;
+	ForeignKey: ForeignKey.Types;
+	Hashed: Hashed.Types;
+	Integer: Integer.Types;
+	Interval: Interval.Types;
+	JSON: JSON.Types;
+	Real: Real.Types;
+	Serial: Serial.Types;
+	SHA: SHA.Types;
+	'Short Text': ShortText.Types;
+	Text: Text.Types;
+	Time: Time.Types;
+	WebResource: WebResource.Types;
+};
+
 export default {
 	'Big Integer': BigInteger,
 	'Big Serial': BigSerial,
@@ -50,12 +75,13 @@ export default {
 	Time,
 	WebResource,
 } satisfies {
+	[fieldType in keyof Types]: SbvrType;
+} & {
 	Hashed: SbvrType & {
 		compare: (str: string, hash: string) => Promise<boolean>;
 	};
 	SHA: SbvrType & {
 		validateSync: (value: string) => string;
 		compare: (str: string, hash: string) => Promise<boolean>;
 	};
-	[fieldType: string]: SbvrType;
 };
diff --git a/src/type-utils.ts b/src/type-utils.ts
@@ -16,6 +16,10 @@ export interface SbvrType<Read = unknown, Write = any, DbWrite = unknown> {
 	fetchProcessing?: FetchProcessing<Read>;
 	validate: Validate<Write, DbWrite>;
 }
+export interface TsTypes<Read, Write> {
+	Read: Read;
+	Write: Write;
+}
 
 export type FetchProcessing<Read> = (data: unknown) => Read | null | undefined;
 export interface Validate<Write, DbWrite> {

diff --git a/src/types/big-integer.ts b/src/types/big-integer.ts
@@ -9,13 +9,13 @@ export const types = {
 	},
 };
 
-type WriteType = number;
+export type Types = TypeUtils.TsTypes<number, number>;
 type DbWriteType = number;
 
 export const nativeFactTypes = {
 	Integer: TypeUtils.nativeFactTypeTemplates.comparison,
 	Real: TypeUtils.nativeFactTypeTemplates.comparison,
 };
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.integer;
diff --git a/src/types/big-serial.ts b/src/types/big-serial.ts
@@ -23,8 +23,8 @@ export const types = {
 	},
 };
 
-type WriteType = number;
+export type Types = TypeUtils.TsTypes<number, number>;
 type DbWriteType = number;
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.integer;
diff --git a/src/types/boolean.ts b/src/types/boolean.ts
@@ -16,15 +16,15 @@ export const types = {
 	},
 };
 
-type ReadType = boolean;
-type WriteType = boolean | 0 | 1;
+export type Types = TypeUtils.TsTypes<boolean, 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 fetchProcessing: TypeUtils.FetchProcessing<Types['Read']> = (
+	data,
+) => data === true || data === 1;
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], 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);

diff --git a/src/types/case-insensitive-text.ts b/src/types/case-insensitive-text.ts
@@ -9,8 +9,8 @@ export const types = {
 	},
 };
 
-type WriteType = string;
+export type Types = TypeUtils.TsTypes<string, string>;
 type DbWriteType = string;
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.text();
diff --git a/src/types/color.ts b/src/types/color.ts
@@ -16,13 +16,13 @@ export const types = {
 	},
 };
 
-type ReadType = {
+type ColorObj = {
 	r: number;
 	g: number;
 	b: number;
 	a: number;
 };
-type WriteType = number | ReadType;
+export type Types = TypeUtils.TsTypes<ColorObj, number | ColorObj>;
 type DbWriteType = number;
 
 export const nativeProperties = {
@@ -46,7 +46,9 @@ export const nativeProperties = {
 	},
 };
 
-export const fetchProcessing: TypeUtils.FetchProcessing<ReadType> = (data) => {
+export const fetchProcessing: TypeUtils.FetchProcessing<Types['Read']> = (
+	data,
+) => {
 	if (typeof data !== 'number') {
 		throw new Error('Fetched color is not an integer: ' + typeof data);
 	}
@@ -60,7 +62,7 @@ export const fetchProcessing: TypeUtils.FetchProcessing<ReadType> = (data) => {
 	/* eslint-enable no-bitwise */
 };
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.checkRequired((value) => {
 		let processedValue: number;
 		if (typeof value !== 'object') {

diff --git a/src/types/concept-type.ts b/src/types/concept-type.ts
@@ -9,13 +9,13 @@ export const types = {
 	},
 };
 
-type WriteType = number;
+export type Types = TypeUtils.TsTypes<number, number>;
 type DbWriteType = number;
 
 export const nativeFactTypes = {
 	Integer: TypeUtils.nativeFactTypeTemplates.comparison,
 	Real: TypeUtils.nativeFactTypeTemplates.comparison,
 };
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.integer;
diff --git a/src/types/date-time.ts b/src/types/date-time.ts
@@ -9,11 +9,12 @@ export const types = {
 	},
 };
 
-type ReadType = string;
-type WriteType = string | number;
+export type Types = TypeUtils.TsTypes<string, string | number>;
 type DbWriteType = Date;
 
-export const fetchProcessing: TypeUtils.FetchProcessing<ReadType> = (data) => {
+export const fetchProcessing: TypeUtils.FetchProcessing<Types['Read']> = (
+	data,
+) => {
 	if (data == null) {
 		return data;
 	}
@@ -39,5 +40,5 @@ export const nativeNames = {
 	'Current Time': ['Now'],
 };
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.date;
diff --git a/src/types/date.ts b/src/types/date.ts
@@ -9,11 +9,12 @@ export const types = {
 	},
 };
 
-type ReadType = string;
-type WriteType = string | number;
+export type Types = TypeUtils.TsTypes<string, string | number>;
 type DbWriteType = Date;
 
-export const fetchProcessing: TypeUtils.FetchProcessing<ReadType> = (data) => {
+export const fetchProcessing: TypeUtils.FetchProcessing<Types['Read']> = (
+	data,
+) => {
 	if (data == null) {
 		return data;
 	}
@@ -35,5 +36,5 @@ export const nativeFactTypes = {
 	},
 };
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.date;
diff --git a/src/types/file.ts b/src/types/file.ts
@@ -8,10 +8,10 @@ export const types = {
 	},
 };
 
-type WriteType = Buffer | string;
+export type Types = TypeUtils.TsTypes<Buffer, Buffer | string>;
 type DbWriteType = Buffer;
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.checkRequired((value) => {
 		if (Buffer.isBuffer(value)) {
 			return value;

diff --git a/src/types/foreign-key.ts b/src/types/foreign-key.ts
@@ -9,13 +9,13 @@ export const types = {
 	},
 };
 
-type WriteType = number;
+export type Types = TypeUtils.TsTypes<number, number>;
 type DbWriteType = number;
 
 export const nativeFactTypes = {
 	Integer: TypeUtils.nativeFactTypeTemplates.comparison,
 	Real: TypeUtils.nativeFactTypeTemplates.comparison,
 };
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.integer;
diff --git a/src/types/hashed.ts b/src/types/hashed.ts
@@ -18,10 +18,10 @@ export const types = {
 	},
 };
 
-type WriteType = string;
+export type Types = TypeUtils.TsTypes<string, string>;
 type DbWriteType = string;
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.checkRequired(async (value) => {
 		if (typeof value !== 'string') {
 			throw new Error('is not a string');

diff --git a/src/types/integer.ts b/src/types/integer.ts
@@ -9,13 +9,13 @@ export const types = {
 	},
 };
 
-type WriteType = number;
+export type Types = TypeUtils.TsTypes<number, number>;
 type DbWriteType = number;
 
 export const nativeFactTypes = {
 	Integer: TypeUtils.nativeFactTypeTemplates.comparison,
 	Real: TypeUtils.nativeFactTypeTemplates.comparison,
 };
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.integer;
diff --git a/src/types/interval.ts b/src/types/interval.ts
@@ -9,8 +9,8 @@ export const types = {
 	},
 };
 
-type WriteType = number;
+export type Types = TypeUtils.TsTypes<number, number>;
 type DbWriteType = number;
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.integer;
diff --git a/src/types/json.ts b/src/types/json.ts
@@ -20,18 +20,22 @@ type JSONable =
 	| { [key: string]: JSONable }
 	| { toJSON(): JSONable };
 
-type ReadType = { [key: string]: JSON } | JSON[];
-type WriteType = { [key: string]: JSONable } | JSONable[];
+export type Types = TypeUtils.TsTypes<
+	{ [key: string]: JSON } | JSON[],
+	{ [key: string]: JSONable } | JSONable[]
+>;
 type DbWriteType = string;
 
-export const fetchProcessing: TypeUtils.FetchProcessing<ReadType> = (data) => {
+export const fetchProcessing: TypeUtils.FetchProcessing<Types['Read']> = (
+	data,
+) => {
 	if (typeof data === 'string') {
 		return JSON.parse(data);
 	}
 	return data;
 };
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.checkRequired((value) => {
 		// Disallow primitives
 		if (typeof value !== 'object') {

diff --git a/src/types/real.ts b/src/types/real.ts
@@ -9,15 +9,15 @@ export const types = {
 	},
 };
 
-type WriteType = number;
+export type Types = TypeUtils.TsTypes<number, number>;
 type DbWriteType = number;
 
 export const nativeFactTypes = {
 	Integer: TypeUtils.nativeFactTypeTemplates.comparison,
 	Real: TypeUtils.nativeFactTypeTemplates.comparison,
 };
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.checkRequired((value) => {
 		const processedValue = parseFloat(value);
 		if (Number.isNaN(processedValue)) {

diff --git a/src/types/serial.ts b/src/types/serial.ts
@@ -23,8 +23,8 @@ export const types = {
 	},
 };
 
-type WriteType = number;
+export type Types = TypeUtils.TsTypes<number, number>;
 type DbWriteType = number;
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.integer;
diff --git a/src/types/sha.ts b/src/types/sha.ts
@@ -30,12 +30,12 @@ export const types = {
 	},
 };
 
-type WriteType = string;
+export type Types = TypeUtils.TsTypes<string, string>;
 type DbWriteType = string;
 
 export const validateSync = sha256;
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.checkRequired((value) => {
 		if (typeof value !== 'string') {
 			throw new Error('is not a string');

diff --git a/src/types/short-text.ts b/src/types/short-text.ts
@@ -9,8 +9,8 @@ export const types = {
 	},
 };
 
-type WriteType = string;
+export type Types = TypeUtils.TsTypes<string, string>;
 type DbWriteType = string;
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.text(255);
diff --git a/src/types/text.ts b/src/types/text.ts
@@ -9,7 +9,7 @@ export const types = {
 	},
 };
 
-type WriteType = string;
+export type Types = TypeUtils.TsTypes<string, string>;
 type DbWriteType = string;
 
 export const nativeProperties = {
@@ -27,5 +27,5 @@ export const nativeFactTypes = {
 	},
 };
 
-export const validate: TypeUtils.Validate<WriteType, DbWriteType> =
+export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 	TypeUtils.validate.text();