motion-master-client 0.0.322 → 0.0.324

package/src/lib/motion-master-req-res-client.js

@@ -2973,7 +2973,7 @@ class MotionMasterReqResClient {
      * @param commandTimeout - The timeout in milliseconds for the command to complete.
      * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
-     * @returns An observable that emits a boolean value indicating whether the login attempt succeeded.
+     * @throws {Error} If the login attempt fails.
      *
      * @remarks
      * If the device is already logged in, the next login attempt will fail unless the user logs out first.
@@ -2981,7 +2981,11 @@ class MotionMasterReqResClient {
     loginToSmmForParameterDownload(deviceRef, username, password, commandTimeout = 5000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.PARAMETER_DOWNLOAD_LOGIN);
         const content = (0, smm_1.packSmmCredentials)(username, password);
-        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => {
+            if (response.request !== 'succeeded') {
+                throw new Error('Login to SMM for parameter download failed.');
+            }
+        }));
     }
     /**
      * Logs into the SMM for software update with the provided credentials.
@@ -2996,7 +3000,7 @@ class MotionMasterReqResClient {
      * @param commandTimeout - The timeout in milliseconds for the command to complete.
      * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
-     * @returns An observable that emits a boolean value indicating whether the login attempt succeeded.
+     * @throws {Error} If the login attempt fails.
      *
      * @remarks
      * If the device is already logged in, the next login attempt will fail unless the user logs out first.
@@ -3004,7 +3008,11 @@ class MotionMasterReqResClient {
     loginToSmmForSoftwareUpdate(deviceRef, username, password, commandTimeout = 10000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.SOFTWARE_UPDATE_LOGIN);
         const content = (0, smm_1.packSmmCredentials)(username, password);
-        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => {
+            if (response.request !== 'succeeded') {
+                throw new Error('Login to SMM for software update failed.');
+            }
+        }));
     }
     /**
      * Logs out from the SMM.
@@ -3016,11 +3024,15 @@ class MotionMasterReqResClient {
      * @param commandTimeout - The timeout in milliseconds for the command to complete.
      * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
-     * @returns An observable that emits a boolean value indicating whether the logout attempt succeeded.
+     * @throws {Error} If the logout attempt fails.
      */
     logoutFromSmm(deviceRef, commandTimeout = 10000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.LOGOUT);
-        return this.runOsCommand(deviceRef, command, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+        return this.runOsCommand(deviceRef, command, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => {
+            if (response.request !== 'succeeded') {
+                throw new Error('Logout from SMM failed.');
+            }
+        }));
     }
     /**
      * Logs out from the SMM and then logs back in with the provided credentials for parameter download.
@@ -3035,12 +3047,10 @@ class MotionMasterReqResClient {
      * @param commandTimeout - The timeout in milliseconds for the command to complete.
      * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
-     * @returns An observable that emits a boolean value indicating whether the relogin attempt succeeded.
+     * @throws {Error} If either the logout or login attempt fails.
      */
     reloginToSmmForParameterDownload(deviceRef, username, password, commandTimeout = 10000, responsePollingInterval = 500) {
-        return this.logoutFromSmm(deviceRef, commandTimeout, responsePollingInterval).pipe((0, operators_1.mergeMap)((succeeded) => succeeded
-            ? this.loginToSmmForParameterDownload(deviceRef, username, password, commandTimeout, responsePollingInterval)
-            : (0, rxjs_1.of)(false)));
+        return this.logoutFromSmm(deviceRef, commandTimeout, responsePollingInterval).pipe((0, operators_1.mergeMap)(() => this.loginToSmmForParameterDownload(deviceRef, username, password, commandTimeout, responsePollingInterval)));
     }
     /**
      * Changes the SMM password for the specified device.
@@ -3050,7 +3060,8 @@ class MotionMasterReqResClient {
      * @param newPassword - The new password to set for the SMM.
      * @param commandTimeout - The timeout in milliseconds for the command to complete.
      * @param responsePollingInterval - The interval in milliseconds between polling for the response.
-     * @returns An Observable that emits `true` if the password change and SMM restart succeed, otherwise `false`.
+     *
+     * @throws {Error} If the password change attempt fails.
      *
      * @remarks
      * A prior successful login is required before changing the password.
@@ -3061,7 +3072,7 @@ class MotionMasterReqResClient {
     changeSmmPassword(deviceRef, oldPassword, newPassword, commandTimeout = 10000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.CHANGE_PASSWORD);
         const content = (0, smm_1.packSmmChangePassword)(newPassword, oldPassword);
-        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'), (0, operators_1.mergeMap)((succeeded) => (succeeded ? this.triggerSmmRestart(deviceRef) : (0, rxjs_1.of)(false))));
+        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.mergeMap)(() => this.triggerSmmRestart(deviceRef)));
     }
     /**
      * Triggers an SMM restart for the specified device.
@@ -3076,11 +3087,15 @@ class MotionMasterReqResClient {
      * @param commandTimeout - The timeout in milliseconds for the command to complete.
      * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
-     * @returns An Observable that emits `true` if the restart was successful, or `false` otherwise.
+     * @throws {Error} If the SMM restart attempt fails.
      */
     triggerSmmRestart(deviceRef, commandTimeout = 40000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.TRIGGER_RESTART);
