@springfield/ham-radio-api 16.0.0 → 16.1.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [16.1.0](https://gitlab.com/springfield-ham-radio/app/ham-radio-api/compare/v16.0.0...v16.1.0) (2025-06-23)
+
+
+### Features
+
+* add loglayer dependency and enhance radio module exports ([a8e5363](https://gitlab.com/springfield-ham-radio/app/ham-radio-api/commit/a8e5363f6ac40a0c2cb9fb4495d241776400cef9))
+
 ## [16.0.0](https://gitlab.com/springfield-ham-radio/app/ham-radio-api/compare/v15.0.0...v16.0.0) (2025-06-23)
 
 

package/dist/index.d.ts

@@ -10,6 +10,7 @@ export * from './branded-types/wavelength.js';
 export * from './license/class.js';
 export * from './radio/channel.js';
 export * from './radio/codec.js';
+export * from './radio/codec-factory.js';
 export * from './radio/connection.js';
 export * from './radio/ctcss.js';
 export * from './radio/dcs.js';
@@ -27,8 +28,10 @@ export * from './radio/protocol.js';
 export * from './radio/radio.js';
 export * from './radio/schema.js';
 export * from './radio/serial-config.js';
+export * from './radio/shared-components.js';
 export * from './radio/settings.js';
 export * from './radio/tone.js';
+export * from './radio/validation.js';
 export * from './spectrum/band.js';
 export * from './spectrum/channel.js';
 export * from './spectrum/mode.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,oBAAoB,CAAC;AAEnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAEhC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,oBAAoB,CAAC;AAEnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AAEtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC"}

package/dist/index.js

@@ -10,6 +10,7 @@ export * from './branded-types/wavelength.js';
 export * from './license/class.js';
 export * from './radio/channel.js';
 export * from './radio/codec.js';
+export * from './radio/codec-factory.js';
 export * from './radio/connection.js';
 export * from './radio/ctcss.js';
 export * from './radio/dcs.js';
@@ -27,8 +28,10 @@ export * from './radio/protocol.js';
 export * from './radio/radio.js';
 export * from './radio/schema.js';
 export * from './radio/serial-config.js';
+export * from './radio/shared-components.js';
 export * from './radio/settings.js';
 export * from './radio/tone.js';
+export * from './radio/validation.js';
 export * from './spectrum/band.js';
 export * from './spectrum/channel.js';
 export * from './spectrum/mode.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,oBAAoB,CAAC;AAEnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAEhC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,oBAAoB,CAAC;AAEnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AAEtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC"}

package/dist/radio/codec-factory.d.ts

@@ -0,0 +1,21 @@
+import type { ILogLayer } from 'loglayer';
+import type { RadioCodec } from './codec.js';
+import type { RadioModelId } from '../branded-types/radio-model-id.js';
+/**
+ * Factory interface for creating radio codecs
+ *
+ * This interface provides a standardized way for radio modules to create
+ * codec instances that can encode/decode radio memory data.
+ */
+export interface CodecFactory {
+    /**
+     * Creates a codec instance for a specific radio model
+     *
+     * @param modelId - The radio model identifier
+     * @param config - Configuration object for the codec
+     * @param logger - Logger instance for the codec
+     * @returns Promise that resolves to a RadioCodec instance
+     */
+    createCodec(modelId: RadioModelId, config: Record<string, unknown>, logger: ILogLayer): Promise<RadioCodec>;
+}
+//# sourceMappingURL=codec-factory.d.ts.map

package/dist/radio/codec-factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codec-factory.d.ts","sourceRoot":"","sources":["../../src/radio/codec-factory.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;OAOG;IACH,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC7G"}

package/dist/radio/codec-factory.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=codec-factory.js.map

package/dist/radio/codec-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codec-factory.js","sourceRoot":"","sources":["../../src/radio/codec-factory.ts"],"names":[],"mappings":""}

package/dist/radio/shared-components.d.ts

@@ -0,0 +1,40 @@
+import type { RadioCodec } from './codec.js';
+/**
+ * Interface for managing shared components across radio models
+ *
+ * This interface provides a standardized way for radio modules to share
+ * common components like schemas, protocols, and codecs.
+ */
+export interface SharedComponentManager {
+    /**
+     * Load a shared schema from a file path
+     *
+     * @param schemaPath - Path to the schema file
+     * @returns Promise that resolves to the schema object
+     */
+    loadSchema(schemaPath: string): Promise<Record<string, unknown>>;
+    /**
+     * Load a shared protocol from a file path
+     *
+     * @param protocolPath - Path to the protocol file
+     * @returns Promise that resolves to the protocol object
+     */
+    loadProtocol(protocolPath: string): Promise<Record<string, unknown>>;
+    /**
+     * Load a shared codec from a file path
+     *
+     * @param codecPath - Path to the codec module
+     * @param config - Configuration for the codec
+     * @returns Promise that resolves to a RadioCodec instance
+     */
+    loadCodec(codecPath: string, config: Record<string, unknown>): Promise<RadioCodec>;
+    /**
+     * Resolve a component reference relative to a base path
+     *
+     * @param reference - The reference to resolve
+     * @param basePath - The base path for resolution
+     * @returns The resolved absolute path
+     */
+    resolveReference(reference: string, basePath: string): string;
+}
+//# sourceMappingURL=shared-components.d.ts.map

package/dist/radio/shared-components.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared-components.d.ts","sourceRoot":"","sources":["../../src/radio/shared-components.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAErE;;;;;;OAMG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEnF;;;;;;OAMG;IACH,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;CAC/D"}

package/dist/radio/shared-components.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=shared-components.js.map

package/dist/radio/shared-components.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared-components.js","sourceRoot":"","sources":["../../src/radio/shared-components.ts"],"names":[],"mappings":""}

package/dist/radio/validation.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Result of a validation operation
+ *
+ * This interface provides a standardized way to return validation results
+ * across different parts of the radio system.
+ */
+export interface ValidationResult {
+    /**
+     * Whether the validation passed
+     */
+    isValid: boolean;
+    /**
+     * List of validation errors
+     */
+    errors: string[];
+    /**
+     * List of validation warnings
+     */
+    warnings: string[];
+}
+//# sourceMappingURL=validation.d.ts.map

package/dist/radio/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/radio/validation.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB"}

package/dist/radio/validation.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=validation.js.map

package/dist/radio/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/radio/validation.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@springfield/ham-radio-api",
-  "version": "16.0.0",
+  "version": "16.1.0",
   "author": "Bryan Hunt",
   "packageManager": "yarn@4.9.2",
   "main": "dist/index.js",
@@ -61,6 +61,7 @@
     "typescript": "5.8.3"
   },
   "dependencies": {
+    "loglayer": "^6.4.3",
     "ts-brand": "^0.2.0"
   }
 }

package/src/index.ts

@@ -12,6 +12,7 @@ export * from './license/class.js';
 
 export * from './radio/channel.js';
 export * from './radio/codec.js';
+export * from './radio/codec-factory.js';
 export * from './radio/connection.js';
 export * from './radio/ctcss.js';
 export * from './radio/dcs.js';
@@ -29,8 +30,10 @@ export * from './radio/protocol.js';
 export * from './radio/radio.js';
 export * from './radio/schema.js';
 export * from './radio/serial-config.js';
+export * from './radio/shared-components.js';
 export * from './radio/settings.js';
 export * from './radio/tone.js';
+export * from './radio/validation.js';
 
 export * from './spectrum/band.js';
 export * from './spectrum/channel.js';

package/src/radio/codec-factory.ts

@@ -0,0 +1,22 @@
+// oxlint-disable consistent-indexed-object-style
+import type { ILogLayer } from 'loglayer';
+import type { RadioCodec } from './codec.js';
+import type { RadioModelId } from '../branded-types/radio-model-id.js';
+
+/**
+ * Factory interface for creating radio codecs
+ *
+ * This interface provides a standardized way for radio modules to create
+ * codec instances that can encode/decode radio memory data.
+ */
+export interface CodecFactory {
+  /**
+   * Creates a codec instance for a specific radio model
+   *
+   * @param modelId - The radio model identifier
+   * @param config - Configuration object for the codec
+   * @param logger - Logger instance for the codec
+   * @returns Promise that resolves to a RadioCodec instance
+   */
+  createCodec(modelId: RadioModelId, config: Record<string, unknown>, logger: ILogLayer): Promise<RadioCodec>;
+}

package/src/radio/shared-components.ts

@@ -0,0 +1,44 @@
+// oxlint-disable consistent-indexed-object-style
+import type { RadioCodec } from './codec.js';
+
+/**
+ * Interface for managing shared components across radio models
+ *
+ * This interface provides a standardized way for radio modules to share
+ * common components like schemas, protocols, and codecs.
+ */
+export interface SharedComponentManager {
+  /**
+   * Load a shared schema from a file path
+   *
+   * @param schemaPath - Path to the schema file
+   * @returns Promise that resolves to the schema object
+   */
+  loadSchema(schemaPath: string): Promise<Record<string, unknown>>;
+
+  /**
+   * Load a shared protocol from a file path
+   *
+   * @param protocolPath - Path to the protocol file
+   * @returns Promise that resolves to the protocol object
+   */
+  loadProtocol(protocolPath: string): Promise<Record<string, unknown>>;
+
+  /**
+   * Load a shared codec from a file path
+   *
+   * @param codecPath - Path to the codec module
+   * @param config - Configuration for the codec
+   * @returns Promise that resolves to a RadioCodec instance
+   */
+  loadCodec(codecPath: string, config: Record<string, unknown>): Promise<RadioCodec>;
+
+  /**
+   * Resolve a component reference relative to a base path
+   *
+   * @param reference - The reference to resolve
+   * @param basePath - The base path for resolution
+   * @returns The resolved absolute path
+   */
+  resolveReference(reference: string, basePath: string): string;
+}

package/src/radio/validation.ts

@@ -0,0 +1,22 @@
+/**
+ * Result of a validation operation
+ *
+ * This interface provides a standardized way to return validation results
+ * across different parts of the radio system.
+ */
+export interface ValidationResult {
+  /**
+   * Whether the validation passed
+   */
+  isValid: boolean;
+
+  /**
+   * List of validation errors
+   */
+  errors: string[];
+
+  /**
+   * List of validation warnings
+   */
+  warnings: string[];
+}