@ledgerhq/live-common 24.0.0 → 24.1.0

package/lib/hw/getOnboardingStatePolling.js

@@ -0,0 +1,117 @@
+"use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+exports.isAllowedOnboardingStatePollingError = exports.getOnboardingStatePolling = void 0;
+var rxjs_1 = require("rxjs");
+var operators_1 = require("rxjs/operators");
+var getVersion_1 = __importDefault(require("./getVersion"));
+var deviceAccess_1 = require("./deviceAccess");
+var errors_1 = require("@ledgerhq/errors");
+var extractOnboardingState_1 = require("./extractOnboardingState");
+/**
+ * Polls the device onboarding state at a given frequency
+ * @param deviceId A device id
+ * @param pollingPeriodMs The period in ms after which the device onboarding state is fetched again
+ * @param fetchingTimeoutMs The time to wait while fetching for the device onboarding state before throwing an error, in ms
+ * @returns An Observable that polls the device onboarding state
+ */
+var getOnboardingStatePolling = function (_a) {
+    var deviceId = _a.deviceId, pollingPeriodMs = _a.pollingPeriodMs, _b = _a.fetchingTimeoutMs, fetchingTimeoutMs = _b === void 0 ? pollingPeriodMs : _b;
+    var firstRun = true;
+    var delayedOnceOnboardingStateObservable = new rxjs_1.Observable(function (subscriber) {
+        var delayMs = firstRun ? 0 : pollingPeriodMs;
+        firstRun = false;
+        var getOnboardingStateOnce = function () {
+            var firmwareInfoOrAllowedErrorObservable = (0, deviceAccess_1.withDevice)(deviceId)(function (t) {
+                return (0, rxjs_1.from)((0, getVersion_1["default"])(t));
+            }).pipe((0, operators_1.timeout)(fetchingTimeoutMs), // Throws a TimeoutError
+            (0, operators_1.first)(), (0, operators_1.catchError)(function (error) {
+                if ((0, exports.isAllowedOnboardingStatePollingError)(error)) {
+                    // Pushes the error to the next step to be processed (no retry from the beginning)
+                    return (0, rxjs_1.of)(error);
+                }
+                return (0, rxjs_1.throwError)(error);
+            }));
+            // If an error is catched previously, and this error is "allowed",
+            // the value from the observable is not a FirmwareInfo but an Error
+            var _a = __read((0, rxjs_1.partition)(firmwareInfoOrAllowedErrorObservable, 
+            // TS cannot infer correctly the value given to RxJS partition
+            function (value) { return Boolean(value === null || value === void 0 ? void 0 : value.flags); }), 2), firmwareInfoObservable = _a[0], allowedErrorObservable = _a[1];
+            var onboardingStateFromFirmwareInfoObservable = firmwareInfoObservable.pipe((0, operators_1.map)(function (firmwareInfo) {
+                var _a;
+                var onboardingState = null;
+                try {
+                    onboardingState = (0, extractOnboardingState_1.extractOnboardingState)(firmwareInfo.flags);
+                }
+                catch (error) {
+                    if (error instanceof errors_1.DeviceExtractOnboardingStateError) {
+                        return {
+                            onboardingState: null,
+                            allowedError: error
+                        };
+                    }
+                    else {
+                        return {
+                            onboardingState: null,
+                            allowedError: new errors_1.DeviceOnboardingStatePollingError("SyncOnboarding: Unknown error while extracting the onboarding state ".concat((_a = error === null || error === void 0 ? void 0 : error.name) !== null && _a !== void 0 ? _a : error, " ").concat(error === null || error === void 0 ? void 0 : error.message))
+                        };
+                    }
+                }
+                return { onboardingState: onboardingState, allowedError: null };
+            }));
+            // Handles the case of an (allowed) Error value
+            var onboardingStateFromAllowedErrorObservable = allowedErrorObservable.pipe((0, operators_1.map)(function (allowedError) {
+                return {
+                    onboardingState: null,
+                    allowedError: allowedError
+                };
+            }));
+            return (0, rxjs_1.merge)(onboardingStateFromFirmwareInfoObservable, onboardingStateFromAllowedErrorObservable);
+        };
+        // Delays the fetch of the onboarding state
+        setTimeout(function () {
+            getOnboardingStateOnce().subscribe({
+                next: function (value) {
+                    subscriber.next(value);
+                },
+                error: function (error) {
+                    subscriber.error(error);
+                },
+                complete: function () { return subscriber.complete(); }
+            });
+        }, delayMs);
+    });
+    return delayedOnceOnboardingStateObservable.pipe((0, operators_1.repeat)());
+};
+exports.getOnboardingStatePolling = getOnboardingStatePolling;
+var isAllowedOnboardingStatePollingError = function (error) {
+    if (error &&
+        // Timeout error is thrown by rxjs's timeout
+        (error instanceof rxjs_1.TimeoutError ||
+            error instanceof errors_1.DisconnectedDevice ||
+            error instanceof errors_1.CantOpenDevice ||
+            error instanceof errors_1.TransportStatusError)) {
+        return true;
+    }
+    return false;
+};
+exports.isAllowedOnboardingStatePollingError = isAllowedOnboardingStatePollingError;
+//# sourceMappingURL=getOnboardingStatePolling.js.map

