@exodus/hw-ledger 2.8.1 → 2.9.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.9.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@2.8.1...@exodus/hw-ledger@2.9.0) (2024-07-16)
+
+### Features
+
+- **hw-ledger:** expose bluetooth status to clients ([#7848](https://github.com/ExodusMovement/exodus-hydra/issues/7848)) ([36943b1](https://github.com/ExodusMovement/exodus-hydra/commit/36943b194c286a07c44dd78bd3a1f03324c87ce8))
+
 ## [2.8.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@2.8.0...@exodus/hw-ledger@2.8.1) (2024-07-10)
 
 ### Bug Fixes

package/lib/atoms/index.d.ts

@@ -1,5 +1,5 @@
-export declare const bluetoothEnabledAtomDefinition: {
-    readonly id: "bluetoothEnabledAtom";
+export declare const bluetoothStatusAtomDefinition: {
+    readonly id: "bluetoothStatusAtom";
     readonly type: "atom";
     readonly factory: () => import("@exodus/atoms").Atom<boolean>;
     readonly dependencies: readonly [];

package/lib/atoms/index.js

@@ -1,6 +1,6 @@
 import { createInMemoryAtom } from '@exodus/atoms';
-export const bluetoothEnabledAtomDefinition = {
-    id: 'bluetoothEnabledAtom',
+export const bluetoothStatusAtomDefinition = {
+    id: 'bluetoothStatusAtom',
     type: 'atom',
     factory: () => createInMemoryAtom({ defaultValue: false }),
     dependencies: [],

package/lib/index.d.ts

@@ -3,7 +3,7 @@ declare const hardwareWalletLedger: ({ bluetoothScannerTimeout, }?: Partial<HwLe
     readonly id: "hardwareWalletLedger";
     readonly definitions: readonly [{
         readonly definition: {
-            readonly id: "bluetoothEnabledAtom";
+            readonly id: "bluetoothStatusAtom";
             readonly type: "atom";
             readonly factory: () => import("libraries/atoms/lib").Atom<boolean>;
             readonly dependencies: readonly [];
@@ -19,10 +19,10 @@ declare const hardwareWalletLedger: ({ bluetoothScannerTimeout, }?: Partial<HwLe
         readonly definition: {
             readonly id: "hardwareWalletLedgerPlugin";
             readonly type: "plugin";
-            readonly factory: ({ logger, transportsFactories, bluetoothEnabledAtom, bluetoothScanningAtom, port, }: {
+            readonly factory: ({ logger, transportsFactories, bluetoothStatusAtom, bluetoothScanningAtom, port, }: {
                 logger: import("./shared/types").Logger;
                 transportsFactories: import("./module/types").TransportFactories;
-                bluetoothEnabledAtom: import("libraries/atoms/lib").Atom<boolean>;
+                bluetoothStatusAtom: import("libraries/atoms/lib").Atom<import("./redux/initial-state").BluetoothStatus>;
                 bluetoothScanningAtom: import("libraries/atoms/lib").Atom<boolean>;
                 port: import("./shared/types").Port;
             }) => {
@@ -30,7 +30,7 @@ declare const hardwareWalletLedger: ({ bluetoothScannerTimeout, }?: Partial<HwLe
                 onLoad: () => void;
                 onStop: () => void;
             };
-            readonly dependencies: readonly ["logger", "transportsFactories", "bluetoothEnabledAtom", "bluetoothScanningAtom", "port"];
+            readonly dependencies: readonly ["logger", "transportsFactories", "bluetoothStatusAtom", "bluetoothScanningAtom", "port"];
         };
     }, {
         readonly definition: {

package/lib/index.js

@@ -1,4 +1,4 @@
-import { bluetoothEnabledAtomDefinition, bluetoothScanningAtomDefinition } from './atoms';
+import { bluetoothStatusAtomDefinition, bluetoothScanningAtomDefinition } from './atoms';
 import ledgerDiscoveryDefinition from './module';
 import hardwareWalletLedgerPluginDefinition from './plugin';
 const hardwareWalletLedger = ({ bluetoothScannerTimeout = 10000, } = {}) => {
@@ -6,7 +6,7 @@ const hardwareWalletLedger = ({ bluetoothScannerTimeout = 10000, } = {}) => {
         id: 'hardwareWalletLedger',
         definitions: [
             {
-                definition: bluetoothEnabledAtomDefinition,
+                definition: bluetoothStatusAtomDefinition,
             },
             {
                 definition: bluetoothScanningAtomDefinition,

package/lib/plugin/index.d.ts

@@ -1,13 +1,14 @@
 import type { Atom } from '@exodus/atoms';
 import type { TransportFactories } from '../module/types';
 import type { Logger, Port } from '../shared/types';
+import { BluetoothStatus } from '../redux/initial-state';
 declare const hardwareWalletLedgerPluginDefinition: {
     readonly id: "hardwareWalletLedgerPlugin";
     readonly type: "plugin";
-    readonly factory: ({ logger, transportsFactories, bluetoothEnabledAtom, bluetoothScanningAtom, port, }: {
+    readonly factory: ({ logger, transportsFactories, bluetoothStatusAtom, bluetoothScanningAtom, port, }: {
         logger: Logger;
         transportsFactories: TransportFactories;
-        bluetoothEnabledAtom: Atom<boolean>;
+        bluetoothStatusAtom: Atom<BluetoothStatus>;
         bluetoothScanningAtom: Atom<boolean>;
         port: Port;
     }) => {
@@ -15,6 +16,6 @@ declare const hardwareWalletLedgerPluginDefinition: {
         onLoad: () => void;
         onStop: () => void;
     };
-    readonly dependencies: readonly ["logger", "transportsFactories", "bluetoothEnabledAtom", "bluetoothScanningAtom", "port"];
+    readonly dependencies: readonly ["logger", "transportsFactories", "bluetoothStatusAtom", "bluetoothScanningAtom", "port"];
 };
 export default hardwareWalletLedgerPluginDefinition;

package/lib/plugin/index.js

@@ -1,8 +1,8 @@
 import { createAtomObserver } from '@exodus/atoms';
-const createHardwareWalletLedgerPlugin = ({ logger, transportsFactories, bluetoothEnabledAtom, bluetoothScanningAtom, port, }) => {
+const createHardwareWalletLedgerPlugin = ({ logger, transportsFactories, bluetoothStatusAtom, bluetoothScanningAtom, port, }) => {
     let subscription;
     const observers = [
-        createAtomObserver({ atom: bluetoothEnabledAtom, port, event: 'bluetoothEnabled' }),
+        createAtomObserver({ atom: bluetoothStatusAtom, port, event: 'bluetoothStatus' }),
         createAtomObserver({ atom: bluetoothScanningAtom, port, event: 'bluetoothScanning' }),
     ];
     observers.forEach((observer) => observer.register());
@@ -13,17 +13,13 @@ const createHardwareWalletLedgerPlugin = ({ logger, transportsFactories, bluetoo
             return;
         if (transportsFactories.bluetooth.observeState) {
             subscription = transportsFactories.bluetooth.observeState({
-                next: (e) => {
-                    bluetoothEnabledAtom.set(!!e.available);
-                },
+                next: ({ type, available }) => bluetoothStatusAtom.set({ type, available }),
                 error: (error) => logger.error(error),
             });
         }
         else if (transportsFactories.bluetooth.observeAvailability) {
             subscription = transportsFactories.bluetooth.observeAvailability({
-                next: (available) => {
-                    bluetoothEnabledAtom.set(available);
-                },
+                next: (available) => bluetoothStatusAtom.set({ type: 'Unknown', available }),
                 error: (error) => logger.error(error),
             });
         }
@@ -51,7 +47,7 @@ const hardwareWalletLedgerPluginDefinition = {
     dependencies: [
         'logger',
         'transportsFactories',
-        'bluetoothEnabledAtom',
+        'bluetoothStatusAtom',
         'bluetoothScanningAtom',
         'port',
     ],

package/lib/redux/index.d.ts

@@ -4,18 +4,18 @@ declare const exchangeReduxDefinition: {
     readonly type: "redux-module";
     readonly initialState: LedgerHardwareWalletState;
     readonly eventReducers: {
-        readonly bluetoothEnabled: (state: LedgerHardwareWalletState, payload: boolean) => {
-            bluetoothEnabled: boolean;
+        readonly bluetoothStatus: (state: LedgerHardwareWalletState, payload: boolean) => {
+            bluetoothStatus: boolean;
             bluetoothScanning: boolean;
         };
         readonly bluetoothScanning: (state: LedgerHardwareWalletState, payload: boolean) => {
             bluetoothScanning: boolean;
-            bluetoothEnabled: boolean;
+            bluetoothStatus: import("./initial-state").BluetoothStatus;
         };
     };
     readonly selectorDefinitions: ({
-        readonly id: "bluetoothEnabled";
-        readonly resultFunction: (state: LedgerHardwareWalletState) => boolean;
+        readonly id: "bluetoothStatus";
+        readonly resultFunction: (state: LedgerHardwareWalletState) => import("./initial-state").BluetoothStatus;
         readonly dependencies: readonly [{
             readonly selector: string;
         }];

package/lib/redux/index.js

@@ -6,9 +6,9 @@ const exchangeReduxDefinition = {
     type: 'redux-module',
     initialState,
     eventReducers: {
-        bluetoothEnabled: (state, payload) => ({
+        bluetoothStatus: (state, payload) => ({
             ...state,
-            bluetoothEnabled: payload,
+            bluetoothStatus: payload,
         }),
         bluetoothScanning: (state, payload) => ({
             ...state,

package/lib/redux/initial-state.d.ts

@@ -1,5 +1,9 @@
+export type BluetoothStatus = {
+    type: 'Unknown' | 'Resetting' | 'Unsupported' | 'Unauthorized' | 'PoweredOff' | 'PoweredOn';
+    available: boolean;
+};
 export type LedgerHardwareWalletState = {
-    bluetoothEnabled: boolean;
+    bluetoothStatus: BluetoothStatus;
     bluetoothScanning: boolean;
 };
 declare const initialState: LedgerHardwareWalletState;

package/lib/redux/initial-state.js

@@ -1,5 +1,5 @@
 const initialState = {
-    bluetoothEnabled: false,
+    bluetoothStatus: { type: 'Unknown', available: false },
     bluetoothScanning: false,
 };
 export default initialState;

package/lib/redux/selectors/{bluetoothEnabled.d.ts → bluetoothStatus.d.ts}

@@ -1,9 +1,9 @@
 import type { LedgerHardwareWalletState } from '../initial-state';
-declare const bluetoothEnabledSelectorDefinition: {
-    readonly id: "bluetoothEnabled";
-    readonly resultFunction: (state: LedgerHardwareWalletState) => boolean;
+declare const bluetoothStatusSelectorDefinition: {
+    readonly id: "bluetoothStatus";
+    readonly resultFunction: (state: LedgerHardwareWalletState) => import("../initial-state").BluetoothStatus;
     readonly dependencies: readonly [{
         readonly selector: string;
     }];
 };
-export default bluetoothEnabledSelectorDefinition;
+export default bluetoothStatusSelectorDefinition;

package/lib/redux/selectors/bluetoothStatus.js

@@ -0,0 +1,8 @@
+import { MY_STATE } from '@exodus/redux-dependency-injection';
+const resultFunction = (state) => state.bluetoothStatus;
+const bluetoothStatusSelectorDefinition = {
+    id: 'bluetoothStatus',
+    resultFunction,
+    dependencies: [{ selector: MY_STATE }],
+};
+export default bluetoothStatusSelectorDefinition;

package/lib/redux/selectors/index.d.ts

@@ -1,6 +1,6 @@
 declare const ledgerSelectors: ({
-    readonly id: "bluetoothEnabled";
-    readonly resultFunction: (state: import("../initial-state").LedgerHardwareWalletState) => boolean;
+    readonly id: "bluetoothStatus";
+    readonly resultFunction: (state: import("../initial-state").LedgerHardwareWalletState) => import("../initial-state").BluetoothStatus;
     readonly dependencies: readonly [{
         readonly selector: string;
     }];

package/lib/redux/selectors/index.js

@@ -1,4 +1,4 @@
-import bluetoothEnabledSelectorDefinition from './bluetoothEnabled';
+import bluetoothStatusSelectorDefinition from './bluetoothStatus';
 import bluetoothScanningSelectorDefinition from './bluetoothScanning';
-const ledgerSelectors = [bluetoothEnabledSelectorDefinition, bluetoothScanningSelectorDefinition];
+const ledgerSelectors = [bluetoothStatusSelectorDefinition, bluetoothScanningSelectorDefinition];
 export default ledgerSelectors;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/hw-ledger",
-  "version": "2.8.1",
+  "version": "2.9.0",
   "description": "The ledger module",
   "author": "Exodus Movement, Inc.",
   "repository": {
@@ -72,5 +72,5 @@
     "ts-jest": "^29.0.3",
     "typescript": "^4.7.3"
   },
-  "gitHead": "53b2dc8a2362537c92f3be5b23c6f71e13980d81"
+  "gitHead": "03f1666538fa7d596c729b77a380f891f7e747e4"
 }

package/lib/redux/selectors/bluetoothEnabled.js

@@ -1,8 +0,0 @@
-import { MY_STATE } from '@exodus/redux-dependency-injection';
-const resultFunction = (state) => state.bluetoothEnabled;
-const bluetoothEnabledSelectorDefinition = {
-    id: 'bluetoothEnabled',
-    resultFunction,
-    dependencies: [{ selector: MY_STATE }],
-};
-export default bluetoothEnabledSelectorDefinition;