sjg/trx-rs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: convert background decode controls to TypeScript

Browse Source
This commit is contained in:
sjg
2026-08-01 12:36:27 +02:00
parent 7251ec276d
commit ec59908e0d
6 changed files with 531 additions and 423 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/trx-client/trx-frontend/trx-frontend-http/assets/web/generated/background-decode.js
+54 -44
View File
@@ -1,8 +1,11 @@
"use strict"; "use strict";
(function() { (() => {
// src/plugins/background-decode.ts
var bgdWindow = window;
(function() {
"use strict"; "use strict";
function bgdSupportedIds() { function bgdSupportedIds() {
return (window.decoderRegistry || []).filter(function(d) { return (bgdWindow.decoderRegistry || []).filter(function(d) {
return d.background_decode; return d.background_decode;
}).map(function(d) { }).map(function(d) {
return d.id; return d.id;
@@ -29,7 +32,7 @@
} }
function apiGetConfig(rigId) { function apiGetConfig(rigId) {
return fetch("/background-decode/" + encodeURIComponent(rigId)).then(function(r) { return fetch("/background-decode/" + encodeURIComponent(rigId)).then(function(r) {
if (!r.ok) throw new Error("HTTP " + r.status); if (!r.ok) throw new Error(`HTTP ${String(r.status)}`);
return r.json(); return r.json();
}); });
} }
@@ -39,7 +42,7 @@
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
body: JSON.stringify(config) body: JSON.stringify(config)
}).then(function(r) { }).then(function(r) {
if (!r.ok) throw new Error("HTTP " + r.status); if (!r.ok) throw new Error(`HTTP ${String(r.status)}`);
return r.json(); return r.json();
}); });
} }
@@ -47,19 +50,19 @@
return fetch("/background-decode/" + encodeURIComponent(rigId), { return fetch("/background-decode/" + encodeURIComponent(rigId), {
method: "DELETE" method: "DELETE"
}).then(function(r) { }).then(function(r) {
if (!r.ok) throw new Error("HTTP " + r.status); if (!r.ok) throw new Error(`HTTP ${String(r.status)}`);
return r.json(); return r.json();
}); });
} }
function apiGetStatus(rigId) { function apiGetStatus(rigId) {
return fetch("/background-decode/" + encodeURIComponent(rigId) + "/status").then(function(r) { return fetch("/background-decode/" + encodeURIComponent(rigId) + "/status").then(function(r) {
if (!r.ok) throw new Error("HTTP " + r.status); if (!r.ok) throw new Error(`HTTP ${String(r.status)}`);
return r.json(); return r.json();
}); });
} }
function apiGetBookmarks() { function apiGetBookmarks() {
return fetch("/bookmarks").then(function(r) { return fetch("/bookmarks").then(function(r) {
if (!r.ok) throw new Error("HTTP " + r.status); if (!r.ok) throw new Error(`HTTP ${String(r.status)}`);
return r.json(); return r.json();
}); });
} }
@@ -67,7 +70,7 @@
const rigId = currentRigId; const rigId = currentRigId;
if (!rigId) return; if (!rigId) return;
Promise.all([apiGetConfig(rigId), apiGetBookmarks()]).then(function([config, bookmarks]) { Promise.all([apiGetConfig(rigId), apiGetBookmarks()]).then(function([config, bookmarks]) {
currentConfig = config || { remote: rigId, enabled: false, bookmark_ids: [] }; currentConfig = config;
bookmarkList = Array.isArray(bookmarks) ? bookmarks : []; bookmarkList = Array.isArray(bookmarks) ? bookmarks : [];
renderBackgroundDecode(); renderBackgroundDecode();
clearBgdDirty(); clearBgdDirty();
@@ -82,16 +85,16 @@
}); });
} }
function bookmarkDecoderKinds(bookmark) { function bookmarkDecoderKinds(bookmark) {
var ids = bgdSupportedIds(); const ids = bgdSupportedIds();
var decoders = Array.isArray(bookmark && bookmark.decoders) ? bookmark.decoders : []; const decoders = bookmark.decoders ?? [];
var explicit = decoders.map(function(item) { const explicit = decoders.map(function(item) {
return String(item || "").trim().toLowerCase(); return item.trim().toLowerCase();
}).filter(function(item, index, arr) { }).filter(function(item, index, arr) {
return ids.indexOf(item) >= 0 && arr.indexOf(item) === index; return ids.indexOf(item) >= 0 && arr.indexOf(item) === index;
}); });
if (explicit.length > 0) return explicit; if (explicit.length > 0) return explicit;
var mode = String(bookmark && bookmark.mode || "").trim().toUpperCase(); const mode = bookmark.mode.trim().toUpperCase();
return (window.decoderRegistry || []).filter(function(d) { return (bgdWindow.decoderRegistry || []).filter(function(d) {
return d.activation === "mode_bound" && d.background_decode && d.active_modes.indexOf(mode) >= 0; return d.activation === "mode_bound" && d.background_decode && d.active_modes.indexOf(mode) >= 0;
}).map(function(d) { }).map(function(d) {
return d.id; return d.id;
@@ -101,9 +104,9 @@
if (!currentConfig) { if (!currentConfig) {
currentConfig = { remote: currentRigId, enabled: false, bookmark_ids: [] }; currentConfig = { remote: currentRigId, enabled: false, bookmark_ids: [] };
} }
setCheckbox("background-decode-enabled", !!currentConfig.enabled); setCheckbox("background-decode-enabled", currentConfig.enabled);
renderBookmarkChecklist(); renderBookmarkChecklist();
const isControl = backgroundDecodeRole === "control" || typeof authEnabled !== "undefined" && !authEnabled; const isControl = backgroundDecodeRole === "control" || bgdWindow.authEnabled === false;
const panel = document.getElementById("background-decode-panel"); const panel = document.getElementById("background-decode-panel");
if (panel) { if (panel) {
panel.querySelectorAll("input, select, button.sch-write").forEach(function(el) { panel.querySelectorAll("input, select, button.sch-write").forEach(function(el) {
@@ -115,7 +118,7 @@
if (saveBtn) saveBtn.style.display = isControl ? "" : "none"; if (saveBtn) saveBtn.style.display = isControl ? "" : "none";
if (resetBtn) resetBtn.style.display = isControl ? "" : "none"; if (resetBtn) resetBtn.style.display = isControl ? "" : "none";
} }
function renderBookmarkChecklist(filterText) { function renderBookmarkChecklist(filterText = "") {
const container = document.getElementById("bgd-bookmark-checklist"); const container = document.getElementById("bgd-bookmark-checklist");
if (!container) return; if (!container) return;
container.innerHTML = ""; container.innerHTML = "";
@@ -125,7 +128,7 @@
const all = supportedBookmarks(); const all = supportedBookmarks();
const filter = (filterText || "").trim().toLowerCase(); const filter = (filterText || "").trim().toLowerCase();
const filtered = filter ? all.filter(function(bm) { const filtered = filter ? all.filter(function(bm) {
var text = (bm.name + " " + formatFreq(bm.freq_hz) + " " + bm.mode).toLowerCase(); const text = (bm.name + " " + formatFreq(bm.freq_hz) + " " + bm.mode).toLowerCase();
return text.indexOf(filter) >= 0; return text.indexOf(filter) >= 0;
}) : all; }) : all;
if (filtered.length === 0) { if (filtered.length === 0) {
@@ -133,13 +136,13 @@
return; return;
} }
filtered.forEach(function(bookmark) { filtered.forEach(function(bookmark) {
var row = document.createElement("label"); const row = document.createElement("label");
row.className = "bgd-checklist-row"; row.className = "bgd-checklist-row";
var decoders = bookmarkDecoderKinds(bookmark); const decoders = bookmarkDecoderKinds(bookmark);
var checked = selectedIds.has(bookmark.id) ? " checked" : ""; const checked = selectedIds.has(bookmark.id) ? " checked" : "";
row.innerHTML = '<input type="checkbox"' + checked + ' data-bm-id="' + escHtml(bookmark.id) + '" /><span class="bgd-checklist-name">' + escHtml(bookmark.name) + '</span><span class="bgd-checklist-meta">' + escHtml(formatFreq(bookmark.freq_hz) + " " + bookmark.mode + " · " + decoders.join("/").toUpperCase()) + "</span>"; row.innerHTML = '<input type="checkbox"' + checked + ' data-bm-id="' + escHtml(bookmark.id) + '" /><span class="bgd-checklist-name">' + escHtml(bookmark.name) + '</span><span class="bgd-checklist-meta">' + escHtml(formatFreq(bookmark.freq_hz) + " " + bookmark.mode + " · " + decoders.join("/").toUpperCase()) + "</span>";
row.querySelector("input").addEventListener("change", function(e) { row.querySelector("input")?.addEventListener("change", function(e) {
onChecklistToggle(bookmark.id, e.target.checked); onChecklistToggle(bookmark.id, e.currentTarget.checked);
}); });
container.appendChild(row); container.appendChild(row);
}); });
@@ -163,8 +166,8 @@
if (!rigId) return; if (!rigId) return;
const payload = { const payload = {
remote: rigId, remote: rigId,
enabled: !!document.getElementById("background-decode-enabled").checked, enabled: document.getElementById("background-decode-enabled")?.checked ?? false,
bookmark_ids: Array.isArray(currentConfig && currentConfig.bookmark_ids) ? currentConfig.bookmark_ids.slice() : [] bookmark_ids: currentConfig?.bookmark_ids.slice() ?? []
}; };
const btn = document.getElementById("background-decode-save-btn"); const btn = document.getElementById("background-decode-save-btn");
if (btn) btn.disabled = true; if (btn) btn.disabled = true;
@@ -173,9 +176,9 @@
renderBackgroundDecode(); renderBackgroundDecode();
clearBgdDirty(); clearBgdDirty();
pollBackgroundDecodeStatus(); pollBackgroundDecodeStatus();
showToast("Background decode saved."); showToast("Background decode saved.", false);
}).catch(function(err) { }).catch(function(err) {
showToast("Save failed: " + err.message, true); showToast(`Save failed: ${errorMessage(err)}`, true);
}).finally(function() { }).finally(function() {
if (btn) btn.disabled = false; if (btn) btn.disabled = false;
}); });
@@ -183,15 +186,15 @@
async function resetBackgroundDecode() { async function resetBackgroundDecode() {
const rigId = currentRigId; const rigId = currentRigId;
if (!rigId) return; if (!rigId) return;
if (!await window.trxUi.confirm({ title: "Reset background decoding?", message: "The current background decode configuration will be permanently reset.", confirmLabel: "Reset" })) return; if (!await bgdWindow.trxUi.confirm({ title: "Reset background decoding?", message: "The current background decode configuration will be permanently reset.", confirmLabel: "Reset" })) return;
apiResetConfig(rigId).then(function(saved) { apiResetConfig(rigId).then(function(saved) {
currentConfig = saved; currentConfig = saved;
renderBackgroundDecode(); renderBackgroundDecode();
clearBgdDirty(); clearBgdDirty();
pollBackgroundDecodeStatus(); pollBackgroundDecodeStatus();
showToast("Background decode reset."); showToast("Background decode reset.", false);
}).catch(function(err) { }).catch(function(err) {
showToast("Reset failed: " + err.message, true); showToast(`Reset failed: ${errorMessage(err)}`, true);
}); });
} }
function startStatusPolling() { function startStatusPolling() {
@@ -207,15 +210,15 @@
function renderStatus(status) { function renderStatus(status) {
const card = document.getElementById("background-decode-status-card"); const card = document.getElementById("background-decode-status-card");
if (!card) return; if (!card) return;
const entries = Array.isArray(status && status.entries) ? status.entries : []; const entries = status.entries ?? [];
if (!entries.length) { if (!entries.length) {
card.textContent = "No background decode bookmarks configured."; card.textContent = "No background decode bookmarks configured.";
return; return;
} }
const summary = []; const summary = [];
if (status.active_rig) { if (status.active_rig) {
if (Number.isFinite(status.center_hz)) summary.push("Center " + formatFreq(status.center_hz)); if (typeof status.center_hz === "number" && Number.isFinite(status.center_hz)) summary.push("Center " + formatFreq(status.center_hz));
if (Number.isFinite(status.sample_rate) && status.sample_rate > 0) summary.push("Span ±" + formatFreq(status.sample_rate / 2)); if (typeof status.sample_rate === "number" && Number.isFinite(status.sample_rate) && status.sample_rate > 0) summary.push("Span ±" + formatFreq(status.sample_rate / 2));
} else { } else {
summary.push("This rig is not currently selected for audio."); summary.push("This rig is not currently selected for audio.");
} }
@@ -224,7 +227,7 @@
entries.forEach(function(entry) { entries.forEach(function(entry) {
const name = entry.bookmark_name || entry.bookmark_id || "Unknown bookmark"; const name = entry.bookmark_name || entry.bookmark_id || "Unknown bookmark";
const parts = []; const parts = [];
if (Number.isFinite(entry.freq_hz)) parts.push(formatFreq(entry.freq_hz)); if (typeof entry.freq_hz === "number" && Number.isFinite(entry.freq_hz)) parts.push(formatFreq(entry.freq_hz));
if (entry.mode) parts.push(entry.mode); if (entry.mode) parts.push(entry.mode);
if (Array.isArray(entry.decoder_kinds) && entry.decoder_kinds.length) { if (Array.isArray(entry.decoder_kinds) && entry.decoder_kinds.length) {
parts.push(entry.decoder_kinds.join("/").toUpperCase()); parts.push(entry.decoder_kinds.join("/").toUpperCase());
@@ -262,26 +265,30 @@
} }
function setCheckbox(id, value) { function setCheckbox(id, value) {
const el = document.getElementById(id); const el = document.getElementById(id);
if (el) el.checked = !!value; if (el) el.checked = value;
} }
function formatFreq(hz) { function formatFreq(hz) {
if (!Number.isFinite(hz) || hz <= 0) return "--"; if (!Number.isFinite(hz) || hz <= 0) return "--";
if (hz >= 1e6) return (hz / 1e6).toFixed(3).replace(/\.?0+$/, "") + " MHz"; if (hz >= 1e6) return (hz / 1e6).toFixed(3).replace(/\.?0+$/, "") + " MHz";
if (hz >= 1e3) return (hz / 1e3).toFixed(1).replace(/\.?0+$/, "") + " kHz"; if (hz >= 1e3) return (hz / 1e3).toFixed(1).replace(/\.?0+$/, "") + " kHz";
return hz + " Hz"; return `${String(hz)} Hz`;
} }
function escHtml(value) { function escHtml(value) {
return String(value == null ? "" : value).replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;"); const text = typeof value === "string" || typeof value === "number" || typeof value === "boolean" ? String(value) : "";
return text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
}
function errorMessage(error) {
return error instanceof Error ? error.message : String(error);
} }
function markBgdDirty() { function markBgdDirty() {
if (bgdDirty) return; if (bgdDirty) return;
bgdDirty = true; bgdDirty = true;
var btn = document.getElementById("background-decode-save-btn"); const btn = document.getElementById("background-decode-save-btn");
if (btn) btn.classList.add("sch-dirty"); if (btn) btn.classList.add("sch-dirty");
} }
function clearBgdDirty() { function clearBgdDirty() {
bgdDirty = false; bgdDirty = false;
var btn = document.getElementById("background-decode-save-btn"); const btn = document.getElementById("background-decode-save-btn");
if (btn) btn.classList.remove("sch-dirty"); if (btn) btn.classList.remove("sch-dirty");
} }
function showToast(msg, isError) { function showToast(msg, isError) {
@@ -298,7 +305,7 @@
if (!currentConfig) { if (!currentConfig) {
currentConfig = { remote: currentRigId, enabled: false, bookmark_ids: [] }; currentConfig = { remote: currentRigId, enabled: false, bookmark_ids: [] };
} }
var ids = supportedBookmarks().map(function(bm) { const ids = supportedBookmarks().map(function(bm) {
return bm.id; return bm.id;
}); });
currentConfig.bookmark_ids = ids; currentConfig.bookmark_ids = ids;
@@ -346,10 +353,13 @@
const resetBtn = document.getElementById("background-decode-reset-btn"); const resetBtn = document.getElementById("background-decode-reset-btn");
if (resetBtn && !resetBtn._wired) { if (resetBtn && !resetBtn._wired) {
resetBtn._wired = true; resetBtn._wired = true;
resetBtn.addEventListener("click", resetBackgroundDecode); resetBtn.addEventListener("click", () => {
void resetBackgroundDecode();
});
} }
} }
window.initBackgroundDecode = initBackgroundDecode; bgdWindow.initBackgroundDecode = initBackgroundDecode;
window.wireBackgroundDecodeEvents = wireBackgroundDecodeEvents; bgdWindow.wireBackgroundDecodeEvents = wireBackgroundDecodeEvents;
window.setBackgroundDecodeRig = setBackgroundDecodeRig; bgdWindow.setBackgroundDecodeRig = setBackgroundDecodeRig;
})();
})(); })();
src/trx-client/trx-frontend/trx-frontend-http/assets/web/generated/plugin-loader.js
+1 -1
View File
@@ -10,7 +10,7 @@ const pluginGroups = {
}; };
const loaded = /* @__PURE__ */ new Set(); const loaded = /* @__PURE__ */ new Set();
const loading = /* @__PURE__ */ new Map(); const loading = /* @__PURE__ */ new Map();
const modulePlugins = /* @__PURE__ */ new Set(["/ft8.js", "/ft4.js", "/ft2.js", "/wspr.js", "/cw.js", "/vdes.js", "/wefax.js"]); const modulePlugins = /* @__PURE__ */ new Set(["/ft8.js", "/ft4.js", "/ft2.js", "/wspr.js", "/cw.js", "/vdes.js", "/wefax.js", "/background-decode.js"]);
function loadLegacyScript(path) { function loadLegacyScript(path) {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
const script = document.createElement("script"); const script = document.createElement("script");
src/trx-client/trx-frontend/trx-frontend-http/frontend/build.mjs
+1 -1
View File
@@ -24,7 +24,6 @@ await build({
"webgl-renderer": path.join(sourceDir, "webgl-renderer.ts"), "webgl-renderer": path.join(sourceDir, "webgl-renderer.ts"),
ais: path.join(sourceDir, "plugins", "ais.js"), ais: path.join(sourceDir, "plugins", "ais.js"),
aprs: path.join(sourceDir, "plugins", "aprs.js"), aprs: path.join(sourceDir, "plugins", "aprs.js"),
"background-decode": path.join(sourceDir, "plugins", "background-decode.js"),
bookmarks: path.join(sourceDir, "plugins", "bookmarks.js"), bookmarks: path.join(sourceDir, "plugins", "bookmarks.js"),
"hf-aprs": path.join(sourceDir, "plugins", "hf-aprs.js"), "hf-aprs": path.join(sourceDir, "plugins", "hf-aprs.js"),
sat: path.join(sourceDir, "plugins", "sat.js"), sat: path.join(sourceDir, "plugins", "sat.js"),
@@ -51,6 +50,7 @@ await build({
"leaflet-ais-tracksymbol": path.join(sourceDir, "leaflet-ais-tracksymbol.ts"), "leaflet-ais-tracksymbol": path.join(sourceDir, "leaflet-ais-tracksymbol.ts"),
vdes: path.join(sourceDir, "plugins", "vdes.ts"), vdes: path.join(sourceDir, "plugins", "vdes.ts"),
wefax: path.join(sourceDir, "plugins", "wefax.ts"), wefax: path.join(sourceDir, "plugins", "wefax.ts"),
"background-decode": path.join(sourceDir, "plugins", "background-decode.ts"),
}, },
outdir: outputDir, outdir: outputDir,
bundle: true, bundle: true,
src/trx-client/trx-frontend/trx-frontend-http/frontend/src/plugin-loader.ts
+1 -1
View File
@@ -16,7 +16,7 @@ const pluginGroups: Readonly<Record<PluginGroup, readonly string[]>> = {
const loaded = new Set<string>(); const loaded = new Set<string>();
const loading = new Map<string, Promise<void>>(); const loading = new Map<string, Promise<void>>();
const modulePlugins = new Set(["/ft8.js", "/ft4.js", "/ft2.js", "/wspr.js", "/cw.js", "/vdes.js", "/wefax.js"]); const modulePlugins = new Set(["/ft8.js", "/ft4.js", "/ft2.js", "/wspr.js", "/cw.js", "/vdes.js", "/wefax.js", "/background-decode.js"]);
function loadLegacyScript(path: string): Promise<void> { function loadLegacyScript(path: string): Promise<void> {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
src/trx-client/trx-frontend/trx-frontend-http/frontend/src/plugins/background-decode.js → src/trx-client/trx-frontend/trx-frontend-http/frontend/src/plugins/background-decode.ts
+137 -85
View File
@@ -2,30 +2,75 @@
// //
// SPDX-License-Identifier: GPL-2.0-or-later // SPDX-License-Identifier: GPL-2.0-or-later
export {};
interface DecoderDescriptor {
id: string;
background_decode?: boolean;
activation?: string;
active_modes: string[];
}
interface Bookmark {
id: string;
name: string;
freq_hz: number;
mode: string;
decoders?: string[];
}
interface BackgroundDecodeConfig {
remote: string | null;
enabled: boolean;
bookmark_ids: string[];
}
interface BackgroundStatusEntry {
bookmark_name?: string;
bookmark_id?: string;
freq_hz?: number;
mode?: string;
decoder_kinds?: string[];
state?: string;
}
interface BackgroundDecodeStatus {
entries?: BackgroundStatusEntry[];
active_rig?: boolean;
center_hz?: number;
sample_rate?: number;
}
interface BackgroundBridge {
decoderRegistry?: DecoderDescriptor[];
authEnabled?: boolean;
trxUi: { confirm(options: { title: string; message: string; confirmLabel: string }): Promise<boolean> };
initBackgroundDecode?: (rigId: string | null, role: string | null) => void;
wireBackgroundDecodeEvents?: () => void;
setBackgroundDecodeRig?: (rigId: string | null) => void;
}
interface WiredElement extends HTMLElement { _wired?: boolean }
const bgdWindow = window as unknown as BackgroundBridge;
(function () { (function () {
"use strict"; "use strict";
function bgdSupportedIds() { function bgdSupportedIds(): string[] {
return (window.decoderRegistry || []) return (bgdWindow.decoderRegistry || [])
.filter(function (d) { return d.background_decode; }) .filter(function (d) { return d.background_decode; })
.map(function (d) { return d.id; }); .map(function (d) { return d.id; });
} }
let backgroundDecodeRole = null; let backgroundDecodeRole: string | null = null;
let currentRigId = null; let currentRigId: string | null = null;
let currentConfig = null; let currentConfig: BackgroundDecodeConfig | null = null;
let bookmarkList = []; let bookmarkList: Bookmark[] = [];
let statusInterval = null; let statusInterval: ReturnType<typeof setInterval> | null = null;
let bgdDirty = false; let bgdDirty = false;
function initBackgroundDecode(rigId, role) { function initBackgroundDecode(rigId: string | null, role: string | null): void {
backgroundDecodeRole = role; backgroundDecodeRole = role;
currentRigId = rigId || null; currentRigId = rigId || null;
if (currentRigId) loadBackgroundDecode(); if (currentRigId) loadBackgroundDecode();
startStatusPolling(); startStatusPolling();
} }
function setBackgroundDecodeRig(rigId) { function setBackgroundDecodeRig(rigId: string | null): void {
const nextRigId = rigId || null; const nextRigId = rigId || null;
if (nextRigId === currentRigId) return; if (nextRigId === currentRigId) return;
currentRigId = nextRigId; currentRigId = nextRigId;
@@ -33,44 +78,44 @@
loadBackgroundDecode(); loadBackgroundDecode();
} }
function apiGetConfig(rigId) { function apiGetConfig(rigId: string): Promise<BackgroundDecodeConfig> {
return fetch("/background-decode/" + encodeURIComponent(rigId)).then(function (r) { return fetch("/background-decode/" + encodeURIComponent(rigId)).then(function (r) {
if (!r.ok) throw new Error("HTTP " + r.status); if (!r.ok) throw new Error(`HTTP ${String(r.status)}`);
return r.json(); return r.json() as Promise<BackgroundDecodeConfig>;
}); });
} }
function apiPutConfig(rigId, config) { function apiPutConfig(rigId: string, config: BackgroundDecodeConfig): Promise<BackgroundDecodeConfig> {
return fetch("/background-decode/" + encodeURIComponent(rigId), { return fetch("/background-decode/" + encodeURIComponent(rigId), {
method: "PUT", method: "PUT",
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
body: JSON.stringify(config), body: JSON.stringify(config),
}).then(function (r) { }).then(function (r) {
if (!r.ok) throw new Error("HTTP " + r.status); if (!r.ok) throw new Error(`HTTP ${String(r.status)}`);
return r.json(); return r.json() as Promise<BackgroundDecodeConfig>;
}); });
} }
function apiResetConfig(rigId) { function apiResetConfig(rigId: string): Promise<BackgroundDecodeConfig> {
return fetch("/background-decode/" + encodeURIComponent(rigId), { return fetch("/background-decode/" + encodeURIComponent(rigId), {
method: "DELETE", method: "DELETE",
}).then(function (r) { }).then(function (r) {
if (!r.ok) throw new Error("HTTP " + r.status); if (!r.ok) throw new Error(`HTTP ${String(r.status)}`);
return r.json(); return r.json() as Promise<BackgroundDecodeConfig>;
}); });
} }
function apiGetStatus(rigId) { function apiGetStatus(rigId: string): Promise<BackgroundDecodeStatus> {
return fetch("/background-decode/" + encodeURIComponent(rigId) + "/status").then(function (r) { return fetch("/background-decode/" + encodeURIComponent(rigId) + "/status").then(function (r) {
if (!r.ok) throw new Error("HTTP " + r.status); if (!r.ok) throw new Error(`HTTP ${String(r.status)}`);
return r.json(); return r.json() as Promise<BackgroundDecodeStatus>;
}); });
} }
function apiGetBookmarks() { function apiGetBookmarks(): Promise<Bookmark[]> {
return fetch("/bookmarks").then(function (r) { return fetch("/bookmarks").then(function (r) {
if (!r.ok) throw new Error("HTTP " + r.status); if (!r.ok) throw new Error(`HTTP ${String(r.status)}`);
return r.json(); return r.json() as Promise<Bookmark[]>;
}); });
} }
@@ -79,35 +124,35 @@
if (!rigId) return; if (!rigId) return;
Promise.all([apiGetConfig(rigId), apiGetBookmarks()]) Promise.all([apiGetConfig(rigId), apiGetBookmarks()])
.then(function ([config, bookmarks]) { .then(function ([config, bookmarks]) {
currentConfig = config || { remote: rigId, enabled: false, bookmark_ids: [] }; currentConfig = config;
bookmarkList = Array.isArray(bookmarks) ? bookmarks : []; bookmarkList = Array.isArray(bookmarks) ? bookmarks : [];
renderBackgroundDecode(); renderBackgroundDecode();
clearBgdDirty(); clearBgdDirty();
pollBackgroundDecodeStatus(); pollBackgroundDecodeStatus();
}) })
.catch(function (err) { .catch(function (err: unknown) {
console.error("background decode load failed", err); console.error("background decode load failed", err);
}); });
} }
function supportedBookmarks() { function supportedBookmarks(): Bookmark[] {
return bookmarkList.filter(function (bookmark) { return bookmarkList.filter(function (bookmark) {
return bookmarkDecoderKinds(bookmark).length > 0; return bookmarkDecoderKinds(bookmark).length > 0;
}); });
} }
function bookmarkDecoderKinds(bookmark) { function bookmarkDecoderKinds(bookmark: Bookmark): string[] {
var ids = bgdSupportedIds(); const ids = bgdSupportedIds();
var decoders = Array.isArray(bookmark && bookmark.decoders) ? bookmark.decoders : []; const decoders = bookmark.decoders ?? [];
var explicit = decoders const explicit = decoders
.map(function (item) { return String(item || "").trim().toLowerCase(); }) .map(function (item) { return item.trim().toLowerCase(); })
.filter(function (item, index, arr) { .filter(function (item, index, arr) {
return ids.indexOf(item) >= 0 && arr.indexOf(item) === index; return ids.indexOf(item) >= 0 && arr.indexOf(item) === index;
}); });
if (explicit.length > 0) return explicit; if (explicit.length > 0) return explicit;
// Fall back: infer from mode via mode-bound entries in the registry. // Fall back: infer from mode via mode-bound entries in the registry.
var mode = String(bookmark && bookmark.mode || "").trim().toUpperCase(); const mode = bookmark.mode.trim().toUpperCase();
return (window.decoderRegistry || []) return (bgdWindow.decoderRegistry || [])
.filter(function (d) { .filter(function (d) {
return d.activation === "mode_bound" && d.background_decode return d.activation === "mode_bound" && d.background_decode
&& d.active_modes.indexOf(mode) >= 0; && d.active_modes.indexOf(mode) >= 0;
@@ -119,13 +164,13 @@
if (!currentConfig) { if (!currentConfig) {
currentConfig = { remote: currentRigId, enabled: false, bookmark_ids: [] }; currentConfig = { remote: currentRigId, enabled: false, bookmark_ids: [] };
} }
setCheckbox("background-decode-enabled", !!currentConfig.enabled); setCheckbox("background-decode-enabled", currentConfig.enabled);
renderBookmarkChecklist(); renderBookmarkChecklist();
const isControl = backgroundDecodeRole === "control" || (typeof authEnabled !== "undefined" && !authEnabled); const isControl = backgroundDecodeRole === "control" || bgdWindow.authEnabled === false;
const panel = document.getElementById("background-decode-panel"); const panel = document.getElementById("background-decode-panel");
if (panel) { if (panel) {
panel.querySelectorAll("input, select, button.sch-write").forEach(function (el) { panel.querySelectorAll<HTMLInputElement | HTMLSelectElement | HTMLButtonElement>("input, select, button.sch-write").forEach(function (el) {
el.disabled = !isControl; el.disabled = !isControl;
}); });
} }
@@ -135,7 +180,7 @@
if (resetBtn) resetBtn.style.display = isControl ? "" : "none"; if (resetBtn) resetBtn.style.display = isControl ? "" : "none";
} }
function renderBookmarkChecklist(filterText) { function renderBookmarkChecklist(filterText = ""): void {
const container = document.getElementById("bgd-bookmark-checklist"); const container = document.getElementById("bgd-bookmark-checklist");
if (!container) return; if (!container) return;
container.innerHTML = ""; container.innerHTML = "";
@@ -148,7 +193,7 @@
const filtered = filter const filtered = filter
? all.filter(function (bm) { ? all.filter(function (bm) {
var text = (bm.name + " " + formatFreq(bm.freq_hz) + " " + bm.mode).toLowerCase(); const text = (bm.name + " " + formatFreq(bm.freq_hz) + " " + bm.mode).toLowerCase();
return text.indexOf(filter) >= 0; return text.indexOf(filter) >= 0;
}) })
: all; : all;
@@ -161,22 +206,22 @@
} }
filtered.forEach(function (bookmark) { filtered.forEach(function (bookmark) {
var row = document.createElement("label"); const row = document.createElement("label");
row.className = "bgd-checklist-row"; row.className = "bgd-checklist-row";
var decoders = bookmarkDecoderKinds(bookmark); const decoders = bookmarkDecoderKinds(bookmark);
var checked = selectedIds.has(bookmark.id) ? " checked" : ""; const checked = selectedIds.has(bookmark.id) ? " checked" : "";
row.innerHTML = row.innerHTML =
'<input type="checkbox"' + checked + ' data-bm-id="' + escHtml(bookmark.id) + '" />' + '<input type="checkbox"' + checked + ' data-bm-id="' + escHtml(bookmark.id) + '" />' +
'<span class="bgd-checklist-name">' + escHtml(bookmark.name) + '</span>' + '<span class="bgd-checklist-name">' + escHtml(bookmark.name) + '</span>' +
'<span class="bgd-checklist-meta">' + escHtml(formatFreq(bookmark.freq_hz) + " " + bookmark.mode + " · " + decoders.join("/").toUpperCase()) + '</span>'; '<span class="bgd-checklist-meta">' + escHtml(formatFreq(bookmark.freq_hz) + " " + bookmark.mode + " · " + decoders.join("/").toUpperCase()) + '</span>';
row.querySelector("input").addEventListener("change", function (e) { row.querySelector<HTMLInputElement>("input")?.addEventListener("change", function (e) {
onChecklistToggle(bookmark.id, e.target.checked); onChecklistToggle(bookmark.id, (e.currentTarget as HTMLInputElement).checked);
}); });
container.appendChild(row); container.appendChild(row);
}); });
} }
function onChecklistToggle(bookmarkId, checked) { function onChecklistToggle(bookmarkId: string, checked: boolean): void {
if (!currentConfig) { if (!currentConfig) {
currentConfig = { remote: currentRigId, enabled: false, bookmark_ids: [] }; currentConfig = { remote: currentRigId, enabled: false, bookmark_ids: [] };
} }
@@ -192,12 +237,12 @@
function saveBackgroundDecode() { function saveBackgroundDecode() {
const rigId = currentRigId; const rigId = currentRigId;
if (!rigId) return; if (!rigId) return;
const payload = { const payload: BackgroundDecodeConfig = {
remote: rigId, remote: rigId,
enabled: !!document.getElementById("background-decode-enabled").checked, enabled: (document.getElementById("background-decode-enabled") as HTMLInputElement | null)?.checked ?? false,
bookmark_ids: Array.isArray(currentConfig && currentConfig.bookmark_ids) ? currentConfig.bookmark_ids.slice() : [], bookmark_ids: currentConfig?.bookmark_ids.slice() ?? [],
}; };
const btn = document.getElementById("background-decode-save-btn"); const btn = document.getElementById("background-decode-save-btn") as HTMLButtonElement | null;
if (btn) btn.disabled = true; if (btn) btn.disabled = true;
apiPutConfig(rigId, payload) apiPutConfig(rigId, payload)
.then(function (saved) { .then(function (saved) {
@@ -205,10 +250,10 @@
renderBackgroundDecode(); renderBackgroundDecode();
clearBgdDirty(); clearBgdDirty();
pollBackgroundDecodeStatus(); pollBackgroundDecodeStatus();
showToast("Background decode saved."); showToast("Background decode saved.", false);
}) })
.catch(function (err) { .catch(function (err: unknown) {
showToast("Save failed: " + err.message, true); showToast(`Save failed: ${errorMessage(err)}`, true);
}) })
.finally(function () { .finally(function () {
if (btn) btn.disabled = false; if (btn) btn.disabled = false;
@@ -218,17 +263,17 @@
async function resetBackgroundDecode() { async function resetBackgroundDecode() {
const rigId = currentRigId; const rigId = currentRigId;
if (!rigId) return; if (!rigId) return;
if (!await window.trxUi.confirm({ title: "Reset background decoding?", message: "The current background decode configuration will be permanently reset.", confirmLabel: "Reset" })) return; if (!await bgdWindow.trxUi.confirm({ title: "Reset background decoding?", message: "The current background decode configuration will be permanently reset.", confirmLabel: "Reset" })) return;
apiResetConfig(rigId) apiResetConfig(rigId)
.then(function (saved) { .then(function (saved) {
currentConfig = saved; currentConfig = saved;
renderBackgroundDecode(); renderBackgroundDecode();
clearBgdDirty(); clearBgdDirty();
pollBackgroundDecodeStatus(); pollBackgroundDecodeStatus();
showToast("Background decode reset."); showToast("Background decode reset.", false);
}) })
.catch(function (err) { .catch(function (err: unknown) {
showToast("Reset failed: " + err.message, true); showToast(`Reset failed: ${errorMessage(err)}`, true);
}); });
} }
@@ -245,18 +290,18 @@
.catch(function () {}); .catch(function () {});
} }
function renderStatus(status) { function renderStatus(status: BackgroundDecodeStatus): void {
const card = document.getElementById("background-decode-status-card"); const card = document.getElementById("background-decode-status-card");
if (!card) return; if (!card) return;
const entries = Array.isArray(status && status.entries) ? status.entries : []; const entries = status.entries ?? [];
if (!entries.length) { if (!entries.length) {
card.textContent = "No background decode bookmarks configured."; card.textContent = "No background decode bookmarks configured.";
return; return;
} }
const summary = []; const summary = [];
if (status.active_rig) { if (status.active_rig) {
if (Number.isFinite(status.center_hz)) summary.push("Center " + formatFreq(status.center_hz)); if (typeof status.center_hz === "number" && Number.isFinite(status.center_hz)) summary.push("Center " + formatFreq(status.center_hz));
if (Number.isFinite(status.sample_rate) && status.sample_rate > 0) summary.push("Span ±" + formatFreq(status.sample_rate / 2)); if (typeof status.sample_rate === "number" && Number.isFinite(status.sample_rate) && status.sample_rate > 0) summary.push("Span ±" + formatFreq(status.sample_rate / 2));
} else { } else {
summary.push("This rig is not currently selected for audio."); summary.push("This rig is not currently selected for audio.");
} }
@@ -265,7 +310,7 @@
entries.forEach(function (entry) { entries.forEach(function (entry) {
const name = entry.bookmark_name || entry.bookmark_id || "Unknown bookmark"; const name = entry.bookmark_name || entry.bookmark_id || "Unknown bookmark";
const parts = []; const parts = [];
if (Number.isFinite(entry.freq_hz)) parts.push(formatFreq(entry.freq_hz)); if (typeof entry.freq_hz === "number" && Number.isFinite(entry.freq_hz)) parts.push(formatFreq(entry.freq_hz));
if (entry.mode) parts.push(entry.mode); if (entry.mode) parts.push(entry.mode);
if (Array.isArray(entry.decoder_kinds) && entry.decoder_kinds.length) { if (Array.isArray(entry.decoder_kinds) && entry.decoder_kinds.length) {
parts.push(entry.decoder_kinds.join("/").toUpperCase()); parts.push(entry.decoder_kinds.join("/").toUpperCase());
@@ -285,7 +330,7 @@
card.innerHTML = html; card.innerHTML = html;
} }
function prettyState(state) { function prettyState(state: string | undefined): string {
switch (state) { switch (state) {
case "active": return "\u2713 Active"; case "active": return "\u2713 Active";
case "out_of_span": return "\u25B3 Out of span"; case "out_of_span": return "\u25B3 Out of span";
@@ -301,40 +346,47 @@
} }
} }
function setCheckbox(id, value) { function setCheckbox(id: string, value: boolean): void {
const el = document.getElementById(id); const el = document.getElementById(id) as HTMLInputElement | null;
if (el) el.checked = !!value; if (el) el.checked = value;
} }
function formatFreq(hz) { function formatFreq(hz: number): string {
if (!Number.isFinite(hz) || hz <= 0) return "--"; if (!Number.isFinite(hz) || hz <= 0) return "--";
if (hz >= 1e6) return (hz / 1e6).toFixed(3).replace(/\.?0+$/, "") + " MHz"; if (hz >= 1e6) return (hz / 1e6).toFixed(3).replace(/\.?0+$/, "") + " MHz";
if (hz >= 1e3) return (hz / 1e3).toFixed(1).replace(/\.?0+$/, "") + " kHz"; if (hz >= 1e3) return (hz / 1e3).toFixed(1).replace(/\.?0+$/, "") + " kHz";
return hz + " Hz"; return `${String(hz)} Hz`;
} }
function escHtml(value) { function escHtml(value: unknown): string {
return String(value == null ? "" : value) const text = typeof value === "string" || typeof value === "number" || typeof value === "boolean"
? String(value)
: "";
return text
.replace(/&/g, "&amp;") .replace(/&/g, "&amp;")
.replace(/</g, "&lt;") .replace(/</g, "&lt;")
.replace(/>/g, "&gt;") .replace(/>/g, "&gt;")
.replace(/"/g, "&quot;"); .replace(/"/g, "&quot;");
} }
function errorMessage(error: unknown): string {
return error instanceof Error ? error.message : String(error);
}
function markBgdDirty() { function markBgdDirty() {
if (bgdDirty) return; if (bgdDirty) return;
bgdDirty = true; bgdDirty = true;
var btn = document.getElementById("background-decode-save-btn"); const btn = document.getElementById("background-decode-save-btn");
if (btn) btn.classList.add("sch-dirty"); if (btn) btn.classList.add("sch-dirty");
} }
function clearBgdDirty() { function clearBgdDirty() {
bgdDirty = false; bgdDirty = false;
var btn = document.getElementById("background-decode-save-btn"); const btn = document.getElementById("background-decode-save-btn");
if (btn) btn.classList.remove("sch-dirty"); if (btn) btn.classList.remove("sch-dirty");
} }
function showToast(msg, isError) { function showToast(msg: string, isError: boolean): void {
const el = document.getElementById("background-decode-toast"); const el = document.getElementById("background-decode-toast");
if (!el) return; if (!el) return;
el.textContent = msg; el.textContent = msg;
@@ -349,9 +401,9 @@
if (!currentConfig) { if (!currentConfig) {
currentConfig = { remote: currentRigId, enabled: false, bookmark_ids: [] }; currentConfig = { remote: currentRigId, enabled: false, bookmark_ids: [] };
} }
var ids = supportedBookmarks().map(function (bm) { return bm.id; }); const ids = supportedBookmarks().map(function (bm) { return bm.id; });
currentConfig.bookmark_ids = ids; currentConfig.bookmark_ids = ids;
renderBookmarkChecklist(document.getElementById("bgd-bookmark-filter")?.value); renderBookmarkChecklist((document.getElementById("bgd-bookmark-filter") as HTMLInputElement | null)?.value);
markBgdDirty(); markBgdDirty();
} }
@@ -360,12 +412,12 @@
currentConfig = { remote: currentRigId, enabled: false, bookmark_ids: [] }; currentConfig = { remote: currentRigId, enabled: false, bookmark_ids: [] };
} }
currentConfig.bookmark_ids = []; currentConfig.bookmark_ids = [];
renderBookmarkChecklist(document.getElementById("bgd-bookmark-filter")?.value); renderBookmarkChecklist((document.getElementById("bgd-bookmark-filter") as HTMLInputElement | null)?.value);
markBgdDirty(); markBgdDirty();
} }
function wireBackgroundDecodeEvents() { function wireBackgroundDecodeEvents() {
const filterInput = document.getElementById("bgd-bookmark-filter"); const filterInput = document.getElementById("bgd-bookmark-filter") as (HTMLInputElement & WiredElement) | null;
if (filterInput && !filterInput._wired) { if (filterInput && !filterInput._wired) {
filterInput._wired = true; filterInput._wired = true;
filterInput.addEventListener("input", function () { filterInput.addEventListener("input", function () {
@@ -373,38 +425,38 @@
}); });
} }
const enabledCb = document.getElementById("background-decode-enabled"); const enabledCb = document.getElementById("background-decode-enabled") as (HTMLInputElement & WiredElement) | null;
if (enabledCb && !enabledCb._wired) { if (enabledCb && !enabledCb._wired) {
enabledCb._wired = true; enabledCb._wired = true;
enabledCb.addEventListener("change", function () { markBgdDirty(); }); enabledCb.addEventListener("change", function () { markBgdDirty(); });
} }
const selectAllBtn = document.getElementById("bgd-select-all-btn"); const selectAllBtn = document.getElementById("bgd-select-all-btn") as WiredElement | null;
if (selectAllBtn && !selectAllBtn._wired) { if (selectAllBtn && !selectAllBtn._wired) {
selectAllBtn._wired = true; selectAllBtn._wired = true;
selectAllBtn.addEventListener("click", selectAllBookmarks); selectAllBtn.addEventListener("click", selectAllBookmarks);
} }
const deselectAllBtn = document.getElementById("bgd-deselect-all-btn"); const deselectAllBtn = document.getElementById("bgd-deselect-all-btn") as WiredElement | null;
if (deselectAllBtn && !deselectAllBtn._wired) { if (deselectAllBtn && !deselectAllBtn._wired) {
deselectAllBtn._wired = true; deselectAllBtn._wired = true;
deselectAllBtn.addEventListener("click", deselectAllBookmarks); deselectAllBtn.addEventListener("click", deselectAllBookmarks);
} }
const saveBtn = document.getElementById("background-decode-save-btn"); const saveBtn = document.getElementById("background-decode-save-btn") as WiredElement | null;
if (saveBtn && !saveBtn._wired) { if (saveBtn && !saveBtn._wired) {
saveBtn._wired = true; saveBtn._wired = true;
saveBtn.addEventListener("click", saveBackgroundDecode); saveBtn.addEventListener("click", saveBackgroundDecode);
} }
const resetBtn = document.getElementById("background-decode-reset-btn"); const resetBtn = document.getElementById("background-decode-reset-btn") as WiredElement | null;
if (resetBtn && !resetBtn._wired) { if (resetBtn && !resetBtn._wired) {
resetBtn._wired = true; resetBtn._wired = true;
resetBtn.addEventListener("click", resetBackgroundDecode); resetBtn.addEventListener("click", () => { void resetBackgroundDecode(); });
} }
} }
window.initBackgroundDecode = initBackgroundDecode; bgdWindow.initBackgroundDecode = initBackgroundDecode;
window.wireBackgroundDecodeEvents = wireBackgroundDecodeEvents; bgdWindow.wireBackgroundDecodeEvents = wireBackgroundDecodeEvents;
window.setBackgroundDecodeRig = setBackgroundDecodeRig; bgdWindow.setBackgroundDecodeRig = setBackgroundDecodeRig;
})(); })();
src/trx-client/trx-frontend/trx-frontend-http/frontend/tests/background-decode.test.mjs
+46
View File
@@ -0,0 +1,46 @@
// SPDX-FileCopyrightText: 2026 Stan Grams <sjg@haxx.space>
//
// SPDX-License-Identifier: GPL-2.0-or-later
import assert from "node:assert/strict";
import { readFile } from "node:fs/promises";
import test from "node:test";
import vm from "node:vm";
test("background decode loads configuration for the explicitly selected rig", async () => {
const requested = [];
const window = {
decoderRegistry: [],
trxUi: { confirm: async () => true },
};
const context = vm.createContext({
window,
document: { getElementById: () => null },
fetch: async (url) => {
requested.push(url);
return {
ok: true,
json: async () => url === "/bookmarks"
? []
: url.endsWith("/status")
? { entries: [] }
: { remote: "rig/a", enabled: false, bookmark_ids: [] },
};
},
setInterval: () => 1,
clearInterval() {},
setTimeout,
URL,
Set,
Error,
console,
});
const source = await readFile(new URL("../../assets/web/generated/background-decode.js", import.meta.url), "utf8");
new vm.Script(source).runInContext(context);
window.initBackgroundDecode("rig/a", "control");
await new Promise((resolve) => setTimeout(resolve, 0));
assert.ok(requested.includes("/background-decode/rig%2Fa"));
assert.ok(requested.includes("/bookmarks"));
assert.ok(requested.includes("/background-decode/rig%2Fa/status"));
});