package/lib/hw/getOnboardingStatePolling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOnboardingStatePolling.js","sourceRoot":"","sources":["../../src/hw/getOnboardingStatePolling.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,6BAQc;AACd,4CAAyE;AACzE,4DAAsC;AACtC,+CAA4C;AAC5C,2CAM0B;AAE1B,mEAGkC;AAOlC;;;;;;GAMG;AACI,IAAM,yBAAyB,GAAG,UAAC,EAQzC;QAPC,QAAQ,cAAA,EACR,eAAe,qBAAA,EACf,yBAAmC,EAAnC,iBAAiB,mBAAG,eAAe,KAAA;IAMnC,IAAI,QAAQ,GAAG,IAAI,CAAC;IAEpB,IAAM,oCAAoC,GACxC,IAAI,iBAAU,CAAC,UAAC,UAAU;QACxB,IAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC;QAC/C,QAAQ,GAAG,KAAK,CAAC;QAEjB,IAAM,sBAAsB,GAAG;YAC7B,IAAM,oCAAoC,GAAG,IAAA,yBAAU,EAAC,QAAQ,CAAC,CAAC,UAAC,CAAC;gBAClE,OAAA,IAAA,WAAI,EAAC,IAAA,uBAAU,EAAC,CAAC,CAAC,CAAC;YAAnB,CAAmB,CACpB,CAAC,IAAI,CACJ,IAAA,mBAAO,EAAC,iBAAiB,CAAC,EAAE,wBAAwB;YACpD,IAAA,iBAAK,GAAE,EACP,IAAA,sBAAU,EAAC,UAAC,KAAU;gBACpB,IAAI,IAAA,4CAAoC,EAAC,KAAK,CAAC,EAAE;oBAC/C,kFAAkF;oBAClF,OAAO,IAAA,SAAE,EAAC,KAAK,CAAC,CAAC;iBAClB;gBAED,OAAO,IAAA,iBAAU,EAAC,KAAK,CAAC,CAAC;YAC3B,CAAC,CAAC,CACH,CAAC;YAEF,kEAAkE;YAClE,mEAAmE;YAC7D,IAAA,KAAA,OAAmD,IAAA,gBAAS,EAChE,oCAAoC;YACpC,8DAA8D;YAC9D,UAAC,KAAU,IAAK,OAAA,OAAO,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,CAAC,EAArB,CAAqB,CACtC,IAAA,EAJM,sBAAsB,QAAA,EAAE,sBAAsB,QAIpD,CAAC;YAEF,IAAM,yCAAyC,GAC7C,sBAAsB,CAAC,IAAI,CACzB,IAAA,eAAG,EAAC,UAAC,YAA0B;;gBAC7B,IAAI,eAAe,GAA2B,IAAI,CAAC;gBAEnD,IAAI;oBACF,eAAe,GAAG,IAAA,+CAAsB,EAAC,YAAY,CAAC,KAAK,CAAC,CAAC;iBAC9D;gBAAC,OAAO,KAAU,EAAE;oBACnB,IAAI,KAAK,YAAY,0CAAiC,EAAE;wBACtD,OAAO;4BACL,eAAe,EAAE,IAAI;4BACrB,YAAY,EAAE,KAAK;yBACpB,CAAC;qBACH;yBAAM;wBACL,OAAO;4BACL,eAAe,EAAE,IAAI;4BACrB,YAAY,EAAE,IAAI,0CAAiC,CACjD,8EACE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,mCAAI,KAAK,cAClB,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,CAAE,CACrB;yBACF,CAAC;qBACH;iBACF;gBACD,OAAO,EAAE,eAAe,iBAAA,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;YACjD,CAAC,CAAC,CACH,CAAC;YAEJ,+CAA+C;YAC/C,IAAM,yCAAyC,GAC7C,sBAAsB,CAAC,IAAI,CACzB,IAAA,eAAG,EAAC,UAAC,YAAmB;gBACtB,OAAO;oBACL,eAAe,EAAE,IAAI;oBACrB,YAAY,EAAE,YAAY;iBAC3B,CAAC;YACJ,CAAC,CAAC,CACH,CAAC;YAEJ,OAAO,IAAA,YAAK,EACV,yCAAyC,EACzC,yCAAyC,CAC1C,CAAC;QACJ,CAAC,CAAC;QAEF,2CAA2C;QAC3C,UAAU,CAAC;YACT,sBAAsB,EAAE,CAAC,SAAS,CAAC;gBACjC,IAAI,EAAE,UAAC,KAAmC;oBACxC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACzB,CAAC;gBACD,KAAK,EAAE,UAAC,KAAU;oBAChB,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAC1B,CAAC;gBACD,QAAQ,EAAE,cAAM,OAAA,UAAU,CAAC,QAAQ,EAAE,EAArB,CAAqB;aACtC,CAAC,CAAC;QACL,CAAC,EAAE,OAAO,CAAC,CAAC;IACd,CAAC,CAAC,CAAC;IAEL,OAAO,oCAAoC,CAAC,IAAI,CAAC,IAAA,kBAAM,GAAE,CAAC,CAAC;AAC7D,CAAC,CAAC;AApGW,QAAA,yBAAyB,6BAoGpC;AAEK,IAAM,oCAAoC,GAAG,UAAC,KAAY;IAC/D,IACE,KAAK;QACL,4CAA4C;QAC5C,CAAC,KAAK,YAAY,mBAAY;YAC5B,KAAK,YAAY,2BAAkB;YACnC,KAAK,YAAY,uBAAc;YAC/B,KAAK,YAAY,6BAAoB,CAAC,EACxC;QACA,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAbW,QAAA,oCAAoC,wCAa/C"}

