@nordicsemiconductor/pc-nrfconnect-shared 89.0.0 → 91.0.0

package/src/Device/sdfuOperations.ts

@@ -4,17 +4,17 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import nrfDeviceLib from '@nordicsemiconductor/nrf-device-lib-js';
 import AdmZip from 'adm-zip';
 import { createHash } from 'crypto';
 import fs from 'fs';
 import MemoryMap from 'nrf-intel-hex';
 
+import NrfutilDeviceLib from '../../nrfutil/device/device';
+import { McuState } from '../../nrfutil/device/setMcuState';
 import logger from '../logging';
 import { AppThunk, RootState } from '../store';
 import { getAppFile } from '../utils/appDirs';
 import { setWaitForDevice } from './deviceAutoSelectSlice';
-import { getDeviceLibContext } from './deviceLibWrapper';
 import { DeviceSetup, DfuEntry } from './deviceSetup';
 import { openDeviceSetupDialog } from './deviceSetupSlice';
 import { Device } from './deviceSlice';
@@ -63,10 +63,7 @@ export const ensureBootloaderMode = (device: Device) => {
 };
 
 const getBootloaderInformation = async (device: Device) => {
-    const info = await nrfDeviceLib.readFwInfo(
-        getDeviceLibContext(),
-        device.id
-    );
+    const info = await NrfutilDeviceLib.getFwInfo(device);
 
     const index = info.imageInfoList.findIndex(
         imageInfo => imageInfo.imageType === 'NRFDL_IMAGE_TYPE_BOOTLOADER'
@@ -106,76 +103,67 @@ const updateBootloader =
                 onFail,
             })
         );
