@nordicsemiconductor/pc-nrfconnect-shared 213.0.0 → 215.0.0

package/Changelog.md

@@ -7,6 +7,28 @@ This project does _not_ adhere to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html) but contrary to it
 every new version is a new major version.
 
+## 215.0.0 - 2025-06-27
+
+### Added
+
+-   `generateSystemReport` now includes relevant app information.
+
+### Changed
+
+-   StateSelector:Refactored with tailwind. Added `size` prop to control the
+    height of the selector.
+
+## 214.0.0 - 2025-06-17
+
+### Changed
+
+-   macOS: Removed check if the universal variant of J-Link is used.
+
+### Fixed
+
+-   While publishing apps, updated files on files.nordicsemi.com might become
+    stale on files.nordicsemi.cn.
+
 ## 213.0.0 - 2025-06-11
 
 ### Fixed
@@ -19,10 +41,20 @@ every new version is a new major version.
 
 -   Specify what core version of nrfutil an app depends on.
 
+### Removed
+
+-   Function `prepareSandbox`.
+
+### Changed
+
+-   Signature of `xRead`.
+
 ### Steps to upgrade when using this package
 
 -   In apps in `package.json` set the field `nrfConnectForDesktop.nrfutilCore`
     to the core version of nrfutil that the nrfutil commands will use.
+-   Replace usage of `prepareSandbox` with `NrfutilSandbox.create`
+-   Update calls of `xRead`.
 
 ## 211.0.0 - 2025-05-29
 

package/nrfutil/collectingResultParser.ts

@@ -0,0 +1,82 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { convertNrfutilProgress, parseJsonBuffers } from './common';
+import type {
+    NrfutilJson,
+    OnLog,
+    OnProgress,
+    OnTaskBegin,
+    OnTaskEnd,
+    TaskEnd,
+} from './sandboxTypes';
+
+const addPunctuation = (str: string) =>
+    str.endsWith('.') ? str.trim() : `${str.trim()}.`;
+
+export default class CollectingResultParser<Result> {
+    private readonly info: Result[] = [];
+    private readonly taskEnd: TaskEnd<Result>[] = [];
+
+    // eslint-disable-next-line no-useless-constructor
+    constructor(
+        private onLog: OnLog,
+        private onProgress?: OnProgress,
+        private onTaskBegin?: OnTaskBegin,
+        private onTaskEnd?: OnTaskEnd<Result>
+    ) {}
+
+    public handleData = (data: Buffer, pid?: number) => {
+        const parsedData: NrfutilJson<Result>[] | undefined =
+            parseJsonBuffers(data);
+
+        if (!parsedData) {
+            return data;
+        }
+
+        const processItem = (item: NrfutilJson<Result>) => {
+            switch (item.type) {
+                case 'task_progress':
+                    this.onProgress?.(
+                        convertNrfutilProgress(item.data.progress),
+                        item.data.task
+                    );
+                    break;
+                case 'task_begin':
+                    this.onTaskBegin?.(item.data);
+                    break;
+                case 'task_end':
+                    this.taskEnd.push(item.data);
+                    this.onTaskEnd?.(item.data);
+                    break;
+                case 'info':
+                    this.info.push(item.data);
+                    break;
+                case 'log':
+                    this.onLog(item.data, pid);
+                    break;
+                case 'batch_update':
+                    processItem(item.data.data);
+                    break;
+            }
+        };
+
+        parsedData.forEach(processItem);
+    };
+
+    public hasFailures = () =>
+        this.taskEnd.filter(({ result }) => result === 'fail').length > 0;
+
+    public errorMessage = () =>
+        this.taskEnd
+            .filter(end => end.result === 'fail' && !!end.message)
+            .map(end =>
+                end.message ? `Message: ${addPunctuation(end.message)}` : ''
+            )
+            .join('\n');
+
+    public result = () => ({ taskEnd: this.taskEnd, info: this.info });
+}

