Merge pull request #613 from NordicSemiconductor/refactor/rename-device-setup-types

Refactor/rename device setup types

Author: kylebonnici

.gitignore

@@ -3,4 +3,5 @@
 /coverage
 /scripts/nordic-publish.js
 /dist
-/typings/generated/tsconfig.tsbuildinfo
+/typings/generated/tsconfig.tsbuildinfo
+.vscode/settings.json

Changelog.md

@@ -16,6 +16,11 @@ every new version is a new major version.
 -   Optional `choiceMessage` to `DeviceSetup`
 -   `react-dom` is now listed as an external package.
 
+### Changed
+
+-   `IDeviceSetup` renamed to `DeviceSetup`
+-   `DeviceSetup` renamed to `DeviceSetupConfig`
+
 ### Removed
 
 -   `needSerialport` property from `DeviceSetup`.
@@ -26,6 +31,8 @@ every new version is a new major version.
 -   `needSerialport` has been removed from `IDeviceSetup`. If needed, it should
     be placed into the `supportsProgrammingMode` callback or can be passed as a
     parameter to the `jprogDeviceSetup` or `sdfuDeviceSetup` wrappers.
+-   Replace type `DeviceSetup` with `DeviceSetupConfig`
+-   Replace type `IDeviceSetup` with `DeviceSetup`
 
 ## 46 - 2023-05-19
 

src/Device/DeviceSelector/DeviceSelector.test.tsx

@@ -231,7 +231,7 @@ describe('DeviceSelector', () => {
                     jlink: true,
                     mcuBoot: true,
                 }}
