move schema to json, use function for type mapping

Author: avivkeller

src/generators/node-config-schema/constants.mjs

@@ -3,9 +3,8 @@ export const ERRORS = {
   missingCCandHFiles:
     'Both node_options.cc and node_options.h must be provided.',
   headerTypeNotFound:
-    'Header type for "{{headerKey}}" not found in the header file.',
-  missingTypeDefinition:
-    'No type definition found for header type "{{headerType}}" in TYPE_DEFINITION_MAP.',
+    'A type for "{{headerKey}}" not found in the header file.',
+  missingTypeDefinition: 'No type schema found for "{{type}}".',
 };
 
 // Regex pattern to match calls to the AddOption function.
@@ -14,38 +13,3 @@ export const ADD_OPTION_REGEX =
 
 // Regex pattern to match header keys in the Options class.
 export const OPTION_HEADER_KEY_REGEX = /Options::(\w+)/;
-
-// Basic JSON schema for node.config.json
-export const BASIC_SCHEMA = {
-  $schema: 'https://json-schema.org/draft/2020-12/schema',
-  additionalProperties: false,
-  properties: {
-    $schema: {
-      type: 'string',
-    },
-    nodeOptions: {
-      additionalProperties: false,
-      properties: {},
-      type: 'object',
-    },
-  },
-  type: 'object',
-};
-
-// Schema Definition Map for Data Types
-export const TYPE_DEFINITION_MAP = {
-  'std::vector<std::string>': {
-    oneOf: [
-      { type: 'string' }, // Single string case
-      {
-        items: { type: 'string', minItems: 1 }, // Array of strings, ensuring at least one item
-        type: 'array',
-      },
-    ],
-  },
-  uint64_t: { type: 'number' }, // 64-bit unsigned integer maps to a number
-  int64_t: { type: 'number' }, // 64-bit signed integer maps to a number
-  HostPort: { type: 'number' }, // HostPort is a number, like 4000
-  'std::string': { type: 'string' }, // String type
-  bool: { type: 'boolean' }, // Boolean type
-};

src/generators/node-config-schema/index.mjs

@@ -2,9 +2,7 @@ import { readFile, writeFile } from 'node:fs/promises';
 import {
   ERRORS,
   ADD_OPTION_REGEX,
-  BASIC_SCHEMA,
   OPTION_HEADER_KEY_REGEX,
-  TYPE_DEFINITION_MAP,
 } from './constants.mjs';
 import { join } from 'node:path';
 
@@ -48,10 +46,10 @@ export default {
     // Read the contents of the cc and h files
     const ccContent = await readFile(ccFile, 'utf-8');
     const hContent = await readFile(hFile, 'utf-8');
+    const schema = JSON.parse(
+      await readFile(new URL('./schema.json', import.meta.url))
+    );
 
-    // Clone the BASIC_SCHEMA to avoid mutating the original schema object
-    /** @type {typeof BASIC_SCHEMA} */
-    const schema = Object.assign({}, BASIC_SCHEMA);
     const { nodeOptions } = schema.properties;
 
     // Process the cc content and match AddOption calls
@@ -78,18 +76,10 @@ export default {
         );
       }
 
-      const headerType = headerTypeMatch[1].trim();
-
-      // Ensure the headerType exists in the TYPE_DEFINITION_MAP
-      const typeDefinition = TYPE_DEFINITION_MAP[headerType];
-      if (!typeDefinition) {
-        throw new Error(
-          formatErrorMessage(ERRORS.missingTypeDefinition, { headerType })
-        );
-      }
-
       // Add the option to the schema after removing the '--' prefix
-      nodeOptions.properties[option.replace('--', '')] = typeDefinition;
+      nodeOptions.properties[option.replace('--', '')] = getTypeSchema(
+        headerTypeMatch[1].trim()
+      );
     }
 
     nodeOptions.properties = Object.fromEntries(
@@ -116,3 +106,37 @@ export default {
 function formatErrorMessage(message, params) {
   return message.replace(/{{(\w+)}}/g, (_, key) => params[key] || `{{${key}}}`);
 }
+
+/**
+ * Returns the JSON Schema definition for a given C++ type.
+ *
+ * @param {string} type - The type to get the schema for.
+ * @returns {object} JSON Schema definition for the given type.
+ */
+function getTypeSchema(type) {
+  switch (type) {
+    case 'std::vector<std::string>':
+      return {
+        oneOf: [
+          { type: 'string' },
+          {
+            type: 'array',
+            items: { type: 'string' },
+            minItems: 1,
+          },
+        ],
+      };
+    case 'uint64_t':
+    case 'int64_t':
+    case 'HostPort':
+      return { type: 'number' };
+    case 'std::string':
+      return { type: 'string' };
+    case 'bool':
+      return { type: 'boolean' };
+    default:
+      throw new Error(
+        formatErrorMessage(ERRORS.missingTypeDefinition, { type })
+      );
+  }
+}

src/generators/node-config-schema/schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "nodeOptions": {
+      "additionalProperties": false,
+      "properties": {},
+      "type": "object"
+    }
+  },
+  "type": "object"
+}