@nordicsemiconductor/nrf-jlink-js 0.13.1 → 0.14.0

package/dist/index.d.ts

@@ -2,3 +2,4 @@ export type { Update as JLinkUpdate } from './shared/update';
 export { downloadAndInstallJLink, downloadAndSaveJLink } from './jlink';
 export { getJLinkState, type JLinkState } from './operations/getJLinkState';
 export { installJLink } from './operations/installJLink';
+export { getHostFirmwareVersions, isDebugProbeFirmwareUpdateAvailable, } from './operations/debugProbeFirmwares';

package/dist/index.js

@@ -5,7 +5,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.installJLink = exports.getJLinkState = exports.downloadAndSaveJLink = exports.downloadAndInstallJLink = void 0;
+exports.isDebugProbeFirmwareUpdateAvailable = exports.getHostFirmwareVersions = exports.installJLink = exports.getJLinkState = exports.downloadAndSaveJLink = exports.downloadAndInstallJLink = void 0;
 var jlink_1 = require("./jlink");
 Object.defineProperty(exports, "downloadAndInstallJLink", { enumerable: true, get: function () { return jlink_1.downloadAndInstallJLink; } });
 Object.defineProperty(exports, "downloadAndSaveJLink", { enumerable: true, get: function () { return jlink_1.downloadAndSaveJLink; } });
@@ -13,3 +13,6 @@ var getJLinkState_1 = require("./operations/getJLinkState");
 Object.defineProperty(exports, "getJLinkState", { enumerable: true, get: function () { return getJLinkState_1.getJLinkState; } });
 var installJLink_1 = require("./operations/installJLink");
 Object.defineProperty(exports, "installJLink", { enumerable: true, get: function () { return installJLink_1.installJLink; } });
+var debugProbeFirmwares_1 = require("./operations/debugProbeFirmwares");
+Object.defineProperty(exports, "getHostFirmwareVersions", { enumerable: true, get: function () { return debugProbeFirmwares_1.getHostFirmwareVersions; } });
+Object.defineProperty(exports, "isDebugProbeFirmwareUpdateAvailable", { enumerable: true, get: function () { return debugProbeFirmwares_1.isDebugProbeFirmwareUpdateAvailable; } });

package/dist/operations/debugProbeFirmwares.d.ts

@@ -0,0 +1,24 @@
+interface HostFirmwareInfo {
+    filePath: string;
+    compiledOn: Date;
+}
+interface HostFirmwares {
+    [key: string]: HostFirmwareInfo;
+}
+/**
+ * Reads the debug probe firmware files in the given JLink directory and returns
+ * a map of their IDs and compilation dates.
+ */
+export declare const getHostFirmwareVersions: (jlinkDir: string) => HostFirmwares;
+/**
+ * Returns whether a debug probe firmware update is available for the given device
+ * based on the host firmware versions.
+ *
+ * @param jlinkObFirmwareVersion The connected debug probe firmware version as returned by
+ *         `nrfutil --json --skip-overhead device device-info --serial-number ${serialNumber}`
+ * @param hostFirmwares The host firmware versions as returned by `getHostFirmwareVersions`
+ * @returns `true` if an update is available, `false` if not, or `undefined` if the
+ *          information is insufficient to determine this.
+ */
+export declare const isDebugProbeFirmwareUpdateAvailable: (jlinkObFirmwareVersion: string, hostFirmwares: HostFirmwares) => boolean | undefined;
+export {};

package/dist/operations/debugProbeFirmwares.js

@@ -0,0 +1,65 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDebugProbeFirmwareUpdateAvailable = exports.getHostFirmwareVersions = void 0;
+var node_fs_1 = require("node:fs");
+var node_path_1 = require("node:path");
+/**
+ * Reads the debug probe firmware files in the given JLink directory and returns
+ * a map of their IDs and compilation dates.
+ */
+var getHostFirmwareVersions = function (jlinkDir) {
+    var buffer = Buffer.alloc(64);
+    return Object.fromEntries((0, node_fs_1.readdirSync)((0, node_path_1.join)(jlinkDir, 'Firmwares'))
+        .map(function (file) {
+        var filePath = (0, node_path_1.join)(jlinkDir, 'Firmwares', file);
+        var fd = (0, node_fs_1.openSync)(filePath, 'r');
+        (0, node_fs_1.readSync)(fd, buffer, 0, buffer.length, 0);
+        var _a = buffer
+            .toString()
+            .split('\0')[0]
+            .split(' compiled '), id = _a[0], dateStr = _a[1];
+        (0, node_fs_1.closeSync)(fd);
+        return id && dateStr
+            ? [
+                id,
+                {
+                    filePath: filePath,
+                    compiledOn: new Date(dateStr),
+                },
+            ]
+            : undefined;
+    })
+        .filter(function (v) { return v !== undefined; }));
+};
+exports.getHostFirmwareVersions = getHostFirmwareVersions;
+/**
+ * Returns whether a debug probe firmware update is available for the given device
+ * based on the host firmware versions.
+ *
+ * @param jlinkObFirmwareVersion The connected debug probe firmware version as returned by
+ *         `nrfutil --json --skip-overhead device device-info --serial-number ${serialNumber}`
+ * @param hostFirmwares The host firmware versions as returned by `getHostFirmwareVersions`
+ * @returns `true` if an update is available, `false` if not, or `undefined` if the
+ *          information is insufficient to determine this.
+ */
+var isDebugProbeFirmwareUpdateAvailable = function (jlinkObFirmwareVersion, hostFirmwares) {
+    var _a;
+    var _b = jlinkObFirmwareVersion.split(' compiled '), deviceObFirmwareId = _b[0], deviceObFirmwareDateStr = _b[1];
+    if (!deviceObFirmwareId || !deviceObFirmwareDateStr) {
+        // No date info in firmware version
+        return;
+    }
+    var hostFwDate = (_a = hostFirmwares[deviceObFirmwareId]) === null || _a === void 0 ? void 0 : _a.compiledOn;
+    if (!hostFwDate) {
+        // No matching firmware found
+        return;
+    }
+    // Return true if host firmware is newer indicating an update is available
+    return hostFwDate > new Date(deviceObFirmwareDateStr);
+};
+exports.isDebugProbeFirmwareUpdateAvailable = isDebugProbeFirmwareUpdateAvailable;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nordicsemiconductor/nrf-jlink-js",
-    "version": "0.13.1",
+    "version": "0.14.0",
     "main": "dist",
     "types": "dist",
     "files": [