@springfield/ham-radio-utils 4.9.0 → 4.10.0

package/dist/schemas/radio-protocol-schema.json

@@ -78,10 +78,21 @@
       "properties": {
         "baudRate": {
           "type": "integer",
-          "description": "Serial baud rate",
+          "description": "Default serial baud rate used to open the programming port. Must be included in baudRates when that list is present.",
           "minimum": 1200,
           "maximum": 115200
         },
+        "baudRates": {
+          "type": "array",
+          "description": "Baud rates the radio programming port accepts. Omit when only baudRate is valid. The HamBench import and write dialogs show a selector when more than one value is listed.",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "type": "integer",
+            "minimum": 1200,
+            "maximum": 115200
+          }
+        },
         "dataBits": {
           "type": "integer",
           "description": "Number of data bits",

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":"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"}
+{"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,CAiBvD;IAED,iBAAiB,CAAC,SAAS,EAAE,OAAO,GAAG,gBAAgB,CAEtD;IAED,OAAO,CAAC,eAAe;CAsBxB"}

package/dist/utils/schema-validator.js

@@ -12,7 +12,18 @@ export class SchemaValidator {
         addFormats(this.ajv);
     }
     validateRadioProtocol(config) {
-        return this.validateAgainst(radioProtocolSchema, config);
+        const schemaResult = this.validateAgainst(radioProtocolSchema, config);
+        if (!schemaResult.valid) {
+            return schemaResult;
+        }
+        const baudRateErrors = baudRateMembershipErrors(config);
+        if (baudRateErrors.length === 0) {
+            return schemaResult;
+        }
+        return {
+            valid: false,
+            errors: baudRateErrors,
+        };
     }
     validateMemoryMap(memoryMap) {
         return this.validateAgainst(radioMemoryMapSchema, memoryMap);
@@ -36,4 +47,26 @@ export class SchemaValidator {
         };
     }
 }
+function isRecord(value) {
+    return value !== null && typeof value === 'object' && !Array.isArray(value);
+}
+/**
+ * `baudRate` is the default open speed. When a radio lists `baudRates`, that
+ * default must be one of the accepted values so the UI can preselect it.
+ */
+function baudRateMembershipErrors(config) {
+    if (!isRecord(config) || !isRecord(config.serialConfig)) {
+        return [];
+    }
+    const serialConfig = config.serialConfig;
+    const baudRate = serialConfig.baudRate;
+    const baudRates = serialConfig.baudRates;
+    if (!Array.isArray(baudRates) || typeof baudRate !== 'number') {
+        return [];
+    }
+    if (baudRates.includes(baudRate)) {
+        return [];
+    }
+    return ['/serialConfig/baudRate: must be included in baudRates'];
+}
 //# sourceMappingURL=schema-validator.js.map

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;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"]}
+{"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,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;QAEvE,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;YACxB,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,MAAM,cAAc,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAExD,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,cAAc;SACvB,CAAC;IACJ,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;QAE1B,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;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED;;;GAGG;AACH,SAAS,wBAAwB,CAAC,MAAe;IAC/C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;QACxD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;IACzC,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC;IACvC,MAAM,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC;IAEzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC9D,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,CAAC,uDAAuD,CAAC,CAAC;AACnE,CAAC","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    const schemaResult = this.validateAgainst(radioProtocolSchema, config);\n\n    if (!schemaResult.valid) {\n      return schemaResult;\n    }\n\n    const baudRateErrors = baudRateMembershipErrors(config);\n\n    if (baudRateErrors.length === 0) {\n      return schemaResult;\n    }\n\n    return {\n      valid: false,\n      errors: baudRateErrors,\n    };\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\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\nfunction isRecord(value: unknown): value is Record<string, unknown> {\n  return value !== null && typeof value === 'object' && !Array.isArray(value);\n}\n\n/**\n * `baudRate` is the default open speed. When a radio lists `baudRates`, that\n * default must be one of the accepted values so the UI can preselect it.\n */\nfunction baudRateMembershipErrors(config: unknown): string[] {\n  if (!isRecord(config) || !isRecord(config.serialConfig)) {\n    return [];\n  }\n\n  const serialConfig = config.serialConfig;\n  const baudRate = serialConfig.baudRate;\n  const baudRates = serialConfig.baudRates;\n\n  if (!Array.isArray(baudRates) || typeof baudRate !== 'number') {\n    return [];\n  }\n\n  if (baudRates.includes(baudRate)) {\n    return [];\n  }\n\n  return ['/serialConfig/baudRate: must be included in baudRates'];\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@springfield/ham-radio-utils",
-  "version": "4.9.0",
+  "version": "4.10.0",
   "author": "Bryan Hunt",
   "license": "MIT",
   "readme": "README.md",

package/src/schemas/radio-protocol-schema.json

@@ -78,10 +78,21 @@
       "properties": {
         "baudRate": {
           "type": "integer",
-          "description": "Serial baud rate",
+          "description": "Default serial baud rate used to open the programming port. Must be included in baudRates when that list is present.",
           "minimum": 1200,
           "maximum": 115200
         },
+        "baudRates": {
+          "type": "array",
+          "description": "Baud rates the radio programming port accepts. Omit when only baudRate is valid. The HamBench import and write dialogs show a selector when more than one value is listed.",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "type": "integer",
+            "minimum": 1200,
+            "maximum": 115200
+          }
+        },
         "dataBits": {
           "type": "integer",
           "description": "Number of data bits",

package/src/utils/schema-validator.ts

@@ -25,7 +25,22 @@ export class SchemaValidator {
   }
 
   validateRadioProtocol(config: unknown): ValidationResult {
-    return this.validateAgainst(radioProtocolSchema, config);
+    const schemaResult = this.validateAgainst(radioProtocolSchema, config);
+
+    if (!schemaResult.valid) {
+      return schemaResult;
+    }
+
+    const baudRateErrors = baudRateMembershipErrors(config);
+
+    if (baudRateErrors.length === 0) {
+      return schemaResult;
+    }
+
+    return {
+      valid: false,
+      errors: baudRateErrors,
+    };
   }
 
   validateMemoryMap(memoryMap: unknown): ValidationResult {
@@ -41,6 +56,7 @@ export class SchemaValidator {
     }
 
     let errors: string[] = [];
+
     if (validate.errors && validate.errors.length > 0) {
       errors = validate.errors.map((error: AjvError) => {
         const path = error.instancePath || 'root';
@@ -54,3 +70,31 @@ export class SchemaValidator {
     };
   }
 }
+
+function isRecord(value: unknown): value is Record<string, unknown> {
+  return value !== null && typeof value === 'object' && !Array.isArray(value);
+}
+
+/**
+ * `baudRate` is the default open speed. When a radio lists `baudRates`, that
+ * default must be one of the accepted values so the UI can preselect it.
+ */
+function baudRateMembershipErrors(config: unknown): string[] {
+  if (!isRecord(config) || !isRecord(config.serialConfig)) {
+    return [];
+  }
+
+  const serialConfig = config.serialConfig;
+  const baudRate = serialConfig.baudRate;
+  const baudRates = serialConfig.baudRates;
+
+  if (!Array.isArray(baudRates) || typeof baudRate !== 'number') {
+    return [];
+  }
+
+  if (baudRates.includes(baudRate)) {
+    return [];
+  }
+
+  return ['/serialConfig/baudRate: must be included in baudRates'];
+}