From b729b85ad012c59b18addc47afc1573012858bf5 Mon Sep 17 00:00:00 2001 From: Jakob Scheid Date: Fri, 5 Jun 2026 11:35:41 +0200 Subject: [PATCH 1/2] feat(settings): allow only sections as first-level settings --- src/features/settings/types/settingsConfig.js | 7 ++----- .../utils/__tests__/settingsValidator.test.js | 9 --------- src/features/settings/utils/settingsValidator.js | 15 ++++++++++++++- 3 files changed, 16 insertions(+), 15 deletions(-) diff --git a/src/features/settings/types/settingsConfig.js b/src/features/settings/types/settingsConfig.js index d2ee124..42f5474 100644 --- a/src/features/settings/types/settingsConfig.js +++ b/src/features/settings/types/settingsConfig.js @@ -53,10 +53,6 @@ limitations under the License. * @typedef {BoolSettingConfig | NumberSettingConfig | StringSettingConfig | SelectionSettingConfig | SectionSettingConfig} SettingConfigEntry */ -/** - * @typedef {Object} SettingsConfig - * @property {SettingConfigEntry[]} contents - */ /** * @typedef {{ type: 'bool', name: string, i18n: string, description?: string, default: boolean }} BoolSettingConfig * @typedef {{ type: 'number', name: string, i18n: string, description?: string, default: number }} NumberSettingConfig @@ -64,5 +60,6 @@ limitations under the License. * @typedef {{ type: 'selection', name: string, i18n: string, description?: string, default: string | string[], allowMultiple?: boolean, options: SelectionOption[] }} SelectionSettingConfig * @typedef {{ type: 'section', name: string, i18n?: string, description?: string, content: SettingConfigEntry[] }} SectionSettingConfig * @typedef {BoolSettingConfig | NumberSettingConfig | StringSettingConfig | SelectionSettingConfig | SectionSettingConfig} SettingConfigEntry - * @typedef {{ contents: SettingConfigEntry[] }} SettingsConfig + * @typedef {{ contents: SettingConfigEntry[] }} FirstLevelSettingConfigEntry + * @typedef {{ contents: FirstLevelSettingConfigEntry[] }} SettingsConfig */ \ No newline at end of file diff --git a/src/features/settings/utils/__tests__/settingsValidator.test.js b/src/features/settings/utils/__tests__/settingsValidator.test.js index 5f30729..f36777f 100644 --- a/src/features/settings/utils/__tests__/settingsValidator.test.js +++ b/src/features/settings/utils/__tests__/settingsValidator.test.js @@ -33,7 +33,6 @@ describe('validateSettingsConfig', () => { { raw: { contents: [ { - type: 'section', name: 'general', i18n: 'settings.settings.general', content: [ @@ -49,7 +48,6 @@ describe('validateSettingsConfig', () => { { raw: { contents: [ { - type: 'section', name: 'general', i18n: 'settings.settings.general', content: [ @@ -61,7 +59,6 @@ describe('validateSettingsConfig', () => { ] }, { - type: 'section', name: 'copyOfGeneral', i18n: 'settings.settings.copyOfGeneral', content: [ @@ -77,7 +74,6 @@ describe('validateSettingsConfig', () => { { raw: { contents: [ { - type: 'section', name: 'general', i18n: 'settings.settings.general', content: [ @@ -89,7 +85,6 @@ describe('validateSettingsConfig', () => { ] }, { - type: 'section', name: 'copyOfGeneral', i18n: 'settings.settings.copyOfGeneral', content: [ @@ -102,7 +97,6 @@ describe('validateSettingsConfig', () => { ] }, { - type: 'section', name: 'aSection', i18n: 'settings.settings.aSection', content: [ @@ -141,7 +135,6 @@ describe('validateSettingsConfig', () => { { raw: { contents: [ { - type: 'section', name: 'general', i18n: 'settings.settings.general', content: [ @@ -153,7 +146,6 @@ describe('validateSettingsConfig', () => { ] }, { - type: 'section', name: 'copyOfGeneral', i18n: 'settings.settings.copyOfGeneral', content: [ @@ -166,7 +158,6 @@ describe('validateSettingsConfig', () => { ] }, { - type: 'section', name: 'aSection', i18n: 'settings.settings.aSection', content: [ diff --git a/src/features/settings/utils/settingsValidator.js b/src/features/settings/utils/settingsValidator.js index 1cf5b09..14c3910 100644 --- a/src/features/settings/utils/settingsValidator.js +++ b/src/features/settings/utils/settingsValidator.js @@ -83,6 +83,19 @@ export const validateEntry = function validateEntry (entry, path) { } } +export const validateFirstLevelSection = function validateFirstLevelSection (section, path) { + assertString(section.name); + assertString(section.i18n); + + if (!Array.isArray(section.content)) { + throw new Error(`[settings] "${path}.content" must be an array`); + }; + + section.content.forEach((entry, i) => + validateEntry(entry, `${path}.content[${i}]`) + ); +}; + /** * Validates a raw settings config object. * @param {unknown} raw @@ -97,7 +110,7 @@ export function validateSettingsConfig(raw) { throw new Error('[settings] "contents" must be an array'); } raw.contents.forEach((entry, i) => - validateEntry(entry, `contents[${i}]`) + validateFirstLevelSection(entry, `contents[${i}]`) ); return { valid: true, config: raw }; } catch (e) { -- 2.39.5 From 192f3c37a922afa7f0da4cae561ba2e0b2770df9 Mon Sep 17 00:00:00 2001 From: Jakob Scheid Date: Fri, 5 Jun 2026 11:37:17 +0200 Subject: [PATCH 2/2] feat(settings): add test cases to test that only sections are allowed as first-level settings --- .../utils/__tests__/settingsValidator.test.js | 68 +++++++++++++++++++ 1 file changed, 68 insertions(+) diff --git a/src/features/settings/utils/__tests__/settingsValidator.test.js b/src/features/settings/utils/__tests__/settingsValidator.test.js index f36777f..05f00fd 100644 --- a/src/features/settings/utils/__tests__/settingsValidator.test.js +++ b/src/features/settings/utils/__tests__/settingsValidator.test.js @@ -194,6 +194,74 @@ describe('validateSettingsConfig', () => { }, ] }, expected: true }, + { raw: { + contents: [ + { + type: 'bool', + name: 'aStandaloneBooleanSetting', + i18n: 'settings.settings.aStandaloneBooleanSetting', + default: true + }, + { + name: 'general', + i18n: 'settings.settings.general', + content: [ + { + type: 'bool', + name: 'Enable feature 42', + i18n: 'settings.settings.general.enableFeature42' + } + ] + }, + { + name: 'copyOfGeneral', + i18n: 'settings.settings.copyOfGeneral', + content: [ + { + type: 'bool', + name: 'Enable feature 42', + default: false, + i18n: 'settings.settings.general.enableFeature42' + } + ] + }, + { + name: 'aSection', + i18n: 'settings.settings.aSection', + content: [ + { + type: 'bool', + name: 'Enable feature 43', + i18n: 'settings.settings.aSection.enableFeature43' + }, + { + type: 'selection', + name: 'language', + i18n: 'settings.settings.aSection.language.label', + default: 'en', + allowMultiple: false, + options: [ + { name: 'en', i18n: 'settings.settings.aSection.language.options.en' }, + { name: 'de', i18n: 'settings.settings.aSection.language.options.de' }, + ] + }, + { + type: 'section', + name: 'section2', + i18n: 'settings.settings.aSection.section2.label', + content: [ + { + type: 'string', + name: 'string', + i18n: 'settings.settings.aSection.sections.string', + default: 'str' + } + ] + }, + ] + }, + ] + }, expected: false }, { raw: { contents: [ { -- 2.39.5