@springfield/ham-radio-utils 4.1.2 → 4.3.0

package/src/memory/memory-map-ui.ts

@@ -0,0 +1,84 @@
+import type { RadioMemoryMap, RadioMemoryMapFieldUi, RadioMemoryMapValueKind } from '@springfield/ham-radio-api';
+
+/**
+ * Flattened field descriptor for schema-driven settings UI.
+ */
+export interface RadioMemoryMapUiField {
+  /** Dot path into decoded settings, e.g. settings.squelch or pttid.0.code */
+  path: string;
+  structId: string;
+  fieldId: string;
+  arrayIndex?: number;
+  ui: RadioMemoryMapFieldUi;
+  value?: RadioMemoryMapValueKind;
+}
+
+/**
+ * Collect writable UI fields from a memory map, in declaration order.
+ */
+export function collectMemoryMapUiFields(memoryMap: RadioMemoryMap): RadioMemoryMapUiField[] {
+  const fields: RadioMemoryMapUiField[] = [];
+  const channelStructIds = new Set<string>();
+
+  if (memoryMap.channelBindings) {
+    channelStructIds.add(memoryMap.channelBindings.records);
+
+    if (memoryMap.channelBindings.names) {
+      channelStructIds.add(memoryMap.channelBindings.names);
+    }
+  }
+
+  for (const struct of memoryMap.structs) {
+    if (channelStructIds.has(struct.id)) {
+      continue;
+    }
+
+    const count = struct.count ?? 1;
+
+    for (let index = 0; index < count; index += 1) {
+      for (const field of struct.fields) {
+        if (field.reserved || !field.ui) {
+          continue;
+        }
+
+        const path =
+          count > 1 ? `${struct.id}.${index}.${field.id}` : `${struct.id}.${field.id}`;
+
+        const label =
+          count > 1 && field.ui.label.indexOf('%') === -1
+            ? `${field.ui.label} ${index + 1}`
+            : field.ui.label;
+
+        fields.push({
+          path,
+          structId: struct.id,
+          fieldId: field.id,
+          arrayIndex: count > 1 ? index : undefined,
+          ui: { ...field.ui, label },
+          value: field.value,
+        });
+      }
+    }
+  }
+
+  return fields;
+}
+
+/**
+ * Group UI fields by their ui.group key, preserving first-seen group order.
+ */
+export function groupMemoryMapUiFields(fields: RadioMemoryMapUiField[]): Map<string, RadioMemoryMapUiField[]> {
+  const groups = new Map<string, RadioMemoryMapUiField[]>();
+
+  for (const field of fields) {
+    const existing = groups.get(field.ui.group);
+
+    if (existing) {
+      existing.push(field);
+    } else {
+      groups.set(field.ui.group, [field]);
+    }
+  }
+
+  return groups;
+}

package/src/schemas/radio-memory-map-schema.json

