spotcharge-types 1.0.390 → 1.0.391

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 (4) hide show
  1. package/dist/models/api/reports/admin-report.api.model.d.ts +16 -0
  2. package/dist/models/api/reports/admin-report.api.model.d.ts.map +1 -1
  3. package/package.json +1 -1
  4. package/src/models/api/reports/admin-report.api.model.ts +16 -0
package/dist/models/api/reports/admin-report.api.model.d.ts CHANGED
@@ -4,6 +4,8 @@ import { ApiSortDirection } from '../users/admin-user.api.model';
4
4
  export interface AdminReportCatalogItemApiModel {
5
5
  key: string;
6
6
  title: string;
7
+ /** One sentence so ops can tell reports apart on the list. */
8
+ text: string;
7
9
  group: string;
8
10
  favorite: boolean;
9
11
  }
@@ -28,6 +30,8 @@ export interface AdminReportFilterApiModel {
28
30
  key: string;
29
31
  kind: AdminReportFilterKind;
30
32
  label: string;
33
+ /** Plain-language note for ops. The shell shows it under the field and as a tooltip. */
34
+ hint?: string;
31
35
  options?: AdminReportFilterOptionApiModel[];
32
36
  /** Query param for the start of a dateRange filter. */
33
37
  fromParam?: string;
@@ -38,10 +42,18 @@ export interface AdminReportColumnApiModel {
38
42
  key: string;
39
43
  label: string;
40
44
  sortable: boolean;
45
+ /** Plain-language note for ops. The shell shows it as a tooltip on the column. */
46
+ hint?: string;
41
47
  }
42
48
  export interface AdminReportMetricApiModel {
43
49
  key: string;
44
50
  label: string;
51
+ /** Groups figures that share a heading. Omitted figures stay in one grid. */
52
+ section?: string;
53
+ /** One sentence under the section heading. Same text on every figure in the section. */
54
+ sectionNote?: string;
55
+ /** Plain-language note for ops. The shell shows it as a tooltip. */
56
+ hint?: string;
45
57
  }
46
58
  /** GET /api/admin/reports/:key */
47
59
  export interface AdminReportDescriptionApiModel {
@@ -74,6 +86,10 @@ export interface AdminReportMetricValueApiModel {
74
86
  key: string;
75
87
  label: string;
76
88
  value: string;
89
+ section?: string;
90
+ sectionNote?: string;
91
+ /** Same note as the metric definition, so the run response explains the figure. */
92
+ hint?: string;
77
93
  }
78
94
  export interface AdminReportMetricsPageApiModel {
79
95
  layout: 'metrics';
package/dist/models/api/reports/admin-report.api.model.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"admin-report.api.model.d.ts","sourceRoot":"","sources":["../../../../src/models/api/reports/admin-report.api.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEjE,iEAAiE;AACjE,MAAM,WAAW,8BAA8B;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,+BAA+B;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,cAAc,CAAC;IAC/B,OAAO,EAAE,8BAA8B,EAAE,CAAC;CAC3C;AAED,6BAA6B;AAC7B,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,+BAA+B,EAAE,CAAC;CAC3C;AAED,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;AAElF,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpD,MAAM,WAAW,+BAA+B;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,qBAAqB,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,+BAA+B,EAAE,CAAC;IAC5C,uDAAuD;IACvD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,yBAAyB;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,kCAAkC;AAClC,MAAM,WAAW,8BAA8B;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,cAAc,EAAE,cAAc,CAAC;IAC/B,gBAAgB,EAAE,cAAc,CAAC;IACjC,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACrC,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACrC,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACrC,iFAAiF;IACjF,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,WAAW,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACrC,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,gBAAgB,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,8BAA8B,EAAE,CAAC;CAC3C;AAED,sCAAsC;AACtC,MAAM,MAAM,sBAAsB,GAAG,4BAA4B,GAAG,8BAA8B,CAAC"}
1
+ {"version":3,"file":"admin-report.api.model.d.ts","sourceRoot":"","sources":["../../../../src/models/api/reports/admin-report.api.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEjE,iEAAiE;AACjE,MAAM,WAAW,8BAA8B;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,+BAA+B;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,cAAc,CAAC;IAC/B,OAAO,EAAE,8BAA8B,EAAE,CAAC;CAC3C;AAED,6BAA6B;AAC7B,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,+BAA+B,EAAE,CAAC;CAC3C;AAED,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;AAElF,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpD,MAAM,WAAW,+BAA+B;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,qBAAqB,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,wFAAwF;IACxF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,+BAA+B,EAAE,CAAC;IAC5C,uDAAuD;IACvD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAClB,kFAAkF;IAClF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,6EAA6E;IAC7E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wFAAwF;IACxF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oEAAoE;IACpE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,kCAAkC;AAClC,MAAM,WAAW,8BAA8B;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,cAAc,EAAE,cAAc,CAAC;IAC/B,gBAAgB,EAAE,cAAc,CAAC;IACjC,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACrC,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACrC,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACrC,iFAAiF;IACjF,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,WAAW,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACrC,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,gBAAgB,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mFAAmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,8BAA8B,EAAE,CAAC;CAC3C;AAED,sCAAsC;AACtC,MAAM,MAAM,sBAAsB,GAAG,4BAA4B,GAAG,8BAA8B,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "spotcharge-types",
3
- "version": "1.0.390",
3
+ "version": "1.0.391",
4
4
  "description": "Spotcharge types",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/models/api/reports/admin-report.api.model.ts CHANGED
@@ -5,6 +5,8 @@ import { ApiSortDirection } from '../users/admin-user.api.model';
5
5
  export interface AdminReportCatalogItemApiModel {
6
6
  key: string;
7
7
  title: string;
8
+ /** One sentence so ops can tell reports apart on the list. */
9
+ text: string;
8
10
  group: string;
9
11
  favorite: boolean;
10
12
  }
@@ -35,6 +37,8 @@ export interface AdminReportFilterApiModel {
35
37
  key: string;
36
38
  kind: AdminReportFilterKind;
37
39
  label: string;
40
+ /** Plain-language note for ops. The shell shows it under the field and as a tooltip. */
41
+ hint?: string;
38
42
  options?: AdminReportFilterOptionApiModel[];
39
43
  /** Query param for the start of a dateRange filter. */
40
44
  fromParam?: string;
@@ -46,11 +50,19 @@ export interface AdminReportColumnApiModel {
46
50
  key: string;
47
51
  label: string;
48
52
  sortable: boolean;
53
+ /** Plain-language note for ops. The shell shows it as a tooltip on the column. */
54
+ hint?: string;
49
55
  }
50
56
 
51
57
  export interface AdminReportMetricApiModel {
52
58
  key: string;
53
59
  label: string;
60
+ /** Groups figures that share a heading. Omitted figures stay in one grid. */
61
+ section?: string;
62
+ /** One sentence under the section heading. Same text on every figure in the section. */
63
+ sectionNote?: string;
64
+ /** Plain-language note for ops. The shell shows it as a tooltip. */
65
+ hint?: string;
54
66
  }
55
67
 
56
68
  /** GET /api/admin/reports/:key */
@@ -86,6 +98,10 @@ export interface AdminReportMetricValueApiModel {
86
98
  key: string;
87
99
  label: string;
88
100
  value: string;
101
+ section?: string;
102
+ sectionNote?: string;
103
+ /** Same note as the metric definition, so the run response explains the figure. */
104
+ hint?: string;
89
105
  }
90
106
 
91
107
  export interface AdminReportMetricsPageApiModel {