passbolt-styleguide/src/react-extension/components/Common/Progress/HandleProgressEvents/HandleProgressEvents.js

Passbolt styleguide contains common styling assets used by the different sites, plugin, etc.

/**
 * Passbolt ~ Open source password manager for teams
 * Copyright (c) 2020 Passbolt SA (https://www.passbolt.com)
 *
 * Licensed under GNU Affero General Public License version 3 of the or any later version.
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) 2020 Passbolt SA (https://www.passbolt.com)
 * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
 * @link          https://www.passbolt.com Passbolt(tm)
 * @since         2.12.0
 */

import React from 'react';
import DisplayProgress from "../DisplayProgress/DisplayProgress";
import {withAppContext} from "../../../../contexts/AppContext";
import {withDialog} from "../../../../contexts/DialogContext";
import PropTypes from "prop-types";

/**
 * This component listens any event related to progress dialog actions to perform
 */
class HandleProgressEvents extends React.Component {
  /**
   * Default constructor
   */
  constructor(props) {
    super(props);
    this.state = this.defaultState;
    this.bindCallbacks();
  }

  /**
   * Returns the default component state
   */
  get defaultState() {
    return {
      dialogIndex: null // The index of the opened dialog
    };
  }

  /**
   * Bind callbacks methods
   */
  bindCallbacks() {
    this.handleProgressDialogOpenEvent = this.handleProgressDialogOpenEvent.bind(this);
    this.handleProgressDialogUpdateEvent = this.handleProgressDialogUpdateEvent.bind(this);
    this.handleProgressDialogUpdateGoalsEvent = this.handleProgressDialogUpdateGoalsEvent.bind(this);
    this.handleProgressDialogCloseEvent = this.handleProgressDialogCloseEvent.bind(this);
  }

  /**
   * Whenever the component is mounted
   */
  componentDidMount() {
    this.listen();
  }

  /**
   * Listen the progress dialog event from the context and acts accordingly
   */
  listen() {
    this.props.context.port.on('passbolt.progress.open-progress-dialog', this.handleProgressDialogOpenEvent);
    this.props.context.port.on("passbolt.progress.update", this.handleProgressDialogUpdateEvent);
    this.props.context.port.on("passbolt.progress.update-goals", this.handleProgressDialogUpdateGoalsEvent);
    this.props.context.port.on('passbolt.progress.close-progress-dialog', this.handleProgressDialogCloseEvent);
  }

  /**
   * Handle the dialog opening
   * @param title Dialog title
   * @param goals Dialog goals
   * @param message Dialog message
   */
  handleProgressDialogOpenEvent(title, goals, message) {
    const progressDialogProps = {title, goals, message};
    this.props.context.setContext({progressDialogProps});
    const dialogIndex = this.props.dialogContext.open(DisplayProgress);
    this.setState({dialogIndex});
  }

  /**
   * Handle the dialog update
   * @param message The message to display
   * @param completed The progress completion
   */
  handleProgressDialogUpdateEvent(message, completed) {
    const progressDialogProps = Object.assign(
      {},
      this.props.context.progressDialogProps,
      {
        message: message || this.props.context.progressDialogProps.message,
        completed
      });
    this.props.context.setContext({progressDialogProps});
  }

  /**
   *  Handle the dialog goals update
   * @param goals The progress goals
   */
  handleProgressDialogUpdateGoalsEvent(goals) {
    const progressDialogProps = Object.assign(
      {},
      this.props.context.progressDialogProps,
      {goals});
    this.props.context.setContext({progressDialogProps});
  }

  /**
   * Handle the dialog close
   */
  handleProgressDialogCloseEvent() {
    this.props.dialogContext.close(this.state.dialogIndex);
    this.props.context.setContext({progressDialogProps: {}});
  }

  /**
   * Renders the component
   * @returns {JSX.Element}
   */
  render() {
    return <></>;
  }
}

HandleProgressEvents.propTypes = {
  context: PropTypes.any, // The application context
  dialogContext: PropTypes.any, // the dialog context
};

export default withAppContext(withDialog(HandleProgressEvents));