package/nrfutil/common.ts

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import type { NrfutilProgress, Progress } from './sandboxTypes';
+
+export const convertNrfutilProgress = (progress: NrfutilProgress): Progress => {
+    const amountOfSteps = progress.amountOfSteps ?? 1;
+    const step = progress.step ?? 1;
+
+    const singleStepWeight = (1 / amountOfSteps) * 100;
+
+    const totalProgressPercentage =
+        singleStepWeight * (step - 1) +
+        progress.progressPercentage / amountOfSteps;
+
+    return {
+        ...progress,
+        stepProgressPercentage: progress.progressPercentage,
+        totalProgressPercentage,
+        amountOfSteps,
+        step,
+    };
+};
+
+export const parseJsonBuffers = <T>(data: Buffer): T[] | undefined => {
+    const dataString = data.toString().trim();
+    if (!dataString.endsWith('}')) {
+        return undefined;
+    }
+    try {
+        return JSON.parse(`[${dataString.replaceAll('}\n{', '}\n,{')}]`) ?? [];
+    } catch {
+        return undefined;
+    }
+};
+
+export const collectErrorMessages = (...messages: (string | undefined)[]) =>
+    messages.filter(Boolean).join('\n').replaceAll('Error: ', '');

package/nrfutil/device/batch.ts

@@ -5,14 +5,12 @@
  */
 
 import fs from 'fs';
