@packet-net/pdn-aprs 0.1.1 → 0.3.0

package/src/header.ts

@@ -71,17 +71,24 @@ export function parseTnc2Header(line: Uint8Array, options: ParseOptions): Parsed
   }
 }
 
-/** Parses `SOURCE>DEST,PATH` (without the colon). Used for TNC2 lines and third-party headers. */
+/** A third-party source: 1-9 printable ASCII characters (APRS12c ch. 17); `>` and `:` end it. */
+const THIRD_PARTY_SOURCE = /^[\x20-\x7e]{1,9}$/;
+
+/**
+ * Parses `SOURCE>DEST,PATH` (without the colon). Used for TNC2 lines and third-party headers,
+ * whose source need not be an APRS-IS address (`thirdParty`).
+ */
 export function parseHeaderText(
   header: string,
   options: ParseOptions,
   diags: Diagnostic[],
+  thirdParty = false,
 ): { source: string; destination: string; path: PathEntry[] } {
   const gt = header.indexOf('>');
   if (gt < 0) fail(diags, 'invalid-header');
   const source = header.slice(0, gt);
   if (source.length === 0) fail(diags, 'invalid-header');
-  if (!APRS_IS_ADDRESS.test(source)) fail(diags, 'invalid-address');
+  if (!(thirdParty ? THIRD_PARTY_SOURCE : APRS_IS_ADDRESS).test(source)) fail(diags, 'invalid-address');
   const parts = header.slice(gt + 1).split(',');
   const destination = parts[0]!;
   if (destination.length === 0) tolerate(options, diags, 'empty-destination');

package/src/index.ts

@@ -54,4 +54,5 @@ export {
   DEFAULT_DESTINATION,
   timestampOf,
   type BuiltPacket,
+  type WeatherInput,
 } from './builder.js';

package/src/neutral.ts

@@ -3,7 +3,8 @@
 // sent. Used by the conformance tests and the differential dump, and handy for comparing this
 // library with another implementation.
 
-import { formatDiagnostic } from './diagnostics.js';
+import type { DiagnosticCode } from './codes.js';
+import { diagnostic, formatDiagnostic, type Diagnostic, type Severity } from './diagnostics.js';
 import type {
   AprsData,
   AprsPacket,
@@ -281,6 +282,7 @@ export function toNeutralData(d: AprsData): Neutral {
       put(o, 'altitude_m', d.altitudeM);
       put(o, 'time', d.time);
       put(o, 'waypoint', d.waypoint);
+      put(o, 'comment', d.comment);
       break;
     case 'maidenhead-beacon':
       put(o, 'locator', d.locator);
@@ -560,6 +562,7 @@ export function fromNeutralData(d: J): AprsData {
       opt(o, 'altitudeM', d.altitude_m);
       opt(o, 'time', d.time);
       opt(o, 'waypoint', d.waypoint);
+      opt(o, 'comment', d.comment);
       break;
     case 'maidenhead-beacon':
       o.locator = d.locator ?? '';
@@ -588,8 +591,26 @@ export function fromNeutralData(d: J): AprsData {
     case 'unrecognized':
       o.reason = d.reason;
       break;
-    case 'third-party':
-      throw new RangeError('third-party data cannot be built from the neutral form');
+    case 'third-party': {
+      // The inner packet as data: its information field is written from its data, and its
+      // diagnostics are kept, so one with a tolerated defect is refused, as the Encoding rule says.
+      const p: J = d.packet ?? {};
+      o.packet = {
+        source: p.source ?? '',
+        destination: p.destination ?? '',
+        path: ((p.path ?? []) as string[]).map((e) => (e.endsWith('*') ? { address: e.slice(0, -1), used: true } : { address: e, used: false })),
+        information: new Uint8Array(0),
+        data: fromNeutralData(p.data ?? { type: 'unrecognized', reason: 'empty' }),
+        diagnostics: ((p.diagnostics ?? []) as string[]).map(diagnosticFrom),
+      };
+      break;
+    }
   }
   return o as unknown as AprsData;
 }
+
+/** A diagnostic from its neutral form, `severity:code`. */
+function diagnosticFrom(text: string): Diagnostic {
+  const colon = text.indexOf(':');
+  return diagnostic(text.slice(0, colon) as Severity, text.slice(colon + 1) as DiagnosticCode);
+}

package/src/types.ts

@@ -136,7 +136,7 @@ export type DaoPrecision = 'none' | 'thousandths' | 'base91';
 
 /** The `!DAO!` datum and precision (APRS12c ch. 5). */
 export interface Dao {
-  /** The datum letter, upper case (`W` is WGS84). */
+  /** The datum: a letter, upper case (`W` is WGS84), or a digit for a local datum. */
   readonly datum: string;
   readonly precision: DaoPrecision;
 }
@@ -146,7 +146,7 @@ export interface CommentTelemetry {
   readonly sequence: number;
   /** One to five analog values, 0-8280. */
   readonly analog: readonly number[];
-  /** The eight digital bits as a number, B1 the least significant bit. */
+  /** The eight binary channels as a number, 0-255, B1 the least significant bit. */
   readonly digital?: number;
 }
 
@@ -419,7 +419,7 @@ export interface RawWeather {
 /** A raw NMEA sentence (`$`). */
 export interface NmeaSentence {
   readonly type: 'nmea';
-  /** The sentence without the `$`. */
+  /** The sentence without the `$`, up to and including any `*hh` checksum. */
   readonly sentence: string;
   readonly hasChecksum?: boolean;
   readonly latitude?: number;
@@ -428,9 +428,11 @@ export interface NmeaSentence {
   readonly courseDegrees?: number;
   readonly speedKnots?: number;
   readonly altitudeM?: number;
-  /** `HH:MM:SS`, with any fraction of a second. */
+  /** `HH:MM:SS`, with any fraction of a second as sent. */
   readonly time?: string;
   readonly waypoint?: string;
+  /** Text after the checksum (TinyTrack and FreeTrak send one), as sent. */
+  readonly comment?: string;
 }
 
 /** A Maidenhead locator beacon (`[`), obsolete. */
@@ -440,11 +442,24 @@ export interface MaidenheadBeacon {
   readonly comment?: string;
 }
 
+/** A general query's footprint: a latitude, a longitude and a radius (APRS12c ch. 15). */
+export interface QueryFootprint {
+  /** Degrees, north positive. */
+  readonly latitude: number;
+  /** Degrees, east positive. */
+  readonly longitude: number;
+  readonly radiusMiles: number;
+  /** The latitude as sent (` 34.0`, `-.1715`), with any leading space, so it can be written back the same. */
+  readonly latitudeText?: string;
+  /** The longitude as sent, so it can be written back the same. */
+  readonly longitudeText?: string;
+}
+
 /** A general query (`?`). */
 export interface Query {
   readonly type: 'query';
   readonly queryType: string;
-  readonly footprint?: { readonly latitude: number; readonly longitude: number; readonly radiusMiles: number };
+  readonly footprint?: QueryFootprint;
 }
 
 /** A station capability: a token, or a token and its value. */