6ecfa9b954
This commit introduces stricter type validation across the application to reject objects with unexpected properties, enhancing the robustness and predictability of data handling. Changes include: - Implement a common utility to validate object types. - Refactor across various parsers and data handlers to utilize the new validations. - Update error messages for better clarity and troubleshooting.
63 lines
2.0 KiB
TypeScript
63 lines
2.0 KiB
TypeScript
import { isString } from '@/TypeHelpers';
|
|
|
|
// Because we cannot do "T extends enum" 😞 https://github.com/microsoft/TypeScript/issues/30611
|
|
export type EnumType = number | string;
|
|
export type EnumVariable<T extends EnumType, TEnumValue extends EnumType>
|
|
= { [key in T]: TEnumValue };
|
|
|
|
export interface EnumParser<TEnum> {
|
|
parseEnum(value: string, propertyName: string): TEnum;
|
|
}
|
|
|
|
export function createEnumParser<T extends EnumType, TEnumValue extends EnumType>(
|
|
enumVariable: EnumVariable<T, TEnumValue>,
|
|
): EnumParser<TEnumValue> {
|
|
return {
|
|
parseEnum: (value, propertyName) => parseEnumValue(value, propertyName, enumVariable),
|
|
};
|
|
}
|
|
|
|
function parseEnumValue<T extends EnumType, TEnumValue extends EnumType>(
|
|
value: string,
|
|
enumName: string,
|
|
enumVariable: EnumVariable<T, TEnumValue>,
|
|
): TEnumValue {
|
|
if (!value) {
|
|
throw new Error(`missing ${enumName}`);
|
|
}
|
|
if (!isString(value)) {
|
|
throw new Error(`unexpected type of ${enumName}: "${typeof value}"`);
|
|
}
|
|
const casedValue = getEnumNames(enumVariable)
|
|
.find((enumValue) => enumValue.toLowerCase() === value.toLowerCase());
|
|
if (!casedValue) {
|
|
throw new Error(`unknown ${enumName}: "${value}"`);
|
|
}
|
|
return enumVariable[casedValue as keyof typeof enumVariable];
|
|
}
|
|
|
|
export function getEnumNames
|
|
<T extends EnumType, TEnumValue extends EnumType>(
|
|
enumVariable: EnumVariable<T, TEnumValue>,
|
|
): string[] {
|
|
return Object
|
|
.values(enumVariable)
|
|
.filter((enumMember): enumMember is string => isString(enumMember));
|
|
}
|
|
|
|
export function getEnumValues<T extends EnumType, TEnumValue extends EnumType>(
|
|
enumVariable: EnumVariable<T, TEnumValue>,
|
|
): TEnumValue[] {
|
|
return getEnumNames(enumVariable)
|
|
.map((level) => enumVariable[level]) as TEnumValue[];
|
|
}
|
|
|
|
export function assertInRange<T extends EnumType, TEnumValue extends EnumType>(
|
|
value: TEnumValue,
|
|
enumVariable: EnumVariable<T, TEnumValue>,
|
|
) {
|
|
if (!(value in enumVariable)) {
|
|
throw new RangeError(`enum value "${value}" is out of range`);
|
|
}
|
|
}
|