@nordicsemiconductor/pc-nrfconnect-shared 230.0.0 → 232.0.0

package/src/Device/deviceSetup.ts

@@ -37,21 +37,21 @@ export interface JprogEntry {
 export interface DeviceSetup {
     supportsProgrammingMode: (
         device: Device,
-        deviceInfo?: DeviceInfo
+        deviceInfo?: DeviceInfo,
     ) => boolean; // Return true if this device can be programed using this interface e.g. MCU Boot or DFU
     getFirmwareOptions: (
         device: Device,
-        deviceInfo?: DeviceInfo
+        deviceInfo?: DeviceInfo,
     ) => {
         key: string;
         description?: string;
         programDevice: (
-            onProgress: (progress: number, message?: string) => void
+            onProgress: (progress: number, message?: string) => void,
         ) => AppThunk<RootState, Promise<Device>>;
     }[]; // The list of all firmware that can be applied for this device with the program function for that fw item
     isExpectedFirmware: (
         device: Device,
-        deviceInfo?: DeviceInfo
+        deviceInfo?: DeviceInfo,
     ) => AppThunk<
         RootState,
         Promise<{
@@ -60,7 +60,7 @@ export interface DeviceSetup {
         }>
     >; // returns true if device has one of the expected firmware returned by getFirmwareOptions
     tryToSwitchToApplicationMode: (
-        device: Device
+        device: Device,
     ) => AppThunk<RootState, Promise<Device | null>>; // returns the device after switched to app mode. If this is not possible or not relevant return null
 }
 
@@ -79,13 +79,13 @@ export const prepareDevice =
         onFail: (reason?: unknown) => void,
         deviceInfo: DeviceInfo | undefined,
         checkCurrentFirmwareVersion = true,
-        requireUserConfirmation = true
+        requireUserConfirmation = true,
     ): AppThunk<RootState, Promise<void>> =>
     async dispatch => {
         const onSuccessWrapper = (d: Device) => {
             logger.info(
                 `Connected to the device with the serial number ${device.serialNumber} ` +
-                    `and family: ${device.devkit?.deviceFamily || 'Unknown'} `
+                    `and family: ${device.devkit?.deviceFamily || 'Unknown'} `,
             );
             onSuccess(d);
             dispatch(closeDeviceSetupDialog());
@@ -93,12 +93,12 @@ export const prepareDevice =
 
         const validDeviceSetups = deviceSetupConfig.deviceSetups.filter(
             deviceSetup =>
-                deviceSetup.supportsProgrammingMode(device, deviceInfo)
+                deviceSetup.supportsProgrammingMode(device, deviceInfo),
         );
 
         const possibleFirmware = validDeviceSetups
             .map(deviceSetup =>
-                deviceSetup.getFirmwareOptions(device, deviceInfo)
+                deviceSetup.getFirmwareOptions(device, deviceInfo),
             )
             .flat();
 
@@ -107,12 +107,12 @@ export const prepareDevice =
                 logger.info(
                     'Note: no pre-compiled firmware is available for the selected device. ' +
                         'You may still use the app if you have programmed the device ' +
-                        'with a compatible firmware.'
+                        'with a compatible firmware.',
                 );
                 onSuccessWrapper(device);
             } else {
                 logger.info(
-                    'Note: no pre-compiled firmware is available for the selected device. '
+                    'Note: no pre-compiled firmware is available for the selected device. ',
                 );
                 onFail('No device setup found');
             }
@@ -126,7 +126,7 @@ export const prepareDevice =
                 try {
                     // eslint-disable-next-line no-await-in-loop
                     const result = await dispatch(
-                        deviceSetup.isExpectedFirmware(device, deviceInfo)
+                        deviceSetup.isExpectedFirmware(device, deviceInfo),
                     );
                     device = result.device;
                     if (result.validFirmware) {
@@ -142,7 +142,8 @@ export const prepareDevice =
 
         const choices = possibleFirmware
             .map(
-                fw => `${fw.key}${fw.description ? ` - ${fw.description}` : ''}`
+                fw =>
+                    `${fw.key}${fw.description ? ` - ${fw.description}` : ''}`,
             )
             .flat();
 
@@ -158,10 +159,10 @@ export const prepareDevice =
                             dispatch(setDeviceSetupProgress(progress));
                             if (message)
                                 dispatch(
-                                    setDeviceSetupProgressMessage(message)
+                                    setDeviceSetupProgressMessage(message),
                                 );
-                        }
-                    )
+                        },
+                    ),
                 )
                     .then(onSuccessWrapper)
                     .catch(onFail);