-        return this.runOsCommand(deviceRef, command, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+        return this.runOsCommand(deviceRef, command, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => {
+            if (response.request !== 'succeeded') {
+                throw new Error('Triggering SMM restart failed.');
+            }
+        }));
     }
     /**
      * Acknowledges an I/O failure on the specified device.
@@ -3092,11 +3107,15 @@ class MotionMasterReqResClient {
      * @param commandTimeout - The timeout in milliseconds for the command to complete.
      * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
-     * @returns An Observable that emits `true` if the acknowledgment was successful, or `false` otherwise.
+     * @throws {Error} If the acknowledgment attempt fails.
      */
     acknowledgeIoFailureOnSmm(deviceRef, commandTimeout = 10000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.IO_FAILURE_ACKNOWLEDGE);
-        return this.runOsCommand(deviceRef, command, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+        return this.runOsCommand(deviceRef, command, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => {
+            if (response.request !== 'succeeded') {
+                throw new Error('Acknowledging I/O failure on SMM failed.');
+            }
+        }));
     }
     /**
      * Configures the SMM software update process for the specified device.
@@ -3105,11 +3124,15 @@ class MotionMasterReqResClient {
      * @param deviceRef - A reference to the target device.
      * @param fileSize - The size of the software update file, in bytes.
      *
-     * @returns An Observable that emits `true` if the configuration succeeds, or `false` if it fails.
+     * @throws {Error} If the configuration attempt fails.
      */
     configureSmmSoftwareUpdate(deviceRef, fileSize) {
         const command = (0, os_command_1.createSmmAcyclicHandlerConfigureSoftwareUpdateOsCommand)(fileSize);
-        return this.runOsCommand(deviceRef, command, 10000, 100).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+        return this.runOsCommand(deviceRef, command, 10000, 100).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => {
+            if (response.request !== 'succeeded') {
+                throw new Error('Configuring SMM software update failed.');
+            }
+        }));
     }
     /**
      * Performs a complete SMM software update on the specified device.
@@ -3126,8 +3149,7 @@ class MotionMasterReqResClient {
      * @param responsePollingInterval - (Optional) Polling interval for command responses. Defaults to 1000 ms.
      * @param fsBufferReadWriteTimeout - (Optional) Timeout for fs-buffer read/write operations. Defaults to 120,000 ms.
      *
-     * @returns An `Observable<boolean>` that emits the result of the final step.
-     * The observable completes successfully if all steps succeed, or errors out at the first failure.
+     * @throws {Error} If any step in the software update process fails.
      *
      * @remarks
      * The software update procedure follows these sequential steps:
@@ -3139,8 +3161,8 @@ class MotionMasterReqResClient {
      * 6. Finalize the software update.
      * 7. Trigger a device restart to apply the update.
      *
-     * Each step is implemented as a deferred observable. The commands execute only when subscribed to,
-     * ensuring a strict sequence. If any step fails, the process terminates immediately via `concat` behavior.
+     * Each step is implemented as a deferred observable.
+     * The commands execute only when subscribed to, ensuring a strict sequence.
      */
     updateSmmSoftware(deviceRef, username, password, buffer, crc, chunkSize = 1000, commandTimeout = 30000, responsePollingInterval = 1000, fsBufferReadWriteTimeout = 120000) {
         const fileSize = buffer.byteLength;
@@ -3161,14 +3183,22 @@ class MotionMasterReqResClient {
             const end = start + chunkSize;
             const fsBufferContent = buffer.slice(start, end);
             observables.push((0, rxjs_1.defer)(() => this.runOsCommandAndWriteFsBuffer(deviceRef, transmitSoftwareCommand, fsBufferContent, commandTimeout, responsePollingInterval, false, fsBufferReadWriteTimeout).pipe((0, operators_1.last)(), // Only consider the final response of the command.
-            (0, operators_1.map)((response) => response.request === 'succeeded') // Interpret the response success.
+            (0, operators_1.map)((response) => {
+                if (response.request !== 'succeeded') {
+                    throw new Error(`Transmitting SMM software chunk ${i + 1}/${n} failed.`);
+                }
+            }) // Interpret the response success.
             )));
         }
         // Step 5: Pack the CRC value and prepare the finalize command.
         const packedCrc = (0, smm_1.packSmmSoftwareUpdateCrc)(crc);
         const finalizeSoftwareUpdateCommand = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.FINALIZE_SOFTWARE_UPDATE);
         // Step 6: Send the CRC to validate data integrity.
