@springfield/ham-radio-utils 4.1.2 → 4.2.0

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

@@ -0,0 +1,151 @@
+{
+  "$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"
+      }
+    }
+  },
+  "definitions": {
+    "seek": {
+      "oneOf": [
+        { "type": "integer", "minimum": 0 },
+        { "type": "string", "pattern": "^(0[xX][0-9a-fA-F]+|[0-9]+)$" }
+      ]
+    },
+    "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
+        }
+      ]
+    },
+    "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 }
+      },
+      "additionalProperties": false
+    }
+  }
+}

package/dist/utils/schema-validator.d.ts

@@ -6,5 +6,7 @@ export declare class SchemaValidator {
     private ajv;
     constructor();
     validateRadioProtocol(config: unknown): ValidationResult;
+    validateMemoryMap(memoryMap: unknown): ValidationResult;
+    private validateAgainst;
 }
 //# sourceMappingURL=schema-validator.d.ts.map

package/dist/utils/schema-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema-validator.d.ts","sourceRoot":"","sources":["../../src/utils/schema-validator.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAOD,qBAAa,eAAe;IAC1B,OAAO,CAAC,GAAG,CAAM;IAEjB,cAMC;IAED,qBAAqB,CAAC,MAAM,EAAE,OAAO,GAAG,gBAAgB,CAoBvD;CACF"}
+{"version":3,"file":"schema-validator.d.ts","sourceRoot":"","sources":["../../src/utils/schema-validator.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAOD,qBAAa,eAAe;IAC1B,OAAO,CAAC,GAAG,CAAM;IAEjB,cAMC;IAED,qBAAqB,CAAC,MAAM,EAAE,OAAO,GAAG,gBAAgB,CAEvD;IAED,iBAAiB,CAAC,SAAS,EAAE,OAAO,GAAG,gBAAgB,CAEtD;IAED,OAAO,CAAC,eAAe;CAqBxB"}

package/dist/utils/schema-validator.js

@@ -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 class SchemaValidator {
     ajv;
     constructor() {
@@ -11,8 +12,14 @@ export class SchemaValidator {
         addFormats(this.ajv);
     }
     validateRadioProtocol(config) {
-        const validate = this.ajv.compile(radioProtocolSchema);
-        const valid = validate(config);
+        return this.validateAgainst(radioProtocolSchema, config);
+    }
+    validateMemoryMap(memoryMap) {
+        return this.validateAgainst(radioMemoryMapSchema, memoryMap);
+    }
+    validateAgainst(schema, data) {
+        const validate = this.ajv.compile(schema);
+        const valid = validate(data);
         if (valid) {
             return { valid: true };
         }

package/dist/utils/schema-validator.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema-validator.js","sourceRoot":"","sources":["../../src/utils/schema-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAC1B,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,mBAAmB,MAAM,uCAAuC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAY9F,MAAM,OAAO,eAAe;IAClB,GAAG,CAAM;IAEjB;QACE,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC;YACjB,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;QACF,UAA2C,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzD,CAAC;IAED,qBAAqB,CAAC,MAAe;QACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QACvD,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;QAE/B,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACzB,CAAC;QAED,IAAI,MAAM,GAAa,EAAE,CAAC;QAC1B,IAAI,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClD,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAe,EAAE,EAAE;gBAC/C,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,IAAI,MAAM,CAAC;gBAC1C,OAAO,GAAG,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;YACrC,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO;YACL,MAAM;YACN,KAAK,EAAE,KAAK;SACb,CAAC;IACJ,CAAC;CACF","sourcesContent":["import { Ajv } from 'ajv';\nimport addFormats from 'ajv-formats';\nimport radioProtocolSchema from '../schemas/radio-protocol-schema.json' with { type: 'json' };\n\nexport interface ValidationResult {\n  valid: boolean;\n  errors?: string[];\n}\n\ninterface AjvError {\n  instancePath?: string;\n  message?: string;\n}\n\nexport class SchemaValidator {\n  private ajv: Ajv;\n\n  constructor() {\n    this.ajv = new Ajv({\n      allErrors: true,\n      verbose: true,\n    });\n    (addFormats as unknown as (ajv: Ajv) => Ajv)(this.ajv);\n  }\n\n  validateRadioProtocol(config: unknown): ValidationResult {\n    const validate = this.ajv.compile(radioProtocolSchema);\n    const valid = validate(config);\n\n    if (valid) {\n      return { valid: true };\n    }\n\n    let errors: string[] = [];\n    if (validate.errors && validate.errors.length > 0) {\n      errors = validate.errors.map((error: AjvError) => {\n        const path = error.instancePath || 'root';\n        return `${path}: ${error.message}`;\n      });\n    }\n\n    return {\n      errors,\n      valid: false,\n    };\n  }\n}\n"]}
+{"version":3,"file":"schema-validator.js","sourceRoot":"","sources":["../../src/utils/schema-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAC1B,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,mBAAmB,MAAM,uCAAuC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAC9F,OAAO,oBAAoB,MAAM,yCAAyC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAYjG,MAAM,OAAO,eAAe;IAClB,GAAG,CAAM;IAEjB;QACE,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC;YACjB,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;QACF,UAA2C,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzD,CAAC;IAED,qBAAqB,CAAC,MAAe;QACnC,OAAO,IAAI,CAAC,eAAe,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED,iBAAiB,CAAC,SAAkB;QAClC,OAAO,IAAI,CAAC,eAAe,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC;IAEO,eAAe,CAAC,MAAc,EAAE,IAAa;QACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1C,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE7B,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACzB,CAAC;QAED,IAAI,MAAM,GAAa,EAAE,CAAC;QAC1B,IAAI,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClD,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAe,EAAE,EAAE;gBAC/C,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,IAAI,MAAM,CAAC;gBAC1C,OAAO,GAAG,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;YACrC,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO;YACL,MAAM;YACN,KAAK,EAAE,KAAK;SACb,CAAC;IACJ,CAAC;CACF","sourcesContent":["import { Ajv } from 'ajv';\nimport addFormats from 'ajv-formats';\nimport radioProtocolSchema from '../schemas/radio-protocol-schema.json' with { type: 'json' };\nimport radioMemoryMapSchema from '../schemas/radio-memory-map-schema.json' with { type: 'json' };\n\nexport interface ValidationResult {\n  valid: boolean;\n  errors?: string[];\n}\n\ninterface AjvError {\n  instancePath?: string;\n  message?: string;\n}\n\nexport class SchemaValidator {\n  private ajv: Ajv;\n\n  constructor() {\n    this.ajv = new Ajv({\n      allErrors: true,\n      verbose: true,\n    });\n    (addFormats as unknown as (ajv: Ajv) => Ajv)(this.ajv);\n  }\n\n  validateRadioProtocol(config: unknown): ValidationResult {\n    return this.validateAgainst(radioProtocolSchema, config);\n  }\n\n  validateMemoryMap(memoryMap: unknown): ValidationResult {\n    return this.validateAgainst(radioMemoryMapSchema, memoryMap);\n  }\n\n  private validateAgainst(schema: object, data: unknown): ValidationResult {\n    const validate = this.ajv.compile(schema);\n    const valid = validate(data);\n\n    if (valid) {\n      return { valid: true };\n    }\n\n    let errors: string[] = [];\n    if (validate.errors && validate.errors.length > 0) {\n      errors = validate.errors.map((error: AjvError) => {\n        const path = error.instancePath || 'root';\n        return `${path}: ${error.message}`;\n      });\n    }\n\n    return {\n      errors,\n      valid: false,\n    };\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@springfield/ham-radio-utils",
-  "version": "4.1.2",
+  "version": "4.2.0",
   "author": "Bryan Hunt",
   "license": "MIT",
   "readme": "README.md",
@@ -30,7 +30,7 @@
     "test:unit": "tsx --test test/unit/**/*.test.ts"
   },
   "dependencies": {
-    "@springfield/ham-radio-api": "^17.0.0",
+    "@springfield/ham-radio-api": "^17.1.0",
     "ajv": "^8.20.0",
     "ajv-formats": "^3.0.1",
     "fishery": "^2.4.0",

package/src/index.ts

@@ -1,4 +1,6 @@
 export * from './memory/segmented-memory.js';
+export * from './memory/memory-map-codec.js';
+export * from './memory/memory-map-ui.js';
 
 export * from './test-utils/radio-channel-factory.js';
 export * from './test-utils/radio-programmed-channel-factory.js';
@@ -15,3 +17,4 @@ export * from './utils/ui-logger-factory.js';
 
 // Export the radio protocol schema
 export { default as radioProtocolSchema } from './schemas/radio-protocol-schema.json' with { type: 'json' };
+export { default as radioMemoryMapSchema } from './schemas/radio-memory-map-schema.json' with { type: 'json' };