@chipmobilesdk/rn-i18n 0.1.2 → 0.2.0

package/src/format/units.ts

@@ -1,151 +1,139 @@
-import type {
-	InvalidFormatPolicy,
-	UnitDimension,
-	UnitId,
-} from '../config/types';
-import { applyInvalidFormatPolicy } from './invalid';
-import { formatNumberValue } from './number';
-
-interface UnitDefinition {
-	dimension: UnitDimension;
-	/** Factor to the dimension's base unit; unused for temperature. */
-	factor: number;
-	symbol: string;
-}
-
-/**
- * Package-owned unit registry and conversion tables. Intl.NumberFormat unit
- * style is not consistently available under Hermes, so the numeric part is
- * formatted through Intl and the unit symbol is appended from this registry
- * (research R4). Base units: meter, kilogram, liter, celsius.
- */
-const UNIT_REGISTRY: Record<UnitId, UnitDefinition> = {
-	millimeter: { dimension: 'length', factor: 0.001, symbol: 'mm' },
-	centimeter: { dimension: 'length', factor: 0.01, symbol: 'cm' },
-	meter: { dimension: 'length', factor: 1, symbol: 'm' },
-	kilometer: { dimension: 'length', factor: 1000, symbol: 'km' },
-	inch: { dimension: 'length', factor: 0.0254, symbol: 'in' },
-	foot: { dimension: 'length', factor: 0.3048, symbol: 'ft' },
-	mile: { dimension: 'length', factor: 1609.344, symbol: 'mi' },
-	gram: { dimension: 'mass', factor: 0.001, symbol: 'g' },
-	kilogram: { dimension: 'mass', factor: 1, symbol: 'kg' },
-	ounce: { dimension: 'mass', factor: 0.028349523125, symbol: 'oz' },
-	pound: { dimension: 'mass', factor: 0.45359237, symbol: 'lb' },
-	milliliter: { dimension: 'volume', factor: 0.001, symbol: 'ml' },
-	liter: { dimension: 'volume', factor: 1, symbol: 'l' },
-	gallon: { dimension: 'volume', factor: 3.785411784, symbol: 'gal' },
-	celsius: { dimension: 'temperature', factor: 1, symbol: '°C' },
-	fahrenheit: { dimension: 'temperature', factor: 1, symbol: '°F' },
-	kelvin: { dimension: 'temperature', factor: 1, symbol: 'K' },
-};
-
-export const SUPPORTED_UNITS = Object.keys(UNIT_REGISTRY) as readonly UnitId[];
-
-export const KNOWN_UNIT_IDS: ReadonlySet<string> = new Set(SUPPORTED_UNITS);
-
-export class UnitConversionError extends Error {
-	constructor(message: string) {
-		super(message);
-		this.name = 'UnitConversionError';
-	}
-}
-
-export function getUnitSymbol(unit: UnitId): string {
-	return UNIT_REGISTRY[unit].symbol;
-}
-
-function toCelsius(value: number, from: UnitId): number {
-	switch (from) {
-		case 'fahrenheit':
-			return ((value - 32) * 5) / 9;
-		case 'kelvin':
-			return value - 273.15;
-		default:
-			return value;
-	}
-}
-
-function fromCelsius(value: number, to: UnitId): number {
-	switch (to) {
-		case 'fahrenheit':
-			return (value * 9) / 5 + 32;
-		case 'kelvin':
-			return value + 273.15;
-		default:
-			return value;
-	}
-}
-
-/**
- * Converts between compatible supported units. Unknown units or conversions
- * across dimensions throw a UnitConversionError (FR-044/FR-045).
- */
-export function convertUnitValue(
-	value: number,
-	from: UnitId,
-	to: UnitId,
-): number {
-	const fromDef = UNIT_REGISTRY[from];
-	const toDef = UNIT_REGISTRY[to];
-	if (!fromDef || !toDef) {
-		throw new UnitConversionError(
-			`Unknown unit in conversion "${from}" -> "${to}".`,
-		);
-	}
-	if (fromDef.dimension !== toDef.dimension) {
-		throw new UnitConversionError(
-			`Cannot convert between incompatible dimensions "${fromDef.dimension}" (${from}) and "${toDef.dimension}" (${to}).`,
-		);
-	}
-	if (!Number.isFinite(value)) {
-		throw new UnitConversionError(
-			`Cannot convert invalid value "${String(value)}" from "${from}" to "${to}".`,
-		);
-	}
-	if (from === to) {
-		return value;
-	}
-	if (fromDef.dimension === 'temperature') {
-		return fromCelsius(toCelsius(value, from), to);
-	}
-	return (value * fromDef.factor) / toDef.factor;
-}
-
-export interface UnitFormatOptions extends Intl.NumberFormatOptions {
-	/** Unit the value is expressed in. Default: the locale's default unit. */
-	from?: UnitId;
-	/** Unit to display. Default: `from` (no conversion). */
-	to?: UnitId;
-}
-
-/**
- * Converts (when requested) and formats a measurement value: locale-aware
- * numeric part via Intl.NumberFormat plus the package-owned unit symbol.
- */
-export function formatUnitValue(
-	value: number,
-	localeCode: string,
-	localeDefaultUnit: UnitId,
-	numberDefaults: Intl.NumberFormatOptions,
-	options: UnitFormatOptions | undefined,
-	invalidFormat: InvalidFormatPolicy,
-): string {
-	const { from = localeDefaultUnit, to = from, ...numberOptions } = options ?? {};
-	let converted: number;
-	try {
-		converted = convertUnitValue(value, from, to);
-	} catch (error) {
-		return applyInvalidFormatPolicy(
-			invalidFormat,
-			error instanceof Error ? error.message : String(error),
-		);
-	}
-	const formatted = formatNumberValue(
-		converted,
-		localeCode,
-		numberDefaults,
-		numberOptions,
-		invalidFormat,
-	);
-	return `${formatted} ${getUnitSymbol(to)}`;
-}
+import type { InvalidFormatPolicy, UnitDimension, UnitId } from '../config/types';
+import { applyInvalidFormatPolicy } from './invalid';
+import { formatNumberValue } from './number';
+
+interface UnitDefinition {
+	dimension: UnitDimension;
+	/** Factor to the dimension's base unit; unused for temperature. */
+	factor: number;
+	symbol: string;
+}
+
+/**
+ * Package-owned unit registry and conversion tables. Intl.NumberFormat unit
+ * style is not consistently available under Hermes, so the numeric part is
+ * formatted through Intl and the unit symbol is appended from this registry
+ * (research R4). Base units: meter, kilogram, liter, celsius.
+ */
+const UNIT_REGISTRY: Record<UnitId, UnitDefinition> = {
+	millimeter: { dimension: 'length', factor: 0.001, symbol: 'mm' },
+	centimeter: { dimension: 'length', factor: 0.01, symbol: 'cm' },
+	meter: { dimension: 'length', factor: 1, symbol: 'm' },
+	kilometer: { dimension: 'length', factor: 1000, symbol: 'km' },
+	inch: { dimension: 'length', factor: 0.0254, symbol: 'in' },
+	foot: { dimension: 'length', factor: 0.3048, symbol: 'ft' },
+	mile: { dimension: 'length', factor: 1609.344, symbol: 'mi' },
+	gram: { dimension: 'mass', factor: 0.001, symbol: 'g' },
+	kilogram: { dimension: 'mass', factor: 1, symbol: 'kg' },
+	ounce: { dimension: 'mass', factor: 0.028349523125, symbol: 'oz' },
+	pound: { dimension: 'mass', factor: 0.45359237, symbol: 'lb' },
+	milliliter: { dimension: 'volume', factor: 0.001, symbol: 'ml' },
+	liter: { dimension: 'volume', factor: 1, symbol: 'l' },
+	gallon: { dimension: 'volume', factor: 3.785411784, symbol: 'gal' },
+	celsius: { dimension: 'temperature', factor: 1, symbol: '°C' },
+	fahrenheit: { dimension: 'temperature', factor: 1, symbol: '°F' },
+	kelvin: { dimension: 'temperature', factor: 1, symbol: 'K' },
+};
+
+export const SUPPORTED_UNITS = Object.keys(UNIT_REGISTRY) as readonly UnitId[];
+
+export const KNOWN_UNIT_IDS: ReadonlySet<string> = new Set(SUPPORTED_UNITS);
+
+// Kept importable from here for compatibility; the errors live in config/errors.ts.
+import { UnitConversionError } from '../config/errors';
+
+export { UnitConversionError };
+
+export function getUnitSymbol(unit: UnitId): string {
+	return UNIT_REGISTRY[unit].symbol;
+}
+
+function toCelsius(value: number, from: UnitId): number {
+	switch (from) {
+		case 'fahrenheit':
+			return ((value - 32) * 5) / 9;
+		case 'kelvin':
+			return value - 273.15;
+		default:
+			return value;
+	}
+}
+
+function fromCelsius(value: number, to: UnitId): number {
+	switch (to) {
+		case 'fahrenheit':
+			return (value * 9) / 5 + 32;
+		case 'kelvin':
+			return value + 273.15;
+		default:
+			return value;
+	}
+}
+
+/**
+ * Converts between compatible supported units. Unknown units or conversions
+ * across dimensions throw a UnitConversionError (FR-044/FR-045).
+ */
+export function convertUnitValue(value: number, from: UnitId, to: UnitId): number {
+	const fromDef = UNIT_REGISTRY[from];
+	const toDef = UNIT_REGISTRY[to];
+	if (!fromDef || !toDef) {
+		throw new UnitConversionError(`Unknown unit in conversion "${from}" -> "${to}".`);
+	}
+	if (fromDef.dimension !== toDef.dimension) {
+		throw new UnitConversionError(
+			`Cannot convert between incompatible dimensions "${fromDef.dimension}" (${from}) and "${toDef.dimension}" (${to}).`,
+		);
+	}
+	if (!Number.isFinite(value)) {
+		throw new UnitConversionError(
+			`Cannot convert invalid value "${String(value)}" from "${from}" to "${to}".`,
+		);
+	}
+	if (from === to) {
+		return value;
+	}
+	if (fromDef.dimension === 'temperature') {
+		return fromCelsius(toCelsius(value, from), to);
+	}
+	return (value * fromDef.factor) / toDef.factor;
+}
+
+export interface UnitFormatOptions extends Intl.NumberFormatOptions {
+	/** Unit the value is expressed in. Default: the locale's default unit. */
+	from?: UnitId;
+	/** Unit to display. Default: `from` (no conversion). */
+	to?: UnitId;
+}
+
+/**
+ * Converts (when requested) and formats a measurement value: locale-aware
+ * numeric part via Intl.NumberFormat plus the package-owned unit symbol.
+ */
+export function formatUnitValue(
+	value: number,
+	localeCode: string,
+	localeDefaultUnit: UnitId,
+	numberDefaults: Intl.NumberFormatOptions,
+	options: UnitFormatOptions | undefined,
+	invalidFormat: InvalidFormatPolicy,
+): string {
+	const { from = localeDefaultUnit, to = from, ...numberOptions } = options ?? {};
+	let converted: number;
+	try {
+		converted = convertUnitValue(value, from, to);
+	} catch (error) {
+		return applyInvalidFormatPolicy(
+			invalidFormat,
+			error instanceof Error ? error.message : String(error),
+		);
+	}
+	const formatted = formatNumberValue(
+		converted,
+		localeCode,
+		numberDefaults,
+		numberOptions,
+		invalidFormat,
+	);
+	return `${formatted} ${getUnitSymbol(to)}`;
+}