package/lib/hw/getOnboardingStatePolling.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=getOnboardingStatePolling.test.d.ts.map

package/lib/hw/getOnboardingStatePolling.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOnboardingStatePolling.test.d.ts","sourceRoot":"","sources":["../../src/hw/getOnboardingStatePolling.test.ts"],"names":[],"mappings":""}

package/lib/hw/getOnboardingStatePolling.test.js

@@ -0,0 +1,224 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var getOnboardingStatePolling_1 = require("./getOnboardingStatePolling");
+var rxjs_1 = require("rxjs");
+var rxjsOperators = __importStar(require("rxjs/operators"));
+var devices_1 = require("@ledgerhq/devices");
+var hw_transport_1 = __importDefault(require("@ledgerhq/hw-transport"));
+var errors_1 = require("@ledgerhq/errors");
+var deviceAccess_1 = require("./deviceAccess");
+var getVersion_1 = __importDefault(require("./getVersion"));
+var extractOnboardingState_1 = require("./extractOnboardingState");
+var manager_1 = require("../types/manager");
+jest.mock("./deviceAccess");
+jest.mock("./getVersion");
+jest.mock("./extractOnboardingState");
+jest.mock("@ledgerhq/hw-transport");
+jest.useFakeTimers();
+var aDevice = {
+    deviceId: "DEVICE_ID_A",
+    deviceName: "DEVICE_NAME_A",
+    modelId: devices_1.DeviceModelId.nanoFTS,
+    wired: false
+};
+// As extractOnboardingState is mocked, the firmwareInfo
+// returned by getVersion does not matter
+var aFirmwareInfo = {
+    isBootloader: false,
+    rawVersion: "",
+    targetId: 0,
+    mcuVersion: "",
+    flags: Buffer.from([])
+};
+var pollingPeriodMs = 1000;
+var mockedGetVersion = jest.mocked(getVersion_1["default"]);
+var mockedWithDevice = jest.mocked(deviceAccess_1.withDevice);
+mockedWithDevice.mockReturnValue(function (job) { return (0, rxjs_1.from)(job(new hw_transport_1["default"]())); });
+var mockedExtractOnboardingState = jest.mocked(extractOnboardingState_1.extractOnboardingState);
+describe("getOnboardingStatePolling", function () {
+    var anOnboardingState;
+    var onboardingStatePollingSubscription;
+    beforeEach(function () {
+        anOnboardingState = {
+            isOnboarded: false,
+            isInRecoveryMode: false,
+            seedPhraseType: manager_1.SeedPhraseType.TwentyFour,
+            currentSeedWordIndex: 0,
+            currentOnboardingStep: extractOnboardingState_1.OnboardingStep.NewDevice
+        };
+    });
+    afterEach(function () {
+        mockedGetVersion.mockClear();
+        mockedExtractOnboardingState.mockClear();
+        jest.clearAllTimers();
+        onboardingStatePollingSubscription === null || onboardingStatePollingSubscription === void 0 ? void 0 : onboardingStatePollingSubscription.unsubscribe();
+    });
+    describe("When a communication error occurs while fetching the device state", function () {
+        describe("and when the error is allowed and thrown before the defined timeout", function () {
+            it("should update the onboarding state to null and keep track of the allowed error", function (done) {
+                mockedGetVersion.mockRejectedValue(new errors_1.DisconnectedDevice("An allowed error"));
+                mockedExtractOnboardingState.mockReturnValue(anOnboardingState);
+                var device = aDevice;
+                (0, getOnboardingStatePolling_1.getOnboardingStatePolling)({
+                    deviceId: device.deviceId,
+                    pollingPeriodMs: pollingPeriodMs
+                }).subscribe({
+                    next: function (value) {
+                        expect(value.onboardingState).toBeNull();
+                        expect(value.allowedError).toBeInstanceOf(errors_1.DisconnectedDevice);
+                        done();
+                    }
+                });
+                // The timeout is equal to pollingPeriodMs by default
+                jest.advanceTimersByTime(pollingPeriodMs - 1);
+            });
+        });
+        describe("and when a timeout occurred before the error (or the fetch took too long)", function () {
+            it("should update the allowed error value to notify the consumer - default value for the timeout", function (done) {
+                mockedGetVersion.mockResolvedValue(aFirmwareInfo);
+                mockedExtractOnboardingState.mockReturnValue(anOnboardingState);
+                var device = aDevice;
+                (0, getOnboardingStatePolling_1.getOnboardingStatePolling)({
+                    deviceId: device.deviceId,
+                    pollingPeriodMs: pollingPeriodMs
+                }).subscribe({
+                    next: function (value) {
+                        expect(value.onboardingState).toBeNull();
+                        expect(value.allowedError).toBeInstanceOf(rxjs_1.TimeoutError);
+                        done();
+                    }
+                });
+                // Waits more than the timeout
+                jest.advanceTimersByTime(pollingPeriodMs + 1);
+            });
+            it("should update the allowed error value to notify the consumer - timeout value set by the consumer", function (done) {
+                var fetchingTimeoutMs = pollingPeriodMs + 500;
+                mockedGetVersion.mockResolvedValue(aFirmwareInfo);
+                mockedExtractOnboardingState.mockReturnValue(anOnboardingState);
+                var device = aDevice;
+                (0, getOnboardingStatePolling_1.getOnboardingStatePolling)({
+                    deviceId: device.deviceId,
+                    pollingPeriodMs: pollingPeriodMs,
+                    fetchingTimeoutMs: fetchingTimeoutMs
+                }).subscribe({
+                    next: function (value) {
+                        expect(value.onboardingState).toBeNull();
+                        expect(value.allowedError).toBeInstanceOf(rxjs_1.TimeoutError);
+                        done();
+                    }
+                });
+                // Waits more than the timeout
+                jest.advanceTimersByTime(fetchingTimeoutMs + 1);
+            });
+        });
+        describe("and when the error is fatal and thrown before the defined timeout", function () {
+            it("should notify the consumer that a unallowed error occurred", function (done) {
+                mockedGetVersion.mockRejectedValue(new Error("Unknown error"));
+                var device = aDevice;
+                (0, getOnboardingStatePolling_1.getOnboardingStatePolling)({
+                    deviceId: device.deviceId,
+                    pollingPeriodMs: pollingPeriodMs
+                }).subscribe({
+                    error: function (error) {
+                        expect(error).toBeInstanceOf(Error);
+                        expect(error === null || error === void 0 ? void 0 : error.message).toBe("Unknown error");
+                        done();
+                    }
+                });
+                jest.advanceTimersByTime(pollingPeriodMs - 1);
+            });
+        });
+    });
+    describe("When the fetched device state is incorrect", function () {
+        it("should return a null onboarding state, and keep track of the extract error", function (done) {
+            mockedGetVersion.mockResolvedValue(aFirmwareInfo);
+            mockedExtractOnboardingState.mockImplementation(function () {
+                throw new errors_1.DeviceExtractOnboardingStateError("Some incorrect device info");
+            });
+            var device = aDevice;
+            onboardingStatePollingSubscription = (0, getOnboardingStatePolling_1.getOnboardingStatePolling)({
+                deviceId: device.deviceId,
+                pollingPeriodMs: pollingPeriodMs
+            }).subscribe({
+                next: function (value) {
+                    expect(value.onboardingState).toBeNull();
+                    expect(value.allowedError).toBeInstanceOf(errors_1.DeviceExtractOnboardingStateError);
+                    done();
+                }
+            });
+            jest.advanceTimersByTime(pollingPeriodMs - 1);
+        });
+    });
+    describe("When polling returns a correct device state", function () {
+        it("should return a correct onboarding state", function (done) {
+            mockedGetVersion.mockResolvedValue(aFirmwareInfo);
+            mockedExtractOnboardingState.mockReturnValue(anOnboardingState);
+            var device = aDevice;
+            onboardingStatePollingSubscription = (0, getOnboardingStatePolling_1.getOnboardingStatePolling)({
+                deviceId: device.deviceId,
+                pollingPeriodMs: pollingPeriodMs
+            }).subscribe({
+                next: function (value) {
+                    expect(value.allowedError).toBeNull();
+                    expect(value.onboardingState).toEqual(anOnboardingState);
+                    done();
+                },
+                error: function (error) {
+                    done(error);
+                }
+            });
+            jest.advanceTimersByTime(pollingPeriodMs - 1);
+        });
+        it("should poll a new onboarding state after the defined period of time", function (done) {
+            mockedGetVersion.mockResolvedValue(aFirmwareInfo);
+            mockedExtractOnboardingState.mockReturnValue(anOnboardingState);
+            var device = aDevice;
+            // Did not manage to test that the polling is repeated by using jest's fake timer
+            // and advanceTimersByTime method or equivalent.
+            // Hacky test: spy on the repeat operator to see if it has been called.
+            var spiedRepeat = jest.spyOn(rxjsOperators, "repeat");
+            onboardingStatePollingSubscription = (0, getOnboardingStatePolling_1.getOnboardingStatePolling)({
+                deviceId: device.deviceId,
+                pollingPeriodMs: pollingPeriodMs
+            }).subscribe({
+                next: function (value) {
+                    expect(value.onboardingState).toEqual(anOnboardingState);
+                    expect(value.allowedError).toBeNull();
+                    expect(spiedRepeat).toHaveBeenCalledTimes(1);
+                    done();
+                },
+                error: function (error) {
+                    done(error);
+                }
+            });
+            jest.runOnlyPendingTimers();
+        });
+    });
+});
+//# sourceMappingURL=getOnboardingStatePolling.test.js.map

