@springfield/ham-radio-utils 4.1.1 → 4.1.2

package/dist/utils/band-plan.d.ts

@@ -4,11 +4,18 @@ interface LicenseClass {
     name: string;
 }
 export declare class BandPlan {
-    private bands;
-    private licenseClasses;
+    private readonly bands;
+    private readonly licenseClasses;
+    private readonly frsLicenseClassId;
     constructor();
     /**
-     * Finds the spectrum band that contains the given frequency
+     * Finds the spectrum band that contains the given frequency.
+     *
+     * Channelized allocations (FRS, GMRS, weather) interleave in the same
+     * MHz range. An exact channel match is preferred over a surrounding
+     * band envelope so FRS interstitial frequencies are not treated as GMRS
+     * repeater inputs.
+     *
      * @param frequency The frequency in Hz to find the band for
      * @returns The spectrum band containing the frequency, or undefined if no band contains it
      */
@@ -23,7 +30,9 @@ export declare class BandPlan {
      * Returns whether the given license class may transmit on the frequency.
      *
      * Looks up the band that contains the frequency and checks that band's
-     * privileges list. Frequencies outside every known band return false.
+     * privileges list. FRS is a license-free service, so any band that
+     * includes the FRS privilege is allowed for every operator. Frequencies
+     * outside every known band return false.
      *
      * @param frequencyHz - Frequency in Hz
      * @param licenseClassId - Springfield license-class ID

package/dist/utils/band-plan.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"band-plan.d.ts","sourceRoot":"","sources":["../../src/utils/band-plan.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAI/D,UAAU,YAAY;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd;AAED,qBAAa,QAAQ;IACnB,OAAO,CAAC,KAAK,CAAiB;IAC9B,OAAO,CAAC,cAAc,CAA4B;IAElD,cAGC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAE/D;IAED;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAEtD;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAQjE;CACF"}
+{"version":3,"file":"band-plan.d.ts","sourceRoot":"","sources":["../../src/utils/band-plan.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAI/D,UAAU,YAAY;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd;AAED,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAiB;IACvC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA4B;IAC3D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAqB;IAEvD,cAIC;IAED;;;;;;;;;;OAUG;IACH,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAS/D;IAED;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAEtD;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAcjE;CACF"}

package/dist/utils/band-plan.js

@@ -3,17 +3,30 @@ import licenseClassesData from '../db/license-classes.json' with { type: 'json'
 export class BandPlan {
     bands;
     licenseClasses;
+    frsLicenseClassId;
     constructor() {
         this.bands = bandsData;
         this.licenseClasses = new Map(licenseClassesData.map((licenseClass) => [licenseClass.id, licenseClass]));
+        this.frsLicenseClassId = [...this.licenseClasses.values()].find((licenseClass) => licenseClass.name === 'FRS')?.id;
     }
     /**
-     * Finds the spectrum band that contains the given frequency
+     * Finds the spectrum band that contains the given frequency.
+     *
+     * Channelized allocations (FRS, GMRS, weather) interleave in the same
+     * MHz range. An exact channel match is preferred over a surrounding
+     * band envelope so FRS interstitial frequencies are not treated as GMRS
+     * repeater inputs.
+     *
      * @param frequency The frequency in Hz to find the band for
      * @returns The spectrum band containing the frequency, or undefined if no band contains it
      */
     findBandByFrequency(frequency) {
-        return this.bands.find((band) => frequency >= band.lowerFrequency && frequency <= band.upperFrequency);
+        const frequencyHz = Math.round(frequency);
+        const channelMatch = this.bands.find((band) => band.channels?.some((channel) => channel.frequency === frequencyHz));
+        if (channelMatch) {
+            return channelMatch;
+        }
+        return this.bands.find((band) => frequencyHz >= band.lowerFrequency && frequencyHz <= band.upperFrequency);
     }
     /**
      * Finds a license class by its ID
@@ -27,7 +40,9 @@ export class BandPlan {
      * Returns whether the given license class may transmit on the frequency.
      *
      * Looks up the band that contains the frequency and checks that band's
-     * privileges list. Frequencies outside every known band return false.
+     * privileges list. FRS is a license-free service, so any band that
+     * includes the FRS privilege is allowed for every operator. Frequencies
+     * outside every known band return false.
      *
      * @param frequencyHz - Frequency in Hz
      * @param licenseClassId - Springfield license-class ID
@@ -38,7 +53,11 @@ export class BandPlan {
         if (!band) {
             return false;
         }
-        return band.privileges.includes(licenseClassId);
+        const privileges = band.privileges;
+        if (this.frsLicenseClassId && privileges.includes(this.frsLicenseClassId)) {
+            return true;
+        }
+        return privileges.includes(licenseClassId);
     }
 }
 //# sourceMappingURL=band-plan.js.map

package/dist/utils/band-plan.js.map

@@ -1 +1 @@
-{"version":3,"file":"band-plan.js","sourceRoot":"","sources":["../../src/utils/band-plan.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,kBAAkB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAC/D,OAAO,kBAAkB,MAAM,4BAA4B,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAOlF,MAAM,OAAO,QAAQ;IACX,KAAK,CAAiB;IACtB,cAAc,CAA4B;IAElD;QACE,IAAI,CAAC,KAAK,GAAG,SAA2B,CAAC;QACzC,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,CAAE,kBAAqC,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAC/H,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,SAAiB;QACnC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,IAAI,IAAI,CAAC,cAAc,IAAI,SAAS,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC;IACzG,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,EAAU;QAC1B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,WAAmB,EAAE,cAAsB;QACtD,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAQ,IAAI,CAAC,UAAuB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IAChE,CAAC;CACF","sourcesContent":["import type { SpectrumBand } from '@springfield/ham-radio-api';\nimport bandsData from '../db/bands.json' with { type: 'json' };\nimport licenseClassesData from '../db/license-classes.json' with { type: 'json' };\n\ninterface LicenseClass {\n  id: string;\n  name: string;\n}\n\nexport class BandPlan {\n  private bands: SpectrumBand[];\n  private licenseClasses: Map<string, LicenseClass>;\n\n  constructor() {\n    this.bands = bandsData as SpectrumBand[];\n    this.licenseClasses = new Map((licenseClassesData as LicenseClass[]).map((licenseClass) => [licenseClass.id, licenseClass]));\n  }\n\n  /**\n   * Finds the spectrum band that contains the given frequency\n   * @param frequency The frequency in Hz to find the band for\n   * @returns The spectrum band containing the frequency, or undefined if no band contains it\n   */\n  findBandByFrequency(frequency: number): SpectrumBand | undefined {\n    return this.bands.find((band) => frequency >= band.lowerFrequency && frequency <= band.upperFrequency);\n  }\n\n  /**\n   * Finds a license class by its ID\n   * @param id The ID of the license class to find\n   * @returns The license class with the given ID, or undefined if not found\n   */\n  findPrivilegeById(id: string): LicenseClass | undefined {\n    return this.licenseClasses.get(id);\n  }\n\n  /**\n   * Returns whether the given license class may transmit on the frequency.\n   *\n   * Looks up the band that contains the frequency and checks that band's\n   * privileges list. Frequencies outside every known band return false.\n   *\n   * @param frequencyHz - Frequency in Hz\n   * @param licenseClassId - Springfield license-class ID\n   * @returns true when the class has privilege on that frequency\n   */\n  hasPrivilege(frequencyHz: number, licenseClassId: string): boolean {\n    const band = this.findBandByFrequency(frequencyHz);\n\n    if (!band) {\n      return false;\n    }\n\n    return (band.privileges as string[]).includes(licenseClassId);\n  }\n}\n"]}
+{"version":3,"file":"band-plan.js","sourceRoot":"","sources":["../../src/utils/band-plan.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,kBAAkB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAC/D,OAAO,kBAAkB,MAAM,4BAA4B,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAOlF,MAAM,OAAO,QAAQ;IACF,KAAK,CAAiB;IACtB,cAAc,CAA4B;IAC1C,iBAAiB,CAAqB;IAEvD;QACE,IAAI,CAAC,KAAK,GAAG,SAA2B,CAAC;QACzC,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,CAAE,kBAAqC,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7H,IAAI,CAAC,iBAAiB,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,EAAE,CAAC;IACrH,CAAC;IAED;;;;;;;;;;OAUG;IACH,mBAAmB,CAAC,SAAiB;QACnC,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,KAAK,WAAW,CAAC,CAAC,CAAC;QAEpH,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,IAAI,IAAI,CAAC,cAAc,IAAI,WAAW,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC;IAC7G,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,EAAU;QAC1B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,WAAmB,EAAE,cAAsB;QACtD,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,UAAsB,CAAC;QAE/C,IAAI,IAAI,CAAC,iBAAiB,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAC1E,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IAC7C,CAAC;CACF","sourcesContent":["import type { SpectrumBand } from '@springfield/ham-radio-api';\nimport bandsData from '../db/bands.json' with { type: 'json' };\nimport licenseClassesData from '../db/license-classes.json' with { type: 'json' };\n\ninterface LicenseClass {\n  id: string;\n  name: string;\n}\n\nexport class BandPlan {\n  private readonly bands: SpectrumBand[];\n  private readonly licenseClasses: Map<string, LicenseClass>;\n  private readonly frsLicenseClassId: string | undefined;\n\n  constructor() {\n    this.bands = bandsData as SpectrumBand[];\n    this.licenseClasses = new Map((licenseClassesData as LicenseClass[]).map((licenseClass) => [licenseClass.id, licenseClass]));\n    this.frsLicenseClassId = [...this.licenseClasses.values()].find((licenseClass) => licenseClass.name === 'FRS')?.id;\n  }\n\n  /**\n   * Finds the spectrum band that contains the given frequency.\n   *\n   * Channelized allocations (FRS, GMRS, weather) interleave in the same\n   * MHz range. An exact channel match is preferred over a surrounding\n   * band envelope so FRS interstitial frequencies are not treated as GMRS\n   * repeater inputs.\n   *\n   * @param frequency The frequency in Hz to find the band for\n   * @returns The spectrum band containing the frequency, or undefined if no band contains it\n   */\n  findBandByFrequency(frequency: number): SpectrumBand | undefined {\n    const frequencyHz = Math.round(frequency);\n    const channelMatch = this.bands.find((band) => band.channels?.some((channel) => channel.frequency === frequencyHz));\n\n    if (channelMatch) {\n      return channelMatch;\n    }\n\n    return this.bands.find((band) => frequencyHz >= band.lowerFrequency && frequencyHz <= band.upperFrequency);\n  }\n\n  /**\n   * Finds a license class by its ID\n   * @param id The ID of the license class to find\n   * @returns The license class with the given ID, or undefined if not found\n   */\n  findPrivilegeById(id: string): LicenseClass | undefined {\n    return this.licenseClasses.get(id);\n  }\n\n  /**\n   * Returns whether the given license class may transmit on the frequency.\n   *\n   * Looks up the band that contains the frequency and checks that band's\n   * privileges list. FRS is a license-free service, so any band that\n   * includes the FRS privilege is allowed for every operator. Frequencies\n   * outside every known band return false.\n   *\n   * @param frequencyHz - Frequency in Hz\n   * @param licenseClassId - Springfield license-class ID\n   * @returns true when the class has privilege on that frequency\n   */\n  hasPrivilege(frequencyHz: number, licenseClassId: string): boolean {\n    const band = this.findBandByFrequency(frequencyHz);\n\n    if (!band) {\n      return false;\n    }\n\n    const privileges = band.privileges as string[];\n\n    if (this.frsLicenseClassId && privileges.includes(this.frsLicenseClassId)) {\n      return true;\n    }\n\n    return privileges.includes(licenseClassId);\n  }\n}\n"]}

package/package.json

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

package/src/utils/band-plan.ts

@@ -8,21 +8,36 @@ interface LicenseClass {
 }
 
 export class BandPlan {
-  private bands: SpectrumBand[];
-  private licenseClasses: Map<string, LicenseClass>;
+  private readonly bands: SpectrumBand[];
+  private readonly licenseClasses: Map<string, LicenseClass>;
+  private readonly frsLicenseClassId: string | undefined;
 
   constructor() {
     this.bands = bandsData as SpectrumBand[];
     this.licenseClasses = new Map((licenseClassesData as LicenseClass[]).map((licenseClass) => [licenseClass.id, licenseClass]));
+    this.frsLicenseClassId = [...this.licenseClasses.values()].find((licenseClass) => licenseClass.name === 'FRS')?.id;
   }
 
   /**
-   * Finds the spectrum band that contains the given frequency
+   * Finds the spectrum band that contains the given frequency.
+   *
+   * Channelized allocations (FRS, GMRS, weather) interleave in the same
+   * MHz range. An exact channel match is preferred over a surrounding
+   * band envelope so FRS interstitial frequencies are not treated as GMRS
+   * repeater inputs.
+   *
    * @param frequency The frequency in Hz to find the band for
    * @returns The spectrum band containing the frequency, or undefined if no band contains it
    */
   findBandByFrequency(frequency: number): SpectrumBand | undefined {
-    return this.bands.find((band) => frequency >= band.lowerFrequency && frequency <= band.upperFrequency);
+    const frequencyHz = Math.round(frequency);
+    const channelMatch = this.bands.find((band) => band.channels?.some((channel) => channel.frequency === frequencyHz));
+
+    if (channelMatch) {
+      return channelMatch;
+    }
+
+    return this.bands.find((band) => frequencyHz >= band.lowerFrequency && frequencyHz <= band.upperFrequency);
   }
 
   /**
@@ -38,7 +53,9 @@ export class BandPlan {
    * Returns whether the given license class may transmit on the frequency.
    *
    * Looks up the band that contains the frequency and checks that band's
-   * privileges list. Frequencies outside every known band return false.
+   * privileges list. FRS is a license-free service, so any band that
+   * includes the FRS privilege is allowed for every operator. Frequencies
+   * outside every known band return false.
    *
    * @param frequencyHz - Frequency in Hz
    * @param licenseClassId - Springfield license-class ID
@@ -51,6 +68,12 @@ export class BandPlan {
       return false;
     }
 
-    return (band.privileges as string[]).includes(licenseClassId);
+    const privileges = band.privileges as string[];
+
+    if (this.frsLicenseClassId && privileges.includes(this.frsLicenseClassId)) {
+      return true;
+    }
+
+    return privileges.includes(licenseClassId);
   }
 }