passbolt-styleguide/src/shared/services/serviceWorker/metadata/metadataSettingsServiceWorkerService.js

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

/**
 * Passbolt ~ Open source password manager for teams
 * Copyright (c) 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) Passbolt SA (https://www.passbolt.com)
 * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
 * @link          https://www.passbolt.com Passbolt(tm)
 * @since         4.11.0
 */
import MetadataTypesSettingsEntity from "../../../models/entity/metadata/metadataTypesSettingsEntity";
import MetadataKeysSettingsEntity from "../../../models/entity/metadata/metadataKeysSettingsEntity";

export const METADATA_FIND_KEYS_SETTINGS_EVENT = "passbolt.metadata.find-metadata-keys-settings";
export const METADATA_FIND_TYPES_SETTINGS_EVENT = "passbolt.metadata.find-metadata-types-settings";
export const METADATA_SAVE_KEYS_SETTINGS_EVENT = "passbolt.metadata.save-metadata-keys-settings";
export const METADATA_SAVE_TYPES_SETTINGS_EVENT = "passbolt.metadata.save-metadata-types-settings";

class MetadataSettingsServiceWorkerService {
  /**
   * Constructor
   * @param {port} port The browser extension background page / service worker port.
   */
  constructor(port) {
    this.port = port;
  }

  /**
   * Find the metadata keys settings.
   * @returns {Promise<MetadataKeysSettingsEntity>}
   */
  async findKeysSettings() {
    const settingsDto = await this.port.request(METADATA_FIND_KEYS_SETTINGS_EVENT);
    return new MetadataKeysSettingsEntity(settingsDto);
  }

  /**
   * Find the metadata types settings.
   * @returns {Promise<MetadataTypesSettingsEntity>}
   */
  async findTypesSettings() {
    const settingsDto = await this.port.request(METADATA_FIND_TYPES_SETTINGS_EVENT);
    return new MetadataTypesSettingsEntity(settingsDto);
  }

  /**
   * Save the metadata types settings.
   * @param {MetadataTypesSettingsEntity} formSettings The metadata types settings to save.
   * @return {Promise<MetadataTypesSettingsEntity>}
   * @throws {TypeError} If the settings property is not of type MetadataTypesSettingsEntity.
   * @throws {EntityValidationError} If the data returned by the browser extension is not a valid MetadataTypesSettings entity.
   */
  async saveTypesSettings(formSettings) {
    if (!(formSettings instanceof MetadataTypesSettingsEntity)) {
      throw new TypeError("The 'settings' property should be of type 'MetadataTypesSettingsEntity'.");
    }
    const savedSettingsDto = await this.port.request(METADATA_SAVE_TYPES_SETTINGS_EVENT, formSettings.toDto());
    return new MetadataTypesSettingsEntity(savedSettingsDto);
  }

  /**
   * Save the metadata keys settings.
   * @param {MetadataKeysSettingsEntity} settings The metadata keys settings to save.
   * @return {Promise<MetadataKeysSettingsEntity>}
   * @throws {TypeError} If the settings property is not of type MetadataKeysSettingsEntity.
   * @throws {EntityValidationError} If the saved metadata keys settings does not validate.
   */
  async saveKeysSettings(settings) {
    if (!(settings instanceof MetadataKeysSettingsEntity)) {
      throw new TypeError("The 'settings' property should be of type 'MetadataKeysSettingsEntity'.");
    }
    const savedSettingsDto = await this.port.request(METADATA_SAVE_KEYS_SETTINGS_EVENT, settings.toDto());
    return new MetadataKeysSettingsEntity(savedSettingsDto);
  }
}

export default MetadataSettingsServiceWorkerService;