package/lib/hw/getOnboardingStatePolling.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOnboardingStatePolling.test.js","sourceRoot":"","sources":["../../src/hw/getOnboardingStatePolling.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yEAAwE;AACxE,6BAAwD;AACxD,4DAAgD;AAChD,6CAAkD;AAClD,wEAA+C;AAC/C,2CAG0B;AAC1B,+CAA4C;AAC5C,4DAAsC;AACtC,mEAIkC;AAClC,4CAAkD;AAElD,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;AAC5B,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAC1B,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;AACtC,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;AACpC,IAAI,CAAC,aAAa,EAAE,CAAC;AAErB,IAAM,OAAO,GAAG;IACd,QAAQ,EAAE,aAAa;IACvB,UAAU,EAAE,eAAe;IAC3B,OAAO,EAAE,uBAAa,CAAC,OAAO;IAC9B,KAAK,EAAE,KAAK;CACb,CAAC;AAEF,wDAAwD;AACxD,yCAAyC;AACzC,IAAM,aAAa,GAAG;IACpB,YAAY,EAAE,KAAK;IACnB,UAAU,EAAE,EAAE;IACd,QAAQ,EAAE,CAAC;IACX,UAAU,EAAE,EAAE;IACd,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;CACvB,CAAC;AAEF,IAAM,eAAe,GAAG,IAAI,CAAC;AAE7B,IAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,uBAAU,CAAC,CAAC;AAEjD,IAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,yBAAU,CAAC,CAAC;AACjD,gBAAgB,CAAC,eAAe,CAAC,UAAC,GAAG,IAAK,OAAA,IAAA,WAAI,EAAC,GAAG,CAAC,IAAI,yBAAS,EAAE,CAAC,CAAC,EAA1B,CAA0B,CAAC,CAAC;AAEtE,IAAM,4BAA4B,GAAG,IAAI,CAAC,MAAM,CAAC,+CAAsB,CAAC,CAAC;AAEzE,QAAQ,CAAC,2BAA2B,EAAE;IACpC,IAAI,iBAAkC,CAAC;IACvC,IAAI,kCAAuD,CAAC;IAE5D,UAAU,CAAC;QACT,iBAAiB,GAAG;YAClB,WAAW,EAAE,KAAK;YAClB,gBAAgB,EAAE,KAAK;YACvB,cAAc,EAAE,wBAAc,CAAC,UAAU;YACzC,oBAAoB,EAAE,CAAC;YACvB,qBAAqB,EAAE,uCAAc,CAAC,SAAS;SAChD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC;QACR,gBAAgB,CAAC,SAAS,EAAE,CAAC;QAC7B,4BAA4B,CAAC,SAAS,EAAE,CAAC;QACzC,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,kCAAkC,aAAlC,kCAAkC,uBAAlC,kCAAkC,CAAE,WAAW,EAAE,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mEAAmE,EAAE;QAC5E,QAAQ,CAAC,qEAAqE,EAAE;YAC9E,EAAE,CAAC,gFAAgF,EAAE,UAAC,IAAI;gBACxF,gBAAgB,CAAC,iBAAiB,CAChC,IAAI,2BAAkB,CAAC,kBAAkB,CAAC,CAC3C,CAAC;gBACF,4BAA4B,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;gBAEhE,IAAM,MAAM,GAAG,OAAO,CAAC;gBAEvB,IAAA,qDAAyB,EAAC;oBACxB,QAAQ,EAAE,MAAM,CAAC,QAAQ;oBACzB,eAAe,iBAAA;iBAChB,CAAC,CAAC,SAAS,CAAC;oBACX,IAAI,EAAE,UAAC,KAAK;wBACV,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC;wBACzC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,2BAAkB,CAAC,CAAC;wBAC9D,IAAI,EAAE,CAAC;oBACT,CAAC;iBACF,CAAC,CAAC;gBAEH,qDAAqD;gBACrD,IAAI,CAAC,mBAAmB,CAAC,eAAe,GAAG,CAAC,CAAC,CAAC;YAChD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,2EAA2E,EAAE;YACpF,EAAE,CAAC,8FAA8F,EAAE,UAAC,IAAI;gBACtG,gBAAgB,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;gBAClD,4BAA4B,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;gBAEhE,IAAM,MAAM,GAAG,OAAO,CAAC;gBAEvB,IAAA,qDAAyB,EAAC;oBACxB,QAAQ,EAAE,MAAM,CAAC,QAAQ;oBACzB,eAAe,iBAAA;iBAChB,CAAC,CAAC,SAAS,CAAC;oBACX,IAAI,EAAE,UAAC,KAAK;wBACV,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC;wBACzC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,mBAAY,CAAC,CAAC;wBACxD,IAAI,EAAE,CAAC;oBACT,CAAC;iBACF,CAAC,CAAC;gBAEH,8BAA8B;gBAC9B,IAAI,CAAC,mBAAmB,CAAC,eAAe,GAAG,CAAC,CAAC,CAAC;YAChD,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,kGAAkG,EAAE,UAAC,IAAI;gBAC1G,IAAM,iBAAiB,GAAG,eAAe,GAAG,GAAG,CAAC;gBAChD,gBAAgB,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;gBAClD,4BAA4B,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;gBAEhE,IAAM,MAAM,GAAG,OAAO,CAAC;gBAEvB,IAAA,qDAAyB,EAAC;oBACxB,QAAQ,EAAE,MAAM,CAAC,QAAQ;oBACzB,eAAe,iBAAA;oBACf,iBAAiB,mBAAA;iBAClB,CAAC,CAAC,SAAS,CAAC;oBACX,IAAI,EAAE,UAAC,KAAK;wBACV,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC;wBACzC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,mBAAY,CAAC,CAAC;wBACxD,IAAI,EAAE,CAAC;oBACT,CAAC;iBACF,CAAC,CAAC;gBAEH,8BAA8B;gBAC9B,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,GAAG,CAAC,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,mEAAmE,EAAE;YAC5E,EAAE,CAAC,4DAA4D,EAAE,UAAC,IAAI;gBACpE,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;gBAE/D,IAAM,MAAM,GAAG,OAAO,CAAC;gBAEvB,IAAA,qDAAyB,EAAC;oBACxB,QAAQ,EAAE,MAAM,CAAC,QAAQ;oBACzB,eAAe,iBAAA;iBAChB,CAAC,CAAC,SAAS,CAAC;oBACX,KAAK,EAAE,UAAC,KAAK;wBACX,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;wBACpC,MAAM,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;wBAC7C,IAAI,EAAE,CAAC;oBACT,CAAC;iBACF,CAAC,CAAC;gBAEH,IAAI,CAAC,mBAAmB,CAAC,eAAe,GAAG,CAAC,CAAC,CAAC;YAChD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,4CAA4C,EAAE;QACrD,EAAE,CAAC,4EAA4E,EAAE,UAAC,IAAI;YACpF,gBAAgB,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAClD,4BAA4B,CAAC,kBAAkB,CAAC;gBAC9C,MAAM,IAAI,0CAAiC,CACzC,4BAA4B,CAC7B,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,IAAM,MAAM,GAAG,OAAO,CAAC;YAEvB,kCAAkC,GAAG,IAAA,qDAAyB,EAAC;gBAC7D,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,eAAe,iBAAA;aAChB,CAAC,CAAC,SAAS,CAAC;gBACX,IAAI,EAAE,UAAC,KAAK;oBACV,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC;oBACzC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,cAAc,CACvC,0CAAiC,CAClC,CAAC;oBACF,IAAI,EAAE,CAAC;gBACT,CAAC;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,mBAAmB,CAAC,eAAe,GAAG,CAAC,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,6CAA6C,EAAE;QACtD,EAAE,CAAC,0CAA0C,EAAE,UAAC,IAAI;YAClD,gBAAgB,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAClD,4BAA4B,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;YAEhE,IAAM,MAAM,GAAG,OAAO,CAAC;YAEvB,kCAAkC,GAAG,IAAA,qDAAyB,EAAC;gBAC7D,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,eAAe,iBAAA;aAChB,CAAC,CAAC,SAAS,CAAC;gBACX,IAAI,EAAE,UAAC,KAAK;oBACV,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;oBACtC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;oBACzD,IAAI,EAAE,CAAC;gBACT,CAAC;gBACD,KAAK,EAAE,UAAC,KAAK;oBACX,IAAI,CAAC,KAAK,CAAC,CAAC;gBACd,CAAC;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,mBAAmB,CAAC,eAAe,GAAG,CAAC,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qEAAqE,EAAE,UAAC,IAAI;YAC7E,gBAAgB,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAClD,4BAA4B,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;YAEhE,IAAM,MAAM,GAAG,OAAO,CAAC;YAEvB,iFAAiF;YACjF,gDAAgD;YAChD,uEAAuE;YACvE,IAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YAExD,kCAAkC,GAAG,IAAA,qDAAyB,EAAC;gBAC7D,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,eAAe,iBAAA;aAChB,CAAC,CAAC,SAAS,CAAC;gBACX,IAAI,EAAE,UAAC,KAAK;oBACV,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;oBACzD,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;oBACtC,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;oBAC7C,IAAI,EAAE,CAAC;gBACT,CAAC;gBACD,KAAK,EAAE,UAAC,KAAK;oBACX,IAAI,CAAC,KAAK,CAAC,CAAC;gBACd,CAAC;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/onboarding/hooks/useOnboardingStatePolling.d.ts

