Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add switch to toggle the use of custom branding #4507

Merged
merged 138 commits into from
Nov 2, 2022
Merged
Changes from 1 commit
Commits
Show all changes
138 commits
Select commit Hold shift + click to select a range
918418f
feat(settings): centralize the plugin settings
Desvelao Sep 13, 2022
de48a49
feat(settings): add setting services and replaced the references to c…
Desvelao Sep 13, 2022
c25a1a0
feat(settings): refactor the content of the default configuration file
Desvelao Sep 13, 2022
ffdb2d7
feat(inputs): create new inputs components
Desvelao Sep 13, 2022
e7cd9b0
feat(configuration): refactor the form of Settings/Configuration
Desvelao Sep 13, 2022
5999419
feat(settings): support updating multiple setting at the same time
Desvelao Sep 13, 2022
9a2b9ba
feat: add validation to the plugin settings
Desvelao Sep 13, 2022
f530d7a
feat(validation): add validation to the `PUT /utils/configuration`
Desvelao Sep 13, 2022
b6a7220
feat(validation): add validation to the configuration form in
Desvelao Sep 13, 2022
134ffd8
feat(validatio): remove no used import
Desvelao Sep 13, 2022
9b977e6
clean: remove not used code
Desvelao Sep 13, 2022
a984a7c
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Sep 13, 2022
f3fc8c8
Add report header-footer configuration
asteriscos Sep 13, 2022
17ad2e8
fix: fixed category name in `Settings/Configuration`
Desvelao Sep 13, 2022
ce4652e
fix(settings): Fix accessing to `validate` of undefined error
Desvelao Sep 13, 2022
23b925d
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Sep 13, 2022
a454dd8
fix(settings): fixed error due to missing service
Desvelao Sep 13, 2022
a56e9d1
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Sep 13, 2022
9bd9835
Add custom branding enabled switch
asteriscos Sep 13, 2022
c3daf43
Merge branch 'feat/settings-validation' into feat/header-footer-repor…
asteriscos Sep 14, 2022
969aa79
Merge branch 'feat/header-footer-report-customization-4426' into feat…
asteriscos Sep 14, 2022
acb8bf0
Fix custom logo ratio in PDF sheet
asteriscos Sep 14, 2022
5d68615
fix(settings): refactor the form and inputs of `Settings/Configuratio…
Desvelao Sep 16, 2022
ef8d6ad
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Sep 16, 2022
1c076be
Merge branch 'feat/settings-validation' into feat/header-footer-repor…
asteriscos Sep 16, 2022
8459f45
Merge branch 'feat/header-footer-report-customization-4426' into feat…
asteriscos Sep 16, 2022
cf15ef8
fix: add value transformation for the form inputs and output of field…
Desvelao Sep 19, 2022
2597cf6
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Sep 19, 2022
951812e
fix: Fixed some settings validation
Desvelao Sep 19, 2022
e0a057e
fix(settings): fixed validation of literals
Desvelao Sep 19, 2022
9699336
fix(settings): removed unused import
Desvelao Sep 19, 2022
0a1ee1d
fix(settings): renamed properties related to transform the value of t…
Desvelao Sep 19, 2022
0109910
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Sep 19, 2022
b4ef2cd
feat(settings): add description to the plugin setting definition prop…
Desvelao Sep 19, 2022
fac95d5
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Sep 19, 2022
34c8de2
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Sep 19, 2022
138db83
fix(settings): fix getConfiguration service when the configuration fi…
Desvelao Sep 20, 2022
710800d
fix(settings): Fixed error when do changes of the `useForm` hook an r…
Desvelao Sep 20, 2022
7d7decc
tests(settings): add test related to the plugin settings and its conf…
Desvelao Sep 20, 2022
5f4d0bd
feat(settings): rename plugin setting options of type select to match…
Desvelao Sep 21, 2022
0cb6be5
feat(settings): add plugin settings services and enhance the descript…
Desvelao Sep 21, 2022
34ddc38
tests(input-form): update tests of InputForm component
Desvelao Sep 21, 2022
f74553b
test(configuration-file): add tests of the default configuration file
Desvelao Sep 21, 2022
4bc1972
feat(settings): remove `extensions.mitre` plugin setting
Desvelao Sep 21, 2022
c4b4c3e
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Sep 21, 2022
28c2266
test(settings): add test to validate the plugin setting when updating…
Desvelao Sep 22, 2022
3d2ca47
feat(settings): add documentation to some setting services and test s…
Desvelao Sep 22, 2022
ef631ff
fix: fixed documentation of setting service
Desvelao Sep 22, 2022
1851f9e
doc(settings): move the documentation of the plugin setting properties
Desvelao Sep 22, 2022
d2a8773
fix(settings): rename some plugin setting properties because of reque…
Desvelao Sep 23, 2022
1d34f6c
tests: fix tests of InputForm component
Desvelao Sep 23, 2022
ac3ebc2
fix: response properties when saving the configuration
Desvelao Sep 23, 2022
70e408d
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Sep 23, 2022
1356c5b
fix(settings): fix validation plugin settings value in the UI
Desvelao Sep 23, 2022
797c9c6
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Sep 23, 2022
92510c4
Merge branch 'feat/header-footer-report-customization-4426' of https:…
Desvelao Sep 23, 2022
b0e5864
fix(settings): fix `customization.reports.header` and `customization.…
Desvelao Sep 23, 2022
061b99b
Merge branch 'feat/header-footer-report-customization-4426' of https:…
Desvelao Sep 23, 2022
6e8b657
fix(settings): fix validation of numbers
Desvelao Sep 23, 2022
fdb6bfc
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Sep 23, 2022
27c5ab4
Merge branch 'feat/header-footer-report-customization-4426' of https:…
Desvelao Sep 23, 2022
b0881c6
fix(settings): fix validation of numbers
Desvelao Sep 23, 2022
7f96098
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Sep 23, 2022
7be2be3
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Sep 23, 2022
7855a3f
test(settings): Add tests related to validation for the `useForm` hoo…
Desvelao Sep 26, 2022
e7fd477
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Sep 26, 2022
f916356
Merge branch 'feat/header-footer-report-customization-4426' of https:…
Desvelao Sep 26, 2022
716a582
fix(settings): fix displaying toast to run the healthcheck when savin…
Desvelao Sep 26, 2022
8ae5067
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Sep 26, 2022
b5c4229
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Sep 26, 2022
ec48ad4
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Sep 26, 2022
6b3cdd3
test(settings): add tests for the `customization.reports.footer` and …
Desvelao Sep 27, 2022
41aeb41
test(settings): Add tests for the `customization.enabled` setting
Desvelao Sep 27, 2022
88f0012
Merge branch 'feat/header-footer-report-customization-4426' of https:…
Desvelao Sep 27, 2022
93157e3
Added category sorting + description + docs link
asteriscos Sep 28, 2022
a007e01
Added settings sorting within their category
asteriscos Sep 28, 2022
0549cb6
Fixed constant types definition
asteriscos Sep 28, 2022
26fa66c
Checks if localCompare exists validation
asteriscos Sep 28, 2022
1f4c01a
fix(settings): fixed plugin setting description doesn't display the m…
Desvelao Oct 3, 2022
33bc999
fix(settings): fix setting type of `wazuh.monitoring.replicas` and li…
Desvelao Oct 3, 2022
ffb1eb9
feat(settins): add plugin settings category description
Desvelao Oct 3, 2022
a935861
fix(settings): fix a problem comparing the initial and current value …
Desvelao Oct 3, 2022
3847992
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Oct 3, 2022
62d1aab
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Oct 3, 2022
0b32a5b
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Oct 3, 2022
a962188
fix(settings): fix wrong conflict resolution
Desvelao Oct 3, 2022
b551b00
fix(settings): fix typo in setting description
Desvelao Oct 3, 2022
8adf7b4
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Oct 3, 2022
0e5e8c9
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Oct 3, 2022
2137bdc
Merge branch 'feat/header-footer-report-customization-4426' of https:…
Desvelao Oct 3, 2022
f5bf16f
Add set custom header footer unit test
asteriscos Oct 3, 2022
a4e202e
feat(settings): enhance the validation of plugin settings related to …
Desvelao Oct 4, 2022
08792c9
feat(settings): add validation of setting values in the inputs
Desvelao Oct 4, 2022
51f96cb
Added unit test to verify the PDF report integrity
asteriscos Oct 4, 2022
624a8f4
fix(tests): format tables of the tests
Desvelao Oct 5, 2022
d6a22a7
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Oct 5, 2022
2e0d6c3
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Oct 5, 2022
9456bcf
Merge branch 'feat/header-footer-report-customization-4426' of https:…
Desvelao Oct 5, 2022
95b9020
fix: remove unnecessary import
Desvelao Oct 5, 2022
034bd34
test(endpoints): add test to GET /reports endpoint
Desvelao Oct 5, 2022
ff57714
Merge branch 'feat/header-footer-report-customization-4426' of https:…
Desvelao Oct 5, 2022
75ed4f0
test(settings): add test for `customization.enabled` setting in the f…
Desvelao Oct 5, 2022
91e6749
Improved report unit test with more cases
asteriscos Oct 5, 2022
282b7e9
Fix small typo
asteriscos Oct 5, 2022
12fe59c
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Oct 6, 2022
22f2e70
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Oct 6, 2022
ffbdd35
Merge branch 'feat/header-footer-report-customization-4426' of https:…
Desvelao Oct 6, 2022
04f7457
fix(settings): fix a typo in a toast related to modify the plugin set…
Desvelao Oct 6, 2022
066002e
Merge branch 'feat/centralize-plugin-settings' of https://github.com/…
Desvelao Oct 6, 2022
caf1c98
Merge branch 'feat/settings-validation' of https://github.com/wazuh/w…
Desvelao Oct 6, 2022
cf2c243
Merge branch 'feat/header-footer-report-customization-4426' of https:…
Desvelao Oct 6, 2022
312461c
Changed Custom Branding documentation link
asteriscos Oct 11, 2022
6d5afcd
Merge centralize plugin settings PR
asteriscos Oct 11, 2022
cb793d6
Fix white-labeling documentation link
asteriscos Oct 11, 2022
950688e
Fix white-labeling documentation link
asteriscos Oct 11, 2022
d4c18b1
Code format
asteriscos Oct 20, 2022
19c7cac
Delete unused imports
asteriscos Oct 20, 2022
84472df
Merge branch 'feat/centralize-plugin-settings' into feat/settings-val…
AlexRuiz7 Oct 20, 2022
e6da4c3
fix(settings): fix a problem with the useForm hook
Desvelao Oct 21, 2022
dffeb09
fix(settings): refactor the settings validation function to a class a…
Desvelao Oct 21, 2022
e5a28ea
feat(settings): add check for integer numbers and adapt the affected …
Desvelao Oct 21, 2022
a4e0a86
Merge branch 'feat/settings-validation' into feat/header-footer-repor…
asteriscos Oct 24, 2022
6e13173
Merge branch 'feat/header-footer-report-customization-4426' into feat…
asteriscos Oct 24, 2022
38ca355
Merge branch '4.4-7.10' of https://github.com/wazuh/wazuh-kibana-app …
Desvelao Oct 31, 2022
363b622
changelog: Add PR entry
Desvelao Oct 31, 2022
8d86689
fix(settings): fix the customization settings do not apply when the `…
Desvelao Oct 31, 2022
f62dca9
fix(settings): the `customization.logo.sidebar` is updated without re…
Desvelao Oct 31, 2022
6ffbdb6
Fix customization.enable on GET api/logos endpoint
asteriscos Oct 31, 2022
b7ee36b
Merge branch 'feat/add-custom-branding-enabled-configuration-4506' of…
asteriscos Oct 31, 2022
f07964b
fix: revert unused change
Desvelao Nov 2, 2022
c137ccc
fix: revert the updating of the `customization.logo.sidebar` when the…
Desvelao Nov 2, 2022
17e4363
Merge branch '4.4-7.10' into feat/add-custom-branding-enabled-configu…
AlexRuiz7 Nov 2, 2022
ce65312
fix: removed unused code and removed space
Desvelao Nov 2, 2022
f946f86
Merge branch 'feat/add-custom-branding-enabled-configuration-4506' of…
Desvelao Nov 2, 2022
58e7be7
fix: undone unwanted changes
Desvelao Nov 2, 2022
e36d4df
fix: resolve setting when it is an empty string
Desvelao Nov 2, 2022
7ad0476
fix: request changes and rename function
Desvelao Nov 2, 2022
95297d2
fix: fix settings tests
Desvelao Nov 2, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc(settings): move the documentation of the plugin setting properties
  • Loading branch information
Desvelao committed Sep 22, 2022

Unverified

This user has not yet uploaded their public signing key.
commit 1851f9e5255fe4d91aa7215090f14be6d534be5c
46 changes: 30 additions & 16 deletions common/constants.ts
Original file line number Diff line number Diff line change
@@ -375,7 +375,6 @@ type TpluginSettingOptionsSwitch = {
}
};


export enum EpluginSettingType{
text = 'text',
textarea = 'textarea',
@@ -386,21 +385,36 @@ export enum EpluginSettingType{
};

export type TpluginSetting = {
title: string // Define the text displayed in the UI.
description: string // Description.
category: SettingCategory // Category.
type: EpluginSettingType // Type.
default: any // Default value.
defaultHidden?: any // Default value if it is not set. It has preference over `default`
configurableFile: boolean, // Configurable from the configuration file
configurableUI: boolean // Configurable from the UI (Settings/Configuration)
requireHealthCheck?: boolean // Modify the setting requires running the plugin health check (frontend)
requireReload?: boolean // Modify the setting requires reloading the browser tab (frontend)
requireRestart?: boolean // Modify the setting requires restarting the plugin platform to take effect
options?: TpluginSettingOptionsNumber | TpluginSettingOptionsEditor | TpluginSettingOptionsSelect | TpluginSettingOptionsSwitch // Define options related to the `type`
uiFormTransformChangedInputValue?: (value: any) => any // Transform the input value. The result is saved in the form global state of Settings/Configuration
uiFormTransformInputValueToConfigurationValue?: (value: any) => any // Transform the configuration value or default as initial value for the input in Settings/Configuration
uiFormTransformConfigurationValueToInputValue?: (value: any) => any // Transform the input value changed in the form of Settings/Configuration and returned in the `changed` property of the hook useForm
// Define the text displayed in the UI.
title: string
// Description.
description: string
// Category.
category: SettingCategory
// Type.
type: EpluginSettingType
// Default value.
default: any
// Default value if it is not set. It has preference over `default`.
defaultHidden?: any
// Configurable from the configuration file.
configurableFile: boolean
// Configurable from the UI (Settings/Configuration).
configurableUI: boolean
// Modify the setting requires running the plugin health check (frontend).
requireHealthCheck?: boolean
// Modify the setting requires reloading the browser tab (frontend).
requireReload?: boolean
// Modify the setting requires restarting the plugin platform to take effect.
requireRestart?: boolean
// Define options related to the `type`.
options?: TpluginSettingOptionsNumber | TpluginSettingOptionsEditor | TpluginSettingOptionsSelect | TpluginSettingOptionsSwitch
// Transform the input value. The result is saved in the form global state of Settings/Configuration
uiFormTransformChangedInputValue?: (value: any) => any
// Transform the configuration value or default as initial value for the input in Settings/Configuration
uiFormTransformConfigurationValueToInputValue?: (value: any) => any
// Transform the input value changed in the form of Settings/Configuration and returned in the `changed` property of the hook useForm
uiFormTransformInputValueToConfigurationValue?: (value: any) => any
};

export type TPluginSettingWithKey = TpluginSetting & { key: string };