BetterDiscordApp-v2/client/src/structs/settings/types/array.js

/**
 * BetterDiscord Array Setting Struct
 * Copyright (c) 2015-present Jiiks/JsSucks - https://github.com/Jiiks / https://github.com/JsSucks
 * All rights reserved.
 * https://betterdiscord.net
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

import { ThemeManager } from 'modules';
import { Utils } from 'common';
import Setting from './basesetting';
import SettingsSet from '../settingsset';
import SettingsCategory from '../settingscategory';
import SettingsScheme from '../settingsscheme';

export default class ArraySetting extends Setting {

    constructor(args, ...merge) {
        super(args, ...merge);

        this.args.settings = this.settings.map(category => new SettingsCategory(category));
        this.args.schemes = this.schemes.map(scheme => new SettingsScheme(scheme));
        this.args.items = this.value ? this.value.map(item => this.createItem(item.args || item)) : [];

        this.updateValue(false, false);
    }

    /**
     * The value to use when the setting doesn't have a value.
     */
    get defaultValue() {
        return [];
    }

    /**
     * An array of sets currently in this array setting.
     */
    get items() {
        return this.args.items || [];
    }

    set items(items) {
        this.args.items = items ? items.map(item => this.createItem(item)) : [];
        this.updateValue();
    }

    /**
     * Whether the setting should take the full width of the settings panel.
     * This is always false for array settings.
     */
    get fullwidth() {
        return false;
    }

    /**
     * An array of SettingsCategory objects that each set in this setting should have.
     */
    get categories() {
        return this.args.categories || this.args.settings || [];
    }

    get settings() {
        return this.categories;
    }

    /**
     * An array of SettingsScheme objects that can be used in this array's sets.
     */
    get schemes() {
        return this.args.schemes || [];
    }

    /**
     * Whether to display this array setting's sets inline instead of opening them in a modal.
     */
    get inline() {
        return this.args.inline || false;
    }

    /**
     * Whether to allow opening this array setting's sets in a modal.
     * This is always true when inline is false.
     */
    get allow_external() {
        return this.args.allow_external || !this.inline;
    }

    /**
     * The minimum amount of sets the user may create.
     * This only restricts deleting sets when there is less or equal sets than this, and does not ensure that this number of items actually exists.
     */
    get min() {
        return this.args.min || 0;
    }

    /**
     * The maximum amount of sets the user may create.
     */
    get max() {
        return this.args.max || null;
    }

    /**
     * Adds a new set to this array setting.
     * This ignores the maximum value.
     * @param {SettingsSet} item Values to merge into the new set (optional)
     * @return {SettingsSet} The new set
     */
    addItem(item) {
        const newItem = this.createItem(item);
        this.args.items.push(newItem);
        this.updateValue();
        return newItem;
    }

    /**
     * Removes a set from this array setting.
     * This ignores the minimum value.
     * @param {SettingsSet} item The set to remove
     */
    removeItem(item) {
        this.args.items = this.items.filter(i => i !== item);
        this.updateValue();
    }

    /**
     * Creates a new set for this array setting.
     * @param {SettingsSet} item Values to merge into the new set (optional)
     * @return {SettingsSet} The new set
     */
    createItem(item) {
        const set = new SettingsSet({
            settings: Utils.deepclone(this.settings),
            schemes: this.schemes
        }, item ? item.args || item : undefined);

        // if (item) set.merge(item.args || item);
        set.setSaved();
        set.on('settings-updated', () => this.updateValue());
        return set;
    }

    /**
     * Sets the value of this setting.
     * This is only intended for use by settings.
     * @param {SettingsSetting} value The new value of this setting
     * @param {Boolean} emit_multi Whether to emit a SettingsUpdatedEvent
     * @param {Boolean} emit Whether to emit a SettingUpdatedEvent
     * @return {Promise}
     */
    setValue(value, emit_multi = true, emit = true) {
        this.args.items = value ? value.map(item => this.createItem(item)) : [];
        this.updateValue(emit_multi, emit);
    }

    /**
     * Updates the value of this array setting.
     * This only exists for use by array settings.
     * @param {Boolean} emit_multi Whether to emit a SettingsUpdatedEvent
     * @param {Boolean} emit Whether to emit a SettingUpdatedEvent
     * @return {Promise}
     */
    updateValue(emit_multi = true, emit = true) {
        return this.__proto__.__proto__.setValue.call(this, this.items.map(item => {
            if (!item) return;
            item.setSaved();
            return item.strip();
        }), emit_multi, emit);
    }

    /**
     * Sets the path of the plugin/theme this setting is part of.
     * This is passed to this array setting's settings.
     * @param {String} contentPath The plugin/theme's directory path
     */
    setContentPath(contentPath) {
        this.args.path = contentPath;

        for (let category of this.categories) {
            for (let setting of category.settings) {
                setting.setContentPath(contentPath);
            }
        }
    }

    /**
     * Returns a representation of this setting's value in SCSS.
     * @return {Promise}
     */
    async toSCSS() {
        const maps = [];
        for (let item of this.items)
            maps.push(await ThemeManager.getConfigAsSCSSMap(item));

        // Final comma ensures the variable is a list
        return maps.length ? maps.join(', ') + ',' : '()';
    }

}