@@ -0,0 +1,22 @@
+import type { Device } from "../../hw/actions/types";
+import type { OnboardingStatePollingResult } from "../../hw/getOnboardingStatePolling";
+export declare type UseOnboardingStatePollingResult = OnboardingStatePollingResult & {
+    fatalError: Error | null;
+};
+/**
+ * Polls the current device onboarding state, and notify the hook consumer of
+ * any allowed errors and fatal errors
+ * @param device A Device object
+ * @param pollingPeriodMs The period in ms after which the device onboarding state is fetched again
+ * @param stopPolling Flag to stop or continue the polling
+ * @returns An object containing:
+ * - onboardingState: the device state during the onboarding
+ * - allowedError: any error that is allowed and does not stop the polling
+ * - fatalError: any error that is fatal and stops the polling
+ */
+export declare const useOnboardingStatePolling: ({ device, pollingPeriodMs, stopPolling, }: {
+    device: Device | null;
+    pollingPeriodMs: number;
+    stopPolling?: boolean | undefined;
+}) => UseOnboardingStatePollingResult;
+//# sourceMappingURL=useOnboardingStatePolling.d.ts.map

package/lib/onboarding/hooks/useOnboardingStatePolling.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useOnboardingStatePolling.d.ts","sourceRoot":"","sources":["../../../src/onboarding/hooks/useOnboardingStatePolling.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAGrD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAIvF,oBAAY,+BAA+B,GAAG,4BAA4B,GAAG;IAC3E,UAAU,EAAE,KAAK,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,yBAAyB;YAK5B,MAAM,GAAG,IAAI;qBACJ,MAAM;;MAErB,+BAqDH,CAAC"}

