@isoftdata/utility-dashboard-backend 2.4.9 → 2.4.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.ts +1 -1
  2. package/dist/types/chart.d.ts +26 -26
  3. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -62,7 +62,7 @@ type FormatReportMetadataOptions = {
62
62
  siteNameColumn?: string;
63
63
  };
64
64
  export declare function formatReportMetadata(mysqlConnection: Connection, { report, chartsInReport, session, site, siteIdColumn, siteNameColumn }: FormatReportMetadataOptions): Promise<Report>;
65
- type FormatChartDataForReportOptions = {
65
+ export type FormatChartDataForReportOptions = {
66
66
  reportParameters: DashboardReportParameter[];
67
67
  chart: Chart;
68
68
  reportChart: {
package/dist/types/chart.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import type { NumberFormatOptions, MediumDateFormatOptions, LongDateFormatOptions } from '../formatting-templates';
1
+ import type { NumberFormatOptions, MediumDateFormatOptions, LongDateFormatOptions } from "../formatting-templates";
2
2
  export type GoogleDataTableCell = {
3
3
  v?: unknown;
4
4
  f?: string | undefined;
@@ -27,71 +27,71 @@ interface WidthAndHeight {
27
27
  export type ChartWrapper = {
28
28
  options: google.visualization.TreeMapOptions & WidthAndHeight;
29
29
  dataTable?: GoogleDataTable;
30
- chartType: 'TreeMap';
30
+ chartType: "TreeMap";
31
31
  } | {
32
32
  options: google.visualization.GeoChartOptions & WidthAndHeight;
33
33
  dataTable?: GoogleDataTable;
34
- chartType: 'GeoChart';
34
+ chartType: "GeoChart";
35
35
  } | {
36
36
  options: google.visualization.ScatterChartOptions & WidthAndHeight;
37
37
  dataTable?: GoogleDataTable;
38
- chartType: 'ScatterChart';
38
+ chartType: "ScatterChart";
39
39
  } | {
40
40
  options: google.visualization.ColumnChartOptions & WidthAndHeight;
41
41
  dataTable?: GoogleDataTable;
42
- chartType: 'ColumnChart';
42
+ chartType: "ColumnChart";
43
43
  } | {
44
44
  options: google.visualization.HistogramOptions & WidthAndHeight;
45
45
  dataTable?: GoogleDataTable;
46
- chartType: 'HistogramOptions';
46
+ chartType: "HistogramOptions";
47
47
  } | {
48
48
  options: google.visualization.BarChartOptions & WidthAndHeight;
49
49
  dataTable?: GoogleDataTable;
50
- chartType: 'BarChart';
50
+ chartType: "BarChart";
51
51
  } | {
52
52
  options: google.visualization.ComboChartOptions & WidthAndHeight;
53
53
  dataTable?: GoogleDataTable;
54
- chartType: 'ComboChart';
54
+ chartType: "ComboChart";
55
55
  } | {
56
56
  options: google.visualization.AreaChartOptions & WidthAndHeight;
57
57
  dataTable?: GoogleDataTable;
58
- chartType: 'AreaChart';
58
+ chartType: "AreaChart";
59
59
  } | {
60
60
  options: google.visualization.SteppedAreaChartOptions & WidthAndHeight;
61
61
  dataTable?: GoogleDataTable;
62
- chartType: 'SteppedAreaChart';
62
+ chartType: "SteppedAreaChart";
63
63
  } | {
64
64
  options: google.visualization.LineChartOptions & WidthAndHeight;
65
65
  dataTable?: GoogleDataTable;
66
- chartType: 'LineChart';
66
+ chartType: "LineChart";
67
67
  } | {
68
68
  options: google.visualization.PieChartOptions & WidthAndHeight;
69
69
  dataTable?: GoogleDataTable;
70
- chartType: 'PieChart';
70
+ chartType: "PieChart";
71
71
  } | {
72
72
  options: google.visualization.BubbleChartOptions & WidthAndHeight;
73
73
  dataTable?: GoogleDataTable;
74
- chartType: 'BubbleChart';
74
+ chartType: "BubbleChart";
75
75
  } | {
76
76
  options: google.visualization.OrgChartOptions & WidthAndHeight;
77
77
  dataTable?: GoogleDataTable;
78
- chartType: 'OrgChart';
78
+ chartType: "OrgChart";
79
79
  } | {
80
80
  options: google.visualization.TimelineOptions & WidthAndHeight;
81
81
  dataTable?: GoogleDataTable;
82
- chartType: 'Timeline';
82
+ chartType: "Timeline";
83
83
  } | {
84
84
  options: google.visualization.GaugeChartOptions & WidthAndHeight;
85
85
  dataTable?: GoogleDataTable;
86
- chartType: 'GaugeChart';
86
+ chartType: "GaugeChart";
87
87
  } | {
88
88
  options: google.visualization.CandlestickChartOptions & WidthAndHeight;
89
89
  dataTable?: GoogleDataTable;
90
- chartType: 'CandlestickChart';
90
+ chartType: "CandlestickChart";
91
91
  } | {
92
92
  options: google.visualization.TableOptions & WidthAndHeight;
93
93
  dataTable?: GoogleDataTable;
94
- chartType: 'Table';
94
+ chartType: "Table";
95
95
  };
96
96
  export type MultiSeriesOptions = {
97
97
  value: string;
@@ -99,12 +99,12 @@ export type MultiSeriesOptions = {
99
99
  groupXAxisBy: string;
100
100
  tooltip?: string;
101
101
  };
102
- export type FormattingType = 'DateFormat' | 'NumberFormat';
102
+ export type FormattingType = "DateFormat" | "NumberFormat";
103
103
  export type FormattingRule = {
104
- type: 'DateFormat';
104
+ type: "DateFormat";
105
105
  format: LongDateFormatOptions | MediumDateFormatOptions;
106
106
  } | {
107
- type: 'NumberFormat';
107
+ type: "NumberFormat";
108
108
  format: NumberFormatOptions;
109
109
  };
110
110
  export type Formatting = Record<string, FormattingRule>;
@@ -147,7 +147,7 @@ export type TableStyleTemplate = {
147
147
  html?: string;
148
148
  [key: string]: string | undefined;
149
149
  };
150
- export type ChartSuperType = 'google' | 'table' | 'embed';
150
+ export type ChartSuperType = "google" | "table" | "embed";
151
151
  export type ChartBase = {
152
152
  chartId: number;
153
153
  query: string;
@@ -170,14 +170,14 @@ export type ChartBase = {
170
170
  url?: string;
171
171
  };
172
172
  type GoogleChart = ChartBase & {
173
- supertype: 'google';
173
+ supertype: "google";
174
174
  };
175
175
  type TableChart = ChartBase & {
176
- supertype: 'table';
177
- table: NonNullable<ChartBase['table']>;
176
+ supertype: "table";
177
+ table: NonNullable<ChartBase["table"]>;
178
178
  };
179
179
  type EmbedChart = ChartBase & {
180
- supertype: 'embed';
180
+ supertype: "embed";
181
181
  url: string;
182
182
  };
183
183
  export type Chart = GoogleChart | TableChart | EmbedChart;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@isoftdata/utility-dashboard-backend",
3
- "version": "2.4.9",
3
+ "version": "2.4.10",
4
4
  "description": "A utility for formatting chart and report data to be usable by the frontend dashboard component.",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {