aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/api/rules.ts
blob: ea42bf0a1a7c25b0b09a5953abaacb3e9e0441df (plain)
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
/*
 * SonarQube
 * Copyright (C) 2009-2018 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 { post, getJSON, postJSON } from '../helpers/request';
import throwGlobalError from '../app/utils/throwGlobalError';
import { Rule, RuleDetails, RuleActivation } from '../app/types';

export interface GetRulesAppResponse {
  canWrite?: boolean;
  repositories: { key: string; language: string; name: string }[];
}

export function getRulesApp(data: {
  organization: string | undefined;
}): Promise<GetRulesAppResponse> {
  return getJSON('/api/rules/app', data).catch(throwGlobalError);
}

export interface SearchRulesResponse {
  actives?: { [rule: string]: RuleActivation[] };
  facets?: { property: string; values: { count: number; val: string }[] }[];
  p: number;
  ps: number;
  rules: Rule[];
  total: number;
}

export function searchRules(data: {
  organization: string | undefined;
  [x: string]: any;
}): Promise<SearchRulesResponse> {
  return getJSON('/api/rules/search', data).catch(throwGlobalError);
}

export function takeFacet(response: any, property: string) {
  const facet = response.facets.find((facet: any) => facet.property === property);
  return facet ? facet.values : [];
}

export function getRuleDetails(parameters: {
  actives?: boolean;
  key: string;
  organization: string | undefined;
}): Promise<{ actives?: RuleActivation[]; rule: RuleDetails }> {
  return getJSON('/api/rules/show', parameters).catch(throwGlobalError);
}

export function getRuleTags(parameters: {
  organization: string | undefined;
  ps?: number;
  q: string;
}): Promise<string[]> {
  return getJSON('/api/rules/tags', parameters).then(r => r.tags, throwGlobalError);
}

export function createRule(data: {
  custom_key: string;
  markdown_description: string;
  name: string;
  organization: string | undefined;
  params?: string;
  prevent_reactivation?: boolean;
  severity?: string;
  status?: string;
  template_key: string;
  type?: string;
}): Promise<RuleDetails> {
  return postJSON('/api/rules/create', data).then(
    r => r.rule,
    error => {
      // do not show global error if the status code is 409
      // this case should be handled inside a component
      if (error && error.response && error.response.status === 409) {
        return Promise.reject(error.response);
      } else {
        return throwGlobalError(error);
      }
    }
  );
}

export function deleteRule(parameters: { key: string; organization: string | undefined }) {
  return post('/api/rules/delete', parameters).catch(throwGlobalError);
}

export function updateRule(data: {
  key: string;
  markdown_description?: string;
  markdown_note?: string;
  name?: string;
  organization: string | undefined;
  params?: string;
  remediation_fn_base_effort?: string;
  remediation_fn_type?: string;
  remediation_fy_gap_multiplier?: string;
  severity?: string;
  status?: string;
  tags?: string;
}): Promise<RuleDetails> {
  return postJSON('/api/rules/update', data).then(r => r.rule, throwGlobalError);
}