1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
/*
* SonarQube
* Copyright (C) 2009-2024 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
import { omitBy } from 'lodash';
import { throwGlobalError } from '~sonar-aligned/helpers/error';
import { getJSON } from '~sonar-aligned/helpers/request';
import { isCategoryDefinition } from '../apps/settings/utils';
import { post, postJSON, RequestData } from '../helpers/request';
import { BranchParameters } from '../types/branch-like';
import {
ExtendedSettingDefinition,
SettingDefinition,
SettingType,
SettingValue,
SettingValueResponse,
} from '../types/settings';
export function getDefinitions(component?: string): Promise<ExtendedSettingDefinition[]> {
return getJSON('/api/settings/list_definitions', { component }).then(
(r) => r.definitions,
throwGlobalError,
);
}
export function getValue(
data: { key: string; component?: string } & BranchParameters,
): Promise<SettingValue> {
return getValues({ keys: [data.key], component: data.component }).then(([result]) => result);
}
export function getValues(
data: { keys: string[]; component?: string } & BranchParameters,
): Promise<SettingValue[]> {
return getJSON('/api/settings/values', {
keys: data.keys.join(','),
component: data.component,
}).then((r: SettingValueResponse) => [
...r.settings,
...r.setSecuredSettings.map((key) => ({ key })),
]);
}
export function getAllValues(
data: { component?: string } & BranchParameters = {},
): Promise<SettingValue[]> {
return getJSON('/api/settings/values', data).then((r: SettingValueResponse) => [
...r.settings,
...r.setSecuredSettings.map((key) => ({ key })),
]);
}
export function setSettingValue(
definition: SettingDefinition,
value: any,
component?: string,
): Promise<void> {
const { key } = definition;
const data: RequestData = { key, component };
if (definition.type === SettingType.PROPERTY_SET) {
data.fieldValues = value
.map((fields: any) => omitBy(fields, (value) => value == null))
.map(JSON.stringify);
} else if (isCategoryDefinition(definition) && definition.multiValues) {
data.values = value;
} else {
data.value = value;
}
return post('/api/settings/set', data);
}
export function setSimpleSettingValue(
data: { component?: string; value?: string; values?: string[]; key: string } & BranchParameters,
): Promise<void | Response> {
return post('/api/settings/set', data).catch(throwGlobalError);
}
export function resetSettingValue(
data: { keys: string; component?: string } & BranchParameters,
): Promise<void> {
return post('/api/settings/reset', data);
}
export function sendTestEmail(to: string, subject: string, message: string): Promise<void> {
return post('/api/emails/send', { to, subject, message });
}
export function checkSecretKey(): Promise<{ secretKeyAvailable: boolean }> {
return getJSON('/api/settings/check_secret_key').catch(throwGlobalError);
}
export function generateSecretKey(): Promise<{ secretKey: string }> {
return getJSON('/api/settings/generate_secret_key').catch(throwGlobalError);
}
export function encryptValue(value: string): Promise<{ encryptedValue: string }> {
return postJSON('/api/settings/encrypt', { value }).catch(throwGlobalError);
}
export function getLoginMessage(): Promise<{ message: string }> {
return getJSON('/api/settings/login_message').catch(throwGlobalError);
}
|
