framework/js/src/admin/utils/ExtensionData.js

import ItemList from '../../common/utils/ItemList';

export default class ExtensionData {
  constructor() {
    this.data = {};
    this.currentExtension = null;
  }

  /**
   * This function simply takes the extension id
   *
   * @example
   * app.extensionData.load('flarum-tags')
   *
   * flarum/flags -> flarum-flags | acme/extension -> acme-extension
   *
   * @param extension
   */
  for(extension) {
    this.currentExtension = extension;
    this.data[extension] = this.data[extension] || {};

    return this;
  }

  /**
   * This function registers your settings with Flarum
   *
   * It takes either a settings object or a callback.
   *
   * @example
   *
   * .registerSetting({
   *   setting: 'flarum-flags.guidelines_url',
   *   type: 'text', // This will be inputted into the input tag for the setting (text/number/etc)
   *   label: app.translator.trans('flarum-flags.admin.settings.guidelines_url_label')
   * }, 15) // priority is optional (ItemList)
   *
   *
   * @param content
   * @param priority
   * @returns {ExtensionData}
   */
  registerSetting(content, priority = 0) {
    this.data[this.currentExtension].settings = this.data[this.currentExtension].settings || new ItemList();

    this.data[this.currentExtension].settings.add(content.setting, content, priority);

    return this;
  }

  /**
   * This function registers your permission with Flarum
   *
   * @example
   *
   * .registerPermission('permissions', {
   *     icon: 'fas fa-flag',
   *     label: app.translator.trans('flarum-flags.admin.permissions.view_flags_label'),
   *     permission: 'discussion.viewFlags'
   * }, 'moderate', 65)
   *
   * @param content
   * @param permissionType
   * @param priority
   * @returns {ExtensionData}
   */
  registerPermission(content, permissionType = null, priority = 0) {
    this.data[this.currentExtension].permissions = this.data[this.currentExtension].permissions || {};

    if (!this.data[this.currentExtension].permissions[permissionType]) {
      this.data[this.currentExtension].permissions[permissionType] = new ItemList();
    }

    this.data[this.currentExtension].permissions[permissionType].add(content.permission, content, priority);

    return this;
  }

  /**
   * Replace the default extension page with a custom component.
   * This component would typically extend ExtensionPage
   *
   * @param component
   * @returns {ExtensionData}
   */
  registerPage(component) {
    this.data[this.currentExtension].page = component;

    return this;
  }

  /**
   * Get an extension's registered settings
   *
   * @param extensionId
   * @returns {boolean|*}
   */
  getSettings(extensionId) {
    if (this.data[extensionId] && this.data[extensionId].settings) {
      return this.data[extensionId].settings.toArray();
    }

    return false;
  }

  /**
   *
   * Get an ItemList of all extensions' registered permissions
   *
   * @param extension
   * @param type
   * @returns {ItemList}
   */
  getAllExtensionPermissions(type) {
    const items = new ItemList();

    Object.keys(this.data).map((extension) => {
      if (this.extensionHasPermissions(extension) && this.data[extension].permissions[type]) {
        items.merge(this.data[extension].permissions[type]);
      }
    });

    return items;
  }

  /**
   * Get a singular extension's registered permissions
   *
   * @param extension
   * @param type
   * @returns {boolean|*}
   */
  getExtensionPermissions(extension, type) {
    if (this.extensionHasPermissions(extension) && this.data[extension].permissions[type]) {
      return this.data[extension].permissions[type];
    }

    return new ItemList();
  }

  /**
   * Checks whether a given extension has registered permissions.
   *
   * @param extension
   * @returns {boolean}
   */
  extensionHasPermissions(extension) {
    if (this.data[extension] && this.data[extension].permissions) {
      return true;
    }

    return false;
  }

  /**
   * Returns an extension's custom page component if it exists.
   *
   * @param extension
   * @returns {boolean|*}
   */
  getPage(extension) {
    if (this.data[extension]) {
      return this.data[extension].page;
    }

    return false;
  }
}