package/lib/onboarding/hooks/useOnboardingStatePolling.js

@@ -0,0 +1,81 @@
+"use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+exports.__esModule = true;
+exports.useOnboardingStatePolling = void 0;
+var react_1 = require("react");
+var errors_1 = require("@ledgerhq/errors");
+var getOnboardingStatePolling_1 = require("../../hw/getOnboardingStatePolling");
+/**
+ * Polls the current device onboarding state, and notify the hook consumer of
+ * any allowed errors and fatal errors
+ * @param device A Device object
+ * @param pollingPeriodMs The period in ms after which the device onboarding state is fetched again
+ * @param stopPolling Flag to stop or continue the polling
+ * @returns An object containing:
+ * - onboardingState: the device state during the onboarding
+ * - allowedError: any error that is allowed and does not stop the polling
+ * - fatalError: any error that is fatal and stops the polling
+ */
+var useOnboardingStatePolling = function (_a) {
+    var device = _a.device, pollingPeriodMs = _a.pollingPeriodMs, _b = _a.stopPolling, stopPolling = _b === void 0 ? false : _b;
+    var _c = __read((0, react_1.useState)(null), 2), onboardingState = _c[0], setOnboardingState = _c[1];
+    var _d = __read((0, react_1.useState)(null), 2), allowedError = _d[0], setAllowedError = _d[1];
+    var _e = __read((0, react_1.useState)(null), 2), fatalError = _e[0], setFatalError = _e[1];
+    (0, react_1.useEffect)(function () {
+        var onboardingStatePollingSubscription;
+        // If stopPolling is updated and set to true, the useEffect hook will call its
+        // cleanup function (return) and the polling won't restart with the below condition
+        if (device && !stopPolling) {
+            onboardingStatePollingSubscription = (0, getOnboardingStatePolling_1.getOnboardingStatePolling)({
+                deviceId: device.deviceId,
+                pollingPeriodMs: pollingPeriodMs
+            }).subscribe({
+                next: function (onboardingStatePollingResult) {
+                    if (onboardingStatePollingResult) {
+                        setFatalError(null);
+                        setAllowedError(onboardingStatePollingResult.allowedError);
+                        // Does not update the onboarding state if an allowed error occurred
+                        if (!onboardingStatePollingResult.allowedError) {
+                            setOnboardingState(onboardingStatePollingResult.onboardingState);
+                        }
+                    }
+                },
+                error: function (error) {
+                    var _a;
+                    setAllowedError(null);
+                    setFatalError(error instanceof Error
+                        ? error
+                        : new errors_1.DeviceOnboardingStatePollingError("Error from: ".concat((_a = error === null || error === void 0 ? void 0 : error.name) !== null && _a !== void 0 ? _a : error, " ").concat(error === null || error === void 0 ? void 0 : error.message)));
+                }
+            });
+        }
+        return function () {
+            onboardingStatePollingSubscription === null || onboardingStatePollingSubscription === void 0 ? void 0 : onboardingStatePollingSubscription.unsubscribe();
+        };
+    }, [
+        device,
+        pollingPeriodMs,
+        setOnboardingState,
+        setAllowedError,
+        setFatalError,
+        stopPolling,
+    ]);
+    return { onboardingState: onboardingState, allowedError: allowedError, fatalError: fatalError };
+};
+exports.useOnboardingStatePolling = useOnboardingStatePolling;
+//# sourceMappingURL=useOnboardingStatePolling.js.map