@@ -0,0 +1,203 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Radio Memory-Map DSL Schema",
+  "description": "Schema for defining radio EEPROM settings layout as JSON (Chirp MEM_FORMAT as data)",
+  "type": "object",
+  "required": ["structs"],
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "Optional map version"
+    },
+    "description": {
+      "type": "string"
+    },
+    "structs": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/definitions/struct"
+      }
+    },
+    "channelBindings": {
+      "$ref": "#/definitions/channelBindings"
+    }
+  },
+  "definitions": {
+    "seek": {
+      "oneOf": [
+        { "type": "integer", "minimum": 0 },
+        { "type": "string", "pattern": "^(0[xX][0-9a-fA-F]+|[0-9]+)$" }
+      ]
+    },
+    "channelBindings": {
+      "type": "object",
+      "required": ["records", "receiveFrequency", "transmitFrequency", "receiveTone", "transmitTone"],
+      "properties": {
+        "records": { "type": "string", "minLength": 1 },
+        "names": { "type": "string", "minLength": 1 },
+        "nameField": { "type": "string", "minLength": 1 },
+        "receiveFrequency": { "type": "string", "minLength": 1 },
+        "transmitFrequency": { "type": "string", "minLength": 1 },
+        "receiveTone": { "type": "string", "minLength": 1 },
+        "transmitTone": { "type": "string", "minLength": 1 }
+      },
+      "additionalProperties": false
+    },
+    "emptyWhen": {
+      "type": "object",
+      "required": ["equals"],
+      "properties": {
+        "equals": { "type": "integer", "minimum": 0, "maximum": 255 }
+      },
+      "additionalProperties": false
+    },
+    "ui": {
+      "type": "object",
+      "required": ["group", "label", "widget"],
+      "properties": {
+        "group": { "type": "string" },
+        "label": { "type": "string" },
+        "widget": {
+          "type": "string",
+          "enum": ["integer", "select", "switch", "text", "number"]
+        },
+        "description": { "type": "string" },
+        "writable": { "type": "boolean" }
+      },
+      "additionalProperties": false
+    },
+    "value": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": ["kind"],
+          "properties": {
+            "kind": { "const": "integer" },
+            "min": { "type": "number" },
+            "max": { "type": "number" }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["kind"],
+          "properties": {
+            "kind": { "const": "boolean" }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["kind", "values"],
+          "properties": {
+            "kind": { "const": "enum" },
+            "values": {
+              "type": "array",
+              "items": { "type": "string" },
+              "minItems": 1
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["kind", "length"],
+          "properties": {
+            "kind": { "const": "ascii" },
+            "length": { "type": "integer", "minimum": 1 }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["kind", "length"],
+          "properties": {
+            "kind": { "const": "digits" },
+            "length": { "type": "integer", "minimum": 1 },
+            "scale": { "type": "number" }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["kind", "length"],
+          "properties": {
+            "kind": { "const": "dtmf" },
+            "length": { "type": "integer", "minimum": 1 },
+            "charset": { "type": "string" }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["kind", "length"],
+          "properties": {
+            "kind": { "const": "bbcd" },
+            "length": { "type": "integer", "minimum": 1 }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["kind", "length"],
+          "properties": {
+            "kind": { "const": "lbcd" },
+            "length": { "type": "integer", "minimum": 1 },
+            "scale": { "type": "number" }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["kind", "values"],
+          "properties": {
+            "kind": { "const": "tone" },
+            "values": {
+              "type": "array",
+              "items": { "type": "integer" },
+              "minItems": 1
+            },
+            "ctcssMin": { "type": "integer" },
+            "reverseOffset": { "type": "integer" }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "field": {
+      "type": "object",
+      "required": ["id", "type"],
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "type": {
+          "type": "string",
+          "enum": ["u8", "u16", "bits", "char"]
+        },
+        "width": { "type": "integer", "minimum": 1, "maximum": 8 },
+        "reserved": { "type": "boolean" },
+        "value": { "$ref": "#/definitions/value" },
+        "ui": { "$ref": "#/definitions/ui" }
+      },
+      "additionalProperties": false
+    },
+    "struct": {
+      "type": "object",
+      "required": ["id", "seek", "fields"],
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "seek": { "$ref": "#/definitions/seek" },
+        "fields": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/definitions/field" }
+        },
+        "count": { "type": "integer", "minimum": 1 },
+        "stride": { "type": "integer", "minimum": 1 },
+        "emptyWhen": { "$ref": "#/definitions/emptyWhen" },
+        "clearEmpty": { "type": "boolean" }
+      },
+      "additionalProperties": false
+    }
+  }
+}

package/src/utils/schema-validator.ts

@@ -1,6 +1,7 @@
 import { Ajv } from 'ajv';
 import addFormats from 'ajv-formats';
 import radioProtocolSchema from '../schemas/radio-protocol-schema.json' with { type: 'json' };
+import radioMemoryMapSchema from '../schemas/radio-memory-map-schema.json' with { type: 'json' };
 
 export interface ValidationResult {
   valid: boolean;
@@ -24,8 +25,16 @@ export class SchemaValidator {
   }
 
   validateRadioProtocol(config: unknown): ValidationResult {
-    const validate = this.ajv.compile(radioProtocolSchema);
-    const valid = validate(config);
+    return this.validateAgainst(radioProtocolSchema, config);
+  }
+
+  validateMemoryMap(memoryMap: unknown): ValidationResult {
+    return this.validateAgainst(radioMemoryMapSchema, memoryMap);
+  }
+
+  private validateAgainst(schema: object, data: unknown): ValidationResult {
+    const validate = this.ajv.compile(schema);
+    const valid = validate(data);
 
     if (valid) {
       return { valid: true };