From c387c1486f14b6921953e4c987c53aaec22225ec Mon Sep 17 00:00:00 2001 From: "johannes.vos" Date: Tue, 26 May 2026 11:32:51 +0200 Subject: [PATCH] feat(settings): add JSDoc type definitions for settings config --- src/features/settings/types/settingsConfig.js | 71 +++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/src/features/settings/types/settingsConfig.js b/src/features/settings/types/settingsConfig.js index e69de29..c7a4135 100644 --- a/src/features/settings/types/settingsConfig.js +++ b/src/features/settings/types/settingsConfig.js @@ -0,0 +1,71 @@ +/* +Copyright 2026 Seekra + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +/** + * @typedef {'bool' | 'number' | 'string' | 'selection' | 'section'} SettingType + */ + +/** + * @typedef {Object} SelectionOption + * @property {string} name + * @property {string} i18n + */ + +/** + * @typedef {Object} BaseSettingConfig + * @property {SettingType} type + * @property {string} name + * @property {string} i18n + * @property {string} [description] + */ + +/** + * @typedef {BaseSettingConfig & { default: boolean }} BoolSettingConfig + */ + +/** + * @typedef {BaseSettingConfig & { default: number }} NumberSettingConfig + */ + +/** + * @typedef {BaseSettingConfig & { default: string }} StringSettingConfig + */ + +/** + * @typedef {BaseSettingConfig & { + * default: string | string[], + * allowMultiple: boolean, + * options: SelectionOption[] + * }} SelectionSettingConfig + */ + +/** + * @typedef {Object} SectionSettingConfig + * @property {'section'} type + * @property {string} name + * @property {string} [i18n] + * @property {string} [description] + * @property {SettingConfigEntry[]} content + */ + +/** + * @typedef {BoolSettingConfig | NumberSettingConfig | StringSettingConfig | SelectionSettingConfig | SectionSettingConfig} SettingConfigEntry + */ + +/** + * @typedef {Object} SettingsConfig + * @property {SettingConfigEntry[]} contents + */ \ No newline at end of file