fix: Add some exclusion to types to better handle remmaped DeviceEvent type to Redux Actions

Author: peter-sanderson

packages/suite/src/types/suite/index.ts

@@ -9,7 +9,8 @@ import { messageSystemActions } from '@suite-common/message-system';
 import type { Route } from '@suite-common/suite-types';
 import { notificationsActions } from '@suite-common/toast-notifications';
 import { deviceActions, discoveryActions, transactionsActions } from '@suite-common/wallet-core';
-import type { BlockchainEvent, TransportEvent, UiEvent } from '@trezor/connect';
+import { BlockchainEvent, DEVICE, DeviceEvent, TransportEvent, UiEvent } from '@trezor/connect';
+import { FilterOutFromUnionByTypeProperty } from '@trezor/type-utils';
 
 import type { BackupAction } from 'src/actions/backup/backupActions';
 import type { OnboardingAction } from 'src/actions/onboarding/onboardingActions';
@@ -41,7 +42,14 @@ export type {
     TrezorDevice,
 } from '@suite-common/suite-types';
 
-type TrezorConnectEvents = TransportEvent | UiEvent | BlockchainEvent;
+type FilteredDeviceEvents = FilterOutFromUnionByTypeProperty<
+    DeviceEvent,
+    // Those types are remapped onto different actions in the connectInitThunks.ts and not used directly
+    // as the rest of the DeviceEvents.
+    typeof DEVICE.CONNECT | typeof DEVICE.CONNECT_UNACQUIRED
+>;
+
+type TrezorConnectEvents = TransportEvent | UiEvent | FilteredDeviceEvents | BlockchainEvent;
 
 export type TransactionAction = ReturnType<
     (typeof transactionsActions)[keyof typeof transactionsActions]
@@ -62,7 +70,7 @@ type DeviceAuthenticityAction = ReturnType<
 
 // all actions from all apps used to properly type Dispatch.
 export type Action =
-    | TrezorConnectEvents // Todo: This should not be here, actions shall be defined independently from Connect Events (and they shall be mapped onto them)
+    | TrezorConnectEvents
     | RouterAction
     | WindowAction
     | StorageAction
@@ -113,6 +121,7 @@ export type ForegroundAppProps = {
 export type ToastNotificationVariant = 'success' | 'info' | 'warning' | 'error' | 'transparent';
 
 export { TorStatus } from '@trezor/suite-desktop-api/src/enums';
+
 export interface TorBootstrap {
     current: number;
     total: number;

packages/type-utils/src/utils.ts

@@ -108,3 +108,23 @@ export type DefinedUnionMember<T> = T extends string ? T : never;
 export type FilterPropertiesByType<T, ValueFilter> = {
     [Key in keyof T as T[Key] extends ValueFilter ? Key : never]: T[Key];
 };
+
+/**
+ * Removed the type from the union where `{ type: U }`.
+ *
+ * Example:
+ *  ```
+ *  type T1 =
+ *     | { type: 'A'; a: string }
+ *     | { type: 'B'; b: number }
+ *     | { type: 'C' | 'D' | 'E'; cde: boolean };
+ *
+ *  // { type: 'A', a: string } | { type: 'B', b: number } | { type: 'D' | 'E', cde: boolean };
+ *  type NotC = FilterOutFromUnionByTypeProperty<T1, 'C'>;
+ *  ```
+ */
+export type FilterOutFromUnionByTypeProperty<T, U> = T extends { type: infer P }
+    ? P extends U
+        ? never
+        : { type: Exclude<P, U> } & Omit<T, 'type'>
+    : T;

suite-common/wallet-core/src/device/deviceActions.ts

@@ -2,7 +2,7 @@ import { createAction } from '@reduxjs/toolkit';
 
 import { ButtonRequest, TrezorDevice } from '@suite-common/suite-types';
 import { WalletType } from '@suite-common/wallet-types';
-import { DEVICE, Device, DeviceVersionChanged } from '@trezor/connect';
+import { DEVICE, Device } from '@trezor/connect';
 
 export const DEVICE_MODULE_PREFIX = '@suite/device';
 
@@ -29,16 +29,6 @@ const deviceDisconnect = createAction(DEVICE.DISCONNECT, (payload: TrezorDevice)
     payload,
 }));
 
-// this action is not used but is required because of the typings
-// changed here: https://github.com/trezor/trezor-suite/commit/c02412bccf80da7c827f624b7a7c85cdedf278c5#diff-2e9d057f0bfe2cc92fe50d4ce28838622d9e79fcca010ab8847a0fa288da13fd
-// in fact action is dispatched from connectInitThunk same as the rest of events
-const deviceFirmwareVersionChanged = createAction(
-    DEVICE.FIRMWARE_VERSION_CHANGED,
-    (payload: DeviceVersionChanged['payload']) => ({
-        payload,
-    }),
-);
-
 const updatePassphraseMode = createAction(
     `${DEVICE_MODULE_PREFIX}/updatePassphraseMode`,
     (payload: { device: TrezorDevice; hidden: boolean; alwaysOnDevice?: boolean }) => ({ payload }),
@@ -118,5 +108,4 @@ export const deviceActions = {
     updateSelectedDevice,
     removeButtonRequests,
     setEntropyCheckFail,
-    deviceFirmwareVersionChanged,
 };