@nordicsemiconductor/pc-nrfconnect-shared 121.0.0 → 123.0.0

package/ipc/launcherConfig.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { ipcMain, ipcRenderer } from 'electron';
+
+export interface Configuration {
+    isRunningLauncherFromSource: boolean;
+    isSkipUpdateApps: boolean;
+    isSkipUpdateLauncher: boolean;
+    launcherVersion: string;
+    userDataDir: string;
+}
+const channel = 'get-config';
+
+const getConfig = (): Configuration => ipcRenderer.sendSync(channel);
+const registerGetConfig = (config: Configuration) =>
+    ipcMain.on(channel, event => {
+        event.returnValue = config;
+    });
+
+export const forRenderer = { registerGetConfig };
+export const inMain = { getConfig };

package/ipc/openWindow.ts

@@ -12,8 +12,24 @@ const channel = {
     launcher: 'open-app-launcher', // It would be nice to call this `open:launcher` but we have to stick to the current name, because that is used by supported apps.
 };
 
+export const isOpenAppOptionsDeviceSN = (
+    device: OpenAppOptionsDevice
+): device is OpenAppOptionsDeviceSN =>
+    (device as OpenAppOptionsDeviceSN).serialNumber !== undefined;
+
+export const isOpenAppOptionsDevicePort = (
+    device: OpenAppOptionsDevice
+): device is OpenAppOptionsDevicePort =>
+    (device as OpenAppOptionsDevicePort).serialPortPath !== undefined;
+
+type OpenAppOptionsDeviceSN = { serialNumber: string };
+
+type OpenAppOptionsDevicePort = { serialPortPath: string };
+
+type OpenAppOptionsDevice = OpenAppOptionsDeviceSN | OpenAppOptionsDevicePort;
+
 export interface OpenAppOptions {
-    device?: { serialNumber: string; serialPortPath?: string };
+    device?: OpenAppOptionsDevice;
 }
 
 type OpenApp = (app: AppSpec, openAppOptions?: OpenAppOptions) => void;

package/ipc/schema/packageJson.ts

@@ -10,6 +10,20 @@ import { knownDevicePcas } from '../device';
 import { nrfModules, semver } from '../MetaFiles';
 import { parseWithPrettifiedErrorMessage } from './parseJson';
 