-        observables.push((0, rxjs_1.defer)(() => this.runOsCommandAndWriteFsBuffer(deviceRef, finalizeSoftwareUpdateCommand, packedCrc).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'))), 
+        observables.push((0, rxjs_1.defer)(() => this.runOsCommandAndWriteFsBuffer(deviceRef, finalizeSoftwareUpdateCommand, packedCrc).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => {
+            if (response.request !== 'succeeded') {
+                throw new Error('Finalizing SMM software update failed.');
+            }
+        }))), 
         // Step 7: Trigger a restart so the new software takes effect.
         (0, rxjs_1.defer)(() => this.triggerSmmRestart(deviceRef)));
         return (0, rxjs_1.concat)(...observables).pipe((0, operators_1.last)());
@@ -3183,20 +3213,24 @@ class MotionMasterReqResClient {
      * @param commandTimeout - The timeout in milliseconds for the command to complete.
      * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
-     * @returns An Observable that emits `true` if the operation succeeds, or `false` if it fails, the `values` array is empty.
+     * @throws {Error} If the transmission fails or if the `values` array is empty.
      *
      * @remarks
-     * - If the `values` array is empty, the function immediately returns `false`.
+     * - If the `values` array is empty, the function throws an error.
      * - The function constructs an OS command for transmitting the parameters and writes the packed buffer to the fs-buffer file.
      */
     transmitSmmParameters(deviceRef, values, parameterStructureVersion = undefined, commandTimeout = 5000, responsePollingInterval = 500) {
         if (values.length === 0) {
-            return (0, rxjs_1.of)(false);
+            throw new Error('Transmitting SMM parameters failed. The values array is empty.');
         }
         return (parameterStructureVersion ? (0, rxjs_1.of)(parameterStructureVersion) : this.resolveSmmParameterStructureVersion(deviceRef)).pipe((0, operators_1.mergeMap)((version) => {
             const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.TRANSMIT_PARAMETERS);
             const { buffer: content } = (0, smm_1.packSmmParameterValues)(values, version);
-            return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+            return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => {
+                if (response.request !== 'succeeded') {
+                    throw new Error('Transmitting SMM parameters failed.');
+                }
+            }));
         }));
     }
     /**
@@ -3244,7 +3278,8 @@ class MotionMasterReqResClient {
      * If not provided, the version is resolved dynamically from the device.
      * @param commandTimeout - The timeout in milliseconds for the command to complete.
      * @param responsePollingInterval - The interval in milliseconds between polling for the response.
-     * @returns An `Observable<boolean>` that emits `true` if the verification succeeded, or `false` otherwise.
+     *
+     * @throws {Error} If the verification fails.
      *
      * @remarks
      * This function requires parameters to be previously loaded for verification to succeed. If parameters are not preloaded, the verification will fail.
@@ -3254,7 +3289,11 @@ class MotionMasterReqResClient {
         return (parameterStructureVersion ? (0, rxjs_1.of)(parameterStructureVersion) : this.resolveSmmParameterStructureVersion(deviceRef)).pipe((0, operators_1.mergeMap)((version) => {
             const { buffer: content } = (0, smm_1.packSmmParameterValuesForVerification)(values, groupIndex, version);
             const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.VERIFY_PARAMETERS);
-            return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+            return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => {
+                if (response.request !== 'succeeded') {
+                    throw new Error('Verifying SMM parameters failed.');
+                }
+            }));
         }));
     }
     /**
@@ -3304,7 +3343,7 @@ class MotionMasterReqResClient {
      * @param commandTimeout - The timeout in milliseconds for the command to complete.
      * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
-     * @returns An Observable that emits `true` if the configuration validation succeeds, or `false` if it fails.
+     * @throws An error if the validation fails.
      *
      * @remarks
      * - Packs the validation report, date, username, and password into a buffer.
@@ -3315,7 +3354,11 @@ class MotionMasterReqResClient {
     validateSmmConfiguration(deviceRef, report, date, username, password, commandTimeout = 5000, responsePollingInterval = 500) {
         const { buffer: content } = (0, smm_1.packSmmValidationReport)(report, date, username, password);
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.VALIDATE_CONFIGURATION);
-        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => {
+            if (response.request !== 'succeeded') {
+                throw new Error('Validating SMM configuration failed.');
+            }
+        }));
     }
     /**
      * Reads the safety parameters report from the device and validates the SMM configuration.
@@ -3327,9 +3370,7 @@ class MotionMasterReqResClient {
      * @param commandTimeout - The timeout in milliseconds for the command to complete.
      * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
-     * @returns An Observable that emits `true` if the SMM configuration is successfully validated, or `false` if validation fails.
-     *
-     * @throws An error if the `.safety_parameters_report` file is missing.
+     * @throws An error if the safety parameters report file is missing or if the validation fails.
      *
      * @remarks
      * - The function attempts to retrieve the `.safety_parameters_report` file from the device.
@@ -3503,7 +3544,7 @@ class MotionMasterReqResClient {
      * @param parameterStructureVersion - (Optional) A specific SMM parameter structure version to use.
      * If not provided, the version is resolved dynamically from the device.
      *
-     * @returns An Observable that emits `true` if the reset succeeds, or `false` if it fails.
+     * @throws {Error} If the factory reset operation fails.
      *
      * @remarks
      * This function first determines the SMM parameter structure version — either from the provided argument
@@ -3790,15 +3831,9 @@ class MotionMasterReqResClient {
                 return fail(`Mismatch: the configuration file contains ${configFile.parameters.length} parameters, but the SMM parameter structure expects ${values.length - 1}.`);
             }
             // Log out from SMM if already logged in, then log in for parameter download.
-            return this.logoutFromSmm(deviceRef).pipe((0, operators_1.concatMap)(() => this.loginToSmmForParameterDownload(deviceRef, username, password)), (0, operators_1.concatMap)((loginSuccess) => {
-                if (!loginSuccess) {
-                    return fail('Failed to log in for parameter download.');
-                }
+            return this.logoutFromSmm(deviceRef).pipe((0, operators_1.concatMap)(() => this.loginToSmmForParameterDownload(deviceRef, username, password)), (0, operators_1.concatMap)(() => {
                 // Transmit the SMM parameters, then verify them by loading and checking against the original values.
-                return this.transmitSmmParameters(deviceRef, values, parameterStructureVersion).pipe((0, operators_1.concatMap)((transmitSuccess) => {
-                    if (!transmitSuccess) {
-                        return fail('Failed to transmit SMM parameters.');
-                    }
+                return this.transmitSmmParameters(deviceRef, values, parameterStructureVersion).pipe((0, operators_1.concatMap)(() => {
                     // Load the SMM parameters for verification.
                     return this.loadSmmParametersForVerification(deviceRef).pipe((0, operators_1.concatMap)((status) => {
                         if (status.request === 'failed') {
@@ -3817,22 +3852,14 @@ class MotionMasterReqResClient {
                         // For each group entry, call verifySmmParameters and fail if any group fails verification.
                         // Uses concatMap to ensure groups are verified one after another in order.
                         return (0, rxjs_1.from)(groupEntries).pipe((0, operators_1.concatMap)(([_, groupValues], i) => this.verifySmmParameters(deviceRef, groupValues, i + 1, // Skipping the first group (None).
-                        parameterStructureVersion).pipe((0, operators_1.concatMap)((verifySuccess) => {
-                            if (!verifySuccess) {
-                                return fail(`Verification failed for parameter group ${i + 1}.`);
-                            }
-                            return (0, rxjs_1.of)(true);
-                        }))), (0, operators_1.toArray)(), // Collect all verification results.
+                        parameterStructureVersion).pipe((0, operators_1.concatMap)(() => (0, rxjs_1.of)(true)))), (0, operators_1.toArray)(), // Collect all verification results.
                         (0, operators_1.concatMap)(() => this.loadSmmValidationFileAndReadSafetyParametersReportFile(deviceRef).pipe((0, operators_1.concatMap)((safetyParametersReport) => {
                             if (!safetyParametersReport) {
                                 return fail('Failed to load the safety parameter validation file or read the safety parameter report.');
                             }
                             // Encode validation file content as Uint8Array for transmission.
                             const report = new TextEncoder().encode(safetyParametersReport);
-                            return this.validateSmmConfiguration(deviceRef, report, new Date(), username, password).pipe((0, operators_1.concatMap)((validateSuccess) => {
-                                if (!validateSuccess) {
-                                    return fail('SMM configuration validation failed.');
-                                }
+                            return this.validateSmmConfiguration(deviceRef, report, new Date(), username, password).pipe((0, operators_1.concatMap)(() => {
                                 // Re-read the SMM parameters to update the values stored on the Motion Master.
                                 return this.getSmmOdParameters(deviceRef, parameterStructureVersion, 'device', false).pipe((0, operators_1.map)(() => safetyParametersReport));
                             }));