-                deviceSetup={{
+                deviceSetupConfig={{
                     deviceSetups: [
                         jprogDeviceSetup([
                             {
@@ -263,7 +263,7 @@ describe('DeviceSelector', () => {
                     jlink: true,
                     mcuBoot: true,
                 }}
-                deviceSetup={{
+                deviceSetupConfig={{
                     deviceSetups: [
                         jprogDeviceSetup([
                             {
@@ -301,7 +301,7 @@ describe('DeviceSelector', () => {
                     jlink: true,
                     mcuBoot: true,
                 }}
-                deviceSetup={validFirmware}
+                deviceSetupConfig={validFirmware}
             />,
             [setDevices([testDevice])]
         );
@@ -323,7 +323,7 @@ describe('DeviceSelector', () => {
                     jlink: true,
                     mcuBoot: true,
                 }}
-                deviceSetup={validFirmware}
+                deviceSetupConfig={validFirmware}
             />,
             [setDevices([testDevice])]
         );

src/Device/DeviceSelector/DeviceSelector.tsx

@@ -16,7 +16,7 @@ import {
     setAutoSelectDevice,
 } from '../deviceAutoSelectSlice';
 import { startWatchingDevices, stopWatchingDevices } from '../deviceLister';
-import { DeviceSetup as DeviceSetupShared, setupDevice } from '../deviceSetup';
+import { DeviceSetupConfig, setupDevice } from '../deviceSetup';
 import DeviceSetupView from '../DeviceSetup/DeviceSetupView';
 import {
     deselectDevice,
@@ -35,7 +35,7 @@ interface OutdatedDeviceTraits {
 
 export interface Props {
     deviceListing: DeviceTraits & OutdatedDeviceTraits;
-    deviceSetup?: DeviceSetupShared;
+    deviceSetupConfig?: DeviceSetupConfig;
     onDeviceSelected?: (device: Device, autoReselected: boolean) => void;
     onDeviceDeselected?: () => void;
     onDeviceConnected?: (device: Device) => void;
@@ -47,7 +47,7 @@ export interface Props {
 const noop = () => {};
 export default ({
     deviceListing,
-    deviceSetup,
+    deviceSetupConfig,
     onDeviceSelected = noop,
     onDeviceDeselected = noop,
     onDeviceConnected = noop,
@@ -80,19 +80,19 @@ export default ({
             dispatch(selectDevice(device));
             dispatch(setAutoSelectDevice(device));
             onDeviceSelected(device, autoReselected);
-            if (deviceSetup) {
+            if (deviceSetupConfig) {
                 dispatch(
                     setupDevice(
                         device,
-                        deviceSetup,
+                        deviceSetupConfig,
                         onDeviceIsReady,
                         doDeselectDevice
                     )
                 );
             }
         },
         [
-            deviceSetup,
+            deviceSetupConfig,
             dispatch,
             doDeselectDevice,
             onDeviceIsReady,

src/Device/deviceSetup.ts

@@ -3,8 +3,6 @@
  *
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
-import { SerialPort } from 'serialport';
-
 import logger from '../logging';
 import describeError from '../logging/describeError';
 import { Device, RootState, TDispatch } from '../state';
@@ -33,7 +31,7 @@ export interface JprogEntry {
     fwVersion: string;
 }
 
-export interface IDeviceSetup {
+export interface DeviceSetup {
     supportsProgrammingMode: (device: Device) => boolean; // Return true if this device can be programed using this interface e.g. MCU Boot or DFU
     getFirmwareOptions: (device: Device) => {
         key: string;
@@ -60,17 +58,17 @@ export interface IDeviceSetup {
     ) => Promise<Device | null>; // returns the device after switched to app mode. If this is not possible or not relevant return null
 }
 
-export interface DeviceSetup {
-    deviceSetups: IDeviceSetup[];
-    allowCustomDevice?: boolean; // allow custom J-Link device
+export interface DeviceSetupConfig {
+    deviceSetups: DeviceSetup[];
+    allowCustomDevice?: boolean;
     confirmMessage?: string;
     choiceMessage?: string;
 }
 
 export const prepareDevice =
     (
         device: Device,
-        deviceSetupConfig: DeviceSetup,
+        deviceSetupConfig: DeviceSetupConfig,
         onSuccess: (device: Device) => void,
         onFail: (reason?: unknown) => void,
         checkCurrentFirmwareVersion = true,
@@ -225,20 +223,18 @@ export const prepareDevice =
 export const setupDevice =
     (
         device: Device,
-        deviceSetup: DeviceSetup,
+        deviceSetupConfig: DeviceSetupConfig,
         onDeviceIsReady: (device: Device) => void,
         doDeselectDevice: () => void
     ) =>
-    (dispatch: TDispatch, getState: () => RootState) => {
-        const deviceSetupConfig = {
-            allowCustomDevice: false,
-            ...deviceSetup,
-        };
-
+    (dispatch: TDispatch, getState: () => RootState) =>
         dispatch(
             prepareDevice(
                 device,
-                deviceSetupConfig,
+                {
+                    allowCustomDevice: false,
+                    ...deviceSetupConfig,
+                },
                 d => {
                     // Given that this task has async elements to it one might call setupDevice and
                     // while that is still in progress select some other device
@@ -260,4 +256,3 @@ export const setupDevice =
                 }
             )
         );
-    };

src/Device/jprogOperations.ts

@@ -16,7 +16,7 @@ import nrfDeviceLib, {
 import logger from '../logging';
 import { Device, RootState, TDispatch } from '../state';
 import { getDeviceLibContext } from './deviceLibWrapper';
-import { IDeviceSetup, JprogEntry } from './deviceSetup';
+import { DeviceSetup, JprogEntry } from './deviceSetup';
 import { setReadbackProtected } from './deviceSlice';
 
 const program = (
@@ -155,7 +155,7 @@ const firmwareOptions = (device: Device, firmware: JprogEntry[]) =>
 export const jprogDeviceSetup = (
     firmware: JprogEntry[],
     needSerialport = false
-): IDeviceSetup => ({
+): DeviceSetup => ({
     supportsProgrammingMode: (device: Device) =>
         (needSerialport === !!device.traits.serialPorts || !needSerialport) &&
         !!device.traits.jlink,

src/Device/sdfuOperations.ts

@@ -15,7 +15,7 @@ import { Device, TDispatch } from '../state';
 import { getAppFile } from '../utils/appDirs';
 import { setWaitForDevice } from './deviceAutoSelectSlice';
 import { getDeviceLibContext } from './deviceLibWrapper';
-import { DfuEntry, IDeviceSetup } from './deviceSetup';
+import { DeviceSetup, DfuEntry } from './deviceSetup';
 import { openDeviceSetupDialog } from './deviceSetupSlice';
 import {
     createInitPacketBuffer,
@@ -549,7 +549,7 @@ const programDeviceWithFw =
 export const sdfuDeviceSetup = (
     dfuFirmware: DfuEntry[],
     needSerialport = false
-): IDeviceSetup => ({
+): DeviceSetup => ({
     supportsProgrammingMode: (device: Device) =>
         ((!!device.dfuTriggerVersion &&
             device.dfuTriggerVersion.semVer.length > 0) ||

src/index.ts

@@ -125,7 +125,7 @@ export type { Props as DeviceSelectorProps } from './Device/DeviceSelector/Devic
 
 export type { PaneProps } from './App/App';
 export type { DfuImage } from './Device/initPacket';
-export type { DeviceSetup, IDeviceSetup } from './Device/deviceSetup';
+export type { DeviceSetupConfig, DeviceSetup } from './Device/deviceSetup';
 export { prepareDevice } from './Device/deviceSetup';
 export type {
     AppInfo,

typings/generated/src/Device/DeviceSelector/DeviceSelector.d.ts

@@ -1,20 +1,20 @@
 /// <reference types="react" />
 import { DeviceTraits } from '@nordicsemiconductor/nrf-device-lib-js';
 import { Device } from '../../state';
-import { DeviceSetup as DeviceSetupShared } from '../deviceSetup';
+import { DeviceSetupConfig } from '../deviceSetup';
 interface OutdatedDeviceTraits {
     serialPort?: boolean;
     serialport?: boolean;
 }
 export interface Props {
     deviceListing: DeviceTraits & OutdatedDeviceTraits;
-    deviceSetup?: DeviceSetupShared;
+    deviceSetupConfig?: DeviceSetupConfig;
     onDeviceSelected?: (device: Device, autoReselected: boolean) => void;
     onDeviceDeselected?: () => void;
     onDeviceConnected?: (device: Device) => void;
     onDeviceDisconnected?: (device: Device) => void;
     onDeviceIsReady?: (device: Device) => void;
     deviceFilter?: (device: Device) => boolean;
 }
-declare const _default: ({ deviceListing, deviceSetup, onDeviceSelected, onDeviceDeselected, onDeviceConnected, onDeviceDisconnected, onDeviceIsReady, deviceFilter, }: Props) => JSX.Element;
+declare const _default: ({ deviceListing, deviceSetupConfig, onDeviceSelected, onDeviceDeselected, onDeviceConnected, onDeviceDisconnected, onDeviceIsReady, deviceFilter, }: Props) => JSX.Element;
 export default _default;

typings/generated/src/Device/deviceSetup.d.ts

@@ -16,7 +16,7 @@ export interface JprogEntry {
     fwIdAddress: number;
     fwVersion: string;
 }
-export interface IDeviceSetup {
+export interface DeviceSetup {
     supportsProgrammingMode: (device: Device) => boolean;
     getFirmwareOptions: (device: Device) => {
         key: string;
@@ -29,11 +29,11 @@ export interface IDeviceSetup {
     }>;
     tryToSwitchToApplicationMode: (device: Device) => (dispatch: TDispatch, getState: () => RootState) => Promise<Device | null>;
 }
-export interface DeviceSetup {
-    deviceSetups: IDeviceSetup[];
+export interface DeviceSetupConfig {
+    deviceSetups: DeviceSetup[];
     allowCustomDevice?: boolean;
     confirmMessage?: string;
     choiceMessage?: string;
 }
-export declare const prepareDevice: (device: Device, deviceSetupConfig: DeviceSetup, onSuccess: (device: Device) => void, onFail: (reason?: unknown) => void, checkCurrentFirmwareVersion?: boolean, requireUserConfirmation?: boolean) => (dispatch: TDispatch) => Promise<void>;
-export declare const setupDevice: (device: Device, deviceSetup: DeviceSetup, onDeviceIsReady: (device: Device) => void, doDeselectDevice: () => void) => (dispatch: TDispatch, getState: () => RootState) => void;
+export declare const prepareDevice: (device: Device, deviceSetupConfig: DeviceSetupConfig, onSuccess: (device: Device) => void, onFail: (reason?: unknown) => void, checkCurrentFirmwareVersion?: boolean, requireUserConfirmation?: boolean) => (dispatch: TDispatch) => Promise<void>;
+export declare const setupDevice: (device: Device, deviceSetupConfig: DeviceSetupConfig, onDeviceIsReady: (device: Device) => void, doDeselectDevice: () => void) => (dispatch: TDispatch, getState: () => RootState) => Promise<void>;