@@ -173,8 +174,8 @@ export const prepareDevice =
                             Closing application right now might result in unknown behavior and might also brick the device.
                             Are you sure you want to continue?`,
                         },
-                        task
-                    )
+                        task,
+                    ),
                 );
             }
         };
@@ -187,7 +188,7 @@ export const prepareDevice =
                 try {
                     // eslint-disable-next-line no-await-in-loop
                     const result = await dispatch(
-                        deviceSetup.tryToSwitchToApplicationMode(device)
+                        deviceSetup.tryToSwitchToApplicationMode(device),
                     );
                     if (result) {
                         onSuccessWrapper(result);
@@ -218,7 +219,7 @@ export const prepareDevice =
                         message:
                             deviceSetupConfig.confirmMessage ??
                             'Device must be programmed. Do you want to proceed?',
-                    })
+                    }),
                 );
             } else {
                 dispatch(
@@ -226,7 +227,7 @@ export const prepareDevice =
                         message:
                             deviceSetupConfig.confirmMessage ??
                             'Device must be programmed. Do you want to proceed?',
-                    })
+                    }),
                 );
                 proceedAction(0);
             }
@@ -244,7 +245,7 @@ export const prepareDevice =
                         deviceSetupConfig.choiceMessage ??
                         'Which firmware do you want to program?',
                     choices,
-                })
+                }),
             );
         }
     };
@@ -255,7 +256,7 @@ export const setupDevice =
         deviceSetupConfig: DeviceSetupConfig,
         onDeviceIsReady: (device: Device) => void,
         doDeselectDevice: (device?: Device) => void,
-        deviceInfo: DeviceInfo | undefined
+        deviceInfo: DeviceInfo | undefined,
     ): AppThunk<RootState> =>
     (dispatch, getState) =>
         dispatch(
@@ -279,11 +280,11 @@ export const setupDevice =
                 error => {
                     dispatch(closeDeviceSetupDialog());
                     logger.error(
-                        `Error while setting up device with the serial number ${device.serialNumber}`
+                        `Error while setting up device with the serial number ${device.serialNumber}`,
                     );
                     logger.error(describeError(error));
                     doDeselectDevice(getState().device.selectedDevice);
                 },
-                deviceInfo
-            )
+                deviceInfo,
+            ),
         );

package/src/Device/deviceSetupSlice.ts

@@ -36,7 +36,7 @@ const slice = createSlice({
                 onUserInput?: (canceled: boolean, choice?: number) => void;
                 message: string;
                 choices?: string[];
-            }>
+            }>,
         ) => {
             state.visible = true;
             state.onUserInput = action.payload.onUserInput;
@@ -53,7 +53,7 @@ const slice = createSlice({
         },
         setDeviceSetupProgressMessage: (
             state,
-            action: PayloadAction<string>
+            action: PayloadAction<string>,
         ) => {
             state.progressMessage = action.payload;
         },

package/src/Device/deviceSlice.ts

@@ -28,17 +28,17 @@ export interface DeviceWithSerialNumber extends Device {
 }
 
 export const isDeviceWithSerialNumber = (
-    device: Device
+    device: Device,
 ): device is DeviceWithSerialNumber =>
     !!(device as DeviceWithSerialNumber).serialNumber;
 
 const findDeviceItem = (
     devices: Device[],
     id: number,
-    serialNumber?: string | null
+    serialNumber?: string | null,
 ) => {
     const index = devices.findIndex(
-        d => d.id === id || d.serialNumber === serialNumber
+        d => d.id === id || d.serialNumber === serialNumber,
     );
 
     return { index, device: devices[index] };
@@ -48,7 +48,7 @@ const updateDevice = (
     state: DeviceState,
     updateToMergeIn: Partial<Device>,
     id: number,
-    serialNumber?: string | null
+    serialNumber?: string | null,
 ) => {
     const device = findDeviceItem(state.devices, id, serialNumber).device;
     if (device) {
@@ -80,7 +80,7 @@ const slice = createSlice({
 
         setSelectedDeviceInfo: (
             state,
-            action: PayloadAction<DeviceInfo | undefined>
+            action: PayloadAction<DeviceInfo | undefined>,
         ) => {
             state.selectedDeviceInfo = action.payload;
         },
@@ -97,7 +97,7 @@ const slice = createSlice({
             const index = state.devices.findIndex(
                 item =>
                     item.serialNumber === action.payload.serialNumber ||
-                    item.id === action.payload.id
+                    item.id === action.payload.id,
             );
             if (index !== -1) {
                 state.devices[index] = action.payload;
@@ -108,7 +108,7 @@ const slice = createSlice({
 
         persistSerialPortOptions: (
             state,
-            action: PayloadAction<SerialPortOpenOptions<AutoDetectTypes>>
+            action: PayloadAction<SerialPortOpenOptions<AutoDetectTypes>>,
         ) => {
             if (!state.selectedDevice) return;
 
@@ -116,7 +116,7 @@ const slice = createSlice({
 
             if (selectedDevice) {
                 const vComIndex = selectedDevice.serialPorts?.findIndex(
-                    e => e.comName === action.payload.path
+                    e => e.comName === action.payload.path,
                 );
 
                 if (
@@ -124,7 +124,6 @@ const slice = createSlice({
                     vComIndex !== undefined &&
                     vComIndex !== -1
                 ) {
-                    // eslint-disable-next-line @typescript-eslint/no-unused-vars -- used to filter out the path property
                     const { path: _, ...serialPortOptions } = action.payload;
 
                     persistSerialPortSettingsToStore(
@@ -132,7 +131,7 @@ const slice = createSlice({
                         {
                             serialPortOptions,
                             vComIndex,
-                        }
+                        },
                     );
 
                     updateDevice(
@@ -142,7 +141,7 @@ const slice = createSlice({
                             persistedSerialPortOptions: action.payload,
                         },
                         selectedDevice.id,
-                        selectedDevice.serialNumber
+                        selectedDevice.serialNumber,
                     );
                 }
             }
@@ -152,7 +151,7 @@ const slice = createSlice({
             const index = findDeviceItem(
                 state.devices,
                 action.payload.id,
-                action.payload.serialNumber
+                action.payload.serialNumber,
             ).index;
             state.devices.splice(index, 1);
 
@@ -166,7 +165,7 @@ const slice = createSlice({
             const device = findDeviceItem(
                 state.devices,
                 action.payload.id,
-                action.payload.serialNumber
+                action.payload.serialNumber,
             ).device;
 
             if (!device.serialNumber) return;
@@ -180,7 +179,7 @@ const slice = createSlice({
                     favorite: newFavoriteState,
                 },
                 action.payload.id,
-                action.payload.serialNumber
+                action.payload.serialNumber,
             );
         },
 
@@ -193,13 +192,13 @@ const slice = createSlice({
                 action: PayloadAction<{
                     device: Device;
                     nickname: string;
-                }>
+                }>,
             ) => {
                 if (!action.payload.device.serialNumber) return;
 
                 persistNickname(
                     action.payload.device.serialNumber,
-                    action.payload.nickname
+                    action.payload.nickname,
                 );
                 updateDevice(
                     state,
@@ -207,7 +206,7 @@ const slice = createSlice({
                         nickname: action.payload.nickname,
                     },
                     action.payload.device.id,
-                    action.payload.device.serialNumber
+                    action.payload.device.serialNumber,
                 );
             },
         },
@@ -222,7 +221,7 @@ const slice = createSlice({
                     nickname: '',
                 },
                 action.payload.id,
-                action.payload.serialNumber
+                action.payload.serialNumber,
             );
         },
 

package/src/Device/initPacket.ts

@@ -104,7 +104,7 @@ const createInitCommand = (
     blSize: number | undefined,
     appSize: number | undefined,
     hash: protobuf.Message | undefined,
-    isDebug = false
+    isDebug = false,
 ): protobuf.Message => {
     const initCommandMessage = root.lookupType('dfu.InitCommand');
     const initCommandPayload = {
@@ -126,7 +126,7 @@ const createInitCommand = (
 // Create command
 const createCommand = (
     opCode: number,
-    commandInput: protobuf.Message
+    commandInput: protobuf.Message,
 ): protobuf.Message => {
     const commandMessage = root.lookupType('dfu.Command');
     const commandPayload = {
@@ -142,7 +142,7 @@ const createCommand = (
 const createSignedCommand = (
     command: protobuf.Message,
     signatureType: number,
-    signature: []
+    signature: [],
 ): protobuf.Message => {
     const signedCommandMessage = root.lookupType('dfu.SignedCommand');
     const signedCommandPayload = {
@@ -158,7 +158,7 @@ const createSignedCommand = (
 // Create packet
 const createPacket = (
     command: protobuf.Message,
-    isSigned: boolean
+    isSigned: boolean,
 ): protobuf.Message => {
     const packetPayload = {
         [isSigned ? 'signedCommand' : 'command']: command,
@@ -197,7 +197,7 @@ const messageToBuffer = (type: string, message: protobuf.Message) => {
 export const createResetPacket = (
     timeout: number,
     signatureType: number,
-    signature: []
+    signature: [],
 ): protobuf.Message => {
     // Check input parameters
     if (timeout === undefined) {
@@ -242,7 +242,7 @@ export const createResetPacket = (
 export const createResetPacketBuffer = (
     timeout: number,
     signatureType: number,
-    signature: []
+    signature: [],
 ): Uint8Array => {
     const packet = createResetPacket(timeout, signatureType, signature);
     const buffer = messageToBuffer('Packet', packet);
@@ -280,7 +280,7 @@ export const createInitPacket = (
     hash: Buffer | undefined,
     isDebug: boolean,
     signatureType: number | undefined,
-    signature: [] | undefined
+    signature: [] | undefined,
 ): protobuf.Message => {
     // It checks both null and undefined here
     if (
@@ -293,7 +293,7 @@ export const createInitPacket = (
     // Create init command
     const hashInput = createHash(
         hashType || HashType.NO_HASH,
-        hash ?? Buffer.from([])
+        hash ?? Buffer.from([]),
     );
     const initCommand = createInitCommand(
         fwVersion,
@@ -304,7 +304,7 @@ export const createInitPacket = (
         blSize,
         appSize,
         hashInput,
-        isDebug
+        isDebug,
     );
     let command = createCommand(OpCode.INIT, initCommand);
     let isSigned = false;
@@ -351,7 +351,7 @@ export const createInitPacketBuffer = (
     hash: Buffer,
     isDebug: boolean,
     signatureType: number,
-    signature: []
+    signature: [],
 ): Buffer => {
     const packet = createInitPacket(
         fwVersion,
@@ -365,7 +365,7 @@ export const createInitPacketBuffer = (
         hash,
         isDebug,
         signatureType,
-        signature
+        signature,
     );
     const buffer = messageToBuffer('Packet', packet);
 
@@ -380,7 +380,7 @@ export const createInitPacketBuffer = (
  * @returns {Uint8Array} converted from init command packet buffer
  */
 export const createInitPacketUint8Array = (
-    packetParams: InitPacket
+    packetParams: InitPacket,
 ): Uint8Array => {
     const packet = createInitPacket(
         packetParams.fwVersion,
@@ -394,7 +394,7 @@ export const createInitPacketUint8Array = (
         packetParams.hash,
         packetParams.isDebug,
         packetParams.signatureType,
-        packetParams.signature
+        packetParams.signature,
     );
     const buffer = messageToBuffer('Packet', packet);
 

package/src/Device/jprogOperations.ts

@@ -19,7 +19,7 @@ const programDeviceWithFw =
     (
         device: Device,
         selectedFw: JprogEntry,
-        onProgress: (progress: number, message?: string) => void
+        onProgress: (progress: number, message?: string) => void,
     ): AppThunk<RootState, Promise<Device>> =>
     async (dispatch, getState) => {
         try {
@@ -37,7 +37,7 @@ const programDeviceWithFw =
                     onProgress: progress => {
                         onProgress(
                             progress.totalProgressPercentage,
-                            'Recovering device'
+                            'Recovering device',
                         );
                     },
                 });
@@ -50,7 +50,7 @@ const programDeviceWithFw =
                 onProgress: progress => {
                     onProgress(
                         progress.totalProgressPercentage,
-                        progress.message ?? 'programming'
+                        progress.message ?? 'programming',
                     );
                 },
             });
@@ -62,7 +62,7 @@ const programDeviceWithFw =
                 onProgress: progress => {
                     onProgress(
                         progress.totalProgressPercentage,
-                        'Resetting device'
+                        'Resetting device',
                     );
                 },
             });
@@ -78,7 +78,7 @@ const programDeviceWithFw =
             if (programError instanceof Error) {
                 logger.error(programError);
                 throw new Error(
-                    `Error when programming ${programError.message}`
+                    `Error when programming ${programError.message}`,
                 );
             }
         }
@@ -88,7 +88,7 @@ const programDeviceWithFw =
 const firmwareOptions = (
     device: Device,
     firmware: JprogEntry[],
-    deviceInfo?: DeviceInfo
+    deviceInfo?: DeviceInfo,
 ) =>
     firmware.filter(fw => {
         const family = (device.devkit?.deviceFamily || '').toLowerCase();
@@ -110,7 +110,7 @@ const firmwareOptions = (
 export const jprogDeviceSetup = (
     firmware: JprogEntry[],
     needSerialport = false,
-    hideDeviceSetupWhenProtected = false
+    hideDeviceSetupWhenProtected = false,
 ): DeviceSetup => ({
     supportsProgrammingMode: device =>
         (needSerialport === !!device.traits.serialPorts || !needSerialport) &&
@@ -121,7 +121,7 @@ export const jprogDeviceSetup = (
             description: firmwareOption.description,
             programDevice: onProgress => dispatch =>
                 dispatch(
-                    programDeviceWithFw(device, firmwareOption, onProgress)
+                    programDeviceWithFw(device, firmwareOption, onProgress),
                 ),
         })),
     isExpectedFirmware: (device, deviceInfo) => async (_, getState) => {
@@ -137,7 +137,7 @@ export const jprogDeviceSetup = (
             getReadbackProtection(getState()) !== 'NRFDL_PROTECTION_STATUS_NONE'
         ) {
             logger.warn(
-                'Readback protection on device enabled. Unable to verify that the firmware version is correct.'
+                'Readback protection on device enabled. Unable to verify that the firmware version is correct.',
             );
 
             return Promise.resolve({
@@ -153,8 +153,8 @@ export const jprogDeviceSetup = (
                     info.imageInfoList.find(
                         imageInfo =>
                             typeof imageInfo.version === 'string' &&
-                            imageInfo.version.includes(version.fwVersion)
-                    )
+                            imageInfo.version.includes(version.fwVersion),
+                    ),
                 );
 
                 return Promise.resolve({