@planning-inspectorate/data-model 1.11.0

package/src/index.d.ts

@@ -0,0 +1,18 @@
+import * as Schemas from './schemas';
+export * from './enums';
+
+export interface LoadedSchemas {
+	schemas: {
+		[name: string]: any;
+	};
+	commands: {
+		[name: string]: any;
+	};
+}
+
+export const schemasPath: string;
+export const commandsPath: string;
+export function loadAllSchemas(): Promise<LoadedSchemas>;
+export function loadAllSchemasSync(): LoadedSchemas;
+
+export { Schemas };

package/src/index.js

@@ -0,0 +1,34 @@
+import path from 'path';
+import url from 'url';
+import { loadSchemas, loadSchemasSync } from './lib/load.js';
+
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+
+export * from './enums.js';
+
+export const schemasPath = path.join(__dirname, '..', 'schemas');
+export const commandsPath = path.join(schemasPath, 'commands');
+
+/**
+ * Load all schemas from schemas and commands folders
+ *
+ * @returns {Promise<import('./index.js').LoadedSchemas>}
+ */
+export async function loadAllSchemas() {
+	return {
+		schemas: await loadSchemas(schemasPath),
+		commands: await loadSchemas(commandsPath)
+	};
+}
+
+/**
+ * Load all schemas from schemas and commands folders
+ *
+ * @returns {import('./index.js').LoadedSchemas}
+ */
+export function loadAllSchemasSync() {
+	return {
+		schemas: loadSchemasSync(schemasPath),
+		commands: loadSchemasSync(commandsPath)
+	};
+}

package/src/lib/load.js

@@ -0,0 +1,78 @@
+import { readFile, readdir } from 'fs/promises';
+import { readFileSync, readdirSync } from 'fs';
+import { parse } from 'jsonc-parser';
+import path from 'path';
+
+/**
+ * Load all schemas from a directory and return a map of schema name to parsed schema object.
+ *
+ * @param {string} dirPath
+ * @returns {Promise<Object<string,any>>}
+ */
+export async function loadSchemas(dirPath) {
+	const entries = await readdir(dirPath);
+	const schemaFiles = entries.filter(isSchemaFile);
+
+	/** @type {Object<string,any>} */
+	const schemaMap = {};
+	await Promise.all(
+		schemaFiles.map(async (filePath) => {
+			schemaMap[path.basename(filePath)] = await loadSchema(path.join(dirPath, filePath));
+		})
+	);
+	return schemaMap;
+}
+
+/**
+ * Load the schema file and parse it.
+ *
+ * @param {string} filePath
+ * @returns {Promise<any>}
+ */
+async function loadSchema(filePath) {
+	const content = await readFile(filePath);
+	return parse(content.toString());
+}
+
+/**
+ * Does this file path have a schema extension?
+ *
+ * @param {string} filePath
+ * @returns {boolean}
+ */
+function isSchemaFile(filePath) {
+	const fileName = path.basename(filePath);
+	return fileName.endsWith('schema.jsonc') || fileName.endsWith('schema.json');
+}
+
+/**
+ * Load all schemas from a directory and return a map of schema name to parsed schema object.
+ *
+ * @param {string} dirPath
+ * @returns {Object<string,any>}
+ */
+export function loadSchemasSync(dirPath) {
+	const entries = readdirSync(dirPath);
+	const schemaFiles = entries.filter(isSchemaFile);
+
+	/** @type {Object<string,any>} */
+	const initialSchemaMap = {};
+
+	return schemaFiles.reduce((acc, filePath) => {
+		return {
+			...acc,
+			[path.basename(filePath)]: loadSchemaSync(path.join(dirPath, filePath))
+		};
+	}, initialSchemaMap);
+}
+
+/**
+ * Load the schema file and parse it.
+ *
+ * @param {string} filePath
+ * @returns {any}
+ */
+function loadSchemaSync(filePath) {
+	const content = readFileSync(filePath);
+	return parse(content.toString());
+}