-import os from 'os';
-import path from 'path';
-import { v4 as uuid } from 'uuid';
 
 import { getModule } from '..';
 import { TaskEnd } from '../sandboxTypes';
 import { BatchOperationWrapper, Callbacks } from './batchTypes';
 import {
+    coreArg,
     DeviceCore,
     DeviceTraits,
     deviceTraitsToArgs,
@@ -23,11 +21,18 @@ import { DeviceCoreInfo } from './getCoreInfo';
 import { FWInfo } from './getFwInfo';
 import { GetProtectionStatusResult } from './getProtectionStatus';
 import {
-    FirmwareType,
+    createTempFile,
+    Firmware,
     ProgrammingOptions,
     programmingOptionsToArgs,
 } from './program';
-import { MemoryReadRaw, ReadResult, toIntelHex } from './xRead';
+import {
+    MemoryReadRaw,
+    ReadResult,
+    toIntelHex,
+    type XReadOptions,
+    xReadOptionsToArgs,
+} from './xRead';
 
 type BatchOperationWrapperUnknown = BatchOperationWrapper<unknown>;
 type CallbacksUnknown = Callbacks<unknown>;
@@ -45,7 +50,7 @@ export class Batch {
     private enqueueBatchOperationObject(
         command: string,
         core: DeviceCore,
-        callbacks?: Callbacks<unknown>,
+        callbacks?: CallbacksUnknown,
         args: string[] = []
     ) {
         const getPromise = async () => {
@@ -55,9 +60,7 @@ export class Batch {
                 await box.singleInfoOperationOptionalData<object>(
                     command,
                     undefined,
-                    ['--generate', ...(core ? ['--core', core] : [])].concat(
-                        args
-                    )
+                    ['--generate', ...coreArg(core), ...args]
                 );
 
             return {
@@ -160,28 +163,9 @@ export class Batch {
 
     public xRead(
         core: DeviceCore,
-        address: number,
-        bytes: number,
-        width?: 8 | 15 | 32,
-        direct?: boolean,
+        options: XReadOptions,
         callbacks?: Callbacks<ReadResult>
     ) {
-        const args: string[] = [
-            '--address',
-            address.toString(),
-            '--bytes',
-            bytes.toString(),
-        ];
-
-        if (direct) {
-            args.push('--direct');
-        }
-
-        if (width) {
-            args.push('--width');
-            args.push(width.toString());
-        }
-
         this.enqueueBatchOperationObject(
             'x-read',
             core,
@@ -204,7 +188,7 @@ export class Batch {
                     }
                 },
             } as CallbacksUnknown,
-            args
+            xReadOptionsToArgs(options)
         );
 
         return this;
@@ -247,52 +231,31 @@ export class Batch {
     }
 
     public program(
-        firmware: FirmwareType,
+        firmware: Firmware,
         core: DeviceCore,
         programmingOptions?: ProgrammingOptions,
         deviceTraits?: DeviceTraits,
-        callbacks?: Callbacks
+        callbacks?: CallbacksUnknown
     ) {
-        let args = [
+        const args = [
             ...(deviceTraits ? deviceTraitsToArgs(deviceTraits) : []),
             ...programmingOptionsToArgs(programmingOptions),
         ];
-        let newCallbacks = { ...callbacks };
+        const newCallbacks = { ...callbacks };
 
         if (typeof firmware === 'string') {
-            args = ['--firmware', firmware].concat(args);
+            args.unshift('--firmware', firmware);
         } else {
-            const saveTemp = (): string => {
-                let tempFilePath;
-                do {
-                    tempFilePath = path.join(
-                        os.tmpdir(),
-                        `${uuid()}.${firmware.type}`
-                    );
-                } while (fs.existsSync(tempFilePath));
+            const tempFilePath = createTempFile(firmware);
+            args.unshift('--firmware', tempFilePath);
 
-                fs.writeFileSync(tempFilePath, firmware.buffer);
-
-                return tempFilePath;
+            newCallbacks.onTaskEnd = (taskEnd: TaskEnd<unknown>) => {
+                fs.unlinkSync(tempFilePath);
+                callbacks?.onTaskEnd?.(taskEnd);
             };
-            const tempFilePath = saveTemp();
-            args = ['--firmware', tempFilePath].concat(args);
-
-            newCallbacks = {
-                ...callbacks,
-                onTaskEnd: (taskEnd: TaskEnd<void>) => {
-                    fs.unlinkSync(tempFilePath);
-                    callbacks?.onTaskEnd?.(taskEnd);
-                },
-            } as CallbacksUnknown;
         }
 
-        this.enqueueBatchOperationObject(
-            'program',
-            core,
-            newCallbacks as CallbacksUnknown,
-            args
-        );
+        this.enqueueBatchOperationObject('program', core, newCallbacks, args);
 
         return this;
     }

package/nrfutil/device/batchTypes.ts

@@ -4,27 +4,21 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { Progress, Task, TaskBegin, TaskEnd } from '../sandboxTypes';
-import { DeviceCore, ResetKind } from './common';
-import {
-    isJLinkProgrammingOptions,
-    isMcuBootProgrammingOptions,
-    isNordicDfuProgrammingOptions,
-    ProgrammingOptions,
-} from './program';
+import type { OnProgress, OnTaskBegin, OnTaskEnd } from '../sandboxTypes';
+import { type DeviceCore, type ResetKind } from './common';
 
 export interface BatchOperationWrapper<T = void> {
     operation: object;
-    onProgress?: (progress: Progress, task?: Task) => void;
-    onTaskBegin?: TaskBeginCallback;
-    onTaskEnd?: TaskEndCallback<T>;
+    onProgress?: OnProgress;
+    onTaskBegin?: OnTaskBegin;
+    onTaskEnd?: OnTaskEnd<T>;
     onException?: (error: Error) => void;
 }
 
 export type Callbacks<T = void> = {
-    onTaskBegin?: TaskBeginCallback;
-    onTaskEnd?: TaskEndCallback<T>;
-    onProgress?: (progress: Progress, task?: Task) => void;
+    onTaskBegin?: OnTaskBegin;
+    onTaskEnd?: OnTaskEnd<T>;
+    onProgress?: OnProgress;
     onException?: (error: Error) => void;
 };
 
@@ -44,35 +38,6 @@ export const convertDeviceCoreType = (core?: DeviceCore) => {
     }
 };
 
-export const convertProgrammingOptionsType = (
-    programmingOptions?: ProgrammingOptions
-) => {
-    if (!programmingOptions) {
-        return undefined;
-    }
-
-    if (isJLinkProgrammingOptions(programmingOptions)) {
-        return {
-            qspi_erase_mode: programmingOptions.chipEraseMode,
-            reset: programmingOptions.reset,
-            verify: programmingOptions.verify,
-        };
-    }
-
-    if (isMcuBootProgrammingOptions(programmingOptions)) {
-        return {
-            mcu_end_state: programmingOptions.mcuEndState,
-            net_core_upload_delay: programmingOptions.netCoreUploadDelay,
-        };
-    }
-
-    if (isNordicDfuProgrammingOptions(programmingOptions)) {
-        return {
-            mcu_end_state: programmingOptions.mcuEndState,
-        };
-    }
-};
-
 export interface ProgrammingOperation {
     type: 'program';
     firmware: {
@@ -128,6 +93,3 @@ export type BatchOperation =
     | EraseOperation
     | GetCoreInfoOperation
     | GetFwInfoOperation;
-
-export type TaskEndCallback<T = void> = (end: TaskEnd<T>) => void;
-export type TaskBeginCallback = (begin: TaskBegin) => void;

package/nrfutil/device/boardController.ts

@@ -4,13 +4,13 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { Progress } from '../sandboxTypes';
+import { type OnProgress } from '../sandboxTypes';
 import { deviceSingleTaskEndOperationVoid, NrfutilDevice } from './common';
 
 export default (
     device: NrfutilDevice,
     data: object,
-    onProgress?: (progress: Progress) => void,
+    onProgress?: OnProgress,
     controller?: AbortController
 ) => {
     // "operation: 2, command_id: 0" is the command to set the configuration for the board controller.

package/nrfutil/device/common.ts

@@ -5,21 +5,15 @@
  */
 
 import { getModule } from '../modules';
-import { Progress } from '../sandboxTypes';
+import { type OnProgress } from '../sandboxTypes';
 
 export const deviceTraitsToArgs = (traits: DeviceTraits) => {
-    const args: string[] = [];
     const traitsString = Object.keys(traits)
         .map(trait => (traits[trait as keyof DeviceTraits] ? trait : null))
         .filter(t => t !== null)
         .join(',');
 
-    if (traitsString.length > 0) {
-        args.push('--traits');
-        args.push(traitsString);
-    }
-
-    return args;
+    return traitsString.length > 0 ? ['--traits', traitsString] : [];
 };
 
 export type ResetKind =
@@ -157,7 +151,7 @@ export interface SerialPort {
 export const deviceSingleTaskEndOperation = async <T = void>(
     device: NrfutilDevice,
     command: string,
-    onProgress?: (progress: Progress) => void,
+    onProgress?: OnProgress,
     controller?: AbortController,
     args: string[] = []
 ) => {
@@ -178,7 +172,7 @@ export const deviceSingleTaskEndOperation = async <T = void>(
 export const deviceSingleTaskEndOperationVoid = async (
     device: NrfutilDevice,
     command: string,
-    onProgress?: (progress: Progress) => void,
+    onProgress?: OnProgress,
     controller?: AbortController,
     args: string[] = []
 ) => {
@@ -196,3 +190,5 @@ export const deviceSingleTaskEndOperationVoid = async (
         [...args, '--serial-number', device.serialNumber]
     );
 };
+
+export const coreArg = (core?: DeviceCore) => (core ? ['--core', core] : []);

package/nrfutil/device/deviceInfo.ts

@@ -4,8 +4,9 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { Progress } from '../sandboxTypes';
+import { type OnProgress } from '../sandboxTypes';
 import {
+    coreArg,
     DeviceCore,
     deviceSingleTaskEndOperation,
     NrfutilDevice,
@@ -68,7 +69,7 @@ export interface DeviceInfoRaw {
 export default async (
     device: NrfutilDevice,
     core?: DeviceCore,
-    onProgress?: (progress: Progress) => void,
+    onProgress?: OnProgress,
     controller?: AbortController
 ) => {
     try {
@@ -81,7 +82,7 @@ export default async (
                       'device-info',
                       onProgress,
                       controller,
-                      core ? ['--core', core] : []
+                      coreArg(core)
                   )
               ).deviceInfo
             : undefined;

package/nrfutil/device/erase.ts

@@ -4,8 +4,9 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { Progress } from '../sandboxTypes';
+import { type OnProgress } from '../sandboxTypes';
 import {
+    coreArg,
     DeviceCore,
     deviceSingleTaskEndOperationVoid,
     NrfutilDevice,
@@ -14,7 +15,7 @@ import {
 export default (
     device: NrfutilDevice,
     core?: DeviceCore,
-    onProgress?: (progress: Progress) => void,
+    onProgress?: OnProgress,
     controller?: AbortController
 ) =>
     deviceSingleTaskEndOperationVoid(
@@ -22,5 +23,5 @@ export default (
         'erase',
         onProgress,
         controller,
-        core ? ['--core', core] : []
+        coreArg(core)
     );

package/nrfutil/device/getBoardControllerConfig.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { Progress } from '../sandboxTypes';
+import { type OnProgress } from '../sandboxTypes';
 import { deviceSingleTaskEndOperation, NrfutilDevice } from './common';
 
 export interface BoardControllerConfigResponse {
@@ -15,7 +15,7 @@ export interface BoardControllerConfigResponse {
 
 export default (
     device: NrfutilDevice,
-    onProgress?: (progress: Progress) => void,
+    onProgress?: OnProgress,
     controller?: AbortController
 ) => {
     // "operation: 0, command_id: 0" is the command to retrieve the configuration from the board controller.

package/nrfutil/device/getBoardControllerVersion.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { Progress } from '../sandboxTypes';
+import { type OnProgress } from '../sandboxTypes';
 import { deviceSingleTaskEndOperation, NrfutilDevice } from './common';
 
 export interface BoardControllerVersionResponse {
@@ -22,7 +22,7 @@ export interface BoardControllerVersion {
 
 export default (
     device: NrfutilDevice,
-    onProgress?: (progress: Progress) => void,
+    onProgress?: OnProgress,
     controller?: AbortController
 ) => {
     // "operation: 0, command_id: 1" is the command to retrieve version information from the board controller.

package/nrfutil/device/getCoreInfo.ts

@@ -4,8 +4,9 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { Progress } from '../sandboxTypes';
+import { type OnProgress } from '../sandboxTypes';
 import {
+    coreArg,
     DeviceCore,
     deviceSingleTaskEndOperation,
     NrfutilDevice,
@@ -32,7 +33,7 @@ export type DeviceCoreInfo = {
 export default (
     device: NrfutilDevice,
     core?: DeviceCore,
-    onProgress?: (progress: Progress) => void,
+    onProgress?: OnProgress,
     controller?: AbortController
 ) =>
     deviceSingleTaskEndOperation<DeviceCoreInfo>(
@@ -40,5 +41,5 @@ export default (
         'core-info',
         onProgress,
         controller,
-        core ? ['--core', core] : []
+        coreArg(core)
     );

package/nrfutil/device/getFwInfo.ts

@@ -4,8 +4,9 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { Progress } from '../sandboxTypes';
+import { type OnProgress } from '../sandboxTypes';
 import {
+    coreArg,
     DeviceCore,
     deviceSingleTaskEndOperation,
     NrfutilDevice,
@@ -57,7 +58,7 @@ export interface FWInfo {
 export default (
     device: NrfutilDevice,
     core?: DeviceCore,
-    onProgress?: (progress: Progress) => void,
+    onProgress?: OnProgress,
     controller?: AbortController
 ) =>
     deviceSingleTaskEndOperation<FWInfo>(
@@ -65,5 +66,5 @@ export default (
         'fw-info',
         onProgress,
         controller,
-        core ? ['--core', core] : []
+        coreArg(core)
     );

package/nrfutil/device/getProtectionStatus.ts

@@ -4,8 +4,9 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { Progress } from '../sandboxTypes';
+import { type OnProgress } from '../sandboxTypes';
 import {
+    coreArg,
     DeviceCore,
     deviceSingleTaskEndOperation,
     NrfutilDevice,
@@ -28,7 +29,7 @@ export interface GetProtectionStatusResult {
 export default (
     device: NrfutilDevice,
     core?: DeviceCore,
-    onProgress?: (progress: Progress) => void,
+    onProgress?: OnProgress,
     controller?: AbortController
 ) =>
     deviceSingleTaskEndOperation<GetProtectionStatusResult>(
@@ -36,5 +37,5 @@ export default (
         'protection-get',
         onProgress,
         controller,
-        core ? ['--core', core] : []
+        coreArg(core)
     );

package/nrfutil/device/list.ts

@@ -34,16 +34,11 @@ export default async (
     },
     timeout?: number
 ) => {
-    const args: string[] = deviceTraitsToArgs(traits);
-
-    if (onHotplugEvent) {
-        args.push('--hotplug');
-    }
-
-    if (timeout !== undefined) {
-        args.push('--timeout-ms');
-        args.push(timeout.toString());
-    }
+    const args = [
+        ...deviceTraitsToArgs(traits),
+        ...(onHotplugEvent ? ['--hotplug'] : []),
+        ...(timeout !== undefined ? ['--timeout-ms', timeout.toString()] : []),
+    ];
 
     const onData = (data: HotplugEvent | ListEvent) => {
         if (isListEvent(data)) {