+const packageJson = z.object({
+    name: z.string(),
+    version: semver,
+
+    displayName: z.string().optional(),
+});
+
+export type PackageJson = z.infer<typeof packageJson>;
+
+export const parsePackageJson =
+    parseWithPrettifiedErrorMessage<PackageJson>(packageJson);
+
+// Apps have more required fields in their package.json
+
 const nrfConnectForDesktop = z.object({
     supportedDevices: z.enum(knownDevicePcas).array().nonempty().optional(),
     nrfutil: nrfModules.optional(),
@@ -22,12 +36,7 @@ const engines = recordOfOptionalStrings.and(
     z.object({ nrfconnect: z.string() })
 );
 
-const packageJson = z.object({
-    name: z.string(),
-    version: semver,
-
-    author: z.string().optional(),
-    bin: z.string().or(recordOfOptionalStrings).optional(),
+const packageJsonApp = packageJson.extend({
     dependencies: recordOfOptionalStrings.optional(),
     description: z.string(),
     homepage: z.string().url().optional(),
@@ -36,8 +45,6 @@ const packageJson = z.object({
     engines,
     nrfConnectForDesktop,
     files: z.string().array().optional(),
-    license: z.string().optional(),
-    main: z.string().optional(),
     peerDependencies: recordOfOptionalStrings.optional(),
     repository: z
         .object({
@@ -45,25 +52,22 @@ const packageJson = z.object({
             url: z.string().url(),
         })
         .optional(),
-    scripts: recordOfOptionalStrings.optional(),
 });
 
-export type PackageJson = z.infer<typeof packageJson>;
+export type PackageJsonApp = z.infer<typeof packageJsonApp>;
 
-export const parsePackageJson =
-    parseWithPrettifiedErrorMessage<PackageJson>(packageJson);
+export const parsePackageJsonApp =
+    parseWithPrettifiedErrorMessage<PackageJsonApp>(packageJsonApp);
 
 // In the launcher we want to handle that the whole nrfConnectForDesktop may be missing
 // and the html in it can also be undefined, so there we need to use this legacy variant
-const legacyPackageJson = packageJson.merge(
-    z.object({
-        nrfConnectForDesktop: nrfConnectForDesktop
-            .partial({ html: true })
-            .optional(),
-    })
-);
+const packageJsonLegacyApp = packageJsonApp.extend({
+    nrfConnectForDesktop: nrfConnectForDesktop
+        .partial({ html: true })
+        .optional(),
+});
 
-export type LegacyPackageJson = z.infer<typeof legacyPackageJson>;
+export type PackageJsonLegacyApp = z.infer<typeof packageJsonLegacyApp>;
 
-export const parseLegacyPackageJson =
-    parseWithPrettifiedErrorMessage<LegacyPackageJson>(legacyPackageJson);
+export const parsePackageJsonLegacyApp =
+    parseWithPrettifiedErrorMessage<PackageJsonLegacyApp>(packageJsonLegacyApp);

package/main/index.ts

@@ -6,6 +6,7 @@
 
 import { forRenderer as forRendererAppDetails } from '../ipc/appDetails';
 import { forRenderer as forRendererApps } from '../ipc/apps';
+import { forRenderer as forRendererLauncherConfig } from '../ipc/launcherConfig';
 import { forRenderer as forRendererOpenWindow } from '../ipc/openWindow';
 import { forRenderer as forRendererPreventSleep } from '../ipc/preventSleep';
 import { forRenderer as forRendererSafeStorage } from '../ipc/safeStorage';
@@ -18,6 +19,7 @@ export { registerLauncherWindowFromMain } from '../ipc/infrastructure/mainToRend
 
 export const appDetails = { forRenderer: forRendererAppDetails };
 export const apps = { forRenderer: forRendererApps };
+export const launcherConfig = { forRenderer: forRendererLauncherConfig };
 export const openWindow = { forRenderer: forRendererOpenWindow };
 export const preventSleep = { forRenderer: forRendererPreventSleep };
 export const safeStorage = {
@@ -37,11 +39,15 @@ export {
     type WithdrawnJson,
 } from '../ipc/MetaFiles';
 export {
-    type LegacyPackageJson,
-    type PackageJson,
-    parseLegacyPackageJson,
-    parsePackageJson,
+    type PackageJsonLegacyApp,
+    type PackageJsonApp,
+    parsePackageJsonLegacyApp,
+    parsePackageJsonApp,
 } from '../ipc/schema/packageJson';
 
 export { type OverwriteOptions } from '../ipc/serialPort';
-export { type OpenAppOptions } from '../ipc/openWindow';
+export type { OpenAppOptions } from '../ipc/openWindow';
+export {
+    isOpenAppOptionsDevicePort,
+    isOpenAppOptionsDeviceSN,
+} from '../ipc/openWindow';

package/mocks/packageJsonMock.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-export default () => ({
+export const packageJson = () => ({
     name: 'mocked-test-app',
     version: '27.6.72',
 });

package/nrfutil/device/__mocks__/device.ts

@@ -6,6 +6,7 @@
 
 const program = jest.fn();
 const programBuffer = jest.fn();
+const deviceInfo = jest.fn(() => Promise.resolve({}));
 const erase = jest.fn();
 const recover = jest.fn();
 const reset = jest.fn();
@@ -26,6 +27,7 @@ const getModuleVersion = jest.fn();
 export default {
     program,
     programBuffer,
+    deviceInfo,
     erase,
     recover,
     reset,

package/nrfutil/device/batch.ts

@@ -16,7 +16,7 @@ import {
     DeviceTraits,
     deviceTraitsToArgs,
     getDeviceSandbox,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
     ResetKind,
 } from './common';
 import { DeviceBuffer } from './firmwareRead';
@@ -55,13 +55,7 @@ export class Batch {
                 await box.singleInfoOperationOptionalData<object>(
                     command,
                     undefined,
-                    [
-                        '--serial-number', // this is a workaround this param should now be needed with --generate
-                        '123',
-                        '--generate',
-                        '--core',
-                        core,
-                    ].concat(args)
+                    ['--generate', '--core', core].concat(args)
                 );
 
             return {
@@ -75,6 +69,16 @@ export class Batch {
         this.operationBatchGeneration.push(getPromise());
     }
 
+    public getDeviceInfo(core: DeviceCore, callbacks?: Callbacks<FWInfo>) {
+        this.enqueueBatchOperationObject(
+            'device-info',
+            core,
+            callbacks as CallbacksUnknown
+        );
+
+        return this;
+    }
+
     public erase(core: DeviceCore, callbacks?: Callbacks) {
         this.enqueueBatchOperationObject(
             'erase',
@@ -225,9 +229,15 @@ export class Batch {
     }
 
     public async run(
-        device: NrfutilDeviceWithSerialnumber,
+        device: NrfutilDevice,
         controller?: AbortController | undefined
     ): Promise<unknown[]> {
+        if (!device.serialNumber) {
+            throw new Error(
+                `Device does not have a serial number, no device operation is possible`
+            );
+        }
+
         let currentOperationIndex = -1;
         let lastCompletedOperationIndex = -1;
         const results: TaskEnd<unknown>[] = [];

package/nrfutil/device/common.ts

@@ -42,48 +42,25 @@ export interface DeviceLeftEvent {
     id: number;
 }
 
-export interface HwInfo {
-    romSize: number;
-    ramSize: number;
-    romPageSize: number;
-    deviceFamily: string;
-    deviceVersion: string;
-}
-
-export interface DfuTriggerInfo {
-    wAddress: number;
-    wVersionMajor: number;
-    wVersionMinor: number;
-    wFirmwareId: number;
-    wFlashSize: number;
-    wFlashPageSize: number;
-}
-
-export interface DfuTriggerVersion {
-    semVer: string;
+export interface NordicDevKit {
+    boardVersion?: string;
+    deviceFamily?: string;
 }
 
 export interface NrfutilDevice {
     id: number;
-    serialNumber?: string; // undefined in case udev is not installed
+    devkit?: NordicDevKit;
+    serialNumber?: string | null; // undefined in case udev is not installed
     traits: DeviceTraits;
     usb?: USB;
-    jlink?: JLink;
     // non-Nordic devices may not have serialPorts property at all
     serialPorts?: Array<SerialPort>;
-    hwInfo?: HwInfo;
-    dfuTriggerInfo?: DfuTriggerInfo;
-    dfuTriggerVersion?: DfuTriggerVersion;
     broken?: null | {
         description: string;
         url: string;
     };
 }
 
-export interface NrfutilDeviceWithSerialnumber extends NrfutilDevice {
-    serialNumber: string;
-}
-
 export type DeviceFamily =
     | 'NRF51_FAMILY'
     | 'NRF52_FAMILY'
@@ -168,15 +145,6 @@ export interface USBDevice {
     descriptor: USBDeviceDescriptor;
     configList: USBConfiguration; // todo: check this prop
 }
-
-export interface JLink {
-    serialNumber: string;
-    boardVersion: string | null; // can be null for external jLink
-    jlinkObFirmwareVersion: string | null;
-    deviceFamily: string | null;
-    deviceVersion: string | null; // will be null if device is protected
-}
-
 export interface SerialPort {
     serialNumber: string | null;
     comName: string | null;
@@ -204,26 +172,33 @@ export const getDeviceSandbox = async () => {
         );
         deviceSandbox = await promiseDeviceSandbox;
 
-        deviceSandbox.onLogging(evt => {
+        deviceSandbox.onLogging((evt, pid) => {
             const deviceLogger = getNrfutilLogger();
+            const formatMsg = (msg: string) =>
+                `${
+                    pid && deviceSandbox?.logLevel === 'trace'
+                        ? `[PID:${pid}] `
+                        : ''
+                }${msg}`;
+
             switch (evt.level) {
                 case 'TRACE':
-                    deviceLogger?.verbose(evt.message);
+                    deviceLogger?.verbose(formatMsg(evt.message));
                     break;
                 case 'DEBUG':
-                    deviceLogger?.debug(evt.message);
+                    deviceLogger?.debug(formatMsg(evt.message));
                     break;
                 case 'INFO':
-                    deviceLogger?.info(evt.message);
+                    deviceLogger?.info(formatMsg(evt.message));
                     break;
                 case 'WARN':
-                    deviceLogger?.warn(evt.message);
+                    deviceLogger?.warn(formatMsg(evt.message));
                     break;
                 case 'ERROR':
-                    deviceLogger?.error(evt.message);
+                    deviceLogger?.error(formatMsg(evt.message));
                     break;
                 case 'CRITICAL':
-                    deviceLogger?.error(evt.message);
+                    deviceLogger?.error(formatMsg(evt.message));
                     break;
                 case 'OFF':
                 default:
@@ -246,12 +221,17 @@ export const getDeviceSandbox = async () => {
 };
 
 export const deviceSingleTaskEndOperation = async <T = void>(
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     command: string,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController,
     args: string[] = []
 ) => {
+    if (!device.serialNumber) {
+        throw new Error(
+            `Device does not have a serial number, no device operation is possible`
+        );
+    }
     const box = await getDeviceSandbox();
     return box.singleTaskEndOperationWithData<T>(
         command,
@@ -262,12 +242,18 @@ export const deviceSingleTaskEndOperation = async <T = void>(
 };
 
 export const deviceSingleTaskEndOperationVoid = async (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     command: string,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController,
     args: string[] = []
 ) => {
+    if (!device.serialNumber) {
+        throw new Error(
+            `Device does not have a serial number, no device operation is possible`
+        );
+    }
+
     const box = await getDeviceSandbox();
     await box.singleTaskEndOperationOptionalData(
         command,

package/nrfutil/device/device.ts

@@ -7,6 +7,7 @@
 import { LogLevel, LogMessage } from '../sandboxTypes';
 import { Batch } from './batch';
 import { getDeviceSandbox } from './common';
+import deviceInfo from './deviceInfo';
 import erase from './erase';
 import firmwareRead from './firmwareRead';
 import getCoreInfo from './getCoreInfo';
@@ -43,6 +44,7 @@ const getModuleVersion = async () => {
 
 export default {
     program,
+    deviceInfo,
     erase,
     recover,
     reset,

package/nrfutil/device/deviceInfo.ts

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { Progress } from '../sandboxTypes';
+import {
+    DeviceCore,
+    deviceSingleTaskEndOperation,
+    NrfutilDevice,
+} from './common';
+
+export interface HwInfo {
+    romSize: number;
+    ramSize: number;
+    romPageSize: number;
+    deviceFamily: string;
+    deviceVersion: string;
+}
+
+export interface JLinkDeviceInfo {
+    serialNumber: string;
+    boardVersion?: string;
+    jlinkObFirmwareVersion: string;
+    deviceFamily: string | null;
+    deviceVersion?: string | null;
+}
+
+export interface DfuTriggerInfo {
+    wAddress: number;
+    wVersionMajor: number;
+    wVersionMinor: number;
+    wFirmwareId: number;
+    wFlashSize: number;
+    wFlashPageSize: number;
+}
+export interface DfuTriggerVersion {
+    semVer: string;
+}
+
+export interface DeviceInfo {
+    hwInfo?: HwInfo;
+    jlink?: JLinkDeviceInfo;
+    dfuTriggerVersion?: DfuTriggerVersion;
+    dfuTriggerInfo?: DfuTriggerInfo;
+}
+
+export interface DeviceInfoRaw {
+    name: 'device-info';
+    deviceInfo: DeviceInfo;
+}
+
+export default async (
+    device: NrfutilDevice,
+    core?: DeviceCore,
+    onProgress?: (progress: Progress) => void,
+    controller?: AbortController
+) =>
+    device.traits.jlink || device.traits.nordicDfu
+        ? (
+              await deviceSingleTaskEndOperation<DeviceInfoRaw>(
+                  device,
+                  'device-info',
+                  onProgress,
+                  controller,
+                  core ? ['--core', core] : []
+              )
+          ).deviceInfo
+        : undefined;

package/nrfutil/device/erase.ts

@@ -8,11 +8,11 @@ import { Progress } from '../sandboxTypes';
 import {
     DeviceCore,
     deviceSingleTaskEndOperationVoid,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
 } from './common';
 
 export default (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     core?: DeviceCore,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController

package/nrfutil/device/firmwareRead.ts

@@ -8,7 +8,7 @@ import { Progress } from '../sandboxTypes';
 import {
     DeviceCore,
     deviceSingleTaskEndOperation,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
 } from './common';
 
 export interface DeviceBuffer {
@@ -17,7 +17,7 @@ export interface DeviceBuffer {
 }
 
 export default async (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     core?: DeviceCore,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController

package/nrfutil/device/getCoreInfo.ts

@@ -8,7 +8,7 @@ import { Progress } from '../sandboxTypes';
 import {
     DeviceCore,
     deviceSingleTaskEndOperation,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
 } from './common';
 
 export type DeviceCoreInfo = {
@@ -30,7 +30,7 @@ export type DeviceCoreInfo = {
 };
 
 export default (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     core?: DeviceCore,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController

package/nrfutil/device/getFwInfo.ts

@@ -8,7 +8,7 @@ import { Progress } from '../sandboxTypes';
 import {
     DeviceCore,
     deviceSingleTaskEndOperation,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
 } from './common';
 
 type BootloaderType =
@@ -55,7 +55,7 @@ export interface FWInfo {
 }
 
 export default (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     core?: DeviceCore,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController

package/nrfutil/device/getProtectionStatus.ts

@@ -8,7 +8,7 @@ import { Progress } from '../sandboxTypes';
 import {
     DeviceCore,
     deviceSingleTaskEndOperation,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
 } from './common';
 
 type DeviceFamily =
@@ -32,7 +32,7 @@ export interface GetProtectionStatusResult {
 }
 
 export default (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     core?: DeviceCore,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController

package/nrfutil/device/list.ts

@@ -4,13 +4,11 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import logger from '../../src/logging';
 import {
     DeviceTraits,
     deviceTraitsToArgs,
     getDeviceSandbox,
     NrfutilDevice,
-    NrfutilDeviceWithSerialnumber,
 } from './common';
 
 export interface HotplugEvent {
@@ -32,10 +30,10 @@ const isHotplugEvent = (
 
 export default async (
     traits: DeviceTraits,
-    onEnumerated: (devices: NrfutilDeviceWithSerialnumber[]) => void,
-    onError: (error: Error) => void,
+    onEnumerated: (devices: NrfutilDevice[]) => void,
+    onError: (error: Error, pid?: number) => void,
     onHotplugEvent?: {
-        onDeviceArrived: (device: NrfutilDeviceWithSerialnumber) => void;
+        onDeviceArrived: (device: NrfutilDevice) => void;
         onDeviceLeft: (id: number) => void;
     },
     timeout?: number
@@ -53,21 +51,7 @@ export default async (
 
     const onData = (data: HotplugEvent | ListEvent) => {
         if (isListEvent(data)) {
-            data.devices
-                .filter(d => !d.serialNumber)
-                .forEach(d => {
-                    logger.warn(
-                        `Device was skipped as it has no Serial number ${JSON.stringify(
-                            d
-                        )}`
-                    );
-                });
-
-            onEnumerated(
-                data.devices.filter(
-                    d => d.serialNumber
-                ) as NrfutilDeviceWithSerialnumber[]
-            );
+            onEnumerated(data.devices);
 
             return;
         }
@@ -77,17 +61,7 @@ export default async (
         }
 
         if (data.event === 'Arrived' && data.device) {
-            if (data.device.serialNumber) {
-                onHotplugEvent.onDeviceArrived(
-                    data.device as NrfutilDeviceWithSerialnumber
-                );
-            } else {
-                logger.warn(
-                    `Device was skipped as it has no Serial number ${JSON.stringify(
-                        data.device
-                    )}`
-                );
-            }
+            onHotplugEvent.onDeviceArrived(data.device);
         } else if (data.event === 'Left') {
             onHotplugEvent.onDeviceLeft(data.id);
         }

package/nrfutil/device/program.ts

@@ -14,7 +14,7 @@ import {
     DeviceCore,
     deviceSingleTaskEndOperationVoid,
     DeviceTraits,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
     ResetKind,
 } from './common';
 
@@ -99,7 +99,7 @@ export const programmingOptionsToArgs = (options?: ProgrammingOptions) => {
     return args.length > 0 ? ['--options', `${args.join(',')}`] : [];
 };
 const program = (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     firmwarePath: string,
     onProgress?: (progress: Progress) => void,
     core?: DeviceCore,
@@ -121,7 +121,7 @@ const program = (
     );
 
 const programBuffer = async (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     firmware: Buffer,
     type: FileExtensions,
     onProgress?: (progress: Progress) => void,
@@ -157,7 +157,7 @@ const programBuffer = async (
 };
 
 export default async (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     firmware: FirmwareType,
     onProgress?: (progress: Progress) => void,
     core?: DeviceCore,