-        await nrfDeviceLib.firmwareProgram(
-            getDeviceLibContext(),
-            device.id,
-            'NRFDL_FW_BUFFER',
-            'NRFDL_FW_SDFU_ZIP',
-            zipBuffer,
-            err => {
-                if (err) {
-                    logger.error(
-                        `Failed to write bootloader to the target device: ${
-                            err.message || err
-                        }`
-                    );
-                    onFail(err.message);
-                } else {
-                    dispatch(
-                        setWaitForDevice({
-                            timeout: DEFAULT_DEVICE_WAIT_TIME,
-                            when: 'always',
-                            once: true,
-                            onSuccess,
-                            onFail,
-                        })
-                    );
 
-                    onProgress(100, 'Bootloader updated');
-                    logger.info(
-                        'Bootloader has been written to the target device'
+        try {
+            await NrfutilDeviceLib.program(
+                device,
+                { buffer: zipBuffer, type: 'zip' },
+                progress => {
+                    onProgress(
+                        progress.progressPercentage,
+                        progress.message ?? 'Programming bootloader'
                     );
-                    logger.debug('Bootloader DFU completed successfully!');
                 }
-            },
-            progress => {
-                onProgress(
-                    progress.progressJson.progressPercentage,
-                    progress.progressJson.message ?? 'Programming bootloader'
+            );
+        } catch (error) {
+            if (error) {
+                logger.error(
+                    `Failed to write bootloader to the target device: ${
+                        (error as Error).message || error
+                    }`
+                );
+                onFail((error as Error).message || error);
+            } else {
+                dispatch(
+                    setWaitForDevice({
+                        timeout: DEFAULT_DEVICE_WAIT_TIME,
+                        when: 'always',
+                        once: true,
+                        onSuccess,
+                        onFail,
+                    })
                 );
+
+                onProgress(100, 'Bootloader updated');
+                logger.info('Bootloader has been written to the target device');
+                logger.debug('Bootloader DFU completed successfully!');
             }
-        );
+        }
     };
 
 const switchToDeviceMode =
     (
         device: Device,
-        mcuState: nrfDeviceLib.MCUState,
+        mcuState: McuState,
         onSuccess: (device: Device) => void,
         onFail: (reason?: unknown) => void
     ): AppThunk =>
     dispatch => {
-        nrfDeviceLib
-            .deviceControlSetMcuState(
-                getDeviceLibContext(),
-                device.id,
-                mcuState
-            )
-            .then(() => {
-                dispatch(
-                    setWaitForDevice({
-                        timeout: 10000,
-                        when:
-                            mcuState === 'NRFDL_MCU_STATE_APPLICATION'
-                                ? 'applicationMode'
-                                : 'dfuBootLoaderMode',
-                        once: true,
-                        onSuccess,
-                        onFail,
-                    })
-                );
+        dispatch(
+            setWaitForDevice({
+                timeout: 10000,
+                when:
+                    mcuState === 'Application'
+                        ? 'applicationMode'
+                        : 'dfuBootLoaderMode',
+                once: true,
+                onSuccess,
+                onFail,
             })
-            .catch(err => onFail(err));
+        );
+        NrfutilDeviceLib.setMcuState(device, mcuState).catch(err =>
+            onFail(err)
+        );
     };
 
 export const switchToBootloaderMode =
@@ -189,7 +177,7 @@ export const switchToBootloaderMode =
             dispatch(
                 switchToDeviceMode(
                     device,
-                    'NRFDL_MCU_STATE_PROGRAMMING',
+                    'Programming',
                     d => {
                         if (!isDeviceInDFUBootloader(d))
                             onFail(
@@ -216,7 +204,7 @@ export const switchToApplicationMode =
             dispatch(
                 switchToDeviceMode(
                     device,
-                    'NRFDL_MCU_STATE_APPLICATION',
+                    'Application',
                     d => {
                         if (isDeviceInDFUBootloader(d))
                             onFail(
@@ -487,13 +475,31 @@ const programInDFUBootloader =
                 onFail,
             })
         );
-        nrfDeviceLib.firmwareProgram(
-            getDeviceLibContext(),
-            device.id,
-            'NRFDL_FW_BUFFER',
-            'NRFDL_FW_SDFU_ZIP',
-            zipBuffer,
-            err => {
+
+        NrfutilDeviceLib.program(
+            device,
+            { buffer: zipBuffer, type: 'zip' },
+            progress => {
+                onProgress(progress.progressPercentage, progress.message ?? '');
+            }
+        )
+            .then(() => {
+                logger.info(
+                    'All dfu images have been written to the target device'
+                );
+                logger.debug('DFU completed successfully!');
+                dispatch(
+                    setWaitForDevice({
+                        timeout: DEFAULT_DEVICE_WAIT_TIME,
+                        when: 'applicationMode',
+                        once: true,
+                        onSuccess,
+                        onFail,
+                    })
+                );
+                onProgress(100, 'Waiting for device to reboot');
+            })
+            .catch(err => {
                 if (err) {
                     logger.error(
                         `Failed to write to the target device: ${
@@ -501,30 +507,8 @@ const programInDFUBootloader =
                         }`
                     );
                     onFail(err);
-                } else {
-                    logger.info(
-                        'All dfu images have been written to the target device'
-                    );
-                    logger.debug('DFU completed successfully!');
-                    dispatch(
-                        setWaitForDevice({
-                            timeout: DEFAULT_DEVICE_WAIT_TIME,
-                            when: 'applicationMode',
-                            once: true,
-                            onSuccess,
-                            onFail,
-                        })
-                    );
-                    onProgress(100, 'Waiting for device to reboot');
                 }
-            },
-            progress => {
-                onProgress(
-                    progress.progressJson.progressPercentage,
-                    progress.progressJson.message ?? ''
-                );
-            }
-        );
+            });
     };
 
 const programDeviceWithFw =

package/src/ErrorBoundary/ErrorBoundary.tsx

@@ -6,9 +6,9 @@
 
 import React, { ReactNode } from 'react';
 import { getCurrentWindow } from '@electron/remote';
-import { Device } from '@nordicsemiconductor/nrf-device-lib-js';
 
 import Button from '../Button/Button';
+import { Device } from '../Device/deviceSlice';
 import FactoryResetButton from '../FactoryReset/FactoryResetButton';
 import { CollapsibleGroup } from '../SidePanel/Group';
 import Spinner from '../Spinner/Spinner';

package/src/Log/LogViewer.tsx

@@ -7,8 +7,6 @@
 import React, { useEffect, useRef } from 'react';
 import { useDispatch, useSelector } from 'react-redux';
 
-import { forwardLogEventsFromDeviceLib } from '../Device/deviceLibWrapper';
-import logger from '../logging';
 import sendInitialLogMessages from '../logging/sendInitialLogMessages';
 import LogEntry from './LogEntry';
 import {
@@ -22,8 +20,6 @@ import './log-viewer.scss';
 export const useInitialisedLog = () => {
     const dispatch = useDispatch();
     useEffect(() => {
-        logger.initialise();
-        forwardLogEventsFromDeviceLib();
         sendInitialLogMessages();
         const stopSyncLogToStore = startSyncLogToStore(dispatch);
 

package/src/Log/logSlice.ts

@@ -39,9 +39,7 @@ const limitedToMaxSize = (entries: LogEntry[]) =>
 
 export const autoScroll = (state: RootState) => state.log.autoScroll;
 export const logEntries = (state: RootState) => state.log.logEntries;
-let isLoggingVerboseLocal = initialState.isLoggingVerbose;
-export const isLoggingVerbose = () => isLoggingVerboseLocal;
-export const isLoggingVerboseSelector = (state: RootState) =>
+export const isLoggingVerbose = (state: RootState) =>
     state.log.isLoggingVerbose;
 
 const slice = createSlice({
@@ -60,14 +58,13 @@ const slice = createSlice({
         toggleAutoScroll: state => {
             state.autoScroll = !state.autoScroll;
         },
-        toggleIsLoggingVerbose: state => {
-            state.isLoggingVerbose = !state.isLoggingVerbose;
-            isLoggingVerboseLocal = state.isLoggingVerbose;
+        setIsLoggingVerbose: (state, action: PayloadAction<boolean>) => {
+            state.isLoggingVerbose = action.payload;
         },
     },
 });
 
 export const {
     reducer,
-    actions: { addEntries, clear, toggleAutoScroll, toggleIsLoggingVerbose },
+    actions: { addEntries, clear, toggleAutoScroll, setIsLoggingVerbose },
 } = slice;

package/src/index.ts

@@ -107,7 +107,6 @@ export {
 } from './Device/deviceAutoSelectSlice';
 export { clearWaitForDevice } from './Device/deviceLister';
 export { deviceInfo } from './Device/deviceInfo/deviceInfo';
-export { getDeviceLibContext } from './Device/deviceLibWrapper';
 export { isDeviceInDFUBootloader } from './Device/sdfuOperations';
 export {
     default as sdfuOperations,

package/src/logging/sendInitialLogMessages.ts

@@ -4,15 +4,13 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { getModuleVersions } from '@nordicsemiconductor/nrf-device-lib-js';
-
 import { inMain as appDetails } from '../../ipc/appDetails';
+import NrfutilDeviceLib from '../../nrfutil/device/device';
 import {
-    getDeviceLibContext,
-    getModuleVersion,
-} from '../Device/deviceLibWrapper';
+    describeVersion,
+    resolveModuleVersion,
+} from '../../nrfutil/moduleVersion';
 import { getAppDataDir } from '../utils/appDirs';
-import describeVersion from '../utils/describeVersion';
 import logLibVersions from '../utils/logLibVersions';
 import udevInstalled from '../utils/udevInstalled';
 import logger from '.';
@@ -50,8 +48,9 @@ export default async () => {
     logger.debug(`TmpDir: ${tmpDir}`);
 
     if (bundledJlink) {
-        const versions = await getModuleVersions(getDeviceLibContext());
-        const jlinkVersion = getModuleVersion('JlinkARM', versions);
+        const dependencies = (await NrfutilDeviceLib.getModuleVersion())
+            .dependencies;
+        const jlinkVersion = resolveModuleVersion('JlinkARM', dependencies);
 
         if (!describeVersion(jlinkVersion).includes(bundledJlink)) {
             logger.info(

package/src/utils/appDirs.ts

@@ -16,10 +16,10 @@ const getUserDataDir = () => getGlobal('userDataDir');
  *
  * @returns {string|undefined} Absolute path of current app.
  */
-function getAppDir() {
+const getAppDir = () => {
     const html = packageJson()?.nrfConnectForDesktop?.html ?? '';
     return __filename.replace(html, '');
-}
+};
 
 /**
  * Get the filesystem path of a file for the currently loaded app.
@@ -27,26 +27,21 @@ function getAppDir() {
  * @param {string} filename relative name of file in the app directory
  * @returns {string|undefined} Absolute path of file.
  */
-function getAppFile(filename: string) {
-    return path.resolve(getAppDir(), filename);
-}
+const getAppFile = (filename: string) => path.resolve(getAppDir(), filename);
 
 /**
  * Get the filesystem path of the data directory of currently loaded app.
  *
  * @returns {string|undefined} Absolute path of data directory of the current app.
  */
-function getAppDataDir() {
-    return `${getUserDataDir()}${path.basename(getAppDir())}`;
-}
+const getAppDataDir = () =>
+    path.join(getUserDataDir(), path.basename(getAppDir()));
 
 /**
  * Get the filesystem path of the log directory of currently loaded app.
  *
  * @returns {string|undefined} Absolute path of data directory of the current app.
  */
-function getAppLogDir() {
-    return `${getAppDataDir()}/logs`;
-}
+const getAppLogDir = () => path.join(getAppDataDir(), 'logs');
 
 export { getAppDir, getAppFile, getAppDataDir, getAppLogDir, getUserDataDir };

package/src/utils/logLibVersions.ts

@@ -4,21 +4,18 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import {
-    getModuleVersions,
-    ModuleVersion,
-} from '@nordicsemiconductor/nrf-device-lib-js';
 import { spawn } from 'child_process';
 import os from 'os';
 
+import NrfutilDeviceLib from '../../nrfutil/device/device';
 import {
-    getDeviceLibContext,
-    getModuleVersion,
-} from '../Device/deviceLibWrapper';
+    describeVersion,
+    resolveModuleVersion,
+} from '../../nrfutil/moduleVersion';
+import { SubDependency } from '../../nrfutil/sandboxTypes';
 import logger from '../logging';
-import describeVersion from './describeVersion';
 
-const log = (description: string, moduleVersion?: ModuleVersion) => {
+const log = (description: string, moduleVersion?: SubDependency | string) => {
     if (moduleVersion == null) {
         logger.warn(`Unable to detect version of ${description}.`);
     } else {
@@ -72,12 +69,13 @@ const checkJLinkArchitectureOnDarwin = async () => {
 
 export default async () => {
     try {
-        const versions = await getModuleVersions(getDeviceLibContext());
+        const moduleVersion = await NrfutilDeviceLib.getModuleVersion();
+        const dependencies = moduleVersion.dependencies;
 
-        log('nrf-device-lib-js', getModuleVersion('nrfdl-js', versions));
-        log('nrf-device-lib', getModuleVersion('nrfdl', versions));
-        log('nrfjprog DLL', getModuleVersion('jprog', versions));
-        log('JLink', getModuleVersion('JlinkARM', versions));
+        log('nrfutil-device', moduleVersion.version);
+        log('nrf-device-lib', resolveModuleVersion('nrfdl', dependencies));
+        log('nrfjprog DLL', resolveModuleVersion('jprog', dependencies));
+        log('JLink', resolveModuleVersion('JlinkARM', dependencies));
         if (
             process.platform === 'darwin' &&
             os.cpus()[0].model.includes('Apple')

package/src/utils/packageJson.ts

@@ -40,5 +40,15 @@ export default () => {
 - Or if the app was packaged without a package.json, but in that case the launcher should not even launch this app.`);
     }
 
-    return packageJson as PackageJson;
+    /* We need an intermediate, less safe typecast to `unknown`: TypeScript
+       assumes for the properties of NrfutilModules that they are string[] but
+       we type them as [string, ...string[]] in PackageJson. And TypeScript
+       considers these two types as not compatible. We hopefully can remove this
+       typecast when we check the format of package.json with zod.
+
+       Rationale for typing the properties as [string, ...string[]]: We require
+       that always at least one version is provided and also check this in
+       `check-app-properties.ts`)
+      */
+    return packageJson as unknown as PackageJson;
 };

package/src/utils/systemReport.ts

@@ -4,24 +4,24 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import nrfDeviceLib, { Device } from '@nordicsemiconductor/nrf-device-lib-js';
 import fs from 'fs';
 import { EOL } from 'os';
 import path from 'path';
 import pretty from 'prettysize';
 import type Systeminformation from 'systeminformation';
 
+import NrfutilDeviceLib from '../../nrfutil/device/device';
+import {
+    describeVersion,
+    resolveModuleVersion,
+} from '../../nrfutil/moduleVersion';
 import {
     deviceInfo as getDeviceInfo,
     productPageUrl,
 } from '../Device/deviceInfo/deviceInfo';
-import {
-    getDeviceLibContext,
-    getModuleVersion,
-} from '../Device/deviceLibWrapper';
+import { Device } from '../Device/deviceSlice';
 import logger from '../logging';
 import { getAppDataDir } from './appDirs';
-import describeVersion from './describeVersion';
 import { openFile } from './open';
 
 const generalInfoReport = async () => {
@@ -52,9 +52,8 @@ const generalInfoReport = async () => {
         si.fsSize(),
     ]);
 
-    const versions = await nrfDeviceLib.getModuleVersions(
-        getDeviceLibContext()
-    );
+    const moduleVersion = await NrfutilDeviceLib.getModuleVersion();
+    const dependencies = moduleVersion.dependencies;
 
     return [
         `- System:     ${manufacturer} ${model}`,
@@ -74,17 +73,12 @@ const generalInfoReport = async () => {
         `    - node: ${node}`,
         `    - python: ${python}`,
         `    - python3: ${python3}`,
-        `    - nrf-device-lib-js: ${describeVersion(
-            getModuleVersion('nrfdl-js', versions)
-        )}`,
-        `    - nrf-device-lib: ${describeVersion(
-            getModuleVersion('nrfdl', versions)
-        )}`,
+        `    - nrfutil-device: ${moduleVersion.version}`,
         `    - nrfjprog DLL: ${describeVersion(
-            getModuleVersion('jprog', versions)
+            resolveModuleVersion('jprog', dependencies)
         )}`,
         `    - JLink: ${describeVersion(
-            getModuleVersion('JlinkARM', versions)
+            resolveModuleVersion('JlinkARM', dependencies)
         )}`,
         '',
     ];

package/src/utils/usageData.ts

@@ -6,9 +6,9 @@
 
 import { ApplicationInsights } from '@microsoft/applicationinsights-web';
 import type Systeminformation from 'systeminformation';
+import winston from 'winston';
 
 import type { PackageJson } from '../../ipc/MetaFiles';
-import logger from '../logging';
 import { isDevelopment } from './environment';
 import {
     deleteIsSendingUsageData,
@@ -67,7 +67,7 @@ export const init = (packageJson: PackageJson) => {
         };
     });
 
-    logger.debug(
+    logger?.debug(
         `Application Insights for category ${applicationName} has initialized`
     );
 
@@ -85,7 +85,7 @@ export const init = (packageJson: PackageJson) => {
  * @returns {Boolean} returns whether the setting is on, off or undefined
  */
 export const isInitialized = () => {
-    logger.debug(
+    logger?.debug(
         `Usage report instance is${
             insights !== undefined ? '' : ' not'
         } initialized`
@@ -100,7 +100,7 @@ export const isInitialized = () => {
  */
 export const isEnabled = () => {
     const isSendingUsageData = getIsSendingUsageData();
-    logger.debug(`Usage data is ${isSendingUsageData}`);
+    logger?.debug(`Usage data is ${isSendingUsageData}`);
     return isSendingUsageData;
 };
 
@@ -111,7 +111,7 @@ export const isEnabled = () => {
  */
 export const enable = () => {
     persistIsSendingUsageData(true);
-    logger.debug('Usage data has been enabled');
+    logger?.debug('Usage data has been enabled');
 };
 
 /**
@@ -121,7 +121,7 @@ export const enable = () => {
  */
 export const disable = () => {
     persistIsSendingUsageData(false);
-    logger.debug('Usage data has been disabled');
+    logger?.debug('Usage data has been disabled');
 };
 
 /**
@@ -132,7 +132,7 @@ export const disable = () => {
  */
 export const reset = () => {
     deleteIsSendingUsageData();
-    logger.debug('Usage data setting has been reset');
+    logger?.debug('Usage data setting has been reset');
 };
 
 /**
@@ -145,7 +145,7 @@ const sendEvent = ({ action, label }: EventAction) => {
     const isSendingUsageData = getIsSendingUsageData();
 
     if (isSendingUsageData && insights !== undefined) {
-        logger.debug(`Sending usage data ${action} ${label}`);
+        logger?.debug(`Sending usage data ${action} ${label}`);
         insights.trackEvent({
             name: action,
             properties: label ? { label } : undefined,
@@ -174,7 +174,7 @@ export const sendUsageData = <T extends string>(action: T, label?: string) => {
  * @returns {void}
  */
 export const sendErrorReport = (error: string) => {
-    logger.error(error);
+    logger?.error(error);
     insights?.trackException({
         exception: new Error(error),
     });
@@ -184,6 +184,11 @@ export const sendErrorReport = (error: string) => {
     );
 };
 
+let logger: winston.Logger | undefined;
+export const setUsageLogger = (log: winston.Logger) => {
+    logger = log;
+};
+
 export default {
     disable,
     enable,

package/tsconfig.json

@@ -1,6 +1,7 @@
 {
     "extends": "./config/tsconfig.json",
     "include": [
+        "./nrfutil/**/*.ts",
         "./main/**/*.ts",
         "./src/**/*.ts",
         "./src/**/*.tsx",

package/typings/generated/ipc/MetaFiles.d.ts

@@ -5,10 +5,12 @@ export interface SourceJson {
 }
 export type WithdrawnJson = UrlString[];
 export type AppVersions = {
-    [version: string]: {
-        shasum?: string;
-        tarballUrl: UrlString;
-    };
+    [version: string]: AppVersion;
+};
+export type AppVersion = {
+    shasum?: string;
+    tarballUrl: UrlString;
+    nrfutilModules?: NrfutilModules;
 };
 export interface AppInfo {
     name: string;
@@ -27,9 +29,22 @@ export interface AppInfo {
 interface ObjectContainingOptionalStrings {
     [index: string]: string | undefined;
 }
+interface NrfConnectForDesktop {
+    nrfutil?: NrfutilModules;
+    html?: string;
+}
+type SemverString = string;
+export type NrfutilModuleName = string;
+export type NrfutilModuleVersion = SemverString;
+export interface NrfutilModules {
+    [name: NrfutilModuleName]: [
+        NrfutilModuleVersion,
+        ...NrfutilModuleVersion[]
+    ];
+}
 export interface PackageJson {
     name: string;
-    version: string;
+    version: SemverString;
     author?: string;
     bin?: ObjectContainingOptionalStrings | string;
     dependencies?: ObjectContainingOptionalStrings;
@@ -38,6 +53,7 @@ export interface PackageJson {
     devDependencies?: ObjectContainingOptionalStrings;
     displayName?: string;
     engines?: ObjectContainingOptionalStrings;
+    nrfConnectForDesktop?: NrfConnectForDesktop;
     files?: readonly string[];
     license?: string;
     main?: string;
@@ -47,9 +63,6 @@ export interface PackageJson {
         url: UrlString;
     };
     scripts?: ObjectContainingOptionalStrings;
-    nrfConnectForDesktop?: {
-        html?: string;
-    };
 }
 export {};
 //# sourceMappingURL=MetaFiles.d.ts.map