Configuration management and related UI creation module
目前为
此脚本不应直接安装，它是一个供其他脚本使用的外部库。如果您需要使用该库，请在脚本元属性加入：// @require https://update.greasyfork.icu/scripts/418665/937539/Brazen%20Configuration%20Manager.js
// ==UserScript==
// @name Brazen Configuration Manager
// @namespace brazenvoid
// @version 2.0.0
// @author brazenvoid
// @license GPL-3.0-only
// @description Configuration management and related UI creation module
// ==/UserScript==
const CONFIG_TYPE_CHECKBOXES_GROUP = 'checkboxes'
const CONFIG_TYPE_FLAG = 'flag'
const CONFIG_TYPE_NUMBER = 'number'
const CONFIG_TYPE_RADIOS_GROUP = 'radios'
const CONFIG_TYPE_RANGE = 'range'
const CONFIG_TYPE_RULESET = 'ruleset'
const CONFIG_TYPE_SELECT = 'select'
const CONFIG_TYPE_TEXT = 'text'
class BrazenConfigurationManager
{
/**
* @typedef {{key: string, title: string, type: string, element: null|JQuery, value: *, maximum: int, minimum: int, optimized: *, options: string[],
* helpText: string, unit: string, onFormatForUI: ConfigurationManagerRulesetCallback, onTranslateFromUI: ConfigurationManagerRulesetCallback,
* onOptimize: ConfigurationManagerRulesetCallback, createElement: Function, setFromUserInterface: Function,
* updateUserInterface: Function}} ConfigurationField
*/
/**
* @callback ConfigurationManagerRulesetCallback
* @param {*} values
*/
/**
* @callback ExternalConfigurationChangeCallback
* @param {BrazenConfigurationManager} manager
*/
/**
* @param {BrazenUIGenerator} uiGenerator
* @return {BrazenConfigurationManager}
*/
static create (uiGenerator)
{
return new BrazenConfigurationManager(uiGenerator)
}
constructor (uiGenerator)
{
/**
* @type {{}}
* @private
*/
this._config = {}
/**
* @type {ExternalConfigurationChangeCallback|null}
* @private
*/
this._onExternalConfigurationChange = null
/**
* @type {LocalStore}
* @private
*/
this._localStore = null
/**
* @type {LocalStore}
* @private
*/
this._localStoreId = null
/**
* @type {number}
* @private
*/
this._syncedLocalStoreId = 0
/**
* @type BrazenUIGenerator
* @private
*/
this._uiGen = uiGenerator
}
/**
* @param {string} type
* @param {string} name
* @param {*} value
* @param {string|null} helpText
* @return ConfigurationField
* @private
*/
_createField (type, name, value, helpText)
{
let fieldKey = this._formatFieldKey(name)
let field = this._config[fieldKey]
if (!field) {
field = {
key: fieldKey,
element: null,
helpText: helpText,
title: name,
type: type,
value: value,
createElement: null,
setFromUserInterface: null,
updateUserInterface: null,
}
this._config[fieldKey] = field
} else {
if (helpText) {
field.helpText = helpText
}
field.value = value
}
return field
}
/**
* @param {string} name
* @return {string}
* @private
*/
_formatFieldKey (name)
{
return Utilities.toKebabCase(name.replaceAll('&', 'and'))
}
/**
* @param {boolean} ignoreIfDefaultsSet
* @private
*/
_syncLocalStore (ignoreIfDefaultsSet)
{
let field
let storeObject = this._localStore.get()
if (!ignoreIfDefaultsSet || !this._localStore.wereDefaultsSet()) {
for (let key in this._config) {
field = this._config[key]
if (typeof storeObject[key] !== 'undefined') {
field.value = storeObject[key]
if (field.type === CONFIG_TYPE_RULESET) {
field.optimized = Utilities.callEventHandler(field.onOptimize, [field.value])
}
}
}
this.updateInterface()
}
return this
}
/**
* @return {{}}
* @private
*/
_toStoreObject ()
{
let storeObject = {}
for (let key in this._config) {
storeObject[key] = this._config[key].value
}
return storeObject
}
/**
* @private
*/
_regenerateStoreId ()
{
this._localStoreId.save({id: Utilities.generateId()})
}
/**
* @param {string} name
* @param {string[]} options
* @param {string} helpText
* @returns {BrazenConfigurationManager}
*/
addCheckboxesGroup (name, options, helpText)
{
let field = this._createField(CONFIG_TYPE_CHECKBOXES_GROUP, name, [], helpText)
field.options = options
field.createElement = () => this._uiGen.createFormConfigSwitchesGroup(field)
field.setFromUserInterface = () => {
field.value = []
field.element.find('input:checked').each((index, element) => field.value.push($(element).val()))
}
field.updateUserInterface = () => {
let elements = field.element.find('input').prop('checked', false)
for (let checkboxIndex of field.value) {
elements.eq(checkboxIndex).prop('checked', true)
}
}
return this
}
/**
* @param {string} name
* @param {string} helpText
* @returns {BrazenConfigurationManager}
*/
addFlagField (name, helpText)
{
let field = this._createField(CONFIG_TYPE_FLAG, name, false, helpText)
field.createElement = () => this._uiGen.createFormConfigSwitch(field)
field.setFromUserInterface = () => field.value = field.element.find('input').prop('checked')
field.updateUserInterface = () => field.element.find('input').prop('checked', field.value)
return this
}
/**
* @param {string} name
* @param {string} unit
* @param {number} minimum
* @param {number} maximum
* @param {string} helpText
* @returns {BrazenConfigurationManager}
*/
addNumberField (name, unit, minimum, maximum, helpText)
{
let field = this._createField(CONFIG_TYPE_NUMBER, name, minimum, helpText)
field.minimum = minimum
field.maximum = maximum
field.unit = unit
field.createElement = () => this._uiGen.createFormConfigNumberInput(field)
field.setFromUserInterface = () => field.value = field.element.find('input').val()
field.updateUserInterface = () => field.element.find('input').val(field.value)
return this
}
/**
* @param {string} name
* @param {string} unit
* @param {number} minimum
* @param {number} maximum
* @param {string} helpText
* @returns {BrazenConfigurationManager}
*/
addRangeField (name, unit, minimum, maximum, helpText)
{
let field = this._createField(CONFIG_TYPE_RANGE, name, {minimum: minimum, maximum: minimum}, helpText)
field.minimum = minimum
field.maximum = maximum
field.unit = unit
field.createElement = () => this._uiGen.createFormConfigRangeInput(field)
field.setFromUserInterface = () => field.value = {
minimum: field.element.find('.range-min').val(),
maximum: field.element.find('.range-max').val(),
}
field.updateUserInterface = () => {
field.element.find('.range-min').val(field.value.minimum)
field.element.find('.range-max').val(field.value.maximum)
}
return this
}
/**
* @param {string} name
* @param {number} rows
* @param {string|null} helpText
* @param {ConfigurationManagerRulesetCallback} onTranslateFromUI
* @param {ConfigurationManagerRulesetCallback} onFormatForUI
* @param {ConfigurationManagerRulesetCallback} onOptimize
* @return {BrazenConfigurationManager}
*/
addRulesetField (name, rows, helpText, onTranslateFromUI = null, onFormatForUI = null, onOptimize = null)
{
let field = this._createField(CONFIG_TYPE_RULESET, name, [], helpText)
field.optimized = null
field.onTranslateFromUI = onTranslateFromUI ?? field.onTranslateFromUI
field.onFormatForUI = onFormatForUI ?? field.onFormatForUI
field.onOptimize = onOptimize ?? field.onOptimize
field.createElement = () => this._uiGen.createFormConfigRulesetAccordion(field)
field.setFromUserInterface = () => {
let value = Utilities.trimAndKeepNonEmptyStrings(field.element.find('.ruleset-input').val().split(REGEX_LINE_BREAK))
field.value = Utilities.callEventHandler(field.onTranslateFromUI, [value], value)
field.optimized = Utilities.callEventHandler(field.onOptimize, [field.value])
}
field.updateUserInterface = () => field.element
.find('.ruleset-input')
.val(Utilities.callEventHandler(field.onFormatForUI, [field.value], field.value).join('\n'))
return this
}
/**
* @param {string} name
* @param {string[]} options
* @param {string} helpText
* @returns {BrazenConfigurationManager}
*/
addSelectField (name, options, helpText)
{
let field = this._createField(CONFIG_TYPE_SELECT, name, 0, helpText)
field.options = options
field.createElement = () => this._uiGen.createFormConfigSelect(field)
field.setFromUserInterface = () => field.value = field.element.find('select').val()
field.updateUserInterface = () => field.element.find('select').val(field.value).trigger('change')
return this
}
/**
* @param {string} name
* @param {string} helpText
* @returns {BrazenConfigurationManager}
*/
addTextField (name, helpText)
{
let field = this._createField(CONFIG_TYPE_TEXT, name, '', helpText)
field.createElement = () => this._uiGen.createFormConfigInput(field)
field.setFromUserInterface = () => field.value = field.element.find('input').val()
field.updateUserInterface = () => field.element.find('input').val(field.value)
return this
}
backup ()
{
let backupConfig = this._toStoreObject()
backupConfig.id = this._syncedLocalStoreId
return Utilities.objectToJSON(backupConfig)
}
createElement (name)
{
return this.getFieldOrFail(name).createElement()
}
/**
* @param {string} name
* @return {ConfigurationField|null}
*/
getField (name)
{
return this._config[this._formatFieldKey(name)]
}
/**
* @param {string} name
* @return {ConfigurationField}
*/
getFieldOrFail (name)
{
let field = this._config[this._formatFieldKey(name)]
if (field) {
return field
}
throw new Error('Field named "' + name + '" could not be found')
}
getValue (name)
{
return this.getFieldOrFail(name).value
}
/**
* @param {string} name
* @return {boolean}
*/
hasField (name)
{
return typeof this.getField(name) !== 'undefined'
}
/**
* @return {BrazenConfigurationManager}
*/
initialize (scriptName)
{
let scriptKey = this._formatFieldKey(scriptName)
this._localStore = new LocalStore(scriptKey + '-settings', this._toStoreObject())
this._localStore.onChange(() => this.updateInterface())
this._localStoreId = new LocalStore( scriptKey + '-settings-id', {id: Utilities.generateId()})
$(document).on('visibilitychange', () => {
if (!document.hidden && this._syncedLocalStoreId !== this._localStoreId.get().id) {
Utilities.callEventHandler(this._onExternalConfigurationChange, [this])
}
})
return this._syncLocalStore(true)
}
/**
* @param {ExternalConfigurationChangeCallback} eventHandler
* @return {BrazenConfigurationManager}
*/
onExternalConfigurationChange (eventHandler)
{
this._onExternalConfigurationChange = eventHandler
return this
}
/**
* @param {string} backedUpConfiguration
*/
restore (backedUpConfiguration)
{
let backupConfig = Utilities.objectFromJSON(backedUpConfiguration)
if (typeof backupConfig.id !== 'undefined') {
this._syncedLocalStoreId = backupConfig.id
this._localStoreId.save({id: backupConfig.id})
delete backupConfig.id
} else {
this._regenerateStoreId()
}
this._localStore.save(backupConfig)
this._syncLocalStore(false)
return this
}
revertChanges ()
{
return this._syncLocalStore(false)
}
save ()
{
this.update()._localStore.save(this._toStoreObject())
this._regenerateStoreId()
return this
}
update ()
{
let field
for (let fieldName in this._config) {
field = this._config[fieldName]
if (field.element) {
field.setFromUserInterface()
}
}
return this
}
updateInterface ()
{
let field
for (let fieldName in this._config) {
field = this._config[fieldName]
if (field.element) {
field.updateUserInterface()
}
}
return this
}
}