inventoresed/packages/config/src/Manufacturers.ts

Z-Wave driver written entirely in JavaScript/TypeScript

import { isZWaveError, ZWaveError, ZWaveErrorCodes } from "@zwave-js/core";
import { formatId, stringify } from "@zwave-js/shared";
import { isObject } from "alcalzone-shared/typeguards";
import { pathExists, readFile, writeFile } from "fs-extra";
import JSON5 from "json5";
import path from "path";
import { configDir, externalConfigDir } from "./utils";
import { hexKeyRegex4Digits, throwInvalidConfig } from "./utils_safe";

export type ManufacturersMap = Map<number, string>;

/** @internal */
export async function loadManufacturersInternal(
	externalConfig?: boolean,
): Promise<ManufacturersMap> {
	const configPath = path.join(
		(externalConfig && externalConfigDir()) || configDir,
		"manufacturers.json",
	);

	if (!(await pathExists(configPath))) {
		throw new ZWaveError(
			"The manufacturer config file does not exist!",
			ZWaveErrorCodes.Config_Invalid,
		);
	}
	try {
		const fileContents = await readFile(configPath, "utf8");
		const definition = JSON5.parse(fileContents);
		if (!isObject(definition)) {
			throwInvalidConfig(
				"manufacturers",
				`the database is not an object!`,
			);
		}

		const manufacturers = new Map();
		for (const [id, name] of Object.entries(definition)) {
			if (!hexKeyRegex4Digits.test(id)) {
				throwInvalidConfig(
					"manufacturers",
					`found invalid key ${id} at the root level. Manufacturer IDs must be hexadecimal lowercase.`,
				);
			}
			if (typeof name !== "string") {
				throwInvalidConfig(
					"manufacturers",
					`Key ${id} has a non-string manufacturer name`,
				);
			}
			const idNum = parseInt(id.slice(2), 16);
			manufacturers.set(idNum, name);
		}

		return manufacturers;
	} catch (e) {
		if (isZWaveError(e)) {
			throw e;
		} else {
			throwInvalidConfig("manufacturers");
		}
	}
}

/**
 * Write current manufacturers map to json
 */
export async function saveManufacturersInternal(
	manufacturers: ManufacturersMap,
): Promise<void> {
	const data: Record<string, string> = {};

	const orderedMap = new Map(
		[...manufacturers].sort((a, b) => (a[0] > b[0] ? 1 : -1)),
	);

	for (const [id, name] of orderedMap) {
		data[formatId(id)] = name;
	}

	const configPath = path.join(configDir, "manufacturers.json");
	await writeFile(configPath, stringify(data, "\t") + "\n");
}