mirror of
https://github.com/SillyTavern/SillyTavern.git
synced 2024-12-14 10:24:47 +01:00
80 lines
3.4 KiB
JavaScript
80 lines
3.4 KiB
JavaScript
import { SlashCommandExecutor } from './SlashCommandExecutor.js';
|
|
import { SlashCommandScope } from './SlashCommandScope.js';
|
|
|
|
|
|
/**
|
|
* @typedef {'enum' | 'command' | 'namedArgument' | 'variable' | 'qr' | 'macro' | 'number' | 'name'} EnumType
|
|
*/
|
|
|
|
/**
|
|
* Collection of the enum types that can be used with `SlashCommandEnumValue`
|
|
*
|
|
* Contains documentation on which color this will result to
|
|
*/
|
|
export const enumTypes = {
|
|
/** 'enum' - [string] - light orange @type {EnumType} */
|
|
enum: 'enum',
|
|
/** 'command' - [cmd] - light yellow @type {EnumType} */
|
|
command: 'command',
|
|
/** 'namedArgument' - [argName] - sky blue @type {EnumType} */
|
|
namedArgument: 'namedArgument',
|
|
/** 'variable' - [punctuationL1] - pink @type {EnumType} */
|
|
variable: 'variable',
|
|
/** 'qr' - [variable] - light blue @type {EnumType} */
|
|
qr: 'qr',
|
|
/** 'macro' - [variableLanguage] - blue @type {EnumType} */
|
|
macro: 'macro',
|
|
/** 'number' - [number] - light green @type {EnumType} */
|
|
number: 'number',
|
|
/** 'name' - [type] - forest green @type {EnumType} */
|
|
name: 'name',
|
|
|
|
/**
|
|
* Gets the value of the enum type based on the provided index
|
|
*
|
|
* Can be used to get differing colors or even random colors, by providing the index of a unique set
|
|
*
|
|
* @param {number?} index - The index used to retrieve the enum type
|
|
* @return {EnumType} The enum type corresponding to the index
|
|
*/
|
|
getBasedOnIndex(index) {
|
|
const keys = Object.keys(this);
|
|
return this[keys[(index ?? 0) % keys.length]];
|
|
},
|
|
};
|
|
|
|
export class SlashCommandEnumValue {
|
|
/**@type {string}*/ value;
|
|
/**@type {string}*/ description;
|
|
/**@type {EnumType}*/ type = 'enum';
|
|
/**@type {string}*/ typeIcon = '◊';
|
|
/**@type {(input:string)=>boolean}*/ matchProvider;
|
|
/**@type {(input:string)=>string}*/ valueProvider;
|
|
/**@type {boolean}*/ makeSelectable = false;
|
|
|
|
/**
|
|
* A constructor for creating a SlashCommandEnumValue instance.
|
|
*
|
|
* @param {string} value - The value
|
|
* @param {string?} description - Optional description, displayed in a second line
|
|
* @param {EnumType?} type - type of the enum (defining its color)
|
|
* @param {string?} typeIcon - The icon to display (Can be pulled from `enumIcons` for common ones)
|
|
* @param {(input:string)=>boolean?} matchProvider - A custom function to match autocomplete input instead of startsWith/includes/fuzzy. Should only be used for generic options like "any number" or "any string". "input" is the part of the text that is getting auto completed.
|
|
* @param {(input:string)=>string?} valueProvider - A function returning a value to be used in autocomplete instead of the enum value. "input" is the part of the text that is getting auto completed. By default, values with a valueProvider will not be selectable in the autocomplete (with tab/enter).
|
|
* @param {boolean?} makeSelectable - Set to true to make the value selectable (through tab/enter) even though a valueProvider exists.
|
|
*/
|
|
constructor(value, description = null, type = 'enum', typeIcon = '◊', matchProvider = null, valueProvider = null, makeSelectable = false) {
|
|
this.value = value;
|
|
this.description = description;
|
|
this.type = type ?? 'enum';
|
|
this.typeIcon = typeIcon;
|
|
this.matchProvider = matchProvider;
|
|
this.valueProvider = valueProvider;
|
|
this.makeSelectable = makeSelectable;
|
|
}
|
|
|
|
toString() {
|
|
return this.value;
|
|
}
|
|
}
|