plugins/ScheduledReports/vue/src/types.ts


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

/*!
 * Matomo - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

export interface Report {
  [name: string]: unknown;

  idreport: string|number;
  idsite: string|number;
  login: string;
  description: string;
  idsegment: string|number|null;
  period: string;
  hour: string|number;
  type: string;
  format: string;
  reports: string[];
  parameters: Record<string, unknown>; // QueryParameters
  ts_created: string;
  ts_last_sent: string|null;
  deleted: string|number;
  evolution_graph_within_period: string|number;
  evolution_graph_period_n: string|number;
  period_param: string;
  evolutionPeriodFor: string;
  evolutionPeriodN: number;
  periodParam: string;
  recipients: string[];
}

interface ReportPluginGlobal {
  defaultPeriod: string;
  defaultHour: string;
  defaultReportType: string;
  defaultReportFormat: string;
  reportList: Report[];
  createReportString: string;
  updateReportString: string;
  defaultEvolutionPeriodN: number;
  periodTranslations: Record<string, { single: string, plural: string }>;
}

declare global {
  interface Window {
    ReportPlugin: ReportPluginGlobal;
    getReportParametersFunctions: Record<string, (report: Report) => Record<string, unknown>>;
    resetReportParametersFunctions: Record<string, (report: Report) => void>;
    updateReportParametersFunctions: Record<string, (report: Report) => void>;
  }
}