package/lib/onboarding/hooks/useOnboardingStatePolling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useOnboardingStatePolling.js","sourceRoot":"","sources":["../../../src/onboarding/hooks/useOnboardingStatePolling.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAAA,+BAA4C;AAG5C,2CAAqE;AAGrE,gFAA+E;AAO/E;;;;;;;;;;GAUG;AACI,IAAM,yBAAyB,GAAG,UAAC,EAQzC;QAPC,MAAM,YAAA,EACN,eAAe,qBAAA,EACf,mBAAmB,EAAnB,WAAW,mBAAG,KAAK,KAAA;IAMb,IAAA,KAAA,OACJ,IAAA,gBAAQ,EAAyB,IAAI,CAAC,IAAA,EADjC,eAAe,QAAA,EAAE,kBAAkB,QACF,CAAC;IACnC,IAAA,KAAA,OAAkC,IAAA,gBAAQ,EAAe,IAAI,CAAC,IAAA,EAA7D,YAAY,QAAA,EAAE,eAAe,QAAgC,CAAC;IAC/D,IAAA,KAAA,OAA8B,IAAA,gBAAQ,EAAe,IAAI,CAAC,IAAA,EAAzD,UAAU,QAAA,EAAE,aAAa,QAAgC,CAAC;IAEjE,IAAA,iBAAS,EAAC;QACR,IAAI,kCAAgD,CAAC;QAErD,8EAA8E;QAC9E,mFAAmF;QACnF,IAAI,MAAM,IAAI,CAAC,WAAW,EAAE;YAC1B,kCAAkC,GAAG,IAAA,qDAAyB,EAAC;gBAC7D,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,eAAe,iBAAA;aAChB,CAAC,CAAC,SAAS,CAAC;gBACX,IAAI,EAAE,UAAC,4BAA0D;oBAC/D,IAAI,4BAA4B,EAAE;wBAChC,aAAa,CAAC,IAAI,CAAC,CAAC;wBACpB,eAAe,CAAC,4BAA4B,CAAC,YAAY,CAAC,CAAC;wBAE3D,oEAAoE;wBACpE,IAAI,CAAC,4BAA4B,CAAC,YAAY,EAAE;4BAC9C,kBAAkB,CAAC,4BAA4B,CAAC,eAAe,CAAC,CAAC;yBAClE;qBACF;gBACH,CAAC;gBACD,KAAK,EAAE,UAAC,KAAK;;oBACX,eAAe,CAAC,IAAI,CAAC,CAAC;oBACtB,aAAa,CACX,KAAK,YAAY,KAAK;wBACpB,CAAC,CAAC,KAAK;wBACP,CAAC,CAAC,IAAI,0CAAiC,CACnC,sBAAe,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,mCAAI,KAAK,cAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,CAAE,CACxD,CACN,CAAC;gBACJ,CAAC;aACF,CAAC,CAAC;SACJ;QAED,OAAO;YACL,kCAAkC,aAAlC,kCAAkC,uBAAlC,kCAAkC,CAAE,WAAW,EAAE,CAAC;QACpD,CAAC,CAAC;IACJ,CAAC,EAAE;QACD,MAAM;QACN,eAAe;QACf,kBAAkB;QAClB,eAAe;QACf,aAAa;QACb,WAAW;KACZ,CAAC,CAAC;IAEH,OAAO,EAAE,eAAe,iBAAA,EAAE,YAAY,cAAA,EAAE,UAAU,YAAA,EAAE,CAAC;AACvD,CAAC,CAAC;AA7DW,QAAA,yBAAyB,6BA6DpC"}

package/lib/onboarding/hooks/useOnboardingStatePolling.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useOnboardingStatePolling.test.d.ts.map

package/lib/onboarding/hooks/useOnboardingStatePolling.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useOnboardingStatePolling.test.d.ts","sourceRoot":"","sources":["../../../src/onboarding/hooks/useOnboardingStatePolling.test.ts"],"names":[],"mappings":""}