@ledgerhq/live-common
Version:
Common ground for the Ledger Live apps
46 lines • 2.47 kB
JavaScript
import { useEffect, useState } from "react";
import { log } from "@ledgerhq/logs";
import { getLatestAvailableFirmwareAction as defaultGetLatestAvailableFirmwareAction, initialState, } from "../actions/getLatestAvailableFirmware";
import { filterIgnoredFirmwareUpdates } from "./filterIgnoredFirmwareUpdates";
/**
* Hook to get the latest available firmware that the device could update to
*
* @param `deviceId` A device id, or an empty string if device is usb plugged
* @param isHookEnabled A boolean to enable (true, default value) or disable (false) the hook
* @returns an object containing the state of the process to get the latest available firmware.
* The state is as follow (+ shared state with other actions):
* - `firmwareUpdateContext`: the `FirmwareUpdateContext` when retrieved, null otherwise
* - `deviceInfo`: the `DeviceInfo` when retrieved, null otherwise
* - `status`: the current status of the action: "error" | "no-available-firmware" | "available-firmware" meaning the action has finished
* - `error`: an error coming from the business logic, the device or internal. Some error are retried:
* `{ type`: "SharedError", retrying: true, ... }`
* - `...sharedActionState`
*/
export const useGetLatestAvailableFirmware = ({ getLatestAvailableFirmwareAction = defaultGetLatestAvailableFirmwareAction, deviceId, isHookEnabled = true, ignoredOSUpdates, }) => {
const [state, setState] = useState(initialState);
useEffect(() => {
if (!isHookEnabled) {
return;
}
// Resets the resulting state on each new triggering
// (not on clean up, to keep the last state when `isHookEnabled === false`)
setState(initialState);
const subscription = getLatestAvailableFirmwareAction({
deviceId,
}).subscribe({
next: newValue => {
const filteredValue = filterIgnoredFirmwareUpdates(newValue, ignoredOSUpdates);
setState(filteredValue);
},
error: (error) => {
// Error from an action should be handled like an event and should not reach here
log("useGetLatestAvailableFirmware", "Unknown error", error);
},
});
return () => {
subscription.unsubscribe();
};
}, [deviceId, getLatestAvailableFirmwareAction, ignoredOSUpdates, isHookEnabled]);
return { state };
};
//# sourceMappingURL=useGetLatestAvailableFirmware.js.map